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 /* Vector containing glyphs for an ellipsis `...'. */
520 static Lisp_Object default_invis_vector
[3];
522 /* This is the window where the echo area message was displayed. It
523 is always a mini-buffer window, but it may not be the same window
524 currently active as a mini-buffer. */
526 Lisp_Object echo_area_window
;
528 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
529 pushes the current message and the value of
530 message_enable_multibyte on the stack, the function restore_message
531 pops the stack and displays MESSAGE again. */
533 static Lisp_Object Vmessage_stack
;
535 /* Nonzero means multibyte characters were enabled when the echo area
536 message was specified. */
538 static int message_enable_multibyte
;
540 /* Nonzero if we should redraw the mode lines on the next redisplay. */
542 int update_mode_lines
;
544 /* Nonzero if window sizes or contents have changed since last
545 redisplay that finished. */
547 int windows_or_buffers_changed
;
549 /* Nonzero means a frame's cursor type has been changed. */
551 int cursor_type_changed
;
553 /* Nonzero after display_mode_line if %l was used and it displayed a
556 static int line_number_displayed
;
558 /* The name of the *Messages* buffer, a string. */
560 static Lisp_Object Vmessages_buffer_name
;
562 /* Current, index 0, and last displayed echo area message. Either
563 buffers from echo_buffers, or nil to indicate no message. */
565 Lisp_Object echo_area_buffer
[2];
567 /* The buffers referenced from echo_area_buffer. */
569 static Lisp_Object echo_buffer
[2];
571 /* A vector saved used in with_area_buffer to reduce consing. */
573 static Lisp_Object Vwith_echo_area_save_vector
;
575 /* Non-zero means display_echo_area should display the last echo area
576 message again. Set by redisplay_preserve_echo_area. */
578 static int display_last_displayed_message_p
;
580 /* Nonzero if echo area is being used by print; zero if being used by
583 static int message_buf_print
;
585 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
587 static Lisp_Object Qinhibit_menubar_update
;
588 static Lisp_Object Qmessage_truncate_lines
;
590 /* Set to 1 in clear_message to make redisplay_internal aware
591 of an emptied echo area. */
593 static int message_cleared_p
;
595 /* A scratch glyph row with contents used for generating truncation
596 glyphs. Also used in direct_output_for_insert. */
598 #define MAX_SCRATCH_GLYPHS 100
599 static struct glyph_row scratch_glyph_row
;
600 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
602 /* Ascent and height of the last line processed by move_it_to. */
604 static int last_max_ascent
, last_height
;
606 /* Non-zero if there's a help-echo in the echo area. */
608 int help_echo_showing_p
;
610 /* If >= 0, computed, exact values of mode-line and header-line height
611 to use in the macros CURRENT_MODE_LINE_HEIGHT and
612 CURRENT_HEADER_LINE_HEIGHT. */
614 int current_mode_line_height
, current_header_line_height
;
616 /* The maximum distance to look ahead for text properties. Values
617 that are too small let us call compute_char_face and similar
618 functions too often which is expensive. Values that are too large
619 let us call compute_char_face and alike too often because we
620 might not be interested in text properties that far away. */
622 #define TEXT_PROP_DISTANCE_LIMIT 100
624 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
625 iterator state and later restore it. This is needed because the
626 bidi iterator on bidi.c keeps a stacked cache of its states, which
627 is really a singleton. When we use scratch iterator objects to
628 move around the buffer, we can cause the bidi cache to be pushed or
629 popped, and therefore we need to restore the cache state when we
630 return to the original iterator. */
631 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
634 bidi_unshelve_cache (CACHE, 1); \
636 CACHE = bidi_shelve_cache (); \
639 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
641 if (pITORIG != pITCOPY) \
642 *(pITORIG) = *(pITCOPY); \
643 bidi_unshelve_cache (CACHE, 0); \
649 /* Non-zero means print traces of redisplay if compiled with
650 GLYPH_DEBUG defined. */
652 int trace_redisplay_p
;
654 #endif /* GLYPH_DEBUG */
656 #ifdef DEBUG_TRACE_MOVE
657 /* Non-zero means trace with TRACE_MOVE to stderr. */
660 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
662 #define TRACE_MOVE(x) (void) 0
665 static Lisp_Object Qauto_hscroll_mode
;
667 /* Buffer being redisplayed -- for redisplay_window_error. */
669 static struct buffer
*displayed_buffer
;
671 /* Value returned from text property handlers (see below). */
676 HANDLED_RECOMPUTE_PROPS
,
677 HANDLED_OVERLAY_STRING_CONSUMED
,
681 /* A description of text properties that redisplay is interested
686 /* The name of the property. */
689 /* A unique index for the property. */
692 /* A handler function called to set up iterator IT from the property
693 at IT's current position. Value is used to steer handle_stop. */
694 enum prop_handled (*handler
) (struct it
*it
);
697 static enum prop_handled
handle_face_prop (struct it
*);
698 static enum prop_handled
handle_invisible_prop (struct it
*);
699 static enum prop_handled
handle_display_prop (struct it
*);
700 static enum prop_handled
handle_composition_prop (struct it
*);
701 static enum prop_handled
handle_overlay_change (struct it
*);
702 static enum prop_handled
handle_fontified_prop (struct it
*);
704 /* Properties handled by iterators. */
706 static struct props it_props
[] =
708 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
709 /* Handle `face' before `display' because some sub-properties of
710 `display' need to know the face. */
711 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
712 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
713 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
714 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
718 /* Value is the position described by X. If X is a marker, value is
719 the marker_position of X. Otherwise, value is X. */
721 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
723 /* Enumeration returned by some move_it_.* functions internally. */
727 /* Not used. Undefined value. */
730 /* Move ended at the requested buffer position or ZV. */
731 MOVE_POS_MATCH_OR_ZV
,
733 /* Move ended at the requested X pixel position. */
736 /* Move within a line ended at the end of a line that must be
740 /* Move within a line ended at the end of a line that would
741 be displayed truncated. */
744 /* Move within a line ended at a line end. */
748 /* This counter is used to clear the face cache every once in a while
749 in redisplay_internal. It is incremented for each redisplay.
750 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
753 #define CLEAR_FACE_CACHE_COUNT 500
754 static int clear_face_cache_count
;
756 /* Similarly for the image cache. */
758 #ifdef HAVE_WINDOW_SYSTEM
759 #define CLEAR_IMAGE_CACHE_COUNT 101
760 static int clear_image_cache_count
;
762 /* Null glyph slice */
763 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
766 /* True while redisplay_internal is in progress. */
770 static Lisp_Object Qinhibit_free_realized_faces
;
771 static Lisp_Object Qmode_line_default_help_echo
;
773 /* If a string, XTread_socket generates an event to display that string.
774 (The display is done in read_char.) */
776 Lisp_Object help_echo_string
;
777 Lisp_Object help_echo_window
;
778 Lisp_Object help_echo_object
;
779 ptrdiff_t help_echo_pos
;
781 /* Temporary variable for XTread_socket. */
783 Lisp_Object previous_help_echo_string
;
785 /* Platform-independent portion of hourglass implementation. */
787 /* Non-zero means an hourglass cursor is currently shown. */
788 int hourglass_shown_p
;
790 /* If non-null, an asynchronous timer that, when it expires, displays
791 an hourglass cursor on all frames. */
792 struct atimer
*hourglass_atimer
;
794 /* Name of the face used to display glyphless characters. */
795 Lisp_Object Qglyphless_char
;
797 /* Symbol for the purpose of Vglyphless_char_display. */
798 static Lisp_Object Qglyphless_char_display
;
800 /* Method symbols for Vglyphless_char_display. */
801 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
803 /* Default pixel width of `thin-space' display method. */
804 #define THIN_SPACE_WIDTH 1
806 /* Default number of seconds to wait before displaying an hourglass
808 #define DEFAULT_HOURGLASS_DELAY 1
811 /* Function prototypes. */
813 static void setup_for_ellipsis (struct it
*, int);
814 static void set_iterator_to_next (struct it
*, int);
815 static void mark_window_display_accurate_1 (struct window
*, int);
816 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
817 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
818 static int cursor_row_p (struct glyph_row
*);
819 static int redisplay_mode_lines (Lisp_Object
, int);
820 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
822 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
824 static void handle_line_prefix (struct it
*);
826 static void pint2str (char *, int, ptrdiff_t);
827 static void pint2hrstr (char *, int, ptrdiff_t);
828 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
830 static void reconsider_clip_changes (struct window
*, struct buffer
*);
831 static int text_outside_line_unchanged_p (struct window
*,
832 ptrdiff_t, ptrdiff_t);
833 static void store_mode_line_noprop_char (char);
834 static int store_mode_line_noprop (const char *, int, int);
835 static void handle_stop (struct it
*);
836 static void handle_stop_backwards (struct it
*, ptrdiff_t);
837 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
838 static void ensure_echo_area_buffers (void);
839 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
840 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
841 static int with_echo_area_buffer (struct window
*, int,
842 int (*) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
843 ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
844 static void clear_garbaged_frames (void);
845 static int current_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
846 static void pop_message (void);
847 static int truncate_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
848 static void set_message (const char *, Lisp_Object
, ptrdiff_t, int);
849 static int set_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
850 static int display_echo_area (struct window
*);
851 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
852 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
853 static Lisp_Object
unwind_redisplay (Lisp_Object
);
854 static int string_char_and_length (const unsigned char *, int *);
855 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
857 static int compute_window_start_on_continuation_line (struct window
*);
858 static void insert_left_trunc_glyphs (struct it
*);
859 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
861 static void extend_face_to_end_of_line (struct it
*);
862 static int append_space_for_newline (struct it
*, int);
863 static int cursor_row_fully_visible_p (struct window
*, int, int);
864 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
865 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
866 static int trailing_whitespace_p (ptrdiff_t);
867 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
868 static void push_it (struct it
*, struct text_pos
*);
869 static void iterate_out_of_display_property (struct it
*);
870 static void pop_it (struct it
*);
871 static void sync_frame_with_window_matrix_rows (struct window
*);
872 static void redisplay_internal (void);
873 static int echo_area_display (int);
874 static void redisplay_windows (Lisp_Object
);
875 static void redisplay_window (Lisp_Object
, int);
876 static Lisp_Object
redisplay_window_error (Lisp_Object
);
877 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
878 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
879 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
880 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
882 static int update_menu_bar (struct frame
*, int, int);
883 static int try_window_reusing_current_matrix (struct window
*);
884 static int try_window_id (struct window
*);
885 static int display_line (struct it
*);
886 static int display_mode_lines (struct window
*);
887 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
888 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
889 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
890 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
891 static void display_menu_bar (struct window
*);
892 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
894 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
895 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
896 static void compute_line_metrics (struct it
*);
897 static void run_redisplay_end_trigger_hook (struct it
*);
898 static int get_overlay_strings (struct it
*, ptrdiff_t);
899 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
900 static void next_overlay_string (struct it
*);
901 static void reseat (struct it
*, struct text_pos
, int);
902 static void reseat_1 (struct it
*, struct text_pos
, int);
903 static void back_to_previous_visible_line_start (struct it
*);
904 void reseat_at_previous_visible_line_start (struct it
*);
905 static void reseat_at_next_visible_line_start (struct it
*, int);
906 static int next_element_from_ellipsis (struct it
*);
907 static int next_element_from_display_vector (struct it
*);
908 static int next_element_from_string (struct it
*);
909 static int next_element_from_c_string (struct it
*);
910 static int next_element_from_buffer (struct it
*);
911 static int next_element_from_composition (struct it
*);
912 static int next_element_from_image (struct it
*);
913 static int next_element_from_stretch (struct it
*);
914 static void load_overlay_strings (struct it
*, ptrdiff_t);
915 static int init_from_display_pos (struct it
*, struct window
*,
916 struct display_pos
*);
917 static void reseat_to_string (struct it
*, const char *,
918 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
919 static int get_next_display_element (struct it
*);
920 static enum move_it_result
921 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
922 enum move_operation_enum
);
923 void move_it_vertically_backward (struct it
*, int);
924 static void get_visually_first_element (struct it
*);
925 static void init_to_row_start (struct it
*, struct window
*,
927 static int init_to_row_end (struct it
*, struct window
*,
929 static void back_to_previous_line_start (struct it
*);
930 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
931 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
932 Lisp_Object
, ptrdiff_t);
933 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
934 static struct text_pos
c_string_pos (ptrdiff_t, const char *, int);
935 static ptrdiff_t number_of_chars (const char *, int);
936 static void compute_stop_pos (struct it
*);
937 static void compute_string_pos (struct text_pos
*, struct text_pos
,
939 static int face_before_or_after_it_pos (struct it
*, int);
940 static ptrdiff_t next_overlay_change (ptrdiff_t);
941 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
942 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
943 static int handle_single_display_spec (struct it
*, Lisp_Object
,
944 Lisp_Object
, Lisp_Object
,
945 struct text_pos
*, ptrdiff_t, int, int);
946 static int underlying_face_id (struct it
*);
947 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
950 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
951 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
953 #ifdef HAVE_WINDOW_SYSTEM
955 static void x_consider_frame_title (Lisp_Object
);
956 static int tool_bar_lines_needed (struct frame
*, int *);
957 static void update_tool_bar (struct frame
*, int);
958 static void build_desired_tool_bar_string (struct frame
*f
);
959 static int redisplay_tool_bar (struct frame
*);
960 static void display_tool_bar_line (struct it
*, int);
961 static void notice_overwritten_cursor (struct window
*,
964 static void append_stretch_glyph (struct it
*, Lisp_Object
,
968 #endif /* HAVE_WINDOW_SYSTEM */
970 static void produce_special_glyphs (struct it
*, enum display_element_type
);
971 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
972 static int coords_in_mouse_face_p (struct window
*, int, int);
976 /***********************************************************************
977 Window display dimensions
978 ***********************************************************************/
980 /* Return the bottom boundary y-position for text lines in window W.
981 This is the first y position at which a line cannot start.
982 It is relative to the top of the window.
984 This is the height of W minus the height of a mode line, if any. */
987 window_text_bottom_y (struct window
*w
)
989 int height
= WINDOW_TOTAL_HEIGHT (w
);
991 if (WINDOW_WANTS_MODELINE_P (w
))
992 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
996 /* Return the pixel width of display area AREA of window W. AREA < 0
997 means return the total width of W, not including fringes to
998 the left and right of the window. */
1001 window_box_width (struct window
*w
, int area
)
1003 int cols
= XFASTINT (w
->total_cols
);
1006 if (!w
->pseudo_window_p
)
1008 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1010 if (area
== TEXT_AREA
)
1012 if (INTEGERP (w
->left_margin_cols
))
1013 cols
-= XFASTINT (w
->left_margin_cols
);
1014 if (INTEGERP (w
->right_margin_cols
))
1015 cols
-= XFASTINT (w
->right_margin_cols
);
1016 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1018 else if (area
== LEFT_MARGIN_AREA
)
1020 cols
= (INTEGERP (w
->left_margin_cols
)
1021 ? XFASTINT (w
->left_margin_cols
) : 0);
1024 else if (area
== RIGHT_MARGIN_AREA
)
1026 cols
= (INTEGERP (w
->right_margin_cols
)
1027 ? XFASTINT (w
->right_margin_cols
) : 0);
1032 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1036 /* Return the pixel height of the display area of window W, not
1037 including mode lines of W, if any. */
1040 window_box_height (struct window
*w
)
1042 struct frame
*f
= XFRAME (w
->frame
);
1043 int height
= WINDOW_TOTAL_HEIGHT (w
);
1045 eassert (height
>= 0);
1047 /* Note: the code below that determines the mode-line/header-line
1048 height is essentially the same as that contained in the macro
1049 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1050 the appropriate glyph row has its `mode_line_p' flag set,
1051 and if it doesn't, uses estimate_mode_line_height instead. */
1053 if (WINDOW_WANTS_MODELINE_P (w
))
1055 struct glyph_row
*ml_row
1056 = (w
->current_matrix
&& w
->current_matrix
->rows
1057 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1059 if (ml_row
&& ml_row
->mode_line_p
)
1060 height
-= ml_row
->height
;
1062 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1065 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1067 struct glyph_row
*hl_row
1068 = (w
->current_matrix
&& w
->current_matrix
->rows
1069 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1071 if (hl_row
&& hl_row
->mode_line_p
)
1072 height
-= hl_row
->height
;
1074 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1077 /* With a very small font and a mode-line that's taller than
1078 default, we might end up with a negative height. */
1079 return max (0, height
);
1082 /* Return the window-relative coordinate of the left edge of display
1083 area AREA of window W. AREA < 0 means return the left edge of the
1084 whole window, to the right of the left fringe of W. */
1087 window_box_left_offset (struct window
*w
, int area
)
1091 if (w
->pseudo_window_p
)
1094 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1096 if (area
== TEXT_AREA
)
1097 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1098 + window_box_width (w
, LEFT_MARGIN_AREA
));
1099 else if (area
== RIGHT_MARGIN_AREA
)
1100 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1101 + window_box_width (w
, LEFT_MARGIN_AREA
)
1102 + window_box_width (w
, TEXT_AREA
)
1103 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1105 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1106 else if (area
== LEFT_MARGIN_AREA
1107 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1108 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1114 /* Return the window-relative coordinate of the right edge of display
1115 area AREA of window W. AREA < 0 means return the right edge of the
1116 whole window, to the left of the right fringe of W. */
1119 window_box_right_offset (struct window
*w
, int area
)
1121 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1124 /* Return the frame-relative coordinate of the left edge of display
1125 area AREA of window W. AREA < 0 means return the left edge of the
1126 whole window, to the right of the left fringe of W. */
1129 window_box_left (struct window
*w
, int area
)
1131 struct frame
*f
= XFRAME (w
->frame
);
1134 if (w
->pseudo_window_p
)
1135 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1137 x
= (WINDOW_LEFT_EDGE_X (w
)
1138 + window_box_left_offset (w
, area
));
1144 /* Return the frame-relative coordinate of the right edge of display
1145 area AREA of window W. AREA < 0 means return the right edge of the
1146 whole window, to the left of the right fringe of W. */
1149 window_box_right (struct window
*w
, int area
)
1151 return window_box_left (w
, area
) + window_box_width (w
, area
);
1154 /* Get the bounding box of the display area AREA of window W, without
1155 mode lines, in frame-relative coordinates. AREA < 0 means the
1156 whole window, not including the left and right fringes of
1157 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1158 coordinates of the upper-left corner of the box. Return in
1159 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1162 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1163 int *box_width
, int *box_height
)
1166 *box_width
= window_box_width (w
, area
);
1168 *box_height
= window_box_height (w
);
1170 *box_x
= window_box_left (w
, area
);
1173 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1174 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1175 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1180 /* Get the bounding box of the display area AREA of window W, without
1181 mode lines. AREA < 0 means the whole window, not including the
1182 left and right fringe of the window. Return in *TOP_LEFT_X
1183 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1184 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1185 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1189 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1190 int *bottom_right_x
, int *bottom_right_y
)
1192 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1194 *bottom_right_x
+= *top_left_x
;
1195 *bottom_right_y
+= *top_left_y
;
1200 /***********************************************************************
1202 ***********************************************************************/
1204 /* Return the bottom y-position of the line the iterator IT is in.
1205 This can modify IT's settings. */
1208 line_bottom_y (struct it
*it
)
1210 int line_height
= it
->max_ascent
+ it
->max_descent
;
1211 int line_top_y
= it
->current_y
;
1213 if (line_height
== 0)
1216 line_height
= last_height
;
1217 else if (IT_CHARPOS (*it
) < ZV
)
1219 move_it_by_lines (it
, 1);
1220 line_height
= (it
->max_ascent
|| it
->max_descent
1221 ? it
->max_ascent
+ it
->max_descent
1226 struct glyph_row
*row
= it
->glyph_row
;
1228 /* Use the default character height. */
1229 it
->glyph_row
= NULL
;
1230 it
->what
= IT_CHARACTER
;
1233 PRODUCE_GLYPHS (it
);
1234 line_height
= it
->ascent
+ it
->descent
;
1235 it
->glyph_row
= row
;
1239 return line_top_y
+ line_height
;
1242 /* Subroutine of pos_visible_p below. Extracts a display string, if
1243 any, from the display spec given as its argument. */
1245 string_from_display_spec (Lisp_Object spec
)
1249 while (CONSP (spec
))
1251 if (STRINGP (XCAR (spec
)))
1256 else if (VECTORP (spec
))
1260 for (i
= 0; i
< ASIZE (spec
); i
++)
1262 if (STRINGP (AREF (spec
, i
)))
1263 return AREF (spec
, i
);
1272 /* Limit insanely large values of W->hscroll on frame F to the largest
1273 value that will still prevent first_visible_x and last_visible_x of
1274 'struct it' from overflowing an int. */
1276 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1278 ptrdiff_t window_hscroll
= w
->hscroll
;
1279 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1280 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1282 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1283 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1285 return window_hscroll
;
1288 /* Return 1 if position CHARPOS is visible in window W.
1289 CHARPOS < 0 means return info about WINDOW_END position.
1290 If visible, set *X and *Y to pixel coordinates of top left corner.
1291 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1292 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1295 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1296 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1299 void *itdata
= bidi_shelve_cache ();
1300 struct text_pos top
;
1302 struct buffer
*old_buffer
= NULL
;
1304 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1307 if (XBUFFER (w
->buffer
) != current_buffer
)
1309 old_buffer
= current_buffer
;
1310 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1313 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1314 /* Scrolling a minibuffer window via scroll bar when the echo area
1315 shows long text sometimes resets the minibuffer contents behind
1317 if (CHARPOS (top
) > ZV
)
1318 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1320 /* Compute exact mode line heights. */
1321 if (WINDOW_WANTS_MODELINE_P (w
))
1322 current_mode_line_height
1323 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1324 BVAR (current_buffer
, mode_line_format
));
1326 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1327 current_header_line_height
1328 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1329 BVAR (current_buffer
, header_line_format
));
1331 start_display (&it
, w
, top
);
1332 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1333 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1336 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1337 && IT_CHARPOS (it
) >= charpos
)
1338 /* When scanning backwards under bidi iteration, move_it_to
1339 stops at or _before_ CHARPOS, because it stops at or to
1340 the _right_ of the character at CHARPOS. */
1341 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1342 && IT_CHARPOS (it
) <= charpos
)))
1344 /* We have reached CHARPOS, or passed it. How the call to
1345 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1346 or covered by a display property, move_it_to stops at the end
1347 of the invisible text, to the right of CHARPOS. (ii) If
1348 CHARPOS is in a display vector, move_it_to stops on its last
1350 int top_x
= it
.current_x
;
1351 int top_y
= it
.current_y
;
1352 /* Calling line_bottom_y may change it.method, it.position, etc. */
1353 enum it_method it_method
= it
.method
;
1354 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1355 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1357 if (top_y
< window_top_y
)
1358 visible_p
= bottom_y
> window_top_y
;
1359 else if (top_y
< it
.last_visible_y
)
1361 if (bottom_y
>= it
.last_visible_y
1362 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1363 && IT_CHARPOS (it
) < charpos
)
1365 /* When the last line of the window is scanned backwards
1366 under bidi iteration, we could be duped into thinking
1367 that we have passed CHARPOS, when in fact move_it_to
1368 simply stopped short of CHARPOS because it reached
1369 last_visible_y. To see if that's what happened, we call
1370 move_it_to again with a slightly larger vertical limit,
1371 and see if it actually moved vertically; if it did, we
1372 didn't really reach CHARPOS, which is beyond window end. */
1373 struct it save_it
= it
;
1374 /* Why 10? because we don't know how many canonical lines
1375 will the height of the next line(s) be. So we guess. */
1376 int ten_more_lines
=
1377 10 * FRAME_LINE_HEIGHT (XFRAME (WINDOW_FRAME (w
)));
1379 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1380 MOVE_TO_POS
| MOVE_TO_Y
);
1381 if (it
.current_y
> top_y
)
1388 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1390 /* We stopped on the last glyph of a display vector.
1391 Try and recompute. Hack alert! */
1392 if (charpos
< 2 || top
.charpos
>= charpos
)
1393 top_x
= it
.glyph_row
->x
;
1397 start_display (&it2
, w
, top
);
1398 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1399 get_next_display_element (&it2
);
1400 PRODUCE_GLYPHS (&it2
);
1401 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1402 || it2
.current_x
> it2
.last_visible_x
)
1403 top_x
= it
.glyph_row
->x
;
1406 top_x
= it2
.current_x
;
1407 top_y
= it2
.current_y
;
1411 else if (IT_CHARPOS (it
) != charpos
)
1413 Lisp_Object cpos
= make_number (charpos
);
1414 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1415 Lisp_Object string
= string_from_display_spec (spec
);
1416 int newline_in_string
= 0;
1418 if (STRINGP (string
))
1420 const char *s
= SSDATA (string
);
1421 const char *e
= s
+ SBYTES (string
);
1426 newline_in_string
= 1;
1431 /* The tricky code below is needed because there's a
1432 discrepancy between move_it_to and how we set cursor
1433 when the display line ends in a newline from a
1434 display string. move_it_to will stop _after_ such
1435 display strings, whereas set_cursor_from_row
1436 conspires with cursor_row_p to place the cursor on
1437 the first glyph produced from the display string. */
1439 /* We have overshoot PT because it is covered by a
1440 display property whose value is a string. If the
1441 string includes embedded newlines, we are also in the
1442 wrong display line. Backtrack to the correct line,
1443 where the display string begins. */
1444 if (newline_in_string
)
1446 Lisp_Object startpos
, endpos
;
1447 EMACS_INT start
, end
;
1451 /* Find the first and the last buffer positions
1452 covered by the display string. */
1454 Fnext_single_char_property_change (cpos
, Qdisplay
,
1457 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1459 start
= XFASTINT (startpos
);
1460 end
= XFASTINT (endpos
);
1461 /* Move to the last buffer position before the
1462 display property. */
1463 start_display (&it3
, w
, top
);
1464 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1465 /* Move forward one more line if the position before
1466 the display string is a newline or if it is the
1467 rightmost character on a line that is
1468 continued or word-wrapped. */
1469 if (it3
.method
== GET_FROM_BUFFER
1471 move_it_by_lines (&it3
, 1);
1472 else if (move_it_in_display_line_to (&it3
, -1,
1476 == MOVE_LINE_CONTINUED
)
1478 move_it_by_lines (&it3
, 1);
1479 /* When we are under word-wrap, the #$@%!
1480 move_it_by_lines moves 2 lines, so we need to
1482 if (it3
.line_wrap
== WORD_WRAP
)
1483 move_it_by_lines (&it3
, -1);
1486 /* Record the vertical coordinate of the display
1487 line where we wound up. */
1488 top_y
= it3
.current_y
;
1491 /* When characters are reordered for display,
1492 the character displayed to the left of the
1493 display string could be _after_ the display
1494 property in the logical order. Use the
1495 smallest vertical position of these two. */
1496 start_display (&it3
, w
, top
);
1497 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1498 if (it3
.current_y
< top_y
)
1499 top_y
= it3
.current_y
;
1501 /* Move from the top of the window to the beginning
1502 of the display line where the display string
1504 start_display (&it3
, w
, top
);
1505 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1506 /* If it3_moved stays zero after the 'while' loop
1507 below, that means we already were at a newline
1508 before the loop (e.g., the display string begins
1509 with a newline), so we don't need to (and cannot)
1510 inspect the glyphs of it3.glyph_row, because
1511 PRODUCE_GLYPHS will not produce anything for a
1512 newline, and thus it3.glyph_row stays at its
1513 stale content it got at top of the window. */
1515 /* Finally, advance the iterator until we hit the
1516 first display element whose character position is
1517 CHARPOS, or until the first newline from the
1518 display string, which signals the end of the
1520 while (get_next_display_element (&it3
))
1522 PRODUCE_GLYPHS (&it3
);
1523 if (IT_CHARPOS (it3
) == charpos
1524 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1527 set_iterator_to_next (&it3
, 0);
1529 top_x
= it3
.current_x
- it3
.pixel_width
;
1530 /* Normally, we would exit the above loop because we
1531 found the display element whose character
1532 position is CHARPOS. For the contingency that we
1533 didn't, and stopped at the first newline from the
1534 display string, move back over the glyphs
1535 produced from the string, until we find the
1536 rightmost glyph not from the string. */
1538 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1540 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1541 + it3
.glyph_row
->used
[TEXT_AREA
];
1543 while (EQ ((g
- 1)->object
, string
))
1546 top_x
-= g
->pixel_width
;
1548 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1549 + it3
.glyph_row
->used
[TEXT_AREA
]);
1555 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1556 *rtop
= max (0, window_top_y
- top_y
);
1557 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1558 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1559 - max (top_y
, window_top_y
)));
1565 /* We were asked to provide info about WINDOW_END. */
1567 void *it2data
= NULL
;
1569 SAVE_IT (it2
, it
, it2data
);
1570 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1571 move_it_by_lines (&it
, 1);
1572 if (charpos
< IT_CHARPOS (it
)
1573 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1576 RESTORE_IT (&it2
, &it2
, it2data
);
1577 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1579 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1580 *rtop
= max (0, -it2
.current_y
);
1581 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1582 - it
.last_visible_y
));
1583 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1585 - max (it2
.current_y
,
1586 WINDOW_HEADER_LINE_HEIGHT (w
))));
1590 bidi_unshelve_cache (it2data
, 1);
1592 bidi_unshelve_cache (itdata
, 0);
1595 set_buffer_internal_1 (old_buffer
);
1597 current_header_line_height
= current_mode_line_height
= -1;
1599 if (visible_p
&& w
->hscroll
> 0)
1601 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1602 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1605 /* Debugging code. */
1607 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1608 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1610 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1617 /* Return the next character from STR. Return in *LEN the length of
1618 the character. This is like STRING_CHAR_AND_LENGTH but never
1619 returns an invalid character. If we find one, we return a `?', but
1620 with the length of the invalid character. */
1623 string_char_and_length (const unsigned char *str
, int *len
)
1627 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1628 if (!CHAR_VALID_P (c
))
1629 /* We may not change the length here because other places in Emacs
1630 don't use this function, i.e. they silently accept invalid
1639 /* Given a position POS containing a valid character and byte position
1640 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1642 static struct text_pos
1643 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1645 eassert (STRINGP (string
) && nchars
>= 0);
1647 if (STRING_MULTIBYTE (string
))
1649 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1654 string_char_and_length (p
, &len
);
1657 BYTEPOS (pos
) += len
;
1661 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1667 /* Value is the text position, i.e. character and byte position,
1668 for character position CHARPOS in STRING. */
1670 static struct text_pos
1671 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1673 struct text_pos pos
;
1674 eassert (STRINGP (string
));
1675 eassert (charpos
>= 0);
1676 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1681 /* Value is a text position, i.e. character and byte position, for
1682 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1683 means recognize multibyte characters. */
1685 static struct text_pos
1686 c_string_pos (ptrdiff_t charpos
, const char *s
, int multibyte_p
)
1688 struct text_pos pos
;
1690 eassert (s
!= NULL
);
1691 eassert (charpos
>= 0);
1697 SET_TEXT_POS (pos
, 0, 0);
1700 string_char_and_length ((const unsigned char *) s
, &len
);
1703 BYTEPOS (pos
) += len
;
1707 SET_TEXT_POS (pos
, charpos
, charpos
);
1713 /* Value is the number of characters in C string S. MULTIBYTE_P
1714 non-zero means recognize multibyte characters. */
1717 number_of_chars (const char *s
, int multibyte_p
)
1723 ptrdiff_t rest
= strlen (s
);
1725 const unsigned char *p
= (const unsigned char *) s
;
1727 for (nchars
= 0; rest
> 0; ++nchars
)
1729 string_char_and_length (p
, &len
);
1730 rest
-= len
, p
+= len
;
1734 nchars
= strlen (s
);
1740 /* Compute byte position NEWPOS->bytepos corresponding to
1741 NEWPOS->charpos. POS is a known position in string STRING.
1742 NEWPOS->charpos must be >= POS.charpos. */
1745 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1747 eassert (STRINGP (string
));
1748 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1750 if (STRING_MULTIBYTE (string
))
1751 *newpos
= string_pos_nchars_ahead (pos
, string
,
1752 CHARPOS (*newpos
) - CHARPOS (pos
));
1754 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1758 Return an estimation of the pixel height of mode or header lines on
1759 frame F. FACE_ID specifies what line's height to estimate. */
1762 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1764 #ifdef HAVE_WINDOW_SYSTEM
1765 if (FRAME_WINDOW_P (f
))
1767 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1769 /* This function is called so early when Emacs starts that the face
1770 cache and mode line face are not yet initialized. */
1771 if (FRAME_FACE_CACHE (f
))
1773 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1777 height
= FONT_HEIGHT (face
->font
);
1778 if (face
->box_line_width
> 0)
1779 height
+= 2 * face
->box_line_width
;
1790 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1791 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1792 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1793 not force the value into range. */
1796 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1797 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1800 #ifdef HAVE_WINDOW_SYSTEM
1801 if (FRAME_WINDOW_P (f
))
1803 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1804 even for negative values. */
1806 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1808 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1810 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1811 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1814 STORE_NATIVE_RECT (*bounds
,
1815 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1816 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1817 FRAME_COLUMN_WIDTH (f
) - 1,
1818 FRAME_LINE_HEIGHT (f
) - 1);
1824 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1825 pix_x
= FRAME_TOTAL_COLS (f
);
1829 else if (pix_y
> FRAME_LINES (f
))
1830 pix_y
= FRAME_LINES (f
);
1840 /* Find the glyph under window-relative coordinates X/Y in window W.
1841 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1842 strings. Return in *HPOS and *VPOS the row and column number of
1843 the glyph found. Return in *AREA the glyph area containing X.
1844 Value is a pointer to the glyph found or null if X/Y is not on
1845 text, or we can't tell because W's current matrix is not up to
1850 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1851 int *dx
, int *dy
, int *area
)
1853 struct glyph
*glyph
, *end
;
1854 struct glyph_row
*row
= NULL
;
1857 /* Find row containing Y. Give up if some row is not enabled. */
1858 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1860 row
= MATRIX_ROW (w
->current_matrix
, i
);
1861 if (!row
->enabled_p
)
1863 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1870 /* Give up if Y is not in the window. */
1871 if (i
== w
->current_matrix
->nrows
)
1874 /* Get the glyph area containing X. */
1875 if (w
->pseudo_window_p
)
1882 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1884 *area
= LEFT_MARGIN_AREA
;
1885 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1887 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1890 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1894 *area
= RIGHT_MARGIN_AREA
;
1895 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1899 /* Find glyph containing X. */
1900 glyph
= row
->glyphs
[*area
];
1901 end
= glyph
+ row
->used
[*area
];
1903 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1905 x
-= glyph
->pixel_width
;
1915 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1918 *hpos
= glyph
- row
->glyphs
[*area
];
1922 /* Convert frame-relative x/y to coordinates relative to window W.
1923 Takes pseudo-windows into account. */
1926 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1928 if (w
->pseudo_window_p
)
1930 /* A pseudo-window is always full-width, and starts at the
1931 left edge of the frame, plus a frame border. */
1932 struct frame
*f
= XFRAME (w
->frame
);
1933 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1934 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1938 *x
-= WINDOW_LEFT_EDGE_X (w
);
1939 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1943 #ifdef HAVE_WINDOW_SYSTEM
1946 Return in RECTS[] at most N clipping rectangles for glyph string S.
1947 Return the number of stored rectangles. */
1950 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1957 if (s
->row
->full_width_p
)
1959 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1960 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1961 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1963 /* Unless displaying a mode or menu bar line, which are always
1964 fully visible, clip to the visible part of the row. */
1965 if (s
->w
->pseudo_window_p
)
1966 r
.height
= s
->row
->visible_height
;
1968 r
.height
= s
->height
;
1972 /* This is a text line that may be partially visible. */
1973 r
.x
= window_box_left (s
->w
, s
->area
);
1974 r
.width
= window_box_width (s
->w
, s
->area
);
1975 r
.height
= s
->row
->visible_height
;
1979 if (r
.x
< s
->clip_head
->x
)
1981 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1982 r
.width
-= s
->clip_head
->x
- r
.x
;
1985 r
.x
= s
->clip_head
->x
;
1988 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1990 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1991 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1996 /* If S draws overlapping rows, it's sufficient to use the top and
1997 bottom of the window for clipping because this glyph string
1998 intentionally draws over other lines. */
1999 if (s
->for_overlaps
)
2001 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2002 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2004 /* Alas, the above simple strategy does not work for the
2005 environments with anti-aliased text: if the same text is
2006 drawn onto the same place multiple times, it gets thicker.
2007 If the overlap we are processing is for the erased cursor, we
2008 take the intersection with the rectangle of the cursor. */
2009 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2011 XRectangle rc
, r_save
= r
;
2013 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2014 rc
.y
= s
->w
->phys_cursor
.y
;
2015 rc
.width
= s
->w
->phys_cursor_width
;
2016 rc
.height
= s
->w
->phys_cursor_height
;
2018 x_intersect_rectangles (&r_save
, &rc
, &r
);
2023 /* Don't use S->y for clipping because it doesn't take partially
2024 visible lines into account. For example, it can be negative for
2025 partially visible lines at the top of a window. */
2026 if (!s
->row
->full_width_p
2027 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2028 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2030 r
.y
= max (0, s
->row
->y
);
2033 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2035 /* If drawing the cursor, don't let glyph draw outside its
2036 advertised boundaries. Cleartype does this under some circumstances. */
2037 if (s
->hl
== DRAW_CURSOR
)
2039 struct glyph
*glyph
= s
->first_glyph
;
2044 r
.width
-= s
->x
- r
.x
;
2047 r
.width
= min (r
.width
, glyph
->pixel_width
);
2049 /* If r.y is below window bottom, ensure that we still see a cursor. */
2050 height
= min (glyph
->ascent
+ glyph
->descent
,
2051 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2052 max_y
= window_text_bottom_y (s
->w
) - height
;
2053 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2054 if (s
->ybase
- glyph
->ascent
> max_y
)
2061 /* Don't draw cursor glyph taller than our actual glyph. */
2062 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2063 if (height
< r
.height
)
2065 max_y
= r
.y
+ r
.height
;
2066 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2067 r
.height
= min (max_y
- r
.y
, height
);
2074 XRectangle r_save
= r
;
2076 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2080 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2081 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2083 #ifdef CONVERT_FROM_XRECT
2084 CONVERT_FROM_XRECT (r
, *rects
);
2092 /* If we are processing overlapping and allowed to return
2093 multiple clipping rectangles, we exclude the row of the glyph
2094 string from the clipping rectangle. This is to avoid drawing
2095 the same text on the environment with anti-aliasing. */
2096 #ifdef CONVERT_FROM_XRECT
2099 XRectangle
*rs
= rects
;
2101 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2103 if (s
->for_overlaps
& OVERLAPS_PRED
)
2106 if (r
.y
+ r
.height
> row_y
)
2109 rs
[i
].height
= row_y
- r
.y
;
2115 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2118 if (r
.y
< row_y
+ s
->row
->visible_height
)
2120 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2122 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2123 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2132 #ifdef CONVERT_FROM_XRECT
2133 for (i
= 0; i
< n
; i
++)
2134 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2141 Return in *NR the clipping rectangle for glyph string S. */
2144 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2146 get_glyph_string_clip_rects (s
, nr
, 1);
2151 Return the position and height of the phys cursor in window W.
2152 Set w->phys_cursor_width to width of phys cursor.
2156 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2157 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2159 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2160 int x
, y
, wd
, h
, h0
, y0
;
2162 /* Compute the width of the rectangle to draw. If on a stretch
2163 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2164 rectangle as wide as the glyph, but use a canonical character
2166 wd
= glyph
->pixel_width
- 1;
2167 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2171 x
= w
->phys_cursor
.x
;
2178 if (glyph
->type
== STRETCH_GLYPH
2179 && !x_stretch_cursor_p
)
2180 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2181 w
->phys_cursor_width
= wd
;
2183 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2185 /* If y is below window bottom, ensure that we still see a cursor. */
2186 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2188 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2189 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2191 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2194 h
= max (h
- (y0
- y
) + 1, h0
);
2199 y0
= window_text_bottom_y (w
) - h0
;
2207 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2208 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2213 * Remember which glyph the mouse is over.
2217 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2221 struct glyph_row
*r
, *gr
, *end_row
;
2222 enum window_part part
;
2223 enum glyph_row_area area
;
2224 int x
, y
, width
, height
;
2226 /* Try to determine frame pixel position and size of the glyph under
2227 frame pixel coordinates X/Y on frame F. */
2229 if (!f
->glyphs_initialized_p
2230 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2233 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2234 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2238 w
= XWINDOW (window
);
2239 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2240 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2242 x
= window_relative_x_coord (w
, part
, gx
);
2243 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2245 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2246 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2248 if (w
->pseudo_window_p
)
2251 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2257 case ON_LEFT_MARGIN
:
2258 area
= LEFT_MARGIN_AREA
;
2261 case ON_RIGHT_MARGIN
:
2262 area
= RIGHT_MARGIN_AREA
;
2265 case ON_HEADER_LINE
:
2267 gr
= (part
== ON_HEADER_LINE
2268 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2269 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2272 goto text_glyph_row_found
;
2279 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2280 if (r
->y
+ r
->height
> y
)
2286 text_glyph_row_found
:
2289 struct glyph
*g
= gr
->glyphs
[area
];
2290 struct glyph
*end
= g
+ gr
->used
[area
];
2292 height
= gr
->height
;
2293 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2294 if (gx
+ g
->pixel_width
> x
)
2299 if (g
->type
== IMAGE_GLYPH
)
2301 /* Don't remember when mouse is over image, as
2302 image may have hot-spots. */
2303 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2306 width
= g
->pixel_width
;
2310 /* Use nominal char spacing at end of line. */
2312 gx
+= (x
/ width
) * width
;
2315 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2316 gx
+= window_box_left_offset (w
, area
);
2320 /* Use nominal line height at end of window. */
2321 gx
= (x
/ width
) * width
;
2323 gy
+= (y
/ height
) * height
;
2327 case ON_LEFT_FRINGE
:
2328 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2329 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2330 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2331 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2334 case ON_RIGHT_FRINGE
:
2335 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2336 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2337 : window_box_right_offset (w
, TEXT_AREA
));
2338 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2342 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2344 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2345 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2346 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2348 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2352 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2353 if (r
->y
+ r
->height
> y
)
2360 height
= gr
->height
;
2363 /* Use nominal line height at end of window. */
2365 gy
+= (y
/ height
) * height
;
2372 /* If there is no glyph under the mouse, then we divide the screen
2373 into a grid of the smallest glyph in the frame, and use that
2376 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2377 round down even for negative values. */
2383 gx
= (gx
/ width
) * width
;
2384 gy
= (gy
/ height
) * height
;
2389 gx
+= WINDOW_LEFT_EDGE_X (w
);
2390 gy
+= WINDOW_TOP_EDGE_Y (w
);
2393 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2395 /* Visible feedback for debugging. */
2398 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2399 f
->output_data
.x
->normal_gc
,
2400 gx
, gy
, width
, height
);
2406 #endif /* HAVE_WINDOW_SYSTEM */
2409 /***********************************************************************
2410 Lisp form evaluation
2411 ***********************************************************************/
2413 /* Error handler for safe_eval and safe_call. */
2416 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2418 add_to_log ("Error during redisplay: %S signaled %S",
2419 Flist (nargs
, args
), arg
);
2423 /* Call function FUNC with the rest of NARGS - 1 arguments
2424 following. Return the result, or nil if something went
2425 wrong. Prevent redisplay during the evaluation. */
2428 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2432 if (inhibit_eval_during_redisplay
)
2438 ptrdiff_t count
= SPECPDL_INDEX ();
2439 struct gcpro gcpro1
;
2440 Lisp_Object
*args
= alloca (nargs
* word_size
);
2443 va_start (ap
, func
);
2444 for (i
= 1; i
< nargs
; i
++)
2445 args
[i
] = va_arg (ap
, Lisp_Object
);
2449 gcpro1
.nvars
= nargs
;
2450 specbind (Qinhibit_redisplay
, Qt
);
2451 /* Use Qt to ensure debugger does not run,
2452 so there is no possibility of wanting to redisplay. */
2453 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2456 val
= unbind_to (count
, val
);
2463 /* Call function FN with one argument ARG.
2464 Return the result, or nil if something went wrong. */
2467 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2469 return safe_call (2, fn
, arg
);
2472 static Lisp_Object Qeval
;
2475 safe_eval (Lisp_Object sexpr
)
2477 return safe_call1 (Qeval
, sexpr
);
2480 /* Call function FN with two arguments ARG1 and ARG2.
2481 Return the result, or nil if something went wrong. */
2484 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2486 return safe_call (3, fn
, arg1
, arg2
);
2491 /***********************************************************************
2493 ***********************************************************************/
2497 /* Define CHECK_IT to perform sanity checks on iterators.
2498 This is for debugging. It is too slow to do unconditionally. */
2501 check_it (struct it
*it
)
2503 if (it
->method
== GET_FROM_STRING
)
2505 eassert (STRINGP (it
->string
));
2506 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2510 eassert (IT_STRING_CHARPOS (*it
) < 0);
2511 if (it
->method
== GET_FROM_BUFFER
)
2513 /* Check that character and byte positions agree. */
2514 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2519 eassert (it
->current
.dpvec_index
>= 0);
2521 eassert (it
->current
.dpvec_index
< 0);
2524 #define CHECK_IT(IT) check_it ((IT))
2528 #define CHECK_IT(IT) (void) 0
2533 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2535 /* Check that the window end of window W is what we expect it
2536 to be---the last row in the current matrix displaying text. */
2539 check_window_end (struct window
*w
)
2541 if (!MINI_WINDOW_P (w
)
2542 && !NILP (w
->window_end_valid
))
2544 struct glyph_row
*row
;
2545 eassert ((row
= MATRIX_ROW (w
->current_matrix
,
2546 XFASTINT (w
->window_end_vpos
)),
2548 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2549 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2553 #define CHECK_WINDOW_END(W) check_window_end ((W))
2557 #define CHECK_WINDOW_END(W) (void) 0
2559 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2561 /* Return mark position if current buffer has the region of non-zero length,
2565 markpos_of_region (void)
2567 if (!NILP (Vtransient_mark_mode
)
2568 && !NILP (BVAR (current_buffer
, mark_active
))
2569 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= NULL
)
2571 ptrdiff_t markpos
= XMARKER (BVAR (current_buffer
, mark
))->charpos
;
2579 /***********************************************************************
2580 Iterator initialization
2581 ***********************************************************************/
2583 /* Initialize IT for displaying current_buffer in window W, starting
2584 at character position CHARPOS. CHARPOS < 0 means that no buffer
2585 position is specified which is useful when the iterator is assigned
2586 a position later. BYTEPOS is the byte position corresponding to
2587 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2589 If ROW is not null, calls to produce_glyphs with IT as parameter
2590 will produce glyphs in that row.
2592 BASE_FACE_ID is the id of a base face to use. It must be one of
2593 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2594 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2595 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2597 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2598 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2599 will be initialized to use the corresponding mode line glyph row of
2600 the desired matrix of W. */
2603 init_iterator (struct it
*it
, struct window
*w
,
2604 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2605 struct glyph_row
*row
, enum face_id base_face_id
)
2608 enum face_id remapped_base_face_id
= base_face_id
;
2610 /* Some precondition checks. */
2611 eassert (w
!= NULL
&& it
!= NULL
);
2612 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2615 /* If face attributes have been changed since the last redisplay,
2616 free realized faces now because they depend on face definitions
2617 that might have changed. Don't free faces while there might be
2618 desired matrices pending which reference these faces. */
2619 if (face_change_count
&& !inhibit_free_realized_faces
)
2621 face_change_count
= 0;
2622 free_all_realized_faces (Qnil
);
2625 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2626 if (! NILP (Vface_remapping_alist
))
2627 remapped_base_face_id
2628 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2630 /* Use one of the mode line rows of W's desired matrix if
2634 if (base_face_id
== MODE_LINE_FACE_ID
2635 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2636 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2637 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2638 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2642 memset (it
, 0, sizeof *it
);
2643 it
->current
.overlay_string_index
= -1;
2644 it
->current
.dpvec_index
= -1;
2645 it
->base_face_id
= remapped_base_face_id
;
2647 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2648 it
->paragraph_embedding
= L2R
;
2649 it
->bidi_it
.string
.lstring
= Qnil
;
2650 it
->bidi_it
.string
.s
= NULL
;
2651 it
->bidi_it
.string
.bufpos
= 0;
2653 /* The window in which we iterate over current_buffer: */
2654 XSETWINDOW (it
->window
, w
);
2656 it
->f
= XFRAME (w
->frame
);
2660 /* Extra space between lines (on window systems only). */
2661 if (base_face_id
== DEFAULT_FACE_ID
2662 && FRAME_WINDOW_P (it
->f
))
2664 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2665 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2666 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2667 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2668 * FRAME_LINE_HEIGHT (it
->f
));
2669 else if (it
->f
->extra_line_spacing
> 0)
2670 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2671 it
->max_extra_line_spacing
= 0;
2674 /* If realized faces have been removed, e.g. because of face
2675 attribute changes of named faces, recompute them. When running
2676 in batch mode, the face cache of the initial frame is null. If
2677 we happen to get called, make a dummy face cache. */
2678 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2679 init_frame_faces (it
->f
);
2680 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2681 recompute_basic_faces (it
->f
);
2683 /* Current value of the `slice', `space-width', and 'height' properties. */
2684 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2685 it
->space_width
= Qnil
;
2686 it
->font_height
= Qnil
;
2687 it
->override_ascent
= -1;
2689 /* Are control characters displayed as `^C'? */
2690 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2692 /* -1 means everything between a CR and the following line end
2693 is invisible. >0 means lines indented more than this value are
2695 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2697 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2699 : (!NILP (BVAR (current_buffer
, selective_display
))
2701 it
->selective_display_ellipsis_p
2702 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2704 /* Display table to use. */
2705 it
->dp
= window_display_table (w
);
2707 /* Are multibyte characters enabled in current_buffer? */
2708 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2710 /* If visible region is of non-zero length, set IT->region_beg_charpos
2711 and IT->region_end_charpos to the start and end of a visible region
2712 in window IT->w. Set both to -1 to indicate no region. */
2713 markpos
= markpos_of_region ();
2715 /* Maybe highlight only in selected window. */
2716 && (/* Either show region everywhere. */
2717 highlight_nonselected_windows
2718 /* Or show region in the selected window. */
2719 || w
== XWINDOW (selected_window
)
2720 /* Or show the region if we are in the mini-buffer and W is
2721 the window the mini-buffer refers to. */
2722 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2723 && WINDOWP (minibuf_selected_window
)
2724 && w
== XWINDOW (minibuf_selected_window
))))
2726 it
->region_beg_charpos
= min (PT
, markpos
);
2727 it
->region_end_charpos
= max (PT
, markpos
);
2730 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2732 /* Get the position at which the redisplay_end_trigger hook should
2733 be run, if it is to be run at all. */
2734 if (MARKERP (w
->redisplay_end_trigger
)
2735 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2736 it
->redisplay_end_trigger_charpos
2737 = marker_position (w
->redisplay_end_trigger
);
2738 else if (INTEGERP (w
->redisplay_end_trigger
))
2739 it
->redisplay_end_trigger_charpos
=
2740 clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
), PTRDIFF_MAX
);
2742 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2744 /* Are lines in the display truncated? */
2745 if (base_face_id
!= DEFAULT_FACE_ID
2747 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2748 && ((!NILP (Vtruncate_partial_width_windows
)
2749 && !INTEGERP (Vtruncate_partial_width_windows
))
2750 || (INTEGERP (Vtruncate_partial_width_windows
)
2751 && (WINDOW_TOTAL_COLS (it
->w
)
2752 < XINT (Vtruncate_partial_width_windows
))))))
2753 it
->line_wrap
= TRUNCATE
;
2754 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2755 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2756 ? WINDOW_WRAP
: WORD_WRAP
;
2758 it
->line_wrap
= TRUNCATE
;
2760 /* Get dimensions of truncation and continuation glyphs. These are
2761 displayed as fringe bitmaps under X, but we need them for such
2762 frames when the fringes are turned off. But leave the dimensions
2763 zero for tooltip frames, as these glyphs look ugly there and also
2764 sabotage calculations of tooltip dimensions in x-show-tip. */
2765 #ifdef HAVE_WINDOW_SYSTEM
2766 if (!(FRAME_WINDOW_P (it
->f
)
2767 && FRAMEP (tip_frame
)
2768 && it
->f
== XFRAME (tip_frame
)))
2771 if (it
->line_wrap
== TRUNCATE
)
2773 /* We will need the truncation glyph. */
2774 eassert (it
->glyph_row
== NULL
);
2775 produce_special_glyphs (it
, IT_TRUNCATION
);
2776 it
->truncation_pixel_width
= it
->pixel_width
;
2780 /* We will need the continuation glyph. */
2781 eassert (it
->glyph_row
== NULL
);
2782 produce_special_glyphs (it
, IT_CONTINUATION
);
2783 it
->continuation_pixel_width
= it
->pixel_width
;
2787 /* Reset these values to zero because the produce_special_glyphs
2788 above has changed them. */
2789 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2790 it
->phys_ascent
= it
->phys_descent
= 0;
2792 /* Set this after getting the dimensions of truncation and
2793 continuation glyphs, so that we don't produce glyphs when calling
2794 produce_special_glyphs, above. */
2795 it
->glyph_row
= row
;
2796 it
->area
= TEXT_AREA
;
2798 /* Forget any previous info about this row being reversed. */
2800 it
->glyph_row
->reversed_p
= 0;
2802 /* Get the dimensions of the display area. The display area
2803 consists of the visible window area plus a horizontally scrolled
2804 part to the left of the window. All x-values are relative to the
2805 start of this total display area. */
2806 if (base_face_id
!= DEFAULT_FACE_ID
)
2808 /* Mode lines, menu bar in terminal frames. */
2809 it
->first_visible_x
= 0;
2810 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2814 it
->first_visible_x
=
2815 window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2816 it
->last_visible_x
= (it
->first_visible_x
2817 + window_box_width (w
, TEXT_AREA
));
2819 /* If we truncate lines, leave room for the truncation glyph(s) at
2820 the right margin. Otherwise, leave room for the continuation
2821 glyph(s). Done only if the window has no fringes. Since we
2822 don't know at this point whether there will be any R2L lines in
2823 the window, we reserve space for truncation/continuation glyphs
2824 even if only one of the fringes is absent. */
2825 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
2826 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
2828 if (it
->line_wrap
== TRUNCATE
)
2829 it
->last_visible_x
-= it
->truncation_pixel_width
;
2831 it
->last_visible_x
-= it
->continuation_pixel_width
;
2834 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2835 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2838 /* Leave room for a border glyph. */
2839 if (!FRAME_WINDOW_P (it
->f
)
2840 && !WINDOW_RIGHTMOST_P (it
->w
))
2841 it
->last_visible_x
-= 1;
2843 it
->last_visible_y
= window_text_bottom_y (w
);
2845 /* For mode lines and alike, arrange for the first glyph having a
2846 left box line if the face specifies a box. */
2847 if (base_face_id
!= DEFAULT_FACE_ID
)
2851 it
->face_id
= remapped_base_face_id
;
2853 /* If we have a boxed mode line, make the first character appear
2854 with a left box line. */
2855 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2856 if (face
->box
!= FACE_NO_BOX
)
2857 it
->start_of_box_run_p
= 1;
2860 /* If a buffer position was specified, set the iterator there,
2861 getting overlays and face properties from that position. */
2862 if (charpos
>= BUF_BEG (current_buffer
))
2864 it
->end_charpos
= ZV
;
2865 IT_CHARPOS (*it
) = charpos
;
2867 /* We will rely on `reseat' to set this up properly, via
2868 handle_face_prop. */
2869 it
->face_id
= it
->base_face_id
;
2871 /* Compute byte position if not specified. */
2872 if (bytepos
< charpos
)
2873 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2875 IT_BYTEPOS (*it
) = bytepos
;
2877 it
->start
= it
->current
;
2878 /* Do we need to reorder bidirectional text? Not if this is a
2879 unibyte buffer: by definition, none of the single-byte
2880 characters are strong R2L, so no reordering is needed. And
2881 bidi.c doesn't support unibyte buffers anyway. Also, don't
2882 reorder while we are loading loadup.el, since the tables of
2883 character properties needed for reordering are not yet
2887 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2890 /* If we are to reorder bidirectional text, init the bidi
2894 /* Note the paragraph direction that this buffer wants to
2896 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2898 it
->paragraph_embedding
= L2R
;
2899 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2901 it
->paragraph_embedding
= R2L
;
2903 it
->paragraph_embedding
= NEUTRAL_DIR
;
2904 bidi_unshelve_cache (NULL
, 0);
2905 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2909 /* Compute faces etc. */
2910 reseat (it
, it
->current
.pos
, 1);
2917 /* Initialize IT for the display of window W with window start POS. */
2920 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2922 struct glyph_row
*row
;
2923 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2925 row
= w
->desired_matrix
->rows
+ first_vpos
;
2926 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2927 it
->first_vpos
= first_vpos
;
2929 /* Don't reseat to previous visible line start if current start
2930 position is in a string or image. */
2931 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2933 int start_at_line_beg_p
;
2934 int first_y
= it
->current_y
;
2936 /* If window start is not at a line start, skip forward to POS to
2937 get the correct continuation lines width. */
2938 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2939 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2940 if (!start_at_line_beg_p
)
2944 reseat_at_previous_visible_line_start (it
);
2945 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2947 new_x
= it
->current_x
+ it
->pixel_width
;
2949 /* If lines are continued, this line may end in the middle
2950 of a multi-glyph character (e.g. a control character
2951 displayed as \003, or in the middle of an overlay
2952 string). In this case move_it_to above will not have
2953 taken us to the start of the continuation line but to the
2954 end of the continued line. */
2955 if (it
->current_x
> 0
2956 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2957 && (/* And glyph doesn't fit on the line. */
2958 new_x
> it
->last_visible_x
2959 /* Or it fits exactly and we're on a window
2961 || (new_x
== it
->last_visible_x
2962 && FRAME_WINDOW_P (it
->f
)
2963 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2964 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2965 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2967 if ((it
->current
.dpvec_index
>= 0
2968 || it
->current
.overlay_string_index
>= 0)
2969 /* If we are on a newline from a display vector or
2970 overlay string, then we are already at the end of
2971 a screen line; no need to go to the next line in
2972 that case, as this line is not really continued.
2973 (If we do go to the next line, C-e will not DTRT.) */
2976 set_iterator_to_next (it
, 1);
2977 move_it_in_display_line_to (it
, -1, -1, 0);
2980 it
->continuation_lines_width
+= it
->current_x
;
2982 /* If the character at POS is displayed via a display
2983 vector, move_it_to above stops at the final glyph of
2984 IT->dpvec. To make the caller redisplay that character
2985 again (a.k.a. start at POS), we need to reset the
2986 dpvec_index to the beginning of IT->dpvec. */
2987 else if (it
->current
.dpvec_index
>= 0)
2988 it
->current
.dpvec_index
= 0;
2990 /* We're starting a new display line, not affected by the
2991 height of the continued line, so clear the appropriate
2992 fields in the iterator structure. */
2993 it
->max_ascent
= it
->max_descent
= 0;
2994 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2996 it
->current_y
= first_y
;
2998 it
->current_x
= it
->hpos
= 0;
3004 /* Return 1 if POS is a position in ellipses displayed for invisible
3005 text. W is the window we display, for text property lookup. */
3008 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3010 Lisp_Object prop
, window
;
3012 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3014 /* If POS specifies a position in a display vector, this might
3015 be for an ellipsis displayed for invisible text. We won't
3016 get the iterator set up for delivering that ellipsis unless
3017 we make sure that it gets aware of the invisible text. */
3018 if (pos
->dpvec_index
>= 0
3019 && pos
->overlay_string_index
< 0
3020 && CHARPOS (pos
->string_pos
) < 0
3022 && (XSETWINDOW (window
, w
),
3023 prop
= Fget_char_property (make_number (charpos
),
3024 Qinvisible
, window
),
3025 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3027 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3029 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3036 /* Initialize IT for stepping through current_buffer in window W,
3037 starting at position POS that includes overlay string and display
3038 vector/ control character translation position information. Value
3039 is zero if there are overlay strings with newlines at POS. */
3042 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3044 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3045 int i
, overlay_strings_with_newlines
= 0;
3047 /* If POS specifies a position in a display vector, this might
3048 be for an ellipsis displayed for invisible text. We won't
3049 get the iterator set up for delivering that ellipsis unless
3050 we make sure that it gets aware of the invisible text. */
3051 if (in_ellipses_for_invisible_text_p (pos
, w
))
3057 /* Keep in mind: the call to reseat in init_iterator skips invisible
3058 text, so we might end up at a position different from POS. This
3059 is only a problem when POS is a row start after a newline and an
3060 overlay starts there with an after-string, and the overlay has an
3061 invisible property. Since we don't skip invisible text in
3062 display_line and elsewhere immediately after consuming the
3063 newline before the row start, such a POS will not be in a string,
3064 but the call to init_iterator below will move us to the
3066 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3068 /* This only scans the current chunk -- it should scan all chunks.
3069 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3070 to 16 in 22.1 to make this a lesser problem. */
3071 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3073 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3074 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3076 while (s
< e
&& *s
!= '\n')
3081 overlay_strings_with_newlines
= 1;
3086 /* If position is within an overlay string, set up IT to the right
3088 if (pos
->overlay_string_index
>= 0)
3092 /* If the first overlay string happens to have a `display'
3093 property for an image, the iterator will be set up for that
3094 image, and we have to undo that setup first before we can
3095 correct the overlay string index. */
3096 if (it
->method
== GET_FROM_IMAGE
)
3099 /* We already have the first chunk of overlay strings in
3100 IT->overlay_strings. Load more until the one for
3101 pos->overlay_string_index is in IT->overlay_strings. */
3102 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3104 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3105 it
->current
.overlay_string_index
= 0;
3108 load_overlay_strings (it
, 0);
3109 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3113 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3114 relative_index
= (it
->current
.overlay_string_index
3115 % OVERLAY_STRING_CHUNK_SIZE
);
3116 it
->string
= it
->overlay_strings
[relative_index
];
3117 eassert (STRINGP (it
->string
));
3118 it
->current
.string_pos
= pos
->string_pos
;
3119 it
->method
= GET_FROM_STRING
;
3120 it
->end_charpos
= SCHARS (it
->string
);
3121 /* Set up the bidi iterator for this overlay string. */
3124 it
->bidi_it
.string
.lstring
= it
->string
;
3125 it
->bidi_it
.string
.s
= NULL
;
3126 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3127 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3128 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3129 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3130 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3131 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3133 /* Synchronize the state of the bidi iterator with
3134 pos->string_pos. For any string position other than
3135 zero, this will be done automagically when we resume
3136 iteration over the string and get_visually_first_element
3137 is called. But if string_pos is zero, and the string is
3138 to be reordered for display, we need to resync manually,
3139 since it could be that the iteration state recorded in
3140 pos ended at string_pos of 0 moving backwards in string. */
3141 if (CHARPOS (pos
->string_pos
) == 0)
3143 get_visually_first_element (it
);
3144 if (IT_STRING_CHARPOS (*it
) != 0)
3147 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3148 bidi_move_to_visually_next (&it
->bidi_it
);
3149 } while (it
->bidi_it
.charpos
!= 0);
3151 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3152 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3156 if (CHARPOS (pos
->string_pos
) >= 0)
3158 /* Recorded position is not in an overlay string, but in another
3159 string. This can only be a string from a `display' property.
3160 IT should already be filled with that string. */
3161 it
->current
.string_pos
= pos
->string_pos
;
3162 eassert (STRINGP (it
->string
));
3164 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3165 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3168 /* Restore position in display vector translations, control
3169 character translations or ellipses. */
3170 if (pos
->dpvec_index
>= 0)
3172 if (it
->dpvec
== NULL
)
3173 get_next_display_element (it
);
3174 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3175 it
->current
.dpvec_index
= pos
->dpvec_index
;
3179 return !overlay_strings_with_newlines
;
3183 /* Initialize IT for stepping through current_buffer in window W
3184 starting at ROW->start. */
3187 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3189 init_from_display_pos (it
, w
, &row
->start
);
3190 it
->start
= row
->start
;
3191 it
->continuation_lines_width
= row
->continuation_lines_width
;
3196 /* Initialize IT for stepping through current_buffer in window W
3197 starting in the line following ROW, i.e. starting at ROW->end.
3198 Value is zero if there are overlay strings with newlines at ROW's
3202 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3206 if (init_from_display_pos (it
, w
, &row
->end
))
3208 if (row
->continued_p
)
3209 it
->continuation_lines_width
3210 = row
->continuation_lines_width
+ row
->pixel_width
;
3221 /***********************************************************************
3223 ***********************************************************************/
3225 /* Called when IT reaches IT->stop_charpos. Handle text property and
3226 overlay changes. Set IT->stop_charpos to the next position where
3230 handle_stop (struct it
*it
)
3232 enum prop_handled handled
;
3233 int handle_overlay_change_p
;
3237 it
->current
.dpvec_index
= -1;
3238 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3239 it
->ignore_overlay_strings_at_pos_p
= 0;
3242 /* Use face of preceding text for ellipsis (if invisible) */
3243 if (it
->selective_display_ellipsis_p
)
3244 it
->saved_face_id
= it
->face_id
;
3248 handled
= HANDLED_NORMALLY
;
3250 /* Call text property handlers. */
3251 for (p
= it_props
; p
->handler
; ++p
)
3253 handled
= p
->handler (it
);
3255 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3257 else if (handled
== HANDLED_RETURN
)
3259 /* We still want to show before and after strings from
3260 overlays even if the actual buffer text is replaced. */
3261 if (!handle_overlay_change_p
3263 /* Don't call get_overlay_strings_1 if we already
3264 have overlay strings loaded, because doing so
3265 will load them again and push the iterator state
3266 onto the stack one more time, which is not
3267 expected by the rest of the code that processes
3269 || (it
->current
.overlay_string_index
< 0
3270 ? !get_overlay_strings_1 (it
, 0, 0)
3274 setup_for_ellipsis (it
, 0);
3275 /* When handling a display spec, we might load an
3276 empty string. In that case, discard it here. We
3277 used to discard it in handle_single_display_spec,
3278 but that causes get_overlay_strings_1, above, to
3279 ignore overlay strings that we must check. */
3280 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3284 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3288 it
->ignore_overlay_strings_at_pos_p
= 1;
3289 it
->string_from_display_prop_p
= 0;
3290 it
->from_disp_prop_p
= 0;
3291 handle_overlay_change_p
= 0;
3293 handled
= HANDLED_RECOMPUTE_PROPS
;
3296 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3297 handle_overlay_change_p
= 0;
3300 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3302 /* Don't check for overlay strings below when set to deliver
3303 characters from a display vector. */
3304 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3305 handle_overlay_change_p
= 0;
3307 /* Handle overlay changes.
3308 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3309 if it finds overlays. */
3310 if (handle_overlay_change_p
)
3311 handled
= handle_overlay_change (it
);
3316 setup_for_ellipsis (it
, 0);
3320 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3322 /* Determine where to stop next. */
3323 if (handled
== HANDLED_NORMALLY
)
3324 compute_stop_pos (it
);
3328 /* Compute IT->stop_charpos from text property and overlay change
3329 information for IT's current position. */
3332 compute_stop_pos (struct it
*it
)
3334 register INTERVAL iv
, next_iv
;
3335 Lisp_Object object
, limit
, position
;
3336 ptrdiff_t charpos
, bytepos
;
3338 if (STRINGP (it
->string
))
3340 /* Strings are usually short, so don't limit the search for
3342 it
->stop_charpos
= it
->end_charpos
;
3343 object
= it
->string
;
3345 charpos
= IT_STRING_CHARPOS (*it
);
3346 bytepos
= IT_STRING_BYTEPOS (*it
);
3352 /* If end_charpos is out of range for some reason, such as a
3353 misbehaving display function, rationalize it (Bug#5984). */
3354 if (it
->end_charpos
> ZV
)
3355 it
->end_charpos
= ZV
;
3356 it
->stop_charpos
= it
->end_charpos
;
3358 /* If next overlay change is in front of the current stop pos
3359 (which is IT->end_charpos), stop there. Note: value of
3360 next_overlay_change is point-max if no overlay change
3362 charpos
= IT_CHARPOS (*it
);
3363 bytepos
= IT_BYTEPOS (*it
);
3364 pos
= next_overlay_change (charpos
);
3365 if (pos
< it
->stop_charpos
)
3366 it
->stop_charpos
= pos
;
3368 /* If showing the region, we have to stop at the region
3369 start or end because the face might change there. */
3370 if (it
->region_beg_charpos
> 0)
3372 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3373 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3374 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3375 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3378 /* Set up variables for computing the stop position from text
3379 property changes. */
3380 XSETBUFFER (object
, current_buffer
);
3381 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3384 /* Get the interval containing IT's position. Value is a null
3385 interval if there isn't such an interval. */
3386 position
= make_number (charpos
);
3387 iv
= validate_interval_range (object
, &position
, &position
, 0);
3390 Lisp_Object values_here
[LAST_PROP_IDX
];
3393 /* Get properties here. */
3394 for (p
= it_props
; p
->handler
; ++p
)
3395 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3397 /* Look for an interval following iv that has different
3399 for (next_iv
= next_interval (iv
);
3402 || XFASTINT (limit
) > next_iv
->position
));
3403 next_iv
= next_interval (next_iv
))
3405 for (p
= it_props
; p
->handler
; ++p
)
3407 Lisp_Object new_value
;
3409 new_value
= textget (next_iv
->plist
, *p
->name
);
3410 if (!EQ (values_here
[p
->idx
], new_value
))
3420 if (INTEGERP (limit
)
3421 && next_iv
->position
>= XFASTINT (limit
))
3422 /* No text property change up to limit. */
3423 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3425 /* Text properties change in next_iv. */
3426 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3430 if (it
->cmp_it
.id
< 0)
3432 ptrdiff_t stoppos
= it
->end_charpos
;
3434 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3436 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3437 stoppos
, it
->string
);
3440 eassert (STRINGP (it
->string
)
3441 || (it
->stop_charpos
>= BEGV
3442 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3446 /* Return the position of the next overlay change after POS in
3447 current_buffer. Value is point-max if no overlay change
3448 follows. This is like `next-overlay-change' but doesn't use
3452 next_overlay_change (ptrdiff_t pos
)
3454 ptrdiff_t i
, noverlays
;
3456 Lisp_Object
*overlays
;
3458 /* Get all overlays at the given position. */
3459 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3461 /* If any of these overlays ends before endpos,
3462 use its ending point instead. */
3463 for (i
= 0; i
< noverlays
; ++i
)
3468 oend
= OVERLAY_END (overlays
[i
]);
3469 oendpos
= OVERLAY_POSITION (oend
);
3470 endpos
= min (endpos
, oendpos
);
3476 /* How many characters forward to search for a display property or
3477 display string. Searching too far forward makes the bidi display
3478 sluggish, especially in small windows. */
3479 #define MAX_DISP_SCAN 250
3481 /* Return the character position of a display string at or after
3482 position specified by POSITION. If no display string exists at or
3483 after POSITION, return ZV. A display string is either an overlay
3484 with `display' property whose value is a string, or a `display'
3485 text property whose value is a string. STRING is data about the
3486 string to iterate; if STRING->lstring is nil, we are iterating a
3487 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3488 on a GUI frame. DISP_PROP is set to zero if we searched
3489 MAX_DISP_SCAN characters forward without finding any display
3490 strings, non-zero otherwise. It is set to 2 if the display string
3491 uses any kind of `(space ...)' spec that will produce a stretch of
3492 white space in the text area. */
3494 compute_display_string_pos (struct text_pos
*position
,
3495 struct bidi_string_data
*string
,
3496 int frame_window_p
, int *disp_prop
)
3498 /* OBJECT = nil means current buffer. */
3499 Lisp_Object object
=
3500 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3501 Lisp_Object pos
, spec
, limpos
;
3502 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3503 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3504 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3505 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3507 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3508 struct text_pos tpos
;
3514 /* We don't support display properties whose values are strings
3515 that have display string properties. */
3516 || string
->from_disp_str
3517 /* C strings cannot have display properties. */
3518 || (string
->s
&& !STRINGP (object
)))
3524 /* If the character at CHARPOS is where the display string begins,
3526 pos
= make_number (charpos
);
3527 if (STRINGP (object
))
3528 bufpos
= string
->bufpos
;
3532 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3534 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3537 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3545 /* Look forward for the first character with a `display' property
3546 that will replace the underlying text when displayed. */
3547 limpos
= make_number (lim
);
3549 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3550 CHARPOS (tpos
) = XFASTINT (pos
);
3551 if (CHARPOS (tpos
) >= lim
)
3556 if (STRINGP (object
))
3557 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3559 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3560 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3561 if (!STRINGP (object
))
3562 bufpos
= CHARPOS (tpos
);
3563 } while (NILP (spec
)
3564 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3565 bufpos
, frame_window_p
)));
3569 return CHARPOS (tpos
);
3572 /* Return the character position of the end of the display string that
3573 started at CHARPOS. If there's no display string at CHARPOS,
3574 return -1. A display string is either an overlay with `display'
3575 property whose value is a string or a `display' text property whose
3576 value is a string. */
3578 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3580 /* OBJECT = nil means current buffer. */
3581 Lisp_Object object
=
3582 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3583 Lisp_Object pos
= make_number (charpos
);
3585 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3587 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3590 /* It could happen that the display property or overlay was removed
3591 since we found it in compute_display_string_pos above. One way
3592 this can happen is if JIT font-lock was called (through
3593 handle_fontified_prop), and jit-lock-functions remove text
3594 properties or overlays from the portion of buffer that includes
3595 CHARPOS. Muse mode is known to do that, for example. In this
3596 case, we return -1 to the caller, to signal that no display
3597 string is actually present at CHARPOS. See bidi_fetch_char for
3598 how this is handled.
3600 An alternative would be to never look for display properties past
3601 it->stop_charpos. But neither compute_display_string_pos nor
3602 bidi_fetch_char that calls it know or care where the next
3604 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3607 /* Look forward for the first character where the `display' property
3609 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3611 return XFASTINT (pos
);
3616 /***********************************************************************
3618 ***********************************************************************/
3620 /* Handle changes in the `fontified' property of the current buffer by
3621 calling hook functions from Qfontification_functions to fontify
3624 static enum prop_handled
3625 handle_fontified_prop (struct it
*it
)
3627 Lisp_Object prop
, pos
;
3628 enum prop_handled handled
= HANDLED_NORMALLY
;
3630 if (!NILP (Vmemory_full
))
3633 /* Get the value of the `fontified' property at IT's current buffer
3634 position. (The `fontified' property doesn't have a special
3635 meaning in strings.) If the value is nil, call functions from
3636 Qfontification_functions. */
3637 if (!STRINGP (it
->string
)
3639 && !NILP (Vfontification_functions
)
3640 && !NILP (Vrun_hooks
)
3641 && (pos
= make_number (IT_CHARPOS (*it
)),
3642 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3643 /* Ignore the special cased nil value always present at EOB since
3644 no amount of fontifying will be able to change it. */
3645 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3647 ptrdiff_t count
= SPECPDL_INDEX ();
3649 struct buffer
*obuf
= current_buffer
;
3650 int begv
= BEGV
, zv
= ZV
;
3651 int old_clip_changed
= current_buffer
->clip_changed
;
3653 val
= Vfontification_functions
;
3654 specbind (Qfontification_functions
, Qnil
);
3656 eassert (it
->end_charpos
== ZV
);
3658 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3659 safe_call1 (val
, pos
);
3662 Lisp_Object fns
, fn
;
3663 struct gcpro gcpro1
, gcpro2
;
3668 for (; CONSP (val
); val
= XCDR (val
))
3674 /* A value of t indicates this hook has a local
3675 binding; it means to run the global binding too.
3676 In a global value, t should not occur. If it
3677 does, we must ignore it to avoid an endless
3679 for (fns
= Fdefault_value (Qfontification_functions
);
3685 safe_call1 (fn
, pos
);
3689 safe_call1 (fn
, pos
);
3695 unbind_to (count
, Qnil
);
3697 /* Fontification functions routinely call `save-restriction'.
3698 Normally, this tags clip_changed, which can confuse redisplay
3699 (see discussion in Bug#6671). Since we don't perform any
3700 special handling of fontification changes in the case where
3701 `save-restriction' isn't called, there's no point doing so in
3702 this case either. So, if the buffer's restrictions are
3703 actually left unchanged, reset clip_changed. */
3704 if (obuf
== current_buffer
)
3706 if (begv
== BEGV
&& zv
== ZV
)
3707 current_buffer
->clip_changed
= old_clip_changed
;
3709 /* There isn't much we can reasonably do to protect against
3710 misbehaving fontification, but here's a fig leaf. */
3711 else if (BUFFER_LIVE_P (obuf
))
3712 set_buffer_internal_1 (obuf
);
3714 /* The fontification code may have added/removed text.
3715 It could do even a lot worse, but let's at least protect against
3716 the most obvious case where only the text past `pos' gets changed',
3717 as is/was done in grep.el where some escapes sequences are turned
3718 into face properties (bug#7876). */
3719 it
->end_charpos
= ZV
;
3721 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3722 something. This avoids an endless loop if they failed to
3723 fontify the text for which reason ever. */
3724 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3725 handled
= HANDLED_RECOMPUTE_PROPS
;
3733 /***********************************************************************
3735 ***********************************************************************/
3737 /* Set up iterator IT from face properties at its current position.
3738 Called from handle_stop. */
3740 static enum prop_handled
3741 handle_face_prop (struct it
*it
)
3744 ptrdiff_t next_stop
;
3746 if (!STRINGP (it
->string
))
3749 = face_at_buffer_position (it
->w
,
3751 it
->region_beg_charpos
,
3752 it
->region_end_charpos
,
3755 + TEXT_PROP_DISTANCE_LIMIT
),
3756 0, it
->base_face_id
);
3758 /* Is this a start of a run of characters with box face?
3759 Caveat: this can be called for a freshly initialized
3760 iterator; face_id is -1 in this case. We know that the new
3761 face will not change until limit, i.e. if the new face has a
3762 box, all characters up to limit will have one. But, as
3763 usual, we don't know whether limit is really the end. */
3764 if (new_face_id
!= it
->face_id
)
3766 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3767 /* If it->face_id is -1, old_face below will be NULL, see
3768 the definition of FACE_FROM_ID. This will happen if this
3769 is the initial call that gets the face. */
3770 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3772 /* If the value of face_id of the iterator is -1, we have to
3773 look in front of IT's position and see whether there is a
3774 face there that's different from new_face_id. */
3775 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3777 int prev_face_id
= face_before_it_pos (it
);
3779 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3782 /* If the new face has a box, but the old face does not,
3783 this is the start of a run of characters with box face,
3784 i.e. this character has a shadow on the left side. */
3785 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3786 && (old_face
== NULL
|| !old_face
->box
));
3787 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3795 Lisp_Object from_overlay
3796 = (it
->current
.overlay_string_index
>= 0
3797 ? it
->string_overlays
[it
->current
.overlay_string_index
3798 % OVERLAY_STRING_CHUNK_SIZE
]
3801 /* See if we got to this string directly or indirectly from
3802 an overlay property. That includes the before-string or
3803 after-string of an overlay, strings in display properties
3804 provided by an overlay, their text properties, etc.
3806 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3807 if (! NILP (from_overlay
))
3808 for (i
= it
->sp
- 1; i
>= 0; i
--)
3810 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3812 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3813 % OVERLAY_STRING_CHUNK_SIZE
];
3814 else if (! NILP (it
->stack
[i
].from_overlay
))
3815 from_overlay
= it
->stack
[i
].from_overlay
;
3817 if (!NILP (from_overlay
))
3821 if (! NILP (from_overlay
))
3823 bufpos
= IT_CHARPOS (*it
);
3824 /* For a string from an overlay, the base face depends
3825 only on text properties and ignores overlays. */
3827 = face_for_overlay_string (it
->w
,
3829 it
->region_beg_charpos
,
3830 it
->region_end_charpos
,
3833 + TEXT_PROP_DISTANCE_LIMIT
),
3841 /* For strings from a `display' property, use the face at
3842 IT's current buffer position as the base face to merge
3843 with, so that overlay strings appear in the same face as
3844 surrounding text, unless they specify their own
3846 base_face_id
= it
->string_from_prefix_prop_p
3848 : underlying_face_id (it
);
3851 new_face_id
= face_at_string_position (it
->w
,
3853 IT_STRING_CHARPOS (*it
),
3855 it
->region_beg_charpos
,
3856 it
->region_end_charpos
,
3860 /* Is this a start of a run of characters with box? Caveat:
3861 this can be called for a freshly allocated iterator; face_id
3862 is -1 is this case. We know that the new face will not
3863 change until the next check pos, i.e. if the new face has a
3864 box, all characters up to that position will have a
3865 box. But, as usual, we don't know whether that position
3866 is really the end. */
3867 if (new_face_id
!= it
->face_id
)
3869 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3870 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3872 /* If new face has a box but old face hasn't, this is the
3873 start of a run of characters with box, i.e. it has a
3874 shadow on the left side. */
3875 it
->start_of_box_run_p
3876 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3877 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3881 it
->face_id
= new_face_id
;
3882 return HANDLED_NORMALLY
;
3886 /* Return the ID of the face ``underlying'' IT's current position,
3887 which is in a string. If the iterator is associated with a
3888 buffer, return the face at IT's current buffer position.
3889 Otherwise, use the iterator's base_face_id. */
3892 underlying_face_id (struct it
*it
)
3894 int face_id
= it
->base_face_id
, i
;
3896 eassert (STRINGP (it
->string
));
3898 for (i
= it
->sp
- 1; i
>= 0; --i
)
3899 if (NILP (it
->stack
[i
].string
))
3900 face_id
= it
->stack
[i
].face_id
;
3906 /* Compute the face one character before or after the current position
3907 of IT, in the visual order. BEFORE_P non-zero means get the face
3908 in front (to the left in L2R paragraphs, to the right in R2L
3909 paragraphs) of IT's screen position. Value is the ID of the face. */
3912 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3915 ptrdiff_t next_check_charpos
;
3917 void *it_copy_data
= NULL
;
3919 eassert (it
->s
== NULL
);
3921 if (STRINGP (it
->string
))
3923 ptrdiff_t bufpos
, charpos
;
3926 /* No face change past the end of the string (for the case
3927 we are padding with spaces). No face change before the
3929 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3930 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3935 /* Set charpos to the position before or after IT's current
3936 position, in the logical order, which in the non-bidi
3937 case is the same as the visual order. */
3939 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3940 else if (it
->what
== IT_COMPOSITION
)
3941 /* For composition, we must check the character after the
3943 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3945 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3951 /* With bidi iteration, the character before the current
3952 in the visual order cannot be found by simple
3953 iteration, because "reverse" reordering is not
3954 supported. Instead, we need to use the move_it_*
3955 family of functions. */
3956 /* Ignore face changes before the first visible
3957 character on this display line. */
3958 if (it
->current_x
<= it
->first_visible_x
)
3960 SAVE_IT (it_copy
, *it
, it_copy_data
);
3961 /* Implementation note: Since move_it_in_display_line
3962 works in the iterator geometry, and thinks the first
3963 character is always the leftmost, even in R2L lines,
3964 we don't need to distinguish between the R2L and L2R
3966 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3967 it_copy
.current_x
- 1, MOVE_TO_X
);
3968 charpos
= IT_STRING_CHARPOS (it_copy
);
3969 RESTORE_IT (it
, it
, it_copy_data
);
3973 /* Set charpos to the string position of the character
3974 that comes after IT's current position in the visual
3976 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3980 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3982 charpos
= it_copy
.bidi_it
.charpos
;
3985 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3987 if (it
->current
.overlay_string_index
>= 0)
3988 bufpos
= IT_CHARPOS (*it
);
3992 base_face_id
= underlying_face_id (it
);
3994 /* Get the face for ASCII, or unibyte. */
3995 face_id
= face_at_string_position (it
->w
,
3999 it
->region_beg_charpos
,
4000 it
->region_end_charpos
,
4001 &next_check_charpos
,
4004 /* Correct the face for charsets different from ASCII. Do it
4005 for the multibyte case only. The face returned above is
4006 suitable for unibyte text if IT->string is unibyte. */
4007 if (STRING_MULTIBYTE (it
->string
))
4009 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4010 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4012 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4014 c
= string_char_and_length (p
, &len
);
4015 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4020 struct text_pos pos
;
4022 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4023 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4026 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4027 pos
= it
->current
.pos
;
4032 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4035 if (it
->what
== IT_COMPOSITION
)
4037 /* For composition, we must check the position after
4039 pos
.charpos
+= it
->cmp_it
.nchars
;
4040 pos
.bytepos
+= it
->len
;
4043 INC_TEXT_POS (pos
, it
->multibyte_p
);
4050 /* With bidi iteration, the character before the current
4051 in the visual order cannot be found by simple
4052 iteration, because "reverse" reordering is not
4053 supported. Instead, we need to use the move_it_*
4054 family of functions. */
4055 /* Ignore face changes before the first visible
4056 character on this display line. */
4057 if (it
->current_x
<= it
->first_visible_x
)
4059 SAVE_IT (it_copy
, *it
, it_copy_data
);
4060 /* Implementation note: Since move_it_in_display_line
4061 works in the iterator geometry, and thinks the first
4062 character is always the leftmost, even in R2L lines,
4063 we don't need to distinguish between the R2L and L2R
4065 move_it_in_display_line (&it_copy
, ZV
,
4066 it_copy
.current_x
- 1, MOVE_TO_X
);
4067 pos
= it_copy
.current
.pos
;
4068 RESTORE_IT (it
, it
, it_copy_data
);
4072 /* Set charpos to the buffer position of the character
4073 that comes after IT's current position in the visual
4075 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4079 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4082 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4085 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4087 /* Determine face for CHARSET_ASCII, or unibyte. */
4088 face_id
= face_at_buffer_position (it
->w
,
4090 it
->region_beg_charpos
,
4091 it
->region_end_charpos
,
4092 &next_check_charpos
,
4095 /* Correct the face for charsets different from ASCII. Do it
4096 for the multibyte case only. The face returned above is
4097 suitable for unibyte text if current_buffer is unibyte. */
4098 if (it
->multibyte_p
)
4100 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4101 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4102 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4111 /***********************************************************************
4113 ***********************************************************************/
4115 /* Set up iterator IT from invisible properties at its current
4116 position. Called from handle_stop. */
4118 static enum prop_handled
4119 handle_invisible_prop (struct it
*it
)
4121 enum prop_handled handled
= HANDLED_NORMALLY
;
4125 if (STRINGP (it
->string
))
4127 Lisp_Object end_charpos
, limit
, charpos
;
4129 /* Get the value of the invisible text property at the
4130 current position. Value will be nil if there is no such
4132 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4133 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4134 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4136 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4138 /* Record whether we have to display an ellipsis for the
4140 int display_ellipsis_p
= (invis_p
== 2);
4141 ptrdiff_t len
, endpos
;
4143 handled
= HANDLED_RECOMPUTE_PROPS
;
4145 /* Get the position at which the next visible text can be
4146 found in IT->string, if any. */
4147 endpos
= len
= SCHARS (it
->string
);
4148 XSETINT (limit
, len
);
4151 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4153 if (INTEGERP (end_charpos
))
4155 endpos
= XFASTINT (end_charpos
);
4156 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4157 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4159 display_ellipsis_p
= 1;
4162 while (invis_p
&& endpos
< len
);
4164 if (display_ellipsis_p
)
4169 /* Text at END_CHARPOS is visible. Move IT there. */
4170 struct text_pos old
;
4173 old
= it
->current
.string_pos
;
4174 oldpos
= CHARPOS (old
);
4177 if (it
->bidi_it
.first_elt
4178 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4179 bidi_paragraph_init (it
->paragraph_embedding
,
4181 /* Bidi-iterate out of the invisible text. */
4184 bidi_move_to_visually_next (&it
->bidi_it
);
4186 while (oldpos
<= it
->bidi_it
.charpos
4187 && it
->bidi_it
.charpos
< endpos
);
4189 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4190 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4191 if (IT_CHARPOS (*it
) >= endpos
)
4192 it
->prev_stop
= endpos
;
4196 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4197 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4202 /* The rest of the string is invisible. If this is an
4203 overlay string, proceed with the next overlay string
4204 or whatever comes and return a character from there. */
4205 if (it
->current
.overlay_string_index
>= 0
4206 && !display_ellipsis_p
)
4208 next_overlay_string (it
);
4209 /* Don't check for overlay strings when we just
4210 finished processing them. */
4211 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4215 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4216 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4223 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4224 Lisp_Object pos
, overlay
;
4226 /* First of all, is there invisible text at this position? */
4227 tem
= start_charpos
= IT_CHARPOS (*it
);
4228 pos
= make_number (tem
);
4229 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4231 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4233 /* If we are on invisible text, skip over it. */
4234 if (invis_p
&& start_charpos
< it
->end_charpos
)
4236 /* Record whether we have to display an ellipsis for the
4238 int display_ellipsis_p
= invis_p
== 2;
4240 handled
= HANDLED_RECOMPUTE_PROPS
;
4242 /* Loop skipping over invisible text. The loop is left at
4243 ZV or with IT on the first char being visible again. */
4246 /* Try to skip some invisible text. Return value is the
4247 position reached which can be equal to where we start
4248 if there is nothing invisible there. This skips both
4249 over invisible text properties and overlays with
4250 invisible property. */
4251 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4253 /* If we skipped nothing at all we weren't at invisible
4254 text in the first place. If everything to the end of
4255 the buffer was skipped, end the loop. */
4256 if (newpos
== tem
|| newpos
>= ZV
)
4260 /* We skipped some characters but not necessarily
4261 all there are. Check if we ended up on visible
4262 text. Fget_char_property returns the property of
4263 the char before the given position, i.e. if we
4264 get invis_p = 0, this means that the char at
4265 newpos is visible. */
4266 pos
= make_number (newpos
);
4267 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4268 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4271 /* If we ended up on invisible text, proceed to
4272 skip starting with next_stop. */
4276 /* If there are adjacent invisible texts, don't lose the
4277 second one's ellipsis. */
4279 display_ellipsis_p
= 1;
4283 /* The position newpos is now either ZV or on visible text. */
4286 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4288 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4290 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4292 /* If the invisible text ends on a newline or on a
4293 character after a newline, we can avoid the costly,
4294 character by character, bidi iteration to NEWPOS, and
4295 instead simply reseat the iterator there. That's
4296 because all bidi reordering information is tossed at
4297 the newline. This is a big win for modes that hide
4298 complete lines, like Outline, Org, etc. */
4299 if (on_newline
|| after_newline
)
4301 struct text_pos tpos
;
4302 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4304 SET_TEXT_POS (tpos
, newpos
, bpos
);
4305 reseat_1 (it
, tpos
, 0);
4306 /* If we reseat on a newline/ZV, we need to prep the
4307 bidi iterator for advancing to the next character
4308 after the newline/EOB, keeping the current paragraph
4309 direction (so that PRODUCE_GLYPHS does TRT wrt
4310 prepending/appending glyphs to a glyph row). */
4313 it
->bidi_it
.first_elt
= 0;
4314 it
->bidi_it
.paragraph_dir
= pdir
;
4315 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4316 it
->bidi_it
.nchars
= 1;
4317 it
->bidi_it
.ch_len
= 1;
4320 else /* Must use the slow method. */
4322 /* With bidi iteration, the region of invisible text
4323 could start and/or end in the middle of a
4324 non-base embedding level. Therefore, we need to
4325 skip invisible text using the bidi iterator,
4326 starting at IT's current position, until we find
4327 ourselves outside of the invisible text.
4328 Skipping invisible text _after_ bidi iteration
4329 avoids affecting the visual order of the
4330 displayed text when invisible properties are
4331 added or removed. */
4332 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4334 /* If we were `reseat'ed to a new paragraph,
4335 determine the paragraph base direction. We
4336 need to do it now because
4337 next_element_from_buffer may not have a
4338 chance to do it, if we are going to skip any
4339 text at the beginning, which resets the
4341 bidi_paragraph_init (it
->paragraph_embedding
,
4346 bidi_move_to_visually_next (&it
->bidi_it
);
4348 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4349 && it
->bidi_it
.charpos
< newpos
);
4350 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4351 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4352 /* If we overstepped NEWPOS, record its position in
4353 the iterator, so that we skip invisible text if
4354 later the bidi iteration lands us in the
4355 invisible region again. */
4356 if (IT_CHARPOS (*it
) >= newpos
)
4357 it
->prev_stop
= newpos
;
4362 IT_CHARPOS (*it
) = newpos
;
4363 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4366 /* If there are before-strings at the start of invisible
4367 text, and the text is invisible because of a text
4368 property, arrange to show before-strings because 20.x did
4369 it that way. (If the text is invisible because of an
4370 overlay property instead of a text property, this is
4371 already handled in the overlay code.) */
4373 && get_overlay_strings (it
, it
->stop_charpos
))
4375 handled
= HANDLED_RECOMPUTE_PROPS
;
4376 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4378 else if (display_ellipsis_p
)
4380 /* Make sure that the glyphs of the ellipsis will get
4381 correct `charpos' values. If we would not update
4382 it->position here, the glyphs would belong to the
4383 last visible character _before_ the invisible
4384 text, which confuses `set_cursor_from_row'.
4386 We use the last invisible position instead of the
4387 first because this way the cursor is always drawn on
4388 the first "." of the ellipsis, whenever PT is inside
4389 the invisible text. Otherwise the cursor would be
4390 placed _after_ the ellipsis when the point is after the
4391 first invisible character. */
4392 if (!STRINGP (it
->object
))
4394 it
->position
.charpos
= newpos
- 1;
4395 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4398 /* Let the ellipsis display before
4399 considering any properties of the following char.
4400 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4401 handled
= HANDLED_RETURN
;
4410 /* Make iterator IT return `...' next.
4411 Replaces LEN characters from buffer. */
4414 setup_for_ellipsis (struct it
*it
, int len
)
4416 /* Use the display table definition for `...'. Invalid glyphs
4417 will be handled by the method returning elements from dpvec. */
4418 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4420 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4421 it
->dpvec
= v
->contents
;
4422 it
->dpend
= v
->contents
+ v
->header
.size
;
4426 /* Default `...'. */
4427 it
->dpvec
= default_invis_vector
;
4428 it
->dpend
= default_invis_vector
+ 3;
4431 it
->dpvec_char_len
= len
;
4432 it
->current
.dpvec_index
= 0;
4433 it
->dpvec_face_id
= -1;
4435 /* Remember the current face id in case glyphs specify faces.
4436 IT's face is restored in set_iterator_to_next.
4437 saved_face_id was set to preceding char's face in handle_stop. */
4438 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4439 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4441 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4447 /***********************************************************************
4449 ***********************************************************************/
4451 /* Set up iterator IT from `display' property at its current position.
4452 Called from handle_stop.
4453 We return HANDLED_RETURN if some part of the display property
4454 overrides the display of the buffer text itself.
4455 Otherwise we return HANDLED_NORMALLY. */
4457 static enum prop_handled
4458 handle_display_prop (struct it
*it
)
4460 Lisp_Object propval
, object
, overlay
;
4461 struct text_pos
*position
;
4463 /* Nonzero if some property replaces the display of the text itself. */
4464 int display_replaced_p
= 0;
4466 if (STRINGP (it
->string
))
4468 object
= it
->string
;
4469 position
= &it
->current
.string_pos
;
4470 bufpos
= CHARPOS (it
->current
.pos
);
4474 XSETWINDOW (object
, it
->w
);
4475 position
= &it
->current
.pos
;
4476 bufpos
= CHARPOS (*position
);
4479 /* Reset those iterator values set from display property values. */
4480 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4481 it
->space_width
= Qnil
;
4482 it
->font_height
= Qnil
;
4485 /* We don't support recursive `display' properties, i.e. string
4486 values that have a string `display' property, that have a string
4487 `display' property etc. */
4488 if (!it
->string_from_display_prop_p
)
4489 it
->area
= TEXT_AREA
;
4491 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4492 Qdisplay
, object
, &overlay
);
4494 return HANDLED_NORMALLY
;
4495 /* Now OVERLAY is the overlay that gave us this property, or nil
4496 if it was a text property. */
4498 if (!STRINGP (it
->string
))
4499 object
= it
->w
->buffer
;
4501 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4503 FRAME_WINDOW_P (it
->f
));
4505 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4508 /* Subroutine of handle_display_prop. Returns non-zero if the display
4509 specification in SPEC is a replacing specification, i.e. it would
4510 replace the text covered by `display' property with something else,
4511 such as an image or a display string. If SPEC includes any kind or
4512 `(space ...) specification, the value is 2; this is used by
4513 compute_display_string_pos, which see.
4515 See handle_single_display_spec for documentation of arguments.
4516 frame_window_p is non-zero if the window being redisplayed is on a
4517 GUI frame; this argument is used only if IT is NULL, see below.
4519 IT can be NULL, if this is called by the bidi reordering code
4520 through compute_display_string_pos, which see. In that case, this
4521 function only examines SPEC, but does not otherwise "handle" it, in
4522 the sense that it doesn't set up members of IT from the display
4525 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4526 Lisp_Object overlay
, struct text_pos
*position
,
4527 ptrdiff_t bufpos
, int frame_window_p
)
4529 int replacing_p
= 0;
4533 /* Simple specifications. */
4534 && !EQ (XCAR (spec
), Qimage
)
4535 && !EQ (XCAR (spec
), Qspace
)
4536 && !EQ (XCAR (spec
), Qwhen
)
4537 && !EQ (XCAR (spec
), Qslice
)
4538 && !EQ (XCAR (spec
), Qspace_width
)
4539 && !EQ (XCAR (spec
), Qheight
)
4540 && !EQ (XCAR (spec
), Qraise
)
4541 /* Marginal area specifications. */
4542 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4543 && !EQ (XCAR (spec
), Qleft_fringe
)
4544 && !EQ (XCAR (spec
), Qright_fringe
)
4545 && !NILP (XCAR (spec
)))
4547 for (; CONSP (spec
); spec
= XCDR (spec
))
4549 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4550 overlay
, position
, bufpos
,
4551 replacing_p
, frame_window_p
)))
4554 /* If some text in a string is replaced, `position' no
4555 longer points to the position of `object'. */
4556 if (!it
|| STRINGP (object
))
4561 else if (VECTORP (spec
))
4564 for (i
= 0; i
< ASIZE (spec
); ++i
)
4565 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4566 overlay
, position
, bufpos
,
4567 replacing_p
, frame_window_p
)))
4570 /* If some text in a string is replaced, `position' no
4571 longer points to the position of `object'. */
4572 if (!it
|| STRINGP (object
))
4578 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4579 position
, bufpos
, 0,
4587 /* Value is the position of the end of the `display' property starting
4588 at START_POS in OBJECT. */
4590 static struct text_pos
4591 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4594 struct text_pos end_pos
;
4596 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4597 Qdisplay
, object
, Qnil
);
4598 CHARPOS (end_pos
) = XFASTINT (end
);
4599 if (STRINGP (object
))
4600 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4602 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4608 /* Set up IT from a single `display' property specification SPEC. OBJECT
4609 is the object in which the `display' property was found. *POSITION
4610 is the position in OBJECT at which the `display' property was found.
4611 BUFPOS is the buffer position of OBJECT (different from POSITION if
4612 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4613 previously saw a display specification which already replaced text
4614 display with something else, for example an image; we ignore such
4615 properties after the first one has been processed.
4617 OVERLAY is the overlay this `display' property came from,
4618 or nil if it was a text property.
4620 If SPEC is a `space' or `image' specification, and in some other
4621 cases too, set *POSITION to the position where the `display'
4624 If IT is NULL, only examine the property specification in SPEC, but
4625 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4626 is intended to be displayed in a window on a GUI frame.
4628 Value is non-zero if something was found which replaces the display
4629 of buffer or string text. */
4632 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4633 Lisp_Object overlay
, struct text_pos
*position
,
4634 ptrdiff_t bufpos
, int display_replaced_p
,
4638 Lisp_Object location
, value
;
4639 struct text_pos start_pos
= *position
;
4642 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4643 If the result is non-nil, use VALUE instead of SPEC. */
4645 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4654 if (!NILP (form
) && !EQ (form
, Qt
))
4656 ptrdiff_t count
= SPECPDL_INDEX ();
4657 struct gcpro gcpro1
;
4659 /* Bind `object' to the object having the `display' property, a
4660 buffer or string. Bind `position' to the position in the
4661 object where the property was found, and `buffer-position'
4662 to the current position in the buffer. */
4665 XSETBUFFER (object
, current_buffer
);
4666 specbind (Qobject
, object
);
4667 specbind (Qposition
, make_number (CHARPOS (*position
)));
4668 specbind (Qbuffer_position
, make_number (bufpos
));
4670 form
= safe_eval (form
);
4672 unbind_to (count
, Qnil
);
4678 /* Handle `(height HEIGHT)' specifications. */
4680 && EQ (XCAR (spec
), Qheight
)
4681 && CONSP (XCDR (spec
)))
4685 if (!FRAME_WINDOW_P (it
->f
))
4688 it
->font_height
= XCAR (XCDR (spec
));
4689 if (!NILP (it
->font_height
))
4691 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4692 int new_height
= -1;
4694 if (CONSP (it
->font_height
)
4695 && (EQ (XCAR (it
->font_height
), Qplus
)
4696 || EQ (XCAR (it
->font_height
), Qminus
))
4697 && CONSP (XCDR (it
->font_height
))
4698 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4700 /* `(+ N)' or `(- N)' where N is an integer. */
4701 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4702 if (EQ (XCAR (it
->font_height
), Qplus
))
4704 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4706 else if (FUNCTIONP (it
->font_height
))
4708 /* Call function with current height as argument.
4709 Value is the new height. */
4711 height
= safe_call1 (it
->font_height
,
4712 face
->lface
[LFACE_HEIGHT_INDEX
]);
4713 if (NUMBERP (height
))
4714 new_height
= XFLOATINT (height
);
4716 else if (NUMBERP (it
->font_height
))
4718 /* Value is a multiple of the canonical char height. */
4721 f
= FACE_FROM_ID (it
->f
,
4722 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4723 new_height
= (XFLOATINT (it
->font_height
)
4724 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4728 /* Evaluate IT->font_height with `height' bound to the
4729 current specified height to get the new height. */
4730 ptrdiff_t count
= SPECPDL_INDEX ();
4732 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4733 value
= safe_eval (it
->font_height
);
4734 unbind_to (count
, Qnil
);
4736 if (NUMBERP (value
))
4737 new_height
= XFLOATINT (value
);
4741 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4748 /* Handle `(space-width WIDTH)'. */
4750 && EQ (XCAR (spec
), Qspace_width
)
4751 && CONSP (XCDR (spec
)))
4755 if (!FRAME_WINDOW_P (it
->f
))
4758 value
= XCAR (XCDR (spec
));
4759 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4760 it
->space_width
= value
;
4766 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4768 && EQ (XCAR (spec
), Qslice
))
4774 if (!FRAME_WINDOW_P (it
->f
))
4777 if (tem
= XCDR (spec
), CONSP (tem
))
4779 it
->slice
.x
= XCAR (tem
);
4780 if (tem
= XCDR (tem
), CONSP (tem
))
4782 it
->slice
.y
= XCAR (tem
);
4783 if (tem
= XCDR (tem
), CONSP (tem
))
4785 it
->slice
.width
= XCAR (tem
);
4786 if (tem
= XCDR (tem
), CONSP (tem
))
4787 it
->slice
.height
= XCAR (tem
);
4796 /* Handle `(raise FACTOR)'. */
4798 && EQ (XCAR (spec
), Qraise
)
4799 && CONSP (XCDR (spec
)))
4803 if (!FRAME_WINDOW_P (it
->f
))
4806 #ifdef HAVE_WINDOW_SYSTEM
4807 value
= XCAR (XCDR (spec
));
4808 if (NUMBERP (value
))
4810 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4811 it
->voffset
= - (XFLOATINT (value
)
4812 * (FONT_HEIGHT (face
->font
)));
4814 #endif /* HAVE_WINDOW_SYSTEM */
4820 /* Don't handle the other kinds of display specifications
4821 inside a string that we got from a `display' property. */
4822 if (it
&& it
->string_from_display_prop_p
)
4825 /* Characters having this form of property are not displayed, so
4826 we have to find the end of the property. */
4829 start_pos
= *position
;
4830 *position
= display_prop_end (it
, object
, start_pos
);
4834 /* Stop the scan at that end position--we assume that all
4835 text properties change there. */
4837 it
->stop_charpos
= position
->charpos
;
4839 /* Handle `(left-fringe BITMAP [FACE])'
4840 and `(right-fringe BITMAP [FACE])'. */
4842 && (EQ (XCAR (spec
), Qleft_fringe
)
4843 || EQ (XCAR (spec
), Qright_fringe
))
4844 && CONSP (XCDR (spec
)))
4850 if (!FRAME_WINDOW_P (it
->f
))
4851 /* If we return here, POSITION has been advanced
4852 across the text with this property. */
4854 /* Synchronize the bidi iterator with POSITION. This is
4855 needed because we are not going to push the iterator
4856 on behalf of this display property, so there will be
4857 no pop_it call to do this synchronization for us. */
4860 it
->position
= *position
;
4861 iterate_out_of_display_property (it
);
4862 *position
= it
->position
;
4867 else if (!frame_window_p
)
4870 #ifdef HAVE_WINDOW_SYSTEM
4871 value
= XCAR (XCDR (spec
));
4872 if (!SYMBOLP (value
)
4873 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4874 /* If we return here, POSITION has been advanced
4875 across the text with this property. */
4877 if (it
&& it
->bidi_p
)
4879 it
->position
= *position
;
4880 iterate_out_of_display_property (it
);
4881 *position
= it
->position
;
4888 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4890 if (CONSP (XCDR (XCDR (spec
))))
4892 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4893 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4899 /* Save current settings of IT so that we can restore them
4900 when we are finished with the glyph property value. */
4901 push_it (it
, position
);
4903 it
->area
= TEXT_AREA
;
4904 it
->what
= IT_IMAGE
;
4905 it
->image_id
= -1; /* no image */
4906 it
->position
= start_pos
;
4907 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4908 it
->method
= GET_FROM_IMAGE
;
4909 it
->from_overlay
= Qnil
;
4910 it
->face_id
= face_id
;
4911 it
->from_disp_prop_p
= 1;
4913 /* Say that we haven't consumed the characters with
4914 `display' property yet. The call to pop_it in
4915 set_iterator_to_next will clean this up. */
4916 *position
= start_pos
;
4918 if (EQ (XCAR (spec
), Qleft_fringe
))
4920 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4921 it
->left_user_fringe_face_id
= face_id
;
4925 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4926 it
->right_user_fringe_face_id
= face_id
;
4929 #endif /* HAVE_WINDOW_SYSTEM */
4933 /* Prepare to handle `((margin left-margin) ...)',
4934 `((margin right-margin) ...)' and `((margin nil) ...)'
4935 prefixes for display specifications. */
4936 location
= Qunbound
;
4937 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4941 value
= XCDR (spec
);
4943 value
= XCAR (value
);
4946 if (EQ (XCAR (tem
), Qmargin
)
4947 && (tem
= XCDR (tem
),
4948 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4950 || EQ (tem
, Qleft_margin
)
4951 || EQ (tem
, Qright_margin
))))
4955 if (EQ (location
, Qunbound
))
4961 /* After this point, VALUE is the property after any
4962 margin prefix has been stripped. It must be a string,
4963 an image specification, or `(space ...)'.
4965 LOCATION specifies where to display: `left-margin',
4966 `right-margin' or nil. */
4968 valid_p
= (STRINGP (value
)
4969 #ifdef HAVE_WINDOW_SYSTEM
4970 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4971 && valid_image_p (value
))
4972 #endif /* not HAVE_WINDOW_SYSTEM */
4973 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4975 if (valid_p
&& !display_replaced_p
)
4981 /* Callers need to know whether the display spec is any kind
4982 of `(space ...)' spec that is about to affect text-area
4984 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4989 /* Save current settings of IT so that we can restore them
4990 when we are finished with the glyph property value. */
4991 push_it (it
, position
);
4992 it
->from_overlay
= overlay
;
4993 it
->from_disp_prop_p
= 1;
4995 if (NILP (location
))
4996 it
->area
= TEXT_AREA
;
4997 else if (EQ (location
, Qleft_margin
))
4998 it
->area
= LEFT_MARGIN_AREA
;
5000 it
->area
= RIGHT_MARGIN_AREA
;
5002 if (STRINGP (value
))
5005 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5006 it
->current
.overlay_string_index
= -1;
5007 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5008 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5009 it
->method
= GET_FROM_STRING
;
5010 it
->stop_charpos
= 0;
5012 it
->base_level_stop
= 0;
5013 it
->string_from_display_prop_p
= 1;
5014 /* Say that we haven't consumed the characters with
5015 `display' property yet. The call to pop_it in
5016 set_iterator_to_next will clean this up. */
5017 if (BUFFERP (object
))
5018 *position
= start_pos
;
5020 /* Force paragraph direction to be that of the parent
5021 object. If the parent object's paragraph direction is
5022 not yet determined, default to L2R. */
5023 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5024 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5026 it
->paragraph_embedding
= L2R
;
5028 /* Set up the bidi iterator for this display string. */
5031 it
->bidi_it
.string
.lstring
= it
->string
;
5032 it
->bidi_it
.string
.s
= NULL
;
5033 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5034 it
->bidi_it
.string
.bufpos
= bufpos
;
5035 it
->bidi_it
.string
.from_disp_str
= 1;
5036 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5037 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5040 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5042 it
->method
= GET_FROM_STRETCH
;
5044 *position
= it
->position
= start_pos
;
5045 retval
= 1 + (it
->area
== TEXT_AREA
);
5047 #ifdef HAVE_WINDOW_SYSTEM
5050 it
->what
= IT_IMAGE
;
5051 it
->image_id
= lookup_image (it
->f
, value
);
5052 it
->position
= start_pos
;
5053 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
5054 it
->method
= GET_FROM_IMAGE
;
5056 /* Say that we haven't consumed the characters with
5057 `display' property yet. The call to pop_it in
5058 set_iterator_to_next will clean this up. */
5059 *position
= start_pos
;
5061 #endif /* HAVE_WINDOW_SYSTEM */
5066 /* Invalid property or property not supported. Restore
5067 POSITION to what it was before. */
5068 *position
= start_pos
;
5072 /* Check if PROP is a display property value whose text should be
5073 treated as intangible. OVERLAY is the overlay from which PROP
5074 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5075 specify the buffer position covered by PROP. */
5078 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5079 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5081 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5082 struct text_pos position
;
5084 SET_TEXT_POS (position
, charpos
, bytepos
);
5085 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5086 &position
, charpos
, frame_window_p
);
5090 /* Return 1 if PROP is a display sub-property value containing STRING.
5092 Implementation note: this and the following function are really
5093 special cases of handle_display_spec and
5094 handle_single_display_spec, and should ideally use the same code.
5095 Until they do, these two pairs must be consistent and must be
5096 modified in sync. */
5099 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5101 if (EQ (string
, prop
))
5104 /* Skip over `when FORM'. */
5105 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5110 /* Actually, the condition following `when' should be eval'ed,
5111 like handle_single_display_spec does, and we should return
5112 zero if it evaluates to nil. However, this function is
5113 called only when the buffer was already displayed and some
5114 glyph in the glyph matrix was found to come from a display
5115 string. Therefore, the condition was already evaluated, and
5116 the result was non-nil, otherwise the display string wouldn't
5117 have been displayed and we would have never been called for
5118 this property. Thus, we can skip the evaluation and assume
5119 its result is non-nil. */
5124 /* Skip over `margin LOCATION'. */
5125 if (EQ (XCAR (prop
), Qmargin
))
5136 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5140 /* Return 1 if STRING appears in the `display' property PROP. */
5143 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5146 && !EQ (XCAR (prop
), Qwhen
)
5147 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5149 /* A list of sub-properties. */
5150 while (CONSP (prop
))
5152 if (single_display_spec_string_p (XCAR (prop
), string
))
5157 else if (VECTORP (prop
))
5159 /* A vector of sub-properties. */
5161 for (i
= 0; i
< ASIZE (prop
); ++i
)
5162 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5166 return single_display_spec_string_p (prop
, string
);
5171 /* Look for STRING in overlays and text properties in the current
5172 buffer, between character positions FROM and TO (excluding TO).
5173 BACK_P non-zero means look back (in this case, TO is supposed to be
5175 Value is the first character position where STRING was found, or
5176 zero if it wasn't found before hitting TO.
5178 This function may only use code that doesn't eval because it is
5179 called asynchronously from note_mouse_highlight. */
5182 string_buffer_position_lim (Lisp_Object string
,
5183 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5185 Lisp_Object limit
, prop
, pos
;
5188 pos
= make_number (max (from
, BEGV
));
5190 if (!back_p
) /* looking forward */
5192 limit
= make_number (min (to
, ZV
));
5193 while (!found
&& !EQ (pos
, limit
))
5195 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5196 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5199 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5203 else /* looking back */
5205 limit
= make_number (max (to
, BEGV
));
5206 while (!found
&& !EQ (pos
, limit
))
5208 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5209 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5212 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5217 return found
? XINT (pos
) : 0;
5220 /* Determine which buffer position in current buffer STRING comes from.
5221 AROUND_CHARPOS is an approximate position where it could come from.
5222 Value is the buffer position or 0 if it couldn't be determined.
5224 This function is necessary because we don't record buffer positions
5225 in glyphs generated from strings (to keep struct glyph small).
5226 This function may only use code that doesn't eval because it is
5227 called asynchronously from note_mouse_highlight. */
5230 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5232 const int MAX_DISTANCE
= 1000;
5233 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5234 around_charpos
+ MAX_DISTANCE
,
5238 found
= string_buffer_position_lim (string
, around_charpos
,
5239 around_charpos
- MAX_DISTANCE
, 1);
5245 /***********************************************************************
5246 `composition' property
5247 ***********************************************************************/
5249 /* Set up iterator IT from `composition' property at its current
5250 position. Called from handle_stop. */
5252 static enum prop_handled
5253 handle_composition_prop (struct it
*it
)
5255 Lisp_Object prop
, string
;
5256 ptrdiff_t pos
, pos_byte
, start
, end
;
5258 if (STRINGP (it
->string
))
5262 pos
= IT_STRING_CHARPOS (*it
);
5263 pos_byte
= IT_STRING_BYTEPOS (*it
);
5264 string
= it
->string
;
5265 s
= SDATA (string
) + pos_byte
;
5266 it
->c
= STRING_CHAR (s
);
5270 pos
= IT_CHARPOS (*it
);
5271 pos_byte
= IT_BYTEPOS (*it
);
5273 it
->c
= FETCH_CHAR (pos_byte
);
5276 /* If there's a valid composition and point is not inside of the
5277 composition (in the case that the composition is from the current
5278 buffer), draw a glyph composed from the composition components. */
5279 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5280 && COMPOSITION_VALID_P (start
, end
, prop
)
5281 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5284 /* As we can't handle this situation (perhaps font-lock added
5285 a new composition), we just return here hoping that next
5286 redisplay will detect this composition much earlier. */
5287 return HANDLED_NORMALLY
;
5290 if (STRINGP (it
->string
))
5291 pos_byte
= string_char_to_byte (it
->string
, start
);
5293 pos_byte
= CHAR_TO_BYTE (start
);
5295 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5298 if (it
->cmp_it
.id
>= 0)
5301 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5302 it
->cmp_it
.nglyphs
= -1;
5306 return HANDLED_NORMALLY
;
5311 /***********************************************************************
5313 ***********************************************************************/
5315 /* The following structure is used to record overlay strings for
5316 later sorting in load_overlay_strings. */
5318 struct overlay_entry
5320 Lisp_Object overlay
;
5327 /* Set up iterator IT from overlay strings at its current position.
5328 Called from handle_stop. */
5330 static enum prop_handled
5331 handle_overlay_change (struct it
*it
)
5333 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5334 return HANDLED_RECOMPUTE_PROPS
;
5336 return HANDLED_NORMALLY
;
5340 /* Set up the next overlay string for delivery by IT, if there is an
5341 overlay string to deliver. Called by set_iterator_to_next when the
5342 end of the current overlay string is reached. If there are more
5343 overlay strings to display, IT->string and
5344 IT->current.overlay_string_index are set appropriately here.
5345 Otherwise IT->string is set to nil. */
5348 next_overlay_string (struct it
*it
)
5350 ++it
->current
.overlay_string_index
;
5351 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5353 /* No more overlay strings. Restore IT's settings to what
5354 they were before overlay strings were processed, and
5355 continue to deliver from current_buffer. */
5357 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5360 || (NILP (it
->string
)
5361 && it
->method
== GET_FROM_BUFFER
5362 && it
->stop_charpos
>= BEGV
5363 && it
->stop_charpos
<= it
->end_charpos
));
5364 it
->current
.overlay_string_index
= -1;
5365 it
->n_overlay_strings
= 0;
5366 it
->overlay_strings_charpos
= -1;
5367 /* If there's an empty display string on the stack, pop the
5368 stack, to resync the bidi iterator with IT's position. Such
5369 empty strings are pushed onto the stack in
5370 get_overlay_strings_1. */
5371 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5374 /* If we're at the end of the buffer, record that we have
5375 processed the overlay strings there already, so that
5376 next_element_from_buffer doesn't try it again. */
5377 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5378 it
->overlay_strings_at_end_processed_p
= 1;
5382 /* There are more overlay strings to process. If
5383 IT->current.overlay_string_index has advanced to a position
5384 where we must load IT->overlay_strings with more strings, do
5385 it. We must load at the IT->overlay_strings_charpos where
5386 IT->n_overlay_strings was originally computed; when invisible
5387 text is present, this might not be IT_CHARPOS (Bug#7016). */
5388 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5390 if (it
->current
.overlay_string_index
&& i
== 0)
5391 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5393 /* Initialize IT to deliver display elements from the overlay
5395 it
->string
= it
->overlay_strings
[i
];
5396 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5397 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5398 it
->method
= GET_FROM_STRING
;
5399 it
->stop_charpos
= 0;
5400 it
->end_charpos
= SCHARS (it
->string
);
5401 if (it
->cmp_it
.stop_pos
>= 0)
5402 it
->cmp_it
.stop_pos
= 0;
5404 it
->base_level_stop
= 0;
5406 /* Set up the bidi iterator for this overlay string. */
5409 it
->bidi_it
.string
.lstring
= it
->string
;
5410 it
->bidi_it
.string
.s
= NULL
;
5411 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5412 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5413 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5414 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5415 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5423 /* Compare two overlay_entry structures E1 and E2. Used as a
5424 comparison function for qsort in load_overlay_strings. Overlay
5425 strings for the same position are sorted so that
5427 1. All after-strings come in front of before-strings, except
5428 when they come from the same overlay.
5430 2. Within after-strings, strings are sorted so that overlay strings
5431 from overlays with higher priorities come first.
5433 2. Within before-strings, strings are sorted so that overlay
5434 strings from overlays with higher priorities come last.
5436 Value is analogous to strcmp. */
5440 compare_overlay_entries (const void *e1
, const void *e2
)
5442 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5443 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5446 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5448 /* Let after-strings appear in front of before-strings if
5449 they come from different overlays. */
5450 if (EQ (entry1
->overlay
, entry2
->overlay
))
5451 result
= entry1
->after_string_p
? 1 : -1;
5453 result
= entry1
->after_string_p
? -1 : 1;
5455 else if (entry1
->priority
!= entry2
->priority
)
5457 if (entry1
->after_string_p
)
5458 /* After-strings sorted in order of decreasing priority. */
5459 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5461 /* Before-strings sorted in order of increasing priority. */
5462 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5471 /* Load the vector IT->overlay_strings with overlay strings from IT's
5472 current buffer position, or from CHARPOS if that is > 0. Set
5473 IT->n_overlays to the total number of overlay strings found.
5475 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5476 a time. On entry into load_overlay_strings,
5477 IT->current.overlay_string_index gives the number of overlay
5478 strings that have already been loaded by previous calls to this
5481 IT->add_overlay_start contains an additional overlay start
5482 position to consider for taking overlay strings from, if non-zero.
5483 This position comes into play when the overlay has an `invisible'
5484 property, and both before and after-strings. When we've skipped to
5485 the end of the overlay, because of its `invisible' property, we
5486 nevertheless want its before-string to appear.
5487 IT->add_overlay_start will contain the overlay start position
5490 Overlay strings are sorted so that after-string strings come in
5491 front of before-string strings. Within before and after-strings,
5492 strings are sorted by overlay priority. See also function
5493 compare_overlay_entries. */
5496 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5498 Lisp_Object overlay
, window
, str
, invisible
;
5499 struct Lisp_Overlay
*ov
;
5500 ptrdiff_t start
, end
;
5501 ptrdiff_t size
= 20;
5502 ptrdiff_t n
= 0, i
, j
;
5504 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5508 charpos
= IT_CHARPOS (*it
);
5510 /* Append the overlay string STRING of overlay OVERLAY to vector
5511 `entries' which has size `size' and currently contains `n'
5512 elements. AFTER_P non-zero means STRING is an after-string of
5514 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5517 Lisp_Object priority; \
5521 struct overlay_entry *old = entries; \
5522 SAFE_NALLOCA (entries, 2, size); \
5523 memcpy (entries, old, size * sizeof *entries); \
5527 entries[n].string = (STRING); \
5528 entries[n].overlay = (OVERLAY); \
5529 priority = Foverlay_get ((OVERLAY), Qpriority); \
5530 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5531 entries[n].after_string_p = (AFTER_P); \
5536 /* Process overlay before the overlay center. */
5537 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5539 XSETMISC (overlay
, ov
);
5540 eassert (OVERLAYP (overlay
));
5541 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5542 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5547 /* Skip this overlay if it doesn't start or end at IT's current
5549 if (end
!= charpos
&& start
!= charpos
)
5552 /* Skip this overlay if it doesn't apply to IT->w. */
5553 window
= Foverlay_get (overlay
, Qwindow
);
5554 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5557 /* If the text ``under'' the overlay is invisible, both before-
5558 and after-strings from this overlay are visible; start and
5559 end position are indistinguishable. */
5560 invisible
= Foverlay_get (overlay
, Qinvisible
);
5561 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5563 /* If overlay has a non-empty before-string, record it. */
5564 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5565 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5567 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5569 /* If overlay has a non-empty after-string, record it. */
5570 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5571 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5573 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5576 /* Process overlays after the overlay center. */
5577 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5579 XSETMISC (overlay
, ov
);
5580 eassert (OVERLAYP (overlay
));
5581 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5582 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5584 if (start
> charpos
)
5587 /* Skip this overlay if it doesn't start or end at IT's current
5589 if (end
!= charpos
&& start
!= charpos
)
5592 /* Skip this overlay if it doesn't apply to IT->w. */
5593 window
= Foverlay_get (overlay
, Qwindow
);
5594 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5597 /* If the text ``under'' the overlay is invisible, it has a zero
5598 dimension, and both before- and after-strings apply. */
5599 invisible
= Foverlay_get (overlay
, Qinvisible
);
5600 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5602 /* If overlay has a non-empty before-string, record it. */
5603 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5604 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5606 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5608 /* If overlay has a non-empty after-string, record it. */
5609 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5610 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5612 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5615 #undef RECORD_OVERLAY_STRING
5619 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5621 /* Record number of overlay strings, and where we computed it. */
5622 it
->n_overlay_strings
= n
;
5623 it
->overlay_strings_charpos
= charpos
;
5625 /* IT->current.overlay_string_index is the number of overlay strings
5626 that have already been consumed by IT. Copy some of the
5627 remaining overlay strings to IT->overlay_strings. */
5629 j
= it
->current
.overlay_string_index
;
5630 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5632 it
->overlay_strings
[i
] = entries
[j
].string
;
5633 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5641 /* Get the first chunk of overlay strings at IT's current buffer
5642 position, or at CHARPOS if that is > 0. Value is non-zero if at
5643 least one overlay string was found. */
5646 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5648 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5649 process. This fills IT->overlay_strings with strings, and sets
5650 IT->n_overlay_strings to the total number of strings to process.
5651 IT->pos.overlay_string_index has to be set temporarily to zero
5652 because load_overlay_strings needs this; it must be set to -1
5653 when no overlay strings are found because a zero value would
5654 indicate a position in the first overlay string. */
5655 it
->current
.overlay_string_index
= 0;
5656 load_overlay_strings (it
, charpos
);
5658 /* If we found overlay strings, set up IT to deliver display
5659 elements from the first one. Otherwise set up IT to deliver
5660 from current_buffer. */
5661 if (it
->n_overlay_strings
)
5663 /* Make sure we know settings in current_buffer, so that we can
5664 restore meaningful values when we're done with the overlay
5667 compute_stop_pos (it
);
5668 eassert (it
->face_id
>= 0);
5670 /* Save IT's settings. They are restored after all overlay
5671 strings have been processed. */
5672 eassert (!compute_stop_p
|| it
->sp
== 0);
5674 /* When called from handle_stop, there might be an empty display
5675 string loaded. In that case, don't bother saving it. But
5676 don't use this optimization with the bidi iterator, since we
5677 need the corresponding pop_it call to resync the bidi
5678 iterator's position with IT's position, after we are done
5679 with the overlay strings. (The corresponding call to pop_it
5680 in case of an empty display string is in
5681 next_overlay_string.) */
5683 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5686 /* Set up IT to deliver display elements from the first overlay
5688 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5689 it
->string
= it
->overlay_strings
[0];
5690 it
->from_overlay
= Qnil
;
5691 it
->stop_charpos
= 0;
5692 eassert (STRINGP (it
->string
));
5693 it
->end_charpos
= SCHARS (it
->string
);
5695 it
->base_level_stop
= 0;
5696 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5697 it
->method
= GET_FROM_STRING
;
5698 it
->from_disp_prop_p
= 0;
5700 /* Force paragraph direction to be that of the parent
5702 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5703 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5705 it
->paragraph_embedding
= L2R
;
5707 /* Set up the bidi iterator for this overlay string. */
5710 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5712 it
->bidi_it
.string
.lstring
= it
->string
;
5713 it
->bidi_it
.string
.s
= NULL
;
5714 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5715 it
->bidi_it
.string
.bufpos
= pos
;
5716 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5717 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5718 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5723 it
->current
.overlay_string_index
= -1;
5728 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5731 it
->method
= GET_FROM_BUFFER
;
5733 (void) get_overlay_strings_1 (it
, charpos
, 1);
5737 /* Value is non-zero if we found at least one overlay string. */
5738 return STRINGP (it
->string
);
5743 /***********************************************************************
5744 Saving and restoring state
5745 ***********************************************************************/
5747 /* Save current settings of IT on IT->stack. Called, for example,
5748 before setting up IT for an overlay string, to be able to restore
5749 IT's settings to what they were after the overlay string has been
5750 processed. If POSITION is non-NULL, it is the position to save on
5751 the stack instead of IT->position. */
5754 push_it (struct it
*it
, struct text_pos
*position
)
5756 struct iterator_stack_entry
*p
;
5758 eassert (it
->sp
< IT_STACK_SIZE
);
5759 p
= it
->stack
+ it
->sp
;
5761 p
->stop_charpos
= it
->stop_charpos
;
5762 p
->prev_stop
= it
->prev_stop
;
5763 p
->base_level_stop
= it
->base_level_stop
;
5764 p
->cmp_it
= it
->cmp_it
;
5765 eassert (it
->face_id
>= 0);
5766 p
->face_id
= it
->face_id
;
5767 p
->string
= it
->string
;
5768 p
->method
= it
->method
;
5769 p
->from_overlay
= it
->from_overlay
;
5772 case GET_FROM_IMAGE
:
5773 p
->u
.image
.object
= it
->object
;
5774 p
->u
.image
.image_id
= it
->image_id
;
5775 p
->u
.image
.slice
= it
->slice
;
5777 case GET_FROM_STRETCH
:
5778 p
->u
.stretch
.object
= it
->object
;
5781 p
->position
= position
? *position
: it
->position
;
5782 p
->current
= it
->current
;
5783 p
->end_charpos
= it
->end_charpos
;
5784 p
->string_nchars
= it
->string_nchars
;
5786 p
->multibyte_p
= it
->multibyte_p
;
5787 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5788 p
->space_width
= it
->space_width
;
5789 p
->font_height
= it
->font_height
;
5790 p
->voffset
= it
->voffset
;
5791 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5792 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5793 p
->display_ellipsis_p
= 0;
5794 p
->line_wrap
= it
->line_wrap
;
5795 p
->bidi_p
= it
->bidi_p
;
5796 p
->paragraph_embedding
= it
->paragraph_embedding
;
5797 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5800 /* Save the state of the bidi iterator as well. */
5802 bidi_push_it (&it
->bidi_it
);
5806 iterate_out_of_display_property (struct it
*it
)
5808 int buffer_p
= !STRINGP (it
->string
);
5809 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5810 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5812 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5814 /* Maybe initialize paragraph direction. If we are at the beginning
5815 of a new paragraph, next_element_from_buffer may not have a
5816 chance to do that. */
5817 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5818 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5819 /* prev_stop can be zero, so check against BEGV as well. */
5820 while (it
->bidi_it
.charpos
>= bob
5821 && it
->prev_stop
<= it
->bidi_it
.charpos
5822 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5823 && it
->bidi_it
.charpos
< eob
)
5824 bidi_move_to_visually_next (&it
->bidi_it
);
5825 /* Record the stop_pos we just crossed, for when we cross it
5827 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5828 it
->prev_stop
= CHARPOS (it
->position
);
5829 /* If we ended up not where pop_it put us, resync IT's
5830 positional members with the bidi iterator. */
5831 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5832 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5834 it
->current
.pos
= it
->position
;
5836 it
->current
.string_pos
= it
->position
;
5839 /* Restore IT's settings from IT->stack. Called, for example, when no
5840 more overlay strings must be processed, and we return to delivering
5841 display elements from a buffer, or when the end of a string from a
5842 `display' property is reached and we return to delivering display
5843 elements from an overlay string, or from a buffer. */
5846 pop_it (struct it
*it
)
5848 struct iterator_stack_entry
*p
;
5849 int from_display_prop
= it
->from_disp_prop_p
;
5851 eassert (it
->sp
> 0);
5853 p
= it
->stack
+ it
->sp
;
5854 it
->stop_charpos
= p
->stop_charpos
;
5855 it
->prev_stop
= p
->prev_stop
;
5856 it
->base_level_stop
= p
->base_level_stop
;
5857 it
->cmp_it
= p
->cmp_it
;
5858 it
->face_id
= p
->face_id
;
5859 it
->current
= p
->current
;
5860 it
->position
= p
->position
;
5861 it
->string
= p
->string
;
5862 it
->from_overlay
= p
->from_overlay
;
5863 if (NILP (it
->string
))
5864 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5865 it
->method
= p
->method
;
5868 case GET_FROM_IMAGE
:
5869 it
->image_id
= p
->u
.image
.image_id
;
5870 it
->object
= p
->u
.image
.object
;
5871 it
->slice
= p
->u
.image
.slice
;
5873 case GET_FROM_STRETCH
:
5874 it
->object
= p
->u
.stretch
.object
;
5876 case GET_FROM_BUFFER
:
5877 it
->object
= it
->w
->buffer
;
5879 case GET_FROM_STRING
:
5880 it
->object
= it
->string
;
5882 case GET_FROM_DISPLAY_VECTOR
:
5884 it
->method
= GET_FROM_C_STRING
;
5885 else if (STRINGP (it
->string
))
5886 it
->method
= GET_FROM_STRING
;
5889 it
->method
= GET_FROM_BUFFER
;
5890 it
->object
= it
->w
->buffer
;
5893 it
->end_charpos
= p
->end_charpos
;
5894 it
->string_nchars
= p
->string_nchars
;
5896 it
->multibyte_p
= p
->multibyte_p
;
5897 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5898 it
->space_width
= p
->space_width
;
5899 it
->font_height
= p
->font_height
;
5900 it
->voffset
= p
->voffset
;
5901 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5902 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5903 it
->line_wrap
= p
->line_wrap
;
5904 it
->bidi_p
= p
->bidi_p
;
5905 it
->paragraph_embedding
= p
->paragraph_embedding
;
5906 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5909 bidi_pop_it (&it
->bidi_it
);
5910 /* Bidi-iterate until we get out of the portion of text, if any,
5911 covered by a `display' text property or by an overlay with
5912 `display' property. (We cannot just jump there, because the
5913 internal coherency of the bidi iterator state can not be
5914 preserved across such jumps.) We also must determine the
5915 paragraph base direction if the overlay we just processed is
5916 at the beginning of a new paragraph. */
5917 if (from_display_prop
5918 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5919 iterate_out_of_display_property (it
);
5921 eassert ((BUFFERP (it
->object
)
5922 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5923 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5924 || (STRINGP (it
->object
)
5925 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5926 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5927 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5933 /***********************************************************************
5935 ***********************************************************************/
5937 /* Set IT's current position to the previous line start. */
5940 back_to_previous_line_start (struct it
*it
)
5942 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5943 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5947 /* Move IT to the next line start.
5949 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5950 we skipped over part of the text (as opposed to moving the iterator
5951 continuously over the text). Otherwise, don't change the value
5954 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5955 iterator on the newline, if it was found.
5957 Newlines may come from buffer text, overlay strings, or strings
5958 displayed via the `display' property. That's the reason we can't
5959 simply use find_next_newline_no_quit.
5961 Note that this function may not skip over invisible text that is so
5962 because of text properties and immediately follows a newline. If
5963 it would, function reseat_at_next_visible_line_start, when called
5964 from set_iterator_to_next, would effectively make invisible
5965 characters following a newline part of the wrong glyph row, which
5966 leads to wrong cursor motion. */
5969 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5970 struct bidi_it
*bidi_it_prev
)
5972 ptrdiff_t old_selective
;
5973 int newline_found_p
, n
;
5974 const int MAX_NEWLINE_DISTANCE
= 500;
5976 /* If already on a newline, just consume it to avoid unintended
5977 skipping over invisible text below. */
5978 if (it
->what
== IT_CHARACTER
5980 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5982 if (it
->bidi_p
&& bidi_it_prev
)
5983 *bidi_it_prev
= it
->bidi_it
;
5984 set_iterator_to_next (it
, 0);
5989 /* Don't handle selective display in the following. It's (a)
5990 unnecessary because it's done by the caller, and (b) leads to an
5991 infinite recursion because next_element_from_ellipsis indirectly
5992 calls this function. */
5993 old_selective
= it
->selective
;
5996 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5997 from buffer text. */
5998 for (n
= newline_found_p
= 0;
5999 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6000 n
+= STRINGP (it
->string
) ? 0 : 1)
6002 if (!get_next_display_element (it
))
6004 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6005 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6006 *bidi_it_prev
= it
->bidi_it
;
6007 set_iterator_to_next (it
, 0);
6010 /* If we didn't find a newline near enough, see if we can use a
6012 if (!newline_found_p
)
6014 ptrdiff_t start
= IT_CHARPOS (*it
);
6015 ptrdiff_t limit
= find_next_newline_no_quit (start
, 1);
6018 eassert (!STRINGP (it
->string
));
6020 /* If there isn't any `display' property in sight, and no
6021 overlays, we can just use the position of the newline in
6023 if (it
->stop_charpos
>= limit
6024 || ((pos
= Fnext_single_property_change (make_number (start
),
6026 make_number (limit
)),
6028 && next_overlay_change (start
) == ZV
))
6032 IT_CHARPOS (*it
) = limit
;
6033 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
6037 struct bidi_it bprev
;
6039 /* Help bidi.c avoid expensive searches for display
6040 properties and overlays, by telling it that there are
6041 none up to `limit'. */
6042 if (it
->bidi_it
.disp_pos
< limit
)
6044 it
->bidi_it
.disp_pos
= limit
;
6045 it
->bidi_it
.disp_prop
= 0;
6048 bprev
= it
->bidi_it
;
6049 bidi_move_to_visually_next (&it
->bidi_it
);
6050 } while (it
->bidi_it
.charpos
!= limit
);
6051 IT_CHARPOS (*it
) = limit
;
6052 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6054 *bidi_it_prev
= bprev
;
6056 *skipped_p
= newline_found_p
= 1;
6060 while (get_next_display_element (it
)
6061 && !newline_found_p
)
6063 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6064 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6065 *bidi_it_prev
= it
->bidi_it
;
6066 set_iterator_to_next (it
, 0);
6071 it
->selective
= old_selective
;
6072 return newline_found_p
;
6076 /* Set IT's current position to the previous visible line start. Skip
6077 invisible text that is so either due to text properties or due to
6078 selective display. Caution: this does not change IT->current_x and
6082 back_to_previous_visible_line_start (struct it
*it
)
6084 while (IT_CHARPOS (*it
) > BEGV
)
6086 back_to_previous_line_start (it
);
6088 if (IT_CHARPOS (*it
) <= BEGV
)
6091 /* If selective > 0, then lines indented more than its value are
6093 if (it
->selective
> 0
6094 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6098 /* Check the newline before point for invisibility. */
6101 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6102 Qinvisible
, it
->window
);
6103 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6107 if (IT_CHARPOS (*it
) <= BEGV
)
6112 void *it2data
= NULL
;
6115 Lisp_Object val
, overlay
;
6117 SAVE_IT (it2
, *it
, it2data
);
6119 /* If newline is part of a composition, continue from start of composition */
6120 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6121 && beg
< IT_CHARPOS (*it
))
6124 /* If newline is replaced by a display property, find start of overlay
6125 or interval and continue search from that point. */
6126 pos
= --IT_CHARPOS (it2
);
6129 bidi_unshelve_cache (NULL
, 0);
6130 it2
.string_from_display_prop_p
= 0;
6131 it2
.from_disp_prop_p
= 0;
6132 if (handle_display_prop (&it2
) == HANDLED_RETURN
6133 && !NILP (val
= get_char_property_and_overlay
6134 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6135 && (OVERLAYP (overlay
)
6136 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6137 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6139 RESTORE_IT (it
, it
, it2data
);
6143 /* Newline is not replaced by anything -- so we are done. */
6144 RESTORE_IT (it
, it
, it2data
);
6150 IT_CHARPOS (*it
) = beg
;
6151 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6155 it
->continuation_lines_width
= 0;
6157 eassert (IT_CHARPOS (*it
) >= BEGV
);
6158 eassert (IT_CHARPOS (*it
) == BEGV
6159 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6164 /* Reseat iterator IT at the previous visible line start. Skip
6165 invisible text that is so either due to text properties or due to
6166 selective display. At the end, update IT's overlay information,
6167 face information etc. */
6170 reseat_at_previous_visible_line_start (struct it
*it
)
6172 back_to_previous_visible_line_start (it
);
6173 reseat (it
, it
->current
.pos
, 1);
6178 /* Reseat iterator IT on the next visible line start in the current
6179 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6180 preceding the line start. Skip over invisible text that is so
6181 because of selective display. Compute faces, overlays etc at the
6182 new position. Note that this function does not skip over text that
6183 is invisible because of text properties. */
6186 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6188 int newline_found_p
, skipped_p
= 0;
6189 struct bidi_it bidi_it_prev
;
6191 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6193 /* Skip over lines that are invisible because they are indented
6194 more than the value of IT->selective. */
6195 if (it
->selective
> 0)
6196 while (IT_CHARPOS (*it
) < ZV
6197 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6200 eassert (IT_BYTEPOS (*it
) == BEGV
6201 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6203 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6206 /* Position on the newline if that's what's requested. */
6207 if (on_newline_p
&& newline_found_p
)
6209 if (STRINGP (it
->string
))
6211 if (IT_STRING_CHARPOS (*it
) > 0)
6215 --IT_STRING_CHARPOS (*it
);
6216 --IT_STRING_BYTEPOS (*it
);
6220 /* We need to restore the bidi iterator to the state
6221 it had on the newline, and resync the IT's
6222 position with that. */
6223 it
->bidi_it
= bidi_it_prev
;
6224 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6225 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6229 else if (IT_CHARPOS (*it
) > BEGV
)
6238 /* We need to restore the bidi iterator to the state it
6239 had on the newline and resync IT with that. */
6240 it
->bidi_it
= bidi_it_prev
;
6241 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6242 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6244 reseat (it
, it
->current
.pos
, 0);
6248 reseat (it
, it
->current
.pos
, 0);
6255 /***********************************************************************
6256 Changing an iterator's position
6257 ***********************************************************************/
6259 /* Change IT's current position to POS in current_buffer. If FORCE_P
6260 is non-zero, always check for text properties at the new position.
6261 Otherwise, text properties are only looked up if POS >=
6262 IT->check_charpos of a property. */
6265 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6267 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6269 reseat_1 (it
, pos
, 0);
6271 /* Determine where to check text properties. Avoid doing it
6272 where possible because text property lookup is very expensive. */
6274 || CHARPOS (pos
) > it
->stop_charpos
6275 || CHARPOS (pos
) < original_pos
)
6279 /* For bidi iteration, we need to prime prev_stop and
6280 base_level_stop with our best estimations. */
6281 /* Implementation note: Of course, POS is not necessarily a
6282 stop position, so assigning prev_pos to it is a lie; we
6283 should have called compute_stop_backwards. However, if
6284 the current buffer does not include any R2L characters,
6285 that call would be a waste of cycles, because the
6286 iterator will never move back, and thus never cross this
6287 "fake" stop position. So we delay that backward search
6288 until the time we really need it, in next_element_from_buffer. */
6289 if (CHARPOS (pos
) != it
->prev_stop
)
6290 it
->prev_stop
= CHARPOS (pos
);
6291 if (CHARPOS (pos
) < it
->base_level_stop
)
6292 it
->base_level_stop
= 0; /* meaning it's unknown */
6298 it
->prev_stop
= it
->base_level_stop
= 0;
6307 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6308 IT->stop_pos to POS, also. */
6311 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6313 /* Don't call this function when scanning a C string. */
6314 eassert (it
->s
== NULL
);
6316 /* POS must be a reasonable value. */
6317 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6319 it
->current
.pos
= it
->position
= pos
;
6320 it
->end_charpos
= ZV
;
6322 it
->current
.dpvec_index
= -1;
6323 it
->current
.overlay_string_index
= -1;
6324 IT_STRING_CHARPOS (*it
) = -1;
6325 IT_STRING_BYTEPOS (*it
) = -1;
6327 it
->method
= GET_FROM_BUFFER
;
6328 it
->object
= it
->w
->buffer
;
6329 it
->area
= TEXT_AREA
;
6330 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6332 it
->string_from_display_prop_p
= 0;
6333 it
->string_from_prefix_prop_p
= 0;
6335 it
->from_disp_prop_p
= 0;
6336 it
->face_before_selective_p
= 0;
6339 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6341 bidi_unshelve_cache (NULL
, 0);
6342 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6343 it
->bidi_it
.string
.s
= NULL
;
6344 it
->bidi_it
.string
.lstring
= Qnil
;
6345 it
->bidi_it
.string
.bufpos
= 0;
6346 it
->bidi_it
.string
.unibyte
= 0;
6351 it
->stop_charpos
= CHARPOS (pos
);
6352 it
->base_level_stop
= CHARPOS (pos
);
6354 /* This make the information stored in it->cmp_it invalidate. */
6359 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6360 If S is non-null, it is a C string to iterate over. Otherwise,
6361 STRING gives a Lisp string to iterate over.
6363 If PRECISION > 0, don't return more then PRECISION number of
6364 characters from the string.
6366 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6367 characters have been returned. FIELD_WIDTH < 0 means an infinite
6370 MULTIBYTE = 0 means disable processing of multibyte characters,
6371 MULTIBYTE > 0 means enable it,
6372 MULTIBYTE < 0 means use IT->multibyte_p.
6374 IT must be initialized via a prior call to init_iterator before
6375 calling this function. */
6378 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6379 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6382 /* No region in strings. */
6383 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6385 /* No text property checks performed by default, but see below. */
6386 it
->stop_charpos
= -1;
6388 /* Set iterator position and end position. */
6389 memset (&it
->current
, 0, sizeof it
->current
);
6390 it
->current
.overlay_string_index
= -1;
6391 it
->current
.dpvec_index
= -1;
6392 eassert (charpos
>= 0);
6394 /* If STRING is specified, use its multibyteness, otherwise use the
6395 setting of MULTIBYTE, if specified. */
6397 it
->multibyte_p
= multibyte
> 0;
6399 /* Bidirectional reordering of strings is controlled by the default
6400 value of bidi-display-reordering. Don't try to reorder while
6401 loading loadup.el, as the necessary character property tables are
6402 not yet available. */
6405 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6409 eassert (STRINGP (string
));
6410 it
->string
= string
;
6412 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6413 it
->method
= GET_FROM_STRING
;
6414 it
->current
.string_pos
= string_pos (charpos
, string
);
6418 it
->bidi_it
.string
.lstring
= string
;
6419 it
->bidi_it
.string
.s
= NULL
;
6420 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6421 it
->bidi_it
.string
.bufpos
= 0;
6422 it
->bidi_it
.string
.from_disp_str
= 0;
6423 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6424 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6425 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6430 it
->s
= (const unsigned char *) s
;
6433 /* Note that we use IT->current.pos, not it->current.string_pos,
6434 for displaying C strings. */
6435 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6436 if (it
->multibyte_p
)
6438 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6439 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6443 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6444 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6449 it
->bidi_it
.string
.lstring
= Qnil
;
6450 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6451 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6452 it
->bidi_it
.string
.bufpos
= 0;
6453 it
->bidi_it
.string
.from_disp_str
= 0;
6454 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6455 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6458 it
->method
= GET_FROM_C_STRING
;
6461 /* PRECISION > 0 means don't return more than PRECISION characters
6463 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6465 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6467 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6470 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6471 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6472 FIELD_WIDTH < 0 means infinite field width. This is useful for
6473 padding with `-' at the end of a mode line. */
6474 if (field_width
< 0)
6475 field_width
= INFINITY
;
6476 /* Implementation note: We deliberately don't enlarge
6477 it->bidi_it.string.schars here to fit it->end_charpos, because
6478 the bidi iterator cannot produce characters out of thin air. */
6479 if (field_width
> it
->end_charpos
- charpos
)
6480 it
->end_charpos
= charpos
+ field_width
;
6482 /* Use the standard display table for displaying strings. */
6483 if (DISP_TABLE_P (Vstandard_display_table
))
6484 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6486 it
->stop_charpos
= charpos
;
6487 it
->prev_stop
= charpos
;
6488 it
->base_level_stop
= 0;
6491 it
->bidi_it
.first_elt
= 1;
6492 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6493 it
->bidi_it
.disp_pos
= -1;
6495 if (s
== NULL
&& it
->multibyte_p
)
6497 ptrdiff_t endpos
= SCHARS (it
->string
);
6498 if (endpos
> it
->end_charpos
)
6499 endpos
= it
->end_charpos
;
6500 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6508 /***********************************************************************
6510 ***********************************************************************/
6512 /* Map enum it_method value to corresponding next_element_from_* function. */
6514 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6516 next_element_from_buffer
,
6517 next_element_from_display_vector
,
6518 next_element_from_string
,
6519 next_element_from_c_string
,
6520 next_element_from_image
,
6521 next_element_from_stretch
6524 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6527 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6528 (possibly with the following characters). */
6530 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6531 ((IT)->cmp_it.id >= 0 \
6532 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6533 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6534 END_CHARPOS, (IT)->w, \
6535 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6539 /* Lookup the char-table Vglyphless_char_display for character C (-1
6540 if we want information for no-font case), and return the display
6541 method symbol. By side-effect, update it->what and
6542 it->glyphless_method. This function is called from
6543 get_next_display_element for each character element, and from
6544 x_produce_glyphs when no suitable font was found. */
6547 lookup_glyphless_char_display (int c
, struct it
*it
)
6549 Lisp_Object glyphless_method
= Qnil
;
6551 if (CHAR_TABLE_P (Vglyphless_char_display
)
6552 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6556 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6557 if (CONSP (glyphless_method
))
6558 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6559 ? XCAR (glyphless_method
)
6560 : XCDR (glyphless_method
);
6563 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6567 if (NILP (glyphless_method
))
6570 /* The default is to display the character by a proper font. */
6572 /* The default for the no-font case is to display an empty box. */
6573 glyphless_method
= Qempty_box
;
6575 if (EQ (glyphless_method
, Qzero_width
))
6578 return glyphless_method
;
6579 /* This method can't be used for the no-font case. */
6580 glyphless_method
= Qempty_box
;
6582 if (EQ (glyphless_method
, Qthin_space
))
6583 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6584 else if (EQ (glyphless_method
, Qempty_box
))
6585 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6586 else if (EQ (glyphless_method
, Qhex_code
))
6587 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6588 else if (STRINGP (glyphless_method
))
6589 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6592 /* Invalid value. We use the default method. */
6593 glyphless_method
= Qnil
;
6596 it
->what
= IT_GLYPHLESS
;
6597 return glyphless_method
;
6600 /* Load IT's display element fields with information about the next
6601 display element from the current position of IT. Value is zero if
6602 end of buffer (or C string) is reached. */
6604 static struct frame
*last_escape_glyph_frame
= NULL
;
6605 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6606 static int last_escape_glyph_merged_face_id
= 0;
6608 struct frame
*last_glyphless_glyph_frame
= NULL
;
6609 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6610 int last_glyphless_glyph_merged_face_id
= 0;
6613 get_next_display_element (struct it
*it
)
6615 /* Non-zero means that we found a display element. Zero means that
6616 we hit the end of what we iterate over. Performance note: the
6617 function pointer `method' used here turns out to be faster than
6618 using a sequence of if-statements. */
6622 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6624 if (it
->what
== IT_CHARACTER
)
6626 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6627 and only if (a) the resolved directionality of that character
6629 /* FIXME: Do we need an exception for characters from display
6631 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6632 it
->c
= bidi_mirror_char (it
->c
);
6633 /* Map via display table or translate control characters.
6634 IT->c, IT->len etc. have been set to the next character by
6635 the function call above. If we have a display table, and it
6636 contains an entry for IT->c, translate it. Don't do this if
6637 IT->c itself comes from a display table, otherwise we could
6638 end up in an infinite recursion. (An alternative could be to
6639 count the recursion depth of this function and signal an
6640 error when a certain maximum depth is reached.) Is it worth
6642 if (success_p
&& it
->dpvec
== NULL
)
6645 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6646 int nonascii_space_p
= 0;
6647 int nonascii_hyphen_p
= 0;
6648 int c
= it
->c
; /* This is the character to display. */
6650 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6652 eassert (SINGLE_BYTE_CHAR_P (c
));
6653 if (unibyte_display_via_language_environment
)
6655 c
= DECODE_CHAR (unibyte
, c
);
6657 c
= BYTE8_TO_CHAR (it
->c
);
6660 c
= BYTE8_TO_CHAR (it
->c
);
6664 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6667 struct Lisp_Vector
*v
= XVECTOR (dv
);
6669 /* Return the first character from the display table
6670 entry, if not empty. If empty, don't display the
6671 current character. */
6674 it
->dpvec_char_len
= it
->len
;
6675 it
->dpvec
= v
->contents
;
6676 it
->dpend
= v
->contents
+ v
->header
.size
;
6677 it
->current
.dpvec_index
= 0;
6678 it
->dpvec_face_id
= -1;
6679 it
->saved_face_id
= it
->face_id
;
6680 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6685 set_iterator_to_next (it
, 0);
6690 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6692 if (it
->what
== IT_GLYPHLESS
)
6694 /* Don't display this character. */
6695 set_iterator_to_next (it
, 0);
6699 /* If `nobreak-char-display' is non-nil, we display
6700 non-ASCII spaces and hyphens specially. */
6701 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6704 nonascii_space_p
= 1;
6705 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6706 nonascii_hyphen_p
= 1;
6709 /* Translate control characters into `\003' or `^C' form.
6710 Control characters coming from a display table entry are
6711 currently not translated because we use IT->dpvec to hold
6712 the translation. This could easily be changed but I
6713 don't believe that it is worth doing.
6715 The characters handled by `nobreak-char-display' must be
6718 Non-printable characters and raw-byte characters are also
6719 translated to octal form. */
6720 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6721 ? (it
->area
!= TEXT_AREA
6722 /* In mode line, treat \n, \t like other crl chars. */
6725 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6726 || (c
!= '\n' && c
!= '\t'))
6728 || nonascii_hyphen_p
6730 || ! CHAR_PRINTABLE_P (c
))))
6732 /* C is a control character, non-ASCII space/hyphen,
6733 raw-byte, or a non-printable character which must be
6734 displayed either as '\003' or as `^C' where the '\\'
6735 and '^' can be defined in the display table. Fill
6736 IT->ctl_chars with glyphs for what we have to
6737 display. Then, set IT->dpvec to these glyphs. */
6744 /* Handle control characters with ^. */
6746 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6750 g
= '^'; /* default glyph for Control */
6751 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6753 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6755 g
= GLYPH_CODE_CHAR (gc
);
6756 lface_id
= GLYPH_CODE_FACE (gc
);
6760 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6762 else if (it
->f
== last_escape_glyph_frame
6763 && it
->face_id
== last_escape_glyph_face_id
)
6765 face_id
= last_escape_glyph_merged_face_id
;
6769 /* Merge the escape-glyph face into the current face. */
6770 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6772 last_escape_glyph_frame
= it
->f
;
6773 last_escape_glyph_face_id
= it
->face_id
;
6774 last_escape_glyph_merged_face_id
= face_id
;
6777 XSETINT (it
->ctl_chars
[0], g
);
6778 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6780 goto display_control
;
6783 /* Handle non-ascii space in the mode where it only gets
6786 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6788 /* Merge `nobreak-space' into the current face. */
6789 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6791 XSETINT (it
->ctl_chars
[0], ' ');
6793 goto display_control
;
6796 /* Handle sequences that start with the "escape glyph". */
6798 /* the default escape glyph is \. */
6799 escape_glyph
= '\\';
6802 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6804 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6805 lface_id
= GLYPH_CODE_FACE (gc
);
6809 /* The display table specified a face.
6810 Merge it into face_id and also into escape_glyph. */
6811 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6814 else if (it
->f
== last_escape_glyph_frame
6815 && it
->face_id
== last_escape_glyph_face_id
)
6817 face_id
= last_escape_glyph_merged_face_id
;
6821 /* Merge the escape-glyph face into the current face. */
6822 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6824 last_escape_glyph_frame
= it
->f
;
6825 last_escape_glyph_face_id
= it
->face_id
;
6826 last_escape_glyph_merged_face_id
= face_id
;
6829 /* Draw non-ASCII hyphen with just highlighting: */
6831 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6833 XSETINT (it
->ctl_chars
[0], '-');
6835 goto display_control
;
6838 /* Draw non-ASCII space/hyphen with escape glyph: */
6840 if (nonascii_space_p
|| nonascii_hyphen_p
)
6842 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6843 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6845 goto display_control
;
6852 if (CHAR_BYTE8_P (c
))
6853 /* Display \200 instead of \17777600. */
6854 c
= CHAR_TO_BYTE8 (c
);
6855 len
= sprintf (str
, "%03o", c
);
6857 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6858 for (i
= 0; i
< len
; i
++)
6859 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6864 /* Set up IT->dpvec and return first character from it. */
6865 it
->dpvec_char_len
= it
->len
;
6866 it
->dpvec
= it
->ctl_chars
;
6867 it
->dpend
= it
->dpvec
+ ctl_len
;
6868 it
->current
.dpvec_index
= 0;
6869 it
->dpvec_face_id
= face_id
;
6870 it
->saved_face_id
= it
->face_id
;
6871 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6875 it
->char_to_display
= c
;
6879 it
->char_to_display
= it
->c
;
6883 /* Adjust face id for a multibyte character. There are no multibyte
6884 character in unibyte text. */
6885 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6888 && FRAME_WINDOW_P (it
->f
))
6890 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6892 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6894 /* Automatic composition with glyph-string. */
6895 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6897 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6901 ptrdiff_t pos
= (it
->s
? -1
6902 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6903 : IT_CHARPOS (*it
));
6906 if (it
->what
== IT_CHARACTER
)
6907 c
= it
->char_to_display
;
6910 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6914 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6915 /* TAB in a composition means display glyphs with
6916 padding space on the left or right. */
6917 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6920 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6925 /* Is this character the last one of a run of characters with
6926 box? If yes, set IT->end_of_box_run_p to 1. */
6930 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6932 int face_id
= underlying_face_id (it
);
6933 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6937 if (face
->box
== FACE_NO_BOX
)
6939 /* If the box comes from face properties in a
6940 display string, check faces in that string. */
6941 int string_face_id
= face_after_it_pos (it
);
6942 it
->end_of_box_run_p
6943 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6946 /* Otherwise, the box comes from the underlying face.
6947 If this is the last string character displayed, check
6948 the next buffer location. */
6949 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6950 && (it
->current
.overlay_string_index
6951 == it
->n_overlay_strings
- 1))
6955 struct text_pos pos
= it
->current
.pos
;
6956 INC_TEXT_POS (pos
, it
->multibyte_p
);
6958 next_face_id
= face_at_buffer_position
6959 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6960 it
->region_end_charpos
, &ignore
,
6961 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6963 it
->end_of_box_run_p
6964 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6971 int face_id
= face_after_it_pos (it
);
6972 it
->end_of_box_run_p
6973 = (face_id
!= it
->face_id
6974 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6977 /* If we reached the end of the object we've been iterating (e.g., a
6978 display string or an overlay string), and there's something on
6979 IT->stack, proceed with what's on the stack. It doesn't make
6980 sense to return zero if there's unprocessed stuff on the stack,
6981 because otherwise that stuff will never be displayed. */
6982 if (!success_p
&& it
->sp
> 0)
6984 set_iterator_to_next (it
, 0);
6985 success_p
= get_next_display_element (it
);
6988 /* Value is 0 if end of buffer or string reached. */
6993 /* Move IT to the next display element.
6995 RESEAT_P non-zero means if called on a newline in buffer text,
6996 skip to the next visible line start.
6998 Functions get_next_display_element and set_iterator_to_next are
6999 separate because I find this arrangement easier to handle than a
7000 get_next_display_element function that also increments IT's
7001 position. The way it is we can first look at an iterator's current
7002 display element, decide whether it fits on a line, and if it does,
7003 increment the iterator position. The other way around we probably
7004 would either need a flag indicating whether the iterator has to be
7005 incremented the next time, or we would have to implement a
7006 decrement position function which would not be easy to write. */
7009 set_iterator_to_next (struct it
*it
, int reseat_p
)
7011 /* Reset flags indicating start and end of a sequence of characters
7012 with box. Reset them at the start of this function because
7013 moving the iterator to a new position might set them. */
7014 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7018 case GET_FROM_BUFFER
:
7019 /* The current display element of IT is a character from
7020 current_buffer. Advance in the buffer, and maybe skip over
7021 invisible lines that are so because of selective display. */
7022 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7023 reseat_at_next_visible_line_start (it
, 0);
7024 else if (it
->cmp_it
.id
>= 0)
7026 /* We are currently getting glyphs from a composition. */
7031 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7032 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7033 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7035 it
->cmp_it
.from
= it
->cmp_it
.to
;
7040 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7042 it
->end_charpos
, Qnil
);
7045 else if (! it
->cmp_it
.reversed_p
)
7047 /* Composition created while scanning forward. */
7048 /* Update IT's char/byte positions to point to the first
7049 character of the next grapheme cluster, or to the
7050 character visually after the current composition. */
7051 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7052 bidi_move_to_visually_next (&it
->bidi_it
);
7053 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7054 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7056 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7058 /* Proceed to the next grapheme cluster. */
7059 it
->cmp_it
.from
= it
->cmp_it
.to
;
7063 /* No more grapheme clusters in this composition.
7064 Find the next stop position. */
7065 ptrdiff_t stop
= it
->end_charpos
;
7066 if (it
->bidi_it
.scan_dir
< 0)
7067 /* Now we are scanning backward and don't know
7070 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7071 IT_BYTEPOS (*it
), stop
, Qnil
);
7076 /* Composition created while scanning backward. */
7077 /* Update IT's char/byte positions to point to the last
7078 character of the previous grapheme cluster, or the
7079 character visually after the current composition. */
7080 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7081 bidi_move_to_visually_next (&it
->bidi_it
);
7082 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7083 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7084 if (it
->cmp_it
.from
> 0)
7086 /* Proceed to the previous grapheme cluster. */
7087 it
->cmp_it
.to
= it
->cmp_it
.from
;
7091 /* No more grapheme clusters in this composition.
7092 Find the next stop position. */
7093 ptrdiff_t stop
= it
->end_charpos
;
7094 if (it
->bidi_it
.scan_dir
< 0)
7095 /* Now we are scanning backward and don't know
7098 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7099 IT_BYTEPOS (*it
), stop
, Qnil
);
7105 eassert (it
->len
!= 0);
7109 IT_BYTEPOS (*it
) += it
->len
;
7110 IT_CHARPOS (*it
) += 1;
7114 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7115 /* If this is a new paragraph, determine its base
7116 direction (a.k.a. its base embedding level). */
7117 if (it
->bidi_it
.new_paragraph
)
7118 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7119 bidi_move_to_visually_next (&it
->bidi_it
);
7120 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7121 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7122 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7124 /* As the scan direction was changed, we must
7125 re-compute the stop position for composition. */
7126 ptrdiff_t stop
= it
->end_charpos
;
7127 if (it
->bidi_it
.scan_dir
< 0)
7129 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7130 IT_BYTEPOS (*it
), stop
, Qnil
);
7133 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7137 case GET_FROM_C_STRING
:
7138 /* Current display element of IT is from a C string. */
7140 /* If the string position is beyond string's end, it means
7141 next_element_from_c_string is padding the string with
7142 blanks, in which case we bypass the bidi iterator,
7143 because it cannot deal with such virtual characters. */
7144 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7146 IT_BYTEPOS (*it
) += it
->len
;
7147 IT_CHARPOS (*it
) += 1;
7151 bidi_move_to_visually_next (&it
->bidi_it
);
7152 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7153 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7157 case GET_FROM_DISPLAY_VECTOR
:
7158 /* Current display element of IT is from a display table entry.
7159 Advance in the display table definition. Reset it to null if
7160 end reached, and continue with characters from buffers/
7162 ++it
->current
.dpvec_index
;
7164 /* Restore face of the iterator to what they were before the
7165 display vector entry (these entries may contain faces). */
7166 it
->face_id
= it
->saved_face_id
;
7168 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7170 int recheck_faces
= it
->ellipsis_p
;
7173 it
->method
= GET_FROM_C_STRING
;
7174 else if (STRINGP (it
->string
))
7175 it
->method
= GET_FROM_STRING
;
7178 it
->method
= GET_FROM_BUFFER
;
7179 it
->object
= it
->w
->buffer
;
7183 it
->current
.dpvec_index
= -1;
7185 /* Skip over characters which were displayed via IT->dpvec. */
7186 if (it
->dpvec_char_len
< 0)
7187 reseat_at_next_visible_line_start (it
, 1);
7188 else if (it
->dpvec_char_len
> 0)
7190 if (it
->method
== GET_FROM_STRING
7191 && it
->n_overlay_strings
> 0)
7192 it
->ignore_overlay_strings_at_pos_p
= 1;
7193 it
->len
= it
->dpvec_char_len
;
7194 set_iterator_to_next (it
, reseat_p
);
7197 /* Maybe recheck faces after display vector */
7199 it
->stop_charpos
= IT_CHARPOS (*it
);
7203 case GET_FROM_STRING
:
7204 /* Current display element is a character from a Lisp string. */
7205 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7206 /* Don't advance past string end. These conditions are true
7207 when set_iterator_to_next is called at the end of
7208 get_next_display_element, in which case the Lisp string is
7209 already exhausted, and all we want is pop the iterator
7211 if (it
->current
.overlay_string_index
>= 0)
7213 /* This is an overlay string, so there's no padding with
7214 spaces, and the number of characters in the string is
7215 where the string ends. */
7216 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7217 goto consider_string_end
;
7221 /* Not an overlay string. There could be padding, so test
7222 against it->end_charpos . */
7223 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7224 goto consider_string_end
;
7226 if (it
->cmp_it
.id
>= 0)
7232 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7233 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7234 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7235 it
->cmp_it
.from
= it
->cmp_it
.to
;
7239 composition_compute_stop_pos (&it
->cmp_it
,
7240 IT_STRING_CHARPOS (*it
),
7241 IT_STRING_BYTEPOS (*it
),
7242 it
->end_charpos
, it
->string
);
7245 else if (! it
->cmp_it
.reversed_p
)
7247 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7248 bidi_move_to_visually_next (&it
->bidi_it
);
7249 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7250 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7252 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7253 it
->cmp_it
.from
= it
->cmp_it
.to
;
7256 ptrdiff_t stop
= it
->end_charpos
;
7257 if (it
->bidi_it
.scan_dir
< 0)
7259 composition_compute_stop_pos (&it
->cmp_it
,
7260 IT_STRING_CHARPOS (*it
),
7261 IT_STRING_BYTEPOS (*it
), stop
,
7267 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7268 bidi_move_to_visually_next (&it
->bidi_it
);
7269 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7270 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7271 if (it
->cmp_it
.from
> 0)
7272 it
->cmp_it
.to
= it
->cmp_it
.from
;
7275 ptrdiff_t stop
= it
->end_charpos
;
7276 if (it
->bidi_it
.scan_dir
< 0)
7278 composition_compute_stop_pos (&it
->cmp_it
,
7279 IT_STRING_CHARPOS (*it
),
7280 IT_STRING_BYTEPOS (*it
), stop
,
7288 /* If the string position is beyond string's end, it
7289 means next_element_from_string is padding the string
7290 with blanks, in which case we bypass the bidi
7291 iterator, because it cannot deal with such virtual
7293 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7295 IT_STRING_BYTEPOS (*it
) += it
->len
;
7296 IT_STRING_CHARPOS (*it
) += 1;
7300 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7302 bidi_move_to_visually_next (&it
->bidi_it
);
7303 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7304 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7305 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7307 ptrdiff_t stop
= it
->end_charpos
;
7309 if (it
->bidi_it
.scan_dir
< 0)
7311 composition_compute_stop_pos (&it
->cmp_it
,
7312 IT_STRING_CHARPOS (*it
),
7313 IT_STRING_BYTEPOS (*it
), stop
,
7319 consider_string_end
:
7321 if (it
->current
.overlay_string_index
>= 0)
7323 /* IT->string is an overlay string. Advance to the
7324 next, if there is one. */
7325 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7328 next_overlay_string (it
);
7330 setup_for_ellipsis (it
, 0);
7335 /* IT->string is not an overlay string. If we reached
7336 its end, and there is something on IT->stack, proceed
7337 with what is on the stack. This can be either another
7338 string, this time an overlay string, or a buffer. */
7339 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7343 if (it
->method
== GET_FROM_STRING
)
7344 goto consider_string_end
;
7349 case GET_FROM_IMAGE
:
7350 case GET_FROM_STRETCH
:
7351 /* The position etc with which we have to proceed are on
7352 the stack. The position may be at the end of a string,
7353 if the `display' property takes up the whole string. */
7354 eassert (it
->sp
> 0);
7356 if (it
->method
== GET_FROM_STRING
)
7357 goto consider_string_end
;
7361 /* There are no other methods defined, so this should be a bug. */
7365 eassert (it
->method
!= GET_FROM_STRING
7366 || (STRINGP (it
->string
)
7367 && IT_STRING_CHARPOS (*it
) >= 0));
7370 /* Load IT's display element fields with information about the next
7371 display element which comes from a display table entry or from the
7372 result of translating a control character to one of the forms `^C'
7375 IT->dpvec holds the glyphs to return as characters.
7376 IT->saved_face_id holds the face id before the display vector--it
7377 is restored into IT->face_id in set_iterator_to_next. */
7380 next_element_from_display_vector (struct it
*it
)
7385 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7387 it
->face_id
= it
->saved_face_id
;
7389 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7390 That seemed totally bogus - so I changed it... */
7391 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7393 if (GLYPH_CODE_P (gc
))
7395 it
->c
= GLYPH_CODE_CHAR (gc
);
7396 it
->len
= CHAR_BYTES (it
->c
);
7398 /* The entry may contain a face id to use. Such a face id is
7399 the id of a Lisp face, not a realized face. A face id of
7400 zero means no face is specified. */
7401 if (it
->dpvec_face_id
>= 0)
7402 it
->face_id
= it
->dpvec_face_id
;
7405 int lface_id
= GLYPH_CODE_FACE (gc
);
7407 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7412 /* Display table entry is invalid. Return a space. */
7413 it
->c
= ' ', it
->len
= 1;
7415 /* Don't change position and object of the iterator here. They are
7416 still the values of the character that had this display table
7417 entry or was translated, and that's what we want. */
7418 it
->what
= IT_CHARACTER
;
7422 /* Get the first element of string/buffer in the visual order, after
7423 being reseated to a new position in a string or a buffer. */
7425 get_visually_first_element (struct it
*it
)
7427 int string_p
= STRINGP (it
->string
) || it
->s
;
7428 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7429 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7431 if (STRINGP (it
->string
))
7433 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7434 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7438 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7439 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7442 if (it
->bidi_it
.charpos
== eob
)
7444 /* Nothing to do, but reset the FIRST_ELT flag, like
7445 bidi_paragraph_init does, because we are not going to
7447 it
->bidi_it
.first_elt
= 0;
7449 else if (it
->bidi_it
.charpos
== bob
7451 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7452 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7454 /* If we are at the beginning of a line/string, we can produce
7455 the next element right away. */
7456 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7457 bidi_move_to_visually_next (&it
->bidi_it
);
7461 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7463 /* We need to prime the bidi iterator starting at the line's or
7464 string's beginning, before we will be able to produce the
7467 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7470 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7472 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7474 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7477 /* Now return to buffer/string position where we were asked
7478 to get the next display element, and produce that. */
7479 bidi_move_to_visually_next (&it
->bidi_it
);
7481 while (it
->bidi_it
.bytepos
!= orig_bytepos
7482 && it
->bidi_it
.charpos
< eob
);
7485 /* Adjust IT's position information to where we ended up. */
7486 if (STRINGP (it
->string
))
7488 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7489 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7493 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7494 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7497 if (STRINGP (it
->string
) || !it
->s
)
7499 ptrdiff_t stop
, charpos
, bytepos
;
7501 if (STRINGP (it
->string
))
7504 stop
= SCHARS (it
->string
);
7505 if (stop
> it
->end_charpos
)
7506 stop
= it
->end_charpos
;
7507 charpos
= IT_STRING_CHARPOS (*it
);
7508 bytepos
= IT_STRING_BYTEPOS (*it
);
7512 stop
= it
->end_charpos
;
7513 charpos
= IT_CHARPOS (*it
);
7514 bytepos
= IT_BYTEPOS (*it
);
7516 if (it
->bidi_it
.scan_dir
< 0)
7518 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7523 /* Load IT with the next display element from Lisp string IT->string.
7524 IT->current.string_pos is the current position within the string.
7525 If IT->current.overlay_string_index >= 0, the Lisp string is an
7529 next_element_from_string (struct it
*it
)
7531 struct text_pos position
;
7533 eassert (STRINGP (it
->string
));
7534 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7535 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7536 position
= it
->current
.string_pos
;
7538 /* With bidi reordering, the character to display might not be the
7539 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7540 that we were reseat()ed to a new string, whose paragraph
7541 direction is not known. */
7542 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7544 get_visually_first_element (it
);
7545 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7548 /* Time to check for invisible text? */
7549 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7551 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7554 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7555 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7557 /* With bidi non-linear iteration, we could find
7558 ourselves far beyond the last computed stop_charpos,
7559 with several other stop positions in between that we
7560 missed. Scan them all now, in buffer's logical
7561 order, until we find and handle the last stop_charpos
7562 that precedes our current position. */
7563 handle_stop_backwards (it
, it
->stop_charpos
);
7564 return GET_NEXT_DISPLAY_ELEMENT (it
);
7570 /* Take note of the stop position we just moved
7571 across, for when we will move back across it. */
7572 it
->prev_stop
= it
->stop_charpos
;
7573 /* If we are at base paragraph embedding level, take
7574 note of the last stop position seen at this
7576 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7577 it
->base_level_stop
= it
->stop_charpos
;
7581 /* Since a handler may have changed IT->method, we must
7583 return GET_NEXT_DISPLAY_ELEMENT (it
);
7587 /* If we are before prev_stop, we may have overstepped
7588 on our way backwards a stop_pos, and if so, we need
7589 to handle that stop_pos. */
7590 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7591 /* We can sometimes back up for reasons that have nothing
7592 to do with bidi reordering. E.g., compositions. The
7593 code below is only needed when we are above the base
7594 embedding level, so test for that explicitly. */
7595 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7597 /* If we lost track of base_level_stop, we have no better
7598 place for handle_stop_backwards to start from than string
7599 beginning. This happens, e.g., when we were reseated to
7600 the previous screenful of text by vertical-motion. */
7601 if (it
->base_level_stop
<= 0
7602 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7603 it
->base_level_stop
= 0;
7604 handle_stop_backwards (it
, it
->base_level_stop
);
7605 return GET_NEXT_DISPLAY_ELEMENT (it
);
7609 if (it
->current
.overlay_string_index
>= 0)
7611 /* Get the next character from an overlay string. In overlay
7612 strings, there is no field width or padding with spaces to
7614 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7619 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7620 IT_STRING_BYTEPOS (*it
),
7621 it
->bidi_it
.scan_dir
< 0
7623 : SCHARS (it
->string
))
7624 && next_element_from_composition (it
))
7628 else if (STRING_MULTIBYTE (it
->string
))
7630 const unsigned char *s
= (SDATA (it
->string
)
7631 + IT_STRING_BYTEPOS (*it
));
7632 it
->c
= string_char_and_length (s
, &it
->len
);
7636 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7642 /* Get the next character from a Lisp string that is not an
7643 overlay string. Such strings come from the mode line, for
7644 example. We may have to pad with spaces, or truncate the
7645 string. See also next_element_from_c_string. */
7646 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7651 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7653 /* Pad with spaces. */
7654 it
->c
= ' ', it
->len
= 1;
7655 CHARPOS (position
) = BYTEPOS (position
) = -1;
7657 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7658 IT_STRING_BYTEPOS (*it
),
7659 it
->bidi_it
.scan_dir
< 0
7661 : it
->string_nchars
)
7662 && next_element_from_composition (it
))
7666 else if (STRING_MULTIBYTE (it
->string
))
7668 const unsigned char *s
= (SDATA (it
->string
)
7669 + IT_STRING_BYTEPOS (*it
));
7670 it
->c
= string_char_and_length (s
, &it
->len
);
7674 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7679 /* Record what we have and where it came from. */
7680 it
->what
= IT_CHARACTER
;
7681 it
->object
= it
->string
;
7682 it
->position
= position
;
7687 /* Load IT with next display element from C string IT->s.
7688 IT->string_nchars is the maximum number of characters to return
7689 from the string. IT->end_charpos may be greater than
7690 IT->string_nchars when this function is called, in which case we
7691 may have to return padding spaces. Value is zero if end of string
7692 reached, including padding spaces. */
7695 next_element_from_c_string (struct it
*it
)
7700 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7701 it
->what
= IT_CHARACTER
;
7702 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7705 /* With bidi reordering, the character to display might not be the
7706 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7707 we were reseated to a new string, whose paragraph direction is
7709 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7710 get_visually_first_element (it
);
7712 /* IT's position can be greater than IT->string_nchars in case a
7713 field width or precision has been specified when the iterator was
7715 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7717 /* End of the game. */
7721 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7723 /* Pad with spaces. */
7724 it
->c
= ' ', it
->len
= 1;
7725 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7727 else if (it
->multibyte_p
)
7728 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7730 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7736 /* Set up IT to return characters from an ellipsis, if appropriate.
7737 The definition of the ellipsis glyphs may come from a display table
7738 entry. This function fills IT with the first glyph from the
7739 ellipsis if an ellipsis is to be displayed. */
7742 next_element_from_ellipsis (struct it
*it
)
7744 if (it
->selective_display_ellipsis_p
)
7745 setup_for_ellipsis (it
, it
->len
);
7748 /* The face at the current position may be different from the
7749 face we find after the invisible text. Remember what it
7750 was in IT->saved_face_id, and signal that it's there by
7751 setting face_before_selective_p. */
7752 it
->saved_face_id
= it
->face_id
;
7753 it
->method
= GET_FROM_BUFFER
;
7754 it
->object
= it
->w
->buffer
;
7755 reseat_at_next_visible_line_start (it
, 1);
7756 it
->face_before_selective_p
= 1;
7759 return GET_NEXT_DISPLAY_ELEMENT (it
);
7763 /* Deliver an image display element. The iterator IT is already
7764 filled with image information (done in handle_display_prop). Value
7769 next_element_from_image (struct it
*it
)
7771 it
->what
= IT_IMAGE
;
7772 it
->ignore_overlay_strings_at_pos_p
= 0;
7777 /* Fill iterator IT with next display element from a stretch glyph
7778 property. IT->object is the value of the text property. Value is
7782 next_element_from_stretch (struct it
*it
)
7784 it
->what
= IT_STRETCH
;
7788 /* Scan backwards from IT's current position until we find a stop
7789 position, or until BEGV. This is called when we find ourself
7790 before both the last known prev_stop and base_level_stop while
7791 reordering bidirectional text. */
7794 compute_stop_pos_backwards (struct it
*it
)
7796 const int SCAN_BACK_LIMIT
= 1000;
7797 struct text_pos pos
;
7798 struct display_pos save_current
= it
->current
;
7799 struct text_pos save_position
= it
->position
;
7800 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7801 ptrdiff_t where_we_are
= charpos
;
7802 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7803 ptrdiff_t save_end_pos
= it
->end_charpos
;
7805 eassert (NILP (it
->string
) && !it
->s
);
7806 eassert (it
->bidi_p
);
7810 it
->end_charpos
= min (charpos
+ 1, ZV
);
7811 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7812 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
7813 reseat_1 (it
, pos
, 0);
7814 compute_stop_pos (it
);
7815 /* We must advance forward, right? */
7816 if (it
->stop_charpos
<= charpos
)
7819 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7821 if (it
->stop_charpos
<= where_we_are
)
7822 it
->prev_stop
= it
->stop_charpos
;
7824 it
->prev_stop
= BEGV
;
7826 it
->current
= save_current
;
7827 it
->position
= save_position
;
7828 it
->stop_charpos
= save_stop_pos
;
7829 it
->end_charpos
= save_end_pos
;
7832 /* Scan forward from CHARPOS in the current buffer/string, until we
7833 find a stop position > current IT's position. Then handle the stop
7834 position before that. This is called when we bump into a stop
7835 position while reordering bidirectional text. CHARPOS should be
7836 the last previously processed stop_pos (or BEGV/0, if none were
7837 processed yet) whose position is less that IT's current
7841 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7843 int bufp
= !STRINGP (it
->string
);
7844 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7845 struct display_pos save_current
= it
->current
;
7846 struct text_pos save_position
= it
->position
;
7847 struct text_pos pos1
;
7848 ptrdiff_t next_stop
;
7850 /* Scan in strict logical order. */
7851 eassert (it
->bidi_p
);
7855 it
->prev_stop
= charpos
;
7858 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7859 reseat_1 (it
, pos1
, 0);
7862 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7863 compute_stop_pos (it
);
7864 /* We must advance forward, right? */
7865 if (it
->stop_charpos
<= it
->prev_stop
)
7867 charpos
= it
->stop_charpos
;
7869 while (charpos
<= where_we_are
);
7872 it
->current
= save_current
;
7873 it
->position
= save_position
;
7874 next_stop
= it
->stop_charpos
;
7875 it
->stop_charpos
= it
->prev_stop
;
7877 it
->stop_charpos
= next_stop
;
7880 /* Load IT with the next display element from current_buffer. Value
7881 is zero if end of buffer reached. IT->stop_charpos is the next
7882 position at which to stop and check for text properties or buffer
7886 next_element_from_buffer (struct it
*it
)
7890 eassert (IT_CHARPOS (*it
) >= BEGV
);
7891 eassert (NILP (it
->string
) && !it
->s
);
7892 eassert (!it
->bidi_p
7893 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7894 && it
->bidi_it
.string
.s
== NULL
));
7896 /* With bidi reordering, the character to display might not be the
7897 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7898 we were reseat()ed to a new buffer position, which is potentially
7899 a different paragraph. */
7900 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7902 get_visually_first_element (it
);
7903 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7906 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7908 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7910 int overlay_strings_follow_p
;
7912 /* End of the game, except when overlay strings follow that
7913 haven't been returned yet. */
7914 if (it
->overlay_strings_at_end_processed_p
)
7915 overlay_strings_follow_p
= 0;
7918 it
->overlay_strings_at_end_processed_p
= 1;
7919 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7922 if (overlay_strings_follow_p
)
7923 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7927 it
->position
= it
->current
.pos
;
7931 else if (!(!it
->bidi_p
7932 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7933 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7935 /* With bidi non-linear iteration, we could find ourselves
7936 far beyond the last computed stop_charpos, with several
7937 other stop positions in between that we missed. Scan
7938 them all now, in buffer's logical order, until we find
7939 and handle the last stop_charpos that precedes our
7940 current position. */
7941 handle_stop_backwards (it
, it
->stop_charpos
);
7942 return GET_NEXT_DISPLAY_ELEMENT (it
);
7948 /* Take note of the stop position we just moved across,
7949 for when we will move back across it. */
7950 it
->prev_stop
= it
->stop_charpos
;
7951 /* If we are at base paragraph embedding level, take
7952 note of the last stop position seen at this
7954 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7955 it
->base_level_stop
= it
->stop_charpos
;
7958 return GET_NEXT_DISPLAY_ELEMENT (it
);
7962 /* If we are before prev_stop, we may have overstepped on
7963 our way backwards a stop_pos, and if so, we need to
7964 handle that stop_pos. */
7965 && IT_CHARPOS (*it
) < it
->prev_stop
7966 /* We can sometimes back up for reasons that have nothing
7967 to do with bidi reordering. E.g., compositions. The
7968 code below is only needed when we are above the base
7969 embedding level, so test for that explicitly. */
7970 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7972 if (it
->base_level_stop
<= 0
7973 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7975 /* If we lost track of base_level_stop, we need to find
7976 prev_stop by looking backwards. This happens, e.g., when
7977 we were reseated to the previous screenful of text by
7979 it
->base_level_stop
= BEGV
;
7980 compute_stop_pos_backwards (it
);
7981 handle_stop_backwards (it
, it
->prev_stop
);
7984 handle_stop_backwards (it
, it
->base_level_stop
);
7985 return GET_NEXT_DISPLAY_ELEMENT (it
);
7989 /* No face changes, overlays etc. in sight, so just return a
7990 character from current_buffer. */
7994 /* Maybe run the redisplay end trigger hook. Performance note:
7995 This doesn't seem to cost measurable time. */
7996 if (it
->redisplay_end_trigger_charpos
7998 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7999 run_redisplay_end_trigger_hook (it
);
8001 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8002 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8004 && next_element_from_composition (it
))
8009 /* Get the next character, maybe multibyte. */
8010 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8011 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
8012 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8014 it
->c
= *p
, it
->len
= 1;
8016 /* Record what we have and where it came from. */
8017 it
->what
= IT_CHARACTER
;
8018 it
->object
= it
->w
->buffer
;
8019 it
->position
= it
->current
.pos
;
8021 /* Normally we return the character found above, except when we
8022 really want to return an ellipsis for selective display. */
8027 /* A value of selective > 0 means hide lines indented more
8028 than that number of columns. */
8029 if (it
->selective
> 0
8030 && IT_CHARPOS (*it
) + 1 < ZV
8031 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8032 IT_BYTEPOS (*it
) + 1,
8035 success_p
= next_element_from_ellipsis (it
);
8036 it
->dpvec_char_len
= -1;
8039 else if (it
->c
== '\r' && it
->selective
== -1)
8041 /* A value of selective == -1 means that everything from the
8042 CR to the end of the line is invisible, with maybe an
8043 ellipsis displayed for it. */
8044 success_p
= next_element_from_ellipsis (it
);
8045 it
->dpvec_char_len
= -1;
8050 /* Value is zero if end of buffer reached. */
8051 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8056 /* Run the redisplay end trigger hook for IT. */
8059 run_redisplay_end_trigger_hook (struct it
*it
)
8061 Lisp_Object args
[3];
8063 /* IT->glyph_row should be non-null, i.e. we should be actually
8064 displaying something, or otherwise we should not run the hook. */
8065 eassert (it
->glyph_row
);
8067 /* Set up hook arguments. */
8068 args
[0] = Qredisplay_end_trigger_functions
;
8069 args
[1] = it
->window
;
8070 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8071 it
->redisplay_end_trigger_charpos
= 0;
8073 /* Since we are *trying* to run these functions, don't try to run
8074 them again, even if they get an error. */
8075 wset_redisplay_end_trigger (it
->w
, Qnil
);
8076 Frun_hook_with_args (3, args
);
8078 /* Notice if it changed the face of the character we are on. */
8079 handle_face_prop (it
);
8083 /* Deliver a composition display element. Unlike the other
8084 next_element_from_XXX, this function is not registered in the array
8085 get_next_element[]. It is called from next_element_from_buffer and
8086 next_element_from_string when necessary. */
8089 next_element_from_composition (struct it
*it
)
8091 it
->what
= IT_COMPOSITION
;
8092 it
->len
= it
->cmp_it
.nbytes
;
8093 if (STRINGP (it
->string
))
8097 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8098 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8101 it
->position
= it
->current
.string_pos
;
8102 it
->object
= it
->string
;
8103 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8104 IT_STRING_BYTEPOS (*it
), it
->string
);
8110 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8111 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8114 if (it
->bidi_it
.new_paragraph
)
8115 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8116 /* Resync the bidi iterator with IT's new position.
8117 FIXME: this doesn't support bidirectional text. */
8118 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8119 bidi_move_to_visually_next (&it
->bidi_it
);
8123 it
->position
= it
->current
.pos
;
8124 it
->object
= it
->w
->buffer
;
8125 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8126 IT_BYTEPOS (*it
), Qnil
);
8133 /***********************************************************************
8134 Moving an iterator without producing glyphs
8135 ***********************************************************************/
8137 /* Check if iterator is at a position corresponding to a valid buffer
8138 position after some move_it_ call. */
8140 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8141 ((it)->method == GET_FROM_STRING \
8142 ? IT_STRING_CHARPOS (*it) == 0 \
8146 /* Move iterator IT to a specified buffer or X position within one
8147 line on the display without producing glyphs.
8149 OP should be a bit mask including some or all of these bits:
8150 MOVE_TO_X: Stop upon reaching x-position TO_X.
8151 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8152 Regardless of OP's value, stop upon reaching the end of the display line.
8154 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8155 This means, in particular, that TO_X includes window's horizontal
8158 The return value has several possible values that
8159 say what condition caused the scan to stop:
8161 MOVE_POS_MATCH_OR_ZV
8162 - when TO_POS or ZV was reached.
8165 -when TO_X was reached before TO_POS or ZV were reached.
8168 - when we reached the end of the display area and the line must
8172 - when we reached the end of the display area and the line is
8176 - when we stopped at a line end, i.e. a newline or a CR and selective
8179 static enum move_it_result
8180 move_it_in_display_line_to (struct it
*it
,
8181 ptrdiff_t to_charpos
, int to_x
,
8182 enum move_operation_enum op
)
8184 enum move_it_result result
= MOVE_UNDEFINED
;
8185 struct glyph_row
*saved_glyph_row
;
8186 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8187 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8188 void *ppos_data
= NULL
;
8190 enum it_method prev_method
= it
->method
;
8191 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8192 int saw_smaller_pos
= prev_pos
< to_charpos
;
8194 /* Don't produce glyphs in produce_glyphs. */
8195 saved_glyph_row
= it
->glyph_row
;
8196 it
->glyph_row
= NULL
;
8198 /* Use wrap_it to save a copy of IT wherever a word wrap could
8199 occur. Use atpos_it to save a copy of IT at the desired buffer
8200 position, if found, so that we can scan ahead and check if the
8201 word later overshoots the window edge. Use atx_it similarly, for
8207 /* Use ppos_it under bidi reordering to save a copy of IT for the
8208 position > CHARPOS that is the closest to CHARPOS. We restore
8209 that position in IT when we have scanned the entire display line
8210 without finding a match for CHARPOS and all the character
8211 positions are greater than CHARPOS. */
8214 SAVE_IT (ppos_it
, *it
, ppos_data
);
8215 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8216 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8217 SAVE_IT (ppos_it
, *it
, ppos_data
);
8220 #define BUFFER_POS_REACHED_P() \
8221 ((op & MOVE_TO_POS) != 0 \
8222 && BUFFERP (it->object) \
8223 && (IT_CHARPOS (*it) == to_charpos \
8225 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8226 && IT_CHARPOS (*it) > to_charpos) \
8227 || (it->what == IT_COMPOSITION \
8228 && ((IT_CHARPOS (*it) > to_charpos \
8229 && to_charpos >= it->cmp_it.charpos) \
8230 || (IT_CHARPOS (*it) < to_charpos \
8231 && to_charpos <= it->cmp_it.charpos)))) \
8232 && (it->method == GET_FROM_BUFFER \
8233 || (it->method == GET_FROM_DISPLAY_VECTOR \
8234 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8236 /* If there's a line-/wrap-prefix, handle it. */
8237 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8238 && it
->current_y
< it
->last_visible_y
)
8239 handle_line_prefix (it
);
8241 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8242 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8246 int x
, i
, ascent
= 0, descent
= 0;
8248 /* Utility macro to reset an iterator with x, ascent, and descent. */
8249 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8250 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8251 (IT)->max_descent = descent)
8253 /* Stop if we move beyond TO_CHARPOS (after an image or a
8254 display string or stretch glyph). */
8255 if ((op
& MOVE_TO_POS
) != 0
8256 && BUFFERP (it
->object
)
8257 && it
->method
== GET_FROM_BUFFER
8259 /* When the iterator is at base embedding level, we
8260 are guaranteed that characters are delivered for
8261 display in strictly increasing order of their
8262 buffer positions. */
8263 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8264 && IT_CHARPOS (*it
) > to_charpos
)
8266 && (prev_method
== GET_FROM_IMAGE
8267 || prev_method
== GET_FROM_STRETCH
8268 || prev_method
== GET_FROM_STRING
)
8269 /* Passed TO_CHARPOS from left to right. */
8270 && ((prev_pos
< to_charpos
8271 && IT_CHARPOS (*it
) > to_charpos
)
8272 /* Passed TO_CHARPOS from right to left. */
8273 || (prev_pos
> to_charpos
8274 && IT_CHARPOS (*it
) < to_charpos
)))))
8276 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8278 result
= MOVE_POS_MATCH_OR_ZV
;
8281 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8282 /* If wrap_it is valid, the current position might be in a
8283 word that is wrapped. So, save the iterator in
8284 atpos_it and continue to see if wrapping happens. */
8285 SAVE_IT (atpos_it
, *it
, atpos_data
);
8288 /* Stop when ZV reached.
8289 We used to stop here when TO_CHARPOS reached as well, but that is
8290 too soon if this glyph does not fit on this line. So we handle it
8291 explicitly below. */
8292 if (!get_next_display_element (it
))
8294 result
= MOVE_POS_MATCH_OR_ZV
;
8298 if (it
->line_wrap
== TRUNCATE
)
8300 if (BUFFER_POS_REACHED_P ())
8302 result
= MOVE_POS_MATCH_OR_ZV
;
8308 if (it
->line_wrap
== WORD_WRAP
)
8310 if (IT_DISPLAYING_WHITESPACE (it
))
8314 /* We have reached a glyph that follows one or more
8315 whitespace characters. If the position is
8316 already found, we are done. */
8317 if (atpos_it
.sp
>= 0)
8319 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8320 result
= MOVE_POS_MATCH_OR_ZV
;
8325 RESTORE_IT (it
, &atx_it
, atx_data
);
8326 result
= MOVE_X_REACHED
;
8329 /* Otherwise, we can wrap here. */
8330 SAVE_IT (wrap_it
, *it
, wrap_data
);
8336 /* Remember the line height for the current line, in case
8337 the next element doesn't fit on the line. */
8338 ascent
= it
->max_ascent
;
8339 descent
= it
->max_descent
;
8341 /* The call to produce_glyphs will get the metrics of the
8342 display element IT is loaded with. Record the x-position
8343 before this display element, in case it doesn't fit on the
8347 PRODUCE_GLYPHS (it
);
8349 if (it
->area
!= TEXT_AREA
)
8351 prev_method
= it
->method
;
8352 if (it
->method
== GET_FROM_BUFFER
)
8353 prev_pos
= IT_CHARPOS (*it
);
8354 set_iterator_to_next (it
, 1);
8355 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8356 SET_TEXT_POS (this_line_min_pos
,
8357 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8359 && (op
& MOVE_TO_POS
)
8360 && IT_CHARPOS (*it
) > to_charpos
8361 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8362 SAVE_IT (ppos_it
, *it
, ppos_data
);
8366 /* The number of glyphs we get back in IT->nglyphs will normally
8367 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8368 character on a terminal frame, or (iii) a line end. For the
8369 second case, IT->nglyphs - 1 padding glyphs will be present.
8370 (On X frames, there is only one glyph produced for a
8371 composite character.)
8373 The behavior implemented below means, for continuation lines,
8374 that as many spaces of a TAB as fit on the current line are
8375 displayed there. For terminal frames, as many glyphs of a
8376 multi-glyph character are displayed in the current line, too.
8377 This is what the old redisplay code did, and we keep it that
8378 way. Under X, the whole shape of a complex character must
8379 fit on the line or it will be completely displayed in the
8382 Note that both for tabs and padding glyphs, all glyphs have
8386 /* More than one glyph or glyph doesn't fit on line. All
8387 glyphs have the same width. */
8388 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8390 int x_before_this_char
= x
;
8391 int hpos_before_this_char
= it
->hpos
;
8393 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8395 new_x
= x
+ single_glyph_width
;
8397 /* We want to leave anything reaching TO_X to the caller. */
8398 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8400 if (BUFFER_POS_REACHED_P ())
8402 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8403 goto buffer_pos_reached
;
8404 if (atpos_it
.sp
< 0)
8406 SAVE_IT (atpos_it
, *it
, atpos_data
);
8407 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8412 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8415 result
= MOVE_X_REACHED
;
8420 SAVE_IT (atx_it
, *it
, atx_data
);
8421 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8426 if (/* Lines are continued. */
8427 it
->line_wrap
!= TRUNCATE
8428 && (/* And glyph doesn't fit on the line. */
8429 new_x
> it
->last_visible_x
8430 /* Or it fits exactly and we're on a window
8432 || (new_x
== it
->last_visible_x
8433 && FRAME_WINDOW_P (it
->f
)
8434 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8435 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8436 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8438 if (/* IT->hpos == 0 means the very first glyph
8439 doesn't fit on the line, e.g. a wide image. */
8441 || (new_x
== it
->last_visible_x
8442 && FRAME_WINDOW_P (it
->f
)))
8445 it
->current_x
= new_x
;
8447 /* The character's last glyph just barely fits
8449 if (i
== it
->nglyphs
- 1)
8451 /* If this is the destination position,
8452 return a position *before* it in this row,
8453 now that we know it fits in this row. */
8454 if (BUFFER_POS_REACHED_P ())
8456 if (it
->line_wrap
!= WORD_WRAP
8459 it
->hpos
= hpos_before_this_char
;
8460 it
->current_x
= x_before_this_char
;
8461 result
= MOVE_POS_MATCH_OR_ZV
;
8464 if (it
->line_wrap
== WORD_WRAP
8467 SAVE_IT (atpos_it
, *it
, atpos_data
);
8468 atpos_it
.current_x
= x_before_this_char
;
8469 atpos_it
.hpos
= hpos_before_this_char
;
8473 prev_method
= it
->method
;
8474 if (it
->method
== GET_FROM_BUFFER
)
8475 prev_pos
= IT_CHARPOS (*it
);
8476 set_iterator_to_next (it
, 1);
8477 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8478 SET_TEXT_POS (this_line_min_pos
,
8479 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8480 /* On graphical terminals, newlines may
8481 "overflow" into the fringe if
8482 overflow-newline-into-fringe is non-nil.
8483 On text terminals, and on graphical
8484 terminals with no right margin, newlines
8485 may overflow into the last glyph on the
8487 if (!FRAME_WINDOW_P (it
->f
)
8489 && it
->bidi_it
.paragraph_dir
== R2L
)
8490 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8491 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8492 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8494 if (!get_next_display_element (it
))
8496 result
= MOVE_POS_MATCH_OR_ZV
;
8499 if (BUFFER_POS_REACHED_P ())
8501 if (ITERATOR_AT_END_OF_LINE_P (it
))
8502 result
= MOVE_POS_MATCH_OR_ZV
;
8504 result
= MOVE_LINE_CONTINUED
;
8507 if (ITERATOR_AT_END_OF_LINE_P (it
))
8509 result
= MOVE_NEWLINE_OR_CR
;
8516 IT_RESET_X_ASCENT_DESCENT (it
);
8518 if (wrap_it
.sp
>= 0)
8520 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8525 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8527 result
= MOVE_LINE_CONTINUED
;
8531 if (BUFFER_POS_REACHED_P ())
8533 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8534 goto buffer_pos_reached
;
8535 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8537 SAVE_IT (atpos_it
, *it
, atpos_data
);
8538 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8542 if (new_x
> it
->first_visible_x
)
8544 /* Glyph is visible. Increment number of glyphs that
8545 would be displayed. */
8550 if (result
!= MOVE_UNDEFINED
)
8553 else if (BUFFER_POS_REACHED_P ())
8556 IT_RESET_X_ASCENT_DESCENT (it
);
8557 result
= MOVE_POS_MATCH_OR_ZV
;
8560 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8562 /* Stop when TO_X specified and reached. This check is
8563 necessary here because of lines consisting of a line end,
8564 only. The line end will not produce any glyphs and we
8565 would never get MOVE_X_REACHED. */
8566 eassert (it
->nglyphs
== 0);
8567 result
= MOVE_X_REACHED
;
8571 /* Is this a line end? If yes, we're done. */
8572 if (ITERATOR_AT_END_OF_LINE_P (it
))
8574 /* If we are past TO_CHARPOS, but never saw any character
8575 positions smaller than TO_CHARPOS, return
8576 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8578 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8580 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8582 if (IT_CHARPOS (ppos_it
) < ZV
)
8584 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8585 result
= MOVE_POS_MATCH_OR_ZV
;
8588 goto buffer_pos_reached
;
8590 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8591 && IT_CHARPOS (*it
) > to_charpos
)
8592 goto buffer_pos_reached
;
8594 result
= MOVE_NEWLINE_OR_CR
;
8597 result
= MOVE_NEWLINE_OR_CR
;
8601 prev_method
= it
->method
;
8602 if (it
->method
== GET_FROM_BUFFER
)
8603 prev_pos
= IT_CHARPOS (*it
);
8604 /* The current display element has been consumed. Advance
8606 set_iterator_to_next (it
, 1);
8607 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8608 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8609 if (IT_CHARPOS (*it
) < to_charpos
)
8610 saw_smaller_pos
= 1;
8612 && (op
& MOVE_TO_POS
)
8613 && IT_CHARPOS (*it
) >= to_charpos
8614 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8615 SAVE_IT (ppos_it
, *it
, ppos_data
);
8617 /* Stop if lines are truncated and IT's current x-position is
8618 past the right edge of the window now. */
8619 if (it
->line_wrap
== TRUNCATE
8620 && it
->current_x
>= it
->last_visible_x
)
8622 if (!FRAME_WINDOW_P (it
->f
)
8623 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8624 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8625 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8626 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8630 if ((at_eob_p
= !get_next_display_element (it
))
8631 || BUFFER_POS_REACHED_P ()
8632 /* If we are past TO_CHARPOS, but never saw any
8633 character positions smaller than TO_CHARPOS,
8634 return MOVE_POS_MATCH_OR_ZV, like the
8635 unidirectional display did. */
8636 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8638 && IT_CHARPOS (*it
) > to_charpos
))
8641 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8642 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8643 result
= MOVE_POS_MATCH_OR_ZV
;
8646 if (ITERATOR_AT_END_OF_LINE_P (it
))
8648 result
= MOVE_NEWLINE_OR_CR
;
8652 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8654 && IT_CHARPOS (*it
) > to_charpos
)
8656 if (IT_CHARPOS (ppos_it
) < ZV
)
8657 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8658 result
= MOVE_POS_MATCH_OR_ZV
;
8661 result
= MOVE_LINE_TRUNCATED
;
8664 #undef IT_RESET_X_ASCENT_DESCENT
8667 #undef BUFFER_POS_REACHED_P
8669 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8670 restore the saved iterator. */
8671 if (atpos_it
.sp
>= 0)
8672 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8673 else if (atx_it
.sp
>= 0)
8674 RESTORE_IT (it
, &atx_it
, atx_data
);
8679 bidi_unshelve_cache (atpos_data
, 1);
8681 bidi_unshelve_cache (atx_data
, 1);
8683 bidi_unshelve_cache (wrap_data
, 1);
8685 bidi_unshelve_cache (ppos_data
, 1);
8687 /* Restore the iterator settings altered at the beginning of this
8689 it
->glyph_row
= saved_glyph_row
;
8693 /* For external use. */
8695 move_it_in_display_line (struct it
*it
,
8696 ptrdiff_t to_charpos
, int to_x
,
8697 enum move_operation_enum op
)
8699 if (it
->line_wrap
== WORD_WRAP
8700 && (op
& MOVE_TO_X
))
8703 void *save_data
= NULL
;
8706 SAVE_IT (save_it
, *it
, save_data
);
8707 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8708 /* When word-wrap is on, TO_X may lie past the end
8709 of a wrapped line. Then it->current is the
8710 character on the next line, so backtrack to the
8711 space before the wrap point. */
8712 if (skip
== MOVE_LINE_CONTINUED
)
8714 int prev_x
= max (it
->current_x
- 1, 0);
8715 RESTORE_IT (it
, &save_it
, save_data
);
8716 move_it_in_display_line_to
8717 (it
, -1, prev_x
, MOVE_TO_X
);
8720 bidi_unshelve_cache (save_data
, 1);
8723 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8727 /* Move IT forward until it satisfies one or more of the criteria in
8728 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8730 OP is a bit-mask that specifies where to stop, and in particular,
8731 which of those four position arguments makes a difference. See the
8732 description of enum move_operation_enum.
8734 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8735 screen line, this function will set IT to the next position that is
8736 displayed to the right of TO_CHARPOS on the screen. */
8739 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8741 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8742 int line_height
, line_start_x
= 0, reached
= 0;
8743 void *backup_data
= NULL
;
8747 if (op
& MOVE_TO_VPOS
)
8749 /* If no TO_CHARPOS and no TO_X specified, stop at the
8750 start of the line TO_VPOS. */
8751 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8753 if (it
->vpos
== to_vpos
)
8759 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8763 /* TO_VPOS >= 0 means stop at TO_X in the line at
8764 TO_VPOS, or at TO_POS, whichever comes first. */
8765 if (it
->vpos
== to_vpos
)
8771 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8773 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8778 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8780 /* We have reached TO_X but not in the line we want. */
8781 skip
= move_it_in_display_line_to (it
, to_charpos
,
8783 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8791 else if (op
& MOVE_TO_Y
)
8793 struct it it_backup
;
8795 if (it
->line_wrap
== WORD_WRAP
)
8796 SAVE_IT (it_backup
, *it
, backup_data
);
8798 /* TO_Y specified means stop at TO_X in the line containing
8799 TO_Y---or at TO_CHARPOS if this is reached first. The
8800 problem is that we can't really tell whether the line
8801 contains TO_Y before we have completely scanned it, and
8802 this may skip past TO_X. What we do is to first scan to
8805 If TO_X is not specified, use a TO_X of zero. The reason
8806 is to make the outcome of this function more predictable.
8807 If we didn't use TO_X == 0, we would stop at the end of
8808 the line which is probably not what a caller would expect
8810 skip
= move_it_in_display_line_to
8811 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8812 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8814 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8815 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8817 else if (skip
== MOVE_X_REACHED
)
8819 /* If TO_X was reached, we want to know whether TO_Y is
8820 in the line. We know this is the case if the already
8821 scanned glyphs make the line tall enough. Otherwise,
8822 we must check by scanning the rest of the line. */
8823 line_height
= it
->max_ascent
+ it
->max_descent
;
8824 if (to_y
>= it
->current_y
8825 && to_y
< it
->current_y
+ line_height
)
8830 SAVE_IT (it_backup
, *it
, backup_data
);
8831 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8832 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8834 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8835 line_height
= it
->max_ascent
+ it
->max_descent
;
8836 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8838 if (to_y
>= it
->current_y
8839 && to_y
< it
->current_y
+ line_height
)
8841 /* If TO_Y is in this line and TO_X was reached
8842 above, we scanned too far. We have to restore
8843 IT's settings to the ones before skipping. But
8844 keep the more accurate values of max_ascent and
8845 max_descent we've found while skipping the rest
8846 of the line, for the sake of callers, such as
8847 pos_visible_p, that need to know the line
8849 int max_ascent
= it
->max_ascent
;
8850 int max_descent
= it
->max_descent
;
8852 RESTORE_IT (it
, &it_backup
, backup_data
);
8853 it
->max_ascent
= max_ascent
;
8854 it
->max_descent
= max_descent
;
8860 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8866 /* Check whether TO_Y is in this line. */
8867 line_height
= it
->max_ascent
+ it
->max_descent
;
8868 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8870 if (to_y
>= it
->current_y
8871 && to_y
< it
->current_y
+ line_height
)
8873 /* When word-wrap is on, TO_X may lie past the end
8874 of a wrapped line. Then it->current is the
8875 character on the next line, so backtrack to the
8876 space before the wrap point. */
8877 if (skip
== MOVE_LINE_CONTINUED
8878 && it
->line_wrap
== WORD_WRAP
)
8880 int prev_x
= max (it
->current_x
- 1, 0);
8881 RESTORE_IT (it
, &it_backup
, backup_data
);
8882 skip
= move_it_in_display_line_to
8883 (it
, -1, prev_x
, MOVE_TO_X
);
8892 else if (BUFFERP (it
->object
)
8893 && (it
->method
== GET_FROM_BUFFER
8894 || it
->method
== GET_FROM_STRETCH
)
8895 && IT_CHARPOS (*it
) >= to_charpos
8896 /* Under bidi iteration, a call to set_iterator_to_next
8897 can scan far beyond to_charpos if the initial
8898 portion of the next line needs to be reordered. In
8899 that case, give move_it_in_display_line_to another
8902 && it
->bidi_it
.scan_dir
== -1))
8903 skip
= MOVE_POS_MATCH_OR_ZV
;
8905 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8909 case MOVE_POS_MATCH_OR_ZV
:
8913 case MOVE_NEWLINE_OR_CR
:
8914 set_iterator_to_next (it
, 1);
8915 it
->continuation_lines_width
= 0;
8918 case MOVE_LINE_TRUNCATED
:
8919 it
->continuation_lines_width
= 0;
8920 reseat_at_next_visible_line_start (it
, 0);
8921 if ((op
& MOVE_TO_POS
) != 0
8922 && IT_CHARPOS (*it
) > to_charpos
)
8929 case MOVE_LINE_CONTINUED
:
8930 /* For continued lines ending in a tab, some of the glyphs
8931 associated with the tab are displayed on the current
8932 line. Since it->current_x does not include these glyphs,
8933 we use it->last_visible_x instead. */
8936 it
->continuation_lines_width
+= it
->last_visible_x
;
8937 /* When moving by vpos, ensure that the iterator really
8938 advances to the next line (bug#847, bug#969). Fixme:
8939 do we need to do this in other circumstances? */
8940 if (it
->current_x
!= it
->last_visible_x
8941 && (op
& MOVE_TO_VPOS
)
8942 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8944 line_start_x
= it
->current_x
+ it
->pixel_width
8945 - it
->last_visible_x
;
8946 set_iterator_to_next (it
, 0);
8950 it
->continuation_lines_width
+= it
->current_x
;
8957 /* Reset/increment for the next run. */
8958 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8959 it
->current_x
= line_start_x
;
8962 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8964 last_height
= it
->max_ascent
+ it
->max_descent
;
8965 last_max_ascent
= it
->max_ascent
;
8966 it
->max_ascent
= it
->max_descent
= 0;
8971 /* On text terminals, we may stop at the end of a line in the middle
8972 of a multi-character glyph. If the glyph itself is continued,
8973 i.e. it is actually displayed on the next line, don't treat this
8974 stopping point as valid; move to the next line instead (unless
8975 that brings us offscreen). */
8976 if (!FRAME_WINDOW_P (it
->f
)
8978 && IT_CHARPOS (*it
) == to_charpos
8979 && it
->what
== IT_CHARACTER
8981 && it
->line_wrap
== WINDOW_WRAP
8982 && it
->current_x
== it
->last_visible_x
- 1
8985 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8987 it
->continuation_lines_width
+= it
->current_x
;
8988 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8989 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8991 last_height
= it
->max_ascent
+ it
->max_descent
;
8992 last_max_ascent
= it
->max_ascent
;
8996 bidi_unshelve_cache (backup_data
, 1);
8998 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9002 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9004 If DY > 0, move IT backward at least that many pixels. DY = 0
9005 means move IT backward to the preceding line start or BEGV. This
9006 function may move over more than DY pixels if IT->current_y - DY
9007 ends up in the middle of a line; in this case IT->current_y will be
9008 set to the top of the line moved to. */
9011 move_it_vertically_backward (struct it
*it
, int dy
)
9015 void *it2data
= NULL
, *it3data
= NULL
;
9016 ptrdiff_t start_pos
;
9021 start_pos
= IT_CHARPOS (*it
);
9023 /* Estimate how many newlines we must move back. */
9024 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
9026 /* Set the iterator's position that many lines back. */
9027 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
9028 back_to_previous_visible_line_start (it
);
9030 /* Reseat the iterator here. When moving backward, we don't want
9031 reseat to skip forward over invisible text, set up the iterator
9032 to deliver from overlay strings at the new position etc. So,
9033 use reseat_1 here. */
9034 reseat_1 (it
, it
->current
.pos
, 1);
9036 /* We are now surely at a line start. */
9037 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9038 reordering is in effect. */
9039 it
->continuation_lines_width
= 0;
9041 /* Move forward and see what y-distance we moved. First move to the
9042 start of the next line so that we get its height. We need this
9043 height to be able to tell whether we reached the specified
9045 SAVE_IT (it2
, *it
, it2data
);
9046 it2
.max_ascent
= it2
.max_descent
= 0;
9049 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9050 MOVE_TO_POS
| MOVE_TO_VPOS
);
9052 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9053 /* If we are in a display string which starts at START_POS,
9054 and that display string includes a newline, and we are
9055 right after that newline (i.e. at the beginning of a
9056 display line), exit the loop, because otherwise we will
9057 infloop, since move_it_to will see that it is already at
9058 START_POS and will not move. */
9059 || (it2
.method
== GET_FROM_STRING
9060 && IT_CHARPOS (it2
) == start_pos
9061 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9062 eassert (IT_CHARPOS (*it
) >= BEGV
);
9063 SAVE_IT (it3
, it2
, it3data
);
9065 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9066 eassert (IT_CHARPOS (*it
) >= BEGV
);
9067 /* H is the actual vertical distance from the position in *IT
9068 and the starting position. */
9069 h
= it2
.current_y
- it
->current_y
;
9070 /* NLINES is the distance in number of lines. */
9071 nlines
= it2
.vpos
- it
->vpos
;
9073 /* Correct IT's y and vpos position
9074 so that they are relative to the starting point. */
9080 /* DY == 0 means move to the start of the screen line. The
9081 value of nlines is > 0 if continuation lines were involved,
9082 or if the original IT position was at start of a line. */
9083 RESTORE_IT (it
, it
, it2data
);
9085 move_it_by_lines (it
, nlines
);
9086 /* The above code moves us to some position NLINES down,
9087 usually to its first glyph (leftmost in an L2R line), but
9088 that's not necessarily the start of the line, under bidi
9089 reordering. We want to get to the character position
9090 that is immediately after the newline of the previous
9093 && !it
->continuation_lines_width
9094 && !STRINGP (it
->string
)
9095 && IT_CHARPOS (*it
) > BEGV
9096 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9099 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
9101 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
9103 bidi_unshelve_cache (it3data
, 1);
9107 /* The y-position we try to reach, relative to *IT.
9108 Note that H has been subtracted in front of the if-statement. */
9109 int target_y
= it
->current_y
+ h
- dy
;
9110 int y0
= it3
.current_y
;
9114 RESTORE_IT (&it3
, &it3
, it3data
);
9115 y1
= line_bottom_y (&it3
);
9116 line_height
= y1
- y0
;
9117 RESTORE_IT (it
, it
, it2data
);
9118 /* If we did not reach target_y, try to move further backward if
9119 we can. If we moved too far backward, try to move forward. */
9120 if (target_y
< it
->current_y
9121 /* This is heuristic. In a window that's 3 lines high, with
9122 a line height of 13 pixels each, recentering with point
9123 on the bottom line will try to move -39/2 = 19 pixels
9124 backward. Try to avoid moving into the first line. */
9125 && (it
->current_y
- target_y
9126 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9127 && IT_CHARPOS (*it
) > BEGV
)
9129 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9130 target_y
- it
->current_y
));
9131 dy
= it
->current_y
- target_y
;
9132 goto move_further_back
;
9134 else if (target_y
>= it
->current_y
+ line_height
9135 && IT_CHARPOS (*it
) < ZV
)
9137 /* Should move forward by at least one line, maybe more.
9139 Note: Calling move_it_by_lines can be expensive on
9140 terminal frames, where compute_motion is used (via
9141 vmotion) to do the job, when there are very long lines
9142 and truncate-lines is nil. That's the reason for
9143 treating terminal frames specially here. */
9145 if (!FRAME_WINDOW_P (it
->f
))
9146 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9151 move_it_by_lines (it
, 1);
9153 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9160 /* Move IT by a specified amount of pixel lines DY. DY negative means
9161 move backwards. DY = 0 means move to start of screen line. At the
9162 end, IT will be on the start of a screen line. */
9165 move_it_vertically (struct it
*it
, int dy
)
9168 move_it_vertically_backward (it
, -dy
);
9171 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9172 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9173 MOVE_TO_POS
| MOVE_TO_Y
);
9174 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9176 /* If buffer ends in ZV without a newline, move to the start of
9177 the line to satisfy the post-condition. */
9178 if (IT_CHARPOS (*it
) == ZV
9180 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9181 move_it_by_lines (it
, 0);
9186 /* Move iterator IT past the end of the text line it is in. */
9189 move_it_past_eol (struct it
*it
)
9191 enum move_it_result rc
;
9193 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9194 if (rc
== MOVE_NEWLINE_OR_CR
)
9195 set_iterator_to_next (it
, 0);
9199 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9200 negative means move up. DVPOS == 0 means move to the start of the
9203 Optimization idea: If we would know that IT->f doesn't use
9204 a face with proportional font, we could be faster for
9205 truncate-lines nil. */
9208 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9211 /* The commented-out optimization uses vmotion on terminals. This
9212 gives bad results, because elements like it->what, on which
9213 callers such as pos_visible_p rely, aren't updated. */
9214 /* struct position pos;
9215 if (!FRAME_WINDOW_P (it->f))
9217 struct text_pos textpos;
9219 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9220 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9221 reseat (it, textpos, 1);
9222 it->vpos += pos.vpos;
9223 it->current_y += pos.vpos;
9229 /* DVPOS == 0 means move to the start of the screen line. */
9230 move_it_vertically_backward (it
, 0);
9231 /* Let next call to line_bottom_y calculate real line height */
9236 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9237 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9239 /* Only move to the next buffer position if we ended up in a
9240 string from display property, not in an overlay string
9241 (before-string or after-string). That is because the
9242 latter don't conceal the underlying buffer position, so
9243 we can ask to move the iterator to the exact position we
9244 are interested in. Note that, even if we are already at
9245 IT_CHARPOS (*it), the call below is not a no-op, as it
9246 will detect that we are at the end of the string, pop the
9247 iterator, and compute it->current_x and it->hpos
9249 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9250 -1, -1, -1, MOVE_TO_POS
);
9256 void *it2data
= NULL
;
9257 ptrdiff_t start_charpos
, i
;
9259 /* Start at the beginning of the screen line containing IT's
9260 position. This may actually move vertically backwards,
9261 in case of overlays, so adjust dvpos accordingly. */
9263 move_it_vertically_backward (it
, 0);
9266 /* Go back -DVPOS visible lines and reseat the iterator there. */
9267 start_charpos
= IT_CHARPOS (*it
);
9268 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
9269 back_to_previous_visible_line_start (it
);
9270 reseat (it
, it
->current
.pos
, 1);
9272 /* Move further back if we end up in a string or an image. */
9273 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9275 /* First try to move to start of display line. */
9277 move_it_vertically_backward (it
, 0);
9279 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9281 /* If start of line is still in string or image,
9282 move further back. */
9283 back_to_previous_visible_line_start (it
);
9284 reseat (it
, it
->current
.pos
, 1);
9288 it
->current_x
= it
->hpos
= 0;
9290 /* Above call may have moved too far if continuation lines
9291 are involved. Scan forward and see if it did. */
9292 SAVE_IT (it2
, *it
, it2data
);
9293 it2
.vpos
= it2
.current_y
= 0;
9294 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9295 it
->vpos
-= it2
.vpos
;
9296 it
->current_y
-= it2
.current_y
;
9297 it
->current_x
= it
->hpos
= 0;
9299 /* If we moved too far back, move IT some lines forward. */
9300 if (it2
.vpos
> -dvpos
)
9302 int delta
= it2
.vpos
+ dvpos
;
9304 RESTORE_IT (&it2
, &it2
, it2data
);
9305 SAVE_IT (it2
, *it
, it2data
);
9306 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9307 /* Move back again if we got too far ahead. */
9308 if (IT_CHARPOS (*it
) >= start_charpos
)
9309 RESTORE_IT (it
, &it2
, it2data
);
9311 bidi_unshelve_cache (it2data
, 1);
9314 RESTORE_IT (it
, it
, it2data
);
9318 /* Return 1 if IT points into the middle of a display vector. */
9321 in_display_vector_p (struct it
*it
)
9323 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9324 && it
->current
.dpvec_index
> 0
9325 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9329 /***********************************************************************
9331 ***********************************************************************/
9334 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9338 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9340 Lisp_Object args
[3];
9341 Lisp_Object msg
, fmt
;
9344 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9348 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9350 args
[0] = fmt
= build_string (format
);
9353 msg
= Fformat (3, args
);
9355 len
= SBYTES (msg
) + 1;
9356 buffer
= SAFE_ALLOCA (len
);
9357 memcpy (buffer
, SDATA (msg
), len
);
9359 message_dolog (buffer
, len
- 1, 1, 0);
9366 /* Output a newline in the *Messages* buffer if "needs" one. */
9369 message_log_maybe_newline (void)
9371 if (message_log_need_newline
)
9372 message_dolog ("", 0, 1, 0);
9376 /* Add a string M of length NBYTES to the message log, optionally
9377 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9378 nonzero, means interpret the contents of M as multibyte. This
9379 function calls low-level routines in order to bypass text property
9380 hooks, etc. which might not be safe to run.
9382 This may GC (insert may run before/after change hooks),
9383 so the buffer M must NOT point to a Lisp string. */
9386 message_dolog (const char *m
, ptrdiff_t nbytes
, int nlflag
, int multibyte
)
9388 const unsigned char *msg
= (const unsigned char *) m
;
9390 if (!NILP (Vmemory_full
))
9393 if (!NILP (Vmessage_log_max
))
9395 struct buffer
*oldbuf
;
9396 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9397 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9398 ptrdiff_t point_at_end
= 0;
9399 ptrdiff_t zv_at_end
= 0;
9400 Lisp_Object old_deactivate_mark
;
9402 struct gcpro gcpro1
;
9404 old_deactivate_mark
= Vdeactivate_mark
;
9405 oldbuf
= current_buffer
;
9406 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9407 bset_undo_list (current_buffer
, Qt
);
9409 oldpoint
= message_dolog_marker1
;
9410 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9411 oldbegv
= message_dolog_marker2
;
9412 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9413 oldzv
= message_dolog_marker3
;
9414 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9415 GCPRO1 (old_deactivate_mark
);
9423 BEGV_BYTE
= BEG_BYTE
;
9426 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9428 /* Insert the string--maybe converting multibyte to single byte
9429 or vice versa, so that all the text fits the buffer. */
9431 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9437 /* Convert a multibyte string to single-byte
9438 for the *Message* buffer. */
9439 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9441 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9442 work
[0] = (ASCII_CHAR_P (c
)
9444 : multibyte_char_to_unibyte (c
));
9445 insert_1_both (work
, 1, 1, 1, 0, 0);
9448 else if (! multibyte
9449 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9453 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9454 /* Convert a single-byte string to multibyte
9455 for the *Message* buffer. */
9456 for (i
= 0; i
< nbytes
; i
++)
9459 MAKE_CHAR_MULTIBYTE (c
);
9460 char_bytes
= CHAR_STRING (c
, str
);
9461 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9465 insert_1 (m
, nbytes
, 1, 0, 0);
9469 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9471 insert_1 ("\n", 1, 1, 0, 0);
9473 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9475 this_bol_byte
= PT_BYTE
;
9477 /* See if this line duplicates the previous one.
9478 If so, combine duplicates. */
9481 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9483 prev_bol_byte
= PT_BYTE
;
9485 dups
= message_log_check_duplicate (prev_bol_byte
,
9489 del_range_both (prev_bol
, prev_bol_byte
,
9490 this_bol
, this_bol_byte
, 0);
9493 char dupstr
[sizeof " [ times]"
9494 + INT_STRLEN_BOUND (printmax_t
)];
9496 /* If you change this format, don't forget to also
9497 change message_log_check_duplicate. */
9498 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9499 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9500 insert_1 (dupstr
, duplen
, 1, 0, 1);
9505 /* If we have more than the desired maximum number of lines
9506 in the *Messages* buffer now, delete the oldest ones.
9507 This is safe because we don't have undo in this buffer. */
9509 if (NATNUMP (Vmessage_log_max
))
9511 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9512 -XFASTINT (Vmessage_log_max
) - 1, 0);
9513 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9516 BEGV
= marker_position (oldbegv
);
9517 BEGV_BYTE
= marker_byte_position (oldbegv
);
9526 ZV
= marker_position (oldzv
);
9527 ZV_BYTE
= marker_byte_position (oldzv
);
9531 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9533 /* We can't do Fgoto_char (oldpoint) because it will run some
9535 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
9536 marker_byte_position (oldpoint
));
9539 unchain_marker (XMARKER (oldpoint
));
9540 unchain_marker (XMARKER (oldbegv
));
9541 unchain_marker (XMARKER (oldzv
));
9543 shown
= buffer_window_count (current_buffer
) > 0;
9544 set_buffer_internal (oldbuf
);
9546 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9547 message_log_need_newline
= !nlflag
;
9548 Vdeactivate_mark
= old_deactivate_mark
;
9553 /* We are at the end of the buffer after just having inserted a newline.
9554 (Note: We depend on the fact we won't be crossing the gap.)
9555 Check to see if the most recent message looks a lot like the previous one.
9556 Return 0 if different, 1 if the new one should just replace it, or a
9557 value N > 1 if we should also append " [N times]". */
9560 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9563 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9565 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9566 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9568 for (i
= 0; i
< len
; i
++)
9570 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9578 if (*p1
++ == ' ' && *p1
++ == '[')
9581 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9582 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9589 /* Display an echo area message M with a specified length of NBYTES
9590 bytes. The string may include null characters. If M is 0, clear
9591 out any existing message, and let the mini-buffer text show
9594 This may GC, so the buffer M must NOT point to a Lisp string. */
9597 message2 (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9599 /* First flush out any partial line written with print. */
9600 message_log_maybe_newline ();
9602 message_dolog (m
, nbytes
, 1, multibyte
);
9603 message2_nolog (m
, nbytes
, multibyte
);
9607 /* The non-logging counterpart of message2. */
9610 message2_nolog (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9612 struct frame
*sf
= SELECTED_FRAME ();
9613 message_enable_multibyte
= multibyte
;
9615 if (FRAME_INITIAL_P (sf
))
9617 if (noninteractive_need_newline
)
9618 putc ('\n', stderr
);
9619 noninteractive_need_newline
= 0;
9621 fwrite (m
, nbytes
, 1, stderr
);
9622 if (cursor_in_echo_area
== 0)
9623 fprintf (stderr
, "\n");
9626 /* A null message buffer means that the frame hasn't really been
9627 initialized yet. Error messages get reported properly by
9628 cmd_error, so this must be just an informative message; toss it. */
9629 else if (INTERACTIVE
9630 && sf
->glyphs_initialized_p
9631 && FRAME_MESSAGE_BUF (sf
))
9633 Lisp_Object mini_window
;
9636 /* Get the frame containing the mini-buffer
9637 that the selected frame is using. */
9638 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9639 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9641 FRAME_SAMPLE_VISIBILITY (f
);
9642 if (FRAME_VISIBLE_P (sf
)
9643 && ! FRAME_VISIBLE_P (f
))
9644 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9648 set_message (m
, Qnil
, nbytes
, multibyte
);
9649 if (minibuffer_auto_raise
)
9650 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9653 clear_message (1, 1);
9655 do_pending_window_change (0);
9656 echo_area_display (1);
9657 do_pending_window_change (0);
9658 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
9659 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9664 /* Display an echo area message M with a specified length of NBYTES
9665 bytes. The string may include null characters. If M is not a
9666 string, clear out any existing message, and let the mini-buffer
9669 This function cancels echoing. */
9672 message3 (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9674 struct gcpro gcpro1
;
9677 clear_message (1,1);
9680 /* First flush out any partial line written with print. */
9681 message_log_maybe_newline ();
9685 char *buffer
= SAFE_ALLOCA (nbytes
);
9686 memcpy (buffer
, SDATA (m
), nbytes
);
9687 message_dolog (buffer
, nbytes
, 1, multibyte
);
9690 message3_nolog (m
, nbytes
, multibyte
);
9696 /* The non-logging version of message3.
9697 This does not cancel echoing, because it is used for echoing.
9698 Perhaps we need to make a separate function for echoing
9699 and make this cancel echoing. */
9702 message3_nolog (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9704 struct frame
*sf
= SELECTED_FRAME ();
9705 message_enable_multibyte
= multibyte
;
9707 if (FRAME_INITIAL_P (sf
))
9709 if (noninteractive_need_newline
)
9710 putc ('\n', stderr
);
9711 noninteractive_need_newline
= 0;
9713 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9714 if (cursor_in_echo_area
== 0)
9715 fprintf (stderr
, "\n");
9718 /* A null message buffer means that the frame hasn't really been
9719 initialized yet. Error messages get reported properly by
9720 cmd_error, so this must be just an informative message; toss it. */
9721 else if (INTERACTIVE
9722 && sf
->glyphs_initialized_p
9723 && FRAME_MESSAGE_BUF (sf
))
9725 Lisp_Object mini_window
;
9729 /* Get the frame containing the mini-buffer
9730 that the selected frame is using. */
9731 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9732 frame
= XWINDOW (mini_window
)->frame
;
9735 FRAME_SAMPLE_VISIBILITY (f
);
9736 if (FRAME_VISIBLE_P (sf
)
9737 && !FRAME_VISIBLE_P (f
))
9738 Fmake_frame_visible (frame
);
9740 if (STRINGP (m
) && SCHARS (m
) > 0)
9742 set_message (NULL
, m
, nbytes
, multibyte
);
9743 if (minibuffer_auto_raise
)
9744 Fraise_frame (frame
);
9745 /* Assume we are not echoing.
9746 (If we are, echo_now will override this.) */
9747 echo_message_buffer
= Qnil
;
9750 clear_message (1, 1);
9752 do_pending_window_change (0);
9753 echo_area_display (1);
9754 do_pending_window_change (0);
9755 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
9756 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9761 /* Display a null-terminated echo area message M. If M is 0, clear
9762 out any existing message, and let the mini-buffer text show through.
9764 The buffer M must continue to exist until after the echo area gets
9765 cleared or some other message gets displayed there. Do not pass
9766 text that is stored in a Lisp string. Do not pass text in a buffer
9767 that was alloca'd. */
9770 message1 (const char *m
)
9772 message2 (m
, (m
? strlen (m
) : 0), 0);
9776 /* The non-logging counterpart of message1. */
9779 message1_nolog (const char *m
)
9781 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9784 /* Display a message M which contains a single %s
9785 which gets replaced with STRING. */
9788 message_with_string (const char *m
, Lisp_Object string
, int log
)
9790 CHECK_STRING (string
);
9796 if (noninteractive_need_newline
)
9797 putc ('\n', stderr
);
9798 noninteractive_need_newline
= 0;
9799 fprintf (stderr
, m
, SDATA (string
));
9800 if (!cursor_in_echo_area
)
9801 fprintf (stderr
, "\n");
9805 else if (INTERACTIVE
)
9807 /* The frame whose minibuffer we're going to display the message on.
9808 It may be larger than the selected frame, so we need
9809 to use its buffer, not the selected frame's buffer. */
9810 Lisp_Object mini_window
;
9811 struct frame
*f
, *sf
= SELECTED_FRAME ();
9813 /* Get the frame containing the minibuffer
9814 that the selected frame is using. */
9815 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9816 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9818 /* A null message buffer means that the frame hasn't really been
9819 initialized yet. Error messages get reported properly by
9820 cmd_error, so this must be just an informative message; toss it. */
9821 if (FRAME_MESSAGE_BUF (f
))
9823 Lisp_Object args
[2], msg
;
9824 struct gcpro gcpro1
, gcpro2
;
9826 args
[0] = build_string (m
);
9827 args
[1] = msg
= string
;
9828 GCPRO2 (args
[0], msg
);
9831 msg
= Fformat (2, args
);
9834 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9836 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9840 /* Print should start at the beginning of the message
9841 buffer next time. */
9842 message_buf_print
= 0;
9848 /* Dump an informative message to the minibuf. If M is 0, clear out
9849 any existing message, and let the mini-buffer text show through. */
9852 vmessage (const char *m
, va_list ap
)
9858 if (noninteractive_need_newline
)
9859 putc ('\n', stderr
);
9860 noninteractive_need_newline
= 0;
9861 vfprintf (stderr
, m
, ap
);
9862 if (cursor_in_echo_area
== 0)
9863 fprintf (stderr
, "\n");
9867 else if (INTERACTIVE
)
9869 /* The frame whose mini-buffer we're going to display the message
9870 on. It may be larger than the selected frame, so we need to
9871 use its buffer, not the selected frame's buffer. */
9872 Lisp_Object mini_window
;
9873 struct frame
*f
, *sf
= SELECTED_FRAME ();
9875 /* Get the frame containing the mini-buffer
9876 that the selected frame is using. */
9877 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9878 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9880 /* A null message buffer means that the frame hasn't really been
9881 initialized yet. Error messages get reported properly by
9882 cmd_error, so this must be just an informative message; toss
9884 if (FRAME_MESSAGE_BUF (f
))
9890 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9891 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9893 message2 (FRAME_MESSAGE_BUF (f
), len
, 1);
9898 /* Print should start at the beginning of the message
9899 buffer next time. */
9900 message_buf_print
= 0;
9906 message (const char *m
, ...)
9916 /* The non-logging version of message. */
9919 message_nolog (const char *m
, ...)
9921 Lisp_Object old_log_max
;
9924 old_log_max
= Vmessage_log_max
;
9925 Vmessage_log_max
= Qnil
;
9927 Vmessage_log_max
= old_log_max
;
9933 /* Display the current message in the current mini-buffer. This is
9934 only called from error handlers in process.c, and is not time
9938 update_echo_area (void)
9940 if (!NILP (echo_area_buffer
[0]))
9943 string
= Fcurrent_message ();
9944 message3 (string
, SBYTES (string
),
9945 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9950 /* Make sure echo area buffers in `echo_buffers' are live.
9951 If they aren't, make new ones. */
9954 ensure_echo_area_buffers (void)
9958 for (i
= 0; i
< 2; ++i
)
9959 if (!BUFFERP (echo_buffer
[i
])
9960 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
9963 Lisp_Object old_buffer
;
9966 old_buffer
= echo_buffer
[i
];
9967 echo_buffer
[i
] = Fget_buffer_create
9968 (make_formatted_string (name
, " *Echo Area %d*", i
));
9969 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
9970 /* to force word wrap in echo area -
9971 it was decided to postpone this*/
9972 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9974 for (j
= 0; j
< 2; ++j
)
9975 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9976 echo_area_buffer
[j
] = echo_buffer
[i
];
9981 /* Call FN with args A1..A4 with either the current or last displayed
9982 echo_area_buffer as current buffer.
9984 WHICH zero means use the current message buffer
9985 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9986 from echo_buffer[] and clear it.
9988 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9989 suitable buffer from echo_buffer[] and clear it.
9991 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9992 that the current message becomes the last displayed one, make
9993 choose a suitable buffer for echo_area_buffer[0], and clear it.
9995 Value is what FN returns. */
9998 with_echo_area_buffer (struct window
*w
, int which
,
9999 int (*fn
) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
10000 ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10002 Lisp_Object buffer
;
10003 int this_one
, the_other
, clear_buffer_p
, rc
;
10004 ptrdiff_t count
= SPECPDL_INDEX ();
10006 /* If buffers aren't live, make new ones. */
10007 ensure_echo_area_buffers ();
10009 clear_buffer_p
= 0;
10012 this_one
= 0, the_other
= 1;
10013 else if (which
> 0)
10014 this_one
= 1, the_other
= 0;
10017 this_one
= 0, the_other
= 1;
10018 clear_buffer_p
= 1;
10020 /* We need a fresh one in case the current echo buffer equals
10021 the one containing the last displayed echo area message. */
10022 if (!NILP (echo_area_buffer
[this_one
])
10023 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10024 echo_area_buffer
[this_one
] = Qnil
;
10027 /* Choose a suitable buffer from echo_buffer[] is we don't
10029 if (NILP (echo_area_buffer
[this_one
]))
10031 echo_area_buffer
[this_one
]
10032 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10033 ? echo_buffer
[the_other
]
10034 : echo_buffer
[this_one
]);
10035 clear_buffer_p
= 1;
10038 buffer
= echo_area_buffer
[this_one
];
10040 /* Don't get confused by reusing the buffer used for echoing
10041 for a different purpose. */
10042 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10045 record_unwind_protect (unwind_with_echo_area_buffer
,
10046 with_echo_area_buffer_unwind_data (w
));
10048 /* Make the echo area buffer current. Note that for display
10049 purposes, it is not necessary that the displayed window's buffer
10050 == current_buffer, except for text property lookup. So, let's
10051 only set that buffer temporarily here without doing a full
10052 Fset_window_buffer. We must also change w->pointm, though,
10053 because otherwise an assertions in unshow_buffer fails, and Emacs
10055 set_buffer_internal_1 (XBUFFER (buffer
));
10058 wset_buffer (w
, buffer
);
10059 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10062 bset_undo_list (current_buffer
, Qt
);
10063 bset_read_only (current_buffer
, Qnil
);
10064 specbind (Qinhibit_read_only
, Qt
);
10065 specbind (Qinhibit_modification_hooks
, Qt
);
10067 if (clear_buffer_p
&& Z
> BEG
)
10068 del_range (BEG
, Z
);
10070 eassert (BEGV
>= BEG
);
10071 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10073 rc
= fn (a1
, a2
, a3
, a4
);
10075 eassert (BEGV
>= BEG
);
10076 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10078 unbind_to (count
, Qnil
);
10083 /* Save state that should be preserved around the call to the function
10084 FN called in with_echo_area_buffer. */
10087 with_echo_area_buffer_unwind_data (struct window
*w
)
10090 Lisp_Object vector
, tmp
;
10092 /* Reduce consing by keeping one vector in
10093 Vwith_echo_area_save_vector. */
10094 vector
= Vwith_echo_area_save_vector
;
10095 Vwith_echo_area_save_vector
= Qnil
;
10098 vector
= Fmake_vector (make_number (7), Qnil
);
10100 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10101 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10102 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10106 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10107 ASET (vector
, i
, w
->buffer
); ++i
;
10108 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10109 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10114 for (; i
< end
; ++i
)
10115 ASET (vector
, i
, Qnil
);
10118 eassert (i
== ASIZE (vector
));
10123 /* Restore global state from VECTOR which was created by
10124 with_echo_area_buffer_unwind_data. */
10127 unwind_with_echo_area_buffer (Lisp_Object vector
)
10129 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10130 Vdeactivate_mark
= AREF (vector
, 1);
10131 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10133 if (WINDOWP (AREF (vector
, 3)))
10136 Lisp_Object buffer
, charpos
, bytepos
;
10138 w
= XWINDOW (AREF (vector
, 3));
10139 buffer
= AREF (vector
, 4);
10140 charpos
= AREF (vector
, 5);
10141 bytepos
= AREF (vector
, 6);
10143 wset_buffer (w
, buffer
);
10144 set_marker_both (w
->pointm
, buffer
,
10145 XFASTINT (charpos
), XFASTINT (bytepos
));
10148 Vwith_echo_area_save_vector
= vector
;
10153 /* Set up the echo area for use by print functions. MULTIBYTE_P
10154 non-zero means we will print multibyte. */
10157 setup_echo_area_for_printing (int multibyte_p
)
10159 /* If we can't find an echo area any more, exit. */
10160 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10161 Fkill_emacs (Qnil
);
10163 ensure_echo_area_buffers ();
10165 if (!message_buf_print
)
10167 /* A message has been output since the last time we printed.
10168 Choose a fresh echo area buffer. */
10169 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10170 echo_area_buffer
[0] = echo_buffer
[1];
10172 echo_area_buffer
[0] = echo_buffer
[0];
10174 /* Switch to that buffer and clear it. */
10175 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10176 bset_truncate_lines (current_buffer
, Qnil
);
10180 ptrdiff_t count
= SPECPDL_INDEX ();
10181 specbind (Qinhibit_read_only
, Qt
);
10182 /* Note that undo recording is always disabled. */
10183 del_range (BEG
, Z
);
10184 unbind_to (count
, Qnil
);
10186 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10188 /* Set up the buffer for the multibyteness we need. */
10190 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10191 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10193 /* Raise the frame containing the echo area. */
10194 if (minibuffer_auto_raise
)
10196 struct frame
*sf
= SELECTED_FRAME ();
10197 Lisp_Object mini_window
;
10198 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10199 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10202 message_log_maybe_newline ();
10203 message_buf_print
= 1;
10207 if (NILP (echo_area_buffer
[0]))
10209 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10210 echo_area_buffer
[0] = echo_buffer
[1];
10212 echo_area_buffer
[0] = echo_buffer
[0];
10215 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10217 /* Someone switched buffers between print requests. */
10218 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10219 bset_truncate_lines (current_buffer
, Qnil
);
10225 /* Display an echo area message in window W. Value is non-zero if W's
10226 height is changed. If display_last_displayed_message_p is
10227 non-zero, display the message that was last displayed, otherwise
10228 display the current message. */
10231 display_echo_area (struct window
*w
)
10233 int i
, no_message_p
, window_height_changed_p
;
10235 /* Temporarily disable garbage collections while displaying the echo
10236 area. This is done because a GC can print a message itself.
10237 That message would modify the echo area buffer's contents while a
10238 redisplay of the buffer is going on, and seriously confuse
10240 ptrdiff_t count
= inhibit_garbage_collection ();
10242 /* If there is no message, we must call display_echo_area_1
10243 nevertheless because it resizes the window. But we will have to
10244 reset the echo_area_buffer in question to nil at the end because
10245 with_echo_area_buffer will sets it to an empty buffer. */
10246 i
= display_last_displayed_message_p
? 1 : 0;
10247 no_message_p
= NILP (echo_area_buffer
[i
]);
10249 window_height_changed_p
10250 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10251 display_echo_area_1
,
10252 (intptr_t) w
, Qnil
, 0, 0);
10255 echo_area_buffer
[i
] = Qnil
;
10257 unbind_to (count
, Qnil
);
10258 return window_height_changed_p
;
10262 /* Helper for display_echo_area. Display the current buffer which
10263 contains the current echo area message in window W, a mini-window,
10264 a pointer to which is passed in A1. A2..A4 are currently not used.
10265 Change the height of W so that all of the message is displayed.
10266 Value is non-zero if height of W was changed. */
10269 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10272 struct window
*w
= (struct window
*) i1
;
10273 Lisp_Object window
;
10274 struct text_pos start
;
10275 int window_height_changed_p
= 0;
10277 /* Do this before displaying, so that we have a large enough glyph
10278 matrix for the display. If we can't get enough space for the
10279 whole text, display the last N lines. That works by setting w->start. */
10280 window_height_changed_p
= resize_mini_window (w
, 0);
10282 /* Use the starting position chosen by resize_mini_window. */
10283 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10286 clear_glyph_matrix (w
->desired_matrix
);
10287 XSETWINDOW (window
, w
);
10288 try_window (window
, start
, 0);
10290 return window_height_changed_p
;
10294 /* Resize the echo area window to exactly the size needed for the
10295 currently displayed message, if there is one. If a mini-buffer
10296 is active, don't shrink it. */
10299 resize_echo_area_exactly (void)
10301 if (BUFFERP (echo_area_buffer
[0])
10302 && WINDOWP (echo_area_window
))
10304 struct window
*w
= XWINDOW (echo_area_window
);
10306 Lisp_Object resize_exactly
;
10308 if (minibuf_level
== 0)
10309 resize_exactly
= Qt
;
10311 resize_exactly
= Qnil
;
10313 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10314 (intptr_t) w
, resize_exactly
,
10318 ++windows_or_buffers_changed
;
10319 ++update_mode_lines
;
10320 redisplay_internal ();
10326 /* Callback function for with_echo_area_buffer, when used from
10327 resize_echo_area_exactly. A1 contains a pointer to the window to
10328 resize, EXACTLY non-nil means resize the mini-window exactly to the
10329 size of the text displayed. A3 and A4 are not used. Value is what
10330 resize_mini_window returns. */
10333 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
, ptrdiff_t a3
, ptrdiff_t a4
)
10336 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10340 /* Resize mini-window W to fit the size of its contents. EXACT_P
10341 means size the window exactly to the size needed. Otherwise, it's
10342 only enlarged until W's buffer is empty.
10344 Set W->start to the right place to begin display. If the whole
10345 contents fit, start at the beginning. Otherwise, start so as
10346 to make the end of the contents appear. This is particularly
10347 important for y-or-n-p, but seems desirable generally.
10349 Value is non-zero if the window height has been changed. */
10352 resize_mini_window (struct window
*w
, int exact_p
)
10354 struct frame
*f
= XFRAME (w
->frame
);
10355 int window_height_changed_p
= 0;
10357 eassert (MINI_WINDOW_P (w
));
10359 /* By default, start display at the beginning. */
10360 set_marker_both (w
->start
, w
->buffer
,
10361 BUF_BEGV (XBUFFER (w
->buffer
)),
10362 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10364 /* Don't resize windows while redisplaying a window; it would
10365 confuse redisplay functions when the size of the window they are
10366 displaying changes from under them. Such a resizing can happen,
10367 for instance, when which-func prints a long message while
10368 we are running fontification-functions. We're running these
10369 functions with safe_call which binds inhibit-redisplay to t. */
10370 if (!NILP (Vinhibit_redisplay
))
10373 /* Nil means don't try to resize. */
10374 if (NILP (Vresize_mini_windows
)
10375 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10378 if (!FRAME_MINIBUF_ONLY_P (f
))
10381 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10382 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10384 EMACS_INT max_height
;
10385 int unit
= FRAME_LINE_HEIGHT (f
);
10386 struct text_pos start
;
10387 struct buffer
*old_current_buffer
= NULL
;
10389 if (current_buffer
!= XBUFFER (w
->buffer
))
10391 old_current_buffer
= current_buffer
;
10392 set_buffer_internal (XBUFFER (w
->buffer
));
10395 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10397 /* Compute the max. number of lines specified by the user. */
10398 if (FLOATP (Vmax_mini_window_height
))
10399 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10400 else if (INTEGERP (Vmax_mini_window_height
))
10401 max_height
= XINT (Vmax_mini_window_height
);
10403 max_height
= total_height
/ 4;
10405 /* Correct that max. height if it's bogus. */
10406 max_height
= clip_to_bounds (1, max_height
, total_height
);
10408 /* Find out the height of the text in the window. */
10409 if (it
.line_wrap
== TRUNCATE
)
10414 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10415 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10416 height
= it
.current_y
+ last_height
;
10418 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10419 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10420 height
= (height
+ unit
- 1) / unit
;
10423 /* Compute a suitable window start. */
10424 if (height
> max_height
)
10426 height
= max_height
;
10427 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10428 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10429 start
= it
.current
.pos
;
10432 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10433 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10435 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10437 /* Let it grow only, until we display an empty message, in which
10438 case the window shrinks again. */
10439 if (height
> WINDOW_TOTAL_LINES (w
))
10441 int old_height
= WINDOW_TOTAL_LINES (w
);
10442 freeze_window_starts (f
, 1);
10443 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10444 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10446 else if (height
< WINDOW_TOTAL_LINES (w
)
10447 && (exact_p
|| BEGV
== ZV
))
10449 int old_height
= WINDOW_TOTAL_LINES (w
);
10450 freeze_window_starts (f
, 0);
10451 shrink_mini_window (w
);
10452 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10457 /* Always resize to exact size needed. */
10458 if (height
> WINDOW_TOTAL_LINES (w
))
10460 int old_height
= WINDOW_TOTAL_LINES (w
);
10461 freeze_window_starts (f
, 1);
10462 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10463 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10465 else if (height
< WINDOW_TOTAL_LINES (w
))
10467 int old_height
= WINDOW_TOTAL_LINES (w
);
10468 freeze_window_starts (f
, 0);
10469 shrink_mini_window (w
);
10473 freeze_window_starts (f
, 1);
10474 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10477 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10481 if (old_current_buffer
)
10482 set_buffer_internal (old_current_buffer
);
10485 return window_height_changed_p
;
10489 /* Value is the current message, a string, or nil if there is no
10490 current message. */
10493 current_message (void)
10497 if (!BUFFERP (echo_area_buffer
[0]))
10501 with_echo_area_buffer (0, 0, current_message_1
,
10502 (intptr_t) &msg
, Qnil
, 0, 0);
10504 echo_area_buffer
[0] = Qnil
;
10512 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10515 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10518 *msg
= make_buffer_string (BEG
, Z
, 1);
10525 /* Push the current message on Vmessage_stack for later restoration
10526 by restore_message. Value is non-zero if the current message isn't
10527 empty. This is a relatively infrequent operation, so it's not
10528 worth optimizing. */
10531 push_message (void)
10533 Lisp_Object msg
= current_message ();
10534 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10535 return STRINGP (msg
);
10539 /* Restore message display from the top of Vmessage_stack. */
10542 restore_message (void)
10546 eassert (CONSP (Vmessage_stack
));
10547 msg
= XCAR (Vmessage_stack
);
10549 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10551 message3_nolog (msg
, 0, 0);
10555 /* Handler for record_unwind_protect calling pop_message. */
10558 pop_message_unwind (Lisp_Object dummy
)
10564 /* Pop the top-most entry off Vmessage_stack. */
10569 eassert (CONSP (Vmessage_stack
));
10570 Vmessage_stack
= XCDR (Vmessage_stack
);
10574 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10575 exits. If the stack is not empty, we have a missing pop_message
10579 check_message_stack (void)
10581 if (!NILP (Vmessage_stack
))
10586 /* Truncate to NCHARS what will be displayed in the echo area the next
10587 time we display it---but don't redisplay it now. */
10590 truncate_echo_area (ptrdiff_t nchars
)
10593 echo_area_buffer
[0] = Qnil
;
10594 /* A null message buffer means that the frame hasn't really been
10595 initialized yet. Error messages get reported properly by
10596 cmd_error, so this must be just an informative message; toss it. */
10597 else if (!noninteractive
10599 && !NILP (echo_area_buffer
[0]))
10601 struct frame
*sf
= SELECTED_FRAME ();
10602 if (FRAME_MESSAGE_BUF (sf
))
10603 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10608 /* Helper function for truncate_echo_area. Truncate the current
10609 message to at most NCHARS characters. */
10612 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10614 if (BEG
+ nchars
< Z
)
10615 del_range (BEG
+ nchars
, Z
);
10617 echo_area_buffer
[0] = Qnil
;
10621 /* Set the current message to a substring of S or STRING.
10623 If STRING is a Lisp string, set the message to the first NBYTES
10624 bytes from STRING. NBYTES zero means use the whole string. If
10625 STRING is multibyte, the message will be displayed multibyte.
10627 If S is not null, set the message to the first LEN bytes of S. LEN
10628 zero means use the whole string. MULTIBYTE_P non-zero means S is
10629 multibyte. Display the message multibyte in that case.
10631 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10632 to t before calling set_message_1 (which calls insert).
10636 set_message (const char *s
, Lisp_Object string
,
10637 ptrdiff_t nbytes
, int multibyte_p
)
10639 message_enable_multibyte
10640 = ((s
&& multibyte_p
)
10641 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10643 with_echo_area_buffer (0, -1, set_message_1
,
10644 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10645 message_buf_print
= 0;
10646 help_echo_showing_p
= 0;
10648 if (STRINGP (Vdebug_on_message
)
10649 && fast_string_match (Vdebug_on_message
, string
) >= 0)
10650 call_debugger (list2 (Qerror
, string
));
10654 /* Helper function for set_message. Arguments have the same meaning
10655 as there, with A1 corresponding to S and A2 corresponding to STRING
10656 This function is called with the echo area buffer being
10660 set_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t nbytes
, ptrdiff_t multibyte_p
)
10663 const char *s
= (const char *) i1
;
10664 const unsigned char *msg
= (const unsigned char *) s
;
10665 Lisp_Object string
= a2
;
10667 /* Change multibyteness of the echo buffer appropriately. */
10668 if (message_enable_multibyte
10669 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10670 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10672 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
10673 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10674 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
10676 /* Insert new message at BEG. */
10677 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10679 if (STRINGP (string
))
10684 nbytes
= SBYTES (string
);
10685 nchars
= string_byte_to_char (string
, nbytes
);
10687 /* This function takes care of single/multibyte conversion. We
10688 just have to ensure that the echo area buffer has the right
10689 setting of enable_multibyte_characters. */
10690 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10695 nbytes
= strlen (s
);
10697 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10699 /* Convert from multi-byte to single-byte. */
10704 /* Convert a multibyte string to single-byte. */
10705 for (i
= 0; i
< nbytes
; i
+= n
)
10707 c
= string_char_and_length (msg
+ i
, &n
);
10708 work
[0] = (ASCII_CHAR_P (c
)
10710 : multibyte_char_to_unibyte (c
));
10711 insert_1_both (work
, 1, 1, 1, 0, 0);
10714 else if (!multibyte_p
10715 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10717 /* Convert from single-byte to multi-byte. */
10720 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10722 /* Convert a single-byte string to multibyte. */
10723 for (i
= 0; i
< nbytes
; i
++)
10726 MAKE_CHAR_MULTIBYTE (c
);
10727 n
= CHAR_STRING (c
, str
);
10728 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10732 insert_1 (s
, nbytes
, 1, 0, 0);
10739 /* Clear messages. CURRENT_P non-zero means clear the current
10740 message. LAST_DISPLAYED_P non-zero means clear the message
10744 clear_message (int current_p
, int last_displayed_p
)
10748 echo_area_buffer
[0] = Qnil
;
10749 message_cleared_p
= 1;
10752 if (last_displayed_p
)
10753 echo_area_buffer
[1] = Qnil
;
10755 message_buf_print
= 0;
10758 /* Clear garbaged frames.
10760 This function is used where the old redisplay called
10761 redraw_garbaged_frames which in turn called redraw_frame which in
10762 turn called clear_frame. The call to clear_frame was a source of
10763 flickering. I believe a clear_frame is not necessary. It should
10764 suffice in the new redisplay to invalidate all current matrices,
10765 and ensure a complete redisplay of all windows. */
10768 clear_garbaged_frames (void)
10770 if (frame_garbaged
)
10772 Lisp_Object tail
, frame
;
10773 int changed_count
= 0;
10775 FOR_EACH_FRAME (tail
, frame
)
10777 struct frame
*f
= XFRAME (frame
);
10779 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10784 f
->force_flush_display_p
= 1;
10786 clear_current_matrices (f
);
10793 frame_garbaged
= 0;
10795 ++windows_or_buffers_changed
;
10800 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10801 is non-zero update selected_frame. Value is non-zero if the
10802 mini-windows height has been changed. */
10805 echo_area_display (int update_frame_p
)
10807 Lisp_Object mini_window
;
10810 int window_height_changed_p
= 0;
10811 struct frame
*sf
= SELECTED_FRAME ();
10813 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10814 w
= XWINDOW (mini_window
);
10815 f
= XFRAME (WINDOW_FRAME (w
));
10817 /* Don't display if frame is invisible or not yet initialized. */
10818 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10821 #ifdef HAVE_WINDOW_SYSTEM
10822 /* When Emacs starts, selected_frame may be the initial terminal
10823 frame. If we let this through, a message would be displayed on
10825 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10827 #endif /* HAVE_WINDOW_SYSTEM */
10829 /* Redraw garbaged frames. */
10830 clear_garbaged_frames ();
10832 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10834 echo_area_window
= mini_window
;
10835 window_height_changed_p
= display_echo_area (w
);
10836 w
->must_be_updated_p
= 1;
10838 /* Update the display, unless called from redisplay_internal.
10839 Also don't update the screen during redisplay itself. The
10840 update will happen at the end of redisplay, and an update
10841 here could cause confusion. */
10842 if (update_frame_p
&& !redisplaying_p
)
10846 /* If the display update has been interrupted by pending
10847 input, update mode lines in the frame. Due to the
10848 pending input, it might have been that redisplay hasn't
10849 been called, so that mode lines above the echo area are
10850 garbaged. This looks odd, so we prevent it here. */
10851 if (!display_completed
)
10852 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10854 if (window_height_changed_p
10855 /* Don't do this if Emacs is shutting down. Redisplay
10856 needs to run hooks. */
10857 && !NILP (Vrun_hooks
))
10859 /* Must update other windows. Likewise as in other
10860 cases, don't let this update be interrupted by
10862 ptrdiff_t count
= SPECPDL_INDEX ();
10863 specbind (Qredisplay_dont_pause
, Qt
);
10864 windows_or_buffers_changed
= 1;
10865 redisplay_internal ();
10866 unbind_to (count
, Qnil
);
10868 else if (FRAME_WINDOW_P (f
) && n
== 0)
10870 /* Window configuration is the same as before.
10871 Can do with a display update of the echo area,
10872 unless we displayed some mode lines. */
10873 update_single_window (w
, 1);
10874 FRAME_RIF (f
)->flush_display (f
);
10877 update_frame (f
, 1, 1);
10879 /* If cursor is in the echo area, make sure that the next
10880 redisplay displays the minibuffer, so that the cursor will
10881 be replaced with what the minibuffer wants. */
10882 if (cursor_in_echo_area
)
10883 ++windows_or_buffers_changed
;
10886 else if (!EQ (mini_window
, selected_window
))
10887 windows_or_buffers_changed
++;
10889 /* Last displayed message is now the current message. */
10890 echo_area_buffer
[1] = echo_area_buffer
[0];
10891 /* Inform read_char that we're not echoing. */
10892 echo_message_buffer
= Qnil
;
10894 /* Prevent redisplay optimization in redisplay_internal by resetting
10895 this_line_start_pos. This is done because the mini-buffer now
10896 displays the message instead of its buffer text. */
10897 if (EQ (mini_window
, selected_window
))
10898 CHARPOS (this_line_start_pos
) = 0;
10900 return window_height_changed_p
;
10903 /* Nonzero if the current window's buffer is shown in more than one
10904 window and was modified since last redisplay. */
10907 buffer_shared_and_changed (void)
10909 return (buffer_window_count (current_buffer
) > 1
10910 && UNCHANGED_MODIFIED
< MODIFF
);
10913 /* Nonzero if W doesn't reflect the actual state of current buffer due
10914 to its text or overlays change. FIXME: this may be called when
10915 XBUFFER (w->buffer) != current_buffer, which looks suspicious. */
10918 window_outdated (struct window
*w
)
10920 return (w
->last_modified
< MODIFF
10921 || w
->last_overlay_modified
< OVERLAY_MODIFF
);
10924 /* Nonzero if W's buffer was changed but not saved or Transient Mark mode
10925 is enabled and mark of W's buffer was changed since last W's update. */
10928 window_buffer_changed (struct window
*w
)
10930 struct buffer
*b
= XBUFFER (w
->buffer
);
10932 eassert (BUFFER_LIVE_P (b
));
10934 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
)
10935 || ((!NILP (Vtransient_mark_mode
) && !NILP (BVAR (b
, mark_active
)))
10936 != !NILP (w
->region_showing
)));
10939 /* Nonzero if W has %c in its mode line and mode line should be updated. */
10942 mode_line_update_needed (struct window
*w
)
10944 return (!NILP (w
->column_number_displayed
)
10945 && !(PT
== w
->last_point
&& !window_outdated (w
))
10946 && (XFASTINT (w
->column_number_displayed
) != current_column ()));
10949 /***********************************************************************
10950 Mode Lines and Frame Titles
10951 ***********************************************************************/
10953 /* A buffer for constructing non-propertized mode-line strings and
10954 frame titles in it; allocated from the heap in init_xdisp and
10955 resized as needed in store_mode_line_noprop_char. */
10957 static char *mode_line_noprop_buf
;
10959 /* The buffer's end, and a current output position in it. */
10961 static char *mode_line_noprop_buf_end
;
10962 static char *mode_line_noprop_ptr
;
10964 #define MODE_LINE_NOPROP_LEN(start) \
10965 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10968 MODE_LINE_DISPLAY
= 0,
10972 } mode_line_target
;
10974 /* Alist that caches the results of :propertize.
10975 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10976 static Lisp_Object mode_line_proptrans_alist
;
10978 /* List of strings making up the mode-line. */
10979 static Lisp_Object mode_line_string_list
;
10981 /* Base face property when building propertized mode line string. */
10982 static Lisp_Object mode_line_string_face
;
10983 static Lisp_Object mode_line_string_face_prop
;
10986 /* Unwind data for mode line strings */
10988 static Lisp_Object Vmode_line_unwind_vector
;
10991 format_mode_line_unwind_data (struct frame
*target_frame
,
10992 struct buffer
*obuf
,
10994 int save_proptrans
)
10996 Lisp_Object vector
, tmp
;
10998 /* Reduce consing by keeping one vector in
10999 Vwith_echo_area_save_vector. */
11000 vector
= Vmode_line_unwind_vector
;
11001 Vmode_line_unwind_vector
= Qnil
;
11004 vector
= Fmake_vector (make_number (10), Qnil
);
11006 ASET (vector
, 0, make_number (mode_line_target
));
11007 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11008 ASET (vector
, 2, mode_line_string_list
);
11009 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11010 ASET (vector
, 4, mode_line_string_face
);
11011 ASET (vector
, 5, mode_line_string_face_prop
);
11014 XSETBUFFER (tmp
, obuf
);
11017 ASET (vector
, 6, tmp
);
11018 ASET (vector
, 7, owin
);
11021 /* Similarly to `with-selected-window', if the operation selects
11022 a window on another frame, we must restore that frame's
11023 selected window, and (for a tty) the top-frame. */
11024 ASET (vector
, 8, target_frame
->selected_window
);
11025 if (FRAME_TERMCAP_P (target_frame
))
11026 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11033 unwind_format_mode_line (Lisp_Object vector
)
11035 Lisp_Object old_window
= AREF (vector
, 7);
11036 Lisp_Object target_frame_window
= AREF (vector
, 8);
11037 Lisp_Object old_top_frame
= AREF (vector
, 9);
11039 mode_line_target
= XINT (AREF (vector
, 0));
11040 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11041 mode_line_string_list
= AREF (vector
, 2);
11042 if (! EQ (AREF (vector
, 3), Qt
))
11043 mode_line_proptrans_alist
= AREF (vector
, 3);
11044 mode_line_string_face
= AREF (vector
, 4);
11045 mode_line_string_face_prop
= AREF (vector
, 5);
11047 /* Select window before buffer, since it may change the buffer. */
11048 if (!NILP (old_window
))
11050 /* If the operation that we are unwinding had selected a window
11051 on a different frame, reset its frame-selected-window. For a
11052 text terminal, reset its top-frame if necessary. */
11053 if (!NILP (target_frame_window
))
11056 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11058 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11059 Fselect_window (target_frame_window
, Qt
);
11061 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11062 Fselect_frame (old_top_frame
, Qt
);
11065 Fselect_window (old_window
, Qt
);
11068 if (!NILP (AREF (vector
, 6)))
11070 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11071 ASET (vector
, 6, Qnil
);
11074 Vmode_line_unwind_vector
= vector
;
11079 /* Store a single character C for the frame title in mode_line_noprop_buf.
11080 Re-allocate mode_line_noprop_buf if necessary. */
11083 store_mode_line_noprop_char (char c
)
11085 /* If output position has reached the end of the allocated buffer,
11086 increase the buffer's size. */
11087 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11089 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11090 ptrdiff_t size
= len
;
11091 mode_line_noprop_buf
=
11092 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11093 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11094 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11097 *mode_line_noprop_ptr
++ = c
;
11101 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11102 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11103 characters that yield more columns than PRECISION; PRECISION <= 0
11104 means copy the whole string. Pad with spaces until FIELD_WIDTH
11105 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11106 pad. Called from display_mode_element when it is used to build a
11110 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11112 const unsigned char *str
= (const unsigned char *) string
;
11114 ptrdiff_t dummy
, nbytes
;
11116 /* Copy at most PRECISION chars from STR. */
11117 nbytes
= strlen (string
);
11118 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11120 store_mode_line_noprop_char (*str
++);
11122 /* Fill up with spaces until FIELD_WIDTH reached. */
11123 while (field_width
> 0
11124 && n
< field_width
)
11126 store_mode_line_noprop_char (' ');
11133 /***********************************************************************
11135 ***********************************************************************/
11137 #ifdef HAVE_WINDOW_SYSTEM
11139 /* Set the title of FRAME, if it has changed. The title format is
11140 Vicon_title_format if FRAME is iconified, otherwise it is
11141 frame_title_format. */
11144 x_consider_frame_title (Lisp_Object frame
)
11146 struct frame
*f
= XFRAME (frame
);
11148 if (FRAME_WINDOW_P (f
)
11149 || FRAME_MINIBUF_ONLY_P (f
)
11150 || f
->explicit_name
)
11152 /* Do we have more than one visible frame on this X display? */
11153 Lisp_Object tail
, other_frame
, fmt
;
11154 ptrdiff_t title_start
;
11158 ptrdiff_t count
= SPECPDL_INDEX ();
11160 FOR_EACH_FRAME (tail
, other_frame
)
11162 struct frame
*tf
= XFRAME (other_frame
);
11165 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11166 && !FRAME_MINIBUF_ONLY_P (tf
)
11167 && !EQ (other_frame
, tip_frame
)
11168 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11172 /* Set global variable indicating that multiple frames exist. */
11173 multiple_frames
= CONSP (tail
);
11175 /* Switch to the buffer of selected window of the frame. Set up
11176 mode_line_target so that display_mode_element will output into
11177 mode_line_noprop_buf; then display the title. */
11178 record_unwind_protect (unwind_format_mode_line
,
11179 format_mode_line_unwind_data
11180 (f
, current_buffer
, selected_window
, 0));
11182 Fselect_window (f
->selected_window
, Qt
);
11183 set_buffer_internal_1
11184 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
11185 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11187 mode_line_target
= MODE_LINE_TITLE
;
11188 title_start
= MODE_LINE_NOPROP_LEN (0);
11189 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11190 NULL
, DEFAULT_FACE_ID
);
11191 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11192 len
= MODE_LINE_NOPROP_LEN (title_start
);
11193 title
= mode_line_noprop_buf
+ title_start
;
11194 unbind_to (count
, Qnil
);
11196 /* Set the title only if it's changed. This avoids consing in
11197 the common case where it hasn't. (If it turns out that we've
11198 already wasted too much time by walking through the list with
11199 display_mode_element, then we might need to optimize at a
11200 higher level than this.) */
11201 if (! STRINGP (f
->name
)
11202 || SBYTES (f
->name
) != len
11203 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11204 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11208 #endif /* not HAVE_WINDOW_SYSTEM */
11211 /***********************************************************************
11213 ***********************************************************************/
11216 /* Prepare for redisplay by updating menu-bar item lists when
11217 appropriate. This can call eval. */
11220 prepare_menu_bars (void)
11223 struct gcpro gcpro1
, gcpro2
;
11225 Lisp_Object tooltip_frame
;
11227 #ifdef HAVE_WINDOW_SYSTEM
11228 tooltip_frame
= tip_frame
;
11230 tooltip_frame
= Qnil
;
11233 /* Update all frame titles based on their buffer names, etc. We do
11234 this before the menu bars so that the buffer-menu will show the
11235 up-to-date frame titles. */
11236 #ifdef HAVE_WINDOW_SYSTEM
11237 if (windows_or_buffers_changed
|| update_mode_lines
)
11239 Lisp_Object tail
, frame
;
11241 FOR_EACH_FRAME (tail
, frame
)
11243 f
= XFRAME (frame
);
11244 if (!EQ (frame
, tooltip_frame
)
11245 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
11246 x_consider_frame_title (frame
);
11249 #endif /* HAVE_WINDOW_SYSTEM */
11251 /* Update the menu bar item lists, if appropriate. This has to be
11252 done before any actual redisplay or generation of display lines. */
11253 all_windows
= (update_mode_lines
11254 || buffer_shared_and_changed ()
11255 || windows_or_buffers_changed
);
11258 Lisp_Object tail
, frame
;
11259 ptrdiff_t count
= SPECPDL_INDEX ();
11260 /* 1 means that update_menu_bar has run its hooks
11261 so any further calls to update_menu_bar shouldn't do so again. */
11262 int menu_bar_hooks_run
= 0;
11264 record_unwind_save_match_data ();
11266 FOR_EACH_FRAME (tail
, frame
)
11268 f
= XFRAME (frame
);
11270 /* Ignore tooltip frame. */
11271 if (EQ (frame
, tooltip_frame
))
11274 /* If a window on this frame changed size, report that to
11275 the user and clear the size-change flag. */
11276 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11278 Lisp_Object functions
;
11280 /* Clear flag first in case we get an error below. */
11281 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11282 functions
= Vwindow_size_change_functions
;
11283 GCPRO2 (tail
, functions
);
11285 while (CONSP (functions
))
11287 if (!EQ (XCAR (functions
), Qt
))
11288 call1 (XCAR (functions
), frame
);
11289 functions
= XCDR (functions
);
11295 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11296 #ifdef HAVE_WINDOW_SYSTEM
11297 update_tool_bar (f
, 0);
11300 if (windows_or_buffers_changed
11303 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->buffer
));
11308 unbind_to (count
, Qnil
);
11312 struct frame
*sf
= SELECTED_FRAME ();
11313 update_menu_bar (sf
, 1, 0);
11314 #ifdef HAVE_WINDOW_SYSTEM
11315 update_tool_bar (sf
, 1);
11321 /* Update the menu bar item list for frame F. This has to be done
11322 before we start to fill in any display lines, because it can call
11325 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11327 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11328 already ran the menu bar hooks for this redisplay, so there
11329 is no need to run them again. The return value is the
11330 updated value of this flag, to pass to the next call. */
11333 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11335 Lisp_Object window
;
11336 register struct window
*w
;
11338 /* If called recursively during a menu update, do nothing. This can
11339 happen when, for instance, an activate-menubar-hook causes a
11341 if (inhibit_menubar_update
)
11344 window
= FRAME_SELECTED_WINDOW (f
);
11345 w
= XWINDOW (window
);
11347 if (FRAME_WINDOW_P (f
)
11349 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11350 || defined (HAVE_NS) || defined (USE_GTK)
11351 FRAME_EXTERNAL_MENU_BAR (f
)
11353 FRAME_MENU_BAR_LINES (f
) > 0
11355 : FRAME_MENU_BAR_LINES (f
) > 0)
11357 /* If the user has switched buffers or windows, we need to
11358 recompute to reflect the new bindings. But we'll
11359 recompute when update_mode_lines is set too; that means
11360 that people can use force-mode-line-update to request
11361 that the menu bar be recomputed. The adverse effect on
11362 the rest of the redisplay algorithm is about the same as
11363 windows_or_buffers_changed anyway. */
11364 if (windows_or_buffers_changed
11365 /* This used to test w->update_mode_line, but we believe
11366 there is no need to recompute the menu in that case. */
11367 || update_mode_lines
11368 || window_buffer_changed (w
))
11370 struct buffer
*prev
= current_buffer
;
11371 ptrdiff_t count
= SPECPDL_INDEX ();
11373 specbind (Qinhibit_menubar_update
, Qt
);
11375 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11376 if (save_match_data
)
11377 record_unwind_save_match_data ();
11378 if (NILP (Voverriding_local_map_menu_flag
))
11380 specbind (Qoverriding_terminal_local_map
, Qnil
);
11381 specbind (Qoverriding_local_map
, Qnil
);
11386 /* Run the Lucid hook. */
11387 safe_run_hooks (Qactivate_menubar_hook
);
11389 /* If it has changed current-menubar from previous value,
11390 really recompute the menu-bar from the value. */
11391 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11392 call0 (Qrecompute_lucid_menubar
);
11394 safe_run_hooks (Qmenu_bar_update_hook
);
11399 XSETFRAME (Vmenu_updating_frame
, f
);
11400 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11402 /* Redisplay the menu bar in case we changed it. */
11403 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11404 || defined (HAVE_NS) || defined (USE_GTK)
11405 if (FRAME_WINDOW_P (f
))
11407 #if defined (HAVE_NS)
11408 /* All frames on Mac OS share the same menubar. So only
11409 the selected frame should be allowed to set it. */
11410 if (f
== SELECTED_FRAME ())
11412 set_frame_menubar (f
, 0, 0);
11415 /* On a terminal screen, the menu bar is an ordinary screen
11416 line, and this makes it get updated. */
11417 w
->update_mode_line
= 1;
11418 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11419 /* In the non-toolkit version, the menu bar is an ordinary screen
11420 line, and this makes it get updated. */
11421 w
->update_mode_line
= 1;
11422 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11424 unbind_to (count
, Qnil
);
11425 set_buffer_internal_1 (prev
);
11434 /***********************************************************************
11436 ***********************************************************************/
11438 #ifdef HAVE_WINDOW_SYSTEM
11441 Nominal cursor position -- where to draw output.
11442 HPOS and VPOS are window relative glyph matrix coordinates.
11443 X and Y are window relative pixel coordinates. */
11445 struct cursor_pos output_cursor
;
11449 Set the global variable output_cursor to CURSOR. All cursor
11450 positions are relative to updated_window. */
11453 set_output_cursor (struct cursor_pos
*cursor
)
11455 output_cursor
.hpos
= cursor
->hpos
;
11456 output_cursor
.vpos
= cursor
->vpos
;
11457 output_cursor
.x
= cursor
->x
;
11458 output_cursor
.y
= cursor
->y
;
11463 Set a nominal cursor position.
11465 HPOS and VPOS are column/row positions in a window glyph matrix. X
11466 and Y are window text area relative pixel positions.
11468 If this is done during an update, updated_window will contain the
11469 window that is being updated and the position is the future output
11470 cursor position for that window. If updated_window is null, use
11471 selected_window and display the cursor at the given position. */
11474 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11478 /* If updated_window is not set, work on selected_window. */
11479 if (updated_window
)
11480 w
= updated_window
;
11482 w
= XWINDOW (selected_window
);
11484 /* Set the output cursor. */
11485 output_cursor
.hpos
= hpos
;
11486 output_cursor
.vpos
= vpos
;
11487 output_cursor
.x
= x
;
11488 output_cursor
.y
= y
;
11490 /* If not called as part of an update, really display the cursor.
11491 This will also set the cursor position of W. */
11492 if (updated_window
== NULL
)
11495 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11496 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11497 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11502 #endif /* HAVE_WINDOW_SYSTEM */
11505 /***********************************************************************
11507 ***********************************************************************/
11509 #ifdef HAVE_WINDOW_SYSTEM
11511 /* Where the mouse was last time we reported a mouse event. */
11513 FRAME_PTR last_mouse_frame
;
11515 /* Tool-bar item index of the item on which a mouse button was pressed
11518 int last_tool_bar_item
;
11520 /* Select `frame' temporarily without running all the code in
11522 FIXME: Maybe do_switch_frame should be trimmed down similarly
11523 when `norecord' is set. */
11525 fast_set_selected_frame (Lisp_Object frame
)
11527 if (!EQ (selected_frame
, frame
))
11529 selected_frame
= frame
;
11530 selected_window
= XFRAME (frame
)->selected_window
;
11535 /* Update the tool-bar item list for frame F. This has to be done
11536 before we start to fill in any display lines. Called from
11537 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11538 and restore it here. */
11541 update_tool_bar (struct frame
*f
, int save_match_data
)
11543 #if defined (USE_GTK) || defined (HAVE_NS)
11544 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11546 int do_update
= WINDOWP (f
->tool_bar_window
)
11547 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11552 Lisp_Object window
;
11555 window
= FRAME_SELECTED_WINDOW (f
);
11556 w
= XWINDOW (window
);
11558 /* If the user has switched buffers or windows, we need to
11559 recompute to reflect the new bindings. But we'll
11560 recompute when update_mode_lines is set too; that means
11561 that people can use force-mode-line-update to request
11562 that the menu bar be recomputed. The adverse effect on
11563 the rest of the redisplay algorithm is about the same as
11564 windows_or_buffers_changed anyway. */
11565 if (windows_or_buffers_changed
11566 || w
->update_mode_line
11567 || update_mode_lines
11568 || window_buffer_changed (w
))
11570 struct buffer
*prev
= current_buffer
;
11571 ptrdiff_t count
= SPECPDL_INDEX ();
11572 Lisp_Object frame
, new_tool_bar
;
11573 int new_n_tool_bar
;
11574 struct gcpro gcpro1
;
11576 /* Set current_buffer to the buffer of the selected
11577 window of the frame, so that we get the right local
11579 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11581 /* Save match data, if we must. */
11582 if (save_match_data
)
11583 record_unwind_save_match_data ();
11585 /* Make sure that we don't accidentally use bogus keymaps. */
11586 if (NILP (Voverriding_local_map_menu_flag
))
11588 specbind (Qoverriding_terminal_local_map
, Qnil
);
11589 specbind (Qoverriding_local_map
, Qnil
);
11592 GCPRO1 (new_tool_bar
);
11594 /* We must temporarily set the selected frame to this frame
11595 before calling tool_bar_items, because the calculation of
11596 the tool-bar keymap uses the selected frame (see
11597 `tool-bar-make-keymap' in tool-bar.el). */
11598 eassert (EQ (selected_window
,
11599 /* Since we only explicitly preserve selected_frame,
11600 check that selected_window would be redundant. */
11601 XFRAME (selected_frame
)->selected_window
));
11602 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11603 XSETFRAME (frame
, f
);
11604 fast_set_selected_frame (frame
);
11606 /* Build desired tool-bar items from keymaps. */
11608 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11611 /* Redisplay the tool-bar if we changed it. */
11612 if (new_n_tool_bar
!= f
->n_tool_bar_items
11613 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11615 /* Redisplay that happens asynchronously due to an expose event
11616 may access f->tool_bar_items. Make sure we update both
11617 variables within BLOCK_INPUT so no such event interrupts. */
11619 fset_tool_bar_items (f
, new_tool_bar
);
11620 f
->n_tool_bar_items
= new_n_tool_bar
;
11621 w
->update_mode_line
= 1;
11627 unbind_to (count
, Qnil
);
11628 set_buffer_internal_1 (prev
);
11634 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11635 F's desired tool-bar contents. F->tool_bar_items must have
11636 been set up previously by calling prepare_menu_bars. */
11639 build_desired_tool_bar_string (struct frame
*f
)
11641 int i
, size
, size_needed
;
11642 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11643 Lisp_Object image
, plist
, props
;
11645 image
= plist
= props
= Qnil
;
11646 GCPRO3 (image
, plist
, props
);
11648 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11649 Otherwise, make a new string. */
11651 /* The size of the string we might be able to reuse. */
11652 size
= (STRINGP (f
->desired_tool_bar_string
)
11653 ? SCHARS (f
->desired_tool_bar_string
)
11656 /* We need one space in the string for each image. */
11657 size_needed
= f
->n_tool_bar_items
;
11659 /* Reuse f->desired_tool_bar_string, if possible. */
11660 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11661 fset_desired_tool_bar_string
11662 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11665 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11666 Fremove_text_properties (make_number (0), make_number (size
),
11667 props
, f
->desired_tool_bar_string
);
11670 /* Put a `display' property on the string for the images to display,
11671 put a `menu_item' property on tool-bar items with a value that
11672 is the index of the item in F's tool-bar item vector. */
11673 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11675 #define PROP(IDX) \
11676 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11678 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11679 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11680 int hmargin
, vmargin
, relief
, idx
, end
;
11682 /* If image is a vector, choose the image according to the
11684 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11685 if (VECTORP (image
))
11689 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11690 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11693 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11694 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11696 eassert (ASIZE (image
) >= idx
);
11697 image
= AREF (image
, idx
);
11702 /* Ignore invalid image specifications. */
11703 if (!valid_image_p (image
))
11706 /* Display the tool-bar button pressed, or depressed. */
11707 plist
= Fcopy_sequence (XCDR (image
));
11709 /* Compute margin and relief to draw. */
11710 relief
= (tool_bar_button_relief
>= 0
11711 ? tool_bar_button_relief
11712 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11713 hmargin
= vmargin
= relief
;
11715 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11716 INT_MAX
- max (hmargin
, vmargin
)))
11718 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11719 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11721 else if (CONSP (Vtool_bar_button_margin
))
11723 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11724 INT_MAX
- hmargin
))
11725 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11727 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11728 INT_MAX
- vmargin
))
11729 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11732 if (auto_raise_tool_bar_buttons_p
)
11734 /* Add a `:relief' property to the image spec if the item is
11738 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11745 /* If image is selected, display it pressed, i.e. with a
11746 negative relief. If it's not selected, display it with a
11748 plist
= Fplist_put (plist
, QCrelief
,
11750 ? make_number (-relief
)
11751 : make_number (relief
)));
11756 /* Put a margin around the image. */
11757 if (hmargin
|| vmargin
)
11759 if (hmargin
== vmargin
)
11760 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11762 plist
= Fplist_put (plist
, QCmargin
,
11763 Fcons (make_number (hmargin
),
11764 make_number (vmargin
)));
11767 /* If button is not enabled, and we don't have special images
11768 for the disabled state, make the image appear disabled by
11769 applying an appropriate algorithm to it. */
11770 if (!enabled_p
&& idx
< 0)
11771 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11773 /* Put a `display' text property on the string for the image to
11774 display. Put a `menu-item' property on the string that gives
11775 the start of this item's properties in the tool-bar items
11777 image
= Fcons (Qimage
, plist
);
11778 props
= list4 (Qdisplay
, image
,
11779 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11781 /* Let the last image hide all remaining spaces in the tool bar
11782 string. The string can be longer than needed when we reuse a
11783 previous string. */
11784 if (i
+ 1 == f
->n_tool_bar_items
)
11785 end
= SCHARS (f
->desired_tool_bar_string
);
11788 Fadd_text_properties (make_number (i
), make_number (end
),
11789 props
, f
->desired_tool_bar_string
);
11797 /* Display one line of the tool-bar of frame IT->f.
11799 HEIGHT specifies the desired height of the tool-bar line.
11800 If the actual height of the glyph row is less than HEIGHT, the
11801 row's height is increased to HEIGHT, and the icons are centered
11802 vertically in the new height.
11804 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11805 count a final empty row in case the tool-bar width exactly matches
11810 display_tool_bar_line (struct it
*it
, int height
)
11812 struct glyph_row
*row
= it
->glyph_row
;
11813 int max_x
= it
->last_visible_x
;
11814 struct glyph
*last
;
11816 prepare_desired_row (row
);
11817 row
->y
= it
->current_y
;
11819 /* Note that this isn't made use of if the face hasn't a box,
11820 so there's no need to check the face here. */
11821 it
->start_of_box_run_p
= 1;
11823 while (it
->current_x
< max_x
)
11825 int x
, n_glyphs_before
, i
, nglyphs
;
11826 struct it it_before
;
11828 /* Get the next display element. */
11829 if (!get_next_display_element (it
))
11831 /* Don't count empty row if we are counting needed tool-bar lines. */
11832 if (height
< 0 && !it
->hpos
)
11837 /* Produce glyphs. */
11838 n_glyphs_before
= row
->used
[TEXT_AREA
];
11841 PRODUCE_GLYPHS (it
);
11843 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11845 x
= it_before
.current_x
;
11846 while (i
< nglyphs
)
11848 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11850 if (x
+ glyph
->pixel_width
> max_x
)
11852 /* Glyph doesn't fit on line. Backtrack. */
11853 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11855 /* If this is the only glyph on this line, it will never fit on the
11856 tool-bar, so skip it. But ensure there is at least one glyph,
11857 so we don't accidentally disable the tool-bar. */
11858 if (n_glyphs_before
== 0
11859 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11865 x
+= glyph
->pixel_width
;
11869 /* Stop at line end. */
11870 if (ITERATOR_AT_END_OF_LINE_P (it
))
11873 set_iterator_to_next (it
, 1);
11878 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11880 /* Use default face for the border below the tool bar.
11882 FIXME: When auto-resize-tool-bars is grow-only, there is
11883 no additional border below the possibly empty tool-bar lines.
11884 So to make the extra empty lines look "normal", we have to
11885 use the tool-bar face for the border too. */
11886 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11887 it
->face_id
= DEFAULT_FACE_ID
;
11889 extend_face_to_end_of_line (it
);
11890 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11891 last
->right_box_line_p
= 1;
11892 if (last
== row
->glyphs
[TEXT_AREA
])
11893 last
->left_box_line_p
= 1;
11895 /* Make line the desired height and center it vertically. */
11896 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11898 /* Don't add more than one line height. */
11899 height
%= FRAME_LINE_HEIGHT (it
->f
);
11900 it
->max_ascent
+= height
/ 2;
11901 it
->max_descent
+= (height
+ 1) / 2;
11904 compute_line_metrics (it
);
11906 /* If line is empty, make it occupy the rest of the tool-bar. */
11907 if (!row
->displays_text_p
)
11909 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11910 row
->visible_height
= row
->height
;
11911 row
->ascent
= row
->phys_ascent
= 0;
11912 row
->extra_line_spacing
= 0;
11915 row
->full_width_p
= 1;
11916 row
->continued_p
= 0;
11917 row
->truncated_on_left_p
= 0;
11918 row
->truncated_on_right_p
= 0;
11920 it
->current_x
= it
->hpos
= 0;
11921 it
->current_y
+= row
->height
;
11927 /* Max tool-bar height. */
11929 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11930 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11932 /* Value is the number of screen lines needed to make all tool-bar
11933 items of frame F visible. The number of actual rows needed is
11934 returned in *N_ROWS if non-NULL. */
11937 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11939 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11941 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11942 the desired matrix, so use (unused) mode-line row as temporary row to
11943 avoid destroying the first tool-bar row. */
11944 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11946 /* Initialize an iterator for iteration over
11947 F->desired_tool_bar_string in the tool-bar window of frame F. */
11948 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11949 it
.first_visible_x
= 0;
11950 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11951 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11952 it
.paragraph_embedding
= L2R
;
11954 while (!ITERATOR_AT_END_P (&it
))
11956 clear_glyph_row (temp_row
);
11957 it
.glyph_row
= temp_row
;
11958 display_tool_bar_line (&it
, -1);
11960 clear_glyph_row (temp_row
);
11962 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11964 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11966 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11970 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11972 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
11973 If FRAME is nil or omitted, use the selected frame. */)
11974 (Lisp_Object frame
)
11976 struct frame
*f
= decode_any_frame (frame
);
11980 if (WINDOWP (f
->tool_bar_window
)
11981 && (w
= XWINDOW (f
->tool_bar_window
),
11982 WINDOW_TOTAL_LINES (w
) > 0))
11984 update_tool_bar (f
, 1);
11985 if (f
->n_tool_bar_items
)
11987 build_desired_tool_bar_string (f
);
11988 nlines
= tool_bar_lines_needed (f
, NULL
);
11992 return make_number (nlines
);
11996 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11997 height should be changed. */
12000 redisplay_tool_bar (struct frame
*f
)
12004 struct glyph_row
*row
;
12006 #if defined (USE_GTK) || defined (HAVE_NS)
12007 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12008 update_frame_tool_bar (f
);
12012 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12013 do anything. This means you must start with tool-bar-lines
12014 non-zero to get the auto-sizing effect. Or in other words, you
12015 can turn off tool-bars by specifying tool-bar-lines zero. */
12016 if (!WINDOWP (f
->tool_bar_window
)
12017 || (w
= XWINDOW (f
->tool_bar_window
),
12018 WINDOW_TOTAL_LINES (w
) == 0))
12021 /* Set up an iterator for the tool-bar window. */
12022 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12023 it
.first_visible_x
= 0;
12024 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
12025 row
= it
.glyph_row
;
12027 /* Build a string that represents the contents of the tool-bar. */
12028 build_desired_tool_bar_string (f
);
12029 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12030 /* FIXME: This should be controlled by a user option. But it
12031 doesn't make sense to have an R2L tool bar if the menu bar cannot
12032 be drawn also R2L, and making the menu bar R2L is tricky due
12033 toolkit-specific code that implements it. If an R2L tool bar is
12034 ever supported, display_tool_bar_line should also be augmented to
12035 call unproduce_glyphs like display_line and display_string
12037 it
.paragraph_embedding
= L2R
;
12039 if (f
->n_tool_bar_rows
== 0)
12043 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
12044 nlines
!= WINDOW_TOTAL_LINES (w
)))
12047 int old_height
= WINDOW_TOTAL_LINES (w
);
12049 XSETFRAME (frame
, f
);
12050 Fmodify_frame_parameters (frame
,
12051 Fcons (Fcons (Qtool_bar_lines
,
12052 make_number (nlines
)),
12054 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12056 clear_glyph_matrix (w
->desired_matrix
);
12057 fonts_changed_p
= 1;
12063 /* Display as many lines as needed to display all tool-bar items. */
12065 if (f
->n_tool_bar_rows
> 0)
12067 int border
, rows
, height
, extra
;
12069 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12070 border
= XINT (Vtool_bar_border
);
12071 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12072 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12073 else if (EQ (Vtool_bar_border
, Qborder_width
))
12074 border
= f
->border_width
;
12080 rows
= f
->n_tool_bar_rows
;
12081 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12082 extra
= it
.last_visible_y
- border
- height
* rows
;
12084 while (it
.current_y
< it
.last_visible_y
)
12087 if (extra
> 0 && rows
-- > 0)
12089 h
= (extra
+ rows
- 1) / rows
;
12092 display_tool_bar_line (&it
, height
+ h
);
12097 while (it
.current_y
< it
.last_visible_y
)
12098 display_tool_bar_line (&it
, 0);
12101 /* It doesn't make much sense to try scrolling in the tool-bar
12102 window, so don't do it. */
12103 w
->desired_matrix
->no_scrolling_p
= 1;
12104 w
->must_be_updated_p
= 1;
12106 if (!NILP (Vauto_resize_tool_bars
))
12108 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12109 int change_height_p
= 0;
12111 /* If we couldn't display everything, change the tool-bar's
12112 height if there is room for more. */
12113 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12114 && it
.current_y
< max_tool_bar_height
)
12115 change_height_p
= 1;
12117 row
= it
.glyph_row
- 1;
12119 /* If there are blank lines at the end, except for a partially
12120 visible blank line at the end that is smaller than
12121 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12122 if (!row
->displays_text_p
12123 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12124 change_height_p
= 1;
12126 /* If row displays tool-bar items, but is partially visible,
12127 change the tool-bar's height. */
12128 if (row
->displays_text_p
12129 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12130 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12131 change_height_p
= 1;
12133 /* Resize windows as needed by changing the `tool-bar-lines'
12134 frame parameter. */
12135 if (change_height_p
)
12138 int old_height
= WINDOW_TOTAL_LINES (w
);
12140 int nlines
= tool_bar_lines_needed (f
, &nrows
);
12142 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12143 && !f
->minimize_tool_bar_window_p
)
12144 ? (nlines
> old_height
)
12145 : (nlines
!= old_height
));
12146 f
->minimize_tool_bar_window_p
= 0;
12148 if (change_height_p
)
12150 XSETFRAME (frame
, f
);
12151 Fmodify_frame_parameters (frame
,
12152 Fcons (Fcons (Qtool_bar_lines
,
12153 make_number (nlines
)),
12155 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12157 clear_glyph_matrix (w
->desired_matrix
);
12158 f
->n_tool_bar_rows
= nrows
;
12159 fonts_changed_p
= 1;
12166 f
->minimize_tool_bar_window_p
= 0;
12171 /* Get information about the tool-bar item which is displayed in GLYPH
12172 on frame F. Return in *PROP_IDX the index where tool-bar item
12173 properties start in F->tool_bar_items. Value is zero if
12174 GLYPH doesn't display a tool-bar item. */
12177 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12183 /* This function can be called asynchronously, which means we must
12184 exclude any possibility that Fget_text_property signals an
12186 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12187 charpos
= max (0, charpos
);
12189 /* Get the text property `menu-item' at pos. The value of that
12190 property is the start index of this item's properties in
12191 F->tool_bar_items. */
12192 prop
= Fget_text_property (make_number (charpos
),
12193 Qmenu_item
, f
->current_tool_bar_string
);
12194 if (INTEGERP (prop
))
12196 *prop_idx
= XINT (prop
);
12206 /* Get information about the tool-bar item at position X/Y on frame F.
12207 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12208 the current matrix of the tool-bar window of F, or NULL if not
12209 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12210 item in F->tool_bar_items. Value is
12212 -1 if X/Y is not on a tool-bar item
12213 0 if X/Y is on the same item that was highlighted before.
12217 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12218 int *hpos
, int *vpos
, int *prop_idx
)
12220 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12221 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12224 /* Find the glyph under X/Y. */
12225 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12226 if (*glyph
== NULL
)
12229 /* Get the start of this tool-bar item's properties in
12230 f->tool_bar_items. */
12231 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12234 /* Is mouse on the highlighted item? */
12235 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12236 && *vpos
>= hlinfo
->mouse_face_beg_row
12237 && *vpos
<= hlinfo
->mouse_face_end_row
12238 && (*vpos
> hlinfo
->mouse_face_beg_row
12239 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12240 && (*vpos
< hlinfo
->mouse_face_end_row
12241 || *hpos
< hlinfo
->mouse_face_end_col
12242 || hlinfo
->mouse_face_past_end
))
12250 Handle mouse button event on the tool-bar of frame F, at
12251 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12252 0 for button release. MODIFIERS is event modifiers for button
12256 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12259 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12260 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12261 int hpos
, vpos
, prop_idx
;
12262 struct glyph
*glyph
;
12263 Lisp_Object enabled_p
;
12265 /* If not on the highlighted tool-bar item, return. */
12266 frame_to_window_pixel_xy (w
, &x
, &y
);
12267 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12270 /* If item is disabled, do nothing. */
12271 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12272 if (NILP (enabled_p
))
12277 /* Show item in pressed state. */
12278 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12279 last_tool_bar_item
= prop_idx
;
12283 Lisp_Object key
, frame
;
12284 struct input_event event
;
12285 EVENT_INIT (event
);
12287 /* Show item in released state. */
12288 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12290 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12292 XSETFRAME (frame
, f
);
12293 event
.kind
= TOOL_BAR_EVENT
;
12294 event
.frame_or_window
= frame
;
12296 kbd_buffer_store_event (&event
);
12298 event
.kind
= TOOL_BAR_EVENT
;
12299 event
.frame_or_window
= frame
;
12301 event
.modifiers
= modifiers
;
12302 kbd_buffer_store_event (&event
);
12303 last_tool_bar_item
= -1;
12308 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12309 tool-bar window-relative coordinates X/Y. Called from
12310 note_mouse_highlight. */
12313 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12315 Lisp_Object window
= f
->tool_bar_window
;
12316 struct window
*w
= XWINDOW (window
);
12317 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12318 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12320 struct glyph
*glyph
;
12321 struct glyph_row
*row
;
12323 Lisp_Object enabled_p
;
12325 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12326 int mouse_down_p
, rc
;
12328 /* Function note_mouse_highlight is called with negative X/Y
12329 values when mouse moves outside of the frame. */
12330 if (x
<= 0 || y
<= 0)
12332 clear_mouse_face (hlinfo
);
12336 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12339 /* Not on tool-bar item. */
12340 clear_mouse_face (hlinfo
);
12344 /* On same tool-bar item as before. */
12345 goto set_help_echo
;
12347 clear_mouse_face (hlinfo
);
12349 /* Mouse is down, but on different tool-bar item? */
12350 mouse_down_p
= (dpyinfo
->grabbed
12351 && f
== last_mouse_frame
12352 && FRAME_LIVE_P (f
));
12354 && last_tool_bar_item
!= prop_idx
)
12357 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12359 /* If tool-bar item is not enabled, don't highlight it. */
12360 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12361 if (!NILP (enabled_p
))
12363 /* Compute the x-position of the glyph. In front and past the
12364 image is a space. We include this in the highlighted area. */
12365 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12366 for (i
= x
= 0; i
< hpos
; ++i
)
12367 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12369 /* Record this as the current active region. */
12370 hlinfo
->mouse_face_beg_col
= hpos
;
12371 hlinfo
->mouse_face_beg_row
= vpos
;
12372 hlinfo
->mouse_face_beg_x
= x
;
12373 hlinfo
->mouse_face_beg_y
= row
->y
;
12374 hlinfo
->mouse_face_past_end
= 0;
12376 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12377 hlinfo
->mouse_face_end_row
= vpos
;
12378 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12379 hlinfo
->mouse_face_end_y
= row
->y
;
12380 hlinfo
->mouse_face_window
= window
;
12381 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12383 /* Display it as active. */
12384 show_mouse_face (hlinfo
, draw
);
12389 /* Set help_echo_string to a help string to display for this tool-bar item.
12390 XTread_socket does the rest. */
12391 help_echo_object
= help_echo_window
= Qnil
;
12392 help_echo_pos
= -1;
12393 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12394 if (NILP (help_echo_string
))
12395 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12398 #endif /* HAVE_WINDOW_SYSTEM */
12402 /************************************************************************
12403 Horizontal scrolling
12404 ************************************************************************/
12406 static int hscroll_window_tree (Lisp_Object
);
12407 static int hscroll_windows (Lisp_Object
);
12409 /* For all leaf windows in the window tree rooted at WINDOW, set their
12410 hscroll value so that PT is (i) visible in the window, and (ii) so
12411 that it is not within a certain margin at the window's left and
12412 right border. Value is non-zero if any window's hscroll has been
12416 hscroll_window_tree (Lisp_Object window
)
12418 int hscrolled_p
= 0;
12419 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12420 int hscroll_step_abs
= 0;
12421 double hscroll_step_rel
= 0;
12423 if (hscroll_relative_p
)
12425 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12426 if (hscroll_step_rel
< 0)
12428 hscroll_relative_p
= 0;
12429 hscroll_step_abs
= 0;
12432 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12434 hscroll_step_abs
= XINT (Vhscroll_step
);
12435 if (hscroll_step_abs
< 0)
12436 hscroll_step_abs
= 0;
12439 hscroll_step_abs
= 0;
12441 while (WINDOWP (window
))
12443 struct window
*w
= XWINDOW (window
);
12445 if (WINDOWP (w
->hchild
))
12446 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12447 else if (WINDOWP (w
->vchild
))
12448 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12449 else if (w
->cursor
.vpos
>= 0)
12452 int text_area_width
;
12453 struct glyph_row
*current_cursor_row
12454 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12455 struct glyph_row
*desired_cursor_row
12456 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12457 struct glyph_row
*cursor_row
12458 = (desired_cursor_row
->enabled_p
12459 ? desired_cursor_row
12460 : current_cursor_row
);
12461 int row_r2l_p
= cursor_row
->reversed_p
;
12463 text_area_width
= window_box_width (w
, TEXT_AREA
);
12465 /* Scroll when cursor is inside this scroll margin. */
12466 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12468 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12469 /* For left-to-right rows, hscroll when cursor is either
12470 (i) inside the right hscroll margin, or (ii) if it is
12471 inside the left margin and the window is already
12475 && w
->cursor
.x
<= h_margin
)
12476 || (cursor_row
->enabled_p
12477 && cursor_row
->truncated_on_right_p
12478 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12479 /* For right-to-left rows, the logic is similar,
12480 except that rules for scrolling to left and right
12481 are reversed. E.g., if cursor.x <= h_margin, we
12482 need to hscroll "to the right" unconditionally,
12483 and that will scroll the screen to the left so as
12484 to reveal the next portion of the row. */
12486 && ((cursor_row
->enabled_p
12487 /* FIXME: It is confusing to set the
12488 truncated_on_right_p flag when R2L rows
12489 are actually truncated on the left. */
12490 && cursor_row
->truncated_on_right_p
12491 && w
->cursor
.x
<= h_margin
)
12493 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12497 struct buffer
*saved_current_buffer
;
12501 /* Find point in a display of infinite width. */
12502 saved_current_buffer
= current_buffer
;
12503 current_buffer
= XBUFFER (w
->buffer
);
12505 if (w
== XWINDOW (selected_window
))
12508 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12510 /* Move iterator to pt starting at cursor_row->start in
12511 a line with infinite width. */
12512 init_to_row_start (&it
, w
, cursor_row
);
12513 it
.last_visible_x
= INFINITY
;
12514 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12515 current_buffer
= saved_current_buffer
;
12517 /* Position cursor in window. */
12518 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12519 hscroll
= max (0, (it
.current_x
12520 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12521 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12522 : (text_area_width
/ 2))))
12523 / FRAME_COLUMN_WIDTH (it
.f
);
12524 else if ((!row_r2l_p
12525 && w
->cursor
.x
>= text_area_width
- h_margin
)
12526 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12528 if (hscroll_relative_p
)
12529 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12532 wanted_x
= text_area_width
12533 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12536 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12540 if (hscroll_relative_p
)
12541 wanted_x
= text_area_width
* hscroll_step_rel
12544 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12547 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12549 hscroll
= max (hscroll
, w
->min_hscroll
);
12551 /* Don't prevent redisplay optimizations if hscroll
12552 hasn't changed, as it will unnecessarily slow down
12554 if (w
->hscroll
!= hscroll
)
12556 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12557 w
->hscroll
= hscroll
;
12566 /* Value is non-zero if hscroll of any leaf window has been changed. */
12567 return hscrolled_p
;
12571 /* Set hscroll so that cursor is visible and not inside horizontal
12572 scroll margins for all windows in the tree rooted at WINDOW. See
12573 also hscroll_window_tree above. Value is non-zero if any window's
12574 hscroll has been changed. If it has, desired matrices on the frame
12575 of WINDOW are cleared. */
12578 hscroll_windows (Lisp_Object window
)
12580 int hscrolled_p
= hscroll_window_tree (window
);
12582 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12583 return hscrolled_p
;
12588 /************************************************************************
12590 ************************************************************************/
12592 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12593 to a non-zero value. This is sometimes handy to have in a debugger
12598 /* First and last unchanged row for try_window_id. */
12600 static int debug_first_unchanged_at_end_vpos
;
12601 static int debug_last_unchanged_at_beg_vpos
;
12603 /* Delta vpos and y. */
12605 static int debug_dvpos
, debug_dy
;
12607 /* Delta in characters and bytes for try_window_id. */
12609 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12611 /* Values of window_end_pos and window_end_vpos at the end of
12614 static ptrdiff_t debug_end_vpos
;
12616 /* Append a string to W->desired_matrix->method. FMT is a printf
12617 format string. If trace_redisplay_p is non-zero also printf the
12618 resulting string to stderr. */
12620 static void debug_method_add (struct window
*, char const *, ...)
12621 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12624 debug_method_add (struct window
*w
, char const *fmt
, ...)
12626 char *method
= w
->desired_matrix
->method
;
12627 int len
= strlen (method
);
12628 int size
= sizeof w
->desired_matrix
->method
;
12629 int remaining
= size
- len
- 1;
12632 if (len
&& remaining
)
12635 --remaining
, ++len
;
12638 va_start (ap
, fmt
);
12639 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12642 if (trace_redisplay_p
)
12643 fprintf (stderr
, "%p (%s): %s\n",
12645 ((BUFFERP (w
->buffer
)
12646 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12647 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12652 #endif /* GLYPH_DEBUG */
12655 /* Value is non-zero if all changes in window W, which displays
12656 current_buffer, are in the text between START and END. START is a
12657 buffer position, END is given as a distance from Z. Used in
12658 redisplay_internal for display optimization. */
12661 text_outside_line_unchanged_p (struct window
*w
,
12662 ptrdiff_t start
, ptrdiff_t end
)
12664 int unchanged_p
= 1;
12666 /* If text or overlays have changed, see where. */
12667 if (window_outdated (w
))
12669 /* Gap in the line? */
12670 if (GPT
< start
|| Z
- GPT
< end
)
12673 /* Changes start in front of the line, or end after it? */
12675 && (BEG_UNCHANGED
< start
- 1
12676 || END_UNCHANGED
< end
))
12679 /* If selective display, can't optimize if changes start at the
12680 beginning of the line. */
12682 && INTEGERP (BVAR (current_buffer
, selective_display
))
12683 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12684 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12687 /* If there are overlays at the start or end of the line, these
12688 may have overlay strings with newlines in them. A change at
12689 START, for instance, may actually concern the display of such
12690 overlay strings as well, and they are displayed on different
12691 lines. So, quickly rule out this case. (For the future, it
12692 might be desirable to implement something more telling than
12693 just BEG/END_UNCHANGED.) */
12696 if (BEG
+ BEG_UNCHANGED
== start
12697 && overlay_touches_p (start
))
12699 if (END_UNCHANGED
== end
12700 && overlay_touches_p (Z
- end
))
12704 /* Under bidi reordering, adding or deleting a character in the
12705 beginning of a paragraph, before the first strong directional
12706 character, can change the base direction of the paragraph (unless
12707 the buffer specifies a fixed paragraph direction), which will
12708 require to redisplay the whole paragraph. It might be worthwhile
12709 to find the paragraph limits and widen the range of redisplayed
12710 lines to that, but for now just give up this optimization. */
12711 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12712 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12716 return unchanged_p
;
12720 /* Do a frame update, taking possible shortcuts into account. This is
12721 the main external entry point for redisplay.
12723 If the last redisplay displayed an echo area message and that message
12724 is no longer requested, we clear the echo area or bring back the
12725 mini-buffer if that is in use. */
12730 redisplay_internal ();
12735 overlay_arrow_string_or_property (Lisp_Object var
)
12739 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12742 return Voverlay_arrow_string
;
12745 /* Return 1 if there are any overlay-arrows in current_buffer. */
12747 overlay_arrow_in_current_buffer_p (void)
12751 for (vlist
= Voverlay_arrow_variable_list
;
12753 vlist
= XCDR (vlist
))
12755 Lisp_Object var
= XCAR (vlist
);
12758 if (!SYMBOLP (var
))
12760 val
= find_symbol_value (var
);
12762 && current_buffer
== XMARKER (val
)->buffer
)
12769 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12773 overlay_arrows_changed_p (void)
12777 for (vlist
= Voverlay_arrow_variable_list
;
12779 vlist
= XCDR (vlist
))
12781 Lisp_Object var
= XCAR (vlist
);
12782 Lisp_Object val
, pstr
;
12784 if (!SYMBOLP (var
))
12786 val
= find_symbol_value (var
);
12787 if (!MARKERP (val
))
12789 if (! EQ (COERCE_MARKER (val
),
12790 Fget (var
, Qlast_arrow_position
))
12791 || ! (pstr
= overlay_arrow_string_or_property (var
),
12792 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12798 /* Mark overlay arrows to be updated on next redisplay. */
12801 update_overlay_arrows (int up_to_date
)
12805 for (vlist
= Voverlay_arrow_variable_list
;
12807 vlist
= XCDR (vlist
))
12809 Lisp_Object var
= XCAR (vlist
);
12811 if (!SYMBOLP (var
))
12814 if (up_to_date
> 0)
12816 Lisp_Object val
= find_symbol_value (var
);
12817 Fput (var
, Qlast_arrow_position
,
12818 COERCE_MARKER (val
));
12819 Fput (var
, Qlast_arrow_string
,
12820 overlay_arrow_string_or_property (var
));
12822 else if (up_to_date
< 0
12823 || !NILP (Fget (var
, Qlast_arrow_position
)))
12825 Fput (var
, Qlast_arrow_position
, Qt
);
12826 Fput (var
, Qlast_arrow_string
, Qt
);
12832 /* Return overlay arrow string to display at row.
12833 Return integer (bitmap number) for arrow bitmap in left fringe.
12834 Return nil if no overlay arrow. */
12837 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12841 for (vlist
= Voverlay_arrow_variable_list
;
12843 vlist
= XCDR (vlist
))
12845 Lisp_Object var
= XCAR (vlist
);
12848 if (!SYMBOLP (var
))
12851 val
= find_symbol_value (var
);
12854 && current_buffer
== XMARKER (val
)->buffer
12855 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12857 if (FRAME_WINDOW_P (it
->f
)
12858 /* FIXME: if ROW->reversed_p is set, this should test
12859 the right fringe, not the left one. */
12860 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12862 #ifdef HAVE_WINDOW_SYSTEM
12863 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12866 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12867 return make_number (fringe_bitmap
);
12870 return make_number (-1); /* Use default arrow bitmap. */
12872 return overlay_arrow_string_or_property (var
);
12879 /* Return 1 if point moved out of or into a composition. Otherwise
12880 return 0. PREV_BUF and PREV_PT are the last point buffer and
12881 position. BUF and PT are the current point buffer and position. */
12884 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12885 struct buffer
*buf
, ptrdiff_t pt
)
12887 ptrdiff_t start
, end
;
12889 Lisp_Object buffer
;
12891 XSETBUFFER (buffer
, buf
);
12892 /* Check a composition at the last point if point moved within the
12894 if (prev_buf
== buf
)
12897 /* Point didn't move. */
12900 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12901 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12902 && COMPOSITION_VALID_P (start
, end
, prop
)
12903 && start
< prev_pt
&& end
> prev_pt
)
12904 /* The last point was within the composition. Return 1 iff
12905 point moved out of the composition. */
12906 return (pt
<= start
|| pt
>= end
);
12909 /* Check a composition at the current point. */
12910 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12911 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12912 && COMPOSITION_VALID_P (start
, end
, prop
)
12913 && start
< pt
&& end
> pt
);
12917 /* Reconsider the setting of B->clip_changed which is displayed
12921 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12923 if (b
->clip_changed
12924 && !NILP (w
->window_end_valid
)
12925 && w
->current_matrix
->buffer
== b
12926 && w
->current_matrix
->zv
== BUF_ZV (b
)
12927 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12928 b
->clip_changed
= 0;
12930 /* If display wasn't paused, and W is not a tool bar window, see if
12931 point has been moved into or out of a composition. In that case,
12932 we set b->clip_changed to 1 to force updating the screen. If
12933 b->clip_changed has already been set to 1, we can skip this
12935 if (!b
->clip_changed
12936 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12940 if (w
== XWINDOW (selected_window
))
12943 pt
= marker_position (w
->pointm
);
12945 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12946 || pt
!= w
->last_point
)
12947 && check_point_in_composition (w
->current_matrix
->buffer
,
12949 XBUFFER (w
->buffer
), pt
))
12950 b
->clip_changed
= 1;
12955 #define STOP_POLLING \
12956 do { if (! polling_stopped_here) stop_polling (); \
12957 polling_stopped_here = 1; } while (0)
12959 #define RESUME_POLLING \
12960 do { if (polling_stopped_here) start_polling (); \
12961 polling_stopped_here = 0; } while (0)
12964 /* Perhaps in the future avoid recentering windows if it
12965 is not necessary; currently that causes some problems. */
12968 redisplay_internal (void)
12970 struct window
*w
= XWINDOW (selected_window
);
12974 int must_finish
= 0;
12975 struct text_pos tlbufpos
, tlendpos
;
12976 int number_of_visible_frames
;
12977 ptrdiff_t count
, count1
;
12979 int polling_stopped_here
= 0;
12980 Lisp_Object tail
, frame
;
12981 struct backtrace backtrace
;
12983 /* Non-zero means redisplay has to consider all windows on all
12984 frames. Zero means, only selected_window is considered. */
12985 int consider_all_windows_p
;
12987 /* Non-zero means redisplay has to redisplay the miniwindow. */
12988 int update_miniwindow_p
= 0;
12990 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12992 /* No redisplay if running in batch mode or frame is not yet fully
12993 initialized, or redisplay is explicitly turned off by setting
12994 Vinhibit_redisplay. */
12995 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12996 || !NILP (Vinhibit_redisplay
))
12999 /* Don't examine these until after testing Vinhibit_redisplay.
13000 When Emacs is shutting down, perhaps because its connection to
13001 X has dropped, we should not look at them at all. */
13002 fr
= XFRAME (w
->frame
);
13003 sf
= SELECTED_FRAME ();
13005 if (!fr
->glyphs_initialized_p
)
13008 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13009 if (popup_activated ())
13013 /* I don't think this happens but let's be paranoid. */
13014 if (redisplaying_p
)
13017 /* Record a function that clears redisplaying_p
13018 when we leave this function. */
13019 count
= SPECPDL_INDEX ();
13020 record_unwind_protect (unwind_redisplay
, selected_frame
);
13021 redisplaying_p
= 1;
13022 specbind (Qinhibit_free_realized_faces
, Qnil
);
13024 /* Record this function, so it appears on the profiler's backtraces. */
13025 backtrace
.next
= backtrace_list
;
13026 backtrace
.function
= Qredisplay_internal
;
13027 backtrace
.args
= &Qnil
;
13028 backtrace
.nargs
= 0;
13029 backtrace
.debug_on_exit
= 0;
13030 backtrace_list
= &backtrace
;
13032 FOR_EACH_FRAME (tail
, frame
)
13033 XFRAME (frame
)->already_hscrolled_p
= 0;
13036 /* Remember the currently selected window. */
13040 reconsider_clip_changes (w
, current_buffer
);
13041 last_escape_glyph_frame
= NULL
;
13042 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13043 last_glyphless_glyph_frame
= NULL
;
13044 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13046 /* If new fonts have been loaded that make a glyph matrix adjustment
13047 necessary, do it. */
13048 if (fonts_changed_p
)
13050 adjust_glyphs (NULL
);
13051 ++windows_or_buffers_changed
;
13052 fonts_changed_p
= 0;
13055 /* If face_change_count is non-zero, init_iterator will free all
13056 realized faces, which includes the faces referenced from current
13057 matrices. So, we can't reuse current matrices in this case. */
13058 if (face_change_count
)
13059 ++windows_or_buffers_changed
;
13061 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13062 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13064 /* Since frames on a single ASCII terminal share the same
13065 display area, displaying a different frame means redisplay
13066 the whole thing. */
13067 windows_or_buffers_changed
++;
13068 SET_FRAME_GARBAGED (sf
);
13070 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13072 FRAME_TTY (sf
)->previous_frame
= sf
;
13075 /* Set the visible flags for all frames. Do this before checking for
13076 resized or garbaged frames; they want to know if their frames are
13077 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13078 number_of_visible_frames
= 0;
13080 FOR_EACH_FRAME (tail
, frame
)
13082 struct frame
*f
= XFRAME (frame
);
13084 FRAME_SAMPLE_VISIBILITY (f
);
13085 if (FRAME_VISIBLE_P (f
))
13086 ++number_of_visible_frames
;
13087 clear_desired_matrices (f
);
13090 /* Notice any pending interrupt request to change frame size. */
13091 do_pending_window_change (1);
13093 /* do_pending_window_change could change the selected_window due to
13094 frame resizing which makes the selected window too small. */
13095 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13098 reconsider_clip_changes (w
, current_buffer
);
13101 /* Clear frames marked as garbaged. */
13102 clear_garbaged_frames ();
13104 /* Build menubar and tool-bar items. */
13105 if (NILP (Vmemory_full
))
13106 prepare_menu_bars ();
13108 if (windows_or_buffers_changed
)
13109 update_mode_lines
++;
13111 /* Detect case that we need to write or remove a star in the mode line. */
13112 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13114 w
->update_mode_line
= 1;
13115 if (buffer_shared_and_changed ())
13116 update_mode_lines
++;
13119 /* Avoid invocation of point motion hooks by `current_column' below. */
13120 count1
= SPECPDL_INDEX ();
13121 specbind (Qinhibit_point_motion_hooks
, Qt
);
13123 if (mode_line_update_needed (w
))
13124 w
->update_mode_line
= 1;
13126 unbind_to (count1
, Qnil
);
13128 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
13130 consider_all_windows_p
= (update_mode_lines
13131 || buffer_shared_and_changed ()
13132 || cursor_type_changed
);
13134 /* If specs for an arrow have changed, do thorough redisplay
13135 to ensure we remove any arrow that should no longer exist. */
13136 if (overlay_arrows_changed_p ())
13137 consider_all_windows_p
= windows_or_buffers_changed
= 1;
13139 /* Normally the message* functions will have already displayed and
13140 updated the echo area, but the frame may have been trashed, or
13141 the update may have been preempted, so display the echo area
13142 again here. Checking message_cleared_p captures the case that
13143 the echo area should be cleared. */
13144 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13145 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13146 || (message_cleared_p
13147 && minibuf_level
== 0
13148 /* If the mini-window is currently selected, this means the
13149 echo-area doesn't show through. */
13150 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13152 int window_height_changed_p
= echo_area_display (0);
13154 if (message_cleared_p
)
13155 update_miniwindow_p
= 1;
13159 /* If we don't display the current message, don't clear the
13160 message_cleared_p flag, because, if we did, we wouldn't clear
13161 the echo area in the next redisplay which doesn't preserve
13163 if (!display_last_displayed_message_p
)
13164 message_cleared_p
= 0;
13166 if (fonts_changed_p
)
13168 else if (window_height_changed_p
)
13170 consider_all_windows_p
= 1;
13171 ++update_mode_lines
;
13172 ++windows_or_buffers_changed
;
13174 /* If window configuration was changed, frames may have been
13175 marked garbaged. Clear them or we will experience
13176 surprises wrt scrolling. */
13177 clear_garbaged_frames ();
13180 else if (EQ (selected_window
, minibuf_window
)
13181 && (current_buffer
->clip_changed
|| window_outdated (w
))
13182 && resize_mini_window (w
, 0))
13184 /* Resized active mini-window to fit the size of what it is
13185 showing if its contents might have changed. */
13187 /* FIXME: this causes all frames to be updated, which seems unnecessary
13188 since only the current frame needs to be considered. This function
13189 needs to be rewritten with two variables, consider_all_windows and
13190 consider_all_frames. */
13191 consider_all_windows_p
= 1;
13192 ++windows_or_buffers_changed
;
13193 ++update_mode_lines
;
13195 /* If window configuration was changed, frames may have been
13196 marked garbaged. Clear them or we will experience
13197 surprises wrt scrolling. */
13198 clear_garbaged_frames ();
13202 /* If showing the region, and mark has changed, we must redisplay
13203 the whole window. The assignment to this_line_start_pos prevents
13204 the optimization directly below this if-statement. */
13205 if (((!NILP (Vtransient_mark_mode
)
13206 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
13207 != !NILP (w
->region_showing
))
13208 || (!NILP (w
->region_showing
)
13209 && !EQ (w
->region_showing
,
13210 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
13211 CHARPOS (this_line_start_pos
) = 0;
13213 /* Optimize the case that only the line containing the cursor in the
13214 selected window has changed. Variables starting with this_ are
13215 set in display_line and record information about the line
13216 containing the cursor. */
13217 tlbufpos
= this_line_start_pos
;
13218 tlendpos
= this_line_end_pos
;
13219 if (!consider_all_windows_p
13220 && CHARPOS (tlbufpos
) > 0
13221 && !w
->update_mode_line
13222 && !current_buffer
->clip_changed
13223 && !current_buffer
->prevent_redisplay_optimizations_p
13224 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13225 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13226 /* Make sure recorded data applies to current buffer, etc. */
13227 && this_line_buffer
== current_buffer
13228 && current_buffer
== XBUFFER (w
->buffer
)
13230 && !w
->optional_new_start
13231 /* Point must be on the line that we have info recorded about. */
13232 && PT
>= CHARPOS (tlbufpos
)
13233 && PT
<= Z
- CHARPOS (tlendpos
)
13234 /* All text outside that line, including its final newline,
13235 must be unchanged. */
13236 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13237 CHARPOS (tlendpos
)))
13239 if (CHARPOS (tlbufpos
) > BEGV
13240 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13241 && (CHARPOS (tlbufpos
) == ZV
13242 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13243 /* Former continuation line has disappeared by becoming empty. */
13245 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13247 /* We have to handle the case of continuation around a
13248 wide-column character (see the comment in indent.c around
13251 For instance, in the following case:
13253 -------- Insert --------
13254 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13255 J_I_ ==> J_I_ `^^' are cursors.
13259 As we have to redraw the line above, we cannot use this
13263 int line_height_before
= this_line_pixel_height
;
13265 /* Note that start_display will handle the case that the
13266 line starting at tlbufpos is a continuation line. */
13267 start_display (&it
, w
, tlbufpos
);
13269 /* Implementation note: It this still necessary? */
13270 if (it
.current_x
!= this_line_start_x
)
13273 TRACE ((stderr
, "trying display optimization 1\n"));
13274 w
->cursor
.vpos
= -1;
13275 overlay_arrow_seen
= 0;
13276 it
.vpos
= this_line_vpos
;
13277 it
.current_y
= this_line_y
;
13278 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13279 display_line (&it
);
13281 /* If line contains point, is not continued,
13282 and ends at same distance from eob as before, we win. */
13283 if (w
->cursor
.vpos
>= 0
13284 /* Line is not continued, otherwise this_line_start_pos
13285 would have been set to 0 in display_line. */
13286 && CHARPOS (this_line_start_pos
)
13287 /* Line ends as before. */
13288 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13289 /* Line has same height as before. Otherwise other lines
13290 would have to be shifted up or down. */
13291 && this_line_pixel_height
== line_height_before
)
13293 /* If this is not the window's last line, we must adjust
13294 the charstarts of the lines below. */
13295 if (it
.current_y
< it
.last_visible_y
)
13297 struct glyph_row
*row
13298 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13299 ptrdiff_t delta
, delta_bytes
;
13301 /* We used to distinguish between two cases here,
13302 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13303 when the line ends in a newline or the end of the
13304 buffer's accessible portion. But both cases did
13305 the same, so they were collapsed. */
13307 - CHARPOS (tlendpos
)
13308 - MATRIX_ROW_START_CHARPOS (row
));
13309 delta_bytes
= (Z_BYTE
13310 - BYTEPOS (tlendpos
)
13311 - MATRIX_ROW_START_BYTEPOS (row
));
13313 increment_matrix_positions (w
->current_matrix
,
13314 this_line_vpos
+ 1,
13315 w
->current_matrix
->nrows
,
13316 delta
, delta_bytes
);
13319 /* If this row displays text now but previously didn't,
13320 or vice versa, w->window_end_vpos may have to be
13322 if ((it
.glyph_row
- 1)->displays_text_p
)
13324 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13325 wset_window_end_vpos (w
, make_number (this_line_vpos
));
13327 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13328 && this_line_vpos
> 0)
13329 wset_window_end_vpos (w
, make_number (this_line_vpos
- 1));
13330 wset_window_end_valid (w
, Qnil
);
13332 /* Update hint: No need to try to scroll in update_window. */
13333 w
->desired_matrix
->no_scrolling_p
= 1;
13336 *w
->desired_matrix
->method
= 0;
13337 debug_method_add (w
, "optimization 1");
13339 #ifdef HAVE_WINDOW_SYSTEM
13340 update_window_fringes (w
, 0);
13347 else if (/* Cursor position hasn't changed. */
13348 PT
== w
->last_point
13349 /* Make sure the cursor was last displayed
13350 in this window. Otherwise we have to reposition it. */
13351 && 0 <= w
->cursor
.vpos
13352 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13356 do_pending_window_change (1);
13357 /* If selected_window changed, redisplay again. */
13358 if (WINDOWP (selected_window
)
13359 && (w
= XWINDOW (selected_window
)) != sw
)
13362 /* We used to always goto end_of_redisplay here, but this
13363 isn't enough if we have a blinking cursor. */
13364 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13365 goto end_of_redisplay
;
13369 /* If highlighting the region, or if the cursor is in the echo area,
13370 then we can't just move the cursor. */
13371 else if (! (!NILP (Vtransient_mark_mode
)
13372 && !NILP (BVAR (current_buffer
, mark_active
)))
13373 && (EQ (selected_window
,
13374 BVAR (current_buffer
, last_selected_window
))
13375 || highlight_nonselected_windows
)
13376 && NILP (w
->region_showing
)
13377 && NILP (Vshow_trailing_whitespace
)
13378 && !cursor_in_echo_area
)
13381 struct glyph_row
*row
;
13383 /* Skip from tlbufpos to PT and see where it is. Note that
13384 PT may be in invisible text. If so, we will end at the
13385 next visible position. */
13386 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13387 NULL
, DEFAULT_FACE_ID
);
13388 it
.current_x
= this_line_start_x
;
13389 it
.current_y
= this_line_y
;
13390 it
.vpos
= this_line_vpos
;
13392 /* The call to move_it_to stops in front of PT, but
13393 moves over before-strings. */
13394 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13396 if (it
.vpos
== this_line_vpos
13397 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13400 eassert (this_line_vpos
== it
.vpos
);
13401 eassert (this_line_y
== it
.current_y
);
13402 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13404 *w
->desired_matrix
->method
= 0;
13405 debug_method_add (w
, "optimization 3");
13414 /* Text changed drastically or point moved off of line. */
13415 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13418 CHARPOS (this_line_start_pos
) = 0;
13419 consider_all_windows_p
|= buffer_shared_and_changed ();
13420 ++clear_face_cache_count
;
13421 #ifdef HAVE_WINDOW_SYSTEM
13422 ++clear_image_cache_count
;
13425 /* Build desired matrices, and update the display. If
13426 consider_all_windows_p is non-zero, do it for all windows on all
13427 frames. Otherwise do it for selected_window, only. */
13429 if (consider_all_windows_p
)
13431 FOR_EACH_FRAME (tail
, frame
)
13432 XFRAME (frame
)->updated_p
= 0;
13434 FOR_EACH_FRAME (tail
, frame
)
13436 struct frame
*f
= XFRAME (frame
);
13438 /* We don't have to do anything for unselected terminal
13440 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13441 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13444 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13446 /* Mark all the scroll bars to be removed; we'll redeem
13447 the ones we want when we redisplay their windows. */
13448 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13449 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13451 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13452 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13454 /* The X error handler may have deleted that frame. */
13455 if (!FRAME_LIVE_P (f
))
13458 /* Any scroll bars which redisplay_windows should have
13459 nuked should now go away. */
13460 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13461 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13463 /* If fonts changed, display again. */
13464 /* ??? rms: I suspect it is a mistake to jump all the way
13465 back to retry here. It should just retry this frame. */
13466 if (fonts_changed_p
)
13469 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13471 /* See if we have to hscroll. */
13472 if (!f
->already_hscrolled_p
)
13474 f
->already_hscrolled_p
= 1;
13475 if (hscroll_windows (f
->root_window
))
13479 /* Prevent various kinds of signals during display
13480 update. stdio is not robust about handling
13481 signals, which can cause an apparent I/O
13483 if (interrupt_input
)
13484 unrequest_sigio ();
13487 /* Update the display. */
13488 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13489 pending
|= update_frame (f
, 0, 0);
13495 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13499 /* Do the mark_window_display_accurate after all windows have
13500 been redisplayed because this call resets flags in buffers
13501 which are needed for proper redisplay. */
13502 FOR_EACH_FRAME (tail
, frame
)
13504 struct frame
*f
= XFRAME (frame
);
13507 mark_window_display_accurate (f
->root_window
, 1);
13508 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13509 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13514 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13516 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13517 struct frame
*mini_frame
;
13519 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13520 /* Use list_of_error, not Qerror, so that
13521 we catch only errors and don't run the debugger. */
13522 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13524 redisplay_window_error
);
13525 if (update_miniwindow_p
)
13526 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13528 redisplay_window_error
);
13530 /* Compare desired and current matrices, perform output. */
13533 /* If fonts changed, display again. */
13534 if (fonts_changed_p
)
13537 /* Prevent various kinds of signals during display update.
13538 stdio is not robust about handling signals,
13539 which can cause an apparent I/O error. */
13540 if (interrupt_input
)
13541 unrequest_sigio ();
13544 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13546 if (hscroll_windows (selected_window
))
13549 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13550 pending
= update_frame (sf
, 0, 0);
13553 /* We may have called echo_area_display at the top of this
13554 function. If the echo area is on another frame, that may
13555 have put text on a frame other than the selected one, so the
13556 above call to update_frame would not have caught it. Catch
13558 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13559 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13561 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13563 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13564 pending
|= update_frame (mini_frame
, 0, 0);
13565 if (!pending
&& hscroll_windows (mini_window
))
13570 /* If display was paused because of pending input, make sure we do a
13571 thorough update the next time. */
13574 /* Prevent the optimization at the beginning of
13575 redisplay_internal that tries a single-line update of the
13576 line containing the cursor in the selected window. */
13577 CHARPOS (this_line_start_pos
) = 0;
13579 /* Let the overlay arrow be updated the next time. */
13580 update_overlay_arrows (0);
13582 /* If we pause after scrolling, some rows in the current
13583 matrices of some windows are not valid. */
13584 if (!WINDOW_FULL_WIDTH_P (w
)
13585 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13586 update_mode_lines
= 1;
13590 if (!consider_all_windows_p
)
13592 /* This has already been done above if
13593 consider_all_windows_p is set. */
13594 mark_window_display_accurate_1 (w
, 1);
13596 /* Say overlay arrows are up to date. */
13597 update_overlay_arrows (1);
13599 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13600 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13603 update_mode_lines
= 0;
13604 windows_or_buffers_changed
= 0;
13605 cursor_type_changed
= 0;
13608 /* Start SIGIO interrupts coming again. Having them off during the
13609 code above makes it less likely one will discard output, but not
13610 impossible, since there might be stuff in the system buffer here.
13611 But it is much hairier to try to do anything about that. */
13612 if (interrupt_input
)
13616 /* If a frame has become visible which was not before, redisplay
13617 again, so that we display it. Expose events for such a frame
13618 (which it gets when becoming visible) don't call the parts of
13619 redisplay constructing glyphs, so simply exposing a frame won't
13620 display anything in this case. So, we have to display these
13621 frames here explicitly. */
13626 FOR_EACH_FRAME (tail
, frame
)
13628 int this_is_visible
= 0;
13630 if (XFRAME (frame
)->visible
)
13631 this_is_visible
= 1;
13632 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13633 if (XFRAME (frame
)->visible
)
13634 this_is_visible
= 1;
13636 if (this_is_visible
)
13640 if (new_count
!= number_of_visible_frames
)
13641 windows_or_buffers_changed
++;
13644 /* Change frame size now if a change is pending. */
13645 do_pending_window_change (1);
13647 /* If we just did a pending size change, or have additional
13648 visible frames, or selected_window changed, redisplay again. */
13649 if ((windows_or_buffers_changed
&& !pending
)
13650 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13653 /* Clear the face and image caches.
13655 We used to do this only if consider_all_windows_p. But the cache
13656 needs to be cleared if a timer creates images in the current
13657 buffer (e.g. the test case in Bug#6230). */
13659 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13661 clear_face_cache (0);
13662 clear_face_cache_count
= 0;
13665 #ifdef HAVE_WINDOW_SYSTEM
13666 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13668 clear_image_caches (Qnil
);
13669 clear_image_cache_count
= 0;
13671 #endif /* HAVE_WINDOW_SYSTEM */
13674 backtrace_list
= backtrace
.next
;
13675 unbind_to (count
, Qnil
);
13680 /* Redisplay, but leave alone any recent echo area message unless
13681 another message has been requested in its place.
13683 This is useful in situations where you need to redisplay but no
13684 user action has occurred, making it inappropriate for the message
13685 area to be cleared. See tracking_off and
13686 wait_reading_process_output for examples of these situations.
13688 FROM_WHERE is an integer saying from where this function was
13689 called. This is useful for debugging. */
13692 redisplay_preserve_echo_area (int from_where
)
13694 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13696 if (!NILP (echo_area_buffer
[1]))
13698 /* We have a previously displayed message, but no current
13699 message. Redisplay the previous message. */
13700 display_last_displayed_message_p
= 1;
13701 redisplay_internal ();
13702 display_last_displayed_message_p
= 0;
13705 redisplay_internal ();
13707 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13708 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13709 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13713 /* Function registered with record_unwind_protect in redisplay_internal.
13714 Clear redisplaying_p. Also select the previously selected frame. */
13717 unwind_redisplay (Lisp_Object old_frame
)
13719 redisplaying_p
= 0;
13724 /* Mark the display of window W as accurate or inaccurate. If
13725 ACCURATE_P is non-zero mark display of W as accurate. If
13726 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13727 redisplay_internal is called. */
13730 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13732 if (BUFFERP (w
->buffer
))
13734 struct buffer
*b
= XBUFFER (w
->buffer
);
13736 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
13737 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
13739 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13743 b
->clip_changed
= 0;
13744 b
->prevent_redisplay_optimizations_p
= 0;
13746 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13747 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13748 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13749 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13751 w
->current_matrix
->buffer
= b
;
13752 w
->current_matrix
->begv
= BUF_BEGV (b
);
13753 w
->current_matrix
->zv
= BUF_ZV (b
);
13755 w
->last_cursor
= w
->cursor
;
13756 w
->last_cursor_off_p
= w
->cursor_off_p
;
13758 if (w
== XWINDOW (selected_window
))
13759 w
->last_point
= BUF_PT (b
);
13761 w
->last_point
= marker_position (w
->pointm
);
13767 wset_window_end_valid (w
, w
->buffer
);
13768 w
->update_mode_line
= 0;
13773 /* Mark the display of windows in the window tree rooted at WINDOW as
13774 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13775 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13776 be redisplayed the next time redisplay_internal is called. */
13779 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13783 for (; !NILP (window
); window
= w
->next
)
13785 w
= XWINDOW (window
);
13786 mark_window_display_accurate_1 (w
, accurate_p
);
13788 if (!NILP (w
->vchild
))
13789 mark_window_display_accurate (w
->vchild
, accurate_p
);
13790 if (!NILP (w
->hchild
))
13791 mark_window_display_accurate (w
->hchild
, accurate_p
);
13796 update_overlay_arrows (1);
13800 /* Force a thorough redisplay the next time by setting
13801 last_arrow_position and last_arrow_string to t, which is
13802 unequal to any useful value of Voverlay_arrow_... */
13803 update_overlay_arrows (-1);
13808 /* Return value in display table DP (Lisp_Char_Table *) for character
13809 C. Since a display table doesn't have any parent, we don't have to
13810 follow parent. Do not call this function directly but use the
13811 macro DISP_CHAR_VECTOR. */
13814 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13818 if (ASCII_CHAR_P (c
))
13821 if (SUB_CHAR_TABLE_P (val
))
13822 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13828 XSETCHAR_TABLE (table
, dp
);
13829 val
= char_table_ref (table
, c
);
13838 /***********************************************************************
13840 ***********************************************************************/
13842 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13845 redisplay_windows (Lisp_Object window
)
13847 while (!NILP (window
))
13849 struct window
*w
= XWINDOW (window
);
13851 if (!NILP (w
->hchild
))
13852 redisplay_windows (w
->hchild
);
13853 else if (!NILP (w
->vchild
))
13854 redisplay_windows (w
->vchild
);
13855 else if (!NILP (w
->buffer
))
13857 displayed_buffer
= XBUFFER (w
->buffer
);
13858 /* Use list_of_error, not Qerror, so that
13859 we catch only errors and don't run the debugger. */
13860 internal_condition_case_1 (redisplay_window_0
, window
,
13862 redisplay_window_error
);
13870 redisplay_window_error (Lisp_Object ignore
)
13872 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13877 redisplay_window_0 (Lisp_Object window
)
13879 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13880 redisplay_window (window
, 0);
13885 redisplay_window_1 (Lisp_Object window
)
13887 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13888 redisplay_window (window
, 1);
13893 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13894 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13895 which positions recorded in ROW differ from current buffer
13898 Return 0 if cursor is not on this row, 1 otherwise. */
13901 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13902 struct glyph_matrix
*matrix
,
13903 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13906 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13907 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13908 struct glyph
*cursor
= NULL
;
13909 /* The last known character position in row. */
13910 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13912 ptrdiff_t pt_old
= PT
- delta
;
13913 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13914 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13915 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13916 /* A glyph beyond the edge of TEXT_AREA which we should never
13918 struct glyph
*glyphs_end
= end
;
13919 /* Non-zero means we've found a match for cursor position, but that
13920 glyph has the avoid_cursor_p flag set. */
13921 int match_with_avoid_cursor
= 0;
13922 /* Non-zero means we've seen at least one glyph that came from a
13924 int string_seen
= 0;
13925 /* Largest and smallest buffer positions seen so far during scan of
13927 ptrdiff_t bpos_max
= pos_before
;
13928 ptrdiff_t bpos_min
= pos_after
;
13929 /* Last buffer position covered by an overlay string with an integer
13930 `cursor' property. */
13931 ptrdiff_t bpos_covered
= 0;
13932 /* Non-zero means the display string on which to display the cursor
13933 comes from a text property, not from an overlay. */
13934 int string_from_text_prop
= 0;
13936 /* Don't even try doing anything if called for a mode-line or
13937 header-line row, since the rest of the code isn't prepared to
13938 deal with such calamities. */
13939 eassert (!row
->mode_line_p
);
13940 if (row
->mode_line_p
)
13943 /* Skip over glyphs not having an object at the start and the end of
13944 the row. These are special glyphs like truncation marks on
13945 terminal frames. */
13946 if (row
->displays_text_p
)
13948 if (!row
->reversed_p
)
13951 && INTEGERP (glyph
->object
)
13952 && glyph
->charpos
< 0)
13954 x
+= glyph
->pixel_width
;
13958 && INTEGERP ((end
- 1)->object
)
13959 /* CHARPOS is zero for blanks and stretch glyphs
13960 inserted by extend_face_to_end_of_line. */
13961 && (end
- 1)->charpos
<= 0)
13963 glyph_before
= glyph
- 1;
13970 /* If the glyph row is reversed, we need to process it from back
13971 to front, so swap the edge pointers. */
13972 glyphs_end
= end
= glyph
- 1;
13973 glyph
+= row
->used
[TEXT_AREA
] - 1;
13975 while (glyph
> end
+ 1
13976 && INTEGERP (glyph
->object
)
13977 && glyph
->charpos
< 0)
13980 x
-= glyph
->pixel_width
;
13982 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13984 /* By default, in reversed rows we put the cursor on the
13985 rightmost (first in the reading order) glyph. */
13986 for (g
= end
+ 1; g
< glyph
; g
++)
13987 x
+= g
->pixel_width
;
13989 && INTEGERP ((end
+ 1)->object
)
13990 && (end
+ 1)->charpos
<= 0)
13992 glyph_before
= glyph
+ 1;
13996 else if (row
->reversed_p
)
13998 /* In R2L rows that don't display text, put the cursor on the
13999 rightmost glyph. Case in point: an empty last line that is
14000 part of an R2L paragraph. */
14002 /* Avoid placing the cursor on the last glyph of the row, where
14003 on terminal frames we hold the vertical border between
14004 adjacent windows. */
14005 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14006 && !WINDOW_RIGHTMOST_P (w
)
14007 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14009 x
= -1; /* will be computed below, at label compute_x */
14012 /* Step 1: Try to find the glyph whose character position
14013 corresponds to point. If that's not possible, find 2 glyphs
14014 whose character positions are the closest to point, one before
14015 point, the other after it. */
14016 if (!row
->reversed_p
)
14017 while (/* not marched to end of glyph row */
14019 /* glyph was not inserted by redisplay for internal purposes */
14020 && !INTEGERP (glyph
->object
))
14022 if (BUFFERP (glyph
->object
))
14024 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14026 if (glyph
->charpos
> bpos_max
)
14027 bpos_max
= glyph
->charpos
;
14028 if (glyph
->charpos
< bpos_min
)
14029 bpos_min
= glyph
->charpos
;
14030 if (!glyph
->avoid_cursor_p
)
14032 /* If we hit point, we've found the glyph on which to
14033 display the cursor. */
14036 match_with_avoid_cursor
= 0;
14039 /* See if we've found a better approximation to
14040 POS_BEFORE or to POS_AFTER. */
14041 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14043 pos_before
= glyph
->charpos
;
14044 glyph_before
= glyph
;
14046 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14048 pos_after
= glyph
->charpos
;
14049 glyph_after
= glyph
;
14052 else if (dpos
== 0)
14053 match_with_avoid_cursor
= 1;
14055 else if (STRINGP (glyph
->object
))
14057 Lisp_Object chprop
;
14058 ptrdiff_t glyph_pos
= glyph
->charpos
;
14060 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14062 if (!NILP (chprop
))
14064 /* If the string came from a `display' text property,
14065 look up the buffer position of that property and
14066 use that position to update bpos_max, as if we
14067 actually saw such a position in one of the row's
14068 glyphs. This helps with supporting integer values
14069 of `cursor' property on the display string in
14070 situations where most or all of the row's buffer
14071 text is completely covered by display properties,
14072 so that no glyph with valid buffer positions is
14073 ever seen in the row. */
14074 ptrdiff_t prop_pos
=
14075 string_buffer_position_lim (glyph
->object
, pos_before
,
14078 if (prop_pos
>= pos_before
)
14079 bpos_max
= prop_pos
- 1;
14081 if (INTEGERP (chprop
))
14083 bpos_covered
= bpos_max
+ XINT (chprop
);
14084 /* If the `cursor' property covers buffer positions up
14085 to and including point, we should display cursor on
14086 this glyph. Note that, if a `cursor' property on one
14087 of the string's characters has an integer value, we
14088 will break out of the loop below _before_ we get to
14089 the position match above. IOW, integer values of
14090 the `cursor' property override the "exact match for
14091 point" strategy of positioning the cursor. */
14092 /* Implementation note: bpos_max == pt_old when, e.g.,
14093 we are in an empty line, where bpos_max is set to
14094 MATRIX_ROW_START_CHARPOS, see above. */
14095 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14104 x
+= glyph
->pixel_width
;
14107 else if (glyph
> end
) /* row is reversed */
14108 while (!INTEGERP (glyph
->object
))
14110 if (BUFFERP (glyph
->object
))
14112 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14114 if (glyph
->charpos
> bpos_max
)
14115 bpos_max
= glyph
->charpos
;
14116 if (glyph
->charpos
< bpos_min
)
14117 bpos_min
= glyph
->charpos
;
14118 if (!glyph
->avoid_cursor_p
)
14122 match_with_avoid_cursor
= 0;
14125 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14127 pos_before
= glyph
->charpos
;
14128 glyph_before
= glyph
;
14130 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14132 pos_after
= glyph
->charpos
;
14133 glyph_after
= glyph
;
14136 else if (dpos
== 0)
14137 match_with_avoid_cursor
= 1;
14139 else if (STRINGP (glyph
->object
))
14141 Lisp_Object chprop
;
14142 ptrdiff_t glyph_pos
= glyph
->charpos
;
14144 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14146 if (!NILP (chprop
))
14148 ptrdiff_t prop_pos
=
14149 string_buffer_position_lim (glyph
->object
, pos_before
,
14152 if (prop_pos
>= pos_before
)
14153 bpos_max
= prop_pos
- 1;
14155 if (INTEGERP (chprop
))
14157 bpos_covered
= bpos_max
+ XINT (chprop
);
14158 /* If the `cursor' property covers buffer positions up
14159 to and including point, we should display cursor on
14161 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14170 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14172 x
--; /* can't use any pixel_width */
14175 x
-= glyph
->pixel_width
;
14178 /* Step 2: If we didn't find an exact match for point, we need to
14179 look for a proper place to put the cursor among glyphs between
14180 GLYPH_BEFORE and GLYPH_AFTER. */
14181 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14182 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14183 && !(bpos_max
< pt_old
&& pt_old
<= bpos_covered
))
14185 /* An empty line has a single glyph whose OBJECT is zero and
14186 whose CHARPOS is the position of a newline on that line.
14187 Note that on a TTY, there are more glyphs after that, which
14188 were produced by extend_face_to_end_of_line, but their
14189 CHARPOS is zero or negative. */
14191 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14192 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14193 /* On a TTY, continued and truncated rows also have a glyph at
14194 their end whose OBJECT is zero and whose CHARPOS is
14195 positive (the continuation and truncation glyphs), but such
14196 rows are obviously not "empty". */
14197 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14199 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14201 ptrdiff_t ellipsis_pos
;
14203 /* Scan back over the ellipsis glyphs. */
14204 if (!row
->reversed_p
)
14206 ellipsis_pos
= (glyph
- 1)->charpos
;
14207 while (glyph
> row
->glyphs
[TEXT_AREA
]
14208 && (glyph
- 1)->charpos
== ellipsis_pos
)
14209 glyph
--, x
-= glyph
->pixel_width
;
14210 /* That loop always goes one position too far, including
14211 the glyph before the ellipsis. So scan forward over
14213 x
+= glyph
->pixel_width
;
14216 else /* row is reversed */
14218 ellipsis_pos
= (glyph
+ 1)->charpos
;
14219 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14220 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14221 glyph
++, x
+= glyph
->pixel_width
;
14222 x
-= glyph
->pixel_width
;
14226 else if (match_with_avoid_cursor
)
14228 cursor
= glyph_after
;
14231 else if (string_seen
)
14233 int incr
= row
->reversed_p
? -1 : +1;
14235 /* Need to find the glyph that came out of a string which is
14236 present at point. That glyph is somewhere between
14237 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14238 positioned between POS_BEFORE and POS_AFTER in the
14240 struct glyph
*start
, *stop
;
14241 ptrdiff_t pos
= pos_before
;
14245 /* If the row ends in a newline from a display string,
14246 reordering could have moved the glyphs belonging to the
14247 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14248 in this case we extend the search to the last glyph in
14249 the row that was not inserted by redisplay. */
14250 if (row
->ends_in_newline_from_string_p
)
14253 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14256 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14257 correspond to POS_BEFORE and POS_AFTER, respectively. We
14258 need START and STOP in the order that corresponds to the
14259 row's direction as given by its reversed_p flag. If the
14260 directionality of characters between POS_BEFORE and
14261 POS_AFTER is the opposite of the row's base direction,
14262 these characters will have been reordered for display,
14263 and we need to reverse START and STOP. */
14264 if (!row
->reversed_p
)
14266 start
= min (glyph_before
, glyph_after
);
14267 stop
= max (glyph_before
, glyph_after
);
14271 start
= max (glyph_before
, glyph_after
);
14272 stop
= min (glyph_before
, glyph_after
);
14274 for (glyph
= start
+ incr
;
14275 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14278 /* Any glyphs that come from the buffer are here because
14279 of bidi reordering. Skip them, and only pay
14280 attention to glyphs that came from some string. */
14281 if (STRINGP (glyph
->object
))
14285 /* If the display property covers the newline, we
14286 need to search for it one position farther. */
14287 ptrdiff_t lim
= pos_after
14288 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14290 string_from_text_prop
= 0;
14291 str
= glyph
->object
;
14292 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14293 if (tem
== 0 /* from overlay */
14296 /* If the string from which this glyph came is
14297 found in the buffer at point, or at position
14298 that is closer to point than pos_after, then
14299 we've found the glyph we've been looking for.
14300 If it comes from an overlay (tem == 0), and
14301 it has the `cursor' property on one of its
14302 glyphs, record that glyph as a candidate for
14303 displaying the cursor. (As in the
14304 unidirectional version, we will display the
14305 cursor on the last candidate we find.) */
14308 || (tem
- pt_old
> 0 && tem
< pos_after
))
14310 /* The glyphs from this string could have
14311 been reordered. Find the one with the
14312 smallest string position. Or there could
14313 be a character in the string with the
14314 `cursor' property, which means display
14315 cursor on that character's glyph. */
14316 ptrdiff_t strpos
= glyph
->charpos
;
14321 string_from_text_prop
= 1;
14324 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14325 && EQ (glyph
->object
, str
);
14329 ptrdiff_t gpos
= glyph
->charpos
;
14331 cprop
= Fget_char_property (make_number (gpos
),
14339 if (tem
&& glyph
->charpos
< strpos
)
14341 strpos
= glyph
->charpos
;
14347 || (tem
- pt_old
> 0 && tem
< pos_after
))
14351 pos
= tem
+ 1; /* don't find previous instances */
14353 /* This string is not what we want; skip all of the
14354 glyphs that came from it. */
14355 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14356 && EQ (glyph
->object
, str
))
14363 /* If we reached the end of the line, and END was from a string,
14364 the cursor is not on this line. */
14366 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14367 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14368 && STRINGP (end
->object
)
14369 && row
->continued_p
)
14372 /* A truncated row may not include PT among its character positions.
14373 Setting the cursor inside the scroll margin will trigger
14374 recalculation of hscroll in hscroll_window_tree. But if a
14375 display string covers point, defer to the string-handling
14376 code below to figure this out. */
14377 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14379 cursor
= glyph_before
;
14382 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14383 /* Zero-width characters produce no glyphs. */
14385 && (row
->reversed_p
14386 ? glyph_after
> glyphs_end
14387 : glyph_after
< glyphs_end
)))
14389 cursor
= glyph_after
;
14395 if (cursor
!= NULL
)
14397 else if (glyph
== glyphs_end
14398 && pos_before
== pos_after
14399 && STRINGP ((row
->reversed_p
14400 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14401 : row
->glyphs
[TEXT_AREA
])->object
))
14403 /* If all the glyphs of this row came from strings, put the
14404 cursor on the first glyph of the row. This avoids having the
14405 cursor outside of the text area in this very rare and hard
14409 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14410 : row
->glyphs
[TEXT_AREA
];
14416 /* Need to compute x that corresponds to GLYPH. */
14417 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14419 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14421 x
+= g
->pixel_width
;
14425 /* ROW could be part of a continued line, which, under bidi
14426 reordering, might have other rows whose start and end charpos
14427 occlude point. Only set w->cursor if we found a better
14428 approximation to the cursor position than we have from previously
14429 examined candidate rows belonging to the same continued line. */
14430 if (/* we already have a candidate row */
14431 w
->cursor
.vpos
>= 0
14432 /* that candidate is not the row we are processing */
14433 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14434 /* Make sure cursor.vpos specifies a row whose start and end
14435 charpos occlude point, and it is valid candidate for being a
14436 cursor-row. This is because some callers of this function
14437 leave cursor.vpos at the row where the cursor was displayed
14438 during the last redisplay cycle. */
14439 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14440 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14441 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14444 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14446 /* Don't consider glyphs that are outside TEXT_AREA. */
14447 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14449 /* Keep the candidate whose buffer position is the closest to
14450 point or has the `cursor' property. */
14451 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14452 w
->cursor
.hpos
>= 0
14453 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14454 && ((BUFFERP (g1
->object
)
14455 && (g1
->charpos
== pt_old
/* an exact match always wins */
14456 || (BUFFERP (glyph
->object
)
14457 && eabs (g1
->charpos
- pt_old
)
14458 < eabs (glyph
->charpos
- pt_old
))))
14459 /* previous candidate is a glyph from a string that has
14460 a non-nil `cursor' property */
14461 || (STRINGP (g1
->object
)
14462 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14463 Qcursor
, g1
->object
))
14464 /* previous candidate is from the same display
14465 string as this one, and the display string
14466 came from a text property */
14467 || (EQ (g1
->object
, glyph
->object
)
14468 && string_from_text_prop
)
14469 /* this candidate is from newline and its
14470 position is not an exact match */
14471 || (INTEGERP (glyph
->object
)
14472 && glyph
->charpos
!= pt_old
)))))
14474 /* If this candidate gives an exact match, use that. */
14475 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14476 /* If this candidate is a glyph created for the
14477 terminating newline of a line, and point is on that
14478 newline, it wins because it's an exact match. */
14479 || (!row
->continued_p
14480 && INTEGERP (glyph
->object
)
14481 && glyph
->charpos
== 0
14482 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14483 /* Otherwise, keep the candidate that comes from a row
14484 spanning less buffer positions. This may win when one or
14485 both candidate positions are on glyphs that came from
14486 display strings, for which we cannot compare buffer
14488 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14489 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14490 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14493 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14495 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14496 w
->cursor
.y
= row
->y
+ dy
;
14498 if (w
== XWINDOW (selected_window
))
14500 if (!row
->continued_p
14501 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14504 this_line_buffer
= XBUFFER (w
->buffer
);
14506 CHARPOS (this_line_start_pos
)
14507 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14508 BYTEPOS (this_line_start_pos
)
14509 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14511 CHARPOS (this_line_end_pos
)
14512 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14513 BYTEPOS (this_line_end_pos
)
14514 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14516 this_line_y
= w
->cursor
.y
;
14517 this_line_pixel_height
= row
->height
;
14518 this_line_vpos
= w
->cursor
.vpos
;
14519 this_line_start_x
= row
->x
;
14522 CHARPOS (this_line_start_pos
) = 0;
14529 /* Run window scroll functions, if any, for WINDOW with new window
14530 start STARTP. Sets the window start of WINDOW to that position.
14532 We assume that the window's buffer is really current. */
14534 static struct text_pos
14535 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14537 struct window
*w
= XWINDOW (window
);
14538 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14540 if (current_buffer
!= XBUFFER (w
->buffer
))
14543 if (!NILP (Vwindow_scroll_functions
))
14545 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14546 make_number (CHARPOS (startp
)));
14547 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14548 /* In case the hook functions switch buffers. */
14549 set_buffer_internal (XBUFFER (w
->buffer
));
14556 /* Make sure the line containing the cursor is fully visible.
14557 A value of 1 means there is nothing to be done.
14558 (Either the line is fully visible, or it cannot be made so,
14559 or we cannot tell.)
14561 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14562 is higher than window.
14564 A value of 0 means the caller should do scrolling
14565 as if point had gone off the screen. */
14568 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14570 struct glyph_matrix
*matrix
;
14571 struct glyph_row
*row
;
14574 if (!make_cursor_line_fully_visible_p
)
14577 /* It's not always possible to find the cursor, e.g, when a window
14578 is full of overlay strings. Don't do anything in that case. */
14579 if (w
->cursor
.vpos
< 0)
14582 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14583 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14585 /* If the cursor row is not partially visible, there's nothing to do. */
14586 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14589 /* If the row the cursor is in is taller than the window's height,
14590 it's not clear what to do, so do nothing. */
14591 window_height
= window_box_height (w
);
14592 if (row
->height
>= window_height
)
14594 if (!force_p
|| MINI_WINDOW_P (w
)
14595 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14602 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14603 non-zero means only WINDOW is redisplayed in redisplay_internal.
14604 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14605 in redisplay_window to bring a partially visible line into view in
14606 the case that only the cursor has moved.
14608 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14609 last screen line's vertical height extends past the end of the screen.
14613 1 if scrolling succeeded
14615 0 if scrolling didn't find point.
14617 -1 if new fonts have been loaded so that we must interrupt
14618 redisplay, adjust glyph matrices, and try again. */
14624 SCROLLING_NEED_LARGER_MATRICES
14627 /* If scroll-conservatively is more than this, never recenter.
14629 If you change this, don't forget to update the doc string of
14630 `scroll-conservatively' and the Emacs manual. */
14631 #define SCROLL_LIMIT 100
14634 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14635 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14636 int temp_scroll_step
, int last_line_misfit
)
14638 struct window
*w
= XWINDOW (window
);
14639 struct frame
*f
= XFRAME (w
->frame
);
14640 struct text_pos pos
, startp
;
14642 int this_scroll_margin
, scroll_max
, rc
, height
;
14643 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14644 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14645 Lisp_Object aggressive
;
14646 /* We will never try scrolling more than this number of lines. */
14647 int scroll_limit
= SCROLL_LIMIT
;
14650 debug_method_add (w
, "try_scrolling");
14653 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14655 /* Compute scroll margin height in pixels. We scroll when point is
14656 within this distance from the top or bottom of the window. */
14657 if (scroll_margin
> 0)
14658 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14659 * FRAME_LINE_HEIGHT (f
);
14661 this_scroll_margin
= 0;
14663 /* Force arg_scroll_conservatively to have a reasonable value, to
14664 avoid scrolling too far away with slow move_it_* functions. Note
14665 that the user can supply scroll-conservatively equal to
14666 `most-positive-fixnum', which can be larger than INT_MAX. */
14667 if (arg_scroll_conservatively
> scroll_limit
)
14669 arg_scroll_conservatively
= scroll_limit
+ 1;
14670 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14672 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14673 /* Compute how much we should try to scroll maximally to bring
14674 point into view. */
14675 scroll_max
= (max (scroll_step
,
14676 max (arg_scroll_conservatively
, temp_scroll_step
))
14677 * FRAME_LINE_HEIGHT (f
));
14678 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14679 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14680 /* We're trying to scroll because of aggressive scrolling but no
14681 scroll_step is set. Choose an arbitrary one. */
14682 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14688 /* Decide whether to scroll down. */
14689 if (PT
> CHARPOS (startp
))
14691 int scroll_margin_y
;
14693 /* Compute the pixel ypos of the scroll margin, then move IT to
14694 either that ypos or PT, whichever comes first. */
14695 start_display (&it
, w
, startp
);
14696 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14697 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14698 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14699 (MOVE_TO_POS
| MOVE_TO_Y
));
14701 if (PT
> CHARPOS (it
.current
.pos
))
14703 int y0
= line_bottom_y (&it
);
14704 /* Compute how many pixels below window bottom to stop searching
14705 for PT. This avoids costly search for PT that is far away if
14706 the user limited scrolling by a small number of lines, but
14707 always finds PT if scroll_conservatively is set to a large
14708 number, such as most-positive-fixnum. */
14709 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14710 int y_to_move
= it
.last_visible_y
+ slack
;
14712 /* Compute the distance from the scroll margin to PT or to
14713 the scroll limit, whichever comes first. This should
14714 include the height of the cursor line, to make that line
14716 move_it_to (&it
, PT
, -1, y_to_move
,
14717 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14718 dy
= line_bottom_y (&it
) - y0
;
14720 if (dy
> scroll_max
)
14721 return SCROLLING_FAILED
;
14730 /* Point is in or below the bottom scroll margin, so move the
14731 window start down. If scrolling conservatively, move it just
14732 enough down to make point visible. If scroll_step is set,
14733 move it down by scroll_step. */
14734 if (arg_scroll_conservatively
)
14736 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14737 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14738 else if (scroll_step
|| temp_scroll_step
)
14739 amount_to_scroll
= scroll_max
;
14742 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14743 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14744 if (NUMBERP (aggressive
))
14746 double float_amount
= XFLOATINT (aggressive
) * height
;
14747 int aggressive_scroll
= float_amount
;
14748 if (aggressive_scroll
== 0 && float_amount
> 0)
14749 aggressive_scroll
= 1;
14750 /* Don't let point enter the scroll margin near top of
14751 the window. This could happen if the value of
14752 scroll_up_aggressively is too large and there are
14753 non-zero margins, because scroll_up_aggressively
14754 means put point that fraction of window height
14755 _from_the_bottom_margin_. */
14756 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14757 aggressive_scroll
= height
- 2*this_scroll_margin
;
14758 amount_to_scroll
= dy
+ aggressive_scroll
;
14762 if (amount_to_scroll
<= 0)
14763 return SCROLLING_FAILED
;
14765 start_display (&it
, w
, startp
);
14766 if (arg_scroll_conservatively
<= scroll_limit
)
14767 move_it_vertically (&it
, amount_to_scroll
);
14770 /* Extra precision for users who set scroll-conservatively
14771 to a large number: make sure the amount we scroll
14772 the window start is never less than amount_to_scroll,
14773 which was computed as distance from window bottom to
14774 point. This matters when lines at window top and lines
14775 below window bottom have different height. */
14777 void *it1data
= NULL
;
14778 /* We use a temporary it1 because line_bottom_y can modify
14779 its argument, if it moves one line down; see there. */
14782 SAVE_IT (it1
, it
, it1data
);
14783 start_y
= line_bottom_y (&it1
);
14785 RESTORE_IT (&it
, &it
, it1data
);
14786 move_it_by_lines (&it
, 1);
14787 SAVE_IT (it1
, it
, it1data
);
14788 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14791 /* If STARTP is unchanged, move it down another screen line. */
14792 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14793 move_it_by_lines (&it
, 1);
14794 startp
= it
.current
.pos
;
14798 struct text_pos scroll_margin_pos
= startp
;
14800 /* See if point is inside the scroll margin at the top of the
14802 if (this_scroll_margin
)
14804 start_display (&it
, w
, startp
);
14805 move_it_vertically (&it
, this_scroll_margin
);
14806 scroll_margin_pos
= it
.current
.pos
;
14809 if (PT
< CHARPOS (scroll_margin_pos
))
14811 /* Point is in the scroll margin at the top of the window or
14812 above what is displayed in the window. */
14815 /* Compute the vertical distance from PT to the scroll
14816 margin position. Move as far as scroll_max allows, or
14817 one screenful, or 10 screen lines, whichever is largest.
14818 Give up if distance is greater than scroll_max or if we
14819 didn't reach the scroll margin position. */
14820 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14821 start_display (&it
, w
, pos
);
14823 y_to_move
= max (it
.last_visible_y
,
14824 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14825 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14827 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14828 dy
= it
.current_y
- y0
;
14829 if (dy
> scroll_max
14830 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
14831 return SCROLLING_FAILED
;
14833 /* Compute new window start. */
14834 start_display (&it
, w
, startp
);
14836 if (arg_scroll_conservatively
)
14837 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14838 max (scroll_step
, temp_scroll_step
));
14839 else if (scroll_step
|| temp_scroll_step
)
14840 amount_to_scroll
= scroll_max
;
14843 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14844 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14845 if (NUMBERP (aggressive
))
14847 double float_amount
= XFLOATINT (aggressive
) * height
;
14848 int aggressive_scroll
= float_amount
;
14849 if (aggressive_scroll
== 0 && float_amount
> 0)
14850 aggressive_scroll
= 1;
14851 /* Don't let point enter the scroll margin near
14852 bottom of the window, if the value of
14853 scroll_down_aggressively happens to be too
14855 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14856 aggressive_scroll
= height
- 2*this_scroll_margin
;
14857 amount_to_scroll
= dy
+ aggressive_scroll
;
14861 if (amount_to_scroll
<= 0)
14862 return SCROLLING_FAILED
;
14864 move_it_vertically_backward (&it
, amount_to_scroll
);
14865 startp
= it
.current
.pos
;
14869 /* Run window scroll functions. */
14870 startp
= run_window_scroll_functions (window
, startp
);
14872 /* Display the window. Give up if new fonts are loaded, or if point
14874 if (!try_window (window
, startp
, 0))
14875 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14876 else if (w
->cursor
.vpos
< 0)
14878 clear_glyph_matrix (w
->desired_matrix
);
14879 rc
= SCROLLING_FAILED
;
14883 /* Maybe forget recorded base line for line number display. */
14884 if (!just_this_one_p
14885 || current_buffer
->clip_changed
14886 || BEG_UNCHANGED
< CHARPOS (startp
))
14887 wset_base_line_number (w
, Qnil
);
14889 /* If cursor ends up on a partially visible line,
14890 treat that as being off the bottom of the screen. */
14891 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14892 /* It's possible that the cursor is on the first line of the
14893 buffer, which is partially obscured due to a vscroll
14894 (Bug#7537). In that case, avoid looping forever . */
14895 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14897 clear_glyph_matrix (w
->desired_matrix
);
14898 ++extra_scroll_margin_lines
;
14901 rc
= SCROLLING_SUCCESS
;
14908 /* Compute a suitable window start for window W if display of W starts
14909 on a continuation line. Value is non-zero if a new window start
14912 The new window start will be computed, based on W's width, starting
14913 from the start of the continued line. It is the start of the
14914 screen line with the minimum distance from the old start W->start. */
14917 compute_window_start_on_continuation_line (struct window
*w
)
14919 struct text_pos pos
, start_pos
;
14920 int window_start_changed_p
= 0;
14922 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14924 /* If window start is on a continuation line... Window start may be
14925 < BEGV in case there's invisible text at the start of the
14926 buffer (M-x rmail, for example). */
14927 if (CHARPOS (start_pos
) > BEGV
14928 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14931 struct glyph_row
*row
;
14933 /* Handle the case that the window start is out of range. */
14934 if (CHARPOS (start_pos
) < BEGV
)
14935 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14936 else if (CHARPOS (start_pos
) > ZV
)
14937 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14939 /* Find the start of the continued line. This should be fast
14940 because scan_buffer is fast (newline cache). */
14941 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14942 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14943 row
, DEFAULT_FACE_ID
);
14944 reseat_at_previous_visible_line_start (&it
);
14946 /* If the line start is "too far" away from the window start,
14947 say it takes too much time to compute a new window start. */
14948 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14949 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14951 int min_distance
, distance
;
14953 /* Move forward by display lines to find the new window
14954 start. If window width was enlarged, the new start can
14955 be expected to be > the old start. If window width was
14956 decreased, the new window start will be < the old start.
14957 So, we're looking for the display line start with the
14958 minimum distance from the old window start. */
14959 pos
= it
.current
.pos
;
14960 min_distance
= INFINITY
;
14961 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14962 distance
< min_distance
)
14964 min_distance
= distance
;
14965 pos
= it
.current
.pos
;
14966 move_it_by_lines (&it
, 1);
14969 /* Set the window start there. */
14970 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14971 window_start_changed_p
= 1;
14975 return window_start_changed_p
;
14979 /* Try cursor movement in case text has not changed in window WINDOW,
14980 with window start STARTP. Value is
14982 CURSOR_MOVEMENT_SUCCESS if successful
14984 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14986 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14987 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14988 we want to scroll as if scroll-step were set to 1. See the code.
14990 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14991 which case we have to abort this redisplay, and adjust matrices
14996 CURSOR_MOVEMENT_SUCCESS
,
14997 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14998 CURSOR_MOVEMENT_MUST_SCROLL
,
14999 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15003 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15005 struct window
*w
= XWINDOW (window
);
15006 struct frame
*f
= XFRAME (w
->frame
);
15007 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15010 if (inhibit_try_cursor_movement
)
15014 /* Previously, there was a check for Lisp integer in the
15015 if-statement below. Now, this field is converted to
15016 ptrdiff_t, thus zero means invalid position in a buffer. */
15017 eassert (w
->last_point
> 0);
15019 /* Handle case where text has not changed, only point, and it has
15020 not moved off the frame. */
15021 if (/* Point may be in this window. */
15022 PT
>= CHARPOS (startp
)
15023 /* Selective display hasn't changed. */
15024 && !current_buffer
->clip_changed
15025 /* Function force-mode-line-update is used to force a thorough
15026 redisplay. It sets either windows_or_buffers_changed or
15027 update_mode_lines. So don't take a shortcut here for these
15029 && !update_mode_lines
15030 && !windows_or_buffers_changed
15031 && !cursor_type_changed
15032 /* Can't use this case if highlighting a region. When a
15033 region exists, cursor movement has to do more than just
15035 && markpos_of_region () < 0
15036 && NILP (w
->region_showing
)
15037 && NILP (Vshow_trailing_whitespace
)
15038 /* This code is not used for mini-buffer for the sake of the case
15039 of redisplaying to replace an echo area message; since in
15040 that case the mini-buffer contents per se are usually
15041 unchanged. This code is of no real use in the mini-buffer
15042 since the handling of this_line_start_pos, etc., in redisplay
15043 handles the same cases. */
15044 && !EQ (window
, minibuf_window
)
15045 /* When splitting windows or for new windows, it happens that
15046 redisplay is called with a nil window_end_vpos or one being
15047 larger than the window. This should really be fixed in
15048 window.c. I don't have this on my list, now, so we do
15049 approximately the same as the old redisplay code. --gerd. */
15050 && INTEGERP (w
->window_end_vpos
)
15051 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
15052 && (FRAME_WINDOW_P (f
)
15053 || !overlay_arrow_in_current_buffer_p ()))
15055 int this_scroll_margin
, top_scroll_margin
;
15056 struct glyph_row
*row
= NULL
;
15059 debug_method_add (w
, "cursor movement");
15062 /* Scroll if point within this distance from the top or bottom
15063 of the window. This is a pixel value. */
15064 if (scroll_margin
> 0)
15066 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15067 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15070 this_scroll_margin
= 0;
15072 top_scroll_margin
= this_scroll_margin
;
15073 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15074 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15076 /* Start with the row the cursor was displayed during the last
15077 not paused redisplay. Give up if that row is not valid. */
15078 if (w
->last_cursor
.vpos
< 0
15079 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
15080 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15083 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
15084 if (row
->mode_line_p
)
15086 if (!row
->enabled_p
)
15087 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15090 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15092 int scroll_p
= 0, must_scroll
= 0;
15093 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15095 if (PT
> w
->last_point
)
15097 /* Point has moved forward. */
15098 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15099 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15101 eassert (row
->enabled_p
);
15105 /* If the end position of a row equals the start
15106 position of the next row, and PT is at that position,
15107 we would rather display cursor in the next line. */
15108 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15109 && MATRIX_ROW_END_CHARPOS (row
) == PT
15110 && row
< w
->current_matrix
->rows
15111 + w
->current_matrix
->nrows
- 1
15112 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15113 && !cursor_row_p (row
))
15116 /* If within the scroll margin, scroll. Note that
15117 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15118 the next line would be drawn, and that
15119 this_scroll_margin can be zero. */
15120 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15121 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15122 /* Line is completely visible last line in window
15123 and PT is to be set in the next line. */
15124 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15125 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15126 && !row
->ends_at_zv_p
15127 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15130 else if (PT
< w
->last_point
)
15132 /* Cursor has to be moved backward. Note that PT >=
15133 CHARPOS (startp) because of the outer if-statement. */
15134 while (!row
->mode_line_p
15135 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15136 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15137 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15138 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15139 row
> w
->current_matrix
->rows
15140 && (row
-1)->ends_in_newline_from_string_p
))))
15141 && (row
->y
> top_scroll_margin
15142 || CHARPOS (startp
) == BEGV
))
15144 eassert (row
->enabled_p
);
15148 /* Consider the following case: Window starts at BEGV,
15149 there is invisible, intangible text at BEGV, so that
15150 display starts at some point START > BEGV. It can
15151 happen that we are called with PT somewhere between
15152 BEGV and START. Try to handle that case. */
15153 if (row
< w
->current_matrix
->rows
15154 || row
->mode_line_p
)
15156 row
= w
->current_matrix
->rows
;
15157 if (row
->mode_line_p
)
15161 /* Due to newlines in overlay strings, we may have to
15162 skip forward over overlay strings. */
15163 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15164 && MATRIX_ROW_END_CHARPOS (row
) == PT
15165 && !cursor_row_p (row
))
15168 /* If within the scroll margin, scroll. */
15169 if (row
->y
< top_scroll_margin
15170 && CHARPOS (startp
) != BEGV
)
15175 /* Cursor did not move. So don't scroll even if cursor line
15176 is partially visible, as it was so before. */
15177 rc
= CURSOR_MOVEMENT_SUCCESS
;
15180 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15181 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15183 /* if PT is not in the glyph row, give up. */
15184 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15187 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15188 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15190 struct glyph_row
*row1
;
15192 /* If rows are bidi-reordered and point moved, back up
15193 until we find a row that does not belong to a
15194 continuation line. This is because we must consider
15195 all rows of a continued line as candidates for the
15196 new cursor positioning, since row start and end
15197 positions change non-linearly with vertical position
15199 /* FIXME: Revisit this when glyph ``spilling'' in
15200 continuation lines' rows is implemented for
15201 bidi-reordered rows. */
15202 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15203 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15206 /* If we hit the beginning of the displayed portion
15207 without finding the first row of a continued
15211 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15214 eassert (row
->enabled_p
);
15219 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15220 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15221 /* Make sure this isn't a header line by any chance, since
15222 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15223 && !row
->mode_line_p
15224 && make_cursor_line_fully_visible_p
)
15226 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15227 && !row
->ends_at_zv_p
15228 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15229 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15230 else if (row
->height
> window_box_height (w
))
15232 /* If we end up in a partially visible line, let's
15233 make it fully visible, except when it's taller
15234 than the window, in which case we can't do much
15237 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15241 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15242 if (!cursor_row_fully_visible_p (w
, 0, 1))
15243 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15245 rc
= CURSOR_MOVEMENT_SUCCESS
;
15249 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15250 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15251 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15253 /* With bidi-reordered rows, there could be more than
15254 one candidate row whose start and end positions
15255 occlude point. We need to let set_cursor_from_row
15256 find the best candidate. */
15257 /* FIXME: Revisit this when glyph ``spilling'' in
15258 continuation lines' rows is implemented for
15259 bidi-reordered rows. */
15264 int at_zv_p
= 0, exact_match_p
= 0;
15266 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15267 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15268 && cursor_row_p (row
))
15269 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15271 /* As soon as we've found the exact match for point,
15272 or the first suitable row whose ends_at_zv_p flag
15273 is set, we are done. */
15275 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15277 && w
->cursor
.hpos
>= 0
15278 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15281 struct glyph_row
*candidate
=
15282 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15284 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15285 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15288 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15289 || (INTEGERP (g
->object
)
15290 && (g
->charpos
== PT
15291 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15293 if (rv
&& (at_zv_p
|| exact_match_p
))
15295 rc
= CURSOR_MOVEMENT_SUCCESS
;
15298 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15302 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15303 || row
->continued_p
)
15304 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15305 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15306 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15307 /* If we didn't find any candidate rows, or exited the
15308 loop before all the candidates were examined, signal
15309 to the caller that this method failed. */
15310 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15312 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15313 && !row
->continued_p
))
15314 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15316 rc
= CURSOR_MOVEMENT_SUCCESS
;
15322 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15324 rc
= CURSOR_MOVEMENT_SUCCESS
;
15329 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15330 && MATRIX_ROW_START_CHARPOS (row
) == PT
15331 && cursor_row_p (row
));
15339 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15343 set_vertical_scroll_bar (struct window
*w
)
15345 ptrdiff_t start
, end
, whole
;
15347 /* Calculate the start and end positions for the current window.
15348 At some point, it would be nice to choose between scrollbars
15349 which reflect the whole buffer size, with special markers
15350 indicating narrowing, and scrollbars which reflect only the
15353 Note that mini-buffers sometimes aren't displaying any text. */
15354 if (!MINI_WINDOW_P (w
)
15355 || (w
== XWINDOW (minibuf_window
)
15356 && NILP (echo_area_buffer
[0])))
15358 struct buffer
*buf
= XBUFFER (w
->buffer
);
15359 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15360 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15361 /* I don't think this is guaranteed to be right. For the
15362 moment, we'll pretend it is. */
15363 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15367 if (whole
< (end
- start
))
15368 whole
= end
- start
;
15371 start
= end
= whole
= 0;
15373 /* Indicate what this scroll bar ought to be displaying now. */
15374 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15375 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15376 (w
, end
- start
, whole
, start
);
15380 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15381 selected_window is redisplayed.
15383 We can return without actually redisplaying the window if
15384 fonts_changed_p. In that case, redisplay_internal will
15388 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15390 struct window
*w
= XWINDOW (window
);
15391 struct frame
*f
= XFRAME (w
->frame
);
15392 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15393 struct buffer
*old
= current_buffer
;
15394 struct text_pos lpoint
, opoint
, startp
;
15395 int update_mode_line
;
15398 /* Record it now because it's overwritten. */
15399 int current_matrix_up_to_date_p
= 0;
15400 int used_current_matrix_p
= 0;
15401 /* This is less strict than current_matrix_up_to_date_p.
15402 It indicates that the buffer contents and narrowing are unchanged. */
15403 int buffer_unchanged_p
= 0;
15404 int temp_scroll_step
= 0;
15405 ptrdiff_t count
= SPECPDL_INDEX ();
15407 int centering_position
= -1;
15408 int last_line_misfit
= 0;
15409 ptrdiff_t beg_unchanged
, end_unchanged
;
15411 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15414 /* W must be a leaf window here. */
15415 eassert (!NILP (w
->buffer
));
15417 *w
->desired_matrix
->method
= 0;
15421 reconsider_clip_changes (w
, buffer
);
15423 /* Has the mode line to be updated? */
15424 update_mode_line
= (w
->update_mode_line
15425 || update_mode_lines
15426 || buffer
->clip_changed
15427 || buffer
->prevent_redisplay_optimizations_p
);
15429 if (MINI_WINDOW_P (w
))
15431 if (w
== XWINDOW (echo_area_window
)
15432 && !NILP (echo_area_buffer
[0]))
15434 if (update_mode_line
)
15435 /* We may have to update a tty frame's menu bar or a
15436 tool-bar. Example `M-x C-h C-h C-g'. */
15437 goto finish_menu_bars
;
15439 /* We've already displayed the echo area glyphs in this window. */
15440 goto finish_scroll_bars
;
15442 else if ((w
!= XWINDOW (minibuf_window
)
15443 || minibuf_level
== 0)
15444 /* When buffer is nonempty, redisplay window normally. */
15445 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15446 /* Quail displays non-mini buffers in minibuffer window.
15447 In that case, redisplay the window normally. */
15448 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15450 /* W is a mini-buffer window, but it's not active, so clear
15452 int yb
= window_text_bottom_y (w
);
15453 struct glyph_row
*row
;
15456 for (y
= 0, row
= w
->desired_matrix
->rows
;
15458 y
+= row
->height
, ++row
)
15459 blank_row (w
, row
, y
);
15460 goto finish_scroll_bars
;
15463 clear_glyph_matrix (w
->desired_matrix
);
15466 /* Otherwise set up data on this window; select its buffer and point
15468 /* Really select the buffer, for the sake of buffer-local
15470 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15472 current_matrix_up_to_date_p
15473 = (!NILP (w
->window_end_valid
)
15474 && !current_buffer
->clip_changed
15475 && !current_buffer
->prevent_redisplay_optimizations_p
15476 && !window_outdated (w
));
15478 /* Run the window-bottom-change-functions
15479 if it is possible that the text on the screen has changed
15480 (either due to modification of the text, or any other reason). */
15481 if (!current_matrix_up_to_date_p
15482 && !NILP (Vwindow_text_change_functions
))
15484 safe_run_hooks (Qwindow_text_change_functions
);
15488 beg_unchanged
= BEG_UNCHANGED
;
15489 end_unchanged
= END_UNCHANGED
;
15491 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15493 specbind (Qinhibit_point_motion_hooks
, Qt
);
15496 = (!NILP (w
->window_end_valid
)
15497 && !current_buffer
->clip_changed
15498 && !window_outdated (w
));
15500 /* When windows_or_buffers_changed is non-zero, we can't rely on
15501 the window end being valid, so set it to nil there. */
15502 if (windows_or_buffers_changed
)
15504 /* If window starts on a continuation line, maybe adjust the
15505 window start in case the window's width changed. */
15506 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15507 compute_window_start_on_continuation_line (w
);
15509 wset_window_end_valid (w
, Qnil
);
15512 /* Some sanity checks. */
15513 CHECK_WINDOW_END (w
);
15514 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15516 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15519 if (mode_line_update_needed (w
))
15520 update_mode_line
= 1;
15522 /* Point refers normally to the selected window. For any other
15523 window, set up appropriate value. */
15524 if (!EQ (window
, selected_window
))
15526 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15527 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15531 new_pt_byte
= BEGV_BYTE
;
15532 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15534 else if (new_pt
> (ZV
- 1))
15537 new_pt_byte
= ZV_BYTE
;
15538 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15541 /* We don't use SET_PT so that the point-motion hooks don't run. */
15542 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15545 /* If any of the character widths specified in the display table
15546 have changed, invalidate the width run cache. It's true that
15547 this may be a bit late to catch such changes, but the rest of
15548 redisplay goes (non-fatally) haywire when the display table is
15549 changed, so why should we worry about doing any better? */
15550 if (current_buffer
->width_run_cache
)
15552 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15554 if (! disptab_matches_widthtab
15555 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15557 invalidate_region_cache (current_buffer
,
15558 current_buffer
->width_run_cache
,
15560 recompute_width_table (current_buffer
, disptab
);
15564 /* If window-start is screwed up, choose a new one. */
15565 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15568 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15570 /* If someone specified a new starting point but did not insist,
15571 check whether it can be used. */
15572 if (w
->optional_new_start
15573 && CHARPOS (startp
) >= BEGV
15574 && CHARPOS (startp
) <= ZV
)
15576 w
->optional_new_start
= 0;
15577 start_display (&it
, w
, startp
);
15578 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15579 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15580 if (IT_CHARPOS (it
) == PT
)
15581 w
->force_start
= 1;
15582 /* IT may overshoot PT if text at PT is invisible. */
15583 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15584 w
->force_start
= 1;
15589 /* Handle case where place to start displaying has been specified,
15590 unless the specified location is outside the accessible range. */
15591 if (w
->force_start
|| w
->frozen_window_start_p
)
15593 /* We set this later on if we have to adjust point. */
15596 w
->force_start
= 0;
15598 wset_window_end_valid (w
, Qnil
);
15600 /* Forget any recorded base line for line number display. */
15601 if (!buffer_unchanged_p
)
15602 wset_base_line_number (w
, Qnil
);
15604 /* Redisplay the mode line. Select the buffer properly for that.
15605 Also, run the hook window-scroll-functions
15606 because we have scrolled. */
15607 /* Note, we do this after clearing force_start because
15608 if there's an error, it is better to forget about force_start
15609 than to get into an infinite loop calling the hook functions
15610 and having them get more errors. */
15611 if (!update_mode_line
15612 || ! NILP (Vwindow_scroll_functions
))
15614 update_mode_line
= 1;
15615 w
->update_mode_line
= 1;
15616 startp
= run_window_scroll_functions (window
, startp
);
15619 w
->last_modified
= 0;
15620 w
->last_overlay_modified
= 0;
15621 if (CHARPOS (startp
) < BEGV
)
15622 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15623 else if (CHARPOS (startp
) > ZV
)
15624 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15626 /* Redisplay, then check if cursor has been set during the
15627 redisplay. Give up if new fonts were loaded. */
15628 /* We used to issue a CHECK_MARGINS argument to try_window here,
15629 but this causes scrolling to fail when point begins inside
15630 the scroll margin (bug#148) -- cyd */
15631 if (!try_window (window
, startp
, 0))
15633 w
->force_start
= 1;
15634 clear_glyph_matrix (w
->desired_matrix
);
15635 goto need_larger_matrices
;
15638 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15640 /* If point does not appear, try to move point so it does
15641 appear. The desired matrix has been built above, so we
15642 can use it here. */
15643 new_vpos
= window_box_height (w
) / 2;
15646 if (!cursor_row_fully_visible_p (w
, 0, 0))
15648 /* Point does appear, but on a line partly visible at end of window.
15649 Move it back to a fully-visible line. */
15650 new_vpos
= window_box_height (w
);
15652 else if (w
->cursor
.vpos
>=0)
15654 /* Some people insist on not letting point enter the scroll
15655 margin, even though this part handles windows that didn't
15657 int margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15658 int pixel_margin
= margin
* FRAME_LINE_HEIGHT (f
);
15659 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
15661 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
15662 below, which finds the row to move point to, advances by
15663 the Y coordinate of the _next_ row, see the definition of
15664 MATRIX_ROW_BOTTOM_Y. */
15665 if (w
->cursor
.vpos
< margin
+ header_line
)
15667 = pixel_margin
+ (header_line
15668 ? CURRENT_HEADER_LINE_HEIGHT (w
)
15669 : 0) + FRAME_LINE_HEIGHT (f
);
15672 int window_height
= window_box_height (w
);
15675 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15676 if (w
->cursor
.y
>= window_height
- pixel_margin
)
15677 new_vpos
= window_height
- pixel_margin
;
15681 /* If we need to move point for either of the above reasons,
15682 now actually do it. */
15685 struct glyph_row
*row
;
15687 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15688 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15691 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15692 MATRIX_ROW_START_BYTEPOS (row
));
15694 if (w
!= XWINDOW (selected_window
))
15695 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15696 else if (current_buffer
== old
)
15697 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15699 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15701 /* If we are highlighting the region, then we just changed
15702 the region, so redisplay to show it. */
15703 if (0 <= markpos_of_region ())
15705 clear_glyph_matrix (w
->desired_matrix
);
15706 if (!try_window (window
, startp
, 0))
15707 goto need_larger_matrices
;
15712 debug_method_add (w
, "forced window start");
15717 /* Handle case where text has not changed, only point, and it has
15718 not moved off the frame, and we are not retrying after hscroll.
15719 (current_matrix_up_to_date_p is nonzero when retrying.) */
15720 if (current_matrix_up_to_date_p
15721 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15722 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15726 case CURSOR_MOVEMENT_SUCCESS
:
15727 used_current_matrix_p
= 1;
15730 case CURSOR_MOVEMENT_MUST_SCROLL
:
15731 goto try_to_scroll
;
15737 /* If current starting point was originally the beginning of a line
15738 but no longer is, find a new starting point. */
15739 else if (w
->start_at_line_beg
15740 && !(CHARPOS (startp
) <= BEGV
15741 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15744 debug_method_add (w
, "recenter 1");
15749 /* Try scrolling with try_window_id. Value is > 0 if update has
15750 been done, it is -1 if we know that the same window start will
15751 not work. It is 0 if unsuccessful for some other reason. */
15752 else if ((tem
= try_window_id (w
)) != 0)
15755 debug_method_add (w
, "try_window_id %d", tem
);
15758 if (fonts_changed_p
)
15759 goto need_larger_matrices
;
15763 /* Otherwise try_window_id has returned -1 which means that we
15764 don't want the alternative below this comment to execute. */
15766 else if (CHARPOS (startp
) >= BEGV
15767 && CHARPOS (startp
) <= ZV
15768 && PT
>= CHARPOS (startp
)
15769 && (CHARPOS (startp
) < ZV
15770 /* Avoid starting at end of buffer. */
15771 || CHARPOS (startp
) == BEGV
15772 || !window_outdated (w
)))
15774 int d1
, d2
, d3
, d4
, d5
, d6
;
15776 /* If first window line is a continuation line, and window start
15777 is inside the modified region, but the first change is before
15778 current window start, we must select a new window start.
15780 However, if this is the result of a down-mouse event (e.g. by
15781 extending the mouse-drag-overlay), we don't want to select a
15782 new window start, since that would change the position under
15783 the mouse, resulting in an unwanted mouse-movement rather
15784 than a simple mouse-click. */
15785 if (!w
->start_at_line_beg
15786 && NILP (do_mouse_tracking
)
15787 && CHARPOS (startp
) > BEGV
15788 && CHARPOS (startp
) > BEG
+ beg_unchanged
15789 && CHARPOS (startp
) <= Z
- end_unchanged
15790 /* Even if w->start_at_line_beg is nil, a new window may
15791 start at a line_beg, since that's how set_buffer_window
15792 sets it. So, we need to check the return value of
15793 compute_window_start_on_continuation_line. (See also
15795 && XMARKER (w
->start
)->buffer
== current_buffer
15796 && compute_window_start_on_continuation_line (w
)
15797 /* It doesn't make sense to force the window start like we
15798 do at label force_start if it is already known that point
15799 will not be visible in the resulting window, because
15800 doing so will move point from its correct position
15801 instead of scrolling the window to bring point into view.
15803 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15805 w
->force_start
= 1;
15806 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15811 debug_method_add (w
, "same window start");
15814 /* Try to redisplay starting at same place as before.
15815 If point has not moved off frame, accept the results. */
15816 if (!current_matrix_up_to_date_p
15817 /* Don't use try_window_reusing_current_matrix in this case
15818 because a window scroll function can have changed the
15820 || !NILP (Vwindow_scroll_functions
)
15821 || MINI_WINDOW_P (w
)
15822 || !(used_current_matrix_p
15823 = try_window_reusing_current_matrix (w
)))
15825 IF_DEBUG (debug_method_add (w
, "1"));
15826 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15827 /* -1 means we need to scroll.
15828 0 means we need new matrices, but fonts_changed_p
15829 is set in that case, so we will detect it below. */
15830 goto try_to_scroll
;
15833 if (fonts_changed_p
)
15834 goto need_larger_matrices
;
15836 if (w
->cursor
.vpos
>= 0)
15838 if (!just_this_one_p
15839 || current_buffer
->clip_changed
15840 || BEG_UNCHANGED
< CHARPOS (startp
))
15841 /* Forget any recorded base line for line number display. */
15842 wset_base_line_number (w
, Qnil
);
15844 if (!cursor_row_fully_visible_p (w
, 1, 0))
15846 clear_glyph_matrix (w
->desired_matrix
);
15847 last_line_misfit
= 1;
15849 /* Drop through and scroll. */
15854 clear_glyph_matrix (w
->desired_matrix
);
15859 w
->last_modified
= 0;
15860 w
->last_overlay_modified
= 0;
15862 /* Redisplay the mode line. Select the buffer properly for that. */
15863 if (!update_mode_line
)
15865 update_mode_line
= 1;
15866 w
->update_mode_line
= 1;
15869 /* Try to scroll by specified few lines. */
15870 if ((scroll_conservatively
15871 || emacs_scroll_step
15872 || temp_scroll_step
15873 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15874 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15875 && CHARPOS (startp
) >= BEGV
15876 && CHARPOS (startp
) <= ZV
)
15878 /* The function returns -1 if new fonts were loaded, 1 if
15879 successful, 0 if not successful. */
15880 int ss
= try_scrolling (window
, just_this_one_p
,
15881 scroll_conservatively
,
15883 temp_scroll_step
, last_line_misfit
);
15886 case SCROLLING_SUCCESS
:
15889 case SCROLLING_NEED_LARGER_MATRICES
:
15890 goto need_larger_matrices
;
15892 case SCROLLING_FAILED
:
15900 /* Finally, just choose a place to start which positions point
15901 according to user preferences. */
15906 debug_method_add (w
, "recenter");
15909 /* w->vscroll = 0; */
15911 /* Forget any previously recorded base line for line number display. */
15912 if (!buffer_unchanged_p
)
15913 wset_base_line_number (w
, Qnil
);
15915 /* Determine the window start relative to point. */
15916 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15917 it
.current_y
= it
.last_visible_y
;
15918 if (centering_position
< 0)
15922 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15924 ptrdiff_t margin_pos
= CHARPOS (startp
);
15925 Lisp_Object aggressive
;
15928 /* If there is a scroll margin at the top of the window, find
15929 its character position. */
15931 /* Cannot call start_display if startp is not in the
15932 accessible region of the buffer. This can happen when we
15933 have just switched to a different buffer and/or changed
15934 its restriction. In that case, startp is initialized to
15935 the character position 1 (BEGV) because we did not yet
15936 have chance to display the buffer even once. */
15937 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15940 void *it1data
= NULL
;
15942 SAVE_IT (it1
, it
, it1data
);
15943 start_display (&it1
, w
, startp
);
15944 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15945 margin_pos
= IT_CHARPOS (it1
);
15946 RESTORE_IT (&it
, &it
, it1data
);
15948 scrolling_up
= PT
> margin_pos
;
15951 ? BVAR (current_buffer
, scroll_up_aggressively
)
15952 : BVAR (current_buffer
, scroll_down_aggressively
);
15954 if (!MINI_WINDOW_P (w
)
15955 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15959 /* Setting scroll-conservatively overrides
15960 scroll-*-aggressively. */
15961 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15963 double float_amount
= XFLOATINT (aggressive
);
15965 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15966 if (pt_offset
== 0 && float_amount
> 0)
15968 if (pt_offset
&& margin
> 0)
15971 /* Compute how much to move the window start backward from
15972 point so that point will be displayed where the user
15976 centering_position
= it
.last_visible_y
;
15978 centering_position
-= pt_offset
;
15979 centering_position
-=
15980 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15981 + WINDOW_HEADER_LINE_HEIGHT (w
);
15982 /* Don't let point enter the scroll margin near top of
15984 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15985 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15988 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15991 /* Set the window start half the height of the window backward
15993 centering_position
= window_box_height (w
) / 2;
15995 move_it_vertically_backward (&it
, centering_position
);
15997 eassert (IT_CHARPOS (it
) >= BEGV
);
15999 /* The function move_it_vertically_backward may move over more
16000 than the specified y-distance. If it->w is small, e.g. a
16001 mini-buffer window, we may end up in front of the window's
16002 display area. Start displaying at the start of the line
16003 containing PT in this case. */
16004 if (it
.current_y
<= 0)
16006 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16007 move_it_vertically_backward (&it
, 0);
16011 it
.current_x
= it
.hpos
= 0;
16013 /* Set the window start position here explicitly, to avoid an
16014 infinite loop in case the functions in window-scroll-functions
16016 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16018 /* Run scroll hooks. */
16019 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16021 /* Redisplay the window. */
16022 if (!current_matrix_up_to_date_p
16023 || windows_or_buffers_changed
16024 || cursor_type_changed
16025 /* Don't use try_window_reusing_current_matrix in this case
16026 because it can have changed the buffer. */
16027 || !NILP (Vwindow_scroll_functions
)
16028 || !just_this_one_p
16029 || MINI_WINDOW_P (w
)
16030 || !(used_current_matrix_p
16031 = try_window_reusing_current_matrix (w
)))
16032 try_window (window
, startp
, 0);
16034 /* If new fonts have been loaded (due to fontsets), give up. We
16035 have to start a new redisplay since we need to re-adjust glyph
16037 if (fonts_changed_p
)
16038 goto need_larger_matrices
;
16040 /* If cursor did not appear assume that the middle of the window is
16041 in the first line of the window. Do it again with the next line.
16042 (Imagine a window of height 100, displaying two lines of height
16043 60. Moving back 50 from it->last_visible_y will end in the first
16045 if (w
->cursor
.vpos
< 0)
16047 if (!NILP (w
->window_end_valid
)
16048 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
16050 clear_glyph_matrix (w
->desired_matrix
);
16051 move_it_by_lines (&it
, 1);
16052 try_window (window
, it
.current
.pos
, 0);
16054 else if (PT
< IT_CHARPOS (it
))
16056 clear_glyph_matrix (w
->desired_matrix
);
16057 move_it_by_lines (&it
, -1);
16058 try_window (window
, it
.current
.pos
, 0);
16062 /* Not much we can do about it. */
16066 /* Consider the following case: Window starts at BEGV, there is
16067 invisible, intangible text at BEGV, so that display starts at
16068 some point START > BEGV. It can happen that we are called with
16069 PT somewhere between BEGV and START. Try to handle that case. */
16070 if (w
->cursor
.vpos
< 0)
16072 struct glyph_row
*row
= w
->current_matrix
->rows
;
16073 if (row
->mode_line_p
)
16075 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16078 if (!cursor_row_fully_visible_p (w
, 0, 0))
16080 /* If vscroll is enabled, disable it and try again. */
16084 clear_glyph_matrix (w
->desired_matrix
);
16088 /* Users who set scroll-conservatively to a large number want
16089 point just above/below the scroll margin. If we ended up
16090 with point's row partially visible, move the window start to
16091 make that row fully visible and out of the margin. */
16092 if (scroll_conservatively
> SCROLL_LIMIT
)
16096 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
16098 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
16100 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16101 clear_glyph_matrix (w
->desired_matrix
);
16102 if (1 == try_window (window
, it
.current
.pos
,
16103 TRY_WINDOW_CHECK_MARGINS
))
16107 /* If centering point failed to make the whole line visible,
16108 put point at the top instead. That has to make the whole line
16109 visible, if it can be done. */
16110 if (centering_position
== 0)
16113 clear_glyph_matrix (w
->desired_matrix
);
16114 centering_position
= 0;
16120 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16121 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16122 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16124 /* Display the mode line, if we must. */
16125 if ((update_mode_line
16126 /* If window not full width, must redo its mode line
16127 if (a) the window to its side is being redone and
16128 (b) we do a frame-based redisplay. This is a consequence
16129 of how inverted lines are drawn in frame-based redisplay. */
16130 || (!just_this_one_p
16131 && !FRAME_WINDOW_P (f
)
16132 && !WINDOW_FULL_WIDTH_P (w
))
16133 /* Line number to display. */
16134 || INTEGERP (w
->base_line_pos
)
16135 /* Column number is displayed and different from the one displayed. */
16136 || (!NILP (w
->column_number_displayed
)
16137 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
16138 /* This means that the window has a mode line. */
16139 && (WINDOW_WANTS_MODELINE_P (w
)
16140 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16142 display_mode_lines (w
);
16144 /* If mode line height has changed, arrange for a thorough
16145 immediate redisplay using the correct mode line height. */
16146 if (WINDOW_WANTS_MODELINE_P (w
)
16147 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16149 fonts_changed_p
= 1;
16150 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16151 = DESIRED_MODE_LINE_HEIGHT (w
);
16154 /* If header line height has changed, arrange for a thorough
16155 immediate redisplay using the correct header line height. */
16156 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16157 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16159 fonts_changed_p
= 1;
16160 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16161 = DESIRED_HEADER_LINE_HEIGHT (w
);
16164 if (fonts_changed_p
)
16165 goto need_larger_matrices
;
16168 if (!line_number_displayed
16169 && !BUFFERP (w
->base_line_pos
))
16171 wset_base_line_pos (w
, Qnil
);
16172 wset_base_line_number (w
, Qnil
);
16177 /* When we reach a frame's selected window, redo the frame's menu bar. */
16178 if (update_mode_line
16179 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16181 int redisplay_menu_p
= 0;
16183 if (FRAME_WINDOW_P (f
))
16185 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16186 || defined (HAVE_NS) || defined (USE_GTK)
16187 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16189 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16193 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16195 if (redisplay_menu_p
)
16196 display_menu_bar (w
);
16198 #ifdef HAVE_WINDOW_SYSTEM
16199 if (FRAME_WINDOW_P (f
))
16201 #if defined (USE_GTK) || defined (HAVE_NS)
16202 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16203 redisplay_tool_bar (f
);
16205 if (WINDOWP (f
->tool_bar_window
)
16206 && (FRAME_TOOL_BAR_LINES (f
) > 0
16207 || !NILP (Vauto_resize_tool_bars
))
16208 && redisplay_tool_bar (f
))
16209 ignore_mouse_drag_p
= 1;
16215 #ifdef HAVE_WINDOW_SYSTEM
16216 if (FRAME_WINDOW_P (f
)
16217 && update_window_fringes (w
, (just_this_one_p
16218 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16219 || w
->pseudo_window_p
)))
16223 if (draw_window_fringes (w
, 1))
16224 x_draw_vertical_border (w
);
16228 #endif /* HAVE_WINDOW_SYSTEM */
16230 /* We go to this label, with fonts_changed_p set,
16231 if it is necessary to try again using larger glyph matrices.
16232 We have to redeem the scroll bar even in this case,
16233 because the loop in redisplay_internal expects that. */
16234 need_larger_matrices
:
16236 finish_scroll_bars
:
16238 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16240 /* Set the thumb's position and size. */
16241 set_vertical_scroll_bar (w
);
16243 /* Note that we actually used the scroll bar attached to this
16244 window, so it shouldn't be deleted at the end of redisplay. */
16245 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16246 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16249 /* Restore current_buffer and value of point in it. The window
16250 update may have changed the buffer, so first make sure `opoint'
16251 is still valid (Bug#6177). */
16252 if (CHARPOS (opoint
) < BEGV
)
16253 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16254 else if (CHARPOS (opoint
) > ZV
)
16255 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16257 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16259 set_buffer_internal_1 (old
);
16260 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16261 shorter. This can be caused by log truncation in *Messages*. */
16262 if (CHARPOS (lpoint
) <= ZV
)
16263 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16265 unbind_to (count
, Qnil
);
16269 /* Build the complete desired matrix of WINDOW with a window start
16270 buffer position POS.
16272 Value is 1 if successful. It is zero if fonts were loaded during
16273 redisplay which makes re-adjusting glyph matrices necessary, and -1
16274 if point would appear in the scroll margins.
16275 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16276 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16280 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16282 struct window
*w
= XWINDOW (window
);
16284 struct glyph_row
*last_text_row
= NULL
;
16285 struct frame
*f
= XFRAME (w
->frame
);
16287 /* Make POS the new window start. */
16288 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16290 /* Mark cursor position as unknown. No overlay arrow seen. */
16291 w
->cursor
.vpos
= -1;
16292 overlay_arrow_seen
= 0;
16294 /* Initialize iterator and info to start at POS. */
16295 start_display (&it
, w
, pos
);
16297 /* Display all lines of W. */
16298 while (it
.current_y
< it
.last_visible_y
)
16300 if (display_line (&it
))
16301 last_text_row
= it
.glyph_row
- 1;
16302 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16306 /* Don't let the cursor end in the scroll margins. */
16307 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16308 && !MINI_WINDOW_P (w
))
16310 int this_scroll_margin
;
16312 if (scroll_margin
> 0)
16314 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16315 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16318 this_scroll_margin
= 0;
16320 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16321 && w
->cursor
.y
< this_scroll_margin
16322 && CHARPOS (pos
) > BEGV
16323 && IT_CHARPOS (it
) < ZV
)
16324 /* rms: considering make_cursor_line_fully_visible_p here
16325 seems to give wrong results. We don't want to recenter
16326 when the last line is partly visible, we want to allow
16327 that case to be handled in the usual way. */
16328 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16330 w
->cursor
.vpos
= -1;
16331 clear_glyph_matrix (w
->desired_matrix
);
16336 /* If bottom moved off end of frame, change mode line percentage. */
16337 if (XFASTINT (w
->window_end_pos
) <= 0
16338 && Z
!= IT_CHARPOS (it
))
16339 w
->update_mode_line
= 1;
16341 /* Set window_end_pos to the offset of the last character displayed
16342 on the window from the end of current_buffer. Set
16343 window_end_vpos to its row number. */
16346 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16347 w
->window_end_bytepos
16348 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16349 wset_window_end_pos
16350 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16351 wset_window_end_vpos
16352 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
)));
16354 (MATRIX_ROW (w
->desired_matrix
,
16355 XFASTINT (w
->window_end_vpos
))->displays_text_p
);
16359 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16360 wset_window_end_pos (w
, make_number (Z
- ZV
));
16361 wset_window_end_vpos (w
, make_number (0));
16364 /* But that is not valid info until redisplay finishes. */
16365 wset_window_end_valid (w
, Qnil
);
16371 /************************************************************************
16372 Window redisplay reusing current matrix when buffer has not changed
16373 ************************************************************************/
16375 /* Try redisplay of window W showing an unchanged buffer with a
16376 different window start than the last time it was displayed by
16377 reusing its current matrix. Value is non-zero if successful.
16378 W->start is the new window start. */
16381 try_window_reusing_current_matrix (struct window
*w
)
16383 struct frame
*f
= XFRAME (w
->frame
);
16384 struct glyph_row
*bottom_row
;
16387 struct text_pos start
, new_start
;
16388 int nrows_scrolled
, i
;
16389 struct glyph_row
*last_text_row
;
16390 struct glyph_row
*last_reused_text_row
;
16391 struct glyph_row
*start_row
;
16392 int start_vpos
, min_y
, max_y
;
16395 if (inhibit_try_window_reusing
)
16399 if (/* This function doesn't handle terminal frames. */
16400 !FRAME_WINDOW_P (f
)
16401 /* Don't try to reuse the display if windows have been split
16403 || windows_or_buffers_changed
16404 || cursor_type_changed
)
16407 /* Can't do this if region may have changed. */
16408 if (0 <= markpos_of_region ()
16409 || !NILP (w
->region_showing
)
16410 || !NILP (Vshow_trailing_whitespace
))
16413 /* If top-line visibility has changed, give up. */
16414 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16415 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16418 /* Give up if old or new display is scrolled vertically. We could
16419 make this function handle this, but right now it doesn't. */
16420 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16421 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16424 /* The variable new_start now holds the new window start. The old
16425 start `start' can be determined from the current matrix. */
16426 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16427 start
= start_row
->minpos
;
16428 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16430 /* Clear the desired matrix for the display below. */
16431 clear_glyph_matrix (w
->desired_matrix
);
16433 if (CHARPOS (new_start
) <= CHARPOS (start
))
16435 /* Don't use this method if the display starts with an ellipsis
16436 displayed for invisible text. It's not easy to handle that case
16437 below, and it's certainly not worth the effort since this is
16438 not a frequent case. */
16439 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16442 IF_DEBUG (debug_method_add (w
, "twu1"));
16444 /* Display up to a row that can be reused. The variable
16445 last_text_row is set to the last row displayed that displays
16446 text. Note that it.vpos == 0 if or if not there is a
16447 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16448 start_display (&it
, w
, new_start
);
16449 w
->cursor
.vpos
= -1;
16450 last_text_row
= last_reused_text_row
= NULL
;
16452 while (it
.current_y
< it
.last_visible_y
16453 && !fonts_changed_p
)
16455 /* If we have reached into the characters in the START row,
16456 that means the line boundaries have changed. So we
16457 can't start copying with the row START. Maybe it will
16458 work to start copying with the following row. */
16459 while (IT_CHARPOS (it
) > CHARPOS (start
))
16461 /* Advance to the next row as the "start". */
16463 start
= start_row
->minpos
;
16464 /* If there are no more rows to try, or just one, give up. */
16465 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16466 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16467 || CHARPOS (start
) == ZV
)
16469 clear_glyph_matrix (w
->desired_matrix
);
16473 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16475 /* If we have reached alignment, we can copy the rest of the
16477 if (IT_CHARPOS (it
) == CHARPOS (start
)
16478 /* Don't accept "alignment" inside a display vector,
16479 since start_row could have started in the middle of
16480 that same display vector (thus their character
16481 positions match), and we have no way of telling if
16482 that is the case. */
16483 && it
.current
.dpvec_index
< 0)
16486 if (display_line (&it
))
16487 last_text_row
= it
.glyph_row
- 1;
16491 /* A value of current_y < last_visible_y means that we stopped
16492 at the previous window start, which in turn means that we
16493 have at least one reusable row. */
16494 if (it
.current_y
< it
.last_visible_y
)
16496 struct glyph_row
*row
;
16498 /* IT.vpos always starts from 0; it counts text lines. */
16499 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16501 /* Find PT if not already found in the lines displayed. */
16502 if (w
->cursor
.vpos
< 0)
16504 int dy
= it
.current_y
- start_row
->y
;
16506 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16507 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16509 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16510 dy
, nrows_scrolled
);
16513 clear_glyph_matrix (w
->desired_matrix
);
16518 /* Scroll the display. Do it before the current matrix is
16519 changed. The problem here is that update has not yet
16520 run, i.e. part of the current matrix is not up to date.
16521 scroll_run_hook will clear the cursor, and use the
16522 current matrix to get the height of the row the cursor is
16524 run
.current_y
= start_row
->y
;
16525 run
.desired_y
= it
.current_y
;
16526 run
.height
= it
.last_visible_y
- it
.current_y
;
16528 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16531 FRAME_RIF (f
)->update_window_begin_hook (w
);
16532 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16533 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16534 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16538 /* Shift current matrix down by nrows_scrolled lines. */
16539 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16540 rotate_matrix (w
->current_matrix
,
16542 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16545 /* Disable lines that must be updated. */
16546 for (i
= 0; i
< nrows_scrolled
; ++i
)
16547 (start_row
+ i
)->enabled_p
= 0;
16549 /* Re-compute Y positions. */
16550 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16551 max_y
= it
.last_visible_y
;
16552 for (row
= start_row
+ nrows_scrolled
;
16556 row
->y
= it
.current_y
;
16557 row
->visible_height
= row
->height
;
16559 if (row
->y
< min_y
)
16560 row
->visible_height
-= min_y
- row
->y
;
16561 if (row
->y
+ row
->height
> max_y
)
16562 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16563 if (row
->fringe_bitmap_periodic_p
)
16564 row
->redraw_fringe_bitmaps_p
= 1;
16566 it
.current_y
+= row
->height
;
16568 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16569 last_reused_text_row
= row
;
16570 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16574 /* Disable lines in the current matrix which are now
16575 below the window. */
16576 for (++row
; row
< bottom_row
; ++row
)
16577 row
->enabled_p
= row
->mode_line_p
= 0;
16580 /* Update window_end_pos etc.; last_reused_text_row is the last
16581 reused row from the current matrix containing text, if any.
16582 The value of last_text_row is the last displayed line
16583 containing text. */
16584 if (last_reused_text_row
)
16586 w
->window_end_bytepos
16587 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16588 wset_window_end_pos
16590 - MATRIX_ROW_END_CHARPOS (last_reused_text_row
)));
16591 wset_window_end_vpos
16592 (w
, make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16593 w
->current_matrix
)));
16595 else if (last_text_row
)
16597 w
->window_end_bytepos
16598 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16599 wset_window_end_pos
16600 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16601 wset_window_end_vpos
16602 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16603 w
->desired_matrix
)));
16607 /* This window must be completely empty. */
16608 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16609 wset_window_end_pos (w
, make_number (Z
- ZV
));
16610 wset_window_end_vpos (w
, make_number (0));
16612 wset_window_end_valid (w
, Qnil
);
16614 /* Update hint: don't try scrolling again in update_window. */
16615 w
->desired_matrix
->no_scrolling_p
= 1;
16618 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16622 else if (CHARPOS (new_start
) > CHARPOS (start
))
16624 struct glyph_row
*pt_row
, *row
;
16625 struct glyph_row
*first_reusable_row
;
16626 struct glyph_row
*first_row_to_display
;
16628 int yb
= window_text_bottom_y (w
);
16630 /* Find the row starting at new_start, if there is one. Don't
16631 reuse a partially visible line at the end. */
16632 first_reusable_row
= start_row
;
16633 while (first_reusable_row
->enabled_p
16634 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16635 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16636 < CHARPOS (new_start
)))
16637 ++first_reusable_row
;
16639 /* Give up if there is no row to reuse. */
16640 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16641 || !first_reusable_row
->enabled_p
16642 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16643 != CHARPOS (new_start
)))
16646 /* We can reuse fully visible rows beginning with
16647 first_reusable_row to the end of the window. Set
16648 first_row_to_display to the first row that cannot be reused.
16649 Set pt_row to the row containing point, if there is any. */
16651 for (first_row_to_display
= first_reusable_row
;
16652 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16653 ++first_row_to_display
)
16655 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16656 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16657 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16658 && first_row_to_display
->ends_at_zv_p
16659 && pt_row
== NULL
)))
16660 pt_row
= first_row_to_display
;
16663 /* Start displaying at the start of first_row_to_display. */
16664 eassert (first_row_to_display
->y
< yb
);
16665 init_to_row_start (&it
, w
, first_row_to_display
);
16667 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16669 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16671 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16672 + WINDOW_HEADER_LINE_HEIGHT (w
));
16674 /* Display lines beginning with first_row_to_display in the
16675 desired matrix. Set last_text_row to the last row displayed
16676 that displays text. */
16677 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16678 if (pt_row
== NULL
)
16679 w
->cursor
.vpos
= -1;
16680 last_text_row
= NULL
;
16681 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16682 if (display_line (&it
))
16683 last_text_row
= it
.glyph_row
- 1;
16685 /* If point is in a reused row, adjust y and vpos of the cursor
16689 w
->cursor
.vpos
-= nrows_scrolled
;
16690 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16693 /* Give up if point isn't in a row displayed or reused. (This
16694 also handles the case where w->cursor.vpos < nrows_scrolled
16695 after the calls to display_line, which can happen with scroll
16696 margins. See bug#1295.) */
16697 if (w
->cursor
.vpos
< 0)
16699 clear_glyph_matrix (w
->desired_matrix
);
16703 /* Scroll the display. */
16704 run
.current_y
= first_reusable_row
->y
;
16705 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16706 run
.height
= it
.last_visible_y
- run
.current_y
;
16707 dy
= run
.current_y
- run
.desired_y
;
16712 FRAME_RIF (f
)->update_window_begin_hook (w
);
16713 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16714 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16715 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16719 /* Adjust Y positions of reused rows. */
16720 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16721 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16722 max_y
= it
.last_visible_y
;
16723 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16726 row
->visible_height
= row
->height
;
16727 if (row
->y
< min_y
)
16728 row
->visible_height
-= min_y
- row
->y
;
16729 if (row
->y
+ row
->height
> max_y
)
16730 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16731 if (row
->fringe_bitmap_periodic_p
)
16732 row
->redraw_fringe_bitmaps_p
= 1;
16735 /* Scroll the current matrix. */
16736 eassert (nrows_scrolled
> 0);
16737 rotate_matrix (w
->current_matrix
,
16739 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16742 /* Disable rows not reused. */
16743 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16744 row
->enabled_p
= 0;
16746 /* Point may have moved to a different line, so we cannot assume that
16747 the previous cursor position is valid; locate the correct row. */
16750 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16752 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16753 && !row
->ends_at_zv_p
;
16757 w
->cursor
.y
= row
->y
;
16759 if (row
< bottom_row
)
16761 /* Can't simply scan the row for point with
16762 bidi-reordered glyph rows. Let set_cursor_from_row
16763 figure out where to put the cursor, and if it fails,
16765 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16767 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
16770 clear_glyph_matrix (w
->desired_matrix
);
16776 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16777 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16780 && (!BUFFERP (glyph
->object
)
16781 || glyph
->charpos
< PT
);
16785 w
->cursor
.x
+= glyph
->pixel_width
;
16791 /* Adjust window end. A null value of last_text_row means that
16792 the window end is in reused rows which in turn means that
16793 only its vpos can have changed. */
16796 w
->window_end_bytepos
16797 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16798 wset_window_end_pos
16799 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16800 wset_window_end_vpos
16801 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16802 w
->desired_matrix
)));
16806 wset_window_end_vpos
16807 (w
, make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
));
16810 wset_window_end_valid (w
, Qnil
);
16811 w
->desired_matrix
->no_scrolling_p
= 1;
16814 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16824 /************************************************************************
16825 Window redisplay reusing current matrix when buffer has changed
16826 ************************************************************************/
16828 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16829 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16830 ptrdiff_t *, ptrdiff_t *);
16831 static struct glyph_row
*
16832 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16833 struct glyph_row
*);
16836 /* Return the last row in MATRIX displaying text. If row START is
16837 non-null, start searching with that row. IT gives the dimensions
16838 of the display. Value is null if matrix is empty; otherwise it is
16839 a pointer to the row found. */
16841 static struct glyph_row
*
16842 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16843 struct glyph_row
*start
)
16845 struct glyph_row
*row
, *row_found
;
16847 /* Set row_found to the last row in IT->w's current matrix
16848 displaying text. The loop looks funny but think of partially
16851 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16852 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16854 eassert (row
->enabled_p
);
16856 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16865 /* Return the last row in the current matrix of W that is not affected
16866 by changes at the start of current_buffer that occurred since W's
16867 current matrix was built. Value is null if no such row exists.
16869 BEG_UNCHANGED us the number of characters unchanged at the start of
16870 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16871 first changed character in current_buffer. Characters at positions <
16872 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16873 when the current matrix was built. */
16875 static struct glyph_row
*
16876 find_last_unchanged_at_beg_row (struct window
*w
)
16878 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16879 struct glyph_row
*row
;
16880 struct glyph_row
*row_found
= NULL
;
16881 int yb
= window_text_bottom_y (w
);
16883 /* Find the last row displaying unchanged text. */
16884 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16885 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16886 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16889 if (/* If row ends before first_changed_pos, it is unchanged,
16890 except in some case. */
16891 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16892 /* When row ends in ZV and we write at ZV it is not
16894 && !row
->ends_at_zv_p
16895 /* When first_changed_pos is the end of a continued line,
16896 row is not unchanged because it may be no longer
16898 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16899 && (row
->continued_p
16900 || row
->exact_window_width_line_p
))
16901 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16902 needs to be recomputed, so don't consider this row as
16903 unchanged. This happens when the last line was
16904 bidi-reordered and was killed immediately before this
16905 redisplay cycle. In that case, ROW->end stores the
16906 buffer position of the first visual-order character of
16907 the killed text, which is now beyond ZV. */
16908 && CHARPOS (row
->end
.pos
) <= ZV
)
16911 /* Stop if last visible row. */
16912 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16920 /* Find the first glyph row in the current matrix of W that is not
16921 affected by changes at the end of current_buffer since the
16922 time W's current matrix was built.
16924 Return in *DELTA the number of chars by which buffer positions in
16925 unchanged text at the end of current_buffer must be adjusted.
16927 Return in *DELTA_BYTES the corresponding number of bytes.
16929 Value is null if no such row exists, i.e. all rows are affected by
16932 static struct glyph_row
*
16933 find_first_unchanged_at_end_row (struct window
*w
,
16934 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16936 struct glyph_row
*row
;
16937 struct glyph_row
*row_found
= NULL
;
16939 *delta
= *delta_bytes
= 0;
16941 /* Display must not have been paused, otherwise the current matrix
16942 is not up to date. */
16943 eassert (!NILP (w
->window_end_valid
));
16945 /* A value of window_end_pos >= END_UNCHANGED means that the window
16946 end is in the range of changed text. If so, there is no
16947 unchanged row at the end of W's current matrix. */
16948 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16951 /* Set row to the last row in W's current matrix displaying text. */
16952 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16954 /* If matrix is entirely empty, no unchanged row exists. */
16955 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16957 /* The value of row is the last glyph row in the matrix having a
16958 meaningful buffer position in it. The end position of row
16959 corresponds to window_end_pos. This allows us to translate
16960 buffer positions in the current matrix to current buffer
16961 positions for characters not in changed text. */
16963 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16964 ptrdiff_t Z_BYTE_old
=
16965 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16966 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
16967 struct glyph_row
*first_text_row
16968 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16970 *delta
= Z
- Z_old
;
16971 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16973 /* Set last_unchanged_pos to the buffer position of the last
16974 character in the buffer that has not been changed. Z is the
16975 index + 1 of the last character in current_buffer, i.e. by
16976 subtracting END_UNCHANGED we get the index of the last
16977 unchanged character, and we have to add BEG to get its buffer
16979 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16980 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16982 /* Search backward from ROW for a row displaying a line that
16983 starts at a minimum position >= last_unchanged_pos_old. */
16984 for (; row
> first_text_row
; --row
)
16986 /* This used to abort, but it can happen.
16987 It is ok to just stop the search instead here. KFS. */
16988 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16991 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16996 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17002 /* Make sure that glyph rows in the current matrix of window W
17003 reference the same glyph memory as corresponding rows in the
17004 frame's frame matrix. This function is called after scrolling W's
17005 current matrix on a terminal frame in try_window_id and
17006 try_window_reusing_current_matrix. */
17009 sync_frame_with_window_matrix_rows (struct window
*w
)
17011 struct frame
*f
= XFRAME (w
->frame
);
17012 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17014 /* Preconditions: W must be a leaf window and full-width. Its frame
17015 must have a frame matrix. */
17016 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
17017 eassert (WINDOW_FULL_WIDTH_P (w
));
17018 eassert (!FRAME_WINDOW_P (f
));
17020 /* If W is a full-width window, glyph pointers in W's current matrix
17021 have, by definition, to be the same as glyph pointers in the
17022 corresponding frame matrix. Note that frame matrices have no
17023 marginal areas (see build_frame_matrix). */
17024 window_row
= w
->current_matrix
->rows
;
17025 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17026 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17027 while (window_row
< window_row_end
)
17029 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17030 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17032 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17033 frame_row
->glyphs
[TEXT_AREA
] = start
;
17034 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17035 frame_row
->glyphs
[LAST_AREA
] = end
;
17037 /* Disable frame rows whose corresponding window rows have
17038 been disabled in try_window_id. */
17039 if (!window_row
->enabled_p
)
17040 frame_row
->enabled_p
= 0;
17042 ++window_row
, ++frame_row
;
17047 /* Find the glyph row in window W containing CHARPOS. Consider all
17048 rows between START and END (not inclusive). END null means search
17049 all rows to the end of the display area of W. Value is the row
17050 containing CHARPOS or null. */
17053 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17054 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17056 struct glyph_row
*row
= start
;
17057 struct glyph_row
*best_row
= NULL
;
17058 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
17061 /* If we happen to start on a header-line, skip that. */
17062 if (row
->mode_line_p
)
17065 if ((end
&& row
>= end
) || !row
->enabled_p
)
17068 last_y
= window_text_bottom_y (w
) - dy
;
17072 /* Give up if we have gone too far. */
17073 if (end
&& row
>= end
)
17075 /* This formerly returned if they were equal.
17076 I think that both quantities are of a "last plus one" type;
17077 if so, when they are equal, the row is within the screen. -- rms. */
17078 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17081 /* If it is in this row, return this row. */
17082 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17083 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17084 /* The end position of a row equals the start
17085 position of the next row. If CHARPOS is there, we
17086 would rather display it in the next line, except
17087 when this line ends in ZV. */
17088 && !row
->ends_at_zv_p
17089 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
17090 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17094 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17095 || (!best_row
&& !row
->continued_p
))
17097 /* In bidi-reordered rows, there could be several rows
17098 occluding point, all of them belonging to the same
17099 continued line. We need to find the row which fits
17100 CHARPOS the best. */
17101 for (g
= row
->glyphs
[TEXT_AREA
];
17102 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17105 if (!STRINGP (g
->object
))
17107 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17109 mindif
= eabs (g
->charpos
- charpos
);
17111 /* Exact match always wins. */
17118 else if (best_row
&& !row
->continued_p
)
17125 /* Try to redisplay window W by reusing its existing display. W's
17126 current matrix must be up to date when this function is called,
17127 i.e. window_end_valid must not be nil.
17131 1 if display has been updated
17132 0 if otherwise unsuccessful
17133 -1 if redisplay with same window start is known not to succeed
17135 The following steps are performed:
17137 1. Find the last row in the current matrix of W that is not
17138 affected by changes at the start of current_buffer. If no such row
17141 2. Find the first row in W's current matrix that is not affected by
17142 changes at the end of current_buffer. Maybe there is no such row.
17144 3. Display lines beginning with the row + 1 found in step 1 to the
17145 row found in step 2 or, if step 2 didn't find a row, to the end of
17148 4. If cursor is not known to appear on the window, give up.
17150 5. If display stopped at the row found in step 2, scroll the
17151 display and current matrix as needed.
17153 6. Maybe display some lines at the end of W, if we must. This can
17154 happen under various circumstances, like a partially visible line
17155 becoming fully visible, or because newly displayed lines are displayed
17156 in smaller font sizes.
17158 7. Update W's window end information. */
17161 try_window_id (struct window
*w
)
17163 struct frame
*f
= XFRAME (w
->frame
);
17164 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17165 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17166 struct glyph_row
*last_unchanged_at_beg_row
;
17167 struct glyph_row
*first_unchanged_at_end_row
;
17168 struct glyph_row
*row
;
17169 struct glyph_row
*bottom_row
;
17172 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17174 struct text_pos start_pos
;
17176 int first_unchanged_at_end_vpos
= 0;
17177 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17178 struct text_pos start
;
17179 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17182 if (inhibit_try_window_id
)
17186 /* This is handy for debugging. */
17188 #define GIVE_UP(X) \
17190 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17194 #define GIVE_UP(X) return 0
17197 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17199 /* Don't use this for mini-windows because these can show
17200 messages and mini-buffers, and we don't handle that here. */
17201 if (MINI_WINDOW_P (w
))
17204 /* This flag is used to prevent redisplay optimizations. */
17205 if (windows_or_buffers_changed
|| cursor_type_changed
)
17208 /* Verify that narrowing has not changed.
17209 Also verify that we were not told to prevent redisplay optimizations.
17210 It would be nice to further
17211 reduce the number of cases where this prevents try_window_id. */
17212 if (current_buffer
->clip_changed
17213 || current_buffer
->prevent_redisplay_optimizations_p
)
17216 /* Window must either use window-based redisplay or be full width. */
17217 if (!FRAME_WINDOW_P (f
)
17218 && (!FRAME_LINE_INS_DEL_OK (f
)
17219 || !WINDOW_FULL_WIDTH_P (w
)))
17222 /* Give up if point is known NOT to appear in W. */
17223 if (PT
< CHARPOS (start
))
17226 /* Another way to prevent redisplay optimizations. */
17227 if (w
->last_modified
== 0)
17230 /* Verify that window is not hscrolled. */
17231 if (w
->hscroll
!= 0)
17234 /* Verify that display wasn't paused. */
17235 if (NILP (w
->window_end_valid
))
17238 /* Can't use this if highlighting a region because a cursor movement
17239 will do more than just set the cursor. */
17240 if (0 <= markpos_of_region ())
17243 /* Likewise if highlighting trailing whitespace. */
17244 if (!NILP (Vshow_trailing_whitespace
))
17247 /* Likewise if showing a region. */
17248 if (!NILP (w
->region_showing
))
17251 /* Can't use this if overlay arrow position and/or string have
17253 if (overlay_arrows_changed_p ())
17256 /* When word-wrap is on, adding a space to the first word of a
17257 wrapped line can change the wrap position, altering the line
17258 above it. It might be worthwhile to handle this more
17259 intelligently, but for now just redisplay from scratch. */
17260 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
17263 /* Under bidi reordering, adding or deleting a character in the
17264 beginning of a paragraph, before the first strong directional
17265 character, can change the base direction of the paragraph (unless
17266 the buffer specifies a fixed paragraph direction), which will
17267 require to redisplay the whole paragraph. It might be worthwhile
17268 to find the paragraph limits and widen the range of redisplayed
17269 lines to that, but for now just give up this optimization and
17270 redisplay from scratch. */
17271 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17272 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
17275 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17276 only if buffer has really changed. The reason is that the gap is
17277 initially at Z for freshly visited files. The code below would
17278 set end_unchanged to 0 in that case. */
17279 if (MODIFF
> SAVE_MODIFF
17280 /* This seems to happen sometimes after saving a buffer. */
17281 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17283 if (GPT
- BEG
< BEG_UNCHANGED
)
17284 BEG_UNCHANGED
= GPT
- BEG
;
17285 if (Z
- GPT
< END_UNCHANGED
)
17286 END_UNCHANGED
= Z
- GPT
;
17289 /* The position of the first and last character that has been changed. */
17290 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17291 last_changed_charpos
= Z
- END_UNCHANGED
;
17293 /* If window starts after a line end, and the last change is in
17294 front of that newline, then changes don't affect the display.
17295 This case happens with stealth-fontification. Note that although
17296 the display is unchanged, glyph positions in the matrix have to
17297 be adjusted, of course. */
17298 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17299 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17300 && ((last_changed_charpos
< CHARPOS (start
)
17301 && CHARPOS (start
) == BEGV
)
17302 || (last_changed_charpos
< CHARPOS (start
) - 1
17303 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17305 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17306 struct glyph_row
*r0
;
17308 /* Compute how many chars/bytes have been added to or removed
17309 from the buffer. */
17310 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17311 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17312 Z_delta
= Z
- Z_old
;
17313 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17315 /* Give up if PT is not in the window. Note that it already has
17316 been checked at the start of try_window_id that PT is not in
17317 front of the window start. */
17318 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17321 /* If window start is unchanged, we can reuse the whole matrix
17322 as is, after adjusting glyph positions. No need to compute
17323 the window end again, since its offset from Z hasn't changed. */
17324 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17325 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17326 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17327 /* PT must not be in a partially visible line. */
17328 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17329 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17331 /* Adjust positions in the glyph matrix. */
17332 if (Z_delta
|| Z_delta_bytes
)
17334 struct glyph_row
*r1
17335 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17336 increment_matrix_positions (w
->current_matrix
,
17337 MATRIX_ROW_VPOS (r0
, current_matrix
),
17338 MATRIX_ROW_VPOS (r1
, current_matrix
),
17339 Z_delta
, Z_delta_bytes
);
17342 /* Set the cursor. */
17343 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17345 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17352 /* Handle the case that changes are all below what is displayed in
17353 the window, and that PT is in the window. This shortcut cannot
17354 be taken if ZV is visible in the window, and text has been added
17355 there that is visible in the window. */
17356 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17357 /* ZV is not visible in the window, or there are no
17358 changes at ZV, actually. */
17359 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17360 || first_changed_charpos
== last_changed_charpos
))
17362 struct glyph_row
*r0
;
17364 /* Give up if PT is not in the window. Note that it already has
17365 been checked at the start of try_window_id that PT is not in
17366 front of the window start. */
17367 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17370 /* If window start is unchanged, we can reuse the whole matrix
17371 as is, without changing glyph positions since no text has
17372 been added/removed in front of the window end. */
17373 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17374 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17375 /* PT must not be in a partially visible line. */
17376 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17377 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17379 /* We have to compute the window end anew since text
17380 could have been added/removed after it. */
17381 wset_window_end_pos
17382 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17383 w
->window_end_bytepos
17384 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17386 /* Set the cursor. */
17387 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17389 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17396 /* Give up if window start is in the changed area.
17398 The condition used to read
17400 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17402 but why that was tested escapes me at the moment. */
17403 if (CHARPOS (start
) >= first_changed_charpos
17404 && CHARPOS (start
) <= last_changed_charpos
)
17407 /* Check that window start agrees with the start of the first glyph
17408 row in its current matrix. Check this after we know the window
17409 start is not in changed text, otherwise positions would not be
17411 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17412 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17415 /* Give up if the window ends in strings. Overlay strings
17416 at the end are difficult to handle, so don't try. */
17417 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17418 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17421 /* Compute the position at which we have to start displaying new
17422 lines. Some of the lines at the top of the window might be
17423 reusable because they are not displaying changed text. Find the
17424 last row in W's current matrix not affected by changes at the
17425 start of current_buffer. Value is null if changes start in the
17426 first line of window. */
17427 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17428 if (last_unchanged_at_beg_row
)
17430 /* Avoid starting to display in the middle of a character, a TAB
17431 for instance. This is easier than to set up the iterator
17432 exactly, and it's not a frequent case, so the additional
17433 effort wouldn't really pay off. */
17434 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17435 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17436 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17437 --last_unchanged_at_beg_row
;
17439 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17442 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17444 start_pos
= it
.current
.pos
;
17446 /* Start displaying new lines in the desired matrix at the same
17447 vpos we would use in the current matrix, i.e. below
17448 last_unchanged_at_beg_row. */
17449 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17451 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17452 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17454 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17458 /* There are no reusable lines at the start of the window.
17459 Start displaying in the first text line. */
17460 start_display (&it
, w
, start
);
17461 it
.vpos
= it
.first_vpos
;
17462 start_pos
= it
.current
.pos
;
17465 /* Find the first row that is not affected by changes at the end of
17466 the buffer. Value will be null if there is no unchanged row, in
17467 which case we must redisplay to the end of the window. delta
17468 will be set to the value by which buffer positions beginning with
17469 first_unchanged_at_end_row have to be adjusted due to text
17471 first_unchanged_at_end_row
17472 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17473 IF_DEBUG (debug_delta
= delta
);
17474 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17476 /* Set stop_pos to the buffer position up to which we will have to
17477 display new lines. If first_unchanged_at_end_row != NULL, this
17478 is the buffer position of the start of the line displayed in that
17479 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17480 that we don't stop at a buffer position. */
17482 if (first_unchanged_at_end_row
)
17484 eassert (last_unchanged_at_beg_row
== NULL
17485 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17487 /* If this is a continuation line, move forward to the next one
17488 that isn't. Changes in lines above affect this line.
17489 Caution: this may move first_unchanged_at_end_row to a row
17490 not displaying text. */
17491 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17492 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17493 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17494 < it
.last_visible_y
))
17495 ++first_unchanged_at_end_row
;
17497 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17498 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17499 >= it
.last_visible_y
))
17500 first_unchanged_at_end_row
= NULL
;
17503 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17505 first_unchanged_at_end_vpos
17506 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17507 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17510 else if (last_unchanged_at_beg_row
== NULL
)
17516 /* Either there is no unchanged row at the end, or the one we have
17517 now displays text. This is a necessary condition for the window
17518 end pos calculation at the end of this function. */
17519 eassert (first_unchanged_at_end_row
== NULL
17520 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17522 debug_last_unchanged_at_beg_vpos
17523 = (last_unchanged_at_beg_row
17524 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17526 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17528 #endif /* GLYPH_DEBUG */
17531 /* Display new lines. Set last_text_row to the last new line
17532 displayed which has text on it, i.e. might end up as being the
17533 line where the window_end_vpos is. */
17534 w
->cursor
.vpos
= -1;
17535 last_text_row
= NULL
;
17536 overlay_arrow_seen
= 0;
17537 while (it
.current_y
< it
.last_visible_y
17538 && !fonts_changed_p
17539 && (first_unchanged_at_end_row
== NULL
17540 || IT_CHARPOS (it
) < stop_pos
))
17542 if (display_line (&it
))
17543 last_text_row
= it
.glyph_row
- 1;
17546 if (fonts_changed_p
)
17550 /* Compute differences in buffer positions, y-positions etc. for
17551 lines reused at the bottom of the window. Compute what we can
17553 if (first_unchanged_at_end_row
17554 /* No lines reused because we displayed everything up to the
17555 bottom of the window. */
17556 && it
.current_y
< it
.last_visible_y
)
17559 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17561 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17562 run
.current_y
= first_unchanged_at_end_row
->y
;
17563 run
.desired_y
= run
.current_y
+ dy
;
17564 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17568 delta
= delta_bytes
= dvpos
= dy
17569 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17570 first_unchanged_at_end_row
= NULL
;
17572 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17575 /* Find the cursor if not already found. We have to decide whether
17576 PT will appear on this window (it sometimes doesn't, but this is
17577 not a very frequent case.) This decision has to be made before
17578 the current matrix is altered. A value of cursor.vpos < 0 means
17579 that PT is either in one of the lines beginning at
17580 first_unchanged_at_end_row or below the window. Don't care for
17581 lines that might be displayed later at the window end; as
17582 mentioned, this is not a frequent case. */
17583 if (w
->cursor
.vpos
< 0)
17585 /* Cursor in unchanged rows at the top? */
17586 if (PT
< CHARPOS (start_pos
)
17587 && last_unchanged_at_beg_row
)
17589 row
= row_containing_pos (w
, PT
,
17590 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17591 last_unchanged_at_beg_row
+ 1, 0);
17593 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17596 /* Start from first_unchanged_at_end_row looking for PT. */
17597 else if (first_unchanged_at_end_row
)
17599 row
= row_containing_pos (w
, PT
- delta
,
17600 first_unchanged_at_end_row
, NULL
, 0);
17602 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17603 delta_bytes
, dy
, dvpos
);
17606 /* Give up if cursor was not found. */
17607 if (w
->cursor
.vpos
< 0)
17609 clear_glyph_matrix (w
->desired_matrix
);
17614 /* Don't let the cursor end in the scroll margins. */
17616 int this_scroll_margin
, cursor_height
;
17618 this_scroll_margin
=
17619 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17620 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17621 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17623 if ((w
->cursor
.y
< this_scroll_margin
17624 && CHARPOS (start
) > BEGV
)
17625 /* Old redisplay didn't take scroll margin into account at the bottom,
17626 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17627 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17628 ? cursor_height
+ this_scroll_margin
17629 : 1)) > it
.last_visible_y
)
17631 w
->cursor
.vpos
= -1;
17632 clear_glyph_matrix (w
->desired_matrix
);
17637 /* Scroll the display. Do it before changing the current matrix so
17638 that xterm.c doesn't get confused about where the cursor glyph is
17640 if (dy
&& run
.height
)
17644 if (FRAME_WINDOW_P (f
))
17646 FRAME_RIF (f
)->update_window_begin_hook (w
);
17647 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17648 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17649 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17653 /* Terminal frame. In this case, dvpos gives the number of
17654 lines to scroll by; dvpos < 0 means scroll up. */
17656 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17657 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17658 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17659 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17660 + window_internal_height (w
));
17662 #if defined (HAVE_GPM) || defined (MSDOS)
17663 x_clear_window_mouse_face (w
);
17665 /* Perform the operation on the screen. */
17668 /* Scroll last_unchanged_at_beg_row to the end of the
17669 window down dvpos lines. */
17670 set_terminal_window (f
, end
);
17672 /* On dumb terminals delete dvpos lines at the end
17673 before inserting dvpos empty lines. */
17674 if (!FRAME_SCROLL_REGION_OK (f
))
17675 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17677 /* Insert dvpos empty lines in front of
17678 last_unchanged_at_beg_row. */
17679 ins_del_lines (f
, from
, dvpos
);
17681 else if (dvpos
< 0)
17683 /* Scroll up last_unchanged_at_beg_vpos to the end of
17684 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17685 set_terminal_window (f
, end
);
17687 /* Delete dvpos lines in front of
17688 last_unchanged_at_beg_vpos. ins_del_lines will set
17689 the cursor to the given vpos and emit |dvpos| delete
17691 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17693 /* On a dumb terminal insert dvpos empty lines at the
17695 if (!FRAME_SCROLL_REGION_OK (f
))
17696 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17699 set_terminal_window (f
, 0);
17705 /* Shift reused rows of the current matrix to the right position.
17706 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17708 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17709 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17712 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17713 bottom_vpos
, dvpos
);
17714 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17717 else if (dvpos
> 0)
17719 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17720 bottom_vpos
, dvpos
);
17721 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17722 first_unchanged_at_end_vpos
+ dvpos
);
17725 /* For frame-based redisplay, make sure that current frame and window
17726 matrix are in sync with respect to glyph memory. */
17727 if (!FRAME_WINDOW_P (f
))
17728 sync_frame_with_window_matrix_rows (w
);
17730 /* Adjust buffer positions in reused rows. */
17731 if (delta
|| delta_bytes
)
17732 increment_matrix_positions (current_matrix
,
17733 first_unchanged_at_end_vpos
+ dvpos
,
17734 bottom_vpos
, delta
, delta_bytes
);
17736 /* Adjust Y positions. */
17738 shift_glyph_matrix (w
, current_matrix
,
17739 first_unchanged_at_end_vpos
+ dvpos
,
17742 if (first_unchanged_at_end_row
)
17744 first_unchanged_at_end_row
+= dvpos
;
17745 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17746 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17747 first_unchanged_at_end_row
= NULL
;
17750 /* If scrolling up, there may be some lines to display at the end of
17752 last_text_row_at_end
= NULL
;
17755 /* Scrolling up can leave for example a partially visible line
17756 at the end of the window to be redisplayed. */
17757 /* Set last_row to the glyph row in the current matrix where the
17758 window end line is found. It has been moved up or down in
17759 the matrix by dvpos. */
17760 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17761 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17763 /* If last_row is the window end line, it should display text. */
17764 eassert (last_row
->displays_text_p
);
17766 /* If window end line was partially visible before, begin
17767 displaying at that line. Otherwise begin displaying with the
17768 line following it. */
17769 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17771 init_to_row_start (&it
, w
, last_row
);
17772 it
.vpos
= last_vpos
;
17773 it
.current_y
= last_row
->y
;
17777 init_to_row_end (&it
, w
, last_row
);
17778 it
.vpos
= 1 + last_vpos
;
17779 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17783 /* We may start in a continuation line. If so, we have to
17784 get the right continuation_lines_width and current_x. */
17785 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17786 it
.hpos
= it
.current_x
= 0;
17788 /* Display the rest of the lines at the window end. */
17789 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17790 while (it
.current_y
< it
.last_visible_y
17791 && !fonts_changed_p
)
17793 /* Is it always sure that the display agrees with lines in
17794 the current matrix? I don't think so, so we mark rows
17795 displayed invalid in the current matrix by setting their
17796 enabled_p flag to zero. */
17797 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17798 if (display_line (&it
))
17799 last_text_row_at_end
= it
.glyph_row
- 1;
17803 /* Update window_end_pos and window_end_vpos. */
17804 if (first_unchanged_at_end_row
17805 && !last_text_row_at_end
)
17807 /* Window end line if one of the preserved rows from the current
17808 matrix. Set row to the last row displaying text in current
17809 matrix starting at first_unchanged_at_end_row, after
17811 eassert (first_unchanged_at_end_row
->displays_text_p
);
17812 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17813 first_unchanged_at_end_row
);
17814 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17816 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17817 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17818 wset_window_end_vpos
17819 (w
, make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
)));
17820 eassert (w
->window_end_bytepos
>= 0);
17821 IF_DEBUG (debug_method_add (w
, "A"));
17823 else if (last_text_row_at_end
)
17825 wset_window_end_pos
17826 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
)));
17827 w
->window_end_bytepos
17828 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17829 wset_window_end_vpos
17830 (w
, make_number (MATRIX_ROW_VPOS (last_text_row_at_end
,
17832 eassert (w
->window_end_bytepos
>= 0);
17833 IF_DEBUG (debug_method_add (w
, "B"));
17835 else if (last_text_row
)
17837 /* We have displayed either to the end of the window or at the
17838 end of the window, i.e. the last row with text is to be found
17839 in the desired matrix. */
17840 wset_window_end_pos
17841 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
17842 w
->window_end_bytepos
17843 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17844 wset_window_end_vpos
17845 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
)));
17846 eassert (w
->window_end_bytepos
>= 0);
17848 else if (first_unchanged_at_end_row
== NULL
17849 && last_text_row
== NULL
17850 && last_text_row_at_end
== NULL
)
17852 /* Displayed to end of window, but no line containing text was
17853 displayed. Lines were deleted at the end of the window. */
17854 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17855 int vpos
= XFASTINT (w
->window_end_vpos
);
17856 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17857 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17860 row
== NULL
&& vpos
>= first_vpos
;
17861 --vpos
, --current_row
, --desired_row
)
17863 if (desired_row
->enabled_p
)
17865 if (desired_row
->displays_text_p
)
17868 else if (current_row
->displays_text_p
)
17872 eassert (row
!= NULL
);
17873 wset_window_end_vpos (w
, make_number (vpos
+ 1));
17874 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17875 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17876 eassert (w
->window_end_bytepos
>= 0);
17877 IF_DEBUG (debug_method_add (w
, "C"));
17882 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17883 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17885 /* Record that display has not been completed. */
17886 wset_window_end_valid (w
, Qnil
);
17887 w
->desired_matrix
->no_scrolling_p
= 1;
17895 /***********************************************************************
17896 More debugging support
17897 ***********************************************************************/
17901 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17902 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17903 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17906 /* Dump the contents of glyph matrix MATRIX on stderr.
17908 GLYPHS 0 means don't show glyph contents.
17909 GLYPHS 1 means show glyphs in short form
17910 GLYPHS > 1 means show glyphs in long form. */
17913 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17916 for (i
= 0; i
< matrix
->nrows
; ++i
)
17917 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17921 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17922 the glyph row and area where the glyph comes from. */
17925 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17927 if (glyph
->type
== CHAR_GLYPH
)
17930 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17931 glyph
- row
->glyphs
[TEXT_AREA
],
17934 (BUFFERP (glyph
->object
)
17936 : (STRINGP (glyph
->object
)
17939 glyph
->pixel_width
,
17941 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17945 glyph
->left_box_line_p
,
17946 glyph
->right_box_line_p
);
17948 else if (glyph
->type
== STRETCH_GLYPH
)
17951 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17952 glyph
- row
->glyphs
[TEXT_AREA
],
17955 (BUFFERP (glyph
->object
)
17957 : (STRINGP (glyph
->object
)
17960 glyph
->pixel_width
,
17964 glyph
->left_box_line_p
,
17965 glyph
->right_box_line_p
);
17967 else if (glyph
->type
== IMAGE_GLYPH
)
17970 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17971 glyph
- row
->glyphs
[TEXT_AREA
],
17974 (BUFFERP (glyph
->object
)
17976 : (STRINGP (glyph
->object
)
17979 glyph
->pixel_width
,
17983 glyph
->left_box_line_p
,
17984 glyph
->right_box_line_p
);
17986 else if (glyph
->type
== COMPOSITE_GLYPH
)
17989 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17990 glyph
- row
->glyphs
[TEXT_AREA
],
17993 (BUFFERP (glyph
->object
)
17995 : (STRINGP (glyph
->object
)
17998 glyph
->pixel_width
,
18000 if (glyph
->u
.cmp
.automatic
)
18003 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18004 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18006 glyph
->left_box_line_p
,
18007 glyph
->right_box_line_p
);
18012 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18013 GLYPHS 0 means don't show glyph contents.
18014 GLYPHS 1 means show glyphs in short form
18015 GLYPHS > 1 means show glyphs in long form. */
18018 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18022 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18023 fprintf (stderr
, "======================================================================\n");
18025 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18026 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18028 MATRIX_ROW_START_CHARPOS (row
),
18029 MATRIX_ROW_END_CHARPOS (row
),
18030 row
->used
[TEXT_AREA
],
18031 row
->contains_overlapping_glyphs_p
,
18033 row
->truncated_on_left_p
,
18034 row
->truncated_on_right_p
,
18036 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18037 row
->displays_text_p
,
18040 row
->ends_in_middle_of_char_p
,
18041 row
->starts_in_middle_of_char_p
,
18047 row
->visible_height
,
18050 fprintf (stderr
, "%9"pD
"d %5"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18051 row
->end
.overlay_string_index
,
18052 row
->continuation_lines_width
);
18053 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
18054 CHARPOS (row
->start
.string_pos
),
18055 CHARPOS (row
->end
.string_pos
));
18056 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
18057 row
->end
.dpvec_index
);
18064 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18066 struct glyph
*glyph
= row
->glyphs
[area
];
18067 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18069 /* Glyph for a line end in text. */
18070 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18073 if (glyph
< glyph_end
)
18074 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
18076 for (; glyph
< glyph_end
; ++glyph
)
18077 dump_glyph (row
, glyph
, area
);
18080 else if (glyphs
== 1)
18084 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18086 char *s
= alloca (row
->used
[area
] + 1);
18089 for (i
= 0; i
< row
->used
[area
]; ++i
)
18091 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18092 if (glyph
->type
== CHAR_GLYPH
18093 && glyph
->u
.ch
< 0x80
18094 && glyph
->u
.ch
>= ' ')
18095 s
[i
] = glyph
->u
.ch
;
18101 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18107 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18108 Sdump_glyph_matrix
, 0, 1, "p",
18109 doc
: /* Dump the current matrix of the selected window to stderr.
18110 Shows contents of glyph row structures. With non-nil
18111 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18112 glyphs in short form, otherwise show glyphs in long form. */)
18113 (Lisp_Object glyphs
)
18115 struct window
*w
= XWINDOW (selected_window
);
18116 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18118 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18119 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18120 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18121 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18122 fprintf (stderr
, "=============================================\n");
18123 dump_glyph_matrix (w
->current_matrix
,
18124 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18129 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18130 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18133 struct frame
*f
= XFRAME (selected_frame
);
18134 dump_glyph_matrix (f
->current_matrix
, 1);
18139 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18140 doc
: /* Dump glyph row ROW to stderr.
18141 GLYPH 0 means don't dump glyphs.
18142 GLYPH 1 means dump glyphs in short form.
18143 GLYPH > 1 or omitted means dump glyphs in long form. */)
18144 (Lisp_Object row
, Lisp_Object glyphs
)
18146 struct glyph_matrix
*matrix
;
18149 CHECK_NUMBER (row
);
18150 matrix
= XWINDOW (selected_window
)->current_matrix
;
18152 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18153 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18155 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18160 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18161 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18162 GLYPH 0 means don't dump glyphs.
18163 GLYPH 1 means dump glyphs in short form.
18164 GLYPH > 1 or omitted means dump glyphs in long form. */)
18165 (Lisp_Object row
, Lisp_Object glyphs
)
18167 struct frame
*sf
= SELECTED_FRAME ();
18168 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18171 CHECK_NUMBER (row
);
18173 if (vpos
>= 0 && vpos
< m
->nrows
)
18174 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18175 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18180 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18181 doc
: /* Toggle tracing of redisplay.
18182 With ARG, turn tracing on if and only if ARG is positive. */)
18186 trace_redisplay_p
= !trace_redisplay_p
;
18189 arg
= Fprefix_numeric_value (arg
);
18190 trace_redisplay_p
= XINT (arg
) > 0;
18197 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18198 doc
: /* Like `format', but print result to stderr.
18199 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18200 (ptrdiff_t nargs
, Lisp_Object
*args
)
18202 Lisp_Object s
= Fformat (nargs
, args
);
18203 fprintf (stderr
, "%s", SDATA (s
));
18207 #endif /* GLYPH_DEBUG */
18211 /***********************************************************************
18212 Building Desired Matrix Rows
18213 ***********************************************************************/
18215 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18216 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18218 static struct glyph_row
*
18219 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18221 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18222 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18223 struct buffer
*old
= current_buffer
;
18224 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18225 int arrow_len
= SCHARS (overlay_arrow_string
);
18226 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18227 const unsigned char *p
;
18230 int n_glyphs_before
;
18232 set_buffer_temp (buffer
);
18233 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18234 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18235 SET_TEXT_POS (it
.position
, 0, 0);
18237 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18239 while (p
< arrow_end
)
18241 Lisp_Object face
, ilisp
;
18243 /* Get the next character. */
18245 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18248 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18249 if (! ASCII_CHAR_P (it
.c
))
18250 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18254 /* Get its face. */
18255 ilisp
= make_number (p
- arrow_string
);
18256 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18257 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18259 /* Compute its width, get its glyphs. */
18260 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18261 SET_TEXT_POS (it
.position
, -1, -1);
18262 PRODUCE_GLYPHS (&it
);
18264 /* If this character doesn't fit any more in the line, we have
18265 to remove some glyphs. */
18266 if (it
.current_x
> it
.last_visible_x
)
18268 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18273 set_buffer_temp (old
);
18274 return it
.glyph_row
;
18278 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18279 glyphs to insert is determined by produce_special_glyphs. */
18282 insert_left_trunc_glyphs (struct it
*it
)
18284 struct it truncate_it
;
18285 struct glyph
*from
, *end
, *to
, *toend
;
18287 eassert (!FRAME_WINDOW_P (it
->f
)
18288 || (!it
->glyph_row
->reversed_p
18289 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18290 || (it
->glyph_row
->reversed_p
18291 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18293 /* Get the truncation glyphs. */
18295 truncate_it
.current_x
= 0;
18296 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18297 truncate_it
.glyph_row
= &scratch_glyph_row
;
18298 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18299 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18300 truncate_it
.object
= make_number (0);
18301 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18303 /* Overwrite glyphs from IT with truncation glyphs. */
18304 if (!it
->glyph_row
->reversed_p
)
18306 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18308 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18309 end
= from
+ tused
;
18310 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18311 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18312 if (FRAME_WINDOW_P (it
->f
))
18314 /* On GUI frames, when variable-size fonts are displayed,
18315 the truncation glyphs may need more pixels than the row's
18316 glyphs they overwrite. We overwrite more glyphs to free
18317 enough screen real estate, and enlarge the stretch glyph
18318 on the right (see display_line), if there is one, to
18319 preserve the screen position of the truncation glyphs on
18322 struct glyph
*g
= to
;
18325 /* The first glyph could be partially visible, in which case
18326 it->glyph_row->x will be negative. But we want the left
18327 truncation glyphs to be aligned at the left margin of the
18328 window, so we override the x coordinate at which the row
18330 it
->glyph_row
->x
= 0;
18331 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18333 w
+= g
->pixel_width
;
18336 if (g
- to
- tused
> 0)
18338 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18339 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18341 used
= it
->glyph_row
->used
[TEXT_AREA
];
18342 if (it
->glyph_row
->truncated_on_right_p
18343 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18344 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18347 int extra
= w
- it
->truncation_pixel_width
;
18349 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18356 /* There may be padding glyphs left over. Overwrite them too. */
18357 if (!FRAME_WINDOW_P (it
->f
))
18359 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18361 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18368 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18372 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18374 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18375 that back to front. */
18376 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18377 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18378 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18379 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18380 if (FRAME_WINDOW_P (it
->f
))
18383 struct glyph
*g
= to
;
18385 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18387 w
+= g
->pixel_width
;
18390 if (to
- g
- tused
> 0)
18392 if (it
->glyph_row
->truncated_on_right_p
18393 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18394 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18396 int extra
= w
- it
->truncation_pixel_width
;
18398 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18402 while (from
>= end
&& to
>= toend
)
18404 if (!FRAME_WINDOW_P (it
->f
))
18406 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18409 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18410 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18411 while (from
>= end
&& to
>= toend
)
18417 /* Need to free some room before prepending additional
18419 int move_by
= from
- end
+ 1;
18420 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18421 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18423 for ( ; g
>= g0
; g
--)
18425 while (from
>= end
)
18427 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18432 /* Compute the hash code for ROW. */
18434 row_hash (struct glyph_row
*row
)
18437 unsigned hashval
= 0;
18439 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18440 for (k
= 0; k
< row
->used
[area
]; ++k
)
18441 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18442 + row
->glyphs
[area
][k
].u
.val
18443 + row
->glyphs
[area
][k
].face_id
18444 + row
->glyphs
[area
][k
].padding_p
18445 + (row
->glyphs
[area
][k
].type
<< 2));
18450 /* Compute the pixel height and width of IT->glyph_row.
18452 Most of the time, ascent and height of a display line will be equal
18453 to the max_ascent and max_height values of the display iterator
18454 structure. This is not the case if
18456 1. We hit ZV without displaying anything. In this case, max_ascent
18457 and max_height will be zero.
18459 2. We have some glyphs that don't contribute to the line height.
18460 (The glyph row flag contributes_to_line_height_p is for future
18461 pixmap extensions).
18463 The first case is easily covered by using default values because in
18464 these cases, the line height does not really matter, except that it
18465 must not be zero. */
18468 compute_line_metrics (struct it
*it
)
18470 struct glyph_row
*row
= it
->glyph_row
;
18472 if (FRAME_WINDOW_P (it
->f
))
18474 int i
, min_y
, max_y
;
18476 /* The line may consist of one space only, that was added to
18477 place the cursor on it. If so, the row's height hasn't been
18479 if (row
->height
== 0)
18481 if (it
->max_ascent
+ it
->max_descent
== 0)
18482 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18483 row
->ascent
= it
->max_ascent
;
18484 row
->height
= it
->max_ascent
+ it
->max_descent
;
18485 row
->phys_ascent
= it
->max_phys_ascent
;
18486 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18487 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18490 /* Compute the width of this line. */
18491 row
->pixel_width
= row
->x
;
18492 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18493 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18495 eassert (row
->pixel_width
>= 0);
18496 eassert (row
->ascent
>= 0 && row
->height
> 0);
18498 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18499 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18501 /* If first line's physical ascent is larger than its logical
18502 ascent, use the physical ascent, and make the row taller.
18503 This makes accented characters fully visible. */
18504 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18505 && row
->phys_ascent
> row
->ascent
)
18507 row
->height
+= row
->phys_ascent
- row
->ascent
;
18508 row
->ascent
= row
->phys_ascent
;
18511 /* Compute how much of the line is visible. */
18512 row
->visible_height
= row
->height
;
18514 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18515 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18517 if (row
->y
< min_y
)
18518 row
->visible_height
-= min_y
- row
->y
;
18519 if (row
->y
+ row
->height
> max_y
)
18520 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18524 row
->pixel_width
= row
->used
[TEXT_AREA
];
18525 if (row
->continued_p
)
18526 row
->pixel_width
-= it
->continuation_pixel_width
;
18527 else if (row
->truncated_on_right_p
)
18528 row
->pixel_width
-= it
->truncation_pixel_width
;
18529 row
->ascent
= row
->phys_ascent
= 0;
18530 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18531 row
->extra_line_spacing
= 0;
18534 /* Compute a hash code for this row. */
18535 row
->hash
= row_hash (row
);
18537 it
->max_ascent
= it
->max_descent
= 0;
18538 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18542 /* Append one space to the glyph row of iterator IT if doing a
18543 window-based redisplay. The space has the same face as
18544 IT->face_id. Value is non-zero if a space was added.
18546 This function is called to make sure that there is always one glyph
18547 at the end of a glyph row that the cursor can be set on under
18548 window-systems. (If there weren't such a glyph we would not know
18549 how wide and tall a box cursor should be displayed).
18551 At the same time this space let's a nicely handle clearing to the
18552 end of the line if the row ends in italic text. */
18555 append_space_for_newline (struct it
*it
, int default_face_p
)
18557 if (FRAME_WINDOW_P (it
->f
))
18559 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18561 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18562 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18564 /* Save some values that must not be changed.
18565 Must save IT->c and IT->len because otherwise
18566 ITERATOR_AT_END_P wouldn't work anymore after
18567 append_space_for_newline has been called. */
18568 enum display_element_type saved_what
= it
->what
;
18569 int saved_c
= it
->c
, saved_len
= it
->len
;
18570 int saved_char_to_display
= it
->char_to_display
;
18571 int saved_x
= it
->current_x
;
18572 int saved_face_id
= it
->face_id
;
18573 int saved_box_end
= it
->end_of_box_run_p
;
18574 struct text_pos saved_pos
;
18575 Lisp_Object saved_object
;
18578 saved_object
= it
->object
;
18579 saved_pos
= it
->position
;
18581 it
->what
= IT_CHARACTER
;
18582 memset (&it
->position
, 0, sizeof it
->position
);
18583 it
->object
= make_number (0);
18584 it
->c
= it
->char_to_display
= ' ';
18587 /* If the default face was remapped, be sure to use the
18588 remapped face for the appended newline. */
18589 if (default_face_p
)
18590 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18591 else if (it
->face_before_selective_p
)
18592 it
->face_id
= it
->saved_face_id
;
18593 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18594 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18595 /* In R2L rows, we will prepend a stretch glyph that will
18596 have the end_of_box_run_p flag set for it, so there's no
18597 need for the appended newline glyph to have that flag
18599 if (it
->glyph_row
->reversed_p
18600 /* But if the appended newline glyph goes all the way to
18601 the end of the row, there will be no stretch glyph,
18602 so leave the box flag set. */
18603 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
18604 it
->end_of_box_run_p
= 0;
18606 PRODUCE_GLYPHS (it
);
18608 it
->override_ascent
= -1;
18609 it
->constrain_row_ascent_descent_p
= 0;
18610 it
->current_x
= saved_x
;
18611 it
->object
= saved_object
;
18612 it
->position
= saved_pos
;
18613 it
->what
= saved_what
;
18614 it
->face_id
= saved_face_id
;
18615 it
->len
= saved_len
;
18617 it
->char_to_display
= saved_char_to_display
;
18618 it
->end_of_box_run_p
= saved_box_end
;
18627 /* Extend the face of the last glyph in the text area of IT->glyph_row
18628 to the end of the display line. Called from display_line. If the
18629 glyph row is empty, add a space glyph to it so that we know the
18630 face to draw. Set the glyph row flag fill_line_p. If the glyph
18631 row is R2L, prepend a stretch glyph to cover the empty space to the
18632 left of the leftmost glyph. */
18635 extend_face_to_end_of_line (struct it
*it
)
18637 struct face
*face
, *default_face
;
18638 struct frame
*f
= it
->f
;
18640 /* If line is already filled, do nothing. Non window-system frames
18641 get a grace of one more ``pixel'' because their characters are
18642 1-``pixel'' wide, so they hit the equality too early. This grace
18643 is needed only for R2L rows that are not continued, to produce
18644 one extra blank where we could display the cursor. */
18645 if (it
->current_x
>= it
->last_visible_x
18646 + (!FRAME_WINDOW_P (f
)
18647 && it
->glyph_row
->reversed_p
18648 && !it
->glyph_row
->continued_p
))
18651 /* The default face, possibly remapped. */
18652 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18654 /* Face extension extends the background and box of IT->face_id
18655 to the end of the line. If the background equals the background
18656 of the frame, we don't have to do anything. */
18657 if (it
->face_before_selective_p
)
18658 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18660 face
= FACE_FROM_ID (f
, it
->face_id
);
18662 if (FRAME_WINDOW_P (f
)
18663 && it
->glyph_row
->displays_text_p
18664 && face
->box
== FACE_NO_BOX
18665 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18667 && !it
->glyph_row
->reversed_p
)
18670 /* Set the glyph row flag indicating that the face of the last glyph
18671 in the text area has to be drawn to the end of the text area. */
18672 it
->glyph_row
->fill_line_p
= 1;
18674 /* If current character of IT is not ASCII, make sure we have the
18675 ASCII face. This will be automatically undone the next time
18676 get_next_display_element returns a multibyte character. Note
18677 that the character will always be single byte in unibyte
18679 if (!ASCII_CHAR_P (it
->c
))
18681 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18684 if (FRAME_WINDOW_P (f
))
18686 /* If the row is empty, add a space with the current face of IT,
18687 so that we know which face to draw. */
18688 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18690 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18691 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18692 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18694 #ifdef HAVE_WINDOW_SYSTEM
18695 if (it
->glyph_row
->reversed_p
)
18697 /* Prepend a stretch glyph to the row, such that the
18698 rightmost glyph will be drawn flushed all the way to the
18699 right margin of the window. The stretch glyph that will
18700 occupy the empty space, if any, to the left of the
18702 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18703 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18704 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18706 int row_width
, stretch_ascent
, stretch_width
;
18707 struct text_pos saved_pos
;
18708 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
18710 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18711 row_width
+= g
->pixel_width
;
18712 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18713 if (stretch_width
> 0)
18716 (((it
->ascent
+ it
->descent
)
18717 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18718 saved_pos
= it
->position
;
18719 memset (&it
->position
, 0, sizeof it
->position
);
18720 saved_avoid_cursor
= it
->avoid_cursor_p
;
18721 it
->avoid_cursor_p
= 1;
18722 saved_face_id
= it
->face_id
;
18723 saved_box_start
= it
->start_of_box_run_p
;
18724 /* The last row's stretch glyph should get the default
18725 face, to avoid painting the rest of the window with
18726 the region face, if the region ends at ZV. */
18727 if (it
->glyph_row
->ends_at_zv_p
)
18728 it
->face_id
= default_face
->id
;
18730 it
->face_id
= face
->id
;
18731 it
->start_of_box_run_p
= 0;
18732 append_stretch_glyph (it
, make_number (0), stretch_width
,
18733 it
->ascent
+ it
->descent
, stretch_ascent
);
18734 it
->position
= saved_pos
;
18735 it
->avoid_cursor_p
= saved_avoid_cursor
;
18736 it
->face_id
= saved_face_id
;
18737 it
->start_of_box_run_p
= saved_box_start
;
18740 #endif /* HAVE_WINDOW_SYSTEM */
18744 /* Save some values that must not be changed. */
18745 int saved_x
= it
->current_x
;
18746 struct text_pos saved_pos
;
18747 Lisp_Object saved_object
;
18748 enum display_element_type saved_what
= it
->what
;
18749 int saved_face_id
= it
->face_id
;
18751 saved_object
= it
->object
;
18752 saved_pos
= it
->position
;
18754 it
->what
= IT_CHARACTER
;
18755 memset (&it
->position
, 0, sizeof it
->position
);
18756 it
->object
= make_number (0);
18757 it
->c
= it
->char_to_display
= ' ';
18759 /* The last row's blank glyphs should get the default face, to
18760 avoid painting the rest of the window with the region face,
18761 if the region ends at ZV. */
18762 if (it
->glyph_row
->ends_at_zv_p
)
18763 it
->face_id
= default_face
->id
;
18765 it
->face_id
= face
->id
;
18767 PRODUCE_GLYPHS (it
);
18769 while (it
->current_x
<= it
->last_visible_x
)
18770 PRODUCE_GLYPHS (it
);
18772 /* Don't count these blanks really. It would let us insert a left
18773 truncation glyph below and make us set the cursor on them, maybe. */
18774 it
->current_x
= saved_x
;
18775 it
->object
= saved_object
;
18776 it
->position
= saved_pos
;
18777 it
->what
= saved_what
;
18778 it
->face_id
= saved_face_id
;
18783 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18784 trailing whitespace. */
18787 trailing_whitespace_p (ptrdiff_t charpos
)
18789 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18792 while (bytepos
< ZV_BYTE
18793 && (c
= FETCH_CHAR (bytepos
),
18794 c
== ' ' || c
== '\t'))
18797 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18799 if (bytepos
!= PT_BYTE
)
18806 /* Highlight trailing whitespace, if any, in ROW. */
18809 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18811 int used
= row
->used
[TEXT_AREA
];
18815 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18816 struct glyph
*glyph
= start
+ used
- 1;
18818 if (row
->reversed_p
)
18820 /* Right-to-left rows need to be processed in the opposite
18821 direction, so swap the edge pointers. */
18823 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18826 /* Skip over glyphs inserted to display the cursor at the
18827 end of a line, for extending the face of the last glyph
18828 to the end of the line on terminals, and for truncation
18829 and continuation glyphs. */
18830 if (!row
->reversed_p
)
18832 while (glyph
>= start
18833 && glyph
->type
== CHAR_GLYPH
18834 && INTEGERP (glyph
->object
))
18839 while (glyph
<= start
18840 && glyph
->type
== CHAR_GLYPH
18841 && INTEGERP (glyph
->object
))
18845 /* If last glyph is a space or stretch, and it's trailing
18846 whitespace, set the face of all trailing whitespace glyphs in
18847 IT->glyph_row to `trailing-whitespace'. */
18848 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18849 && BUFFERP (glyph
->object
)
18850 && (glyph
->type
== STRETCH_GLYPH
18851 || (glyph
->type
== CHAR_GLYPH
18852 && glyph
->u
.ch
== ' '))
18853 && trailing_whitespace_p (glyph
->charpos
))
18855 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18859 if (!row
->reversed_p
)
18861 while (glyph
>= start
18862 && BUFFERP (glyph
->object
)
18863 && (glyph
->type
== STRETCH_GLYPH
18864 || (glyph
->type
== CHAR_GLYPH
18865 && glyph
->u
.ch
== ' ')))
18866 (glyph
--)->face_id
= face_id
;
18870 while (glyph
<= start
18871 && BUFFERP (glyph
->object
)
18872 && (glyph
->type
== STRETCH_GLYPH
18873 || (glyph
->type
== CHAR_GLYPH
18874 && glyph
->u
.ch
== ' ')))
18875 (glyph
++)->face_id
= face_id
;
18882 /* Value is non-zero if glyph row ROW should be
18883 used to hold the cursor. */
18886 cursor_row_p (struct glyph_row
*row
)
18890 if (PT
== CHARPOS (row
->end
.pos
)
18891 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18893 /* Suppose the row ends on a string.
18894 Unless the row is continued, that means it ends on a newline
18895 in the string. If it's anything other than a display string
18896 (e.g., a before-string from an overlay), we don't want the
18897 cursor there. (This heuristic seems to give the optimal
18898 behavior for the various types of multi-line strings.)
18899 One exception: if the string has `cursor' property on one of
18900 its characters, we _do_ want the cursor there. */
18901 if (CHARPOS (row
->end
.string_pos
) >= 0)
18903 if (row
->continued_p
)
18907 /* Check for `display' property. */
18908 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18909 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18910 struct glyph
*glyph
;
18913 for (glyph
= end
; glyph
>= beg
; --glyph
)
18914 if (STRINGP (glyph
->object
))
18917 = Fget_char_property (make_number (PT
),
18921 && display_prop_string_p (prop
, glyph
->object
));
18922 /* If there's a `cursor' property on one of the
18923 string's characters, this row is a cursor row,
18924 even though this is not a display string. */
18927 Lisp_Object s
= glyph
->object
;
18929 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18931 ptrdiff_t gpos
= glyph
->charpos
;
18933 if (!NILP (Fget_char_property (make_number (gpos
),
18945 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18947 /* If the row ends in middle of a real character,
18948 and the line is continued, we want the cursor here.
18949 That's because CHARPOS (ROW->end.pos) would equal
18950 PT if PT is before the character. */
18951 if (!row
->ends_in_ellipsis_p
)
18952 result
= row
->continued_p
;
18954 /* If the row ends in an ellipsis, then
18955 CHARPOS (ROW->end.pos) will equal point after the
18956 invisible text. We want that position to be displayed
18957 after the ellipsis. */
18960 /* If the row ends at ZV, display the cursor at the end of that
18961 row instead of at the start of the row below. */
18962 else if (row
->ends_at_zv_p
)
18973 /* Push the property PROP so that it will be rendered at the current
18974 position in IT. Return 1 if PROP was successfully pushed, 0
18975 otherwise. Called from handle_line_prefix to handle the
18976 `line-prefix' and `wrap-prefix' properties. */
18979 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18981 struct text_pos pos
=
18982 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18984 eassert (it
->method
== GET_FROM_BUFFER
18985 || it
->method
== GET_FROM_DISPLAY_VECTOR
18986 || it
->method
== GET_FROM_STRING
);
18988 /* We need to save the current buffer/string position, so it will be
18989 restored by pop_it, because iterate_out_of_display_property
18990 depends on that being set correctly, but some situations leave
18991 it->position not yet set when this function is called. */
18992 push_it (it
, &pos
);
18994 if (STRINGP (prop
))
18996 if (SCHARS (prop
) == 0)
19003 it
->string_from_prefix_prop_p
= 1;
19004 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19005 it
->current
.overlay_string_index
= -1;
19006 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19007 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19008 it
->method
= GET_FROM_STRING
;
19009 it
->stop_charpos
= 0;
19011 it
->base_level_stop
= 0;
19013 /* Force paragraph direction to be that of the parent
19015 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19016 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19018 it
->paragraph_embedding
= L2R
;
19020 /* Set up the bidi iterator for this display string. */
19023 it
->bidi_it
.string
.lstring
= it
->string
;
19024 it
->bidi_it
.string
.s
= NULL
;
19025 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19026 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19027 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19028 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19029 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19032 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19034 it
->method
= GET_FROM_STRETCH
;
19037 #ifdef HAVE_WINDOW_SYSTEM
19038 else if (IMAGEP (prop
))
19040 it
->what
= IT_IMAGE
;
19041 it
->image_id
= lookup_image (it
->f
, prop
);
19042 it
->method
= GET_FROM_IMAGE
;
19044 #endif /* HAVE_WINDOW_SYSTEM */
19047 pop_it (it
); /* bogus display property, give up */
19054 /* Return the character-property PROP at the current position in IT. */
19057 get_it_property (struct it
*it
, Lisp_Object prop
)
19059 Lisp_Object position
;
19061 if (STRINGP (it
->object
))
19062 position
= make_number (IT_STRING_CHARPOS (*it
));
19063 else if (BUFFERP (it
->object
))
19064 position
= make_number (IT_CHARPOS (*it
));
19068 return Fget_char_property (position
, prop
, it
->object
);
19071 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19074 handle_line_prefix (struct it
*it
)
19076 Lisp_Object prefix
;
19078 if (it
->continuation_lines_width
> 0)
19080 prefix
= get_it_property (it
, Qwrap_prefix
);
19082 prefix
= Vwrap_prefix
;
19086 prefix
= get_it_property (it
, Qline_prefix
);
19088 prefix
= Vline_prefix
;
19090 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19092 /* If the prefix is wider than the window, and we try to wrap
19093 it, it would acquire its own wrap prefix, and so on till the
19094 iterator stack overflows. So, don't wrap the prefix. */
19095 it
->line_wrap
= TRUNCATE
;
19096 it
->avoid_cursor_p
= 1;
19102 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19103 only for R2L lines from display_line and display_string, when they
19104 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19105 the line/string needs to be continued on the next glyph row. */
19107 unproduce_glyphs (struct it
*it
, int n
)
19109 struct glyph
*glyph
, *end
;
19111 eassert (it
->glyph_row
);
19112 eassert (it
->glyph_row
->reversed_p
);
19113 eassert (it
->area
== TEXT_AREA
);
19114 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19116 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19117 n
= it
->glyph_row
->used
[TEXT_AREA
];
19118 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19119 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19120 for ( ; glyph
< end
; glyph
++)
19121 glyph
[-n
] = *glyph
;
19124 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19125 and ROW->maxpos. */
19127 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19128 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19129 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19131 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19132 lines' rows is implemented for bidi-reordered rows. */
19134 /* ROW->minpos is the value of min_pos, the minimal buffer position
19135 we have in ROW, or ROW->start.pos if that is smaller. */
19136 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19137 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19139 /* We didn't find buffer positions smaller than ROW->start, or
19140 didn't find _any_ valid buffer positions in any of the glyphs,
19141 so we must trust the iterator's computed positions. */
19142 row
->minpos
= row
->start
.pos
;
19145 max_pos
= CHARPOS (it
->current
.pos
);
19146 max_bpos
= BYTEPOS (it
->current
.pos
);
19149 /* Here are the various use-cases for ending the row, and the
19150 corresponding values for ROW->maxpos:
19152 Line ends in a newline from buffer eol_pos + 1
19153 Line is continued from buffer max_pos + 1
19154 Line is truncated on right it->current.pos
19155 Line ends in a newline from string max_pos + 1(*)
19156 (*) + 1 only when line ends in a forward scan
19157 Line is continued from string max_pos
19158 Line is continued from display vector max_pos
19159 Line is entirely from a string min_pos == max_pos
19160 Line is entirely from a display vector min_pos == max_pos
19161 Line that ends at ZV ZV
19163 If you discover other use-cases, please add them here as
19165 if (row
->ends_at_zv_p
)
19166 row
->maxpos
= it
->current
.pos
;
19167 else if (row
->used
[TEXT_AREA
])
19169 int seen_this_string
= 0;
19170 struct glyph_row
*r1
= row
- 1;
19172 /* Did we see the same display string on the previous row? */
19173 if (STRINGP (it
->object
)
19174 /* this is not the first row */
19175 && row
> it
->w
->desired_matrix
->rows
19176 /* previous row is not the header line */
19177 && !r1
->mode_line_p
19178 /* previous row also ends in a newline from a string */
19179 && r1
->ends_in_newline_from_string_p
)
19181 struct glyph
*start
, *end
;
19183 /* Search for the last glyph of the previous row that came
19184 from buffer or string. Depending on whether the row is
19185 L2R or R2L, we need to process it front to back or the
19186 other way round. */
19187 if (!r1
->reversed_p
)
19189 start
= r1
->glyphs
[TEXT_AREA
];
19190 end
= start
+ r1
->used
[TEXT_AREA
];
19191 /* Glyphs inserted by redisplay have an integer (zero)
19192 as their object. */
19194 && INTEGERP ((end
- 1)->object
)
19195 && (end
- 1)->charpos
<= 0)
19199 if (EQ ((end
- 1)->object
, it
->object
))
19200 seen_this_string
= 1;
19203 /* If all the glyphs of the previous row were inserted
19204 by redisplay, it means the previous row was
19205 produced from a single newline, which is only
19206 possible if that newline came from the same string
19207 as the one which produced this ROW. */
19208 seen_this_string
= 1;
19212 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19213 start
= end
+ r1
->used
[TEXT_AREA
];
19215 && INTEGERP ((end
+ 1)->object
)
19216 && (end
+ 1)->charpos
<= 0)
19220 if (EQ ((end
+ 1)->object
, it
->object
))
19221 seen_this_string
= 1;
19224 seen_this_string
= 1;
19227 /* Take note of each display string that covers a newline only
19228 once, the first time we see it. This is for when a display
19229 string includes more than one newline in it. */
19230 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19232 /* If we were scanning the buffer forward when we displayed
19233 the string, we want to account for at least one buffer
19234 position that belongs to this row (position covered by
19235 the display string), so that cursor positioning will
19236 consider this row as a candidate when point is at the end
19237 of the visual line represented by this row. This is not
19238 required when scanning back, because max_pos will already
19239 have a much larger value. */
19240 if (CHARPOS (row
->end
.pos
) > max_pos
)
19241 INC_BOTH (max_pos
, max_bpos
);
19242 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19244 else if (CHARPOS (it
->eol_pos
) > 0)
19245 SET_TEXT_POS (row
->maxpos
,
19246 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19247 else if (row
->continued_p
)
19249 /* If max_pos is different from IT's current position, it
19250 means IT->method does not belong to the display element
19251 at max_pos. However, it also means that the display
19252 element at max_pos was displayed in its entirety on this
19253 line, which is equivalent to saying that the next line
19254 starts at the next buffer position. */
19255 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19256 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19259 INC_BOTH (max_pos
, max_bpos
);
19260 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19263 else if (row
->truncated_on_right_p
)
19264 /* display_line already called reseat_at_next_visible_line_start,
19265 which puts the iterator at the beginning of the next line, in
19266 the logical order. */
19267 row
->maxpos
= it
->current
.pos
;
19268 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19269 /* A line that is entirely from a string/image/stretch... */
19270 row
->maxpos
= row
->minpos
;
19275 row
->maxpos
= it
->current
.pos
;
19278 /* Construct the glyph row IT->glyph_row in the desired matrix of
19279 IT->w from text at the current position of IT. See dispextern.h
19280 for an overview of struct it. Value is non-zero if
19281 IT->glyph_row displays text, as opposed to a line displaying ZV
19285 display_line (struct it
*it
)
19287 struct glyph_row
*row
= it
->glyph_row
;
19288 Lisp_Object overlay_arrow_string
;
19290 void *wrap_data
= NULL
;
19291 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19292 int wrap_row_used
= -1;
19293 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19294 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19295 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19296 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19297 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19299 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19300 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19302 /* We always start displaying at hpos zero even if hscrolled. */
19303 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19305 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19306 >= it
->w
->desired_matrix
->nrows
)
19308 it
->w
->nrows_scale_factor
++;
19309 fonts_changed_p
= 1;
19313 /* Is IT->w showing the region? */
19314 wset_region_showing (it
->w
, it
->region_beg_charpos
> 0 ? Qt
: Qnil
);
19316 /* Clear the result glyph row and enable it. */
19317 prepare_desired_row (row
);
19319 row
->y
= it
->current_y
;
19320 row
->start
= it
->start
;
19321 row
->continuation_lines_width
= it
->continuation_lines_width
;
19322 row
->displays_text_p
= 1;
19323 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19324 it
->starts_in_middle_of_char_p
= 0;
19326 /* Arrange the overlays nicely for our purposes. Usually, we call
19327 display_line on only one line at a time, in which case this
19328 can't really hurt too much, or we call it on lines which appear
19329 one after another in the buffer, in which case all calls to
19330 recenter_overlay_lists but the first will be pretty cheap. */
19331 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19333 /* Move over display elements that are not visible because we are
19334 hscrolled. This may stop at an x-position < IT->first_visible_x
19335 if the first glyph is partially visible or if we hit a line end. */
19336 if (it
->current_x
< it
->first_visible_x
)
19338 enum move_it_result move_result
;
19340 this_line_min_pos
= row
->start
.pos
;
19341 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19342 MOVE_TO_POS
| MOVE_TO_X
);
19343 /* If we are under a large hscroll, move_it_in_display_line_to
19344 could hit the end of the line without reaching
19345 it->first_visible_x. Pretend that we did reach it. This is
19346 especially important on a TTY, where we will call
19347 extend_face_to_end_of_line, which needs to know how many
19348 blank glyphs to produce. */
19349 if (it
->current_x
< it
->first_visible_x
19350 && (move_result
== MOVE_NEWLINE_OR_CR
19351 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19352 it
->current_x
= it
->first_visible_x
;
19354 /* Record the smallest positions seen while we moved over
19355 display elements that are not visible. This is needed by
19356 redisplay_internal for optimizing the case where the cursor
19357 stays inside the same line. The rest of this function only
19358 considers positions that are actually displayed, so
19359 RECORD_MAX_MIN_POS will not otherwise record positions that
19360 are hscrolled to the left of the left edge of the window. */
19361 min_pos
= CHARPOS (this_line_min_pos
);
19362 min_bpos
= BYTEPOS (this_line_min_pos
);
19366 /* We only do this when not calling `move_it_in_display_line_to'
19367 above, because move_it_in_display_line_to calls
19368 handle_line_prefix itself. */
19369 handle_line_prefix (it
);
19372 /* Get the initial row height. This is either the height of the
19373 text hscrolled, if there is any, or zero. */
19374 row
->ascent
= it
->max_ascent
;
19375 row
->height
= it
->max_ascent
+ it
->max_descent
;
19376 row
->phys_ascent
= it
->max_phys_ascent
;
19377 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19378 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19380 /* Utility macro to record max and min buffer positions seen until now. */
19381 #define RECORD_MAX_MIN_POS(IT) \
19384 int composition_p = !STRINGP ((IT)->string) \
19385 && ((IT)->what == IT_COMPOSITION); \
19386 ptrdiff_t current_pos = \
19387 composition_p ? (IT)->cmp_it.charpos \
19388 : IT_CHARPOS (*(IT)); \
19389 ptrdiff_t current_bpos = \
19390 composition_p ? CHAR_TO_BYTE (current_pos) \
19391 : IT_BYTEPOS (*(IT)); \
19392 if (current_pos < min_pos) \
19394 min_pos = current_pos; \
19395 min_bpos = current_bpos; \
19397 if (IT_CHARPOS (*it) > max_pos) \
19399 max_pos = IT_CHARPOS (*it); \
19400 max_bpos = IT_BYTEPOS (*it); \
19405 /* Loop generating characters. The loop is left with IT on the next
19406 character to display. */
19409 int n_glyphs_before
, hpos_before
, x_before
;
19411 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19413 /* Retrieve the next thing to display. Value is zero if end of
19415 if (!get_next_display_element (it
))
19417 /* Maybe add a space at the end of this line that is used to
19418 display the cursor there under X. Set the charpos of the
19419 first glyph of blank lines not corresponding to any text
19421 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19422 row
->exact_window_width_line_p
= 1;
19423 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19424 || row
->used
[TEXT_AREA
] == 0)
19426 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19427 row
->displays_text_p
= 0;
19429 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19430 && (!MINI_WINDOW_P (it
->w
)
19431 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19432 row
->indicate_empty_line_p
= 1;
19435 it
->continuation_lines_width
= 0;
19436 row
->ends_at_zv_p
= 1;
19437 /* A row that displays right-to-left text must always have
19438 its last face extended all the way to the end of line,
19439 even if this row ends in ZV, because we still write to
19440 the screen left to right. We also need to extend the
19441 last face if the default face is remapped to some
19442 different face, otherwise the functions that clear
19443 portions of the screen will clear with the default face's
19444 background color. */
19445 if (row
->reversed_p
19446 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19447 extend_face_to_end_of_line (it
);
19451 /* Now, get the metrics of what we want to display. This also
19452 generates glyphs in `row' (which is IT->glyph_row). */
19453 n_glyphs_before
= row
->used
[TEXT_AREA
];
19456 /* Remember the line height so far in case the next element doesn't
19457 fit on the line. */
19458 if (it
->line_wrap
!= TRUNCATE
)
19460 ascent
= it
->max_ascent
;
19461 descent
= it
->max_descent
;
19462 phys_ascent
= it
->max_phys_ascent
;
19463 phys_descent
= it
->max_phys_descent
;
19465 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19467 if (IT_DISPLAYING_WHITESPACE (it
))
19471 SAVE_IT (wrap_it
, *it
, wrap_data
);
19473 wrap_row_used
= row
->used
[TEXT_AREA
];
19474 wrap_row_ascent
= row
->ascent
;
19475 wrap_row_height
= row
->height
;
19476 wrap_row_phys_ascent
= row
->phys_ascent
;
19477 wrap_row_phys_height
= row
->phys_height
;
19478 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19479 wrap_row_min_pos
= min_pos
;
19480 wrap_row_min_bpos
= min_bpos
;
19481 wrap_row_max_pos
= max_pos
;
19482 wrap_row_max_bpos
= max_bpos
;
19488 PRODUCE_GLYPHS (it
);
19490 /* If this display element was in marginal areas, continue with
19492 if (it
->area
!= TEXT_AREA
)
19494 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19495 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19496 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19497 row
->phys_height
= max (row
->phys_height
,
19498 it
->max_phys_ascent
+ it
->max_phys_descent
);
19499 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19500 it
->max_extra_line_spacing
);
19501 set_iterator_to_next (it
, 1);
19505 /* Does the display element fit on the line? If we truncate
19506 lines, we should draw past the right edge of the window. If
19507 we don't truncate, we want to stop so that we can display the
19508 continuation glyph before the right margin. If lines are
19509 continued, there are two possible strategies for characters
19510 resulting in more than 1 glyph (e.g. tabs): Display as many
19511 glyphs as possible in this line and leave the rest for the
19512 continuation line, or display the whole element in the next
19513 line. Original redisplay did the former, so we do it also. */
19514 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19515 hpos_before
= it
->hpos
;
19518 if (/* Not a newline. */
19520 /* Glyphs produced fit entirely in the line. */
19521 && it
->current_x
< it
->last_visible_x
)
19523 it
->hpos
+= nglyphs
;
19524 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19525 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19526 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19527 row
->phys_height
= max (row
->phys_height
,
19528 it
->max_phys_ascent
+ it
->max_phys_descent
);
19529 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19530 it
->max_extra_line_spacing
);
19531 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19532 row
->x
= x
- it
->first_visible_x
;
19533 /* Record the maximum and minimum buffer positions seen so
19534 far in glyphs that will be displayed by this row. */
19536 RECORD_MAX_MIN_POS (it
);
19541 struct glyph
*glyph
;
19543 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19545 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19546 new_x
= x
+ glyph
->pixel_width
;
19548 if (/* Lines are continued. */
19549 it
->line_wrap
!= TRUNCATE
19550 && (/* Glyph doesn't fit on the line. */
19551 new_x
> it
->last_visible_x
19552 /* Or it fits exactly on a window system frame. */
19553 || (new_x
== it
->last_visible_x
19554 && FRAME_WINDOW_P (it
->f
)
19555 && (row
->reversed_p
19556 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19557 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19559 /* End of a continued line. */
19562 || (new_x
== it
->last_visible_x
19563 && FRAME_WINDOW_P (it
->f
)
19564 && (row
->reversed_p
19565 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19566 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19568 /* Current glyph is the only one on the line or
19569 fits exactly on the line. We must continue
19570 the line because we can't draw the cursor
19571 after the glyph. */
19572 row
->continued_p
= 1;
19573 it
->current_x
= new_x
;
19574 it
->continuation_lines_width
+= new_x
;
19576 if (i
== nglyphs
- 1)
19578 /* If line-wrap is on, check if a previous
19579 wrap point was found. */
19580 if (wrap_row_used
> 0
19581 /* Even if there is a previous wrap
19582 point, continue the line here as
19583 usual, if (i) the previous character
19584 was a space or tab AND (ii) the
19585 current character is not. */
19587 || IT_DISPLAYING_WHITESPACE (it
)))
19590 /* Record the maximum and minimum buffer
19591 positions seen so far in glyphs that will be
19592 displayed by this row. */
19594 RECORD_MAX_MIN_POS (it
);
19595 set_iterator_to_next (it
, 1);
19596 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19598 if (!get_next_display_element (it
))
19600 row
->exact_window_width_line_p
= 1;
19601 it
->continuation_lines_width
= 0;
19602 row
->continued_p
= 0;
19603 row
->ends_at_zv_p
= 1;
19605 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19607 row
->continued_p
= 0;
19608 row
->exact_window_width_line_p
= 1;
19612 else if (it
->bidi_p
)
19613 RECORD_MAX_MIN_POS (it
);
19615 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19616 && !FRAME_WINDOW_P (it
->f
))
19618 /* A padding glyph that doesn't fit on this line.
19619 This means the whole character doesn't fit
19621 if (row
->reversed_p
)
19622 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19623 - n_glyphs_before
);
19624 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19626 /* Fill the rest of the row with continuation
19627 glyphs like in 20.x. */
19628 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19629 < row
->glyphs
[1 + TEXT_AREA
])
19630 produce_special_glyphs (it
, IT_CONTINUATION
);
19632 row
->continued_p
= 1;
19633 it
->current_x
= x_before
;
19634 it
->continuation_lines_width
+= x_before
;
19636 /* Restore the height to what it was before the
19637 element not fitting on the line. */
19638 it
->max_ascent
= ascent
;
19639 it
->max_descent
= descent
;
19640 it
->max_phys_ascent
= phys_ascent
;
19641 it
->max_phys_descent
= phys_descent
;
19643 else if (wrap_row_used
> 0)
19646 if (row
->reversed_p
)
19647 unproduce_glyphs (it
,
19648 row
->used
[TEXT_AREA
] - wrap_row_used
);
19649 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19650 it
->continuation_lines_width
+= wrap_x
;
19651 row
->used
[TEXT_AREA
] = wrap_row_used
;
19652 row
->ascent
= wrap_row_ascent
;
19653 row
->height
= wrap_row_height
;
19654 row
->phys_ascent
= wrap_row_phys_ascent
;
19655 row
->phys_height
= wrap_row_phys_height
;
19656 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19657 min_pos
= wrap_row_min_pos
;
19658 min_bpos
= wrap_row_min_bpos
;
19659 max_pos
= wrap_row_max_pos
;
19660 max_bpos
= wrap_row_max_bpos
;
19661 row
->continued_p
= 1;
19662 row
->ends_at_zv_p
= 0;
19663 row
->exact_window_width_line_p
= 0;
19664 it
->continuation_lines_width
+= x
;
19666 /* Make sure that a non-default face is extended
19667 up to the right margin of the window. */
19668 extend_face_to_end_of_line (it
);
19670 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19672 /* A TAB that extends past the right edge of the
19673 window. This produces a single glyph on
19674 window system frames. We leave the glyph in
19675 this row and let it fill the row, but don't
19676 consume the TAB. */
19677 if ((row
->reversed_p
19678 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19679 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19680 produce_special_glyphs (it
, IT_CONTINUATION
);
19681 it
->continuation_lines_width
+= it
->last_visible_x
;
19682 row
->ends_in_middle_of_char_p
= 1;
19683 row
->continued_p
= 1;
19684 glyph
->pixel_width
= it
->last_visible_x
- x
;
19685 it
->starts_in_middle_of_char_p
= 1;
19689 /* Something other than a TAB that draws past
19690 the right edge of the window. Restore
19691 positions to values before the element. */
19692 if (row
->reversed_p
)
19693 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19694 - (n_glyphs_before
+ i
));
19695 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19697 /* Display continuation glyphs. */
19698 it
->current_x
= x_before
;
19699 it
->continuation_lines_width
+= x
;
19700 if (!FRAME_WINDOW_P (it
->f
)
19701 || (row
->reversed_p
19702 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19703 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19704 produce_special_glyphs (it
, IT_CONTINUATION
);
19705 row
->continued_p
= 1;
19707 extend_face_to_end_of_line (it
);
19709 if (nglyphs
> 1 && i
> 0)
19711 row
->ends_in_middle_of_char_p
= 1;
19712 it
->starts_in_middle_of_char_p
= 1;
19715 /* Restore the height to what it was before the
19716 element not fitting on the line. */
19717 it
->max_ascent
= ascent
;
19718 it
->max_descent
= descent
;
19719 it
->max_phys_ascent
= phys_ascent
;
19720 it
->max_phys_descent
= phys_descent
;
19725 else if (new_x
> it
->first_visible_x
)
19727 /* Increment number of glyphs actually displayed. */
19730 /* Record the maximum and minimum buffer positions
19731 seen so far in glyphs that will be displayed by
19734 RECORD_MAX_MIN_POS (it
);
19736 if (x
< it
->first_visible_x
)
19737 /* Glyph is partially visible, i.e. row starts at
19738 negative X position. */
19739 row
->x
= x
- it
->first_visible_x
;
19743 /* Glyph is completely off the left margin of the
19744 window. This should not happen because of the
19745 move_it_in_display_line at the start of this
19746 function, unless the text display area of the
19747 window is empty. */
19748 eassert (it
->first_visible_x
<= it
->last_visible_x
);
19751 /* Even if this display element produced no glyphs at all,
19752 we want to record its position. */
19753 if (it
->bidi_p
&& nglyphs
== 0)
19754 RECORD_MAX_MIN_POS (it
);
19756 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19757 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19758 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19759 row
->phys_height
= max (row
->phys_height
,
19760 it
->max_phys_ascent
+ it
->max_phys_descent
);
19761 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19762 it
->max_extra_line_spacing
);
19764 /* End of this display line if row is continued. */
19765 if (row
->continued_p
|| row
->ends_at_zv_p
)
19770 /* Is this a line end? If yes, we're also done, after making
19771 sure that a non-default face is extended up to the right
19772 margin of the window. */
19773 if (ITERATOR_AT_END_OF_LINE_P (it
))
19775 int used_before
= row
->used
[TEXT_AREA
];
19777 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19779 /* Add a space at the end of the line that is used to
19780 display the cursor there. */
19781 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19782 append_space_for_newline (it
, 0);
19784 /* Extend the face to the end of the line. */
19785 extend_face_to_end_of_line (it
);
19787 /* Make sure we have the position. */
19788 if (used_before
== 0)
19789 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19791 /* Record the position of the newline, for use in
19793 it
->eol_pos
= it
->current
.pos
;
19795 /* Consume the line end. This skips over invisible lines. */
19796 set_iterator_to_next (it
, 1);
19797 it
->continuation_lines_width
= 0;
19801 /* Proceed with next display element. Note that this skips
19802 over lines invisible because of selective display. */
19803 set_iterator_to_next (it
, 1);
19805 /* If we truncate lines, we are done when the last displayed
19806 glyphs reach past the right margin of the window. */
19807 if (it
->line_wrap
== TRUNCATE
19808 && (FRAME_WINDOW_P (it
->f
) && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19809 ? (it
->current_x
>= it
->last_visible_x
)
19810 : (it
->current_x
> it
->last_visible_x
)))
19812 /* Maybe add truncation glyphs. */
19813 if (!FRAME_WINDOW_P (it
->f
)
19814 || (row
->reversed_p
19815 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19816 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19820 if (!row
->reversed_p
)
19822 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19823 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19828 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19829 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19831 /* Remove any padding glyphs at the front of ROW, to
19832 make room for the truncation glyphs we will be
19833 adding below. The loop below always inserts at
19834 least one truncation glyph, so also remove the
19835 last glyph added to ROW. */
19836 unproduce_glyphs (it
, i
+ 1);
19837 /* Adjust i for the loop below. */
19838 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19841 it
->current_x
= x_before
;
19842 if (!FRAME_WINDOW_P (it
->f
))
19844 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19846 row
->used
[TEXT_AREA
] = i
;
19847 produce_special_glyphs (it
, IT_TRUNCATION
);
19852 row
->used
[TEXT_AREA
] = i
;
19853 produce_special_glyphs (it
, IT_TRUNCATION
);
19856 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19858 /* Don't truncate if we can overflow newline into fringe. */
19859 if (!get_next_display_element (it
))
19861 it
->continuation_lines_width
= 0;
19862 row
->ends_at_zv_p
= 1;
19863 row
->exact_window_width_line_p
= 1;
19866 if (ITERATOR_AT_END_OF_LINE_P (it
))
19868 row
->exact_window_width_line_p
= 1;
19869 goto at_end_of_line
;
19871 it
->current_x
= x_before
;
19874 row
->truncated_on_right_p
= 1;
19875 it
->continuation_lines_width
= 0;
19876 reseat_at_next_visible_line_start (it
, 0);
19877 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19878 it
->hpos
= hpos_before
;
19884 bidi_unshelve_cache (wrap_data
, 1);
19886 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19887 at the left window margin. */
19888 if (it
->first_visible_x
19889 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19891 if (!FRAME_WINDOW_P (it
->f
)
19892 || (row
->reversed_p
19893 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19894 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
19895 insert_left_trunc_glyphs (it
);
19896 row
->truncated_on_left_p
= 1;
19899 /* Remember the position at which this line ends.
19901 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19902 cannot be before the call to find_row_edges below, since that is
19903 where these positions are determined. */
19904 row
->end
= it
->current
;
19907 row
->minpos
= row
->start
.pos
;
19908 row
->maxpos
= row
->end
.pos
;
19912 /* ROW->minpos and ROW->maxpos must be the smallest and
19913 `1 + the largest' buffer positions in ROW. But if ROW was
19914 bidi-reordered, these two positions can be anywhere in the
19915 row, so we must determine them now. */
19916 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19919 /* If the start of this line is the overlay arrow-position, then
19920 mark this glyph row as the one containing the overlay arrow.
19921 This is clearly a mess with variable size fonts. It would be
19922 better to let it be displayed like cursors under X. */
19923 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19924 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19925 !NILP (overlay_arrow_string
)))
19927 /* Overlay arrow in window redisplay is a fringe bitmap. */
19928 if (STRINGP (overlay_arrow_string
))
19930 struct glyph_row
*arrow_row
19931 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19932 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19933 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19934 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19935 struct glyph
*p2
, *end
;
19937 /* Copy the arrow glyphs. */
19938 while (glyph
< arrow_end
)
19941 /* Throw away padding glyphs. */
19943 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19944 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19950 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19955 eassert (INTEGERP (overlay_arrow_string
));
19956 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19958 overlay_arrow_seen
= 1;
19961 /* Highlight trailing whitespace. */
19962 if (!NILP (Vshow_trailing_whitespace
))
19963 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19965 /* Compute pixel dimensions of this line. */
19966 compute_line_metrics (it
);
19968 /* Implementation note: No changes in the glyphs of ROW or in their
19969 faces can be done past this point, because compute_line_metrics
19970 computes ROW's hash value and stores it within the glyph_row
19973 /* Record whether this row ends inside an ellipsis. */
19974 row
->ends_in_ellipsis_p
19975 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19976 && it
->ellipsis_p
);
19978 /* Save fringe bitmaps in this row. */
19979 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19980 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19981 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19982 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19984 it
->left_user_fringe_bitmap
= 0;
19985 it
->left_user_fringe_face_id
= 0;
19986 it
->right_user_fringe_bitmap
= 0;
19987 it
->right_user_fringe_face_id
= 0;
19989 /* Maybe set the cursor. */
19990 cvpos
= it
->w
->cursor
.vpos
;
19992 /* In bidi-reordered rows, keep checking for proper cursor
19993 position even if one has been found already, because buffer
19994 positions in such rows change non-linearly with ROW->VPOS,
19995 when a line is continued. One exception: when we are at ZV,
19996 display cursor on the first suitable glyph row, since all
19997 the empty rows after that also have their position set to ZV. */
19998 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19999 lines' rows is implemented for bidi-reordered rows. */
20001 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20002 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20003 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20004 && cursor_row_p (row
))
20005 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20007 /* Prepare for the next line. This line starts horizontally at (X
20008 HPOS) = (0 0). Vertical positions are incremented. As a
20009 convenience for the caller, IT->glyph_row is set to the next
20011 it
->current_x
= it
->hpos
= 0;
20012 it
->current_y
+= row
->height
;
20013 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20016 /* The next row should by default use the same value of the
20017 reversed_p flag as this one. set_iterator_to_next decides when
20018 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20019 the flag accordingly. */
20020 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20021 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20022 it
->start
= row
->end
;
20023 return row
->displays_text_p
;
20025 #undef RECORD_MAX_MIN_POS
20028 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20029 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20030 doc
: /* Return paragraph direction at point in BUFFER.
20031 Value is either `left-to-right' or `right-to-left'.
20032 If BUFFER is omitted or nil, it defaults to the current buffer.
20034 Paragraph direction determines how the text in the paragraph is displayed.
20035 In left-to-right paragraphs, text begins at the left margin of the window
20036 and the reading direction is generally left to right. In right-to-left
20037 paragraphs, text begins at the right margin and is read from right to left.
20039 See also `bidi-paragraph-direction'. */)
20040 (Lisp_Object buffer
)
20042 struct buffer
*buf
= current_buffer
;
20043 struct buffer
*old
= buf
;
20045 if (! NILP (buffer
))
20047 CHECK_BUFFER (buffer
);
20048 buf
= XBUFFER (buffer
);
20051 if (NILP (BVAR (buf
, bidi_display_reordering
))
20052 || NILP (BVAR (buf
, enable_multibyte_characters
))
20053 /* When we are loading loadup.el, the character property tables
20054 needed for bidi iteration are not yet available. */
20055 || !NILP (Vpurify_flag
))
20056 return Qleft_to_right
;
20057 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20058 return BVAR (buf
, bidi_paragraph_direction
);
20061 /* Determine the direction from buffer text. We could try to
20062 use current_matrix if it is up to date, but this seems fast
20063 enough as it is. */
20064 struct bidi_it itb
;
20065 ptrdiff_t pos
= BUF_PT (buf
);
20066 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20068 void *itb_data
= bidi_shelve_cache ();
20070 set_buffer_temp (buf
);
20071 /* bidi_paragraph_init finds the base direction of the paragraph
20072 by searching forward from paragraph start. We need the base
20073 direction of the current or _previous_ paragraph, so we need
20074 to make sure we are within that paragraph. To that end, find
20075 the previous non-empty line. */
20076 if (pos
>= ZV
&& pos
> BEGV
)
20079 bytepos
= CHAR_TO_BYTE (pos
);
20081 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20082 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20084 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20085 || c
== ' ' || c
== '\t' || c
== '\f')
20087 if (bytepos
<= BEGV_BYTE
)
20092 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20095 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20096 itb
.paragraph_dir
= NEUTRAL_DIR
;
20097 itb
.string
.s
= NULL
;
20098 itb
.string
.lstring
= Qnil
;
20099 itb
.string
.bufpos
= 0;
20100 itb
.string
.unibyte
= 0;
20101 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20102 bidi_unshelve_cache (itb_data
, 0);
20103 set_buffer_temp (old
);
20104 switch (itb
.paragraph_dir
)
20107 return Qleft_to_right
;
20110 return Qright_to_left
;
20120 /***********************************************************************
20122 ***********************************************************************/
20124 /* Redisplay the menu bar in the frame for window W.
20126 The menu bar of X frames that don't have X toolkit support is
20127 displayed in a special window W->frame->menu_bar_window.
20129 The menu bar of terminal frames is treated specially as far as
20130 glyph matrices are concerned. Menu bar lines are not part of
20131 windows, so the update is done directly on the frame matrix rows
20132 for the menu bar. */
20135 display_menu_bar (struct window
*w
)
20137 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20142 /* Don't do all this for graphical frames. */
20144 if (FRAME_W32_P (f
))
20147 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
20153 if (FRAME_NS_P (f
))
20155 #endif /* HAVE_NS */
20157 #ifdef USE_X_TOOLKIT
20158 eassert (!FRAME_WINDOW_P (f
));
20159 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
20160 it
.first_visible_x
= 0;
20161 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20162 #else /* not USE_X_TOOLKIT */
20163 if (FRAME_WINDOW_P (f
))
20165 /* Menu bar lines are displayed in the desired matrix of the
20166 dummy window menu_bar_window. */
20167 struct window
*menu_w
;
20168 eassert (WINDOWP (f
->menu_bar_window
));
20169 menu_w
= XWINDOW (f
->menu_bar_window
);
20170 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
20172 it
.first_visible_x
= 0;
20173 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20177 /* This is a TTY frame, i.e. character hpos/vpos are used as
20179 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
20181 it
.first_visible_x
= 0;
20182 it
.last_visible_x
= FRAME_COLS (f
);
20184 #endif /* not USE_X_TOOLKIT */
20186 /* FIXME: This should be controlled by a user option. See the
20187 comments in redisplay_tool_bar and display_mode_line about
20189 it
.paragraph_embedding
= L2R
;
20191 /* Clear all rows of the menu bar. */
20192 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
20194 struct glyph_row
*row
= it
.glyph_row
+ i
;
20195 clear_glyph_row (row
);
20196 row
->enabled_p
= 1;
20197 row
->full_width_p
= 1;
20200 /* Display all items of the menu bar. */
20201 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
20202 for (i
= 0; i
< ASIZE (items
); i
+= 4)
20204 Lisp_Object string
;
20206 /* Stop at nil string. */
20207 string
= AREF (items
, i
+ 1);
20211 /* Remember where item was displayed. */
20212 ASET (items
, i
+ 3, make_number (it
.hpos
));
20214 /* Display the item, pad with one space. */
20215 if (it
.current_x
< it
.last_visible_x
)
20216 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
20217 SCHARS (string
) + 1, 0, 0, -1);
20220 /* Fill out the line with spaces. */
20221 if (it
.current_x
< it
.last_visible_x
)
20222 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
20224 /* Compute the total height of the lines. */
20225 compute_line_metrics (&it
);
20230 /***********************************************************************
20232 ***********************************************************************/
20234 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20235 FORCE is non-zero, redisplay mode lines unconditionally.
20236 Otherwise, redisplay only mode lines that are garbaged. Value is
20237 the number of windows whose mode lines were redisplayed. */
20240 redisplay_mode_lines (Lisp_Object window
, int force
)
20244 while (!NILP (window
))
20246 struct window
*w
= XWINDOW (window
);
20248 if (WINDOWP (w
->hchild
))
20249 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
20250 else if (WINDOWP (w
->vchild
))
20251 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
20253 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20254 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20256 struct text_pos lpoint
;
20257 struct buffer
*old
= current_buffer
;
20259 /* Set the window's buffer for the mode line display. */
20260 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20261 set_buffer_internal_1 (XBUFFER (w
->buffer
));
20263 /* Point refers normally to the selected window. For any
20264 other window, set up appropriate value. */
20265 if (!EQ (window
, selected_window
))
20267 struct text_pos pt
;
20269 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20270 if (CHARPOS (pt
) < BEGV
)
20271 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
20272 else if (CHARPOS (pt
) > (ZV
- 1))
20273 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
20275 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20278 /* Display mode lines. */
20279 clear_glyph_matrix (w
->desired_matrix
);
20280 if (display_mode_lines (w
))
20283 w
->must_be_updated_p
= 1;
20286 /* Restore old settings. */
20287 set_buffer_internal_1 (old
);
20288 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20298 /* Display the mode and/or header line of window W. Value is the
20299 sum number of mode lines and header lines displayed. */
20302 display_mode_lines (struct window
*w
)
20304 Lisp_Object old_selected_window
= selected_window
;
20305 Lisp_Object old_selected_frame
= selected_frame
;
20306 Lisp_Object new_frame
= w
->frame
;
20307 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
20310 selected_frame
= new_frame
;
20311 /* FIXME: If we were to allow the mode-line's computation changing the buffer
20312 or window's point, then we'd need select_window_1 here as well. */
20313 XSETWINDOW (selected_window
, w
);
20314 XFRAME (new_frame
)->selected_window
= selected_window
;
20316 /* These will be set while the mode line specs are processed. */
20317 line_number_displayed
= 0;
20318 wset_column_number_displayed (w
, Qnil
);
20320 if (WINDOW_WANTS_MODELINE_P (w
))
20322 struct window
*sel_w
= XWINDOW (old_selected_window
);
20324 /* Select mode line face based on the real selected window. */
20325 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20326 BVAR (current_buffer
, mode_line_format
));
20330 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20332 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20333 BVAR (current_buffer
, header_line_format
));
20337 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
20338 selected_frame
= old_selected_frame
;
20339 selected_window
= old_selected_window
;
20344 /* Display mode or header line of window W. FACE_ID specifies which
20345 line to display; it is either MODE_LINE_FACE_ID or
20346 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20347 display. Value is the pixel height of the mode/header line
20351 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20355 ptrdiff_t count
= SPECPDL_INDEX ();
20357 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20358 /* Don't extend on a previously drawn mode-line.
20359 This may happen if called from pos_visible_p. */
20360 it
.glyph_row
->enabled_p
= 0;
20361 prepare_desired_row (it
.glyph_row
);
20363 it
.glyph_row
->mode_line_p
= 1;
20365 /* FIXME: This should be controlled by a user option. But
20366 supporting such an option is not trivial, since the mode line is
20367 made up of many separate strings. */
20368 it
.paragraph_embedding
= L2R
;
20370 record_unwind_protect (unwind_format_mode_line
,
20371 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
20373 mode_line_target
= MODE_LINE_DISPLAY
;
20375 /* Temporarily make frame's keyboard the current kboard so that
20376 kboard-local variables in the mode_line_format will get the right
20378 push_kboard (FRAME_KBOARD (it
.f
));
20379 record_unwind_save_match_data ();
20380 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20383 unbind_to (count
, Qnil
);
20385 /* Fill up with spaces. */
20386 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20388 compute_line_metrics (&it
);
20389 it
.glyph_row
->full_width_p
= 1;
20390 it
.glyph_row
->continued_p
= 0;
20391 it
.glyph_row
->truncated_on_left_p
= 0;
20392 it
.glyph_row
->truncated_on_right_p
= 0;
20394 /* Make a 3D mode-line have a shadow at its right end. */
20395 face
= FACE_FROM_ID (it
.f
, face_id
);
20396 extend_face_to_end_of_line (&it
);
20397 if (face
->box
!= FACE_NO_BOX
)
20399 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20400 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20401 last
->right_box_line_p
= 1;
20404 return it
.glyph_row
->height
;
20407 /* Move element ELT in LIST to the front of LIST.
20408 Return the updated list. */
20411 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20413 register Lisp_Object tail
, prev
;
20414 register Lisp_Object tem
;
20418 while (CONSP (tail
))
20424 /* Splice out the link TAIL. */
20426 list
= XCDR (tail
);
20428 Fsetcdr (prev
, XCDR (tail
));
20430 /* Now make it the first. */
20431 Fsetcdr (tail
, list
);
20436 tail
= XCDR (tail
);
20440 /* Not found--return unchanged LIST. */
20444 /* Contribute ELT to the mode line for window IT->w. How it
20445 translates into text depends on its data type.
20447 IT describes the display environment in which we display, as usual.
20449 DEPTH is the depth in recursion. It is used to prevent
20450 infinite recursion here.
20452 FIELD_WIDTH is the number of characters the display of ELT should
20453 occupy in the mode line, and PRECISION is the maximum number of
20454 characters to display from ELT's representation. See
20455 display_string for details.
20457 Returns the hpos of the end of the text generated by ELT.
20459 PROPS is a property list to add to any string we encounter.
20461 If RISKY is nonzero, remove (disregard) any properties in any string
20462 we encounter, and ignore :eval and :propertize.
20464 The global variable `mode_line_target' determines whether the
20465 output is passed to `store_mode_line_noprop',
20466 `store_mode_line_string', or `display_string'. */
20469 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20470 Lisp_Object elt
, Lisp_Object props
, int risky
)
20472 int n
= 0, field
, prec
;
20477 elt
= build_string ("*too-deep*");
20481 switch (XTYPE (elt
))
20485 /* A string: output it and check for %-constructs within it. */
20487 ptrdiff_t offset
= 0;
20489 if (SCHARS (elt
) > 0
20490 && (!NILP (props
) || risky
))
20492 Lisp_Object oprops
, aelt
;
20493 oprops
= Ftext_properties_at (make_number (0), elt
);
20495 /* If the starting string's properties are not what
20496 we want, translate the string. Also, if the string
20497 is risky, do that anyway. */
20499 if (NILP (Fequal (props
, oprops
)) || risky
)
20501 /* If the starting string has properties,
20502 merge the specified ones onto the existing ones. */
20503 if (! NILP (oprops
) && !risky
)
20507 oprops
= Fcopy_sequence (oprops
);
20509 while (CONSP (tem
))
20511 oprops
= Fplist_put (oprops
, XCAR (tem
),
20512 XCAR (XCDR (tem
)));
20513 tem
= XCDR (XCDR (tem
));
20518 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20519 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20521 /* AELT is what we want. Move it to the front
20522 without consing. */
20524 mode_line_proptrans_alist
20525 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20531 /* If AELT has the wrong props, it is useless.
20532 so get rid of it. */
20534 mode_line_proptrans_alist
20535 = Fdelq (aelt
, mode_line_proptrans_alist
);
20537 elt
= Fcopy_sequence (elt
);
20538 Fset_text_properties (make_number (0), Flength (elt
),
20540 /* Add this item to mode_line_proptrans_alist. */
20541 mode_line_proptrans_alist
20542 = Fcons (Fcons (elt
, props
),
20543 mode_line_proptrans_alist
);
20544 /* Truncate mode_line_proptrans_alist
20545 to at most 50 elements. */
20546 tem
= Fnthcdr (make_number (50),
20547 mode_line_proptrans_alist
);
20549 XSETCDR (tem
, Qnil
);
20558 prec
= precision
- n
;
20559 switch (mode_line_target
)
20561 case MODE_LINE_NOPROP
:
20562 case MODE_LINE_TITLE
:
20563 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20565 case MODE_LINE_STRING
:
20566 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20568 case MODE_LINE_DISPLAY
:
20569 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20570 0, prec
, 0, STRING_MULTIBYTE (elt
));
20577 /* Handle the non-literal case. */
20579 while ((precision
<= 0 || n
< precision
)
20580 && SREF (elt
, offset
) != 0
20581 && (mode_line_target
!= MODE_LINE_DISPLAY
20582 || it
->current_x
< it
->last_visible_x
))
20584 ptrdiff_t last_offset
= offset
;
20586 /* Advance to end of string or next format specifier. */
20587 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20590 if (offset
- 1 != last_offset
)
20592 ptrdiff_t nchars
, nbytes
;
20594 /* Output to end of string or up to '%'. Field width
20595 is length of string. Don't output more than
20596 PRECISION allows us. */
20599 prec
= c_string_width (SDATA (elt
) + last_offset
,
20600 offset
- last_offset
, precision
- n
,
20603 switch (mode_line_target
)
20605 case MODE_LINE_NOPROP
:
20606 case MODE_LINE_TITLE
:
20607 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20609 case MODE_LINE_STRING
:
20611 ptrdiff_t bytepos
= last_offset
;
20612 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20613 ptrdiff_t endpos
= (precision
<= 0
20614 ? string_byte_to_char (elt
, offset
)
20615 : charpos
+ nchars
);
20617 n
+= store_mode_line_string (NULL
,
20618 Fsubstring (elt
, make_number (charpos
),
20619 make_number (endpos
)),
20623 case MODE_LINE_DISPLAY
:
20625 ptrdiff_t bytepos
= last_offset
;
20626 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20628 if (precision
<= 0)
20629 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20630 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20632 STRING_MULTIBYTE (elt
));
20637 else /* c == '%' */
20639 ptrdiff_t percent_position
= offset
;
20641 /* Get the specified minimum width. Zero means
20644 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20645 field
= field
* 10 + c
- '0';
20647 /* Don't pad beyond the total padding allowed. */
20648 if (field_width
- n
> 0 && field
> field_width
- n
)
20649 field
= field_width
- n
;
20651 /* Note that either PRECISION <= 0 or N < PRECISION. */
20652 prec
= precision
- n
;
20655 n
+= display_mode_element (it
, depth
, field
, prec
,
20656 Vglobal_mode_string
, props
,
20661 ptrdiff_t bytepos
, charpos
;
20663 Lisp_Object string
;
20665 bytepos
= percent_position
;
20666 charpos
= (STRING_MULTIBYTE (elt
)
20667 ? string_byte_to_char (elt
, bytepos
)
20669 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20670 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20672 switch (mode_line_target
)
20674 case MODE_LINE_NOPROP
:
20675 case MODE_LINE_TITLE
:
20676 n
+= store_mode_line_noprop (spec
, field
, prec
);
20678 case MODE_LINE_STRING
:
20680 Lisp_Object tem
= build_string (spec
);
20681 props
= Ftext_properties_at (make_number (charpos
), elt
);
20682 /* Should only keep face property in props */
20683 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20686 case MODE_LINE_DISPLAY
:
20688 int nglyphs_before
, nwritten
;
20690 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20691 nwritten
= display_string (spec
, string
, elt
,
20696 /* Assign to the glyphs written above the
20697 string where the `%x' came from, position
20701 struct glyph
*glyph
20702 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20706 for (i
= 0; i
< nwritten
; ++i
)
20708 glyph
[i
].object
= elt
;
20709 glyph
[i
].charpos
= charpos
;
20726 /* A symbol: process the value of the symbol recursively
20727 as if it appeared here directly. Avoid error if symbol void.
20728 Special case: if value of symbol is a string, output the string
20731 register Lisp_Object tem
;
20733 /* If the variable is not marked as risky to set
20734 then its contents are risky to use. */
20735 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20738 tem
= Fboundp (elt
);
20741 tem
= Fsymbol_value (elt
);
20742 /* If value is a string, output that string literally:
20743 don't check for % within it. */
20747 if (!EQ (tem
, elt
))
20749 /* Give up right away for nil or t. */
20759 register Lisp_Object car
, tem
;
20761 /* A cons cell: five distinct cases.
20762 If first element is :eval or :propertize, do something special.
20763 If first element is a string or a cons, process all the elements
20764 and effectively concatenate them.
20765 If first element is a negative number, truncate displaying cdr to
20766 at most that many characters. If positive, pad (with spaces)
20767 to at least that many characters.
20768 If first element is a symbol, process the cadr or caddr recursively
20769 according to whether the symbol's value is non-nil or nil. */
20771 if (EQ (car
, QCeval
))
20773 /* An element of the form (:eval FORM) means evaluate FORM
20774 and use the result as mode line elements. */
20779 if (CONSP (XCDR (elt
)))
20782 spec
= safe_eval (XCAR (XCDR (elt
)));
20783 n
+= display_mode_element (it
, depth
, field_width
- n
,
20784 precision
- n
, spec
, props
,
20788 else if (EQ (car
, QCpropertize
))
20790 /* An element of the form (:propertize ELT PROPS...)
20791 means display ELT but applying properties PROPS. */
20796 if (CONSP (XCDR (elt
)))
20797 n
+= display_mode_element (it
, depth
, field_width
- n
,
20798 precision
- n
, XCAR (XCDR (elt
)),
20799 XCDR (XCDR (elt
)), risky
);
20801 else if (SYMBOLP (car
))
20803 tem
= Fboundp (car
);
20807 /* elt is now the cdr, and we know it is a cons cell.
20808 Use its car if CAR has a non-nil value. */
20811 tem
= Fsymbol_value (car
);
20818 /* Symbol's value is nil (or symbol is unbound)
20819 Get the cddr of the original list
20820 and if possible find the caddr and use that. */
20824 else if (!CONSP (elt
))
20829 else if (INTEGERP (car
))
20831 register int lim
= XINT (car
);
20835 /* Negative int means reduce maximum width. */
20836 if (precision
<= 0)
20839 precision
= min (precision
, -lim
);
20843 /* Padding specified. Don't let it be more than
20844 current maximum. */
20846 lim
= min (precision
, lim
);
20848 /* If that's more padding than already wanted, queue it.
20849 But don't reduce padding already specified even if
20850 that is beyond the current truncation point. */
20851 field_width
= max (lim
, field_width
);
20855 else if (STRINGP (car
) || CONSP (car
))
20857 Lisp_Object halftail
= elt
;
20861 && (precision
<= 0 || n
< precision
))
20863 n
+= display_mode_element (it
, depth
,
20864 /* Do padding only after the last
20865 element in the list. */
20866 (! CONSP (XCDR (elt
))
20869 precision
- n
, XCAR (elt
),
20873 if ((len
& 1) == 0)
20874 halftail
= XCDR (halftail
);
20875 /* Check for cycle. */
20876 if (EQ (halftail
, elt
))
20885 elt
= build_string ("*invalid*");
20889 /* Pad to FIELD_WIDTH. */
20890 if (field_width
> 0 && n
< field_width
)
20892 switch (mode_line_target
)
20894 case MODE_LINE_NOPROP
:
20895 case MODE_LINE_TITLE
:
20896 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20898 case MODE_LINE_STRING
:
20899 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20901 case MODE_LINE_DISPLAY
:
20902 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20911 /* Store a mode-line string element in mode_line_string_list.
20913 If STRING is non-null, display that C string. Otherwise, the Lisp
20914 string LISP_STRING is displayed.
20916 FIELD_WIDTH is the minimum number of output glyphs to produce.
20917 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20918 with spaces. FIELD_WIDTH <= 0 means don't pad.
20920 PRECISION is the maximum number of characters to output from
20921 STRING. PRECISION <= 0 means don't truncate the string.
20923 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20924 properties to the string.
20926 PROPS are the properties to add to the string.
20927 The mode_line_string_face face property is always added to the string.
20931 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20932 int field_width
, int precision
, Lisp_Object props
)
20937 if (string
!= NULL
)
20939 len
= strlen (string
);
20940 if (precision
> 0 && len
> precision
)
20942 lisp_string
= make_string (string
, len
);
20944 props
= mode_line_string_face_prop
;
20945 else if (!NILP (mode_line_string_face
))
20947 Lisp_Object face
= Fplist_get (props
, Qface
);
20948 props
= Fcopy_sequence (props
);
20950 face
= mode_line_string_face
;
20952 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20953 props
= Fplist_put (props
, Qface
, face
);
20955 Fadd_text_properties (make_number (0), make_number (len
),
20956 props
, lisp_string
);
20960 len
= XFASTINT (Flength (lisp_string
));
20961 if (precision
> 0 && len
> precision
)
20964 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20967 if (!NILP (mode_line_string_face
))
20971 props
= Ftext_properties_at (make_number (0), lisp_string
);
20972 face
= Fplist_get (props
, Qface
);
20974 face
= mode_line_string_face
;
20976 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20977 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20979 lisp_string
= Fcopy_sequence (lisp_string
);
20982 Fadd_text_properties (make_number (0), make_number (len
),
20983 props
, lisp_string
);
20988 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20992 if (field_width
> len
)
20994 field_width
-= len
;
20995 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20997 Fadd_text_properties (make_number (0), make_number (field_width
),
20998 props
, lisp_string
);
20999 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
21007 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
21009 doc
: /* Format a string out of a mode line format specification.
21010 First arg FORMAT specifies the mode line format (see `mode-line-format'
21011 for details) to use.
21013 By default, the format is evaluated for the currently selected window.
21015 Optional second arg FACE specifies the face property to put on all
21016 characters for which no face is specified. The value nil means the
21017 default face. The value t means whatever face the window's mode line
21018 currently uses (either `mode-line' or `mode-line-inactive',
21019 depending on whether the window is the selected window or not).
21020 An integer value means the value string has no text
21023 Optional third and fourth args WINDOW and BUFFER specify the window
21024 and buffer to use as the context for the formatting (defaults
21025 are the selected window and the WINDOW's buffer). */)
21026 (Lisp_Object format
, Lisp_Object face
,
21027 Lisp_Object window
, Lisp_Object buffer
)
21032 struct buffer
*old_buffer
= NULL
;
21034 int no_props
= INTEGERP (face
);
21035 ptrdiff_t count
= SPECPDL_INDEX ();
21037 int string_start
= 0;
21039 w
= decode_any_window (window
);
21040 XSETWINDOW (window
, w
);
21043 buffer
= w
->buffer
;
21044 CHECK_BUFFER (buffer
);
21046 /* Make formatting the modeline a non-op when noninteractive, otherwise
21047 there will be problems later caused by a partially initialized frame. */
21048 if (NILP (format
) || noninteractive
)
21049 return empty_unibyte_string
;
21054 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
21055 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
21056 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
21057 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
21058 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
21059 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
21060 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
21063 old_buffer
= current_buffer
;
21065 /* Save things including mode_line_proptrans_alist,
21066 and set that to nil so that we don't alter the outer value. */
21067 record_unwind_protect (unwind_format_mode_line
,
21068 format_mode_line_unwind_data
21069 (XFRAME (WINDOW_FRAME (w
)),
21070 old_buffer
, selected_window
, 1));
21071 mode_line_proptrans_alist
= Qnil
;
21073 Fselect_window (window
, Qt
);
21074 set_buffer_internal_1 (XBUFFER (buffer
));
21076 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21080 mode_line_target
= MODE_LINE_NOPROP
;
21081 mode_line_string_face_prop
= Qnil
;
21082 mode_line_string_list
= Qnil
;
21083 string_start
= MODE_LINE_NOPROP_LEN (0);
21087 mode_line_target
= MODE_LINE_STRING
;
21088 mode_line_string_list
= Qnil
;
21089 mode_line_string_face
= face
;
21090 mode_line_string_face_prop
21091 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
21094 push_kboard (FRAME_KBOARD (it
.f
));
21095 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21100 len
= MODE_LINE_NOPROP_LEN (string_start
);
21101 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
21105 mode_line_string_list
= Fnreverse (mode_line_string_list
);
21106 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
21107 empty_unibyte_string
);
21110 unbind_to (count
, Qnil
);
21114 /* Write a null-terminated, right justified decimal representation of
21115 the positive integer D to BUF using a minimal field width WIDTH. */
21118 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
21120 register char *p
= buf
;
21128 *p
++ = d
% 10 + '0';
21133 for (width
-= (int) (p
- buf
); width
> 0; --width
)
21144 /* Write a null-terminated, right justified decimal and "human
21145 readable" representation of the nonnegative integer D to BUF using
21146 a minimal field width WIDTH. D should be smaller than 999.5e24. */
21148 static const char power_letter
[] =
21162 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
21164 /* We aim to represent the nonnegative integer D as
21165 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
21166 ptrdiff_t quotient
= d
;
21168 /* -1 means: do not use TENTHS. */
21172 /* Length of QUOTIENT.TENTHS as a string. */
21178 if (1000 <= quotient
)
21180 /* Scale to the appropriate EXPONENT. */
21183 remainder
= quotient
% 1000;
21187 while (1000 <= quotient
);
21189 /* Round to nearest and decide whether to use TENTHS or not. */
21192 tenths
= remainder
/ 100;
21193 if (50 <= remainder
% 100)
21200 if (quotient
== 10)
21208 if (500 <= remainder
)
21210 if (quotient
< 999)
21221 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21222 if (tenths
== -1 && quotient
<= 99)
21229 p
= psuffix
= buf
+ max (width
, length
);
21231 /* Print EXPONENT. */
21232 *psuffix
++ = power_letter
[exponent
];
21235 /* Print TENTHS. */
21238 *--p
= '0' + tenths
;
21242 /* Print QUOTIENT. */
21245 int digit
= quotient
% 10;
21246 *--p
= '0' + digit
;
21248 while ((quotient
/= 10) != 0);
21250 /* Print leading spaces. */
21255 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21256 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21257 type of CODING_SYSTEM. Return updated pointer into BUF. */
21259 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21262 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21265 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21266 const unsigned char *eol_str
;
21268 /* The EOL conversion we are using. */
21269 Lisp_Object eoltype
;
21271 val
= CODING_SYSTEM_SPEC (coding_system
);
21274 if (!VECTORP (val
)) /* Not yet decided. */
21276 *buf
++ = multibyte
? '-' : ' ';
21278 eoltype
= eol_mnemonic_undecided
;
21279 /* Don't mention EOL conversion if it isn't decided. */
21284 Lisp_Object eolvalue
;
21286 attrs
= AREF (val
, 0);
21287 eolvalue
= AREF (val
, 2);
21290 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21295 /* The EOL conversion that is normal on this system. */
21297 if (NILP (eolvalue
)) /* Not yet decided. */
21298 eoltype
= eol_mnemonic_undecided
;
21299 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21300 eoltype
= eol_mnemonic_undecided
;
21301 else /* eolvalue is Qunix, Qdos, or Qmac. */
21302 eoltype
= (EQ (eolvalue
, Qunix
)
21303 ? eol_mnemonic_unix
21304 : (EQ (eolvalue
, Qdos
) == 1
21305 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21311 /* Mention the EOL conversion if it is not the usual one. */
21312 if (STRINGP (eoltype
))
21314 eol_str
= SDATA (eoltype
);
21315 eol_str_len
= SBYTES (eoltype
);
21317 else if (CHARACTERP (eoltype
))
21319 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
21320 int c
= XFASTINT (eoltype
);
21321 eol_str_len
= CHAR_STRING (c
, tmp
);
21326 eol_str
= invalid_eol_type
;
21327 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21329 memcpy (buf
, eol_str
, eol_str_len
);
21330 buf
+= eol_str_len
;
21336 /* Return a string for the output of a mode line %-spec for window W,
21337 generated by character C. FIELD_WIDTH > 0 means pad the string
21338 returned with spaces to that value. Return a Lisp string in
21339 *STRING if the resulting string is taken from that Lisp string.
21341 Note we operate on the current buffer for most purposes,
21342 the exception being w->base_line_pos. */
21344 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21346 static const char *
21347 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21348 Lisp_Object
*string
)
21351 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21352 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21353 /* We are going to use f->decode_mode_spec_buffer as the buffer to
21354 produce strings from numerical values, so limit preposterously
21355 large values of FIELD_WIDTH to avoid overrunning the buffer's
21356 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
21357 bytes plus the terminating null. */
21358 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
21359 struct buffer
*b
= current_buffer
;
21367 if (!NILP (BVAR (b
, read_only
)))
21369 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21374 /* This differs from %* only for a modified read-only buffer. */
21375 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21377 if (!NILP (BVAR (b
, read_only
)))
21382 /* This differs from %* in ignoring read-only-ness. */
21383 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21395 if (command_loop_level
> 5)
21397 p
= decode_mode_spec_buf
;
21398 for (i
= 0; i
< command_loop_level
; i
++)
21401 return decode_mode_spec_buf
;
21409 if (command_loop_level
> 5)
21411 p
= decode_mode_spec_buf
;
21412 for (i
= 0; i
< command_loop_level
; i
++)
21415 return decode_mode_spec_buf
;
21422 /* Let lots_of_dashes be a string of infinite length. */
21423 if (mode_line_target
== MODE_LINE_NOPROP
21424 || mode_line_target
== MODE_LINE_STRING
)
21426 if (field_width
<= 0
21427 || field_width
> sizeof (lots_of_dashes
))
21429 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21430 decode_mode_spec_buf
[i
] = '-';
21431 decode_mode_spec_buf
[i
] = '\0';
21432 return decode_mode_spec_buf
;
21435 return lots_of_dashes
;
21439 obj
= BVAR (b
, name
);
21443 /* %c and %l are ignored in `frame-title-format'.
21444 (In redisplay_internal, the frame title is drawn _before_ the
21445 windows are updated, so the stuff which depends on actual
21446 window contents (such as %l) may fail to render properly, or
21447 even crash emacs.) */
21448 if (mode_line_target
== MODE_LINE_TITLE
)
21452 ptrdiff_t col
= current_column ();
21453 wset_column_number_displayed (w
, make_number (col
));
21454 pint2str (decode_mode_spec_buf
, width
, col
);
21455 return decode_mode_spec_buf
;
21459 #ifndef SYSTEM_MALLOC
21461 if (NILP (Vmemory_full
))
21464 return "!MEM FULL! ";
21471 /* %F displays the frame name. */
21472 if (!NILP (f
->title
))
21473 return SSDATA (f
->title
);
21474 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21475 return SSDATA (f
->name
);
21479 obj
= BVAR (b
, filename
);
21484 ptrdiff_t size
= ZV
- BEGV
;
21485 pint2str (decode_mode_spec_buf
, width
, size
);
21486 return decode_mode_spec_buf
;
21491 ptrdiff_t size
= ZV
- BEGV
;
21492 pint2hrstr (decode_mode_spec_buf
, width
, size
);
21493 return decode_mode_spec_buf
;
21498 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21499 ptrdiff_t topline
, nlines
, height
;
21502 /* %c and %l are ignored in `frame-title-format'. */
21503 if (mode_line_target
== MODE_LINE_TITLE
)
21506 startpos
= marker_position (w
->start
);
21507 startpos_byte
= marker_byte_position (w
->start
);
21508 height
= WINDOW_TOTAL_LINES (w
);
21510 /* If we decided that this buffer isn't suitable for line numbers,
21511 don't forget that too fast. */
21512 if (EQ (w
->base_line_pos
, w
->buffer
))
21514 /* But do forget it, if the window shows a different buffer now. */
21515 else if (BUFFERP (w
->base_line_pos
))
21516 wset_base_line_pos (w
, Qnil
);
21518 /* If the buffer is very big, don't waste time. */
21519 if (INTEGERP (Vline_number_display_limit
)
21520 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21522 wset_base_line_pos (w
, Qnil
);
21523 wset_base_line_number (w
, Qnil
);
21527 if (INTEGERP (w
->base_line_number
)
21528 && INTEGERP (w
->base_line_pos
)
21529 && XFASTINT (w
->base_line_pos
) <= startpos
)
21531 line
= XFASTINT (w
->base_line_number
);
21532 linepos
= XFASTINT (w
->base_line_pos
);
21533 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21538 linepos
= BUF_BEGV (b
);
21539 linepos_byte
= BUF_BEGV_BYTE (b
);
21542 /* Count lines from base line to window start position. */
21543 nlines
= display_count_lines (linepos_byte
,
21547 topline
= nlines
+ line
;
21549 /* Determine a new base line, if the old one is too close
21550 or too far away, or if we did not have one.
21551 "Too close" means it's plausible a scroll-down would
21552 go back past it. */
21553 if (startpos
== BUF_BEGV (b
))
21555 wset_base_line_number (w
, make_number (topline
));
21556 wset_base_line_pos (w
, make_number (BUF_BEGV (b
)));
21558 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21559 || linepos
== BUF_BEGV (b
))
21561 ptrdiff_t limit
= BUF_BEGV (b
);
21562 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21563 ptrdiff_t position
;
21564 ptrdiff_t distance
=
21565 (height
* 2 + 30) * line_number_display_limit_width
;
21567 if (startpos
- distance
> limit
)
21569 limit
= startpos
- distance
;
21570 limit_byte
= CHAR_TO_BYTE (limit
);
21573 nlines
= display_count_lines (startpos_byte
,
21575 - (height
* 2 + 30),
21577 /* If we couldn't find the lines we wanted within
21578 line_number_display_limit_width chars per line,
21579 give up on line numbers for this window. */
21580 if (position
== limit_byte
&& limit
== startpos
- distance
)
21582 wset_base_line_pos (w
, w
->buffer
);
21583 wset_base_line_number (w
, Qnil
);
21587 wset_base_line_number (w
, make_number (topline
- nlines
));
21588 wset_base_line_pos (w
, make_number (BYTE_TO_CHAR (position
)));
21591 /* Now count lines from the start pos to point. */
21592 nlines
= display_count_lines (startpos_byte
,
21593 PT_BYTE
, PT
, &junk
);
21595 /* Record that we did display the line number. */
21596 line_number_displayed
= 1;
21598 /* Make the string to show. */
21599 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
21600 return decode_mode_spec_buf
;
21603 char* p
= decode_mode_spec_buf
;
21604 int pad
= width
- 2;
21610 return decode_mode_spec_buf
;
21616 obj
= BVAR (b
, mode_name
);
21620 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21626 ptrdiff_t pos
= marker_position (w
->start
);
21627 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21629 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21631 if (pos
<= BUF_BEGV (b
))
21636 else if (pos
<= BUF_BEGV (b
))
21640 if (total
> 1000000)
21641 /* Do it differently for a large value, to avoid overflow. */
21642 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21644 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21645 /* We can't normally display a 3-digit number,
21646 so get us a 2-digit number that is close. */
21649 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21650 return decode_mode_spec_buf
;
21654 /* Display percentage of size above the bottom of the screen. */
21657 ptrdiff_t toppos
= marker_position (w
->start
);
21658 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21659 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21661 if (botpos
>= BUF_ZV (b
))
21663 if (toppos
<= BUF_BEGV (b
))
21670 if (total
> 1000000)
21671 /* Do it differently for a large value, to avoid overflow. */
21672 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21674 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21675 /* We can't normally display a 3-digit number,
21676 so get us a 2-digit number that is close. */
21679 if (toppos
<= BUF_BEGV (b
))
21680 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21682 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21683 return decode_mode_spec_buf
;
21688 /* status of process */
21689 obj
= Fget_buffer_process (Fcurrent_buffer ());
21691 return "no process";
21693 obj
= Fsymbol_name (Fprocess_status (obj
));
21699 ptrdiff_t count
= inhibit_garbage_collection ();
21700 Lisp_Object val
= call1 (intern ("file-remote-p"),
21701 BVAR (current_buffer
, directory
));
21702 unbind_to (count
, Qnil
);
21710 case 't': /* indicate TEXT or BINARY */
21714 /* coding-system (not including end-of-line format) */
21716 /* coding-system (including end-of-line type) */
21718 int eol_flag
= (c
== 'Z');
21719 char *p
= decode_mode_spec_buf
;
21721 if (! FRAME_WINDOW_P (f
))
21723 /* No need to mention EOL here--the terminal never needs
21724 to do EOL conversion. */
21725 p
= decode_mode_spec_coding (CODING_ID_NAME
21726 (FRAME_KEYBOARD_CODING (f
)->id
),
21728 p
= decode_mode_spec_coding (CODING_ID_NAME
21729 (FRAME_TERMINAL_CODING (f
)->id
),
21732 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21735 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21736 #ifdef subprocesses
21737 obj
= Fget_buffer_process (Fcurrent_buffer ());
21738 if (PROCESSP (obj
))
21740 p
= decode_mode_spec_coding
21741 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
21742 p
= decode_mode_spec_coding
21743 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
21745 #endif /* subprocesses */
21748 return decode_mode_spec_buf
;
21755 return SSDATA (obj
);
21762 /* Count up to COUNT lines starting from START_BYTE.
21763 But don't go beyond LIMIT_BYTE.
21764 Return the number of lines thus found (always nonnegative).
21766 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21769 display_count_lines (ptrdiff_t start_byte
,
21770 ptrdiff_t limit_byte
, ptrdiff_t count
,
21771 ptrdiff_t *byte_pos_ptr
)
21773 register unsigned char *cursor
;
21774 unsigned char *base
;
21776 register ptrdiff_t ceiling
;
21777 register unsigned char *ceiling_addr
;
21778 ptrdiff_t orig_count
= count
;
21780 /* If we are not in selective display mode,
21781 check only for newlines. */
21782 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21783 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21787 while (start_byte
< limit_byte
)
21789 ceiling
= BUFFER_CEILING_OF (start_byte
);
21790 ceiling
= min (limit_byte
- 1, ceiling
);
21791 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21792 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21795 if (selective_display
)
21796 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21799 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21802 if (cursor
!= ceiling_addr
)
21806 start_byte
+= cursor
- base
+ 1;
21807 *byte_pos_ptr
= start_byte
;
21811 if (++cursor
== ceiling_addr
)
21817 start_byte
+= cursor
- base
;
21822 while (start_byte
> limit_byte
)
21824 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21825 ceiling
= max (limit_byte
, ceiling
);
21826 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21827 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21830 if (selective_display
)
21831 while (--cursor
!= ceiling_addr
21832 && *cursor
!= '\n' && *cursor
!= 015)
21835 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21838 if (cursor
!= ceiling_addr
)
21842 start_byte
+= cursor
- base
+ 1;
21843 *byte_pos_ptr
= start_byte
;
21844 /* When scanning backwards, we should
21845 not count the newline posterior to which we stop. */
21846 return - orig_count
- 1;
21852 /* Here we add 1 to compensate for the last decrement
21853 of CURSOR, which took it past the valid range. */
21854 start_byte
+= cursor
- base
+ 1;
21858 *byte_pos_ptr
= limit_byte
;
21861 return - orig_count
+ count
;
21862 return orig_count
- count
;
21868 /***********************************************************************
21870 ***********************************************************************/
21872 /* Display a NUL-terminated string, starting with index START.
21874 If STRING is non-null, display that C string. Otherwise, the Lisp
21875 string LISP_STRING is displayed. There's a case that STRING is
21876 non-null and LISP_STRING is not nil. It means STRING is a string
21877 data of LISP_STRING. In that case, we display LISP_STRING while
21878 ignoring its text properties.
21880 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21881 FACE_STRING. Display STRING or LISP_STRING with the face at
21882 FACE_STRING_POS in FACE_STRING:
21884 Display the string in the environment given by IT, but use the
21885 standard display table, temporarily.
21887 FIELD_WIDTH is the minimum number of output glyphs to produce.
21888 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21889 with spaces. If STRING has more characters, more than FIELD_WIDTH
21890 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21892 PRECISION is the maximum number of characters to output from
21893 STRING. PRECISION < 0 means don't truncate the string.
21895 This is roughly equivalent to printf format specifiers:
21897 FIELD_WIDTH PRECISION PRINTF
21898 ----------------------------------------
21904 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21905 display them, and < 0 means obey the current buffer's value of
21906 enable_multibyte_characters.
21908 Value is the number of columns displayed. */
21911 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21912 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
21913 int field_width
, int precision
, int max_x
, int multibyte
)
21915 int hpos_at_start
= it
->hpos
;
21916 int saved_face_id
= it
->face_id
;
21917 struct glyph_row
*row
= it
->glyph_row
;
21918 ptrdiff_t it_charpos
;
21920 /* Initialize the iterator IT for iteration over STRING beginning
21921 with index START. */
21922 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21923 precision
, field_width
, multibyte
);
21924 if (string
&& STRINGP (lisp_string
))
21925 /* LISP_STRING is the one returned by decode_mode_spec. We should
21926 ignore its text properties. */
21927 it
->stop_charpos
= it
->end_charpos
;
21929 /* If displaying STRING, set up the face of the iterator from
21930 FACE_STRING, if that's given. */
21931 if (STRINGP (face_string
))
21937 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21938 0, it
->region_beg_charpos
,
21939 it
->region_end_charpos
,
21940 &endptr
, it
->base_face_id
, 0);
21941 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21942 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21945 /* Set max_x to the maximum allowed X position. Don't let it go
21946 beyond the right edge of the window. */
21948 max_x
= it
->last_visible_x
;
21950 max_x
= min (max_x
, it
->last_visible_x
);
21952 /* Skip over display elements that are not visible. because IT->w is
21954 if (it
->current_x
< it
->first_visible_x
)
21955 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21956 MOVE_TO_POS
| MOVE_TO_X
);
21958 row
->ascent
= it
->max_ascent
;
21959 row
->height
= it
->max_ascent
+ it
->max_descent
;
21960 row
->phys_ascent
= it
->max_phys_ascent
;
21961 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21962 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21964 if (STRINGP (it
->string
))
21965 it_charpos
= IT_STRING_CHARPOS (*it
);
21967 it_charpos
= IT_CHARPOS (*it
);
21969 /* This condition is for the case that we are called with current_x
21970 past last_visible_x. */
21971 while (it
->current_x
< max_x
)
21973 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21975 /* Get the next display element. */
21976 if (!get_next_display_element (it
))
21979 /* Produce glyphs. */
21980 x_before
= it
->current_x
;
21981 n_glyphs_before
= row
->used
[TEXT_AREA
];
21982 PRODUCE_GLYPHS (it
);
21984 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21987 while (i
< nglyphs
)
21989 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21991 if (it
->line_wrap
!= TRUNCATE
21992 && x
+ glyph
->pixel_width
> max_x
)
21994 /* End of continued line or max_x reached. */
21995 if (CHAR_GLYPH_PADDING_P (*glyph
))
21997 /* A wide character is unbreakable. */
21998 if (row
->reversed_p
)
21999 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
22000 - n_glyphs_before
);
22001 row
->used
[TEXT_AREA
] = n_glyphs_before
;
22002 it
->current_x
= x_before
;
22006 if (row
->reversed_p
)
22007 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
22008 - (n_glyphs_before
+ i
));
22009 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
22014 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
22016 /* Glyph is at least partially visible. */
22018 if (x
< it
->first_visible_x
)
22019 row
->x
= x
- it
->first_visible_x
;
22023 /* Glyph is off the left margin of the display area.
22024 Should not happen. */
22028 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
22029 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
22030 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
22031 row
->phys_height
= max (row
->phys_height
,
22032 it
->max_phys_ascent
+ it
->max_phys_descent
);
22033 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
22034 it
->max_extra_line_spacing
);
22035 x
+= glyph
->pixel_width
;
22039 /* Stop if max_x reached. */
22043 /* Stop at line ends. */
22044 if (ITERATOR_AT_END_OF_LINE_P (it
))
22046 it
->continuation_lines_width
= 0;
22050 set_iterator_to_next (it
, 1);
22051 if (STRINGP (it
->string
))
22052 it_charpos
= IT_STRING_CHARPOS (*it
);
22054 it_charpos
= IT_CHARPOS (*it
);
22056 /* Stop if truncating at the right edge. */
22057 if (it
->line_wrap
== TRUNCATE
22058 && it
->current_x
>= it
->last_visible_x
)
22060 /* Add truncation mark, but don't do it if the line is
22061 truncated at a padding space. */
22062 if (it_charpos
< it
->string_nchars
)
22064 if (!FRAME_WINDOW_P (it
->f
))
22068 if (it
->current_x
> it
->last_visible_x
)
22070 if (!row
->reversed_p
)
22072 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
22073 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22078 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
22079 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22081 unproduce_glyphs (it
, ii
+ 1);
22082 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
22084 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
22086 row
->used
[TEXT_AREA
] = ii
;
22087 produce_special_glyphs (it
, IT_TRUNCATION
);
22090 produce_special_glyphs (it
, IT_TRUNCATION
);
22092 row
->truncated_on_right_p
= 1;
22098 /* Maybe insert a truncation at the left. */
22099 if (it
->first_visible_x
22102 if (!FRAME_WINDOW_P (it
->f
)
22103 || (row
->reversed_p
22104 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22105 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
22106 insert_left_trunc_glyphs (it
);
22107 row
->truncated_on_left_p
= 1;
22110 it
->face_id
= saved_face_id
;
22112 /* Value is number of columns displayed. */
22113 return it
->hpos
- hpos_at_start
;
22118 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
22119 appears as an element of LIST or as the car of an element of LIST.
22120 If PROPVAL is a list, compare each element against LIST in that
22121 way, and return 1/2 if any element of PROPVAL is found in LIST.
22122 Otherwise return 0. This function cannot quit.
22123 The return value is 2 if the text is invisible but with an ellipsis
22124 and 1 if it's invisible and without an ellipsis. */
22127 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
22129 register Lisp_Object tail
, proptail
;
22131 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22133 register Lisp_Object tem
;
22135 if (EQ (propval
, tem
))
22137 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
22138 return NILP (XCDR (tem
)) ? 1 : 2;
22141 if (CONSP (propval
))
22143 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
22145 Lisp_Object propelt
;
22146 propelt
= XCAR (proptail
);
22147 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22149 register Lisp_Object tem
;
22151 if (EQ (propelt
, tem
))
22153 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
22154 return NILP (XCDR (tem
)) ? 1 : 2;
22162 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
22163 doc
: /* Non-nil if the property makes the text invisible.
22164 POS-OR-PROP can be a marker or number, in which case it is taken to be
22165 a position in the current buffer and the value of the `invisible' property
22166 is checked; or it can be some other value, which is then presumed to be the
22167 value of the `invisible' property of the text of interest.
22168 The non-nil value returned can be t for truly invisible text or something
22169 else if the text is replaced by an ellipsis. */)
22170 (Lisp_Object pos_or_prop
)
22173 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
22174 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
22176 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
22177 return (invis
== 0 ? Qnil
22179 : make_number (invis
));
22182 /* Calculate a width or height in pixels from a specification using
22183 the following elements:
22186 NUM - a (fractional) multiple of the default font width/height
22187 (NUM) - specifies exactly NUM pixels
22188 UNIT - a fixed number of pixels, see below.
22189 ELEMENT - size of a display element in pixels, see below.
22190 (NUM . SPEC) - equals NUM * SPEC
22191 (+ SPEC SPEC ...) - add pixel values
22192 (- SPEC SPEC ...) - subtract pixel values
22193 (- SPEC) - negate pixel value
22196 INT or FLOAT - a number constant
22197 SYMBOL - use symbol's (buffer local) variable binding.
22200 in - pixels per inch *)
22201 mm - pixels per 1/1000 meter *)
22202 cm - pixels per 1/100 meter *)
22203 width - width of current font in pixels.
22204 height - height of current font in pixels.
22206 *) using the ratio(s) defined in display-pixels-per-inch.
22210 left-fringe - left fringe width in pixels
22211 right-fringe - right fringe width in pixels
22213 left-margin - left margin width in pixels
22214 right-margin - right margin width in pixels
22216 scroll-bar - scroll-bar area width in pixels
22220 Pixels corresponding to 5 inches:
22223 Total width of non-text areas on left side of window (if scroll-bar is on left):
22224 '(space :width (+ left-fringe left-margin scroll-bar))
22226 Align to first text column (in header line):
22227 '(space :align-to 0)
22229 Align to middle of text area minus half the width of variable `my-image'
22230 containing a loaded image:
22231 '(space :align-to (0.5 . (- text my-image)))
22233 Width of left margin minus width of 1 character in the default font:
22234 '(space :width (- left-margin 1))
22236 Width of left margin minus width of 2 characters in the current font:
22237 '(space :width (- left-margin (2 . width)))
22239 Center 1 character over left-margin (in header line):
22240 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22242 Different ways to express width of left fringe plus left margin minus one pixel:
22243 '(space :width (- (+ left-fringe left-margin) (1)))
22244 '(space :width (+ left-fringe left-margin (- (1))))
22245 '(space :width (+ left-fringe left-margin (-1)))
22249 #define NUMVAL(X) \
22250 ((INTEGERP (X) || FLOATP (X)) \
22255 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22256 struct font
*font
, int width_p
, int *align_to
)
22260 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22261 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22264 return OK_PIXELS (0);
22266 eassert (FRAME_LIVE_P (it
->f
));
22268 if (SYMBOLP (prop
))
22270 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22272 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22274 if (unit
[0] == 'i' && unit
[1] == 'n')
22276 else if (unit
[0] == 'm' && unit
[1] == 'm')
22278 else if (unit
[0] == 'c' && unit
[1] == 'm')
22285 #ifdef HAVE_WINDOW_SYSTEM
22286 if (FRAME_WINDOW_P (it
->f
)
22288 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
22289 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
22291 return OK_PIXELS (ppi
/ pixels
);
22294 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
22295 || (CONSP (Vdisplay_pixels_per_inch
)
22297 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
22298 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
22300 return OK_PIXELS (ppi
/ pixels
);
22306 #ifdef HAVE_WINDOW_SYSTEM
22307 if (EQ (prop
, Qheight
))
22308 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22309 if (EQ (prop
, Qwidth
))
22310 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22312 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22313 return OK_PIXELS (1);
22316 if (EQ (prop
, Qtext
))
22317 return OK_PIXELS (width_p
22318 ? window_box_width (it
->w
, TEXT_AREA
)
22319 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22321 if (align_to
&& *align_to
< 0)
22324 if (EQ (prop
, Qleft
))
22325 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22326 if (EQ (prop
, Qright
))
22327 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22328 if (EQ (prop
, Qcenter
))
22329 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22330 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22331 if (EQ (prop
, Qleft_fringe
))
22332 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22333 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22334 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22335 if (EQ (prop
, Qright_fringe
))
22336 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22337 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22338 : window_box_right_offset (it
->w
, TEXT_AREA
));
22339 if (EQ (prop
, Qleft_margin
))
22340 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22341 if (EQ (prop
, Qright_margin
))
22342 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22343 if (EQ (prop
, Qscroll_bar
))
22344 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22346 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22347 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22348 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22353 if (EQ (prop
, Qleft_fringe
))
22354 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22355 if (EQ (prop
, Qright_fringe
))
22356 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22357 if (EQ (prop
, Qleft_margin
))
22358 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22359 if (EQ (prop
, Qright_margin
))
22360 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22361 if (EQ (prop
, Qscroll_bar
))
22362 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22365 prop
= buffer_local_value_1 (prop
, it
->w
->buffer
);
22366 if (EQ (prop
, Qunbound
))
22370 if (INTEGERP (prop
) || FLOATP (prop
))
22372 int base_unit
= (width_p
22373 ? FRAME_COLUMN_WIDTH (it
->f
)
22374 : FRAME_LINE_HEIGHT (it
->f
));
22375 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22380 Lisp_Object car
= XCAR (prop
);
22381 Lisp_Object cdr
= XCDR (prop
);
22385 #ifdef HAVE_WINDOW_SYSTEM
22386 if (FRAME_WINDOW_P (it
->f
)
22387 && valid_image_p (prop
))
22389 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22390 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22392 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22395 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22401 while (CONSP (cdr
))
22403 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22404 font
, width_p
, align_to
))
22407 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22412 if (EQ (car
, Qminus
))
22414 return OK_PIXELS (pixels
);
22417 car
= buffer_local_value_1 (car
, it
->w
->buffer
);
22418 if (EQ (car
, Qunbound
))
22422 if (INTEGERP (car
) || FLOATP (car
))
22425 pixels
= XFLOATINT (car
);
22427 return OK_PIXELS (pixels
);
22428 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22429 font
, width_p
, align_to
))
22430 return OK_PIXELS (pixels
* fact
);
22441 /***********************************************************************
22443 ***********************************************************************/
22445 #ifdef HAVE_WINDOW_SYSTEM
22450 dump_glyph_string (struct glyph_string
*s
)
22452 fprintf (stderr
, "glyph string\n");
22453 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22454 s
->x
, s
->y
, s
->width
, s
->height
);
22455 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22456 fprintf (stderr
, " hl = %d\n", s
->hl
);
22457 fprintf (stderr
, " left overhang = %d, right = %d\n",
22458 s
->left_overhang
, s
->right_overhang
);
22459 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22460 fprintf (stderr
, " extends to end of line = %d\n",
22461 s
->extends_to_end_of_line_p
);
22462 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22463 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22466 #endif /* GLYPH_DEBUG */
22468 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22469 of XChar2b structures for S; it can't be allocated in
22470 init_glyph_string because it must be allocated via `alloca'. W
22471 is the window on which S is drawn. ROW and AREA are the glyph row
22472 and area within the row from which S is constructed. START is the
22473 index of the first glyph structure covered by S. HL is a
22474 face-override for drawing S. */
22477 #define OPTIONAL_HDC(hdc) HDC hdc,
22478 #define DECLARE_HDC(hdc) HDC hdc;
22479 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22480 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22483 #ifndef OPTIONAL_HDC
22484 #define OPTIONAL_HDC(hdc)
22485 #define DECLARE_HDC(hdc)
22486 #define ALLOCATE_HDC(hdc, f)
22487 #define RELEASE_HDC(hdc, f)
22491 init_glyph_string (struct glyph_string
*s
,
22493 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22494 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22496 memset (s
, 0, sizeof *s
);
22498 s
->f
= XFRAME (w
->frame
);
22502 s
->display
= FRAME_X_DISPLAY (s
->f
);
22503 s
->window
= FRAME_X_WINDOW (s
->f
);
22504 s
->char2b
= char2b
;
22508 s
->first_glyph
= row
->glyphs
[area
] + start
;
22509 s
->height
= row
->height
;
22510 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22511 s
->ybase
= s
->y
+ row
->ascent
;
22515 /* Append the list of glyph strings with head H and tail T to the list
22516 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22519 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22520 struct glyph_string
*h
, struct glyph_string
*t
)
22534 /* Prepend the list of glyph strings with head H and tail T to the
22535 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22539 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22540 struct glyph_string
*h
, struct glyph_string
*t
)
22554 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22555 Set *HEAD and *TAIL to the resulting list. */
22558 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22559 struct glyph_string
*s
)
22561 s
->next
= s
->prev
= NULL
;
22562 append_glyph_string_lists (head
, tail
, s
, s
);
22566 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22567 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22568 make sure that X resources for the face returned are allocated.
22569 Value is a pointer to a realized face that is ready for display if
22570 DISPLAY_P is non-zero. */
22572 static struct face
*
22573 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22574 XChar2b
*char2b
, int display_p
)
22576 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22580 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22582 if (code
!= FONT_INVALID_CODE
)
22583 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22585 STORE_XCHAR2B (char2b
, 0, 0);
22588 /* Make sure X resources of the face are allocated. */
22589 #ifdef HAVE_X_WINDOWS
22593 eassert (face
!= NULL
);
22594 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22601 /* Get face and two-byte form of character glyph GLYPH on frame F.
22602 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22603 a pointer to a realized face that is ready for display. */
22605 static struct face
*
22606 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22607 XChar2b
*char2b
, int *two_byte_p
)
22611 eassert (glyph
->type
== CHAR_GLYPH
);
22612 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22621 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22622 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22624 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22626 if (code
!= FONT_INVALID_CODE
)
22627 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22629 STORE_XCHAR2B (char2b
, 0, 0);
22632 /* Make sure X resources of the face are allocated. */
22633 eassert (face
!= NULL
);
22634 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22639 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22640 Return 1 if FONT has a glyph for C, otherwise return 0. */
22643 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22647 if (CHAR_BYTE8_P (c
))
22648 code
= CHAR_TO_BYTE8 (c
);
22650 code
= font
->driver
->encode_char (font
, c
);
22652 if (code
== FONT_INVALID_CODE
)
22654 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22659 /* Fill glyph string S with composition components specified by S->cmp.
22661 BASE_FACE is the base face of the composition.
22662 S->cmp_from is the index of the first component for S.
22664 OVERLAPS non-zero means S should draw the foreground only, and use
22665 its physical height for clipping. See also draw_glyphs.
22667 Value is the index of a component not in S. */
22670 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22674 /* For all glyphs of this composition, starting at the offset
22675 S->cmp_from, until we reach the end of the definition or encounter a
22676 glyph that requires the different face, add it to S. */
22681 s
->for_overlaps
= overlaps
;
22684 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22686 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22688 /* TAB in a composition means display glyphs with padding space
22689 on the left or right. */
22692 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22695 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22702 s
->font
= s
->face
->font
;
22704 else if (s
->face
!= face
)
22712 if (s
->face
== NULL
)
22714 s
->face
= base_face
->ascii_face
;
22715 s
->font
= s
->face
->font
;
22718 /* All glyph strings for the same composition has the same width,
22719 i.e. the width set for the first component of the composition. */
22720 s
->width
= s
->first_glyph
->pixel_width
;
22722 /* If the specified font could not be loaded, use the frame's
22723 default font, but record the fact that we couldn't load it in
22724 the glyph string so that we can draw rectangles for the
22725 characters of the glyph string. */
22726 if (s
->font
== NULL
)
22728 s
->font_not_found_p
= 1;
22729 s
->font
= FRAME_FONT (s
->f
);
22732 /* Adjust base line for subscript/superscript text. */
22733 s
->ybase
+= s
->first_glyph
->voffset
;
22735 /* This glyph string must always be drawn with 16-bit functions. */
22742 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22743 int start
, int end
, int overlaps
)
22745 struct glyph
*glyph
, *last
;
22746 Lisp_Object lgstring
;
22749 s
->for_overlaps
= overlaps
;
22750 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22751 last
= s
->row
->glyphs
[s
->area
] + end
;
22752 s
->cmp_id
= glyph
->u
.cmp
.id
;
22753 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22754 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22755 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22756 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22757 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22759 while (glyph
< last
22760 && glyph
->u
.cmp
.automatic
22761 && glyph
->u
.cmp
.id
== s
->cmp_id
22762 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22763 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22765 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22767 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22768 unsigned code
= LGLYPH_CODE (lglyph
);
22770 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22772 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22773 return glyph
- s
->row
->glyphs
[s
->area
];
22777 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22778 See the comment of fill_glyph_string for arguments.
22779 Value is the index of the first glyph not in S. */
22783 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22784 int start
, int end
, int overlaps
)
22786 struct glyph
*glyph
, *last
;
22789 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22790 s
->for_overlaps
= overlaps
;
22791 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22792 last
= s
->row
->glyphs
[s
->area
] + end
;
22793 voffset
= glyph
->voffset
;
22794 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22795 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
22797 s
->width
= glyph
->pixel_width
;
22799 while (glyph
< last
22800 && glyph
->type
== GLYPHLESS_GLYPH
22801 && glyph
->voffset
== voffset
22802 && glyph
->face_id
== face_id
)
22805 s
->width
+= glyph
->pixel_width
;
22808 s
->ybase
+= voffset
;
22809 return glyph
- s
->row
->glyphs
[s
->area
];
22813 /* Fill glyph string S from a sequence of character glyphs.
22815 FACE_ID is the face id of the string. START is the index of the
22816 first glyph to consider, END is the index of the last + 1.
22817 OVERLAPS non-zero means S should draw the foreground only, and use
22818 its physical height for clipping. See also draw_glyphs.
22820 Value is the index of the first glyph not in S. */
22823 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22824 int start
, int end
, int overlaps
)
22826 struct glyph
*glyph
, *last
;
22828 int glyph_not_available_p
;
22830 eassert (s
->f
== XFRAME (s
->w
->frame
));
22831 eassert (s
->nchars
== 0);
22832 eassert (start
>= 0 && end
> start
);
22834 s
->for_overlaps
= overlaps
;
22835 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22836 last
= s
->row
->glyphs
[s
->area
] + end
;
22837 voffset
= glyph
->voffset
;
22838 s
->padding_p
= glyph
->padding_p
;
22839 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22841 while (glyph
< last
22842 && glyph
->type
== CHAR_GLYPH
22843 && glyph
->voffset
== voffset
22844 /* Same face id implies same font, nowadays. */
22845 && glyph
->face_id
== face_id
22846 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22850 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22851 s
->char2b
+ s
->nchars
,
22853 s
->two_byte_p
= two_byte_p
;
22855 eassert (s
->nchars
<= end
- start
);
22856 s
->width
+= glyph
->pixel_width
;
22857 if (glyph
++->padding_p
!= s
->padding_p
)
22861 s
->font
= s
->face
->font
;
22863 /* If the specified font could not be loaded, use the frame's font,
22864 but record the fact that we couldn't load it in
22865 S->font_not_found_p so that we can draw rectangles for the
22866 characters of the glyph string. */
22867 if (s
->font
== NULL
|| glyph_not_available_p
)
22869 s
->font_not_found_p
= 1;
22870 s
->font
= FRAME_FONT (s
->f
);
22873 /* Adjust base line for subscript/superscript text. */
22874 s
->ybase
+= voffset
;
22876 eassert (s
->face
&& s
->face
->gc
);
22877 return glyph
- s
->row
->glyphs
[s
->area
];
22881 /* Fill glyph string S from image glyph S->first_glyph. */
22884 fill_image_glyph_string (struct glyph_string
*s
)
22886 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22887 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22889 s
->slice
= s
->first_glyph
->slice
.img
;
22890 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22891 s
->font
= s
->face
->font
;
22892 s
->width
= s
->first_glyph
->pixel_width
;
22894 /* Adjust base line for subscript/superscript text. */
22895 s
->ybase
+= s
->first_glyph
->voffset
;
22899 /* Fill glyph string S from a sequence of stretch glyphs.
22901 START is the index of the first glyph to consider,
22902 END is the index of the last + 1.
22904 Value is the index of the first glyph not in S. */
22907 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22909 struct glyph
*glyph
, *last
;
22910 int voffset
, face_id
;
22912 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22914 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22915 last
= s
->row
->glyphs
[s
->area
] + end
;
22916 face_id
= glyph
->face_id
;
22917 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22918 s
->font
= s
->face
->font
;
22919 s
->width
= glyph
->pixel_width
;
22921 voffset
= glyph
->voffset
;
22925 && glyph
->type
== STRETCH_GLYPH
22926 && glyph
->voffset
== voffset
22927 && glyph
->face_id
== face_id
);
22929 s
->width
+= glyph
->pixel_width
;
22931 /* Adjust base line for subscript/superscript text. */
22932 s
->ybase
+= voffset
;
22934 /* The case that face->gc == 0 is handled when drawing the glyph
22935 string by calling PREPARE_FACE_FOR_DISPLAY. */
22937 return glyph
- s
->row
->glyphs
[s
->area
];
22940 static struct font_metrics
*
22941 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22943 static struct font_metrics metrics
;
22944 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22946 if (! font
|| code
== FONT_INVALID_CODE
)
22948 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22953 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22954 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22955 assumed to be zero. */
22958 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22960 *left
= *right
= 0;
22962 if (glyph
->type
== CHAR_GLYPH
)
22966 struct font_metrics
*pcm
;
22968 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22969 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22971 if (pcm
->rbearing
> pcm
->width
)
22972 *right
= pcm
->rbearing
- pcm
->width
;
22973 if (pcm
->lbearing
< 0)
22974 *left
= -pcm
->lbearing
;
22977 else if (glyph
->type
== COMPOSITE_GLYPH
)
22979 if (! glyph
->u
.cmp
.automatic
)
22981 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22983 if (cmp
->rbearing
> cmp
->pixel_width
)
22984 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22985 if (cmp
->lbearing
< 0)
22986 *left
= - cmp
->lbearing
;
22990 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22991 struct font_metrics metrics
;
22993 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22994 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22995 if (metrics
.rbearing
> metrics
.width
)
22996 *right
= metrics
.rbearing
- metrics
.width
;
22997 if (metrics
.lbearing
< 0)
22998 *left
= - metrics
.lbearing
;
23004 /* Return the index of the first glyph preceding glyph string S that
23005 is overwritten by S because of S's left overhang. Value is -1
23006 if no glyphs are overwritten. */
23009 left_overwritten (struct glyph_string
*s
)
23013 if (s
->left_overhang
)
23016 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23017 int first
= s
->first_glyph
- glyphs
;
23019 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
23020 x
-= glyphs
[i
].pixel_width
;
23031 /* Return the index of the first glyph preceding glyph string S that
23032 is overwriting S because of its right overhang. Value is -1 if no
23033 glyph in front of S overwrites S. */
23036 left_overwriting (struct glyph_string
*s
)
23039 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23040 int first
= s
->first_glyph
- glyphs
;
23044 for (i
= first
- 1; i
>= 0; --i
)
23047 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23050 x
-= glyphs
[i
].pixel_width
;
23057 /* Return the index of the last glyph following glyph string S that is
23058 overwritten by S because of S's right overhang. Value is -1 if
23059 no such glyph is found. */
23062 right_overwritten (struct glyph_string
*s
)
23066 if (s
->right_overhang
)
23069 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23070 int first
= (s
->first_glyph
- glyphs
23071 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23072 int end
= s
->row
->used
[s
->area
];
23074 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
23075 x
+= glyphs
[i
].pixel_width
;
23084 /* Return the index of the last glyph following glyph string S that
23085 overwrites S because of its left overhang. Value is negative
23086 if no such glyph is found. */
23089 right_overwriting (struct glyph_string
*s
)
23092 int end
= s
->row
->used
[s
->area
];
23093 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23094 int first
= (s
->first_glyph
- glyphs
23095 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23099 for (i
= first
; i
< end
; ++i
)
23102 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23105 x
+= glyphs
[i
].pixel_width
;
23112 /* Set background width of glyph string S. START is the index of the
23113 first glyph following S. LAST_X is the right-most x-position + 1
23114 in the drawing area. */
23117 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
23119 /* If the face of this glyph string has to be drawn to the end of
23120 the drawing area, set S->extends_to_end_of_line_p. */
23122 if (start
== s
->row
->used
[s
->area
]
23123 && s
->area
== TEXT_AREA
23124 && ((s
->row
->fill_line_p
23125 && (s
->hl
== DRAW_NORMAL_TEXT
23126 || s
->hl
== DRAW_IMAGE_RAISED
23127 || s
->hl
== DRAW_IMAGE_SUNKEN
))
23128 || s
->hl
== DRAW_MOUSE_FACE
))
23129 s
->extends_to_end_of_line_p
= 1;
23131 /* If S extends its face to the end of the line, set its
23132 background_width to the distance to the right edge of the drawing
23134 if (s
->extends_to_end_of_line_p
)
23135 s
->background_width
= last_x
- s
->x
+ 1;
23137 s
->background_width
= s
->width
;
23141 /* Compute overhangs and x-positions for glyph string S and its
23142 predecessors, or successors. X is the starting x-position for S.
23143 BACKWARD_P non-zero means process predecessors. */
23146 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
23152 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23153 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23163 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23164 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23174 /* The following macros are only called from draw_glyphs below.
23175 They reference the following parameters of that function directly:
23176 `w', `row', `area', and `overlap_p'
23177 as well as the following local variables:
23178 `s', `f', and `hdc' (in W32) */
23181 /* On W32, silently add local `hdc' variable to argument list of
23182 init_glyph_string. */
23183 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23184 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23186 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23187 init_glyph_string (s, char2b, w, row, area, start, hl)
23190 /* Add a glyph string for a stretch glyph to the list of strings
23191 between HEAD and TAIL. START is the index of the stretch glyph in
23192 row area AREA of glyph row ROW. END is the index of the last glyph
23193 in that glyph row area. X is the current output position assigned
23194 to the new glyph string constructed. HL overrides that face of the
23195 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23196 is the right-most x-position of the drawing area. */
23198 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23199 and below -- keep them on one line. */
23200 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23203 s = alloca (sizeof *s); \
23204 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23205 START = fill_stretch_glyph_string (s, START, END); \
23206 append_glyph_string (&HEAD, &TAIL, s); \
23212 /* Add a glyph string for an image glyph to the list of strings
23213 between HEAD and TAIL. START is the index of the image glyph in
23214 row area AREA of glyph row ROW. END is the index of the last glyph
23215 in that glyph row area. X is the current output position assigned
23216 to the new glyph string constructed. HL overrides that face of the
23217 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23218 is the right-most x-position of the drawing area. */
23220 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23223 s = alloca (sizeof *s); \
23224 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23225 fill_image_glyph_string (s); \
23226 append_glyph_string (&HEAD, &TAIL, s); \
23233 /* Add a glyph string for a sequence of character glyphs to the list
23234 of strings between HEAD and TAIL. START is the index of the first
23235 glyph in row area AREA of glyph row ROW that is part of the new
23236 glyph string. END is the index of the last glyph in that glyph row
23237 area. X is the current output position assigned to the new glyph
23238 string constructed. HL overrides that face of the glyph; e.g. it
23239 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23240 right-most x-position of the drawing area. */
23242 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23248 face_id = (row)->glyphs[area][START].face_id; \
23250 s = alloca (sizeof *s); \
23251 char2b = alloca ((END - START) * sizeof *char2b); \
23252 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23253 append_glyph_string (&HEAD, &TAIL, s); \
23255 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23260 /* Add a glyph string for a composite sequence to the list of strings
23261 between HEAD and TAIL. START is the index of the first glyph in
23262 row area AREA of glyph row ROW that is part of the new glyph
23263 string. END is the index of the last glyph in that glyph row area.
23264 X is the current output position assigned to the new glyph string
23265 constructed. HL overrides that face of the glyph; e.g. it is
23266 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23267 x-position of the drawing area. */
23269 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23271 int face_id = (row)->glyphs[area][START].face_id; \
23272 struct face *base_face = FACE_FROM_ID (f, face_id); \
23273 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23274 struct composition *cmp = composition_table[cmp_id]; \
23276 struct glyph_string *first_s = NULL; \
23279 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23281 /* Make glyph_strings for each glyph sequence that is drawable by \
23282 the same face, and append them to HEAD/TAIL. */ \
23283 for (n = 0; n < cmp->glyph_len;) \
23285 s = alloca (sizeof *s); \
23286 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23287 append_glyph_string (&(HEAD), &(TAIL), s); \
23293 n = fill_composite_glyph_string (s, base_face, overlaps); \
23301 /* Add a glyph string for a glyph-string sequence to the list of strings
23302 between HEAD and TAIL. */
23304 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23308 Lisp_Object gstring; \
23310 face_id = (row)->glyphs[area][START].face_id; \
23311 gstring = (composition_gstring_from_id \
23312 ((row)->glyphs[area][START].u.cmp.id)); \
23313 s = alloca (sizeof *s); \
23314 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23315 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23316 append_glyph_string (&(HEAD), &(TAIL), s); \
23318 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23322 /* Add a glyph string for a sequence of glyphless character's glyphs
23323 to the list of strings between HEAD and TAIL. The meanings of
23324 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23326 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23331 face_id = (row)->glyphs[area][START].face_id; \
23333 s = alloca (sizeof *s); \
23334 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23335 append_glyph_string (&HEAD, &TAIL, s); \
23337 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23343 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23344 of AREA of glyph row ROW on window W between indices START and END.
23345 HL overrides the face for drawing glyph strings, e.g. it is
23346 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23347 x-positions of the drawing area.
23349 This is an ugly monster macro construct because we must use alloca
23350 to allocate glyph strings (because draw_glyphs can be called
23351 asynchronously). */
23353 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23356 HEAD = TAIL = NULL; \
23357 while (START < END) \
23359 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23360 switch (first_glyph->type) \
23363 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23367 case COMPOSITE_GLYPH: \
23368 if (first_glyph->u.cmp.automatic) \
23369 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23372 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23376 case STRETCH_GLYPH: \
23377 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23381 case IMAGE_GLYPH: \
23382 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23386 case GLYPHLESS_GLYPH: \
23387 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23397 set_glyph_string_background_width (s, START, LAST_X); \
23404 /* Draw glyphs between START and END in AREA of ROW on window W,
23405 starting at x-position X. X is relative to AREA in W. HL is a
23406 face-override with the following meaning:
23408 DRAW_NORMAL_TEXT draw normally
23409 DRAW_CURSOR draw in cursor face
23410 DRAW_MOUSE_FACE draw in mouse face.
23411 DRAW_INVERSE_VIDEO draw in mode line face
23412 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23413 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23415 If OVERLAPS is non-zero, draw only the foreground of characters and
23416 clip to the physical height of ROW. Non-zero value also defines
23417 the overlapping part to be drawn:
23419 OVERLAPS_PRED overlap with preceding rows
23420 OVERLAPS_SUCC overlap with succeeding rows
23421 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23422 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23424 Value is the x-position reached, relative to AREA of W. */
23427 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23428 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23429 enum draw_glyphs_face hl
, int overlaps
)
23431 struct glyph_string
*head
, *tail
;
23432 struct glyph_string
*s
;
23433 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23434 int i
, j
, x_reached
, last_x
, area_left
= 0;
23435 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23438 ALLOCATE_HDC (hdc
, f
);
23440 /* Let's rather be paranoid than getting a SEGV. */
23441 end
= min (end
, row
->used
[area
]);
23442 start
= clip_to_bounds (0, start
, end
);
23444 /* Translate X to frame coordinates. Set last_x to the right
23445 end of the drawing area. */
23446 if (row
->full_width_p
)
23448 /* X is relative to the left edge of W, without scroll bars
23450 area_left
= WINDOW_LEFT_EDGE_X (w
);
23451 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23455 area_left
= window_box_left (w
, area
);
23456 last_x
= area_left
+ window_box_width (w
, area
);
23460 /* Build a doubly-linked list of glyph_string structures between
23461 head and tail from what we have to draw. Note that the macro
23462 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23463 the reason we use a separate variable `i'. */
23465 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23467 x_reached
= tail
->x
+ tail
->background_width
;
23471 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23472 the row, redraw some glyphs in front or following the glyph
23473 strings built above. */
23474 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23476 struct glyph_string
*h
, *t
;
23477 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23478 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23479 int check_mouse_face
= 0;
23482 /* If mouse highlighting is on, we may need to draw adjacent
23483 glyphs using mouse-face highlighting. */
23484 if (area
== TEXT_AREA
&& row
->mouse_face_p
23485 && hlinfo
->mouse_face_beg_row
>= 0
23486 && hlinfo
->mouse_face_end_row
>= 0)
23488 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23490 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23491 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23493 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23495 check_mouse_face
= 1;
23496 mouse_beg_col
= (row
== mouse_beg_row
)
23497 ? hlinfo
->mouse_face_beg_col
: 0;
23498 mouse_end_col
= (row
== mouse_end_row
)
23499 ? hlinfo
->mouse_face_end_col
23500 : row
->used
[TEXT_AREA
];
23504 /* Compute overhangs for all glyph strings. */
23505 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23506 for (s
= head
; s
; s
= s
->next
)
23507 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23509 /* Prepend glyph strings for glyphs in front of the first glyph
23510 string that are overwritten because of the first glyph
23511 string's left overhang. The background of all strings
23512 prepended must be drawn because the first glyph string
23514 i
= left_overwritten (head
);
23517 enum draw_glyphs_face overlap_hl
;
23519 /* If this row contains mouse highlighting, attempt to draw
23520 the overlapped glyphs with the correct highlight. This
23521 code fails if the overlap encompasses more than one glyph
23522 and mouse-highlight spans only some of these glyphs.
23523 However, making it work perfectly involves a lot more
23524 code, and I don't know if the pathological case occurs in
23525 practice, so we'll stick to this for now. --- cyd */
23526 if (check_mouse_face
23527 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23528 overlap_hl
= DRAW_MOUSE_FACE
;
23530 overlap_hl
= DRAW_NORMAL_TEXT
;
23533 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23534 overlap_hl
, dummy_x
, last_x
);
23536 compute_overhangs_and_x (t
, head
->x
, 1);
23537 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23541 /* Prepend glyph strings for glyphs in front of the first glyph
23542 string that overwrite that glyph string because of their
23543 right overhang. For these strings, only the foreground must
23544 be drawn, because it draws over the glyph string at `head'.
23545 The background must not be drawn because this would overwrite
23546 right overhangs of preceding glyphs for which no glyph
23548 i
= left_overwriting (head
);
23551 enum draw_glyphs_face overlap_hl
;
23553 if (check_mouse_face
23554 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23555 overlap_hl
= DRAW_MOUSE_FACE
;
23557 overlap_hl
= DRAW_NORMAL_TEXT
;
23560 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23561 overlap_hl
, dummy_x
, last_x
);
23562 for (s
= h
; s
; s
= s
->next
)
23563 s
->background_filled_p
= 1;
23564 compute_overhangs_and_x (t
, head
->x
, 1);
23565 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23568 /* Append glyphs strings for glyphs following the last glyph
23569 string tail that are overwritten by tail. The background of
23570 these strings has to be drawn because tail's foreground draws
23572 i
= right_overwritten (tail
);
23575 enum draw_glyphs_face overlap_hl
;
23577 if (check_mouse_face
23578 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23579 overlap_hl
= DRAW_MOUSE_FACE
;
23581 overlap_hl
= DRAW_NORMAL_TEXT
;
23583 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23584 overlap_hl
, x
, last_x
);
23585 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23586 we don't have `end = i;' here. */
23587 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23588 append_glyph_string_lists (&head
, &tail
, h
, t
);
23592 /* Append glyph strings for glyphs following the last glyph
23593 string tail that overwrite tail. The foreground of such
23594 glyphs has to be drawn because it writes into the background
23595 of tail. The background must not be drawn because it could
23596 paint over the foreground of following glyphs. */
23597 i
= right_overwriting (tail
);
23600 enum draw_glyphs_face overlap_hl
;
23601 if (check_mouse_face
23602 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23603 overlap_hl
= DRAW_MOUSE_FACE
;
23605 overlap_hl
= DRAW_NORMAL_TEXT
;
23608 i
++; /* We must include the Ith glyph. */
23609 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23610 overlap_hl
, x
, last_x
);
23611 for (s
= h
; s
; s
= s
->next
)
23612 s
->background_filled_p
= 1;
23613 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23614 append_glyph_string_lists (&head
, &tail
, h
, t
);
23616 if (clip_head
|| clip_tail
)
23617 for (s
= head
; s
; s
= s
->next
)
23619 s
->clip_head
= clip_head
;
23620 s
->clip_tail
= clip_tail
;
23624 /* Draw all strings. */
23625 for (s
= head
; s
; s
= s
->next
)
23626 FRAME_RIF (f
)->draw_glyph_string (s
);
23629 /* When focus a sole frame and move horizontally, this sets on_p to 0
23630 causing a failure to erase prev cursor position. */
23631 if (area
== TEXT_AREA
23632 && !row
->full_width_p
23633 /* When drawing overlapping rows, only the glyph strings'
23634 foreground is drawn, which doesn't erase a cursor
23638 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23639 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23640 : (tail
? tail
->x
+ tail
->background_width
: x
));
23644 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23645 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23649 /* Value is the x-position up to which drawn, relative to AREA of W.
23650 This doesn't include parts drawn because of overhangs. */
23651 if (row
->full_width_p
)
23652 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23654 x_reached
-= area_left
;
23656 RELEASE_HDC (hdc
, f
);
23661 /* Expand row matrix if too narrow. Don't expand if area
23664 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23666 if (!fonts_changed_p \
23667 && (it->glyph_row->glyphs[area] \
23668 < it->glyph_row->glyphs[area + 1])) \
23670 it->w->ncols_scale_factor++; \
23671 fonts_changed_p = 1; \
23675 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23676 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23679 append_glyph (struct it
*it
)
23681 struct glyph
*glyph
;
23682 enum glyph_row_area area
= it
->area
;
23684 eassert (it
->glyph_row
);
23685 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23687 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23688 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23690 /* If the glyph row is reversed, we need to prepend the glyph
23691 rather than append it. */
23692 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23696 /* Make room for the additional glyph. */
23697 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23699 glyph
= it
->glyph_row
->glyphs
[area
];
23701 glyph
->charpos
= CHARPOS (it
->position
);
23702 glyph
->object
= it
->object
;
23703 if (it
->pixel_width
> 0)
23705 glyph
->pixel_width
= it
->pixel_width
;
23706 glyph
->padding_p
= 0;
23710 /* Assure at least 1-pixel width. Otherwise, cursor can't
23711 be displayed correctly. */
23712 glyph
->pixel_width
= 1;
23713 glyph
->padding_p
= 1;
23715 glyph
->ascent
= it
->ascent
;
23716 glyph
->descent
= it
->descent
;
23717 glyph
->voffset
= it
->voffset
;
23718 glyph
->type
= CHAR_GLYPH
;
23719 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23720 glyph
->multibyte_p
= it
->multibyte_p
;
23721 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23723 /* In R2L rows, the left and the right box edges need to be
23724 drawn in reverse direction. */
23725 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23726 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23730 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23731 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23733 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23734 || it
->phys_descent
> it
->descent
);
23735 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23736 glyph
->face_id
= it
->face_id
;
23737 glyph
->u
.ch
= it
->char_to_display
;
23738 glyph
->slice
.img
= null_glyph_slice
;
23739 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23742 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23743 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23745 glyph
->bidi_type
= it
->bidi_it
.type
;
23749 glyph
->resolved_level
= 0;
23750 glyph
->bidi_type
= UNKNOWN_BT
;
23752 ++it
->glyph_row
->used
[area
];
23755 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23758 /* Store one glyph for the composition IT->cmp_it.id in
23759 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23763 append_composite_glyph (struct it
*it
)
23765 struct glyph
*glyph
;
23766 enum glyph_row_area area
= it
->area
;
23768 eassert (it
->glyph_row
);
23770 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23771 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23773 /* If the glyph row is reversed, we need to prepend the glyph
23774 rather than append it. */
23775 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23779 /* Make room for the new glyph. */
23780 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23782 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23784 glyph
->charpos
= it
->cmp_it
.charpos
;
23785 glyph
->object
= it
->object
;
23786 glyph
->pixel_width
= it
->pixel_width
;
23787 glyph
->ascent
= it
->ascent
;
23788 glyph
->descent
= it
->descent
;
23789 glyph
->voffset
= it
->voffset
;
23790 glyph
->type
= COMPOSITE_GLYPH
;
23791 if (it
->cmp_it
.ch
< 0)
23793 glyph
->u
.cmp
.automatic
= 0;
23794 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23795 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23799 glyph
->u
.cmp
.automatic
= 1;
23800 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23801 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23802 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23804 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23805 glyph
->multibyte_p
= it
->multibyte_p
;
23806 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23808 /* In R2L rows, the left and the right box edges need to be
23809 drawn in reverse direction. */
23810 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23811 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23815 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23816 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23818 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23819 || it
->phys_descent
> it
->descent
);
23820 glyph
->padding_p
= 0;
23821 glyph
->glyph_not_available_p
= 0;
23822 glyph
->face_id
= it
->face_id
;
23823 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23826 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23827 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23829 glyph
->bidi_type
= it
->bidi_it
.type
;
23831 ++it
->glyph_row
->used
[area
];
23834 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23838 /* Change IT->ascent and IT->height according to the setting of
23842 take_vertical_position_into_account (struct it
*it
)
23846 if (it
->voffset
< 0)
23847 /* Increase the ascent so that we can display the text higher
23849 it
->ascent
-= it
->voffset
;
23851 /* Increase the descent so that we can display the text lower
23853 it
->descent
+= it
->voffset
;
23858 /* Produce glyphs/get display metrics for the image IT is loaded with.
23859 See the description of struct display_iterator in dispextern.h for
23860 an overview of struct display_iterator. */
23863 produce_image_glyph (struct it
*it
)
23867 int glyph_ascent
, crop
;
23868 struct glyph_slice slice
;
23870 eassert (it
->what
== IT_IMAGE
);
23872 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23874 /* Make sure X resources of the face is loaded. */
23875 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23877 if (it
->image_id
< 0)
23879 /* Fringe bitmap. */
23880 it
->ascent
= it
->phys_ascent
= 0;
23881 it
->descent
= it
->phys_descent
= 0;
23882 it
->pixel_width
= 0;
23887 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23889 /* Make sure X resources of the image is loaded. */
23890 prepare_image_for_display (it
->f
, img
);
23892 slice
.x
= slice
.y
= 0;
23893 slice
.width
= img
->width
;
23894 slice
.height
= img
->height
;
23896 if (INTEGERP (it
->slice
.x
))
23897 slice
.x
= XINT (it
->slice
.x
);
23898 else if (FLOATP (it
->slice
.x
))
23899 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23901 if (INTEGERP (it
->slice
.y
))
23902 slice
.y
= XINT (it
->slice
.y
);
23903 else if (FLOATP (it
->slice
.y
))
23904 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23906 if (INTEGERP (it
->slice
.width
))
23907 slice
.width
= XINT (it
->slice
.width
);
23908 else if (FLOATP (it
->slice
.width
))
23909 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23911 if (INTEGERP (it
->slice
.height
))
23912 slice
.height
= XINT (it
->slice
.height
);
23913 else if (FLOATP (it
->slice
.height
))
23914 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23916 if (slice
.x
>= img
->width
)
23917 slice
.x
= img
->width
;
23918 if (slice
.y
>= img
->height
)
23919 slice
.y
= img
->height
;
23920 if (slice
.x
+ slice
.width
>= img
->width
)
23921 slice
.width
= img
->width
- slice
.x
;
23922 if (slice
.y
+ slice
.height
> img
->height
)
23923 slice
.height
= img
->height
- slice
.y
;
23925 if (slice
.width
== 0 || slice
.height
== 0)
23928 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23930 it
->descent
= slice
.height
- glyph_ascent
;
23932 it
->descent
+= img
->vmargin
;
23933 if (slice
.y
+ slice
.height
== img
->height
)
23934 it
->descent
+= img
->vmargin
;
23935 it
->phys_descent
= it
->descent
;
23937 it
->pixel_width
= slice
.width
;
23939 it
->pixel_width
+= img
->hmargin
;
23940 if (slice
.x
+ slice
.width
== img
->width
)
23941 it
->pixel_width
+= img
->hmargin
;
23943 /* It's quite possible for images to have an ascent greater than
23944 their height, so don't get confused in that case. */
23945 if (it
->descent
< 0)
23950 if (face
->box
!= FACE_NO_BOX
)
23952 if (face
->box_line_width
> 0)
23955 it
->ascent
+= face
->box_line_width
;
23956 if (slice
.y
+ slice
.height
== img
->height
)
23957 it
->descent
+= face
->box_line_width
;
23960 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23961 it
->pixel_width
+= eabs (face
->box_line_width
);
23962 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23963 it
->pixel_width
+= eabs (face
->box_line_width
);
23966 take_vertical_position_into_account (it
);
23968 /* Automatically crop wide image glyphs at right edge so we can
23969 draw the cursor on same display row. */
23970 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23971 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23973 it
->pixel_width
-= crop
;
23974 slice
.width
-= crop
;
23979 struct glyph
*glyph
;
23980 enum glyph_row_area area
= it
->area
;
23982 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23983 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23985 glyph
->charpos
= CHARPOS (it
->position
);
23986 glyph
->object
= it
->object
;
23987 glyph
->pixel_width
= it
->pixel_width
;
23988 glyph
->ascent
= glyph_ascent
;
23989 glyph
->descent
= it
->descent
;
23990 glyph
->voffset
= it
->voffset
;
23991 glyph
->type
= IMAGE_GLYPH
;
23992 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23993 glyph
->multibyte_p
= it
->multibyte_p
;
23994 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23996 /* In R2L rows, the left and the right box edges need to be
23997 drawn in reverse direction. */
23998 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23999 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24003 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24004 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24006 glyph
->overlaps_vertically_p
= 0;
24007 glyph
->padding_p
= 0;
24008 glyph
->glyph_not_available_p
= 0;
24009 glyph
->face_id
= it
->face_id
;
24010 glyph
->u
.img_id
= img
->id
;
24011 glyph
->slice
.img
= slice
;
24012 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24015 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24016 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24018 glyph
->bidi_type
= it
->bidi_it
.type
;
24020 ++it
->glyph_row
->used
[area
];
24023 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24028 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
24029 of the glyph, WIDTH and HEIGHT are the width and height of the
24030 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
24033 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
24034 int width
, int height
, int ascent
)
24036 struct glyph
*glyph
;
24037 enum glyph_row_area area
= it
->area
;
24039 eassert (ascent
>= 0 && ascent
<= height
);
24041 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24042 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24044 /* If the glyph row is reversed, we need to prepend the glyph
24045 rather than append it. */
24046 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24050 /* Make room for the additional glyph. */
24051 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24053 glyph
= it
->glyph_row
->glyphs
[area
];
24055 glyph
->charpos
= CHARPOS (it
->position
);
24056 glyph
->object
= object
;
24057 glyph
->pixel_width
= width
;
24058 glyph
->ascent
= ascent
;
24059 glyph
->descent
= height
- ascent
;
24060 glyph
->voffset
= it
->voffset
;
24061 glyph
->type
= STRETCH_GLYPH
;
24062 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24063 glyph
->multibyte_p
= it
->multibyte_p
;
24064 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24066 /* In R2L rows, the left and the right box edges need to be
24067 drawn in reverse direction. */
24068 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24069 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24073 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24074 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24076 glyph
->overlaps_vertically_p
= 0;
24077 glyph
->padding_p
= 0;
24078 glyph
->glyph_not_available_p
= 0;
24079 glyph
->face_id
= it
->face_id
;
24080 glyph
->u
.stretch
.ascent
= ascent
;
24081 glyph
->u
.stretch
.height
= height
;
24082 glyph
->slice
.img
= null_glyph_slice
;
24083 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24086 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24087 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24089 glyph
->bidi_type
= it
->bidi_it
.type
;
24093 glyph
->resolved_level
= 0;
24094 glyph
->bidi_type
= UNKNOWN_BT
;
24096 ++it
->glyph_row
->used
[area
];
24099 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24102 #endif /* HAVE_WINDOW_SYSTEM */
24104 /* Produce a stretch glyph for iterator IT. IT->object is the value
24105 of the glyph property displayed. The value must be a list
24106 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
24109 1. `:width WIDTH' specifies that the space should be WIDTH *
24110 canonical char width wide. WIDTH may be an integer or floating
24113 2. `:relative-width FACTOR' specifies that the width of the stretch
24114 should be computed from the width of the first character having the
24115 `glyph' property, and should be FACTOR times that width.
24117 3. `:align-to HPOS' specifies that the space should be wide enough
24118 to reach HPOS, a value in canonical character units.
24120 Exactly one of the above pairs must be present.
24122 4. `:height HEIGHT' specifies that the height of the stretch produced
24123 should be HEIGHT, measured in canonical character units.
24125 5. `:relative-height FACTOR' specifies that the height of the
24126 stretch should be FACTOR times the height of the characters having
24127 the glyph property.
24129 Either none or exactly one of 4 or 5 must be present.
24131 6. `:ascent ASCENT' specifies that ASCENT percent of the height
24132 of the stretch should be used for the ascent of the stretch.
24133 ASCENT must be in the range 0 <= ASCENT <= 100. */
24136 produce_stretch_glyph (struct it
*it
)
24138 /* (space :width WIDTH :height HEIGHT ...) */
24139 Lisp_Object prop
, plist
;
24140 int width
= 0, height
= 0, align_to
= -1;
24141 int zero_width_ok_p
= 0;
24143 struct font
*font
= NULL
;
24145 #ifdef HAVE_WINDOW_SYSTEM
24147 int zero_height_ok_p
= 0;
24149 if (FRAME_WINDOW_P (it
->f
))
24151 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24152 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24153 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24157 /* List should start with `space'. */
24158 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
24159 plist
= XCDR (it
->object
);
24161 /* Compute the width of the stretch. */
24162 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
24163 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
24165 /* Absolute width `:width WIDTH' specified and valid. */
24166 zero_width_ok_p
= 1;
24169 #ifdef HAVE_WINDOW_SYSTEM
24170 else if (FRAME_WINDOW_P (it
->f
)
24171 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
24173 /* Relative width `:relative-width FACTOR' specified and valid.
24174 Compute the width of the characters having the `glyph'
24177 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
24180 if (it
->multibyte_p
)
24181 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
24184 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
24185 if (! ASCII_CHAR_P (it2
.c
))
24186 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
24189 it2
.glyph_row
= NULL
;
24190 it2
.what
= IT_CHARACTER
;
24191 x_produce_glyphs (&it2
);
24192 width
= NUMVAL (prop
) * it2
.pixel_width
;
24194 #endif /* HAVE_WINDOW_SYSTEM */
24195 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
24196 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
24198 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
24199 align_to
= (align_to
< 0
24201 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
24202 else if (align_to
< 0)
24203 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
24204 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
24205 zero_width_ok_p
= 1;
24208 /* Nothing specified -> width defaults to canonical char width. */
24209 width
= FRAME_COLUMN_WIDTH (it
->f
);
24211 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
24214 #ifdef HAVE_WINDOW_SYSTEM
24215 /* Compute height. */
24216 if (FRAME_WINDOW_P (it
->f
))
24218 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
24219 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24222 zero_height_ok_p
= 1;
24224 else if (prop
= Fplist_get (plist
, QCrelative_height
),
24226 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
24228 height
= FONT_HEIGHT (font
);
24230 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
24233 /* Compute percentage of height used for ascent. If
24234 `:ascent ASCENT' is present and valid, use that. Otherwise,
24235 derive the ascent from the font in use. */
24236 if (prop
= Fplist_get (plist
, QCascent
),
24237 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
24238 ascent
= height
* NUMVAL (prop
) / 100.0;
24239 else if (!NILP (prop
)
24240 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24241 ascent
= min (max (0, (int)tem
), height
);
24243 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
24246 #endif /* HAVE_WINDOW_SYSTEM */
24249 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24250 && it
->current_x
+ width
> it
->last_visible_x
)
24252 width
= it
->last_visible_x
- it
->current_x
;
24253 #ifdef HAVE_WINDOW_SYSTEM
24254 /* Subtract one more pixel from the stretch width, but only on
24255 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24256 width
-= FRAME_WINDOW_P (it
->f
);
24260 if (width
> 0 && height
> 0 && it
->glyph_row
)
24262 Lisp_Object o_object
= it
->object
;
24263 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24266 if (!STRINGP (object
))
24267 object
= it
->w
->buffer
;
24268 #ifdef HAVE_WINDOW_SYSTEM
24269 if (FRAME_WINDOW_P (it
->f
))
24270 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24274 it
->object
= object
;
24275 it
->char_to_display
= ' ';
24276 it
->pixel_width
= it
->len
= 1;
24278 tty_append_glyph (it
);
24279 it
->object
= o_object
;
24283 it
->pixel_width
= width
;
24284 #ifdef HAVE_WINDOW_SYSTEM
24285 if (FRAME_WINDOW_P (it
->f
))
24287 it
->ascent
= it
->phys_ascent
= ascent
;
24288 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24289 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24290 take_vertical_position_into_account (it
);
24294 it
->nglyphs
= width
;
24297 /* Get information about special display element WHAT in an
24298 environment described by IT. WHAT is one of IT_TRUNCATION or
24299 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24300 non-null glyph_row member. This function ensures that fields like
24301 face_id, c, len of IT are left untouched. */
24304 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
24311 temp_it
.object
= make_number (0);
24312 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
24314 if (what
== IT_CONTINUATION
)
24316 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24317 if (it
->bidi_it
.paragraph_dir
== R2L
)
24318 SET_GLYPH_FROM_CHAR (glyph
, '/');
24320 SET_GLYPH_FROM_CHAR (glyph
, '\\');
24322 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24324 /* FIXME: Should we mirror GC for R2L lines? */
24325 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24326 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24329 else if (what
== IT_TRUNCATION
)
24331 /* Truncation glyph. */
24332 SET_GLYPH_FROM_CHAR (glyph
, '$');
24334 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24336 /* FIXME: Should we mirror GC for R2L lines? */
24337 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24338 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24344 #ifdef HAVE_WINDOW_SYSTEM
24345 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24346 is turned off, we precede the truncation/continuation glyphs by a
24347 stretch glyph whose width is computed such that these special
24348 glyphs are aligned at the window margin, even when very different
24349 fonts are used in different glyph rows. */
24350 if (FRAME_WINDOW_P (temp_it
.f
)
24351 /* init_iterator calls this with it->glyph_row == NULL, and it
24352 wants only the pixel width of the truncation/continuation
24354 && temp_it
.glyph_row
24355 /* insert_left_trunc_glyphs calls us at the beginning of the
24356 row, and it has its own calculation of the stretch glyph
24358 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
24359 && (temp_it
.glyph_row
->reversed_p
24360 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
24361 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
24363 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
24365 if (stretch_width
> 0)
24367 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
24368 struct font
*font
=
24369 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
24370 int stretch_ascent
=
24371 (((temp_it
.ascent
+ temp_it
.descent
)
24372 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
24374 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
24375 temp_it
.ascent
+ temp_it
.descent
,
24382 temp_it
.what
= IT_CHARACTER
;
24384 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
24385 temp_it
.face_id
= GLYPH_FACE (glyph
);
24386 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
24388 PRODUCE_GLYPHS (&temp_it
);
24389 it
->pixel_width
= temp_it
.pixel_width
;
24390 it
->nglyphs
= temp_it
.pixel_width
;
24393 #ifdef HAVE_WINDOW_SYSTEM
24395 /* Calculate line-height and line-spacing properties.
24396 An integer value specifies explicit pixel value.
24397 A float value specifies relative value to current face height.
24398 A cons (float . face-name) specifies relative value to
24399 height of specified face font.
24401 Returns height in pixels, or nil. */
24405 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24406 int boff
, int override
)
24408 Lisp_Object face_name
= Qnil
;
24409 int ascent
, descent
, height
;
24411 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24416 face_name
= XCAR (val
);
24418 if (!NUMBERP (val
))
24419 val
= make_number (1);
24420 if (NILP (face_name
))
24422 height
= it
->ascent
+ it
->descent
;
24427 if (NILP (face_name
))
24429 font
= FRAME_FONT (it
->f
);
24430 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24432 else if (EQ (face_name
, Qt
))
24441 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24443 return make_number (-1);
24445 face
= FACE_FROM_ID (it
->f
, face_id
);
24448 return make_number (-1);
24449 boff
= font
->baseline_offset
;
24450 if (font
->vertical_centering
)
24451 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24454 ascent
= FONT_BASE (font
) + boff
;
24455 descent
= FONT_DESCENT (font
) - boff
;
24459 it
->override_ascent
= ascent
;
24460 it
->override_descent
= descent
;
24461 it
->override_boff
= boff
;
24464 height
= ascent
+ descent
;
24468 height
= (int)(XFLOAT_DATA (val
) * height
);
24469 else if (INTEGERP (val
))
24470 height
*= XINT (val
);
24472 return make_number (height
);
24476 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24477 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24478 and only if this is for a character for which no font was found.
24480 If the display method (it->glyphless_method) is
24481 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24482 length of the acronym or the hexadecimal string, UPPER_XOFF and
24483 UPPER_YOFF are pixel offsets for the upper part of the string,
24484 LOWER_XOFF and LOWER_YOFF are for the lower part.
24486 For the other display methods, LEN through LOWER_YOFF are zero. */
24489 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24490 short upper_xoff
, short upper_yoff
,
24491 short lower_xoff
, short lower_yoff
)
24493 struct glyph
*glyph
;
24494 enum glyph_row_area area
= it
->area
;
24496 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24497 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24499 /* If the glyph row is reversed, we need to prepend the glyph
24500 rather than append it. */
24501 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24505 /* Make room for the additional glyph. */
24506 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24508 glyph
= it
->glyph_row
->glyphs
[area
];
24510 glyph
->charpos
= CHARPOS (it
->position
);
24511 glyph
->object
= it
->object
;
24512 glyph
->pixel_width
= it
->pixel_width
;
24513 glyph
->ascent
= it
->ascent
;
24514 glyph
->descent
= it
->descent
;
24515 glyph
->voffset
= it
->voffset
;
24516 glyph
->type
= GLYPHLESS_GLYPH
;
24517 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24518 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24519 glyph
->u
.glyphless
.len
= len
;
24520 glyph
->u
.glyphless
.ch
= it
->c
;
24521 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24522 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24523 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24524 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24525 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24526 glyph
->multibyte_p
= it
->multibyte_p
;
24527 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24529 /* In R2L rows, the left and the right box edges need to be
24530 drawn in reverse direction. */
24531 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24532 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24536 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24537 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24539 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24540 || it
->phys_descent
> it
->descent
);
24541 glyph
->padding_p
= 0;
24542 glyph
->glyph_not_available_p
= 0;
24543 glyph
->face_id
= face_id
;
24544 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24547 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24548 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24550 glyph
->bidi_type
= it
->bidi_it
.type
;
24552 ++it
->glyph_row
->used
[area
];
24555 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24559 /* Produce a glyph for a glyphless character for iterator IT.
24560 IT->glyphless_method specifies which method to use for displaying
24561 the character. See the description of enum
24562 glyphless_display_method in dispextern.h for the detail.
24564 FOR_NO_FONT is nonzero if and only if this is for a character for
24565 which no font was found. ACRONYM, if non-nil, is an acronym string
24566 for the character. */
24569 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24574 int base_width
, base_height
, width
, height
;
24575 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24578 /* Get the metrics of the base font. We always refer to the current
24580 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24581 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24582 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24583 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24584 base_height
= it
->ascent
+ it
->descent
;
24585 base_width
= font
->average_width
;
24587 /* Get a face ID for the glyph by utilizing a cache (the same way as
24588 done for `escape-glyph' in get_next_display_element). */
24589 if (it
->f
== last_glyphless_glyph_frame
24590 && it
->face_id
== last_glyphless_glyph_face_id
)
24592 face_id
= last_glyphless_glyph_merged_face_id
;
24596 /* Merge the `glyphless-char' face into the current face. */
24597 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24598 last_glyphless_glyph_frame
= it
->f
;
24599 last_glyphless_glyph_face_id
= it
->face_id
;
24600 last_glyphless_glyph_merged_face_id
= face_id
;
24603 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24605 it
->pixel_width
= THIN_SPACE_WIDTH
;
24607 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24609 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24611 width
= CHAR_WIDTH (it
->c
);
24614 else if (width
> 4)
24616 it
->pixel_width
= base_width
* width
;
24618 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24624 unsigned int code
[6];
24626 int ascent
, descent
;
24627 struct font_metrics metrics_upper
, metrics_lower
;
24629 face
= FACE_FROM_ID (it
->f
, face_id
);
24630 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24631 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24633 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24635 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24636 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24637 if (CONSP (acronym
))
24638 acronym
= XCAR (acronym
);
24639 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24643 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24644 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24647 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24648 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24649 upper_len
= (len
+ 1) / 2;
24650 font
->driver
->text_extents (font
, code
, upper_len
,
24652 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24657 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24658 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24659 upper_xoff
= upper_yoff
= 2; /* the typical case */
24660 if (base_width
>= width
)
24662 /* Align the upper to the left, the lower to the right. */
24663 it
->pixel_width
= base_width
;
24664 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24668 /* Center the shorter one. */
24669 it
->pixel_width
= width
;
24670 if (metrics_upper
.width
>= metrics_lower
.width
)
24671 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24674 /* FIXME: This code doesn't look right. It formerly was
24675 missing the "lower_xoff = 0;", which couldn't have
24676 been right since it left lower_xoff uninitialized. */
24678 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24682 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24683 top, bottom, and between upper and lower strings. */
24684 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24685 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24686 /* Center vertically.
24687 H:base_height, D:base_descent
24688 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24690 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24691 descent = D - H/2 + h/2;
24692 lower_yoff = descent - 2 - ld;
24693 upper_yoff = lower_yoff - la - 1 - ud; */
24694 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24695 descent
= it
->descent
- (base_height
- height
) / 2;
24696 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24697 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24698 - metrics_upper
.descent
);
24699 /* Don't make the height shorter than the base height. */
24700 if (height
> base_height
)
24702 it
->ascent
= ascent
;
24703 it
->descent
= descent
;
24707 it
->phys_ascent
= it
->ascent
;
24708 it
->phys_descent
= it
->descent
;
24710 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24711 upper_xoff
, upper_yoff
,
24712 lower_xoff
, lower_yoff
);
24714 take_vertical_position_into_account (it
);
24719 Produce glyphs/get display metrics for the display element IT is
24720 loaded with. See the description of struct it in dispextern.h
24721 for an overview of struct it. */
24724 x_produce_glyphs (struct it
*it
)
24726 int extra_line_spacing
= it
->extra_line_spacing
;
24728 it
->glyph_not_available_p
= 0;
24730 if (it
->what
== IT_CHARACTER
)
24733 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24734 struct font
*font
= face
->font
;
24735 struct font_metrics
*pcm
= NULL
;
24736 int boff
; /* baseline offset */
24740 /* When no suitable font is found, display this character by
24741 the method specified in the first extra slot of
24742 Vglyphless_char_display. */
24743 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24745 eassert (it
->what
== IT_GLYPHLESS
);
24746 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24750 boff
= font
->baseline_offset
;
24751 if (font
->vertical_centering
)
24752 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24754 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24760 if (it
->override_ascent
>= 0)
24762 it
->ascent
= it
->override_ascent
;
24763 it
->descent
= it
->override_descent
;
24764 boff
= it
->override_boff
;
24768 it
->ascent
= FONT_BASE (font
) + boff
;
24769 it
->descent
= FONT_DESCENT (font
) - boff
;
24772 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24774 pcm
= get_per_char_metric (font
, &char2b
);
24775 if (pcm
->width
== 0
24776 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24782 it
->phys_ascent
= pcm
->ascent
+ boff
;
24783 it
->phys_descent
= pcm
->descent
- boff
;
24784 it
->pixel_width
= pcm
->width
;
24788 it
->glyph_not_available_p
= 1;
24789 it
->phys_ascent
= it
->ascent
;
24790 it
->phys_descent
= it
->descent
;
24791 it
->pixel_width
= font
->space_width
;
24794 if (it
->constrain_row_ascent_descent_p
)
24796 if (it
->descent
> it
->max_descent
)
24798 it
->ascent
+= it
->descent
- it
->max_descent
;
24799 it
->descent
= it
->max_descent
;
24801 if (it
->ascent
> it
->max_ascent
)
24803 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24804 it
->ascent
= it
->max_ascent
;
24806 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24807 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24808 extra_line_spacing
= 0;
24811 /* If this is a space inside a region of text with
24812 `space-width' property, change its width. */
24813 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24815 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24817 /* If face has a box, add the box thickness to the character
24818 height. If character has a box line to the left and/or
24819 right, add the box line width to the character's width. */
24820 if (face
->box
!= FACE_NO_BOX
)
24822 int thick
= face
->box_line_width
;
24826 it
->ascent
+= thick
;
24827 it
->descent
+= thick
;
24832 if (it
->start_of_box_run_p
)
24833 it
->pixel_width
+= thick
;
24834 if (it
->end_of_box_run_p
)
24835 it
->pixel_width
+= thick
;
24838 /* If face has an overline, add the height of the overline
24839 (1 pixel) and a 1 pixel margin to the character height. */
24840 if (face
->overline_p
)
24841 it
->ascent
+= overline_margin
;
24843 if (it
->constrain_row_ascent_descent_p
)
24845 if (it
->ascent
> it
->max_ascent
)
24846 it
->ascent
= it
->max_ascent
;
24847 if (it
->descent
> it
->max_descent
)
24848 it
->descent
= it
->max_descent
;
24851 take_vertical_position_into_account (it
);
24853 /* If we have to actually produce glyphs, do it. */
24858 /* Translate a space with a `space-width' property
24859 into a stretch glyph. */
24860 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24861 / FONT_HEIGHT (font
));
24862 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24863 it
->ascent
+ it
->descent
, ascent
);
24868 /* If characters with lbearing or rbearing are displayed
24869 in this line, record that fact in a flag of the
24870 glyph row. This is used to optimize X output code. */
24871 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24872 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24874 if (! stretched_p
&& it
->pixel_width
== 0)
24875 /* We assure that all visible glyphs have at least 1-pixel
24877 it
->pixel_width
= 1;
24879 else if (it
->char_to_display
== '\n')
24881 /* A newline has no width, but we need the height of the
24882 line. But if previous part of the line sets a height,
24883 don't increase that height */
24885 Lisp_Object height
;
24886 Lisp_Object total_height
= Qnil
;
24888 it
->override_ascent
= -1;
24889 it
->pixel_width
= 0;
24892 height
= get_it_property (it
, Qline_height
);
24893 /* Split (line-height total-height) list */
24895 && CONSP (XCDR (height
))
24896 && NILP (XCDR (XCDR (height
))))
24898 total_height
= XCAR (XCDR (height
));
24899 height
= XCAR (height
);
24901 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24903 if (it
->override_ascent
>= 0)
24905 it
->ascent
= it
->override_ascent
;
24906 it
->descent
= it
->override_descent
;
24907 boff
= it
->override_boff
;
24911 it
->ascent
= FONT_BASE (font
) + boff
;
24912 it
->descent
= FONT_DESCENT (font
) - boff
;
24915 if (EQ (height
, Qt
))
24917 if (it
->descent
> it
->max_descent
)
24919 it
->ascent
+= it
->descent
- it
->max_descent
;
24920 it
->descent
= it
->max_descent
;
24922 if (it
->ascent
> it
->max_ascent
)
24924 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24925 it
->ascent
= it
->max_ascent
;
24927 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24928 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24929 it
->constrain_row_ascent_descent_p
= 1;
24930 extra_line_spacing
= 0;
24934 Lisp_Object spacing
;
24936 it
->phys_ascent
= it
->ascent
;
24937 it
->phys_descent
= it
->descent
;
24939 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24940 && face
->box
!= FACE_NO_BOX
24941 && face
->box_line_width
> 0)
24943 it
->ascent
+= face
->box_line_width
;
24944 it
->descent
+= face
->box_line_width
;
24947 && XINT (height
) > it
->ascent
+ it
->descent
)
24948 it
->ascent
= XINT (height
) - it
->descent
;
24950 if (!NILP (total_height
))
24951 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24954 spacing
= get_it_property (it
, Qline_spacing
);
24955 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24957 if (INTEGERP (spacing
))
24959 extra_line_spacing
= XINT (spacing
);
24960 if (!NILP (total_height
))
24961 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24965 else /* i.e. (it->char_to_display == '\t') */
24967 if (font
->space_width
> 0)
24969 int tab_width
= it
->tab_width
* font
->space_width
;
24970 int x
= it
->current_x
+ it
->continuation_lines_width
;
24971 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24973 /* If the distance from the current position to the next tab
24974 stop is less than a space character width, use the
24975 tab stop after that. */
24976 if (next_tab_x
- x
< font
->space_width
)
24977 next_tab_x
+= tab_width
;
24979 it
->pixel_width
= next_tab_x
- x
;
24981 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24982 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24986 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24987 it
->ascent
+ it
->descent
, it
->ascent
);
24992 it
->pixel_width
= 0;
24997 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24999 /* A static composition.
25001 Note: A composition is represented as one glyph in the
25002 glyph matrix. There are no padding glyphs.
25004 Important note: pixel_width, ascent, and descent are the
25005 values of what is drawn by draw_glyphs (i.e. the values of
25006 the overall glyphs composed). */
25007 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25008 int boff
; /* baseline offset */
25009 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
25010 int glyph_len
= cmp
->glyph_len
;
25011 struct font
*font
= face
->font
;
25015 /* If we have not yet calculated pixel size data of glyphs of
25016 the composition for the current face font, calculate them
25017 now. Theoretically, we have to check all fonts for the
25018 glyphs, but that requires much time and memory space. So,
25019 here we check only the font of the first glyph. This may
25020 lead to incorrect display, but it's very rare, and C-l
25021 (recenter-top-bottom) can correct the display anyway. */
25022 if (! cmp
->font
|| cmp
->font
!= font
)
25024 /* Ascent and descent of the font of the first character
25025 of this composition (adjusted by baseline offset).
25026 Ascent and descent of overall glyphs should not be less
25027 than these, respectively. */
25028 int font_ascent
, font_descent
, font_height
;
25029 /* Bounding box of the overall glyphs. */
25030 int leftmost
, rightmost
, lowest
, highest
;
25031 int lbearing
, rbearing
;
25032 int i
, width
, ascent
, descent
;
25033 int left_padded
= 0, right_padded
= 0;
25034 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
25036 struct font_metrics
*pcm
;
25037 int font_not_found_p
;
25040 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
25041 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
25043 if (glyph_len
< cmp
->glyph_len
)
25045 for (i
= 0; i
< glyph_len
; i
++)
25047 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
25049 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25054 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
25055 : IT_CHARPOS (*it
));
25056 /* If no suitable font is found, use the default font. */
25057 font_not_found_p
= font
== NULL
;
25058 if (font_not_found_p
)
25060 face
= face
->ascii_face
;
25063 boff
= font
->baseline_offset
;
25064 if (font
->vertical_centering
)
25065 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25066 font_ascent
= FONT_BASE (font
) + boff
;
25067 font_descent
= FONT_DESCENT (font
) - boff
;
25068 font_height
= FONT_HEIGHT (font
);
25073 if (! font_not_found_p
)
25075 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
25077 pcm
= get_per_char_metric (font
, &char2b
);
25080 /* Initialize the bounding box. */
25083 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
25084 ascent
= pcm
->ascent
;
25085 descent
= pcm
->descent
;
25086 lbearing
= pcm
->lbearing
;
25087 rbearing
= pcm
->rbearing
;
25091 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
25092 ascent
= FONT_BASE (font
);
25093 descent
= FONT_DESCENT (font
);
25100 lowest
= - descent
+ boff
;
25101 highest
= ascent
+ boff
;
25103 if (! font_not_found_p
25104 && font
->default_ascent
25105 && CHAR_TABLE_P (Vuse_default_ascent
)
25106 && !NILP (Faref (Vuse_default_ascent
,
25107 make_number (it
->char_to_display
))))
25108 highest
= font
->default_ascent
+ boff
;
25110 /* Draw the first glyph at the normal position. It may be
25111 shifted to right later if some other glyphs are drawn
25113 cmp
->offsets
[i
* 2] = 0;
25114 cmp
->offsets
[i
* 2 + 1] = boff
;
25115 cmp
->lbearing
= lbearing
;
25116 cmp
->rbearing
= rbearing
;
25118 /* Set cmp->offsets for the remaining glyphs. */
25119 for (i
++; i
< glyph_len
; i
++)
25121 int left
, right
, btm
, top
;
25122 int ch
= COMPOSITION_GLYPH (cmp
, i
);
25124 struct face
*this_face
;
25128 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
25129 this_face
= FACE_FROM_ID (it
->f
, face_id
);
25130 font
= this_face
->font
;
25136 get_char_face_and_encoding (it
->f
, ch
, face_id
,
25138 pcm
= get_per_char_metric (font
, &char2b
);
25141 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25144 width
= pcm
->width
;
25145 ascent
= pcm
->ascent
;
25146 descent
= pcm
->descent
;
25147 lbearing
= pcm
->lbearing
;
25148 rbearing
= pcm
->rbearing
;
25149 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
25151 /* Relative composition with or without
25152 alternate chars. */
25153 left
= (leftmost
+ rightmost
- width
) / 2;
25154 btm
= - descent
+ boff
;
25155 if (font
->relative_compose
25156 && (! CHAR_TABLE_P (Vignore_relative_composition
)
25157 || NILP (Faref (Vignore_relative_composition
,
25158 make_number (ch
)))))
25161 if (- descent
>= font
->relative_compose
)
25162 /* One extra pixel between two glyphs. */
25164 else if (ascent
<= 0)
25165 /* One extra pixel between two glyphs. */
25166 btm
= lowest
- 1 - ascent
- descent
;
25171 /* A composition rule is specified by an integer
25172 value that encodes global and new reference
25173 points (GREF and NREF). GREF and NREF are
25174 specified by numbers as below:
25176 0---1---2 -- ascent
25180 9--10--11 -- center
25182 ---3---4---5--- baseline
25184 6---7---8 -- descent
25186 int rule
= COMPOSITION_RULE (cmp
, i
);
25187 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
25189 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
25190 grefx
= gref
% 3, nrefx
= nref
% 3;
25191 grefy
= gref
/ 3, nrefy
= nref
/ 3;
25193 xoff
= font_height
* (xoff
- 128) / 256;
25195 yoff
= font_height
* (yoff
- 128) / 256;
25198 + grefx
* (rightmost
- leftmost
) / 2
25199 - nrefx
* width
/ 2
25202 btm
= ((grefy
== 0 ? highest
25204 : grefy
== 2 ? lowest
25205 : (highest
+ lowest
) / 2)
25206 - (nrefy
== 0 ? ascent
+ descent
25207 : nrefy
== 1 ? descent
- boff
25209 : (ascent
+ descent
) / 2)
25213 cmp
->offsets
[i
* 2] = left
;
25214 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
25216 /* Update the bounding box of the overall glyphs. */
25219 right
= left
+ width
;
25220 if (left
< leftmost
)
25222 if (right
> rightmost
)
25225 top
= btm
+ descent
+ ascent
;
25231 if (cmp
->lbearing
> left
+ lbearing
)
25232 cmp
->lbearing
= left
+ lbearing
;
25233 if (cmp
->rbearing
< left
+ rbearing
)
25234 cmp
->rbearing
= left
+ rbearing
;
25238 /* If there are glyphs whose x-offsets are negative,
25239 shift all glyphs to the right and make all x-offsets
25243 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25244 cmp
->offsets
[i
* 2] -= leftmost
;
25245 rightmost
-= leftmost
;
25246 cmp
->lbearing
-= leftmost
;
25247 cmp
->rbearing
-= leftmost
;
25250 if (left_padded
&& cmp
->lbearing
< 0)
25252 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25253 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
25254 rightmost
-= cmp
->lbearing
;
25255 cmp
->rbearing
-= cmp
->lbearing
;
25258 if (right_padded
&& rightmost
< cmp
->rbearing
)
25260 rightmost
= cmp
->rbearing
;
25263 cmp
->pixel_width
= rightmost
;
25264 cmp
->ascent
= highest
;
25265 cmp
->descent
= - lowest
;
25266 if (cmp
->ascent
< font_ascent
)
25267 cmp
->ascent
= font_ascent
;
25268 if (cmp
->descent
< font_descent
)
25269 cmp
->descent
= font_descent
;
25273 && (cmp
->lbearing
< 0
25274 || cmp
->rbearing
> cmp
->pixel_width
))
25275 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25277 it
->pixel_width
= cmp
->pixel_width
;
25278 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
25279 it
->descent
= it
->phys_descent
= cmp
->descent
;
25280 if (face
->box
!= FACE_NO_BOX
)
25282 int thick
= face
->box_line_width
;
25286 it
->ascent
+= thick
;
25287 it
->descent
+= thick
;
25292 if (it
->start_of_box_run_p
)
25293 it
->pixel_width
+= thick
;
25294 if (it
->end_of_box_run_p
)
25295 it
->pixel_width
+= thick
;
25298 /* If face has an overline, add the height of the overline
25299 (1 pixel) and a 1 pixel margin to the character height. */
25300 if (face
->overline_p
)
25301 it
->ascent
+= overline_margin
;
25303 take_vertical_position_into_account (it
);
25304 if (it
->ascent
< 0)
25306 if (it
->descent
< 0)
25309 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
25310 append_composite_glyph (it
);
25312 else if (it
->what
== IT_COMPOSITION
)
25314 /* A dynamic (automatic) composition. */
25315 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25316 Lisp_Object gstring
;
25317 struct font_metrics metrics
;
25321 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
25323 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
25326 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
25327 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25328 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
25329 it
->descent
= it
->phys_descent
= metrics
.descent
;
25330 if (face
->box
!= FACE_NO_BOX
)
25332 int thick
= face
->box_line_width
;
25336 it
->ascent
+= thick
;
25337 it
->descent
+= thick
;
25342 if (it
->start_of_box_run_p
)
25343 it
->pixel_width
+= thick
;
25344 if (it
->end_of_box_run_p
)
25345 it
->pixel_width
+= thick
;
25347 /* If face has an overline, add the height of the overline
25348 (1 pixel) and a 1 pixel margin to the character height. */
25349 if (face
->overline_p
)
25350 it
->ascent
+= overline_margin
;
25351 take_vertical_position_into_account (it
);
25352 if (it
->ascent
< 0)
25354 if (it
->descent
< 0)
25358 append_composite_glyph (it
);
25360 else if (it
->what
== IT_GLYPHLESS
)
25361 produce_glyphless_glyph (it
, 0, Qnil
);
25362 else if (it
->what
== IT_IMAGE
)
25363 produce_image_glyph (it
);
25364 else if (it
->what
== IT_STRETCH
)
25365 produce_stretch_glyph (it
);
25368 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25369 because this isn't true for images with `:ascent 100'. */
25370 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
25371 if (it
->area
== TEXT_AREA
)
25372 it
->current_x
+= it
->pixel_width
;
25374 if (extra_line_spacing
> 0)
25376 it
->descent
+= extra_line_spacing
;
25377 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25378 it
->max_extra_line_spacing
= extra_line_spacing
;
25381 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25382 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25383 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25384 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25388 Output LEN glyphs starting at START at the nominal cursor position.
25389 Advance the nominal cursor over the text. The global variable
25390 updated_window contains the window being updated, updated_row is
25391 the glyph row being updated, and updated_area is the area of that
25392 row being updated. */
25395 x_write_glyphs (struct glyph
*start
, int len
)
25397 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25399 eassert (updated_window
&& updated_row
);
25400 /* When the window is hscrolled, cursor hpos can legitimately be out
25401 of bounds, but we draw the cursor at the corresponding window
25402 margin in that case. */
25403 if (!updated_row
->reversed_p
&& chpos
< 0)
25405 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25406 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25410 /* Write glyphs. */
25412 hpos
= start
- updated_row
->glyphs
[updated_area
];
25413 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25414 updated_row
, updated_area
,
25416 DRAW_NORMAL_TEXT
, 0);
25418 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25419 if (updated_area
== TEXT_AREA
25420 && updated_window
->phys_cursor_on_p
25421 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25423 && chpos
< hpos
+ len
)
25424 updated_window
->phys_cursor_on_p
= 0;
25428 /* Advance the output cursor. */
25429 output_cursor
.hpos
+= len
;
25430 output_cursor
.x
= x
;
25435 Insert LEN glyphs from START at the nominal cursor position. */
25438 x_insert_glyphs (struct glyph
*start
, int len
)
25442 int line_height
, shift_by_width
, shifted_region_width
;
25443 struct glyph_row
*row
;
25444 struct glyph
*glyph
;
25445 int frame_x
, frame_y
;
25448 eassert (updated_window
&& updated_row
);
25450 w
= updated_window
;
25451 f
= XFRAME (WINDOW_FRAME (w
));
25453 /* Get the height of the line we are in. */
25455 line_height
= row
->height
;
25457 /* Get the width of the glyphs to insert. */
25458 shift_by_width
= 0;
25459 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25460 shift_by_width
+= glyph
->pixel_width
;
25462 /* Get the width of the region to shift right. */
25463 shifted_region_width
= (window_box_width (w
, updated_area
)
25468 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25469 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25471 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25472 line_height
, shift_by_width
);
25474 /* Write the glyphs. */
25475 hpos
= start
- row
->glyphs
[updated_area
];
25476 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25478 DRAW_NORMAL_TEXT
, 0);
25480 /* Advance the output cursor. */
25481 output_cursor
.hpos
+= len
;
25482 output_cursor
.x
+= shift_by_width
;
25488 Erase the current text line from the nominal cursor position
25489 (inclusive) to pixel column TO_X (exclusive). The idea is that
25490 everything from TO_X onward is already erased.
25492 TO_X is a pixel position relative to updated_area of
25493 updated_window. TO_X == -1 means clear to the end of this area. */
25496 x_clear_end_of_line (int to_x
)
25499 struct window
*w
= updated_window
;
25500 int max_x
, min_y
, max_y
;
25501 int from_x
, from_y
, to_y
;
25503 eassert (updated_window
&& updated_row
);
25504 f
= XFRAME (w
->frame
);
25506 if (updated_row
->full_width_p
)
25507 max_x
= WINDOW_TOTAL_WIDTH (w
);
25509 max_x
= window_box_width (w
, updated_area
);
25510 max_y
= window_text_bottom_y (w
);
25512 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25513 of window. For TO_X > 0, truncate to end of drawing area. */
25519 to_x
= min (to_x
, max_x
);
25521 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25523 /* Notice if the cursor will be cleared by this operation. */
25524 if (!updated_row
->full_width_p
)
25525 notice_overwritten_cursor (w
, updated_area
,
25526 output_cursor
.x
, -1,
25528 MATRIX_ROW_BOTTOM_Y (updated_row
));
25530 from_x
= output_cursor
.x
;
25532 /* Translate to frame coordinates. */
25533 if (updated_row
->full_width_p
)
25535 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25536 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25540 int area_left
= window_box_left (w
, updated_area
);
25541 from_x
+= area_left
;
25545 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25546 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25547 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25549 /* Prevent inadvertently clearing to end of the X window. */
25550 if (to_x
> from_x
&& to_y
> from_y
)
25553 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25554 to_x
- from_x
, to_y
- from_y
);
25559 #endif /* HAVE_WINDOW_SYSTEM */
25563 /***********************************************************************
25565 ***********************************************************************/
25567 /* Value is the internal representation of the specified cursor type
25568 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25569 of the bar cursor. */
25571 static enum text_cursor_kinds
25572 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25574 enum text_cursor_kinds type
;
25579 if (EQ (arg
, Qbox
))
25580 return FILLED_BOX_CURSOR
;
25582 if (EQ (arg
, Qhollow
))
25583 return HOLLOW_BOX_CURSOR
;
25585 if (EQ (arg
, Qbar
))
25592 && EQ (XCAR (arg
), Qbar
)
25593 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25595 *width
= XINT (XCDR (arg
));
25599 if (EQ (arg
, Qhbar
))
25602 return HBAR_CURSOR
;
25606 && EQ (XCAR (arg
), Qhbar
)
25607 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25609 *width
= XINT (XCDR (arg
));
25610 return HBAR_CURSOR
;
25613 /* Treat anything unknown as "hollow box cursor".
25614 It was bad to signal an error; people have trouble fixing
25615 .Xdefaults with Emacs, when it has something bad in it. */
25616 type
= HOLLOW_BOX_CURSOR
;
25621 /* Set the default cursor types for specified frame. */
25623 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25628 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25629 FRAME_CURSOR_WIDTH (f
) = width
;
25631 /* By default, set up the blink-off state depending on the on-state. */
25633 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25636 FRAME_BLINK_OFF_CURSOR (f
)
25637 = get_specified_cursor_type (XCDR (tem
), &width
);
25638 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25641 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25645 #ifdef HAVE_WINDOW_SYSTEM
25647 /* Return the cursor we want to be displayed in window W. Return
25648 width of bar/hbar cursor through WIDTH arg. Return with
25649 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25650 (i.e. if the `system caret' should track this cursor).
25652 In a mini-buffer window, we want the cursor only to appear if we
25653 are reading input from this window. For the selected window, we
25654 want the cursor type given by the frame parameter or buffer local
25655 setting of cursor-type. If explicitly marked off, draw no cursor.
25656 In all other cases, we want a hollow box cursor. */
25658 static enum text_cursor_kinds
25659 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25660 int *active_cursor
)
25662 struct frame
*f
= XFRAME (w
->frame
);
25663 struct buffer
*b
= XBUFFER (w
->buffer
);
25664 int cursor_type
= DEFAULT_CURSOR
;
25665 Lisp_Object alt_cursor
;
25666 int non_selected
= 0;
25668 *active_cursor
= 1;
25671 if (cursor_in_echo_area
25672 && FRAME_HAS_MINIBUF_P (f
)
25673 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25675 if (w
== XWINDOW (echo_area_window
))
25677 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25679 *width
= FRAME_CURSOR_WIDTH (f
);
25680 return FRAME_DESIRED_CURSOR (f
);
25683 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25686 *active_cursor
= 0;
25690 /* Detect a nonselected window or nonselected frame. */
25691 else if (w
!= XWINDOW (f
->selected_window
)
25692 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25694 *active_cursor
= 0;
25696 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25702 /* Never display a cursor in a window in which cursor-type is nil. */
25703 if (NILP (BVAR (b
, cursor_type
)))
25706 /* Get the normal cursor type for this window. */
25707 if (EQ (BVAR (b
, cursor_type
), Qt
))
25709 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25710 *width
= FRAME_CURSOR_WIDTH (f
);
25713 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25715 /* Use cursor-in-non-selected-windows instead
25716 for non-selected window or frame. */
25719 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25720 if (!EQ (Qt
, alt_cursor
))
25721 return get_specified_cursor_type (alt_cursor
, width
);
25722 /* t means modify the normal cursor type. */
25723 if (cursor_type
== FILLED_BOX_CURSOR
)
25724 cursor_type
= HOLLOW_BOX_CURSOR
;
25725 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25727 return cursor_type
;
25730 /* Use normal cursor if not blinked off. */
25731 if (!w
->cursor_off_p
)
25733 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25735 if (cursor_type
== FILLED_BOX_CURSOR
)
25737 /* Using a block cursor on large images can be very annoying.
25738 So use a hollow cursor for "large" images.
25739 If image is not transparent (no mask), also use hollow cursor. */
25740 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25741 if (img
!= NULL
&& IMAGEP (img
->spec
))
25743 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25744 where N = size of default frame font size.
25745 This should cover most of the "tiny" icons people may use. */
25747 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25748 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25749 cursor_type
= HOLLOW_BOX_CURSOR
;
25752 else if (cursor_type
!= NO_CURSOR
)
25754 /* Display current only supports BOX and HOLLOW cursors for images.
25755 So for now, unconditionally use a HOLLOW cursor when cursor is
25756 not a solid box cursor. */
25757 cursor_type
= HOLLOW_BOX_CURSOR
;
25760 return cursor_type
;
25763 /* Cursor is blinked off, so determine how to "toggle" it. */
25765 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25766 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25767 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25769 /* Then see if frame has specified a specific blink off cursor type. */
25770 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25772 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25773 return FRAME_BLINK_OFF_CURSOR (f
);
25777 /* Some people liked having a permanently visible blinking cursor,
25778 while others had very strong opinions against it. So it was
25779 decided to remove it. KFS 2003-09-03 */
25781 /* Finally perform built-in cursor blinking:
25782 filled box <-> hollow box
25783 wide [h]bar <-> narrow [h]bar
25784 narrow [h]bar <-> no cursor
25785 other type <-> no cursor */
25787 if (cursor_type
== FILLED_BOX_CURSOR
)
25788 return HOLLOW_BOX_CURSOR
;
25790 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25793 return cursor_type
;
25801 /* Notice when the text cursor of window W has been completely
25802 overwritten by a drawing operation that outputs glyphs in AREA
25803 starting at X0 and ending at X1 in the line starting at Y0 and
25804 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25805 the rest of the line after X0 has been written. Y coordinates
25806 are window-relative. */
25809 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25810 int x0
, int x1
, int y0
, int y1
)
25812 int cx0
, cx1
, cy0
, cy1
;
25813 struct glyph_row
*row
;
25815 if (!w
->phys_cursor_on_p
)
25817 if (area
!= TEXT_AREA
)
25820 if (w
->phys_cursor
.vpos
< 0
25821 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25822 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25823 !(row
->enabled_p
&& row
->displays_text_p
)))
25826 if (row
->cursor_in_fringe_p
)
25828 row
->cursor_in_fringe_p
= 0;
25829 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25830 w
->phys_cursor_on_p
= 0;
25834 cx0
= w
->phys_cursor
.x
;
25835 cx1
= cx0
+ w
->phys_cursor_width
;
25836 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25839 /* The cursor image will be completely removed from the
25840 screen if the output area intersects the cursor area in
25841 y-direction. When we draw in [y0 y1[, and some part of
25842 the cursor is at y < y0, that part must have been drawn
25843 before. When scrolling, the cursor is erased before
25844 actually scrolling, so we don't come here. When not
25845 scrolling, the rows above the old cursor row must have
25846 changed, and in this case these rows must have written
25847 over the cursor image.
25849 Likewise if part of the cursor is below y1, with the
25850 exception of the cursor being in the first blank row at
25851 the buffer and window end because update_text_area
25852 doesn't draw that row. (Except when it does, but
25853 that's handled in update_text_area.) */
25855 cy0
= w
->phys_cursor
.y
;
25856 cy1
= cy0
+ w
->phys_cursor_height
;
25857 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25860 w
->phys_cursor_on_p
= 0;
25863 #endif /* HAVE_WINDOW_SYSTEM */
25866 /************************************************************************
25868 ************************************************************************/
25870 #ifdef HAVE_WINDOW_SYSTEM
25873 Fix the display of area AREA of overlapping row ROW in window W
25874 with respect to the overlapping part OVERLAPS. */
25877 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25878 enum glyph_row_area area
, int overlaps
)
25885 for (i
= 0; i
< row
->used
[area
];)
25887 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25889 int start
= i
, start_x
= x
;
25893 x
+= row
->glyphs
[area
][i
].pixel_width
;
25896 while (i
< row
->used
[area
]
25897 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25899 draw_glyphs (w
, start_x
, row
, area
,
25901 DRAW_NORMAL_TEXT
, overlaps
);
25905 x
+= row
->glyphs
[area
][i
].pixel_width
;
25915 Draw the cursor glyph of window W in glyph row ROW. See the
25916 comment of draw_glyphs for the meaning of HL. */
25919 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25920 enum draw_glyphs_face hl
)
25922 /* If cursor hpos is out of bounds, don't draw garbage. This can
25923 happen in mini-buffer windows when switching between echo area
25924 glyphs and mini-buffer. */
25925 if ((row
->reversed_p
25926 ? (w
->phys_cursor
.hpos
>= 0)
25927 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25929 int on_p
= w
->phys_cursor_on_p
;
25931 int hpos
= w
->phys_cursor
.hpos
;
25933 /* When the window is hscrolled, cursor hpos can legitimately be
25934 out of bounds, but we draw the cursor at the corresponding
25935 window margin in that case. */
25936 if (!row
->reversed_p
&& hpos
< 0)
25938 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25939 hpos
= row
->used
[TEXT_AREA
] - 1;
25941 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25943 w
->phys_cursor_on_p
= on_p
;
25945 if (hl
== DRAW_CURSOR
)
25946 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25947 /* When we erase the cursor, and ROW is overlapped by other
25948 rows, make sure that these overlapping parts of other rows
25950 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25952 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25954 if (row
> w
->current_matrix
->rows
25955 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25956 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25957 OVERLAPS_ERASED_CURSOR
);
25959 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25960 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25961 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25962 OVERLAPS_ERASED_CURSOR
);
25969 Erase the image of a cursor of window W from the screen. */
25972 erase_phys_cursor (struct window
*w
)
25974 struct frame
*f
= XFRAME (w
->frame
);
25975 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25976 int hpos
= w
->phys_cursor
.hpos
;
25977 int vpos
= w
->phys_cursor
.vpos
;
25978 int mouse_face_here_p
= 0;
25979 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25980 struct glyph_row
*cursor_row
;
25981 struct glyph
*cursor_glyph
;
25982 enum draw_glyphs_face hl
;
25984 /* No cursor displayed or row invalidated => nothing to do on the
25986 if (w
->phys_cursor_type
== NO_CURSOR
)
25987 goto mark_cursor_off
;
25989 /* VPOS >= active_glyphs->nrows means that window has been resized.
25990 Don't bother to erase the cursor. */
25991 if (vpos
>= active_glyphs
->nrows
)
25992 goto mark_cursor_off
;
25994 /* If row containing cursor is marked invalid, there is nothing we
25996 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25997 if (!cursor_row
->enabled_p
)
25998 goto mark_cursor_off
;
26000 /* If line spacing is > 0, old cursor may only be partially visible in
26001 window after split-window. So adjust visible height. */
26002 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
26003 window_text_bottom_y (w
) - cursor_row
->y
);
26005 /* If row is completely invisible, don't attempt to delete a cursor which
26006 isn't there. This can happen if cursor is at top of a window, and
26007 we switch to a buffer with a header line in that window. */
26008 if (cursor_row
->visible_height
<= 0)
26009 goto mark_cursor_off
;
26011 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
26012 if (cursor_row
->cursor_in_fringe_p
)
26014 cursor_row
->cursor_in_fringe_p
= 0;
26015 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
26016 goto mark_cursor_off
;
26019 /* This can happen when the new row is shorter than the old one.
26020 In this case, either draw_glyphs or clear_end_of_line
26021 should have cleared the cursor. Note that we wouldn't be
26022 able to erase the cursor in this case because we don't have a
26023 cursor glyph at hand. */
26024 if ((cursor_row
->reversed_p
26025 ? (w
->phys_cursor
.hpos
< 0)
26026 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
26027 goto mark_cursor_off
;
26029 /* When the window is hscrolled, cursor hpos can legitimately be out
26030 of bounds, but we draw the cursor at the corresponding window
26031 margin in that case. */
26032 if (!cursor_row
->reversed_p
&& hpos
< 0)
26034 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
26035 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
26037 /* If the cursor is in the mouse face area, redisplay that when
26038 we clear the cursor. */
26039 if (! NILP (hlinfo
->mouse_face_window
)
26040 && coords_in_mouse_face_p (w
, hpos
, vpos
)
26041 /* Don't redraw the cursor's spot in mouse face if it is at the
26042 end of a line (on a newline). The cursor appears there, but
26043 mouse highlighting does not. */
26044 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
26045 mouse_face_here_p
= 1;
26047 /* Maybe clear the display under the cursor. */
26048 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
26051 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
26054 cursor_glyph
= get_phys_cursor_glyph (w
);
26055 if (cursor_glyph
== NULL
)
26056 goto mark_cursor_off
;
26058 width
= cursor_glyph
->pixel_width
;
26059 left_x
= window_box_left_offset (w
, TEXT_AREA
);
26060 x
= w
->phys_cursor
.x
;
26062 width
-= left_x
- x
;
26063 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
26064 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
26065 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
26068 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
26071 /* Erase the cursor by redrawing the character underneath it. */
26072 if (mouse_face_here_p
)
26073 hl
= DRAW_MOUSE_FACE
;
26075 hl
= DRAW_NORMAL_TEXT
;
26076 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
26079 w
->phys_cursor_on_p
= 0;
26080 w
->phys_cursor_type
= NO_CURSOR
;
26085 Display or clear cursor of window W. If ON is zero, clear the
26086 cursor. If it is non-zero, display the cursor. If ON is nonzero,
26087 where to put the cursor is specified by HPOS, VPOS, X and Y. */
26090 display_and_set_cursor (struct window
*w
, int on
,
26091 int hpos
, int vpos
, int x
, int y
)
26093 struct frame
*f
= XFRAME (w
->frame
);
26094 int new_cursor_type
;
26095 int new_cursor_width
;
26097 struct glyph_row
*glyph_row
;
26098 struct glyph
*glyph
;
26100 /* This is pointless on invisible frames, and dangerous on garbaged
26101 windows and frames; in the latter case, the frame or window may
26102 be in the midst of changing its size, and x and y may be off the
26104 if (! FRAME_VISIBLE_P (f
)
26105 || FRAME_GARBAGED_P (f
)
26106 || vpos
>= w
->current_matrix
->nrows
26107 || hpos
>= w
->current_matrix
->matrix_w
)
26110 /* If cursor is off and we want it off, return quickly. */
26111 if (!on
&& !w
->phys_cursor_on_p
)
26114 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26115 /* If cursor row is not enabled, we don't really know where to
26116 display the cursor. */
26117 if (!glyph_row
->enabled_p
)
26119 w
->phys_cursor_on_p
= 0;
26124 if (!glyph_row
->exact_window_width_line_p
26125 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
26126 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
26128 eassert (input_blocked_p ());
26130 /* Set new_cursor_type to the cursor we want to be displayed. */
26131 new_cursor_type
= get_window_cursor_type (w
, glyph
,
26132 &new_cursor_width
, &active_cursor
);
26134 /* If cursor is currently being shown and we don't want it to be or
26135 it is in the wrong place, or the cursor type is not what we want,
26137 if (w
->phys_cursor_on_p
26139 || w
->phys_cursor
.x
!= x
26140 || w
->phys_cursor
.y
!= y
26141 || new_cursor_type
!= w
->phys_cursor_type
26142 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
26143 && new_cursor_width
!= w
->phys_cursor_width
)))
26144 erase_phys_cursor (w
);
26146 /* Don't check phys_cursor_on_p here because that flag is only set
26147 to zero in some cases where we know that the cursor has been
26148 completely erased, to avoid the extra work of erasing the cursor
26149 twice. In other words, phys_cursor_on_p can be 1 and the cursor
26150 still not be visible, or it has only been partly erased. */
26153 w
->phys_cursor_ascent
= glyph_row
->ascent
;
26154 w
->phys_cursor_height
= glyph_row
->height
;
26156 /* Set phys_cursor_.* before x_draw_.* is called because some
26157 of them may need the information. */
26158 w
->phys_cursor
.x
= x
;
26159 w
->phys_cursor
.y
= glyph_row
->y
;
26160 w
->phys_cursor
.hpos
= hpos
;
26161 w
->phys_cursor
.vpos
= vpos
;
26164 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
26165 new_cursor_type
, new_cursor_width
,
26166 on
, active_cursor
);
26170 /* Switch the display of W's cursor on or off, according to the value
26174 update_window_cursor (struct window
*w
, int on
)
26176 /* Don't update cursor in windows whose frame is in the process
26177 of being deleted. */
26178 if (w
->current_matrix
)
26180 int hpos
= w
->phys_cursor
.hpos
;
26181 int vpos
= w
->phys_cursor
.vpos
;
26182 struct glyph_row
*row
;
26184 if (vpos
>= w
->current_matrix
->nrows
26185 || hpos
>= w
->current_matrix
->matrix_w
)
26188 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26190 /* When the window is hscrolled, cursor hpos can legitimately be
26191 out of bounds, but we draw the cursor at the corresponding
26192 window margin in that case. */
26193 if (!row
->reversed_p
&& hpos
< 0)
26195 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26196 hpos
= row
->used
[TEXT_AREA
] - 1;
26199 display_and_set_cursor (w
, on
, hpos
, vpos
,
26200 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26206 /* Call update_window_cursor with parameter ON_P on all leaf windows
26207 in the window tree rooted at W. */
26210 update_cursor_in_window_tree (struct window
*w
, int on_p
)
26214 if (!NILP (w
->hchild
))
26215 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
26216 else if (!NILP (w
->vchild
))
26217 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
26219 update_window_cursor (w
, on_p
);
26221 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
26227 Display the cursor on window W, or clear it, according to ON_P.
26228 Don't change the cursor's position. */
26231 x_update_cursor (struct frame
*f
, int on_p
)
26233 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
26238 Clear the cursor of window W to background color, and mark the
26239 cursor as not shown. This is used when the text where the cursor
26240 is about to be rewritten. */
26243 x_clear_cursor (struct window
*w
)
26245 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
26246 update_window_cursor (w
, 0);
26249 #endif /* HAVE_WINDOW_SYSTEM */
26251 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26254 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
26255 int start_hpos
, int end_hpos
,
26256 enum draw_glyphs_face draw
)
26258 #ifdef HAVE_WINDOW_SYSTEM
26259 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
26261 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
26265 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26266 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
26270 /* Display the active region described by mouse_face_* according to DRAW. */
26273 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
26275 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
26276 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26278 if (/* If window is in the process of being destroyed, don't bother
26280 w
->current_matrix
!= NULL
26281 /* Don't update mouse highlight if hidden */
26282 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
26283 /* Recognize when we are called to operate on rows that don't exist
26284 anymore. This can happen when a window is split. */
26285 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
26287 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
26288 struct glyph_row
*row
, *first
, *last
;
26290 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
26291 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
26293 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
26295 int start_hpos
, end_hpos
, start_x
;
26297 /* For all but the first row, the highlight starts at column 0. */
26300 /* R2L rows have BEG and END in reversed order, but the
26301 screen drawing geometry is always left to right. So
26302 we need to mirror the beginning and end of the
26303 highlighted area in R2L rows. */
26304 if (!row
->reversed_p
)
26306 start_hpos
= hlinfo
->mouse_face_beg_col
;
26307 start_x
= hlinfo
->mouse_face_beg_x
;
26309 else if (row
== last
)
26311 start_hpos
= hlinfo
->mouse_face_end_col
;
26312 start_x
= hlinfo
->mouse_face_end_x
;
26320 else if (row
->reversed_p
&& row
== last
)
26322 start_hpos
= hlinfo
->mouse_face_end_col
;
26323 start_x
= hlinfo
->mouse_face_end_x
;
26333 if (!row
->reversed_p
)
26334 end_hpos
= hlinfo
->mouse_face_end_col
;
26335 else if (row
== first
)
26336 end_hpos
= hlinfo
->mouse_face_beg_col
;
26339 end_hpos
= row
->used
[TEXT_AREA
];
26340 if (draw
== DRAW_NORMAL_TEXT
)
26341 row
->fill_line_p
= 1; /* Clear to end of line */
26344 else if (row
->reversed_p
&& row
== first
)
26345 end_hpos
= hlinfo
->mouse_face_beg_col
;
26348 end_hpos
= row
->used
[TEXT_AREA
];
26349 if (draw
== DRAW_NORMAL_TEXT
)
26350 row
->fill_line_p
= 1; /* Clear to end of line */
26353 if (end_hpos
> start_hpos
)
26355 draw_row_with_mouse_face (w
, start_x
, row
,
26356 start_hpos
, end_hpos
, draw
);
26359 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26363 #ifdef HAVE_WINDOW_SYSTEM
26364 /* When we've written over the cursor, arrange for it to
26365 be displayed again. */
26366 if (FRAME_WINDOW_P (f
)
26367 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26369 int hpos
= w
->phys_cursor
.hpos
;
26371 /* When the window is hscrolled, cursor hpos can legitimately be
26372 out of bounds, but we draw the cursor at the corresponding
26373 window margin in that case. */
26374 if (!row
->reversed_p
&& hpos
< 0)
26376 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26377 hpos
= row
->used
[TEXT_AREA
] - 1;
26380 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26381 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26384 #endif /* HAVE_WINDOW_SYSTEM */
26387 #ifdef HAVE_WINDOW_SYSTEM
26388 /* Change the mouse cursor. */
26389 if (FRAME_WINDOW_P (f
))
26391 if (draw
== DRAW_NORMAL_TEXT
26392 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26393 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26394 else if (draw
== DRAW_MOUSE_FACE
)
26395 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26397 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26399 #endif /* HAVE_WINDOW_SYSTEM */
26403 Clear out the mouse-highlighted active region.
26404 Redraw it un-highlighted first. Value is non-zero if mouse
26405 face was actually drawn unhighlighted. */
26408 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26412 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26414 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26418 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26419 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26420 hlinfo
->mouse_face_window
= Qnil
;
26421 hlinfo
->mouse_face_overlay
= Qnil
;
26425 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26426 within the mouse face on that window. */
26428 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26430 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26432 /* Quickly resolve the easy cases. */
26433 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26434 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26436 if (vpos
< hlinfo
->mouse_face_beg_row
26437 || vpos
> hlinfo
->mouse_face_end_row
)
26439 if (vpos
> hlinfo
->mouse_face_beg_row
26440 && vpos
< hlinfo
->mouse_face_end_row
)
26443 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26445 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26447 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26450 else if ((vpos
== hlinfo
->mouse_face_beg_row
26451 && hpos
>= hlinfo
->mouse_face_beg_col
)
26452 || (vpos
== hlinfo
->mouse_face_end_row
26453 && hpos
< hlinfo
->mouse_face_end_col
))
26458 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26460 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26463 else if ((vpos
== hlinfo
->mouse_face_beg_row
26464 && hpos
<= hlinfo
->mouse_face_beg_col
)
26465 || (vpos
== hlinfo
->mouse_face_end_row
26466 && hpos
> hlinfo
->mouse_face_end_col
))
26474 Non-zero if physical cursor of window W is within mouse face. */
26477 cursor_in_mouse_face_p (struct window
*w
)
26479 int hpos
= w
->phys_cursor
.hpos
;
26480 int vpos
= w
->phys_cursor
.vpos
;
26481 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26483 /* When the window is hscrolled, cursor hpos can legitimately be out
26484 of bounds, but we draw the cursor at the corresponding window
26485 margin in that case. */
26486 if (!row
->reversed_p
&& hpos
< 0)
26488 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26489 hpos
= row
->used
[TEXT_AREA
] - 1;
26491 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26496 /* Find the glyph rows START_ROW and END_ROW of window W that display
26497 characters between buffer positions START_CHARPOS and END_CHARPOS
26498 (excluding END_CHARPOS). DISP_STRING is a display string that
26499 covers these buffer positions. This is similar to
26500 row_containing_pos, but is more accurate when bidi reordering makes
26501 buffer positions change non-linearly with glyph rows. */
26503 rows_from_pos_range (struct window
*w
,
26504 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26505 Lisp_Object disp_string
,
26506 struct glyph_row
**start
, struct glyph_row
**end
)
26508 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26509 int last_y
= window_text_bottom_y (w
);
26510 struct glyph_row
*row
;
26515 while (!first
->enabled_p
26516 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26519 /* Find the START row. */
26521 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26524 /* A row can potentially be the START row if the range of the
26525 characters it displays intersects the range
26526 [START_CHARPOS..END_CHARPOS). */
26527 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26528 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26529 /* See the commentary in row_containing_pos, for the
26530 explanation of the complicated way to check whether
26531 some position is beyond the end of the characters
26532 displayed by a row. */
26533 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26534 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26535 && !row
->ends_at_zv_p
26536 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26537 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26538 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26539 && !row
->ends_at_zv_p
26540 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26542 /* Found a candidate row. Now make sure at least one of the
26543 glyphs it displays has a charpos from the range
26544 [START_CHARPOS..END_CHARPOS).
26546 This is not obvious because bidi reordering could make
26547 buffer positions of a row be 1,2,3,102,101,100, and if we
26548 want to highlight characters in [50..60), we don't want
26549 this row, even though [50..60) does intersect [1..103),
26550 the range of character positions given by the row's start
26551 and end positions. */
26552 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26553 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26557 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26558 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26559 /* A glyph that comes from DISP_STRING is by
26560 definition to be highlighted. */
26561 || EQ (g
->object
, disp_string
))
26570 /* Find the END row. */
26572 /* If the last row is partially visible, start looking for END
26573 from that row, instead of starting from FIRST. */
26574 && !(row
->enabled_p
26575 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26577 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26579 struct glyph_row
*next
= row
+ 1;
26580 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26582 if (!next
->enabled_p
26583 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26584 /* The first row >= START whose range of displayed characters
26585 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26586 is the row END + 1. */
26587 || (start_charpos
< next_start
26588 && end_charpos
< next_start
)
26589 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26590 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26591 && !next
->ends_at_zv_p
26592 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26593 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26594 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26595 && !next
->ends_at_zv_p
26596 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26603 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26604 but none of the characters it displays are in the range, it is
26606 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26607 struct glyph
*s
= g
;
26608 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26612 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26613 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26614 /* If the buffer position of the first glyph in
26615 the row is equal to END_CHARPOS, it means
26616 the last character to be highlighted is the
26617 newline of ROW, and we must consider NEXT as
26619 || (((!next
->reversed_p
&& g
== s
)
26620 || (next
->reversed_p
&& g
== e
- 1))
26621 && (g
->charpos
== end_charpos
26622 /* Special case for when NEXT is an
26623 empty line at ZV. */
26624 || (g
->charpos
== -1
26625 && !row
->ends_at_zv_p
26626 && next_start
== end_charpos
)))))
26627 /* A glyph that comes from DISP_STRING is by
26628 definition to be highlighted. */
26629 || EQ (g
->object
, disp_string
))
26638 /* The first row that ends at ZV must be the last to be
26640 else if (next
->ends_at_zv_p
)
26649 /* This function sets the mouse_face_* elements of HLINFO, assuming
26650 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26651 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26652 for the overlay or run of text properties specifying the mouse
26653 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26654 before-string and after-string that must also be highlighted.
26655 DISP_STRING, if non-nil, is a display string that may cover some
26656 or all of the highlighted text. */
26659 mouse_face_from_buffer_pos (Lisp_Object window
,
26660 Mouse_HLInfo
*hlinfo
,
26661 ptrdiff_t mouse_charpos
,
26662 ptrdiff_t start_charpos
,
26663 ptrdiff_t end_charpos
,
26664 Lisp_Object before_string
,
26665 Lisp_Object after_string
,
26666 Lisp_Object disp_string
)
26668 struct window
*w
= XWINDOW (window
);
26669 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26670 struct glyph_row
*r1
, *r2
;
26671 struct glyph
*glyph
, *end
;
26672 ptrdiff_t ignore
, pos
;
26675 eassert (NILP (disp_string
) || STRINGP (disp_string
));
26676 eassert (NILP (before_string
) || STRINGP (before_string
));
26677 eassert (NILP (after_string
) || STRINGP (after_string
));
26679 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26680 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26682 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26683 /* If the before-string or display-string contains newlines,
26684 rows_from_pos_range skips to its last row. Move back. */
26685 if (!NILP (before_string
) || !NILP (disp_string
))
26687 struct glyph_row
*prev
;
26688 while ((prev
= r1
- 1, prev
>= first
)
26689 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26690 && prev
->used
[TEXT_AREA
] > 0)
26692 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26693 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26694 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26696 || !(EQ (glyph
->object
, before_string
)
26697 || EQ (glyph
->object
, disp_string
)))
26704 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26705 hlinfo
->mouse_face_past_end
= 1;
26707 else if (!NILP (after_string
))
26709 /* If the after-string has newlines, advance to its last row. */
26710 struct glyph_row
*next
;
26711 struct glyph_row
*last
26712 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26714 for (next
= r2
+ 1;
26716 && next
->used
[TEXT_AREA
] > 0
26717 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26721 /* The rest of the display engine assumes that mouse_face_beg_row is
26722 either above mouse_face_end_row or identical to it. But with
26723 bidi-reordered continued lines, the row for START_CHARPOS could
26724 be below the row for END_CHARPOS. If so, swap the rows and store
26725 them in correct order. */
26728 struct glyph_row
*tem
= r2
;
26734 hlinfo
->mouse_face_beg_y
= r1
->y
;
26735 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26736 hlinfo
->mouse_face_end_y
= r2
->y
;
26737 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26739 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26740 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26741 could be anywhere in the row and in any order. The strategy
26742 below is to find the leftmost and the rightmost glyph that
26743 belongs to either of these 3 strings, or whose position is
26744 between START_CHARPOS and END_CHARPOS, and highlight all the
26745 glyphs between those two. This may cover more than just the text
26746 between START_CHARPOS and END_CHARPOS if the range of characters
26747 strides the bidi level boundary, e.g. if the beginning is in R2L
26748 text while the end is in L2R text or vice versa. */
26749 if (!r1
->reversed_p
)
26751 /* This row is in a left to right paragraph. Scan it left to
26753 glyph
= r1
->glyphs
[TEXT_AREA
];
26754 end
= glyph
+ r1
->used
[TEXT_AREA
];
26757 /* Skip truncation glyphs at the start of the glyph row. */
26758 if (r1
->displays_text_p
)
26760 && INTEGERP (glyph
->object
)
26761 && glyph
->charpos
< 0;
26763 x
+= glyph
->pixel_width
;
26765 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26766 or DISP_STRING, and the first glyph from buffer whose
26767 position is between START_CHARPOS and END_CHARPOS. */
26769 && !INTEGERP (glyph
->object
)
26770 && !EQ (glyph
->object
, disp_string
)
26771 && !(BUFFERP (glyph
->object
)
26772 && (glyph
->charpos
>= start_charpos
26773 && glyph
->charpos
< end_charpos
));
26776 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26777 are present at buffer positions between START_CHARPOS and
26778 END_CHARPOS, or if they come from an overlay. */
26779 if (EQ (glyph
->object
, before_string
))
26781 pos
= string_buffer_position (before_string
,
26783 /* If pos == 0, it means before_string came from an
26784 overlay, not from a buffer position. */
26785 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26788 else if (EQ (glyph
->object
, after_string
))
26790 pos
= string_buffer_position (after_string
, end_charpos
);
26791 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26794 x
+= glyph
->pixel_width
;
26796 hlinfo
->mouse_face_beg_x
= x
;
26797 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26801 /* This row is in a right to left paragraph. Scan it right to
26805 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26806 glyph
= end
+ r1
->used
[TEXT_AREA
];
26808 /* Skip truncation glyphs at the start of the glyph row. */
26809 if (r1
->displays_text_p
)
26811 && INTEGERP (glyph
->object
)
26812 && glyph
->charpos
< 0;
26816 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26817 or DISP_STRING, and the first glyph from buffer whose
26818 position is between START_CHARPOS and END_CHARPOS. */
26820 && !INTEGERP (glyph
->object
)
26821 && !EQ (glyph
->object
, disp_string
)
26822 && !(BUFFERP (glyph
->object
)
26823 && (glyph
->charpos
>= start_charpos
26824 && glyph
->charpos
< end_charpos
));
26827 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26828 are present at buffer positions between START_CHARPOS and
26829 END_CHARPOS, or if they come from an overlay. */
26830 if (EQ (glyph
->object
, before_string
))
26832 pos
= string_buffer_position (before_string
, start_charpos
);
26833 /* If pos == 0, it means before_string came from an
26834 overlay, not from a buffer position. */
26835 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26838 else if (EQ (glyph
->object
, after_string
))
26840 pos
= string_buffer_position (after_string
, end_charpos
);
26841 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26846 glyph
++; /* first glyph to the right of the highlighted area */
26847 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26848 x
+= g
->pixel_width
;
26849 hlinfo
->mouse_face_beg_x
= x
;
26850 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26853 /* If the highlight ends in a different row, compute GLYPH and END
26854 for the end row. Otherwise, reuse the values computed above for
26855 the row where the highlight begins. */
26858 if (!r2
->reversed_p
)
26860 glyph
= r2
->glyphs
[TEXT_AREA
];
26861 end
= glyph
+ r2
->used
[TEXT_AREA
];
26866 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26867 glyph
= end
+ r2
->used
[TEXT_AREA
];
26871 if (!r2
->reversed_p
)
26873 /* Skip truncation and continuation glyphs near the end of the
26874 row, and also blanks and stretch glyphs inserted by
26875 extend_face_to_end_of_line. */
26877 && INTEGERP ((end
- 1)->object
))
26879 /* Scan the rest of the glyph row from the end, looking for the
26880 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26881 DISP_STRING, or whose position is between START_CHARPOS
26885 && !INTEGERP (end
->object
)
26886 && !EQ (end
->object
, disp_string
)
26887 && !(BUFFERP (end
->object
)
26888 && (end
->charpos
>= start_charpos
26889 && end
->charpos
< end_charpos
));
26892 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26893 are present at buffer positions between START_CHARPOS and
26894 END_CHARPOS, or if they come from an overlay. */
26895 if (EQ (end
->object
, before_string
))
26897 pos
= string_buffer_position (before_string
, start_charpos
);
26898 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26901 else if (EQ (end
->object
, after_string
))
26903 pos
= string_buffer_position (after_string
, end_charpos
);
26904 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26908 /* Find the X coordinate of the last glyph to be highlighted. */
26909 for (; glyph
<= end
; ++glyph
)
26910 x
+= glyph
->pixel_width
;
26912 hlinfo
->mouse_face_end_x
= x
;
26913 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26917 /* Skip truncation and continuation glyphs near the end of the
26918 row, and also blanks and stretch glyphs inserted by
26919 extend_face_to_end_of_line. */
26923 && INTEGERP (end
->object
))
26925 x
+= end
->pixel_width
;
26928 /* Scan the rest of the glyph row from the end, looking for the
26929 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26930 DISP_STRING, or whose position is between START_CHARPOS
26934 && !INTEGERP (end
->object
)
26935 && !EQ (end
->object
, disp_string
)
26936 && !(BUFFERP (end
->object
)
26937 && (end
->charpos
>= start_charpos
26938 && end
->charpos
< end_charpos
));
26941 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26942 are present at buffer positions between START_CHARPOS and
26943 END_CHARPOS, or if they come from an overlay. */
26944 if (EQ (end
->object
, before_string
))
26946 pos
= string_buffer_position (before_string
, start_charpos
);
26947 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26950 else if (EQ (end
->object
, after_string
))
26952 pos
= string_buffer_position (after_string
, end_charpos
);
26953 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26956 x
+= end
->pixel_width
;
26958 /* If we exited the above loop because we arrived at the last
26959 glyph of the row, and its buffer position is still not in
26960 range, it means the last character in range is the preceding
26961 newline. Bump the end column and x values to get past the
26964 && BUFFERP (end
->object
)
26965 && (end
->charpos
< start_charpos
26966 || end
->charpos
>= end_charpos
))
26968 x
+= end
->pixel_width
;
26971 hlinfo
->mouse_face_end_x
= x
;
26972 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26975 hlinfo
->mouse_face_window
= window
;
26976 hlinfo
->mouse_face_face_id
26977 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26979 !hlinfo
->mouse_face_hidden
, -1);
26980 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26983 /* The following function is not used anymore (replaced with
26984 mouse_face_from_string_pos), but I leave it here for the time
26985 being, in case someone would. */
26987 #if 0 /* not used */
26989 /* Find the position of the glyph for position POS in OBJECT in
26990 window W's current matrix, and return in *X, *Y the pixel
26991 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26993 RIGHT_P non-zero means return the position of the right edge of the
26994 glyph, RIGHT_P zero means return the left edge position.
26996 If no glyph for POS exists in the matrix, return the position of
26997 the glyph with the next smaller position that is in the matrix, if
26998 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26999 exists in the matrix, return the position of the glyph with the
27000 next larger position in OBJECT.
27002 Value is non-zero if a glyph was found. */
27005 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
27006 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
27008 int yb
= window_text_bottom_y (w
);
27009 struct glyph_row
*r
;
27010 struct glyph
*best_glyph
= NULL
;
27011 struct glyph_row
*best_row
= NULL
;
27014 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27015 r
->enabled_p
&& r
->y
< yb
;
27018 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
27019 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
27022 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27023 if (EQ (g
->object
, object
))
27025 if (g
->charpos
== pos
)
27032 else if (best_glyph
== NULL
27033 || ((eabs (g
->charpos
- pos
)
27034 < eabs (best_glyph
->charpos
- pos
))
27037 : g
->charpos
> pos
)))
27051 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
27055 *x
+= best_glyph
->pixel_width
;
27060 *vpos
= best_row
- w
->current_matrix
->rows
;
27063 return best_glyph
!= NULL
;
27065 #endif /* not used */
27067 /* Find the positions of the first and the last glyphs in window W's
27068 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
27069 (assumed to be a string), and return in HLINFO's mouse_face_*
27070 members the pixel and column/row coordinates of those glyphs. */
27073 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
27074 Lisp_Object object
,
27075 ptrdiff_t startpos
, ptrdiff_t endpos
)
27077 int yb
= window_text_bottom_y (w
);
27078 struct glyph_row
*r
;
27079 struct glyph
*g
, *e
;
27083 /* Find the glyph row with at least one position in the range
27084 [STARTPOS..ENDPOS], and the first glyph in that row whose
27085 position belongs to that range. */
27086 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27087 r
->enabled_p
&& r
->y
< yb
;
27090 if (!r
->reversed_p
)
27092 g
= r
->glyphs
[TEXT_AREA
];
27093 e
= g
+ r
->used
[TEXT_AREA
];
27094 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27095 if (EQ (g
->object
, object
)
27096 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27098 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27099 hlinfo
->mouse_face_beg_y
= r
->y
;
27100 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27101 hlinfo
->mouse_face_beg_x
= gx
;
27110 e
= r
->glyphs
[TEXT_AREA
];
27111 g
= e
+ r
->used
[TEXT_AREA
];
27112 for ( ; g
> e
; --g
)
27113 if (EQ ((g
-1)->object
, object
)
27114 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
27116 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27117 hlinfo
->mouse_face_beg_y
= r
->y
;
27118 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27119 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
27120 gx
+= g1
->pixel_width
;
27121 hlinfo
->mouse_face_beg_x
= gx
;
27133 /* Starting with the next row, look for the first row which does NOT
27134 include any glyphs whose positions are in the range. */
27135 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
27137 g
= r
->glyphs
[TEXT_AREA
];
27138 e
= g
+ r
->used
[TEXT_AREA
];
27140 for ( ; g
< e
; ++g
)
27141 if (EQ (g
->object
, object
)
27142 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27151 /* The highlighted region ends on the previous row. */
27154 /* Set the end row and its vertical pixel coordinate. */
27155 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
27156 hlinfo
->mouse_face_end_y
= r
->y
;
27158 /* Compute and set the end column and the end column's horizontal
27159 pixel coordinate. */
27160 if (!r
->reversed_p
)
27162 g
= r
->glyphs
[TEXT_AREA
];
27163 e
= g
+ r
->used
[TEXT_AREA
];
27164 for ( ; e
> g
; --e
)
27165 if (EQ ((e
-1)->object
, object
)
27166 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
27168 hlinfo
->mouse_face_end_col
= e
- g
;
27170 for (gx
= r
->x
; g
< e
; ++g
)
27171 gx
+= g
->pixel_width
;
27172 hlinfo
->mouse_face_end_x
= gx
;
27176 e
= r
->glyphs
[TEXT_AREA
];
27177 g
= e
+ r
->used
[TEXT_AREA
];
27178 for (gx
= r
->x
; e
< g
; ++e
)
27180 if (EQ (e
->object
, object
)
27181 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
27183 gx
+= e
->pixel_width
;
27185 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
27186 hlinfo
->mouse_face_end_x
= gx
;
27190 #ifdef HAVE_WINDOW_SYSTEM
27192 /* See if position X, Y is within a hot-spot of an image. */
27195 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
27197 if (!CONSP (hot_spot
))
27200 if (EQ (XCAR (hot_spot
), Qrect
))
27202 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27203 Lisp_Object rect
= XCDR (hot_spot
);
27207 if (!CONSP (XCAR (rect
)))
27209 if (!CONSP (XCDR (rect
)))
27211 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
27213 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
27215 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
27217 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
27221 else if (EQ (XCAR (hot_spot
), Qcircle
))
27223 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27224 Lisp_Object circ
= XCDR (hot_spot
);
27225 Lisp_Object lr
, lx0
, ly0
;
27227 && CONSP (XCAR (circ
))
27228 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
27229 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
27230 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
27232 double r
= XFLOATINT (lr
);
27233 double dx
= XINT (lx0
) - x
;
27234 double dy
= XINT (ly0
) - y
;
27235 return (dx
* dx
+ dy
* dy
<= r
* r
);
27238 else if (EQ (XCAR (hot_spot
), Qpoly
))
27240 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27241 if (VECTORP (XCDR (hot_spot
)))
27243 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
27244 Lisp_Object
*poly
= v
->contents
;
27245 ptrdiff_t n
= v
->header
.size
;
27248 Lisp_Object lx
, ly
;
27251 /* Need an even number of coordinates, and at least 3 edges. */
27252 if (n
< 6 || n
& 1)
27255 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27256 If count is odd, we are inside polygon. Pixels on edges
27257 may or may not be included depending on actual geometry of the
27259 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
27260 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
27262 x0
= XINT (lx
), y0
= XINT (ly
);
27263 for (i
= 0; i
< n
; i
+= 2)
27265 int x1
= x0
, y1
= y0
;
27266 if ((lx
= poly
[i
], !INTEGERP (lx
))
27267 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
27269 x0
= XINT (lx
), y0
= XINT (ly
);
27271 /* Does this segment cross the X line? */
27279 if (y
> y0
&& y
> y1
)
27281 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
27291 find_hot_spot (Lisp_Object map
, int x
, int y
)
27293 while (CONSP (map
))
27295 if (CONSP (XCAR (map
))
27296 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
27304 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
27306 doc
: /* Lookup in image map MAP coordinates X and Y.
27307 An image map is an alist where each element has the format (AREA ID PLIST).
27308 An AREA is specified as either a rectangle, a circle, or a polygon:
27309 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27310 pixel coordinates of the upper left and bottom right corners.
27311 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27312 and the radius of the circle; r may be a float or integer.
27313 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27314 vector describes one corner in the polygon.
27315 Returns the alist element for the first matching AREA in MAP. */)
27316 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
27324 return find_hot_spot (map
,
27325 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
27326 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
27330 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27332 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
27334 /* Do not change cursor shape while dragging mouse. */
27335 if (!NILP (do_mouse_tracking
))
27338 if (!NILP (pointer
))
27340 if (EQ (pointer
, Qarrow
))
27341 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27342 else if (EQ (pointer
, Qhand
))
27343 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27344 else if (EQ (pointer
, Qtext
))
27345 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27346 else if (EQ (pointer
, intern ("hdrag")))
27347 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27348 #ifdef HAVE_X_WINDOWS
27349 else if (EQ (pointer
, intern ("vdrag")))
27350 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27352 else if (EQ (pointer
, intern ("hourglass")))
27353 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27354 else if (EQ (pointer
, Qmodeline
))
27355 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27357 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27360 if (cursor
!= No_Cursor
)
27361 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27364 #endif /* HAVE_WINDOW_SYSTEM */
27366 /* Take proper action when mouse has moved to the mode or header line
27367 or marginal area AREA of window W, x-position X and y-position Y.
27368 X is relative to the start of the text display area of W, so the
27369 width of bitmap areas and scroll bars must be subtracted to get a
27370 position relative to the start of the mode line. */
27373 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27374 enum window_part area
)
27376 struct window
*w
= XWINDOW (window
);
27377 struct frame
*f
= XFRAME (w
->frame
);
27378 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27379 #ifdef HAVE_WINDOW_SYSTEM
27380 Display_Info
*dpyinfo
;
27382 Cursor cursor
= No_Cursor
;
27383 Lisp_Object pointer
= Qnil
;
27384 int dx
, dy
, width
, height
;
27386 Lisp_Object string
, object
= Qnil
;
27387 Lisp_Object pos
IF_LINT (= Qnil
), help
;
27389 Lisp_Object mouse_face
;
27390 int original_x_pixel
= x
;
27391 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27392 struct glyph_row
*row
IF_LINT (= 0);
27394 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27399 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27400 returns them in row/column units! */
27401 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27402 &object
, &dx
, &dy
, &width
, &height
);
27404 row
= (area
== ON_MODE_LINE
27405 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27406 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27408 /* Find the glyph under the mouse pointer. */
27409 if (row
->mode_line_p
&& row
->enabled_p
)
27411 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27412 end
= glyph
+ row
->used
[TEXT_AREA
];
27414 for (x0
= original_x_pixel
;
27415 glyph
< end
&& x0
>= glyph
->pixel_width
;
27417 x0
-= glyph
->pixel_width
;
27425 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27426 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27427 returns them in row/column units! */
27428 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27429 &object
, &dx
, &dy
, &width
, &height
);
27434 #ifdef HAVE_WINDOW_SYSTEM
27435 if (IMAGEP (object
))
27437 Lisp_Object image_map
, hotspot
;
27438 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27440 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27442 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27446 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27447 If so, we could look for mouse-enter, mouse-leave
27448 properties in PLIST (and do something...). */
27449 hotspot
= XCDR (hotspot
);
27450 if (CONSP (hotspot
)
27451 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27453 pointer
= Fplist_get (plist
, Qpointer
);
27454 if (NILP (pointer
))
27456 help
= Fplist_get (plist
, Qhelp_echo
);
27459 help_echo_string
= help
;
27460 XSETWINDOW (help_echo_window
, w
);
27461 help_echo_object
= w
->buffer
;
27462 help_echo_pos
= charpos
;
27466 if (NILP (pointer
))
27467 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27469 #endif /* HAVE_WINDOW_SYSTEM */
27471 if (STRINGP (string
))
27472 pos
= make_number (charpos
);
27474 /* Set the help text and mouse pointer. If the mouse is on a part
27475 of the mode line without any text (e.g. past the right edge of
27476 the mode line text), use the default help text and pointer. */
27477 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27479 /* Arrange to display the help by setting the global variables
27480 help_echo_string, help_echo_object, and help_echo_pos. */
27483 if (STRINGP (string
))
27484 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27488 help_echo_string
= help
;
27489 XSETWINDOW (help_echo_window
, w
);
27490 help_echo_object
= string
;
27491 help_echo_pos
= charpos
;
27493 else if (area
== ON_MODE_LINE
)
27495 Lisp_Object default_help
27496 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27499 if (STRINGP (default_help
))
27501 help_echo_string
= default_help
;
27502 XSETWINDOW (help_echo_window
, w
);
27503 help_echo_object
= Qnil
;
27504 help_echo_pos
= -1;
27509 #ifdef HAVE_WINDOW_SYSTEM
27510 /* Change the mouse pointer according to what is under it. */
27511 if (FRAME_WINDOW_P (f
))
27513 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27514 if (STRINGP (string
))
27516 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27518 if (NILP (pointer
))
27519 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27521 /* Change the mouse pointer according to what is under X/Y. */
27523 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27526 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27527 if (!KEYMAPP (map
))
27528 map
= Fget_text_property (pos
, Qkeymap
, string
);
27529 if (!KEYMAPP (map
))
27530 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27534 /* Default mode-line pointer. */
27535 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27540 /* Change the mouse face according to what is under X/Y. */
27541 if (STRINGP (string
))
27543 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27544 if (!NILP (mouse_face
)
27545 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27550 struct glyph
* tmp_glyph
;
27554 int total_pixel_width
;
27555 ptrdiff_t begpos
, endpos
, ignore
;
27559 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27560 Qmouse_face
, string
, Qnil
);
27566 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27568 endpos
= SCHARS (string
);
27572 /* Calculate the glyph position GPOS of GLYPH in the
27573 displayed string, relative to the beginning of the
27574 highlighted part of the string.
27576 Note: GPOS is different from CHARPOS. CHARPOS is the
27577 position of GLYPH in the internal string object. A mode
27578 line string format has structures which are converted to
27579 a flattened string by the Emacs Lisp interpreter. The
27580 internal string is an element of those structures. The
27581 displayed string is the flattened string. */
27582 tmp_glyph
= row_start_glyph
;
27583 while (tmp_glyph
< glyph
27584 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27585 && begpos
<= tmp_glyph
->charpos
27586 && tmp_glyph
->charpos
< endpos
)))
27588 gpos
= glyph
- tmp_glyph
;
27590 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27591 the highlighted part of the displayed string to which
27592 GLYPH belongs. Note: GSEQ_LENGTH is different from
27593 SCHARS (STRING), because the latter returns the length of
27594 the internal string. */
27595 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27597 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27598 && begpos
<= tmp_glyph
->charpos
27599 && tmp_glyph
->charpos
< endpos
));
27602 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27604 /* Calculate the total pixel width of all the glyphs between
27605 the beginning of the highlighted area and GLYPH. */
27606 total_pixel_width
= 0;
27607 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27608 total_pixel_width
+= tmp_glyph
->pixel_width
;
27610 /* Pre calculation of re-rendering position. Note: X is in
27611 column units here, after the call to mode_line_string or
27612 marginal_area_string. */
27614 vpos
= (area
== ON_MODE_LINE
27615 ? (w
->current_matrix
)->nrows
- 1
27618 /* If GLYPH's position is included in the region that is
27619 already drawn in mouse face, we have nothing to do. */
27620 if ( EQ (window
, hlinfo
->mouse_face_window
)
27621 && (!row
->reversed_p
27622 ? (hlinfo
->mouse_face_beg_col
<= hpos
27623 && hpos
< hlinfo
->mouse_face_end_col
)
27624 /* In R2L rows we swap BEG and END, see below. */
27625 : (hlinfo
->mouse_face_end_col
<= hpos
27626 && hpos
< hlinfo
->mouse_face_beg_col
))
27627 && hlinfo
->mouse_face_beg_row
== vpos
)
27630 if (clear_mouse_face (hlinfo
))
27631 cursor
= No_Cursor
;
27633 if (!row
->reversed_p
)
27635 hlinfo
->mouse_face_beg_col
= hpos
;
27636 hlinfo
->mouse_face_beg_x
= original_x_pixel
27637 - (total_pixel_width
+ dx
);
27638 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27639 hlinfo
->mouse_face_end_x
= 0;
27643 /* In R2L rows, show_mouse_face expects BEG and END
27644 coordinates to be swapped. */
27645 hlinfo
->mouse_face_end_col
= hpos
;
27646 hlinfo
->mouse_face_end_x
= original_x_pixel
27647 - (total_pixel_width
+ dx
);
27648 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27649 hlinfo
->mouse_face_beg_x
= 0;
27652 hlinfo
->mouse_face_beg_row
= vpos
;
27653 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27654 hlinfo
->mouse_face_beg_y
= 0;
27655 hlinfo
->mouse_face_end_y
= 0;
27656 hlinfo
->mouse_face_past_end
= 0;
27657 hlinfo
->mouse_face_window
= window
;
27659 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27665 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27667 if (NILP (pointer
))
27670 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27671 clear_mouse_face (hlinfo
);
27673 #ifdef HAVE_WINDOW_SYSTEM
27674 if (FRAME_WINDOW_P (f
))
27675 define_frame_cursor1 (f
, cursor
, pointer
);
27681 Take proper action when the mouse has moved to position X, Y on
27682 frame F as regards highlighting characters that have mouse-face
27683 properties. Also de-highlighting chars where the mouse was before.
27684 X and Y can be negative or out of range. */
27687 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27689 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27690 enum window_part part
= ON_NOTHING
;
27691 Lisp_Object window
;
27693 Cursor cursor
= No_Cursor
;
27694 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27697 /* When a menu is active, don't highlight because this looks odd. */
27698 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27699 if (popup_activated ())
27703 if (NILP (Vmouse_highlight
)
27704 || !f
->glyphs_initialized_p
27705 || f
->pointer_invisible
)
27708 hlinfo
->mouse_face_mouse_x
= x
;
27709 hlinfo
->mouse_face_mouse_y
= y
;
27710 hlinfo
->mouse_face_mouse_frame
= f
;
27712 if (hlinfo
->mouse_face_defer
)
27715 /* Which window is that in? */
27716 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27718 /* If displaying active text in another window, clear that. */
27719 if (! EQ (window
, hlinfo
->mouse_face_window
)
27720 /* Also clear if we move out of text area in same window. */
27721 || (!NILP (hlinfo
->mouse_face_window
)
27724 && part
!= ON_MODE_LINE
27725 && part
!= ON_HEADER_LINE
))
27726 clear_mouse_face (hlinfo
);
27728 /* Not on a window -> return. */
27729 if (!WINDOWP (window
))
27732 /* Reset help_echo_string. It will get recomputed below. */
27733 help_echo_string
= Qnil
;
27735 /* Convert to window-relative pixel coordinates. */
27736 w
= XWINDOW (window
);
27737 frame_to_window_pixel_xy (w
, &x
, &y
);
27739 #ifdef HAVE_WINDOW_SYSTEM
27740 /* Handle tool-bar window differently since it doesn't display a
27742 if (EQ (window
, f
->tool_bar_window
))
27744 note_tool_bar_highlight (f
, x
, y
);
27749 /* Mouse is on the mode, header line or margin? */
27750 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27751 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27753 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27757 #ifdef HAVE_WINDOW_SYSTEM
27758 if (part
== ON_VERTICAL_BORDER
)
27760 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27761 help_echo_string
= build_string ("drag-mouse-1: resize");
27763 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27764 || part
== ON_SCROLL_BAR
)
27765 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27767 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27770 /* Are we in a window whose display is up to date?
27771 And verify the buffer's text has not changed. */
27772 b
= XBUFFER (w
->buffer
);
27773 if (part
== ON_TEXT
27774 && EQ (w
->window_end_valid
, w
->buffer
)
27775 && w
->last_modified
== BUF_MODIFF (b
)
27776 && w
->last_overlay_modified
== BUF_OVERLAY_MODIFF (b
))
27778 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27780 struct glyph
*glyph
;
27781 Lisp_Object object
;
27782 Lisp_Object mouse_face
= Qnil
, position
;
27783 Lisp_Object
*overlay_vec
= NULL
;
27784 ptrdiff_t i
, noverlays
;
27785 struct buffer
*obuf
;
27786 ptrdiff_t obegv
, ozv
;
27789 /* Find the glyph under X/Y. */
27790 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27792 #ifdef HAVE_WINDOW_SYSTEM
27793 /* Look for :pointer property on image. */
27794 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27796 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27797 if (img
!= NULL
&& IMAGEP (img
->spec
))
27799 Lisp_Object image_map
, hotspot
;
27800 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27802 && (hotspot
= find_hot_spot (image_map
,
27803 glyph
->slice
.img
.x
+ dx
,
27804 glyph
->slice
.img
.y
+ dy
),
27806 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27810 /* Could check XCAR (hotspot) to see if we enter/leave
27812 If so, we could look for mouse-enter, mouse-leave
27813 properties in PLIST (and do something...). */
27814 hotspot
= XCDR (hotspot
);
27815 if (CONSP (hotspot
)
27816 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27818 pointer
= Fplist_get (plist
, Qpointer
);
27819 if (NILP (pointer
))
27821 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27822 if (!NILP (help_echo_string
))
27824 help_echo_window
= window
;
27825 help_echo_object
= glyph
->object
;
27826 help_echo_pos
= glyph
->charpos
;
27830 if (NILP (pointer
))
27831 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27834 #endif /* HAVE_WINDOW_SYSTEM */
27836 /* Clear mouse face if X/Y not over text. */
27838 || area
!= TEXT_AREA
27839 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27840 /* Glyph's OBJECT is an integer for glyphs inserted by the
27841 display engine for its internal purposes, like truncation
27842 and continuation glyphs and blanks beyond the end of
27843 line's text on text terminals. If we are over such a
27844 glyph, we are not over any text. */
27845 || INTEGERP (glyph
->object
)
27846 /* R2L rows have a stretch glyph at their front, which
27847 stands for no text, whereas L2R rows have no glyphs at
27848 all beyond the end of text. Treat such stretch glyphs
27849 like we do with NULL glyphs in L2R rows. */
27850 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27851 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27852 && glyph
->type
== STRETCH_GLYPH
27853 && glyph
->avoid_cursor_p
))
27855 if (clear_mouse_face (hlinfo
))
27856 cursor
= No_Cursor
;
27857 #ifdef HAVE_WINDOW_SYSTEM
27858 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27860 if (area
!= TEXT_AREA
)
27861 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27863 pointer
= Vvoid_text_area_pointer
;
27869 pos
= glyph
->charpos
;
27870 object
= glyph
->object
;
27871 if (!STRINGP (object
) && !BUFFERP (object
))
27874 /* If we get an out-of-range value, return now; avoid an error. */
27875 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27878 /* Make the window's buffer temporarily current for
27879 overlays_at and compute_char_face. */
27880 obuf
= current_buffer
;
27881 current_buffer
= b
;
27887 /* Is this char mouse-active or does it have help-echo? */
27888 position
= make_number (pos
);
27890 if (BUFFERP (object
))
27892 /* Put all the overlays we want in a vector in overlay_vec. */
27893 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27894 /* Sort overlays into increasing priority order. */
27895 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27900 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27903 cursor
= No_Cursor
;
27905 /* Check mouse-face highlighting. */
27907 /* If there exists an overlay with mouse-face overlapping
27908 the one we are currently highlighting, we have to
27909 check if we enter the overlapping overlay, and then
27910 highlight only that. */
27911 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27912 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27914 /* Find the highest priority overlay with a mouse-face. */
27915 Lisp_Object overlay
= Qnil
;
27916 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27918 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27919 if (!NILP (mouse_face
))
27920 overlay
= overlay_vec
[i
];
27923 /* If we're highlighting the same overlay as before, there's
27924 no need to do that again. */
27925 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27926 goto check_help_echo
;
27927 hlinfo
->mouse_face_overlay
= overlay
;
27929 /* Clear the display of the old active region, if any. */
27930 if (clear_mouse_face (hlinfo
))
27931 cursor
= No_Cursor
;
27933 /* If no overlay applies, get a text property. */
27934 if (NILP (overlay
))
27935 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27937 /* Next, compute the bounds of the mouse highlighting and
27939 if (!NILP (mouse_face
) && STRINGP (object
))
27941 /* The mouse-highlighting comes from a display string
27942 with a mouse-face. */
27946 s
= Fprevious_single_property_change
27947 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27948 e
= Fnext_single_property_change
27949 (position
, Qmouse_face
, object
, Qnil
);
27951 s
= make_number (0);
27953 e
= make_number (SCHARS (object
) - 1);
27954 mouse_face_from_string_pos (w
, hlinfo
, object
,
27955 XINT (s
), XINT (e
));
27956 hlinfo
->mouse_face_past_end
= 0;
27957 hlinfo
->mouse_face_window
= window
;
27958 hlinfo
->mouse_face_face_id
27959 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27960 glyph
->face_id
, 1);
27961 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27962 cursor
= No_Cursor
;
27966 /* The mouse-highlighting, if any, comes from an overlay
27967 or text property in the buffer. */
27968 Lisp_Object buffer
IF_LINT (= Qnil
);
27969 Lisp_Object disp_string
IF_LINT (= Qnil
);
27971 if (STRINGP (object
))
27973 /* If we are on a display string with no mouse-face,
27974 check if the text under it has one. */
27975 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27976 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27977 pos
= string_buffer_position (object
, start
);
27980 mouse_face
= get_char_property_and_overlay
27981 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27982 buffer
= w
->buffer
;
27983 disp_string
= object
;
27989 disp_string
= Qnil
;
27992 if (!NILP (mouse_face
))
27994 Lisp_Object before
, after
;
27995 Lisp_Object before_string
, after_string
;
27996 /* To correctly find the limits of mouse highlight
27997 in a bidi-reordered buffer, we must not use the
27998 optimization of limiting the search in
27999 previous-single-property-change and
28000 next-single-property-change, because
28001 rows_from_pos_range needs the real start and end
28002 positions to DTRT in this case. That's because
28003 the first row visible in a window does not
28004 necessarily display the character whose position
28005 is the smallest. */
28007 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
28008 ? Fmarker_position (w
->start
)
28011 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
28012 ? make_number (BUF_Z (XBUFFER (buffer
))
28013 - XFASTINT (w
->window_end_pos
))
28016 if (NILP (overlay
))
28018 /* Handle the text property case. */
28019 before
= Fprevious_single_property_change
28020 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
28021 after
= Fnext_single_property_change
28022 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
28023 before_string
= after_string
= Qnil
;
28027 /* Handle the overlay case. */
28028 before
= Foverlay_start (overlay
);
28029 after
= Foverlay_end (overlay
);
28030 before_string
= Foverlay_get (overlay
, Qbefore_string
);
28031 after_string
= Foverlay_get (overlay
, Qafter_string
);
28033 if (!STRINGP (before_string
)) before_string
= Qnil
;
28034 if (!STRINGP (after_string
)) after_string
= Qnil
;
28037 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
28040 : XFASTINT (before
),
28042 ? BUF_Z (XBUFFER (buffer
))
28043 : XFASTINT (after
),
28044 before_string
, after_string
,
28046 cursor
= No_Cursor
;
28053 /* Look for a `help-echo' property. */
28054 if (NILP (help_echo_string
)) {
28055 Lisp_Object help
, overlay
;
28057 /* Check overlays first. */
28058 help
= overlay
= Qnil
;
28059 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
28061 overlay
= overlay_vec
[i
];
28062 help
= Foverlay_get (overlay
, Qhelp_echo
);
28067 help_echo_string
= help
;
28068 help_echo_window
= window
;
28069 help_echo_object
= overlay
;
28070 help_echo_pos
= pos
;
28074 Lisp_Object obj
= glyph
->object
;
28075 ptrdiff_t charpos
= glyph
->charpos
;
28077 /* Try text properties. */
28080 && charpos
< SCHARS (obj
))
28082 help
= Fget_text_property (make_number (charpos
),
28086 /* If the string itself doesn't specify a help-echo,
28087 see if the buffer text ``under'' it does. */
28088 struct glyph_row
*r
28089 = MATRIX_ROW (w
->current_matrix
, vpos
);
28090 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28091 ptrdiff_t p
= string_buffer_position (obj
, start
);
28094 help
= Fget_char_property (make_number (p
),
28095 Qhelp_echo
, w
->buffer
);
28104 else if (BUFFERP (obj
)
28107 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
28112 help_echo_string
= help
;
28113 help_echo_window
= window
;
28114 help_echo_object
= obj
;
28115 help_echo_pos
= charpos
;
28120 #ifdef HAVE_WINDOW_SYSTEM
28121 /* Look for a `pointer' property. */
28122 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28124 /* Check overlays first. */
28125 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
28126 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
28128 if (NILP (pointer
))
28130 Lisp_Object obj
= glyph
->object
;
28131 ptrdiff_t charpos
= glyph
->charpos
;
28133 /* Try text properties. */
28136 && charpos
< SCHARS (obj
))
28138 pointer
= Fget_text_property (make_number (charpos
),
28140 if (NILP (pointer
))
28142 /* If the string itself doesn't specify a pointer,
28143 see if the buffer text ``under'' it does. */
28144 struct glyph_row
*r
28145 = MATRIX_ROW (w
->current_matrix
, vpos
);
28146 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28147 ptrdiff_t p
= string_buffer_position (obj
, start
);
28149 pointer
= Fget_char_property (make_number (p
),
28150 Qpointer
, w
->buffer
);
28153 else if (BUFFERP (obj
)
28156 pointer
= Fget_text_property (make_number (charpos
),
28160 #endif /* HAVE_WINDOW_SYSTEM */
28164 current_buffer
= obuf
;
28169 #ifdef HAVE_WINDOW_SYSTEM
28170 if (FRAME_WINDOW_P (f
))
28171 define_frame_cursor1 (f
, cursor
, pointer
);
28173 /* This is here to prevent a compiler error, about "label at end of
28174 compound statement". */
28181 Clear any mouse-face on window W. This function is part of the
28182 redisplay interface, and is called from try_window_id and similar
28183 functions to ensure the mouse-highlight is off. */
28186 x_clear_window_mouse_face (struct window
*w
)
28188 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28189 Lisp_Object window
;
28192 XSETWINDOW (window
, w
);
28193 if (EQ (window
, hlinfo
->mouse_face_window
))
28194 clear_mouse_face (hlinfo
);
28200 Just discard the mouse face information for frame F, if any.
28201 This is used when the size of F is changed. */
28204 cancel_mouse_face (struct frame
*f
)
28206 Lisp_Object window
;
28207 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28209 window
= hlinfo
->mouse_face_window
;
28210 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
28212 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28213 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28214 hlinfo
->mouse_face_window
= Qnil
;
28220 /***********************************************************************
28222 ***********************************************************************/
28224 #ifdef HAVE_WINDOW_SYSTEM
28226 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28227 which intersects rectangle R. R is in window-relative coordinates. */
28230 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
28231 enum glyph_row_area area
)
28233 struct glyph
*first
= row
->glyphs
[area
];
28234 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
28235 struct glyph
*last
;
28236 int first_x
, start_x
, x
;
28238 if (area
== TEXT_AREA
&& row
->fill_line_p
)
28239 /* If row extends face to end of line write the whole line. */
28240 draw_glyphs (w
, 0, row
, area
,
28241 0, row
->used
[area
],
28242 DRAW_NORMAL_TEXT
, 0);
28245 /* Set START_X to the window-relative start position for drawing glyphs of
28246 AREA. The first glyph of the text area can be partially visible.
28247 The first glyphs of other areas cannot. */
28248 start_x
= window_box_left_offset (w
, area
);
28250 if (area
== TEXT_AREA
)
28253 /* Find the first glyph that must be redrawn. */
28255 && x
+ first
->pixel_width
< r
->x
)
28257 x
+= first
->pixel_width
;
28261 /* Find the last one. */
28265 && x
< r
->x
+ r
->width
)
28267 x
+= last
->pixel_width
;
28273 draw_glyphs (w
, first_x
- start_x
, row
, area
,
28274 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
28275 DRAW_NORMAL_TEXT
, 0);
28280 /* Redraw the parts of the glyph row ROW on window W intersecting
28281 rectangle R. R is in window-relative coordinates. Value is
28282 non-zero if mouse-face was overwritten. */
28285 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
28287 eassert (row
->enabled_p
);
28289 if (row
->mode_line_p
|| w
->pseudo_window_p
)
28290 draw_glyphs (w
, 0, row
, TEXT_AREA
,
28291 0, row
->used
[TEXT_AREA
],
28292 DRAW_NORMAL_TEXT
, 0);
28295 if (row
->used
[LEFT_MARGIN_AREA
])
28296 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
28297 if (row
->used
[TEXT_AREA
])
28298 expose_area (w
, row
, r
, TEXT_AREA
);
28299 if (row
->used
[RIGHT_MARGIN_AREA
])
28300 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
28301 draw_row_fringe_bitmaps (w
, row
);
28304 return row
->mouse_face_p
;
28308 /* Redraw those parts of glyphs rows during expose event handling that
28309 overlap other rows. Redrawing of an exposed line writes over parts
28310 of lines overlapping that exposed line; this function fixes that.
28312 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28313 row in W's current matrix that is exposed and overlaps other rows.
28314 LAST_OVERLAPPING_ROW is the last such row. */
28317 expose_overlaps (struct window
*w
,
28318 struct glyph_row
*first_overlapping_row
,
28319 struct glyph_row
*last_overlapping_row
,
28322 struct glyph_row
*row
;
28324 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
28325 if (row
->overlapping_p
)
28327 eassert (row
->enabled_p
&& !row
->mode_line_p
);
28330 if (row
->used
[LEFT_MARGIN_AREA
])
28331 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
28333 if (row
->used
[TEXT_AREA
])
28334 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
28336 if (row
->used
[RIGHT_MARGIN_AREA
])
28337 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
28343 /* Return non-zero if W's cursor intersects rectangle R. */
28346 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
28348 XRectangle cr
, result
;
28349 struct glyph
*cursor_glyph
;
28350 struct glyph_row
*row
;
28352 if (w
->phys_cursor
.vpos
>= 0
28353 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
28354 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
28356 && row
->cursor_in_fringe_p
)
28358 /* Cursor is in the fringe. */
28359 cr
.x
= window_box_right_offset (w
,
28360 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
28361 ? RIGHT_MARGIN_AREA
28364 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
28365 cr
.height
= row
->height
;
28366 return x_intersect_rectangles (&cr
, r
, &result
);
28369 cursor_glyph
= get_phys_cursor_glyph (w
);
28372 /* r is relative to W's box, but w->phys_cursor.x is relative
28373 to left edge of W's TEXT area. Adjust it. */
28374 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28375 cr
.y
= w
->phys_cursor
.y
;
28376 cr
.width
= cursor_glyph
->pixel_width
;
28377 cr
.height
= w
->phys_cursor_height
;
28378 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28379 I assume the effect is the same -- and this is portable. */
28380 return x_intersect_rectangles (&cr
, r
, &result
);
28382 /* If we don't understand the format, pretend we're not in the hot-spot. */
28388 Draw a vertical window border to the right of window W if W doesn't
28389 have vertical scroll bars. */
28392 x_draw_vertical_border (struct window
*w
)
28394 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28396 /* We could do better, if we knew what type of scroll-bar the adjacent
28397 windows (on either side) have... But we don't :-(
28398 However, I think this works ok. ++KFS 2003-04-25 */
28400 /* Redraw borders between horizontally adjacent windows. Don't
28401 do it for frames with vertical scroll bars because either the
28402 right scroll bar of a window, or the left scroll bar of its
28403 neighbor will suffice as a border. */
28404 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28407 if (!WINDOW_RIGHTMOST_P (w
)
28408 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28410 int x0
, x1
, y0
, y1
;
28412 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28415 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28418 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28420 else if (!WINDOW_LEFTMOST_P (w
)
28421 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28423 int x0
, x1
, y0
, y1
;
28425 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28428 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28431 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28436 /* Redraw the part of window W intersection rectangle FR. Pixel
28437 coordinates in FR are frame-relative. Call this function with
28438 input blocked. Value is non-zero if the exposure overwrites
28442 expose_window (struct window
*w
, XRectangle
*fr
)
28444 struct frame
*f
= XFRAME (w
->frame
);
28446 int mouse_face_overwritten_p
= 0;
28448 /* If window is not yet fully initialized, do nothing. This can
28449 happen when toolkit scroll bars are used and a window is split.
28450 Reconfiguring the scroll bar will generate an expose for a newly
28452 if (w
->current_matrix
== NULL
)
28455 /* When we're currently updating the window, display and current
28456 matrix usually don't agree. Arrange for a thorough display
28458 if (w
== updated_window
)
28460 SET_FRAME_GARBAGED (f
);
28464 /* Frame-relative pixel rectangle of W. */
28465 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28466 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28467 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28468 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28470 if (x_intersect_rectangles (fr
, &wr
, &r
))
28472 int yb
= window_text_bottom_y (w
);
28473 struct glyph_row
*row
;
28474 int cursor_cleared_p
, phys_cursor_on_p
;
28475 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28477 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28478 r
.x
, r
.y
, r
.width
, r
.height
));
28480 /* Convert to window coordinates. */
28481 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28482 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28484 /* Turn off the cursor. */
28485 if (!w
->pseudo_window_p
28486 && phys_cursor_in_rect_p (w
, &r
))
28488 x_clear_cursor (w
);
28489 cursor_cleared_p
= 1;
28492 cursor_cleared_p
= 0;
28494 /* If the row containing the cursor extends face to end of line,
28495 then expose_area might overwrite the cursor outside the
28496 rectangle and thus notice_overwritten_cursor might clear
28497 w->phys_cursor_on_p. We remember the original value and
28498 check later if it is changed. */
28499 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28501 /* Update lines intersecting rectangle R. */
28502 first_overlapping_row
= last_overlapping_row
= NULL
;
28503 for (row
= w
->current_matrix
->rows
;
28508 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28510 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28511 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28512 || (r
.y
>= y0
&& r
.y
< y1
)
28513 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28515 /* A header line may be overlapping, but there is no need
28516 to fix overlapping areas for them. KFS 2005-02-12 */
28517 if (row
->overlapping_p
&& !row
->mode_line_p
)
28519 if (first_overlapping_row
== NULL
)
28520 first_overlapping_row
= row
;
28521 last_overlapping_row
= row
;
28525 if (expose_line (w
, row
, &r
))
28526 mouse_face_overwritten_p
= 1;
28529 else if (row
->overlapping_p
)
28531 /* We must redraw a row overlapping the exposed area. */
28533 ? y0
+ row
->phys_height
> r
.y
28534 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28536 if (first_overlapping_row
== NULL
)
28537 first_overlapping_row
= row
;
28538 last_overlapping_row
= row
;
28546 /* Display the mode line if there is one. */
28547 if (WINDOW_WANTS_MODELINE_P (w
)
28548 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28550 && row
->y
< r
.y
+ r
.height
)
28552 if (expose_line (w
, row
, &r
))
28553 mouse_face_overwritten_p
= 1;
28556 if (!w
->pseudo_window_p
)
28558 /* Fix the display of overlapping rows. */
28559 if (first_overlapping_row
)
28560 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28563 /* Draw border between windows. */
28564 x_draw_vertical_border (w
);
28566 /* Turn the cursor on again. */
28567 if (cursor_cleared_p
28568 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28569 update_window_cursor (w
, 1);
28573 return mouse_face_overwritten_p
;
28578 /* Redraw (parts) of all windows in the window tree rooted at W that
28579 intersect R. R contains frame pixel coordinates. Value is
28580 non-zero if the exposure overwrites mouse-face. */
28583 expose_window_tree (struct window
*w
, XRectangle
*r
)
28585 struct frame
*f
= XFRAME (w
->frame
);
28586 int mouse_face_overwritten_p
= 0;
28588 while (w
&& !FRAME_GARBAGED_P (f
))
28590 if (!NILP (w
->hchild
))
28591 mouse_face_overwritten_p
28592 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28593 else if (!NILP (w
->vchild
))
28594 mouse_face_overwritten_p
28595 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28597 mouse_face_overwritten_p
|= expose_window (w
, r
);
28599 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28602 return mouse_face_overwritten_p
;
28607 Redisplay an exposed area of frame F. X and Y are the upper-left
28608 corner of the exposed rectangle. W and H are width and height of
28609 the exposed area. All are pixel values. W or H zero means redraw
28610 the entire frame. */
28613 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28616 int mouse_face_overwritten_p
= 0;
28618 TRACE ((stderr
, "expose_frame "));
28620 /* No need to redraw if frame will be redrawn soon. */
28621 if (FRAME_GARBAGED_P (f
))
28623 TRACE ((stderr
, " garbaged\n"));
28627 /* If basic faces haven't been realized yet, there is no point in
28628 trying to redraw anything. This can happen when we get an expose
28629 event while Emacs is starting, e.g. by moving another window. */
28630 if (FRAME_FACE_CACHE (f
) == NULL
28631 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28633 TRACE ((stderr
, " no faces\n"));
28637 if (w
== 0 || h
== 0)
28640 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28641 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28651 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28652 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28654 if (WINDOWP (f
->tool_bar_window
))
28655 mouse_face_overwritten_p
28656 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28658 #ifdef HAVE_X_WINDOWS
28660 #ifndef USE_X_TOOLKIT
28661 if (WINDOWP (f
->menu_bar_window
))
28662 mouse_face_overwritten_p
28663 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28664 #endif /* not USE_X_TOOLKIT */
28668 /* Some window managers support a focus-follows-mouse style with
28669 delayed raising of frames. Imagine a partially obscured frame,
28670 and moving the mouse into partially obscured mouse-face on that
28671 frame. The visible part of the mouse-face will be highlighted,
28672 then the WM raises the obscured frame. With at least one WM, KDE
28673 2.1, Emacs is not getting any event for the raising of the frame
28674 (even tried with SubstructureRedirectMask), only Expose events.
28675 These expose events will draw text normally, i.e. not
28676 highlighted. Which means we must redo the highlight here.
28677 Subsume it under ``we love X''. --gerd 2001-08-15 */
28678 /* Included in Windows version because Windows most likely does not
28679 do the right thing if any third party tool offers
28680 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28681 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28683 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28684 if (f
== hlinfo
->mouse_face_mouse_frame
)
28686 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28687 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28688 clear_mouse_face (hlinfo
);
28689 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28696 Determine the intersection of two rectangles R1 and R2. Return
28697 the intersection in *RESULT. Value is non-zero if RESULT is not
28701 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28703 XRectangle
*left
, *right
;
28704 XRectangle
*upper
, *lower
;
28705 int intersection_p
= 0;
28707 /* Rearrange so that R1 is the left-most rectangle. */
28709 left
= r1
, right
= r2
;
28711 left
= r2
, right
= r1
;
28713 /* X0 of the intersection is right.x0, if this is inside R1,
28714 otherwise there is no intersection. */
28715 if (right
->x
<= left
->x
+ left
->width
)
28717 result
->x
= right
->x
;
28719 /* The right end of the intersection is the minimum of
28720 the right ends of left and right. */
28721 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28724 /* Same game for Y. */
28726 upper
= r1
, lower
= r2
;
28728 upper
= r2
, lower
= r1
;
28730 /* The upper end of the intersection is lower.y0, if this is inside
28731 of upper. Otherwise, there is no intersection. */
28732 if (lower
->y
<= upper
->y
+ upper
->height
)
28734 result
->y
= lower
->y
;
28736 /* The lower end of the intersection is the minimum of the lower
28737 ends of upper and lower. */
28738 result
->height
= (min (lower
->y
+ lower
->height
,
28739 upper
->y
+ upper
->height
)
28741 intersection_p
= 1;
28745 return intersection_p
;
28748 #endif /* HAVE_WINDOW_SYSTEM */
28751 /***********************************************************************
28753 ***********************************************************************/
28756 syms_of_xdisp (void)
28758 Vwith_echo_area_save_vector
= Qnil
;
28759 staticpro (&Vwith_echo_area_save_vector
);
28761 Vmessage_stack
= Qnil
;
28762 staticpro (&Vmessage_stack
);
28764 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28765 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
28767 message_dolog_marker1
= Fmake_marker ();
28768 staticpro (&message_dolog_marker1
);
28769 message_dolog_marker2
= Fmake_marker ();
28770 staticpro (&message_dolog_marker2
);
28771 message_dolog_marker3
= Fmake_marker ();
28772 staticpro (&message_dolog_marker3
);
28775 defsubr (&Sdump_frame_glyph_matrix
);
28776 defsubr (&Sdump_glyph_matrix
);
28777 defsubr (&Sdump_glyph_row
);
28778 defsubr (&Sdump_tool_bar_row
);
28779 defsubr (&Strace_redisplay
);
28780 defsubr (&Strace_to_stderr
);
28782 #ifdef HAVE_WINDOW_SYSTEM
28783 defsubr (&Stool_bar_lines_needed
);
28784 defsubr (&Slookup_image_map
);
28786 defsubr (&Sformat_mode_line
);
28787 defsubr (&Sinvisible_p
);
28788 defsubr (&Scurrent_bidi_paragraph_direction
);
28790 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28791 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28792 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28793 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28794 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28795 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28796 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28797 DEFSYM (Qeval
, "eval");
28798 DEFSYM (QCdata
, ":data");
28799 DEFSYM (Qdisplay
, "display");
28800 DEFSYM (Qspace_width
, "space-width");
28801 DEFSYM (Qraise
, "raise");
28802 DEFSYM (Qslice
, "slice");
28803 DEFSYM (Qspace
, "space");
28804 DEFSYM (Qmargin
, "margin");
28805 DEFSYM (Qpointer
, "pointer");
28806 DEFSYM (Qleft_margin
, "left-margin");
28807 DEFSYM (Qright_margin
, "right-margin");
28808 DEFSYM (Qcenter
, "center");
28809 DEFSYM (Qline_height
, "line-height");
28810 DEFSYM (QCalign_to
, ":align-to");
28811 DEFSYM (QCrelative_width
, ":relative-width");
28812 DEFSYM (QCrelative_height
, ":relative-height");
28813 DEFSYM (QCeval
, ":eval");
28814 DEFSYM (QCpropertize
, ":propertize");
28815 DEFSYM (QCfile
, ":file");
28816 DEFSYM (Qfontified
, "fontified");
28817 DEFSYM (Qfontification_functions
, "fontification-functions");
28818 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28819 DEFSYM (Qescape_glyph
, "escape-glyph");
28820 DEFSYM (Qnobreak_space
, "nobreak-space");
28821 DEFSYM (Qimage
, "image");
28822 DEFSYM (Qtext
, "text");
28823 DEFSYM (Qboth
, "both");
28824 DEFSYM (Qboth_horiz
, "both-horiz");
28825 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28826 DEFSYM (QCmap
, ":map");
28827 DEFSYM (QCpointer
, ":pointer");
28828 DEFSYM (Qrect
, "rect");
28829 DEFSYM (Qcircle
, "circle");
28830 DEFSYM (Qpoly
, "poly");
28831 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28832 DEFSYM (Qgrow_only
, "grow-only");
28833 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28834 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28835 DEFSYM (Qposition
, "position");
28836 DEFSYM (Qbuffer_position
, "buffer-position");
28837 DEFSYM (Qobject
, "object");
28838 DEFSYM (Qbar
, "bar");
28839 DEFSYM (Qhbar
, "hbar");
28840 DEFSYM (Qbox
, "box");
28841 DEFSYM (Qhollow
, "hollow");
28842 DEFSYM (Qhand
, "hand");
28843 DEFSYM (Qarrow
, "arrow");
28844 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28846 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28847 Fcons (intern_c_string ("void-variable"), Qnil
)),
28849 staticpro (&list_of_error
);
28851 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28852 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28853 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28854 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28856 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28857 staticpro (&echo_buffer
[0]);
28858 staticpro (&echo_buffer
[1]);
28860 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28861 staticpro (&echo_area_buffer
[0]);
28862 staticpro (&echo_area_buffer
[1]);
28864 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
28865 staticpro (&Vmessages_buffer_name
);
28867 mode_line_proptrans_alist
= Qnil
;
28868 staticpro (&mode_line_proptrans_alist
);
28869 mode_line_string_list
= Qnil
;
28870 staticpro (&mode_line_string_list
);
28871 mode_line_string_face
= Qnil
;
28872 staticpro (&mode_line_string_face
);
28873 mode_line_string_face_prop
= Qnil
;
28874 staticpro (&mode_line_string_face_prop
);
28875 Vmode_line_unwind_vector
= Qnil
;
28876 staticpro (&Vmode_line_unwind_vector
);
28878 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
28880 help_echo_string
= Qnil
;
28881 staticpro (&help_echo_string
);
28882 help_echo_object
= Qnil
;
28883 staticpro (&help_echo_object
);
28884 help_echo_window
= Qnil
;
28885 staticpro (&help_echo_window
);
28886 previous_help_echo_string
= Qnil
;
28887 staticpro (&previous_help_echo_string
);
28888 help_echo_pos
= -1;
28890 DEFSYM (Qright_to_left
, "right-to-left");
28891 DEFSYM (Qleft_to_right
, "left-to-right");
28893 #ifdef HAVE_WINDOW_SYSTEM
28894 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28895 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
28896 For example, if a block cursor is over a tab, it will be drawn as
28897 wide as that tab on the display. */);
28898 x_stretch_cursor_p
= 0;
28901 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28902 doc
: /* Non-nil means highlight trailing whitespace.
28903 The face used for trailing whitespace is `trailing-whitespace'. */);
28904 Vshow_trailing_whitespace
= Qnil
;
28906 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28907 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28908 If the value is t, Emacs highlights non-ASCII chars which have the
28909 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28910 or `escape-glyph' face respectively.
28912 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28913 U+2011 (non-breaking hyphen) are affected.
28915 Any other non-nil value means to display these characters as a escape
28916 glyph followed by an ordinary space or hyphen.
28918 A value of nil means no special handling of these characters. */);
28919 Vnobreak_char_display
= Qt
;
28921 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28922 doc
: /* The pointer shape to show in void text areas.
28923 A value of nil means to show the text pointer. Other options are `arrow',
28924 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28925 Vvoid_text_area_pointer
= Qarrow
;
28927 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28928 doc
: /* Non-nil means don't actually do any redisplay.
28929 This is used for internal purposes. */);
28930 Vinhibit_redisplay
= Qnil
;
28932 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28933 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28934 Vglobal_mode_string
= Qnil
;
28936 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28937 doc
: /* Marker for where to display an arrow on top of the buffer text.
28938 This must be the beginning of a line in order to work.
28939 See also `overlay-arrow-string'. */);
28940 Voverlay_arrow_position
= Qnil
;
28942 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28943 doc
: /* String to display as an arrow in non-window frames.
28944 See also `overlay-arrow-position'. */);
28945 Voverlay_arrow_string
= build_pure_c_string ("=>");
28947 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28948 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28949 The symbols on this list are examined during redisplay to determine
28950 where to display overlay arrows. */);
28951 Voverlay_arrow_variable_list
28952 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28954 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28955 doc
: /* The number of lines to try scrolling a window by when point moves out.
28956 If that fails to bring point back on frame, point is centered instead.
28957 If this is zero, point is always centered after it moves off frame.
28958 If you want scrolling to always be a line at a time, you should set
28959 `scroll-conservatively' to a large value rather than set this to 1. */);
28961 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28962 doc
: /* Scroll up to this many lines, to bring point back on screen.
28963 If point moves off-screen, redisplay will scroll by up to
28964 `scroll-conservatively' lines in order to bring point just barely
28965 onto the screen again. If that cannot be done, then redisplay
28966 recenters point as usual.
28968 If the value is greater than 100, redisplay will never recenter point,
28969 but will always scroll just enough text to bring point into view, even
28970 if you move far away.
28972 A value of zero means always recenter point if it moves off screen. */);
28973 scroll_conservatively
= 0;
28975 DEFVAR_INT ("scroll-margin", scroll_margin
,
28976 doc
: /* Number of lines of margin at the top and bottom of a window.
28977 Recenter the window whenever point gets within this many lines
28978 of the top or bottom of the window. */);
28981 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28982 doc
: /* Pixels per inch value for non-window system displays.
28983 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28984 Vdisplay_pixels_per_inch
= make_float (72.0);
28987 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28990 DEFVAR_LISP ("truncate-partial-width-windows",
28991 Vtruncate_partial_width_windows
,
28992 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28993 For an integer value, truncate lines in each window narrower than the
28994 full frame width, provided the window width is less than that integer;
28995 otherwise, respect the value of `truncate-lines'.
28997 For any other non-nil value, truncate lines in all windows that do
28998 not span the full frame width.
29000 A value of nil means to respect the value of `truncate-lines'.
29002 If `word-wrap' is enabled, you might want to reduce this. */);
29003 Vtruncate_partial_width_windows
= make_number (50);
29005 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
29006 doc
: /* Maximum buffer size for which line number should be displayed.
29007 If the buffer is bigger than this, the line number does not appear
29008 in the mode line. A value of nil means no limit. */);
29009 Vline_number_display_limit
= Qnil
;
29011 DEFVAR_INT ("line-number-display-limit-width",
29012 line_number_display_limit_width
,
29013 doc
: /* Maximum line width (in characters) for line number display.
29014 If the average length of the lines near point is bigger than this, then the
29015 line number may be omitted from the mode line. */);
29016 line_number_display_limit_width
= 200;
29018 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
29019 doc
: /* Non-nil means highlight region even in nonselected windows. */);
29020 highlight_nonselected_windows
= 0;
29022 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
29023 doc
: /* Non-nil if more than one frame is visible on this display.
29024 Minibuffer-only frames don't count, but iconified frames do.
29025 This variable is not guaranteed to be accurate except while processing
29026 `frame-title-format' and `icon-title-format'. */);
29028 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
29029 doc
: /* Template for displaying the title bar of visible frames.
29030 \(Assuming the window manager supports this feature.)
29032 This variable has the same structure as `mode-line-format', except that
29033 the %c and %l constructs are ignored. It is used only on frames for
29034 which no explicit name has been set \(see `modify-frame-parameters'). */);
29036 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
29037 doc
: /* Template for displaying the title bar of an iconified frame.
29038 \(Assuming the window manager supports this feature.)
29039 This variable has the same structure as `mode-line-format' (which see),
29040 and is used only on frames for which no explicit name has been set
29041 \(see `modify-frame-parameters'). */);
29043 = Vframe_title_format
29044 = listn (CONSTYPE_PURE
, 3,
29045 intern_c_string ("multiple-frames"),
29046 build_pure_c_string ("%b"),
29047 listn (CONSTYPE_PURE
, 4,
29048 empty_unibyte_string
,
29049 intern_c_string ("invocation-name"),
29050 build_pure_c_string ("@"),
29051 intern_c_string ("system-name")));
29053 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
29054 doc
: /* Maximum number of lines to keep in the message log buffer.
29055 If nil, disable message logging. If t, log messages but don't truncate
29056 the buffer when it becomes large. */);
29057 Vmessage_log_max
= make_number (1000);
29059 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
29060 doc
: /* Functions called before redisplay, if window sizes have changed.
29061 The value should be a list of functions that take one argument.
29062 Just before redisplay, for each frame, if any of its windows have changed
29063 size since the last redisplay, or have been split or deleted,
29064 all the functions in the list are called, with the frame as argument. */);
29065 Vwindow_size_change_functions
= Qnil
;
29067 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
29068 doc
: /* List of functions to call before redisplaying a window with scrolling.
29069 Each function is called with two arguments, the window and its new
29070 display-start position. Note that these functions are also called by
29071 `set-window-buffer'. Also note that the value of `window-end' is not
29072 valid when these functions are called.
29074 Warning: Do not use this feature to alter the way the window
29075 is scrolled. It is not designed for that, and such use probably won't
29077 Vwindow_scroll_functions
= Qnil
;
29079 DEFVAR_LISP ("window-text-change-functions",
29080 Vwindow_text_change_functions
,
29081 doc
: /* Functions to call in redisplay when text in the window might change. */);
29082 Vwindow_text_change_functions
= Qnil
;
29084 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
29085 doc
: /* Functions called when redisplay of a window reaches the end trigger.
29086 Each function is called with two arguments, the window and the end trigger value.
29087 See `set-window-redisplay-end-trigger'. */);
29088 Vredisplay_end_trigger_functions
= Qnil
;
29090 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
29091 doc
: /* Non-nil means autoselect window with mouse pointer.
29092 If nil, do not autoselect windows.
29093 A positive number means delay autoselection by that many seconds: a
29094 window is autoselected only after the mouse has remained in that
29095 window for the duration of the delay.
29096 A negative number has a similar effect, but causes windows to be
29097 autoselected only after the mouse has stopped moving. \(Because of
29098 the way Emacs compares mouse events, you will occasionally wait twice
29099 that time before the window gets selected.\)
29100 Any other value means to autoselect window instantaneously when the
29101 mouse pointer enters it.
29103 Autoselection selects the minibuffer only if it is active, and never
29104 unselects the minibuffer if it is active.
29106 When customizing this variable make sure that the actual value of
29107 `focus-follows-mouse' matches the behavior of your window manager. */);
29108 Vmouse_autoselect_window
= Qnil
;
29110 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
29111 doc
: /* Non-nil means automatically resize tool-bars.
29112 This dynamically changes the tool-bar's height to the minimum height
29113 that is needed to make all tool-bar items visible.
29114 If value is `grow-only', the tool-bar's height is only increased
29115 automatically; to decrease the tool-bar height, use \\[recenter]. */);
29116 Vauto_resize_tool_bars
= Qt
;
29118 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
29119 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
29120 auto_raise_tool_bar_buttons_p
= 1;
29122 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
29123 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
29124 make_cursor_line_fully_visible_p
= 1;
29126 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
29127 doc
: /* Border below tool-bar in pixels.
29128 If an integer, use it as the height of the border.
29129 If it is one of `internal-border-width' or `border-width', use the
29130 value of the corresponding frame parameter.
29131 Otherwise, no border is added below the tool-bar. */);
29132 Vtool_bar_border
= Qinternal_border_width
;
29134 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
29135 doc
: /* Margin around tool-bar buttons in pixels.
29136 If an integer, use that for both horizontal and vertical margins.
29137 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
29138 HORZ specifying the horizontal margin, and VERT specifying the
29139 vertical margin. */);
29140 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
29142 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
29143 doc
: /* Relief thickness of tool-bar buttons. */);
29144 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
29146 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
29147 doc
: /* Tool bar style to use.
29149 image - show images only
29150 text - show text only
29151 both - show both, text below image
29152 both-horiz - show text to the right of the image
29153 text-image-horiz - show text to the left of the image
29154 any other - use system default or image if no system default.
29156 This variable only affects the GTK+ toolkit version of Emacs. */);
29157 Vtool_bar_style
= Qnil
;
29159 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
29160 doc
: /* Maximum number of characters a label can have to be shown.
29161 The tool bar style must also show labels for this to have any effect, see
29162 `tool-bar-style'. */);
29163 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
29165 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
29166 doc
: /* List of functions to call to fontify regions of text.
29167 Each function is called with one argument POS. Functions must
29168 fontify a region starting at POS in the current buffer, and give
29169 fontified regions the property `fontified'. */);
29170 Vfontification_functions
= Qnil
;
29171 Fmake_variable_buffer_local (Qfontification_functions
);
29173 DEFVAR_BOOL ("unibyte-display-via-language-environment",
29174 unibyte_display_via_language_environment
,
29175 doc
: /* Non-nil means display unibyte text according to language environment.
29176 Specifically, this means that raw bytes in the range 160-255 decimal
29177 are displayed by converting them to the equivalent multibyte characters
29178 according to the current language environment. As a result, they are
29179 displayed according to the current fontset.
29181 Note that this variable affects only how these bytes are displayed,
29182 but does not change the fact they are interpreted as raw bytes. */);
29183 unibyte_display_via_language_environment
= 0;
29185 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
29186 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29187 If a float, it specifies a fraction of the mini-window frame's height.
29188 If an integer, it specifies a number of lines. */);
29189 Vmax_mini_window_height
= make_float (0.25);
29191 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
29192 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
29193 A value of nil means don't automatically resize mini-windows.
29194 A value of t means resize them to fit the text displayed in them.
29195 A value of `grow-only', the default, means let mini-windows grow only;
29196 they return to their normal size when the minibuffer is closed, or the
29197 echo area becomes empty. */);
29198 Vresize_mini_windows
= Qgrow_only
;
29200 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
29201 doc
: /* Alist specifying how to blink the cursor off.
29202 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29203 `cursor-type' frame-parameter or variable equals ON-STATE,
29204 comparing using `equal', Emacs uses OFF-STATE to specify
29205 how to blink it off. ON-STATE and OFF-STATE are values for
29206 the `cursor-type' frame parameter.
29208 If a frame's ON-STATE has no entry in this list,
29209 the frame's other specifications determine how to blink the cursor off. */);
29210 Vblink_cursor_alist
= Qnil
;
29212 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
29213 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
29214 If non-nil, windows are automatically scrolled horizontally to make
29215 point visible. */);
29216 automatic_hscrolling_p
= 1;
29217 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
29219 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
29220 doc
: /* How many columns away from the window edge point is allowed to get
29221 before automatic hscrolling will horizontally scroll the window. */);
29222 hscroll_margin
= 5;
29224 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
29225 doc
: /* How many columns to scroll the window when point gets too close to the edge.
29226 When point is less than `hscroll-margin' columns from the window
29227 edge, automatic hscrolling will scroll the window by the amount of columns
29228 determined by this variable. If its value is a positive integer, scroll that
29229 many columns. If it's a positive floating-point number, it specifies the
29230 fraction of the window's width to scroll. If it's nil or zero, point will be
29231 centered horizontally after the scroll. Any other value, including negative
29232 numbers, are treated as if the value were zero.
29234 Automatic hscrolling always moves point outside the scroll margin, so if
29235 point was more than scroll step columns inside the margin, the window will
29236 scroll more than the value given by the scroll step.
29238 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29239 and `scroll-right' overrides this variable's effect. */);
29240 Vhscroll_step
= make_number (0);
29242 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
29243 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
29244 Bind this around calls to `message' to let it take effect. */);
29245 message_truncate_lines
= 0;
29247 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
29248 doc
: /* Normal hook run to update the menu bar definitions.
29249 Redisplay runs this hook before it redisplays the menu bar.
29250 This is used to update submenus such as Buffers,
29251 whose contents depend on various data. */);
29252 Vmenu_bar_update_hook
= Qnil
;
29254 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
29255 doc
: /* Frame for which we are updating a menu.
29256 The enable predicate for a menu binding should check this variable. */);
29257 Vmenu_updating_frame
= Qnil
;
29259 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
29260 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
29261 inhibit_menubar_update
= 0;
29263 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
29264 doc
: /* Prefix prepended to all continuation lines at display time.
29265 The value may be a string, an image, or a stretch-glyph; it is
29266 interpreted in the same way as the value of a `display' text property.
29268 This variable is overridden by any `wrap-prefix' text or overlay
29271 To add a prefix to non-continuation lines, use `line-prefix'. */);
29272 Vwrap_prefix
= Qnil
;
29273 DEFSYM (Qwrap_prefix
, "wrap-prefix");
29274 Fmake_variable_buffer_local (Qwrap_prefix
);
29276 DEFVAR_LISP ("line-prefix", Vline_prefix
,
29277 doc
: /* Prefix prepended to all non-continuation lines at display time.
29278 The value may be a string, an image, or a stretch-glyph; it is
29279 interpreted in the same way as the value of a `display' text property.
29281 This variable is overridden by any `line-prefix' text or overlay
29284 To add a prefix to continuation lines, use `wrap-prefix'. */);
29285 Vline_prefix
= Qnil
;
29286 DEFSYM (Qline_prefix
, "line-prefix");
29287 Fmake_variable_buffer_local (Qline_prefix
);
29289 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
29290 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
29291 inhibit_eval_during_redisplay
= 0;
29293 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
29294 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
29295 inhibit_free_realized_faces
= 0;
29298 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
29299 doc
: /* Inhibit try_window_id display optimization. */);
29300 inhibit_try_window_id
= 0;
29302 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
29303 doc
: /* Inhibit try_window_reusing display optimization. */);
29304 inhibit_try_window_reusing
= 0;
29306 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
29307 doc
: /* Inhibit try_cursor_movement display optimization. */);
29308 inhibit_try_cursor_movement
= 0;
29309 #endif /* GLYPH_DEBUG */
29311 DEFVAR_INT ("overline-margin", overline_margin
,
29312 doc
: /* Space between overline and text, in pixels.
29313 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29314 margin to the character height. */);
29315 overline_margin
= 2;
29317 DEFVAR_INT ("underline-minimum-offset",
29318 underline_minimum_offset
,
29319 doc
: /* Minimum distance between baseline and underline.
29320 This can improve legibility of underlined text at small font sizes,
29321 particularly when using variable `x-use-underline-position-properties'
29322 with fonts that specify an UNDERLINE_POSITION relatively close to the
29323 baseline. The default value is 1. */);
29324 underline_minimum_offset
= 1;
29326 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
29327 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29328 This feature only works when on a window system that can change
29329 cursor shapes. */);
29330 display_hourglass_p
= 1;
29332 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
29333 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29334 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
29336 hourglass_atimer
= NULL
;
29337 hourglass_shown_p
= 0;
29339 DEFSYM (Qglyphless_char
, "glyphless-char");
29340 DEFSYM (Qhex_code
, "hex-code");
29341 DEFSYM (Qempty_box
, "empty-box");
29342 DEFSYM (Qthin_space
, "thin-space");
29343 DEFSYM (Qzero_width
, "zero-width");
29345 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
29346 /* Intern this now in case it isn't already done.
29347 Setting this variable twice is harmless.
29348 But don't staticpro it here--that is done in alloc.c. */
29349 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
29350 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
29352 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
29353 doc
: /* Char-table defining glyphless characters.
29354 Each element, if non-nil, should be one of the following:
29355 an ASCII acronym string: display this string in a box
29356 `hex-code': display the hexadecimal code of a character in a box
29357 `empty-box': display as an empty box
29358 `thin-space': display as 1-pixel width space
29359 `zero-width': don't display
29360 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29361 display method for graphical terminals and text terminals respectively.
29362 GRAPHICAL and TEXT should each have one of the values listed above.
29364 The char-table has one extra slot to control the display of a character for
29365 which no font is found. This slot only takes effect on graphical terminals.
29366 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29367 `thin-space'. The default is `empty-box'. */);
29368 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29369 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29372 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
29373 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
29374 Vdebug_on_message
= Qnil
;
29378 /* Initialize this module when Emacs starts. */
29383 current_header_line_height
= current_mode_line_height
= -1;
29385 CHARPOS (this_line_start_pos
) = 0;
29387 if (!noninteractive
)
29389 struct window
*m
= XWINDOW (minibuf_window
);
29390 Lisp_Object frame
= m
->frame
;
29391 struct frame
*f
= XFRAME (frame
);
29392 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29393 struct window
*r
= XWINDOW (root
);
29396 echo_area_window
= minibuf_window
;
29398 wset_top_line (r
, make_number (FRAME_TOP_MARGIN (f
)));
29400 (r
, make_number (FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
)));
29401 wset_total_cols (r
, make_number (FRAME_COLS (f
)));
29402 wset_top_line (m
, make_number (FRAME_LINES (f
) - 1));
29403 wset_total_lines (m
, make_number (1));
29404 wset_total_cols (m
, make_number (FRAME_COLS (f
)));
29406 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29407 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29408 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29410 /* The default ellipsis glyphs `...'. */
29411 for (i
= 0; i
< 3; ++i
)
29412 default_invis_vector
[i
] = make_number ('.');
29416 /* Allocate the buffer for frame titles.
29417 Also used for `format-mode-line'. */
29419 mode_line_noprop_buf
= xmalloc (size
);
29420 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29421 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29422 mode_line_target
= MODE_LINE_DISPLAY
;
29425 help_echo_showing_p
= 0;
29428 /* Platform-independent portion of hourglass implementation. */
29430 /* Cancel a currently active hourglass timer, and start a new one. */
29432 start_hourglass (void)
29434 #if defined (HAVE_WINDOW_SYSTEM)
29437 cancel_hourglass ();
29439 if (INTEGERP (Vhourglass_delay
)
29440 && XINT (Vhourglass_delay
) > 0)
29441 delay
= make_emacs_time (min (XINT (Vhourglass_delay
),
29442 TYPE_MAXIMUM (time_t)),
29444 else if (FLOATP (Vhourglass_delay
)
29445 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29446 delay
= EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (Vhourglass_delay
));
29448 delay
= make_emacs_time (DEFAULT_HOURGLASS_DELAY
, 0);
29452 extern void w32_note_current_window (void);
29453 w32_note_current_window ();
29455 #endif /* HAVE_NTGUI */
29457 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29458 show_hourglass
, NULL
);
29463 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29466 cancel_hourglass (void)
29468 #if defined (HAVE_WINDOW_SYSTEM)
29469 if (hourglass_atimer
)
29471 cancel_atimer (hourglass_atimer
);
29472 hourglass_atimer
= NULL
;
29475 if (hourglass_shown_p
)