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
519 window (or another buffer with the same base buffer). */
523 /* Vector containing glyphs for an ellipsis `...'. */
525 static Lisp_Object default_invis_vector
[3];
527 /* This is the window where the echo area message was displayed. It
528 is always a mini-buffer window, but it may not be the same window
529 currently active as a mini-buffer. */
531 Lisp_Object echo_area_window
;
533 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
534 pushes the current message and the value of
535 message_enable_multibyte on the stack, the function restore_message
536 pops the stack and displays MESSAGE again. */
538 static Lisp_Object Vmessage_stack
;
540 /* Nonzero means multibyte characters were enabled when the echo area
541 message was specified. */
543 static int message_enable_multibyte
;
545 /* Nonzero if we should redraw the mode lines on the next redisplay. */
547 int update_mode_lines
;
549 /* Nonzero if window sizes or contents have changed since last
550 redisplay that finished. */
552 int windows_or_buffers_changed
;
554 /* Nonzero means a frame's cursor type has been changed. */
556 int cursor_type_changed
;
558 /* Nonzero after display_mode_line if %l was used and it displayed a
561 static int line_number_displayed
;
563 /* The name of the *Messages* buffer, a string. */
565 static Lisp_Object Vmessages_buffer_name
;
567 /* Current, index 0, and last displayed echo area message. Either
568 buffers from echo_buffers, or nil to indicate no message. */
570 Lisp_Object echo_area_buffer
[2];
572 /* The buffers referenced from echo_area_buffer. */
574 static Lisp_Object echo_buffer
[2];
576 /* A vector saved used in with_area_buffer to reduce consing. */
578 static Lisp_Object Vwith_echo_area_save_vector
;
580 /* Non-zero means display_echo_area should display the last echo area
581 message again. Set by redisplay_preserve_echo_area. */
583 static int display_last_displayed_message_p
;
585 /* Nonzero if echo area is being used by print; zero if being used by
588 static int message_buf_print
;
590 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
592 static Lisp_Object Qinhibit_menubar_update
;
593 static Lisp_Object Qmessage_truncate_lines
;
595 /* Set to 1 in clear_message to make redisplay_internal aware
596 of an emptied echo area. */
598 static int message_cleared_p
;
600 /* A scratch glyph row with contents used for generating truncation
601 glyphs. Also used in direct_output_for_insert. */
603 #define MAX_SCRATCH_GLYPHS 100
604 static struct glyph_row scratch_glyph_row
;
605 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
607 /* Ascent and height of the last line processed by move_it_to. */
609 static int last_max_ascent
, last_height
;
611 /* Non-zero if there's a help-echo in the echo area. */
613 int help_echo_showing_p
;
615 /* If >= 0, computed, exact values of mode-line and header-line height
616 to use in the macros CURRENT_MODE_LINE_HEIGHT and
617 CURRENT_HEADER_LINE_HEIGHT. */
619 int current_mode_line_height
, current_header_line_height
;
621 /* The maximum distance to look ahead for text properties. Values
622 that are too small let us call compute_char_face and similar
623 functions too often which is expensive. Values that are too large
624 let us call compute_char_face and alike too often because we
625 might not be interested in text properties that far away. */
627 #define TEXT_PROP_DISTANCE_LIMIT 100
629 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
630 iterator state and later restore it. This is needed because the
631 bidi iterator on bidi.c keeps a stacked cache of its states, which
632 is really a singleton. When we use scratch iterator objects to
633 move around the buffer, we can cause the bidi cache to be pushed or
634 popped, and therefore we need to restore the cache state when we
635 return to the original iterator. */
636 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
639 bidi_unshelve_cache (CACHE, 1); \
641 CACHE = bidi_shelve_cache (); \
644 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
646 if (pITORIG != pITCOPY) \
647 *(pITORIG) = *(pITCOPY); \
648 bidi_unshelve_cache (CACHE, 0); \
654 /* Non-zero means print traces of redisplay if compiled with
655 GLYPH_DEBUG defined. */
657 int trace_redisplay_p
;
659 #endif /* GLYPH_DEBUG */
661 #ifdef DEBUG_TRACE_MOVE
662 /* Non-zero means trace with TRACE_MOVE to stderr. */
665 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
667 #define TRACE_MOVE(x) (void) 0
670 static Lisp_Object Qauto_hscroll_mode
;
672 /* Buffer being redisplayed -- for redisplay_window_error. */
674 static struct buffer
*displayed_buffer
;
676 /* Value returned from text property handlers (see below). */
681 HANDLED_RECOMPUTE_PROPS
,
682 HANDLED_OVERLAY_STRING_CONSUMED
,
686 /* A description of text properties that redisplay is interested
691 /* The name of the property. */
694 /* A unique index for the property. */
697 /* A handler function called to set up iterator IT from the property
698 at IT's current position. Value is used to steer handle_stop. */
699 enum prop_handled (*handler
) (struct it
*it
);
702 static enum prop_handled
handle_face_prop (struct it
*);
703 static enum prop_handled
handle_invisible_prop (struct it
*);
704 static enum prop_handled
handle_display_prop (struct it
*);
705 static enum prop_handled
handle_composition_prop (struct it
*);
706 static enum prop_handled
handle_overlay_change (struct it
*);
707 static enum prop_handled
handle_fontified_prop (struct it
*);
709 /* Properties handled by iterators. */
711 static struct props it_props
[] =
713 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
714 /* Handle `face' before `display' because some sub-properties of
715 `display' need to know the face. */
716 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
717 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
718 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
719 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
723 /* Value is the position described by X. If X is a marker, value is
724 the marker_position of X. Otherwise, value is X. */
726 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
728 /* Enumeration returned by some move_it_.* functions internally. */
732 /* Not used. Undefined value. */
735 /* Move ended at the requested buffer position or ZV. */
736 MOVE_POS_MATCH_OR_ZV
,
738 /* Move ended at the requested X pixel position. */
741 /* Move within a line ended at the end of a line that must be
745 /* Move within a line ended at the end of a line that would
746 be displayed truncated. */
749 /* Move within a line ended at a line end. */
753 /* This counter is used to clear the face cache every once in a while
754 in redisplay_internal. It is incremented for each redisplay.
755 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
758 #define CLEAR_FACE_CACHE_COUNT 500
759 static int clear_face_cache_count
;
761 /* Similarly for the image cache. */
763 #ifdef HAVE_WINDOW_SYSTEM
764 #define CLEAR_IMAGE_CACHE_COUNT 101
765 static int clear_image_cache_count
;
767 /* Null glyph slice */
768 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
771 /* True while redisplay_internal is in progress. */
775 static Lisp_Object Qinhibit_free_realized_faces
;
776 static Lisp_Object Qmode_line_default_help_echo
;
778 /* If a string, XTread_socket generates an event to display that string.
779 (The display is done in read_char.) */
781 Lisp_Object help_echo_string
;
782 Lisp_Object help_echo_window
;
783 Lisp_Object help_echo_object
;
784 ptrdiff_t help_echo_pos
;
786 /* Temporary variable for XTread_socket. */
788 Lisp_Object previous_help_echo_string
;
790 /* Platform-independent portion of hourglass implementation. */
792 /* Non-zero means an hourglass cursor is currently shown. */
793 int hourglass_shown_p
;
795 /* If non-null, an asynchronous timer that, when it expires, displays
796 an hourglass cursor on all frames. */
797 struct atimer
*hourglass_atimer
;
799 /* Name of the face used to display glyphless characters. */
800 Lisp_Object Qglyphless_char
;
802 /* Symbol for the purpose of Vglyphless_char_display. */
803 static Lisp_Object Qglyphless_char_display
;
805 /* Method symbols for Vglyphless_char_display. */
806 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
808 /* Default pixel width of `thin-space' display method. */
809 #define THIN_SPACE_WIDTH 1
811 /* Default number of seconds to wait before displaying an hourglass
813 #define DEFAULT_HOURGLASS_DELAY 1
816 /* Function prototypes. */
818 static void setup_for_ellipsis (struct it
*, int);
819 static void set_iterator_to_next (struct it
*, int);
820 static void mark_window_display_accurate_1 (struct window
*, int);
821 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
822 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
823 static int cursor_row_p (struct glyph_row
*);
824 static int redisplay_mode_lines (Lisp_Object
, int);
825 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
827 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
829 static void handle_line_prefix (struct it
*);
831 static void pint2str (char *, int, ptrdiff_t);
832 static void pint2hrstr (char *, int, ptrdiff_t);
833 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
835 static void reconsider_clip_changes (struct window
*, struct buffer
*);
836 static int text_outside_line_unchanged_p (struct window
*,
837 ptrdiff_t, ptrdiff_t);
838 static void store_mode_line_noprop_char (char);
839 static int store_mode_line_noprop (const char *, int, int);
840 static void handle_stop (struct it
*);
841 static void handle_stop_backwards (struct it
*, ptrdiff_t);
842 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
843 static void ensure_echo_area_buffers (void);
844 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
845 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
846 static int with_echo_area_buffer (struct window
*, int,
847 int (*) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
848 ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
849 static void clear_garbaged_frames (void);
850 static int current_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
851 static void pop_message (void);
852 static int truncate_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
853 static void set_message (const char *, Lisp_Object
, ptrdiff_t, int);
854 static int set_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
855 static int display_echo_area (struct window
*);
856 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
857 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
858 static Lisp_Object
unwind_redisplay (Lisp_Object
);
859 static int string_char_and_length (const unsigned char *, int *);
860 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
862 static int compute_window_start_on_continuation_line (struct window
*);
863 static void insert_left_trunc_glyphs (struct it
*);
864 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
866 static void extend_face_to_end_of_line (struct it
*);
867 static int append_space_for_newline (struct it
*, int);
868 static int cursor_row_fully_visible_p (struct window
*, int, int);
869 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
870 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
871 static int trailing_whitespace_p (ptrdiff_t);
872 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
873 static void push_it (struct it
*, struct text_pos
*);
874 static void iterate_out_of_display_property (struct it
*);
875 static void pop_it (struct it
*);
876 static void sync_frame_with_window_matrix_rows (struct window
*);
877 static void select_frame_for_redisplay (Lisp_Object
);
878 static void redisplay_internal (void);
879 static int echo_area_display (int);
880 static void redisplay_windows (Lisp_Object
);
881 static void redisplay_window (Lisp_Object
, int);
882 static Lisp_Object
redisplay_window_error (Lisp_Object
);
883 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
884 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
885 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
886 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
888 static int update_menu_bar (struct frame
*, int, int);
889 static int try_window_reusing_current_matrix (struct window
*);
890 static int try_window_id (struct window
*);
891 static int display_line (struct it
*);
892 static int display_mode_lines (struct window
*);
893 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
894 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
895 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
896 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
897 static void display_menu_bar (struct window
*);
898 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
900 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
901 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
902 static void compute_line_metrics (struct it
*);
903 static void run_redisplay_end_trigger_hook (struct it
*);
904 static int get_overlay_strings (struct it
*, ptrdiff_t);
905 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
906 static void next_overlay_string (struct it
*);
907 static void reseat (struct it
*, struct text_pos
, int);
908 static void reseat_1 (struct it
*, struct text_pos
, int);
909 static void back_to_previous_visible_line_start (struct it
*);
910 void reseat_at_previous_visible_line_start (struct it
*);
911 static void reseat_at_next_visible_line_start (struct it
*, int);
912 static int next_element_from_ellipsis (struct it
*);
913 static int next_element_from_display_vector (struct it
*);
914 static int next_element_from_string (struct it
*);
915 static int next_element_from_c_string (struct it
*);
916 static int next_element_from_buffer (struct it
*);
917 static int next_element_from_composition (struct it
*);
918 static int next_element_from_image (struct it
*);
919 static int next_element_from_stretch (struct it
*);
920 static void load_overlay_strings (struct it
*, ptrdiff_t);
921 static int init_from_display_pos (struct it
*, struct window
*,
922 struct display_pos
*);
923 static void reseat_to_string (struct it
*, const char *,
924 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
925 static int get_next_display_element (struct it
*);
926 static enum move_it_result
927 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
928 enum move_operation_enum
);
929 void move_it_vertically_backward (struct it
*, int);
930 static void get_visually_first_element (struct it
*);
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
;
3116 it
->end_charpos
= SCHARS (it
->string
);
3117 /* Set up the bidi iterator for this overlay string. */
3120 it
->bidi_it
.string
.lstring
= it
->string
;
3121 it
->bidi_it
.string
.s
= NULL
;
3122 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3123 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3124 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3125 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3126 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3127 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3129 /* Synchronize the state of the bidi iterator with
3130 pos->string_pos. For any string position other than
3131 zero, this will be done automagically when we resume
3132 iteration over the string and get_visually_first_element
3133 is called. But if string_pos is zero, and the string is
3134 to be reordered for display, we need to resync manually,
3135 since it could be that the iteration state recorded in
3136 pos ended at string_pos of 0 moving backwards in string. */
3137 if (CHARPOS (pos
->string_pos
) == 0)
3139 get_visually_first_element (it
);
3140 if (IT_STRING_CHARPOS (*it
) != 0)
3143 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3144 bidi_move_to_visually_next (&it
->bidi_it
);
3145 } while (it
->bidi_it
.charpos
!= 0);
3147 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3148 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3152 if (CHARPOS (pos
->string_pos
) >= 0)
3154 /* Recorded position is not in an overlay string, but in another
3155 string. This can only be a string from a `display' property.
3156 IT should already be filled with that string. */
3157 it
->current
.string_pos
= pos
->string_pos
;
3158 eassert (STRINGP (it
->string
));
3160 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3161 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3164 /* Restore position in display vector translations, control
3165 character translations or ellipses. */
3166 if (pos
->dpvec_index
>= 0)
3168 if (it
->dpvec
== NULL
)
3169 get_next_display_element (it
);
3170 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3171 it
->current
.dpvec_index
= pos
->dpvec_index
;
3175 return !overlay_strings_with_newlines
;
3179 /* Initialize IT for stepping through current_buffer in window W
3180 starting at ROW->start. */
3183 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3185 init_from_display_pos (it
, w
, &row
->start
);
3186 it
->start
= row
->start
;
3187 it
->continuation_lines_width
= row
->continuation_lines_width
;
3192 /* Initialize IT for stepping through current_buffer in window W
3193 starting in the line following ROW, i.e. starting at ROW->end.
3194 Value is zero if there are overlay strings with newlines at ROW's
3198 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3202 if (init_from_display_pos (it
, w
, &row
->end
))
3204 if (row
->continued_p
)
3205 it
->continuation_lines_width
3206 = row
->continuation_lines_width
+ row
->pixel_width
;
3217 /***********************************************************************
3219 ***********************************************************************/
3221 /* Called when IT reaches IT->stop_charpos. Handle text property and
3222 overlay changes. Set IT->stop_charpos to the next position where
3226 handle_stop (struct it
*it
)
3228 enum prop_handled handled
;
3229 int handle_overlay_change_p
;
3233 it
->current
.dpvec_index
= -1;
3234 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3235 it
->ignore_overlay_strings_at_pos_p
= 0;
3238 /* Use face of preceding text for ellipsis (if invisible) */
3239 if (it
->selective_display_ellipsis_p
)
3240 it
->saved_face_id
= it
->face_id
;
3244 handled
= HANDLED_NORMALLY
;
3246 /* Call text property handlers. */
3247 for (p
= it_props
; p
->handler
; ++p
)
3249 handled
= p
->handler (it
);
3251 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3253 else if (handled
== HANDLED_RETURN
)
3255 /* We still want to show before and after strings from
3256 overlays even if the actual buffer text is replaced. */
3257 if (!handle_overlay_change_p
3259 /* Don't call get_overlay_strings_1 if we already
3260 have overlay strings loaded, because doing so
3261 will load them again and push the iterator state
3262 onto the stack one more time, which is not
3263 expected by the rest of the code that processes
3265 || (it
->current
.overlay_string_index
< 0
3266 ? !get_overlay_strings_1 (it
, 0, 0)
3270 setup_for_ellipsis (it
, 0);
3271 /* When handling a display spec, we might load an
3272 empty string. In that case, discard it here. We
3273 used to discard it in handle_single_display_spec,
3274 but that causes get_overlay_strings_1, above, to
3275 ignore overlay strings that we must check. */
3276 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3280 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3284 it
->ignore_overlay_strings_at_pos_p
= 1;
3285 it
->string_from_display_prop_p
= 0;
3286 it
->from_disp_prop_p
= 0;
3287 handle_overlay_change_p
= 0;
3289 handled
= HANDLED_RECOMPUTE_PROPS
;
3292 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3293 handle_overlay_change_p
= 0;
3296 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3298 /* Don't check for overlay strings below when set to deliver
3299 characters from a display vector. */
3300 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3301 handle_overlay_change_p
= 0;
3303 /* Handle overlay changes.
3304 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3305 if it finds overlays. */
3306 if (handle_overlay_change_p
)
3307 handled
= handle_overlay_change (it
);
3312 setup_for_ellipsis (it
, 0);
3316 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3318 /* Determine where to stop next. */
3319 if (handled
== HANDLED_NORMALLY
)
3320 compute_stop_pos (it
);
3324 /* Compute IT->stop_charpos from text property and overlay change
3325 information for IT's current position. */
3328 compute_stop_pos (struct it
*it
)
3330 register INTERVAL iv
, next_iv
;
3331 Lisp_Object object
, limit
, position
;
3332 ptrdiff_t charpos
, bytepos
;
3334 if (STRINGP (it
->string
))
3336 /* Strings are usually short, so don't limit the search for
3338 it
->stop_charpos
= it
->end_charpos
;
3339 object
= it
->string
;
3341 charpos
= IT_STRING_CHARPOS (*it
);
3342 bytepos
= IT_STRING_BYTEPOS (*it
);
3348 /* If end_charpos is out of range for some reason, such as a
3349 misbehaving display function, rationalize it (Bug#5984). */
3350 if (it
->end_charpos
> ZV
)
3351 it
->end_charpos
= ZV
;
3352 it
->stop_charpos
= it
->end_charpos
;
3354 /* If next overlay change is in front of the current stop pos
3355 (which is IT->end_charpos), stop there. Note: value of
3356 next_overlay_change is point-max if no overlay change
3358 charpos
= IT_CHARPOS (*it
);
3359 bytepos
= IT_BYTEPOS (*it
);
3360 pos
= next_overlay_change (charpos
);
3361 if (pos
< it
->stop_charpos
)
3362 it
->stop_charpos
= pos
;
3364 /* If showing the region, we have to stop at the region
3365 start or end because the face might change there. */
3366 if (it
->region_beg_charpos
> 0)
3368 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3369 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3370 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3371 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3374 /* Set up variables for computing the stop position from text
3375 property changes. */
3376 XSETBUFFER (object
, current_buffer
);
3377 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3380 /* Get the interval containing IT's position. Value is a null
3381 interval if there isn't such an interval. */
3382 position
= make_number (charpos
);
3383 iv
= validate_interval_range (object
, &position
, &position
, 0);
3386 Lisp_Object values_here
[LAST_PROP_IDX
];
3389 /* Get properties here. */
3390 for (p
= it_props
; p
->handler
; ++p
)
3391 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3393 /* Look for an interval following iv that has different
3395 for (next_iv
= next_interval (iv
);
3398 || XFASTINT (limit
) > next_iv
->position
));
3399 next_iv
= next_interval (next_iv
))
3401 for (p
= it_props
; p
->handler
; ++p
)
3403 Lisp_Object new_value
;
3405 new_value
= textget (next_iv
->plist
, *p
->name
);
3406 if (!EQ (values_here
[p
->idx
], new_value
))
3416 if (INTEGERP (limit
)
3417 && next_iv
->position
>= XFASTINT (limit
))
3418 /* No text property change up to limit. */
3419 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3421 /* Text properties change in next_iv. */
3422 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3426 if (it
->cmp_it
.id
< 0)
3428 ptrdiff_t stoppos
= it
->end_charpos
;
3430 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3432 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3433 stoppos
, it
->string
);
3436 eassert (STRINGP (it
->string
)
3437 || (it
->stop_charpos
>= BEGV
3438 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3442 /* Return the position of the next overlay change after POS in
3443 current_buffer. Value is point-max if no overlay change
3444 follows. This is like `next-overlay-change' but doesn't use
3448 next_overlay_change (ptrdiff_t pos
)
3450 ptrdiff_t i
, noverlays
;
3452 Lisp_Object
*overlays
;
3454 /* Get all overlays at the given position. */
3455 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3457 /* If any of these overlays ends before endpos,
3458 use its ending point instead. */
3459 for (i
= 0; i
< noverlays
; ++i
)
3464 oend
= OVERLAY_END (overlays
[i
]);
3465 oendpos
= OVERLAY_POSITION (oend
);
3466 endpos
= min (endpos
, oendpos
);
3472 /* How many characters forward to search for a display property or
3473 display string. Searching too far forward makes the bidi display
3474 sluggish, especially in small windows. */
3475 #define MAX_DISP_SCAN 250
3477 /* Return the character position of a display string at or after
3478 position specified by POSITION. If no display string exists at or
3479 after POSITION, return ZV. A display string is either an overlay
3480 with `display' property whose value is a string, or a `display'
3481 text property whose value is a string. STRING is data about the
3482 string to iterate; if STRING->lstring is nil, we are iterating a
3483 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3484 on a GUI frame. DISP_PROP is set to zero if we searched
3485 MAX_DISP_SCAN characters forward without finding any display
3486 strings, non-zero otherwise. It is set to 2 if the display string
3487 uses any kind of `(space ...)' spec that will produce a stretch of
3488 white space in the text area. */
3490 compute_display_string_pos (struct text_pos
*position
,
3491 struct bidi_string_data
*string
,
3492 int frame_window_p
, int *disp_prop
)
3494 /* OBJECT = nil means current buffer. */
3495 Lisp_Object object
=
3496 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3497 Lisp_Object pos
, spec
, limpos
;
3498 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3499 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3500 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3501 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3503 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3504 struct text_pos tpos
;
3510 /* We don't support display properties whose values are strings
3511 that have display string properties. */
3512 || string
->from_disp_str
3513 /* C strings cannot have display properties. */
3514 || (string
->s
&& !STRINGP (object
)))
3520 /* If the character at CHARPOS is where the display string begins,
3522 pos
= make_number (charpos
);
3523 if (STRINGP (object
))
3524 bufpos
= string
->bufpos
;
3528 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3530 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3533 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3541 /* Look forward for the first character with a `display' property
3542 that will replace the underlying text when displayed. */
3543 limpos
= make_number (lim
);
3545 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3546 CHARPOS (tpos
) = XFASTINT (pos
);
3547 if (CHARPOS (tpos
) >= lim
)
3552 if (STRINGP (object
))
3553 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3555 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3556 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3557 if (!STRINGP (object
))
3558 bufpos
= CHARPOS (tpos
);
3559 } while (NILP (spec
)
3560 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3561 bufpos
, frame_window_p
)));
3565 return CHARPOS (tpos
);
3568 /* Return the character position of the end of the display string that
3569 started at CHARPOS. If there's no display string at CHARPOS,
3570 return -1. A display string is either an overlay with `display'
3571 property whose value is a string or a `display' text property whose
3572 value is a string. */
3574 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3576 /* OBJECT = nil means current buffer. */
3577 Lisp_Object object
=
3578 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3579 Lisp_Object pos
= make_number (charpos
);
3581 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3583 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3586 /* It could happen that the display property or overlay was removed
3587 since we found it in compute_display_string_pos above. One way
3588 this can happen is if JIT font-lock was called (through
3589 handle_fontified_prop), and jit-lock-functions remove text
3590 properties or overlays from the portion of buffer that includes
3591 CHARPOS. Muse mode is known to do that, for example. In this
3592 case, we return -1 to the caller, to signal that no display
3593 string is actually present at CHARPOS. See bidi_fetch_char for
3594 how this is handled.
3596 An alternative would be to never look for display properties past
3597 it->stop_charpos. But neither compute_display_string_pos nor
3598 bidi_fetch_char that calls it know or care where the next
3600 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3603 /* Look forward for the first character where the `display' property
3605 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3607 return XFASTINT (pos
);
3612 /***********************************************************************
3614 ***********************************************************************/
3616 /* Handle changes in the `fontified' property of the current buffer by
3617 calling hook functions from Qfontification_functions to fontify
3620 static enum prop_handled
3621 handle_fontified_prop (struct it
*it
)
3623 Lisp_Object prop
, pos
;
3624 enum prop_handled handled
= HANDLED_NORMALLY
;
3626 if (!NILP (Vmemory_full
))
3629 /* Get the value of the `fontified' property at IT's current buffer
3630 position. (The `fontified' property doesn't have a special
3631 meaning in strings.) If the value is nil, call functions from
3632 Qfontification_functions. */
3633 if (!STRINGP (it
->string
)
3635 && !NILP (Vfontification_functions
)
3636 && !NILP (Vrun_hooks
)
3637 && (pos
= make_number (IT_CHARPOS (*it
)),
3638 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3639 /* Ignore the special cased nil value always present at EOB since
3640 no amount of fontifying will be able to change it. */
3641 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3643 ptrdiff_t count
= SPECPDL_INDEX ();
3645 struct buffer
*obuf
= current_buffer
;
3646 int begv
= BEGV
, zv
= ZV
;
3647 int old_clip_changed
= current_buffer
->clip_changed
;
3649 val
= Vfontification_functions
;
3650 specbind (Qfontification_functions
, Qnil
);
3652 eassert (it
->end_charpos
== ZV
);
3654 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3655 safe_call1 (val
, pos
);
3658 Lisp_Object fns
, fn
;
3659 struct gcpro gcpro1
, gcpro2
;
3664 for (; CONSP (val
); val
= XCDR (val
))
3670 /* A value of t indicates this hook has a local
3671 binding; it means to run the global binding too.
3672 In a global value, t should not occur. If it
3673 does, we must ignore it to avoid an endless
3675 for (fns
= Fdefault_value (Qfontification_functions
);
3681 safe_call1 (fn
, pos
);
3685 safe_call1 (fn
, pos
);
3691 unbind_to (count
, Qnil
);
3693 /* Fontification functions routinely call `save-restriction'.
3694 Normally, this tags clip_changed, which can confuse redisplay
3695 (see discussion in Bug#6671). Since we don't perform any
3696 special handling of fontification changes in the case where
3697 `save-restriction' isn't called, there's no point doing so in
3698 this case either. So, if the buffer's restrictions are
3699 actually left unchanged, reset clip_changed. */
3700 if (obuf
== current_buffer
)
3702 if (begv
== BEGV
&& zv
== ZV
)
3703 current_buffer
->clip_changed
= old_clip_changed
;
3705 /* There isn't much we can reasonably do to protect against
3706 misbehaving fontification, but here's a fig leaf. */
3707 else if (BUFFER_LIVE_P (obuf
))
3708 set_buffer_internal_1 (obuf
);
3710 /* The fontification code may have added/removed text.
3711 It could do even a lot worse, but let's at least protect against
3712 the most obvious case where only the text past `pos' gets changed',
3713 as is/was done in grep.el where some escapes sequences are turned
3714 into face properties (bug#7876). */
3715 it
->end_charpos
= ZV
;
3717 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3718 something. This avoids an endless loop if they failed to
3719 fontify the text for which reason ever. */
3720 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3721 handled
= HANDLED_RECOMPUTE_PROPS
;
3729 /***********************************************************************
3731 ***********************************************************************/
3733 /* Set up iterator IT from face properties at its current position.
3734 Called from handle_stop. */
3736 static enum prop_handled
3737 handle_face_prop (struct it
*it
)
3740 ptrdiff_t next_stop
;
3742 if (!STRINGP (it
->string
))
3745 = face_at_buffer_position (it
->w
,
3747 it
->region_beg_charpos
,
3748 it
->region_end_charpos
,
3751 + TEXT_PROP_DISTANCE_LIMIT
),
3752 0, it
->base_face_id
);
3754 /* Is this a start of a run of characters with box face?
3755 Caveat: this can be called for a freshly initialized
3756 iterator; face_id is -1 in this case. We know that the new
3757 face will not change until limit, i.e. if the new face has a
3758 box, all characters up to limit will have one. But, as
3759 usual, we don't know whether limit is really the end. */
3760 if (new_face_id
!= it
->face_id
)
3762 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3764 /* If new face has a box but old face has not, this is
3765 the start of a run of characters with box, i.e. it has
3766 a shadow on the left side. The value of face_id of the
3767 iterator will be -1 if this is the initial call that gets
3768 the face. In this case, we have to look in front of IT's
3769 position and see whether there is a face != new_face_id. */
3770 it
->start_of_box_run_p
3771 = (new_face
->box
!= FACE_NO_BOX
3772 && (it
->face_id
>= 0
3773 || IT_CHARPOS (*it
) == BEG
3774 || new_face_id
!= face_before_it_pos (it
)));
3775 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3783 Lisp_Object from_overlay
3784 = (it
->current
.overlay_string_index
>= 0
3785 ? it
->string_overlays
[it
->current
.overlay_string_index
3786 % OVERLAY_STRING_CHUNK_SIZE
]
3789 /* See if we got to this string directly or indirectly from
3790 an overlay property. That includes the before-string or
3791 after-string of an overlay, strings in display properties
3792 provided by an overlay, their text properties, etc.
3794 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3795 if (! NILP (from_overlay
))
3796 for (i
= it
->sp
- 1; i
>= 0; i
--)
3798 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3800 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3801 % OVERLAY_STRING_CHUNK_SIZE
];
3802 else if (! NILP (it
->stack
[i
].from_overlay
))
3803 from_overlay
= it
->stack
[i
].from_overlay
;
3805 if (!NILP (from_overlay
))
3809 if (! NILP (from_overlay
))
3811 bufpos
= IT_CHARPOS (*it
);
3812 /* For a string from an overlay, the base face depends
3813 only on text properties and ignores overlays. */
3815 = face_for_overlay_string (it
->w
,
3817 it
->region_beg_charpos
,
3818 it
->region_end_charpos
,
3821 + TEXT_PROP_DISTANCE_LIMIT
),
3829 /* For strings from a `display' property, use the face at
3830 IT's current buffer position as the base face to merge
3831 with, so that overlay strings appear in the same face as
3832 surrounding text, unless they specify their own
3834 base_face_id
= it
->string_from_prefix_prop_p
3836 : underlying_face_id (it
);
3839 new_face_id
= face_at_string_position (it
->w
,
3841 IT_STRING_CHARPOS (*it
),
3843 it
->region_beg_charpos
,
3844 it
->region_end_charpos
,
3848 /* Is this a start of a run of characters with box? Caveat:
3849 this can be called for a freshly allocated iterator; face_id
3850 is -1 is this case. We know that the new face will not
3851 change until the next check pos, i.e. if the new face has a
3852 box, all characters up to that position will have a
3853 box. But, as usual, we don't know whether that position
3854 is really the end. */
3855 if (new_face_id
!= it
->face_id
)
3857 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3858 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3860 /* If new face has a box but old face hasn't, this is the
3861 start of a run of characters with box, i.e. it has a
3862 shadow on the left side. */
3863 it
->start_of_box_run_p
3864 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3865 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3869 it
->face_id
= new_face_id
;
3870 return HANDLED_NORMALLY
;
3874 /* Return the ID of the face ``underlying'' IT's current position,
3875 which is in a string. If the iterator is associated with a
3876 buffer, return the face at IT's current buffer position.
3877 Otherwise, use the iterator's base_face_id. */
3880 underlying_face_id (struct it
*it
)
3882 int face_id
= it
->base_face_id
, i
;
3884 eassert (STRINGP (it
->string
));
3886 for (i
= it
->sp
- 1; i
>= 0; --i
)
3887 if (NILP (it
->stack
[i
].string
))
3888 face_id
= it
->stack
[i
].face_id
;
3894 /* Compute the face one character before or after the current position
3895 of IT, in the visual order. BEFORE_P non-zero means get the face
3896 in front (to the left in L2R paragraphs, to the right in R2L
3897 paragraphs) of IT's screen position. Value is the ID of the face. */
3900 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3903 ptrdiff_t next_check_charpos
;
3905 void *it_copy_data
= NULL
;
3907 eassert (it
->s
== NULL
);
3909 if (STRINGP (it
->string
))
3911 ptrdiff_t bufpos
, charpos
;
3914 /* No face change past the end of the string (for the case
3915 we are padding with spaces). No face change before the
3917 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3918 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3923 /* Set charpos to the position before or after IT's current
3924 position, in the logical order, which in the non-bidi
3925 case is the same as the visual order. */
3927 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3928 else if (it
->what
== IT_COMPOSITION
)
3929 /* For composition, we must check the character after the
3931 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3933 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3939 /* With bidi iteration, the character before the current
3940 in the visual order cannot be found by simple
3941 iteration, because "reverse" reordering is not
3942 supported. Instead, we need to use the move_it_*
3943 family of functions. */
3944 /* Ignore face changes before the first visible
3945 character on this display line. */
3946 if (it
->current_x
<= it
->first_visible_x
)
3948 SAVE_IT (it_copy
, *it
, it_copy_data
);
3949 /* Implementation note: Since move_it_in_display_line
3950 works in the iterator geometry, and thinks the first
3951 character is always the leftmost, even in R2L lines,
3952 we don't need to distinguish between the R2L and L2R
3954 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3955 it_copy
.current_x
- 1, MOVE_TO_X
);
3956 charpos
= IT_STRING_CHARPOS (it_copy
);
3957 RESTORE_IT (it
, it
, it_copy_data
);
3961 /* Set charpos to the string position of the character
3962 that comes after IT's current position in the visual
3964 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3968 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3970 charpos
= it_copy
.bidi_it
.charpos
;
3973 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3975 if (it
->current
.overlay_string_index
>= 0)
3976 bufpos
= IT_CHARPOS (*it
);
3980 base_face_id
= underlying_face_id (it
);
3982 /* Get the face for ASCII, or unibyte. */
3983 face_id
= face_at_string_position (it
->w
,
3987 it
->region_beg_charpos
,
3988 it
->region_end_charpos
,
3989 &next_check_charpos
,
3992 /* Correct the face for charsets different from ASCII. Do it
3993 for the multibyte case only. The face returned above is
3994 suitable for unibyte text if IT->string is unibyte. */
3995 if (STRING_MULTIBYTE (it
->string
))
3997 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3998 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4000 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4002 c
= string_char_and_length (p
, &len
);
4003 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4008 struct text_pos pos
;
4010 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4011 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4014 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4015 pos
= it
->current
.pos
;
4020 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4023 if (it
->what
== IT_COMPOSITION
)
4025 /* For composition, we must check the position after
4027 pos
.charpos
+= it
->cmp_it
.nchars
;
4028 pos
.bytepos
+= it
->len
;
4031 INC_TEXT_POS (pos
, it
->multibyte_p
);
4038 /* With bidi iteration, the character before the current
4039 in the visual order cannot be found by simple
4040 iteration, because "reverse" reordering is not
4041 supported. Instead, we need to use the move_it_*
4042 family of functions. */
4043 /* Ignore face changes before the first visible
4044 character on this display line. */
4045 if (it
->current_x
<= it
->first_visible_x
)
4047 SAVE_IT (it_copy
, *it
, it_copy_data
);
4048 /* Implementation note: Since move_it_in_display_line
4049 works in the iterator geometry, and thinks the first
4050 character is always the leftmost, even in R2L lines,
4051 we don't need to distinguish between the R2L and L2R
4053 move_it_in_display_line (&it_copy
, ZV
,
4054 it_copy
.current_x
- 1, MOVE_TO_X
);
4055 pos
= it_copy
.current
.pos
;
4056 RESTORE_IT (it
, it
, it_copy_data
);
4060 /* Set charpos to the buffer position of the character
4061 that comes after IT's current position in the visual
4063 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4067 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4070 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4073 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4075 /* Determine face for CHARSET_ASCII, or unibyte. */
4076 face_id
= face_at_buffer_position (it
->w
,
4078 it
->region_beg_charpos
,
4079 it
->region_end_charpos
,
4080 &next_check_charpos
,
4083 /* Correct the face for charsets different from ASCII. Do it
4084 for the multibyte case only. The face returned above is
4085 suitable for unibyte text if current_buffer is unibyte. */
4086 if (it
->multibyte_p
)
4088 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4089 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4090 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4099 /***********************************************************************
4101 ***********************************************************************/
4103 /* Set up iterator IT from invisible properties at its current
4104 position. Called from handle_stop. */
4106 static enum prop_handled
4107 handle_invisible_prop (struct it
*it
)
4109 enum prop_handled handled
= HANDLED_NORMALLY
;
4113 if (STRINGP (it
->string
))
4115 Lisp_Object end_charpos
, limit
, charpos
;
4117 /* Get the value of the invisible text property at the
4118 current position. Value will be nil if there is no such
4120 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4121 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4122 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4124 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4126 /* Record whether we have to display an ellipsis for the
4128 int display_ellipsis_p
= (invis_p
== 2);
4129 ptrdiff_t len
, endpos
;
4131 handled
= HANDLED_RECOMPUTE_PROPS
;
4133 /* Get the position at which the next visible text can be
4134 found in IT->string, if any. */
4135 endpos
= len
= SCHARS (it
->string
);
4136 XSETINT (limit
, len
);
4139 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4141 if (INTEGERP (end_charpos
))
4143 endpos
= XFASTINT (end_charpos
);
4144 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4145 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4147 display_ellipsis_p
= 1;
4150 while (invis_p
&& endpos
< len
);
4152 if (display_ellipsis_p
)
4157 /* Text at END_CHARPOS is visible. Move IT there. */
4158 struct text_pos old
;
4161 old
= it
->current
.string_pos
;
4162 oldpos
= CHARPOS (old
);
4165 if (it
->bidi_it
.first_elt
4166 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4167 bidi_paragraph_init (it
->paragraph_embedding
,
4169 /* Bidi-iterate out of the invisible text. */
4172 bidi_move_to_visually_next (&it
->bidi_it
);
4174 while (oldpos
<= it
->bidi_it
.charpos
4175 && it
->bidi_it
.charpos
< endpos
);
4177 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4178 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4179 if (IT_CHARPOS (*it
) >= endpos
)
4180 it
->prev_stop
= endpos
;
4184 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4185 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4190 /* The rest of the string is invisible. If this is an
4191 overlay string, proceed with the next overlay string
4192 or whatever comes and return a character from there. */
4193 if (it
->current
.overlay_string_index
>= 0
4194 && !display_ellipsis_p
)
4196 next_overlay_string (it
);
4197 /* Don't check for overlay strings when we just
4198 finished processing them. */
4199 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4203 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4204 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4211 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4212 Lisp_Object pos
, overlay
;
4214 /* First of all, is there invisible text at this position? */
4215 tem
= start_charpos
= IT_CHARPOS (*it
);
4216 pos
= make_number (tem
);
4217 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4219 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4221 /* If we are on invisible text, skip over it. */
4222 if (invis_p
&& start_charpos
< it
->end_charpos
)
4224 /* Record whether we have to display an ellipsis for the
4226 int display_ellipsis_p
= invis_p
== 2;
4228 handled
= HANDLED_RECOMPUTE_PROPS
;
4230 /* Loop skipping over invisible text. The loop is left at
4231 ZV or with IT on the first char being visible again. */
4234 /* Try to skip some invisible text. Return value is the
4235 position reached which can be equal to where we start
4236 if there is nothing invisible there. This skips both
4237 over invisible text properties and overlays with
4238 invisible property. */
4239 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4241 /* If we skipped nothing at all we weren't at invisible
4242 text in the first place. If everything to the end of
4243 the buffer was skipped, end the loop. */
4244 if (newpos
== tem
|| newpos
>= ZV
)
4248 /* We skipped some characters but not necessarily
4249 all there are. Check if we ended up on visible
4250 text. Fget_char_property returns the property of
4251 the char before the given position, i.e. if we
4252 get invis_p = 0, this means that the char at
4253 newpos is visible. */
4254 pos
= make_number (newpos
);
4255 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4256 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4259 /* If we ended up on invisible text, proceed to
4260 skip starting with next_stop. */
4264 /* If there are adjacent invisible texts, don't lose the
4265 second one's ellipsis. */
4267 display_ellipsis_p
= 1;
4271 /* The position newpos is now either ZV or on visible text. */
4274 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4276 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4278 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4280 /* If the invisible text ends on a newline or on a
4281 character after a newline, we can avoid the costly,
4282 character by character, bidi iteration to NEWPOS, and
4283 instead simply reseat the iterator there. That's
4284 because all bidi reordering information is tossed at
4285 the newline. This is a big win for modes that hide
4286 complete lines, like Outline, Org, etc. */
4287 if (on_newline
|| after_newline
)
4289 struct text_pos tpos
;
4290 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4292 SET_TEXT_POS (tpos
, newpos
, bpos
);
4293 reseat_1 (it
, tpos
, 0);
4294 /* If we reseat on a newline/ZV, we need to prep the
4295 bidi iterator for advancing to the next character
4296 after the newline/EOB, keeping the current paragraph
4297 direction (so that PRODUCE_GLYPHS does TRT wrt
4298 prepending/appending glyphs to a glyph row). */
4301 it
->bidi_it
.first_elt
= 0;
4302 it
->bidi_it
.paragraph_dir
= pdir
;
4303 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4304 it
->bidi_it
.nchars
= 1;
4305 it
->bidi_it
.ch_len
= 1;
4308 else /* Must use the slow method. */
4310 /* With bidi iteration, the region of invisible text
4311 could start and/or end in the middle of a
4312 non-base embedding level. Therefore, we need to
4313 skip invisible text using the bidi iterator,
4314 starting at IT's current position, until we find
4315 ourselves outside of the invisible text.
4316 Skipping invisible text _after_ bidi iteration
4317 avoids affecting the visual order of the
4318 displayed text when invisible properties are
4319 added or removed. */
4320 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4322 /* If we were `reseat'ed to a new paragraph,
4323 determine the paragraph base direction. We
4324 need to do it now because
4325 next_element_from_buffer may not have a
4326 chance to do it, if we are going to skip any
4327 text at the beginning, which resets the
4329 bidi_paragraph_init (it
->paragraph_embedding
,
4334 bidi_move_to_visually_next (&it
->bidi_it
);
4336 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4337 && it
->bidi_it
.charpos
< newpos
);
4338 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4339 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4340 /* If we overstepped NEWPOS, record its position in
4341 the iterator, so that we skip invisible text if
4342 later the bidi iteration lands us in the
4343 invisible region again. */
4344 if (IT_CHARPOS (*it
) >= newpos
)
4345 it
->prev_stop
= newpos
;
4350 IT_CHARPOS (*it
) = newpos
;
4351 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4354 /* If there are before-strings at the start of invisible
4355 text, and the text is invisible because of a text
4356 property, arrange to show before-strings because 20.x did
4357 it that way. (If the text is invisible because of an
4358 overlay property instead of a text property, this is
4359 already handled in the overlay code.) */
4361 && get_overlay_strings (it
, it
->stop_charpos
))
4363 handled
= HANDLED_RECOMPUTE_PROPS
;
4364 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4366 else if (display_ellipsis_p
)
4368 /* Make sure that the glyphs of the ellipsis will get
4369 correct `charpos' values. If we would not update
4370 it->position here, the glyphs would belong to the
4371 last visible character _before_ the invisible
4372 text, which confuses `set_cursor_from_row'.
4374 We use the last invisible position instead of the
4375 first because this way the cursor is always drawn on
4376 the first "." of the ellipsis, whenever PT is inside
4377 the invisible text. Otherwise the cursor would be
4378 placed _after_ the ellipsis when the point is after the
4379 first invisible character. */
4380 if (!STRINGP (it
->object
))
4382 it
->position
.charpos
= newpos
- 1;
4383 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4386 /* Let the ellipsis display before
4387 considering any properties of the following char.
4388 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4389 handled
= HANDLED_RETURN
;
4398 /* Make iterator IT return `...' next.
4399 Replaces LEN characters from buffer. */
4402 setup_for_ellipsis (struct it
*it
, int len
)
4404 /* Use the display table definition for `...'. Invalid glyphs
4405 will be handled by the method returning elements from dpvec. */
4406 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4408 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4409 it
->dpvec
= v
->contents
;
4410 it
->dpend
= v
->contents
+ v
->header
.size
;
4414 /* Default `...'. */
4415 it
->dpvec
= default_invis_vector
;
4416 it
->dpend
= default_invis_vector
+ 3;
4419 it
->dpvec_char_len
= len
;
4420 it
->current
.dpvec_index
= 0;
4421 it
->dpvec_face_id
= -1;
4423 /* Remember the current face id in case glyphs specify faces.
4424 IT's face is restored in set_iterator_to_next.
4425 saved_face_id was set to preceding char's face in handle_stop. */
4426 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4427 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4429 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4435 /***********************************************************************
4437 ***********************************************************************/
4439 /* Set up iterator IT from `display' property at its current position.
4440 Called from handle_stop.
4441 We return HANDLED_RETURN if some part of the display property
4442 overrides the display of the buffer text itself.
4443 Otherwise we return HANDLED_NORMALLY. */
4445 static enum prop_handled
4446 handle_display_prop (struct it
*it
)
4448 Lisp_Object propval
, object
, overlay
;
4449 struct text_pos
*position
;
4451 /* Nonzero if some property replaces the display of the text itself. */
4452 int display_replaced_p
= 0;
4454 if (STRINGP (it
->string
))
4456 object
= it
->string
;
4457 position
= &it
->current
.string_pos
;
4458 bufpos
= CHARPOS (it
->current
.pos
);
4462 XSETWINDOW (object
, it
->w
);
4463 position
= &it
->current
.pos
;
4464 bufpos
= CHARPOS (*position
);
4467 /* Reset those iterator values set from display property values. */
4468 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4469 it
->space_width
= Qnil
;
4470 it
->font_height
= Qnil
;
4473 /* We don't support recursive `display' properties, i.e. string
4474 values that have a string `display' property, that have a string
4475 `display' property etc. */
4476 if (!it
->string_from_display_prop_p
)
4477 it
->area
= TEXT_AREA
;
4479 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4480 Qdisplay
, object
, &overlay
);
4482 return HANDLED_NORMALLY
;
4483 /* Now OVERLAY is the overlay that gave us this property, or nil
4484 if it was a text property. */
4486 if (!STRINGP (it
->string
))
4487 object
= it
->w
->buffer
;
4489 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4491 FRAME_WINDOW_P (it
->f
));
4493 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4496 /* Subroutine of handle_display_prop. Returns non-zero if the display
4497 specification in SPEC is a replacing specification, i.e. it would
4498 replace the text covered by `display' property with something else,
4499 such as an image or a display string. If SPEC includes any kind or
4500 `(space ...) specification, the value is 2; this is used by
4501 compute_display_string_pos, which see.
4503 See handle_single_display_spec for documentation of arguments.
4504 frame_window_p is non-zero if the window being redisplayed is on a
4505 GUI frame; this argument is used only if IT is NULL, see below.
4507 IT can be NULL, if this is called by the bidi reordering code
4508 through compute_display_string_pos, which see. In that case, this
4509 function only examines SPEC, but does not otherwise "handle" it, in
4510 the sense that it doesn't set up members of IT from the display
4513 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4514 Lisp_Object overlay
, struct text_pos
*position
,
4515 ptrdiff_t bufpos
, int frame_window_p
)
4517 int replacing_p
= 0;
4521 /* Simple specifications. */
4522 && !EQ (XCAR (spec
), Qimage
)
4523 && !EQ (XCAR (spec
), Qspace
)
4524 && !EQ (XCAR (spec
), Qwhen
)
4525 && !EQ (XCAR (spec
), Qslice
)
4526 && !EQ (XCAR (spec
), Qspace_width
)
4527 && !EQ (XCAR (spec
), Qheight
)
4528 && !EQ (XCAR (spec
), Qraise
)
4529 /* Marginal area specifications. */
4530 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4531 && !EQ (XCAR (spec
), Qleft_fringe
)
4532 && !EQ (XCAR (spec
), Qright_fringe
)
4533 && !NILP (XCAR (spec
)))
4535 for (; CONSP (spec
); spec
= XCDR (spec
))
4537 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4538 overlay
, position
, bufpos
,
4539 replacing_p
, frame_window_p
)))
4542 /* If some text in a string is replaced, `position' no
4543 longer points to the position of `object'. */
4544 if (!it
|| STRINGP (object
))
4549 else if (VECTORP (spec
))
4552 for (i
= 0; i
< ASIZE (spec
); ++i
)
4553 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4554 overlay
, position
, bufpos
,
4555 replacing_p
, frame_window_p
)))
4558 /* If some text in a string is replaced, `position' no
4559 longer points to the position of `object'. */
4560 if (!it
|| STRINGP (object
))
4566 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4567 position
, bufpos
, 0,
4575 /* Value is the position of the end of the `display' property starting
4576 at START_POS in OBJECT. */
4578 static struct text_pos
4579 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4582 struct text_pos end_pos
;
4584 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4585 Qdisplay
, object
, Qnil
);
4586 CHARPOS (end_pos
) = XFASTINT (end
);
4587 if (STRINGP (object
))
4588 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4590 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4596 /* Set up IT from a single `display' property specification SPEC. OBJECT
4597 is the object in which the `display' property was found. *POSITION
4598 is the position in OBJECT at which the `display' property was found.
4599 BUFPOS is the buffer position of OBJECT (different from POSITION if
4600 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4601 previously saw a display specification which already replaced text
4602 display with something else, for example an image; we ignore such
4603 properties after the first one has been processed.
4605 OVERLAY is the overlay this `display' property came from,
4606 or nil if it was a text property.
4608 If SPEC is a `space' or `image' specification, and in some other
4609 cases too, set *POSITION to the position where the `display'
4612 If IT is NULL, only examine the property specification in SPEC, but
4613 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4614 is intended to be displayed in a window on a GUI frame.
4616 Value is non-zero if something was found which replaces the display
4617 of buffer or string text. */
4620 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4621 Lisp_Object overlay
, struct text_pos
*position
,
4622 ptrdiff_t bufpos
, int display_replaced_p
,
4626 Lisp_Object location
, value
;
4627 struct text_pos start_pos
= *position
;
4630 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4631 If the result is non-nil, use VALUE instead of SPEC. */
4633 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4642 if (!NILP (form
) && !EQ (form
, Qt
))
4644 ptrdiff_t count
= SPECPDL_INDEX ();
4645 struct gcpro gcpro1
;
4647 /* Bind `object' to the object having the `display' property, a
4648 buffer or string. Bind `position' to the position in the
4649 object where the property was found, and `buffer-position'
4650 to the current position in the buffer. */
4653 XSETBUFFER (object
, current_buffer
);
4654 specbind (Qobject
, object
);
4655 specbind (Qposition
, make_number (CHARPOS (*position
)));
4656 specbind (Qbuffer_position
, make_number (bufpos
));
4658 form
= safe_eval (form
);
4660 unbind_to (count
, Qnil
);
4666 /* Handle `(height HEIGHT)' specifications. */
4668 && EQ (XCAR (spec
), Qheight
)
4669 && CONSP (XCDR (spec
)))
4673 if (!FRAME_WINDOW_P (it
->f
))
4676 it
->font_height
= XCAR (XCDR (spec
));
4677 if (!NILP (it
->font_height
))
4679 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4680 int new_height
= -1;
4682 if (CONSP (it
->font_height
)
4683 && (EQ (XCAR (it
->font_height
), Qplus
)
4684 || EQ (XCAR (it
->font_height
), Qminus
))
4685 && CONSP (XCDR (it
->font_height
))
4686 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4688 /* `(+ N)' or `(- N)' where N is an integer. */
4689 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4690 if (EQ (XCAR (it
->font_height
), Qplus
))
4692 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4694 else if (FUNCTIONP (it
->font_height
))
4696 /* Call function with current height as argument.
4697 Value is the new height. */
4699 height
= safe_call1 (it
->font_height
,
4700 face
->lface
[LFACE_HEIGHT_INDEX
]);
4701 if (NUMBERP (height
))
4702 new_height
= XFLOATINT (height
);
4704 else if (NUMBERP (it
->font_height
))
4706 /* Value is a multiple of the canonical char height. */
4709 f
= FACE_FROM_ID (it
->f
,
4710 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4711 new_height
= (XFLOATINT (it
->font_height
)
4712 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4716 /* Evaluate IT->font_height with `height' bound to the
4717 current specified height to get the new height. */
4718 ptrdiff_t count
= SPECPDL_INDEX ();
4720 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4721 value
= safe_eval (it
->font_height
);
4722 unbind_to (count
, Qnil
);
4724 if (NUMBERP (value
))
4725 new_height
= XFLOATINT (value
);
4729 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4736 /* Handle `(space-width WIDTH)'. */
4738 && EQ (XCAR (spec
), Qspace_width
)
4739 && CONSP (XCDR (spec
)))
4743 if (!FRAME_WINDOW_P (it
->f
))
4746 value
= XCAR (XCDR (spec
));
4747 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4748 it
->space_width
= value
;
4754 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4756 && EQ (XCAR (spec
), Qslice
))
4762 if (!FRAME_WINDOW_P (it
->f
))
4765 if (tem
= XCDR (spec
), CONSP (tem
))
4767 it
->slice
.x
= XCAR (tem
);
4768 if (tem
= XCDR (tem
), CONSP (tem
))
4770 it
->slice
.y
= XCAR (tem
);
4771 if (tem
= XCDR (tem
), CONSP (tem
))
4773 it
->slice
.width
= XCAR (tem
);
4774 if (tem
= XCDR (tem
), CONSP (tem
))
4775 it
->slice
.height
= XCAR (tem
);
4784 /* Handle `(raise FACTOR)'. */
4786 && EQ (XCAR (spec
), Qraise
)
4787 && CONSP (XCDR (spec
)))
4791 if (!FRAME_WINDOW_P (it
->f
))
4794 #ifdef HAVE_WINDOW_SYSTEM
4795 value
= XCAR (XCDR (spec
));
4796 if (NUMBERP (value
))
4798 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4799 it
->voffset
= - (XFLOATINT (value
)
4800 * (FONT_HEIGHT (face
->font
)));
4802 #endif /* HAVE_WINDOW_SYSTEM */
4808 /* Don't handle the other kinds of display specifications
4809 inside a string that we got from a `display' property. */
4810 if (it
&& it
->string_from_display_prop_p
)
4813 /* Characters having this form of property are not displayed, so
4814 we have to find the end of the property. */
4817 start_pos
= *position
;
4818 *position
= display_prop_end (it
, object
, start_pos
);
4822 /* Stop the scan at that end position--we assume that all
4823 text properties change there. */
4825 it
->stop_charpos
= position
->charpos
;
4827 /* Handle `(left-fringe BITMAP [FACE])'
4828 and `(right-fringe BITMAP [FACE])'. */
4830 && (EQ (XCAR (spec
), Qleft_fringe
)
4831 || EQ (XCAR (spec
), Qright_fringe
))
4832 && CONSP (XCDR (spec
)))
4838 if (!FRAME_WINDOW_P (it
->f
))
4839 /* If we return here, POSITION has been advanced
4840 across the text with this property. */
4842 /* Synchronize the bidi iterator with POSITION. This is
4843 needed because we are not going to push the iterator
4844 on behalf of this display property, so there will be
4845 no pop_it call to do this synchronization for us. */
4848 it
->position
= *position
;
4849 iterate_out_of_display_property (it
);
4850 *position
= it
->position
;
4855 else if (!frame_window_p
)
4858 #ifdef HAVE_WINDOW_SYSTEM
4859 value
= XCAR (XCDR (spec
));
4860 if (!SYMBOLP (value
)
4861 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4862 /* If we return here, POSITION has been advanced
4863 across the text with this property. */
4865 if (it
&& it
->bidi_p
)
4867 it
->position
= *position
;
4868 iterate_out_of_display_property (it
);
4869 *position
= it
->position
;
4876 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4878 if (CONSP (XCDR (XCDR (spec
))))
4880 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4881 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4887 /* Save current settings of IT so that we can restore them
4888 when we are finished with the glyph property value. */
4889 push_it (it
, position
);
4891 it
->area
= TEXT_AREA
;
4892 it
->what
= IT_IMAGE
;
4893 it
->image_id
= -1; /* no image */
4894 it
->position
= start_pos
;
4895 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4896 it
->method
= GET_FROM_IMAGE
;
4897 it
->from_overlay
= Qnil
;
4898 it
->face_id
= face_id
;
4899 it
->from_disp_prop_p
= 1;
4901 /* Say that we haven't consumed the characters with
4902 `display' property yet. The call to pop_it in
4903 set_iterator_to_next will clean this up. */
4904 *position
= start_pos
;
4906 if (EQ (XCAR (spec
), Qleft_fringe
))
4908 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4909 it
->left_user_fringe_face_id
= face_id
;
4913 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4914 it
->right_user_fringe_face_id
= face_id
;
4917 #endif /* HAVE_WINDOW_SYSTEM */
4921 /* Prepare to handle `((margin left-margin) ...)',
4922 `((margin right-margin) ...)' and `((margin nil) ...)'
4923 prefixes for display specifications. */
4924 location
= Qunbound
;
4925 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4929 value
= XCDR (spec
);
4931 value
= XCAR (value
);
4934 if (EQ (XCAR (tem
), Qmargin
)
4935 && (tem
= XCDR (tem
),
4936 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4938 || EQ (tem
, Qleft_margin
)
4939 || EQ (tem
, Qright_margin
))))
4943 if (EQ (location
, Qunbound
))
4949 /* After this point, VALUE is the property after any
4950 margin prefix has been stripped. It must be a string,
4951 an image specification, or `(space ...)'.
4953 LOCATION specifies where to display: `left-margin',
4954 `right-margin' or nil. */
4956 valid_p
= (STRINGP (value
)
4957 #ifdef HAVE_WINDOW_SYSTEM
4958 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4959 && valid_image_p (value
))
4960 #endif /* not HAVE_WINDOW_SYSTEM */
4961 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4963 if (valid_p
&& !display_replaced_p
)
4969 /* Callers need to know whether the display spec is any kind
4970 of `(space ...)' spec that is about to affect text-area
4972 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4977 /* Save current settings of IT so that we can restore them
4978 when we are finished with the glyph property value. */
4979 push_it (it
, position
);
4980 it
->from_overlay
= overlay
;
4981 it
->from_disp_prop_p
= 1;
4983 if (NILP (location
))
4984 it
->area
= TEXT_AREA
;
4985 else if (EQ (location
, Qleft_margin
))
4986 it
->area
= LEFT_MARGIN_AREA
;
4988 it
->area
= RIGHT_MARGIN_AREA
;
4990 if (STRINGP (value
))
4993 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4994 it
->current
.overlay_string_index
= -1;
4995 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4996 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4997 it
->method
= GET_FROM_STRING
;
4998 it
->stop_charpos
= 0;
5000 it
->base_level_stop
= 0;
5001 it
->string_from_display_prop_p
= 1;
5002 /* Say that we haven't consumed the characters with
5003 `display' property yet. The call to pop_it in
5004 set_iterator_to_next will clean this up. */
5005 if (BUFFERP (object
))
5006 *position
= start_pos
;
5008 /* Force paragraph direction to be that of the parent
5009 object. If the parent object's paragraph direction is
5010 not yet determined, default to L2R. */
5011 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5012 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5014 it
->paragraph_embedding
= L2R
;
5016 /* Set up the bidi iterator for this display string. */
5019 it
->bidi_it
.string
.lstring
= it
->string
;
5020 it
->bidi_it
.string
.s
= NULL
;
5021 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5022 it
->bidi_it
.string
.bufpos
= bufpos
;
5023 it
->bidi_it
.string
.from_disp_str
= 1;
5024 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5025 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5028 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5030 it
->method
= GET_FROM_STRETCH
;
5032 *position
= it
->position
= start_pos
;
5033 retval
= 1 + (it
->area
== TEXT_AREA
);
5035 #ifdef HAVE_WINDOW_SYSTEM
5038 it
->what
= IT_IMAGE
;
5039 it
->image_id
= lookup_image (it
->f
, value
);
5040 it
->position
= start_pos
;
5041 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
5042 it
->method
= GET_FROM_IMAGE
;
5044 /* Say that we haven't consumed the characters with
5045 `display' property yet. The call to pop_it in
5046 set_iterator_to_next will clean this up. */
5047 *position
= start_pos
;
5049 #endif /* HAVE_WINDOW_SYSTEM */
5054 /* Invalid property or property not supported. Restore
5055 POSITION to what it was before. */
5056 *position
= start_pos
;
5060 /* Check if PROP is a display property value whose text should be
5061 treated as intangible. OVERLAY is the overlay from which PROP
5062 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5063 specify the buffer position covered by PROP. */
5066 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5067 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5069 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5070 struct text_pos position
;
5072 SET_TEXT_POS (position
, charpos
, bytepos
);
5073 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5074 &position
, charpos
, frame_window_p
);
5078 /* Return 1 if PROP is a display sub-property value containing STRING.
5080 Implementation note: this and the following function are really
5081 special cases of handle_display_spec and
5082 handle_single_display_spec, and should ideally use the same code.
5083 Until they do, these two pairs must be consistent and must be
5084 modified in sync. */
5087 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5089 if (EQ (string
, prop
))
5092 /* Skip over `when FORM'. */
5093 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5098 /* Actually, the condition following `when' should be eval'ed,
5099 like handle_single_display_spec does, and we should return
5100 zero if it evaluates to nil. However, this function is
5101 called only when the buffer was already displayed and some
5102 glyph in the glyph matrix was found to come from a display
5103 string. Therefore, the condition was already evaluated, and
5104 the result was non-nil, otherwise the display string wouldn't
5105 have been displayed and we would have never been called for
5106 this property. Thus, we can skip the evaluation and assume
5107 its result is non-nil. */
5112 /* Skip over `margin LOCATION'. */
5113 if (EQ (XCAR (prop
), Qmargin
))
5124 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5128 /* Return 1 if STRING appears in the `display' property PROP. */
5131 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5134 && !EQ (XCAR (prop
), Qwhen
)
5135 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5137 /* A list of sub-properties. */
5138 while (CONSP (prop
))
5140 if (single_display_spec_string_p (XCAR (prop
), string
))
5145 else if (VECTORP (prop
))
5147 /* A vector of sub-properties. */
5149 for (i
= 0; i
< ASIZE (prop
); ++i
)
5150 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5154 return single_display_spec_string_p (prop
, string
);
5159 /* Look for STRING in overlays and text properties in the current
5160 buffer, between character positions FROM and TO (excluding TO).
5161 BACK_P non-zero means look back (in this case, TO is supposed to be
5163 Value is the first character position where STRING was found, or
5164 zero if it wasn't found before hitting TO.
5166 This function may only use code that doesn't eval because it is
5167 called asynchronously from note_mouse_highlight. */
5170 string_buffer_position_lim (Lisp_Object string
,
5171 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5173 Lisp_Object limit
, prop
, pos
;
5176 pos
= make_number (max (from
, BEGV
));
5178 if (!back_p
) /* looking forward */
5180 limit
= make_number (min (to
, ZV
));
5181 while (!found
&& !EQ (pos
, limit
))
5183 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5184 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5187 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5191 else /* looking back */
5193 limit
= make_number (max (to
, BEGV
));
5194 while (!found
&& !EQ (pos
, limit
))
5196 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5197 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5200 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5205 return found
? XINT (pos
) : 0;
5208 /* Determine which buffer position in current buffer STRING comes from.
5209 AROUND_CHARPOS is an approximate position where it could come from.
5210 Value is the buffer position or 0 if it couldn't be determined.
5212 This function is necessary because we don't record buffer positions
5213 in glyphs generated from strings (to keep struct glyph small).
5214 This function may only use code that doesn't eval because it is
5215 called asynchronously from note_mouse_highlight. */
5218 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5220 const int MAX_DISTANCE
= 1000;
5221 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5222 around_charpos
+ MAX_DISTANCE
,
5226 found
= string_buffer_position_lim (string
, around_charpos
,
5227 around_charpos
- MAX_DISTANCE
, 1);
5233 /***********************************************************************
5234 `composition' property
5235 ***********************************************************************/
5237 /* Set up iterator IT from `composition' property at its current
5238 position. Called from handle_stop. */
5240 static enum prop_handled
5241 handle_composition_prop (struct it
*it
)
5243 Lisp_Object prop
, string
;
5244 ptrdiff_t pos
, pos_byte
, start
, end
;
5246 if (STRINGP (it
->string
))
5250 pos
= IT_STRING_CHARPOS (*it
);
5251 pos_byte
= IT_STRING_BYTEPOS (*it
);
5252 string
= it
->string
;
5253 s
= SDATA (string
) + pos_byte
;
5254 it
->c
= STRING_CHAR (s
);
5258 pos
= IT_CHARPOS (*it
);
5259 pos_byte
= IT_BYTEPOS (*it
);
5261 it
->c
= FETCH_CHAR (pos_byte
);
5264 /* If there's a valid composition and point is not inside of the
5265 composition (in the case that the composition is from the current
5266 buffer), draw a glyph composed from the composition components. */
5267 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5268 && COMPOSITION_VALID_P (start
, end
, prop
)
5269 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5272 /* As we can't handle this situation (perhaps font-lock added
5273 a new composition), we just return here hoping that next
5274 redisplay will detect this composition much earlier. */
5275 return HANDLED_NORMALLY
;
5278 if (STRINGP (it
->string
))
5279 pos_byte
= string_char_to_byte (it
->string
, start
);
5281 pos_byte
= CHAR_TO_BYTE (start
);
5283 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5286 if (it
->cmp_it
.id
>= 0)
5289 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5290 it
->cmp_it
.nglyphs
= -1;
5294 return HANDLED_NORMALLY
;
5299 /***********************************************************************
5301 ***********************************************************************/
5303 /* The following structure is used to record overlay strings for
5304 later sorting in load_overlay_strings. */
5306 struct overlay_entry
5308 Lisp_Object overlay
;
5315 /* Set up iterator IT from overlay strings at its current position.
5316 Called from handle_stop. */
5318 static enum prop_handled
5319 handle_overlay_change (struct it
*it
)
5321 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5322 return HANDLED_RECOMPUTE_PROPS
;
5324 return HANDLED_NORMALLY
;
5328 /* Set up the next overlay string for delivery by IT, if there is an
5329 overlay string to deliver. Called by set_iterator_to_next when the
5330 end of the current overlay string is reached. If there are more
5331 overlay strings to display, IT->string and
5332 IT->current.overlay_string_index are set appropriately here.
5333 Otherwise IT->string is set to nil. */
5336 next_overlay_string (struct it
*it
)
5338 ++it
->current
.overlay_string_index
;
5339 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5341 /* No more overlay strings. Restore IT's settings to what
5342 they were before overlay strings were processed, and
5343 continue to deliver from current_buffer. */
5345 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5348 || (NILP (it
->string
)
5349 && it
->method
== GET_FROM_BUFFER
5350 && it
->stop_charpos
>= BEGV
5351 && it
->stop_charpos
<= it
->end_charpos
));
5352 it
->current
.overlay_string_index
= -1;
5353 it
->n_overlay_strings
= 0;
5354 it
->overlay_strings_charpos
= -1;
5355 /* If there's an empty display string on the stack, pop the
5356 stack, to resync the bidi iterator with IT's position. Such
5357 empty strings are pushed onto the stack in
5358 get_overlay_strings_1. */
5359 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5362 /* If we're at the end of the buffer, record that we have
5363 processed the overlay strings there already, so that
5364 next_element_from_buffer doesn't try it again. */
5365 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5366 it
->overlay_strings_at_end_processed_p
= 1;
5370 /* There are more overlay strings to process. If
5371 IT->current.overlay_string_index has advanced to a position
5372 where we must load IT->overlay_strings with more strings, do
5373 it. We must load at the IT->overlay_strings_charpos where
5374 IT->n_overlay_strings was originally computed; when invisible
5375 text is present, this might not be IT_CHARPOS (Bug#7016). */
5376 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5378 if (it
->current
.overlay_string_index
&& i
== 0)
5379 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5381 /* Initialize IT to deliver display elements from the overlay
5383 it
->string
= it
->overlay_strings
[i
];
5384 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5385 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5386 it
->method
= GET_FROM_STRING
;
5387 it
->stop_charpos
= 0;
5388 it
->end_charpos
= SCHARS (it
->string
);
5389 if (it
->cmp_it
.stop_pos
>= 0)
5390 it
->cmp_it
.stop_pos
= 0;
5392 it
->base_level_stop
= 0;
5394 /* Set up the bidi iterator for this overlay string. */
5397 it
->bidi_it
.string
.lstring
= it
->string
;
5398 it
->bidi_it
.string
.s
= NULL
;
5399 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5400 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5401 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5402 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5403 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5411 /* Compare two overlay_entry structures E1 and E2. Used as a
5412 comparison function for qsort in load_overlay_strings. Overlay
5413 strings for the same position are sorted so that
5415 1. All after-strings come in front of before-strings, except
5416 when they come from the same overlay.
5418 2. Within after-strings, strings are sorted so that overlay strings
5419 from overlays with higher priorities come first.
5421 2. Within before-strings, strings are sorted so that overlay
5422 strings from overlays with higher priorities come last.
5424 Value is analogous to strcmp. */
5428 compare_overlay_entries (const void *e1
, const void *e2
)
5430 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5431 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5434 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5436 /* Let after-strings appear in front of before-strings if
5437 they come from different overlays. */
5438 if (EQ (entry1
->overlay
, entry2
->overlay
))
5439 result
= entry1
->after_string_p
? 1 : -1;
5441 result
= entry1
->after_string_p
? -1 : 1;
5443 else if (entry1
->priority
!= entry2
->priority
)
5445 if (entry1
->after_string_p
)
5446 /* After-strings sorted in order of decreasing priority. */
5447 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5449 /* Before-strings sorted in order of increasing priority. */
5450 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5459 /* Load the vector IT->overlay_strings with overlay strings from IT's
5460 current buffer position, or from CHARPOS if that is > 0. Set
5461 IT->n_overlays to the total number of overlay strings found.
5463 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5464 a time. On entry into load_overlay_strings,
5465 IT->current.overlay_string_index gives the number of overlay
5466 strings that have already been loaded by previous calls to this
5469 IT->add_overlay_start contains an additional overlay start
5470 position to consider for taking overlay strings from, if non-zero.
5471 This position comes into play when the overlay has an `invisible'
5472 property, and both before and after-strings. When we've skipped to
5473 the end of the overlay, because of its `invisible' property, we
5474 nevertheless want its before-string to appear.
5475 IT->add_overlay_start will contain the overlay start position
5478 Overlay strings are sorted so that after-string strings come in
5479 front of before-string strings. Within before and after-strings,
5480 strings are sorted by overlay priority. See also function
5481 compare_overlay_entries. */
5484 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5486 Lisp_Object overlay
, window
, str
, invisible
;
5487 struct Lisp_Overlay
*ov
;
5488 ptrdiff_t start
, end
;
5489 ptrdiff_t size
= 20;
5490 ptrdiff_t n
= 0, i
, j
;
5492 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5496 charpos
= IT_CHARPOS (*it
);
5498 /* Append the overlay string STRING of overlay OVERLAY to vector
5499 `entries' which has size `size' and currently contains `n'
5500 elements. AFTER_P non-zero means STRING is an after-string of
5502 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5505 Lisp_Object priority; \
5509 struct overlay_entry *old = entries; \
5510 SAFE_NALLOCA (entries, 2, size); \
5511 memcpy (entries, old, size * sizeof *entries); \
5515 entries[n].string = (STRING); \
5516 entries[n].overlay = (OVERLAY); \
5517 priority = Foverlay_get ((OVERLAY), Qpriority); \
5518 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5519 entries[n].after_string_p = (AFTER_P); \
5524 /* Process overlay before the overlay center. */
5525 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5527 XSETMISC (overlay
, ov
);
5528 eassert (OVERLAYP (overlay
));
5529 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5530 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5535 /* Skip this overlay if it doesn't start or end at IT's current
5537 if (end
!= charpos
&& start
!= charpos
)
5540 /* Skip this overlay if it doesn't apply to IT->w. */
5541 window
= Foverlay_get (overlay
, Qwindow
);
5542 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5545 /* If the text ``under'' the overlay is invisible, both before-
5546 and after-strings from this overlay are visible; start and
5547 end position are indistinguishable. */
5548 invisible
= Foverlay_get (overlay
, Qinvisible
);
5549 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5551 /* If overlay has a non-empty before-string, record it. */
5552 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5553 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5555 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5557 /* If overlay has a non-empty after-string, record it. */
5558 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5559 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5561 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5564 /* Process overlays after the overlay center. */
5565 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5567 XSETMISC (overlay
, ov
);
5568 eassert (OVERLAYP (overlay
));
5569 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5570 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5572 if (start
> charpos
)
5575 /* Skip this overlay if it doesn't start or end at IT's current
5577 if (end
!= charpos
&& start
!= charpos
)
5580 /* Skip this overlay if it doesn't apply to IT->w. */
5581 window
= Foverlay_get (overlay
, Qwindow
);
5582 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5585 /* If the text ``under'' the overlay is invisible, it has a zero
5586 dimension, and both before- and after-strings apply. */
5587 invisible
= Foverlay_get (overlay
, Qinvisible
);
5588 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5590 /* If overlay has a non-empty before-string, record it. */
5591 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5592 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5594 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5596 /* If overlay has a non-empty after-string, record it. */
5597 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5598 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5600 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5603 #undef RECORD_OVERLAY_STRING
5607 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5609 /* Record number of overlay strings, and where we computed it. */
5610 it
->n_overlay_strings
= n
;
5611 it
->overlay_strings_charpos
= charpos
;
5613 /* IT->current.overlay_string_index is the number of overlay strings
5614 that have already been consumed by IT. Copy some of the
5615 remaining overlay strings to IT->overlay_strings. */
5617 j
= it
->current
.overlay_string_index
;
5618 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5620 it
->overlay_strings
[i
] = entries
[j
].string
;
5621 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5629 /* Get the first chunk of overlay strings at IT's current buffer
5630 position, or at CHARPOS if that is > 0. Value is non-zero if at
5631 least one overlay string was found. */
5634 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5636 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5637 process. This fills IT->overlay_strings with strings, and sets
5638 IT->n_overlay_strings to the total number of strings to process.
5639 IT->pos.overlay_string_index has to be set temporarily to zero
5640 because load_overlay_strings needs this; it must be set to -1
5641 when no overlay strings are found because a zero value would
5642 indicate a position in the first overlay string. */
5643 it
->current
.overlay_string_index
= 0;
5644 load_overlay_strings (it
, charpos
);
5646 /* If we found overlay strings, set up IT to deliver display
5647 elements from the first one. Otherwise set up IT to deliver
5648 from current_buffer. */
5649 if (it
->n_overlay_strings
)
5651 /* Make sure we know settings in current_buffer, so that we can
5652 restore meaningful values when we're done with the overlay
5655 compute_stop_pos (it
);
5656 eassert (it
->face_id
>= 0);
5658 /* Save IT's settings. They are restored after all overlay
5659 strings have been processed. */
5660 eassert (!compute_stop_p
|| it
->sp
== 0);
5662 /* When called from handle_stop, there might be an empty display
5663 string loaded. In that case, don't bother saving it. But
5664 don't use this optimization with the bidi iterator, since we
5665 need the corresponding pop_it call to resync the bidi
5666 iterator's position with IT's position, after we are done
5667 with the overlay strings. (The corresponding call to pop_it
5668 in case of an empty display string is in
5669 next_overlay_string.) */
5671 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5674 /* Set up IT to deliver display elements from the first overlay
5676 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5677 it
->string
= it
->overlay_strings
[0];
5678 it
->from_overlay
= Qnil
;
5679 it
->stop_charpos
= 0;
5680 eassert (STRINGP (it
->string
));
5681 it
->end_charpos
= SCHARS (it
->string
);
5683 it
->base_level_stop
= 0;
5684 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5685 it
->method
= GET_FROM_STRING
;
5686 it
->from_disp_prop_p
= 0;
5688 /* Force paragraph direction to be that of the parent
5690 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5691 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5693 it
->paragraph_embedding
= L2R
;
5695 /* Set up the bidi iterator for this overlay string. */
5698 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5700 it
->bidi_it
.string
.lstring
= it
->string
;
5701 it
->bidi_it
.string
.s
= NULL
;
5702 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5703 it
->bidi_it
.string
.bufpos
= pos
;
5704 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5705 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5706 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5711 it
->current
.overlay_string_index
= -1;
5716 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5719 it
->method
= GET_FROM_BUFFER
;
5721 (void) get_overlay_strings_1 (it
, charpos
, 1);
5725 /* Value is non-zero if we found at least one overlay string. */
5726 return STRINGP (it
->string
);
5731 /***********************************************************************
5732 Saving and restoring state
5733 ***********************************************************************/
5735 /* Save current settings of IT on IT->stack. Called, for example,
5736 before setting up IT for an overlay string, to be able to restore
5737 IT's settings to what they were after the overlay string has been
5738 processed. If POSITION is non-NULL, it is the position to save on
5739 the stack instead of IT->position. */
5742 push_it (struct it
*it
, struct text_pos
*position
)
5744 struct iterator_stack_entry
*p
;
5746 eassert (it
->sp
< IT_STACK_SIZE
);
5747 p
= it
->stack
+ it
->sp
;
5749 p
->stop_charpos
= it
->stop_charpos
;
5750 p
->prev_stop
= it
->prev_stop
;
5751 p
->base_level_stop
= it
->base_level_stop
;
5752 p
->cmp_it
= it
->cmp_it
;
5753 eassert (it
->face_id
>= 0);
5754 p
->face_id
= it
->face_id
;
5755 p
->string
= it
->string
;
5756 p
->method
= it
->method
;
5757 p
->from_overlay
= it
->from_overlay
;
5760 case GET_FROM_IMAGE
:
5761 p
->u
.image
.object
= it
->object
;
5762 p
->u
.image
.image_id
= it
->image_id
;
5763 p
->u
.image
.slice
= it
->slice
;
5765 case GET_FROM_STRETCH
:
5766 p
->u
.stretch
.object
= it
->object
;
5769 p
->position
= position
? *position
: it
->position
;
5770 p
->current
= it
->current
;
5771 p
->end_charpos
= it
->end_charpos
;
5772 p
->string_nchars
= it
->string_nchars
;
5774 p
->multibyte_p
= it
->multibyte_p
;
5775 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5776 p
->space_width
= it
->space_width
;
5777 p
->font_height
= it
->font_height
;
5778 p
->voffset
= it
->voffset
;
5779 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5780 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5781 p
->display_ellipsis_p
= 0;
5782 p
->line_wrap
= it
->line_wrap
;
5783 p
->bidi_p
= it
->bidi_p
;
5784 p
->paragraph_embedding
= it
->paragraph_embedding
;
5785 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5788 /* Save the state of the bidi iterator as well. */
5790 bidi_push_it (&it
->bidi_it
);
5794 iterate_out_of_display_property (struct it
*it
)
5796 int buffer_p
= !STRINGP (it
->string
);
5797 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5798 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5800 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5802 /* Maybe initialize paragraph direction. If we are at the beginning
5803 of a new paragraph, next_element_from_buffer may not have a
5804 chance to do that. */
5805 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5806 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5807 /* prev_stop can be zero, so check against BEGV as well. */
5808 while (it
->bidi_it
.charpos
>= bob
5809 && it
->prev_stop
<= it
->bidi_it
.charpos
5810 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5811 && it
->bidi_it
.charpos
< eob
)
5812 bidi_move_to_visually_next (&it
->bidi_it
);
5813 /* Record the stop_pos we just crossed, for when we cross it
5815 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5816 it
->prev_stop
= CHARPOS (it
->position
);
5817 /* If we ended up not where pop_it put us, resync IT's
5818 positional members with the bidi iterator. */
5819 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5820 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5822 it
->current
.pos
= it
->position
;
5824 it
->current
.string_pos
= it
->position
;
5827 /* Restore IT's settings from IT->stack. Called, for example, when no
5828 more overlay strings must be processed, and we return to delivering
5829 display elements from a buffer, or when the end of a string from a
5830 `display' property is reached and we return to delivering display
5831 elements from an overlay string, or from a buffer. */
5834 pop_it (struct it
*it
)
5836 struct iterator_stack_entry
*p
;
5837 int from_display_prop
= it
->from_disp_prop_p
;
5839 eassert (it
->sp
> 0);
5841 p
= it
->stack
+ it
->sp
;
5842 it
->stop_charpos
= p
->stop_charpos
;
5843 it
->prev_stop
= p
->prev_stop
;
5844 it
->base_level_stop
= p
->base_level_stop
;
5845 it
->cmp_it
= p
->cmp_it
;
5846 it
->face_id
= p
->face_id
;
5847 it
->current
= p
->current
;
5848 it
->position
= p
->position
;
5849 it
->string
= p
->string
;
5850 it
->from_overlay
= p
->from_overlay
;
5851 if (NILP (it
->string
))
5852 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5853 it
->method
= p
->method
;
5856 case GET_FROM_IMAGE
:
5857 it
->image_id
= p
->u
.image
.image_id
;
5858 it
->object
= p
->u
.image
.object
;
5859 it
->slice
= p
->u
.image
.slice
;
5861 case GET_FROM_STRETCH
:
5862 it
->object
= p
->u
.stretch
.object
;
5864 case GET_FROM_BUFFER
:
5865 it
->object
= it
->w
->buffer
;
5867 case GET_FROM_STRING
:
5868 it
->object
= it
->string
;
5870 case GET_FROM_DISPLAY_VECTOR
:
5872 it
->method
= GET_FROM_C_STRING
;
5873 else if (STRINGP (it
->string
))
5874 it
->method
= GET_FROM_STRING
;
5877 it
->method
= GET_FROM_BUFFER
;
5878 it
->object
= it
->w
->buffer
;
5881 it
->end_charpos
= p
->end_charpos
;
5882 it
->string_nchars
= p
->string_nchars
;
5884 it
->multibyte_p
= p
->multibyte_p
;
5885 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5886 it
->space_width
= p
->space_width
;
5887 it
->font_height
= p
->font_height
;
5888 it
->voffset
= p
->voffset
;
5889 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5890 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5891 it
->line_wrap
= p
->line_wrap
;
5892 it
->bidi_p
= p
->bidi_p
;
5893 it
->paragraph_embedding
= p
->paragraph_embedding
;
5894 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5897 bidi_pop_it (&it
->bidi_it
);
5898 /* Bidi-iterate until we get out of the portion of text, if any,
5899 covered by a `display' text property or by an overlay with
5900 `display' property. (We cannot just jump there, because the
5901 internal coherency of the bidi iterator state can not be
5902 preserved across such jumps.) We also must determine the
5903 paragraph base direction if the overlay we just processed is
5904 at the beginning of a new paragraph. */
5905 if (from_display_prop
5906 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5907 iterate_out_of_display_property (it
);
5909 eassert ((BUFFERP (it
->object
)
5910 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5911 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5912 || (STRINGP (it
->object
)
5913 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5914 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5915 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5921 /***********************************************************************
5923 ***********************************************************************/
5925 /* Set IT's current position to the previous line start. */
5928 back_to_previous_line_start (struct it
*it
)
5930 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5931 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5935 /* Move IT to the next line start.
5937 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5938 we skipped over part of the text (as opposed to moving the iterator
5939 continuously over the text). Otherwise, don't change the value
5942 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5943 iterator on the newline, if it was found.
5945 Newlines may come from buffer text, overlay strings, or strings
5946 displayed via the `display' property. That's the reason we can't
5947 simply use find_next_newline_no_quit.
5949 Note that this function may not skip over invisible text that is so
5950 because of text properties and immediately follows a newline. If
5951 it would, function reseat_at_next_visible_line_start, when called
5952 from set_iterator_to_next, would effectively make invisible
5953 characters following a newline part of the wrong glyph row, which
5954 leads to wrong cursor motion. */
5957 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5958 struct bidi_it
*bidi_it_prev
)
5960 ptrdiff_t old_selective
;
5961 int newline_found_p
, n
;
5962 const int MAX_NEWLINE_DISTANCE
= 500;
5964 /* If already on a newline, just consume it to avoid unintended
5965 skipping over invisible text below. */
5966 if (it
->what
== IT_CHARACTER
5968 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5970 if (it
->bidi_p
&& bidi_it_prev
)
5971 *bidi_it_prev
= it
->bidi_it
;
5972 set_iterator_to_next (it
, 0);
5977 /* Don't handle selective display in the following. It's (a)
5978 unnecessary because it's done by the caller, and (b) leads to an
5979 infinite recursion because next_element_from_ellipsis indirectly
5980 calls this function. */
5981 old_selective
= it
->selective
;
5984 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5985 from buffer text. */
5986 for (n
= newline_found_p
= 0;
5987 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5988 n
+= STRINGP (it
->string
) ? 0 : 1)
5990 if (!get_next_display_element (it
))
5992 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5993 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5994 *bidi_it_prev
= it
->bidi_it
;
5995 set_iterator_to_next (it
, 0);
5998 /* If we didn't find a newline near enough, see if we can use a
6000 if (!newline_found_p
)
6002 ptrdiff_t start
= IT_CHARPOS (*it
);
6003 ptrdiff_t limit
= find_next_newline_no_quit (start
, 1);
6006 eassert (!STRINGP (it
->string
));
6008 /* If there isn't any `display' property in sight, and no
6009 overlays, we can just use the position of the newline in
6011 if (it
->stop_charpos
>= limit
6012 || ((pos
= Fnext_single_property_change (make_number (start
),
6014 make_number (limit
)),
6016 && next_overlay_change (start
) == ZV
))
6020 IT_CHARPOS (*it
) = limit
;
6021 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
6025 struct bidi_it bprev
;
6027 /* Help bidi.c avoid expensive searches for display
6028 properties and overlays, by telling it that there are
6029 none up to `limit'. */
6030 if (it
->bidi_it
.disp_pos
< limit
)
6032 it
->bidi_it
.disp_pos
= limit
;
6033 it
->bidi_it
.disp_prop
= 0;
6036 bprev
= it
->bidi_it
;
6037 bidi_move_to_visually_next (&it
->bidi_it
);
6038 } while (it
->bidi_it
.charpos
!= limit
);
6039 IT_CHARPOS (*it
) = limit
;
6040 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6042 *bidi_it_prev
= bprev
;
6044 *skipped_p
= newline_found_p
= 1;
6048 while (get_next_display_element (it
)
6049 && !newline_found_p
)
6051 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6052 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6053 *bidi_it_prev
= it
->bidi_it
;
6054 set_iterator_to_next (it
, 0);
6059 it
->selective
= old_selective
;
6060 return newline_found_p
;
6064 /* Set IT's current position to the previous visible line start. Skip
6065 invisible text that is so either due to text properties or due to
6066 selective display. Caution: this does not change IT->current_x and
6070 back_to_previous_visible_line_start (struct it
*it
)
6072 while (IT_CHARPOS (*it
) > BEGV
)
6074 back_to_previous_line_start (it
);
6076 if (IT_CHARPOS (*it
) <= BEGV
)
6079 /* If selective > 0, then lines indented more than its value are
6081 if (it
->selective
> 0
6082 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6086 /* Check the newline before point for invisibility. */
6089 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6090 Qinvisible
, it
->window
);
6091 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6095 if (IT_CHARPOS (*it
) <= BEGV
)
6100 void *it2data
= NULL
;
6103 Lisp_Object val
, overlay
;
6105 SAVE_IT (it2
, *it
, it2data
);
6107 /* If newline is part of a composition, continue from start of composition */
6108 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6109 && beg
< IT_CHARPOS (*it
))
6112 /* If newline is replaced by a display property, find start of overlay
6113 or interval and continue search from that point. */
6114 pos
= --IT_CHARPOS (it2
);
6117 bidi_unshelve_cache (NULL
, 0);
6118 it2
.string_from_display_prop_p
= 0;
6119 it2
.from_disp_prop_p
= 0;
6120 if (handle_display_prop (&it2
) == HANDLED_RETURN
6121 && !NILP (val
= get_char_property_and_overlay
6122 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6123 && (OVERLAYP (overlay
)
6124 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6125 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6127 RESTORE_IT (it
, it
, it2data
);
6131 /* Newline is not replaced by anything -- so we are done. */
6132 RESTORE_IT (it
, it
, it2data
);
6138 IT_CHARPOS (*it
) = beg
;
6139 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6143 it
->continuation_lines_width
= 0;
6145 eassert (IT_CHARPOS (*it
) >= BEGV
);
6146 eassert (IT_CHARPOS (*it
) == BEGV
6147 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6152 /* Reseat iterator IT at the previous visible line start. Skip
6153 invisible text that is so either due to text properties or due to
6154 selective display. At the end, update IT's overlay information,
6155 face information etc. */
6158 reseat_at_previous_visible_line_start (struct it
*it
)
6160 back_to_previous_visible_line_start (it
);
6161 reseat (it
, it
->current
.pos
, 1);
6166 /* Reseat iterator IT on the next visible line start in the current
6167 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6168 preceding the line start. Skip over invisible text that is so
6169 because of selective display. Compute faces, overlays etc at the
6170 new position. Note that this function does not skip over text that
6171 is invisible because of text properties. */
6174 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6176 int newline_found_p
, skipped_p
= 0;
6177 struct bidi_it bidi_it_prev
;
6179 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6181 /* Skip over lines that are invisible because they are indented
6182 more than the value of IT->selective. */
6183 if (it
->selective
> 0)
6184 while (IT_CHARPOS (*it
) < ZV
6185 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6188 eassert (IT_BYTEPOS (*it
) == BEGV
6189 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6191 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6194 /* Position on the newline if that's what's requested. */
6195 if (on_newline_p
&& newline_found_p
)
6197 if (STRINGP (it
->string
))
6199 if (IT_STRING_CHARPOS (*it
) > 0)
6203 --IT_STRING_CHARPOS (*it
);
6204 --IT_STRING_BYTEPOS (*it
);
6208 /* We need to restore the bidi iterator to the state
6209 it had on the newline, and resync the IT's
6210 position with that. */
6211 it
->bidi_it
= bidi_it_prev
;
6212 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6213 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6217 else if (IT_CHARPOS (*it
) > BEGV
)
6226 /* We need to restore the bidi iterator to the state it
6227 had on the newline and resync IT with that. */
6228 it
->bidi_it
= bidi_it_prev
;
6229 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6230 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6232 reseat (it
, it
->current
.pos
, 0);
6236 reseat (it
, it
->current
.pos
, 0);
6243 /***********************************************************************
6244 Changing an iterator's position
6245 ***********************************************************************/
6247 /* Change IT's current position to POS in current_buffer. If FORCE_P
6248 is non-zero, always check for text properties at the new position.
6249 Otherwise, text properties are only looked up if POS >=
6250 IT->check_charpos of a property. */
6253 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6255 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6257 reseat_1 (it
, pos
, 0);
6259 /* Determine where to check text properties. Avoid doing it
6260 where possible because text property lookup is very expensive. */
6262 || CHARPOS (pos
) > it
->stop_charpos
6263 || CHARPOS (pos
) < original_pos
)
6267 /* For bidi iteration, we need to prime prev_stop and
6268 base_level_stop with our best estimations. */
6269 /* Implementation note: Of course, POS is not necessarily a
6270 stop position, so assigning prev_pos to it is a lie; we
6271 should have called compute_stop_backwards. However, if
6272 the current buffer does not include any R2L characters,
6273 that call would be a waste of cycles, because the
6274 iterator will never move back, and thus never cross this
6275 "fake" stop position. So we delay that backward search
6276 until the time we really need it, in next_element_from_buffer. */
6277 if (CHARPOS (pos
) != it
->prev_stop
)
6278 it
->prev_stop
= CHARPOS (pos
);
6279 if (CHARPOS (pos
) < it
->base_level_stop
)
6280 it
->base_level_stop
= 0; /* meaning it's unknown */
6286 it
->prev_stop
= it
->base_level_stop
= 0;
6295 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6296 IT->stop_pos to POS, also. */
6299 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6301 /* Don't call this function when scanning a C string. */
6302 eassert (it
->s
== NULL
);
6304 /* POS must be a reasonable value. */
6305 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6307 it
->current
.pos
= it
->position
= pos
;
6308 it
->end_charpos
= ZV
;
6310 it
->current
.dpvec_index
= -1;
6311 it
->current
.overlay_string_index
= -1;
6312 IT_STRING_CHARPOS (*it
) = -1;
6313 IT_STRING_BYTEPOS (*it
) = -1;
6315 it
->method
= GET_FROM_BUFFER
;
6316 it
->object
= it
->w
->buffer
;
6317 it
->area
= TEXT_AREA
;
6318 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6320 it
->string_from_display_prop_p
= 0;
6321 it
->string_from_prefix_prop_p
= 0;
6323 it
->from_disp_prop_p
= 0;
6324 it
->face_before_selective_p
= 0;
6327 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6329 bidi_unshelve_cache (NULL
, 0);
6330 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6331 it
->bidi_it
.string
.s
= NULL
;
6332 it
->bidi_it
.string
.lstring
= Qnil
;
6333 it
->bidi_it
.string
.bufpos
= 0;
6334 it
->bidi_it
.string
.unibyte
= 0;
6339 it
->stop_charpos
= CHARPOS (pos
);
6340 it
->base_level_stop
= CHARPOS (pos
);
6342 /* This make the information stored in it->cmp_it invalidate. */
6347 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6348 If S is non-null, it is a C string to iterate over. Otherwise,
6349 STRING gives a Lisp string to iterate over.
6351 If PRECISION > 0, don't return more then PRECISION number of
6352 characters from the string.
6354 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6355 characters have been returned. FIELD_WIDTH < 0 means an infinite
6358 MULTIBYTE = 0 means disable processing of multibyte characters,
6359 MULTIBYTE > 0 means enable it,
6360 MULTIBYTE < 0 means use IT->multibyte_p.
6362 IT must be initialized via a prior call to init_iterator before
6363 calling this function. */
6366 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6367 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6370 /* No region in strings. */
6371 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6373 /* No text property checks performed by default, but see below. */
6374 it
->stop_charpos
= -1;
6376 /* Set iterator position and end position. */
6377 memset (&it
->current
, 0, sizeof it
->current
);
6378 it
->current
.overlay_string_index
= -1;
6379 it
->current
.dpvec_index
= -1;
6380 eassert (charpos
>= 0);
6382 /* If STRING is specified, use its multibyteness, otherwise use the
6383 setting of MULTIBYTE, if specified. */
6385 it
->multibyte_p
= multibyte
> 0;
6387 /* Bidirectional reordering of strings is controlled by the default
6388 value of bidi-display-reordering. Don't try to reorder while
6389 loading loadup.el, as the necessary character property tables are
6390 not yet available. */
6393 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6397 eassert (STRINGP (string
));
6398 it
->string
= string
;
6400 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6401 it
->method
= GET_FROM_STRING
;
6402 it
->current
.string_pos
= string_pos (charpos
, string
);
6406 it
->bidi_it
.string
.lstring
= string
;
6407 it
->bidi_it
.string
.s
= NULL
;
6408 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6409 it
->bidi_it
.string
.bufpos
= 0;
6410 it
->bidi_it
.string
.from_disp_str
= 0;
6411 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6412 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6413 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6418 it
->s
= (const unsigned char *) s
;
6421 /* Note that we use IT->current.pos, not it->current.string_pos,
6422 for displaying C strings. */
6423 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6424 if (it
->multibyte_p
)
6426 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6427 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6431 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6432 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6437 it
->bidi_it
.string
.lstring
= Qnil
;
6438 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6439 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6440 it
->bidi_it
.string
.bufpos
= 0;
6441 it
->bidi_it
.string
.from_disp_str
= 0;
6442 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6443 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6446 it
->method
= GET_FROM_C_STRING
;
6449 /* PRECISION > 0 means don't return more than PRECISION characters
6451 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6453 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6455 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6458 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6459 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6460 FIELD_WIDTH < 0 means infinite field width. This is useful for
6461 padding with `-' at the end of a mode line. */
6462 if (field_width
< 0)
6463 field_width
= INFINITY
;
6464 /* Implementation note: We deliberately don't enlarge
6465 it->bidi_it.string.schars here to fit it->end_charpos, because
6466 the bidi iterator cannot produce characters out of thin air. */
6467 if (field_width
> it
->end_charpos
- charpos
)
6468 it
->end_charpos
= charpos
+ field_width
;
6470 /* Use the standard display table for displaying strings. */
6471 if (DISP_TABLE_P (Vstandard_display_table
))
6472 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6474 it
->stop_charpos
= charpos
;
6475 it
->prev_stop
= charpos
;
6476 it
->base_level_stop
= 0;
6479 it
->bidi_it
.first_elt
= 1;
6480 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6481 it
->bidi_it
.disp_pos
= -1;
6483 if (s
== NULL
&& it
->multibyte_p
)
6485 ptrdiff_t endpos
= SCHARS (it
->string
);
6486 if (endpos
> it
->end_charpos
)
6487 endpos
= it
->end_charpos
;
6488 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6496 /***********************************************************************
6498 ***********************************************************************/
6500 /* Map enum it_method value to corresponding next_element_from_* function. */
6502 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6504 next_element_from_buffer
,
6505 next_element_from_display_vector
,
6506 next_element_from_string
,
6507 next_element_from_c_string
,
6508 next_element_from_image
,
6509 next_element_from_stretch
6512 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6515 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6516 (possibly with the following characters). */
6518 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6519 ((IT)->cmp_it.id >= 0 \
6520 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6521 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6522 END_CHARPOS, (IT)->w, \
6523 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6527 /* Lookup the char-table Vglyphless_char_display for character C (-1
6528 if we want information for no-font case), and return the display
6529 method symbol. By side-effect, update it->what and
6530 it->glyphless_method. This function is called from
6531 get_next_display_element for each character element, and from
6532 x_produce_glyphs when no suitable font was found. */
6535 lookup_glyphless_char_display (int c
, struct it
*it
)
6537 Lisp_Object glyphless_method
= Qnil
;
6539 if (CHAR_TABLE_P (Vglyphless_char_display
)
6540 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6544 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6545 if (CONSP (glyphless_method
))
6546 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6547 ? XCAR (glyphless_method
)
6548 : XCDR (glyphless_method
);
6551 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6555 if (NILP (glyphless_method
))
6558 /* The default is to display the character by a proper font. */
6560 /* The default for the no-font case is to display an empty box. */
6561 glyphless_method
= Qempty_box
;
6563 if (EQ (glyphless_method
, Qzero_width
))
6566 return glyphless_method
;
6567 /* This method can't be used for the no-font case. */
6568 glyphless_method
= Qempty_box
;
6570 if (EQ (glyphless_method
, Qthin_space
))
6571 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6572 else if (EQ (glyphless_method
, Qempty_box
))
6573 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6574 else if (EQ (glyphless_method
, Qhex_code
))
6575 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6576 else if (STRINGP (glyphless_method
))
6577 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6580 /* Invalid value. We use the default method. */
6581 glyphless_method
= Qnil
;
6584 it
->what
= IT_GLYPHLESS
;
6585 return glyphless_method
;
6588 /* Load IT's display element fields with information about the next
6589 display element from the current position of IT. Value is zero if
6590 end of buffer (or C string) is reached. */
6592 static struct frame
*last_escape_glyph_frame
= NULL
;
6593 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6594 static int last_escape_glyph_merged_face_id
= 0;
6596 struct frame
*last_glyphless_glyph_frame
= NULL
;
6597 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6598 int last_glyphless_glyph_merged_face_id
= 0;
6601 get_next_display_element (struct it
*it
)
6603 /* Non-zero means that we found a display element. Zero means that
6604 we hit the end of what we iterate over. Performance note: the
6605 function pointer `method' used here turns out to be faster than
6606 using a sequence of if-statements. */
6610 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6612 if (it
->what
== IT_CHARACTER
)
6614 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6615 and only if (a) the resolved directionality of that character
6617 /* FIXME: Do we need an exception for characters from display
6619 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6620 it
->c
= bidi_mirror_char (it
->c
);
6621 /* Map via display table or translate control characters.
6622 IT->c, IT->len etc. have been set to the next character by
6623 the function call above. If we have a display table, and it
6624 contains an entry for IT->c, translate it. Don't do this if
6625 IT->c itself comes from a display table, otherwise we could
6626 end up in an infinite recursion. (An alternative could be to
6627 count the recursion depth of this function and signal an
6628 error when a certain maximum depth is reached.) Is it worth
6630 if (success_p
&& it
->dpvec
== NULL
)
6633 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6634 int nonascii_space_p
= 0;
6635 int nonascii_hyphen_p
= 0;
6636 int c
= it
->c
; /* This is the character to display. */
6638 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6640 eassert (SINGLE_BYTE_CHAR_P (c
));
6641 if (unibyte_display_via_language_environment
)
6643 c
= DECODE_CHAR (unibyte
, c
);
6645 c
= BYTE8_TO_CHAR (it
->c
);
6648 c
= BYTE8_TO_CHAR (it
->c
);
6652 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6655 struct Lisp_Vector
*v
= XVECTOR (dv
);
6657 /* Return the first character from the display table
6658 entry, if not empty. If empty, don't display the
6659 current character. */
6662 it
->dpvec_char_len
= it
->len
;
6663 it
->dpvec
= v
->contents
;
6664 it
->dpend
= v
->contents
+ v
->header
.size
;
6665 it
->current
.dpvec_index
= 0;
6666 it
->dpvec_face_id
= -1;
6667 it
->saved_face_id
= it
->face_id
;
6668 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6673 set_iterator_to_next (it
, 0);
6678 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6680 if (it
->what
== IT_GLYPHLESS
)
6682 /* Don't display this character. */
6683 set_iterator_to_next (it
, 0);
6687 /* If `nobreak-char-display' is non-nil, we display
6688 non-ASCII spaces and hyphens specially. */
6689 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6692 nonascii_space_p
= 1;
6693 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6694 nonascii_hyphen_p
= 1;
6697 /* Translate control characters into `\003' or `^C' form.
6698 Control characters coming from a display table entry are
6699 currently not translated because we use IT->dpvec to hold
6700 the translation. This could easily be changed but I
6701 don't believe that it is worth doing.
6703 The characters handled by `nobreak-char-display' must be
6706 Non-printable characters and raw-byte characters are also
6707 translated to octal form. */
6708 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6709 ? (it
->area
!= TEXT_AREA
6710 /* In mode line, treat \n, \t like other crl chars. */
6713 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6714 || (c
!= '\n' && c
!= '\t'))
6716 || nonascii_hyphen_p
6718 || ! CHAR_PRINTABLE_P (c
))))
6720 /* C is a control character, non-ASCII space/hyphen,
6721 raw-byte, or a non-printable character which must be
6722 displayed either as '\003' or as `^C' where the '\\'
6723 and '^' can be defined in the display table. Fill
6724 IT->ctl_chars with glyphs for what we have to
6725 display. Then, set IT->dpvec to these glyphs. */
6732 /* Handle control characters with ^. */
6734 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6738 g
= '^'; /* default glyph for Control */
6739 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6741 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6743 g
= GLYPH_CODE_CHAR (gc
);
6744 lface_id
= GLYPH_CODE_FACE (gc
);
6748 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6750 else if (it
->f
== last_escape_glyph_frame
6751 && it
->face_id
== last_escape_glyph_face_id
)
6753 face_id
= last_escape_glyph_merged_face_id
;
6757 /* Merge the escape-glyph face into the current face. */
6758 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6760 last_escape_glyph_frame
= it
->f
;
6761 last_escape_glyph_face_id
= it
->face_id
;
6762 last_escape_glyph_merged_face_id
= face_id
;
6765 XSETINT (it
->ctl_chars
[0], g
);
6766 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6768 goto display_control
;
6771 /* Handle non-ascii space in the mode where it only gets
6774 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6776 /* Merge `nobreak-space' into the current face. */
6777 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6779 XSETINT (it
->ctl_chars
[0], ' ');
6781 goto display_control
;
6784 /* Handle sequences that start with the "escape glyph". */
6786 /* the default escape glyph is \. */
6787 escape_glyph
= '\\';
6790 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6792 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6793 lface_id
= GLYPH_CODE_FACE (gc
);
6797 /* The display table specified a face.
6798 Merge it into face_id and also into escape_glyph. */
6799 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6802 else if (it
->f
== last_escape_glyph_frame
6803 && it
->face_id
== last_escape_glyph_face_id
)
6805 face_id
= last_escape_glyph_merged_face_id
;
6809 /* Merge the escape-glyph face into the current face. */
6810 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6812 last_escape_glyph_frame
= it
->f
;
6813 last_escape_glyph_face_id
= it
->face_id
;
6814 last_escape_glyph_merged_face_id
= face_id
;
6817 /* Draw non-ASCII hyphen with just highlighting: */
6819 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6821 XSETINT (it
->ctl_chars
[0], '-');
6823 goto display_control
;
6826 /* Draw non-ASCII space/hyphen with escape glyph: */
6828 if (nonascii_space_p
|| nonascii_hyphen_p
)
6830 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6831 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6833 goto display_control
;
6840 if (CHAR_BYTE8_P (c
))
6841 /* Display \200 instead of \17777600. */
6842 c
= CHAR_TO_BYTE8 (c
);
6843 len
= sprintf (str
, "%03o", c
);
6845 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6846 for (i
= 0; i
< len
; i
++)
6847 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6852 /* Set up IT->dpvec and return first character from it. */
6853 it
->dpvec_char_len
= it
->len
;
6854 it
->dpvec
= it
->ctl_chars
;
6855 it
->dpend
= it
->dpvec
+ ctl_len
;
6856 it
->current
.dpvec_index
= 0;
6857 it
->dpvec_face_id
= face_id
;
6858 it
->saved_face_id
= it
->face_id
;
6859 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6863 it
->char_to_display
= c
;
6867 it
->char_to_display
= it
->c
;
6871 /* Adjust face id for a multibyte character. There are no multibyte
6872 character in unibyte text. */
6873 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6876 && FRAME_WINDOW_P (it
->f
))
6878 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6880 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6882 /* Automatic composition with glyph-string. */
6883 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6885 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6889 ptrdiff_t pos
= (it
->s
? -1
6890 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6891 : IT_CHARPOS (*it
));
6894 if (it
->what
== IT_CHARACTER
)
6895 c
= it
->char_to_display
;
6898 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6902 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6903 /* TAB in a composition means display glyphs with
6904 padding space on the left or right. */
6905 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6908 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6913 /* Is this character the last one of a run of characters with
6914 box? If yes, set IT->end_of_box_run_p to 1. */
6918 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6920 int face_id
= underlying_face_id (it
);
6921 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6925 if (face
->box
== FACE_NO_BOX
)
6927 /* If the box comes from face properties in a
6928 display string, check faces in that string. */
6929 int string_face_id
= face_after_it_pos (it
);
6930 it
->end_of_box_run_p
6931 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6934 /* Otherwise, the box comes from the underlying face.
6935 If this is the last string character displayed, check
6936 the next buffer location. */
6937 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6938 && (it
->current
.overlay_string_index
6939 == it
->n_overlay_strings
- 1))
6943 struct text_pos pos
= it
->current
.pos
;
6944 INC_TEXT_POS (pos
, it
->multibyte_p
);
6946 next_face_id
= face_at_buffer_position
6947 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6948 it
->region_end_charpos
, &ignore
,
6949 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6951 it
->end_of_box_run_p
6952 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6959 int face_id
= face_after_it_pos (it
);
6960 it
->end_of_box_run_p
6961 = (face_id
!= it
->face_id
6962 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6965 /* If we reached the end of the object we've been iterating (e.g., a
6966 display string or an overlay string), and there's something on
6967 IT->stack, proceed with what's on the stack. It doesn't make
6968 sense to return zero if there's unprocessed stuff on the stack,
6969 because otherwise that stuff will never be displayed. */
6970 if (!success_p
&& it
->sp
> 0)
6972 set_iterator_to_next (it
, 0);
6973 success_p
= get_next_display_element (it
);
6976 /* Value is 0 if end of buffer or string reached. */
6981 /* Move IT to the next display element.
6983 RESEAT_P non-zero means if called on a newline in buffer text,
6984 skip to the next visible line start.
6986 Functions get_next_display_element and set_iterator_to_next are
6987 separate because I find this arrangement easier to handle than a
6988 get_next_display_element function that also increments IT's
6989 position. The way it is we can first look at an iterator's current
6990 display element, decide whether it fits on a line, and if it does,
6991 increment the iterator position. The other way around we probably
6992 would either need a flag indicating whether the iterator has to be
6993 incremented the next time, or we would have to implement a
6994 decrement position function which would not be easy to write. */
6997 set_iterator_to_next (struct it
*it
, int reseat_p
)
6999 /* Reset flags indicating start and end of a sequence of characters
7000 with box. Reset them at the start of this function because
7001 moving the iterator to a new position might set them. */
7002 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7006 case GET_FROM_BUFFER
:
7007 /* The current display element of IT is a character from
7008 current_buffer. Advance in the buffer, and maybe skip over
7009 invisible lines that are so because of selective display. */
7010 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7011 reseat_at_next_visible_line_start (it
, 0);
7012 else if (it
->cmp_it
.id
>= 0)
7014 /* We are currently getting glyphs from a composition. */
7019 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7020 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7021 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7023 it
->cmp_it
.from
= it
->cmp_it
.to
;
7028 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7030 it
->end_charpos
, Qnil
);
7033 else if (! it
->cmp_it
.reversed_p
)
7035 /* Composition created while scanning forward. */
7036 /* Update IT's char/byte positions to point to the first
7037 character of the next grapheme cluster, or to the
7038 character visually after the current composition. */
7039 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7040 bidi_move_to_visually_next (&it
->bidi_it
);
7041 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7042 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7044 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7046 /* Proceed to the next grapheme cluster. */
7047 it
->cmp_it
.from
= it
->cmp_it
.to
;
7051 /* No more grapheme clusters in this composition.
7052 Find the next stop position. */
7053 ptrdiff_t stop
= it
->end_charpos
;
7054 if (it
->bidi_it
.scan_dir
< 0)
7055 /* Now we are scanning backward and don't know
7058 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7059 IT_BYTEPOS (*it
), stop
, Qnil
);
7064 /* Composition created while scanning backward. */
7065 /* Update IT's char/byte positions to point to the last
7066 character of the previous grapheme cluster, or the
7067 character visually after the current composition. */
7068 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7069 bidi_move_to_visually_next (&it
->bidi_it
);
7070 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7071 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7072 if (it
->cmp_it
.from
> 0)
7074 /* Proceed to the previous grapheme cluster. */
7075 it
->cmp_it
.to
= it
->cmp_it
.from
;
7079 /* No more grapheme clusters in this composition.
7080 Find the next stop position. */
7081 ptrdiff_t stop
= it
->end_charpos
;
7082 if (it
->bidi_it
.scan_dir
< 0)
7083 /* Now we are scanning backward and don't know
7086 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7087 IT_BYTEPOS (*it
), stop
, Qnil
);
7093 eassert (it
->len
!= 0);
7097 IT_BYTEPOS (*it
) += it
->len
;
7098 IT_CHARPOS (*it
) += 1;
7102 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7103 /* If this is a new paragraph, determine its base
7104 direction (a.k.a. its base embedding level). */
7105 if (it
->bidi_it
.new_paragraph
)
7106 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7107 bidi_move_to_visually_next (&it
->bidi_it
);
7108 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7109 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7110 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7112 /* As the scan direction was changed, we must
7113 re-compute the stop position for composition. */
7114 ptrdiff_t stop
= it
->end_charpos
;
7115 if (it
->bidi_it
.scan_dir
< 0)
7117 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7118 IT_BYTEPOS (*it
), stop
, Qnil
);
7121 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7125 case GET_FROM_C_STRING
:
7126 /* Current display element of IT is from a C string. */
7128 /* If the string position is beyond string's end, it means
7129 next_element_from_c_string is padding the string with
7130 blanks, in which case we bypass the bidi iterator,
7131 because it cannot deal with such virtual characters. */
7132 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7134 IT_BYTEPOS (*it
) += it
->len
;
7135 IT_CHARPOS (*it
) += 1;
7139 bidi_move_to_visually_next (&it
->bidi_it
);
7140 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7141 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7145 case GET_FROM_DISPLAY_VECTOR
:
7146 /* Current display element of IT is from a display table entry.
7147 Advance in the display table definition. Reset it to null if
7148 end reached, and continue with characters from buffers/
7150 ++it
->current
.dpvec_index
;
7152 /* Restore face of the iterator to what they were before the
7153 display vector entry (these entries may contain faces). */
7154 it
->face_id
= it
->saved_face_id
;
7156 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7158 int recheck_faces
= it
->ellipsis_p
;
7161 it
->method
= GET_FROM_C_STRING
;
7162 else if (STRINGP (it
->string
))
7163 it
->method
= GET_FROM_STRING
;
7166 it
->method
= GET_FROM_BUFFER
;
7167 it
->object
= it
->w
->buffer
;
7171 it
->current
.dpvec_index
= -1;
7173 /* Skip over characters which were displayed via IT->dpvec. */
7174 if (it
->dpvec_char_len
< 0)
7175 reseat_at_next_visible_line_start (it
, 1);
7176 else if (it
->dpvec_char_len
> 0)
7178 if (it
->method
== GET_FROM_STRING
7179 && it
->n_overlay_strings
> 0)
7180 it
->ignore_overlay_strings_at_pos_p
= 1;
7181 it
->len
= it
->dpvec_char_len
;
7182 set_iterator_to_next (it
, reseat_p
);
7185 /* Maybe recheck faces after display vector */
7187 it
->stop_charpos
= IT_CHARPOS (*it
);
7191 case GET_FROM_STRING
:
7192 /* Current display element is a character from a Lisp string. */
7193 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7194 /* Don't advance past string end. These conditions are true
7195 when set_iterator_to_next is called at the end of
7196 get_next_display_element, in which case the Lisp string is
7197 already exhausted, and all we want is pop the iterator
7199 if (it
->current
.overlay_string_index
>= 0)
7201 /* This is an overlay string, so there's no padding with
7202 spaces, and the number of characters in the string is
7203 where the string ends. */
7204 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7205 goto consider_string_end
;
7209 /* Not an overlay string. There could be padding, so test
7210 against it->end_charpos . */
7211 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7212 goto consider_string_end
;
7214 if (it
->cmp_it
.id
>= 0)
7220 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7221 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7222 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7223 it
->cmp_it
.from
= it
->cmp_it
.to
;
7227 composition_compute_stop_pos (&it
->cmp_it
,
7228 IT_STRING_CHARPOS (*it
),
7229 IT_STRING_BYTEPOS (*it
),
7230 it
->end_charpos
, it
->string
);
7233 else if (! it
->cmp_it
.reversed_p
)
7235 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7236 bidi_move_to_visually_next (&it
->bidi_it
);
7237 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7238 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7240 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7241 it
->cmp_it
.from
= it
->cmp_it
.to
;
7244 ptrdiff_t stop
= it
->end_charpos
;
7245 if (it
->bidi_it
.scan_dir
< 0)
7247 composition_compute_stop_pos (&it
->cmp_it
,
7248 IT_STRING_CHARPOS (*it
),
7249 IT_STRING_BYTEPOS (*it
), stop
,
7255 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7256 bidi_move_to_visually_next (&it
->bidi_it
);
7257 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7258 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7259 if (it
->cmp_it
.from
> 0)
7260 it
->cmp_it
.to
= it
->cmp_it
.from
;
7263 ptrdiff_t stop
= it
->end_charpos
;
7264 if (it
->bidi_it
.scan_dir
< 0)
7266 composition_compute_stop_pos (&it
->cmp_it
,
7267 IT_STRING_CHARPOS (*it
),
7268 IT_STRING_BYTEPOS (*it
), stop
,
7276 /* If the string position is beyond string's end, it
7277 means next_element_from_string is padding the string
7278 with blanks, in which case we bypass the bidi
7279 iterator, because it cannot deal with such virtual
7281 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7283 IT_STRING_BYTEPOS (*it
) += it
->len
;
7284 IT_STRING_CHARPOS (*it
) += 1;
7288 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7290 bidi_move_to_visually_next (&it
->bidi_it
);
7291 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7292 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7293 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7295 ptrdiff_t stop
= it
->end_charpos
;
7297 if (it
->bidi_it
.scan_dir
< 0)
7299 composition_compute_stop_pos (&it
->cmp_it
,
7300 IT_STRING_CHARPOS (*it
),
7301 IT_STRING_BYTEPOS (*it
), stop
,
7307 consider_string_end
:
7309 if (it
->current
.overlay_string_index
>= 0)
7311 /* IT->string is an overlay string. Advance to the
7312 next, if there is one. */
7313 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7316 next_overlay_string (it
);
7318 setup_for_ellipsis (it
, 0);
7323 /* IT->string is not an overlay string. If we reached
7324 its end, and there is something on IT->stack, proceed
7325 with what is on the stack. This can be either another
7326 string, this time an overlay string, or a buffer. */
7327 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7331 if (it
->method
== GET_FROM_STRING
)
7332 goto consider_string_end
;
7337 case GET_FROM_IMAGE
:
7338 case GET_FROM_STRETCH
:
7339 /* The position etc with which we have to proceed are on
7340 the stack. The position may be at the end of a string,
7341 if the `display' property takes up the whole string. */
7342 eassert (it
->sp
> 0);
7344 if (it
->method
== GET_FROM_STRING
)
7345 goto consider_string_end
;
7349 /* There are no other methods defined, so this should be a bug. */
7353 eassert (it
->method
!= GET_FROM_STRING
7354 || (STRINGP (it
->string
)
7355 && IT_STRING_CHARPOS (*it
) >= 0));
7358 /* Load IT's display element fields with information about the next
7359 display element which comes from a display table entry or from the
7360 result of translating a control character to one of the forms `^C'
7363 IT->dpvec holds the glyphs to return as characters.
7364 IT->saved_face_id holds the face id before the display vector--it
7365 is restored into IT->face_id in set_iterator_to_next. */
7368 next_element_from_display_vector (struct it
*it
)
7373 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7375 it
->face_id
= it
->saved_face_id
;
7377 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7378 That seemed totally bogus - so I changed it... */
7379 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7381 if (GLYPH_CODE_P (gc
))
7383 it
->c
= GLYPH_CODE_CHAR (gc
);
7384 it
->len
= CHAR_BYTES (it
->c
);
7386 /* The entry may contain a face id to use. Such a face id is
7387 the id of a Lisp face, not a realized face. A face id of
7388 zero means no face is specified. */
7389 if (it
->dpvec_face_id
>= 0)
7390 it
->face_id
= it
->dpvec_face_id
;
7393 int lface_id
= GLYPH_CODE_FACE (gc
);
7395 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7400 /* Display table entry is invalid. Return a space. */
7401 it
->c
= ' ', it
->len
= 1;
7403 /* Don't change position and object of the iterator here. They are
7404 still the values of the character that had this display table
7405 entry or was translated, and that's what we want. */
7406 it
->what
= IT_CHARACTER
;
7410 /* Get the first element of string/buffer in the visual order, after
7411 being reseated to a new position in a string or a buffer. */
7413 get_visually_first_element (struct it
*it
)
7415 int string_p
= STRINGP (it
->string
) || it
->s
;
7416 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7417 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7419 if (STRINGP (it
->string
))
7421 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7422 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7426 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7427 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7430 if (it
->bidi_it
.charpos
== eob
)
7432 /* Nothing to do, but reset the FIRST_ELT flag, like
7433 bidi_paragraph_init does, because we are not going to
7435 it
->bidi_it
.first_elt
= 0;
7437 else if (it
->bidi_it
.charpos
== bob
7439 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7440 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7442 /* If we are at the beginning of a line/string, we can produce
7443 the next element right away. */
7444 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7445 bidi_move_to_visually_next (&it
->bidi_it
);
7449 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7451 /* We need to prime the bidi iterator starting at the line's or
7452 string's beginning, before we will be able to produce the
7455 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7458 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7460 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7462 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7465 /* Now return to buffer/string position where we were asked
7466 to get the next display element, and produce that. */
7467 bidi_move_to_visually_next (&it
->bidi_it
);
7469 while (it
->bidi_it
.bytepos
!= orig_bytepos
7470 && it
->bidi_it
.charpos
< eob
);
7473 /* Adjust IT's position information to where we ended up. */
7474 if (STRINGP (it
->string
))
7476 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7477 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7481 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7482 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7485 if (STRINGP (it
->string
) || !it
->s
)
7487 ptrdiff_t stop
, charpos
, bytepos
;
7489 if (STRINGP (it
->string
))
7492 stop
= SCHARS (it
->string
);
7493 if (stop
> it
->end_charpos
)
7494 stop
= it
->end_charpos
;
7495 charpos
= IT_STRING_CHARPOS (*it
);
7496 bytepos
= IT_STRING_BYTEPOS (*it
);
7500 stop
= it
->end_charpos
;
7501 charpos
= IT_CHARPOS (*it
);
7502 bytepos
= IT_BYTEPOS (*it
);
7504 if (it
->bidi_it
.scan_dir
< 0)
7506 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7511 /* Load IT with the next display element from Lisp string IT->string.
7512 IT->current.string_pos is the current position within the string.
7513 If IT->current.overlay_string_index >= 0, the Lisp string is an
7517 next_element_from_string (struct it
*it
)
7519 struct text_pos position
;
7521 eassert (STRINGP (it
->string
));
7522 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7523 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7524 position
= it
->current
.string_pos
;
7526 /* With bidi reordering, the character to display might not be the
7527 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7528 that we were reseat()ed to a new string, whose paragraph
7529 direction is not known. */
7530 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7532 get_visually_first_element (it
);
7533 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7536 /* Time to check for invisible text? */
7537 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7539 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7542 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7543 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7545 /* With bidi non-linear iteration, we could find
7546 ourselves far beyond the last computed stop_charpos,
7547 with several other stop positions in between that we
7548 missed. Scan them all now, in buffer's logical
7549 order, until we find and handle the last stop_charpos
7550 that precedes our current position. */
7551 handle_stop_backwards (it
, it
->stop_charpos
);
7552 return GET_NEXT_DISPLAY_ELEMENT (it
);
7558 /* Take note of the stop position we just moved
7559 across, for when we will move back across it. */
7560 it
->prev_stop
= it
->stop_charpos
;
7561 /* If we are at base paragraph embedding level, take
7562 note of the last stop position seen at this
7564 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7565 it
->base_level_stop
= it
->stop_charpos
;
7569 /* Since a handler may have changed IT->method, we must
7571 return GET_NEXT_DISPLAY_ELEMENT (it
);
7575 /* If we are before prev_stop, we may have overstepped
7576 on our way backwards a stop_pos, and if so, we need
7577 to handle that stop_pos. */
7578 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7579 /* We can sometimes back up for reasons that have nothing
7580 to do with bidi reordering. E.g., compositions. The
7581 code below is only needed when we are above the base
7582 embedding level, so test for that explicitly. */
7583 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7585 /* If we lost track of base_level_stop, we have no better
7586 place for handle_stop_backwards to start from than string
7587 beginning. This happens, e.g., when we were reseated to
7588 the previous screenful of text by vertical-motion. */
7589 if (it
->base_level_stop
<= 0
7590 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7591 it
->base_level_stop
= 0;
7592 handle_stop_backwards (it
, it
->base_level_stop
);
7593 return GET_NEXT_DISPLAY_ELEMENT (it
);
7597 if (it
->current
.overlay_string_index
>= 0)
7599 /* Get the next character from an overlay string. In overlay
7600 strings, there is no field width or padding with spaces to
7602 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7607 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7608 IT_STRING_BYTEPOS (*it
),
7609 it
->bidi_it
.scan_dir
< 0
7611 : SCHARS (it
->string
))
7612 && next_element_from_composition (it
))
7616 else if (STRING_MULTIBYTE (it
->string
))
7618 const unsigned char *s
= (SDATA (it
->string
)
7619 + IT_STRING_BYTEPOS (*it
));
7620 it
->c
= string_char_and_length (s
, &it
->len
);
7624 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7630 /* Get the next character from a Lisp string that is not an
7631 overlay string. Such strings come from the mode line, for
7632 example. We may have to pad with spaces, or truncate the
7633 string. See also next_element_from_c_string. */
7634 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7639 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7641 /* Pad with spaces. */
7642 it
->c
= ' ', it
->len
= 1;
7643 CHARPOS (position
) = BYTEPOS (position
) = -1;
7645 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7646 IT_STRING_BYTEPOS (*it
),
7647 it
->bidi_it
.scan_dir
< 0
7649 : it
->string_nchars
)
7650 && next_element_from_composition (it
))
7654 else if (STRING_MULTIBYTE (it
->string
))
7656 const unsigned char *s
= (SDATA (it
->string
)
7657 + IT_STRING_BYTEPOS (*it
));
7658 it
->c
= string_char_and_length (s
, &it
->len
);
7662 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7667 /* Record what we have and where it came from. */
7668 it
->what
= IT_CHARACTER
;
7669 it
->object
= it
->string
;
7670 it
->position
= position
;
7675 /* Load IT with next display element from C string IT->s.
7676 IT->string_nchars is the maximum number of characters to return
7677 from the string. IT->end_charpos may be greater than
7678 IT->string_nchars when this function is called, in which case we
7679 may have to return padding spaces. Value is zero if end of string
7680 reached, including padding spaces. */
7683 next_element_from_c_string (struct it
*it
)
7688 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7689 it
->what
= IT_CHARACTER
;
7690 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7693 /* With bidi reordering, the character to display might not be the
7694 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7695 we were reseated to a new string, whose paragraph direction is
7697 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7698 get_visually_first_element (it
);
7700 /* IT's position can be greater than IT->string_nchars in case a
7701 field width or precision has been specified when the iterator was
7703 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7705 /* End of the game. */
7709 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7711 /* Pad with spaces. */
7712 it
->c
= ' ', it
->len
= 1;
7713 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7715 else if (it
->multibyte_p
)
7716 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7718 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7724 /* Set up IT to return characters from an ellipsis, if appropriate.
7725 The definition of the ellipsis glyphs may come from a display table
7726 entry. This function fills IT with the first glyph from the
7727 ellipsis if an ellipsis is to be displayed. */
7730 next_element_from_ellipsis (struct it
*it
)
7732 if (it
->selective_display_ellipsis_p
)
7733 setup_for_ellipsis (it
, it
->len
);
7736 /* The face at the current position may be different from the
7737 face we find after the invisible text. Remember what it
7738 was in IT->saved_face_id, and signal that it's there by
7739 setting face_before_selective_p. */
7740 it
->saved_face_id
= it
->face_id
;
7741 it
->method
= GET_FROM_BUFFER
;
7742 it
->object
= it
->w
->buffer
;
7743 reseat_at_next_visible_line_start (it
, 1);
7744 it
->face_before_selective_p
= 1;
7747 return GET_NEXT_DISPLAY_ELEMENT (it
);
7751 /* Deliver an image display element. The iterator IT is already
7752 filled with image information (done in handle_display_prop). Value
7757 next_element_from_image (struct it
*it
)
7759 it
->what
= IT_IMAGE
;
7760 it
->ignore_overlay_strings_at_pos_p
= 0;
7765 /* Fill iterator IT with next display element from a stretch glyph
7766 property. IT->object is the value of the text property. Value is
7770 next_element_from_stretch (struct it
*it
)
7772 it
->what
= IT_STRETCH
;
7776 /* Scan backwards from IT's current position until we find a stop
7777 position, or until BEGV. This is called when we find ourself
7778 before both the last known prev_stop and base_level_stop while
7779 reordering bidirectional text. */
7782 compute_stop_pos_backwards (struct it
*it
)
7784 const int SCAN_BACK_LIMIT
= 1000;
7785 struct text_pos pos
;
7786 struct display_pos save_current
= it
->current
;
7787 struct text_pos save_position
= it
->position
;
7788 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7789 ptrdiff_t where_we_are
= charpos
;
7790 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7791 ptrdiff_t save_end_pos
= it
->end_charpos
;
7793 eassert (NILP (it
->string
) && !it
->s
);
7794 eassert (it
->bidi_p
);
7798 it
->end_charpos
= min (charpos
+ 1, ZV
);
7799 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7800 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
7801 reseat_1 (it
, pos
, 0);
7802 compute_stop_pos (it
);
7803 /* We must advance forward, right? */
7804 if (it
->stop_charpos
<= charpos
)
7807 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7809 if (it
->stop_charpos
<= where_we_are
)
7810 it
->prev_stop
= it
->stop_charpos
;
7812 it
->prev_stop
= BEGV
;
7814 it
->current
= save_current
;
7815 it
->position
= save_position
;
7816 it
->stop_charpos
= save_stop_pos
;
7817 it
->end_charpos
= save_end_pos
;
7820 /* Scan forward from CHARPOS in the current buffer/string, until we
7821 find a stop position > current IT's position. Then handle the stop
7822 position before that. This is called when we bump into a stop
7823 position while reordering bidirectional text. CHARPOS should be
7824 the last previously processed stop_pos (or BEGV/0, if none were
7825 processed yet) whose position is less that IT's current
7829 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7831 int bufp
= !STRINGP (it
->string
);
7832 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7833 struct display_pos save_current
= it
->current
;
7834 struct text_pos save_position
= it
->position
;
7835 struct text_pos pos1
;
7836 ptrdiff_t next_stop
;
7838 /* Scan in strict logical order. */
7839 eassert (it
->bidi_p
);
7843 it
->prev_stop
= charpos
;
7846 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7847 reseat_1 (it
, pos1
, 0);
7850 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7851 compute_stop_pos (it
);
7852 /* We must advance forward, right? */
7853 if (it
->stop_charpos
<= it
->prev_stop
)
7855 charpos
= it
->stop_charpos
;
7857 while (charpos
<= where_we_are
);
7860 it
->current
= save_current
;
7861 it
->position
= save_position
;
7862 next_stop
= it
->stop_charpos
;
7863 it
->stop_charpos
= it
->prev_stop
;
7865 it
->stop_charpos
= next_stop
;
7868 /* Load IT with the next display element from current_buffer. Value
7869 is zero if end of buffer reached. IT->stop_charpos is the next
7870 position at which to stop and check for text properties or buffer
7874 next_element_from_buffer (struct it
*it
)
7878 eassert (IT_CHARPOS (*it
) >= BEGV
);
7879 eassert (NILP (it
->string
) && !it
->s
);
7880 eassert (!it
->bidi_p
7881 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7882 && it
->bidi_it
.string
.s
== NULL
));
7884 /* With bidi reordering, the character to display might not be the
7885 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7886 we were reseat()ed to a new buffer position, which is potentially
7887 a different paragraph. */
7888 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7890 get_visually_first_element (it
);
7891 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7894 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7896 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7898 int overlay_strings_follow_p
;
7900 /* End of the game, except when overlay strings follow that
7901 haven't been returned yet. */
7902 if (it
->overlay_strings_at_end_processed_p
)
7903 overlay_strings_follow_p
= 0;
7906 it
->overlay_strings_at_end_processed_p
= 1;
7907 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7910 if (overlay_strings_follow_p
)
7911 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7915 it
->position
= it
->current
.pos
;
7919 else if (!(!it
->bidi_p
7920 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7921 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7923 /* With bidi non-linear iteration, we could find ourselves
7924 far beyond the last computed stop_charpos, with several
7925 other stop positions in between that we missed. Scan
7926 them all now, in buffer's logical order, until we find
7927 and handle the last stop_charpos that precedes our
7928 current position. */
7929 handle_stop_backwards (it
, it
->stop_charpos
);
7930 return GET_NEXT_DISPLAY_ELEMENT (it
);
7936 /* Take note of the stop position we just moved across,
7937 for when we will move back across it. */
7938 it
->prev_stop
= it
->stop_charpos
;
7939 /* If we are at base paragraph embedding level, take
7940 note of the last stop position seen at this
7942 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7943 it
->base_level_stop
= it
->stop_charpos
;
7946 return GET_NEXT_DISPLAY_ELEMENT (it
);
7950 /* If we are before prev_stop, we may have overstepped on
7951 our way backwards a stop_pos, and if so, we need to
7952 handle that stop_pos. */
7953 && IT_CHARPOS (*it
) < it
->prev_stop
7954 /* We can sometimes back up for reasons that have nothing
7955 to do with bidi reordering. E.g., compositions. The
7956 code below is only needed when we are above the base
7957 embedding level, so test for that explicitly. */
7958 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7960 if (it
->base_level_stop
<= 0
7961 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7963 /* If we lost track of base_level_stop, we need to find
7964 prev_stop by looking backwards. This happens, e.g., when
7965 we were reseated to the previous screenful of text by
7967 it
->base_level_stop
= BEGV
;
7968 compute_stop_pos_backwards (it
);
7969 handle_stop_backwards (it
, it
->prev_stop
);
7972 handle_stop_backwards (it
, it
->base_level_stop
);
7973 return GET_NEXT_DISPLAY_ELEMENT (it
);
7977 /* No face changes, overlays etc. in sight, so just return a
7978 character from current_buffer. */
7982 /* Maybe run the redisplay end trigger hook. Performance note:
7983 This doesn't seem to cost measurable time. */
7984 if (it
->redisplay_end_trigger_charpos
7986 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7987 run_redisplay_end_trigger_hook (it
);
7989 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7990 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7992 && next_element_from_composition (it
))
7997 /* Get the next character, maybe multibyte. */
7998 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7999 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
8000 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8002 it
->c
= *p
, it
->len
= 1;
8004 /* Record what we have and where it came from. */
8005 it
->what
= IT_CHARACTER
;
8006 it
->object
= it
->w
->buffer
;
8007 it
->position
= it
->current
.pos
;
8009 /* Normally we return the character found above, except when we
8010 really want to return an ellipsis for selective display. */
8015 /* A value of selective > 0 means hide lines indented more
8016 than that number of columns. */
8017 if (it
->selective
> 0
8018 && IT_CHARPOS (*it
) + 1 < ZV
8019 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8020 IT_BYTEPOS (*it
) + 1,
8023 success_p
= next_element_from_ellipsis (it
);
8024 it
->dpvec_char_len
= -1;
8027 else if (it
->c
== '\r' && it
->selective
== -1)
8029 /* A value of selective == -1 means that everything from the
8030 CR to the end of the line is invisible, with maybe an
8031 ellipsis displayed for it. */
8032 success_p
= next_element_from_ellipsis (it
);
8033 it
->dpvec_char_len
= -1;
8038 /* Value is zero if end of buffer reached. */
8039 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8044 /* Run the redisplay end trigger hook for IT. */
8047 run_redisplay_end_trigger_hook (struct it
*it
)
8049 Lisp_Object args
[3];
8051 /* IT->glyph_row should be non-null, i.e. we should be actually
8052 displaying something, or otherwise we should not run the hook. */
8053 eassert (it
->glyph_row
);
8055 /* Set up hook arguments. */
8056 args
[0] = Qredisplay_end_trigger_functions
;
8057 args
[1] = it
->window
;
8058 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8059 it
->redisplay_end_trigger_charpos
= 0;
8061 /* Since we are *trying* to run these functions, don't try to run
8062 them again, even if they get an error. */
8063 wset_redisplay_end_trigger (it
->w
, Qnil
);
8064 Frun_hook_with_args (3, args
);
8066 /* Notice if it changed the face of the character we are on. */
8067 handle_face_prop (it
);
8071 /* Deliver a composition display element. Unlike the other
8072 next_element_from_XXX, this function is not registered in the array
8073 get_next_element[]. It is called from next_element_from_buffer and
8074 next_element_from_string when necessary. */
8077 next_element_from_composition (struct it
*it
)
8079 it
->what
= IT_COMPOSITION
;
8080 it
->len
= it
->cmp_it
.nbytes
;
8081 if (STRINGP (it
->string
))
8085 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8086 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8089 it
->position
= it
->current
.string_pos
;
8090 it
->object
= it
->string
;
8091 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8092 IT_STRING_BYTEPOS (*it
), it
->string
);
8098 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8099 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8102 if (it
->bidi_it
.new_paragraph
)
8103 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8104 /* Resync the bidi iterator with IT's new position.
8105 FIXME: this doesn't support bidirectional text. */
8106 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8107 bidi_move_to_visually_next (&it
->bidi_it
);
8111 it
->position
= it
->current
.pos
;
8112 it
->object
= it
->w
->buffer
;
8113 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8114 IT_BYTEPOS (*it
), Qnil
);
8121 /***********************************************************************
8122 Moving an iterator without producing glyphs
8123 ***********************************************************************/
8125 /* Check if iterator is at a position corresponding to a valid buffer
8126 position after some move_it_ call. */
8128 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8129 ((it)->method == GET_FROM_STRING \
8130 ? IT_STRING_CHARPOS (*it) == 0 \
8134 /* Move iterator IT to a specified buffer or X position within one
8135 line on the display without producing glyphs.
8137 OP should be a bit mask including some or all of these bits:
8138 MOVE_TO_X: Stop upon reaching x-position TO_X.
8139 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8140 Regardless of OP's value, stop upon reaching the end of the display line.
8142 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8143 This means, in particular, that TO_X includes window's horizontal
8146 The return value has several possible values that
8147 say what condition caused the scan to stop:
8149 MOVE_POS_MATCH_OR_ZV
8150 - when TO_POS or ZV was reached.
8153 -when TO_X was reached before TO_POS or ZV were reached.
8156 - when we reached the end of the display area and the line must
8160 - when we reached the end of the display area and the line is
8164 - when we stopped at a line end, i.e. a newline or a CR and selective
8167 static enum move_it_result
8168 move_it_in_display_line_to (struct it
*it
,
8169 ptrdiff_t to_charpos
, int to_x
,
8170 enum move_operation_enum op
)
8172 enum move_it_result result
= MOVE_UNDEFINED
;
8173 struct glyph_row
*saved_glyph_row
;
8174 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8175 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8176 void *ppos_data
= NULL
;
8178 enum it_method prev_method
= it
->method
;
8179 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8180 int saw_smaller_pos
= prev_pos
< to_charpos
;
8182 /* Don't produce glyphs in produce_glyphs. */
8183 saved_glyph_row
= it
->glyph_row
;
8184 it
->glyph_row
= NULL
;
8186 /* Use wrap_it to save a copy of IT wherever a word wrap could
8187 occur. Use atpos_it to save a copy of IT at the desired buffer
8188 position, if found, so that we can scan ahead and check if the
8189 word later overshoots the window edge. Use atx_it similarly, for
8195 /* Use ppos_it under bidi reordering to save a copy of IT for the
8196 position > CHARPOS that is the closest to CHARPOS. We restore
8197 that position in IT when we have scanned the entire display line
8198 without finding a match for CHARPOS and all the character
8199 positions are greater than CHARPOS. */
8202 SAVE_IT (ppos_it
, *it
, ppos_data
);
8203 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8204 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8205 SAVE_IT (ppos_it
, *it
, ppos_data
);
8208 #define BUFFER_POS_REACHED_P() \
8209 ((op & MOVE_TO_POS) != 0 \
8210 && BUFFERP (it->object) \
8211 && (IT_CHARPOS (*it) == to_charpos \
8213 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8214 && IT_CHARPOS (*it) > to_charpos) \
8215 || (it->what == IT_COMPOSITION \
8216 && ((IT_CHARPOS (*it) > to_charpos \
8217 && to_charpos >= it->cmp_it.charpos) \
8218 || (IT_CHARPOS (*it) < to_charpos \
8219 && to_charpos <= it->cmp_it.charpos)))) \
8220 && (it->method == GET_FROM_BUFFER \
8221 || (it->method == GET_FROM_DISPLAY_VECTOR \
8222 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8224 /* If there's a line-/wrap-prefix, handle it. */
8225 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8226 && it
->current_y
< it
->last_visible_y
)
8227 handle_line_prefix (it
);
8229 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8230 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8234 int x
, i
, ascent
= 0, descent
= 0;
8236 /* Utility macro to reset an iterator with x, ascent, and descent. */
8237 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8238 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8239 (IT)->max_descent = descent)
8241 /* Stop if we move beyond TO_CHARPOS (after an image or a
8242 display string or stretch glyph). */
8243 if ((op
& MOVE_TO_POS
) != 0
8244 && BUFFERP (it
->object
)
8245 && it
->method
== GET_FROM_BUFFER
8247 /* When the iterator is at base embedding level, we
8248 are guaranteed that characters are delivered for
8249 display in strictly increasing order of their
8250 buffer positions. */
8251 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8252 && IT_CHARPOS (*it
) > to_charpos
)
8254 && (prev_method
== GET_FROM_IMAGE
8255 || prev_method
== GET_FROM_STRETCH
8256 || prev_method
== GET_FROM_STRING
)
8257 /* Passed TO_CHARPOS from left to right. */
8258 && ((prev_pos
< to_charpos
8259 && IT_CHARPOS (*it
) > to_charpos
)
8260 /* Passed TO_CHARPOS from right to left. */
8261 || (prev_pos
> to_charpos
8262 && IT_CHARPOS (*it
) < to_charpos
)))))
8264 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8266 result
= MOVE_POS_MATCH_OR_ZV
;
8269 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8270 /* If wrap_it is valid, the current position might be in a
8271 word that is wrapped. So, save the iterator in
8272 atpos_it and continue to see if wrapping happens. */
8273 SAVE_IT (atpos_it
, *it
, atpos_data
);
8276 /* Stop when ZV reached.
8277 We used to stop here when TO_CHARPOS reached as well, but that is
8278 too soon if this glyph does not fit on this line. So we handle it
8279 explicitly below. */
8280 if (!get_next_display_element (it
))
8282 result
= MOVE_POS_MATCH_OR_ZV
;
8286 if (it
->line_wrap
== TRUNCATE
)
8288 if (BUFFER_POS_REACHED_P ())
8290 result
= MOVE_POS_MATCH_OR_ZV
;
8296 if (it
->line_wrap
== WORD_WRAP
)
8298 if (IT_DISPLAYING_WHITESPACE (it
))
8302 /* We have reached a glyph that follows one or more
8303 whitespace characters. If the position is
8304 already found, we are done. */
8305 if (atpos_it
.sp
>= 0)
8307 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8308 result
= MOVE_POS_MATCH_OR_ZV
;
8313 RESTORE_IT (it
, &atx_it
, atx_data
);
8314 result
= MOVE_X_REACHED
;
8317 /* Otherwise, we can wrap here. */
8318 SAVE_IT (wrap_it
, *it
, wrap_data
);
8324 /* Remember the line height for the current line, in case
8325 the next element doesn't fit on the line. */
8326 ascent
= it
->max_ascent
;
8327 descent
= it
->max_descent
;
8329 /* The call to produce_glyphs will get the metrics of the
8330 display element IT is loaded with. Record the x-position
8331 before this display element, in case it doesn't fit on the
8335 PRODUCE_GLYPHS (it
);
8337 if (it
->area
!= TEXT_AREA
)
8339 prev_method
= it
->method
;
8340 if (it
->method
== GET_FROM_BUFFER
)
8341 prev_pos
= IT_CHARPOS (*it
);
8342 set_iterator_to_next (it
, 1);
8343 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8344 SET_TEXT_POS (this_line_min_pos
,
8345 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8347 && (op
& MOVE_TO_POS
)
8348 && IT_CHARPOS (*it
) > to_charpos
8349 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8350 SAVE_IT (ppos_it
, *it
, ppos_data
);
8354 /* The number of glyphs we get back in IT->nglyphs will normally
8355 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8356 character on a terminal frame, or (iii) a line end. For the
8357 second case, IT->nglyphs - 1 padding glyphs will be present.
8358 (On X frames, there is only one glyph produced for a
8359 composite character.)
8361 The behavior implemented below means, for continuation lines,
8362 that as many spaces of a TAB as fit on the current line are
8363 displayed there. For terminal frames, as many glyphs of a
8364 multi-glyph character are displayed in the current line, too.
8365 This is what the old redisplay code did, and we keep it that
8366 way. Under X, the whole shape of a complex character must
8367 fit on the line or it will be completely displayed in the
8370 Note that both for tabs and padding glyphs, all glyphs have
8374 /* More than one glyph or glyph doesn't fit on line. All
8375 glyphs have the same width. */
8376 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8378 int x_before_this_char
= x
;
8379 int hpos_before_this_char
= it
->hpos
;
8381 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8383 new_x
= x
+ single_glyph_width
;
8385 /* We want to leave anything reaching TO_X to the caller. */
8386 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8388 if (BUFFER_POS_REACHED_P ())
8390 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8391 goto buffer_pos_reached
;
8392 if (atpos_it
.sp
< 0)
8394 SAVE_IT (atpos_it
, *it
, atpos_data
);
8395 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8400 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8403 result
= MOVE_X_REACHED
;
8408 SAVE_IT (atx_it
, *it
, atx_data
);
8409 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8414 if (/* Lines are continued. */
8415 it
->line_wrap
!= TRUNCATE
8416 && (/* And glyph doesn't fit on the line. */
8417 new_x
> it
->last_visible_x
8418 /* Or it fits exactly and we're on a window
8420 || (new_x
== it
->last_visible_x
8421 && FRAME_WINDOW_P (it
->f
)
8422 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8423 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8424 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8426 if (/* IT->hpos == 0 means the very first glyph
8427 doesn't fit on the line, e.g. a wide image. */
8429 || (new_x
== it
->last_visible_x
8430 && FRAME_WINDOW_P (it
->f
)))
8433 it
->current_x
= new_x
;
8435 /* The character's last glyph just barely fits
8437 if (i
== it
->nglyphs
- 1)
8439 /* If this is the destination position,
8440 return a position *before* it in this row,
8441 now that we know it fits in this row. */
8442 if (BUFFER_POS_REACHED_P ())
8444 if (it
->line_wrap
!= WORD_WRAP
8447 it
->hpos
= hpos_before_this_char
;
8448 it
->current_x
= x_before_this_char
;
8449 result
= MOVE_POS_MATCH_OR_ZV
;
8452 if (it
->line_wrap
== WORD_WRAP
8455 SAVE_IT (atpos_it
, *it
, atpos_data
);
8456 atpos_it
.current_x
= x_before_this_char
;
8457 atpos_it
.hpos
= hpos_before_this_char
;
8461 prev_method
= it
->method
;
8462 if (it
->method
== GET_FROM_BUFFER
)
8463 prev_pos
= IT_CHARPOS (*it
);
8464 set_iterator_to_next (it
, 1);
8465 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8466 SET_TEXT_POS (this_line_min_pos
,
8467 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8468 /* On graphical terminals, newlines may
8469 "overflow" into the fringe if
8470 overflow-newline-into-fringe is non-nil.
8471 On text terminals, and on graphical
8472 terminals with no right margin, newlines
8473 may overflow into the last glyph on the
8475 if (!FRAME_WINDOW_P (it
->f
)
8477 && it
->bidi_it
.paragraph_dir
== R2L
)
8478 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8479 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8480 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8482 if (!get_next_display_element (it
))
8484 result
= MOVE_POS_MATCH_OR_ZV
;
8487 if (BUFFER_POS_REACHED_P ())
8489 if (ITERATOR_AT_END_OF_LINE_P (it
))
8490 result
= MOVE_POS_MATCH_OR_ZV
;
8492 result
= MOVE_LINE_CONTINUED
;
8495 if (ITERATOR_AT_END_OF_LINE_P (it
))
8497 result
= MOVE_NEWLINE_OR_CR
;
8504 IT_RESET_X_ASCENT_DESCENT (it
);
8506 if (wrap_it
.sp
>= 0)
8508 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8513 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8515 result
= MOVE_LINE_CONTINUED
;
8519 if (BUFFER_POS_REACHED_P ())
8521 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8522 goto buffer_pos_reached
;
8523 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8525 SAVE_IT (atpos_it
, *it
, atpos_data
);
8526 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8530 if (new_x
> it
->first_visible_x
)
8532 /* Glyph is visible. Increment number of glyphs that
8533 would be displayed. */
8538 if (result
!= MOVE_UNDEFINED
)
8541 else if (BUFFER_POS_REACHED_P ())
8544 IT_RESET_X_ASCENT_DESCENT (it
);
8545 result
= MOVE_POS_MATCH_OR_ZV
;
8548 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8550 /* Stop when TO_X specified and reached. This check is
8551 necessary here because of lines consisting of a line end,
8552 only. The line end will not produce any glyphs and we
8553 would never get MOVE_X_REACHED. */
8554 eassert (it
->nglyphs
== 0);
8555 result
= MOVE_X_REACHED
;
8559 /* Is this a line end? If yes, we're done. */
8560 if (ITERATOR_AT_END_OF_LINE_P (it
))
8562 /* If we are past TO_CHARPOS, but never saw any character
8563 positions smaller than TO_CHARPOS, return
8564 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8566 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8568 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8570 if (IT_CHARPOS (ppos_it
) < ZV
)
8572 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8573 result
= MOVE_POS_MATCH_OR_ZV
;
8576 goto buffer_pos_reached
;
8578 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8579 && IT_CHARPOS (*it
) > to_charpos
)
8580 goto buffer_pos_reached
;
8582 result
= MOVE_NEWLINE_OR_CR
;
8585 result
= MOVE_NEWLINE_OR_CR
;
8589 prev_method
= it
->method
;
8590 if (it
->method
== GET_FROM_BUFFER
)
8591 prev_pos
= IT_CHARPOS (*it
);
8592 /* The current display element has been consumed. Advance
8594 set_iterator_to_next (it
, 1);
8595 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8596 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8597 if (IT_CHARPOS (*it
) < to_charpos
)
8598 saw_smaller_pos
= 1;
8600 && (op
& MOVE_TO_POS
)
8601 && IT_CHARPOS (*it
) >= to_charpos
8602 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8603 SAVE_IT (ppos_it
, *it
, ppos_data
);
8605 /* Stop if lines are truncated and IT's current x-position is
8606 past the right edge of the window now. */
8607 if (it
->line_wrap
== TRUNCATE
8608 && it
->current_x
>= it
->last_visible_x
)
8610 if (!FRAME_WINDOW_P (it
->f
)
8611 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8612 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8613 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8614 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8618 if ((at_eob_p
= !get_next_display_element (it
))
8619 || BUFFER_POS_REACHED_P ()
8620 /* If we are past TO_CHARPOS, but never saw any
8621 character positions smaller than TO_CHARPOS,
8622 return MOVE_POS_MATCH_OR_ZV, like the
8623 unidirectional display did. */
8624 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8626 && IT_CHARPOS (*it
) > to_charpos
))
8629 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8630 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8631 result
= MOVE_POS_MATCH_OR_ZV
;
8634 if (ITERATOR_AT_END_OF_LINE_P (it
))
8636 result
= MOVE_NEWLINE_OR_CR
;
8640 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8642 && IT_CHARPOS (*it
) > to_charpos
)
8644 if (IT_CHARPOS (ppos_it
) < ZV
)
8645 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8646 result
= MOVE_POS_MATCH_OR_ZV
;
8649 result
= MOVE_LINE_TRUNCATED
;
8652 #undef IT_RESET_X_ASCENT_DESCENT
8655 #undef BUFFER_POS_REACHED_P
8657 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8658 restore the saved iterator. */
8659 if (atpos_it
.sp
>= 0)
8660 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8661 else if (atx_it
.sp
>= 0)
8662 RESTORE_IT (it
, &atx_it
, atx_data
);
8667 bidi_unshelve_cache (atpos_data
, 1);
8669 bidi_unshelve_cache (atx_data
, 1);
8671 bidi_unshelve_cache (wrap_data
, 1);
8673 bidi_unshelve_cache (ppos_data
, 1);
8675 /* Restore the iterator settings altered at the beginning of this
8677 it
->glyph_row
= saved_glyph_row
;
8681 /* For external use. */
8683 move_it_in_display_line (struct it
*it
,
8684 ptrdiff_t to_charpos
, int to_x
,
8685 enum move_operation_enum op
)
8687 if (it
->line_wrap
== WORD_WRAP
8688 && (op
& MOVE_TO_X
))
8691 void *save_data
= NULL
;
8694 SAVE_IT (save_it
, *it
, save_data
);
8695 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8696 /* When word-wrap is on, TO_X may lie past the end
8697 of a wrapped line. Then it->current is the
8698 character on the next line, so backtrack to the
8699 space before the wrap point. */
8700 if (skip
== MOVE_LINE_CONTINUED
)
8702 int prev_x
= max (it
->current_x
- 1, 0);
8703 RESTORE_IT (it
, &save_it
, save_data
);
8704 move_it_in_display_line_to
8705 (it
, -1, prev_x
, MOVE_TO_X
);
8708 bidi_unshelve_cache (save_data
, 1);
8711 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8715 /* Move IT forward until it satisfies one or more of the criteria in
8716 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8718 OP is a bit-mask that specifies where to stop, and in particular,
8719 which of those four position arguments makes a difference. See the
8720 description of enum move_operation_enum.
8722 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8723 screen line, this function will set IT to the next position that is
8724 displayed to the right of TO_CHARPOS on the screen. */
8727 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8729 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8730 int line_height
, line_start_x
= 0, reached
= 0;
8731 void *backup_data
= NULL
;
8735 if (op
& MOVE_TO_VPOS
)
8737 /* If no TO_CHARPOS and no TO_X specified, stop at the
8738 start of the line TO_VPOS. */
8739 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8741 if (it
->vpos
== to_vpos
)
8747 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8751 /* TO_VPOS >= 0 means stop at TO_X in the line at
8752 TO_VPOS, or at TO_POS, whichever comes first. */
8753 if (it
->vpos
== to_vpos
)
8759 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8761 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8766 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8768 /* We have reached TO_X but not in the line we want. */
8769 skip
= move_it_in_display_line_to (it
, to_charpos
,
8771 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8779 else if (op
& MOVE_TO_Y
)
8781 struct it it_backup
;
8783 if (it
->line_wrap
== WORD_WRAP
)
8784 SAVE_IT (it_backup
, *it
, backup_data
);
8786 /* TO_Y specified means stop at TO_X in the line containing
8787 TO_Y---or at TO_CHARPOS if this is reached first. The
8788 problem is that we can't really tell whether the line
8789 contains TO_Y before we have completely scanned it, and
8790 this may skip past TO_X. What we do is to first scan to
8793 If TO_X is not specified, use a TO_X of zero. The reason
8794 is to make the outcome of this function more predictable.
8795 If we didn't use TO_X == 0, we would stop at the end of
8796 the line which is probably not what a caller would expect
8798 skip
= move_it_in_display_line_to
8799 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8800 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8802 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8803 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8805 else if (skip
== MOVE_X_REACHED
)
8807 /* If TO_X was reached, we want to know whether TO_Y is
8808 in the line. We know this is the case if the already
8809 scanned glyphs make the line tall enough. Otherwise,
8810 we must check by scanning the rest of the line. */
8811 line_height
= it
->max_ascent
+ it
->max_descent
;
8812 if (to_y
>= it
->current_y
8813 && to_y
< it
->current_y
+ line_height
)
8818 SAVE_IT (it_backup
, *it
, backup_data
);
8819 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8820 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8822 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8823 line_height
= it
->max_ascent
+ it
->max_descent
;
8824 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8826 if (to_y
>= it
->current_y
8827 && to_y
< it
->current_y
+ line_height
)
8829 /* If TO_Y is in this line and TO_X was reached
8830 above, we scanned too far. We have to restore
8831 IT's settings to the ones before skipping. But
8832 keep the more accurate values of max_ascent and
8833 max_descent we've found while skipping the rest
8834 of the line, for the sake of callers, such as
8835 pos_visible_p, that need to know the line
8837 int max_ascent
= it
->max_ascent
;
8838 int max_descent
= it
->max_descent
;
8840 RESTORE_IT (it
, &it_backup
, backup_data
);
8841 it
->max_ascent
= max_ascent
;
8842 it
->max_descent
= max_descent
;
8848 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8854 /* Check whether TO_Y is in this line. */
8855 line_height
= it
->max_ascent
+ it
->max_descent
;
8856 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8858 if (to_y
>= it
->current_y
8859 && to_y
< it
->current_y
+ line_height
)
8861 /* When word-wrap is on, TO_X may lie past the end
8862 of a wrapped line. Then it->current is the
8863 character on the next line, so backtrack to the
8864 space before the wrap point. */
8865 if (skip
== MOVE_LINE_CONTINUED
8866 && it
->line_wrap
== WORD_WRAP
)
8868 int prev_x
= max (it
->current_x
- 1, 0);
8869 RESTORE_IT (it
, &it_backup
, backup_data
);
8870 skip
= move_it_in_display_line_to
8871 (it
, -1, prev_x
, MOVE_TO_X
);
8880 else if (BUFFERP (it
->object
)
8881 && (it
->method
== GET_FROM_BUFFER
8882 || it
->method
== GET_FROM_STRETCH
)
8883 && IT_CHARPOS (*it
) >= to_charpos
8884 /* Under bidi iteration, a call to set_iterator_to_next
8885 can scan far beyond to_charpos if the initial
8886 portion of the next line needs to be reordered. In
8887 that case, give move_it_in_display_line_to another
8890 && it
->bidi_it
.scan_dir
== -1))
8891 skip
= MOVE_POS_MATCH_OR_ZV
;
8893 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8897 case MOVE_POS_MATCH_OR_ZV
:
8901 case MOVE_NEWLINE_OR_CR
:
8902 set_iterator_to_next (it
, 1);
8903 it
->continuation_lines_width
= 0;
8906 case MOVE_LINE_TRUNCATED
:
8907 it
->continuation_lines_width
= 0;
8908 reseat_at_next_visible_line_start (it
, 0);
8909 if ((op
& MOVE_TO_POS
) != 0
8910 && IT_CHARPOS (*it
) > to_charpos
)
8917 case MOVE_LINE_CONTINUED
:
8918 /* For continued lines ending in a tab, some of the glyphs
8919 associated with the tab are displayed on the current
8920 line. Since it->current_x does not include these glyphs,
8921 we use it->last_visible_x instead. */
8924 it
->continuation_lines_width
+= it
->last_visible_x
;
8925 /* When moving by vpos, ensure that the iterator really
8926 advances to the next line (bug#847, bug#969). Fixme:
8927 do we need to do this in other circumstances? */
8928 if (it
->current_x
!= it
->last_visible_x
8929 && (op
& MOVE_TO_VPOS
)
8930 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8932 line_start_x
= it
->current_x
+ it
->pixel_width
8933 - it
->last_visible_x
;
8934 set_iterator_to_next (it
, 0);
8938 it
->continuation_lines_width
+= it
->current_x
;
8945 /* Reset/increment for the next run. */
8946 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8947 it
->current_x
= line_start_x
;
8950 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8952 last_height
= it
->max_ascent
+ it
->max_descent
;
8953 last_max_ascent
= it
->max_ascent
;
8954 it
->max_ascent
= it
->max_descent
= 0;
8959 /* On text terminals, we may stop at the end of a line in the middle
8960 of a multi-character glyph. If the glyph itself is continued,
8961 i.e. it is actually displayed on the next line, don't treat this
8962 stopping point as valid; move to the next line instead (unless
8963 that brings us offscreen). */
8964 if (!FRAME_WINDOW_P (it
->f
)
8966 && IT_CHARPOS (*it
) == to_charpos
8967 && it
->what
== IT_CHARACTER
8969 && it
->line_wrap
== WINDOW_WRAP
8970 && it
->current_x
== it
->last_visible_x
- 1
8973 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8975 it
->continuation_lines_width
+= it
->current_x
;
8976 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8977 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8979 last_height
= it
->max_ascent
+ it
->max_descent
;
8980 last_max_ascent
= it
->max_ascent
;
8984 bidi_unshelve_cache (backup_data
, 1);
8986 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8990 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8992 If DY > 0, move IT backward at least that many pixels. DY = 0
8993 means move IT backward to the preceding line start or BEGV. This
8994 function may move over more than DY pixels if IT->current_y - DY
8995 ends up in the middle of a line; in this case IT->current_y will be
8996 set to the top of the line moved to. */
8999 move_it_vertically_backward (struct it
*it
, int dy
)
9003 void *it2data
= NULL
, *it3data
= NULL
;
9004 ptrdiff_t start_pos
;
9009 start_pos
= IT_CHARPOS (*it
);
9011 /* Estimate how many newlines we must move back. */
9012 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
9014 /* Set the iterator's position that many lines back. */
9015 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
9016 back_to_previous_visible_line_start (it
);
9018 /* Reseat the iterator here. When moving backward, we don't want
9019 reseat to skip forward over invisible text, set up the iterator
9020 to deliver from overlay strings at the new position etc. So,
9021 use reseat_1 here. */
9022 reseat_1 (it
, it
->current
.pos
, 1);
9024 /* We are now surely at a line start. */
9025 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9026 reordering is in effect. */
9027 it
->continuation_lines_width
= 0;
9029 /* Move forward and see what y-distance we moved. First move to the
9030 start of the next line so that we get its height. We need this
9031 height to be able to tell whether we reached the specified
9033 SAVE_IT (it2
, *it
, it2data
);
9034 it2
.max_ascent
= it2
.max_descent
= 0;
9037 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9038 MOVE_TO_POS
| MOVE_TO_VPOS
);
9040 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9041 /* If we are in a display string which starts at START_POS,
9042 and that display string includes a newline, and we are
9043 right after that newline (i.e. at the beginning of a
9044 display line), exit the loop, because otherwise we will
9045 infloop, since move_it_to will see that it is already at
9046 START_POS and will not move. */
9047 || (it2
.method
== GET_FROM_STRING
9048 && IT_CHARPOS (it2
) == start_pos
9049 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9050 eassert (IT_CHARPOS (*it
) >= BEGV
);
9051 SAVE_IT (it3
, it2
, it3data
);
9053 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9054 eassert (IT_CHARPOS (*it
) >= BEGV
);
9055 /* H is the actual vertical distance from the position in *IT
9056 and the starting position. */
9057 h
= it2
.current_y
- it
->current_y
;
9058 /* NLINES is the distance in number of lines. */
9059 nlines
= it2
.vpos
- it
->vpos
;
9061 /* Correct IT's y and vpos position
9062 so that they are relative to the starting point. */
9068 /* DY == 0 means move to the start of the screen line. The
9069 value of nlines is > 0 if continuation lines were involved,
9070 or if the original IT position was at start of a line. */
9071 RESTORE_IT (it
, it
, it2data
);
9073 move_it_by_lines (it
, nlines
);
9074 /* The above code moves us to some position NLINES down,
9075 usually to its first glyph (leftmost in an L2R line), but
9076 that's not necessarily the start of the line, under bidi
9077 reordering. We want to get to the character position
9078 that is immediately after the newline of the previous
9081 && !it
->continuation_lines_width
9082 && !STRINGP (it
->string
)
9083 && IT_CHARPOS (*it
) > BEGV
9084 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9087 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
9089 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
9091 bidi_unshelve_cache (it3data
, 1);
9095 /* The y-position we try to reach, relative to *IT.
9096 Note that H has been subtracted in front of the if-statement. */
9097 int target_y
= it
->current_y
+ h
- dy
;
9098 int y0
= it3
.current_y
;
9102 RESTORE_IT (&it3
, &it3
, it3data
);
9103 y1
= line_bottom_y (&it3
);
9104 line_height
= y1
- y0
;
9105 RESTORE_IT (it
, it
, it2data
);
9106 /* If we did not reach target_y, try to move further backward if
9107 we can. If we moved too far backward, try to move forward. */
9108 if (target_y
< it
->current_y
9109 /* This is heuristic. In a window that's 3 lines high, with
9110 a line height of 13 pixels each, recentering with point
9111 on the bottom line will try to move -39/2 = 19 pixels
9112 backward. Try to avoid moving into the first line. */
9113 && (it
->current_y
- target_y
9114 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9115 && IT_CHARPOS (*it
) > BEGV
)
9117 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9118 target_y
- it
->current_y
));
9119 dy
= it
->current_y
- target_y
;
9120 goto move_further_back
;
9122 else if (target_y
>= it
->current_y
+ line_height
9123 && IT_CHARPOS (*it
) < ZV
)
9125 /* Should move forward by at least one line, maybe more.
9127 Note: Calling move_it_by_lines can be expensive on
9128 terminal frames, where compute_motion is used (via
9129 vmotion) to do the job, when there are very long lines
9130 and truncate-lines is nil. That's the reason for
9131 treating terminal frames specially here. */
9133 if (!FRAME_WINDOW_P (it
->f
))
9134 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9139 move_it_by_lines (it
, 1);
9141 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9148 /* Move IT by a specified amount of pixel lines DY. DY negative means
9149 move backwards. DY = 0 means move to start of screen line. At the
9150 end, IT will be on the start of a screen line. */
9153 move_it_vertically (struct it
*it
, int dy
)
9156 move_it_vertically_backward (it
, -dy
);
9159 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9160 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9161 MOVE_TO_POS
| MOVE_TO_Y
);
9162 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9164 /* If buffer ends in ZV without a newline, move to the start of
9165 the line to satisfy the post-condition. */
9166 if (IT_CHARPOS (*it
) == ZV
9168 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9169 move_it_by_lines (it
, 0);
9174 /* Move iterator IT past the end of the text line it is in. */
9177 move_it_past_eol (struct it
*it
)
9179 enum move_it_result rc
;
9181 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9182 if (rc
== MOVE_NEWLINE_OR_CR
)
9183 set_iterator_to_next (it
, 0);
9187 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9188 negative means move up. DVPOS == 0 means move to the start of the
9191 Optimization idea: If we would know that IT->f doesn't use
9192 a face with proportional font, we could be faster for
9193 truncate-lines nil. */
9196 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9199 /* The commented-out optimization uses vmotion on terminals. This
9200 gives bad results, because elements like it->what, on which
9201 callers such as pos_visible_p rely, aren't updated. */
9202 /* struct position pos;
9203 if (!FRAME_WINDOW_P (it->f))
9205 struct text_pos textpos;
9207 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9208 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9209 reseat (it, textpos, 1);
9210 it->vpos += pos.vpos;
9211 it->current_y += pos.vpos;
9217 /* DVPOS == 0 means move to the start of the screen line. */
9218 move_it_vertically_backward (it
, 0);
9219 /* Let next call to line_bottom_y calculate real line height */
9224 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9225 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9227 /* Only move to the next buffer position if we ended up in a
9228 string from display property, not in an overlay string
9229 (before-string or after-string). That is because the
9230 latter don't conceal the underlying buffer position, so
9231 we can ask to move the iterator to the exact position we
9232 are interested in. Note that, even if we are already at
9233 IT_CHARPOS (*it), the call below is not a no-op, as it
9234 will detect that we are at the end of the string, pop the
9235 iterator, and compute it->current_x and it->hpos
9237 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9238 -1, -1, -1, MOVE_TO_POS
);
9244 void *it2data
= NULL
;
9245 ptrdiff_t start_charpos
, i
;
9247 /* Start at the beginning of the screen line containing IT's
9248 position. This may actually move vertically backwards,
9249 in case of overlays, so adjust dvpos accordingly. */
9251 move_it_vertically_backward (it
, 0);
9254 /* Go back -DVPOS visible lines and reseat the iterator there. */
9255 start_charpos
= IT_CHARPOS (*it
);
9256 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
9257 back_to_previous_visible_line_start (it
);
9258 reseat (it
, it
->current
.pos
, 1);
9260 /* Move further back if we end up in a string or an image. */
9261 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9263 /* First try to move to start of display line. */
9265 move_it_vertically_backward (it
, 0);
9267 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9269 /* If start of line is still in string or image,
9270 move further back. */
9271 back_to_previous_visible_line_start (it
);
9272 reseat (it
, it
->current
.pos
, 1);
9276 it
->current_x
= it
->hpos
= 0;
9278 /* Above call may have moved too far if continuation lines
9279 are involved. Scan forward and see if it did. */
9280 SAVE_IT (it2
, *it
, it2data
);
9281 it2
.vpos
= it2
.current_y
= 0;
9282 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9283 it
->vpos
-= it2
.vpos
;
9284 it
->current_y
-= it2
.current_y
;
9285 it
->current_x
= it
->hpos
= 0;
9287 /* If we moved too far back, move IT some lines forward. */
9288 if (it2
.vpos
> -dvpos
)
9290 int delta
= it2
.vpos
+ dvpos
;
9292 RESTORE_IT (&it2
, &it2
, it2data
);
9293 SAVE_IT (it2
, *it
, it2data
);
9294 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9295 /* Move back again if we got too far ahead. */
9296 if (IT_CHARPOS (*it
) >= start_charpos
)
9297 RESTORE_IT (it
, &it2
, it2data
);
9299 bidi_unshelve_cache (it2data
, 1);
9302 RESTORE_IT (it
, it
, it2data
);
9306 /* Return 1 if IT points into the middle of a display vector. */
9309 in_display_vector_p (struct it
*it
)
9311 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9312 && it
->current
.dpvec_index
> 0
9313 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9317 /***********************************************************************
9319 ***********************************************************************/
9322 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9326 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9328 Lisp_Object args
[3];
9329 Lisp_Object msg
, fmt
;
9332 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9336 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9338 args
[0] = fmt
= build_string (format
);
9341 msg
= Fformat (3, args
);
9343 len
= SBYTES (msg
) + 1;
9344 buffer
= SAFE_ALLOCA (len
);
9345 memcpy (buffer
, SDATA (msg
), len
);
9347 message_dolog (buffer
, len
- 1, 1, 0);
9354 /* Output a newline in the *Messages* buffer if "needs" one. */
9357 message_log_maybe_newline (void)
9359 if (message_log_need_newline
)
9360 message_dolog ("", 0, 1, 0);
9364 /* Add a string M of length NBYTES to the message log, optionally
9365 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9366 nonzero, means interpret the contents of M as multibyte. This
9367 function calls low-level routines in order to bypass text property
9368 hooks, etc. which might not be safe to run.
9370 This may GC (insert may run before/after change hooks),
9371 so the buffer M must NOT point to a Lisp string. */
9374 message_dolog (const char *m
, ptrdiff_t nbytes
, int nlflag
, int multibyte
)
9376 const unsigned char *msg
= (const unsigned char *) m
;
9378 if (!NILP (Vmemory_full
))
9381 if (!NILP (Vmessage_log_max
))
9383 struct buffer
*oldbuf
;
9384 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9385 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9386 ptrdiff_t point_at_end
= 0;
9387 ptrdiff_t zv_at_end
= 0;
9388 Lisp_Object old_deactivate_mark
, tem
;
9389 struct gcpro gcpro1
;
9391 old_deactivate_mark
= Vdeactivate_mark
;
9392 oldbuf
= current_buffer
;
9393 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9394 bset_undo_list (current_buffer
, Qt
);
9396 oldpoint
= message_dolog_marker1
;
9397 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9398 oldbegv
= message_dolog_marker2
;
9399 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9400 oldzv
= message_dolog_marker3
;
9401 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9402 GCPRO1 (old_deactivate_mark
);
9410 BEGV_BYTE
= BEG_BYTE
;
9413 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9415 /* Insert the string--maybe converting multibyte to single byte
9416 or vice versa, so that all the text fits the buffer. */
9418 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9424 /* Convert a multibyte string to single-byte
9425 for the *Message* buffer. */
9426 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9428 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9429 work
[0] = (ASCII_CHAR_P (c
)
9431 : multibyte_char_to_unibyte (c
));
9432 insert_1_both (work
, 1, 1, 1, 0, 0);
9435 else if (! multibyte
9436 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9440 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9441 /* Convert a single-byte string to multibyte
9442 for the *Message* buffer. */
9443 for (i
= 0; i
< nbytes
; i
++)
9446 MAKE_CHAR_MULTIBYTE (c
);
9447 char_bytes
= CHAR_STRING (c
, str
);
9448 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9452 insert_1 (m
, nbytes
, 1, 0, 0);
9456 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9458 insert_1 ("\n", 1, 1, 0, 0);
9460 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9462 this_bol_byte
= PT_BYTE
;
9464 /* See if this line duplicates the previous one.
9465 If so, combine duplicates. */
9468 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9470 prev_bol_byte
= PT_BYTE
;
9472 dups
= message_log_check_duplicate (prev_bol_byte
,
9476 del_range_both (prev_bol
, prev_bol_byte
,
9477 this_bol
, this_bol_byte
, 0);
9480 char dupstr
[sizeof " [ times]"
9481 + INT_STRLEN_BOUND (printmax_t
)];
9483 /* If you change this format, don't forget to also
9484 change message_log_check_duplicate. */
9485 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9486 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9487 insert_1 (dupstr
, duplen
, 1, 0, 1);
9492 /* If we have more than the desired maximum number of lines
9493 in the *Messages* buffer now, delete the oldest ones.
9494 This is safe because we don't have undo in this buffer. */
9496 if (NATNUMP (Vmessage_log_max
))
9498 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9499 -XFASTINT (Vmessage_log_max
) - 1, 0);
9500 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9503 BEGV
= XMARKER (oldbegv
)->charpos
;
9504 BEGV_BYTE
= marker_byte_position (oldbegv
);
9513 ZV
= XMARKER (oldzv
)->charpos
;
9514 ZV_BYTE
= marker_byte_position (oldzv
);
9518 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9520 /* We can't do Fgoto_char (oldpoint) because it will run some
9522 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9523 XMARKER (oldpoint
)->bytepos
);
9526 unchain_marker (XMARKER (oldpoint
));
9527 unchain_marker (XMARKER (oldbegv
));
9528 unchain_marker (XMARKER (oldzv
));
9530 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9531 set_buffer_internal (oldbuf
);
9533 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9534 message_log_need_newline
= !nlflag
;
9535 Vdeactivate_mark
= old_deactivate_mark
;
9540 /* We are at the end of the buffer after just having inserted a newline.
9541 (Note: We depend on the fact we won't be crossing the gap.)
9542 Check to see if the most recent message looks a lot like the previous one.
9543 Return 0 if different, 1 if the new one should just replace it, or a
9544 value N > 1 if we should also append " [N times]". */
9547 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9550 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9552 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9553 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9555 for (i
= 0; i
< len
; i
++)
9557 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9565 if (*p1
++ == ' ' && *p1
++ == '[')
9568 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9569 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9576 /* Display an echo area message M with a specified length of NBYTES
9577 bytes. The string may include null characters. If M is 0, clear
9578 out any existing message, and let the mini-buffer text show
9581 This may GC, so the buffer M must NOT point to a Lisp string. */
9584 message2 (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9586 /* First flush out any partial line written with print. */
9587 message_log_maybe_newline ();
9589 message_dolog (m
, nbytes
, 1, multibyte
);
9590 message2_nolog (m
, nbytes
, multibyte
);
9594 /* The non-logging counterpart of message2. */
9597 message2_nolog (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9599 struct frame
*sf
= SELECTED_FRAME ();
9600 message_enable_multibyte
= multibyte
;
9602 if (FRAME_INITIAL_P (sf
))
9604 if (noninteractive_need_newline
)
9605 putc ('\n', stderr
);
9606 noninteractive_need_newline
= 0;
9608 fwrite (m
, nbytes
, 1, stderr
);
9609 if (cursor_in_echo_area
== 0)
9610 fprintf (stderr
, "\n");
9613 /* A null message buffer means that the frame hasn't really been
9614 initialized yet. Error messages get reported properly by
9615 cmd_error, so this must be just an informative message; toss it. */
9616 else if (INTERACTIVE
9617 && sf
->glyphs_initialized_p
9618 && FRAME_MESSAGE_BUF (sf
))
9620 Lisp_Object mini_window
;
9623 /* Get the frame containing the mini-buffer
9624 that the selected frame is using. */
9625 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9626 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9628 FRAME_SAMPLE_VISIBILITY (f
);
9629 if (FRAME_VISIBLE_P (sf
)
9630 && ! FRAME_VISIBLE_P (f
))
9631 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9635 set_message (m
, Qnil
, nbytes
, multibyte
);
9636 if (minibuffer_auto_raise
)
9637 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9640 clear_message (1, 1);
9642 do_pending_window_change (0);
9643 echo_area_display (1);
9644 do_pending_window_change (0);
9645 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
9646 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9651 /* Display an echo area message M with a specified length of NBYTES
9652 bytes. The string may include null characters. If M is not a
9653 string, clear out any existing message, and let the mini-buffer
9656 This function cancels echoing. */
9659 message3 (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9661 struct gcpro gcpro1
;
9664 clear_message (1,1);
9667 /* First flush out any partial line written with print. */
9668 message_log_maybe_newline ();
9672 char *buffer
= SAFE_ALLOCA (nbytes
);
9673 memcpy (buffer
, SDATA (m
), nbytes
);
9674 message_dolog (buffer
, nbytes
, 1, multibyte
);
9677 message3_nolog (m
, nbytes
, multibyte
);
9683 /* The non-logging version of message3.
9684 This does not cancel echoing, because it is used for echoing.
9685 Perhaps we need to make a separate function for echoing
9686 and make this cancel echoing. */
9689 message3_nolog (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9691 struct frame
*sf
= SELECTED_FRAME ();
9692 message_enable_multibyte
= multibyte
;
9694 if (FRAME_INITIAL_P (sf
))
9696 if (noninteractive_need_newline
)
9697 putc ('\n', stderr
);
9698 noninteractive_need_newline
= 0;
9700 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9701 if (cursor_in_echo_area
== 0)
9702 fprintf (stderr
, "\n");
9705 /* A null message buffer means that the frame hasn't really been
9706 initialized yet. Error messages get reported properly by
9707 cmd_error, so this must be just an informative message; toss it. */
9708 else if (INTERACTIVE
9709 && sf
->glyphs_initialized_p
9710 && FRAME_MESSAGE_BUF (sf
))
9712 Lisp_Object mini_window
;
9716 /* Get the frame containing the mini-buffer
9717 that the selected frame is using. */
9718 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9719 frame
= XWINDOW (mini_window
)->frame
;
9722 FRAME_SAMPLE_VISIBILITY (f
);
9723 if (FRAME_VISIBLE_P (sf
)
9724 && !FRAME_VISIBLE_P (f
))
9725 Fmake_frame_visible (frame
);
9727 if (STRINGP (m
) && SCHARS (m
) > 0)
9729 set_message (NULL
, m
, nbytes
, multibyte
);
9730 if (minibuffer_auto_raise
)
9731 Fraise_frame (frame
);
9732 /* Assume we are not echoing.
9733 (If we are, echo_now will override this.) */
9734 echo_message_buffer
= Qnil
;
9737 clear_message (1, 1);
9739 do_pending_window_change (0);
9740 echo_area_display (1);
9741 do_pending_window_change (0);
9742 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
9743 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9748 /* Display a null-terminated echo area message M. If M is 0, clear
9749 out any existing message, and let the mini-buffer text show through.
9751 The buffer M must continue to exist until after the echo area gets
9752 cleared or some other message gets displayed there. Do not pass
9753 text that is stored in a Lisp string. Do not pass text in a buffer
9754 that was alloca'd. */
9757 message1 (const char *m
)
9759 message2 (m
, (m
? strlen (m
) : 0), 0);
9763 /* The non-logging counterpart of message1. */
9766 message1_nolog (const char *m
)
9768 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9771 /* Display a message M which contains a single %s
9772 which gets replaced with STRING. */
9775 message_with_string (const char *m
, Lisp_Object string
, int log
)
9777 CHECK_STRING (string
);
9783 if (noninteractive_need_newline
)
9784 putc ('\n', stderr
);
9785 noninteractive_need_newline
= 0;
9786 fprintf (stderr
, m
, SDATA (string
));
9787 if (!cursor_in_echo_area
)
9788 fprintf (stderr
, "\n");
9792 else if (INTERACTIVE
)
9794 /* The frame whose minibuffer we're going to display the message on.
9795 It may be larger than the selected frame, so we need
9796 to use its buffer, not the selected frame's buffer. */
9797 Lisp_Object mini_window
;
9798 struct frame
*f
, *sf
= SELECTED_FRAME ();
9800 /* Get the frame containing the minibuffer
9801 that the selected frame is using. */
9802 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9803 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9805 /* A null message buffer means that the frame hasn't really been
9806 initialized yet. Error messages get reported properly by
9807 cmd_error, so this must be just an informative message; toss it. */
9808 if (FRAME_MESSAGE_BUF (f
))
9810 Lisp_Object args
[2], msg
;
9811 struct gcpro gcpro1
, gcpro2
;
9813 args
[0] = build_string (m
);
9814 args
[1] = msg
= string
;
9815 GCPRO2 (args
[0], msg
);
9818 msg
= Fformat (2, args
);
9821 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9823 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9827 /* Print should start at the beginning of the message
9828 buffer next time. */
9829 message_buf_print
= 0;
9835 /* Dump an informative message to the minibuf. If M is 0, clear out
9836 any existing message, and let the mini-buffer text show through. */
9839 vmessage (const char *m
, va_list ap
)
9845 if (noninteractive_need_newline
)
9846 putc ('\n', stderr
);
9847 noninteractive_need_newline
= 0;
9848 vfprintf (stderr
, m
, ap
);
9849 if (cursor_in_echo_area
== 0)
9850 fprintf (stderr
, "\n");
9854 else if (INTERACTIVE
)
9856 /* The frame whose mini-buffer we're going to display the message
9857 on. It may be larger than the selected frame, so we need to
9858 use its buffer, not the selected frame's buffer. */
9859 Lisp_Object mini_window
;
9860 struct frame
*f
, *sf
= SELECTED_FRAME ();
9862 /* Get the frame containing the mini-buffer
9863 that the selected frame is using. */
9864 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9865 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9867 /* A null message buffer means that the frame hasn't really been
9868 initialized yet. Error messages get reported properly by
9869 cmd_error, so this must be just an informative message; toss
9871 if (FRAME_MESSAGE_BUF (f
))
9877 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9878 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9880 message2 (FRAME_MESSAGE_BUF (f
), len
, 1);
9885 /* Print should start at the beginning of the message
9886 buffer next time. */
9887 message_buf_print
= 0;
9893 message (const char *m
, ...)
9903 /* The non-logging version of message. */
9906 message_nolog (const char *m
, ...)
9908 Lisp_Object old_log_max
;
9911 old_log_max
= Vmessage_log_max
;
9912 Vmessage_log_max
= Qnil
;
9914 Vmessage_log_max
= old_log_max
;
9920 /* Display the current message in the current mini-buffer. This is
9921 only called from error handlers in process.c, and is not time
9925 update_echo_area (void)
9927 if (!NILP (echo_area_buffer
[0]))
9930 string
= Fcurrent_message ();
9931 message3 (string
, SBYTES (string
),
9932 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9937 /* Make sure echo area buffers in `echo_buffers' are live.
9938 If they aren't, make new ones. */
9941 ensure_echo_area_buffers (void)
9945 for (i
= 0; i
< 2; ++i
)
9946 if (!BUFFERP (echo_buffer
[i
])
9947 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
9950 Lisp_Object old_buffer
;
9953 old_buffer
= echo_buffer
[i
];
9954 echo_buffer
[i
] = Fget_buffer_create
9955 (make_formatted_string (name
, " *Echo Area %d*", i
));
9956 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
9957 /* to force word wrap in echo area -
9958 it was decided to postpone this*/
9959 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9961 for (j
= 0; j
< 2; ++j
)
9962 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9963 echo_area_buffer
[j
] = echo_buffer
[i
];
9968 /* Call FN with args A1..A4 with either the current or last displayed
9969 echo_area_buffer as current buffer.
9971 WHICH zero means use the current message buffer
9972 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9973 from echo_buffer[] and clear it.
9975 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9976 suitable buffer from echo_buffer[] and clear it.
9978 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9979 that the current message becomes the last displayed one, make
9980 choose a suitable buffer for echo_area_buffer[0], and clear it.
9982 Value is what FN returns. */
9985 with_echo_area_buffer (struct window
*w
, int which
,
9986 int (*fn
) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
9987 ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
9990 int this_one
, the_other
, clear_buffer_p
, rc
;
9991 ptrdiff_t count
= SPECPDL_INDEX ();
9993 /* If buffers aren't live, make new ones. */
9994 ensure_echo_area_buffers ();
9999 this_one
= 0, the_other
= 1;
10000 else if (which
> 0)
10001 this_one
= 1, the_other
= 0;
10004 this_one
= 0, the_other
= 1;
10005 clear_buffer_p
= 1;
10007 /* We need a fresh one in case the current echo buffer equals
10008 the one containing the last displayed echo area message. */
10009 if (!NILP (echo_area_buffer
[this_one
])
10010 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10011 echo_area_buffer
[this_one
] = Qnil
;
10014 /* Choose a suitable buffer from echo_buffer[] is we don't
10016 if (NILP (echo_area_buffer
[this_one
]))
10018 echo_area_buffer
[this_one
]
10019 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10020 ? echo_buffer
[the_other
]
10021 : echo_buffer
[this_one
]);
10022 clear_buffer_p
= 1;
10025 buffer
= echo_area_buffer
[this_one
];
10027 /* Don't get confused by reusing the buffer used for echoing
10028 for a different purpose. */
10029 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10032 record_unwind_protect (unwind_with_echo_area_buffer
,
10033 with_echo_area_buffer_unwind_data (w
));
10035 /* Make the echo area buffer current. Note that for display
10036 purposes, it is not necessary that the displayed window's buffer
10037 == current_buffer, except for text property lookup. So, let's
10038 only set that buffer temporarily here without doing a full
10039 Fset_window_buffer. We must also change w->pointm, though,
10040 because otherwise an assertions in unshow_buffer fails, and Emacs
10042 set_buffer_internal_1 (XBUFFER (buffer
));
10045 wset_buffer (w
, buffer
);
10046 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10049 bset_undo_list (current_buffer
, Qt
);
10050 bset_read_only (current_buffer
, Qnil
);
10051 specbind (Qinhibit_read_only
, Qt
);
10052 specbind (Qinhibit_modification_hooks
, Qt
);
10054 if (clear_buffer_p
&& Z
> BEG
)
10055 del_range (BEG
, Z
);
10057 eassert (BEGV
>= BEG
);
10058 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10060 rc
= fn (a1
, a2
, a3
, a4
);
10062 eassert (BEGV
>= BEG
);
10063 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10065 unbind_to (count
, Qnil
);
10070 /* Save state that should be preserved around the call to the function
10071 FN called in with_echo_area_buffer. */
10074 with_echo_area_buffer_unwind_data (struct window
*w
)
10077 Lisp_Object vector
, tmp
;
10079 /* Reduce consing by keeping one vector in
10080 Vwith_echo_area_save_vector. */
10081 vector
= Vwith_echo_area_save_vector
;
10082 Vwith_echo_area_save_vector
= Qnil
;
10085 vector
= Fmake_vector (make_number (7), Qnil
);
10087 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10088 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10089 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10093 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10094 ASET (vector
, i
, w
->buffer
); ++i
;
10095 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
10096 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
10101 for (; i
< end
; ++i
)
10102 ASET (vector
, i
, Qnil
);
10105 eassert (i
== ASIZE (vector
));
10110 /* Restore global state from VECTOR which was created by
10111 with_echo_area_buffer_unwind_data. */
10114 unwind_with_echo_area_buffer (Lisp_Object vector
)
10116 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10117 Vdeactivate_mark
= AREF (vector
, 1);
10118 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10120 if (WINDOWP (AREF (vector
, 3)))
10123 Lisp_Object buffer
, charpos
, bytepos
;
10125 w
= XWINDOW (AREF (vector
, 3));
10126 buffer
= AREF (vector
, 4);
10127 charpos
= AREF (vector
, 5);
10128 bytepos
= AREF (vector
, 6);
10130 wset_buffer (w
, buffer
);
10131 set_marker_both (w
->pointm
, buffer
,
10132 XFASTINT (charpos
), XFASTINT (bytepos
));
10135 Vwith_echo_area_save_vector
= vector
;
10140 /* Set up the echo area for use by print functions. MULTIBYTE_P
10141 non-zero means we will print multibyte. */
10144 setup_echo_area_for_printing (int multibyte_p
)
10146 /* If we can't find an echo area any more, exit. */
10147 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10148 Fkill_emacs (Qnil
);
10150 ensure_echo_area_buffers ();
10152 if (!message_buf_print
)
10154 /* A message has been output since the last time we printed.
10155 Choose a fresh echo area buffer. */
10156 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10157 echo_area_buffer
[0] = echo_buffer
[1];
10159 echo_area_buffer
[0] = echo_buffer
[0];
10161 /* Switch to that buffer and clear it. */
10162 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10163 bset_truncate_lines (current_buffer
, Qnil
);
10167 ptrdiff_t count
= SPECPDL_INDEX ();
10168 specbind (Qinhibit_read_only
, Qt
);
10169 /* Note that undo recording is always disabled. */
10170 del_range (BEG
, Z
);
10171 unbind_to (count
, Qnil
);
10173 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10175 /* Set up the buffer for the multibyteness we need. */
10177 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10178 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10180 /* Raise the frame containing the echo area. */
10181 if (minibuffer_auto_raise
)
10183 struct frame
*sf
= SELECTED_FRAME ();
10184 Lisp_Object mini_window
;
10185 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10186 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10189 message_log_maybe_newline ();
10190 message_buf_print
= 1;
10194 if (NILP (echo_area_buffer
[0]))
10196 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10197 echo_area_buffer
[0] = echo_buffer
[1];
10199 echo_area_buffer
[0] = echo_buffer
[0];
10202 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10204 /* Someone switched buffers between print requests. */
10205 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10206 bset_truncate_lines (current_buffer
, Qnil
);
10212 /* Display an echo area message in window W. Value is non-zero if W's
10213 height is changed. If display_last_displayed_message_p is
10214 non-zero, display the message that was last displayed, otherwise
10215 display the current message. */
10218 display_echo_area (struct window
*w
)
10220 int i
, no_message_p
, window_height_changed_p
;
10222 /* Temporarily disable garbage collections while displaying the echo
10223 area. This is done because a GC can print a message itself.
10224 That message would modify the echo area buffer's contents while a
10225 redisplay of the buffer is going on, and seriously confuse
10227 ptrdiff_t count
= inhibit_garbage_collection ();
10229 /* If there is no message, we must call display_echo_area_1
10230 nevertheless because it resizes the window. But we will have to
10231 reset the echo_area_buffer in question to nil at the end because
10232 with_echo_area_buffer will sets it to an empty buffer. */
10233 i
= display_last_displayed_message_p
? 1 : 0;
10234 no_message_p
= NILP (echo_area_buffer
[i
]);
10236 window_height_changed_p
10237 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10238 display_echo_area_1
,
10239 (intptr_t) w
, Qnil
, 0, 0);
10242 echo_area_buffer
[i
] = Qnil
;
10244 unbind_to (count
, Qnil
);
10245 return window_height_changed_p
;
10249 /* Helper for display_echo_area. Display the current buffer which
10250 contains the current echo area message in window W, a mini-window,
10251 a pointer to which is passed in A1. A2..A4 are currently not used.
10252 Change the height of W so that all of the message is displayed.
10253 Value is non-zero if height of W was changed. */
10256 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10259 struct window
*w
= (struct window
*) i1
;
10260 Lisp_Object window
;
10261 struct text_pos start
;
10262 int window_height_changed_p
= 0;
10264 /* Do this before displaying, so that we have a large enough glyph
10265 matrix for the display. If we can't get enough space for the
10266 whole text, display the last N lines. That works by setting w->start. */
10267 window_height_changed_p
= resize_mini_window (w
, 0);
10269 /* Use the starting position chosen by resize_mini_window. */
10270 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10273 clear_glyph_matrix (w
->desired_matrix
);
10274 XSETWINDOW (window
, w
);
10275 try_window (window
, start
, 0);
10277 return window_height_changed_p
;
10281 /* Resize the echo area window to exactly the size needed for the
10282 currently displayed message, if there is one. If a mini-buffer
10283 is active, don't shrink it. */
10286 resize_echo_area_exactly (void)
10288 if (BUFFERP (echo_area_buffer
[0])
10289 && WINDOWP (echo_area_window
))
10291 struct window
*w
= XWINDOW (echo_area_window
);
10293 Lisp_Object resize_exactly
;
10295 if (minibuf_level
== 0)
10296 resize_exactly
= Qt
;
10298 resize_exactly
= Qnil
;
10300 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10301 (intptr_t) w
, resize_exactly
,
10305 ++windows_or_buffers_changed
;
10306 ++update_mode_lines
;
10307 redisplay_internal ();
10313 /* Callback function for with_echo_area_buffer, when used from
10314 resize_echo_area_exactly. A1 contains a pointer to the window to
10315 resize, EXACTLY non-nil means resize the mini-window exactly to the
10316 size of the text displayed. A3 and A4 are not used. Value is what
10317 resize_mini_window returns. */
10320 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
, ptrdiff_t a3
, ptrdiff_t a4
)
10323 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10327 /* Resize mini-window W to fit the size of its contents. EXACT_P
10328 means size the window exactly to the size needed. Otherwise, it's
10329 only enlarged until W's buffer is empty.
10331 Set W->start to the right place to begin display. If the whole
10332 contents fit, start at the beginning. Otherwise, start so as
10333 to make the end of the contents appear. This is particularly
10334 important for y-or-n-p, but seems desirable generally.
10336 Value is non-zero if the window height has been changed. */
10339 resize_mini_window (struct window
*w
, int exact_p
)
10341 struct frame
*f
= XFRAME (w
->frame
);
10342 int window_height_changed_p
= 0;
10344 eassert (MINI_WINDOW_P (w
));
10346 /* By default, start display at the beginning. */
10347 set_marker_both (w
->start
, w
->buffer
,
10348 BUF_BEGV (XBUFFER (w
->buffer
)),
10349 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10351 /* Don't resize windows while redisplaying a window; it would
10352 confuse redisplay functions when the size of the window they are
10353 displaying changes from under them. Such a resizing can happen,
10354 for instance, when which-func prints a long message while
10355 we are running fontification-functions. We're running these
10356 functions with safe_call which binds inhibit-redisplay to t. */
10357 if (!NILP (Vinhibit_redisplay
))
10360 /* Nil means don't try to resize. */
10361 if (NILP (Vresize_mini_windows
)
10362 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10365 if (!FRAME_MINIBUF_ONLY_P (f
))
10368 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10369 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10371 EMACS_INT max_height
;
10372 int unit
= FRAME_LINE_HEIGHT (f
);
10373 struct text_pos start
;
10374 struct buffer
*old_current_buffer
= NULL
;
10376 if (current_buffer
!= XBUFFER (w
->buffer
))
10378 old_current_buffer
= current_buffer
;
10379 set_buffer_internal (XBUFFER (w
->buffer
));
10382 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10384 /* Compute the max. number of lines specified by the user. */
10385 if (FLOATP (Vmax_mini_window_height
))
10386 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10387 else if (INTEGERP (Vmax_mini_window_height
))
10388 max_height
= XINT (Vmax_mini_window_height
);
10390 max_height
= total_height
/ 4;
10392 /* Correct that max. height if it's bogus. */
10393 max_height
= max (1, max_height
);
10394 max_height
= min (total_height
, max_height
);
10396 /* Find out the height of the text in the window. */
10397 if (it
.line_wrap
== TRUNCATE
)
10402 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10403 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10404 height
= it
.current_y
+ last_height
;
10406 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10407 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10408 height
= (height
+ unit
- 1) / unit
;
10411 /* Compute a suitable window start. */
10412 if (height
> max_height
)
10414 height
= max_height
;
10415 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10416 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10417 start
= it
.current
.pos
;
10420 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10421 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10423 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10425 /* Let it grow only, until we display an empty message, in which
10426 case the window shrinks again. */
10427 if (height
> WINDOW_TOTAL_LINES (w
))
10429 int old_height
= WINDOW_TOTAL_LINES (w
);
10430 freeze_window_starts (f
, 1);
10431 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10432 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10434 else if (height
< WINDOW_TOTAL_LINES (w
)
10435 && (exact_p
|| BEGV
== ZV
))
10437 int old_height
= WINDOW_TOTAL_LINES (w
);
10438 freeze_window_starts (f
, 0);
10439 shrink_mini_window (w
);
10440 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10445 /* Always resize to exact size needed. */
10446 if (height
> WINDOW_TOTAL_LINES (w
))
10448 int old_height
= WINDOW_TOTAL_LINES (w
);
10449 freeze_window_starts (f
, 1);
10450 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10451 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10453 else if (height
< WINDOW_TOTAL_LINES (w
))
10455 int old_height
= WINDOW_TOTAL_LINES (w
);
10456 freeze_window_starts (f
, 0);
10457 shrink_mini_window (w
);
10461 freeze_window_starts (f
, 1);
10462 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10465 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10469 if (old_current_buffer
)
10470 set_buffer_internal (old_current_buffer
);
10473 return window_height_changed_p
;
10477 /* Value is the current message, a string, or nil if there is no
10478 current message. */
10481 current_message (void)
10485 if (!BUFFERP (echo_area_buffer
[0]))
10489 with_echo_area_buffer (0, 0, current_message_1
,
10490 (intptr_t) &msg
, Qnil
, 0, 0);
10492 echo_area_buffer
[0] = Qnil
;
10500 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10503 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10506 *msg
= make_buffer_string (BEG
, Z
, 1);
10513 /* Push the current message on Vmessage_stack for later restoration
10514 by restore_message. Value is non-zero if the current message isn't
10515 empty. This is a relatively infrequent operation, so it's not
10516 worth optimizing. */
10519 push_message (void)
10521 Lisp_Object msg
= current_message ();
10522 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10523 return STRINGP (msg
);
10527 /* Restore message display from the top of Vmessage_stack. */
10530 restore_message (void)
10534 eassert (CONSP (Vmessage_stack
));
10535 msg
= XCAR (Vmessage_stack
);
10537 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10539 message3_nolog (msg
, 0, 0);
10543 /* Handler for record_unwind_protect calling pop_message. */
10546 pop_message_unwind (Lisp_Object dummy
)
10552 /* Pop the top-most entry off Vmessage_stack. */
10557 eassert (CONSP (Vmessage_stack
));
10558 Vmessage_stack
= XCDR (Vmessage_stack
);
10562 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10563 exits. If the stack is not empty, we have a missing pop_message
10567 check_message_stack (void)
10569 if (!NILP (Vmessage_stack
))
10574 /* Truncate to NCHARS what will be displayed in the echo area the next
10575 time we display it---but don't redisplay it now. */
10578 truncate_echo_area (ptrdiff_t nchars
)
10581 echo_area_buffer
[0] = Qnil
;
10582 /* A null message buffer means that the frame hasn't really been
10583 initialized yet. Error messages get reported properly by
10584 cmd_error, so this must be just an informative message; toss it. */
10585 else if (!noninteractive
10587 && !NILP (echo_area_buffer
[0]))
10589 struct frame
*sf
= SELECTED_FRAME ();
10590 if (FRAME_MESSAGE_BUF (sf
))
10591 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10596 /* Helper function for truncate_echo_area. Truncate the current
10597 message to at most NCHARS characters. */
10600 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10602 if (BEG
+ nchars
< Z
)
10603 del_range (BEG
+ nchars
, Z
);
10605 echo_area_buffer
[0] = Qnil
;
10609 /* Set the current message to a substring of S or STRING.
10611 If STRING is a Lisp string, set the message to the first NBYTES
10612 bytes from STRING. NBYTES zero means use the whole string. If
10613 STRING is multibyte, the message will be displayed multibyte.
10615 If S is not null, set the message to the first LEN bytes of S. LEN
10616 zero means use the whole string. MULTIBYTE_P non-zero means S is
10617 multibyte. Display the message multibyte in that case.
10619 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10620 to t before calling set_message_1 (which calls insert).
10624 set_message (const char *s
, Lisp_Object string
,
10625 ptrdiff_t nbytes
, int multibyte_p
)
10627 message_enable_multibyte
10628 = ((s
&& multibyte_p
)
10629 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10631 with_echo_area_buffer (0, -1, set_message_1
,
10632 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10633 message_buf_print
= 0;
10634 help_echo_showing_p
= 0;
10636 if (STRINGP (Vdebug_on_message
)
10637 && fast_string_match (Vdebug_on_message
, string
) >= 0)
10638 call_debugger (list2 (Qerror
, string
));
10642 /* Helper function for set_message. Arguments have the same meaning
10643 as there, with A1 corresponding to S and A2 corresponding to STRING
10644 This function is called with the echo area buffer being
10648 set_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t nbytes
, ptrdiff_t multibyte_p
)
10651 const char *s
= (const char *) i1
;
10652 const unsigned char *msg
= (const unsigned char *) s
;
10653 Lisp_Object string
= a2
;
10655 /* Change multibyteness of the echo buffer appropriately. */
10656 if (message_enable_multibyte
10657 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10658 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10660 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
10661 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10662 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
10664 /* Insert new message at BEG. */
10665 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10667 if (STRINGP (string
))
10672 nbytes
= SBYTES (string
);
10673 nchars
= string_byte_to_char (string
, nbytes
);
10675 /* This function takes care of single/multibyte conversion. We
10676 just have to ensure that the echo area buffer has the right
10677 setting of enable_multibyte_characters. */
10678 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10683 nbytes
= strlen (s
);
10685 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10687 /* Convert from multi-byte to single-byte. */
10692 /* Convert a multibyte string to single-byte. */
10693 for (i
= 0; i
< nbytes
; i
+= n
)
10695 c
= string_char_and_length (msg
+ i
, &n
);
10696 work
[0] = (ASCII_CHAR_P (c
)
10698 : multibyte_char_to_unibyte (c
));
10699 insert_1_both (work
, 1, 1, 1, 0, 0);
10702 else if (!multibyte_p
10703 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10705 /* Convert from single-byte to multi-byte. */
10708 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10710 /* Convert a single-byte string to multibyte. */
10711 for (i
= 0; i
< nbytes
; i
++)
10714 MAKE_CHAR_MULTIBYTE (c
);
10715 n
= CHAR_STRING (c
, str
);
10716 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10720 insert_1 (s
, nbytes
, 1, 0, 0);
10727 /* Clear messages. CURRENT_P non-zero means clear the current
10728 message. LAST_DISPLAYED_P non-zero means clear the message
10732 clear_message (int current_p
, int last_displayed_p
)
10736 echo_area_buffer
[0] = Qnil
;
10737 message_cleared_p
= 1;
10740 if (last_displayed_p
)
10741 echo_area_buffer
[1] = Qnil
;
10743 message_buf_print
= 0;
10746 /* Clear garbaged frames.
10748 This function is used where the old redisplay called
10749 redraw_garbaged_frames which in turn called redraw_frame which in
10750 turn called clear_frame. The call to clear_frame was a source of
10751 flickering. I believe a clear_frame is not necessary. It should
10752 suffice in the new redisplay to invalidate all current matrices,
10753 and ensure a complete redisplay of all windows. */
10756 clear_garbaged_frames (void)
10758 if (frame_garbaged
)
10760 Lisp_Object tail
, frame
;
10761 int changed_count
= 0;
10763 FOR_EACH_FRAME (tail
, frame
)
10765 struct frame
*f
= XFRAME (frame
);
10767 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10772 f
->force_flush_display_p
= 1;
10774 clear_current_matrices (f
);
10781 frame_garbaged
= 0;
10783 ++windows_or_buffers_changed
;
10788 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10789 is non-zero update selected_frame. Value is non-zero if the
10790 mini-windows height has been changed. */
10793 echo_area_display (int update_frame_p
)
10795 Lisp_Object mini_window
;
10798 int window_height_changed_p
= 0;
10799 struct frame
*sf
= SELECTED_FRAME ();
10801 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10802 w
= XWINDOW (mini_window
);
10803 f
= XFRAME (WINDOW_FRAME (w
));
10805 /* Don't display if frame is invisible or not yet initialized. */
10806 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10809 #ifdef HAVE_WINDOW_SYSTEM
10810 /* When Emacs starts, selected_frame may be the initial terminal
10811 frame. If we let this through, a message would be displayed on
10813 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10815 #endif /* HAVE_WINDOW_SYSTEM */
10817 /* Redraw garbaged frames. */
10818 clear_garbaged_frames ();
10820 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10822 echo_area_window
= mini_window
;
10823 window_height_changed_p
= display_echo_area (w
);
10824 w
->must_be_updated_p
= 1;
10826 /* Update the display, unless called from redisplay_internal.
10827 Also don't update the screen during redisplay itself. The
10828 update will happen at the end of redisplay, and an update
10829 here could cause confusion. */
10830 if (update_frame_p
&& !redisplaying_p
)
10834 /* If the display update has been interrupted by pending
10835 input, update mode lines in the frame. Due to the
10836 pending input, it might have been that redisplay hasn't
10837 been called, so that mode lines above the echo area are
10838 garbaged. This looks odd, so we prevent it here. */
10839 if (!display_completed
)
10840 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10842 if (window_height_changed_p
10843 /* Don't do this if Emacs is shutting down. Redisplay
10844 needs to run hooks. */
10845 && !NILP (Vrun_hooks
))
10847 /* Must update other windows. Likewise as in other
10848 cases, don't let this update be interrupted by
10850 ptrdiff_t count
= SPECPDL_INDEX ();
10851 specbind (Qredisplay_dont_pause
, Qt
);
10852 windows_or_buffers_changed
= 1;
10853 redisplay_internal ();
10854 unbind_to (count
, Qnil
);
10856 else if (FRAME_WINDOW_P (f
) && n
== 0)
10858 /* Window configuration is the same as before.
10859 Can do with a display update of the echo area,
10860 unless we displayed some mode lines. */
10861 update_single_window (w
, 1);
10862 FRAME_RIF (f
)->flush_display (f
);
10865 update_frame (f
, 1, 1);
10867 /* If cursor is in the echo area, make sure that the next
10868 redisplay displays the minibuffer, so that the cursor will
10869 be replaced with what the minibuffer wants. */
10870 if (cursor_in_echo_area
)
10871 ++windows_or_buffers_changed
;
10874 else if (!EQ (mini_window
, selected_window
))
10875 windows_or_buffers_changed
++;
10877 /* Last displayed message is now the current message. */
10878 echo_area_buffer
[1] = echo_area_buffer
[0];
10879 /* Inform read_char that we're not echoing. */
10880 echo_message_buffer
= Qnil
;
10882 /* Prevent redisplay optimization in redisplay_internal by resetting
10883 this_line_start_pos. This is done because the mini-buffer now
10884 displays the message instead of its buffer text. */
10885 if (EQ (mini_window
, selected_window
))
10886 CHARPOS (this_line_start_pos
) = 0;
10888 return window_height_changed_p
;
10891 /* Nonzero if the current window's buffer is shown in more than one
10892 window and was modified since last redisplay. */
10895 buffer_shared_and_changed (void)
10897 /* The variable buffer_shared is set in redisplay_window and
10898 indicates that we redisplay a buffer in different windows. */
10899 return (buffer_shared
> 1 && UNCHANGED_MODIFIED
< MODIFF
);
10902 /* Nonzero if W doesn't reflect the actual state of current buffer due
10903 to its text or overlays change. FIXME: this may be called when
10904 XBUFFER (w->buffer) != current_buffer, which looks suspicious. */
10907 window_outdated (struct window
*w
)
10909 return (w
->last_modified
< MODIFF
10910 || w
->last_overlay_modified
< OVERLAY_MODIFF
);
10913 /* Nonzero if W's buffer was changed but not saved or Transient Mark mode
10914 is enabled and mark of W's buffer was changed since last W's update. */
10917 window_buffer_changed (struct window
*w
)
10919 struct buffer
*b
= XBUFFER (w
->buffer
);
10921 eassert (BUFFER_LIVE_P (b
));
10923 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
)
10924 || ((!NILP (Vtransient_mark_mode
) && !NILP (BVAR (b
, mark_active
)))
10925 != !NILP (w
->region_showing
)));
10928 /* Nonzero if W has %c in its mode line and mode line should be updated. */
10931 mode_line_update_needed (struct window
*w
)
10933 return (!NILP (w
->column_number_displayed
)
10934 && !(PT
== w
->last_point
&& !window_outdated (w
))
10935 && (XFASTINT (w
->column_number_displayed
) != current_column ()));
10938 /***********************************************************************
10939 Mode Lines and Frame Titles
10940 ***********************************************************************/
10942 /* A buffer for constructing non-propertized mode-line strings and
10943 frame titles in it; allocated from the heap in init_xdisp and
10944 resized as needed in store_mode_line_noprop_char. */
10946 static char *mode_line_noprop_buf
;
10948 /* The buffer's end, and a current output position in it. */
10950 static char *mode_line_noprop_buf_end
;
10951 static char *mode_line_noprop_ptr
;
10953 #define MODE_LINE_NOPROP_LEN(start) \
10954 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10957 MODE_LINE_DISPLAY
= 0,
10961 } mode_line_target
;
10963 /* Alist that caches the results of :propertize.
10964 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10965 static Lisp_Object mode_line_proptrans_alist
;
10967 /* List of strings making up the mode-line. */
10968 static Lisp_Object mode_line_string_list
;
10970 /* Base face property when building propertized mode line string. */
10971 static Lisp_Object mode_line_string_face
;
10972 static Lisp_Object mode_line_string_face_prop
;
10975 /* Unwind data for mode line strings */
10977 static Lisp_Object Vmode_line_unwind_vector
;
10980 format_mode_line_unwind_data (struct frame
*target_frame
,
10981 struct buffer
*obuf
,
10983 int save_proptrans
)
10985 Lisp_Object vector
, tmp
;
10987 /* Reduce consing by keeping one vector in
10988 Vwith_echo_area_save_vector. */
10989 vector
= Vmode_line_unwind_vector
;
10990 Vmode_line_unwind_vector
= Qnil
;
10993 vector
= Fmake_vector (make_number (10), Qnil
);
10995 ASET (vector
, 0, make_number (mode_line_target
));
10996 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10997 ASET (vector
, 2, mode_line_string_list
);
10998 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10999 ASET (vector
, 4, mode_line_string_face
);
11000 ASET (vector
, 5, mode_line_string_face_prop
);
11003 XSETBUFFER (tmp
, obuf
);
11006 ASET (vector
, 6, tmp
);
11007 ASET (vector
, 7, owin
);
11010 /* Similarly to `with-selected-window', if the operation selects
11011 a window on another frame, we must restore that frame's
11012 selected window, and (for a tty) the top-frame. */
11013 ASET (vector
, 8, target_frame
->selected_window
);
11014 if (FRAME_TERMCAP_P (target_frame
))
11015 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11022 unwind_format_mode_line (Lisp_Object vector
)
11024 Lisp_Object old_window
= AREF (vector
, 7);
11025 Lisp_Object target_frame_window
= AREF (vector
, 8);
11026 Lisp_Object old_top_frame
= AREF (vector
, 9);
11028 mode_line_target
= XINT (AREF (vector
, 0));
11029 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11030 mode_line_string_list
= AREF (vector
, 2);
11031 if (! EQ (AREF (vector
, 3), Qt
))
11032 mode_line_proptrans_alist
= AREF (vector
, 3);
11033 mode_line_string_face
= AREF (vector
, 4);
11034 mode_line_string_face_prop
= AREF (vector
, 5);
11036 /* Select window before buffer, since it may change the buffer. */
11037 if (!NILP (old_window
))
11039 /* If the operation that we are unwinding had selected a window
11040 on a different frame, reset its frame-selected-window. For a
11041 text terminal, reset its top-frame if necessary. */
11042 if (!NILP (target_frame_window
))
11045 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11047 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11048 Fselect_window (target_frame_window
, Qt
);
11050 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11051 Fselect_frame (old_top_frame
, Qt
);
11054 Fselect_window (old_window
, Qt
);
11057 if (!NILP (AREF (vector
, 6)))
11059 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11060 ASET (vector
, 6, Qnil
);
11063 Vmode_line_unwind_vector
= vector
;
11068 /* Store a single character C for the frame title in mode_line_noprop_buf.
11069 Re-allocate mode_line_noprop_buf if necessary. */
11072 store_mode_line_noprop_char (char c
)
11074 /* If output position has reached the end of the allocated buffer,
11075 increase the buffer's size. */
11076 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11078 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11079 ptrdiff_t size
= len
;
11080 mode_line_noprop_buf
=
11081 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11082 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11083 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11086 *mode_line_noprop_ptr
++ = c
;
11090 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11091 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11092 characters that yield more columns than PRECISION; PRECISION <= 0
11093 means copy the whole string. Pad with spaces until FIELD_WIDTH
11094 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11095 pad. Called from display_mode_element when it is used to build a
11099 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11101 const unsigned char *str
= (const unsigned char *) string
;
11103 ptrdiff_t dummy
, nbytes
;
11105 /* Copy at most PRECISION chars from STR. */
11106 nbytes
= strlen (string
);
11107 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11109 store_mode_line_noprop_char (*str
++);
11111 /* Fill up with spaces until FIELD_WIDTH reached. */
11112 while (field_width
> 0
11113 && n
< field_width
)
11115 store_mode_line_noprop_char (' ');
11122 /***********************************************************************
11124 ***********************************************************************/
11126 #ifdef HAVE_WINDOW_SYSTEM
11128 /* Set the title of FRAME, if it has changed. The title format is
11129 Vicon_title_format if FRAME is iconified, otherwise it is
11130 frame_title_format. */
11133 x_consider_frame_title (Lisp_Object frame
)
11135 struct frame
*f
= XFRAME (frame
);
11137 if (FRAME_WINDOW_P (f
)
11138 || FRAME_MINIBUF_ONLY_P (f
)
11139 || f
->explicit_name
)
11141 /* Do we have more than one visible frame on this X display? */
11142 Lisp_Object tail
, other_frame
, fmt
;
11143 ptrdiff_t title_start
;
11147 ptrdiff_t count
= SPECPDL_INDEX ();
11149 FOR_EACH_FRAME (tail
, other_frame
)
11151 struct frame
*tf
= XFRAME (other_frame
);
11154 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11155 && !FRAME_MINIBUF_ONLY_P (tf
)
11156 && !EQ (other_frame
, tip_frame
)
11157 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11161 /* Set global variable indicating that multiple frames exist. */
11162 multiple_frames
= CONSP (tail
);
11164 /* Switch to the buffer of selected window of the frame. Set up
11165 mode_line_target so that display_mode_element will output into
11166 mode_line_noprop_buf; then display the title. */
11167 record_unwind_protect (unwind_format_mode_line
,
11168 format_mode_line_unwind_data
11169 (f
, current_buffer
, selected_window
, 0));
11171 Fselect_window (f
->selected_window
, Qt
);
11172 set_buffer_internal_1
11173 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
11174 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11176 mode_line_target
= MODE_LINE_TITLE
;
11177 title_start
= MODE_LINE_NOPROP_LEN (0);
11178 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11179 NULL
, DEFAULT_FACE_ID
);
11180 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11181 len
= MODE_LINE_NOPROP_LEN (title_start
);
11182 title
= mode_line_noprop_buf
+ title_start
;
11183 unbind_to (count
, Qnil
);
11185 /* Set the title only if it's changed. This avoids consing in
11186 the common case where it hasn't. (If it turns out that we've
11187 already wasted too much time by walking through the list with
11188 display_mode_element, then we might need to optimize at a
11189 higher level than this.) */
11190 if (! STRINGP (f
->name
)
11191 || SBYTES (f
->name
) != len
11192 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11193 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11197 #endif /* not HAVE_WINDOW_SYSTEM */
11200 /***********************************************************************
11202 ***********************************************************************/
11205 /* Prepare for redisplay by updating menu-bar item lists when
11206 appropriate. This can call eval. */
11209 prepare_menu_bars (void)
11212 struct gcpro gcpro1
, gcpro2
;
11214 Lisp_Object tooltip_frame
;
11216 #ifdef HAVE_WINDOW_SYSTEM
11217 tooltip_frame
= tip_frame
;
11219 tooltip_frame
= Qnil
;
11222 /* Update all frame titles based on their buffer names, etc. We do
11223 this before the menu bars so that the buffer-menu will show the
11224 up-to-date frame titles. */
11225 #ifdef HAVE_WINDOW_SYSTEM
11226 if (windows_or_buffers_changed
|| update_mode_lines
)
11228 Lisp_Object tail
, frame
;
11230 FOR_EACH_FRAME (tail
, frame
)
11232 f
= XFRAME (frame
);
11233 if (!EQ (frame
, tooltip_frame
)
11234 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
11235 x_consider_frame_title (frame
);
11238 #endif /* HAVE_WINDOW_SYSTEM */
11240 /* Update the menu bar item lists, if appropriate. This has to be
11241 done before any actual redisplay or generation of display lines. */
11242 all_windows
= (update_mode_lines
11243 || buffer_shared_and_changed ()
11244 || windows_or_buffers_changed
);
11247 Lisp_Object tail
, frame
;
11248 ptrdiff_t count
= SPECPDL_INDEX ();
11249 /* 1 means that update_menu_bar has run its hooks
11250 so any further calls to update_menu_bar shouldn't do so again. */
11251 int menu_bar_hooks_run
= 0;
11253 record_unwind_save_match_data ();
11255 FOR_EACH_FRAME (tail
, frame
)
11257 f
= XFRAME (frame
);
11259 /* Ignore tooltip frame. */
11260 if (EQ (frame
, tooltip_frame
))
11263 /* If a window on this frame changed size, report that to
11264 the user and clear the size-change flag. */
11265 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11267 Lisp_Object functions
;
11269 /* Clear flag first in case we get an error below. */
11270 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11271 functions
= Vwindow_size_change_functions
;
11272 GCPRO2 (tail
, functions
);
11274 while (CONSP (functions
))
11276 if (!EQ (XCAR (functions
), Qt
))
11277 call1 (XCAR (functions
), frame
);
11278 functions
= XCDR (functions
);
11284 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11285 #ifdef HAVE_WINDOW_SYSTEM
11286 update_tool_bar (f
, 0);
11289 if (windows_or_buffers_changed
11292 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->buffer
));
11297 unbind_to (count
, Qnil
);
11301 struct frame
*sf
= SELECTED_FRAME ();
11302 update_menu_bar (sf
, 1, 0);
11303 #ifdef HAVE_WINDOW_SYSTEM
11304 update_tool_bar (sf
, 1);
11310 /* Update the menu bar item list for frame F. This has to be done
11311 before we start to fill in any display lines, because it can call
11314 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11316 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11317 already ran the menu bar hooks for this redisplay, so there
11318 is no need to run them again. The return value is the
11319 updated value of this flag, to pass to the next call. */
11322 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11324 Lisp_Object window
;
11325 register struct window
*w
;
11327 /* If called recursively during a menu update, do nothing. This can
11328 happen when, for instance, an activate-menubar-hook causes a
11330 if (inhibit_menubar_update
)
11333 window
= FRAME_SELECTED_WINDOW (f
);
11334 w
= XWINDOW (window
);
11336 if (FRAME_WINDOW_P (f
)
11338 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11339 || defined (HAVE_NS) || defined (USE_GTK)
11340 FRAME_EXTERNAL_MENU_BAR (f
)
11342 FRAME_MENU_BAR_LINES (f
) > 0
11344 : FRAME_MENU_BAR_LINES (f
) > 0)
11346 /* If the user has switched buffers or windows, we need to
11347 recompute to reflect the new bindings. But we'll
11348 recompute when update_mode_lines is set too; that means
11349 that people can use force-mode-line-update to request
11350 that the menu bar be recomputed. The adverse effect on
11351 the rest of the redisplay algorithm is about the same as
11352 windows_or_buffers_changed anyway. */
11353 if (windows_or_buffers_changed
11354 /* This used to test w->update_mode_line, but we believe
11355 there is no need to recompute the menu in that case. */
11356 || update_mode_lines
11357 || window_buffer_changed (w
))
11359 struct buffer
*prev
= current_buffer
;
11360 ptrdiff_t count
= SPECPDL_INDEX ();
11362 specbind (Qinhibit_menubar_update
, Qt
);
11364 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11365 if (save_match_data
)
11366 record_unwind_save_match_data ();
11367 if (NILP (Voverriding_local_map_menu_flag
))
11369 specbind (Qoverriding_terminal_local_map
, Qnil
);
11370 specbind (Qoverriding_local_map
, Qnil
);
11375 /* Run the Lucid hook. */
11376 safe_run_hooks (Qactivate_menubar_hook
);
11378 /* If it has changed current-menubar from previous value,
11379 really recompute the menu-bar from the value. */
11380 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11381 call0 (Qrecompute_lucid_menubar
);
11383 safe_run_hooks (Qmenu_bar_update_hook
);
11388 XSETFRAME (Vmenu_updating_frame
, f
);
11389 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11391 /* Redisplay the menu bar in case we changed it. */
11392 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11393 || defined (HAVE_NS) || defined (USE_GTK)
11394 if (FRAME_WINDOW_P (f
))
11396 #if defined (HAVE_NS)
11397 /* All frames on Mac OS share the same menubar. So only
11398 the selected frame should be allowed to set it. */
11399 if (f
== SELECTED_FRAME ())
11401 set_frame_menubar (f
, 0, 0);
11404 /* On a terminal screen, the menu bar is an ordinary screen
11405 line, and this makes it get updated. */
11406 w
->update_mode_line
= 1;
11407 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11408 /* In the non-toolkit version, the menu bar is an ordinary screen
11409 line, and this makes it get updated. */
11410 w
->update_mode_line
= 1;
11411 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11413 unbind_to (count
, Qnil
);
11414 set_buffer_internal_1 (prev
);
11423 /***********************************************************************
11425 ***********************************************************************/
11427 #ifdef HAVE_WINDOW_SYSTEM
11430 Nominal cursor position -- where to draw output.
11431 HPOS and VPOS are window relative glyph matrix coordinates.
11432 X and Y are window relative pixel coordinates. */
11434 struct cursor_pos output_cursor
;
11438 Set the global variable output_cursor to CURSOR. All cursor
11439 positions are relative to updated_window. */
11442 set_output_cursor (struct cursor_pos
*cursor
)
11444 output_cursor
.hpos
= cursor
->hpos
;
11445 output_cursor
.vpos
= cursor
->vpos
;
11446 output_cursor
.x
= cursor
->x
;
11447 output_cursor
.y
= cursor
->y
;
11452 Set a nominal cursor position.
11454 HPOS and VPOS are column/row positions in a window glyph matrix. X
11455 and Y are window text area relative pixel positions.
11457 If this is done during an update, updated_window will contain the
11458 window that is being updated and the position is the future output
11459 cursor position for that window. If updated_window is null, use
11460 selected_window and display the cursor at the given position. */
11463 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11467 /* If updated_window is not set, work on selected_window. */
11468 if (updated_window
)
11469 w
= updated_window
;
11471 w
= XWINDOW (selected_window
);
11473 /* Set the output cursor. */
11474 output_cursor
.hpos
= hpos
;
11475 output_cursor
.vpos
= vpos
;
11476 output_cursor
.x
= x
;
11477 output_cursor
.y
= y
;
11479 /* If not called as part of an update, really display the cursor.
11480 This will also set the cursor position of W. */
11481 if (updated_window
== NULL
)
11484 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11485 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11486 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11491 #endif /* HAVE_WINDOW_SYSTEM */
11494 /***********************************************************************
11496 ***********************************************************************/
11498 #ifdef HAVE_WINDOW_SYSTEM
11500 /* Where the mouse was last time we reported a mouse event. */
11502 FRAME_PTR last_mouse_frame
;
11504 /* Tool-bar item index of the item on which a mouse button was pressed
11507 int last_tool_bar_item
;
11509 /* Select `frame' temporarily without running all the code in
11511 FIXME: Maybe do_switch_frame should be trimmed down similarly
11512 when `norecord' is set. */
11514 fast_set_selected_frame (Lisp_Object frame
)
11516 if (!EQ (selected_frame
, frame
))
11518 selected_frame
= frame
;
11519 selected_window
= XFRAME (frame
)->selected_window
;
11524 /* Update the tool-bar item list for frame F. This has to be done
11525 before we start to fill in any display lines. Called from
11526 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11527 and restore it here. */
11530 update_tool_bar (struct frame
*f
, int save_match_data
)
11532 #if defined (USE_GTK) || defined (HAVE_NS)
11533 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11535 int do_update
= WINDOWP (f
->tool_bar_window
)
11536 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11541 Lisp_Object window
;
11544 window
= FRAME_SELECTED_WINDOW (f
);
11545 w
= XWINDOW (window
);
11547 /* If the user has switched buffers or windows, we need to
11548 recompute to reflect the new bindings. But we'll
11549 recompute when update_mode_lines is set too; that means
11550 that people can use force-mode-line-update to request
11551 that the menu bar be recomputed. The adverse effect on
11552 the rest of the redisplay algorithm is about the same as
11553 windows_or_buffers_changed anyway. */
11554 if (windows_or_buffers_changed
11555 || w
->update_mode_line
11556 || update_mode_lines
11557 || window_buffer_changed (w
))
11559 struct buffer
*prev
= current_buffer
;
11560 ptrdiff_t count
= SPECPDL_INDEX ();
11561 Lisp_Object frame
, new_tool_bar
;
11562 int new_n_tool_bar
;
11563 struct gcpro gcpro1
;
11565 /* Set current_buffer to the buffer of the selected
11566 window of the frame, so that we get the right local
11568 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11570 /* Save match data, if we must. */
11571 if (save_match_data
)
11572 record_unwind_save_match_data ();
11574 /* Make sure that we don't accidentally use bogus keymaps. */
11575 if (NILP (Voverriding_local_map_menu_flag
))
11577 specbind (Qoverriding_terminal_local_map
, Qnil
);
11578 specbind (Qoverriding_local_map
, Qnil
);
11581 GCPRO1 (new_tool_bar
);
11583 /* We must temporarily set the selected frame to this frame
11584 before calling tool_bar_items, because the calculation of
11585 the tool-bar keymap uses the selected frame (see
11586 `tool-bar-make-keymap' in tool-bar.el). */
11587 eassert (EQ (selected_window
,
11588 /* Since we only explicitly preserve selected_frame,
11589 check that selected_window would be redundant. */
11590 XFRAME (selected_frame
)->selected_window
));
11591 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11592 XSETFRAME (frame
, f
);
11593 fast_set_selected_frame (frame
);
11595 /* Build desired tool-bar items from keymaps. */
11597 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11600 /* Redisplay the tool-bar if we changed it. */
11601 if (new_n_tool_bar
!= f
->n_tool_bar_items
11602 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11604 /* Redisplay that happens asynchronously due to an expose event
11605 may access f->tool_bar_items. Make sure we update both
11606 variables within BLOCK_INPUT so no such event interrupts. */
11608 fset_tool_bar_items (f
, new_tool_bar
);
11609 f
->n_tool_bar_items
= new_n_tool_bar
;
11610 w
->update_mode_line
= 1;
11616 unbind_to (count
, Qnil
);
11617 set_buffer_internal_1 (prev
);
11623 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11624 F's desired tool-bar contents. F->tool_bar_items must have
11625 been set up previously by calling prepare_menu_bars. */
11628 build_desired_tool_bar_string (struct frame
*f
)
11630 int i
, size
, size_needed
;
11631 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11632 Lisp_Object image
, plist
, props
;
11634 image
= plist
= props
= Qnil
;
11635 GCPRO3 (image
, plist
, props
);
11637 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11638 Otherwise, make a new string. */
11640 /* The size of the string we might be able to reuse. */
11641 size
= (STRINGP (f
->desired_tool_bar_string
)
11642 ? SCHARS (f
->desired_tool_bar_string
)
11645 /* We need one space in the string for each image. */
11646 size_needed
= f
->n_tool_bar_items
;
11648 /* Reuse f->desired_tool_bar_string, if possible. */
11649 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11650 fset_desired_tool_bar_string
11651 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11654 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11655 Fremove_text_properties (make_number (0), make_number (size
),
11656 props
, f
->desired_tool_bar_string
);
11659 /* Put a `display' property on the string for the images to display,
11660 put a `menu_item' property on tool-bar items with a value that
11661 is the index of the item in F's tool-bar item vector. */
11662 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11664 #define PROP(IDX) \
11665 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11667 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11668 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11669 int hmargin
, vmargin
, relief
, idx
, end
;
11671 /* If image is a vector, choose the image according to the
11673 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11674 if (VECTORP (image
))
11678 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11679 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11682 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11683 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11685 eassert (ASIZE (image
) >= idx
);
11686 image
= AREF (image
, idx
);
11691 /* Ignore invalid image specifications. */
11692 if (!valid_image_p (image
))
11695 /* Display the tool-bar button pressed, or depressed. */
11696 plist
= Fcopy_sequence (XCDR (image
));
11698 /* Compute margin and relief to draw. */
11699 relief
= (tool_bar_button_relief
>= 0
11700 ? tool_bar_button_relief
11701 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11702 hmargin
= vmargin
= relief
;
11704 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11705 INT_MAX
- max (hmargin
, vmargin
)))
11707 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11708 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11710 else if (CONSP (Vtool_bar_button_margin
))
11712 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11713 INT_MAX
- hmargin
))
11714 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11716 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11717 INT_MAX
- vmargin
))
11718 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11721 if (auto_raise_tool_bar_buttons_p
)
11723 /* Add a `:relief' property to the image spec if the item is
11727 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11734 /* If image is selected, display it pressed, i.e. with a
11735 negative relief. If it's not selected, display it with a
11737 plist
= Fplist_put (plist
, QCrelief
,
11739 ? make_number (-relief
)
11740 : make_number (relief
)));
11745 /* Put a margin around the image. */
11746 if (hmargin
|| vmargin
)
11748 if (hmargin
== vmargin
)
11749 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11751 plist
= Fplist_put (plist
, QCmargin
,
11752 Fcons (make_number (hmargin
),
11753 make_number (vmargin
)));
11756 /* If button is not enabled, and we don't have special images
11757 for the disabled state, make the image appear disabled by
11758 applying an appropriate algorithm to it. */
11759 if (!enabled_p
&& idx
< 0)
11760 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11762 /* Put a `display' text property on the string for the image to
11763 display. Put a `menu-item' property on the string that gives
11764 the start of this item's properties in the tool-bar items
11766 image
= Fcons (Qimage
, plist
);
11767 props
= list4 (Qdisplay
, image
,
11768 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11770 /* Let the last image hide all remaining spaces in the tool bar
11771 string. The string can be longer than needed when we reuse a
11772 previous string. */
11773 if (i
+ 1 == f
->n_tool_bar_items
)
11774 end
= SCHARS (f
->desired_tool_bar_string
);
11777 Fadd_text_properties (make_number (i
), make_number (end
),
11778 props
, f
->desired_tool_bar_string
);
11786 /* Display one line of the tool-bar of frame IT->f.
11788 HEIGHT specifies the desired height of the tool-bar line.
11789 If the actual height of the glyph row is less than HEIGHT, the
11790 row's height is increased to HEIGHT, and the icons are centered
11791 vertically in the new height.
11793 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11794 count a final empty row in case the tool-bar width exactly matches
11799 display_tool_bar_line (struct it
*it
, int height
)
11801 struct glyph_row
*row
= it
->glyph_row
;
11802 int max_x
= it
->last_visible_x
;
11803 struct glyph
*last
;
11805 prepare_desired_row (row
);
11806 row
->y
= it
->current_y
;
11808 /* Note that this isn't made use of if the face hasn't a box,
11809 so there's no need to check the face here. */
11810 it
->start_of_box_run_p
= 1;
11812 while (it
->current_x
< max_x
)
11814 int x
, n_glyphs_before
, i
, nglyphs
;
11815 struct it it_before
;
11817 /* Get the next display element. */
11818 if (!get_next_display_element (it
))
11820 /* Don't count empty row if we are counting needed tool-bar lines. */
11821 if (height
< 0 && !it
->hpos
)
11826 /* Produce glyphs. */
11827 n_glyphs_before
= row
->used
[TEXT_AREA
];
11830 PRODUCE_GLYPHS (it
);
11832 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11834 x
= it_before
.current_x
;
11835 while (i
< nglyphs
)
11837 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11839 if (x
+ glyph
->pixel_width
> max_x
)
11841 /* Glyph doesn't fit on line. Backtrack. */
11842 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11844 /* If this is the only glyph on this line, it will never fit on the
11845 tool-bar, so skip it. But ensure there is at least one glyph,
11846 so we don't accidentally disable the tool-bar. */
11847 if (n_glyphs_before
== 0
11848 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11854 x
+= glyph
->pixel_width
;
11858 /* Stop at line end. */
11859 if (ITERATOR_AT_END_OF_LINE_P (it
))
11862 set_iterator_to_next (it
, 1);
11867 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11869 /* Use default face for the border below the tool bar.
11871 FIXME: When auto-resize-tool-bars is grow-only, there is
11872 no additional border below the possibly empty tool-bar lines.
11873 So to make the extra empty lines look "normal", we have to
11874 use the tool-bar face for the border too. */
11875 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11876 it
->face_id
= DEFAULT_FACE_ID
;
11878 extend_face_to_end_of_line (it
);
11879 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11880 last
->right_box_line_p
= 1;
11881 if (last
== row
->glyphs
[TEXT_AREA
])
11882 last
->left_box_line_p
= 1;
11884 /* Make line the desired height and center it vertically. */
11885 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11887 /* Don't add more than one line height. */
11888 height
%= FRAME_LINE_HEIGHT (it
->f
);
11889 it
->max_ascent
+= height
/ 2;
11890 it
->max_descent
+= (height
+ 1) / 2;
11893 compute_line_metrics (it
);
11895 /* If line is empty, make it occupy the rest of the tool-bar. */
11896 if (!row
->displays_text_p
)
11898 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11899 row
->visible_height
= row
->height
;
11900 row
->ascent
= row
->phys_ascent
= 0;
11901 row
->extra_line_spacing
= 0;
11904 row
->full_width_p
= 1;
11905 row
->continued_p
= 0;
11906 row
->truncated_on_left_p
= 0;
11907 row
->truncated_on_right_p
= 0;
11909 it
->current_x
= it
->hpos
= 0;
11910 it
->current_y
+= row
->height
;
11916 /* Max tool-bar height. */
11918 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11919 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11921 /* Value is the number of screen lines needed to make all tool-bar
11922 items of frame F visible. The number of actual rows needed is
11923 returned in *N_ROWS if non-NULL. */
11926 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11928 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11930 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11931 the desired matrix, so use (unused) mode-line row as temporary row to
11932 avoid destroying the first tool-bar row. */
11933 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11935 /* Initialize an iterator for iteration over
11936 F->desired_tool_bar_string in the tool-bar window of frame F. */
11937 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11938 it
.first_visible_x
= 0;
11939 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11940 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11941 it
.paragraph_embedding
= L2R
;
11943 while (!ITERATOR_AT_END_P (&it
))
11945 clear_glyph_row (temp_row
);
11946 it
.glyph_row
= temp_row
;
11947 display_tool_bar_line (&it
, -1);
11949 clear_glyph_row (temp_row
);
11951 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11953 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11955 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11959 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11961 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
11962 If FRAME is nil or omitted, use the selected frame. */)
11963 (Lisp_Object frame
)
11965 struct frame
*f
= decode_any_frame (frame
);
11969 if (WINDOWP (f
->tool_bar_window
)
11970 && (w
= XWINDOW (f
->tool_bar_window
),
11971 WINDOW_TOTAL_LINES (w
) > 0))
11973 update_tool_bar (f
, 1);
11974 if (f
->n_tool_bar_items
)
11976 build_desired_tool_bar_string (f
);
11977 nlines
= tool_bar_lines_needed (f
, NULL
);
11981 return make_number (nlines
);
11985 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11986 height should be changed. */
11989 redisplay_tool_bar (struct frame
*f
)
11993 struct glyph_row
*row
;
11995 #if defined (USE_GTK) || defined (HAVE_NS)
11996 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11997 update_frame_tool_bar (f
);
12001 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12002 do anything. This means you must start with tool-bar-lines
12003 non-zero to get the auto-sizing effect. Or in other words, you
12004 can turn off tool-bars by specifying tool-bar-lines zero. */
12005 if (!WINDOWP (f
->tool_bar_window
)
12006 || (w
= XWINDOW (f
->tool_bar_window
),
12007 WINDOW_TOTAL_LINES (w
) == 0))
12010 /* Set up an iterator for the tool-bar window. */
12011 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12012 it
.first_visible_x
= 0;
12013 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
12014 row
= it
.glyph_row
;
12016 /* Build a string that represents the contents of the tool-bar. */
12017 build_desired_tool_bar_string (f
);
12018 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12019 /* FIXME: This should be controlled by a user option. But it
12020 doesn't make sense to have an R2L tool bar if the menu bar cannot
12021 be drawn also R2L, and making the menu bar R2L is tricky due
12022 toolkit-specific code that implements it. If an R2L tool bar is
12023 ever supported, display_tool_bar_line should also be augmented to
12024 call unproduce_glyphs like display_line and display_string
12026 it
.paragraph_embedding
= L2R
;
12028 if (f
->n_tool_bar_rows
== 0)
12032 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
12033 nlines
!= WINDOW_TOTAL_LINES (w
)))
12036 int old_height
= WINDOW_TOTAL_LINES (w
);
12038 XSETFRAME (frame
, f
);
12039 Fmodify_frame_parameters (frame
,
12040 Fcons (Fcons (Qtool_bar_lines
,
12041 make_number (nlines
)),
12043 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12045 clear_glyph_matrix (w
->desired_matrix
);
12046 fonts_changed_p
= 1;
12052 /* Display as many lines as needed to display all tool-bar items. */
12054 if (f
->n_tool_bar_rows
> 0)
12056 int border
, rows
, height
, extra
;
12058 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12059 border
= XINT (Vtool_bar_border
);
12060 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12061 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12062 else if (EQ (Vtool_bar_border
, Qborder_width
))
12063 border
= f
->border_width
;
12069 rows
= f
->n_tool_bar_rows
;
12070 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12071 extra
= it
.last_visible_y
- border
- height
* rows
;
12073 while (it
.current_y
< it
.last_visible_y
)
12076 if (extra
> 0 && rows
-- > 0)
12078 h
= (extra
+ rows
- 1) / rows
;
12081 display_tool_bar_line (&it
, height
+ h
);
12086 while (it
.current_y
< it
.last_visible_y
)
12087 display_tool_bar_line (&it
, 0);
12090 /* It doesn't make much sense to try scrolling in the tool-bar
12091 window, so don't do it. */
12092 w
->desired_matrix
->no_scrolling_p
= 1;
12093 w
->must_be_updated_p
= 1;
12095 if (!NILP (Vauto_resize_tool_bars
))
12097 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12098 int change_height_p
= 0;
12100 /* If we couldn't display everything, change the tool-bar's
12101 height if there is room for more. */
12102 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12103 && it
.current_y
< max_tool_bar_height
)
12104 change_height_p
= 1;
12106 row
= it
.glyph_row
- 1;
12108 /* If there are blank lines at the end, except for a partially
12109 visible blank line at the end that is smaller than
12110 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12111 if (!row
->displays_text_p
12112 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12113 change_height_p
= 1;
12115 /* If row displays tool-bar items, but is partially visible,
12116 change the tool-bar's height. */
12117 if (row
->displays_text_p
12118 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12119 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12120 change_height_p
= 1;
12122 /* Resize windows as needed by changing the `tool-bar-lines'
12123 frame parameter. */
12124 if (change_height_p
)
12127 int old_height
= WINDOW_TOTAL_LINES (w
);
12129 int nlines
= tool_bar_lines_needed (f
, &nrows
);
12131 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12132 && !f
->minimize_tool_bar_window_p
)
12133 ? (nlines
> old_height
)
12134 : (nlines
!= old_height
));
12135 f
->minimize_tool_bar_window_p
= 0;
12137 if (change_height_p
)
12139 XSETFRAME (frame
, f
);
12140 Fmodify_frame_parameters (frame
,
12141 Fcons (Fcons (Qtool_bar_lines
,
12142 make_number (nlines
)),
12144 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12146 clear_glyph_matrix (w
->desired_matrix
);
12147 f
->n_tool_bar_rows
= nrows
;
12148 fonts_changed_p
= 1;
12155 f
->minimize_tool_bar_window_p
= 0;
12160 /* Get information about the tool-bar item which is displayed in GLYPH
12161 on frame F. Return in *PROP_IDX the index where tool-bar item
12162 properties start in F->tool_bar_items. Value is zero if
12163 GLYPH doesn't display a tool-bar item. */
12166 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12172 /* This function can be called asynchronously, which means we must
12173 exclude any possibility that Fget_text_property signals an
12175 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12176 charpos
= max (0, charpos
);
12178 /* Get the text property `menu-item' at pos. The value of that
12179 property is the start index of this item's properties in
12180 F->tool_bar_items. */
12181 prop
= Fget_text_property (make_number (charpos
),
12182 Qmenu_item
, f
->current_tool_bar_string
);
12183 if (INTEGERP (prop
))
12185 *prop_idx
= XINT (prop
);
12195 /* Get information about the tool-bar item at position X/Y on frame F.
12196 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12197 the current matrix of the tool-bar window of F, or NULL if not
12198 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12199 item in F->tool_bar_items. Value is
12201 -1 if X/Y is not on a tool-bar item
12202 0 if X/Y is on the same item that was highlighted before.
12206 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12207 int *hpos
, int *vpos
, int *prop_idx
)
12209 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12210 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12213 /* Find the glyph under X/Y. */
12214 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12215 if (*glyph
== NULL
)
12218 /* Get the start of this tool-bar item's properties in
12219 f->tool_bar_items. */
12220 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12223 /* Is mouse on the highlighted item? */
12224 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12225 && *vpos
>= hlinfo
->mouse_face_beg_row
12226 && *vpos
<= hlinfo
->mouse_face_end_row
12227 && (*vpos
> hlinfo
->mouse_face_beg_row
12228 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12229 && (*vpos
< hlinfo
->mouse_face_end_row
12230 || *hpos
< hlinfo
->mouse_face_end_col
12231 || hlinfo
->mouse_face_past_end
))
12239 Handle mouse button event on the tool-bar of frame F, at
12240 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12241 0 for button release. MODIFIERS is event modifiers for button
12245 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12248 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12249 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12250 int hpos
, vpos
, prop_idx
;
12251 struct glyph
*glyph
;
12252 Lisp_Object enabled_p
;
12254 /* If not on the highlighted tool-bar item, return. */
12255 frame_to_window_pixel_xy (w
, &x
, &y
);
12256 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12259 /* If item is disabled, do nothing. */
12260 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12261 if (NILP (enabled_p
))
12266 /* Show item in pressed state. */
12267 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12268 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
12269 last_tool_bar_item
= prop_idx
;
12273 Lisp_Object key
, frame
;
12274 struct input_event event
;
12275 EVENT_INIT (event
);
12277 /* Show item in released state. */
12278 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12279 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
12281 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12283 XSETFRAME (frame
, f
);
12284 event
.kind
= TOOL_BAR_EVENT
;
12285 event
.frame_or_window
= frame
;
12287 kbd_buffer_store_event (&event
);
12289 event
.kind
= TOOL_BAR_EVENT
;
12290 event
.frame_or_window
= frame
;
12292 event
.modifiers
= modifiers
;
12293 kbd_buffer_store_event (&event
);
12294 last_tool_bar_item
= -1;
12299 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12300 tool-bar window-relative coordinates X/Y. Called from
12301 note_mouse_highlight. */
12304 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12306 Lisp_Object window
= f
->tool_bar_window
;
12307 struct window
*w
= XWINDOW (window
);
12308 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12309 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12311 struct glyph
*glyph
;
12312 struct glyph_row
*row
;
12314 Lisp_Object enabled_p
;
12316 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12317 int mouse_down_p
, rc
;
12319 /* Function note_mouse_highlight is called with negative X/Y
12320 values when mouse moves outside of the frame. */
12321 if (x
<= 0 || y
<= 0)
12323 clear_mouse_face (hlinfo
);
12327 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12330 /* Not on tool-bar item. */
12331 clear_mouse_face (hlinfo
);
12335 /* On same tool-bar item as before. */
12336 goto set_help_echo
;
12338 clear_mouse_face (hlinfo
);
12340 /* Mouse is down, but on different tool-bar item? */
12341 mouse_down_p
= (dpyinfo
->grabbed
12342 && f
== last_mouse_frame
12343 && FRAME_LIVE_P (f
));
12345 && last_tool_bar_item
!= prop_idx
)
12348 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
12349 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12351 /* If tool-bar item is not enabled, don't highlight it. */
12352 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12353 if (!NILP (enabled_p
))
12355 /* Compute the x-position of the glyph. In front and past the
12356 image is a space. We include this in the highlighted area. */
12357 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12358 for (i
= x
= 0; i
< hpos
; ++i
)
12359 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12361 /* Record this as the current active region. */
12362 hlinfo
->mouse_face_beg_col
= hpos
;
12363 hlinfo
->mouse_face_beg_row
= vpos
;
12364 hlinfo
->mouse_face_beg_x
= x
;
12365 hlinfo
->mouse_face_beg_y
= row
->y
;
12366 hlinfo
->mouse_face_past_end
= 0;
12368 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12369 hlinfo
->mouse_face_end_row
= vpos
;
12370 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12371 hlinfo
->mouse_face_end_y
= row
->y
;
12372 hlinfo
->mouse_face_window
= window
;
12373 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12375 /* Display it as active. */
12376 show_mouse_face (hlinfo
, draw
);
12377 hlinfo
->mouse_face_image_state
= draw
;
12382 /* Set help_echo_string to a help string to display for this tool-bar item.
12383 XTread_socket does the rest. */
12384 help_echo_object
= help_echo_window
= Qnil
;
12385 help_echo_pos
= -1;
12386 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12387 if (NILP (help_echo_string
))
12388 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12391 #endif /* HAVE_WINDOW_SYSTEM */
12395 /************************************************************************
12396 Horizontal scrolling
12397 ************************************************************************/
12399 static int hscroll_window_tree (Lisp_Object
);
12400 static int hscroll_windows (Lisp_Object
);
12402 /* For all leaf windows in the window tree rooted at WINDOW, set their
12403 hscroll value so that PT is (i) visible in the window, and (ii) so
12404 that it is not within a certain margin at the window's left and
12405 right border. Value is non-zero if any window's hscroll has been
12409 hscroll_window_tree (Lisp_Object window
)
12411 int hscrolled_p
= 0;
12412 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12413 int hscroll_step_abs
= 0;
12414 double hscroll_step_rel
= 0;
12416 if (hscroll_relative_p
)
12418 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12419 if (hscroll_step_rel
< 0)
12421 hscroll_relative_p
= 0;
12422 hscroll_step_abs
= 0;
12425 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12427 hscroll_step_abs
= XINT (Vhscroll_step
);
12428 if (hscroll_step_abs
< 0)
12429 hscroll_step_abs
= 0;
12432 hscroll_step_abs
= 0;
12434 while (WINDOWP (window
))
12436 struct window
*w
= XWINDOW (window
);
12438 if (WINDOWP (w
->hchild
))
12439 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12440 else if (WINDOWP (w
->vchild
))
12441 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12442 else if (w
->cursor
.vpos
>= 0)
12445 int text_area_width
;
12446 struct glyph_row
*current_cursor_row
12447 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12448 struct glyph_row
*desired_cursor_row
12449 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12450 struct glyph_row
*cursor_row
12451 = (desired_cursor_row
->enabled_p
12452 ? desired_cursor_row
12453 : current_cursor_row
);
12454 int row_r2l_p
= cursor_row
->reversed_p
;
12456 text_area_width
= window_box_width (w
, TEXT_AREA
);
12458 /* Scroll when cursor is inside this scroll margin. */
12459 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12461 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12462 /* For left-to-right rows, hscroll when cursor is either
12463 (i) inside the right hscroll margin, or (ii) if it is
12464 inside the left margin and the window is already
12468 && w
->cursor
.x
<= h_margin
)
12469 || (cursor_row
->enabled_p
12470 && cursor_row
->truncated_on_right_p
12471 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12472 /* For right-to-left rows, the logic is similar,
12473 except that rules for scrolling to left and right
12474 are reversed. E.g., if cursor.x <= h_margin, we
12475 need to hscroll "to the right" unconditionally,
12476 and that will scroll the screen to the left so as
12477 to reveal the next portion of the row. */
12479 && ((cursor_row
->enabled_p
12480 /* FIXME: It is confusing to set the
12481 truncated_on_right_p flag when R2L rows
12482 are actually truncated on the left. */
12483 && cursor_row
->truncated_on_right_p
12484 && w
->cursor
.x
<= h_margin
)
12486 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12490 struct buffer
*saved_current_buffer
;
12494 /* Find point in a display of infinite width. */
12495 saved_current_buffer
= current_buffer
;
12496 current_buffer
= XBUFFER (w
->buffer
);
12498 if (w
== XWINDOW (selected_window
))
12502 pt
= marker_position (w
->pointm
);
12503 pt
= max (BEGV
, pt
);
12507 /* Move iterator to pt starting at cursor_row->start in
12508 a line with infinite width. */
12509 init_to_row_start (&it
, w
, cursor_row
);
12510 it
.last_visible_x
= INFINITY
;
12511 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12512 current_buffer
= saved_current_buffer
;
12514 /* Position cursor in window. */
12515 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12516 hscroll
= max (0, (it
.current_x
12517 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12518 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12519 : (text_area_width
/ 2))))
12520 / FRAME_COLUMN_WIDTH (it
.f
);
12521 else if ((!row_r2l_p
12522 && w
->cursor
.x
>= text_area_width
- h_margin
)
12523 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12525 if (hscroll_relative_p
)
12526 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12529 wanted_x
= text_area_width
12530 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12533 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12537 if (hscroll_relative_p
)
12538 wanted_x
= text_area_width
* hscroll_step_rel
12541 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12544 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12546 hscroll
= max (hscroll
, w
->min_hscroll
);
12548 /* Don't prevent redisplay optimizations if hscroll
12549 hasn't changed, as it will unnecessarily slow down
12551 if (w
->hscroll
!= hscroll
)
12553 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12554 w
->hscroll
= hscroll
;
12563 /* Value is non-zero if hscroll of any leaf window has been changed. */
12564 return hscrolled_p
;
12568 /* Set hscroll so that cursor is visible and not inside horizontal
12569 scroll margins for all windows in the tree rooted at WINDOW. See
12570 also hscroll_window_tree above. Value is non-zero if any window's
12571 hscroll has been changed. If it has, desired matrices on the frame
12572 of WINDOW are cleared. */
12575 hscroll_windows (Lisp_Object window
)
12577 int hscrolled_p
= hscroll_window_tree (window
);
12579 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12580 return hscrolled_p
;
12585 /************************************************************************
12587 ************************************************************************/
12589 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12590 to a non-zero value. This is sometimes handy to have in a debugger
12595 /* First and last unchanged row for try_window_id. */
12597 static int debug_first_unchanged_at_end_vpos
;
12598 static int debug_last_unchanged_at_beg_vpos
;
12600 /* Delta vpos and y. */
12602 static int debug_dvpos
, debug_dy
;
12604 /* Delta in characters and bytes for try_window_id. */
12606 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12608 /* Values of window_end_pos and window_end_vpos at the end of
12611 static ptrdiff_t debug_end_vpos
;
12613 /* Append a string to W->desired_matrix->method. FMT is a printf
12614 format string. If trace_redisplay_p is non-zero also printf the
12615 resulting string to stderr. */
12617 static void debug_method_add (struct window
*, char const *, ...)
12618 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12621 debug_method_add (struct window
*w
, char const *fmt
, ...)
12623 char *method
= w
->desired_matrix
->method
;
12624 int len
= strlen (method
);
12625 int size
= sizeof w
->desired_matrix
->method
;
12626 int remaining
= size
- len
- 1;
12629 if (len
&& remaining
)
12632 --remaining
, ++len
;
12635 va_start (ap
, fmt
);
12636 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12639 if (trace_redisplay_p
)
12640 fprintf (stderr
, "%p (%s): %s\n",
12642 ((BUFFERP (w
->buffer
)
12643 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12644 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12649 #endif /* GLYPH_DEBUG */
12652 /* Value is non-zero if all changes in window W, which displays
12653 current_buffer, are in the text between START and END. START is a
12654 buffer position, END is given as a distance from Z. Used in
12655 redisplay_internal for display optimization. */
12658 text_outside_line_unchanged_p (struct window
*w
,
12659 ptrdiff_t start
, ptrdiff_t end
)
12661 int unchanged_p
= 1;
12663 /* If text or overlays have changed, see where. */
12664 if (window_outdated (w
))
12666 /* Gap in the line? */
12667 if (GPT
< start
|| Z
- GPT
< end
)
12670 /* Changes start in front of the line, or end after it? */
12672 && (BEG_UNCHANGED
< start
- 1
12673 || END_UNCHANGED
< end
))
12676 /* If selective display, can't optimize if changes start at the
12677 beginning of the line. */
12679 && INTEGERP (BVAR (current_buffer
, selective_display
))
12680 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12681 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12684 /* If there are overlays at the start or end of the line, these
12685 may have overlay strings with newlines in them. A change at
12686 START, for instance, may actually concern the display of such
12687 overlay strings as well, and they are displayed on different
12688 lines. So, quickly rule out this case. (For the future, it
12689 might be desirable to implement something more telling than
12690 just BEG/END_UNCHANGED.) */
12693 if (BEG
+ BEG_UNCHANGED
== start
12694 && overlay_touches_p (start
))
12696 if (END_UNCHANGED
== end
12697 && overlay_touches_p (Z
- end
))
12701 /* Under bidi reordering, adding or deleting a character in the
12702 beginning of a paragraph, before the first strong directional
12703 character, can change the base direction of the paragraph (unless
12704 the buffer specifies a fixed paragraph direction), which will
12705 require to redisplay the whole paragraph. It might be worthwhile
12706 to find the paragraph limits and widen the range of redisplayed
12707 lines to that, but for now just give up this optimization. */
12708 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12709 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12713 return unchanged_p
;
12717 /* Do a frame update, taking possible shortcuts into account. This is
12718 the main external entry point for redisplay.
12720 If the last redisplay displayed an echo area message and that message
12721 is no longer requested, we clear the echo area or bring back the
12722 mini-buffer if that is in use. */
12727 redisplay_internal ();
12732 overlay_arrow_string_or_property (Lisp_Object var
)
12736 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12739 return Voverlay_arrow_string
;
12742 /* Return 1 if there are any overlay-arrows in current_buffer. */
12744 overlay_arrow_in_current_buffer_p (void)
12748 for (vlist
= Voverlay_arrow_variable_list
;
12750 vlist
= XCDR (vlist
))
12752 Lisp_Object var
= XCAR (vlist
);
12755 if (!SYMBOLP (var
))
12757 val
= find_symbol_value (var
);
12759 && current_buffer
== XMARKER (val
)->buffer
)
12766 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12770 overlay_arrows_changed_p (void)
12774 for (vlist
= Voverlay_arrow_variable_list
;
12776 vlist
= XCDR (vlist
))
12778 Lisp_Object var
= XCAR (vlist
);
12779 Lisp_Object val
, pstr
;
12781 if (!SYMBOLP (var
))
12783 val
= find_symbol_value (var
);
12784 if (!MARKERP (val
))
12786 if (! EQ (COERCE_MARKER (val
),
12787 Fget (var
, Qlast_arrow_position
))
12788 || ! (pstr
= overlay_arrow_string_or_property (var
),
12789 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12795 /* Mark overlay arrows to be updated on next redisplay. */
12798 update_overlay_arrows (int up_to_date
)
12802 for (vlist
= Voverlay_arrow_variable_list
;
12804 vlist
= XCDR (vlist
))
12806 Lisp_Object var
= XCAR (vlist
);
12808 if (!SYMBOLP (var
))
12811 if (up_to_date
> 0)
12813 Lisp_Object val
= find_symbol_value (var
);
12814 Fput (var
, Qlast_arrow_position
,
12815 COERCE_MARKER (val
));
12816 Fput (var
, Qlast_arrow_string
,
12817 overlay_arrow_string_or_property (var
));
12819 else if (up_to_date
< 0
12820 || !NILP (Fget (var
, Qlast_arrow_position
)))
12822 Fput (var
, Qlast_arrow_position
, Qt
);
12823 Fput (var
, Qlast_arrow_string
, Qt
);
12829 /* Return overlay arrow string to display at row.
12830 Return integer (bitmap number) for arrow bitmap in left fringe.
12831 Return nil if no overlay arrow. */
12834 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12838 for (vlist
= Voverlay_arrow_variable_list
;
12840 vlist
= XCDR (vlist
))
12842 Lisp_Object var
= XCAR (vlist
);
12845 if (!SYMBOLP (var
))
12848 val
= find_symbol_value (var
);
12851 && current_buffer
== XMARKER (val
)->buffer
12852 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12854 if (FRAME_WINDOW_P (it
->f
)
12855 /* FIXME: if ROW->reversed_p is set, this should test
12856 the right fringe, not the left one. */
12857 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12859 #ifdef HAVE_WINDOW_SYSTEM
12860 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12863 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12864 return make_number (fringe_bitmap
);
12867 return make_number (-1); /* Use default arrow bitmap. */
12869 return overlay_arrow_string_or_property (var
);
12876 /* Return 1 if point moved out of or into a composition. Otherwise
12877 return 0. PREV_BUF and PREV_PT are the last point buffer and
12878 position. BUF and PT are the current point buffer and position. */
12881 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12882 struct buffer
*buf
, ptrdiff_t pt
)
12884 ptrdiff_t start
, end
;
12886 Lisp_Object buffer
;
12888 XSETBUFFER (buffer
, buf
);
12889 /* Check a composition at the last point if point moved within the
12891 if (prev_buf
== buf
)
12894 /* Point didn't move. */
12897 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12898 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12899 && COMPOSITION_VALID_P (start
, end
, prop
)
12900 && start
< prev_pt
&& end
> prev_pt
)
12901 /* The last point was within the composition. Return 1 iff
12902 point moved out of the composition. */
12903 return (pt
<= start
|| pt
>= end
);
12906 /* Check a composition at the current point. */
12907 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12908 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12909 && COMPOSITION_VALID_P (start
, end
, prop
)
12910 && start
< pt
&& end
> pt
);
12914 /* Reconsider the setting of B->clip_changed which is displayed
12918 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12920 if (b
->clip_changed
12921 && !NILP (w
->window_end_valid
)
12922 && w
->current_matrix
->buffer
== b
12923 && w
->current_matrix
->zv
== BUF_ZV (b
)
12924 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12925 b
->clip_changed
= 0;
12927 /* If display wasn't paused, and W is not a tool bar window, see if
12928 point has been moved into or out of a composition. In that case,
12929 we set b->clip_changed to 1 to force updating the screen. If
12930 b->clip_changed has already been set to 1, we can skip this
12932 if (!b
->clip_changed
12933 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12937 if (w
== XWINDOW (selected_window
))
12940 pt
= marker_position (w
->pointm
);
12942 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12943 || pt
!= w
->last_point
)
12944 && check_point_in_composition (w
->current_matrix
->buffer
,
12946 XBUFFER (w
->buffer
), pt
))
12947 b
->clip_changed
= 1;
12952 /* Select FRAME to forward the values of frame-local variables into C
12953 variables so that the redisplay routines can access those values
12957 select_frame_for_redisplay (Lisp_Object frame
)
12959 Lisp_Object tail
, tem
;
12960 Lisp_Object old
= selected_frame
;
12961 struct Lisp_Symbol
*sym
;
12963 eassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12965 selected_frame
= frame
;
12968 for (tail
= XFRAME (frame
)->param_alist
;
12969 CONSP (tail
); tail
= XCDR (tail
))
12970 if (CONSP (XCAR (tail
))
12971 && (tem
= XCAR (XCAR (tail
)),
12973 && (sym
= indirect_variable (XSYMBOL (tem
)),
12974 sym
->redirect
== SYMBOL_LOCALIZED
)
12975 && sym
->val
.blv
->frame_local
)
12976 /* Use find_symbol_value rather than Fsymbol_value
12977 to avoid an error if it is void. */
12978 find_symbol_value (tem
);
12979 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12982 /* Make sure that previously selected OLD_FRAME is selected unless it has been
12983 deleted (by an X connection failure during redisplay, for example). */
12986 ensure_selected_frame (Lisp_Object old_frame
)
12988 if (!EQ (old_frame
, selected_frame
) && FRAME_LIVE_P (XFRAME (old_frame
)))
12989 select_frame_for_redisplay (old_frame
);
12992 #define STOP_POLLING \
12993 do { if (! polling_stopped_here) stop_polling (); \
12994 polling_stopped_here = 1; } while (0)
12996 #define RESUME_POLLING \
12997 do { if (polling_stopped_here) start_polling (); \
12998 polling_stopped_here = 0; } while (0)
13001 /* Perhaps in the future avoid recentering windows if it
13002 is not necessary; currently that causes some problems. */
13005 redisplay_internal (void)
13007 struct window
*w
= XWINDOW (selected_window
);
13011 int must_finish
= 0;
13012 struct text_pos tlbufpos
, tlendpos
;
13013 int number_of_visible_frames
;
13014 ptrdiff_t count
, count1
;
13016 int polling_stopped_here
= 0;
13017 Lisp_Object tail
, frame
, old_frame
= selected_frame
;
13018 struct backtrace backtrace
;
13020 /* Non-zero means redisplay has to consider all windows on all
13021 frames. Zero means, only selected_window is considered. */
13022 int consider_all_windows_p
;
13024 /* Non-zero means redisplay has to redisplay the miniwindow. */
13025 int update_miniwindow_p
= 0;
13027 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13029 /* No redisplay if running in batch mode or frame is not yet fully
13030 initialized, or redisplay is explicitly turned off by setting
13031 Vinhibit_redisplay. */
13032 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13033 || !NILP (Vinhibit_redisplay
))
13036 /* Don't examine these until after testing Vinhibit_redisplay.
13037 When Emacs is shutting down, perhaps because its connection to
13038 X has dropped, we should not look at them at all. */
13039 fr
= XFRAME (w
->frame
);
13040 sf
= SELECTED_FRAME ();
13042 if (!fr
->glyphs_initialized_p
)
13045 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13046 if (popup_activated ())
13050 /* I don't think this happens but let's be paranoid. */
13051 if (redisplaying_p
)
13054 /* Record a function that clears redisplaying_p
13055 when we leave this function. */
13056 count
= SPECPDL_INDEX ();
13057 record_unwind_protect (unwind_redisplay
, selected_frame
);
13058 redisplaying_p
= 1;
13059 specbind (Qinhibit_free_realized_faces
, Qnil
);
13061 /* Record this function, so it appears on the profiler's backtraces. */
13062 backtrace
.next
= backtrace_list
;
13063 backtrace
.function
= Qredisplay_internal
;
13064 backtrace
.args
= &Qnil
;
13065 backtrace
.nargs
= 0;
13066 backtrace
.debug_on_exit
= 0;
13067 backtrace_list
= &backtrace
;
13069 FOR_EACH_FRAME (tail
, frame
)
13070 XFRAME (frame
)->already_hscrolled_p
= 0;
13073 /* Remember the currently selected window. */
13076 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
13077 selected_frame and selected_window to be temporarily out-of-sync so
13078 when we come back here via `goto retry', we need to resync because we
13079 may need to run Elisp code (via prepare_menu_bars). */
13080 ensure_selected_frame (old_frame
);
13083 reconsider_clip_changes (w
, current_buffer
);
13084 last_escape_glyph_frame
= NULL
;
13085 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13086 last_glyphless_glyph_frame
= NULL
;
13087 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13089 /* If new fonts have been loaded that make a glyph matrix adjustment
13090 necessary, do it. */
13091 if (fonts_changed_p
)
13093 adjust_glyphs (NULL
);
13094 ++windows_or_buffers_changed
;
13095 fonts_changed_p
= 0;
13098 /* If face_change_count is non-zero, init_iterator will free all
13099 realized faces, which includes the faces referenced from current
13100 matrices. So, we can't reuse current matrices in this case. */
13101 if (face_change_count
)
13102 ++windows_or_buffers_changed
;
13104 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13105 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13107 /* Since frames on a single ASCII terminal share the same
13108 display area, displaying a different frame means redisplay
13109 the whole thing. */
13110 windows_or_buffers_changed
++;
13111 SET_FRAME_GARBAGED (sf
);
13113 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13115 FRAME_TTY (sf
)->previous_frame
= sf
;
13118 /* Set the visible flags for all frames. Do this before checking for
13119 resized or garbaged frames; they want to know if their frames are
13120 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13121 number_of_visible_frames
= 0;
13123 FOR_EACH_FRAME (tail
, frame
)
13125 struct frame
*f
= XFRAME (frame
);
13127 FRAME_SAMPLE_VISIBILITY (f
);
13128 if (FRAME_VISIBLE_P (f
))
13129 ++number_of_visible_frames
;
13130 clear_desired_matrices (f
);
13133 /* Notice any pending interrupt request to change frame size. */
13134 do_pending_window_change (1);
13136 /* do_pending_window_change could change the selected_window due to
13137 frame resizing which makes the selected window too small. */
13138 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13141 reconsider_clip_changes (w
, current_buffer
);
13144 /* Clear frames marked as garbaged. */
13145 clear_garbaged_frames ();
13147 /* Build menubar and tool-bar items. */
13148 if (NILP (Vmemory_full
))
13149 prepare_menu_bars ();
13151 if (windows_or_buffers_changed
)
13152 update_mode_lines
++;
13154 /* Detect case that we need to write or remove a star in the mode line. */
13155 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13157 w
->update_mode_line
= 1;
13158 if (buffer_shared_and_changed ())
13159 update_mode_lines
++;
13162 /* Avoid invocation of point motion hooks by `current_column' below. */
13163 count1
= SPECPDL_INDEX ();
13164 specbind (Qinhibit_point_motion_hooks
, Qt
);
13166 if (mode_line_update_needed (w
))
13167 w
->update_mode_line
= 1;
13169 unbind_to (count1
, Qnil
);
13171 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
13173 consider_all_windows_p
= (update_mode_lines
13174 || buffer_shared_and_changed ()
13175 || cursor_type_changed
);
13177 /* If specs for an arrow have changed, do thorough redisplay
13178 to ensure we remove any arrow that should no longer exist. */
13179 if (overlay_arrows_changed_p ())
13180 consider_all_windows_p
= windows_or_buffers_changed
= 1;
13182 /* Normally the message* functions will have already displayed and
13183 updated the echo area, but the frame may have been trashed, or
13184 the update may have been preempted, so display the echo area
13185 again here. Checking message_cleared_p captures the case that
13186 the echo area should be cleared. */
13187 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13188 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13189 || (message_cleared_p
13190 && minibuf_level
== 0
13191 /* If the mini-window is currently selected, this means the
13192 echo-area doesn't show through. */
13193 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13195 int window_height_changed_p
= echo_area_display (0);
13197 if (message_cleared_p
)
13198 update_miniwindow_p
= 1;
13202 /* If we don't display the current message, don't clear the
13203 message_cleared_p flag, because, if we did, we wouldn't clear
13204 the echo area in the next redisplay which doesn't preserve
13206 if (!display_last_displayed_message_p
)
13207 message_cleared_p
= 0;
13209 if (fonts_changed_p
)
13211 else if (window_height_changed_p
)
13213 consider_all_windows_p
= 1;
13214 ++update_mode_lines
;
13215 ++windows_or_buffers_changed
;
13217 /* If window configuration was changed, frames may have been
13218 marked garbaged. Clear them or we will experience
13219 surprises wrt scrolling. */
13220 clear_garbaged_frames ();
13223 else if (EQ (selected_window
, minibuf_window
)
13224 && (current_buffer
->clip_changed
|| window_outdated (w
))
13225 && resize_mini_window (w
, 0))
13227 /* Resized active mini-window to fit the size of what it is
13228 showing if its contents might have changed. */
13230 /* FIXME: this causes all frames to be updated, which seems unnecessary
13231 since only the current frame needs to be considered. This function
13232 needs to be rewritten with two variables, consider_all_windows and
13233 consider_all_frames. */
13234 consider_all_windows_p
= 1;
13235 ++windows_or_buffers_changed
;
13236 ++update_mode_lines
;
13238 /* If window configuration was changed, frames may have been
13239 marked garbaged. Clear them or we will experience
13240 surprises wrt scrolling. */
13241 clear_garbaged_frames ();
13245 /* If showing the region, and mark has changed, we must redisplay
13246 the whole window. The assignment to this_line_start_pos prevents
13247 the optimization directly below this if-statement. */
13248 if (((!NILP (Vtransient_mark_mode
)
13249 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
13250 != !NILP (w
->region_showing
))
13251 || (!NILP (w
->region_showing
)
13252 && !EQ (w
->region_showing
,
13253 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
13254 CHARPOS (this_line_start_pos
) = 0;
13256 /* Optimize the case that only the line containing the cursor in the
13257 selected window has changed. Variables starting with this_ are
13258 set in display_line and record information about the line
13259 containing the cursor. */
13260 tlbufpos
= this_line_start_pos
;
13261 tlendpos
= this_line_end_pos
;
13262 if (!consider_all_windows_p
13263 && CHARPOS (tlbufpos
) > 0
13264 && !w
->update_mode_line
13265 && !current_buffer
->clip_changed
13266 && !current_buffer
->prevent_redisplay_optimizations_p
13267 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13268 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13269 /* Make sure recorded data applies to current buffer, etc. */
13270 && this_line_buffer
== current_buffer
13271 && current_buffer
== XBUFFER (w
->buffer
)
13273 && !w
->optional_new_start
13274 /* Point must be on the line that we have info recorded about. */
13275 && PT
>= CHARPOS (tlbufpos
)
13276 && PT
<= Z
- CHARPOS (tlendpos
)
13277 /* All text outside that line, including its final newline,
13278 must be unchanged. */
13279 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13280 CHARPOS (tlendpos
)))
13282 if (CHARPOS (tlbufpos
) > BEGV
13283 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13284 && (CHARPOS (tlbufpos
) == ZV
13285 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13286 /* Former continuation line has disappeared by becoming empty. */
13288 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13290 /* We have to handle the case of continuation around a
13291 wide-column character (see the comment in indent.c around
13294 For instance, in the following case:
13296 -------- Insert --------
13297 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13298 J_I_ ==> J_I_ `^^' are cursors.
13302 As we have to redraw the line above, we cannot use this
13306 int line_height_before
= this_line_pixel_height
;
13308 /* Note that start_display will handle the case that the
13309 line starting at tlbufpos is a continuation line. */
13310 start_display (&it
, w
, tlbufpos
);
13312 /* Implementation note: It this still necessary? */
13313 if (it
.current_x
!= this_line_start_x
)
13316 TRACE ((stderr
, "trying display optimization 1\n"));
13317 w
->cursor
.vpos
= -1;
13318 overlay_arrow_seen
= 0;
13319 it
.vpos
= this_line_vpos
;
13320 it
.current_y
= this_line_y
;
13321 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13322 display_line (&it
);
13324 /* If line contains point, is not continued,
13325 and ends at same distance from eob as before, we win. */
13326 if (w
->cursor
.vpos
>= 0
13327 /* Line is not continued, otherwise this_line_start_pos
13328 would have been set to 0 in display_line. */
13329 && CHARPOS (this_line_start_pos
)
13330 /* Line ends as before. */
13331 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13332 /* Line has same height as before. Otherwise other lines
13333 would have to be shifted up or down. */
13334 && this_line_pixel_height
== line_height_before
)
13336 /* If this is not the window's last line, we must adjust
13337 the charstarts of the lines below. */
13338 if (it
.current_y
< it
.last_visible_y
)
13340 struct glyph_row
*row
13341 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13342 ptrdiff_t delta
, delta_bytes
;
13344 /* We used to distinguish between two cases here,
13345 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13346 when the line ends in a newline or the end of the
13347 buffer's accessible portion. But both cases did
13348 the same, so they were collapsed. */
13350 - CHARPOS (tlendpos
)
13351 - MATRIX_ROW_START_CHARPOS (row
));
13352 delta_bytes
= (Z_BYTE
13353 - BYTEPOS (tlendpos
)
13354 - MATRIX_ROW_START_BYTEPOS (row
));
13356 increment_matrix_positions (w
->current_matrix
,
13357 this_line_vpos
+ 1,
13358 w
->current_matrix
->nrows
,
13359 delta
, delta_bytes
);
13362 /* If this row displays text now but previously didn't,
13363 or vice versa, w->window_end_vpos may have to be
13365 if ((it
.glyph_row
- 1)->displays_text_p
)
13367 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13368 wset_window_end_vpos (w
, make_number (this_line_vpos
));
13370 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13371 && this_line_vpos
> 0)
13372 wset_window_end_vpos (w
, make_number (this_line_vpos
- 1));
13373 wset_window_end_valid (w
, Qnil
);
13375 /* Update hint: No need to try to scroll in update_window. */
13376 w
->desired_matrix
->no_scrolling_p
= 1;
13379 *w
->desired_matrix
->method
= 0;
13380 debug_method_add (w
, "optimization 1");
13382 #ifdef HAVE_WINDOW_SYSTEM
13383 update_window_fringes (w
, 0);
13390 else if (/* Cursor position hasn't changed. */
13391 PT
== w
->last_point
13392 /* Make sure the cursor was last displayed
13393 in this window. Otherwise we have to reposition it. */
13394 && 0 <= w
->cursor
.vpos
13395 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13399 do_pending_window_change (1);
13400 /* If selected_window changed, redisplay again. */
13401 if (WINDOWP (selected_window
)
13402 && (w
= XWINDOW (selected_window
)) != sw
)
13405 /* We used to always goto end_of_redisplay here, but this
13406 isn't enough if we have a blinking cursor. */
13407 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13408 goto end_of_redisplay
;
13412 /* If highlighting the region, or if the cursor is in the echo area,
13413 then we can't just move the cursor. */
13414 else if (! (!NILP (Vtransient_mark_mode
)
13415 && !NILP (BVAR (current_buffer
, mark_active
)))
13416 && (EQ (selected_window
,
13417 BVAR (current_buffer
, last_selected_window
))
13418 || highlight_nonselected_windows
)
13419 && NILP (w
->region_showing
)
13420 && NILP (Vshow_trailing_whitespace
)
13421 && !cursor_in_echo_area
)
13424 struct glyph_row
*row
;
13426 /* Skip from tlbufpos to PT and see where it is. Note that
13427 PT may be in invisible text. If so, we will end at the
13428 next visible position. */
13429 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13430 NULL
, DEFAULT_FACE_ID
);
13431 it
.current_x
= this_line_start_x
;
13432 it
.current_y
= this_line_y
;
13433 it
.vpos
= this_line_vpos
;
13435 /* The call to move_it_to stops in front of PT, but
13436 moves over before-strings. */
13437 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13439 if (it
.vpos
== this_line_vpos
13440 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13443 eassert (this_line_vpos
== it
.vpos
);
13444 eassert (this_line_y
== it
.current_y
);
13445 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13447 *w
->desired_matrix
->method
= 0;
13448 debug_method_add (w
, "optimization 3");
13457 /* Text changed drastically or point moved off of line. */
13458 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13461 CHARPOS (this_line_start_pos
) = 0;
13462 consider_all_windows_p
|= buffer_shared_and_changed ();
13463 ++clear_face_cache_count
;
13464 #ifdef HAVE_WINDOW_SYSTEM
13465 ++clear_image_cache_count
;
13468 /* Build desired matrices, and update the display. If
13469 consider_all_windows_p is non-zero, do it for all windows on all
13470 frames. Otherwise do it for selected_window, only. */
13472 if (consider_all_windows_p
)
13474 FOR_EACH_FRAME (tail
, frame
)
13475 XFRAME (frame
)->updated_p
= 0;
13477 /* Recompute # windows showing selected buffer. This will be
13478 incremented each time such a window is displayed. */
13481 FOR_EACH_FRAME (tail
, frame
)
13483 struct frame
*f
= XFRAME (frame
);
13485 /* We don't have to do anything for unselected terminal
13487 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13488 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13491 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13493 if (! EQ (frame
, selected_frame
))
13494 /* Select the frame, for the sake of frame-local
13496 select_frame_for_redisplay (frame
);
13498 /* Mark all the scroll bars to be removed; we'll redeem
13499 the ones we want when we redisplay their windows. */
13500 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13501 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13503 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13504 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13506 /* The X error handler may have deleted that frame. */
13507 if (!FRAME_LIVE_P (f
))
13510 /* Any scroll bars which redisplay_windows should have
13511 nuked should now go away. */
13512 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13513 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13515 /* If fonts changed, display again. */
13516 /* ??? rms: I suspect it is a mistake to jump all the way
13517 back to retry here. It should just retry this frame. */
13518 if (fonts_changed_p
)
13521 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13523 /* See if we have to hscroll. */
13524 if (!f
->already_hscrolled_p
)
13526 f
->already_hscrolled_p
= 1;
13527 if (hscroll_windows (f
->root_window
))
13531 /* Prevent various kinds of signals during display
13532 update. stdio is not robust about handling
13533 signals, which can cause an apparent I/O
13535 if (interrupt_input
)
13536 unrequest_sigio ();
13539 /* Update the display. */
13540 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13541 pending
|= update_frame (f
, 0, 0);
13547 /* We played a bit fast-and-loose above and allowed selected_frame
13548 and selected_window to be temporarily out-of-sync but let's make
13549 sure this stays contained. */
13550 ensure_selected_frame (old_frame
);
13551 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13555 /* Do the mark_window_display_accurate after all windows have
13556 been redisplayed because this call resets flags in buffers
13557 which are needed for proper redisplay. */
13558 FOR_EACH_FRAME (tail
, frame
)
13560 struct frame
*f
= XFRAME (frame
);
13563 mark_window_display_accurate (f
->root_window
, 1);
13564 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13565 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13570 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13572 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13573 struct frame
*mini_frame
;
13575 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13576 /* Use list_of_error, not Qerror, so that
13577 we catch only errors and don't run the debugger. */
13578 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13580 redisplay_window_error
);
13581 if (update_miniwindow_p
)
13582 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13584 redisplay_window_error
);
13586 /* Compare desired and current matrices, perform output. */
13589 /* If fonts changed, display again. */
13590 if (fonts_changed_p
)
13593 /* Prevent various kinds of signals during display update.
13594 stdio is not robust about handling signals,
13595 which can cause an apparent I/O error. */
13596 if (interrupt_input
)
13597 unrequest_sigio ();
13600 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13602 if (hscroll_windows (selected_window
))
13605 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13606 pending
= update_frame (sf
, 0, 0);
13609 /* We may have called echo_area_display at the top of this
13610 function. If the echo area is on another frame, that may
13611 have put text on a frame other than the selected one, so the
13612 above call to update_frame would not have caught it. Catch
13614 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13615 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13617 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13619 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13620 pending
|= update_frame (mini_frame
, 0, 0);
13621 if (!pending
&& hscroll_windows (mini_window
))
13626 /* If display was paused because of pending input, make sure we do a
13627 thorough update the next time. */
13630 /* Prevent the optimization at the beginning of
13631 redisplay_internal that tries a single-line update of the
13632 line containing the cursor in the selected window. */
13633 CHARPOS (this_line_start_pos
) = 0;
13635 /* Let the overlay arrow be updated the next time. */
13636 update_overlay_arrows (0);
13638 /* If we pause after scrolling, some rows in the current
13639 matrices of some windows are not valid. */
13640 if (!WINDOW_FULL_WIDTH_P (w
)
13641 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13642 update_mode_lines
= 1;
13646 if (!consider_all_windows_p
)
13648 /* This has already been done above if
13649 consider_all_windows_p is set. */
13650 mark_window_display_accurate_1 (w
, 1);
13652 /* Say overlay arrows are up to date. */
13653 update_overlay_arrows (1);
13655 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13656 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13659 update_mode_lines
= 0;
13660 windows_or_buffers_changed
= 0;
13661 cursor_type_changed
= 0;
13664 /* Start SIGIO interrupts coming again. Having them off during the
13665 code above makes it less likely one will discard output, but not
13666 impossible, since there might be stuff in the system buffer here.
13667 But it is much hairier to try to do anything about that. */
13668 if (interrupt_input
)
13672 /* If a frame has become visible which was not before, redisplay
13673 again, so that we display it. Expose events for such a frame
13674 (which it gets when becoming visible) don't call the parts of
13675 redisplay constructing glyphs, so simply exposing a frame won't
13676 display anything in this case. So, we have to display these
13677 frames here explicitly. */
13682 FOR_EACH_FRAME (tail
, frame
)
13684 int this_is_visible
= 0;
13686 if (XFRAME (frame
)->visible
)
13687 this_is_visible
= 1;
13688 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13689 if (XFRAME (frame
)->visible
)
13690 this_is_visible
= 1;
13692 if (this_is_visible
)
13696 if (new_count
!= number_of_visible_frames
)
13697 windows_or_buffers_changed
++;
13700 /* Change frame size now if a change is pending. */
13701 do_pending_window_change (1);
13703 /* If we just did a pending size change, or have additional
13704 visible frames, or selected_window changed, redisplay again. */
13705 if ((windows_or_buffers_changed
&& !pending
)
13706 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13709 /* Clear the face and image caches.
13711 We used to do this only if consider_all_windows_p. But the cache
13712 needs to be cleared if a timer creates images in the current
13713 buffer (e.g. the test case in Bug#6230). */
13715 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13717 clear_face_cache (0);
13718 clear_face_cache_count
= 0;
13721 #ifdef HAVE_WINDOW_SYSTEM
13722 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13724 clear_image_caches (Qnil
);
13725 clear_image_cache_count
= 0;
13727 #endif /* HAVE_WINDOW_SYSTEM */
13730 backtrace_list
= backtrace
.next
;
13731 unbind_to (count
, Qnil
);
13736 /* Redisplay, but leave alone any recent echo area message unless
13737 another message has been requested in its place.
13739 This is useful in situations where you need to redisplay but no
13740 user action has occurred, making it inappropriate for the message
13741 area to be cleared. See tracking_off and
13742 wait_reading_process_output for examples of these situations.
13744 FROM_WHERE is an integer saying from where this function was
13745 called. This is useful for debugging. */
13748 redisplay_preserve_echo_area (int from_where
)
13750 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13752 if (!NILP (echo_area_buffer
[1]))
13754 /* We have a previously displayed message, but no current
13755 message. Redisplay the previous message. */
13756 display_last_displayed_message_p
= 1;
13757 redisplay_internal ();
13758 display_last_displayed_message_p
= 0;
13761 redisplay_internal ();
13763 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13764 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13765 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13769 /* Function registered with record_unwind_protect in redisplay_internal.
13770 Clear redisplaying_p. Also select the previously selected frame. */
13773 unwind_redisplay (Lisp_Object old_frame
)
13775 redisplaying_p
= 0;
13776 ensure_selected_frame (old_frame
);
13781 /* Mark the display of window W as accurate or inaccurate. If
13782 ACCURATE_P is non-zero mark display of W as accurate. If
13783 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13784 redisplay_internal is called. */
13787 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13789 if (BUFFERP (w
->buffer
))
13791 struct buffer
*b
= XBUFFER (w
->buffer
);
13793 w
->last_modified
= accurate_p
? BUF_MODIFF(b
) : 0;
13794 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF(b
) : 0;
13796 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13800 b
->clip_changed
= 0;
13801 b
->prevent_redisplay_optimizations_p
= 0;
13803 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13804 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13805 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13806 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13808 w
->current_matrix
->buffer
= b
;
13809 w
->current_matrix
->begv
= BUF_BEGV (b
);
13810 w
->current_matrix
->zv
= BUF_ZV (b
);
13812 w
->last_cursor
= w
->cursor
;
13813 w
->last_cursor_off_p
= w
->cursor_off_p
;
13815 if (w
== XWINDOW (selected_window
))
13816 w
->last_point
= BUF_PT (b
);
13818 w
->last_point
= XMARKER (w
->pointm
)->charpos
;
13824 wset_window_end_valid (w
, w
->buffer
);
13825 w
->update_mode_line
= 0;
13830 /* Mark the display of windows in the window tree rooted at WINDOW as
13831 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13832 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13833 be redisplayed the next time redisplay_internal is called. */
13836 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13840 for (; !NILP (window
); window
= w
->next
)
13842 w
= XWINDOW (window
);
13843 mark_window_display_accurate_1 (w
, accurate_p
);
13845 if (!NILP (w
->vchild
))
13846 mark_window_display_accurate (w
->vchild
, accurate_p
);
13847 if (!NILP (w
->hchild
))
13848 mark_window_display_accurate (w
->hchild
, accurate_p
);
13853 update_overlay_arrows (1);
13857 /* Force a thorough redisplay the next time by setting
13858 last_arrow_position and last_arrow_string to t, which is
13859 unequal to any useful value of Voverlay_arrow_... */
13860 update_overlay_arrows (-1);
13865 /* Return value in display table DP (Lisp_Char_Table *) for character
13866 C. Since a display table doesn't have any parent, we don't have to
13867 follow parent. Do not call this function directly but use the
13868 macro DISP_CHAR_VECTOR. */
13871 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13875 if (ASCII_CHAR_P (c
))
13878 if (SUB_CHAR_TABLE_P (val
))
13879 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13885 XSETCHAR_TABLE (table
, dp
);
13886 val
= char_table_ref (table
, c
);
13895 /***********************************************************************
13897 ***********************************************************************/
13899 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13902 redisplay_windows (Lisp_Object window
)
13904 while (!NILP (window
))
13906 struct window
*w
= XWINDOW (window
);
13908 if (!NILP (w
->hchild
))
13909 redisplay_windows (w
->hchild
);
13910 else if (!NILP (w
->vchild
))
13911 redisplay_windows (w
->vchild
);
13912 else if (!NILP (w
->buffer
))
13914 displayed_buffer
= XBUFFER (w
->buffer
);
13915 /* Use list_of_error, not Qerror, so that
13916 we catch only errors and don't run the debugger. */
13917 internal_condition_case_1 (redisplay_window_0
, window
,
13919 redisplay_window_error
);
13927 redisplay_window_error (Lisp_Object ignore
)
13929 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13934 redisplay_window_0 (Lisp_Object window
)
13936 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13937 redisplay_window (window
, 0);
13942 redisplay_window_1 (Lisp_Object window
)
13944 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13945 redisplay_window (window
, 1);
13950 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13951 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13952 which positions recorded in ROW differ from current buffer
13955 Return 0 if cursor is not on this row, 1 otherwise. */
13958 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13959 struct glyph_matrix
*matrix
,
13960 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13963 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13964 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13965 struct glyph
*cursor
= NULL
;
13966 /* The last known character position in row. */
13967 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13969 ptrdiff_t pt_old
= PT
- delta
;
13970 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13971 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13972 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13973 /* A glyph beyond the edge of TEXT_AREA which we should never
13975 struct glyph
*glyphs_end
= end
;
13976 /* Non-zero means we've found a match for cursor position, but that
13977 glyph has the avoid_cursor_p flag set. */
13978 int match_with_avoid_cursor
= 0;
13979 /* Non-zero means we've seen at least one glyph that came from a
13981 int string_seen
= 0;
13982 /* Largest and smallest buffer positions seen so far during scan of
13984 ptrdiff_t bpos_max
= pos_before
;
13985 ptrdiff_t bpos_min
= pos_after
;
13986 /* Last buffer position covered by an overlay string with an integer
13987 `cursor' property. */
13988 ptrdiff_t bpos_covered
= 0;
13989 /* Non-zero means the display string on which to display the cursor
13990 comes from a text property, not from an overlay. */
13991 int string_from_text_prop
= 0;
13993 /* Don't even try doing anything if called for a mode-line or
13994 header-line row, since the rest of the code isn't prepared to
13995 deal with such calamities. */
13996 eassert (!row
->mode_line_p
);
13997 if (row
->mode_line_p
)
14000 /* Skip over glyphs not having an object at the start and the end of
14001 the row. These are special glyphs like truncation marks on
14002 terminal frames. */
14003 if (row
->displays_text_p
)
14005 if (!row
->reversed_p
)
14008 && INTEGERP (glyph
->object
)
14009 && glyph
->charpos
< 0)
14011 x
+= glyph
->pixel_width
;
14015 && INTEGERP ((end
- 1)->object
)
14016 /* CHARPOS is zero for blanks and stretch glyphs
14017 inserted by extend_face_to_end_of_line. */
14018 && (end
- 1)->charpos
<= 0)
14020 glyph_before
= glyph
- 1;
14027 /* If the glyph row is reversed, we need to process it from back
14028 to front, so swap the edge pointers. */
14029 glyphs_end
= end
= glyph
- 1;
14030 glyph
+= row
->used
[TEXT_AREA
] - 1;
14032 while (glyph
> end
+ 1
14033 && INTEGERP (glyph
->object
)
14034 && glyph
->charpos
< 0)
14037 x
-= glyph
->pixel_width
;
14039 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14041 /* By default, in reversed rows we put the cursor on the
14042 rightmost (first in the reading order) glyph. */
14043 for (g
= end
+ 1; g
< glyph
; g
++)
14044 x
+= g
->pixel_width
;
14046 && INTEGERP ((end
+ 1)->object
)
14047 && (end
+ 1)->charpos
<= 0)
14049 glyph_before
= glyph
+ 1;
14053 else if (row
->reversed_p
)
14055 /* In R2L rows that don't display text, put the cursor on the
14056 rightmost glyph. Case in point: an empty last line that is
14057 part of an R2L paragraph. */
14059 /* Avoid placing the cursor on the last glyph of the row, where
14060 on terminal frames we hold the vertical border between
14061 adjacent windows. */
14062 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14063 && !WINDOW_RIGHTMOST_P (w
)
14064 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14066 x
= -1; /* will be computed below, at label compute_x */
14069 /* Step 1: Try to find the glyph whose character position
14070 corresponds to point. If that's not possible, find 2 glyphs
14071 whose character positions are the closest to point, one before
14072 point, the other after it. */
14073 if (!row
->reversed_p
)
14074 while (/* not marched to end of glyph row */
14076 /* glyph was not inserted by redisplay for internal purposes */
14077 && !INTEGERP (glyph
->object
))
14079 if (BUFFERP (glyph
->object
))
14081 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14083 if (glyph
->charpos
> bpos_max
)
14084 bpos_max
= glyph
->charpos
;
14085 if (glyph
->charpos
< bpos_min
)
14086 bpos_min
= glyph
->charpos
;
14087 if (!glyph
->avoid_cursor_p
)
14089 /* If we hit point, we've found the glyph on which to
14090 display the cursor. */
14093 match_with_avoid_cursor
= 0;
14096 /* See if we've found a better approximation to
14097 POS_BEFORE or to POS_AFTER. */
14098 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14100 pos_before
= glyph
->charpos
;
14101 glyph_before
= glyph
;
14103 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14105 pos_after
= glyph
->charpos
;
14106 glyph_after
= glyph
;
14109 else if (dpos
== 0)
14110 match_with_avoid_cursor
= 1;
14112 else if (STRINGP (glyph
->object
))
14114 Lisp_Object chprop
;
14115 ptrdiff_t glyph_pos
= glyph
->charpos
;
14117 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14119 if (!NILP (chprop
))
14121 /* If the string came from a `display' text property,
14122 look up the buffer position of that property and
14123 use that position to update bpos_max, as if we
14124 actually saw such a position in one of the row's
14125 glyphs. This helps with supporting integer values
14126 of `cursor' property on the display string in
14127 situations where most or all of the row's buffer
14128 text is completely covered by display properties,
14129 so that no glyph with valid buffer positions is
14130 ever seen in the row. */
14131 ptrdiff_t prop_pos
=
14132 string_buffer_position_lim (glyph
->object
, pos_before
,
14135 if (prop_pos
>= pos_before
)
14136 bpos_max
= prop_pos
- 1;
14138 if (INTEGERP (chprop
))
14140 bpos_covered
= bpos_max
+ XINT (chprop
);
14141 /* If the `cursor' property covers buffer positions up
14142 to and including point, we should display cursor on
14143 this glyph. Note that, if a `cursor' property on one
14144 of the string's characters has an integer value, we
14145 will break out of the loop below _before_ we get to
14146 the position match above. IOW, integer values of
14147 the `cursor' property override the "exact match for
14148 point" strategy of positioning the cursor. */
14149 /* Implementation note: bpos_max == pt_old when, e.g.,
14150 we are in an empty line, where bpos_max is set to
14151 MATRIX_ROW_START_CHARPOS, see above. */
14152 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14161 x
+= glyph
->pixel_width
;
14164 else if (glyph
> end
) /* row is reversed */
14165 while (!INTEGERP (glyph
->object
))
14167 if (BUFFERP (glyph
->object
))
14169 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14171 if (glyph
->charpos
> bpos_max
)
14172 bpos_max
= glyph
->charpos
;
14173 if (glyph
->charpos
< bpos_min
)
14174 bpos_min
= glyph
->charpos
;
14175 if (!glyph
->avoid_cursor_p
)
14179 match_with_avoid_cursor
= 0;
14182 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14184 pos_before
= glyph
->charpos
;
14185 glyph_before
= glyph
;
14187 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14189 pos_after
= glyph
->charpos
;
14190 glyph_after
= glyph
;
14193 else if (dpos
== 0)
14194 match_with_avoid_cursor
= 1;
14196 else if (STRINGP (glyph
->object
))
14198 Lisp_Object chprop
;
14199 ptrdiff_t glyph_pos
= glyph
->charpos
;
14201 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14203 if (!NILP (chprop
))
14205 ptrdiff_t prop_pos
=
14206 string_buffer_position_lim (glyph
->object
, pos_before
,
14209 if (prop_pos
>= pos_before
)
14210 bpos_max
= prop_pos
- 1;
14212 if (INTEGERP (chprop
))
14214 bpos_covered
= bpos_max
+ XINT (chprop
);
14215 /* If the `cursor' property covers buffer positions up
14216 to and including point, we should display cursor on
14218 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14227 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14229 x
--; /* can't use any pixel_width */
14232 x
-= glyph
->pixel_width
;
14235 /* Step 2: If we didn't find an exact match for point, we need to
14236 look for a proper place to put the cursor among glyphs between
14237 GLYPH_BEFORE and GLYPH_AFTER. */
14238 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14239 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14240 && !(bpos_max
< pt_old
&& pt_old
<= bpos_covered
))
14242 /* An empty line has a single glyph whose OBJECT is zero and
14243 whose CHARPOS is the position of a newline on that line.
14244 Note that on a TTY, there are more glyphs after that, which
14245 were produced by extend_face_to_end_of_line, but their
14246 CHARPOS is zero or negative. */
14248 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14249 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
14251 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14253 ptrdiff_t ellipsis_pos
;
14255 /* Scan back over the ellipsis glyphs. */
14256 if (!row
->reversed_p
)
14258 ellipsis_pos
= (glyph
- 1)->charpos
;
14259 while (glyph
> row
->glyphs
[TEXT_AREA
]
14260 && (glyph
- 1)->charpos
== ellipsis_pos
)
14261 glyph
--, x
-= glyph
->pixel_width
;
14262 /* That loop always goes one position too far, including
14263 the glyph before the ellipsis. So scan forward over
14265 x
+= glyph
->pixel_width
;
14268 else /* row is reversed */
14270 ellipsis_pos
= (glyph
+ 1)->charpos
;
14271 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14272 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14273 glyph
++, x
+= glyph
->pixel_width
;
14274 x
-= glyph
->pixel_width
;
14278 else if (match_with_avoid_cursor
)
14280 cursor
= glyph_after
;
14283 else if (string_seen
)
14285 int incr
= row
->reversed_p
? -1 : +1;
14287 /* Need to find the glyph that came out of a string which is
14288 present at point. That glyph is somewhere between
14289 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14290 positioned between POS_BEFORE and POS_AFTER in the
14292 struct glyph
*start
, *stop
;
14293 ptrdiff_t pos
= pos_before
;
14297 /* If the row ends in a newline from a display string,
14298 reordering could have moved the glyphs belonging to the
14299 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14300 in this case we extend the search to the last glyph in
14301 the row that was not inserted by redisplay. */
14302 if (row
->ends_in_newline_from_string_p
)
14305 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14308 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14309 correspond to POS_BEFORE and POS_AFTER, respectively. We
14310 need START and STOP in the order that corresponds to the
14311 row's direction as given by its reversed_p flag. If the
14312 directionality of characters between POS_BEFORE and
14313 POS_AFTER is the opposite of the row's base direction,
14314 these characters will have been reordered for display,
14315 and we need to reverse START and STOP. */
14316 if (!row
->reversed_p
)
14318 start
= min (glyph_before
, glyph_after
);
14319 stop
= max (glyph_before
, glyph_after
);
14323 start
= max (glyph_before
, glyph_after
);
14324 stop
= min (glyph_before
, glyph_after
);
14326 for (glyph
= start
+ incr
;
14327 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14330 /* Any glyphs that come from the buffer are here because
14331 of bidi reordering. Skip them, and only pay
14332 attention to glyphs that came from some string. */
14333 if (STRINGP (glyph
->object
))
14337 /* If the display property covers the newline, we
14338 need to search for it one position farther. */
14339 ptrdiff_t lim
= pos_after
14340 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14342 string_from_text_prop
= 0;
14343 str
= glyph
->object
;
14344 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14345 if (tem
== 0 /* from overlay */
14348 /* If the string from which this glyph came is
14349 found in the buffer at point, or at position
14350 that is closer to point than pos_after, then
14351 we've found the glyph we've been looking for.
14352 If it comes from an overlay (tem == 0), and
14353 it has the `cursor' property on one of its
14354 glyphs, record that glyph as a candidate for
14355 displaying the cursor. (As in the
14356 unidirectional version, we will display the
14357 cursor on the last candidate we find.) */
14360 || (tem
- pt_old
> 0 && tem
< pos_after
))
14362 /* The glyphs from this string could have
14363 been reordered. Find the one with the
14364 smallest string position. Or there could
14365 be a character in the string with the
14366 `cursor' property, which means display
14367 cursor on that character's glyph. */
14368 ptrdiff_t strpos
= glyph
->charpos
;
14373 string_from_text_prop
= 1;
14376 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14377 && EQ (glyph
->object
, str
);
14381 ptrdiff_t gpos
= glyph
->charpos
;
14383 cprop
= Fget_char_property (make_number (gpos
),
14391 if (tem
&& glyph
->charpos
< strpos
)
14393 strpos
= glyph
->charpos
;
14399 || (tem
- pt_old
> 0 && tem
< pos_after
))
14403 pos
= tem
+ 1; /* don't find previous instances */
14405 /* This string is not what we want; skip all of the
14406 glyphs that came from it. */
14407 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14408 && EQ (glyph
->object
, str
))
14415 /* If we reached the end of the line, and END was from a string,
14416 the cursor is not on this line. */
14418 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14419 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14420 && STRINGP (end
->object
)
14421 && row
->continued_p
)
14424 /* A truncated row may not include PT among its character positions.
14425 Setting the cursor inside the scroll margin will trigger
14426 recalculation of hscroll in hscroll_window_tree. But if a
14427 display string covers point, defer to the string-handling
14428 code below to figure this out. */
14429 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14431 cursor
= glyph_before
;
14434 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14435 /* Zero-width characters produce no glyphs. */
14437 && (row
->reversed_p
14438 ? glyph_after
> glyphs_end
14439 : glyph_after
< glyphs_end
)))
14441 cursor
= glyph_after
;
14447 if (cursor
!= NULL
)
14449 else if (glyph
== glyphs_end
14450 && pos_before
== pos_after
14451 && STRINGP ((row
->reversed_p
14452 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14453 : row
->glyphs
[TEXT_AREA
])->object
))
14455 /* If all the glyphs of this row came from strings, put the
14456 cursor on the first glyph of the row. This avoids having the
14457 cursor outside of the text area in this very rare and hard
14461 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14462 : row
->glyphs
[TEXT_AREA
];
14468 /* Need to compute x that corresponds to GLYPH. */
14469 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14471 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14473 x
+= g
->pixel_width
;
14477 /* ROW could be part of a continued line, which, under bidi
14478 reordering, might have other rows whose start and end charpos
14479 occlude point. Only set w->cursor if we found a better
14480 approximation to the cursor position than we have from previously
14481 examined candidate rows belonging to the same continued line. */
14482 if (/* we already have a candidate row */
14483 w
->cursor
.vpos
>= 0
14484 /* that candidate is not the row we are processing */
14485 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14486 /* Make sure cursor.vpos specifies a row whose start and end
14487 charpos occlude point, and it is valid candidate for being a
14488 cursor-row. This is because some callers of this function
14489 leave cursor.vpos at the row where the cursor was displayed
14490 during the last redisplay cycle. */
14491 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14492 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14493 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14496 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14498 /* Don't consider glyphs that are outside TEXT_AREA. */
14499 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14501 /* Keep the candidate whose buffer position is the closest to
14502 point or has the `cursor' property. */
14503 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14504 w
->cursor
.hpos
>= 0
14505 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14506 && ((BUFFERP (g1
->object
)
14507 && (g1
->charpos
== pt_old
/* an exact match always wins */
14508 || (BUFFERP (glyph
->object
)
14509 && eabs (g1
->charpos
- pt_old
)
14510 < eabs (glyph
->charpos
- pt_old
))))
14511 /* previous candidate is a glyph from a string that has
14512 a non-nil `cursor' property */
14513 || (STRINGP (g1
->object
)
14514 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14515 Qcursor
, g1
->object
))
14516 /* previous candidate is from the same display
14517 string as this one, and the display string
14518 came from a text property */
14519 || (EQ (g1
->object
, glyph
->object
)
14520 && string_from_text_prop
)
14521 /* this candidate is from newline and its
14522 position is not an exact match */
14523 || (INTEGERP (glyph
->object
)
14524 && glyph
->charpos
!= pt_old
)))))
14526 /* If this candidate gives an exact match, use that. */
14527 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14528 /* If this candidate is a glyph created for the
14529 terminating newline of a line, and point is on that
14530 newline, it wins because it's an exact match. */
14531 || (!row
->continued_p
14532 && INTEGERP (glyph
->object
)
14533 && glyph
->charpos
== 0
14534 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14535 /* Otherwise, keep the candidate that comes from a row
14536 spanning less buffer positions. This may win when one or
14537 both candidate positions are on glyphs that came from
14538 display strings, for which we cannot compare buffer
14540 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14541 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14542 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14545 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14547 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14548 w
->cursor
.y
= row
->y
+ dy
;
14550 if (w
== XWINDOW (selected_window
))
14552 if (!row
->continued_p
14553 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14556 this_line_buffer
= XBUFFER (w
->buffer
);
14558 CHARPOS (this_line_start_pos
)
14559 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14560 BYTEPOS (this_line_start_pos
)
14561 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14563 CHARPOS (this_line_end_pos
)
14564 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14565 BYTEPOS (this_line_end_pos
)
14566 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14568 this_line_y
= w
->cursor
.y
;
14569 this_line_pixel_height
= row
->height
;
14570 this_line_vpos
= w
->cursor
.vpos
;
14571 this_line_start_x
= row
->x
;
14574 CHARPOS (this_line_start_pos
) = 0;
14581 /* Run window scroll functions, if any, for WINDOW with new window
14582 start STARTP. Sets the window start of WINDOW to that position.
14584 We assume that the window's buffer is really current. */
14586 static struct text_pos
14587 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14589 struct window
*w
= XWINDOW (window
);
14590 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14592 if (current_buffer
!= XBUFFER (w
->buffer
))
14595 if (!NILP (Vwindow_scroll_functions
))
14597 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14598 make_number (CHARPOS (startp
)));
14599 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14600 /* In case the hook functions switch buffers. */
14601 set_buffer_internal (XBUFFER (w
->buffer
));
14608 /* Make sure the line containing the cursor is fully visible.
14609 A value of 1 means there is nothing to be done.
14610 (Either the line is fully visible, or it cannot be made so,
14611 or we cannot tell.)
14613 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14614 is higher than window.
14616 A value of 0 means the caller should do scrolling
14617 as if point had gone off the screen. */
14620 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14622 struct glyph_matrix
*matrix
;
14623 struct glyph_row
*row
;
14626 if (!make_cursor_line_fully_visible_p
)
14629 /* It's not always possible to find the cursor, e.g, when a window
14630 is full of overlay strings. Don't do anything in that case. */
14631 if (w
->cursor
.vpos
< 0)
14634 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14635 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14637 /* If the cursor row is not partially visible, there's nothing to do. */
14638 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14641 /* If the row the cursor is in is taller than the window's height,
14642 it's not clear what to do, so do nothing. */
14643 window_height
= window_box_height (w
);
14644 if (row
->height
>= window_height
)
14646 if (!force_p
|| MINI_WINDOW_P (w
)
14647 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14654 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14655 non-zero means only WINDOW is redisplayed in redisplay_internal.
14656 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14657 in redisplay_window to bring a partially visible line into view in
14658 the case that only the cursor has moved.
14660 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14661 last screen line's vertical height extends past the end of the screen.
14665 1 if scrolling succeeded
14667 0 if scrolling didn't find point.
14669 -1 if new fonts have been loaded so that we must interrupt
14670 redisplay, adjust glyph matrices, and try again. */
14676 SCROLLING_NEED_LARGER_MATRICES
14679 /* If scroll-conservatively is more than this, never recenter.
14681 If you change this, don't forget to update the doc string of
14682 `scroll-conservatively' and the Emacs manual. */
14683 #define SCROLL_LIMIT 100
14686 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14687 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14688 int temp_scroll_step
, int last_line_misfit
)
14690 struct window
*w
= XWINDOW (window
);
14691 struct frame
*f
= XFRAME (w
->frame
);
14692 struct text_pos pos
, startp
;
14694 int this_scroll_margin
, scroll_max
, rc
, height
;
14695 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14696 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14697 Lisp_Object aggressive
;
14698 /* We will never try scrolling more than this number of lines. */
14699 int scroll_limit
= SCROLL_LIMIT
;
14702 debug_method_add (w
, "try_scrolling");
14705 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14707 /* Compute scroll margin height in pixels. We scroll when point is
14708 within this distance from the top or bottom of the window. */
14709 if (scroll_margin
> 0)
14710 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14711 * FRAME_LINE_HEIGHT (f
);
14713 this_scroll_margin
= 0;
14715 /* Force arg_scroll_conservatively to have a reasonable value, to
14716 avoid scrolling too far away with slow move_it_* functions. Note
14717 that the user can supply scroll-conservatively equal to
14718 `most-positive-fixnum', which can be larger than INT_MAX. */
14719 if (arg_scroll_conservatively
> scroll_limit
)
14721 arg_scroll_conservatively
= scroll_limit
+ 1;
14722 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14724 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14725 /* Compute how much we should try to scroll maximally to bring
14726 point into view. */
14727 scroll_max
= (max (scroll_step
,
14728 max (arg_scroll_conservatively
, temp_scroll_step
))
14729 * FRAME_LINE_HEIGHT (f
));
14730 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14731 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14732 /* We're trying to scroll because of aggressive scrolling but no
14733 scroll_step is set. Choose an arbitrary one. */
14734 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14740 /* Decide whether to scroll down. */
14741 if (PT
> CHARPOS (startp
))
14743 int scroll_margin_y
;
14745 /* Compute the pixel ypos of the scroll margin, then move IT to
14746 either that ypos or PT, whichever comes first. */
14747 start_display (&it
, w
, startp
);
14748 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14749 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14750 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14751 (MOVE_TO_POS
| MOVE_TO_Y
));
14753 if (PT
> CHARPOS (it
.current
.pos
))
14755 int y0
= line_bottom_y (&it
);
14756 /* Compute how many pixels below window bottom to stop searching
14757 for PT. This avoids costly search for PT that is far away if
14758 the user limited scrolling by a small number of lines, but
14759 always finds PT if scroll_conservatively is set to a large
14760 number, such as most-positive-fixnum. */
14761 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14762 int y_to_move
= it
.last_visible_y
+ slack
;
14764 /* Compute the distance from the scroll margin to PT or to
14765 the scroll limit, whichever comes first. This should
14766 include the height of the cursor line, to make that line
14768 move_it_to (&it
, PT
, -1, y_to_move
,
14769 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14770 dy
= line_bottom_y (&it
) - y0
;
14772 if (dy
> scroll_max
)
14773 return SCROLLING_FAILED
;
14782 /* Point is in or below the bottom scroll margin, so move the
14783 window start down. If scrolling conservatively, move it just
14784 enough down to make point visible. If scroll_step is set,
14785 move it down by scroll_step. */
14786 if (arg_scroll_conservatively
)
14788 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14789 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14790 else if (scroll_step
|| temp_scroll_step
)
14791 amount_to_scroll
= scroll_max
;
14794 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14795 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14796 if (NUMBERP (aggressive
))
14798 double float_amount
= XFLOATINT (aggressive
) * height
;
14799 int aggressive_scroll
= float_amount
;
14800 if (aggressive_scroll
== 0 && float_amount
> 0)
14801 aggressive_scroll
= 1;
14802 /* Don't let point enter the scroll margin near top of
14803 the window. This could happen if the value of
14804 scroll_up_aggressively is too large and there are
14805 non-zero margins, because scroll_up_aggressively
14806 means put point that fraction of window height
14807 _from_the_bottom_margin_. */
14808 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14809 aggressive_scroll
= height
- 2*this_scroll_margin
;
14810 amount_to_scroll
= dy
+ aggressive_scroll
;
14814 if (amount_to_scroll
<= 0)
14815 return SCROLLING_FAILED
;
14817 start_display (&it
, w
, startp
);
14818 if (arg_scroll_conservatively
<= scroll_limit
)
14819 move_it_vertically (&it
, amount_to_scroll
);
14822 /* Extra precision for users who set scroll-conservatively
14823 to a large number: make sure the amount we scroll
14824 the window start is never less than amount_to_scroll,
14825 which was computed as distance from window bottom to
14826 point. This matters when lines at window top and lines
14827 below window bottom have different height. */
14829 void *it1data
= NULL
;
14830 /* We use a temporary it1 because line_bottom_y can modify
14831 its argument, if it moves one line down; see there. */
14834 SAVE_IT (it1
, it
, it1data
);
14835 start_y
= line_bottom_y (&it1
);
14837 RESTORE_IT (&it
, &it
, it1data
);
14838 move_it_by_lines (&it
, 1);
14839 SAVE_IT (it1
, it
, it1data
);
14840 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14843 /* If STARTP is unchanged, move it down another screen line. */
14844 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14845 move_it_by_lines (&it
, 1);
14846 startp
= it
.current
.pos
;
14850 struct text_pos scroll_margin_pos
= startp
;
14852 /* See if point is inside the scroll margin at the top of the
14854 if (this_scroll_margin
)
14856 start_display (&it
, w
, startp
);
14857 move_it_vertically (&it
, this_scroll_margin
);
14858 scroll_margin_pos
= it
.current
.pos
;
14861 if (PT
< CHARPOS (scroll_margin_pos
))
14863 /* Point is in the scroll margin at the top of the window or
14864 above what is displayed in the window. */
14867 /* Compute the vertical distance from PT to the scroll
14868 margin position. Move as far as scroll_max allows, or
14869 one screenful, or 10 screen lines, whichever is largest.
14870 Give up if distance is greater than scroll_max or if we
14871 didn't reach the scroll margin position. */
14872 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14873 start_display (&it
, w
, pos
);
14875 y_to_move
= max (it
.last_visible_y
,
14876 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14877 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14879 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14880 dy
= it
.current_y
- y0
;
14881 if (dy
> scroll_max
14882 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
14883 return SCROLLING_FAILED
;
14885 /* Compute new window start. */
14886 start_display (&it
, w
, startp
);
14888 if (arg_scroll_conservatively
)
14889 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14890 max (scroll_step
, temp_scroll_step
));
14891 else if (scroll_step
|| temp_scroll_step
)
14892 amount_to_scroll
= scroll_max
;
14895 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14896 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14897 if (NUMBERP (aggressive
))
14899 double float_amount
= XFLOATINT (aggressive
) * height
;
14900 int aggressive_scroll
= float_amount
;
14901 if (aggressive_scroll
== 0 && float_amount
> 0)
14902 aggressive_scroll
= 1;
14903 /* Don't let point enter the scroll margin near
14904 bottom of the window, if the value of
14905 scroll_down_aggressively happens to be too
14907 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14908 aggressive_scroll
= height
- 2*this_scroll_margin
;
14909 amount_to_scroll
= dy
+ aggressive_scroll
;
14913 if (amount_to_scroll
<= 0)
14914 return SCROLLING_FAILED
;
14916 move_it_vertically_backward (&it
, amount_to_scroll
);
14917 startp
= it
.current
.pos
;
14921 /* Run window scroll functions. */
14922 startp
= run_window_scroll_functions (window
, startp
);
14924 /* Display the window. Give up if new fonts are loaded, or if point
14926 if (!try_window (window
, startp
, 0))
14927 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14928 else if (w
->cursor
.vpos
< 0)
14930 clear_glyph_matrix (w
->desired_matrix
);
14931 rc
= SCROLLING_FAILED
;
14935 /* Maybe forget recorded base line for line number display. */
14936 if (!just_this_one_p
14937 || current_buffer
->clip_changed
14938 || BEG_UNCHANGED
< CHARPOS (startp
))
14939 wset_base_line_number (w
, Qnil
);
14941 /* If cursor ends up on a partially visible line,
14942 treat that as being off the bottom of the screen. */
14943 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14944 /* It's possible that the cursor is on the first line of the
14945 buffer, which is partially obscured due to a vscroll
14946 (Bug#7537). In that case, avoid looping forever . */
14947 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14949 clear_glyph_matrix (w
->desired_matrix
);
14950 ++extra_scroll_margin_lines
;
14953 rc
= SCROLLING_SUCCESS
;
14960 /* Compute a suitable window start for window W if display of W starts
14961 on a continuation line. Value is non-zero if a new window start
14964 The new window start will be computed, based on W's width, starting
14965 from the start of the continued line. It is the start of the
14966 screen line with the minimum distance from the old start W->start. */
14969 compute_window_start_on_continuation_line (struct window
*w
)
14971 struct text_pos pos
, start_pos
;
14972 int window_start_changed_p
= 0;
14974 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14976 /* If window start is on a continuation line... Window start may be
14977 < BEGV in case there's invisible text at the start of the
14978 buffer (M-x rmail, for example). */
14979 if (CHARPOS (start_pos
) > BEGV
14980 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14983 struct glyph_row
*row
;
14985 /* Handle the case that the window start is out of range. */
14986 if (CHARPOS (start_pos
) < BEGV
)
14987 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14988 else if (CHARPOS (start_pos
) > ZV
)
14989 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14991 /* Find the start of the continued line. This should be fast
14992 because scan_buffer is fast (newline cache). */
14993 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14994 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14995 row
, DEFAULT_FACE_ID
);
14996 reseat_at_previous_visible_line_start (&it
);
14998 /* If the line start is "too far" away from the window start,
14999 say it takes too much time to compute a new window start. */
15000 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15001 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15003 int min_distance
, distance
;
15005 /* Move forward by display lines to find the new window
15006 start. If window width was enlarged, the new start can
15007 be expected to be > the old start. If window width was
15008 decreased, the new window start will be < the old start.
15009 So, we're looking for the display line start with the
15010 minimum distance from the old window start. */
15011 pos
= it
.current
.pos
;
15012 min_distance
= INFINITY
;
15013 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15014 distance
< min_distance
)
15016 min_distance
= distance
;
15017 pos
= it
.current
.pos
;
15018 move_it_by_lines (&it
, 1);
15021 /* Set the window start there. */
15022 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15023 window_start_changed_p
= 1;
15027 return window_start_changed_p
;
15031 /* Try cursor movement in case text has not changed in window WINDOW,
15032 with window start STARTP. Value is
15034 CURSOR_MOVEMENT_SUCCESS if successful
15036 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15038 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15039 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15040 we want to scroll as if scroll-step were set to 1. See the code.
15042 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15043 which case we have to abort this redisplay, and adjust matrices
15048 CURSOR_MOVEMENT_SUCCESS
,
15049 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15050 CURSOR_MOVEMENT_MUST_SCROLL
,
15051 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15055 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15057 struct window
*w
= XWINDOW (window
);
15058 struct frame
*f
= XFRAME (w
->frame
);
15059 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15062 if (inhibit_try_cursor_movement
)
15066 /* Previously, there was a check for Lisp integer in the
15067 if-statement below. Now, this field is converted to
15068 ptrdiff_t, thus zero means invalid position in a buffer. */
15069 eassert (w
->last_point
> 0);
15071 /* Handle case where text has not changed, only point, and it has
15072 not moved off the frame. */
15073 if (/* Point may be in this window. */
15074 PT
>= CHARPOS (startp
)
15075 /* Selective display hasn't changed. */
15076 && !current_buffer
->clip_changed
15077 /* Function force-mode-line-update is used to force a thorough
15078 redisplay. It sets either windows_or_buffers_changed or
15079 update_mode_lines. So don't take a shortcut here for these
15081 && !update_mode_lines
15082 && !windows_or_buffers_changed
15083 && !cursor_type_changed
15084 /* Can't use this case if highlighting a region. When a
15085 region exists, cursor movement has to do more than just
15087 && !(!NILP (Vtransient_mark_mode
)
15088 && !NILP (BVAR (current_buffer
, mark_active
)))
15089 && NILP (w
->region_showing
)
15090 && NILP (Vshow_trailing_whitespace
)
15091 /* This code is not used for mini-buffer for the sake of the case
15092 of redisplaying to replace an echo area message; since in
15093 that case the mini-buffer contents per se are usually
15094 unchanged. This code is of no real use in the mini-buffer
15095 since the handling of this_line_start_pos, etc., in redisplay
15096 handles the same cases. */
15097 && !EQ (window
, minibuf_window
)
15098 /* When splitting windows or for new windows, it happens that
15099 redisplay is called with a nil window_end_vpos or one being
15100 larger than the window. This should really be fixed in
15101 window.c. I don't have this on my list, now, so we do
15102 approximately the same as the old redisplay code. --gerd. */
15103 && INTEGERP (w
->window_end_vpos
)
15104 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
15105 && (FRAME_WINDOW_P (f
)
15106 || !overlay_arrow_in_current_buffer_p ()))
15108 int this_scroll_margin
, top_scroll_margin
;
15109 struct glyph_row
*row
= NULL
;
15112 debug_method_add (w
, "cursor movement");
15115 /* Scroll if point within this distance from the top or bottom
15116 of the window. This is a pixel value. */
15117 if (scroll_margin
> 0)
15119 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15120 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15123 this_scroll_margin
= 0;
15125 top_scroll_margin
= this_scroll_margin
;
15126 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15127 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15129 /* Start with the row the cursor was displayed during the last
15130 not paused redisplay. Give up if that row is not valid. */
15131 if (w
->last_cursor
.vpos
< 0
15132 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
15133 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15136 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
15137 if (row
->mode_line_p
)
15139 if (!row
->enabled_p
)
15140 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15143 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15145 int scroll_p
= 0, must_scroll
= 0;
15146 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15148 if (PT
> w
->last_point
)
15150 /* Point has moved forward. */
15151 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15152 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15154 eassert (row
->enabled_p
);
15158 /* If the end position of a row equals the start
15159 position of the next row, and PT is at that position,
15160 we would rather display cursor in the next line. */
15161 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15162 && MATRIX_ROW_END_CHARPOS (row
) == PT
15163 && row
< w
->current_matrix
->rows
15164 + w
->current_matrix
->nrows
- 1
15165 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15166 && !cursor_row_p (row
))
15169 /* If within the scroll margin, scroll. Note that
15170 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15171 the next line would be drawn, and that
15172 this_scroll_margin can be zero. */
15173 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15174 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15175 /* Line is completely visible last line in window
15176 and PT is to be set in the next line. */
15177 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15178 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15179 && !row
->ends_at_zv_p
15180 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15183 else if (PT
< w
->last_point
)
15185 /* Cursor has to be moved backward. Note that PT >=
15186 CHARPOS (startp) because of the outer if-statement. */
15187 while (!row
->mode_line_p
15188 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15189 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15190 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15191 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15192 row
> w
->current_matrix
->rows
15193 && (row
-1)->ends_in_newline_from_string_p
))))
15194 && (row
->y
> top_scroll_margin
15195 || CHARPOS (startp
) == BEGV
))
15197 eassert (row
->enabled_p
);
15201 /* Consider the following case: Window starts at BEGV,
15202 there is invisible, intangible text at BEGV, so that
15203 display starts at some point START > BEGV. It can
15204 happen that we are called with PT somewhere between
15205 BEGV and START. Try to handle that case. */
15206 if (row
< w
->current_matrix
->rows
15207 || row
->mode_line_p
)
15209 row
= w
->current_matrix
->rows
;
15210 if (row
->mode_line_p
)
15214 /* Due to newlines in overlay strings, we may have to
15215 skip forward over overlay strings. */
15216 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15217 && MATRIX_ROW_END_CHARPOS (row
) == PT
15218 && !cursor_row_p (row
))
15221 /* If within the scroll margin, scroll. */
15222 if (row
->y
< top_scroll_margin
15223 && CHARPOS (startp
) != BEGV
)
15228 /* Cursor did not move. So don't scroll even if cursor line
15229 is partially visible, as it was so before. */
15230 rc
= CURSOR_MOVEMENT_SUCCESS
;
15233 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15234 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15236 /* if PT is not in the glyph row, give up. */
15237 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15240 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15241 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15243 struct glyph_row
*row1
;
15245 /* If rows are bidi-reordered and point moved, back up
15246 until we find a row that does not belong to a
15247 continuation line. This is because we must consider
15248 all rows of a continued line as candidates for the
15249 new cursor positioning, since row start and end
15250 positions change non-linearly with vertical position
15252 /* FIXME: Revisit this when glyph ``spilling'' in
15253 continuation lines' rows is implemented for
15254 bidi-reordered rows. */
15255 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15256 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15259 /* If we hit the beginning of the displayed portion
15260 without finding the first row of a continued
15264 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15267 eassert (row
->enabled_p
);
15272 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15273 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15274 /* Make sure this isn't a header line by any chance, since
15275 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15276 && !row
->mode_line_p
15277 && make_cursor_line_fully_visible_p
)
15279 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15280 && !row
->ends_at_zv_p
15281 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15282 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15283 else if (row
->height
> window_box_height (w
))
15285 /* If we end up in a partially visible line, let's
15286 make it fully visible, except when it's taller
15287 than the window, in which case we can't do much
15290 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15294 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15295 if (!cursor_row_fully_visible_p (w
, 0, 1))
15296 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15298 rc
= CURSOR_MOVEMENT_SUCCESS
;
15302 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15303 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15304 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15306 /* With bidi-reordered rows, there could be more than
15307 one candidate row whose start and end positions
15308 occlude point. We need to let set_cursor_from_row
15309 find the best candidate. */
15310 /* FIXME: Revisit this when glyph ``spilling'' in
15311 continuation lines' rows is implemented for
15312 bidi-reordered rows. */
15317 int at_zv_p
= 0, exact_match_p
= 0;
15319 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15320 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15321 && cursor_row_p (row
))
15322 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15324 /* As soon as we've found the exact match for point,
15325 or the first suitable row whose ends_at_zv_p flag
15326 is set, we are done. */
15328 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15330 && w
->cursor
.hpos
>= 0
15331 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15334 struct glyph_row
*candidate
=
15335 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15337 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15338 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15341 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15342 || (INTEGERP (g
->object
)
15343 && (g
->charpos
== PT
15344 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15346 if (rv
&& (at_zv_p
|| exact_match_p
))
15348 rc
= CURSOR_MOVEMENT_SUCCESS
;
15351 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15355 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15356 || row
->continued_p
)
15357 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15358 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15359 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15360 /* If we didn't find any candidate rows, or exited the
15361 loop before all the candidates were examined, signal
15362 to the caller that this method failed. */
15363 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15365 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15366 && !row
->continued_p
))
15367 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15369 rc
= CURSOR_MOVEMENT_SUCCESS
;
15375 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15377 rc
= CURSOR_MOVEMENT_SUCCESS
;
15382 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15383 && MATRIX_ROW_START_CHARPOS (row
) == PT
15384 && cursor_row_p (row
));
15392 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15396 set_vertical_scroll_bar (struct window
*w
)
15398 ptrdiff_t start
, end
, whole
;
15400 /* Calculate the start and end positions for the current window.
15401 At some point, it would be nice to choose between scrollbars
15402 which reflect the whole buffer size, with special markers
15403 indicating narrowing, and scrollbars which reflect only the
15406 Note that mini-buffers sometimes aren't displaying any text. */
15407 if (!MINI_WINDOW_P (w
)
15408 || (w
== XWINDOW (minibuf_window
)
15409 && NILP (echo_area_buffer
[0])))
15411 struct buffer
*buf
= XBUFFER (w
->buffer
);
15412 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15413 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15414 /* I don't think this is guaranteed to be right. For the
15415 moment, we'll pretend it is. */
15416 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15420 if (whole
< (end
- start
))
15421 whole
= end
- start
;
15424 start
= end
= whole
= 0;
15426 /* Indicate what this scroll bar ought to be displaying now. */
15427 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15428 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15429 (w
, end
- start
, whole
, start
);
15433 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15434 selected_window is redisplayed.
15436 We can return without actually redisplaying the window if
15437 fonts_changed_p. In that case, redisplay_internal will
15441 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15443 struct window
*w
= XWINDOW (window
);
15444 struct frame
*f
= XFRAME (w
->frame
);
15445 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15446 struct buffer
*old
= current_buffer
;
15447 struct text_pos lpoint
, opoint
, startp
;
15448 int update_mode_line
;
15451 /* Record it now because it's overwritten. */
15452 int current_matrix_up_to_date_p
= 0;
15453 int used_current_matrix_p
= 0;
15454 /* This is less strict than current_matrix_up_to_date_p.
15455 It indicates that the buffer contents and narrowing are unchanged. */
15456 int buffer_unchanged_p
= 0;
15457 int temp_scroll_step
= 0;
15458 ptrdiff_t count
= SPECPDL_INDEX ();
15460 int centering_position
= -1;
15461 int last_line_misfit
= 0;
15462 ptrdiff_t beg_unchanged
, end_unchanged
;
15464 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15467 /* W must be a leaf window here. */
15468 eassert (!NILP (w
->buffer
));
15470 *w
->desired_matrix
->method
= 0;
15474 reconsider_clip_changes (w
, buffer
);
15476 /* Has the mode line to be updated? */
15477 update_mode_line
= (w
->update_mode_line
15478 || update_mode_lines
15479 || buffer
->clip_changed
15480 || buffer
->prevent_redisplay_optimizations_p
);
15482 if (MINI_WINDOW_P (w
))
15484 if (w
== XWINDOW (echo_area_window
)
15485 && !NILP (echo_area_buffer
[0]))
15487 if (update_mode_line
)
15488 /* We may have to update a tty frame's menu bar or a
15489 tool-bar. Example `M-x C-h C-h C-g'. */
15490 goto finish_menu_bars
;
15492 /* We've already displayed the echo area glyphs in this window. */
15493 goto finish_scroll_bars
;
15495 else if ((w
!= XWINDOW (minibuf_window
)
15496 || minibuf_level
== 0)
15497 /* When buffer is nonempty, redisplay window normally. */
15498 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15499 /* Quail displays non-mini buffers in minibuffer window.
15500 In that case, redisplay the window normally. */
15501 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15503 /* W is a mini-buffer window, but it's not active, so clear
15505 int yb
= window_text_bottom_y (w
);
15506 struct glyph_row
*row
;
15509 for (y
= 0, row
= w
->desired_matrix
->rows
;
15511 y
+= row
->height
, ++row
)
15512 blank_row (w
, row
, y
);
15513 goto finish_scroll_bars
;
15516 clear_glyph_matrix (w
->desired_matrix
);
15519 /* Otherwise set up data on this window; select its buffer and point
15521 /* Really select the buffer, for the sake of buffer-local
15523 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15525 current_matrix_up_to_date_p
15526 = (!NILP (w
->window_end_valid
)
15527 && !current_buffer
->clip_changed
15528 && !current_buffer
->prevent_redisplay_optimizations_p
15529 && !window_outdated (w
));
15531 /* Run the window-bottom-change-functions
15532 if it is possible that the text on the screen has changed
15533 (either due to modification of the text, or any other reason). */
15534 if (!current_matrix_up_to_date_p
15535 && !NILP (Vwindow_text_change_functions
))
15537 safe_run_hooks (Qwindow_text_change_functions
);
15541 beg_unchanged
= BEG_UNCHANGED
;
15542 end_unchanged
= END_UNCHANGED
;
15544 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15546 specbind (Qinhibit_point_motion_hooks
, Qt
);
15549 = (!NILP (w
->window_end_valid
)
15550 && !current_buffer
->clip_changed
15551 && !window_outdated (w
));
15553 /* When windows_or_buffers_changed is non-zero, we can't rely on
15554 the window end being valid, so set it to nil there. */
15555 if (windows_or_buffers_changed
)
15557 /* If window starts on a continuation line, maybe adjust the
15558 window start in case the window's width changed. */
15559 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15560 compute_window_start_on_continuation_line (w
);
15562 wset_window_end_valid (w
, Qnil
);
15565 /* Some sanity checks. */
15566 CHECK_WINDOW_END (w
);
15567 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15569 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15572 if (mode_line_update_needed (w
))
15573 update_mode_line
= 1;
15575 /* Count number of windows showing the selected buffer. An indirect
15576 buffer counts as its base buffer. */
15577 if (!just_this_one_p
)
15579 struct buffer
*current_base
, *window_base
;
15580 current_base
= current_buffer
;
15581 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15582 if (current_base
->base_buffer
)
15583 current_base
= current_base
->base_buffer
;
15584 if (window_base
->base_buffer
)
15585 window_base
= window_base
->base_buffer
;
15586 if (current_base
== window_base
)
15590 /* Point refers normally to the selected window. For any other
15591 window, set up appropriate value. */
15592 if (!EQ (window
, selected_window
))
15594 ptrdiff_t new_pt
= XMARKER (w
->pointm
)->charpos
;
15595 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15599 new_pt_byte
= BEGV_BYTE
;
15600 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15602 else if (new_pt
> (ZV
- 1))
15605 new_pt_byte
= ZV_BYTE
;
15606 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15609 /* We don't use SET_PT so that the point-motion hooks don't run. */
15610 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15613 /* If any of the character widths specified in the display table
15614 have changed, invalidate the width run cache. It's true that
15615 this may be a bit late to catch such changes, but the rest of
15616 redisplay goes (non-fatally) haywire when the display table is
15617 changed, so why should we worry about doing any better? */
15618 if (current_buffer
->width_run_cache
)
15620 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15622 if (! disptab_matches_widthtab
15623 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15625 invalidate_region_cache (current_buffer
,
15626 current_buffer
->width_run_cache
,
15628 recompute_width_table (current_buffer
, disptab
);
15632 /* If window-start is screwed up, choose a new one. */
15633 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15636 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15638 /* If someone specified a new starting point but did not insist,
15639 check whether it can be used. */
15640 if (w
->optional_new_start
15641 && CHARPOS (startp
) >= BEGV
15642 && CHARPOS (startp
) <= ZV
)
15644 w
->optional_new_start
= 0;
15645 start_display (&it
, w
, startp
);
15646 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15647 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15648 if (IT_CHARPOS (it
) == PT
)
15649 w
->force_start
= 1;
15650 /* IT may overshoot PT if text at PT is invisible. */
15651 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15652 w
->force_start
= 1;
15657 /* Handle case where place to start displaying has been specified,
15658 unless the specified location is outside the accessible range. */
15659 if (w
->force_start
|| w
->frozen_window_start_p
)
15661 /* We set this later on if we have to adjust point. */
15664 w
->force_start
= 0;
15666 wset_window_end_valid (w
, Qnil
);
15668 /* Forget any recorded base line for line number display. */
15669 if (!buffer_unchanged_p
)
15670 wset_base_line_number (w
, Qnil
);
15672 /* Redisplay the mode line. Select the buffer properly for that.
15673 Also, run the hook window-scroll-functions
15674 because we have scrolled. */
15675 /* Note, we do this after clearing force_start because
15676 if there's an error, it is better to forget about force_start
15677 than to get into an infinite loop calling the hook functions
15678 and having them get more errors. */
15679 if (!update_mode_line
15680 || ! NILP (Vwindow_scroll_functions
))
15682 update_mode_line
= 1;
15683 w
->update_mode_line
= 1;
15684 startp
= run_window_scroll_functions (window
, startp
);
15687 w
->last_modified
= 0;
15688 w
->last_overlay_modified
= 0;
15689 if (CHARPOS (startp
) < BEGV
)
15690 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15691 else if (CHARPOS (startp
) > ZV
)
15692 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15694 /* Redisplay, then check if cursor has been set during the
15695 redisplay. Give up if new fonts were loaded. */
15696 /* We used to issue a CHECK_MARGINS argument to try_window here,
15697 but this causes scrolling to fail when point begins inside
15698 the scroll margin (bug#148) -- cyd */
15699 if (!try_window (window
, startp
, 0))
15701 w
->force_start
= 1;
15702 clear_glyph_matrix (w
->desired_matrix
);
15703 goto need_larger_matrices
;
15706 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15708 /* If point does not appear, try to move point so it does
15709 appear. The desired matrix has been built above, so we
15710 can use it here. */
15711 new_vpos
= window_box_height (w
) / 2;
15714 if (!cursor_row_fully_visible_p (w
, 0, 0))
15716 /* Point does appear, but on a line partly visible at end of window.
15717 Move it back to a fully-visible line. */
15718 new_vpos
= window_box_height (w
);
15720 else if (w
->cursor
.vpos
>=0)
15722 /* Some people insist on not letting point enter the scroll
15723 margin, even though this part handles windows that didn't
15725 struct frame
*f
= XFRAME (w
->frame
);
15726 int margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15727 int pixel_margin
= margin
* FRAME_LINE_HEIGHT (f
);
15728 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
15730 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
15731 below, which finds the row to move point to, advances by
15732 the Y coordinate of the _next_ row, see the definition of
15733 MATRIX_ROW_BOTTOM_Y. */
15734 if (w
->cursor
.vpos
< margin
+ header_line
)
15736 = pixel_margin
+ (header_line
15737 ? CURRENT_HEADER_LINE_HEIGHT (w
)
15738 : 0) + FRAME_LINE_HEIGHT (f
);
15741 int window_height
= window_box_height (w
);
15744 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15745 if (w
->cursor
.y
>= window_height
- pixel_margin
)
15746 new_vpos
= window_height
- pixel_margin
;
15750 /* If we need to move point for either of the above reasons,
15751 now actually do it. */
15754 struct glyph_row
*row
;
15756 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15757 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15760 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15761 MATRIX_ROW_START_BYTEPOS (row
));
15763 if (w
!= XWINDOW (selected_window
))
15764 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15765 else if (current_buffer
== old
)
15766 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15768 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15770 /* If we are highlighting the region, then we just changed
15771 the region, so redisplay to show it. */
15772 if (!NILP (Vtransient_mark_mode
)
15773 && !NILP (BVAR (current_buffer
, mark_active
)))
15775 clear_glyph_matrix (w
->desired_matrix
);
15776 if (!try_window (window
, startp
, 0))
15777 goto need_larger_matrices
;
15782 debug_method_add (w
, "forced window start");
15787 /* Handle case where text has not changed, only point, and it has
15788 not moved off the frame, and we are not retrying after hscroll.
15789 (current_matrix_up_to_date_p is nonzero when retrying.) */
15790 if (current_matrix_up_to_date_p
15791 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15792 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15796 case CURSOR_MOVEMENT_SUCCESS
:
15797 used_current_matrix_p
= 1;
15800 case CURSOR_MOVEMENT_MUST_SCROLL
:
15801 goto try_to_scroll
;
15807 /* If current starting point was originally the beginning of a line
15808 but no longer is, find a new starting point. */
15809 else if (w
->start_at_line_beg
15810 && !(CHARPOS (startp
) <= BEGV
15811 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15814 debug_method_add (w
, "recenter 1");
15819 /* Try scrolling with try_window_id. Value is > 0 if update has
15820 been done, it is -1 if we know that the same window start will
15821 not work. It is 0 if unsuccessful for some other reason. */
15822 else if ((tem
= try_window_id (w
)) != 0)
15825 debug_method_add (w
, "try_window_id %d", tem
);
15828 if (fonts_changed_p
)
15829 goto need_larger_matrices
;
15833 /* Otherwise try_window_id has returned -1 which means that we
15834 don't want the alternative below this comment to execute. */
15836 else if (CHARPOS (startp
) >= BEGV
15837 && CHARPOS (startp
) <= ZV
15838 && PT
>= CHARPOS (startp
)
15839 && (CHARPOS (startp
) < ZV
15840 /* Avoid starting at end of buffer. */
15841 || CHARPOS (startp
) == BEGV
15842 || !window_outdated (w
)))
15844 int d1
, d2
, d3
, d4
, d5
, d6
;
15846 /* If first window line is a continuation line, and window start
15847 is inside the modified region, but the first change is before
15848 current window start, we must select a new window start.
15850 However, if this is the result of a down-mouse event (e.g. by
15851 extending the mouse-drag-overlay), we don't want to select a
15852 new window start, since that would change the position under
15853 the mouse, resulting in an unwanted mouse-movement rather
15854 than a simple mouse-click. */
15855 if (!w
->start_at_line_beg
15856 && NILP (do_mouse_tracking
)
15857 && CHARPOS (startp
) > BEGV
15858 && CHARPOS (startp
) > BEG
+ beg_unchanged
15859 && CHARPOS (startp
) <= Z
- end_unchanged
15860 /* Even if w->start_at_line_beg is nil, a new window may
15861 start at a line_beg, since that's how set_buffer_window
15862 sets it. So, we need to check the return value of
15863 compute_window_start_on_continuation_line. (See also
15865 && XMARKER (w
->start
)->buffer
== current_buffer
15866 && compute_window_start_on_continuation_line (w
)
15867 /* It doesn't make sense to force the window start like we
15868 do at label force_start if it is already known that point
15869 will not be visible in the resulting window, because
15870 doing so will move point from its correct position
15871 instead of scrolling the window to bring point into view.
15873 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15875 w
->force_start
= 1;
15876 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15881 debug_method_add (w
, "same window start");
15884 /* Try to redisplay starting at same place as before.
15885 If point has not moved off frame, accept the results. */
15886 if (!current_matrix_up_to_date_p
15887 /* Don't use try_window_reusing_current_matrix in this case
15888 because a window scroll function can have changed the
15890 || !NILP (Vwindow_scroll_functions
)
15891 || MINI_WINDOW_P (w
)
15892 || !(used_current_matrix_p
15893 = try_window_reusing_current_matrix (w
)))
15895 IF_DEBUG (debug_method_add (w
, "1"));
15896 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15897 /* -1 means we need to scroll.
15898 0 means we need new matrices, but fonts_changed_p
15899 is set in that case, so we will detect it below. */
15900 goto try_to_scroll
;
15903 if (fonts_changed_p
)
15904 goto need_larger_matrices
;
15906 if (w
->cursor
.vpos
>= 0)
15908 if (!just_this_one_p
15909 || current_buffer
->clip_changed
15910 || BEG_UNCHANGED
< CHARPOS (startp
))
15911 /* Forget any recorded base line for line number display. */
15912 wset_base_line_number (w
, Qnil
);
15914 if (!cursor_row_fully_visible_p (w
, 1, 0))
15916 clear_glyph_matrix (w
->desired_matrix
);
15917 last_line_misfit
= 1;
15919 /* Drop through and scroll. */
15924 clear_glyph_matrix (w
->desired_matrix
);
15929 w
->last_modified
= 0;
15930 w
->last_overlay_modified
= 0;
15932 /* Redisplay the mode line. Select the buffer properly for that. */
15933 if (!update_mode_line
)
15935 update_mode_line
= 1;
15936 w
->update_mode_line
= 1;
15939 /* Try to scroll by specified few lines. */
15940 if ((scroll_conservatively
15941 || emacs_scroll_step
15942 || temp_scroll_step
15943 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15944 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15945 && CHARPOS (startp
) >= BEGV
15946 && CHARPOS (startp
) <= ZV
)
15948 /* The function returns -1 if new fonts were loaded, 1 if
15949 successful, 0 if not successful. */
15950 int ss
= try_scrolling (window
, just_this_one_p
,
15951 scroll_conservatively
,
15953 temp_scroll_step
, last_line_misfit
);
15956 case SCROLLING_SUCCESS
:
15959 case SCROLLING_NEED_LARGER_MATRICES
:
15960 goto need_larger_matrices
;
15962 case SCROLLING_FAILED
:
15970 /* Finally, just choose a place to start which positions point
15971 according to user preferences. */
15976 debug_method_add (w
, "recenter");
15979 /* w->vscroll = 0; */
15981 /* Forget any previously recorded base line for line number display. */
15982 if (!buffer_unchanged_p
)
15983 wset_base_line_number (w
, Qnil
);
15985 /* Determine the window start relative to point. */
15986 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15987 it
.current_y
= it
.last_visible_y
;
15988 if (centering_position
< 0)
15992 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15994 ptrdiff_t margin_pos
= CHARPOS (startp
);
15995 Lisp_Object aggressive
;
15998 /* If there is a scroll margin at the top of the window, find
15999 its character position. */
16001 /* Cannot call start_display if startp is not in the
16002 accessible region of the buffer. This can happen when we
16003 have just switched to a different buffer and/or changed
16004 its restriction. In that case, startp is initialized to
16005 the character position 1 (BEGV) because we did not yet
16006 have chance to display the buffer even once. */
16007 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16010 void *it1data
= NULL
;
16012 SAVE_IT (it1
, it
, it1data
);
16013 start_display (&it1
, w
, startp
);
16014 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
16015 margin_pos
= IT_CHARPOS (it1
);
16016 RESTORE_IT (&it
, &it
, it1data
);
16018 scrolling_up
= PT
> margin_pos
;
16021 ? BVAR (current_buffer
, scroll_up_aggressively
)
16022 : BVAR (current_buffer
, scroll_down_aggressively
);
16024 if (!MINI_WINDOW_P (w
)
16025 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16029 /* Setting scroll-conservatively overrides
16030 scroll-*-aggressively. */
16031 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16033 double float_amount
= XFLOATINT (aggressive
);
16035 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16036 if (pt_offset
== 0 && float_amount
> 0)
16038 if (pt_offset
&& margin
> 0)
16041 /* Compute how much to move the window start backward from
16042 point so that point will be displayed where the user
16046 centering_position
= it
.last_visible_y
;
16048 centering_position
-= pt_offset
;
16049 centering_position
-=
16050 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
16051 + WINDOW_HEADER_LINE_HEIGHT (w
);
16052 /* Don't let point enter the scroll margin near top of
16054 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
16055 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
16058 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
16061 /* Set the window start half the height of the window backward
16063 centering_position
= window_box_height (w
) / 2;
16065 move_it_vertically_backward (&it
, centering_position
);
16067 eassert (IT_CHARPOS (it
) >= BEGV
);
16069 /* The function move_it_vertically_backward may move over more
16070 than the specified y-distance. If it->w is small, e.g. a
16071 mini-buffer window, we may end up in front of the window's
16072 display area. Start displaying at the start of the line
16073 containing PT in this case. */
16074 if (it
.current_y
<= 0)
16076 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16077 move_it_vertically_backward (&it
, 0);
16081 it
.current_x
= it
.hpos
= 0;
16083 /* Set the window start position here explicitly, to avoid an
16084 infinite loop in case the functions in window-scroll-functions
16086 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16088 /* Run scroll hooks. */
16089 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16091 /* Redisplay the window. */
16092 if (!current_matrix_up_to_date_p
16093 || windows_or_buffers_changed
16094 || cursor_type_changed
16095 /* Don't use try_window_reusing_current_matrix in this case
16096 because it can have changed the buffer. */
16097 || !NILP (Vwindow_scroll_functions
)
16098 || !just_this_one_p
16099 || MINI_WINDOW_P (w
)
16100 || !(used_current_matrix_p
16101 = try_window_reusing_current_matrix (w
)))
16102 try_window (window
, startp
, 0);
16104 /* If new fonts have been loaded (due to fontsets), give up. We
16105 have to start a new redisplay since we need to re-adjust glyph
16107 if (fonts_changed_p
)
16108 goto need_larger_matrices
;
16110 /* If cursor did not appear assume that the middle of the window is
16111 in the first line of the window. Do it again with the next line.
16112 (Imagine a window of height 100, displaying two lines of height
16113 60. Moving back 50 from it->last_visible_y will end in the first
16115 if (w
->cursor
.vpos
< 0)
16117 if (!NILP (w
->window_end_valid
)
16118 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
16120 clear_glyph_matrix (w
->desired_matrix
);
16121 move_it_by_lines (&it
, 1);
16122 try_window (window
, it
.current
.pos
, 0);
16124 else if (PT
< IT_CHARPOS (it
))
16126 clear_glyph_matrix (w
->desired_matrix
);
16127 move_it_by_lines (&it
, -1);
16128 try_window (window
, it
.current
.pos
, 0);
16132 /* Not much we can do about it. */
16136 /* Consider the following case: Window starts at BEGV, there is
16137 invisible, intangible text at BEGV, so that display starts at
16138 some point START > BEGV. It can happen that we are called with
16139 PT somewhere between BEGV and START. Try to handle that case. */
16140 if (w
->cursor
.vpos
< 0)
16142 struct glyph_row
*row
= w
->current_matrix
->rows
;
16143 if (row
->mode_line_p
)
16145 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16148 if (!cursor_row_fully_visible_p (w
, 0, 0))
16150 /* If vscroll is enabled, disable it and try again. */
16154 clear_glyph_matrix (w
->desired_matrix
);
16158 /* Users who set scroll-conservatively to a large number want
16159 point just above/below the scroll margin. If we ended up
16160 with point's row partially visible, move the window start to
16161 make that row fully visible and out of the margin. */
16162 if (scroll_conservatively
> SCROLL_LIMIT
)
16166 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
16168 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
16170 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16171 clear_glyph_matrix (w
->desired_matrix
);
16172 if (1 == try_window (window
, it
.current
.pos
,
16173 TRY_WINDOW_CHECK_MARGINS
))
16177 /* If centering point failed to make the whole line visible,
16178 put point at the top instead. That has to make the whole line
16179 visible, if it can be done. */
16180 if (centering_position
== 0)
16183 clear_glyph_matrix (w
->desired_matrix
);
16184 centering_position
= 0;
16190 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16191 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16192 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16194 /* Display the mode line, if we must. */
16195 if ((update_mode_line
16196 /* If window not full width, must redo its mode line
16197 if (a) the window to its side is being redone and
16198 (b) we do a frame-based redisplay. This is a consequence
16199 of how inverted lines are drawn in frame-based redisplay. */
16200 || (!just_this_one_p
16201 && !FRAME_WINDOW_P (f
)
16202 && !WINDOW_FULL_WIDTH_P (w
))
16203 /* Line number to display. */
16204 || INTEGERP (w
->base_line_pos
)
16205 /* Column number is displayed and different from the one displayed. */
16206 || (!NILP (w
->column_number_displayed
)
16207 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
16208 /* This means that the window has a mode line. */
16209 && (WINDOW_WANTS_MODELINE_P (w
)
16210 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16212 display_mode_lines (w
);
16214 /* If mode line height has changed, arrange for a thorough
16215 immediate redisplay using the correct mode line height. */
16216 if (WINDOW_WANTS_MODELINE_P (w
)
16217 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16219 fonts_changed_p
= 1;
16220 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16221 = DESIRED_MODE_LINE_HEIGHT (w
);
16224 /* If header line height has changed, arrange for a thorough
16225 immediate redisplay using the correct header line height. */
16226 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16227 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16229 fonts_changed_p
= 1;
16230 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16231 = DESIRED_HEADER_LINE_HEIGHT (w
);
16234 if (fonts_changed_p
)
16235 goto need_larger_matrices
;
16238 if (!line_number_displayed
16239 && !BUFFERP (w
->base_line_pos
))
16241 wset_base_line_pos (w
, Qnil
);
16242 wset_base_line_number (w
, Qnil
);
16247 /* When we reach a frame's selected window, redo the frame's menu bar. */
16248 if (update_mode_line
16249 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16251 int redisplay_menu_p
= 0;
16253 if (FRAME_WINDOW_P (f
))
16255 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16256 || defined (HAVE_NS) || defined (USE_GTK)
16257 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16259 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16263 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16265 if (redisplay_menu_p
)
16266 display_menu_bar (w
);
16268 #ifdef HAVE_WINDOW_SYSTEM
16269 if (FRAME_WINDOW_P (f
))
16271 #if defined (USE_GTK) || defined (HAVE_NS)
16272 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16273 redisplay_tool_bar (f
);
16275 if (WINDOWP (f
->tool_bar_window
)
16276 && (FRAME_TOOL_BAR_LINES (f
) > 0
16277 || !NILP (Vauto_resize_tool_bars
))
16278 && redisplay_tool_bar (f
))
16279 ignore_mouse_drag_p
= 1;
16285 #ifdef HAVE_WINDOW_SYSTEM
16286 if (FRAME_WINDOW_P (f
)
16287 && update_window_fringes (w
, (just_this_one_p
16288 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16289 || w
->pseudo_window_p
)))
16293 if (draw_window_fringes (w
, 1))
16294 x_draw_vertical_border (w
);
16298 #endif /* HAVE_WINDOW_SYSTEM */
16300 /* We go to this label, with fonts_changed_p set,
16301 if it is necessary to try again using larger glyph matrices.
16302 We have to redeem the scroll bar even in this case,
16303 because the loop in redisplay_internal expects that. */
16304 need_larger_matrices
:
16306 finish_scroll_bars
:
16308 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16310 /* Set the thumb's position and size. */
16311 set_vertical_scroll_bar (w
);
16313 /* Note that we actually used the scroll bar attached to this
16314 window, so it shouldn't be deleted at the end of redisplay. */
16315 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16316 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16319 /* Restore current_buffer and value of point in it. The window
16320 update may have changed the buffer, so first make sure `opoint'
16321 is still valid (Bug#6177). */
16322 if (CHARPOS (opoint
) < BEGV
)
16323 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16324 else if (CHARPOS (opoint
) > ZV
)
16325 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16327 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16329 set_buffer_internal_1 (old
);
16330 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16331 shorter. This can be caused by log truncation in *Messages*. */
16332 if (CHARPOS (lpoint
) <= ZV
)
16333 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16335 unbind_to (count
, Qnil
);
16339 /* Build the complete desired matrix of WINDOW with a window start
16340 buffer position POS.
16342 Value is 1 if successful. It is zero if fonts were loaded during
16343 redisplay which makes re-adjusting glyph matrices necessary, and -1
16344 if point would appear in the scroll margins.
16345 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16346 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16350 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16352 struct window
*w
= XWINDOW (window
);
16354 struct glyph_row
*last_text_row
= NULL
;
16355 struct frame
*f
= XFRAME (w
->frame
);
16357 /* Make POS the new window start. */
16358 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16360 /* Mark cursor position as unknown. No overlay arrow seen. */
16361 w
->cursor
.vpos
= -1;
16362 overlay_arrow_seen
= 0;
16364 /* Initialize iterator and info to start at POS. */
16365 start_display (&it
, w
, pos
);
16367 /* Display all lines of W. */
16368 while (it
.current_y
< it
.last_visible_y
)
16370 if (display_line (&it
))
16371 last_text_row
= it
.glyph_row
- 1;
16372 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16376 /* Don't let the cursor end in the scroll margins. */
16377 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16378 && !MINI_WINDOW_P (w
))
16380 int this_scroll_margin
;
16382 if (scroll_margin
> 0)
16384 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16385 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16388 this_scroll_margin
= 0;
16390 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16391 && w
->cursor
.y
< this_scroll_margin
16392 && CHARPOS (pos
) > BEGV
16393 && IT_CHARPOS (it
) < ZV
)
16394 /* rms: considering make_cursor_line_fully_visible_p here
16395 seems to give wrong results. We don't want to recenter
16396 when the last line is partly visible, we want to allow
16397 that case to be handled in the usual way. */
16398 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16400 w
->cursor
.vpos
= -1;
16401 clear_glyph_matrix (w
->desired_matrix
);
16406 /* If bottom moved off end of frame, change mode line percentage. */
16407 if (XFASTINT (w
->window_end_pos
) <= 0
16408 && Z
!= IT_CHARPOS (it
))
16409 w
->update_mode_line
= 1;
16411 /* Set window_end_pos to the offset of the last character displayed
16412 on the window from the end of current_buffer. Set
16413 window_end_vpos to its row number. */
16416 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16417 w
->window_end_bytepos
16418 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16419 wset_window_end_pos
16420 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16421 wset_window_end_vpos
16422 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
)));
16424 (MATRIX_ROW (w
->desired_matrix
,
16425 XFASTINT (w
->window_end_vpos
))->displays_text_p
);
16429 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16430 wset_window_end_pos (w
, make_number (Z
- ZV
));
16431 wset_window_end_vpos (w
, make_number (0));
16434 /* But that is not valid info until redisplay finishes. */
16435 wset_window_end_valid (w
, Qnil
);
16441 /************************************************************************
16442 Window redisplay reusing current matrix when buffer has not changed
16443 ************************************************************************/
16445 /* Try redisplay of window W showing an unchanged buffer with a
16446 different window start than the last time it was displayed by
16447 reusing its current matrix. Value is non-zero if successful.
16448 W->start is the new window start. */
16451 try_window_reusing_current_matrix (struct window
*w
)
16453 struct frame
*f
= XFRAME (w
->frame
);
16454 struct glyph_row
*bottom_row
;
16457 struct text_pos start
, new_start
;
16458 int nrows_scrolled
, i
;
16459 struct glyph_row
*last_text_row
;
16460 struct glyph_row
*last_reused_text_row
;
16461 struct glyph_row
*start_row
;
16462 int start_vpos
, min_y
, max_y
;
16465 if (inhibit_try_window_reusing
)
16469 if (/* This function doesn't handle terminal frames. */
16470 !FRAME_WINDOW_P (f
)
16471 /* Don't try to reuse the display if windows have been split
16473 || windows_or_buffers_changed
16474 || cursor_type_changed
)
16477 /* Can't do this if region may have changed. */
16478 if ((!NILP (Vtransient_mark_mode
)
16479 && !NILP (BVAR (current_buffer
, mark_active
)))
16480 || !NILP (w
->region_showing
)
16481 || !NILP (Vshow_trailing_whitespace
))
16484 /* If top-line visibility has changed, give up. */
16485 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16486 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16489 /* Give up if old or new display is scrolled vertically. We could
16490 make this function handle this, but right now it doesn't. */
16491 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16492 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16495 /* The variable new_start now holds the new window start. The old
16496 start `start' can be determined from the current matrix. */
16497 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16498 start
= start_row
->minpos
;
16499 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16501 /* Clear the desired matrix for the display below. */
16502 clear_glyph_matrix (w
->desired_matrix
);
16504 if (CHARPOS (new_start
) <= CHARPOS (start
))
16506 /* Don't use this method if the display starts with an ellipsis
16507 displayed for invisible text. It's not easy to handle that case
16508 below, and it's certainly not worth the effort since this is
16509 not a frequent case. */
16510 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16513 IF_DEBUG (debug_method_add (w
, "twu1"));
16515 /* Display up to a row that can be reused. The variable
16516 last_text_row is set to the last row displayed that displays
16517 text. Note that it.vpos == 0 if or if not there is a
16518 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16519 start_display (&it
, w
, new_start
);
16520 w
->cursor
.vpos
= -1;
16521 last_text_row
= last_reused_text_row
= NULL
;
16523 while (it
.current_y
< it
.last_visible_y
16524 && !fonts_changed_p
)
16526 /* If we have reached into the characters in the START row,
16527 that means the line boundaries have changed. So we
16528 can't start copying with the row START. Maybe it will
16529 work to start copying with the following row. */
16530 while (IT_CHARPOS (it
) > CHARPOS (start
))
16532 /* Advance to the next row as the "start". */
16534 start
= start_row
->minpos
;
16535 /* If there are no more rows to try, or just one, give up. */
16536 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16537 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16538 || CHARPOS (start
) == ZV
)
16540 clear_glyph_matrix (w
->desired_matrix
);
16544 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16546 /* If we have reached alignment, we can copy the rest of the
16548 if (IT_CHARPOS (it
) == CHARPOS (start
)
16549 /* Don't accept "alignment" inside a display vector,
16550 since start_row could have started in the middle of
16551 that same display vector (thus their character
16552 positions match), and we have no way of telling if
16553 that is the case. */
16554 && it
.current
.dpvec_index
< 0)
16557 if (display_line (&it
))
16558 last_text_row
= it
.glyph_row
- 1;
16562 /* A value of current_y < last_visible_y means that we stopped
16563 at the previous window start, which in turn means that we
16564 have at least one reusable row. */
16565 if (it
.current_y
< it
.last_visible_y
)
16567 struct glyph_row
*row
;
16569 /* IT.vpos always starts from 0; it counts text lines. */
16570 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16572 /* Find PT if not already found in the lines displayed. */
16573 if (w
->cursor
.vpos
< 0)
16575 int dy
= it
.current_y
- start_row
->y
;
16577 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16578 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16580 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16581 dy
, nrows_scrolled
);
16584 clear_glyph_matrix (w
->desired_matrix
);
16589 /* Scroll the display. Do it before the current matrix is
16590 changed. The problem here is that update has not yet
16591 run, i.e. part of the current matrix is not up to date.
16592 scroll_run_hook will clear the cursor, and use the
16593 current matrix to get the height of the row the cursor is
16595 run
.current_y
= start_row
->y
;
16596 run
.desired_y
= it
.current_y
;
16597 run
.height
= it
.last_visible_y
- it
.current_y
;
16599 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16602 FRAME_RIF (f
)->update_window_begin_hook (w
);
16603 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16604 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16605 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16609 /* Shift current matrix down by nrows_scrolled lines. */
16610 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16611 rotate_matrix (w
->current_matrix
,
16613 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16616 /* Disable lines that must be updated. */
16617 for (i
= 0; i
< nrows_scrolled
; ++i
)
16618 (start_row
+ i
)->enabled_p
= 0;
16620 /* Re-compute Y positions. */
16621 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16622 max_y
= it
.last_visible_y
;
16623 for (row
= start_row
+ nrows_scrolled
;
16627 row
->y
= it
.current_y
;
16628 row
->visible_height
= row
->height
;
16630 if (row
->y
< min_y
)
16631 row
->visible_height
-= min_y
- row
->y
;
16632 if (row
->y
+ row
->height
> max_y
)
16633 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16634 if (row
->fringe_bitmap_periodic_p
)
16635 row
->redraw_fringe_bitmaps_p
= 1;
16637 it
.current_y
+= row
->height
;
16639 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16640 last_reused_text_row
= row
;
16641 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16645 /* Disable lines in the current matrix which are now
16646 below the window. */
16647 for (++row
; row
< bottom_row
; ++row
)
16648 row
->enabled_p
= row
->mode_line_p
= 0;
16651 /* Update window_end_pos etc.; last_reused_text_row is the last
16652 reused row from the current matrix containing text, if any.
16653 The value of last_text_row is the last displayed line
16654 containing text. */
16655 if (last_reused_text_row
)
16657 w
->window_end_bytepos
16658 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16659 wset_window_end_pos
16661 - MATRIX_ROW_END_CHARPOS (last_reused_text_row
)));
16662 wset_window_end_vpos
16663 (w
, make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16664 w
->current_matrix
)));
16666 else if (last_text_row
)
16668 w
->window_end_bytepos
16669 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16670 wset_window_end_pos
16671 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16672 wset_window_end_vpos
16673 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16674 w
->desired_matrix
)));
16678 /* This window must be completely empty. */
16679 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16680 wset_window_end_pos (w
, make_number (Z
- ZV
));
16681 wset_window_end_vpos (w
, make_number (0));
16683 wset_window_end_valid (w
, Qnil
);
16685 /* Update hint: don't try scrolling again in update_window. */
16686 w
->desired_matrix
->no_scrolling_p
= 1;
16689 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16693 else if (CHARPOS (new_start
) > CHARPOS (start
))
16695 struct glyph_row
*pt_row
, *row
;
16696 struct glyph_row
*first_reusable_row
;
16697 struct glyph_row
*first_row_to_display
;
16699 int yb
= window_text_bottom_y (w
);
16701 /* Find the row starting at new_start, if there is one. Don't
16702 reuse a partially visible line at the end. */
16703 first_reusable_row
= start_row
;
16704 while (first_reusable_row
->enabled_p
16705 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16706 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16707 < CHARPOS (new_start
)))
16708 ++first_reusable_row
;
16710 /* Give up if there is no row to reuse. */
16711 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16712 || !first_reusable_row
->enabled_p
16713 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16714 != CHARPOS (new_start
)))
16717 /* We can reuse fully visible rows beginning with
16718 first_reusable_row to the end of the window. Set
16719 first_row_to_display to the first row that cannot be reused.
16720 Set pt_row to the row containing point, if there is any. */
16722 for (first_row_to_display
= first_reusable_row
;
16723 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16724 ++first_row_to_display
)
16726 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16727 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16728 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16729 && first_row_to_display
->ends_at_zv_p
16730 && pt_row
== NULL
)))
16731 pt_row
= first_row_to_display
;
16734 /* Start displaying at the start of first_row_to_display. */
16735 eassert (first_row_to_display
->y
< yb
);
16736 init_to_row_start (&it
, w
, first_row_to_display
);
16738 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16740 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16742 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16743 + WINDOW_HEADER_LINE_HEIGHT (w
));
16745 /* Display lines beginning with first_row_to_display in the
16746 desired matrix. Set last_text_row to the last row displayed
16747 that displays text. */
16748 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16749 if (pt_row
== NULL
)
16750 w
->cursor
.vpos
= -1;
16751 last_text_row
= NULL
;
16752 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16753 if (display_line (&it
))
16754 last_text_row
= it
.glyph_row
- 1;
16756 /* If point is in a reused row, adjust y and vpos of the cursor
16760 w
->cursor
.vpos
-= nrows_scrolled
;
16761 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16764 /* Give up if point isn't in a row displayed or reused. (This
16765 also handles the case where w->cursor.vpos < nrows_scrolled
16766 after the calls to display_line, which can happen with scroll
16767 margins. See bug#1295.) */
16768 if (w
->cursor
.vpos
< 0)
16770 clear_glyph_matrix (w
->desired_matrix
);
16774 /* Scroll the display. */
16775 run
.current_y
= first_reusable_row
->y
;
16776 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16777 run
.height
= it
.last_visible_y
- run
.current_y
;
16778 dy
= run
.current_y
- run
.desired_y
;
16783 FRAME_RIF (f
)->update_window_begin_hook (w
);
16784 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16785 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16786 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16790 /* Adjust Y positions of reused rows. */
16791 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16792 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16793 max_y
= it
.last_visible_y
;
16794 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16797 row
->visible_height
= row
->height
;
16798 if (row
->y
< min_y
)
16799 row
->visible_height
-= min_y
- row
->y
;
16800 if (row
->y
+ row
->height
> max_y
)
16801 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16802 if (row
->fringe_bitmap_periodic_p
)
16803 row
->redraw_fringe_bitmaps_p
= 1;
16806 /* Scroll the current matrix. */
16807 eassert (nrows_scrolled
> 0);
16808 rotate_matrix (w
->current_matrix
,
16810 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16813 /* Disable rows not reused. */
16814 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16815 row
->enabled_p
= 0;
16817 /* Point may have moved to a different line, so we cannot assume that
16818 the previous cursor position is valid; locate the correct row. */
16821 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16823 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16824 && !row
->ends_at_zv_p
;
16828 w
->cursor
.y
= row
->y
;
16830 if (row
< bottom_row
)
16832 /* Can't simply scan the row for point with
16833 bidi-reordered glyph rows. Let set_cursor_from_row
16834 figure out where to put the cursor, and if it fails,
16836 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16838 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
16841 clear_glyph_matrix (w
->desired_matrix
);
16847 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16848 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16851 && (!BUFFERP (glyph
->object
)
16852 || glyph
->charpos
< PT
);
16856 w
->cursor
.x
+= glyph
->pixel_width
;
16862 /* Adjust window end. A null value of last_text_row means that
16863 the window end is in reused rows which in turn means that
16864 only its vpos can have changed. */
16867 w
->window_end_bytepos
16868 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16869 wset_window_end_pos
16870 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16871 wset_window_end_vpos
16872 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16873 w
->desired_matrix
)));
16877 wset_window_end_vpos
16878 (w
, make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
));
16881 wset_window_end_valid (w
, Qnil
);
16882 w
->desired_matrix
->no_scrolling_p
= 1;
16885 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16895 /************************************************************************
16896 Window redisplay reusing current matrix when buffer has changed
16897 ************************************************************************/
16899 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16900 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16901 ptrdiff_t *, ptrdiff_t *);
16902 static struct glyph_row
*
16903 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16904 struct glyph_row
*);
16907 /* Return the last row in MATRIX displaying text. If row START is
16908 non-null, start searching with that row. IT gives the dimensions
16909 of the display. Value is null if matrix is empty; otherwise it is
16910 a pointer to the row found. */
16912 static struct glyph_row
*
16913 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16914 struct glyph_row
*start
)
16916 struct glyph_row
*row
, *row_found
;
16918 /* Set row_found to the last row in IT->w's current matrix
16919 displaying text. The loop looks funny but think of partially
16922 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16923 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16925 eassert (row
->enabled_p
);
16927 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16936 /* Return the last row in the current matrix of W that is not affected
16937 by changes at the start of current_buffer that occurred since W's
16938 current matrix was built. Value is null if no such row exists.
16940 BEG_UNCHANGED us the number of characters unchanged at the start of
16941 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16942 first changed character in current_buffer. Characters at positions <
16943 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16944 when the current matrix was built. */
16946 static struct glyph_row
*
16947 find_last_unchanged_at_beg_row (struct window
*w
)
16949 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16950 struct glyph_row
*row
;
16951 struct glyph_row
*row_found
= NULL
;
16952 int yb
= window_text_bottom_y (w
);
16954 /* Find the last row displaying unchanged text. */
16955 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16956 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16957 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16960 if (/* If row ends before first_changed_pos, it is unchanged,
16961 except in some case. */
16962 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16963 /* When row ends in ZV and we write at ZV it is not
16965 && !row
->ends_at_zv_p
16966 /* When first_changed_pos is the end of a continued line,
16967 row is not unchanged because it may be no longer
16969 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16970 && (row
->continued_p
16971 || row
->exact_window_width_line_p
))
16972 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16973 needs to be recomputed, so don't consider this row as
16974 unchanged. This happens when the last line was
16975 bidi-reordered and was killed immediately before this
16976 redisplay cycle. In that case, ROW->end stores the
16977 buffer position of the first visual-order character of
16978 the killed text, which is now beyond ZV. */
16979 && CHARPOS (row
->end
.pos
) <= ZV
)
16982 /* Stop if last visible row. */
16983 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16991 /* Find the first glyph row in the current matrix of W that is not
16992 affected by changes at the end of current_buffer since the
16993 time W's current matrix was built.
16995 Return in *DELTA the number of chars by which buffer positions in
16996 unchanged text at the end of current_buffer must be adjusted.
16998 Return in *DELTA_BYTES the corresponding number of bytes.
17000 Value is null if no such row exists, i.e. all rows are affected by
17003 static struct glyph_row
*
17004 find_first_unchanged_at_end_row (struct window
*w
,
17005 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17007 struct glyph_row
*row
;
17008 struct glyph_row
*row_found
= NULL
;
17010 *delta
= *delta_bytes
= 0;
17012 /* Display must not have been paused, otherwise the current matrix
17013 is not up to date. */
17014 eassert (!NILP (w
->window_end_valid
));
17016 /* A value of window_end_pos >= END_UNCHANGED means that the window
17017 end is in the range of changed text. If so, there is no
17018 unchanged row at the end of W's current matrix. */
17019 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
17022 /* Set row to the last row in W's current matrix displaying text. */
17023 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17025 /* If matrix is entirely empty, no unchanged row exists. */
17026 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17028 /* The value of row is the last glyph row in the matrix having a
17029 meaningful buffer position in it. The end position of row
17030 corresponds to window_end_pos. This allows us to translate
17031 buffer positions in the current matrix to current buffer
17032 positions for characters not in changed text. */
17034 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17035 ptrdiff_t Z_BYTE_old
=
17036 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17037 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17038 struct glyph_row
*first_text_row
17039 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17041 *delta
= Z
- Z_old
;
17042 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17044 /* Set last_unchanged_pos to the buffer position of the last
17045 character in the buffer that has not been changed. Z is the
17046 index + 1 of the last character in current_buffer, i.e. by
17047 subtracting END_UNCHANGED we get the index of the last
17048 unchanged character, and we have to add BEG to get its buffer
17050 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17051 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17053 /* Search backward from ROW for a row displaying a line that
17054 starts at a minimum position >= last_unchanged_pos_old. */
17055 for (; row
> first_text_row
; --row
)
17057 /* This used to abort, but it can happen.
17058 It is ok to just stop the search instead here. KFS. */
17059 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17062 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17067 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17073 /* Make sure that glyph rows in the current matrix of window W
17074 reference the same glyph memory as corresponding rows in the
17075 frame's frame matrix. This function is called after scrolling W's
17076 current matrix on a terminal frame in try_window_id and
17077 try_window_reusing_current_matrix. */
17080 sync_frame_with_window_matrix_rows (struct window
*w
)
17082 struct frame
*f
= XFRAME (w
->frame
);
17083 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17085 /* Preconditions: W must be a leaf window and full-width. Its frame
17086 must have a frame matrix. */
17087 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
17088 eassert (WINDOW_FULL_WIDTH_P (w
));
17089 eassert (!FRAME_WINDOW_P (f
));
17091 /* If W is a full-width window, glyph pointers in W's current matrix
17092 have, by definition, to be the same as glyph pointers in the
17093 corresponding frame matrix. Note that frame matrices have no
17094 marginal areas (see build_frame_matrix). */
17095 window_row
= w
->current_matrix
->rows
;
17096 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17097 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17098 while (window_row
< window_row_end
)
17100 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17101 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17103 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17104 frame_row
->glyphs
[TEXT_AREA
] = start
;
17105 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17106 frame_row
->glyphs
[LAST_AREA
] = end
;
17108 /* Disable frame rows whose corresponding window rows have
17109 been disabled in try_window_id. */
17110 if (!window_row
->enabled_p
)
17111 frame_row
->enabled_p
= 0;
17113 ++window_row
, ++frame_row
;
17118 /* Find the glyph row in window W containing CHARPOS. Consider all
17119 rows between START and END (not inclusive). END null means search
17120 all rows to the end of the display area of W. Value is the row
17121 containing CHARPOS or null. */
17124 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17125 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17127 struct glyph_row
*row
= start
;
17128 struct glyph_row
*best_row
= NULL
;
17129 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
17132 /* If we happen to start on a header-line, skip that. */
17133 if (row
->mode_line_p
)
17136 if ((end
&& row
>= end
) || !row
->enabled_p
)
17139 last_y
= window_text_bottom_y (w
) - dy
;
17143 /* Give up if we have gone too far. */
17144 if (end
&& row
>= end
)
17146 /* This formerly returned if they were equal.
17147 I think that both quantities are of a "last plus one" type;
17148 if so, when they are equal, the row is within the screen. -- rms. */
17149 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17152 /* If it is in this row, return this row. */
17153 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17154 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17155 /* The end position of a row equals the start
17156 position of the next row. If CHARPOS is there, we
17157 would rather display it in the next line, except
17158 when this line ends in ZV. */
17159 && !row
->ends_at_zv_p
17160 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
17161 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17165 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17166 || (!best_row
&& !row
->continued_p
))
17168 /* In bidi-reordered rows, there could be several rows
17169 occluding point, all of them belonging to the same
17170 continued line. We need to find the row which fits
17171 CHARPOS the best. */
17172 for (g
= row
->glyphs
[TEXT_AREA
];
17173 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17176 if (!STRINGP (g
->object
))
17178 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17180 mindif
= eabs (g
->charpos
- charpos
);
17182 /* Exact match always wins. */
17189 else if (best_row
&& !row
->continued_p
)
17196 /* Try to redisplay window W by reusing its existing display. W's
17197 current matrix must be up to date when this function is called,
17198 i.e. window_end_valid must not be nil.
17202 1 if display has been updated
17203 0 if otherwise unsuccessful
17204 -1 if redisplay with same window start is known not to succeed
17206 The following steps are performed:
17208 1. Find the last row in the current matrix of W that is not
17209 affected by changes at the start of current_buffer. If no such row
17212 2. Find the first row in W's current matrix that is not affected by
17213 changes at the end of current_buffer. Maybe there is no such row.
17215 3. Display lines beginning with the row + 1 found in step 1 to the
17216 row found in step 2 or, if step 2 didn't find a row, to the end of
17219 4. If cursor is not known to appear on the window, give up.
17221 5. If display stopped at the row found in step 2, scroll the
17222 display and current matrix as needed.
17224 6. Maybe display some lines at the end of W, if we must. This can
17225 happen under various circumstances, like a partially visible line
17226 becoming fully visible, or because newly displayed lines are displayed
17227 in smaller font sizes.
17229 7. Update W's window end information. */
17232 try_window_id (struct window
*w
)
17234 struct frame
*f
= XFRAME (w
->frame
);
17235 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17236 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17237 struct glyph_row
*last_unchanged_at_beg_row
;
17238 struct glyph_row
*first_unchanged_at_end_row
;
17239 struct glyph_row
*row
;
17240 struct glyph_row
*bottom_row
;
17243 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17245 struct text_pos start_pos
;
17247 int first_unchanged_at_end_vpos
= 0;
17248 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17249 struct text_pos start
;
17250 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17253 if (inhibit_try_window_id
)
17257 /* This is handy for debugging. */
17259 #define GIVE_UP(X) \
17261 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17265 #define GIVE_UP(X) return 0
17268 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17270 /* Don't use this for mini-windows because these can show
17271 messages and mini-buffers, and we don't handle that here. */
17272 if (MINI_WINDOW_P (w
))
17275 /* This flag is used to prevent redisplay optimizations. */
17276 if (windows_or_buffers_changed
|| cursor_type_changed
)
17279 /* Verify that narrowing has not changed.
17280 Also verify that we were not told to prevent redisplay optimizations.
17281 It would be nice to further
17282 reduce the number of cases where this prevents try_window_id. */
17283 if (current_buffer
->clip_changed
17284 || current_buffer
->prevent_redisplay_optimizations_p
)
17287 /* Window must either use window-based redisplay or be full width. */
17288 if (!FRAME_WINDOW_P (f
)
17289 && (!FRAME_LINE_INS_DEL_OK (f
)
17290 || !WINDOW_FULL_WIDTH_P (w
)))
17293 /* Give up if point is known NOT to appear in W. */
17294 if (PT
< CHARPOS (start
))
17297 /* Another way to prevent redisplay optimizations. */
17298 if (w
->last_modified
== 0)
17301 /* Verify that window is not hscrolled. */
17302 if (w
->hscroll
!= 0)
17305 /* Verify that display wasn't paused. */
17306 if (NILP (w
->window_end_valid
))
17309 /* Can't use this if highlighting a region because a cursor movement
17310 will do more than just set the cursor. */
17311 if (!NILP (Vtransient_mark_mode
)
17312 && !NILP (BVAR (current_buffer
, mark_active
)))
17315 /* Likewise if highlighting trailing whitespace. */
17316 if (!NILP (Vshow_trailing_whitespace
))
17319 /* Likewise if showing a region. */
17320 if (!NILP (w
->region_showing
))
17323 /* Can't use this if overlay arrow position and/or string have
17325 if (overlay_arrows_changed_p ())
17328 /* When word-wrap is on, adding a space to the first word of a
17329 wrapped line can change the wrap position, altering the line
17330 above it. It might be worthwhile to handle this more
17331 intelligently, but for now just redisplay from scratch. */
17332 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
17335 /* Under bidi reordering, adding or deleting a character in the
17336 beginning of a paragraph, before the first strong directional
17337 character, can change the base direction of the paragraph (unless
17338 the buffer specifies a fixed paragraph direction), which will
17339 require to redisplay the whole paragraph. It might be worthwhile
17340 to find the paragraph limits and widen the range of redisplayed
17341 lines to that, but for now just give up this optimization and
17342 redisplay from scratch. */
17343 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17344 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
17347 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17348 only if buffer has really changed. The reason is that the gap is
17349 initially at Z for freshly visited files. The code below would
17350 set end_unchanged to 0 in that case. */
17351 if (MODIFF
> SAVE_MODIFF
17352 /* This seems to happen sometimes after saving a buffer. */
17353 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17355 if (GPT
- BEG
< BEG_UNCHANGED
)
17356 BEG_UNCHANGED
= GPT
- BEG
;
17357 if (Z
- GPT
< END_UNCHANGED
)
17358 END_UNCHANGED
= Z
- GPT
;
17361 /* The position of the first and last character that has been changed. */
17362 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17363 last_changed_charpos
= Z
- END_UNCHANGED
;
17365 /* If window starts after a line end, and the last change is in
17366 front of that newline, then changes don't affect the display.
17367 This case happens with stealth-fontification. Note that although
17368 the display is unchanged, glyph positions in the matrix have to
17369 be adjusted, of course. */
17370 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17371 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17372 && ((last_changed_charpos
< CHARPOS (start
)
17373 && CHARPOS (start
) == BEGV
)
17374 || (last_changed_charpos
< CHARPOS (start
) - 1
17375 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17377 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17378 struct glyph_row
*r0
;
17380 /* Compute how many chars/bytes have been added to or removed
17381 from the buffer. */
17382 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17383 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17384 Z_delta
= Z
- Z_old
;
17385 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17387 /* Give up if PT is not in the window. Note that it already has
17388 been checked at the start of try_window_id that PT is not in
17389 front of the window start. */
17390 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17393 /* If window start is unchanged, we can reuse the whole matrix
17394 as is, after adjusting glyph positions. No need to compute
17395 the window end again, since its offset from Z hasn't changed. */
17396 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17397 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17398 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17399 /* PT must not be in a partially visible line. */
17400 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17401 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17403 /* Adjust positions in the glyph matrix. */
17404 if (Z_delta
|| Z_delta_bytes
)
17406 struct glyph_row
*r1
17407 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17408 increment_matrix_positions (w
->current_matrix
,
17409 MATRIX_ROW_VPOS (r0
, current_matrix
),
17410 MATRIX_ROW_VPOS (r1
, current_matrix
),
17411 Z_delta
, Z_delta_bytes
);
17414 /* Set the cursor. */
17415 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17417 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17424 /* Handle the case that changes are all below what is displayed in
17425 the window, and that PT is in the window. This shortcut cannot
17426 be taken if ZV is visible in the window, and text has been added
17427 there that is visible in the window. */
17428 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17429 /* ZV is not visible in the window, or there are no
17430 changes at ZV, actually. */
17431 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17432 || first_changed_charpos
== last_changed_charpos
))
17434 struct glyph_row
*r0
;
17436 /* Give up if PT is not in the window. Note that it already has
17437 been checked at the start of try_window_id that PT is not in
17438 front of the window start. */
17439 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17442 /* If window start is unchanged, we can reuse the whole matrix
17443 as is, without changing glyph positions since no text has
17444 been added/removed in front of the window end. */
17445 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17446 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17447 /* PT must not be in a partially visible line. */
17448 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17449 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17451 /* We have to compute the window end anew since text
17452 could have been added/removed after it. */
17453 wset_window_end_pos
17454 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17455 w
->window_end_bytepos
17456 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17458 /* Set the cursor. */
17459 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17461 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17468 /* Give up if window start is in the changed area.
17470 The condition used to read
17472 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17474 but why that was tested escapes me at the moment. */
17475 if (CHARPOS (start
) >= first_changed_charpos
17476 && CHARPOS (start
) <= last_changed_charpos
)
17479 /* Check that window start agrees with the start of the first glyph
17480 row in its current matrix. Check this after we know the window
17481 start is not in changed text, otherwise positions would not be
17483 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17484 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17487 /* Give up if the window ends in strings. Overlay strings
17488 at the end are difficult to handle, so don't try. */
17489 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17490 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17493 /* Compute the position at which we have to start displaying new
17494 lines. Some of the lines at the top of the window might be
17495 reusable because they are not displaying changed text. Find the
17496 last row in W's current matrix not affected by changes at the
17497 start of current_buffer. Value is null if changes start in the
17498 first line of window. */
17499 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17500 if (last_unchanged_at_beg_row
)
17502 /* Avoid starting to display in the middle of a character, a TAB
17503 for instance. This is easier than to set up the iterator
17504 exactly, and it's not a frequent case, so the additional
17505 effort wouldn't really pay off. */
17506 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17507 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17508 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17509 --last_unchanged_at_beg_row
;
17511 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17514 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17516 start_pos
= it
.current
.pos
;
17518 /* Start displaying new lines in the desired matrix at the same
17519 vpos we would use in the current matrix, i.e. below
17520 last_unchanged_at_beg_row. */
17521 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17523 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17524 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17526 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17530 /* There are no reusable lines at the start of the window.
17531 Start displaying in the first text line. */
17532 start_display (&it
, w
, start
);
17533 it
.vpos
= it
.first_vpos
;
17534 start_pos
= it
.current
.pos
;
17537 /* Find the first row that is not affected by changes at the end of
17538 the buffer. Value will be null if there is no unchanged row, in
17539 which case we must redisplay to the end of the window. delta
17540 will be set to the value by which buffer positions beginning with
17541 first_unchanged_at_end_row have to be adjusted due to text
17543 first_unchanged_at_end_row
17544 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17545 IF_DEBUG (debug_delta
= delta
);
17546 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17548 /* Set stop_pos to the buffer position up to which we will have to
17549 display new lines. If first_unchanged_at_end_row != NULL, this
17550 is the buffer position of the start of the line displayed in that
17551 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17552 that we don't stop at a buffer position. */
17554 if (first_unchanged_at_end_row
)
17556 eassert (last_unchanged_at_beg_row
== NULL
17557 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17559 /* If this is a continuation line, move forward to the next one
17560 that isn't. Changes in lines above affect this line.
17561 Caution: this may move first_unchanged_at_end_row to a row
17562 not displaying text. */
17563 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17564 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17565 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17566 < it
.last_visible_y
))
17567 ++first_unchanged_at_end_row
;
17569 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17570 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17571 >= it
.last_visible_y
))
17572 first_unchanged_at_end_row
= NULL
;
17575 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17577 first_unchanged_at_end_vpos
17578 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17579 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17582 else if (last_unchanged_at_beg_row
== NULL
)
17588 /* Either there is no unchanged row at the end, or the one we have
17589 now displays text. This is a necessary condition for the window
17590 end pos calculation at the end of this function. */
17591 eassert (first_unchanged_at_end_row
== NULL
17592 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17594 debug_last_unchanged_at_beg_vpos
17595 = (last_unchanged_at_beg_row
17596 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17598 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17600 #endif /* GLYPH_DEBUG */
17603 /* Display new lines. Set last_text_row to the last new line
17604 displayed which has text on it, i.e. might end up as being the
17605 line where the window_end_vpos is. */
17606 w
->cursor
.vpos
= -1;
17607 last_text_row
= NULL
;
17608 overlay_arrow_seen
= 0;
17609 while (it
.current_y
< it
.last_visible_y
17610 && !fonts_changed_p
17611 && (first_unchanged_at_end_row
== NULL
17612 || IT_CHARPOS (it
) < stop_pos
))
17614 if (display_line (&it
))
17615 last_text_row
= it
.glyph_row
- 1;
17618 if (fonts_changed_p
)
17622 /* Compute differences in buffer positions, y-positions etc. for
17623 lines reused at the bottom of the window. Compute what we can
17625 if (first_unchanged_at_end_row
17626 /* No lines reused because we displayed everything up to the
17627 bottom of the window. */
17628 && it
.current_y
< it
.last_visible_y
)
17631 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17633 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17634 run
.current_y
= first_unchanged_at_end_row
->y
;
17635 run
.desired_y
= run
.current_y
+ dy
;
17636 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17640 delta
= delta_bytes
= dvpos
= dy
17641 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17642 first_unchanged_at_end_row
= NULL
;
17644 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17647 /* Find the cursor if not already found. We have to decide whether
17648 PT will appear on this window (it sometimes doesn't, but this is
17649 not a very frequent case.) This decision has to be made before
17650 the current matrix is altered. A value of cursor.vpos < 0 means
17651 that PT is either in one of the lines beginning at
17652 first_unchanged_at_end_row or below the window. Don't care for
17653 lines that might be displayed later at the window end; as
17654 mentioned, this is not a frequent case. */
17655 if (w
->cursor
.vpos
< 0)
17657 /* Cursor in unchanged rows at the top? */
17658 if (PT
< CHARPOS (start_pos
)
17659 && last_unchanged_at_beg_row
)
17661 row
= row_containing_pos (w
, PT
,
17662 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17663 last_unchanged_at_beg_row
+ 1, 0);
17665 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17668 /* Start from first_unchanged_at_end_row looking for PT. */
17669 else if (first_unchanged_at_end_row
)
17671 row
= row_containing_pos (w
, PT
- delta
,
17672 first_unchanged_at_end_row
, NULL
, 0);
17674 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17675 delta_bytes
, dy
, dvpos
);
17678 /* Give up if cursor was not found. */
17679 if (w
->cursor
.vpos
< 0)
17681 clear_glyph_matrix (w
->desired_matrix
);
17686 /* Don't let the cursor end in the scroll margins. */
17688 int this_scroll_margin
, cursor_height
;
17690 this_scroll_margin
=
17691 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17692 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17693 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17695 if ((w
->cursor
.y
< this_scroll_margin
17696 && CHARPOS (start
) > BEGV
)
17697 /* Old redisplay didn't take scroll margin into account at the bottom,
17698 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17699 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17700 ? cursor_height
+ this_scroll_margin
17701 : 1)) > it
.last_visible_y
)
17703 w
->cursor
.vpos
= -1;
17704 clear_glyph_matrix (w
->desired_matrix
);
17709 /* Scroll the display. Do it before changing the current matrix so
17710 that xterm.c doesn't get confused about where the cursor glyph is
17712 if (dy
&& run
.height
)
17716 if (FRAME_WINDOW_P (f
))
17718 FRAME_RIF (f
)->update_window_begin_hook (w
);
17719 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17720 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17721 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17725 /* Terminal frame. In this case, dvpos gives the number of
17726 lines to scroll by; dvpos < 0 means scroll up. */
17728 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17729 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17730 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17731 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17732 + window_internal_height (w
));
17734 #if defined (HAVE_GPM) || defined (MSDOS)
17735 x_clear_window_mouse_face (w
);
17737 /* Perform the operation on the screen. */
17740 /* Scroll last_unchanged_at_beg_row to the end of the
17741 window down dvpos lines. */
17742 set_terminal_window (f
, end
);
17744 /* On dumb terminals delete dvpos lines at the end
17745 before inserting dvpos empty lines. */
17746 if (!FRAME_SCROLL_REGION_OK (f
))
17747 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17749 /* Insert dvpos empty lines in front of
17750 last_unchanged_at_beg_row. */
17751 ins_del_lines (f
, from
, dvpos
);
17753 else if (dvpos
< 0)
17755 /* Scroll up last_unchanged_at_beg_vpos to the end of
17756 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17757 set_terminal_window (f
, end
);
17759 /* Delete dvpos lines in front of
17760 last_unchanged_at_beg_vpos. ins_del_lines will set
17761 the cursor to the given vpos and emit |dvpos| delete
17763 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17765 /* On a dumb terminal insert dvpos empty lines at the
17767 if (!FRAME_SCROLL_REGION_OK (f
))
17768 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17771 set_terminal_window (f
, 0);
17777 /* Shift reused rows of the current matrix to the right position.
17778 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17780 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17781 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17784 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17785 bottom_vpos
, dvpos
);
17786 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17789 else if (dvpos
> 0)
17791 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17792 bottom_vpos
, dvpos
);
17793 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17794 first_unchanged_at_end_vpos
+ dvpos
);
17797 /* For frame-based redisplay, make sure that current frame and window
17798 matrix are in sync with respect to glyph memory. */
17799 if (!FRAME_WINDOW_P (f
))
17800 sync_frame_with_window_matrix_rows (w
);
17802 /* Adjust buffer positions in reused rows. */
17803 if (delta
|| delta_bytes
)
17804 increment_matrix_positions (current_matrix
,
17805 first_unchanged_at_end_vpos
+ dvpos
,
17806 bottom_vpos
, delta
, delta_bytes
);
17808 /* Adjust Y positions. */
17810 shift_glyph_matrix (w
, current_matrix
,
17811 first_unchanged_at_end_vpos
+ dvpos
,
17814 if (first_unchanged_at_end_row
)
17816 first_unchanged_at_end_row
+= dvpos
;
17817 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17818 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17819 first_unchanged_at_end_row
= NULL
;
17822 /* If scrolling up, there may be some lines to display at the end of
17824 last_text_row_at_end
= NULL
;
17827 /* Scrolling up can leave for example a partially visible line
17828 at the end of the window to be redisplayed. */
17829 /* Set last_row to the glyph row in the current matrix where the
17830 window end line is found. It has been moved up or down in
17831 the matrix by dvpos. */
17832 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17833 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17835 /* If last_row is the window end line, it should display text. */
17836 eassert (last_row
->displays_text_p
);
17838 /* If window end line was partially visible before, begin
17839 displaying at that line. Otherwise begin displaying with the
17840 line following it. */
17841 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17843 init_to_row_start (&it
, w
, last_row
);
17844 it
.vpos
= last_vpos
;
17845 it
.current_y
= last_row
->y
;
17849 init_to_row_end (&it
, w
, last_row
);
17850 it
.vpos
= 1 + last_vpos
;
17851 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17855 /* We may start in a continuation line. If so, we have to
17856 get the right continuation_lines_width and current_x. */
17857 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17858 it
.hpos
= it
.current_x
= 0;
17860 /* Display the rest of the lines at the window end. */
17861 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17862 while (it
.current_y
< it
.last_visible_y
17863 && !fonts_changed_p
)
17865 /* Is it always sure that the display agrees with lines in
17866 the current matrix? I don't think so, so we mark rows
17867 displayed invalid in the current matrix by setting their
17868 enabled_p flag to zero. */
17869 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17870 if (display_line (&it
))
17871 last_text_row_at_end
= it
.glyph_row
- 1;
17875 /* Update window_end_pos and window_end_vpos. */
17876 if (first_unchanged_at_end_row
17877 && !last_text_row_at_end
)
17879 /* Window end line if one of the preserved rows from the current
17880 matrix. Set row to the last row displaying text in current
17881 matrix starting at first_unchanged_at_end_row, after
17883 eassert (first_unchanged_at_end_row
->displays_text_p
);
17884 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17885 first_unchanged_at_end_row
);
17886 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17888 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17889 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17890 wset_window_end_vpos
17891 (w
, make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
)));
17892 eassert (w
->window_end_bytepos
>= 0);
17893 IF_DEBUG (debug_method_add (w
, "A"));
17895 else if (last_text_row_at_end
)
17897 wset_window_end_pos
17898 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
)));
17899 w
->window_end_bytepos
17900 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17901 wset_window_end_vpos
17902 (w
, make_number (MATRIX_ROW_VPOS (last_text_row_at_end
,
17904 eassert (w
->window_end_bytepos
>= 0);
17905 IF_DEBUG (debug_method_add (w
, "B"));
17907 else if (last_text_row
)
17909 /* We have displayed either to the end of the window or at the
17910 end of the window, i.e. the last row with text is to be found
17911 in the desired matrix. */
17912 wset_window_end_pos
17913 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
17914 w
->window_end_bytepos
17915 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17916 wset_window_end_vpos
17917 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
)));
17918 eassert (w
->window_end_bytepos
>= 0);
17920 else if (first_unchanged_at_end_row
== NULL
17921 && last_text_row
== NULL
17922 && last_text_row_at_end
== NULL
)
17924 /* Displayed to end of window, but no line containing text was
17925 displayed. Lines were deleted at the end of the window. */
17926 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17927 int vpos
= XFASTINT (w
->window_end_vpos
);
17928 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17929 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17932 row
== NULL
&& vpos
>= first_vpos
;
17933 --vpos
, --current_row
, --desired_row
)
17935 if (desired_row
->enabled_p
)
17937 if (desired_row
->displays_text_p
)
17940 else if (current_row
->displays_text_p
)
17944 eassert (row
!= NULL
);
17945 wset_window_end_vpos (w
, make_number (vpos
+ 1));
17946 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17947 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17948 eassert (w
->window_end_bytepos
>= 0);
17949 IF_DEBUG (debug_method_add (w
, "C"));
17954 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17955 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17957 /* Record that display has not been completed. */
17958 wset_window_end_valid (w
, Qnil
);
17959 w
->desired_matrix
->no_scrolling_p
= 1;
17967 /***********************************************************************
17968 More debugging support
17969 ***********************************************************************/
17973 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17974 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17975 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17978 /* Dump the contents of glyph matrix MATRIX on stderr.
17980 GLYPHS 0 means don't show glyph contents.
17981 GLYPHS 1 means show glyphs in short form
17982 GLYPHS > 1 means show glyphs in long form. */
17985 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17988 for (i
= 0; i
< matrix
->nrows
; ++i
)
17989 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17993 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17994 the glyph row and area where the glyph comes from. */
17997 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17999 if (glyph
->type
== CHAR_GLYPH
)
18002 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18003 glyph
- row
->glyphs
[TEXT_AREA
],
18006 (BUFFERP (glyph
->object
)
18008 : (STRINGP (glyph
->object
)
18011 glyph
->pixel_width
,
18013 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18017 glyph
->left_box_line_p
,
18018 glyph
->right_box_line_p
);
18020 else if (glyph
->type
== STRETCH_GLYPH
)
18023 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18024 glyph
- row
->glyphs
[TEXT_AREA
],
18027 (BUFFERP (glyph
->object
)
18029 : (STRINGP (glyph
->object
)
18032 glyph
->pixel_width
,
18036 glyph
->left_box_line_p
,
18037 glyph
->right_box_line_p
);
18039 else if (glyph
->type
== IMAGE_GLYPH
)
18042 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18043 glyph
- row
->glyphs
[TEXT_AREA
],
18046 (BUFFERP (glyph
->object
)
18048 : (STRINGP (glyph
->object
)
18051 glyph
->pixel_width
,
18055 glyph
->left_box_line_p
,
18056 glyph
->right_box_line_p
);
18058 else if (glyph
->type
== COMPOSITE_GLYPH
)
18061 " %5td %4c %6"pI
"d %c %3d 0x%05x",
18062 glyph
- row
->glyphs
[TEXT_AREA
],
18065 (BUFFERP (glyph
->object
)
18067 : (STRINGP (glyph
->object
)
18070 glyph
->pixel_width
,
18072 if (glyph
->u
.cmp
.automatic
)
18075 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18076 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18078 glyph
->left_box_line_p
,
18079 glyph
->right_box_line_p
);
18084 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18085 GLYPHS 0 means don't show glyph contents.
18086 GLYPHS 1 means show glyphs in short form
18087 GLYPHS > 1 means show glyphs in long form. */
18090 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18094 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18095 fprintf (stderr
, "======================================================================\n");
18097 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18098 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18100 MATRIX_ROW_START_CHARPOS (row
),
18101 MATRIX_ROW_END_CHARPOS (row
),
18102 row
->used
[TEXT_AREA
],
18103 row
->contains_overlapping_glyphs_p
,
18105 row
->truncated_on_left_p
,
18106 row
->truncated_on_right_p
,
18108 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18109 row
->displays_text_p
,
18112 row
->ends_in_middle_of_char_p
,
18113 row
->starts_in_middle_of_char_p
,
18119 row
->visible_height
,
18122 fprintf (stderr
, "%9"pD
"d %5"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18123 row
->end
.overlay_string_index
,
18124 row
->continuation_lines_width
);
18125 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
18126 CHARPOS (row
->start
.string_pos
),
18127 CHARPOS (row
->end
.string_pos
));
18128 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
18129 row
->end
.dpvec_index
);
18136 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18138 struct glyph
*glyph
= row
->glyphs
[area
];
18139 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18141 /* Glyph for a line end in text. */
18142 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18145 if (glyph
< glyph_end
)
18146 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
18148 for (; glyph
< glyph_end
; ++glyph
)
18149 dump_glyph (row
, glyph
, area
);
18152 else if (glyphs
== 1)
18156 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18158 char *s
= alloca (row
->used
[area
] + 1);
18161 for (i
= 0; i
< row
->used
[area
]; ++i
)
18163 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18164 if (glyph
->type
== CHAR_GLYPH
18165 && glyph
->u
.ch
< 0x80
18166 && glyph
->u
.ch
>= ' ')
18167 s
[i
] = glyph
->u
.ch
;
18173 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18179 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18180 Sdump_glyph_matrix
, 0, 1, "p",
18181 doc
: /* Dump the current matrix of the selected window to stderr.
18182 Shows contents of glyph row structures. With non-nil
18183 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18184 glyphs in short form, otherwise show glyphs in long form. */)
18185 (Lisp_Object glyphs
)
18187 struct window
*w
= XWINDOW (selected_window
);
18188 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18190 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18191 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18192 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18193 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18194 fprintf (stderr
, "=============================================\n");
18195 dump_glyph_matrix (w
->current_matrix
,
18196 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18201 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18202 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18205 struct frame
*f
= XFRAME (selected_frame
);
18206 dump_glyph_matrix (f
->current_matrix
, 1);
18211 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18212 doc
: /* Dump glyph row ROW to stderr.
18213 GLYPH 0 means don't dump glyphs.
18214 GLYPH 1 means dump glyphs in short form.
18215 GLYPH > 1 or omitted means dump glyphs in long form. */)
18216 (Lisp_Object row
, Lisp_Object glyphs
)
18218 struct glyph_matrix
*matrix
;
18221 CHECK_NUMBER (row
);
18222 matrix
= XWINDOW (selected_window
)->current_matrix
;
18224 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18225 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18227 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18232 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18233 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18234 GLYPH 0 means don't dump glyphs.
18235 GLYPH 1 means dump glyphs in short form.
18236 GLYPH > 1 or omitted means dump glyphs in long form. */)
18237 (Lisp_Object row
, Lisp_Object glyphs
)
18239 struct frame
*sf
= SELECTED_FRAME ();
18240 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18243 CHECK_NUMBER (row
);
18245 if (vpos
>= 0 && vpos
< m
->nrows
)
18246 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18247 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18252 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18253 doc
: /* Toggle tracing of redisplay.
18254 With ARG, turn tracing on if and only if ARG is positive. */)
18258 trace_redisplay_p
= !trace_redisplay_p
;
18261 arg
= Fprefix_numeric_value (arg
);
18262 trace_redisplay_p
= XINT (arg
) > 0;
18269 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18270 doc
: /* Like `format', but print result to stderr.
18271 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18272 (ptrdiff_t nargs
, Lisp_Object
*args
)
18274 Lisp_Object s
= Fformat (nargs
, args
);
18275 fprintf (stderr
, "%s", SDATA (s
));
18279 #endif /* GLYPH_DEBUG */
18283 /***********************************************************************
18284 Building Desired Matrix Rows
18285 ***********************************************************************/
18287 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18288 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18290 static struct glyph_row
*
18291 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18293 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18294 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18295 struct buffer
*old
= current_buffer
;
18296 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18297 int arrow_len
= SCHARS (overlay_arrow_string
);
18298 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18299 const unsigned char *p
;
18302 int n_glyphs_before
;
18304 set_buffer_temp (buffer
);
18305 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18306 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18307 SET_TEXT_POS (it
.position
, 0, 0);
18309 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18311 while (p
< arrow_end
)
18313 Lisp_Object face
, ilisp
;
18315 /* Get the next character. */
18317 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18320 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18321 if (! ASCII_CHAR_P (it
.c
))
18322 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18326 /* Get its face. */
18327 ilisp
= make_number (p
- arrow_string
);
18328 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18329 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18331 /* Compute its width, get its glyphs. */
18332 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18333 SET_TEXT_POS (it
.position
, -1, -1);
18334 PRODUCE_GLYPHS (&it
);
18336 /* If this character doesn't fit any more in the line, we have
18337 to remove some glyphs. */
18338 if (it
.current_x
> it
.last_visible_x
)
18340 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18345 set_buffer_temp (old
);
18346 return it
.glyph_row
;
18350 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18351 glyphs to insert is determined by produce_special_glyphs. */
18354 insert_left_trunc_glyphs (struct it
*it
)
18356 struct it truncate_it
;
18357 struct glyph
*from
, *end
, *to
, *toend
;
18359 eassert (!FRAME_WINDOW_P (it
->f
)
18360 || (!it
->glyph_row
->reversed_p
18361 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18362 || (it
->glyph_row
->reversed_p
18363 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18365 /* Get the truncation glyphs. */
18367 truncate_it
.current_x
= 0;
18368 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18369 truncate_it
.glyph_row
= &scratch_glyph_row
;
18370 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18371 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18372 truncate_it
.object
= make_number (0);
18373 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18375 /* Overwrite glyphs from IT with truncation glyphs. */
18376 if (!it
->glyph_row
->reversed_p
)
18378 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18380 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18381 end
= from
+ tused
;
18382 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18383 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18384 if (FRAME_WINDOW_P (it
->f
))
18386 /* On GUI frames, when variable-size fonts are displayed,
18387 the truncation glyphs may need more pixels than the row's
18388 glyphs they overwrite. We overwrite more glyphs to free
18389 enough screen real estate, and enlarge the stretch glyph
18390 on the right (see display_line), if there is one, to
18391 preserve the screen position of the truncation glyphs on
18394 struct glyph
*g
= to
;
18397 /* The first glyph could be partially visible, in which case
18398 it->glyph_row->x will be negative. But we want the left
18399 truncation glyphs to be aligned at the left margin of the
18400 window, so we override the x coordinate at which the row
18402 it
->glyph_row
->x
= 0;
18403 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18405 w
+= g
->pixel_width
;
18408 if (g
- to
- tused
> 0)
18410 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18411 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18413 used
= it
->glyph_row
->used
[TEXT_AREA
];
18414 if (it
->glyph_row
->truncated_on_right_p
18415 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18416 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18419 int extra
= w
- it
->truncation_pixel_width
;
18421 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18428 /* There may be padding glyphs left over. Overwrite them too. */
18429 if (!FRAME_WINDOW_P (it
->f
))
18431 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18433 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18440 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18444 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18446 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18447 that back to front. */
18448 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18449 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18450 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18451 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18452 if (FRAME_WINDOW_P (it
->f
))
18455 struct glyph
*g
= to
;
18457 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18459 w
+= g
->pixel_width
;
18462 if (to
- g
- tused
> 0)
18464 if (it
->glyph_row
->truncated_on_right_p
18465 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18466 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18468 int extra
= w
- it
->truncation_pixel_width
;
18470 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18474 while (from
>= end
&& to
>= toend
)
18476 if (!FRAME_WINDOW_P (it
->f
))
18478 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18481 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18482 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18483 while (from
>= end
&& to
>= toend
)
18489 /* Need to free some room before prepending additional
18491 int move_by
= from
- end
+ 1;
18492 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18493 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18495 for ( ; g
>= g0
; g
--)
18497 while (from
>= end
)
18499 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18504 /* Compute the hash code for ROW. */
18506 row_hash (struct glyph_row
*row
)
18509 unsigned hashval
= 0;
18511 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18512 for (k
= 0; k
< row
->used
[area
]; ++k
)
18513 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18514 + row
->glyphs
[area
][k
].u
.val
18515 + row
->glyphs
[area
][k
].face_id
18516 + row
->glyphs
[area
][k
].padding_p
18517 + (row
->glyphs
[area
][k
].type
<< 2));
18522 /* Compute the pixel height and width of IT->glyph_row.
18524 Most of the time, ascent and height of a display line will be equal
18525 to the max_ascent and max_height values of the display iterator
18526 structure. This is not the case if
18528 1. We hit ZV without displaying anything. In this case, max_ascent
18529 and max_height will be zero.
18531 2. We have some glyphs that don't contribute to the line height.
18532 (The glyph row flag contributes_to_line_height_p is for future
18533 pixmap extensions).
18535 The first case is easily covered by using default values because in
18536 these cases, the line height does not really matter, except that it
18537 must not be zero. */
18540 compute_line_metrics (struct it
*it
)
18542 struct glyph_row
*row
= it
->glyph_row
;
18544 if (FRAME_WINDOW_P (it
->f
))
18546 int i
, min_y
, max_y
;
18548 /* The line may consist of one space only, that was added to
18549 place the cursor on it. If so, the row's height hasn't been
18551 if (row
->height
== 0)
18553 if (it
->max_ascent
+ it
->max_descent
== 0)
18554 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18555 row
->ascent
= it
->max_ascent
;
18556 row
->height
= it
->max_ascent
+ it
->max_descent
;
18557 row
->phys_ascent
= it
->max_phys_ascent
;
18558 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18559 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18562 /* Compute the width of this line. */
18563 row
->pixel_width
= row
->x
;
18564 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18565 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18567 eassert (row
->pixel_width
>= 0);
18568 eassert (row
->ascent
>= 0 && row
->height
> 0);
18570 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18571 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18573 /* If first line's physical ascent is larger than its logical
18574 ascent, use the physical ascent, and make the row taller.
18575 This makes accented characters fully visible. */
18576 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18577 && row
->phys_ascent
> row
->ascent
)
18579 row
->height
+= row
->phys_ascent
- row
->ascent
;
18580 row
->ascent
= row
->phys_ascent
;
18583 /* Compute how much of the line is visible. */
18584 row
->visible_height
= row
->height
;
18586 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18587 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18589 if (row
->y
< min_y
)
18590 row
->visible_height
-= min_y
- row
->y
;
18591 if (row
->y
+ row
->height
> max_y
)
18592 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18596 row
->pixel_width
= row
->used
[TEXT_AREA
];
18597 if (row
->continued_p
)
18598 row
->pixel_width
-= it
->continuation_pixel_width
;
18599 else if (row
->truncated_on_right_p
)
18600 row
->pixel_width
-= it
->truncation_pixel_width
;
18601 row
->ascent
= row
->phys_ascent
= 0;
18602 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18603 row
->extra_line_spacing
= 0;
18606 /* Compute a hash code for this row. */
18607 row
->hash
= row_hash (row
);
18609 it
->max_ascent
= it
->max_descent
= 0;
18610 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18614 /* Append one space to the glyph row of iterator IT if doing a
18615 window-based redisplay. The space has the same face as
18616 IT->face_id. Value is non-zero if a space was added.
18618 This function is called to make sure that there is always one glyph
18619 at the end of a glyph row that the cursor can be set on under
18620 window-systems. (If there weren't such a glyph we would not know
18621 how wide and tall a box cursor should be displayed).
18623 At the same time this space let's a nicely handle clearing to the
18624 end of the line if the row ends in italic text. */
18627 append_space_for_newline (struct it
*it
, int default_face_p
)
18629 if (FRAME_WINDOW_P (it
->f
))
18631 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18633 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18634 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18636 /* Save some values that must not be changed.
18637 Must save IT->c and IT->len because otherwise
18638 ITERATOR_AT_END_P wouldn't work anymore after
18639 append_space_for_newline has been called. */
18640 enum display_element_type saved_what
= it
->what
;
18641 int saved_c
= it
->c
, saved_len
= it
->len
;
18642 int saved_char_to_display
= it
->char_to_display
;
18643 int saved_x
= it
->current_x
;
18644 int saved_face_id
= it
->face_id
;
18645 struct text_pos saved_pos
;
18646 Lisp_Object saved_object
;
18649 saved_object
= it
->object
;
18650 saved_pos
= it
->position
;
18652 it
->what
= IT_CHARACTER
;
18653 memset (&it
->position
, 0, sizeof it
->position
);
18654 it
->object
= make_number (0);
18655 it
->c
= it
->char_to_display
= ' ';
18658 /* If the default face was remapped, be sure to use the
18659 remapped face for the appended newline. */
18660 if (default_face_p
)
18661 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18662 else if (it
->face_before_selective_p
)
18663 it
->face_id
= it
->saved_face_id
;
18664 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18665 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18667 PRODUCE_GLYPHS (it
);
18669 it
->override_ascent
= -1;
18670 it
->constrain_row_ascent_descent_p
= 0;
18671 it
->current_x
= saved_x
;
18672 it
->object
= saved_object
;
18673 it
->position
= saved_pos
;
18674 it
->what
= saved_what
;
18675 it
->face_id
= saved_face_id
;
18676 it
->len
= saved_len
;
18678 it
->char_to_display
= saved_char_to_display
;
18687 /* Extend the face of the last glyph in the text area of IT->glyph_row
18688 to the end of the display line. Called from display_line. If the
18689 glyph row is empty, add a space glyph to it so that we know the
18690 face to draw. Set the glyph row flag fill_line_p. If the glyph
18691 row is R2L, prepend a stretch glyph to cover the empty space to the
18692 left of the leftmost glyph. */
18695 extend_face_to_end_of_line (struct it
*it
)
18697 struct face
*face
, *default_face
;
18698 struct frame
*f
= it
->f
;
18700 /* If line is already filled, do nothing. Non window-system frames
18701 get a grace of one more ``pixel'' because their characters are
18702 1-``pixel'' wide, so they hit the equality too early. This grace
18703 is needed only for R2L rows that are not continued, to produce
18704 one extra blank where we could display the cursor. */
18705 if (it
->current_x
>= it
->last_visible_x
18706 + (!FRAME_WINDOW_P (f
)
18707 && it
->glyph_row
->reversed_p
18708 && !it
->glyph_row
->continued_p
))
18711 /* The default face, possibly remapped. */
18712 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18714 /* Face extension extends the background and box of IT->face_id
18715 to the end of the line. If the background equals the background
18716 of the frame, we don't have to do anything. */
18717 if (it
->face_before_selective_p
)
18718 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18720 face
= FACE_FROM_ID (f
, it
->face_id
);
18722 if (FRAME_WINDOW_P (f
)
18723 && it
->glyph_row
->displays_text_p
18724 && face
->box
== FACE_NO_BOX
18725 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18727 && !it
->glyph_row
->reversed_p
)
18730 /* Set the glyph row flag indicating that the face of the last glyph
18731 in the text area has to be drawn to the end of the text area. */
18732 it
->glyph_row
->fill_line_p
= 1;
18734 /* If current character of IT is not ASCII, make sure we have the
18735 ASCII face. This will be automatically undone the next time
18736 get_next_display_element returns a multibyte character. Note
18737 that the character will always be single byte in unibyte
18739 if (!ASCII_CHAR_P (it
->c
))
18741 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18744 if (FRAME_WINDOW_P (f
))
18746 /* If the row is empty, add a space with the current face of IT,
18747 so that we know which face to draw. */
18748 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18750 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18751 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18752 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18754 #ifdef HAVE_WINDOW_SYSTEM
18755 if (it
->glyph_row
->reversed_p
)
18757 /* Prepend a stretch glyph to the row, such that the
18758 rightmost glyph will be drawn flushed all the way to the
18759 right margin of the window. The stretch glyph that will
18760 occupy the empty space, if any, to the left of the
18762 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18763 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18764 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18766 int row_width
, stretch_ascent
, stretch_width
;
18767 struct text_pos saved_pos
;
18768 int saved_face_id
, saved_avoid_cursor
;
18770 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18771 row_width
+= g
->pixel_width
;
18772 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18773 if (stretch_width
> 0)
18776 (((it
->ascent
+ it
->descent
)
18777 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18778 saved_pos
= it
->position
;
18779 memset (&it
->position
, 0, sizeof it
->position
);
18780 saved_avoid_cursor
= it
->avoid_cursor_p
;
18781 it
->avoid_cursor_p
= 1;
18782 saved_face_id
= it
->face_id
;
18783 /* The last row's stretch glyph should get the default
18784 face, to avoid painting the rest of the window with
18785 the region face, if the region ends at ZV. */
18786 if (it
->glyph_row
->ends_at_zv_p
)
18787 it
->face_id
= default_face
->id
;
18789 it
->face_id
= face
->id
;
18790 append_stretch_glyph (it
, make_number (0), stretch_width
,
18791 it
->ascent
+ it
->descent
, stretch_ascent
);
18792 it
->position
= saved_pos
;
18793 it
->avoid_cursor_p
= saved_avoid_cursor
;
18794 it
->face_id
= saved_face_id
;
18797 #endif /* HAVE_WINDOW_SYSTEM */
18801 /* Save some values that must not be changed. */
18802 int saved_x
= it
->current_x
;
18803 struct text_pos saved_pos
;
18804 Lisp_Object saved_object
;
18805 enum display_element_type saved_what
= it
->what
;
18806 int saved_face_id
= it
->face_id
;
18808 saved_object
= it
->object
;
18809 saved_pos
= it
->position
;
18811 it
->what
= IT_CHARACTER
;
18812 memset (&it
->position
, 0, sizeof it
->position
);
18813 it
->object
= make_number (0);
18814 it
->c
= it
->char_to_display
= ' ';
18816 /* The last row's blank glyphs should get the default face, to
18817 avoid painting the rest of the window with the region face,
18818 if the region ends at ZV. */
18819 if (it
->glyph_row
->ends_at_zv_p
)
18820 it
->face_id
= default_face
->id
;
18822 it
->face_id
= face
->id
;
18824 PRODUCE_GLYPHS (it
);
18826 while (it
->current_x
<= it
->last_visible_x
)
18827 PRODUCE_GLYPHS (it
);
18829 /* Don't count these blanks really. It would let us insert a left
18830 truncation glyph below and make us set the cursor on them, maybe. */
18831 it
->current_x
= saved_x
;
18832 it
->object
= saved_object
;
18833 it
->position
= saved_pos
;
18834 it
->what
= saved_what
;
18835 it
->face_id
= saved_face_id
;
18840 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18841 trailing whitespace. */
18844 trailing_whitespace_p (ptrdiff_t charpos
)
18846 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18849 while (bytepos
< ZV_BYTE
18850 && (c
= FETCH_CHAR (bytepos
),
18851 c
== ' ' || c
== '\t'))
18854 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18856 if (bytepos
!= PT_BYTE
)
18863 /* Highlight trailing whitespace, if any, in ROW. */
18866 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18868 int used
= row
->used
[TEXT_AREA
];
18872 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18873 struct glyph
*glyph
= start
+ used
- 1;
18875 if (row
->reversed_p
)
18877 /* Right-to-left rows need to be processed in the opposite
18878 direction, so swap the edge pointers. */
18880 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18883 /* Skip over glyphs inserted to display the cursor at the
18884 end of a line, for extending the face of the last glyph
18885 to the end of the line on terminals, and for truncation
18886 and continuation glyphs. */
18887 if (!row
->reversed_p
)
18889 while (glyph
>= start
18890 && glyph
->type
== CHAR_GLYPH
18891 && INTEGERP (glyph
->object
))
18896 while (glyph
<= start
18897 && glyph
->type
== CHAR_GLYPH
18898 && INTEGERP (glyph
->object
))
18902 /* If last glyph is a space or stretch, and it's trailing
18903 whitespace, set the face of all trailing whitespace glyphs in
18904 IT->glyph_row to `trailing-whitespace'. */
18905 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18906 && BUFFERP (glyph
->object
)
18907 && (glyph
->type
== STRETCH_GLYPH
18908 || (glyph
->type
== CHAR_GLYPH
18909 && glyph
->u
.ch
== ' '))
18910 && trailing_whitespace_p (glyph
->charpos
))
18912 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18916 if (!row
->reversed_p
)
18918 while (glyph
>= start
18919 && BUFFERP (glyph
->object
)
18920 && (glyph
->type
== STRETCH_GLYPH
18921 || (glyph
->type
== CHAR_GLYPH
18922 && glyph
->u
.ch
== ' ')))
18923 (glyph
--)->face_id
= face_id
;
18927 while (glyph
<= start
18928 && BUFFERP (glyph
->object
)
18929 && (glyph
->type
== STRETCH_GLYPH
18930 || (glyph
->type
== CHAR_GLYPH
18931 && glyph
->u
.ch
== ' ')))
18932 (glyph
++)->face_id
= face_id
;
18939 /* Value is non-zero if glyph row ROW should be
18940 used to hold the cursor. */
18943 cursor_row_p (struct glyph_row
*row
)
18947 if (PT
== CHARPOS (row
->end
.pos
)
18948 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18950 /* Suppose the row ends on a string.
18951 Unless the row is continued, that means it ends on a newline
18952 in the string. If it's anything other than a display string
18953 (e.g., a before-string from an overlay), we don't want the
18954 cursor there. (This heuristic seems to give the optimal
18955 behavior for the various types of multi-line strings.)
18956 One exception: if the string has `cursor' property on one of
18957 its characters, we _do_ want the cursor there. */
18958 if (CHARPOS (row
->end
.string_pos
) >= 0)
18960 if (row
->continued_p
)
18964 /* Check for `display' property. */
18965 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18966 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18967 struct glyph
*glyph
;
18970 for (glyph
= end
; glyph
>= beg
; --glyph
)
18971 if (STRINGP (glyph
->object
))
18974 = Fget_char_property (make_number (PT
),
18978 && display_prop_string_p (prop
, glyph
->object
));
18979 /* If there's a `cursor' property on one of the
18980 string's characters, this row is a cursor row,
18981 even though this is not a display string. */
18984 Lisp_Object s
= glyph
->object
;
18986 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18988 ptrdiff_t gpos
= glyph
->charpos
;
18990 if (!NILP (Fget_char_property (make_number (gpos
),
19002 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19004 /* If the row ends in middle of a real character,
19005 and the line is continued, we want the cursor here.
19006 That's because CHARPOS (ROW->end.pos) would equal
19007 PT if PT is before the character. */
19008 if (!row
->ends_in_ellipsis_p
)
19009 result
= row
->continued_p
;
19011 /* If the row ends in an ellipsis, then
19012 CHARPOS (ROW->end.pos) will equal point after the
19013 invisible text. We want that position to be displayed
19014 after the ellipsis. */
19017 /* If the row ends at ZV, display the cursor at the end of that
19018 row instead of at the start of the row below. */
19019 else if (row
->ends_at_zv_p
)
19030 /* Push the property PROP so that it will be rendered at the current
19031 position in IT. Return 1 if PROP was successfully pushed, 0
19032 otherwise. Called from handle_line_prefix to handle the
19033 `line-prefix' and `wrap-prefix' properties. */
19036 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19038 struct text_pos pos
=
19039 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19041 eassert (it
->method
== GET_FROM_BUFFER
19042 || it
->method
== GET_FROM_DISPLAY_VECTOR
19043 || it
->method
== GET_FROM_STRING
);
19045 /* We need to save the current buffer/string position, so it will be
19046 restored by pop_it, because iterate_out_of_display_property
19047 depends on that being set correctly, but some situations leave
19048 it->position not yet set when this function is called. */
19049 push_it (it
, &pos
);
19051 if (STRINGP (prop
))
19053 if (SCHARS (prop
) == 0)
19060 it
->string_from_prefix_prop_p
= 1;
19061 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19062 it
->current
.overlay_string_index
= -1;
19063 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19064 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19065 it
->method
= GET_FROM_STRING
;
19066 it
->stop_charpos
= 0;
19068 it
->base_level_stop
= 0;
19070 /* Force paragraph direction to be that of the parent
19072 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19073 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19075 it
->paragraph_embedding
= L2R
;
19077 /* Set up the bidi iterator for this display string. */
19080 it
->bidi_it
.string
.lstring
= it
->string
;
19081 it
->bidi_it
.string
.s
= NULL
;
19082 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19083 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19084 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19085 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19086 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19089 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19091 it
->method
= GET_FROM_STRETCH
;
19094 #ifdef HAVE_WINDOW_SYSTEM
19095 else if (IMAGEP (prop
))
19097 it
->what
= IT_IMAGE
;
19098 it
->image_id
= lookup_image (it
->f
, prop
);
19099 it
->method
= GET_FROM_IMAGE
;
19101 #endif /* HAVE_WINDOW_SYSTEM */
19104 pop_it (it
); /* bogus display property, give up */
19111 /* Return the character-property PROP at the current position in IT. */
19114 get_it_property (struct it
*it
, Lisp_Object prop
)
19116 Lisp_Object position
;
19118 if (STRINGP (it
->object
))
19119 position
= make_number (IT_STRING_CHARPOS (*it
));
19120 else if (BUFFERP (it
->object
))
19121 position
= make_number (IT_CHARPOS (*it
));
19125 return Fget_char_property (position
, prop
, it
->object
);
19128 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19131 handle_line_prefix (struct it
*it
)
19133 Lisp_Object prefix
;
19135 if (it
->continuation_lines_width
> 0)
19137 prefix
= get_it_property (it
, Qwrap_prefix
);
19139 prefix
= Vwrap_prefix
;
19143 prefix
= get_it_property (it
, Qline_prefix
);
19145 prefix
= Vline_prefix
;
19147 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19149 /* If the prefix is wider than the window, and we try to wrap
19150 it, it would acquire its own wrap prefix, and so on till the
19151 iterator stack overflows. So, don't wrap the prefix. */
19152 it
->line_wrap
= TRUNCATE
;
19153 it
->avoid_cursor_p
= 1;
19159 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19160 only for R2L lines from display_line and display_string, when they
19161 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19162 the line/string needs to be continued on the next glyph row. */
19164 unproduce_glyphs (struct it
*it
, int n
)
19166 struct glyph
*glyph
, *end
;
19168 eassert (it
->glyph_row
);
19169 eassert (it
->glyph_row
->reversed_p
);
19170 eassert (it
->area
== TEXT_AREA
);
19171 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19173 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19174 n
= it
->glyph_row
->used
[TEXT_AREA
];
19175 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19176 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19177 for ( ; glyph
< end
; glyph
++)
19178 glyph
[-n
] = *glyph
;
19181 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19182 and ROW->maxpos. */
19184 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19185 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19186 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19188 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19189 lines' rows is implemented for bidi-reordered rows. */
19191 /* ROW->minpos is the value of min_pos, the minimal buffer position
19192 we have in ROW, or ROW->start.pos if that is smaller. */
19193 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19194 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19196 /* We didn't find buffer positions smaller than ROW->start, or
19197 didn't find _any_ valid buffer positions in any of the glyphs,
19198 so we must trust the iterator's computed positions. */
19199 row
->minpos
= row
->start
.pos
;
19202 max_pos
= CHARPOS (it
->current
.pos
);
19203 max_bpos
= BYTEPOS (it
->current
.pos
);
19206 /* Here are the various use-cases for ending the row, and the
19207 corresponding values for ROW->maxpos:
19209 Line ends in a newline from buffer eol_pos + 1
19210 Line is continued from buffer max_pos + 1
19211 Line is truncated on right it->current.pos
19212 Line ends in a newline from string max_pos + 1(*)
19213 (*) + 1 only when line ends in a forward scan
19214 Line is continued from string max_pos
19215 Line is continued from display vector max_pos
19216 Line is entirely from a string min_pos == max_pos
19217 Line is entirely from a display vector min_pos == max_pos
19218 Line that ends at ZV ZV
19220 If you discover other use-cases, please add them here as
19222 if (row
->ends_at_zv_p
)
19223 row
->maxpos
= it
->current
.pos
;
19224 else if (row
->used
[TEXT_AREA
])
19226 int seen_this_string
= 0;
19227 struct glyph_row
*r1
= row
- 1;
19229 /* Did we see the same display string on the previous row? */
19230 if (STRINGP (it
->object
)
19231 /* this is not the first row */
19232 && row
> it
->w
->desired_matrix
->rows
19233 /* previous row is not the header line */
19234 && !r1
->mode_line_p
19235 /* previous row also ends in a newline from a string */
19236 && r1
->ends_in_newline_from_string_p
)
19238 struct glyph
*start
, *end
;
19240 /* Search for the last glyph of the previous row that came
19241 from buffer or string. Depending on whether the row is
19242 L2R or R2L, we need to process it front to back or the
19243 other way round. */
19244 if (!r1
->reversed_p
)
19246 start
= r1
->glyphs
[TEXT_AREA
];
19247 end
= start
+ r1
->used
[TEXT_AREA
];
19248 /* Glyphs inserted by redisplay have an integer (zero)
19249 as their object. */
19251 && INTEGERP ((end
- 1)->object
)
19252 && (end
- 1)->charpos
<= 0)
19256 if (EQ ((end
- 1)->object
, it
->object
))
19257 seen_this_string
= 1;
19260 /* If all the glyphs of the previous row were inserted
19261 by redisplay, it means the previous row was
19262 produced from a single newline, which is only
19263 possible if that newline came from the same string
19264 as the one which produced this ROW. */
19265 seen_this_string
= 1;
19269 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19270 start
= end
+ r1
->used
[TEXT_AREA
];
19272 && INTEGERP ((end
+ 1)->object
)
19273 && (end
+ 1)->charpos
<= 0)
19277 if (EQ ((end
+ 1)->object
, it
->object
))
19278 seen_this_string
= 1;
19281 seen_this_string
= 1;
19284 /* Take note of each display string that covers a newline only
19285 once, the first time we see it. This is for when a display
19286 string includes more than one newline in it. */
19287 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19289 /* If we were scanning the buffer forward when we displayed
19290 the string, we want to account for at least one buffer
19291 position that belongs to this row (position covered by
19292 the display string), so that cursor positioning will
19293 consider this row as a candidate when point is at the end
19294 of the visual line represented by this row. This is not
19295 required when scanning back, because max_pos will already
19296 have a much larger value. */
19297 if (CHARPOS (row
->end
.pos
) > max_pos
)
19298 INC_BOTH (max_pos
, max_bpos
);
19299 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19301 else if (CHARPOS (it
->eol_pos
) > 0)
19302 SET_TEXT_POS (row
->maxpos
,
19303 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19304 else if (row
->continued_p
)
19306 /* If max_pos is different from IT's current position, it
19307 means IT->method does not belong to the display element
19308 at max_pos. However, it also means that the display
19309 element at max_pos was displayed in its entirety on this
19310 line, which is equivalent to saying that the next line
19311 starts at the next buffer position. */
19312 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19313 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19316 INC_BOTH (max_pos
, max_bpos
);
19317 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19320 else if (row
->truncated_on_right_p
)
19321 /* display_line already called reseat_at_next_visible_line_start,
19322 which puts the iterator at the beginning of the next line, in
19323 the logical order. */
19324 row
->maxpos
= it
->current
.pos
;
19325 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19326 /* A line that is entirely from a string/image/stretch... */
19327 row
->maxpos
= row
->minpos
;
19332 row
->maxpos
= it
->current
.pos
;
19335 /* Construct the glyph row IT->glyph_row in the desired matrix of
19336 IT->w from text at the current position of IT. See dispextern.h
19337 for an overview of struct it. Value is non-zero if
19338 IT->glyph_row displays text, as opposed to a line displaying ZV
19342 display_line (struct it
*it
)
19344 struct glyph_row
*row
= it
->glyph_row
;
19345 Lisp_Object overlay_arrow_string
;
19347 void *wrap_data
= NULL
;
19348 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19349 int wrap_row_used
= -1;
19350 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19351 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19352 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19353 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19354 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19356 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19357 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19359 /* We always start displaying at hpos zero even if hscrolled. */
19360 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19362 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19363 >= it
->w
->desired_matrix
->nrows
)
19365 it
->w
->nrows_scale_factor
++;
19366 fonts_changed_p
= 1;
19370 /* Is IT->w showing the region? */
19371 wset_region_showing (it
->w
, it
->region_beg_charpos
> 0 ? Qt
: Qnil
);
19373 /* Clear the result glyph row and enable it. */
19374 prepare_desired_row (row
);
19376 row
->y
= it
->current_y
;
19377 row
->start
= it
->start
;
19378 row
->continuation_lines_width
= it
->continuation_lines_width
;
19379 row
->displays_text_p
= 1;
19380 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19381 it
->starts_in_middle_of_char_p
= 0;
19383 /* Arrange the overlays nicely for our purposes. Usually, we call
19384 display_line on only one line at a time, in which case this
19385 can't really hurt too much, or we call it on lines which appear
19386 one after another in the buffer, in which case all calls to
19387 recenter_overlay_lists but the first will be pretty cheap. */
19388 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19390 /* Move over display elements that are not visible because we are
19391 hscrolled. This may stop at an x-position < IT->first_visible_x
19392 if the first glyph is partially visible or if we hit a line end. */
19393 if (it
->current_x
< it
->first_visible_x
)
19395 enum move_it_result move_result
;
19397 this_line_min_pos
= row
->start
.pos
;
19398 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19399 MOVE_TO_POS
| MOVE_TO_X
);
19400 /* If we are under a large hscroll, move_it_in_display_line_to
19401 could hit the end of the line without reaching
19402 it->first_visible_x. Pretend that we did reach it. This is
19403 especially important on a TTY, where we will call
19404 extend_face_to_end_of_line, which needs to know how many
19405 blank glyphs to produce. */
19406 if (it
->current_x
< it
->first_visible_x
19407 && (move_result
== MOVE_NEWLINE_OR_CR
19408 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19409 it
->current_x
= it
->first_visible_x
;
19411 /* Record the smallest positions seen while we moved over
19412 display elements that are not visible. This is needed by
19413 redisplay_internal for optimizing the case where the cursor
19414 stays inside the same line. The rest of this function only
19415 considers positions that are actually displayed, so
19416 RECORD_MAX_MIN_POS will not otherwise record positions that
19417 are hscrolled to the left of the left edge of the window. */
19418 min_pos
= CHARPOS (this_line_min_pos
);
19419 min_bpos
= BYTEPOS (this_line_min_pos
);
19423 /* We only do this when not calling `move_it_in_display_line_to'
19424 above, because move_it_in_display_line_to calls
19425 handle_line_prefix itself. */
19426 handle_line_prefix (it
);
19429 /* Get the initial row height. This is either the height of the
19430 text hscrolled, if there is any, or zero. */
19431 row
->ascent
= it
->max_ascent
;
19432 row
->height
= it
->max_ascent
+ it
->max_descent
;
19433 row
->phys_ascent
= it
->max_phys_ascent
;
19434 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19435 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19437 /* Utility macro to record max and min buffer positions seen until now. */
19438 #define RECORD_MAX_MIN_POS(IT) \
19441 int composition_p = !STRINGP ((IT)->string) \
19442 && ((IT)->what == IT_COMPOSITION); \
19443 ptrdiff_t current_pos = \
19444 composition_p ? (IT)->cmp_it.charpos \
19445 : IT_CHARPOS (*(IT)); \
19446 ptrdiff_t current_bpos = \
19447 composition_p ? CHAR_TO_BYTE (current_pos) \
19448 : IT_BYTEPOS (*(IT)); \
19449 if (current_pos < min_pos) \
19451 min_pos = current_pos; \
19452 min_bpos = current_bpos; \
19454 if (IT_CHARPOS (*it) > max_pos) \
19456 max_pos = IT_CHARPOS (*it); \
19457 max_bpos = IT_BYTEPOS (*it); \
19462 /* Loop generating characters. The loop is left with IT on the next
19463 character to display. */
19466 int n_glyphs_before
, hpos_before
, x_before
;
19468 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19470 /* Retrieve the next thing to display. Value is zero if end of
19472 if (!get_next_display_element (it
))
19474 /* Maybe add a space at the end of this line that is used to
19475 display the cursor there under X. Set the charpos of the
19476 first glyph of blank lines not corresponding to any text
19478 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19479 row
->exact_window_width_line_p
= 1;
19480 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19481 || row
->used
[TEXT_AREA
] == 0)
19483 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19484 row
->displays_text_p
= 0;
19486 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19487 && (!MINI_WINDOW_P (it
->w
)
19488 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19489 row
->indicate_empty_line_p
= 1;
19492 it
->continuation_lines_width
= 0;
19493 row
->ends_at_zv_p
= 1;
19494 /* A row that displays right-to-left text must always have
19495 its last face extended all the way to the end of line,
19496 even if this row ends in ZV, because we still write to
19497 the screen left to right. We also need to extend the
19498 last face if the default face is remapped to some
19499 different face, otherwise the functions that clear
19500 portions of the screen will clear with the default face's
19501 background color. */
19502 if (row
->reversed_p
19503 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19504 extend_face_to_end_of_line (it
);
19508 /* Now, get the metrics of what we want to display. This also
19509 generates glyphs in `row' (which is IT->glyph_row). */
19510 n_glyphs_before
= row
->used
[TEXT_AREA
];
19513 /* Remember the line height so far in case the next element doesn't
19514 fit on the line. */
19515 if (it
->line_wrap
!= TRUNCATE
)
19517 ascent
= it
->max_ascent
;
19518 descent
= it
->max_descent
;
19519 phys_ascent
= it
->max_phys_ascent
;
19520 phys_descent
= it
->max_phys_descent
;
19522 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19524 if (IT_DISPLAYING_WHITESPACE (it
))
19528 SAVE_IT (wrap_it
, *it
, wrap_data
);
19530 wrap_row_used
= row
->used
[TEXT_AREA
];
19531 wrap_row_ascent
= row
->ascent
;
19532 wrap_row_height
= row
->height
;
19533 wrap_row_phys_ascent
= row
->phys_ascent
;
19534 wrap_row_phys_height
= row
->phys_height
;
19535 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19536 wrap_row_min_pos
= min_pos
;
19537 wrap_row_min_bpos
= min_bpos
;
19538 wrap_row_max_pos
= max_pos
;
19539 wrap_row_max_bpos
= max_bpos
;
19545 PRODUCE_GLYPHS (it
);
19547 /* If this display element was in marginal areas, continue with
19549 if (it
->area
!= TEXT_AREA
)
19551 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19552 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19553 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19554 row
->phys_height
= max (row
->phys_height
,
19555 it
->max_phys_ascent
+ it
->max_phys_descent
);
19556 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19557 it
->max_extra_line_spacing
);
19558 set_iterator_to_next (it
, 1);
19562 /* Does the display element fit on the line? If we truncate
19563 lines, we should draw past the right edge of the window. If
19564 we don't truncate, we want to stop so that we can display the
19565 continuation glyph before the right margin. If lines are
19566 continued, there are two possible strategies for characters
19567 resulting in more than 1 glyph (e.g. tabs): Display as many
19568 glyphs as possible in this line and leave the rest for the
19569 continuation line, or display the whole element in the next
19570 line. Original redisplay did the former, so we do it also. */
19571 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19572 hpos_before
= it
->hpos
;
19575 if (/* Not a newline. */
19577 /* Glyphs produced fit entirely in the line. */
19578 && it
->current_x
< it
->last_visible_x
)
19580 it
->hpos
+= nglyphs
;
19581 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19582 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19583 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19584 row
->phys_height
= max (row
->phys_height
,
19585 it
->max_phys_ascent
+ it
->max_phys_descent
);
19586 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19587 it
->max_extra_line_spacing
);
19588 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19589 row
->x
= x
- it
->first_visible_x
;
19590 /* Record the maximum and minimum buffer positions seen so
19591 far in glyphs that will be displayed by this row. */
19593 RECORD_MAX_MIN_POS (it
);
19598 struct glyph
*glyph
;
19600 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19602 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19603 new_x
= x
+ glyph
->pixel_width
;
19605 if (/* Lines are continued. */
19606 it
->line_wrap
!= TRUNCATE
19607 && (/* Glyph doesn't fit on the line. */
19608 new_x
> it
->last_visible_x
19609 /* Or it fits exactly on a window system frame. */
19610 || (new_x
== it
->last_visible_x
19611 && FRAME_WINDOW_P (it
->f
)
19612 && (row
->reversed_p
19613 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19614 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19616 /* End of a continued line. */
19619 || (new_x
== it
->last_visible_x
19620 && FRAME_WINDOW_P (it
->f
)
19621 && (row
->reversed_p
19622 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19623 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19625 /* Current glyph is the only one on the line or
19626 fits exactly on the line. We must continue
19627 the line because we can't draw the cursor
19628 after the glyph. */
19629 row
->continued_p
= 1;
19630 it
->current_x
= new_x
;
19631 it
->continuation_lines_width
+= new_x
;
19633 if (i
== nglyphs
- 1)
19635 /* If line-wrap is on, check if a previous
19636 wrap point was found. */
19637 if (wrap_row_used
> 0
19638 /* Even if there is a previous wrap
19639 point, continue the line here as
19640 usual, if (i) the previous character
19641 was a space or tab AND (ii) the
19642 current character is not. */
19644 || IT_DISPLAYING_WHITESPACE (it
)))
19647 /* Record the maximum and minimum buffer
19648 positions seen so far in glyphs that will be
19649 displayed by this row. */
19651 RECORD_MAX_MIN_POS (it
);
19652 set_iterator_to_next (it
, 1);
19653 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19655 if (!get_next_display_element (it
))
19657 row
->exact_window_width_line_p
= 1;
19658 it
->continuation_lines_width
= 0;
19659 row
->continued_p
= 0;
19660 row
->ends_at_zv_p
= 1;
19662 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19664 row
->continued_p
= 0;
19665 row
->exact_window_width_line_p
= 1;
19669 else if (it
->bidi_p
)
19670 RECORD_MAX_MIN_POS (it
);
19672 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19673 && !FRAME_WINDOW_P (it
->f
))
19675 /* A padding glyph that doesn't fit on this line.
19676 This means the whole character doesn't fit
19678 if (row
->reversed_p
)
19679 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19680 - n_glyphs_before
);
19681 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19683 /* Fill the rest of the row with continuation
19684 glyphs like in 20.x. */
19685 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19686 < row
->glyphs
[1 + TEXT_AREA
])
19687 produce_special_glyphs (it
, IT_CONTINUATION
);
19689 row
->continued_p
= 1;
19690 it
->current_x
= x_before
;
19691 it
->continuation_lines_width
+= x_before
;
19693 /* Restore the height to what it was before the
19694 element not fitting on the line. */
19695 it
->max_ascent
= ascent
;
19696 it
->max_descent
= descent
;
19697 it
->max_phys_ascent
= phys_ascent
;
19698 it
->max_phys_descent
= phys_descent
;
19700 else if (wrap_row_used
> 0)
19703 if (row
->reversed_p
)
19704 unproduce_glyphs (it
,
19705 row
->used
[TEXT_AREA
] - wrap_row_used
);
19706 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19707 it
->continuation_lines_width
+= wrap_x
;
19708 row
->used
[TEXT_AREA
] = wrap_row_used
;
19709 row
->ascent
= wrap_row_ascent
;
19710 row
->height
= wrap_row_height
;
19711 row
->phys_ascent
= wrap_row_phys_ascent
;
19712 row
->phys_height
= wrap_row_phys_height
;
19713 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19714 min_pos
= wrap_row_min_pos
;
19715 min_bpos
= wrap_row_min_bpos
;
19716 max_pos
= wrap_row_max_pos
;
19717 max_bpos
= wrap_row_max_bpos
;
19718 row
->continued_p
= 1;
19719 row
->ends_at_zv_p
= 0;
19720 row
->exact_window_width_line_p
= 0;
19721 it
->continuation_lines_width
+= x
;
19723 /* Make sure that a non-default face is extended
19724 up to the right margin of the window. */
19725 extend_face_to_end_of_line (it
);
19727 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19729 /* A TAB that extends past the right edge of the
19730 window. This produces a single glyph on
19731 window system frames. We leave the glyph in
19732 this row and let it fill the row, but don't
19733 consume the TAB. */
19734 if ((row
->reversed_p
19735 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19736 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19737 produce_special_glyphs (it
, IT_CONTINUATION
);
19738 it
->continuation_lines_width
+= it
->last_visible_x
;
19739 row
->ends_in_middle_of_char_p
= 1;
19740 row
->continued_p
= 1;
19741 glyph
->pixel_width
= it
->last_visible_x
- x
;
19742 it
->starts_in_middle_of_char_p
= 1;
19746 /* Something other than a TAB that draws past
19747 the right edge of the window. Restore
19748 positions to values before the element. */
19749 if (row
->reversed_p
)
19750 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19751 - (n_glyphs_before
+ i
));
19752 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19754 /* Display continuation glyphs. */
19755 it
->current_x
= x_before
;
19756 it
->continuation_lines_width
+= x
;
19757 if (!FRAME_WINDOW_P (it
->f
)
19758 || (row
->reversed_p
19759 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19760 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19761 produce_special_glyphs (it
, IT_CONTINUATION
);
19762 row
->continued_p
= 1;
19764 extend_face_to_end_of_line (it
);
19766 if (nglyphs
> 1 && i
> 0)
19768 row
->ends_in_middle_of_char_p
= 1;
19769 it
->starts_in_middle_of_char_p
= 1;
19772 /* Restore the height to what it was before the
19773 element not fitting on the line. */
19774 it
->max_ascent
= ascent
;
19775 it
->max_descent
= descent
;
19776 it
->max_phys_ascent
= phys_ascent
;
19777 it
->max_phys_descent
= phys_descent
;
19782 else if (new_x
> it
->first_visible_x
)
19784 /* Increment number of glyphs actually displayed. */
19787 /* Record the maximum and minimum buffer positions
19788 seen so far in glyphs that will be displayed by
19791 RECORD_MAX_MIN_POS (it
);
19793 if (x
< it
->first_visible_x
)
19794 /* Glyph is partially visible, i.e. row starts at
19795 negative X position. */
19796 row
->x
= x
- it
->first_visible_x
;
19800 /* Glyph is completely off the left margin of the
19801 window. This should not happen because of the
19802 move_it_in_display_line at the start of this
19803 function, unless the text display area of the
19804 window is empty. */
19805 eassert (it
->first_visible_x
<= it
->last_visible_x
);
19808 /* Even if this display element produced no glyphs at all,
19809 we want to record its position. */
19810 if (it
->bidi_p
&& nglyphs
== 0)
19811 RECORD_MAX_MIN_POS (it
);
19813 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19814 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19815 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19816 row
->phys_height
= max (row
->phys_height
,
19817 it
->max_phys_ascent
+ it
->max_phys_descent
);
19818 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19819 it
->max_extra_line_spacing
);
19821 /* End of this display line if row is continued. */
19822 if (row
->continued_p
|| row
->ends_at_zv_p
)
19827 /* Is this a line end? If yes, we're also done, after making
19828 sure that a non-default face is extended up to the right
19829 margin of the window. */
19830 if (ITERATOR_AT_END_OF_LINE_P (it
))
19832 int used_before
= row
->used
[TEXT_AREA
];
19834 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19836 /* Add a space at the end of the line that is used to
19837 display the cursor there. */
19838 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19839 append_space_for_newline (it
, 0);
19841 /* Extend the face to the end of the line. */
19842 extend_face_to_end_of_line (it
);
19844 /* Make sure we have the position. */
19845 if (used_before
== 0)
19846 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19848 /* Record the position of the newline, for use in
19850 it
->eol_pos
= it
->current
.pos
;
19852 /* Consume the line end. This skips over invisible lines. */
19853 set_iterator_to_next (it
, 1);
19854 it
->continuation_lines_width
= 0;
19858 /* Proceed with next display element. Note that this skips
19859 over lines invisible because of selective display. */
19860 set_iterator_to_next (it
, 1);
19862 /* If we truncate lines, we are done when the last displayed
19863 glyphs reach past the right margin of the window. */
19864 if (it
->line_wrap
== TRUNCATE
19865 && (FRAME_WINDOW_P (it
->f
) && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19866 ? (it
->current_x
>= it
->last_visible_x
)
19867 : (it
->current_x
> it
->last_visible_x
)))
19869 /* Maybe add truncation glyphs. */
19870 if (!FRAME_WINDOW_P (it
->f
)
19871 || (row
->reversed_p
19872 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19873 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19877 if (!row
->reversed_p
)
19879 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19880 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19885 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19886 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19888 /* Remove any padding glyphs at the front of ROW, to
19889 make room for the truncation glyphs we will be
19890 adding below. The loop below always inserts at
19891 least one truncation glyph, so also remove the
19892 last glyph added to ROW. */
19893 unproduce_glyphs (it
, i
+ 1);
19894 /* Adjust i for the loop below. */
19895 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19898 it
->current_x
= x_before
;
19899 if (!FRAME_WINDOW_P (it
->f
))
19901 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19903 row
->used
[TEXT_AREA
] = i
;
19904 produce_special_glyphs (it
, IT_TRUNCATION
);
19909 row
->used
[TEXT_AREA
] = i
;
19910 produce_special_glyphs (it
, IT_TRUNCATION
);
19913 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19915 /* Don't truncate if we can overflow newline into fringe. */
19916 if (!get_next_display_element (it
))
19918 it
->continuation_lines_width
= 0;
19919 row
->ends_at_zv_p
= 1;
19920 row
->exact_window_width_line_p
= 1;
19923 if (ITERATOR_AT_END_OF_LINE_P (it
))
19925 row
->exact_window_width_line_p
= 1;
19926 goto at_end_of_line
;
19928 it
->current_x
= x_before
;
19931 row
->truncated_on_right_p
= 1;
19932 it
->continuation_lines_width
= 0;
19933 reseat_at_next_visible_line_start (it
, 0);
19934 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19935 it
->hpos
= hpos_before
;
19941 bidi_unshelve_cache (wrap_data
, 1);
19943 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19944 at the left window margin. */
19945 if (it
->first_visible_x
19946 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19948 if (!FRAME_WINDOW_P (it
->f
)
19949 || (row
->reversed_p
19950 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19951 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
19952 insert_left_trunc_glyphs (it
);
19953 row
->truncated_on_left_p
= 1;
19956 /* Remember the position at which this line ends.
19958 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19959 cannot be before the call to find_row_edges below, since that is
19960 where these positions are determined. */
19961 row
->end
= it
->current
;
19964 row
->minpos
= row
->start
.pos
;
19965 row
->maxpos
= row
->end
.pos
;
19969 /* ROW->minpos and ROW->maxpos must be the smallest and
19970 `1 + the largest' buffer positions in ROW. But if ROW was
19971 bidi-reordered, these two positions can be anywhere in the
19972 row, so we must determine them now. */
19973 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19976 /* If the start of this line is the overlay arrow-position, then
19977 mark this glyph row as the one containing the overlay arrow.
19978 This is clearly a mess with variable size fonts. It would be
19979 better to let it be displayed like cursors under X. */
19980 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19981 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19982 !NILP (overlay_arrow_string
)))
19984 /* Overlay arrow in window redisplay is a fringe bitmap. */
19985 if (STRINGP (overlay_arrow_string
))
19987 struct glyph_row
*arrow_row
19988 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19989 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19990 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19991 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19992 struct glyph
*p2
, *end
;
19994 /* Copy the arrow glyphs. */
19995 while (glyph
< arrow_end
)
19998 /* Throw away padding glyphs. */
20000 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20001 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20007 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20012 eassert (INTEGERP (overlay_arrow_string
));
20013 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20015 overlay_arrow_seen
= 1;
20018 /* Highlight trailing whitespace. */
20019 if (!NILP (Vshow_trailing_whitespace
))
20020 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20022 /* Compute pixel dimensions of this line. */
20023 compute_line_metrics (it
);
20025 /* Implementation note: No changes in the glyphs of ROW or in their
20026 faces can be done past this point, because compute_line_metrics
20027 computes ROW's hash value and stores it within the glyph_row
20030 /* Record whether this row ends inside an ellipsis. */
20031 row
->ends_in_ellipsis_p
20032 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20033 && it
->ellipsis_p
);
20035 /* Save fringe bitmaps in this row. */
20036 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20037 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20038 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20039 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20041 it
->left_user_fringe_bitmap
= 0;
20042 it
->left_user_fringe_face_id
= 0;
20043 it
->right_user_fringe_bitmap
= 0;
20044 it
->right_user_fringe_face_id
= 0;
20046 /* Maybe set the cursor. */
20047 cvpos
= it
->w
->cursor
.vpos
;
20049 /* In bidi-reordered rows, keep checking for proper cursor
20050 position even if one has been found already, because buffer
20051 positions in such rows change non-linearly with ROW->VPOS,
20052 when a line is continued. One exception: when we are at ZV,
20053 display cursor on the first suitable glyph row, since all
20054 the empty rows after that also have their position set to ZV. */
20055 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20056 lines' rows is implemented for bidi-reordered rows. */
20058 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20059 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20060 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20061 && cursor_row_p (row
))
20062 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20064 /* Prepare for the next line. This line starts horizontally at (X
20065 HPOS) = (0 0). Vertical positions are incremented. As a
20066 convenience for the caller, IT->glyph_row is set to the next
20068 it
->current_x
= it
->hpos
= 0;
20069 it
->current_y
+= row
->height
;
20070 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20073 /* The next row should by default use the same value of the
20074 reversed_p flag as this one. set_iterator_to_next decides when
20075 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20076 the flag accordingly. */
20077 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20078 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20079 it
->start
= row
->end
;
20080 return row
->displays_text_p
;
20082 #undef RECORD_MAX_MIN_POS
20085 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20086 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20087 doc
: /* Return paragraph direction at point in BUFFER.
20088 Value is either `left-to-right' or `right-to-left'.
20089 If BUFFER is omitted or nil, it defaults to the current buffer.
20091 Paragraph direction determines how the text in the paragraph is displayed.
20092 In left-to-right paragraphs, text begins at the left margin of the window
20093 and the reading direction is generally left to right. In right-to-left
20094 paragraphs, text begins at the right margin and is read from right to left.
20096 See also `bidi-paragraph-direction'. */)
20097 (Lisp_Object buffer
)
20099 struct buffer
*buf
= current_buffer
;
20100 struct buffer
*old
= buf
;
20102 if (! NILP (buffer
))
20104 CHECK_BUFFER (buffer
);
20105 buf
= XBUFFER (buffer
);
20108 if (NILP (BVAR (buf
, bidi_display_reordering
))
20109 || NILP (BVAR (buf
, enable_multibyte_characters
))
20110 /* When we are loading loadup.el, the character property tables
20111 needed for bidi iteration are not yet available. */
20112 || !NILP (Vpurify_flag
))
20113 return Qleft_to_right
;
20114 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20115 return BVAR (buf
, bidi_paragraph_direction
);
20118 /* Determine the direction from buffer text. We could try to
20119 use current_matrix if it is up to date, but this seems fast
20120 enough as it is. */
20121 struct bidi_it itb
;
20122 ptrdiff_t pos
= BUF_PT (buf
);
20123 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20125 void *itb_data
= bidi_shelve_cache ();
20127 set_buffer_temp (buf
);
20128 /* bidi_paragraph_init finds the base direction of the paragraph
20129 by searching forward from paragraph start. We need the base
20130 direction of the current or _previous_ paragraph, so we need
20131 to make sure we are within that paragraph. To that end, find
20132 the previous non-empty line. */
20133 if (pos
>= ZV
&& pos
> BEGV
)
20136 bytepos
= CHAR_TO_BYTE (pos
);
20138 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20139 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20141 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20142 || c
== ' ' || c
== '\t' || c
== '\f')
20144 if (bytepos
<= BEGV_BYTE
)
20149 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20152 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20153 itb
.paragraph_dir
= NEUTRAL_DIR
;
20154 itb
.string
.s
= NULL
;
20155 itb
.string
.lstring
= Qnil
;
20156 itb
.string
.bufpos
= 0;
20157 itb
.string
.unibyte
= 0;
20158 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20159 bidi_unshelve_cache (itb_data
, 0);
20160 set_buffer_temp (old
);
20161 switch (itb
.paragraph_dir
)
20164 return Qleft_to_right
;
20167 return Qright_to_left
;
20177 /***********************************************************************
20179 ***********************************************************************/
20181 /* Redisplay the menu bar in the frame for window W.
20183 The menu bar of X frames that don't have X toolkit support is
20184 displayed in a special window W->frame->menu_bar_window.
20186 The menu bar of terminal frames is treated specially as far as
20187 glyph matrices are concerned. Menu bar lines are not part of
20188 windows, so the update is done directly on the frame matrix rows
20189 for the menu bar. */
20192 display_menu_bar (struct window
*w
)
20194 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20199 /* Don't do all this for graphical frames. */
20201 if (FRAME_W32_P (f
))
20204 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
20210 if (FRAME_NS_P (f
))
20212 #endif /* HAVE_NS */
20214 #ifdef USE_X_TOOLKIT
20215 eassert (!FRAME_WINDOW_P (f
));
20216 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
20217 it
.first_visible_x
= 0;
20218 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20219 #else /* not USE_X_TOOLKIT */
20220 if (FRAME_WINDOW_P (f
))
20222 /* Menu bar lines are displayed in the desired matrix of the
20223 dummy window menu_bar_window. */
20224 struct window
*menu_w
;
20225 eassert (WINDOWP (f
->menu_bar_window
));
20226 menu_w
= XWINDOW (f
->menu_bar_window
);
20227 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
20229 it
.first_visible_x
= 0;
20230 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20234 /* This is a TTY frame, i.e. character hpos/vpos are used as
20236 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
20238 it
.first_visible_x
= 0;
20239 it
.last_visible_x
= FRAME_COLS (f
);
20241 #endif /* not USE_X_TOOLKIT */
20243 /* FIXME: This should be controlled by a user option. See the
20244 comments in redisplay_tool_bar and display_mode_line about
20246 it
.paragraph_embedding
= L2R
;
20248 /* Clear all rows of the menu bar. */
20249 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
20251 struct glyph_row
*row
= it
.glyph_row
+ i
;
20252 clear_glyph_row (row
);
20253 row
->enabled_p
= 1;
20254 row
->full_width_p
= 1;
20257 /* Display all items of the menu bar. */
20258 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
20259 for (i
= 0; i
< ASIZE (items
); i
+= 4)
20261 Lisp_Object string
;
20263 /* Stop at nil string. */
20264 string
= AREF (items
, i
+ 1);
20268 /* Remember where item was displayed. */
20269 ASET (items
, i
+ 3, make_number (it
.hpos
));
20271 /* Display the item, pad with one space. */
20272 if (it
.current_x
< it
.last_visible_x
)
20273 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
20274 SCHARS (string
) + 1, 0, 0, -1);
20277 /* Fill out the line with spaces. */
20278 if (it
.current_x
< it
.last_visible_x
)
20279 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
20281 /* Compute the total height of the lines. */
20282 compute_line_metrics (&it
);
20287 /***********************************************************************
20289 ***********************************************************************/
20291 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20292 FORCE is non-zero, redisplay mode lines unconditionally.
20293 Otherwise, redisplay only mode lines that are garbaged. Value is
20294 the number of windows whose mode lines were redisplayed. */
20297 redisplay_mode_lines (Lisp_Object window
, int force
)
20301 while (!NILP (window
))
20303 struct window
*w
= XWINDOW (window
);
20305 if (WINDOWP (w
->hchild
))
20306 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
20307 else if (WINDOWP (w
->vchild
))
20308 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
20310 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20311 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20313 struct text_pos lpoint
;
20314 struct buffer
*old
= current_buffer
;
20316 /* Set the window's buffer for the mode line display. */
20317 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20318 set_buffer_internal_1 (XBUFFER (w
->buffer
));
20320 /* Point refers normally to the selected window. For any
20321 other window, set up appropriate value. */
20322 if (!EQ (window
, selected_window
))
20324 struct text_pos pt
;
20326 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20327 if (CHARPOS (pt
) < BEGV
)
20328 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
20329 else if (CHARPOS (pt
) > (ZV
- 1))
20330 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
20332 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20335 /* Display mode lines. */
20336 clear_glyph_matrix (w
->desired_matrix
);
20337 if (display_mode_lines (w
))
20340 w
->must_be_updated_p
= 1;
20343 /* Restore old settings. */
20344 set_buffer_internal_1 (old
);
20345 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20355 /* Display the mode and/or header line of window W. Value is the
20356 sum number of mode lines and header lines displayed. */
20359 display_mode_lines (struct window
*w
)
20361 Lisp_Object old_selected_window
, old_selected_frame
;
20364 old_selected_frame
= selected_frame
;
20365 selected_frame
= w
->frame
;
20366 old_selected_window
= selected_window
;
20367 XSETWINDOW (selected_window
, w
);
20369 /* These will be set while the mode line specs are processed. */
20370 line_number_displayed
= 0;
20371 wset_column_number_displayed (w
, Qnil
);
20373 if (WINDOW_WANTS_MODELINE_P (w
))
20375 struct window
*sel_w
= XWINDOW (old_selected_window
);
20377 /* Select mode line face based on the real selected window. */
20378 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20379 BVAR (current_buffer
, mode_line_format
));
20383 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20385 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20386 BVAR (current_buffer
, header_line_format
));
20390 selected_frame
= old_selected_frame
;
20391 selected_window
= old_selected_window
;
20396 /* Display mode or header line of window W. FACE_ID specifies which
20397 line to display; it is either MODE_LINE_FACE_ID or
20398 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20399 display. Value is the pixel height of the mode/header line
20403 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20407 ptrdiff_t count
= SPECPDL_INDEX ();
20409 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20410 /* Don't extend on a previously drawn mode-line.
20411 This may happen if called from pos_visible_p. */
20412 it
.glyph_row
->enabled_p
= 0;
20413 prepare_desired_row (it
.glyph_row
);
20415 it
.glyph_row
->mode_line_p
= 1;
20417 /* FIXME: This should be controlled by a user option. But
20418 supporting such an option is not trivial, since the mode line is
20419 made up of many separate strings. */
20420 it
.paragraph_embedding
= L2R
;
20422 record_unwind_protect (unwind_format_mode_line
,
20423 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
20425 mode_line_target
= MODE_LINE_DISPLAY
;
20427 /* Temporarily make frame's keyboard the current kboard so that
20428 kboard-local variables in the mode_line_format will get the right
20430 push_kboard (FRAME_KBOARD (it
.f
));
20431 record_unwind_save_match_data ();
20432 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20435 unbind_to (count
, Qnil
);
20437 /* Fill up with spaces. */
20438 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20440 compute_line_metrics (&it
);
20441 it
.glyph_row
->full_width_p
= 1;
20442 it
.glyph_row
->continued_p
= 0;
20443 it
.glyph_row
->truncated_on_left_p
= 0;
20444 it
.glyph_row
->truncated_on_right_p
= 0;
20446 /* Make a 3D mode-line have a shadow at its right end. */
20447 face
= FACE_FROM_ID (it
.f
, face_id
);
20448 extend_face_to_end_of_line (&it
);
20449 if (face
->box
!= FACE_NO_BOX
)
20451 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20452 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20453 last
->right_box_line_p
= 1;
20456 return it
.glyph_row
->height
;
20459 /* Move element ELT in LIST to the front of LIST.
20460 Return the updated list. */
20463 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20465 register Lisp_Object tail
, prev
;
20466 register Lisp_Object tem
;
20470 while (CONSP (tail
))
20476 /* Splice out the link TAIL. */
20478 list
= XCDR (tail
);
20480 Fsetcdr (prev
, XCDR (tail
));
20482 /* Now make it the first. */
20483 Fsetcdr (tail
, list
);
20488 tail
= XCDR (tail
);
20492 /* Not found--return unchanged LIST. */
20496 /* Contribute ELT to the mode line for window IT->w. How it
20497 translates into text depends on its data type.
20499 IT describes the display environment in which we display, as usual.
20501 DEPTH is the depth in recursion. It is used to prevent
20502 infinite recursion here.
20504 FIELD_WIDTH is the number of characters the display of ELT should
20505 occupy in the mode line, and PRECISION is the maximum number of
20506 characters to display from ELT's representation. See
20507 display_string for details.
20509 Returns the hpos of the end of the text generated by ELT.
20511 PROPS is a property list to add to any string we encounter.
20513 If RISKY is nonzero, remove (disregard) any properties in any string
20514 we encounter, and ignore :eval and :propertize.
20516 The global variable `mode_line_target' determines whether the
20517 output is passed to `store_mode_line_noprop',
20518 `store_mode_line_string', or `display_string'. */
20521 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20522 Lisp_Object elt
, Lisp_Object props
, int risky
)
20524 int n
= 0, field
, prec
;
20529 elt
= build_string ("*too-deep*");
20533 switch (XTYPE (elt
))
20537 /* A string: output it and check for %-constructs within it. */
20539 ptrdiff_t offset
= 0;
20541 if (SCHARS (elt
) > 0
20542 && (!NILP (props
) || risky
))
20544 Lisp_Object oprops
, aelt
;
20545 oprops
= Ftext_properties_at (make_number (0), elt
);
20547 /* If the starting string's properties are not what
20548 we want, translate the string. Also, if the string
20549 is risky, do that anyway. */
20551 if (NILP (Fequal (props
, oprops
)) || risky
)
20553 /* If the starting string has properties,
20554 merge the specified ones onto the existing ones. */
20555 if (! NILP (oprops
) && !risky
)
20559 oprops
= Fcopy_sequence (oprops
);
20561 while (CONSP (tem
))
20563 oprops
= Fplist_put (oprops
, XCAR (tem
),
20564 XCAR (XCDR (tem
)));
20565 tem
= XCDR (XCDR (tem
));
20570 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20571 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20573 /* AELT is what we want. Move it to the front
20574 without consing. */
20576 mode_line_proptrans_alist
20577 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20583 /* If AELT has the wrong props, it is useless.
20584 so get rid of it. */
20586 mode_line_proptrans_alist
20587 = Fdelq (aelt
, mode_line_proptrans_alist
);
20589 elt
= Fcopy_sequence (elt
);
20590 Fset_text_properties (make_number (0), Flength (elt
),
20592 /* Add this item to mode_line_proptrans_alist. */
20593 mode_line_proptrans_alist
20594 = Fcons (Fcons (elt
, props
),
20595 mode_line_proptrans_alist
);
20596 /* Truncate mode_line_proptrans_alist
20597 to at most 50 elements. */
20598 tem
= Fnthcdr (make_number (50),
20599 mode_line_proptrans_alist
);
20601 XSETCDR (tem
, Qnil
);
20610 prec
= precision
- n
;
20611 switch (mode_line_target
)
20613 case MODE_LINE_NOPROP
:
20614 case MODE_LINE_TITLE
:
20615 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20617 case MODE_LINE_STRING
:
20618 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20620 case MODE_LINE_DISPLAY
:
20621 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20622 0, prec
, 0, STRING_MULTIBYTE (elt
));
20629 /* Handle the non-literal case. */
20631 while ((precision
<= 0 || n
< precision
)
20632 && SREF (elt
, offset
) != 0
20633 && (mode_line_target
!= MODE_LINE_DISPLAY
20634 || it
->current_x
< it
->last_visible_x
))
20636 ptrdiff_t last_offset
= offset
;
20638 /* Advance to end of string or next format specifier. */
20639 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20642 if (offset
- 1 != last_offset
)
20644 ptrdiff_t nchars
, nbytes
;
20646 /* Output to end of string or up to '%'. Field width
20647 is length of string. Don't output more than
20648 PRECISION allows us. */
20651 prec
= c_string_width (SDATA (elt
) + last_offset
,
20652 offset
- last_offset
, precision
- n
,
20655 switch (mode_line_target
)
20657 case MODE_LINE_NOPROP
:
20658 case MODE_LINE_TITLE
:
20659 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20661 case MODE_LINE_STRING
:
20663 ptrdiff_t bytepos
= last_offset
;
20664 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20665 ptrdiff_t endpos
= (precision
<= 0
20666 ? string_byte_to_char (elt
, offset
)
20667 : charpos
+ nchars
);
20669 n
+= store_mode_line_string (NULL
,
20670 Fsubstring (elt
, make_number (charpos
),
20671 make_number (endpos
)),
20675 case MODE_LINE_DISPLAY
:
20677 ptrdiff_t bytepos
= last_offset
;
20678 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20680 if (precision
<= 0)
20681 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20682 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20684 STRING_MULTIBYTE (elt
));
20689 else /* c == '%' */
20691 ptrdiff_t percent_position
= offset
;
20693 /* Get the specified minimum width. Zero means
20696 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20697 field
= field
* 10 + c
- '0';
20699 /* Don't pad beyond the total padding allowed. */
20700 if (field_width
- n
> 0 && field
> field_width
- n
)
20701 field
= field_width
- n
;
20703 /* Note that either PRECISION <= 0 or N < PRECISION. */
20704 prec
= precision
- n
;
20707 n
+= display_mode_element (it
, depth
, field
, prec
,
20708 Vglobal_mode_string
, props
,
20713 ptrdiff_t bytepos
, charpos
;
20715 Lisp_Object string
;
20717 bytepos
= percent_position
;
20718 charpos
= (STRING_MULTIBYTE (elt
)
20719 ? string_byte_to_char (elt
, bytepos
)
20721 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20722 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20724 switch (mode_line_target
)
20726 case MODE_LINE_NOPROP
:
20727 case MODE_LINE_TITLE
:
20728 n
+= store_mode_line_noprop (spec
, field
, prec
);
20730 case MODE_LINE_STRING
:
20732 Lisp_Object tem
= build_string (spec
);
20733 props
= Ftext_properties_at (make_number (charpos
), elt
);
20734 /* Should only keep face property in props */
20735 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20738 case MODE_LINE_DISPLAY
:
20740 int nglyphs_before
, nwritten
;
20742 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20743 nwritten
= display_string (spec
, string
, elt
,
20748 /* Assign to the glyphs written above the
20749 string where the `%x' came from, position
20753 struct glyph
*glyph
20754 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20758 for (i
= 0; i
< nwritten
; ++i
)
20760 glyph
[i
].object
= elt
;
20761 glyph
[i
].charpos
= charpos
;
20778 /* A symbol: process the value of the symbol recursively
20779 as if it appeared here directly. Avoid error if symbol void.
20780 Special case: if value of symbol is a string, output the string
20783 register Lisp_Object tem
;
20785 /* If the variable is not marked as risky to set
20786 then its contents are risky to use. */
20787 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20790 tem
= Fboundp (elt
);
20793 tem
= Fsymbol_value (elt
);
20794 /* If value is a string, output that string literally:
20795 don't check for % within it. */
20799 if (!EQ (tem
, elt
))
20801 /* Give up right away for nil or t. */
20811 register Lisp_Object car
, tem
;
20813 /* A cons cell: five distinct cases.
20814 If first element is :eval or :propertize, do something special.
20815 If first element is a string or a cons, process all the elements
20816 and effectively concatenate them.
20817 If first element is a negative number, truncate displaying cdr to
20818 at most that many characters. If positive, pad (with spaces)
20819 to at least that many characters.
20820 If first element is a symbol, process the cadr or caddr recursively
20821 according to whether the symbol's value is non-nil or nil. */
20823 if (EQ (car
, QCeval
))
20825 /* An element of the form (:eval FORM) means evaluate FORM
20826 and use the result as mode line elements. */
20831 if (CONSP (XCDR (elt
)))
20834 spec
= safe_eval (XCAR (XCDR (elt
)));
20835 n
+= display_mode_element (it
, depth
, field_width
- n
,
20836 precision
- n
, spec
, props
,
20840 else if (EQ (car
, QCpropertize
))
20842 /* An element of the form (:propertize ELT PROPS...)
20843 means display ELT but applying properties PROPS. */
20848 if (CONSP (XCDR (elt
)))
20849 n
+= display_mode_element (it
, depth
, field_width
- n
,
20850 precision
- n
, XCAR (XCDR (elt
)),
20851 XCDR (XCDR (elt
)), risky
);
20853 else if (SYMBOLP (car
))
20855 tem
= Fboundp (car
);
20859 /* elt is now the cdr, and we know it is a cons cell.
20860 Use its car if CAR has a non-nil value. */
20863 tem
= Fsymbol_value (car
);
20870 /* Symbol's value is nil (or symbol is unbound)
20871 Get the cddr of the original list
20872 and if possible find the caddr and use that. */
20876 else if (!CONSP (elt
))
20881 else if (INTEGERP (car
))
20883 register int lim
= XINT (car
);
20887 /* Negative int means reduce maximum width. */
20888 if (precision
<= 0)
20891 precision
= min (precision
, -lim
);
20895 /* Padding specified. Don't let it be more than
20896 current maximum. */
20898 lim
= min (precision
, lim
);
20900 /* If that's more padding than already wanted, queue it.
20901 But don't reduce padding already specified even if
20902 that is beyond the current truncation point. */
20903 field_width
= max (lim
, field_width
);
20907 else if (STRINGP (car
) || CONSP (car
))
20909 Lisp_Object halftail
= elt
;
20913 && (precision
<= 0 || n
< precision
))
20915 n
+= display_mode_element (it
, depth
,
20916 /* Do padding only after the last
20917 element in the list. */
20918 (! CONSP (XCDR (elt
))
20921 precision
- n
, XCAR (elt
),
20925 if ((len
& 1) == 0)
20926 halftail
= XCDR (halftail
);
20927 /* Check for cycle. */
20928 if (EQ (halftail
, elt
))
20937 elt
= build_string ("*invalid*");
20941 /* Pad to FIELD_WIDTH. */
20942 if (field_width
> 0 && n
< field_width
)
20944 switch (mode_line_target
)
20946 case MODE_LINE_NOPROP
:
20947 case MODE_LINE_TITLE
:
20948 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20950 case MODE_LINE_STRING
:
20951 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20953 case MODE_LINE_DISPLAY
:
20954 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20963 /* Store a mode-line string element in mode_line_string_list.
20965 If STRING is non-null, display that C string. Otherwise, the Lisp
20966 string LISP_STRING is displayed.
20968 FIELD_WIDTH is the minimum number of output glyphs to produce.
20969 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20970 with spaces. FIELD_WIDTH <= 0 means don't pad.
20972 PRECISION is the maximum number of characters to output from
20973 STRING. PRECISION <= 0 means don't truncate the string.
20975 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20976 properties to the string.
20978 PROPS are the properties to add to the string.
20979 The mode_line_string_face face property is always added to the string.
20983 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20984 int field_width
, int precision
, Lisp_Object props
)
20989 if (string
!= NULL
)
20991 len
= strlen (string
);
20992 if (precision
> 0 && len
> precision
)
20994 lisp_string
= make_string (string
, len
);
20996 props
= mode_line_string_face_prop
;
20997 else if (!NILP (mode_line_string_face
))
20999 Lisp_Object face
= Fplist_get (props
, Qface
);
21000 props
= Fcopy_sequence (props
);
21002 face
= mode_line_string_face
;
21004 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
21005 props
= Fplist_put (props
, Qface
, face
);
21007 Fadd_text_properties (make_number (0), make_number (len
),
21008 props
, lisp_string
);
21012 len
= XFASTINT (Flength (lisp_string
));
21013 if (precision
> 0 && len
> precision
)
21016 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
21019 if (!NILP (mode_line_string_face
))
21023 props
= Ftext_properties_at (make_number (0), lisp_string
);
21024 face
= Fplist_get (props
, Qface
);
21026 face
= mode_line_string_face
;
21028 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
21029 props
= Fcons (Qface
, Fcons (face
, Qnil
));
21031 lisp_string
= Fcopy_sequence (lisp_string
);
21034 Fadd_text_properties (make_number (0), make_number (len
),
21035 props
, lisp_string
);
21040 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
21044 if (field_width
> len
)
21046 field_width
-= len
;
21047 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
21049 Fadd_text_properties (make_number (0), make_number (field_width
),
21050 props
, lisp_string
);
21051 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
21059 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
21061 doc
: /* Format a string out of a mode line format specification.
21062 First arg FORMAT specifies the mode line format (see `mode-line-format'
21063 for details) to use.
21065 By default, the format is evaluated for the currently selected window.
21067 Optional second arg FACE specifies the face property to put on all
21068 characters for which no face is specified. The value nil means the
21069 default face. The value t means whatever face the window's mode line
21070 currently uses (either `mode-line' or `mode-line-inactive',
21071 depending on whether the window is the selected window or not).
21072 An integer value means the value string has no text
21075 Optional third and fourth args WINDOW and BUFFER specify the window
21076 and buffer to use as the context for the formatting (defaults
21077 are the selected window and the WINDOW's buffer). */)
21078 (Lisp_Object format
, Lisp_Object face
,
21079 Lisp_Object window
, Lisp_Object buffer
)
21084 struct buffer
*old_buffer
= NULL
;
21086 int no_props
= INTEGERP (face
);
21087 ptrdiff_t count
= SPECPDL_INDEX ();
21089 int string_start
= 0;
21091 w
= decode_any_window (window
);
21092 XSETWINDOW (window
, w
);
21095 buffer
= w
->buffer
;
21096 CHECK_BUFFER (buffer
);
21098 /* Make formatting the modeline a non-op when noninteractive, otherwise
21099 there will be problems later caused by a partially initialized frame. */
21100 if (NILP (format
) || noninteractive
)
21101 return empty_unibyte_string
;
21106 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
21107 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
21108 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
21109 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
21110 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
21111 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
21112 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
21115 old_buffer
= current_buffer
;
21117 /* Save things including mode_line_proptrans_alist,
21118 and set that to nil so that we don't alter the outer value. */
21119 record_unwind_protect (unwind_format_mode_line
,
21120 format_mode_line_unwind_data
21121 (XFRAME (WINDOW_FRAME (w
)),
21122 old_buffer
, selected_window
, 1));
21123 mode_line_proptrans_alist
= Qnil
;
21125 Fselect_window (window
, Qt
);
21126 set_buffer_internal_1 (XBUFFER (buffer
));
21128 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21132 mode_line_target
= MODE_LINE_NOPROP
;
21133 mode_line_string_face_prop
= Qnil
;
21134 mode_line_string_list
= Qnil
;
21135 string_start
= MODE_LINE_NOPROP_LEN (0);
21139 mode_line_target
= MODE_LINE_STRING
;
21140 mode_line_string_list
= Qnil
;
21141 mode_line_string_face
= face
;
21142 mode_line_string_face_prop
21143 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
21146 push_kboard (FRAME_KBOARD (it
.f
));
21147 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21152 len
= MODE_LINE_NOPROP_LEN (string_start
);
21153 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
21157 mode_line_string_list
= Fnreverse (mode_line_string_list
);
21158 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
21159 empty_unibyte_string
);
21162 unbind_to (count
, Qnil
);
21166 /* Write a null-terminated, right justified decimal representation of
21167 the positive integer D to BUF using a minimal field width WIDTH. */
21170 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
21172 register char *p
= buf
;
21180 *p
++ = d
% 10 + '0';
21185 for (width
-= (int) (p
- buf
); width
> 0; --width
)
21196 /* Write a null-terminated, right justified decimal and "human
21197 readable" representation of the nonnegative integer D to BUF using
21198 a minimal field width WIDTH. D should be smaller than 999.5e24. */
21200 static const char power_letter
[] =
21214 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
21216 /* We aim to represent the nonnegative integer D as
21217 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
21218 ptrdiff_t quotient
= d
;
21220 /* -1 means: do not use TENTHS. */
21224 /* Length of QUOTIENT.TENTHS as a string. */
21230 if (1000 <= quotient
)
21232 /* Scale to the appropriate EXPONENT. */
21235 remainder
= quotient
% 1000;
21239 while (1000 <= quotient
);
21241 /* Round to nearest and decide whether to use TENTHS or not. */
21244 tenths
= remainder
/ 100;
21245 if (50 <= remainder
% 100)
21252 if (quotient
== 10)
21260 if (500 <= remainder
)
21262 if (quotient
< 999)
21273 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21274 if (tenths
== -1 && quotient
<= 99)
21281 p
= psuffix
= buf
+ max (width
, length
);
21283 /* Print EXPONENT. */
21284 *psuffix
++ = power_letter
[exponent
];
21287 /* Print TENTHS. */
21290 *--p
= '0' + tenths
;
21294 /* Print QUOTIENT. */
21297 int digit
= quotient
% 10;
21298 *--p
= '0' + digit
;
21300 while ((quotient
/= 10) != 0);
21302 /* Print leading spaces. */
21307 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21308 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21309 type of CODING_SYSTEM. Return updated pointer into BUF. */
21311 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21314 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21317 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21318 const unsigned char *eol_str
;
21320 /* The EOL conversion we are using. */
21321 Lisp_Object eoltype
;
21323 val
= CODING_SYSTEM_SPEC (coding_system
);
21326 if (!VECTORP (val
)) /* Not yet decided. */
21328 *buf
++ = multibyte
? '-' : ' ';
21330 eoltype
= eol_mnemonic_undecided
;
21331 /* Don't mention EOL conversion if it isn't decided. */
21336 Lisp_Object eolvalue
;
21338 attrs
= AREF (val
, 0);
21339 eolvalue
= AREF (val
, 2);
21342 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21347 /* The EOL conversion that is normal on this system. */
21349 if (NILP (eolvalue
)) /* Not yet decided. */
21350 eoltype
= eol_mnemonic_undecided
;
21351 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21352 eoltype
= eol_mnemonic_undecided
;
21353 else /* eolvalue is Qunix, Qdos, or Qmac. */
21354 eoltype
= (EQ (eolvalue
, Qunix
)
21355 ? eol_mnemonic_unix
21356 : (EQ (eolvalue
, Qdos
) == 1
21357 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21363 /* Mention the EOL conversion if it is not the usual one. */
21364 if (STRINGP (eoltype
))
21366 eol_str
= SDATA (eoltype
);
21367 eol_str_len
= SBYTES (eoltype
);
21369 else if (CHARACTERP (eoltype
))
21371 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
21372 int c
= XFASTINT (eoltype
);
21373 eol_str_len
= CHAR_STRING (c
, tmp
);
21378 eol_str
= invalid_eol_type
;
21379 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21381 memcpy (buf
, eol_str
, eol_str_len
);
21382 buf
+= eol_str_len
;
21388 /* Return a string for the output of a mode line %-spec for window W,
21389 generated by character C. FIELD_WIDTH > 0 means pad the string
21390 returned with spaces to that value. Return a Lisp string in
21391 *STRING if the resulting string is taken from that Lisp string.
21393 Note we operate on the current buffer for most purposes,
21394 the exception being w->base_line_pos. */
21396 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21398 static const char *
21399 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21400 Lisp_Object
*string
)
21403 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21404 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21405 /* We are going to use f->decode_mode_spec_buffer as the buffer to
21406 produce strings from numerical values, so limit preposterously
21407 large values of FIELD_WIDTH to avoid overrunning the buffer's
21408 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
21409 bytes plus the terminating null. */
21410 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
21411 struct buffer
*b
= current_buffer
;
21419 if (!NILP (BVAR (b
, read_only
)))
21421 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21426 /* This differs from %* only for a modified read-only buffer. */
21427 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21429 if (!NILP (BVAR (b
, read_only
)))
21434 /* This differs from %* in ignoring read-only-ness. */
21435 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21447 if (command_loop_level
> 5)
21449 p
= decode_mode_spec_buf
;
21450 for (i
= 0; i
< command_loop_level
; i
++)
21453 return decode_mode_spec_buf
;
21461 if (command_loop_level
> 5)
21463 p
= decode_mode_spec_buf
;
21464 for (i
= 0; i
< command_loop_level
; i
++)
21467 return decode_mode_spec_buf
;
21474 /* Let lots_of_dashes be a string of infinite length. */
21475 if (mode_line_target
== MODE_LINE_NOPROP
||
21476 mode_line_target
== MODE_LINE_STRING
)
21478 if (field_width
<= 0
21479 || field_width
> sizeof (lots_of_dashes
))
21481 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21482 decode_mode_spec_buf
[i
] = '-';
21483 decode_mode_spec_buf
[i
] = '\0';
21484 return decode_mode_spec_buf
;
21487 return lots_of_dashes
;
21491 obj
= BVAR (b
, name
);
21495 /* %c and %l are ignored in `frame-title-format'.
21496 (In redisplay_internal, the frame title is drawn _before_ the
21497 windows are updated, so the stuff which depends on actual
21498 window contents (such as %l) may fail to render properly, or
21499 even crash emacs.) */
21500 if (mode_line_target
== MODE_LINE_TITLE
)
21504 ptrdiff_t col
= current_column ();
21505 wset_column_number_displayed (w
, make_number (col
));
21506 pint2str (decode_mode_spec_buf
, width
, col
);
21507 return decode_mode_spec_buf
;
21511 #ifndef SYSTEM_MALLOC
21513 if (NILP (Vmemory_full
))
21516 return "!MEM FULL! ";
21523 /* %F displays the frame name. */
21524 if (!NILP (f
->title
))
21525 return SSDATA (f
->title
);
21526 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21527 return SSDATA (f
->name
);
21531 obj
= BVAR (b
, filename
);
21536 ptrdiff_t size
= ZV
- BEGV
;
21537 pint2str (decode_mode_spec_buf
, width
, size
);
21538 return decode_mode_spec_buf
;
21543 ptrdiff_t size
= ZV
- BEGV
;
21544 pint2hrstr (decode_mode_spec_buf
, width
, size
);
21545 return decode_mode_spec_buf
;
21550 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21551 ptrdiff_t topline
, nlines
, height
;
21554 /* %c and %l are ignored in `frame-title-format'. */
21555 if (mode_line_target
== MODE_LINE_TITLE
)
21558 startpos
= XMARKER (w
->start
)->charpos
;
21559 startpos_byte
= marker_byte_position (w
->start
);
21560 height
= WINDOW_TOTAL_LINES (w
);
21562 /* If we decided that this buffer isn't suitable for line numbers,
21563 don't forget that too fast. */
21564 if (EQ (w
->base_line_pos
, w
->buffer
))
21566 /* But do forget it, if the window shows a different buffer now. */
21567 else if (BUFFERP (w
->base_line_pos
))
21568 wset_base_line_pos (w
, Qnil
);
21570 /* If the buffer is very big, don't waste time. */
21571 if (INTEGERP (Vline_number_display_limit
)
21572 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21574 wset_base_line_pos (w
, Qnil
);
21575 wset_base_line_number (w
, Qnil
);
21579 if (INTEGERP (w
->base_line_number
)
21580 && INTEGERP (w
->base_line_pos
)
21581 && XFASTINT (w
->base_line_pos
) <= startpos
)
21583 line
= XFASTINT (w
->base_line_number
);
21584 linepos
= XFASTINT (w
->base_line_pos
);
21585 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21590 linepos
= BUF_BEGV (b
);
21591 linepos_byte
= BUF_BEGV_BYTE (b
);
21594 /* Count lines from base line to window start position. */
21595 nlines
= display_count_lines (linepos_byte
,
21599 topline
= nlines
+ line
;
21601 /* Determine a new base line, if the old one is too close
21602 or too far away, or if we did not have one.
21603 "Too close" means it's plausible a scroll-down would
21604 go back past it. */
21605 if (startpos
== BUF_BEGV (b
))
21607 wset_base_line_number (w
, make_number (topline
));
21608 wset_base_line_pos (w
, make_number (BUF_BEGV (b
)));
21610 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21611 || linepos
== BUF_BEGV (b
))
21613 ptrdiff_t limit
= BUF_BEGV (b
);
21614 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21615 ptrdiff_t position
;
21616 ptrdiff_t distance
=
21617 (height
* 2 + 30) * line_number_display_limit_width
;
21619 if (startpos
- distance
> limit
)
21621 limit
= startpos
- distance
;
21622 limit_byte
= CHAR_TO_BYTE (limit
);
21625 nlines
= display_count_lines (startpos_byte
,
21627 - (height
* 2 + 30),
21629 /* If we couldn't find the lines we wanted within
21630 line_number_display_limit_width chars per line,
21631 give up on line numbers for this window. */
21632 if (position
== limit_byte
&& limit
== startpos
- distance
)
21634 wset_base_line_pos (w
, w
->buffer
);
21635 wset_base_line_number (w
, Qnil
);
21639 wset_base_line_number (w
, make_number (topline
- nlines
));
21640 wset_base_line_pos (w
, make_number (BYTE_TO_CHAR (position
)));
21643 /* Now count lines from the start pos to point. */
21644 nlines
= display_count_lines (startpos_byte
,
21645 PT_BYTE
, PT
, &junk
);
21647 /* Record that we did display the line number. */
21648 line_number_displayed
= 1;
21650 /* Make the string to show. */
21651 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
21652 return decode_mode_spec_buf
;
21655 char* p
= decode_mode_spec_buf
;
21656 int pad
= width
- 2;
21662 return decode_mode_spec_buf
;
21668 obj
= BVAR (b
, mode_name
);
21672 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21678 ptrdiff_t pos
= marker_position (w
->start
);
21679 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21681 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21683 if (pos
<= BUF_BEGV (b
))
21688 else if (pos
<= BUF_BEGV (b
))
21692 if (total
> 1000000)
21693 /* Do it differently for a large value, to avoid overflow. */
21694 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21696 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21697 /* We can't normally display a 3-digit number,
21698 so get us a 2-digit number that is close. */
21701 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21702 return decode_mode_spec_buf
;
21706 /* Display percentage of size above the bottom of the screen. */
21709 ptrdiff_t toppos
= marker_position (w
->start
);
21710 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21711 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21713 if (botpos
>= BUF_ZV (b
))
21715 if (toppos
<= BUF_BEGV (b
))
21722 if (total
> 1000000)
21723 /* Do it differently for a large value, to avoid overflow. */
21724 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21726 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21727 /* We can't normally display a 3-digit number,
21728 so get us a 2-digit number that is close. */
21731 if (toppos
<= BUF_BEGV (b
))
21732 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21734 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21735 return decode_mode_spec_buf
;
21740 /* status of process */
21741 obj
= Fget_buffer_process (Fcurrent_buffer ());
21743 return "no process";
21745 obj
= Fsymbol_name (Fprocess_status (obj
));
21751 ptrdiff_t count
= inhibit_garbage_collection ();
21752 Lisp_Object val
= call1 (intern ("file-remote-p"),
21753 BVAR (current_buffer
, directory
));
21754 unbind_to (count
, Qnil
);
21762 case 't': /* indicate TEXT or BINARY */
21766 /* coding-system (not including end-of-line format) */
21768 /* coding-system (including end-of-line type) */
21770 int eol_flag
= (c
== 'Z');
21771 char *p
= decode_mode_spec_buf
;
21773 if (! FRAME_WINDOW_P (f
))
21775 /* No need to mention EOL here--the terminal never needs
21776 to do EOL conversion. */
21777 p
= decode_mode_spec_coding (CODING_ID_NAME
21778 (FRAME_KEYBOARD_CODING (f
)->id
),
21780 p
= decode_mode_spec_coding (CODING_ID_NAME
21781 (FRAME_TERMINAL_CODING (f
)->id
),
21784 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21787 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21788 #ifdef subprocesses
21789 obj
= Fget_buffer_process (Fcurrent_buffer ());
21790 if (PROCESSP (obj
))
21792 p
= decode_mode_spec_coding
21793 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
21794 p
= decode_mode_spec_coding
21795 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
21797 #endif /* subprocesses */
21800 return decode_mode_spec_buf
;
21807 return SSDATA (obj
);
21814 /* Count up to COUNT lines starting from START_BYTE.
21815 But don't go beyond LIMIT_BYTE.
21816 Return the number of lines thus found (always nonnegative).
21818 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21821 display_count_lines (ptrdiff_t start_byte
,
21822 ptrdiff_t limit_byte
, ptrdiff_t count
,
21823 ptrdiff_t *byte_pos_ptr
)
21825 register unsigned char *cursor
;
21826 unsigned char *base
;
21828 register ptrdiff_t ceiling
;
21829 register unsigned char *ceiling_addr
;
21830 ptrdiff_t orig_count
= count
;
21832 /* If we are not in selective display mode,
21833 check only for newlines. */
21834 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21835 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21839 while (start_byte
< limit_byte
)
21841 ceiling
= BUFFER_CEILING_OF (start_byte
);
21842 ceiling
= min (limit_byte
- 1, ceiling
);
21843 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21844 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21847 if (selective_display
)
21848 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21851 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21854 if (cursor
!= ceiling_addr
)
21858 start_byte
+= cursor
- base
+ 1;
21859 *byte_pos_ptr
= start_byte
;
21863 if (++cursor
== ceiling_addr
)
21869 start_byte
+= cursor
- base
;
21874 while (start_byte
> limit_byte
)
21876 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21877 ceiling
= max (limit_byte
, ceiling
);
21878 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21879 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21882 if (selective_display
)
21883 while (--cursor
!= ceiling_addr
21884 && *cursor
!= '\n' && *cursor
!= 015)
21887 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21890 if (cursor
!= ceiling_addr
)
21894 start_byte
+= cursor
- base
+ 1;
21895 *byte_pos_ptr
= start_byte
;
21896 /* When scanning backwards, we should
21897 not count the newline posterior to which we stop. */
21898 return - orig_count
- 1;
21904 /* Here we add 1 to compensate for the last decrement
21905 of CURSOR, which took it past the valid range. */
21906 start_byte
+= cursor
- base
+ 1;
21910 *byte_pos_ptr
= limit_byte
;
21913 return - orig_count
+ count
;
21914 return orig_count
- count
;
21920 /***********************************************************************
21922 ***********************************************************************/
21924 /* Display a NUL-terminated string, starting with index START.
21926 If STRING is non-null, display that C string. Otherwise, the Lisp
21927 string LISP_STRING is displayed. There's a case that STRING is
21928 non-null and LISP_STRING is not nil. It means STRING is a string
21929 data of LISP_STRING. In that case, we display LISP_STRING while
21930 ignoring its text properties.
21932 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21933 FACE_STRING. Display STRING or LISP_STRING with the face at
21934 FACE_STRING_POS in FACE_STRING:
21936 Display the string in the environment given by IT, but use the
21937 standard display table, temporarily.
21939 FIELD_WIDTH is the minimum number of output glyphs to produce.
21940 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21941 with spaces. If STRING has more characters, more than FIELD_WIDTH
21942 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21944 PRECISION is the maximum number of characters to output from
21945 STRING. PRECISION < 0 means don't truncate the string.
21947 This is roughly equivalent to printf format specifiers:
21949 FIELD_WIDTH PRECISION PRINTF
21950 ----------------------------------------
21956 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21957 display them, and < 0 means obey the current buffer's value of
21958 enable_multibyte_characters.
21960 Value is the number of columns displayed. */
21963 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21964 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
21965 int field_width
, int precision
, int max_x
, int multibyte
)
21967 int hpos_at_start
= it
->hpos
;
21968 int saved_face_id
= it
->face_id
;
21969 struct glyph_row
*row
= it
->glyph_row
;
21970 ptrdiff_t it_charpos
;
21972 /* Initialize the iterator IT for iteration over STRING beginning
21973 with index START. */
21974 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21975 precision
, field_width
, multibyte
);
21976 if (string
&& STRINGP (lisp_string
))
21977 /* LISP_STRING is the one returned by decode_mode_spec. We should
21978 ignore its text properties. */
21979 it
->stop_charpos
= it
->end_charpos
;
21981 /* If displaying STRING, set up the face of the iterator from
21982 FACE_STRING, if that's given. */
21983 if (STRINGP (face_string
))
21989 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21990 0, it
->region_beg_charpos
,
21991 it
->region_end_charpos
,
21992 &endptr
, it
->base_face_id
, 0);
21993 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21994 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21997 /* Set max_x to the maximum allowed X position. Don't let it go
21998 beyond the right edge of the window. */
22000 max_x
= it
->last_visible_x
;
22002 max_x
= min (max_x
, it
->last_visible_x
);
22004 /* Skip over display elements that are not visible. because IT->w is
22006 if (it
->current_x
< it
->first_visible_x
)
22007 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
22008 MOVE_TO_POS
| MOVE_TO_X
);
22010 row
->ascent
= it
->max_ascent
;
22011 row
->height
= it
->max_ascent
+ it
->max_descent
;
22012 row
->phys_ascent
= it
->max_phys_ascent
;
22013 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
22014 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
22016 if (STRINGP (it
->string
))
22017 it_charpos
= IT_STRING_CHARPOS (*it
);
22019 it_charpos
= IT_CHARPOS (*it
);
22021 /* This condition is for the case that we are called with current_x
22022 past last_visible_x. */
22023 while (it
->current_x
< max_x
)
22025 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
22027 /* Get the next display element. */
22028 if (!get_next_display_element (it
))
22031 /* Produce glyphs. */
22032 x_before
= it
->current_x
;
22033 n_glyphs_before
= row
->used
[TEXT_AREA
];
22034 PRODUCE_GLYPHS (it
);
22036 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
22039 while (i
< nglyphs
)
22041 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
22043 if (it
->line_wrap
!= TRUNCATE
22044 && x
+ glyph
->pixel_width
> max_x
)
22046 /* End of continued line or max_x reached. */
22047 if (CHAR_GLYPH_PADDING_P (*glyph
))
22049 /* A wide character is unbreakable. */
22050 if (row
->reversed_p
)
22051 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
22052 - n_glyphs_before
);
22053 row
->used
[TEXT_AREA
] = n_glyphs_before
;
22054 it
->current_x
= x_before
;
22058 if (row
->reversed_p
)
22059 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
22060 - (n_glyphs_before
+ i
));
22061 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
22066 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
22068 /* Glyph is at least partially visible. */
22070 if (x
< it
->first_visible_x
)
22071 row
->x
= x
- it
->first_visible_x
;
22075 /* Glyph is off the left margin of the display area.
22076 Should not happen. */
22080 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
22081 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
22082 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
22083 row
->phys_height
= max (row
->phys_height
,
22084 it
->max_phys_ascent
+ it
->max_phys_descent
);
22085 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
22086 it
->max_extra_line_spacing
);
22087 x
+= glyph
->pixel_width
;
22091 /* Stop if max_x reached. */
22095 /* Stop at line ends. */
22096 if (ITERATOR_AT_END_OF_LINE_P (it
))
22098 it
->continuation_lines_width
= 0;
22102 set_iterator_to_next (it
, 1);
22103 if (STRINGP (it
->string
))
22104 it_charpos
= IT_STRING_CHARPOS (*it
);
22106 it_charpos
= IT_CHARPOS (*it
);
22108 /* Stop if truncating at the right edge. */
22109 if (it
->line_wrap
== TRUNCATE
22110 && it
->current_x
>= it
->last_visible_x
)
22112 /* Add truncation mark, but don't do it if the line is
22113 truncated at a padding space. */
22114 if (it_charpos
< it
->string_nchars
)
22116 if (!FRAME_WINDOW_P (it
->f
))
22120 if (it
->current_x
> it
->last_visible_x
)
22122 if (!row
->reversed_p
)
22124 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
22125 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22130 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
22131 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22133 unproduce_glyphs (it
, ii
+ 1);
22134 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
22136 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
22138 row
->used
[TEXT_AREA
] = ii
;
22139 produce_special_glyphs (it
, IT_TRUNCATION
);
22142 produce_special_glyphs (it
, IT_TRUNCATION
);
22144 row
->truncated_on_right_p
= 1;
22150 /* Maybe insert a truncation at the left. */
22151 if (it
->first_visible_x
22154 if (!FRAME_WINDOW_P (it
->f
)
22155 || (row
->reversed_p
22156 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22157 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
22158 insert_left_trunc_glyphs (it
);
22159 row
->truncated_on_left_p
= 1;
22162 it
->face_id
= saved_face_id
;
22164 /* Value is number of columns displayed. */
22165 return it
->hpos
- hpos_at_start
;
22170 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
22171 appears as an element of LIST or as the car of an element of LIST.
22172 If PROPVAL is a list, compare each element against LIST in that
22173 way, and return 1/2 if any element of PROPVAL is found in LIST.
22174 Otherwise return 0. This function cannot quit.
22175 The return value is 2 if the text is invisible but with an ellipsis
22176 and 1 if it's invisible and without an ellipsis. */
22179 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
22181 register Lisp_Object tail
, proptail
;
22183 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22185 register Lisp_Object tem
;
22187 if (EQ (propval
, tem
))
22189 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
22190 return NILP (XCDR (tem
)) ? 1 : 2;
22193 if (CONSP (propval
))
22195 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
22197 Lisp_Object propelt
;
22198 propelt
= XCAR (proptail
);
22199 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22201 register Lisp_Object tem
;
22203 if (EQ (propelt
, tem
))
22205 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
22206 return NILP (XCDR (tem
)) ? 1 : 2;
22214 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
22215 doc
: /* Non-nil if the property makes the text invisible.
22216 POS-OR-PROP can be a marker or number, in which case it is taken to be
22217 a position in the current buffer and the value of the `invisible' property
22218 is checked; or it can be some other value, which is then presumed to be the
22219 value of the `invisible' property of the text of interest.
22220 The non-nil value returned can be t for truly invisible text or something
22221 else if the text is replaced by an ellipsis. */)
22222 (Lisp_Object pos_or_prop
)
22225 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
22226 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
22228 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
22229 return (invis
== 0 ? Qnil
22231 : make_number (invis
));
22234 /* Calculate a width or height in pixels from a specification using
22235 the following elements:
22238 NUM - a (fractional) multiple of the default font width/height
22239 (NUM) - specifies exactly NUM pixels
22240 UNIT - a fixed number of pixels, see below.
22241 ELEMENT - size of a display element in pixels, see below.
22242 (NUM . SPEC) - equals NUM * SPEC
22243 (+ SPEC SPEC ...) - add pixel values
22244 (- SPEC SPEC ...) - subtract pixel values
22245 (- SPEC) - negate pixel value
22248 INT or FLOAT - a number constant
22249 SYMBOL - use symbol's (buffer local) variable binding.
22252 in - pixels per inch *)
22253 mm - pixels per 1/1000 meter *)
22254 cm - pixels per 1/100 meter *)
22255 width - width of current font in pixels.
22256 height - height of current font in pixels.
22258 *) using the ratio(s) defined in display-pixels-per-inch.
22262 left-fringe - left fringe width in pixels
22263 right-fringe - right fringe width in pixels
22265 left-margin - left margin width in pixels
22266 right-margin - right margin width in pixels
22268 scroll-bar - scroll-bar area width in pixels
22272 Pixels corresponding to 5 inches:
22275 Total width of non-text areas on left side of window (if scroll-bar is on left):
22276 '(space :width (+ left-fringe left-margin scroll-bar))
22278 Align to first text column (in header line):
22279 '(space :align-to 0)
22281 Align to middle of text area minus half the width of variable `my-image'
22282 containing a loaded image:
22283 '(space :align-to (0.5 . (- text my-image)))
22285 Width of left margin minus width of 1 character in the default font:
22286 '(space :width (- left-margin 1))
22288 Width of left margin minus width of 2 characters in the current font:
22289 '(space :width (- left-margin (2 . width)))
22291 Center 1 character over left-margin (in header line):
22292 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22294 Different ways to express width of left fringe plus left margin minus one pixel:
22295 '(space :width (- (+ left-fringe left-margin) (1)))
22296 '(space :width (+ left-fringe left-margin (- (1))))
22297 '(space :width (+ left-fringe left-margin (-1)))
22301 #define NUMVAL(X) \
22302 ((INTEGERP (X) || FLOATP (X)) \
22307 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22308 struct font
*font
, int width_p
, int *align_to
)
22312 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22313 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22316 return OK_PIXELS (0);
22318 eassert (FRAME_LIVE_P (it
->f
));
22320 if (SYMBOLP (prop
))
22322 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22324 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22326 if (unit
[0] == 'i' && unit
[1] == 'n')
22328 else if (unit
[0] == 'm' && unit
[1] == 'm')
22330 else if (unit
[0] == 'c' && unit
[1] == 'm')
22337 #ifdef HAVE_WINDOW_SYSTEM
22338 if (FRAME_WINDOW_P (it
->f
)
22340 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
22341 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
22343 return OK_PIXELS (ppi
/ pixels
);
22346 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
22347 || (CONSP (Vdisplay_pixels_per_inch
)
22349 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
22350 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
22352 return OK_PIXELS (ppi
/ pixels
);
22358 #ifdef HAVE_WINDOW_SYSTEM
22359 if (EQ (prop
, Qheight
))
22360 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22361 if (EQ (prop
, Qwidth
))
22362 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22364 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22365 return OK_PIXELS (1);
22368 if (EQ (prop
, Qtext
))
22369 return OK_PIXELS (width_p
22370 ? window_box_width (it
->w
, TEXT_AREA
)
22371 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22373 if (align_to
&& *align_to
< 0)
22376 if (EQ (prop
, Qleft
))
22377 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22378 if (EQ (prop
, Qright
))
22379 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22380 if (EQ (prop
, Qcenter
))
22381 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22382 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22383 if (EQ (prop
, Qleft_fringe
))
22384 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22385 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22386 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22387 if (EQ (prop
, Qright_fringe
))
22388 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22389 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22390 : window_box_right_offset (it
->w
, TEXT_AREA
));
22391 if (EQ (prop
, Qleft_margin
))
22392 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22393 if (EQ (prop
, Qright_margin
))
22394 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22395 if (EQ (prop
, Qscroll_bar
))
22396 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22398 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22399 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22400 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22405 if (EQ (prop
, Qleft_fringe
))
22406 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22407 if (EQ (prop
, Qright_fringe
))
22408 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22409 if (EQ (prop
, Qleft_margin
))
22410 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22411 if (EQ (prop
, Qright_margin
))
22412 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22413 if (EQ (prop
, Qscroll_bar
))
22414 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22417 prop
= buffer_local_value_1 (prop
, it
->w
->buffer
);
22418 if (EQ (prop
, Qunbound
))
22422 if (INTEGERP (prop
) || FLOATP (prop
))
22424 int base_unit
= (width_p
22425 ? FRAME_COLUMN_WIDTH (it
->f
)
22426 : FRAME_LINE_HEIGHT (it
->f
));
22427 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22432 Lisp_Object car
= XCAR (prop
);
22433 Lisp_Object cdr
= XCDR (prop
);
22437 #ifdef HAVE_WINDOW_SYSTEM
22438 if (FRAME_WINDOW_P (it
->f
)
22439 && valid_image_p (prop
))
22441 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22442 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22444 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22447 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22453 while (CONSP (cdr
))
22455 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22456 font
, width_p
, align_to
))
22459 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22464 if (EQ (car
, Qminus
))
22466 return OK_PIXELS (pixels
);
22469 car
= buffer_local_value_1 (car
, it
->w
->buffer
);
22470 if (EQ (car
, Qunbound
))
22474 if (INTEGERP (car
) || FLOATP (car
))
22477 pixels
= XFLOATINT (car
);
22479 return OK_PIXELS (pixels
);
22480 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22481 font
, width_p
, align_to
))
22482 return OK_PIXELS (pixels
* fact
);
22493 /***********************************************************************
22495 ***********************************************************************/
22497 #ifdef HAVE_WINDOW_SYSTEM
22502 dump_glyph_string (struct glyph_string
*s
)
22504 fprintf (stderr
, "glyph string\n");
22505 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22506 s
->x
, s
->y
, s
->width
, s
->height
);
22507 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22508 fprintf (stderr
, " hl = %d\n", s
->hl
);
22509 fprintf (stderr
, " left overhang = %d, right = %d\n",
22510 s
->left_overhang
, s
->right_overhang
);
22511 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22512 fprintf (stderr
, " extends to end of line = %d\n",
22513 s
->extends_to_end_of_line_p
);
22514 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22515 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22518 #endif /* GLYPH_DEBUG */
22520 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22521 of XChar2b structures for S; it can't be allocated in
22522 init_glyph_string because it must be allocated via `alloca'. W
22523 is the window on which S is drawn. ROW and AREA are the glyph row
22524 and area within the row from which S is constructed. START is the
22525 index of the first glyph structure covered by S. HL is a
22526 face-override for drawing S. */
22529 #define OPTIONAL_HDC(hdc) HDC hdc,
22530 #define DECLARE_HDC(hdc) HDC hdc;
22531 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22532 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22535 #ifndef OPTIONAL_HDC
22536 #define OPTIONAL_HDC(hdc)
22537 #define DECLARE_HDC(hdc)
22538 #define ALLOCATE_HDC(hdc, f)
22539 #define RELEASE_HDC(hdc, f)
22543 init_glyph_string (struct glyph_string
*s
,
22545 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22546 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22548 memset (s
, 0, sizeof *s
);
22550 s
->f
= XFRAME (w
->frame
);
22554 s
->display
= FRAME_X_DISPLAY (s
->f
);
22555 s
->window
= FRAME_X_WINDOW (s
->f
);
22556 s
->char2b
= char2b
;
22560 s
->first_glyph
= row
->glyphs
[area
] + start
;
22561 s
->height
= row
->height
;
22562 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22563 s
->ybase
= s
->y
+ row
->ascent
;
22567 /* Append the list of glyph strings with head H and tail T to the list
22568 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22571 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22572 struct glyph_string
*h
, struct glyph_string
*t
)
22586 /* Prepend the list of glyph strings with head H and tail T to the
22587 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22591 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22592 struct glyph_string
*h
, struct glyph_string
*t
)
22606 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22607 Set *HEAD and *TAIL to the resulting list. */
22610 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22611 struct glyph_string
*s
)
22613 s
->next
= s
->prev
= NULL
;
22614 append_glyph_string_lists (head
, tail
, s
, s
);
22618 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22619 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22620 make sure that X resources for the face returned are allocated.
22621 Value is a pointer to a realized face that is ready for display if
22622 DISPLAY_P is non-zero. */
22624 static struct face
*
22625 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22626 XChar2b
*char2b
, int display_p
)
22628 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22632 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22634 if (code
!= FONT_INVALID_CODE
)
22635 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22637 STORE_XCHAR2B (char2b
, 0, 0);
22640 /* Make sure X resources of the face are allocated. */
22641 #ifdef HAVE_X_WINDOWS
22645 eassert (face
!= NULL
);
22646 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22653 /* Get face and two-byte form of character glyph GLYPH on frame F.
22654 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22655 a pointer to a realized face that is ready for display. */
22657 static struct face
*
22658 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22659 XChar2b
*char2b
, int *two_byte_p
)
22663 eassert (glyph
->type
== CHAR_GLYPH
);
22664 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22673 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22674 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22676 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22678 if (code
!= FONT_INVALID_CODE
)
22679 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22681 STORE_XCHAR2B (char2b
, 0, 0);
22684 /* Make sure X resources of the face are allocated. */
22685 eassert (face
!= NULL
);
22686 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22691 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22692 Return 1 if FONT has a glyph for C, otherwise return 0. */
22695 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22699 if (CHAR_BYTE8_P (c
))
22700 code
= CHAR_TO_BYTE8 (c
);
22702 code
= font
->driver
->encode_char (font
, c
);
22704 if (code
== FONT_INVALID_CODE
)
22706 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22711 /* Fill glyph string S with composition components specified by S->cmp.
22713 BASE_FACE is the base face of the composition.
22714 S->cmp_from is the index of the first component for S.
22716 OVERLAPS non-zero means S should draw the foreground only, and use
22717 its physical height for clipping. See also draw_glyphs.
22719 Value is the index of a component not in S. */
22722 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22726 /* For all glyphs of this composition, starting at the offset
22727 S->cmp_from, until we reach the end of the definition or encounter a
22728 glyph that requires the different face, add it to S. */
22733 s
->for_overlaps
= overlaps
;
22736 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22738 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22740 /* TAB in a composition means display glyphs with padding space
22741 on the left or right. */
22744 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22747 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22754 s
->font
= s
->face
->font
;
22756 else if (s
->face
!= face
)
22764 if (s
->face
== NULL
)
22766 s
->face
= base_face
->ascii_face
;
22767 s
->font
= s
->face
->font
;
22770 /* All glyph strings for the same composition has the same width,
22771 i.e. the width set for the first component of the composition. */
22772 s
->width
= s
->first_glyph
->pixel_width
;
22774 /* If the specified font could not be loaded, use the frame's
22775 default font, but record the fact that we couldn't load it in
22776 the glyph string so that we can draw rectangles for the
22777 characters of the glyph string. */
22778 if (s
->font
== NULL
)
22780 s
->font_not_found_p
= 1;
22781 s
->font
= FRAME_FONT (s
->f
);
22784 /* Adjust base line for subscript/superscript text. */
22785 s
->ybase
+= s
->first_glyph
->voffset
;
22787 /* This glyph string must always be drawn with 16-bit functions. */
22794 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22795 int start
, int end
, int overlaps
)
22797 struct glyph
*glyph
, *last
;
22798 Lisp_Object lgstring
;
22801 s
->for_overlaps
= overlaps
;
22802 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22803 last
= s
->row
->glyphs
[s
->area
] + end
;
22804 s
->cmp_id
= glyph
->u
.cmp
.id
;
22805 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22806 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22807 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22808 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22809 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22811 while (glyph
< last
22812 && glyph
->u
.cmp
.automatic
22813 && glyph
->u
.cmp
.id
== s
->cmp_id
22814 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22815 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22817 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22819 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22820 unsigned code
= LGLYPH_CODE (lglyph
);
22822 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22824 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22825 return glyph
- s
->row
->glyphs
[s
->area
];
22829 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22830 See the comment of fill_glyph_string for arguments.
22831 Value is the index of the first glyph not in S. */
22835 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22836 int start
, int end
, int overlaps
)
22838 struct glyph
*glyph
, *last
;
22841 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22842 s
->for_overlaps
= overlaps
;
22843 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22844 last
= s
->row
->glyphs
[s
->area
] + end
;
22845 voffset
= glyph
->voffset
;
22846 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22847 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
22849 s
->width
= glyph
->pixel_width
;
22851 while (glyph
< last
22852 && glyph
->type
== GLYPHLESS_GLYPH
22853 && glyph
->voffset
== voffset
22854 && glyph
->face_id
== face_id
)
22857 s
->width
+= glyph
->pixel_width
;
22860 s
->ybase
+= voffset
;
22861 return glyph
- s
->row
->glyphs
[s
->area
];
22865 /* Fill glyph string S from a sequence of character glyphs.
22867 FACE_ID is the face id of the string. START is the index of the
22868 first glyph to consider, END is the index of the last + 1.
22869 OVERLAPS non-zero means S should draw the foreground only, and use
22870 its physical height for clipping. See also draw_glyphs.
22872 Value is the index of the first glyph not in S. */
22875 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22876 int start
, int end
, int overlaps
)
22878 struct glyph
*glyph
, *last
;
22880 int glyph_not_available_p
;
22882 eassert (s
->f
== XFRAME (s
->w
->frame
));
22883 eassert (s
->nchars
== 0);
22884 eassert (start
>= 0 && end
> start
);
22886 s
->for_overlaps
= overlaps
;
22887 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22888 last
= s
->row
->glyphs
[s
->area
] + end
;
22889 voffset
= glyph
->voffset
;
22890 s
->padding_p
= glyph
->padding_p
;
22891 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22893 while (glyph
< last
22894 && glyph
->type
== CHAR_GLYPH
22895 && glyph
->voffset
== voffset
22896 /* Same face id implies same font, nowadays. */
22897 && glyph
->face_id
== face_id
22898 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22902 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22903 s
->char2b
+ s
->nchars
,
22905 s
->two_byte_p
= two_byte_p
;
22907 eassert (s
->nchars
<= end
- start
);
22908 s
->width
+= glyph
->pixel_width
;
22909 if (glyph
++->padding_p
!= s
->padding_p
)
22913 s
->font
= s
->face
->font
;
22915 /* If the specified font could not be loaded, use the frame's font,
22916 but record the fact that we couldn't load it in
22917 S->font_not_found_p so that we can draw rectangles for the
22918 characters of the glyph string. */
22919 if (s
->font
== NULL
|| glyph_not_available_p
)
22921 s
->font_not_found_p
= 1;
22922 s
->font
= FRAME_FONT (s
->f
);
22925 /* Adjust base line for subscript/superscript text. */
22926 s
->ybase
+= voffset
;
22928 eassert (s
->face
&& s
->face
->gc
);
22929 return glyph
- s
->row
->glyphs
[s
->area
];
22933 /* Fill glyph string S from image glyph S->first_glyph. */
22936 fill_image_glyph_string (struct glyph_string
*s
)
22938 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22939 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22941 s
->slice
= s
->first_glyph
->slice
.img
;
22942 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22943 s
->font
= s
->face
->font
;
22944 s
->width
= s
->first_glyph
->pixel_width
;
22946 /* Adjust base line for subscript/superscript text. */
22947 s
->ybase
+= s
->first_glyph
->voffset
;
22951 /* Fill glyph string S from a sequence of stretch glyphs.
22953 START is the index of the first glyph to consider,
22954 END is the index of the last + 1.
22956 Value is the index of the first glyph not in S. */
22959 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22961 struct glyph
*glyph
, *last
;
22962 int voffset
, face_id
;
22964 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22966 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22967 last
= s
->row
->glyphs
[s
->area
] + end
;
22968 face_id
= glyph
->face_id
;
22969 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22970 s
->font
= s
->face
->font
;
22971 s
->width
= glyph
->pixel_width
;
22973 voffset
= glyph
->voffset
;
22977 && glyph
->type
== STRETCH_GLYPH
22978 && glyph
->voffset
== voffset
22979 && glyph
->face_id
== face_id
);
22981 s
->width
+= glyph
->pixel_width
;
22983 /* Adjust base line for subscript/superscript text. */
22984 s
->ybase
+= voffset
;
22986 /* The case that face->gc == 0 is handled when drawing the glyph
22987 string by calling PREPARE_FACE_FOR_DISPLAY. */
22989 return glyph
- s
->row
->glyphs
[s
->area
];
22992 static struct font_metrics
*
22993 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22995 static struct font_metrics metrics
;
22996 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22998 if (! font
|| code
== FONT_INVALID_CODE
)
23000 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
23005 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
23006 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
23007 assumed to be zero. */
23010 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
23012 *left
= *right
= 0;
23014 if (glyph
->type
== CHAR_GLYPH
)
23018 struct font_metrics
*pcm
;
23020 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
23021 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
23023 if (pcm
->rbearing
> pcm
->width
)
23024 *right
= pcm
->rbearing
- pcm
->width
;
23025 if (pcm
->lbearing
< 0)
23026 *left
= -pcm
->lbearing
;
23029 else if (glyph
->type
== COMPOSITE_GLYPH
)
23031 if (! glyph
->u
.cmp
.automatic
)
23033 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
23035 if (cmp
->rbearing
> cmp
->pixel_width
)
23036 *right
= cmp
->rbearing
- cmp
->pixel_width
;
23037 if (cmp
->lbearing
< 0)
23038 *left
= - cmp
->lbearing
;
23042 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
23043 struct font_metrics metrics
;
23045 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
23046 glyph
->slice
.cmp
.to
+ 1, &metrics
);
23047 if (metrics
.rbearing
> metrics
.width
)
23048 *right
= metrics
.rbearing
- metrics
.width
;
23049 if (metrics
.lbearing
< 0)
23050 *left
= - metrics
.lbearing
;
23056 /* Return the index of the first glyph preceding glyph string S that
23057 is overwritten by S because of S's left overhang. Value is -1
23058 if no glyphs are overwritten. */
23061 left_overwritten (struct glyph_string
*s
)
23065 if (s
->left_overhang
)
23068 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23069 int first
= s
->first_glyph
- glyphs
;
23071 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
23072 x
-= glyphs
[i
].pixel_width
;
23083 /* Return the index of the first glyph preceding glyph string S that
23084 is overwriting S because of its right overhang. Value is -1 if no
23085 glyph in front of S overwrites S. */
23088 left_overwriting (struct glyph_string
*s
)
23091 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23092 int first
= s
->first_glyph
- glyphs
;
23096 for (i
= first
- 1; i
>= 0; --i
)
23099 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23102 x
-= glyphs
[i
].pixel_width
;
23109 /* Return the index of the last glyph following glyph string S that is
23110 overwritten by S because of S's right overhang. Value is -1 if
23111 no such glyph is found. */
23114 right_overwritten (struct glyph_string
*s
)
23118 if (s
->right_overhang
)
23121 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23122 int first
= (s
->first_glyph
- glyphs
23123 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23124 int end
= s
->row
->used
[s
->area
];
23126 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
23127 x
+= glyphs
[i
].pixel_width
;
23136 /* Return the index of the last glyph following glyph string S that
23137 overwrites S because of its left overhang. Value is negative
23138 if no such glyph is found. */
23141 right_overwriting (struct glyph_string
*s
)
23144 int end
= s
->row
->used
[s
->area
];
23145 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23146 int first
= (s
->first_glyph
- glyphs
23147 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23151 for (i
= first
; i
< end
; ++i
)
23154 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23157 x
+= glyphs
[i
].pixel_width
;
23164 /* Set background width of glyph string S. START is the index of the
23165 first glyph following S. LAST_X is the right-most x-position + 1
23166 in the drawing area. */
23169 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
23171 /* If the face of this glyph string has to be drawn to the end of
23172 the drawing area, set S->extends_to_end_of_line_p. */
23174 if (start
== s
->row
->used
[s
->area
]
23175 && s
->area
== TEXT_AREA
23176 && ((s
->row
->fill_line_p
23177 && (s
->hl
== DRAW_NORMAL_TEXT
23178 || s
->hl
== DRAW_IMAGE_RAISED
23179 || s
->hl
== DRAW_IMAGE_SUNKEN
))
23180 || s
->hl
== DRAW_MOUSE_FACE
))
23181 s
->extends_to_end_of_line_p
= 1;
23183 /* If S extends its face to the end of the line, set its
23184 background_width to the distance to the right edge of the drawing
23186 if (s
->extends_to_end_of_line_p
)
23187 s
->background_width
= last_x
- s
->x
+ 1;
23189 s
->background_width
= s
->width
;
23193 /* Compute overhangs and x-positions for glyph string S and its
23194 predecessors, or successors. X is the starting x-position for S.
23195 BACKWARD_P non-zero means process predecessors. */
23198 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
23204 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23205 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23215 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23216 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23226 /* The following macros are only called from draw_glyphs below.
23227 They reference the following parameters of that function directly:
23228 `w', `row', `area', and `overlap_p'
23229 as well as the following local variables:
23230 `s', `f', and `hdc' (in W32) */
23233 /* On W32, silently add local `hdc' variable to argument list of
23234 init_glyph_string. */
23235 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23236 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23238 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23239 init_glyph_string (s, char2b, w, row, area, start, hl)
23242 /* Add a glyph string for a stretch glyph to the list of strings
23243 between HEAD and TAIL. START is the index of the stretch glyph in
23244 row area AREA of glyph row ROW. END is the index of the last glyph
23245 in that glyph row area. X is the current output position assigned
23246 to the new glyph string constructed. HL overrides that face of the
23247 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23248 is the right-most x-position of the drawing area. */
23250 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23251 and below -- keep them on one line. */
23252 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23255 s = alloca (sizeof *s); \
23256 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23257 START = fill_stretch_glyph_string (s, START, END); \
23258 append_glyph_string (&HEAD, &TAIL, s); \
23264 /* Add a glyph string for an image glyph to the list of strings
23265 between HEAD and TAIL. START is the index of the image glyph in
23266 row area AREA of glyph row ROW. END is the index of the last glyph
23267 in that glyph row area. X is the current output position assigned
23268 to the new glyph string constructed. HL overrides that face of the
23269 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23270 is the right-most x-position of the drawing area. */
23272 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23275 s = alloca (sizeof *s); \
23276 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23277 fill_image_glyph_string (s); \
23278 append_glyph_string (&HEAD, &TAIL, s); \
23285 /* Add a glyph string for a sequence of character glyphs to the list
23286 of strings between HEAD and TAIL. START is the index of the first
23287 glyph in row area AREA of glyph row ROW that is part of the new
23288 glyph string. END is the index of the last glyph in that glyph row
23289 area. X is the current output position assigned to the new glyph
23290 string constructed. HL overrides that face of the glyph; e.g. it
23291 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23292 right-most x-position of the drawing area. */
23294 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23300 face_id = (row)->glyphs[area][START].face_id; \
23302 s = alloca (sizeof *s); \
23303 char2b = alloca ((END - START) * sizeof *char2b); \
23304 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23305 append_glyph_string (&HEAD, &TAIL, s); \
23307 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23312 /* Add a glyph string for a composite sequence to the list of strings
23313 between HEAD and TAIL. START is the index of the first glyph in
23314 row area AREA of glyph row ROW that is part of the new glyph
23315 string. END is the index of the last glyph in that glyph row area.
23316 X is the current output position assigned to the new glyph string
23317 constructed. HL overrides that face of the glyph; e.g. it is
23318 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23319 x-position of the drawing area. */
23321 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23323 int face_id = (row)->glyphs[area][START].face_id; \
23324 struct face *base_face = FACE_FROM_ID (f, face_id); \
23325 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23326 struct composition *cmp = composition_table[cmp_id]; \
23328 struct glyph_string *first_s = NULL; \
23331 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23333 /* Make glyph_strings for each glyph sequence that is drawable by \
23334 the same face, and append them to HEAD/TAIL. */ \
23335 for (n = 0; n < cmp->glyph_len;) \
23337 s = alloca (sizeof *s); \
23338 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23339 append_glyph_string (&(HEAD), &(TAIL), s); \
23345 n = fill_composite_glyph_string (s, base_face, overlaps); \
23353 /* Add a glyph string for a glyph-string sequence to the list of strings
23354 between HEAD and TAIL. */
23356 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23360 Lisp_Object gstring; \
23362 face_id = (row)->glyphs[area][START].face_id; \
23363 gstring = (composition_gstring_from_id \
23364 ((row)->glyphs[area][START].u.cmp.id)); \
23365 s = alloca (sizeof *s); \
23366 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23367 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23368 append_glyph_string (&(HEAD), &(TAIL), s); \
23370 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23374 /* Add a glyph string for a sequence of glyphless character's glyphs
23375 to the list of strings between HEAD and TAIL. The meanings of
23376 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23378 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23383 face_id = (row)->glyphs[area][START].face_id; \
23385 s = alloca (sizeof *s); \
23386 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23387 append_glyph_string (&HEAD, &TAIL, s); \
23389 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23395 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23396 of AREA of glyph row ROW on window W between indices START and END.
23397 HL overrides the face for drawing glyph strings, e.g. it is
23398 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23399 x-positions of the drawing area.
23401 This is an ugly monster macro construct because we must use alloca
23402 to allocate glyph strings (because draw_glyphs can be called
23403 asynchronously). */
23405 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23408 HEAD = TAIL = NULL; \
23409 while (START < END) \
23411 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23412 switch (first_glyph->type) \
23415 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23419 case COMPOSITE_GLYPH: \
23420 if (first_glyph->u.cmp.automatic) \
23421 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23424 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23428 case STRETCH_GLYPH: \
23429 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23433 case IMAGE_GLYPH: \
23434 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23438 case GLYPHLESS_GLYPH: \
23439 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23449 set_glyph_string_background_width (s, START, LAST_X); \
23456 /* Draw glyphs between START and END in AREA of ROW on window W,
23457 starting at x-position X. X is relative to AREA in W. HL is a
23458 face-override with the following meaning:
23460 DRAW_NORMAL_TEXT draw normally
23461 DRAW_CURSOR draw in cursor face
23462 DRAW_MOUSE_FACE draw in mouse face.
23463 DRAW_INVERSE_VIDEO draw in mode line face
23464 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23465 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23467 If OVERLAPS is non-zero, draw only the foreground of characters and
23468 clip to the physical height of ROW. Non-zero value also defines
23469 the overlapping part to be drawn:
23471 OVERLAPS_PRED overlap with preceding rows
23472 OVERLAPS_SUCC overlap with succeeding rows
23473 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23474 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23476 Value is the x-position reached, relative to AREA of W. */
23479 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23480 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23481 enum draw_glyphs_face hl
, int overlaps
)
23483 struct glyph_string
*head
, *tail
;
23484 struct glyph_string
*s
;
23485 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23486 int i
, j
, x_reached
, last_x
, area_left
= 0;
23487 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23490 ALLOCATE_HDC (hdc
, f
);
23492 /* Let's rather be paranoid than getting a SEGV. */
23493 end
= min (end
, row
->used
[area
]);
23494 start
= max (0, start
);
23495 start
= min (end
, start
);
23497 /* Translate X to frame coordinates. Set last_x to the right
23498 end of the drawing area. */
23499 if (row
->full_width_p
)
23501 /* X is relative to the left edge of W, without scroll bars
23503 area_left
= WINDOW_LEFT_EDGE_X (w
);
23504 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23508 area_left
= window_box_left (w
, area
);
23509 last_x
= area_left
+ window_box_width (w
, area
);
23513 /* Build a doubly-linked list of glyph_string structures between
23514 head and tail from what we have to draw. Note that the macro
23515 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23516 the reason we use a separate variable `i'. */
23518 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23520 x_reached
= tail
->x
+ tail
->background_width
;
23524 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23525 the row, redraw some glyphs in front or following the glyph
23526 strings built above. */
23527 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23529 struct glyph_string
*h
, *t
;
23530 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23531 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23532 int check_mouse_face
= 0;
23535 /* If mouse highlighting is on, we may need to draw adjacent
23536 glyphs using mouse-face highlighting. */
23537 if (area
== TEXT_AREA
&& row
->mouse_face_p
23538 && hlinfo
->mouse_face_beg_row
>= 0
23539 && hlinfo
->mouse_face_end_row
>= 0)
23541 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23543 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23544 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23546 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23548 check_mouse_face
= 1;
23549 mouse_beg_col
= (row
== mouse_beg_row
)
23550 ? hlinfo
->mouse_face_beg_col
: 0;
23551 mouse_end_col
= (row
== mouse_end_row
)
23552 ? hlinfo
->mouse_face_end_col
23553 : row
->used
[TEXT_AREA
];
23557 /* Compute overhangs for all glyph strings. */
23558 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23559 for (s
= head
; s
; s
= s
->next
)
23560 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23562 /* Prepend glyph strings for glyphs in front of the first glyph
23563 string that are overwritten because of the first glyph
23564 string's left overhang. The background of all strings
23565 prepended must be drawn because the first glyph string
23567 i
= left_overwritten (head
);
23570 enum draw_glyphs_face overlap_hl
;
23572 /* If this row contains mouse highlighting, attempt to draw
23573 the overlapped glyphs with the correct highlight. This
23574 code fails if the overlap encompasses more than one glyph
23575 and mouse-highlight spans only some of these glyphs.
23576 However, making it work perfectly involves a lot more
23577 code, and I don't know if the pathological case occurs in
23578 practice, so we'll stick to this for now. --- cyd */
23579 if (check_mouse_face
23580 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23581 overlap_hl
= DRAW_MOUSE_FACE
;
23583 overlap_hl
= DRAW_NORMAL_TEXT
;
23586 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23587 overlap_hl
, dummy_x
, last_x
);
23589 compute_overhangs_and_x (t
, head
->x
, 1);
23590 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23594 /* Prepend glyph strings for glyphs in front of the first glyph
23595 string that overwrite that glyph string because of their
23596 right overhang. For these strings, only the foreground must
23597 be drawn, because it draws over the glyph string at `head'.
23598 The background must not be drawn because this would overwrite
23599 right overhangs of preceding glyphs for which no glyph
23601 i
= left_overwriting (head
);
23604 enum draw_glyphs_face overlap_hl
;
23606 if (check_mouse_face
23607 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23608 overlap_hl
= DRAW_MOUSE_FACE
;
23610 overlap_hl
= DRAW_NORMAL_TEXT
;
23613 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23614 overlap_hl
, dummy_x
, last_x
);
23615 for (s
= h
; s
; s
= s
->next
)
23616 s
->background_filled_p
= 1;
23617 compute_overhangs_and_x (t
, head
->x
, 1);
23618 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23621 /* Append glyphs strings for glyphs following the last glyph
23622 string tail that are overwritten by tail. The background of
23623 these strings has to be drawn because tail's foreground draws
23625 i
= right_overwritten (tail
);
23628 enum draw_glyphs_face overlap_hl
;
23630 if (check_mouse_face
23631 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23632 overlap_hl
= DRAW_MOUSE_FACE
;
23634 overlap_hl
= DRAW_NORMAL_TEXT
;
23636 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23637 overlap_hl
, x
, last_x
);
23638 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23639 we don't have `end = i;' here. */
23640 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23641 append_glyph_string_lists (&head
, &tail
, h
, t
);
23645 /* Append glyph strings for glyphs following the last glyph
23646 string tail that overwrite tail. The foreground of such
23647 glyphs has to be drawn because it writes into the background
23648 of tail. The background must not be drawn because it could
23649 paint over the foreground of following glyphs. */
23650 i
= right_overwriting (tail
);
23653 enum draw_glyphs_face overlap_hl
;
23654 if (check_mouse_face
23655 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23656 overlap_hl
= DRAW_MOUSE_FACE
;
23658 overlap_hl
= DRAW_NORMAL_TEXT
;
23661 i
++; /* We must include the Ith glyph. */
23662 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23663 overlap_hl
, x
, last_x
);
23664 for (s
= h
; s
; s
= s
->next
)
23665 s
->background_filled_p
= 1;
23666 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23667 append_glyph_string_lists (&head
, &tail
, h
, t
);
23669 if (clip_head
|| clip_tail
)
23670 for (s
= head
; s
; s
= s
->next
)
23672 s
->clip_head
= clip_head
;
23673 s
->clip_tail
= clip_tail
;
23677 /* Draw all strings. */
23678 for (s
= head
; s
; s
= s
->next
)
23679 FRAME_RIF (f
)->draw_glyph_string (s
);
23682 /* When focus a sole frame and move horizontally, this sets on_p to 0
23683 causing a failure to erase prev cursor position. */
23684 if (area
== TEXT_AREA
23685 && !row
->full_width_p
23686 /* When drawing overlapping rows, only the glyph strings'
23687 foreground is drawn, which doesn't erase a cursor
23691 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23692 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23693 : (tail
? tail
->x
+ tail
->background_width
: x
));
23697 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23698 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23702 /* Value is the x-position up to which drawn, relative to AREA of W.
23703 This doesn't include parts drawn because of overhangs. */
23704 if (row
->full_width_p
)
23705 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23707 x_reached
-= area_left
;
23709 RELEASE_HDC (hdc
, f
);
23714 /* Expand row matrix if too narrow. Don't expand if area
23717 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23719 if (!fonts_changed_p \
23720 && (it->glyph_row->glyphs[area] \
23721 < it->glyph_row->glyphs[area + 1])) \
23723 it->w->ncols_scale_factor++; \
23724 fonts_changed_p = 1; \
23728 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23729 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23732 append_glyph (struct it
*it
)
23734 struct glyph
*glyph
;
23735 enum glyph_row_area area
= it
->area
;
23737 eassert (it
->glyph_row
);
23738 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23740 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23741 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23743 /* If the glyph row is reversed, we need to prepend the glyph
23744 rather than append it. */
23745 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23749 /* Make room for the additional glyph. */
23750 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23752 glyph
= it
->glyph_row
->glyphs
[area
];
23754 glyph
->charpos
= CHARPOS (it
->position
);
23755 glyph
->object
= it
->object
;
23756 if (it
->pixel_width
> 0)
23758 glyph
->pixel_width
= it
->pixel_width
;
23759 glyph
->padding_p
= 0;
23763 /* Assure at least 1-pixel width. Otherwise, cursor can't
23764 be displayed correctly. */
23765 glyph
->pixel_width
= 1;
23766 glyph
->padding_p
= 1;
23768 glyph
->ascent
= it
->ascent
;
23769 glyph
->descent
= it
->descent
;
23770 glyph
->voffset
= it
->voffset
;
23771 glyph
->type
= CHAR_GLYPH
;
23772 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23773 glyph
->multibyte_p
= it
->multibyte_p
;
23774 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23775 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23776 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23777 || it
->phys_descent
> it
->descent
);
23778 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23779 glyph
->face_id
= it
->face_id
;
23780 glyph
->u
.ch
= it
->char_to_display
;
23781 glyph
->slice
.img
= null_glyph_slice
;
23782 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23785 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23786 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23788 glyph
->bidi_type
= it
->bidi_it
.type
;
23792 glyph
->resolved_level
= 0;
23793 glyph
->bidi_type
= UNKNOWN_BT
;
23795 ++it
->glyph_row
->used
[area
];
23798 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23801 /* Store one glyph for the composition IT->cmp_it.id in
23802 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23806 append_composite_glyph (struct it
*it
)
23808 struct glyph
*glyph
;
23809 enum glyph_row_area area
= it
->area
;
23811 eassert (it
->glyph_row
);
23813 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23814 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23816 /* If the glyph row is reversed, we need to prepend the glyph
23817 rather than append it. */
23818 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23822 /* Make room for the new glyph. */
23823 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23825 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23827 glyph
->charpos
= it
->cmp_it
.charpos
;
23828 glyph
->object
= it
->object
;
23829 glyph
->pixel_width
= it
->pixel_width
;
23830 glyph
->ascent
= it
->ascent
;
23831 glyph
->descent
= it
->descent
;
23832 glyph
->voffset
= it
->voffset
;
23833 glyph
->type
= COMPOSITE_GLYPH
;
23834 if (it
->cmp_it
.ch
< 0)
23836 glyph
->u
.cmp
.automatic
= 0;
23837 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23838 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23842 glyph
->u
.cmp
.automatic
= 1;
23843 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23844 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23845 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23847 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23848 glyph
->multibyte_p
= it
->multibyte_p
;
23849 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23850 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23851 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23852 || it
->phys_descent
> it
->descent
);
23853 glyph
->padding_p
= 0;
23854 glyph
->glyph_not_available_p
= 0;
23855 glyph
->face_id
= it
->face_id
;
23856 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23859 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23860 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23862 glyph
->bidi_type
= it
->bidi_it
.type
;
23864 ++it
->glyph_row
->used
[area
];
23867 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23871 /* Change IT->ascent and IT->height according to the setting of
23875 take_vertical_position_into_account (struct it
*it
)
23879 if (it
->voffset
< 0)
23880 /* Increase the ascent so that we can display the text higher
23882 it
->ascent
-= it
->voffset
;
23884 /* Increase the descent so that we can display the text lower
23886 it
->descent
+= it
->voffset
;
23891 /* Produce glyphs/get display metrics for the image IT is loaded with.
23892 See the description of struct display_iterator in dispextern.h for
23893 an overview of struct display_iterator. */
23896 produce_image_glyph (struct it
*it
)
23900 int glyph_ascent
, crop
;
23901 struct glyph_slice slice
;
23903 eassert (it
->what
== IT_IMAGE
);
23905 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23907 /* Make sure X resources of the face is loaded. */
23908 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23910 if (it
->image_id
< 0)
23912 /* Fringe bitmap. */
23913 it
->ascent
= it
->phys_ascent
= 0;
23914 it
->descent
= it
->phys_descent
= 0;
23915 it
->pixel_width
= 0;
23920 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23922 /* Make sure X resources of the image is loaded. */
23923 prepare_image_for_display (it
->f
, img
);
23925 slice
.x
= slice
.y
= 0;
23926 slice
.width
= img
->width
;
23927 slice
.height
= img
->height
;
23929 if (INTEGERP (it
->slice
.x
))
23930 slice
.x
= XINT (it
->slice
.x
);
23931 else if (FLOATP (it
->slice
.x
))
23932 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23934 if (INTEGERP (it
->slice
.y
))
23935 slice
.y
= XINT (it
->slice
.y
);
23936 else if (FLOATP (it
->slice
.y
))
23937 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23939 if (INTEGERP (it
->slice
.width
))
23940 slice
.width
= XINT (it
->slice
.width
);
23941 else if (FLOATP (it
->slice
.width
))
23942 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23944 if (INTEGERP (it
->slice
.height
))
23945 slice
.height
= XINT (it
->slice
.height
);
23946 else if (FLOATP (it
->slice
.height
))
23947 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23949 if (slice
.x
>= img
->width
)
23950 slice
.x
= img
->width
;
23951 if (slice
.y
>= img
->height
)
23952 slice
.y
= img
->height
;
23953 if (slice
.x
+ slice
.width
>= img
->width
)
23954 slice
.width
= img
->width
- slice
.x
;
23955 if (slice
.y
+ slice
.height
> img
->height
)
23956 slice
.height
= img
->height
- slice
.y
;
23958 if (slice
.width
== 0 || slice
.height
== 0)
23961 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23963 it
->descent
= slice
.height
- glyph_ascent
;
23965 it
->descent
+= img
->vmargin
;
23966 if (slice
.y
+ slice
.height
== img
->height
)
23967 it
->descent
+= img
->vmargin
;
23968 it
->phys_descent
= it
->descent
;
23970 it
->pixel_width
= slice
.width
;
23972 it
->pixel_width
+= img
->hmargin
;
23973 if (slice
.x
+ slice
.width
== img
->width
)
23974 it
->pixel_width
+= img
->hmargin
;
23976 /* It's quite possible for images to have an ascent greater than
23977 their height, so don't get confused in that case. */
23978 if (it
->descent
< 0)
23983 if (face
->box
!= FACE_NO_BOX
)
23985 if (face
->box_line_width
> 0)
23988 it
->ascent
+= face
->box_line_width
;
23989 if (slice
.y
+ slice
.height
== img
->height
)
23990 it
->descent
+= face
->box_line_width
;
23993 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23994 it
->pixel_width
+= eabs (face
->box_line_width
);
23995 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23996 it
->pixel_width
+= eabs (face
->box_line_width
);
23999 take_vertical_position_into_account (it
);
24001 /* Automatically crop wide image glyphs at right edge so we can
24002 draw the cursor on same display row. */
24003 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
24004 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
24006 it
->pixel_width
-= crop
;
24007 slice
.width
-= crop
;
24012 struct glyph
*glyph
;
24013 enum glyph_row_area area
= it
->area
;
24015 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24016 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24018 glyph
->charpos
= CHARPOS (it
->position
);
24019 glyph
->object
= it
->object
;
24020 glyph
->pixel_width
= it
->pixel_width
;
24021 glyph
->ascent
= glyph_ascent
;
24022 glyph
->descent
= it
->descent
;
24023 glyph
->voffset
= it
->voffset
;
24024 glyph
->type
= IMAGE_GLYPH
;
24025 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24026 glyph
->multibyte_p
= it
->multibyte_p
;
24027 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24028 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24029 glyph
->overlaps_vertically_p
= 0;
24030 glyph
->padding_p
= 0;
24031 glyph
->glyph_not_available_p
= 0;
24032 glyph
->face_id
= it
->face_id
;
24033 glyph
->u
.img_id
= img
->id
;
24034 glyph
->slice
.img
= slice
;
24035 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24038 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24039 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24041 glyph
->bidi_type
= it
->bidi_it
.type
;
24043 ++it
->glyph_row
->used
[area
];
24046 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24051 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
24052 of the glyph, WIDTH and HEIGHT are the width and height of the
24053 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
24056 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
24057 int width
, int height
, int ascent
)
24059 struct glyph
*glyph
;
24060 enum glyph_row_area area
= it
->area
;
24062 eassert (ascent
>= 0 && ascent
<= height
);
24064 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24065 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24067 /* If the glyph row is reversed, we need to prepend the glyph
24068 rather than append it. */
24069 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24073 /* Make room for the additional glyph. */
24074 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24076 glyph
= it
->glyph_row
->glyphs
[area
];
24078 glyph
->charpos
= CHARPOS (it
->position
);
24079 glyph
->object
= object
;
24080 glyph
->pixel_width
= width
;
24081 glyph
->ascent
= ascent
;
24082 glyph
->descent
= height
- ascent
;
24083 glyph
->voffset
= it
->voffset
;
24084 glyph
->type
= STRETCH_GLYPH
;
24085 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24086 glyph
->multibyte_p
= it
->multibyte_p
;
24087 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24088 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24089 glyph
->overlaps_vertically_p
= 0;
24090 glyph
->padding_p
= 0;
24091 glyph
->glyph_not_available_p
= 0;
24092 glyph
->face_id
= it
->face_id
;
24093 glyph
->u
.stretch
.ascent
= ascent
;
24094 glyph
->u
.stretch
.height
= height
;
24095 glyph
->slice
.img
= null_glyph_slice
;
24096 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24099 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24100 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24102 glyph
->bidi_type
= it
->bidi_it
.type
;
24106 glyph
->resolved_level
= 0;
24107 glyph
->bidi_type
= UNKNOWN_BT
;
24109 ++it
->glyph_row
->used
[area
];
24112 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24115 #endif /* HAVE_WINDOW_SYSTEM */
24117 /* Produce a stretch glyph for iterator IT. IT->object is the value
24118 of the glyph property displayed. The value must be a list
24119 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
24122 1. `:width WIDTH' specifies that the space should be WIDTH *
24123 canonical char width wide. WIDTH may be an integer or floating
24126 2. `:relative-width FACTOR' specifies that the width of the stretch
24127 should be computed from the width of the first character having the
24128 `glyph' property, and should be FACTOR times that width.
24130 3. `:align-to HPOS' specifies that the space should be wide enough
24131 to reach HPOS, a value in canonical character units.
24133 Exactly one of the above pairs must be present.
24135 4. `:height HEIGHT' specifies that the height of the stretch produced
24136 should be HEIGHT, measured in canonical character units.
24138 5. `:relative-height FACTOR' specifies that the height of the
24139 stretch should be FACTOR times the height of the characters having
24140 the glyph property.
24142 Either none or exactly one of 4 or 5 must be present.
24144 6. `:ascent ASCENT' specifies that ASCENT percent of the height
24145 of the stretch should be used for the ascent of the stretch.
24146 ASCENT must be in the range 0 <= ASCENT <= 100. */
24149 produce_stretch_glyph (struct it
*it
)
24151 /* (space :width WIDTH :height HEIGHT ...) */
24152 Lisp_Object prop
, plist
;
24153 int width
= 0, height
= 0, align_to
= -1;
24154 int zero_width_ok_p
= 0;
24156 struct font
*font
= NULL
;
24158 #ifdef HAVE_WINDOW_SYSTEM
24160 int zero_height_ok_p
= 0;
24162 if (FRAME_WINDOW_P (it
->f
))
24164 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24165 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24166 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24170 /* List should start with `space'. */
24171 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
24172 plist
= XCDR (it
->object
);
24174 /* Compute the width of the stretch. */
24175 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
24176 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
24178 /* Absolute width `:width WIDTH' specified and valid. */
24179 zero_width_ok_p
= 1;
24182 #ifdef HAVE_WINDOW_SYSTEM
24183 else if (FRAME_WINDOW_P (it
->f
)
24184 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
24186 /* Relative width `:relative-width FACTOR' specified and valid.
24187 Compute the width of the characters having the `glyph'
24190 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
24193 if (it
->multibyte_p
)
24194 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
24197 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
24198 if (! ASCII_CHAR_P (it2
.c
))
24199 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
24202 it2
.glyph_row
= NULL
;
24203 it2
.what
= IT_CHARACTER
;
24204 x_produce_glyphs (&it2
);
24205 width
= NUMVAL (prop
) * it2
.pixel_width
;
24207 #endif /* HAVE_WINDOW_SYSTEM */
24208 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
24209 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
24211 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
24212 align_to
= (align_to
< 0
24214 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
24215 else if (align_to
< 0)
24216 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
24217 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
24218 zero_width_ok_p
= 1;
24221 /* Nothing specified -> width defaults to canonical char width. */
24222 width
= FRAME_COLUMN_WIDTH (it
->f
);
24224 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
24227 #ifdef HAVE_WINDOW_SYSTEM
24228 /* Compute height. */
24229 if (FRAME_WINDOW_P (it
->f
))
24231 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
24232 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24235 zero_height_ok_p
= 1;
24237 else if (prop
= Fplist_get (plist
, QCrelative_height
),
24239 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
24241 height
= FONT_HEIGHT (font
);
24243 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
24246 /* Compute percentage of height used for ascent. If
24247 `:ascent ASCENT' is present and valid, use that. Otherwise,
24248 derive the ascent from the font in use. */
24249 if (prop
= Fplist_get (plist
, QCascent
),
24250 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
24251 ascent
= height
* NUMVAL (prop
) / 100.0;
24252 else if (!NILP (prop
)
24253 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24254 ascent
= min (max (0, (int)tem
), height
);
24256 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
24259 #endif /* HAVE_WINDOW_SYSTEM */
24262 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24263 && it
->current_x
+ width
> it
->last_visible_x
)
24265 width
= it
->last_visible_x
- it
->current_x
;
24266 #ifdef HAVE_WINDOW_SYSTEM
24267 /* Subtract one more pixel from the stretch width, but only on
24268 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24269 width
-= FRAME_WINDOW_P (it
->f
);
24273 if (width
> 0 && height
> 0 && it
->glyph_row
)
24275 Lisp_Object o_object
= it
->object
;
24276 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24279 if (!STRINGP (object
))
24280 object
= it
->w
->buffer
;
24281 #ifdef HAVE_WINDOW_SYSTEM
24282 if (FRAME_WINDOW_P (it
->f
))
24283 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24287 it
->object
= object
;
24288 it
->char_to_display
= ' ';
24289 it
->pixel_width
= it
->len
= 1;
24291 tty_append_glyph (it
);
24292 it
->object
= o_object
;
24296 it
->pixel_width
= width
;
24297 #ifdef HAVE_WINDOW_SYSTEM
24298 if (FRAME_WINDOW_P (it
->f
))
24300 it
->ascent
= it
->phys_ascent
= ascent
;
24301 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24302 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24303 take_vertical_position_into_account (it
);
24307 it
->nglyphs
= width
;
24310 /* Get information about special display element WHAT in an
24311 environment described by IT. WHAT is one of IT_TRUNCATION or
24312 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24313 non-null glyph_row member. This function ensures that fields like
24314 face_id, c, len of IT are left untouched. */
24317 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
24324 temp_it
.object
= make_number (0);
24325 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
24327 if (what
== IT_CONTINUATION
)
24329 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24330 if (it
->bidi_it
.paragraph_dir
== R2L
)
24331 SET_GLYPH_FROM_CHAR (glyph
, '/');
24333 SET_GLYPH_FROM_CHAR (glyph
, '\\');
24335 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24337 /* FIXME: Should we mirror GC for R2L lines? */
24338 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24339 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24342 else if (what
== IT_TRUNCATION
)
24344 /* Truncation glyph. */
24345 SET_GLYPH_FROM_CHAR (glyph
, '$');
24347 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24349 /* FIXME: Should we mirror GC for R2L lines? */
24350 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24351 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24357 #ifdef HAVE_WINDOW_SYSTEM
24358 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24359 is turned off, we precede the truncation/continuation glyphs by a
24360 stretch glyph whose width is computed such that these special
24361 glyphs are aligned at the window margin, even when very different
24362 fonts are used in different glyph rows. */
24363 if (FRAME_WINDOW_P (temp_it
.f
)
24364 /* init_iterator calls this with it->glyph_row == NULL, and it
24365 wants only the pixel width of the truncation/continuation
24367 && temp_it
.glyph_row
24368 /* insert_left_trunc_glyphs calls us at the beginning of the
24369 row, and it has its own calculation of the stretch glyph
24371 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
24372 && (temp_it
.glyph_row
->reversed_p
24373 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
24374 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
24376 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
24378 if (stretch_width
> 0)
24380 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
24381 struct font
*font
=
24382 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
24383 int stretch_ascent
=
24384 (((temp_it
.ascent
+ temp_it
.descent
)
24385 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
24387 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
24388 temp_it
.ascent
+ temp_it
.descent
,
24395 temp_it
.what
= IT_CHARACTER
;
24397 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
24398 temp_it
.face_id
= GLYPH_FACE (glyph
);
24399 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
24401 PRODUCE_GLYPHS (&temp_it
);
24402 it
->pixel_width
= temp_it
.pixel_width
;
24403 it
->nglyphs
= temp_it
.pixel_width
;
24406 #ifdef HAVE_WINDOW_SYSTEM
24408 /* Calculate line-height and line-spacing properties.
24409 An integer value specifies explicit pixel value.
24410 A float value specifies relative value to current face height.
24411 A cons (float . face-name) specifies relative value to
24412 height of specified face font.
24414 Returns height in pixels, or nil. */
24418 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24419 int boff
, int override
)
24421 Lisp_Object face_name
= Qnil
;
24422 int ascent
, descent
, height
;
24424 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24429 face_name
= XCAR (val
);
24431 if (!NUMBERP (val
))
24432 val
= make_number (1);
24433 if (NILP (face_name
))
24435 height
= it
->ascent
+ it
->descent
;
24440 if (NILP (face_name
))
24442 font
= FRAME_FONT (it
->f
);
24443 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24445 else if (EQ (face_name
, Qt
))
24454 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24456 return make_number (-1);
24458 face
= FACE_FROM_ID (it
->f
, face_id
);
24461 return make_number (-1);
24462 boff
= font
->baseline_offset
;
24463 if (font
->vertical_centering
)
24464 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24467 ascent
= FONT_BASE (font
) + boff
;
24468 descent
= FONT_DESCENT (font
) - boff
;
24472 it
->override_ascent
= ascent
;
24473 it
->override_descent
= descent
;
24474 it
->override_boff
= boff
;
24477 height
= ascent
+ descent
;
24481 height
= (int)(XFLOAT_DATA (val
) * height
);
24482 else if (INTEGERP (val
))
24483 height
*= XINT (val
);
24485 return make_number (height
);
24489 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24490 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24491 and only if this is for a character for which no font was found.
24493 If the display method (it->glyphless_method) is
24494 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24495 length of the acronym or the hexadecimal string, UPPER_XOFF and
24496 UPPER_YOFF are pixel offsets for the upper part of the string,
24497 LOWER_XOFF and LOWER_YOFF are for the lower part.
24499 For the other display methods, LEN through LOWER_YOFF are zero. */
24502 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24503 short upper_xoff
, short upper_yoff
,
24504 short lower_xoff
, short lower_yoff
)
24506 struct glyph
*glyph
;
24507 enum glyph_row_area area
= it
->area
;
24509 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24510 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24512 /* If the glyph row is reversed, we need to prepend the glyph
24513 rather than append it. */
24514 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24518 /* Make room for the additional glyph. */
24519 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24521 glyph
= it
->glyph_row
->glyphs
[area
];
24523 glyph
->charpos
= CHARPOS (it
->position
);
24524 glyph
->object
= it
->object
;
24525 glyph
->pixel_width
= it
->pixel_width
;
24526 glyph
->ascent
= it
->ascent
;
24527 glyph
->descent
= it
->descent
;
24528 glyph
->voffset
= it
->voffset
;
24529 glyph
->type
= GLYPHLESS_GLYPH
;
24530 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24531 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24532 glyph
->u
.glyphless
.len
= len
;
24533 glyph
->u
.glyphless
.ch
= it
->c
;
24534 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24535 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24536 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24537 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24538 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24539 glyph
->multibyte_p
= it
->multibyte_p
;
24540 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24541 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24542 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24543 || it
->phys_descent
> it
->descent
);
24544 glyph
->padding_p
= 0;
24545 glyph
->glyph_not_available_p
= 0;
24546 glyph
->face_id
= face_id
;
24547 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24550 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24551 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24553 glyph
->bidi_type
= it
->bidi_it
.type
;
24555 ++it
->glyph_row
->used
[area
];
24558 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24562 /* Produce a glyph for a glyphless character for iterator IT.
24563 IT->glyphless_method specifies which method to use for displaying
24564 the character. See the description of enum
24565 glyphless_display_method in dispextern.h for the detail.
24567 FOR_NO_FONT is nonzero if and only if this is for a character for
24568 which no font was found. ACRONYM, if non-nil, is an acronym string
24569 for the character. */
24572 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24577 int base_width
, base_height
, width
, height
;
24578 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24581 /* Get the metrics of the base font. We always refer to the current
24583 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24584 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24585 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24586 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24587 base_height
= it
->ascent
+ it
->descent
;
24588 base_width
= font
->average_width
;
24590 /* Get a face ID for the glyph by utilizing a cache (the same way as
24591 done for `escape-glyph' in get_next_display_element). */
24592 if (it
->f
== last_glyphless_glyph_frame
24593 && it
->face_id
== last_glyphless_glyph_face_id
)
24595 face_id
= last_glyphless_glyph_merged_face_id
;
24599 /* Merge the `glyphless-char' face into the current face. */
24600 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24601 last_glyphless_glyph_frame
= it
->f
;
24602 last_glyphless_glyph_face_id
= it
->face_id
;
24603 last_glyphless_glyph_merged_face_id
= face_id
;
24606 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24608 it
->pixel_width
= THIN_SPACE_WIDTH
;
24610 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24612 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24614 width
= CHAR_WIDTH (it
->c
);
24617 else if (width
> 4)
24619 it
->pixel_width
= base_width
* width
;
24621 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24627 unsigned int code
[6];
24629 int ascent
, descent
;
24630 struct font_metrics metrics_upper
, metrics_lower
;
24632 face
= FACE_FROM_ID (it
->f
, face_id
);
24633 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24634 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24636 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24638 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24639 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24640 if (CONSP (acronym
))
24641 acronym
= XCAR (acronym
);
24642 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24646 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24647 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24650 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24651 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24652 upper_len
= (len
+ 1) / 2;
24653 font
->driver
->text_extents (font
, code
, upper_len
,
24655 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24660 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24661 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24662 upper_xoff
= upper_yoff
= 2; /* the typical case */
24663 if (base_width
>= width
)
24665 /* Align the upper to the left, the lower to the right. */
24666 it
->pixel_width
= base_width
;
24667 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24671 /* Center the shorter one. */
24672 it
->pixel_width
= width
;
24673 if (metrics_upper
.width
>= metrics_lower
.width
)
24674 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24677 /* FIXME: This code doesn't look right. It formerly was
24678 missing the "lower_xoff = 0;", which couldn't have
24679 been right since it left lower_xoff uninitialized. */
24681 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24685 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24686 top, bottom, and between upper and lower strings. */
24687 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24688 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24689 /* Center vertically.
24690 H:base_height, D:base_descent
24691 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24693 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24694 descent = D - H/2 + h/2;
24695 lower_yoff = descent - 2 - ld;
24696 upper_yoff = lower_yoff - la - 1 - ud; */
24697 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24698 descent
= it
->descent
- (base_height
- height
) / 2;
24699 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24700 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24701 - metrics_upper
.descent
);
24702 /* Don't make the height shorter than the base height. */
24703 if (height
> base_height
)
24705 it
->ascent
= ascent
;
24706 it
->descent
= descent
;
24710 it
->phys_ascent
= it
->ascent
;
24711 it
->phys_descent
= it
->descent
;
24713 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24714 upper_xoff
, upper_yoff
,
24715 lower_xoff
, lower_yoff
);
24717 take_vertical_position_into_account (it
);
24722 Produce glyphs/get display metrics for the display element IT is
24723 loaded with. See the description of struct it in dispextern.h
24724 for an overview of struct it. */
24727 x_produce_glyphs (struct it
*it
)
24729 int extra_line_spacing
= it
->extra_line_spacing
;
24731 it
->glyph_not_available_p
= 0;
24733 if (it
->what
== IT_CHARACTER
)
24736 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24737 struct font
*font
= face
->font
;
24738 struct font_metrics
*pcm
= NULL
;
24739 int boff
; /* baseline offset */
24743 /* When no suitable font is found, display this character by
24744 the method specified in the first extra slot of
24745 Vglyphless_char_display. */
24746 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24748 eassert (it
->what
== IT_GLYPHLESS
);
24749 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24753 boff
= font
->baseline_offset
;
24754 if (font
->vertical_centering
)
24755 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24757 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24763 if (it
->override_ascent
>= 0)
24765 it
->ascent
= it
->override_ascent
;
24766 it
->descent
= it
->override_descent
;
24767 boff
= it
->override_boff
;
24771 it
->ascent
= FONT_BASE (font
) + boff
;
24772 it
->descent
= FONT_DESCENT (font
) - boff
;
24775 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24777 pcm
= get_per_char_metric (font
, &char2b
);
24778 if (pcm
->width
== 0
24779 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24785 it
->phys_ascent
= pcm
->ascent
+ boff
;
24786 it
->phys_descent
= pcm
->descent
- boff
;
24787 it
->pixel_width
= pcm
->width
;
24791 it
->glyph_not_available_p
= 1;
24792 it
->phys_ascent
= it
->ascent
;
24793 it
->phys_descent
= it
->descent
;
24794 it
->pixel_width
= font
->space_width
;
24797 if (it
->constrain_row_ascent_descent_p
)
24799 if (it
->descent
> it
->max_descent
)
24801 it
->ascent
+= it
->descent
- it
->max_descent
;
24802 it
->descent
= it
->max_descent
;
24804 if (it
->ascent
> it
->max_ascent
)
24806 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24807 it
->ascent
= it
->max_ascent
;
24809 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24810 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24811 extra_line_spacing
= 0;
24814 /* If this is a space inside a region of text with
24815 `space-width' property, change its width. */
24816 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24818 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24820 /* If face has a box, add the box thickness to the character
24821 height. If character has a box line to the left and/or
24822 right, add the box line width to the character's width. */
24823 if (face
->box
!= FACE_NO_BOX
)
24825 int thick
= face
->box_line_width
;
24829 it
->ascent
+= thick
;
24830 it
->descent
+= thick
;
24835 if (it
->start_of_box_run_p
)
24836 it
->pixel_width
+= thick
;
24837 if (it
->end_of_box_run_p
)
24838 it
->pixel_width
+= thick
;
24841 /* If face has an overline, add the height of the overline
24842 (1 pixel) and a 1 pixel margin to the character height. */
24843 if (face
->overline_p
)
24844 it
->ascent
+= overline_margin
;
24846 if (it
->constrain_row_ascent_descent_p
)
24848 if (it
->ascent
> it
->max_ascent
)
24849 it
->ascent
= it
->max_ascent
;
24850 if (it
->descent
> it
->max_descent
)
24851 it
->descent
= it
->max_descent
;
24854 take_vertical_position_into_account (it
);
24856 /* If we have to actually produce glyphs, do it. */
24861 /* Translate a space with a `space-width' property
24862 into a stretch glyph. */
24863 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24864 / FONT_HEIGHT (font
));
24865 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24866 it
->ascent
+ it
->descent
, ascent
);
24871 /* If characters with lbearing or rbearing are displayed
24872 in this line, record that fact in a flag of the
24873 glyph row. This is used to optimize X output code. */
24874 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24875 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24877 if (! stretched_p
&& it
->pixel_width
== 0)
24878 /* We assure that all visible glyphs have at least 1-pixel
24880 it
->pixel_width
= 1;
24882 else if (it
->char_to_display
== '\n')
24884 /* A newline has no width, but we need the height of the
24885 line. But if previous part of the line sets a height,
24886 don't increase that height */
24888 Lisp_Object height
;
24889 Lisp_Object total_height
= Qnil
;
24891 it
->override_ascent
= -1;
24892 it
->pixel_width
= 0;
24895 height
= get_it_property (it
, Qline_height
);
24896 /* Split (line-height total-height) list */
24898 && CONSP (XCDR (height
))
24899 && NILP (XCDR (XCDR (height
))))
24901 total_height
= XCAR (XCDR (height
));
24902 height
= XCAR (height
);
24904 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24906 if (it
->override_ascent
>= 0)
24908 it
->ascent
= it
->override_ascent
;
24909 it
->descent
= it
->override_descent
;
24910 boff
= it
->override_boff
;
24914 it
->ascent
= FONT_BASE (font
) + boff
;
24915 it
->descent
= FONT_DESCENT (font
) - boff
;
24918 if (EQ (height
, Qt
))
24920 if (it
->descent
> it
->max_descent
)
24922 it
->ascent
+= it
->descent
- it
->max_descent
;
24923 it
->descent
= it
->max_descent
;
24925 if (it
->ascent
> it
->max_ascent
)
24927 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24928 it
->ascent
= it
->max_ascent
;
24930 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24931 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24932 it
->constrain_row_ascent_descent_p
= 1;
24933 extra_line_spacing
= 0;
24937 Lisp_Object spacing
;
24939 it
->phys_ascent
= it
->ascent
;
24940 it
->phys_descent
= it
->descent
;
24942 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24943 && face
->box
!= FACE_NO_BOX
24944 && face
->box_line_width
> 0)
24946 it
->ascent
+= face
->box_line_width
;
24947 it
->descent
+= face
->box_line_width
;
24950 && XINT (height
) > it
->ascent
+ it
->descent
)
24951 it
->ascent
= XINT (height
) - it
->descent
;
24953 if (!NILP (total_height
))
24954 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24957 spacing
= get_it_property (it
, Qline_spacing
);
24958 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24960 if (INTEGERP (spacing
))
24962 extra_line_spacing
= XINT (spacing
);
24963 if (!NILP (total_height
))
24964 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24968 else /* i.e. (it->char_to_display == '\t') */
24970 if (font
->space_width
> 0)
24972 int tab_width
= it
->tab_width
* font
->space_width
;
24973 int x
= it
->current_x
+ it
->continuation_lines_width
;
24974 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24976 /* If the distance from the current position to the next tab
24977 stop is less than a space character width, use the
24978 tab stop after that. */
24979 if (next_tab_x
- x
< font
->space_width
)
24980 next_tab_x
+= tab_width
;
24982 it
->pixel_width
= next_tab_x
- x
;
24984 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24985 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24989 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24990 it
->ascent
+ it
->descent
, it
->ascent
);
24995 it
->pixel_width
= 0;
25000 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
25002 /* A static composition.
25004 Note: A composition is represented as one glyph in the
25005 glyph matrix. There are no padding glyphs.
25007 Important note: pixel_width, ascent, and descent are the
25008 values of what is drawn by draw_glyphs (i.e. the values of
25009 the overall glyphs composed). */
25010 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25011 int boff
; /* baseline offset */
25012 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
25013 int glyph_len
= cmp
->glyph_len
;
25014 struct font
*font
= face
->font
;
25018 /* If we have not yet calculated pixel size data of glyphs of
25019 the composition for the current face font, calculate them
25020 now. Theoretically, we have to check all fonts for the
25021 glyphs, but that requires much time and memory space. So,
25022 here we check only the font of the first glyph. This may
25023 lead to incorrect display, but it's very rare, and C-l
25024 (recenter-top-bottom) can correct the display anyway. */
25025 if (! cmp
->font
|| cmp
->font
!= font
)
25027 /* Ascent and descent of the font of the first character
25028 of this composition (adjusted by baseline offset).
25029 Ascent and descent of overall glyphs should not be less
25030 than these, respectively. */
25031 int font_ascent
, font_descent
, font_height
;
25032 /* Bounding box of the overall glyphs. */
25033 int leftmost
, rightmost
, lowest
, highest
;
25034 int lbearing
, rbearing
;
25035 int i
, width
, ascent
, descent
;
25036 int left_padded
= 0, right_padded
= 0;
25037 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
25039 struct font_metrics
*pcm
;
25040 int font_not_found_p
;
25043 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
25044 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
25046 if (glyph_len
< cmp
->glyph_len
)
25048 for (i
= 0; i
< glyph_len
; i
++)
25050 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
25052 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25057 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
25058 : IT_CHARPOS (*it
));
25059 /* If no suitable font is found, use the default font. */
25060 font_not_found_p
= font
== NULL
;
25061 if (font_not_found_p
)
25063 face
= face
->ascii_face
;
25066 boff
= font
->baseline_offset
;
25067 if (font
->vertical_centering
)
25068 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25069 font_ascent
= FONT_BASE (font
) + boff
;
25070 font_descent
= FONT_DESCENT (font
) - boff
;
25071 font_height
= FONT_HEIGHT (font
);
25076 if (! font_not_found_p
)
25078 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
25080 pcm
= get_per_char_metric (font
, &char2b
);
25083 /* Initialize the bounding box. */
25086 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
25087 ascent
= pcm
->ascent
;
25088 descent
= pcm
->descent
;
25089 lbearing
= pcm
->lbearing
;
25090 rbearing
= pcm
->rbearing
;
25094 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
25095 ascent
= FONT_BASE (font
);
25096 descent
= FONT_DESCENT (font
);
25103 lowest
= - descent
+ boff
;
25104 highest
= ascent
+ boff
;
25106 if (! font_not_found_p
25107 && font
->default_ascent
25108 && CHAR_TABLE_P (Vuse_default_ascent
)
25109 && !NILP (Faref (Vuse_default_ascent
,
25110 make_number (it
->char_to_display
))))
25111 highest
= font
->default_ascent
+ boff
;
25113 /* Draw the first glyph at the normal position. It may be
25114 shifted to right later if some other glyphs are drawn
25116 cmp
->offsets
[i
* 2] = 0;
25117 cmp
->offsets
[i
* 2 + 1] = boff
;
25118 cmp
->lbearing
= lbearing
;
25119 cmp
->rbearing
= rbearing
;
25121 /* Set cmp->offsets for the remaining glyphs. */
25122 for (i
++; i
< glyph_len
; i
++)
25124 int left
, right
, btm
, top
;
25125 int ch
= COMPOSITION_GLYPH (cmp
, i
);
25127 struct face
*this_face
;
25131 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
25132 this_face
= FACE_FROM_ID (it
->f
, face_id
);
25133 font
= this_face
->font
;
25139 get_char_face_and_encoding (it
->f
, ch
, face_id
,
25141 pcm
= get_per_char_metric (font
, &char2b
);
25144 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25147 width
= pcm
->width
;
25148 ascent
= pcm
->ascent
;
25149 descent
= pcm
->descent
;
25150 lbearing
= pcm
->lbearing
;
25151 rbearing
= pcm
->rbearing
;
25152 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
25154 /* Relative composition with or without
25155 alternate chars. */
25156 left
= (leftmost
+ rightmost
- width
) / 2;
25157 btm
= - descent
+ boff
;
25158 if (font
->relative_compose
25159 && (! CHAR_TABLE_P (Vignore_relative_composition
)
25160 || NILP (Faref (Vignore_relative_composition
,
25161 make_number (ch
)))))
25164 if (- descent
>= font
->relative_compose
)
25165 /* One extra pixel between two glyphs. */
25167 else if (ascent
<= 0)
25168 /* One extra pixel between two glyphs. */
25169 btm
= lowest
- 1 - ascent
- descent
;
25174 /* A composition rule is specified by an integer
25175 value that encodes global and new reference
25176 points (GREF and NREF). GREF and NREF are
25177 specified by numbers as below:
25179 0---1---2 -- ascent
25183 9--10--11 -- center
25185 ---3---4---5--- baseline
25187 6---7---8 -- descent
25189 int rule
= COMPOSITION_RULE (cmp
, i
);
25190 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
25192 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
25193 grefx
= gref
% 3, nrefx
= nref
% 3;
25194 grefy
= gref
/ 3, nrefy
= nref
/ 3;
25196 xoff
= font_height
* (xoff
- 128) / 256;
25198 yoff
= font_height
* (yoff
- 128) / 256;
25201 + grefx
* (rightmost
- leftmost
) / 2
25202 - nrefx
* width
/ 2
25205 btm
= ((grefy
== 0 ? highest
25207 : grefy
== 2 ? lowest
25208 : (highest
+ lowest
) / 2)
25209 - (nrefy
== 0 ? ascent
+ descent
25210 : nrefy
== 1 ? descent
- boff
25212 : (ascent
+ descent
) / 2)
25216 cmp
->offsets
[i
* 2] = left
;
25217 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
25219 /* Update the bounding box of the overall glyphs. */
25222 right
= left
+ width
;
25223 if (left
< leftmost
)
25225 if (right
> rightmost
)
25228 top
= btm
+ descent
+ ascent
;
25234 if (cmp
->lbearing
> left
+ lbearing
)
25235 cmp
->lbearing
= left
+ lbearing
;
25236 if (cmp
->rbearing
< left
+ rbearing
)
25237 cmp
->rbearing
= left
+ rbearing
;
25241 /* If there are glyphs whose x-offsets are negative,
25242 shift all glyphs to the right and make all x-offsets
25246 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25247 cmp
->offsets
[i
* 2] -= leftmost
;
25248 rightmost
-= leftmost
;
25249 cmp
->lbearing
-= leftmost
;
25250 cmp
->rbearing
-= leftmost
;
25253 if (left_padded
&& cmp
->lbearing
< 0)
25255 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25256 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
25257 rightmost
-= cmp
->lbearing
;
25258 cmp
->rbearing
-= cmp
->lbearing
;
25261 if (right_padded
&& rightmost
< cmp
->rbearing
)
25263 rightmost
= cmp
->rbearing
;
25266 cmp
->pixel_width
= rightmost
;
25267 cmp
->ascent
= highest
;
25268 cmp
->descent
= - lowest
;
25269 if (cmp
->ascent
< font_ascent
)
25270 cmp
->ascent
= font_ascent
;
25271 if (cmp
->descent
< font_descent
)
25272 cmp
->descent
= font_descent
;
25276 && (cmp
->lbearing
< 0
25277 || cmp
->rbearing
> cmp
->pixel_width
))
25278 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25280 it
->pixel_width
= cmp
->pixel_width
;
25281 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
25282 it
->descent
= it
->phys_descent
= cmp
->descent
;
25283 if (face
->box
!= FACE_NO_BOX
)
25285 int thick
= face
->box_line_width
;
25289 it
->ascent
+= thick
;
25290 it
->descent
+= thick
;
25295 if (it
->start_of_box_run_p
)
25296 it
->pixel_width
+= thick
;
25297 if (it
->end_of_box_run_p
)
25298 it
->pixel_width
+= thick
;
25301 /* If face has an overline, add the height of the overline
25302 (1 pixel) and a 1 pixel margin to the character height. */
25303 if (face
->overline_p
)
25304 it
->ascent
+= overline_margin
;
25306 take_vertical_position_into_account (it
);
25307 if (it
->ascent
< 0)
25309 if (it
->descent
< 0)
25312 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
25313 append_composite_glyph (it
);
25315 else if (it
->what
== IT_COMPOSITION
)
25317 /* A dynamic (automatic) composition. */
25318 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25319 Lisp_Object gstring
;
25320 struct font_metrics metrics
;
25324 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
25326 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
25329 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
25330 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25331 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
25332 it
->descent
= it
->phys_descent
= metrics
.descent
;
25333 if (face
->box
!= FACE_NO_BOX
)
25335 int thick
= face
->box_line_width
;
25339 it
->ascent
+= thick
;
25340 it
->descent
+= thick
;
25345 if (it
->start_of_box_run_p
)
25346 it
->pixel_width
+= thick
;
25347 if (it
->end_of_box_run_p
)
25348 it
->pixel_width
+= thick
;
25350 /* If face has an overline, add the height of the overline
25351 (1 pixel) and a 1 pixel margin to the character height. */
25352 if (face
->overline_p
)
25353 it
->ascent
+= overline_margin
;
25354 take_vertical_position_into_account (it
);
25355 if (it
->ascent
< 0)
25357 if (it
->descent
< 0)
25361 append_composite_glyph (it
);
25363 else if (it
->what
== IT_GLYPHLESS
)
25364 produce_glyphless_glyph (it
, 0, Qnil
);
25365 else if (it
->what
== IT_IMAGE
)
25366 produce_image_glyph (it
);
25367 else if (it
->what
== IT_STRETCH
)
25368 produce_stretch_glyph (it
);
25371 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25372 because this isn't true for images with `:ascent 100'. */
25373 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
25374 if (it
->area
== TEXT_AREA
)
25375 it
->current_x
+= it
->pixel_width
;
25377 if (extra_line_spacing
> 0)
25379 it
->descent
+= extra_line_spacing
;
25380 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25381 it
->max_extra_line_spacing
= extra_line_spacing
;
25384 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25385 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25386 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25387 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25391 Output LEN glyphs starting at START at the nominal cursor position.
25392 Advance the nominal cursor over the text. The global variable
25393 updated_window contains the window being updated, updated_row is
25394 the glyph row being updated, and updated_area is the area of that
25395 row being updated. */
25398 x_write_glyphs (struct glyph
*start
, int len
)
25400 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25402 eassert (updated_window
&& updated_row
);
25403 /* When the window is hscrolled, cursor hpos can legitimately be out
25404 of bounds, but we draw the cursor at the corresponding window
25405 margin in that case. */
25406 if (!updated_row
->reversed_p
&& chpos
< 0)
25408 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25409 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25413 /* Write glyphs. */
25415 hpos
= start
- updated_row
->glyphs
[updated_area
];
25416 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25417 updated_row
, updated_area
,
25419 DRAW_NORMAL_TEXT
, 0);
25421 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25422 if (updated_area
== TEXT_AREA
25423 && updated_window
->phys_cursor_on_p
25424 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25426 && chpos
< hpos
+ len
)
25427 updated_window
->phys_cursor_on_p
= 0;
25431 /* Advance the output cursor. */
25432 output_cursor
.hpos
+= len
;
25433 output_cursor
.x
= x
;
25438 Insert LEN glyphs from START at the nominal cursor position. */
25441 x_insert_glyphs (struct glyph
*start
, int len
)
25445 int line_height
, shift_by_width
, shifted_region_width
;
25446 struct glyph_row
*row
;
25447 struct glyph
*glyph
;
25448 int frame_x
, frame_y
;
25451 eassert (updated_window
&& updated_row
);
25453 w
= updated_window
;
25454 f
= XFRAME (WINDOW_FRAME (w
));
25456 /* Get the height of the line we are in. */
25458 line_height
= row
->height
;
25460 /* Get the width of the glyphs to insert. */
25461 shift_by_width
= 0;
25462 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25463 shift_by_width
+= glyph
->pixel_width
;
25465 /* Get the width of the region to shift right. */
25466 shifted_region_width
= (window_box_width (w
, updated_area
)
25471 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25472 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25474 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25475 line_height
, shift_by_width
);
25477 /* Write the glyphs. */
25478 hpos
= start
- row
->glyphs
[updated_area
];
25479 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25481 DRAW_NORMAL_TEXT
, 0);
25483 /* Advance the output cursor. */
25484 output_cursor
.hpos
+= len
;
25485 output_cursor
.x
+= shift_by_width
;
25491 Erase the current text line from the nominal cursor position
25492 (inclusive) to pixel column TO_X (exclusive). The idea is that
25493 everything from TO_X onward is already erased.
25495 TO_X is a pixel position relative to updated_area of
25496 updated_window. TO_X == -1 means clear to the end of this area. */
25499 x_clear_end_of_line (int to_x
)
25502 struct window
*w
= updated_window
;
25503 int max_x
, min_y
, max_y
;
25504 int from_x
, from_y
, to_y
;
25506 eassert (updated_window
&& updated_row
);
25507 f
= XFRAME (w
->frame
);
25509 if (updated_row
->full_width_p
)
25510 max_x
= WINDOW_TOTAL_WIDTH (w
);
25512 max_x
= window_box_width (w
, updated_area
);
25513 max_y
= window_text_bottom_y (w
);
25515 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25516 of window. For TO_X > 0, truncate to end of drawing area. */
25522 to_x
= min (to_x
, max_x
);
25524 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25526 /* Notice if the cursor will be cleared by this operation. */
25527 if (!updated_row
->full_width_p
)
25528 notice_overwritten_cursor (w
, updated_area
,
25529 output_cursor
.x
, -1,
25531 MATRIX_ROW_BOTTOM_Y (updated_row
));
25533 from_x
= output_cursor
.x
;
25535 /* Translate to frame coordinates. */
25536 if (updated_row
->full_width_p
)
25538 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25539 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25543 int area_left
= window_box_left (w
, updated_area
);
25544 from_x
+= area_left
;
25548 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25549 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25550 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25552 /* Prevent inadvertently clearing to end of the X window. */
25553 if (to_x
> from_x
&& to_y
> from_y
)
25556 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25557 to_x
- from_x
, to_y
- from_y
);
25562 #endif /* HAVE_WINDOW_SYSTEM */
25566 /***********************************************************************
25568 ***********************************************************************/
25570 /* Value is the internal representation of the specified cursor type
25571 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25572 of the bar cursor. */
25574 static enum text_cursor_kinds
25575 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25577 enum text_cursor_kinds type
;
25582 if (EQ (arg
, Qbox
))
25583 return FILLED_BOX_CURSOR
;
25585 if (EQ (arg
, Qhollow
))
25586 return HOLLOW_BOX_CURSOR
;
25588 if (EQ (arg
, Qbar
))
25595 && EQ (XCAR (arg
), Qbar
)
25596 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25598 *width
= XINT (XCDR (arg
));
25602 if (EQ (arg
, Qhbar
))
25605 return HBAR_CURSOR
;
25609 && EQ (XCAR (arg
), Qhbar
)
25610 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25612 *width
= XINT (XCDR (arg
));
25613 return HBAR_CURSOR
;
25616 /* Treat anything unknown as "hollow box cursor".
25617 It was bad to signal an error; people have trouble fixing
25618 .Xdefaults with Emacs, when it has something bad in it. */
25619 type
= HOLLOW_BOX_CURSOR
;
25624 /* Set the default cursor types for specified frame. */
25626 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25631 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25632 FRAME_CURSOR_WIDTH (f
) = width
;
25634 /* By default, set up the blink-off state depending on the on-state. */
25636 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25639 FRAME_BLINK_OFF_CURSOR (f
)
25640 = get_specified_cursor_type (XCDR (tem
), &width
);
25641 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25644 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25648 #ifdef HAVE_WINDOW_SYSTEM
25650 /* Return the cursor we want to be displayed in window W. Return
25651 width of bar/hbar cursor through WIDTH arg. Return with
25652 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25653 (i.e. if the `system caret' should track this cursor).
25655 In a mini-buffer window, we want the cursor only to appear if we
25656 are reading input from this window. For the selected window, we
25657 want the cursor type given by the frame parameter or buffer local
25658 setting of cursor-type. If explicitly marked off, draw no cursor.
25659 In all other cases, we want a hollow box cursor. */
25661 static enum text_cursor_kinds
25662 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25663 int *active_cursor
)
25665 struct frame
*f
= XFRAME (w
->frame
);
25666 struct buffer
*b
= XBUFFER (w
->buffer
);
25667 int cursor_type
= DEFAULT_CURSOR
;
25668 Lisp_Object alt_cursor
;
25669 int non_selected
= 0;
25671 *active_cursor
= 1;
25674 if (cursor_in_echo_area
25675 && FRAME_HAS_MINIBUF_P (f
)
25676 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25678 if (w
== XWINDOW (echo_area_window
))
25680 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25682 *width
= FRAME_CURSOR_WIDTH (f
);
25683 return FRAME_DESIRED_CURSOR (f
);
25686 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25689 *active_cursor
= 0;
25693 /* Detect a nonselected window or nonselected frame. */
25694 else if (w
!= XWINDOW (f
->selected_window
)
25695 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25697 *active_cursor
= 0;
25699 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25705 /* Never display a cursor in a window in which cursor-type is nil. */
25706 if (NILP (BVAR (b
, cursor_type
)))
25709 /* Get the normal cursor type for this window. */
25710 if (EQ (BVAR (b
, cursor_type
), Qt
))
25712 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25713 *width
= FRAME_CURSOR_WIDTH (f
);
25716 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25718 /* Use cursor-in-non-selected-windows instead
25719 for non-selected window or frame. */
25722 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25723 if (!EQ (Qt
, alt_cursor
))
25724 return get_specified_cursor_type (alt_cursor
, width
);
25725 /* t means modify the normal cursor type. */
25726 if (cursor_type
== FILLED_BOX_CURSOR
)
25727 cursor_type
= HOLLOW_BOX_CURSOR
;
25728 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25730 return cursor_type
;
25733 /* Use normal cursor if not blinked off. */
25734 if (!w
->cursor_off_p
)
25736 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25738 if (cursor_type
== FILLED_BOX_CURSOR
)
25740 /* Using a block cursor on large images can be very annoying.
25741 So use a hollow cursor for "large" images.
25742 If image is not transparent (no mask), also use hollow cursor. */
25743 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25744 if (img
!= NULL
&& IMAGEP (img
->spec
))
25746 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25747 where N = size of default frame font size.
25748 This should cover most of the "tiny" icons people may use. */
25750 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25751 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25752 cursor_type
= HOLLOW_BOX_CURSOR
;
25755 else if (cursor_type
!= NO_CURSOR
)
25757 /* Display current only supports BOX and HOLLOW cursors for images.
25758 So for now, unconditionally use a HOLLOW cursor when cursor is
25759 not a solid box cursor. */
25760 cursor_type
= HOLLOW_BOX_CURSOR
;
25763 return cursor_type
;
25766 /* Cursor is blinked off, so determine how to "toggle" it. */
25768 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25769 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25770 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25772 /* Then see if frame has specified a specific blink off cursor type. */
25773 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25775 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25776 return FRAME_BLINK_OFF_CURSOR (f
);
25780 /* Some people liked having a permanently visible blinking cursor,
25781 while others had very strong opinions against it. So it was
25782 decided to remove it. KFS 2003-09-03 */
25784 /* Finally perform built-in cursor blinking:
25785 filled box <-> hollow box
25786 wide [h]bar <-> narrow [h]bar
25787 narrow [h]bar <-> no cursor
25788 other type <-> no cursor */
25790 if (cursor_type
== FILLED_BOX_CURSOR
)
25791 return HOLLOW_BOX_CURSOR
;
25793 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25796 return cursor_type
;
25804 /* Notice when the text cursor of window W has been completely
25805 overwritten by a drawing operation that outputs glyphs in AREA
25806 starting at X0 and ending at X1 in the line starting at Y0 and
25807 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25808 the rest of the line after X0 has been written. Y coordinates
25809 are window-relative. */
25812 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25813 int x0
, int x1
, int y0
, int y1
)
25815 int cx0
, cx1
, cy0
, cy1
;
25816 struct glyph_row
*row
;
25818 if (!w
->phys_cursor_on_p
)
25820 if (area
!= TEXT_AREA
)
25823 if (w
->phys_cursor
.vpos
< 0
25824 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25825 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25826 !(row
->enabled_p
&& row
->displays_text_p
)))
25829 if (row
->cursor_in_fringe_p
)
25831 row
->cursor_in_fringe_p
= 0;
25832 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25833 w
->phys_cursor_on_p
= 0;
25837 cx0
= w
->phys_cursor
.x
;
25838 cx1
= cx0
+ w
->phys_cursor_width
;
25839 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25842 /* The cursor image will be completely removed from the
25843 screen if the output area intersects the cursor area in
25844 y-direction. When we draw in [y0 y1[, and some part of
25845 the cursor is at y < y0, that part must have been drawn
25846 before. When scrolling, the cursor is erased before
25847 actually scrolling, so we don't come here. When not
25848 scrolling, the rows above the old cursor row must have
25849 changed, and in this case these rows must have written
25850 over the cursor image.
25852 Likewise if part of the cursor is below y1, with the
25853 exception of the cursor being in the first blank row at
25854 the buffer and window end because update_text_area
25855 doesn't draw that row. (Except when it does, but
25856 that's handled in update_text_area.) */
25858 cy0
= w
->phys_cursor
.y
;
25859 cy1
= cy0
+ w
->phys_cursor_height
;
25860 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25863 w
->phys_cursor_on_p
= 0;
25866 #endif /* HAVE_WINDOW_SYSTEM */
25869 /************************************************************************
25871 ************************************************************************/
25873 #ifdef HAVE_WINDOW_SYSTEM
25876 Fix the display of area AREA of overlapping row ROW in window W
25877 with respect to the overlapping part OVERLAPS. */
25880 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25881 enum glyph_row_area area
, int overlaps
)
25888 for (i
= 0; i
< row
->used
[area
];)
25890 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25892 int start
= i
, start_x
= x
;
25896 x
+= row
->glyphs
[area
][i
].pixel_width
;
25899 while (i
< row
->used
[area
]
25900 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25902 draw_glyphs (w
, start_x
, row
, area
,
25904 DRAW_NORMAL_TEXT
, overlaps
);
25908 x
+= row
->glyphs
[area
][i
].pixel_width
;
25918 Draw the cursor glyph of window W in glyph row ROW. See the
25919 comment of draw_glyphs for the meaning of HL. */
25922 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25923 enum draw_glyphs_face hl
)
25925 /* If cursor hpos is out of bounds, don't draw garbage. This can
25926 happen in mini-buffer windows when switching between echo area
25927 glyphs and mini-buffer. */
25928 if ((row
->reversed_p
25929 ? (w
->phys_cursor
.hpos
>= 0)
25930 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25932 int on_p
= w
->phys_cursor_on_p
;
25934 int hpos
= w
->phys_cursor
.hpos
;
25936 /* When the window is hscrolled, cursor hpos can legitimately be
25937 out of bounds, but we draw the cursor at the corresponding
25938 window margin in that case. */
25939 if (!row
->reversed_p
&& hpos
< 0)
25941 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25942 hpos
= row
->used
[TEXT_AREA
] - 1;
25944 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25946 w
->phys_cursor_on_p
= on_p
;
25948 if (hl
== DRAW_CURSOR
)
25949 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25950 /* When we erase the cursor, and ROW is overlapped by other
25951 rows, make sure that these overlapping parts of other rows
25953 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25955 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25957 if (row
> w
->current_matrix
->rows
25958 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25959 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25960 OVERLAPS_ERASED_CURSOR
);
25962 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25963 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25964 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25965 OVERLAPS_ERASED_CURSOR
);
25972 Erase the image of a cursor of window W from the screen. */
25975 erase_phys_cursor (struct window
*w
)
25977 struct frame
*f
= XFRAME (w
->frame
);
25978 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25979 int hpos
= w
->phys_cursor
.hpos
;
25980 int vpos
= w
->phys_cursor
.vpos
;
25981 int mouse_face_here_p
= 0;
25982 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25983 struct glyph_row
*cursor_row
;
25984 struct glyph
*cursor_glyph
;
25985 enum draw_glyphs_face hl
;
25987 /* No cursor displayed or row invalidated => nothing to do on the
25989 if (w
->phys_cursor_type
== NO_CURSOR
)
25990 goto mark_cursor_off
;
25992 /* VPOS >= active_glyphs->nrows means that window has been resized.
25993 Don't bother to erase the cursor. */
25994 if (vpos
>= active_glyphs
->nrows
)
25995 goto mark_cursor_off
;
25997 /* If row containing cursor is marked invalid, there is nothing we
25999 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
26000 if (!cursor_row
->enabled_p
)
26001 goto mark_cursor_off
;
26003 /* If line spacing is > 0, old cursor may only be partially visible in
26004 window after split-window. So adjust visible height. */
26005 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
26006 window_text_bottom_y (w
) - cursor_row
->y
);
26008 /* If row is completely invisible, don't attempt to delete a cursor which
26009 isn't there. This can happen if cursor is at top of a window, and
26010 we switch to a buffer with a header line in that window. */
26011 if (cursor_row
->visible_height
<= 0)
26012 goto mark_cursor_off
;
26014 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
26015 if (cursor_row
->cursor_in_fringe_p
)
26017 cursor_row
->cursor_in_fringe_p
= 0;
26018 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
26019 goto mark_cursor_off
;
26022 /* This can happen when the new row is shorter than the old one.
26023 In this case, either draw_glyphs or clear_end_of_line
26024 should have cleared the cursor. Note that we wouldn't be
26025 able to erase the cursor in this case because we don't have a
26026 cursor glyph at hand. */
26027 if ((cursor_row
->reversed_p
26028 ? (w
->phys_cursor
.hpos
< 0)
26029 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
26030 goto mark_cursor_off
;
26032 /* When the window is hscrolled, cursor hpos can legitimately be out
26033 of bounds, but we draw the cursor at the corresponding window
26034 margin in that case. */
26035 if (!cursor_row
->reversed_p
&& hpos
< 0)
26037 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
26038 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
26040 /* If the cursor is in the mouse face area, redisplay that when
26041 we clear the cursor. */
26042 if (! NILP (hlinfo
->mouse_face_window
)
26043 && coords_in_mouse_face_p (w
, hpos
, vpos
)
26044 /* Don't redraw the cursor's spot in mouse face if it is at the
26045 end of a line (on a newline). The cursor appears there, but
26046 mouse highlighting does not. */
26047 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
26048 mouse_face_here_p
= 1;
26050 /* Maybe clear the display under the cursor. */
26051 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
26054 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
26057 cursor_glyph
= get_phys_cursor_glyph (w
);
26058 if (cursor_glyph
== NULL
)
26059 goto mark_cursor_off
;
26061 width
= cursor_glyph
->pixel_width
;
26062 left_x
= window_box_left_offset (w
, TEXT_AREA
);
26063 x
= w
->phys_cursor
.x
;
26065 width
-= left_x
- x
;
26066 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
26067 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
26068 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
26071 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
26074 /* Erase the cursor by redrawing the character underneath it. */
26075 if (mouse_face_here_p
)
26076 hl
= DRAW_MOUSE_FACE
;
26078 hl
= DRAW_NORMAL_TEXT
;
26079 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
26082 w
->phys_cursor_on_p
= 0;
26083 w
->phys_cursor_type
= NO_CURSOR
;
26088 Display or clear cursor of window W. If ON is zero, clear the
26089 cursor. If it is non-zero, display the cursor. If ON is nonzero,
26090 where to put the cursor is specified by HPOS, VPOS, X and Y. */
26093 display_and_set_cursor (struct window
*w
, int on
,
26094 int hpos
, int vpos
, int x
, int y
)
26096 struct frame
*f
= XFRAME (w
->frame
);
26097 int new_cursor_type
;
26098 int new_cursor_width
;
26100 struct glyph_row
*glyph_row
;
26101 struct glyph
*glyph
;
26103 /* This is pointless on invisible frames, and dangerous on garbaged
26104 windows and frames; in the latter case, the frame or window may
26105 be in the midst of changing its size, and x and y may be off the
26107 if (! FRAME_VISIBLE_P (f
)
26108 || FRAME_GARBAGED_P (f
)
26109 || vpos
>= w
->current_matrix
->nrows
26110 || hpos
>= w
->current_matrix
->matrix_w
)
26113 /* If cursor is off and we want it off, return quickly. */
26114 if (!on
&& !w
->phys_cursor_on_p
)
26117 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26118 /* If cursor row is not enabled, we don't really know where to
26119 display the cursor. */
26120 if (!glyph_row
->enabled_p
)
26122 w
->phys_cursor_on_p
= 0;
26127 if (!glyph_row
->exact_window_width_line_p
26128 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
26129 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
26131 eassert (input_blocked_p ());
26133 /* Set new_cursor_type to the cursor we want to be displayed. */
26134 new_cursor_type
= get_window_cursor_type (w
, glyph
,
26135 &new_cursor_width
, &active_cursor
);
26137 /* If cursor is currently being shown and we don't want it to be or
26138 it is in the wrong place, or the cursor type is not what we want,
26140 if (w
->phys_cursor_on_p
26142 || w
->phys_cursor
.x
!= x
26143 || w
->phys_cursor
.y
!= y
26144 || new_cursor_type
!= w
->phys_cursor_type
26145 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
26146 && new_cursor_width
!= w
->phys_cursor_width
)))
26147 erase_phys_cursor (w
);
26149 /* Don't check phys_cursor_on_p here because that flag is only set
26150 to zero in some cases where we know that the cursor has been
26151 completely erased, to avoid the extra work of erasing the cursor
26152 twice. In other words, phys_cursor_on_p can be 1 and the cursor
26153 still not be visible, or it has only been partly erased. */
26156 w
->phys_cursor_ascent
= glyph_row
->ascent
;
26157 w
->phys_cursor_height
= glyph_row
->height
;
26159 /* Set phys_cursor_.* before x_draw_.* is called because some
26160 of them may need the information. */
26161 w
->phys_cursor
.x
= x
;
26162 w
->phys_cursor
.y
= glyph_row
->y
;
26163 w
->phys_cursor
.hpos
= hpos
;
26164 w
->phys_cursor
.vpos
= vpos
;
26167 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
26168 new_cursor_type
, new_cursor_width
,
26169 on
, active_cursor
);
26173 /* Switch the display of W's cursor on or off, according to the value
26177 update_window_cursor (struct window
*w
, int on
)
26179 /* Don't update cursor in windows whose frame is in the process
26180 of being deleted. */
26181 if (w
->current_matrix
)
26183 int hpos
= w
->phys_cursor
.hpos
;
26184 int vpos
= w
->phys_cursor
.vpos
;
26185 struct glyph_row
*row
;
26187 if (vpos
>= w
->current_matrix
->nrows
26188 || hpos
>= w
->current_matrix
->matrix_w
)
26191 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26193 /* When the window is hscrolled, cursor hpos can legitimately be
26194 out of bounds, but we draw the cursor at the corresponding
26195 window margin in that case. */
26196 if (!row
->reversed_p
&& hpos
< 0)
26198 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26199 hpos
= row
->used
[TEXT_AREA
] - 1;
26202 display_and_set_cursor (w
, on
, hpos
, vpos
,
26203 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26209 /* Call update_window_cursor with parameter ON_P on all leaf windows
26210 in the window tree rooted at W. */
26213 update_cursor_in_window_tree (struct window
*w
, int on_p
)
26217 if (!NILP (w
->hchild
))
26218 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
26219 else if (!NILP (w
->vchild
))
26220 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
26222 update_window_cursor (w
, on_p
);
26224 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
26230 Display the cursor on window W, or clear it, according to ON_P.
26231 Don't change the cursor's position. */
26234 x_update_cursor (struct frame
*f
, int on_p
)
26236 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
26241 Clear the cursor of window W to background color, and mark the
26242 cursor as not shown. This is used when the text where the cursor
26243 is about to be rewritten. */
26246 x_clear_cursor (struct window
*w
)
26248 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
26249 update_window_cursor (w
, 0);
26252 #endif /* HAVE_WINDOW_SYSTEM */
26254 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26257 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
26258 int start_hpos
, int end_hpos
,
26259 enum draw_glyphs_face draw
)
26261 #ifdef HAVE_WINDOW_SYSTEM
26262 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
26264 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
26268 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26269 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
26273 /* Display the active region described by mouse_face_* according to DRAW. */
26276 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
26278 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
26279 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26281 if (/* If window is in the process of being destroyed, don't bother
26283 w
->current_matrix
!= NULL
26284 /* Don't update mouse highlight if hidden */
26285 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
26286 /* Recognize when we are called to operate on rows that don't exist
26287 anymore. This can happen when a window is split. */
26288 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
26290 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
26291 struct glyph_row
*row
, *first
, *last
;
26293 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
26294 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
26296 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
26298 int start_hpos
, end_hpos
, start_x
;
26300 /* For all but the first row, the highlight starts at column 0. */
26303 /* R2L rows have BEG and END in reversed order, but the
26304 screen drawing geometry is always left to right. So
26305 we need to mirror the beginning and end of the
26306 highlighted area in R2L rows. */
26307 if (!row
->reversed_p
)
26309 start_hpos
= hlinfo
->mouse_face_beg_col
;
26310 start_x
= hlinfo
->mouse_face_beg_x
;
26312 else if (row
== last
)
26314 start_hpos
= hlinfo
->mouse_face_end_col
;
26315 start_x
= hlinfo
->mouse_face_end_x
;
26323 else if (row
->reversed_p
&& row
== last
)
26325 start_hpos
= hlinfo
->mouse_face_end_col
;
26326 start_x
= hlinfo
->mouse_face_end_x
;
26336 if (!row
->reversed_p
)
26337 end_hpos
= hlinfo
->mouse_face_end_col
;
26338 else if (row
== first
)
26339 end_hpos
= hlinfo
->mouse_face_beg_col
;
26342 end_hpos
= row
->used
[TEXT_AREA
];
26343 if (draw
== DRAW_NORMAL_TEXT
)
26344 row
->fill_line_p
= 1; /* Clear to end of line */
26347 else if (row
->reversed_p
&& row
== first
)
26348 end_hpos
= hlinfo
->mouse_face_beg_col
;
26351 end_hpos
= row
->used
[TEXT_AREA
];
26352 if (draw
== DRAW_NORMAL_TEXT
)
26353 row
->fill_line_p
= 1; /* Clear to end of line */
26356 if (end_hpos
> start_hpos
)
26358 draw_row_with_mouse_face (w
, start_x
, row
,
26359 start_hpos
, end_hpos
, draw
);
26362 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26366 #ifdef HAVE_WINDOW_SYSTEM
26367 /* When we've written over the cursor, arrange for it to
26368 be displayed again. */
26369 if (FRAME_WINDOW_P (f
)
26370 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26372 int hpos
= w
->phys_cursor
.hpos
;
26374 /* When the window is hscrolled, cursor hpos can legitimately be
26375 out of bounds, but we draw the cursor at the corresponding
26376 window margin in that case. */
26377 if (!row
->reversed_p
&& hpos
< 0)
26379 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26380 hpos
= row
->used
[TEXT_AREA
] - 1;
26383 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26384 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26387 #endif /* HAVE_WINDOW_SYSTEM */
26390 #ifdef HAVE_WINDOW_SYSTEM
26391 /* Change the mouse cursor. */
26392 if (FRAME_WINDOW_P (f
))
26394 if (draw
== DRAW_NORMAL_TEXT
26395 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26396 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26397 else if (draw
== DRAW_MOUSE_FACE
)
26398 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26400 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26402 #endif /* HAVE_WINDOW_SYSTEM */
26406 Clear out the mouse-highlighted active region.
26407 Redraw it un-highlighted first. Value is non-zero if mouse
26408 face was actually drawn unhighlighted. */
26411 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26415 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26417 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26421 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26422 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26423 hlinfo
->mouse_face_window
= Qnil
;
26424 hlinfo
->mouse_face_overlay
= Qnil
;
26428 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26429 within the mouse face on that window. */
26431 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26433 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26435 /* Quickly resolve the easy cases. */
26436 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26437 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26439 if (vpos
< hlinfo
->mouse_face_beg_row
26440 || vpos
> hlinfo
->mouse_face_end_row
)
26442 if (vpos
> hlinfo
->mouse_face_beg_row
26443 && vpos
< hlinfo
->mouse_face_end_row
)
26446 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26448 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26450 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26453 else if ((vpos
== hlinfo
->mouse_face_beg_row
26454 && hpos
>= hlinfo
->mouse_face_beg_col
)
26455 || (vpos
== hlinfo
->mouse_face_end_row
26456 && hpos
< hlinfo
->mouse_face_end_col
))
26461 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26463 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26466 else if ((vpos
== hlinfo
->mouse_face_beg_row
26467 && hpos
<= hlinfo
->mouse_face_beg_col
)
26468 || (vpos
== hlinfo
->mouse_face_end_row
26469 && hpos
> hlinfo
->mouse_face_end_col
))
26477 Non-zero if physical cursor of window W is within mouse face. */
26480 cursor_in_mouse_face_p (struct window
*w
)
26482 int hpos
= w
->phys_cursor
.hpos
;
26483 int vpos
= w
->phys_cursor
.vpos
;
26484 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26486 /* When the window is hscrolled, cursor hpos can legitimately be out
26487 of bounds, but we draw the cursor at the corresponding window
26488 margin in that case. */
26489 if (!row
->reversed_p
&& hpos
< 0)
26491 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26492 hpos
= row
->used
[TEXT_AREA
] - 1;
26494 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26499 /* Find the glyph rows START_ROW and END_ROW of window W that display
26500 characters between buffer positions START_CHARPOS and END_CHARPOS
26501 (excluding END_CHARPOS). DISP_STRING is a display string that
26502 covers these buffer positions. This is similar to
26503 row_containing_pos, but is more accurate when bidi reordering makes
26504 buffer positions change non-linearly with glyph rows. */
26506 rows_from_pos_range (struct window
*w
,
26507 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26508 Lisp_Object disp_string
,
26509 struct glyph_row
**start
, struct glyph_row
**end
)
26511 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26512 int last_y
= window_text_bottom_y (w
);
26513 struct glyph_row
*row
;
26518 while (!first
->enabled_p
26519 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26522 /* Find the START row. */
26524 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26527 /* A row can potentially be the START row if the range of the
26528 characters it displays intersects the range
26529 [START_CHARPOS..END_CHARPOS). */
26530 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26531 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26532 /* See the commentary in row_containing_pos, for the
26533 explanation of the complicated way to check whether
26534 some position is beyond the end of the characters
26535 displayed by a row. */
26536 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26537 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26538 && !row
->ends_at_zv_p
26539 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26540 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26541 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26542 && !row
->ends_at_zv_p
26543 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26545 /* Found a candidate row. Now make sure at least one of the
26546 glyphs it displays has a charpos from the range
26547 [START_CHARPOS..END_CHARPOS).
26549 This is not obvious because bidi reordering could make
26550 buffer positions of a row be 1,2,3,102,101,100, and if we
26551 want to highlight characters in [50..60), we don't want
26552 this row, even though [50..60) does intersect [1..103),
26553 the range of character positions given by the row's start
26554 and end positions. */
26555 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26556 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26560 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26561 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26562 /* A glyph that comes from DISP_STRING is by
26563 definition to be highlighted. */
26564 || EQ (g
->object
, disp_string
))
26573 /* Find the END row. */
26575 /* If the last row is partially visible, start looking for END
26576 from that row, instead of starting from FIRST. */
26577 && !(row
->enabled_p
26578 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26580 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26582 struct glyph_row
*next
= row
+ 1;
26583 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26585 if (!next
->enabled_p
26586 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26587 /* The first row >= START whose range of displayed characters
26588 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26589 is the row END + 1. */
26590 || (start_charpos
< next_start
26591 && end_charpos
< next_start
)
26592 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26593 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26594 && !next
->ends_at_zv_p
26595 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26596 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26597 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26598 && !next
->ends_at_zv_p
26599 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26606 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26607 but none of the characters it displays are in the range, it is
26609 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26610 struct glyph
*s
= g
;
26611 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26615 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26616 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26617 /* If the buffer position of the first glyph in
26618 the row is equal to END_CHARPOS, it means
26619 the last character to be highlighted is the
26620 newline of ROW, and we must consider NEXT as
26622 || (((!next
->reversed_p
&& g
== s
)
26623 || (next
->reversed_p
&& g
== e
- 1))
26624 && (g
->charpos
== end_charpos
26625 /* Special case for when NEXT is an
26626 empty line at ZV. */
26627 || (g
->charpos
== -1
26628 && !row
->ends_at_zv_p
26629 && next_start
== end_charpos
)))))
26630 /* A glyph that comes from DISP_STRING is by
26631 definition to be highlighted. */
26632 || EQ (g
->object
, disp_string
))
26641 /* The first row that ends at ZV must be the last to be
26643 else if (next
->ends_at_zv_p
)
26652 /* This function sets the mouse_face_* elements of HLINFO, assuming
26653 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26654 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26655 for the overlay or run of text properties specifying the mouse
26656 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26657 before-string and after-string that must also be highlighted.
26658 DISP_STRING, if non-nil, is a display string that may cover some
26659 or all of the highlighted text. */
26662 mouse_face_from_buffer_pos (Lisp_Object window
,
26663 Mouse_HLInfo
*hlinfo
,
26664 ptrdiff_t mouse_charpos
,
26665 ptrdiff_t start_charpos
,
26666 ptrdiff_t end_charpos
,
26667 Lisp_Object before_string
,
26668 Lisp_Object after_string
,
26669 Lisp_Object disp_string
)
26671 struct window
*w
= XWINDOW (window
);
26672 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26673 struct glyph_row
*r1
, *r2
;
26674 struct glyph
*glyph
, *end
;
26675 ptrdiff_t ignore
, pos
;
26678 eassert (NILP (disp_string
) || STRINGP (disp_string
));
26679 eassert (NILP (before_string
) || STRINGP (before_string
));
26680 eassert (NILP (after_string
) || STRINGP (after_string
));
26682 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26683 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26685 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26686 /* If the before-string or display-string contains newlines,
26687 rows_from_pos_range skips to its last row. Move back. */
26688 if (!NILP (before_string
) || !NILP (disp_string
))
26690 struct glyph_row
*prev
;
26691 while ((prev
= r1
- 1, prev
>= first
)
26692 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26693 && prev
->used
[TEXT_AREA
] > 0)
26695 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26696 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26697 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26699 || !(EQ (glyph
->object
, before_string
)
26700 || EQ (glyph
->object
, disp_string
)))
26707 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26708 hlinfo
->mouse_face_past_end
= 1;
26710 else if (!NILP (after_string
))
26712 /* If the after-string has newlines, advance to its last row. */
26713 struct glyph_row
*next
;
26714 struct glyph_row
*last
26715 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26717 for (next
= r2
+ 1;
26719 && next
->used
[TEXT_AREA
] > 0
26720 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26724 /* The rest of the display engine assumes that mouse_face_beg_row is
26725 either above mouse_face_end_row or identical to it. But with
26726 bidi-reordered continued lines, the row for START_CHARPOS could
26727 be below the row for END_CHARPOS. If so, swap the rows and store
26728 them in correct order. */
26731 struct glyph_row
*tem
= r2
;
26737 hlinfo
->mouse_face_beg_y
= r1
->y
;
26738 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26739 hlinfo
->mouse_face_end_y
= r2
->y
;
26740 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26742 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26743 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26744 could be anywhere in the row and in any order. The strategy
26745 below is to find the leftmost and the rightmost glyph that
26746 belongs to either of these 3 strings, or whose position is
26747 between START_CHARPOS and END_CHARPOS, and highlight all the
26748 glyphs between those two. This may cover more than just the text
26749 between START_CHARPOS and END_CHARPOS if the range of characters
26750 strides the bidi level boundary, e.g. if the beginning is in R2L
26751 text while the end is in L2R text or vice versa. */
26752 if (!r1
->reversed_p
)
26754 /* This row is in a left to right paragraph. Scan it left to
26756 glyph
= r1
->glyphs
[TEXT_AREA
];
26757 end
= glyph
+ r1
->used
[TEXT_AREA
];
26760 /* Skip truncation glyphs at the start of the glyph row. */
26761 if (r1
->displays_text_p
)
26763 && INTEGERP (glyph
->object
)
26764 && glyph
->charpos
< 0;
26766 x
+= glyph
->pixel_width
;
26768 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26769 or DISP_STRING, and the first glyph from buffer whose
26770 position is between START_CHARPOS and END_CHARPOS. */
26772 && !INTEGERP (glyph
->object
)
26773 && !EQ (glyph
->object
, disp_string
)
26774 && !(BUFFERP (glyph
->object
)
26775 && (glyph
->charpos
>= start_charpos
26776 && glyph
->charpos
< end_charpos
));
26779 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26780 are present at buffer positions between START_CHARPOS and
26781 END_CHARPOS, or if they come from an overlay. */
26782 if (EQ (glyph
->object
, before_string
))
26784 pos
= string_buffer_position (before_string
,
26786 /* If pos == 0, it means before_string came from an
26787 overlay, not from a buffer position. */
26788 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26791 else if (EQ (glyph
->object
, after_string
))
26793 pos
= string_buffer_position (after_string
, end_charpos
);
26794 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26797 x
+= glyph
->pixel_width
;
26799 hlinfo
->mouse_face_beg_x
= x
;
26800 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26804 /* This row is in a right to left paragraph. Scan it right to
26808 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26809 glyph
= end
+ r1
->used
[TEXT_AREA
];
26811 /* Skip truncation glyphs at the start of the glyph row. */
26812 if (r1
->displays_text_p
)
26814 && INTEGERP (glyph
->object
)
26815 && glyph
->charpos
< 0;
26819 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26820 or DISP_STRING, and the first glyph from buffer whose
26821 position is between START_CHARPOS and END_CHARPOS. */
26823 && !INTEGERP (glyph
->object
)
26824 && !EQ (glyph
->object
, disp_string
)
26825 && !(BUFFERP (glyph
->object
)
26826 && (glyph
->charpos
>= start_charpos
26827 && glyph
->charpos
< end_charpos
));
26830 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26831 are present at buffer positions between START_CHARPOS and
26832 END_CHARPOS, or if they come from an overlay. */
26833 if (EQ (glyph
->object
, before_string
))
26835 pos
= string_buffer_position (before_string
, start_charpos
);
26836 /* If pos == 0, it means before_string came from an
26837 overlay, not from a buffer position. */
26838 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26841 else if (EQ (glyph
->object
, after_string
))
26843 pos
= string_buffer_position (after_string
, end_charpos
);
26844 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26849 glyph
++; /* first glyph to the right of the highlighted area */
26850 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26851 x
+= g
->pixel_width
;
26852 hlinfo
->mouse_face_beg_x
= x
;
26853 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26856 /* If the highlight ends in a different row, compute GLYPH and END
26857 for the end row. Otherwise, reuse the values computed above for
26858 the row where the highlight begins. */
26861 if (!r2
->reversed_p
)
26863 glyph
= r2
->glyphs
[TEXT_AREA
];
26864 end
= glyph
+ r2
->used
[TEXT_AREA
];
26869 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26870 glyph
= end
+ r2
->used
[TEXT_AREA
];
26874 if (!r2
->reversed_p
)
26876 /* Skip truncation and continuation glyphs near the end of the
26877 row, and also blanks and stretch glyphs inserted by
26878 extend_face_to_end_of_line. */
26880 && INTEGERP ((end
- 1)->object
))
26882 /* Scan the rest of the glyph row from the end, looking for the
26883 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26884 DISP_STRING, or whose position is between START_CHARPOS
26888 && !INTEGERP (end
->object
)
26889 && !EQ (end
->object
, disp_string
)
26890 && !(BUFFERP (end
->object
)
26891 && (end
->charpos
>= start_charpos
26892 && end
->charpos
< end_charpos
));
26895 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26896 are present at buffer positions between START_CHARPOS and
26897 END_CHARPOS, or if they come from an overlay. */
26898 if (EQ (end
->object
, before_string
))
26900 pos
= string_buffer_position (before_string
, start_charpos
);
26901 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26904 else if (EQ (end
->object
, after_string
))
26906 pos
= string_buffer_position (after_string
, end_charpos
);
26907 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26911 /* Find the X coordinate of the last glyph to be highlighted. */
26912 for (; glyph
<= end
; ++glyph
)
26913 x
+= glyph
->pixel_width
;
26915 hlinfo
->mouse_face_end_x
= x
;
26916 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26920 /* Skip truncation and continuation glyphs near the end of the
26921 row, and also blanks and stretch glyphs inserted by
26922 extend_face_to_end_of_line. */
26926 && INTEGERP (end
->object
))
26928 x
+= end
->pixel_width
;
26931 /* Scan the rest of the glyph row from the end, looking for the
26932 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26933 DISP_STRING, or whose position is between START_CHARPOS
26937 && !INTEGERP (end
->object
)
26938 && !EQ (end
->object
, disp_string
)
26939 && !(BUFFERP (end
->object
)
26940 && (end
->charpos
>= start_charpos
26941 && end
->charpos
< end_charpos
));
26944 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26945 are present at buffer positions between START_CHARPOS and
26946 END_CHARPOS, or if they come from an overlay. */
26947 if (EQ (end
->object
, before_string
))
26949 pos
= string_buffer_position (before_string
, start_charpos
);
26950 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26953 else if (EQ (end
->object
, after_string
))
26955 pos
= string_buffer_position (after_string
, end_charpos
);
26956 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26959 x
+= end
->pixel_width
;
26961 /* If we exited the above loop because we arrived at the last
26962 glyph of the row, and its buffer position is still not in
26963 range, it means the last character in range is the preceding
26964 newline. Bump the end column and x values to get past the
26967 && BUFFERP (end
->object
)
26968 && (end
->charpos
< start_charpos
26969 || end
->charpos
>= end_charpos
))
26971 x
+= end
->pixel_width
;
26974 hlinfo
->mouse_face_end_x
= x
;
26975 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26978 hlinfo
->mouse_face_window
= window
;
26979 hlinfo
->mouse_face_face_id
26980 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26982 !hlinfo
->mouse_face_hidden
, -1);
26983 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26986 /* The following function is not used anymore (replaced with
26987 mouse_face_from_string_pos), but I leave it here for the time
26988 being, in case someone would. */
26990 #if 0 /* not used */
26992 /* Find the position of the glyph for position POS in OBJECT in
26993 window W's current matrix, and return in *X, *Y the pixel
26994 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26996 RIGHT_P non-zero means return the position of the right edge of the
26997 glyph, RIGHT_P zero means return the left edge position.
26999 If no glyph for POS exists in the matrix, return the position of
27000 the glyph with the next smaller position that is in the matrix, if
27001 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
27002 exists in the matrix, return the position of the glyph with the
27003 next larger position in OBJECT.
27005 Value is non-zero if a glyph was found. */
27008 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
27009 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
27011 int yb
= window_text_bottom_y (w
);
27012 struct glyph_row
*r
;
27013 struct glyph
*best_glyph
= NULL
;
27014 struct glyph_row
*best_row
= NULL
;
27017 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27018 r
->enabled_p
&& r
->y
< yb
;
27021 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
27022 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
27025 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27026 if (EQ (g
->object
, object
))
27028 if (g
->charpos
== pos
)
27035 else if (best_glyph
== NULL
27036 || ((eabs (g
->charpos
- pos
)
27037 < eabs (best_glyph
->charpos
- pos
))
27040 : g
->charpos
> pos
)))
27054 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
27058 *x
+= best_glyph
->pixel_width
;
27063 *vpos
= best_row
- w
->current_matrix
->rows
;
27066 return best_glyph
!= NULL
;
27068 #endif /* not used */
27070 /* Find the positions of the first and the last glyphs in window W's
27071 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
27072 (assumed to be a string), and return in HLINFO's mouse_face_*
27073 members the pixel and column/row coordinates of those glyphs. */
27076 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
27077 Lisp_Object object
,
27078 ptrdiff_t startpos
, ptrdiff_t endpos
)
27080 int yb
= window_text_bottom_y (w
);
27081 struct glyph_row
*r
;
27082 struct glyph
*g
, *e
;
27086 /* Find the glyph row with at least one position in the range
27087 [STARTPOS..ENDPOS], and the first glyph in that row whose
27088 position belongs to that range. */
27089 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27090 r
->enabled_p
&& r
->y
< yb
;
27093 if (!r
->reversed_p
)
27095 g
= r
->glyphs
[TEXT_AREA
];
27096 e
= g
+ r
->used
[TEXT_AREA
];
27097 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27098 if (EQ (g
->object
, object
)
27099 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27101 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27102 hlinfo
->mouse_face_beg_y
= r
->y
;
27103 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27104 hlinfo
->mouse_face_beg_x
= gx
;
27113 e
= r
->glyphs
[TEXT_AREA
];
27114 g
= e
+ r
->used
[TEXT_AREA
];
27115 for ( ; g
> e
; --g
)
27116 if (EQ ((g
-1)->object
, object
)
27117 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
27119 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27120 hlinfo
->mouse_face_beg_y
= r
->y
;
27121 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27122 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
27123 gx
+= g1
->pixel_width
;
27124 hlinfo
->mouse_face_beg_x
= gx
;
27136 /* Starting with the next row, look for the first row which does NOT
27137 include any glyphs whose positions are in the range. */
27138 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
27140 g
= r
->glyphs
[TEXT_AREA
];
27141 e
= g
+ r
->used
[TEXT_AREA
];
27143 for ( ; g
< e
; ++g
)
27144 if (EQ (g
->object
, object
)
27145 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27154 /* The highlighted region ends on the previous row. */
27157 /* Set the end row and its vertical pixel coordinate. */
27158 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
27159 hlinfo
->mouse_face_end_y
= r
->y
;
27161 /* Compute and set the end column and the end column's horizontal
27162 pixel coordinate. */
27163 if (!r
->reversed_p
)
27165 g
= r
->glyphs
[TEXT_AREA
];
27166 e
= g
+ r
->used
[TEXT_AREA
];
27167 for ( ; e
> g
; --e
)
27168 if (EQ ((e
-1)->object
, object
)
27169 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
27171 hlinfo
->mouse_face_end_col
= e
- g
;
27173 for (gx
= r
->x
; g
< e
; ++g
)
27174 gx
+= g
->pixel_width
;
27175 hlinfo
->mouse_face_end_x
= gx
;
27179 e
= r
->glyphs
[TEXT_AREA
];
27180 g
= e
+ r
->used
[TEXT_AREA
];
27181 for (gx
= r
->x
; e
< g
; ++e
)
27183 if (EQ (e
->object
, object
)
27184 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
27186 gx
+= e
->pixel_width
;
27188 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
27189 hlinfo
->mouse_face_end_x
= gx
;
27193 #ifdef HAVE_WINDOW_SYSTEM
27195 /* See if position X, Y is within a hot-spot of an image. */
27198 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
27200 if (!CONSP (hot_spot
))
27203 if (EQ (XCAR (hot_spot
), Qrect
))
27205 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27206 Lisp_Object rect
= XCDR (hot_spot
);
27210 if (!CONSP (XCAR (rect
)))
27212 if (!CONSP (XCDR (rect
)))
27214 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
27216 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
27218 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
27220 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
27224 else if (EQ (XCAR (hot_spot
), Qcircle
))
27226 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27227 Lisp_Object circ
= XCDR (hot_spot
);
27228 Lisp_Object lr
, lx0
, ly0
;
27230 && CONSP (XCAR (circ
))
27231 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
27232 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
27233 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
27235 double r
= XFLOATINT (lr
);
27236 double dx
= XINT (lx0
) - x
;
27237 double dy
= XINT (ly0
) - y
;
27238 return (dx
* dx
+ dy
* dy
<= r
* r
);
27241 else if (EQ (XCAR (hot_spot
), Qpoly
))
27243 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27244 if (VECTORP (XCDR (hot_spot
)))
27246 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
27247 Lisp_Object
*poly
= v
->contents
;
27248 ptrdiff_t n
= v
->header
.size
;
27251 Lisp_Object lx
, ly
;
27254 /* Need an even number of coordinates, and at least 3 edges. */
27255 if (n
< 6 || n
& 1)
27258 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27259 If count is odd, we are inside polygon. Pixels on edges
27260 may or may not be included depending on actual geometry of the
27262 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
27263 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
27265 x0
= XINT (lx
), y0
= XINT (ly
);
27266 for (i
= 0; i
< n
; i
+= 2)
27268 int x1
= x0
, y1
= y0
;
27269 if ((lx
= poly
[i
], !INTEGERP (lx
))
27270 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
27272 x0
= XINT (lx
), y0
= XINT (ly
);
27274 /* Does this segment cross the X line? */
27282 if (y
> y0
&& y
> y1
)
27284 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
27294 find_hot_spot (Lisp_Object map
, int x
, int y
)
27296 while (CONSP (map
))
27298 if (CONSP (XCAR (map
))
27299 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
27307 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
27309 doc
: /* Lookup in image map MAP coordinates X and Y.
27310 An image map is an alist where each element has the format (AREA ID PLIST).
27311 An AREA is specified as either a rectangle, a circle, or a polygon:
27312 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27313 pixel coordinates of the upper left and bottom right corners.
27314 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27315 and the radius of the circle; r may be a float or integer.
27316 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27317 vector describes one corner in the polygon.
27318 Returns the alist element for the first matching AREA in MAP. */)
27319 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
27327 return find_hot_spot (map
,
27328 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
27329 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
27333 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27335 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
27337 /* Do not change cursor shape while dragging mouse. */
27338 if (!NILP (do_mouse_tracking
))
27341 if (!NILP (pointer
))
27343 if (EQ (pointer
, Qarrow
))
27344 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27345 else if (EQ (pointer
, Qhand
))
27346 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27347 else if (EQ (pointer
, Qtext
))
27348 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27349 else if (EQ (pointer
, intern ("hdrag")))
27350 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27351 #ifdef HAVE_X_WINDOWS
27352 else if (EQ (pointer
, intern ("vdrag")))
27353 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27355 else if (EQ (pointer
, intern ("hourglass")))
27356 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27357 else if (EQ (pointer
, Qmodeline
))
27358 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27360 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27363 if (cursor
!= No_Cursor
)
27364 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27367 #endif /* HAVE_WINDOW_SYSTEM */
27369 /* Take proper action when mouse has moved to the mode or header line
27370 or marginal area AREA of window W, x-position X and y-position Y.
27371 X is relative to the start of the text display area of W, so the
27372 width of bitmap areas and scroll bars must be subtracted to get a
27373 position relative to the start of the mode line. */
27376 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27377 enum window_part area
)
27379 struct window
*w
= XWINDOW (window
);
27380 struct frame
*f
= XFRAME (w
->frame
);
27381 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27382 #ifdef HAVE_WINDOW_SYSTEM
27383 Display_Info
*dpyinfo
;
27385 Cursor cursor
= No_Cursor
;
27386 Lisp_Object pointer
= Qnil
;
27387 int dx
, dy
, width
, height
;
27389 Lisp_Object string
, object
= Qnil
;
27390 Lisp_Object pos
IF_LINT (= Qnil
), help
;
27392 Lisp_Object mouse_face
;
27393 int original_x_pixel
= x
;
27394 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27395 struct glyph_row
*row
IF_LINT (= 0);
27397 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27402 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27403 returns them in row/column units! */
27404 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27405 &object
, &dx
, &dy
, &width
, &height
);
27407 row
= (area
== ON_MODE_LINE
27408 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27409 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27411 /* Find the glyph under the mouse pointer. */
27412 if (row
->mode_line_p
&& row
->enabled_p
)
27414 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27415 end
= glyph
+ row
->used
[TEXT_AREA
];
27417 for (x0
= original_x_pixel
;
27418 glyph
< end
&& x0
>= glyph
->pixel_width
;
27420 x0
-= glyph
->pixel_width
;
27428 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27429 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27430 returns them in row/column units! */
27431 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27432 &object
, &dx
, &dy
, &width
, &height
);
27437 #ifdef HAVE_WINDOW_SYSTEM
27438 if (IMAGEP (object
))
27440 Lisp_Object image_map
, hotspot
;
27441 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27443 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27445 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27449 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27450 If so, we could look for mouse-enter, mouse-leave
27451 properties in PLIST (and do something...). */
27452 hotspot
= XCDR (hotspot
);
27453 if (CONSP (hotspot
)
27454 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27456 pointer
= Fplist_get (plist
, Qpointer
);
27457 if (NILP (pointer
))
27459 help
= Fplist_get (plist
, Qhelp_echo
);
27462 help_echo_string
= help
;
27463 XSETWINDOW (help_echo_window
, w
);
27464 help_echo_object
= w
->buffer
;
27465 help_echo_pos
= charpos
;
27469 if (NILP (pointer
))
27470 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27472 #endif /* HAVE_WINDOW_SYSTEM */
27474 if (STRINGP (string
))
27475 pos
= make_number (charpos
);
27477 /* Set the help text and mouse pointer. If the mouse is on a part
27478 of the mode line without any text (e.g. past the right edge of
27479 the mode line text), use the default help text and pointer. */
27480 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27482 /* Arrange to display the help by setting the global variables
27483 help_echo_string, help_echo_object, and help_echo_pos. */
27486 if (STRINGP (string
))
27487 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27491 help_echo_string
= help
;
27492 XSETWINDOW (help_echo_window
, w
);
27493 help_echo_object
= string
;
27494 help_echo_pos
= charpos
;
27496 else if (area
== ON_MODE_LINE
)
27498 Lisp_Object default_help
27499 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27502 if (STRINGP (default_help
))
27504 help_echo_string
= default_help
;
27505 XSETWINDOW (help_echo_window
, w
);
27506 help_echo_object
= Qnil
;
27507 help_echo_pos
= -1;
27512 #ifdef HAVE_WINDOW_SYSTEM
27513 /* Change the mouse pointer according to what is under it. */
27514 if (FRAME_WINDOW_P (f
))
27516 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27517 if (STRINGP (string
))
27519 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27521 if (NILP (pointer
))
27522 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27524 /* Change the mouse pointer according to what is under X/Y. */
27526 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27529 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27530 if (!KEYMAPP (map
))
27531 map
= Fget_text_property (pos
, Qkeymap
, string
);
27532 if (!KEYMAPP (map
))
27533 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27537 /* Default mode-line pointer. */
27538 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27543 /* Change the mouse face according to what is under X/Y. */
27544 if (STRINGP (string
))
27546 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27547 if (!NILP (mouse_face
)
27548 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27553 struct glyph
* tmp_glyph
;
27557 int total_pixel_width
;
27558 ptrdiff_t begpos
, endpos
, ignore
;
27562 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27563 Qmouse_face
, string
, Qnil
);
27569 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27571 endpos
= SCHARS (string
);
27575 /* Calculate the glyph position GPOS of GLYPH in the
27576 displayed string, relative to the beginning of the
27577 highlighted part of the string.
27579 Note: GPOS is different from CHARPOS. CHARPOS is the
27580 position of GLYPH in the internal string object. A mode
27581 line string format has structures which are converted to
27582 a flattened string by the Emacs Lisp interpreter. The
27583 internal string is an element of those structures. The
27584 displayed string is the flattened string. */
27585 tmp_glyph
= row_start_glyph
;
27586 while (tmp_glyph
< glyph
27587 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27588 && begpos
<= tmp_glyph
->charpos
27589 && tmp_glyph
->charpos
< endpos
)))
27591 gpos
= glyph
- tmp_glyph
;
27593 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27594 the highlighted part of the displayed string to which
27595 GLYPH belongs. Note: GSEQ_LENGTH is different from
27596 SCHARS (STRING), because the latter returns the length of
27597 the internal string. */
27598 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27600 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27601 && begpos
<= tmp_glyph
->charpos
27602 && tmp_glyph
->charpos
< endpos
));
27605 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27607 /* Calculate the total pixel width of all the glyphs between
27608 the beginning of the highlighted area and GLYPH. */
27609 total_pixel_width
= 0;
27610 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27611 total_pixel_width
+= tmp_glyph
->pixel_width
;
27613 /* Pre calculation of re-rendering position. Note: X is in
27614 column units here, after the call to mode_line_string or
27615 marginal_area_string. */
27617 vpos
= (area
== ON_MODE_LINE
27618 ? (w
->current_matrix
)->nrows
- 1
27621 /* If GLYPH's position is included in the region that is
27622 already drawn in mouse face, we have nothing to do. */
27623 if ( EQ (window
, hlinfo
->mouse_face_window
)
27624 && (!row
->reversed_p
27625 ? (hlinfo
->mouse_face_beg_col
<= hpos
27626 && hpos
< hlinfo
->mouse_face_end_col
)
27627 /* In R2L rows we swap BEG and END, see below. */
27628 : (hlinfo
->mouse_face_end_col
<= hpos
27629 && hpos
< hlinfo
->mouse_face_beg_col
))
27630 && hlinfo
->mouse_face_beg_row
== vpos
)
27633 if (clear_mouse_face (hlinfo
))
27634 cursor
= No_Cursor
;
27636 if (!row
->reversed_p
)
27638 hlinfo
->mouse_face_beg_col
= hpos
;
27639 hlinfo
->mouse_face_beg_x
= original_x_pixel
27640 - (total_pixel_width
+ dx
);
27641 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27642 hlinfo
->mouse_face_end_x
= 0;
27646 /* In R2L rows, show_mouse_face expects BEG and END
27647 coordinates to be swapped. */
27648 hlinfo
->mouse_face_end_col
= hpos
;
27649 hlinfo
->mouse_face_end_x
= original_x_pixel
27650 - (total_pixel_width
+ dx
);
27651 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27652 hlinfo
->mouse_face_beg_x
= 0;
27655 hlinfo
->mouse_face_beg_row
= vpos
;
27656 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27657 hlinfo
->mouse_face_beg_y
= 0;
27658 hlinfo
->mouse_face_end_y
= 0;
27659 hlinfo
->mouse_face_past_end
= 0;
27660 hlinfo
->mouse_face_window
= window
;
27662 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27668 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27670 if (NILP (pointer
))
27673 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27674 clear_mouse_face (hlinfo
);
27676 #ifdef HAVE_WINDOW_SYSTEM
27677 if (FRAME_WINDOW_P (f
))
27678 define_frame_cursor1 (f
, cursor
, pointer
);
27684 Take proper action when the mouse has moved to position X, Y on
27685 frame F as regards highlighting characters that have mouse-face
27686 properties. Also de-highlighting chars where the mouse was before.
27687 X and Y can be negative or out of range. */
27690 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27692 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27693 enum window_part part
= ON_NOTHING
;
27694 Lisp_Object window
;
27696 Cursor cursor
= No_Cursor
;
27697 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27700 /* When a menu is active, don't highlight because this looks odd. */
27701 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27702 if (popup_activated ())
27706 if (NILP (Vmouse_highlight
)
27707 || !f
->glyphs_initialized_p
27708 || f
->pointer_invisible
)
27711 hlinfo
->mouse_face_mouse_x
= x
;
27712 hlinfo
->mouse_face_mouse_y
= y
;
27713 hlinfo
->mouse_face_mouse_frame
= f
;
27715 if (hlinfo
->mouse_face_defer
)
27718 /* Which window is that in? */
27719 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27721 /* If displaying active text in another window, clear that. */
27722 if (! EQ (window
, hlinfo
->mouse_face_window
)
27723 /* Also clear if we move out of text area in same window. */
27724 || (!NILP (hlinfo
->mouse_face_window
)
27727 && part
!= ON_MODE_LINE
27728 && part
!= ON_HEADER_LINE
))
27729 clear_mouse_face (hlinfo
);
27731 /* Not on a window -> return. */
27732 if (!WINDOWP (window
))
27735 /* Reset help_echo_string. It will get recomputed below. */
27736 help_echo_string
= Qnil
;
27738 /* Convert to window-relative pixel coordinates. */
27739 w
= XWINDOW (window
);
27740 frame_to_window_pixel_xy (w
, &x
, &y
);
27742 #ifdef HAVE_WINDOW_SYSTEM
27743 /* Handle tool-bar window differently since it doesn't display a
27745 if (EQ (window
, f
->tool_bar_window
))
27747 note_tool_bar_highlight (f
, x
, y
);
27752 /* Mouse is on the mode, header line or margin? */
27753 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27754 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27756 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27760 #ifdef HAVE_WINDOW_SYSTEM
27761 if (part
== ON_VERTICAL_BORDER
)
27763 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27764 help_echo_string
= build_string ("drag-mouse-1: resize");
27766 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27767 || part
== ON_SCROLL_BAR
)
27768 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27770 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27773 /* Are we in a window whose display is up to date?
27774 And verify the buffer's text has not changed. */
27775 b
= XBUFFER (w
->buffer
);
27776 if (part
== ON_TEXT
27777 && EQ (w
->window_end_valid
, w
->buffer
)
27778 && w
->last_modified
== BUF_MODIFF (b
)
27779 && w
->last_overlay_modified
== BUF_OVERLAY_MODIFF (b
))
27781 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27783 struct glyph
*glyph
;
27784 Lisp_Object object
;
27785 Lisp_Object mouse_face
= Qnil
, position
;
27786 Lisp_Object
*overlay_vec
= NULL
;
27787 ptrdiff_t i
, noverlays
;
27788 struct buffer
*obuf
;
27789 ptrdiff_t obegv
, ozv
;
27792 /* Find the glyph under X/Y. */
27793 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27795 #ifdef HAVE_WINDOW_SYSTEM
27796 /* Look for :pointer property on image. */
27797 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27799 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27800 if (img
!= NULL
&& IMAGEP (img
->spec
))
27802 Lisp_Object image_map
, hotspot
;
27803 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27805 && (hotspot
= find_hot_spot (image_map
,
27806 glyph
->slice
.img
.x
+ dx
,
27807 glyph
->slice
.img
.y
+ dy
),
27809 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27813 /* Could check XCAR (hotspot) to see if we enter/leave
27815 If so, we could look for mouse-enter, mouse-leave
27816 properties in PLIST (and do something...). */
27817 hotspot
= XCDR (hotspot
);
27818 if (CONSP (hotspot
)
27819 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27821 pointer
= Fplist_get (plist
, Qpointer
);
27822 if (NILP (pointer
))
27824 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27825 if (!NILP (help_echo_string
))
27827 help_echo_window
= window
;
27828 help_echo_object
= glyph
->object
;
27829 help_echo_pos
= glyph
->charpos
;
27833 if (NILP (pointer
))
27834 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27837 #endif /* HAVE_WINDOW_SYSTEM */
27839 /* Clear mouse face if X/Y not over text. */
27841 || area
!= TEXT_AREA
27842 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27843 /* Glyph's OBJECT is an integer for glyphs inserted by the
27844 display engine for its internal purposes, like truncation
27845 and continuation glyphs and blanks beyond the end of
27846 line's text on text terminals. If we are over such a
27847 glyph, we are not over any text. */
27848 || INTEGERP (glyph
->object
)
27849 /* R2L rows have a stretch glyph at their front, which
27850 stands for no text, whereas L2R rows have no glyphs at
27851 all beyond the end of text. Treat such stretch glyphs
27852 like we do with NULL glyphs in L2R rows. */
27853 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27854 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27855 && glyph
->type
== STRETCH_GLYPH
27856 && glyph
->avoid_cursor_p
))
27858 if (clear_mouse_face (hlinfo
))
27859 cursor
= No_Cursor
;
27860 #ifdef HAVE_WINDOW_SYSTEM
27861 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27863 if (area
!= TEXT_AREA
)
27864 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27866 pointer
= Vvoid_text_area_pointer
;
27872 pos
= glyph
->charpos
;
27873 object
= glyph
->object
;
27874 if (!STRINGP (object
) && !BUFFERP (object
))
27877 /* If we get an out-of-range value, return now; avoid an error. */
27878 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27881 /* Make the window's buffer temporarily current for
27882 overlays_at and compute_char_face. */
27883 obuf
= current_buffer
;
27884 current_buffer
= b
;
27890 /* Is this char mouse-active or does it have help-echo? */
27891 position
= make_number (pos
);
27893 if (BUFFERP (object
))
27895 /* Put all the overlays we want in a vector in overlay_vec. */
27896 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27897 /* Sort overlays into increasing priority order. */
27898 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27903 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27906 cursor
= No_Cursor
;
27908 /* Check mouse-face highlighting. */
27910 /* If there exists an overlay with mouse-face overlapping
27911 the one we are currently highlighting, we have to
27912 check if we enter the overlapping overlay, and then
27913 highlight only that. */
27914 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27915 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27917 /* Find the highest priority overlay with a mouse-face. */
27918 Lisp_Object overlay
= Qnil
;
27919 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27921 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27922 if (!NILP (mouse_face
))
27923 overlay
= overlay_vec
[i
];
27926 /* If we're highlighting the same overlay as before, there's
27927 no need to do that again. */
27928 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27929 goto check_help_echo
;
27930 hlinfo
->mouse_face_overlay
= overlay
;
27932 /* Clear the display of the old active region, if any. */
27933 if (clear_mouse_face (hlinfo
))
27934 cursor
= No_Cursor
;
27936 /* If no overlay applies, get a text property. */
27937 if (NILP (overlay
))
27938 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27940 /* Next, compute the bounds of the mouse highlighting and
27942 if (!NILP (mouse_face
) && STRINGP (object
))
27944 /* The mouse-highlighting comes from a display string
27945 with a mouse-face. */
27949 s
= Fprevious_single_property_change
27950 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27951 e
= Fnext_single_property_change
27952 (position
, Qmouse_face
, object
, Qnil
);
27954 s
= make_number (0);
27956 e
= make_number (SCHARS (object
) - 1);
27957 mouse_face_from_string_pos (w
, hlinfo
, object
,
27958 XINT (s
), XINT (e
));
27959 hlinfo
->mouse_face_past_end
= 0;
27960 hlinfo
->mouse_face_window
= window
;
27961 hlinfo
->mouse_face_face_id
27962 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27963 glyph
->face_id
, 1);
27964 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27965 cursor
= No_Cursor
;
27969 /* The mouse-highlighting, if any, comes from an overlay
27970 or text property in the buffer. */
27971 Lisp_Object buffer
IF_LINT (= Qnil
);
27972 Lisp_Object disp_string
IF_LINT (= Qnil
);
27974 if (STRINGP (object
))
27976 /* If we are on a display string with no mouse-face,
27977 check if the text under it has one. */
27978 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27979 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27980 pos
= string_buffer_position (object
, start
);
27983 mouse_face
= get_char_property_and_overlay
27984 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27985 buffer
= w
->buffer
;
27986 disp_string
= object
;
27992 disp_string
= Qnil
;
27995 if (!NILP (mouse_face
))
27997 Lisp_Object before
, after
;
27998 Lisp_Object before_string
, after_string
;
27999 /* To correctly find the limits of mouse highlight
28000 in a bidi-reordered buffer, we must not use the
28001 optimization of limiting the search in
28002 previous-single-property-change and
28003 next-single-property-change, because
28004 rows_from_pos_range needs the real start and end
28005 positions to DTRT in this case. That's because
28006 the first row visible in a window does not
28007 necessarily display the character whose position
28008 is the smallest. */
28010 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
28011 ? Fmarker_position (w
->start
)
28014 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
28015 ? make_number (BUF_Z (XBUFFER (buffer
))
28016 - XFASTINT (w
->window_end_pos
))
28019 if (NILP (overlay
))
28021 /* Handle the text property case. */
28022 before
= Fprevious_single_property_change
28023 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
28024 after
= Fnext_single_property_change
28025 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
28026 before_string
= after_string
= Qnil
;
28030 /* Handle the overlay case. */
28031 before
= Foverlay_start (overlay
);
28032 after
= Foverlay_end (overlay
);
28033 before_string
= Foverlay_get (overlay
, Qbefore_string
);
28034 after_string
= Foverlay_get (overlay
, Qafter_string
);
28036 if (!STRINGP (before_string
)) before_string
= Qnil
;
28037 if (!STRINGP (after_string
)) after_string
= Qnil
;
28040 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
28043 : XFASTINT (before
),
28045 ? BUF_Z (XBUFFER (buffer
))
28046 : XFASTINT (after
),
28047 before_string
, after_string
,
28049 cursor
= No_Cursor
;
28056 /* Look for a `help-echo' property. */
28057 if (NILP (help_echo_string
)) {
28058 Lisp_Object help
, overlay
;
28060 /* Check overlays first. */
28061 help
= overlay
= Qnil
;
28062 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
28064 overlay
= overlay_vec
[i
];
28065 help
= Foverlay_get (overlay
, Qhelp_echo
);
28070 help_echo_string
= help
;
28071 help_echo_window
= window
;
28072 help_echo_object
= overlay
;
28073 help_echo_pos
= pos
;
28077 Lisp_Object obj
= glyph
->object
;
28078 ptrdiff_t charpos
= glyph
->charpos
;
28080 /* Try text properties. */
28083 && charpos
< SCHARS (obj
))
28085 help
= Fget_text_property (make_number (charpos
),
28089 /* If the string itself doesn't specify a help-echo,
28090 see if the buffer text ``under'' it does. */
28091 struct glyph_row
*r
28092 = MATRIX_ROW (w
->current_matrix
, vpos
);
28093 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28094 ptrdiff_t p
= string_buffer_position (obj
, start
);
28097 help
= Fget_char_property (make_number (p
),
28098 Qhelp_echo
, w
->buffer
);
28107 else if (BUFFERP (obj
)
28110 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
28115 help_echo_string
= help
;
28116 help_echo_window
= window
;
28117 help_echo_object
= obj
;
28118 help_echo_pos
= charpos
;
28123 #ifdef HAVE_WINDOW_SYSTEM
28124 /* Look for a `pointer' property. */
28125 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28127 /* Check overlays first. */
28128 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
28129 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
28131 if (NILP (pointer
))
28133 Lisp_Object obj
= glyph
->object
;
28134 ptrdiff_t charpos
= glyph
->charpos
;
28136 /* Try text properties. */
28139 && charpos
< SCHARS (obj
))
28141 pointer
= Fget_text_property (make_number (charpos
),
28143 if (NILP (pointer
))
28145 /* If the string itself doesn't specify a pointer,
28146 see if the buffer text ``under'' it does. */
28147 struct glyph_row
*r
28148 = MATRIX_ROW (w
->current_matrix
, vpos
);
28149 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28150 ptrdiff_t p
= string_buffer_position (obj
, start
);
28152 pointer
= Fget_char_property (make_number (p
),
28153 Qpointer
, w
->buffer
);
28156 else if (BUFFERP (obj
)
28159 pointer
= Fget_text_property (make_number (charpos
),
28163 #endif /* HAVE_WINDOW_SYSTEM */
28167 current_buffer
= obuf
;
28172 #ifdef HAVE_WINDOW_SYSTEM
28173 if (FRAME_WINDOW_P (f
))
28174 define_frame_cursor1 (f
, cursor
, pointer
);
28176 /* This is here to prevent a compiler error, about "label at end of
28177 compound statement". */
28184 Clear any mouse-face on window W. This function is part of the
28185 redisplay interface, and is called from try_window_id and similar
28186 functions to ensure the mouse-highlight is off. */
28189 x_clear_window_mouse_face (struct window
*w
)
28191 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28192 Lisp_Object window
;
28195 XSETWINDOW (window
, w
);
28196 if (EQ (window
, hlinfo
->mouse_face_window
))
28197 clear_mouse_face (hlinfo
);
28203 Just discard the mouse face information for frame F, if any.
28204 This is used when the size of F is changed. */
28207 cancel_mouse_face (struct frame
*f
)
28209 Lisp_Object window
;
28210 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28212 window
= hlinfo
->mouse_face_window
;
28213 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
28215 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28216 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28217 hlinfo
->mouse_face_window
= Qnil
;
28223 /***********************************************************************
28225 ***********************************************************************/
28227 #ifdef HAVE_WINDOW_SYSTEM
28229 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28230 which intersects rectangle R. R is in window-relative coordinates. */
28233 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
28234 enum glyph_row_area area
)
28236 struct glyph
*first
= row
->glyphs
[area
];
28237 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
28238 struct glyph
*last
;
28239 int first_x
, start_x
, x
;
28241 if (area
== TEXT_AREA
&& row
->fill_line_p
)
28242 /* If row extends face to end of line write the whole line. */
28243 draw_glyphs (w
, 0, row
, area
,
28244 0, row
->used
[area
],
28245 DRAW_NORMAL_TEXT
, 0);
28248 /* Set START_X to the window-relative start position for drawing glyphs of
28249 AREA. The first glyph of the text area can be partially visible.
28250 The first glyphs of other areas cannot. */
28251 start_x
= window_box_left_offset (w
, area
);
28253 if (area
== TEXT_AREA
)
28256 /* Find the first glyph that must be redrawn. */
28258 && x
+ first
->pixel_width
< r
->x
)
28260 x
+= first
->pixel_width
;
28264 /* Find the last one. */
28268 && x
< r
->x
+ r
->width
)
28270 x
+= last
->pixel_width
;
28276 draw_glyphs (w
, first_x
- start_x
, row
, area
,
28277 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
28278 DRAW_NORMAL_TEXT
, 0);
28283 /* Redraw the parts of the glyph row ROW on window W intersecting
28284 rectangle R. R is in window-relative coordinates. Value is
28285 non-zero if mouse-face was overwritten. */
28288 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
28290 eassert (row
->enabled_p
);
28292 if (row
->mode_line_p
|| w
->pseudo_window_p
)
28293 draw_glyphs (w
, 0, row
, TEXT_AREA
,
28294 0, row
->used
[TEXT_AREA
],
28295 DRAW_NORMAL_TEXT
, 0);
28298 if (row
->used
[LEFT_MARGIN_AREA
])
28299 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
28300 if (row
->used
[TEXT_AREA
])
28301 expose_area (w
, row
, r
, TEXT_AREA
);
28302 if (row
->used
[RIGHT_MARGIN_AREA
])
28303 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
28304 draw_row_fringe_bitmaps (w
, row
);
28307 return row
->mouse_face_p
;
28311 /* Redraw those parts of glyphs rows during expose event handling that
28312 overlap other rows. Redrawing of an exposed line writes over parts
28313 of lines overlapping that exposed line; this function fixes that.
28315 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28316 row in W's current matrix that is exposed and overlaps other rows.
28317 LAST_OVERLAPPING_ROW is the last such row. */
28320 expose_overlaps (struct window
*w
,
28321 struct glyph_row
*first_overlapping_row
,
28322 struct glyph_row
*last_overlapping_row
,
28325 struct glyph_row
*row
;
28327 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
28328 if (row
->overlapping_p
)
28330 eassert (row
->enabled_p
&& !row
->mode_line_p
);
28333 if (row
->used
[LEFT_MARGIN_AREA
])
28334 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
28336 if (row
->used
[TEXT_AREA
])
28337 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
28339 if (row
->used
[RIGHT_MARGIN_AREA
])
28340 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
28346 /* Return non-zero if W's cursor intersects rectangle R. */
28349 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
28351 XRectangle cr
, result
;
28352 struct glyph
*cursor_glyph
;
28353 struct glyph_row
*row
;
28355 if (w
->phys_cursor
.vpos
>= 0
28356 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
28357 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
28359 && row
->cursor_in_fringe_p
)
28361 /* Cursor is in the fringe. */
28362 cr
.x
= window_box_right_offset (w
,
28363 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
28364 ? RIGHT_MARGIN_AREA
28367 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
28368 cr
.height
= row
->height
;
28369 return x_intersect_rectangles (&cr
, r
, &result
);
28372 cursor_glyph
= get_phys_cursor_glyph (w
);
28375 /* r is relative to W's box, but w->phys_cursor.x is relative
28376 to left edge of W's TEXT area. Adjust it. */
28377 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28378 cr
.y
= w
->phys_cursor
.y
;
28379 cr
.width
= cursor_glyph
->pixel_width
;
28380 cr
.height
= w
->phys_cursor_height
;
28381 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28382 I assume the effect is the same -- and this is portable. */
28383 return x_intersect_rectangles (&cr
, r
, &result
);
28385 /* If we don't understand the format, pretend we're not in the hot-spot. */
28391 Draw a vertical window border to the right of window W if W doesn't
28392 have vertical scroll bars. */
28395 x_draw_vertical_border (struct window
*w
)
28397 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28399 /* We could do better, if we knew what type of scroll-bar the adjacent
28400 windows (on either side) have... But we don't :-(
28401 However, I think this works ok. ++KFS 2003-04-25 */
28403 /* Redraw borders between horizontally adjacent windows. Don't
28404 do it for frames with vertical scroll bars because either the
28405 right scroll bar of a window, or the left scroll bar of its
28406 neighbor will suffice as a border. */
28407 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28410 if (!WINDOW_RIGHTMOST_P (w
)
28411 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28413 int x0
, x1
, y0
, y1
;
28415 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28418 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28421 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28423 else if (!WINDOW_LEFTMOST_P (w
)
28424 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28426 int x0
, x1
, y0
, y1
;
28428 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28431 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28434 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28439 /* Redraw the part of window W intersection rectangle FR. Pixel
28440 coordinates in FR are frame-relative. Call this function with
28441 input blocked. Value is non-zero if the exposure overwrites
28445 expose_window (struct window
*w
, XRectangle
*fr
)
28447 struct frame
*f
= XFRAME (w
->frame
);
28449 int mouse_face_overwritten_p
= 0;
28451 /* If window is not yet fully initialized, do nothing. This can
28452 happen when toolkit scroll bars are used and a window is split.
28453 Reconfiguring the scroll bar will generate an expose for a newly
28455 if (w
->current_matrix
== NULL
)
28458 /* When we're currently updating the window, display and current
28459 matrix usually don't agree. Arrange for a thorough display
28461 if (w
== updated_window
)
28463 SET_FRAME_GARBAGED (f
);
28467 /* Frame-relative pixel rectangle of W. */
28468 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28469 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28470 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28471 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28473 if (x_intersect_rectangles (fr
, &wr
, &r
))
28475 int yb
= window_text_bottom_y (w
);
28476 struct glyph_row
*row
;
28477 int cursor_cleared_p
, phys_cursor_on_p
;
28478 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28480 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28481 r
.x
, r
.y
, r
.width
, r
.height
));
28483 /* Convert to window coordinates. */
28484 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28485 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28487 /* Turn off the cursor. */
28488 if (!w
->pseudo_window_p
28489 && phys_cursor_in_rect_p (w
, &r
))
28491 x_clear_cursor (w
);
28492 cursor_cleared_p
= 1;
28495 cursor_cleared_p
= 0;
28497 /* If the row containing the cursor extends face to end of line,
28498 then expose_area might overwrite the cursor outside the
28499 rectangle and thus notice_overwritten_cursor might clear
28500 w->phys_cursor_on_p. We remember the original value and
28501 check later if it is changed. */
28502 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28504 /* Update lines intersecting rectangle R. */
28505 first_overlapping_row
= last_overlapping_row
= NULL
;
28506 for (row
= w
->current_matrix
->rows
;
28511 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28513 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28514 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28515 || (r
.y
>= y0
&& r
.y
< y1
)
28516 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28518 /* A header line may be overlapping, but there is no need
28519 to fix overlapping areas for them. KFS 2005-02-12 */
28520 if (row
->overlapping_p
&& !row
->mode_line_p
)
28522 if (first_overlapping_row
== NULL
)
28523 first_overlapping_row
= row
;
28524 last_overlapping_row
= row
;
28528 if (expose_line (w
, row
, &r
))
28529 mouse_face_overwritten_p
= 1;
28532 else if (row
->overlapping_p
)
28534 /* We must redraw a row overlapping the exposed area. */
28536 ? y0
+ row
->phys_height
> r
.y
28537 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28539 if (first_overlapping_row
== NULL
)
28540 first_overlapping_row
= row
;
28541 last_overlapping_row
= row
;
28549 /* Display the mode line if there is one. */
28550 if (WINDOW_WANTS_MODELINE_P (w
)
28551 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28553 && row
->y
< r
.y
+ r
.height
)
28555 if (expose_line (w
, row
, &r
))
28556 mouse_face_overwritten_p
= 1;
28559 if (!w
->pseudo_window_p
)
28561 /* Fix the display of overlapping rows. */
28562 if (first_overlapping_row
)
28563 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28566 /* Draw border between windows. */
28567 x_draw_vertical_border (w
);
28569 /* Turn the cursor on again. */
28570 if (cursor_cleared_p
28571 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28572 update_window_cursor (w
, 1);
28576 return mouse_face_overwritten_p
;
28581 /* Redraw (parts) of all windows in the window tree rooted at W that
28582 intersect R. R contains frame pixel coordinates. Value is
28583 non-zero if the exposure overwrites mouse-face. */
28586 expose_window_tree (struct window
*w
, XRectangle
*r
)
28588 struct frame
*f
= XFRAME (w
->frame
);
28589 int mouse_face_overwritten_p
= 0;
28591 while (w
&& !FRAME_GARBAGED_P (f
))
28593 if (!NILP (w
->hchild
))
28594 mouse_face_overwritten_p
28595 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28596 else if (!NILP (w
->vchild
))
28597 mouse_face_overwritten_p
28598 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28600 mouse_face_overwritten_p
|= expose_window (w
, r
);
28602 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28605 return mouse_face_overwritten_p
;
28610 Redisplay an exposed area of frame F. X and Y are the upper-left
28611 corner of the exposed rectangle. W and H are width and height of
28612 the exposed area. All are pixel values. W or H zero means redraw
28613 the entire frame. */
28616 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28619 int mouse_face_overwritten_p
= 0;
28621 TRACE ((stderr
, "expose_frame "));
28623 /* No need to redraw if frame will be redrawn soon. */
28624 if (FRAME_GARBAGED_P (f
))
28626 TRACE ((stderr
, " garbaged\n"));
28630 /* If basic faces haven't been realized yet, there is no point in
28631 trying to redraw anything. This can happen when we get an expose
28632 event while Emacs is starting, e.g. by moving another window. */
28633 if (FRAME_FACE_CACHE (f
) == NULL
28634 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28636 TRACE ((stderr
, " no faces\n"));
28640 if (w
== 0 || h
== 0)
28643 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28644 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28654 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28655 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28657 if (WINDOWP (f
->tool_bar_window
))
28658 mouse_face_overwritten_p
28659 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28661 #ifdef HAVE_X_WINDOWS
28663 #ifndef USE_X_TOOLKIT
28664 if (WINDOWP (f
->menu_bar_window
))
28665 mouse_face_overwritten_p
28666 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28667 #endif /* not USE_X_TOOLKIT */
28671 /* Some window managers support a focus-follows-mouse style with
28672 delayed raising of frames. Imagine a partially obscured frame,
28673 and moving the mouse into partially obscured mouse-face on that
28674 frame. The visible part of the mouse-face will be highlighted,
28675 then the WM raises the obscured frame. With at least one WM, KDE
28676 2.1, Emacs is not getting any event for the raising of the frame
28677 (even tried with SubstructureRedirectMask), only Expose events.
28678 These expose events will draw text normally, i.e. not
28679 highlighted. Which means we must redo the highlight here.
28680 Subsume it under ``we love X''. --gerd 2001-08-15 */
28681 /* Included in Windows version because Windows most likely does not
28682 do the right thing if any third party tool offers
28683 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28684 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28686 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28687 if (f
== hlinfo
->mouse_face_mouse_frame
)
28689 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28690 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28691 clear_mouse_face (hlinfo
);
28692 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28699 Determine the intersection of two rectangles R1 and R2. Return
28700 the intersection in *RESULT. Value is non-zero if RESULT is not
28704 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28706 XRectangle
*left
, *right
;
28707 XRectangle
*upper
, *lower
;
28708 int intersection_p
= 0;
28710 /* Rearrange so that R1 is the left-most rectangle. */
28712 left
= r1
, right
= r2
;
28714 left
= r2
, right
= r1
;
28716 /* X0 of the intersection is right.x0, if this is inside R1,
28717 otherwise there is no intersection. */
28718 if (right
->x
<= left
->x
+ left
->width
)
28720 result
->x
= right
->x
;
28722 /* The right end of the intersection is the minimum of
28723 the right ends of left and right. */
28724 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28727 /* Same game for Y. */
28729 upper
= r1
, lower
= r2
;
28731 upper
= r2
, lower
= r1
;
28733 /* The upper end of the intersection is lower.y0, if this is inside
28734 of upper. Otherwise, there is no intersection. */
28735 if (lower
->y
<= upper
->y
+ upper
->height
)
28737 result
->y
= lower
->y
;
28739 /* The lower end of the intersection is the minimum of the lower
28740 ends of upper and lower. */
28741 result
->height
= (min (lower
->y
+ lower
->height
,
28742 upper
->y
+ upper
->height
)
28744 intersection_p
= 1;
28748 return intersection_p
;
28751 #endif /* HAVE_WINDOW_SYSTEM */
28754 /***********************************************************************
28756 ***********************************************************************/
28759 syms_of_xdisp (void)
28761 Vwith_echo_area_save_vector
= Qnil
;
28762 staticpro (&Vwith_echo_area_save_vector
);
28764 Vmessage_stack
= Qnil
;
28765 staticpro (&Vmessage_stack
);
28767 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28768 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
28770 message_dolog_marker1
= Fmake_marker ();
28771 staticpro (&message_dolog_marker1
);
28772 message_dolog_marker2
= Fmake_marker ();
28773 staticpro (&message_dolog_marker2
);
28774 message_dolog_marker3
= Fmake_marker ();
28775 staticpro (&message_dolog_marker3
);
28778 defsubr (&Sdump_frame_glyph_matrix
);
28779 defsubr (&Sdump_glyph_matrix
);
28780 defsubr (&Sdump_glyph_row
);
28781 defsubr (&Sdump_tool_bar_row
);
28782 defsubr (&Strace_redisplay
);
28783 defsubr (&Strace_to_stderr
);
28785 #ifdef HAVE_WINDOW_SYSTEM
28786 defsubr (&Stool_bar_lines_needed
);
28787 defsubr (&Slookup_image_map
);
28789 defsubr (&Sformat_mode_line
);
28790 defsubr (&Sinvisible_p
);
28791 defsubr (&Scurrent_bidi_paragraph_direction
);
28793 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28794 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28795 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28796 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28797 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28798 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28799 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28800 DEFSYM (Qeval
, "eval");
28801 DEFSYM (QCdata
, ":data");
28802 DEFSYM (Qdisplay
, "display");
28803 DEFSYM (Qspace_width
, "space-width");
28804 DEFSYM (Qraise
, "raise");
28805 DEFSYM (Qslice
, "slice");
28806 DEFSYM (Qspace
, "space");
28807 DEFSYM (Qmargin
, "margin");
28808 DEFSYM (Qpointer
, "pointer");
28809 DEFSYM (Qleft_margin
, "left-margin");
28810 DEFSYM (Qright_margin
, "right-margin");
28811 DEFSYM (Qcenter
, "center");
28812 DEFSYM (Qline_height
, "line-height");
28813 DEFSYM (QCalign_to
, ":align-to");
28814 DEFSYM (QCrelative_width
, ":relative-width");
28815 DEFSYM (QCrelative_height
, ":relative-height");
28816 DEFSYM (QCeval
, ":eval");
28817 DEFSYM (QCpropertize
, ":propertize");
28818 DEFSYM (QCfile
, ":file");
28819 DEFSYM (Qfontified
, "fontified");
28820 DEFSYM (Qfontification_functions
, "fontification-functions");
28821 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28822 DEFSYM (Qescape_glyph
, "escape-glyph");
28823 DEFSYM (Qnobreak_space
, "nobreak-space");
28824 DEFSYM (Qimage
, "image");
28825 DEFSYM (Qtext
, "text");
28826 DEFSYM (Qboth
, "both");
28827 DEFSYM (Qboth_horiz
, "both-horiz");
28828 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28829 DEFSYM (QCmap
, ":map");
28830 DEFSYM (QCpointer
, ":pointer");
28831 DEFSYM (Qrect
, "rect");
28832 DEFSYM (Qcircle
, "circle");
28833 DEFSYM (Qpoly
, "poly");
28834 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28835 DEFSYM (Qgrow_only
, "grow-only");
28836 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28837 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28838 DEFSYM (Qposition
, "position");
28839 DEFSYM (Qbuffer_position
, "buffer-position");
28840 DEFSYM (Qobject
, "object");
28841 DEFSYM (Qbar
, "bar");
28842 DEFSYM (Qhbar
, "hbar");
28843 DEFSYM (Qbox
, "box");
28844 DEFSYM (Qhollow
, "hollow");
28845 DEFSYM (Qhand
, "hand");
28846 DEFSYM (Qarrow
, "arrow");
28847 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28849 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28850 Fcons (intern_c_string ("void-variable"), Qnil
)),
28852 staticpro (&list_of_error
);
28854 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28855 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28856 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28857 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28859 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28860 staticpro (&echo_buffer
[0]);
28861 staticpro (&echo_buffer
[1]);
28863 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28864 staticpro (&echo_area_buffer
[0]);
28865 staticpro (&echo_area_buffer
[1]);
28867 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
28868 staticpro (&Vmessages_buffer_name
);
28870 mode_line_proptrans_alist
= Qnil
;
28871 staticpro (&mode_line_proptrans_alist
);
28872 mode_line_string_list
= Qnil
;
28873 staticpro (&mode_line_string_list
);
28874 mode_line_string_face
= Qnil
;
28875 staticpro (&mode_line_string_face
);
28876 mode_line_string_face_prop
= Qnil
;
28877 staticpro (&mode_line_string_face_prop
);
28878 Vmode_line_unwind_vector
= Qnil
;
28879 staticpro (&Vmode_line_unwind_vector
);
28881 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
28883 help_echo_string
= Qnil
;
28884 staticpro (&help_echo_string
);
28885 help_echo_object
= Qnil
;
28886 staticpro (&help_echo_object
);
28887 help_echo_window
= Qnil
;
28888 staticpro (&help_echo_window
);
28889 previous_help_echo_string
= Qnil
;
28890 staticpro (&previous_help_echo_string
);
28891 help_echo_pos
= -1;
28893 DEFSYM (Qright_to_left
, "right-to-left");
28894 DEFSYM (Qleft_to_right
, "left-to-right");
28896 #ifdef HAVE_WINDOW_SYSTEM
28897 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28898 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
28899 For example, if a block cursor is over a tab, it will be drawn as
28900 wide as that tab on the display. */);
28901 x_stretch_cursor_p
= 0;
28904 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28905 doc
: /* Non-nil means highlight trailing whitespace.
28906 The face used for trailing whitespace is `trailing-whitespace'. */);
28907 Vshow_trailing_whitespace
= Qnil
;
28909 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28910 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28911 If the value is t, Emacs highlights non-ASCII chars which have the
28912 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28913 or `escape-glyph' face respectively.
28915 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28916 U+2011 (non-breaking hyphen) are affected.
28918 Any other non-nil value means to display these characters as a escape
28919 glyph followed by an ordinary space or hyphen.
28921 A value of nil means no special handling of these characters. */);
28922 Vnobreak_char_display
= Qt
;
28924 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28925 doc
: /* The pointer shape to show in void text areas.
28926 A value of nil means to show the text pointer. Other options are `arrow',
28927 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28928 Vvoid_text_area_pointer
= Qarrow
;
28930 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28931 doc
: /* Non-nil means don't actually do any redisplay.
28932 This is used for internal purposes. */);
28933 Vinhibit_redisplay
= Qnil
;
28935 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28936 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28937 Vglobal_mode_string
= Qnil
;
28939 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28940 doc
: /* Marker for where to display an arrow on top of the buffer text.
28941 This must be the beginning of a line in order to work.
28942 See also `overlay-arrow-string'. */);
28943 Voverlay_arrow_position
= Qnil
;
28945 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28946 doc
: /* String to display as an arrow in non-window frames.
28947 See also `overlay-arrow-position'. */);
28948 Voverlay_arrow_string
= build_pure_c_string ("=>");
28950 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28951 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28952 The symbols on this list are examined during redisplay to determine
28953 where to display overlay arrows. */);
28954 Voverlay_arrow_variable_list
28955 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28957 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28958 doc
: /* The number of lines to try scrolling a window by when point moves out.
28959 If that fails to bring point back on frame, point is centered instead.
28960 If this is zero, point is always centered after it moves off frame.
28961 If you want scrolling to always be a line at a time, you should set
28962 `scroll-conservatively' to a large value rather than set this to 1. */);
28964 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28965 doc
: /* Scroll up to this many lines, to bring point back on screen.
28966 If point moves off-screen, redisplay will scroll by up to
28967 `scroll-conservatively' lines in order to bring point just barely
28968 onto the screen again. If that cannot be done, then redisplay
28969 recenters point as usual.
28971 If the value is greater than 100, redisplay will never recenter point,
28972 but will always scroll just enough text to bring point into view, even
28973 if you move far away.
28975 A value of zero means always recenter point if it moves off screen. */);
28976 scroll_conservatively
= 0;
28978 DEFVAR_INT ("scroll-margin", scroll_margin
,
28979 doc
: /* Number of lines of margin at the top and bottom of a window.
28980 Recenter the window whenever point gets within this many lines
28981 of the top or bottom of the window. */);
28984 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28985 doc
: /* Pixels per inch value for non-window system displays.
28986 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28987 Vdisplay_pixels_per_inch
= make_float (72.0);
28990 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28993 DEFVAR_LISP ("truncate-partial-width-windows",
28994 Vtruncate_partial_width_windows
,
28995 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28996 For an integer value, truncate lines in each window narrower than the
28997 full frame width, provided the window width is less than that integer;
28998 otherwise, respect the value of `truncate-lines'.
29000 For any other non-nil value, truncate lines in all windows that do
29001 not span the full frame width.
29003 A value of nil means to respect the value of `truncate-lines'.
29005 If `word-wrap' is enabled, you might want to reduce this. */);
29006 Vtruncate_partial_width_windows
= make_number (50);
29008 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
29009 doc
: /* Maximum buffer size for which line number should be displayed.
29010 If the buffer is bigger than this, the line number does not appear
29011 in the mode line. A value of nil means no limit. */);
29012 Vline_number_display_limit
= Qnil
;
29014 DEFVAR_INT ("line-number-display-limit-width",
29015 line_number_display_limit_width
,
29016 doc
: /* Maximum line width (in characters) for line number display.
29017 If the average length of the lines near point is bigger than this, then the
29018 line number may be omitted from the mode line. */);
29019 line_number_display_limit_width
= 200;
29021 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
29022 doc
: /* Non-nil means highlight region even in nonselected windows. */);
29023 highlight_nonselected_windows
= 0;
29025 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
29026 doc
: /* Non-nil if more than one frame is visible on this display.
29027 Minibuffer-only frames don't count, but iconified frames do.
29028 This variable is not guaranteed to be accurate except while processing
29029 `frame-title-format' and `icon-title-format'. */);
29031 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
29032 doc
: /* Template for displaying the title bar of visible frames.
29033 \(Assuming the window manager supports this feature.)
29035 This variable has the same structure as `mode-line-format', except that
29036 the %c and %l constructs are ignored. It is used only on frames for
29037 which no explicit name has been set \(see `modify-frame-parameters'). */);
29039 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
29040 doc
: /* Template for displaying the title bar of an iconified frame.
29041 \(Assuming the window manager supports this feature.)
29042 This variable has the same structure as `mode-line-format' (which see),
29043 and is used only on frames for which no explicit name has been set
29044 \(see `modify-frame-parameters'). */);
29046 = Vframe_title_format
29047 = listn (CONSTYPE_PURE
, 3,
29048 intern_c_string ("multiple-frames"),
29049 build_pure_c_string ("%b"),
29050 listn (CONSTYPE_PURE
, 4,
29051 empty_unibyte_string
,
29052 intern_c_string ("invocation-name"),
29053 build_pure_c_string ("@"),
29054 intern_c_string ("system-name")));
29056 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
29057 doc
: /* Maximum number of lines to keep in the message log buffer.
29058 If nil, disable message logging. If t, log messages but don't truncate
29059 the buffer when it becomes large. */);
29060 Vmessage_log_max
= make_number (1000);
29062 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
29063 doc
: /* Functions called before redisplay, if window sizes have changed.
29064 The value should be a list of functions that take one argument.
29065 Just before redisplay, for each frame, if any of its windows have changed
29066 size since the last redisplay, or have been split or deleted,
29067 all the functions in the list are called, with the frame as argument. */);
29068 Vwindow_size_change_functions
= Qnil
;
29070 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
29071 doc
: /* List of functions to call before redisplaying a window with scrolling.
29072 Each function is called with two arguments, the window and its new
29073 display-start position. Note that these functions are also called by
29074 `set-window-buffer'. Also note that the value of `window-end' is not
29075 valid when these functions are called.
29077 Warning: Do not use this feature to alter the way the window
29078 is scrolled. It is not designed for that, and such use probably won't
29080 Vwindow_scroll_functions
= Qnil
;
29082 DEFVAR_LISP ("window-text-change-functions",
29083 Vwindow_text_change_functions
,
29084 doc
: /* Functions to call in redisplay when text in the window might change. */);
29085 Vwindow_text_change_functions
= Qnil
;
29087 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
29088 doc
: /* Functions called when redisplay of a window reaches the end trigger.
29089 Each function is called with two arguments, the window and the end trigger value.
29090 See `set-window-redisplay-end-trigger'. */);
29091 Vredisplay_end_trigger_functions
= Qnil
;
29093 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
29094 doc
: /* Non-nil means autoselect window with mouse pointer.
29095 If nil, do not autoselect windows.
29096 A positive number means delay autoselection by that many seconds: a
29097 window is autoselected only after the mouse has remained in that
29098 window for the duration of the delay.
29099 A negative number has a similar effect, but causes windows to be
29100 autoselected only after the mouse has stopped moving. \(Because of
29101 the way Emacs compares mouse events, you will occasionally wait twice
29102 that time before the window gets selected.\)
29103 Any other value means to autoselect window instantaneously when the
29104 mouse pointer enters it.
29106 Autoselection selects the minibuffer only if it is active, and never
29107 unselects the minibuffer if it is active.
29109 When customizing this variable make sure that the actual value of
29110 `focus-follows-mouse' matches the behavior of your window manager. */);
29111 Vmouse_autoselect_window
= Qnil
;
29113 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
29114 doc
: /* Non-nil means automatically resize tool-bars.
29115 This dynamically changes the tool-bar's height to the minimum height
29116 that is needed to make all tool-bar items visible.
29117 If value is `grow-only', the tool-bar's height is only increased
29118 automatically; to decrease the tool-bar height, use \\[recenter]. */);
29119 Vauto_resize_tool_bars
= Qt
;
29121 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
29122 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
29123 auto_raise_tool_bar_buttons_p
= 1;
29125 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
29126 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
29127 make_cursor_line_fully_visible_p
= 1;
29129 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
29130 doc
: /* Border below tool-bar in pixels.
29131 If an integer, use it as the height of the border.
29132 If it is one of `internal-border-width' or `border-width', use the
29133 value of the corresponding frame parameter.
29134 Otherwise, no border is added below the tool-bar. */);
29135 Vtool_bar_border
= Qinternal_border_width
;
29137 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
29138 doc
: /* Margin around tool-bar buttons in pixels.
29139 If an integer, use that for both horizontal and vertical margins.
29140 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
29141 HORZ specifying the horizontal margin, and VERT specifying the
29142 vertical margin. */);
29143 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
29145 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
29146 doc
: /* Relief thickness of tool-bar buttons. */);
29147 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
29149 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
29150 doc
: /* Tool bar style to use.
29152 image - show images only
29153 text - show text only
29154 both - show both, text below image
29155 both-horiz - show text to the right of the image
29156 text-image-horiz - show text to the left of the image
29157 any other - use system default or image if no system default.
29159 This variable only affects the GTK+ toolkit version of Emacs. */);
29160 Vtool_bar_style
= Qnil
;
29162 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
29163 doc
: /* Maximum number of characters a label can have to be shown.
29164 The tool bar style must also show labels for this to have any effect, see
29165 `tool-bar-style'. */);
29166 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
29168 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
29169 doc
: /* List of functions to call to fontify regions of text.
29170 Each function is called with one argument POS. Functions must
29171 fontify a region starting at POS in the current buffer, and give
29172 fontified regions the property `fontified'. */);
29173 Vfontification_functions
= Qnil
;
29174 Fmake_variable_buffer_local (Qfontification_functions
);
29176 DEFVAR_BOOL ("unibyte-display-via-language-environment",
29177 unibyte_display_via_language_environment
,
29178 doc
: /* Non-nil means display unibyte text according to language environment.
29179 Specifically, this means that raw bytes in the range 160-255 decimal
29180 are displayed by converting them to the equivalent multibyte characters
29181 according to the current language environment. As a result, they are
29182 displayed according to the current fontset.
29184 Note that this variable affects only how these bytes are displayed,
29185 but does not change the fact they are interpreted as raw bytes. */);
29186 unibyte_display_via_language_environment
= 0;
29188 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
29189 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29190 If a float, it specifies a fraction of the mini-window frame's height.
29191 If an integer, it specifies a number of lines. */);
29192 Vmax_mini_window_height
= make_float (0.25);
29194 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
29195 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
29196 A value of nil means don't automatically resize mini-windows.
29197 A value of t means resize them to fit the text displayed in them.
29198 A value of `grow-only', the default, means let mini-windows grow only;
29199 they return to their normal size when the minibuffer is closed, or the
29200 echo area becomes empty. */);
29201 Vresize_mini_windows
= Qgrow_only
;
29203 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
29204 doc
: /* Alist specifying how to blink the cursor off.
29205 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29206 `cursor-type' frame-parameter or variable equals ON-STATE,
29207 comparing using `equal', Emacs uses OFF-STATE to specify
29208 how to blink it off. ON-STATE and OFF-STATE are values for
29209 the `cursor-type' frame parameter.
29211 If a frame's ON-STATE has no entry in this list,
29212 the frame's other specifications determine how to blink the cursor off. */);
29213 Vblink_cursor_alist
= Qnil
;
29215 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
29216 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
29217 If non-nil, windows are automatically scrolled horizontally to make
29218 point visible. */);
29219 automatic_hscrolling_p
= 1;
29220 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
29222 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
29223 doc
: /* How many columns away from the window edge point is allowed to get
29224 before automatic hscrolling will horizontally scroll the window. */);
29225 hscroll_margin
= 5;
29227 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
29228 doc
: /* How many columns to scroll the window when point gets too close to the edge.
29229 When point is less than `hscroll-margin' columns from the window
29230 edge, automatic hscrolling will scroll the window by the amount of columns
29231 determined by this variable. If its value is a positive integer, scroll that
29232 many columns. If it's a positive floating-point number, it specifies the
29233 fraction of the window's width to scroll. If it's nil or zero, point will be
29234 centered horizontally after the scroll. Any other value, including negative
29235 numbers, are treated as if the value were zero.
29237 Automatic hscrolling always moves point outside the scroll margin, so if
29238 point was more than scroll step columns inside the margin, the window will
29239 scroll more than the value given by the scroll step.
29241 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29242 and `scroll-right' overrides this variable's effect. */);
29243 Vhscroll_step
= make_number (0);
29245 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
29246 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
29247 Bind this around calls to `message' to let it take effect. */);
29248 message_truncate_lines
= 0;
29250 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
29251 doc
: /* Normal hook run to update the menu bar definitions.
29252 Redisplay runs this hook before it redisplays the menu bar.
29253 This is used to update submenus such as Buffers,
29254 whose contents depend on various data. */);
29255 Vmenu_bar_update_hook
= Qnil
;
29257 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
29258 doc
: /* Frame for which we are updating a menu.
29259 The enable predicate for a menu binding should check this variable. */);
29260 Vmenu_updating_frame
= Qnil
;
29262 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
29263 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
29264 inhibit_menubar_update
= 0;
29266 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
29267 doc
: /* Prefix prepended to all continuation lines at display time.
29268 The value may be a string, an image, or a stretch-glyph; it is
29269 interpreted in the same way as the value of a `display' text property.
29271 This variable is overridden by any `wrap-prefix' text or overlay
29274 To add a prefix to non-continuation lines, use `line-prefix'. */);
29275 Vwrap_prefix
= Qnil
;
29276 DEFSYM (Qwrap_prefix
, "wrap-prefix");
29277 Fmake_variable_buffer_local (Qwrap_prefix
);
29279 DEFVAR_LISP ("line-prefix", Vline_prefix
,
29280 doc
: /* Prefix prepended to all non-continuation lines at display time.
29281 The value may be a string, an image, or a stretch-glyph; it is
29282 interpreted in the same way as the value of a `display' text property.
29284 This variable is overridden by any `line-prefix' text or overlay
29287 To add a prefix to continuation lines, use `wrap-prefix'. */);
29288 Vline_prefix
= Qnil
;
29289 DEFSYM (Qline_prefix
, "line-prefix");
29290 Fmake_variable_buffer_local (Qline_prefix
);
29292 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
29293 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
29294 inhibit_eval_during_redisplay
= 0;
29296 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
29297 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
29298 inhibit_free_realized_faces
= 0;
29301 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
29302 doc
: /* Inhibit try_window_id display optimization. */);
29303 inhibit_try_window_id
= 0;
29305 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
29306 doc
: /* Inhibit try_window_reusing display optimization. */);
29307 inhibit_try_window_reusing
= 0;
29309 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
29310 doc
: /* Inhibit try_cursor_movement display optimization. */);
29311 inhibit_try_cursor_movement
= 0;
29312 #endif /* GLYPH_DEBUG */
29314 DEFVAR_INT ("overline-margin", overline_margin
,
29315 doc
: /* Space between overline and text, in pixels.
29316 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29317 margin to the character height. */);
29318 overline_margin
= 2;
29320 DEFVAR_INT ("underline-minimum-offset",
29321 underline_minimum_offset
,
29322 doc
: /* Minimum distance between baseline and underline.
29323 This can improve legibility of underlined text at small font sizes,
29324 particularly when using variable `x-use-underline-position-properties'
29325 with fonts that specify an UNDERLINE_POSITION relatively close to the
29326 baseline. The default value is 1. */);
29327 underline_minimum_offset
= 1;
29329 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
29330 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29331 This feature only works when on a window system that can change
29332 cursor shapes. */);
29333 display_hourglass_p
= 1;
29335 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
29336 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29337 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
29339 hourglass_atimer
= NULL
;
29340 hourglass_shown_p
= 0;
29342 DEFSYM (Qglyphless_char
, "glyphless-char");
29343 DEFSYM (Qhex_code
, "hex-code");
29344 DEFSYM (Qempty_box
, "empty-box");
29345 DEFSYM (Qthin_space
, "thin-space");
29346 DEFSYM (Qzero_width
, "zero-width");
29348 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
29349 /* Intern this now in case it isn't already done.
29350 Setting this variable twice is harmless.
29351 But don't staticpro it here--that is done in alloc.c. */
29352 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
29353 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
29355 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
29356 doc
: /* Char-table defining glyphless characters.
29357 Each element, if non-nil, should be one of the following:
29358 an ASCII acronym string: display this string in a box
29359 `hex-code': display the hexadecimal code of a character in a box
29360 `empty-box': display as an empty box
29361 `thin-space': display as 1-pixel width space
29362 `zero-width': don't display
29363 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29364 display method for graphical terminals and text terminals respectively.
29365 GRAPHICAL and TEXT should each have one of the values listed above.
29367 The char-table has one extra slot to control the display of a character for
29368 which no font is found. This slot only takes effect on graphical terminals.
29369 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29370 `thin-space'. The default is `empty-box'. */);
29371 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29372 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29375 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
29376 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
29377 Vdebug_on_message
= Qnil
;
29381 /* Initialize this module when Emacs starts. */
29386 current_header_line_height
= current_mode_line_height
= -1;
29388 CHARPOS (this_line_start_pos
) = 0;
29390 if (!noninteractive
)
29392 struct window
*m
= XWINDOW (minibuf_window
);
29393 Lisp_Object frame
= m
->frame
;
29394 struct frame
*f
= XFRAME (frame
);
29395 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29396 struct window
*r
= XWINDOW (root
);
29399 echo_area_window
= minibuf_window
;
29401 wset_top_line (r
, make_number (FRAME_TOP_MARGIN (f
)));
29403 (r
, make_number (FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
)));
29404 wset_total_cols (r
, make_number (FRAME_COLS (f
)));
29405 wset_top_line (m
, make_number (FRAME_LINES (f
) - 1));
29406 wset_total_lines (m
, make_number (1));
29407 wset_total_cols (m
, make_number (FRAME_COLS (f
)));
29409 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29410 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29411 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29413 /* The default ellipsis glyphs `...'. */
29414 for (i
= 0; i
< 3; ++i
)
29415 default_invis_vector
[i
] = make_number ('.');
29419 /* Allocate the buffer for frame titles.
29420 Also used for `format-mode-line'. */
29422 mode_line_noprop_buf
= xmalloc (size
);
29423 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29424 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29425 mode_line_target
= MODE_LINE_DISPLAY
;
29428 help_echo_showing_p
= 0;
29431 /* Platform-independent portion of hourglass implementation. */
29433 /* Cancel a currently active hourglass timer, and start a new one. */
29435 start_hourglass (void)
29437 #if defined (HAVE_WINDOW_SYSTEM)
29440 cancel_hourglass ();
29442 if (INTEGERP (Vhourglass_delay
)
29443 && XINT (Vhourglass_delay
) > 0)
29444 delay
= make_emacs_time (min (XINT (Vhourglass_delay
),
29445 TYPE_MAXIMUM (time_t)),
29447 else if (FLOATP (Vhourglass_delay
)
29448 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29449 delay
= EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (Vhourglass_delay
));
29451 delay
= make_emacs_time (DEFAULT_HOURGLASS_DELAY
, 0);
29455 extern void w32_note_current_window (void);
29456 w32_note_current_window ();
29458 #endif /* HAVE_NTGUI */
29460 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29461 show_hourglass
, NULL
);
29466 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29469 cancel_hourglass (void)
29471 #if defined (HAVE_WINDOW_SYSTEM)
29472 if (hourglass_atimer
)
29474 cancel_atimer (hourglass_atimer
);
29475 hourglass_atimer
= NULL
;
29478 if (hourglass_shown_p
)