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
, tem
;
9401 struct gcpro gcpro1
;
9403 old_deactivate_mark
= Vdeactivate_mark
;
9404 oldbuf
= current_buffer
;
9405 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9406 bset_undo_list (current_buffer
, Qt
);
9408 oldpoint
= message_dolog_marker1
;
9409 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9410 oldbegv
= message_dolog_marker2
;
9411 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9412 oldzv
= message_dolog_marker3
;
9413 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9414 GCPRO1 (old_deactivate_mark
);
9422 BEGV_BYTE
= BEG_BYTE
;
9425 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9427 /* Insert the string--maybe converting multibyte to single byte
9428 or vice versa, so that all the text fits the buffer. */
9430 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9436 /* Convert a multibyte string to single-byte
9437 for the *Message* buffer. */
9438 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9440 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9441 work
[0] = (ASCII_CHAR_P (c
)
9443 : multibyte_char_to_unibyte (c
));
9444 insert_1_both (work
, 1, 1, 1, 0, 0);
9447 else if (! multibyte
9448 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9452 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9453 /* Convert a single-byte string to multibyte
9454 for the *Message* buffer. */
9455 for (i
= 0; i
< nbytes
; i
++)
9458 MAKE_CHAR_MULTIBYTE (c
);
9459 char_bytes
= CHAR_STRING (c
, str
);
9460 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9464 insert_1 (m
, nbytes
, 1, 0, 0);
9468 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9470 insert_1 ("\n", 1, 1, 0, 0);
9472 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9474 this_bol_byte
= PT_BYTE
;
9476 /* See if this line duplicates the previous one.
9477 If so, combine duplicates. */
9480 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9482 prev_bol_byte
= PT_BYTE
;
9484 dups
= message_log_check_duplicate (prev_bol_byte
,
9488 del_range_both (prev_bol
, prev_bol_byte
,
9489 this_bol
, this_bol_byte
, 0);
9492 char dupstr
[sizeof " [ times]"
9493 + INT_STRLEN_BOUND (printmax_t
)];
9495 /* If you change this format, don't forget to also
9496 change message_log_check_duplicate. */
9497 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9498 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9499 insert_1 (dupstr
, duplen
, 1, 0, 1);
9504 /* If we have more than the desired maximum number of lines
9505 in the *Messages* buffer now, delete the oldest ones.
9506 This is safe because we don't have undo in this buffer. */
9508 if (NATNUMP (Vmessage_log_max
))
9510 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9511 -XFASTINT (Vmessage_log_max
) - 1, 0);
9512 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9515 BEGV
= marker_position (oldbegv
);
9516 BEGV_BYTE
= marker_byte_position (oldbegv
);
9525 ZV
= marker_position (oldzv
);
9526 ZV_BYTE
= marker_byte_position (oldzv
);
9530 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9532 /* We can't do Fgoto_char (oldpoint) because it will run some
9534 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
9535 marker_byte_position (oldpoint
));
9538 unchain_marker (XMARKER (oldpoint
));
9539 unchain_marker (XMARKER (oldbegv
));
9540 unchain_marker (XMARKER (oldzv
));
9542 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9543 set_buffer_internal (oldbuf
);
9545 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9546 message_log_need_newline
= !nlflag
;
9547 Vdeactivate_mark
= old_deactivate_mark
;
9552 /* We are at the end of the buffer after just having inserted a newline.
9553 (Note: We depend on the fact we won't be crossing the gap.)
9554 Check to see if the most recent message looks a lot like the previous one.
9555 Return 0 if different, 1 if the new one should just replace it, or a
9556 value N > 1 if we should also append " [N times]". */
9559 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9562 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9564 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9565 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9567 for (i
= 0; i
< len
; i
++)
9569 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9577 if (*p1
++ == ' ' && *p1
++ == '[')
9580 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9581 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9588 /* Display an echo area message M with a specified length of NBYTES
9589 bytes. The string may include null characters. If M is 0, clear
9590 out any existing message, and let the mini-buffer text show
9593 This may GC, so the buffer M must NOT point to a Lisp string. */
9596 message2 (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9598 /* First flush out any partial line written with print. */
9599 message_log_maybe_newline ();
9601 message_dolog (m
, nbytes
, 1, multibyte
);
9602 message2_nolog (m
, nbytes
, multibyte
);
9606 /* The non-logging counterpart of message2. */
9609 message2_nolog (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9611 struct frame
*sf
= SELECTED_FRAME ();
9612 message_enable_multibyte
= multibyte
;
9614 if (FRAME_INITIAL_P (sf
))
9616 if (noninteractive_need_newline
)
9617 putc ('\n', stderr
);
9618 noninteractive_need_newline
= 0;
9620 fwrite (m
, nbytes
, 1, stderr
);
9621 if (cursor_in_echo_area
== 0)
9622 fprintf (stderr
, "\n");
9625 /* A null message buffer means that the frame hasn't really been
9626 initialized yet. Error messages get reported properly by
9627 cmd_error, so this must be just an informative message; toss it. */
9628 else if (INTERACTIVE
9629 && sf
->glyphs_initialized_p
9630 && FRAME_MESSAGE_BUF (sf
))
9632 Lisp_Object mini_window
;
9635 /* Get the frame containing the mini-buffer
9636 that the selected frame is using. */
9637 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9638 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9640 FRAME_SAMPLE_VISIBILITY (f
);
9641 if (FRAME_VISIBLE_P (sf
)
9642 && ! FRAME_VISIBLE_P (f
))
9643 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9647 set_message (m
, Qnil
, nbytes
, multibyte
);
9648 if (minibuffer_auto_raise
)
9649 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9652 clear_message (1, 1);
9654 do_pending_window_change (0);
9655 echo_area_display (1);
9656 do_pending_window_change (0);
9657 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
9658 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9663 /* Display an echo area message M with a specified length of NBYTES
9664 bytes. The string may include null characters. If M is not a
9665 string, clear out any existing message, and let the mini-buffer
9668 This function cancels echoing. */
9671 message3 (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9673 struct gcpro gcpro1
;
9676 clear_message (1,1);
9679 /* First flush out any partial line written with print. */
9680 message_log_maybe_newline ();
9684 char *buffer
= SAFE_ALLOCA (nbytes
);
9685 memcpy (buffer
, SDATA (m
), nbytes
);
9686 message_dolog (buffer
, nbytes
, 1, multibyte
);
9689 message3_nolog (m
, nbytes
, multibyte
);
9695 /* The non-logging version of message3.
9696 This does not cancel echoing, because it is used for echoing.
9697 Perhaps we need to make a separate function for echoing
9698 and make this cancel echoing. */
9701 message3_nolog (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9703 struct frame
*sf
= SELECTED_FRAME ();
9704 message_enable_multibyte
= multibyte
;
9706 if (FRAME_INITIAL_P (sf
))
9708 if (noninteractive_need_newline
)
9709 putc ('\n', stderr
);
9710 noninteractive_need_newline
= 0;
9712 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9713 if (cursor_in_echo_area
== 0)
9714 fprintf (stderr
, "\n");
9717 /* A null message buffer means that the frame hasn't really been
9718 initialized yet. Error messages get reported properly by
9719 cmd_error, so this must be just an informative message; toss it. */
9720 else if (INTERACTIVE
9721 && sf
->glyphs_initialized_p
9722 && FRAME_MESSAGE_BUF (sf
))
9724 Lisp_Object mini_window
;
9728 /* Get the frame containing the mini-buffer
9729 that the selected frame is using. */
9730 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9731 frame
= XWINDOW (mini_window
)->frame
;
9734 FRAME_SAMPLE_VISIBILITY (f
);
9735 if (FRAME_VISIBLE_P (sf
)
9736 && !FRAME_VISIBLE_P (f
))
9737 Fmake_frame_visible (frame
);
9739 if (STRINGP (m
) && SCHARS (m
) > 0)
9741 set_message (NULL
, m
, nbytes
, multibyte
);
9742 if (minibuffer_auto_raise
)
9743 Fraise_frame (frame
);
9744 /* Assume we are not echoing.
9745 (If we are, echo_now will override this.) */
9746 echo_message_buffer
= Qnil
;
9749 clear_message (1, 1);
9751 do_pending_window_change (0);
9752 echo_area_display (1);
9753 do_pending_window_change (0);
9754 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
9755 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9760 /* Display a null-terminated echo area message M. If M is 0, clear
9761 out any existing message, and let the mini-buffer text show through.
9763 The buffer M must continue to exist until after the echo area gets
9764 cleared or some other message gets displayed there. Do not pass
9765 text that is stored in a Lisp string. Do not pass text in a buffer
9766 that was alloca'd. */
9769 message1 (const char *m
)
9771 message2 (m
, (m
? strlen (m
) : 0), 0);
9775 /* The non-logging counterpart of message1. */
9778 message1_nolog (const char *m
)
9780 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9783 /* Display a message M which contains a single %s
9784 which gets replaced with STRING. */
9787 message_with_string (const char *m
, Lisp_Object string
, int log
)
9789 CHECK_STRING (string
);
9795 if (noninteractive_need_newline
)
9796 putc ('\n', stderr
);
9797 noninteractive_need_newline
= 0;
9798 fprintf (stderr
, m
, SDATA (string
));
9799 if (!cursor_in_echo_area
)
9800 fprintf (stderr
, "\n");
9804 else if (INTERACTIVE
)
9806 /* The frame whose minibuffer we're going to display the message on.
9807 It may be larger than the selected frame, so we need
9808 to use its buffer, not the selected frame's buffer. */
9809 Lisp_Object mini_window
;
9810 struct frame
*f
, *sf
= SELECTED_FRAME ();
9812 /* Get the frame containing the minibuffer
9813 that the selected frame is using. */
9814 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9815 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9817 /* A null message buffer means that the frame hasn't really been
9818 initialized yet. Error messages get reported properly by
9819 cmd_error, so this must be just an informative message; toss it. */
9820 if (FRAME_MESSAGE_BUF (f
))
9822 Lisp_Object args
[2], msg
;
9823 struct gcpro gcpro1
, gcpro2
;
9825 args
[0] = build_string (m
);
9826 args
[1] = msg
= string
;
9827 GCPRO2 (args
[0], msg
);
9830 msg
= Fformat (2, args
);
9833 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9835 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9839 /* Print should start at the beginning of the message
9840 buffer next time. */
9841 message_buf_print
= 0;
9847 /* Dump an informative message to the minibuf. If M is 0, clear out
9848 any existing message, and let the mini-buffer text show through. */
9851 vmessage (const char *m
, va_list ap
)
9857 if (noninteractive_need_newline
)
9858 putc ('\n', stderr
);
9859 noninteractive_need_newline
= 0;
9860 vfprintf (stderr
, m
, ap
);
9861 if (cursor_in_echo_area
== 0)
9862 fprintf (stderr
, "\n");
9866 else if (INTERACTIVE
)
9868 /* The frame whose mini-buffer we're going to display the message
9869 on. It may be larger than the selected frame, so we need to
9870 use its buffer, not the selected frame's buffer. */
9871 Lisp_Object mini_window
;
9872 struct frame
*f
, *sf
= SELECTED_FRAME ();
9874 /* Get the frame containing the mini-buffer
9875 that the selected frame is using. */
9876 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9877 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9879 /* A null message buffer means that the frame hasn't really been
9880 initialized yet. Error messages get reported properly by
9881 cmd_error, so this must be just an informative message; toss
9883 if (FRAME_MESSAGE_BUF (f
))
9889 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9890 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9892 message2 (FRAME_MESSAGE_BUF (f
), len
, 1);
9897 /* Print should start at the beginning of the message
9898 buffer next time. */
9899 message_buf_print
= 0;
9905 message (const char *m
, ...)
9915 /* The non-logging version of message. */
9918 message_nolog (const char *m
, ...)
9920 Lisp_Object old_log_max
;
9923 old_log_max
= Vmessage_log_max
;
9924 Vmessage_log_max
= Qnil
;
9926 Vmessage_log_max
= old_log_max
;
9932 /* Display the current message in the current mini-buffer. This is
9933 only called from error handlers in process.c, and is not time
9937 update_echo_area (void)
9939 if (!NILP (echo_area_buffer
[0]))
9942 string
= Fcurrent_message ();
9943 message3 (string
, SBYTES (string
),
9944 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9949 /* Make sure echo area buffers in `echo_buffers' are live.
9950 If they aren't, make new ones. */
9953 ensure_echo_area_buffers (void)
9957 for (i
= 0; i
< 2; ++i
)
9958 if (!BUFFERP (echo_buffer
[i
])
9959 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
9962 Lisp_Object old_buffer
;
9965 old_buffer
= echo_buffer
[i
];
9966 echo_buffer
[i
] = Fget_buffer_create
9967 (make_formatted_string (name
, " *Echo Area %d*", i
));
9968 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
9969 /* to force word wrap in echo area -
9970 it was decided to postpone this*/
9971 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9973 for (j
= 0; j
< 2; ++j
)
9974 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9975 echo_area_buffer
[j
] = echo_buffer
[i
];
9980 /* Call FN with args A1..A4 with either the current or last displayed
9981 echo_area_buffer as current buffer.
9983 WHICH zero means use the current message buffer
9984 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9985 from echo_buffer[] and clear it.
9987 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9988 suitable buffer from echo_buffer[] and clear it.
9990 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9991 that the current message becomes the last displayed one, make
9992 choose a suitable buffer for echo_area_buffer[0], and clear it.
9994 Value is what FN returns. */
9997 with_echo_area_buffer (struct window
*w
, int which
,
9998 int (*fn
) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
9999 ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10001 Lisp_Object buffer
;
10002 int this_one
, the_other
, clear_buffer_p
, rc
;
10003 ptrdiff_t count
= SPECPDL_INDEX ();
10005 /* If buffers aren't live, make new ones. */
10006 ensure_echo_area_buffers ();
10008 clear_buffer_p
= 0;
10011 this_one
= 0, the_other
= 1;
10012 else if (which
> 0)
10013 this_one
= 1, the_other
= 0;
10016 this_one
= 0, the_other
= 1;
10017 clear_buffer_p
= 1;
10019 /* We need a fresh one in case the current echo buffer equals
10020 the one containing the last displayed echo area message. */
10021 if (!NILP (echo_area_buffer
[this_one
])
10022 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10023 echo_area_buffer
[this_one
] = Qnil
;
10026 /* Choose a suitable buffer from echo_buffer[] is we don't
10028 if (NILP (echo_area_buffer
[this_one
]))
10030 echo_area_buffer
[this_one
]
10031 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10032 ? echo_buffer
[the_other
]
10033 : echo_buffer
[this_one
]);
10034 clear_buffer_p
= 1;
10037 buffer
= echo_area_buffer
[this_one
];
10039 /* Don't get confused by reusing the buffer used for echoing
10040 for a different purpose. */
10041 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10044 record_unwind_protect (unwind_with_echo_area_buffer
,
10045 with_echo_area_buffer_unwind_data (w
));
10047 /* Make the echo area buffer current. Note that for display
10048 purposes, it is not necessary that the displayed window's buffer
10049 == current_buffer, except for text property lookup. So, let's
10050 only set that buffer temporarily here without doing a full
10051 Fset_window_buffer. We must also change w->pointm, though,
10052 because otherwise an assertions in unshow_buffer fails, and Emacs
10054 set_buffer_internal_1 (XBUFFER (buffer
));
10057 wset_buffer (w
, buffer
);
10058 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10061 bset_undo_list (current_buffer
, Qt
);
10062 bset_read_only (current_buffer
, Qnil
);
10063 specbind (Qinhibit_read_only
, Qt
);
10064 specbind (Qinhibit_modification_hooks
, Qt
);
10066 if (clear_buffer_p
&& Z
> BEG
)
10067 del_range (BEG
, Z
);
10069 eassert (BEGV
>= BEG
);
10070 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10072 rc
= fn (a1
, a2
, a3
, a4
);
10074 eassert (BEGV
>= BEG
);
10075 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10077 unbind_to (count
, Qnil
);
10082 /* Save state that should be preserved around the call to the function
10083 FN called in with_echo_area_buffer. */
10086 with_echo_area_buffer_unwind_data (struct window
*w
)
10089 Lisp_Object vector
, tmp
;
10091 /* Reduce consing by keeping one vector in
10092 Vwith_echo_area_save_vector. */
10093 vector
= Vwith_echo_area_save_vector
;
10094 Vwith_echo_area_save_vector
= Qnil
;
10097 vector
= Fmake_vector (make_number (7), Qnil
);
10099 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10100 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10101 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10105 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10106 ASET (vector
, i
, w
->buffer
); ++i
;
10107 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10108 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10113 for (; i
< end
; ++i
)
10114 ASET (vector
, i
, Qnil
);
10117 eassert (i
== ASIZE (vector
));
10122 /* Restore global state from VECTOR which was created by
10123 with_echo_area_buffer_unwind_data. */
10126 unwind_with_echo_area_buffer (Lisp_Object vector
)
10128 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10129 Vdeactivate_mark
= AREF (vector
, 1);
10130 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10132 if (WINDOWP (AREF (vector
, 3)))
10135 Lisp_Object buffer
, charpos
, bytepos
;
10137 w
= XWINDOW (AREF (vector
, 3));
10138 buffer
= AREF (vector
, 4);
10139 charpos
= AREF (vector
, 5);
10140 bytepos
= AREF (vector
, 6);
10142 wset_buffer (w
, buffer
);
10143 set_marker_both (w
->pointm
, buffer
,
10144 XFASTINT (charpos
), XFASTINT (bytepos
));
10147 Vwith_echo_area_save_vector
= vector
;
10152 /* Set up the echo area for use by print functions. MULTIBYTE_P
10153 non-zero means we will print multibyte. */
10156 setup_echo_area_for_printing (int multibyte_p
)
10158 /* If we can't find an echo area any more, exit. */
10159 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10160 Fkill_emacs (Qnil
);
10162 ensure_echo_area_buffers ();
10164 if (!message_buf_print
)
10166 /* A message has been output since the last time we printed.
10167 Choose a fresh echo area buffer. */
10168 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10169 echo_area_buffer
[0] = echo_buffer
[1];
10171 echo_area_buffer
[0] = echo_buffer
[0];
10173 /* Switch to that buffer and clear it. */
10174 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10175 bset_truncate_lines (current_buffer
, Qnil
);
10179 ptrdiff_t count
= SPECPDL_INDEX ();
10180 specbind (Qinhibit_read_only
, Qt
);
10181 /* Note that undo recording is always disabled. */
10182 del_range (BEG
, Z
);
10183 unbind_to (count
, Qnil
);
10185 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10187 /* Set up the buffer for the multibyteness we need. */
10189 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10190 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10192 /* Raise the frame containing the echo area. */
10193 if (minibuffer_auto_raise
)
10195 struct frame
*sf
= SELECTED_FRAME ();
10196 Lisp_Object mini_window
;
10197 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10198 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10201 message_log_maybe_newline ();
10202 message_buf_print
= 1;
10206 if (NILP (echo_area_buffer
[0]))
10208 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10209 echo_area_buffer
[0] = echo_buffer
[1];
10211 echo_area_buffer
[0] = echo_buffer
[0];
10214 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10216 /* Someone switched buffers between print requests. */
10217 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10218 bset_truncate_lines (current_buffer
, Qnil
);
10224 /* Display an echo area message in window W. Value is non-zero if W's
10225 height is changed. If display_last_displayed_message_p is
10226 non-zero, display the message that was last displayed, otherwise
10227 display the current message. */
10230 display_echo_area (struct window
*w
)
10232 int i
, no_message_p
, window_height_changed_p
;
10234 /* Temporarily disable garbage collections while displaying the echo
10235 area. This is done because a GC can print a message itself.
10236 That message would modify the echo area buffer's contents while a
10237 redisplay of the buffer is going on, and seriously confuse
10239 ptrdiff_t count
= inhibit_garbage_collection ();
10241 /* If there is no message, we must call display_echo_area_1
10242 nevertheless because it resizes the window. But we will have to
10243 reset the echo_area_buffer in question to nil at the end because
10244 with_echo_area_buffer will sets it to an empty buffer. */
10245 i
= display_last_displayed_message_p
? 1 : 0;
10246 no_message_p
= NILP (echo_area_buffer
[i
]);
10248 window_height_changed_p
10249 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10250 display_echo_area_1
,
10251 (intptr_t) w
, Qnil
, 0, 0);
10254 echo_area_buffer
[i
] = Qnil
;
10256 unbind_to (count
, Qnil
);
10257 return window_height_changed_p
;
10261 /* Helper for display_echo_area. Display the current buffer which
10262 contains the current echo area message in window W, a mini-window,
10263 a pointer to which is passed in A1. A2..A4 are currently not used.
10264 Change the height of W so that all of the message is displayed.
10265 Value is non-zero if height of W was changed. */
10268 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10271 struct window
*w
= (struct window
*) i1
;
10272 Lisp_Object window
;
10273 struct text_pos start
;
10274 int window_height_changed_p
= 0;
10276 /* Do this before displaying, so that we have a large enough glyph
10277 matrix for the display. If we can't get enough space for the
10278 whole text, display the last N lines. That works by setting w->start. */
10279 window_height_changed_p
= resize_mini_window (w
, 0);
10281 /* Use the starting position chosen by resize_mini_window. */
10282 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10285 clear_glyph_matrix (w
->desired_matrix
);
10286 XSETWINDOW (window
, w
);
10287 try_window (window
, start
, 0);
10289 return window_height_changed_p
;
10293 /* Resize the echo area window to exactly the size needed for the
10294 currently displayed message, if there is one. If a mini-buffer
10295 is active, don't shrink it. */
10298 resize_echo_area_exactly (void)
10300 if (BUFFERP (echo_area_buffer
[0])
10301 && WINDOWP (echo_area_window
))
10303 struct window
*w
= XWINDOW (echo_area_window
);
10305 Lisp_Object resize_exactly
;
10307 if (minibuf_level
== 0)
10308 resize_exactly
= Qt
;
10310 resize_exactly
= Qnil
;
10312 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10313 (intptr_t) w
, resize_exactly
,
10317 ++windows_or_buffers_changed
;
10318 ++update_mode_lines
;
10319 redisplay_internal ();
10325 /* Callback function for with_echo_area_buffer, when used from
10326 resize_echo_area_exactly. A1 contains a pointer to the window to
10327 resize, EXACTLY non-nil means resize the mini-window exactly to the
10328 size of the text displayed. A3 and A4 are not used. Value is what
10329 resize_mini_window returns. */
10332 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
, ptrdiff_t a3
, ptrdiff_t a4
)
10335 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10339 /* Resize mini-window W to fit the size of its contents. EXACT_P
10340 means size the window exactly to the size needed. Otherwise, it's
10341 only enlarged until W's buffer is empty.
10343 Set W->start to the right place to begin display. If the whole
10344 contents fit, start at the beginning. Otherwise, start so as
10345 to make the end of the contents appear. This is particularly
10346 important for y-or-n-p, but seems desirable generally.
10348 Value is non-zero if the window height has been changed. */
10351 resize_mini_window (struct window
*w
, int exact_p
)
10353 struct frame
*f
= XFRAME (w
->frame
);
10354 int window_height_changed_p
= 0;
10356 eassert (MINI_WINDOW_P (w
));
10358 /* By default, start display at the beginning. */
10359 set_marker_both (w
->start
, w
->buffer
,
10360 BUF_BEGV (XBUFFER (w
->buffer
)),
10361 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10363 /* Don't resize windows while redisplaying a window; it would
10364 confuse redisplay functions when the size of the window they are
10365 displaying changes from under them. Such a resizing can happen,
10366 for instance, when which-func prints a long message while
10367 we are running fontification-functions. We're running these
10368 functions with safe_call which binds inhibit-redisplay to t. */
10369 if (!NILP (Vinhibit_redisplay
))
10372 /* Nil means don't try to resize. */
10373 if (NILP (Vresize_mini_windows
)
10374 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10377 if (!FRAME_MINIBUF_ONLY_P (f
))
10380 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10381 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10383 EMACS_INT max_height
;
10384 int unit
= FRAME_LINE_HEIGHT (f
);
10385 struct text_pos start
;
10386 struct buffer
*old_current_buffer
= NULL
;
10388 if (current_buffer
!= XBUFFER (w
->buffer
))
10390 old_current_buffer
= current_buffer
;
10391 set_buffer_internal (XBUFFER (w
->buffer
));
10394 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10396 /* Compute the max. number of lines specified by the user. */
10397 if (FLOATP (Vmax_mini_window_height
))
10398 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10399 else if (INTEGERP (Vmax_mini_window_height
))
10400 max_height
= XINT (Vmax_mini_window_height
);
10402 max_height
= total_height
/ 4;
10404 /* Correct that max. height if it's bogus. */
10405 max_height
= clip_to_bounds (1, max_height
, total_height
);
10407 /* Find out the height of the text in the window. */
10408 if (it
.line_wrap
== TRUNCATE
)
10413 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10414 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10415 height
= it
.current_y
+ last_height
;
10417 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10418 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10419 height
= (height
+ unit
- 1) / unit
;
10422 /* Compute a suitable window start. */
10423 if (height
> max_height
)
10425 height
= max_height
;
10426 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10427 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10428 start
= it
.current
.pos
;
10431 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10432 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10434 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10436 /* Let it grow only, until we display an empty message, in which
10437 case the window shrinks again. */
10438 if (height
> WINDOW_TOTAL_LINES (w
))
10440 int old_height
= WINDOW_TOTAL_LINES (w
);
10441 freeze_window_starts (f
, 1);
10442 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10443 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10445 else if (height
< WINDOW_TOTAL_LINES (w
)
10446 && (exact_p
|| BEGV
== ZV
))
10448 int old_height
= WINDOW_TOTAL_LINES (w
);
10449 freeze_window_starts (f
, 0);
10450 shrink_mini_window (w
);
10451 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10456 /* Always resize to exact size needed. */
10457 if (height
> WINDOW_TOTAL_LINES (w
))
10459 int old_height
= WINDOW_TOTAL_LINES (w
);
10460 freeze_window_starts (f
, 1);
10461 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10462 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10464 else if (height
< WINDOW_TOTAL_LINES (w
))
10466 int old_height
= WINDOW_TOTAL_LINES (w
);
10467 freeze_window_starts (f
, 0);
10468 shrink_mini_window (w
);
10472 freeze_window_starts (f
, 1);
10473 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10476 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10480 if (old_current_buffer
)
10481 set_buffer_internal (old_current_buffer
);
10484 return window_height_changed_p
;
10488 /* Value is the current message, a string, or nil if there is no
10489 current message. */
10492 current_message (void)
10496 if (!BUFFERP (echo_area_buffer
[0]))
10500 with_echo_area_buffer (0, 0, current_message_1
,
10501 (intptr_t) &msg
, Qnil
, 0, 0);
10503 echo_area_buffer
[0] = Qnil
;
10511 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10514 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10517 *msg
= make_buffer_string (BEG
, Z
, 1);
10524 /* Push the current message on Vmessage_stack for later restoration
10525 by restore_message. Value is non-zero if the current message isn't
10526 empty. This is a relatively infrequent operation, so it's not
10527 worth optimizing. */
10530 push_message (void)
10532 Lisp_Object msg
= current_message ();
10533 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10534 return STRINGP (msg
);
10538 /* Restore message display from the top of Vmessage_stack. */
10541 restore_message (void)
10545 eassert (CONSP (Vmessage_stack
));
10546 msg
= XCAR (Vmessage_stack
);
10548 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10550 message3_nolog (msg
, 0, 0);
10554 /* Handler for record_unwind_protect calling pop_message. */
10557 pop_message_unwind (Lisp_Object dummy
)
10563 /* Pop the top-most entry off Vmessage_stack. */
10568 eassert (CONSP (Vmessage_stack
));
10569 Vmessage_stack
= XCDR (Vmessage_stack
);
10573 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10574 exits. If the stack is not empty, we have a missing pop_message
10578 check_message_stack (void)
10580 if (!NILP (Vmessage_stack
))
10585 /* Truncate to NCHARS what will be displayed in the echo area the next
10586 time we display it---but don't redisplay it now. */
10589 truncate_echo_area (ptrdiff_t nchars
)
10592 echo_area_buffer
[0] = Qnil
;
10593 /* A null message buffer means that the frame hasn't really been
10594 initialized yet. Error messages get reported properly by
10595 cmd_error, so this must be just an informative message; toss it. */
10596 else if (!noninteractive
10598 && !NILP (echo_area_buffer
[0]))
10600 struct frame
*sf
= SELECTED_FRAME ();
10601 if (FRAME_MESSAGE_BUF (sf
))
10602 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10607 /* Helper function for truncate_echo_area. Truncate the current
10608 message to at most NCHARS characters. */
10611 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10613 if (BEG
+ nchars
< Z
)
10614 del_range (BEG
+ nchars
, Z
);
10616 echo_area_buffer
[0] = Qnil
;
10620 /* Set the current message to a substring of S or STRING.
10622 If STRING is a Lisp string, set the message to the first NBYTES
10623 bytes from STRING. NBYTES zero means use the whole string. If
10624 STRING is multibyte, the message will be displayed multibyte.
10626 If S is not null, set the message to the first LEN bytes of S. LEN
10627 zero means use the whole string. MULTIBYTE_P non-zero means S is
10628 multibyte. Display the message multibyte in that case.
10630 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10631 to t before calling set_message_1 (which calls insert).
10635 set_message (const char *s
, Lisp_Object string
,
10636 ptrdiff_t nbytes
, int multibyte_p
)
10638 message_enable_multibyte
10639 = ((s
&& multibyte_p
)
10640 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10642 with_echo_area_buffer (0, -1, set_message_1
,
10643 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10644 message_buf_print
= 0;
10645 help_echo_showing_p
= 0;
10647 if (STRINGP (Vdebug_on_message
)
10648 && fast_string_match (Vdebug_on_message
, string
) >= 0)
10649 call_debugger (list2 (Qerror
, string
));
10653 /* Helper function for set_message. Arguments have the same meaning
10654 as there, with A1 corresponding to S and A2 corresponding to STRING
10655 This function is called with the echo area buffer being
10659 set_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t nbytes
, ptrdiff_t multibyte_p
)
10662 const char *s
= (const char *) i1
;
10663 const unsigned char *msg
= (const unsigned char *) s
;
10664 Lisp_Object string
= a2
;
10666 /* Change multibyteness of the echo buffer appropriately. */
10667 if (message_enable_multibyte
10668 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10669 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10671 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
10672 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10673 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
10675 /* Insert new message at BEG. */
10676 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10678 if (STRINGP (string
))
10683 nbytes
= SBYTES (string
);
10684 nchars
= string_byte_to_char (string
, nbytes
);
10686 /* This function takes care of single/multibyte conversion. We
10687 just have to ensure that the echo area buffer has the right
10688 setting of enable_multibyte_characters. */
10689 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10694 nbytes
= strlen (s
);
10696 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10698 /* Convert from multi-byte to single-byte. */
10703 /* Convert a multibyte string to single-byte. */
10704 for (i
= 0; i
< nbytes
; i
+= n
)
10706 c
= string_char_and_length (msg
+ i
, &n
);
10707 work
[0] = (ASCII_CHAR_P (c
)
10709 : multibyte_char_to_unibyte (c
));
10710 insert_1_both (work
, 1, 1, 1, 0, 0);
10713 else if (!multibyte_p
10714 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10716 /* Convert from single-byte to multi-byte. */
10719 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10721 /* Convert a single-byte string to multibyte. */
10722 for (i
= 0; i
< nbytes
; i
++)
10725 MAKE_CHAR_MULTIBYTE (c
);
10726 n
= CHAR_STRING (c
, str
);
10727 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10731 insert_1 (s
, nbytes
, 1, 0, 0);
10738 /* Clear messages. CURRENT_P non-zero means clear the current
10739 message. LAST_DISPLAYED_P non-zero means clear the message
10743 clear_message (int current_p
, int last_displayed_p
)
10747 echo_area_buffer
[0] = Qnil
;
10748 message_cleared_p
= 1;
10751 if (last_displayed_p
)
10752 echo_area_buffer
[1] = Qnil
;
10754 message_buf_print
= 0;
10757 /* Clear garbaged frames.
10759 This function is used where the old redisplay called
10760 redraw_garbaged_frames which in turn called redraw_frame which in
10761 turn called clear_frame. The call to clear_frame was a source of
10762 flickering. I believe a clear_frame is not necessary. It should
10763 suffice in the new redisplay to invalidate all current matrices,
10764 and ensure a complete redisplay of all windows. */
10767 clear_garbaged_frames (void)
10769 if (frame_garbaged
)
10771 Lisp_Object tail
, frame
;
10772 int changed_count
= 0;
10774 FOR_EACH_FRAME (tail
, frame
)
10776 struct frame
*f
= XFRAME (frame
);
10778 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10783 f
->force_flush_display_p
= 1;
10785 clear_current_matrices (f
);
10792 frame_garbaged
= 0;
10794 ++windows_or_buffers_changed
;
10799 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10800 is non-zero update selected_frame. Value is non-zero if the
10801 mini-windows height has been changed. */
10804 echo_area_display (int update_frame_p
)
10806 Lisp_Object mini_window
;
10809 int window_height_changed_p
= 0;
10810 struct frame
*sf
= SELECTED_FRAME ();
10812 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10813 w
= XWINDOW (mini_window
);
10814 f
= XFRAME (WINDOW_FRAME (w
));
10816 /* Don't display if frame is invisible or not yet initialized. */
10817 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10820 #ifdef HAVE_WINDOW_SYSTEM
10821 /* When Emacs starts, selected_frame may be the initial terminal
10822 frame. If we let this through, a message would be displayed on
10824 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10826 #endif /* HAVE_WINDOW_SYSTEM */
10828 /* Redraw garbaged frames. */
10829 clear_garbaged_frames ();
10831 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10833 echo_area_window
= mini_window
;
10834 window_height_changed_p
= display_echo_area (w
);
10835 w
->must_be_updated_p
= 1;
10837 /* Update the display, unless called from redisplay_internal.
10838 Also don't update the screen during redisplay itself. The
10839 update will happen at the end of redisplay, and an update
10840 here could cause confusion. */
10841 if (update_frame_p
&& !redisplaying_p
)
10845 /* If the display update has been interrupted by pending
10846 input, update mode lines in the frame. Due to the
10847 pending input, it might have been that redisplay hasn't
10848 been called, so that mode lines above the echo area are
10849 garbaged. This looks odd, so we prevent it here. */
10850 if (!display_completed
)
10851 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10853 if (window_height_changed_p
10854 /* Don't do this if Emacs is shutting down. Redisplay
10855 needs to run hooks. */
10856 && !NILP (Vrun_hooks
))
10858 /* Must update other windows. Likewise as in other
10859 cases, don't let this update be interrupted by
10861 ptrdiff_t count
= SPECPDL_INDEX ();
10862 specbind (Qredisplay_dont_pause
, Qt
);
10863 windows_or_buffers_changed
= 1;
10864 redisplay_internal ();
10865 unbind_to (count
, Qnil
);
10867 else if (FRAME_WINDOW_P (f
) && n
== 0)
10869 /* Window configuration is the same as before.
10870 Can do with a display update of the echo area,
10871 unless we displayed some mode lines. */
10872 update_single_window (w
, 1);
10873 FRAME_RIF (f
)->flush_display (f
);
10876 update_frame (f
, 1, 1);
10878 /* If cursor is in the echo area, make sure that the next
10879 redisplay displays the minibuffer, so that the cursor will
10880 be replaced with what the minibuffer wants. */
10881 if (cursor_in_echo_area
)
10882 ++windows_or_buffers_changed
;
10885 else if (!EQ (mini_window
, selected_window
))
10886 windows_or_buffers_changed
++;
10888 /* Last displayed message is now the current message. */
10889 echo_area_buffer
[1] = echo_area_buffer
[0];
10890 /* Inform read_char that we're not echoing. */
10891 echo_message_buffer
= Qnil
;
10893 /* Prevent redisplay optimization in redisplay_internal by resetting
10894 this_line_start_pos. This is done because the mini-buffer now
10895 displays the message instead of its buffer text. */
10896 if (EQ (mini_window
, selected_window
))
10897 CHARPOS (this_line_start_pos
) = 0;
10899 return window_height_changed_p
;
10902 /* Nonzero if the current window's buffer is shown in more than one
10903 window and was modified since last redisplay. */
10906 buffer_shared_and_changed (void)
10908 return (buffer_window_count (current_buffer
) > 1
10909 && UNCHANGED_MODIFIED
< MODIFF
);
10912 /* Nonzero if W doesn't reflect the actual state of current buffer due
10913 to its text or overlays change. FIXME: this may be called when
10914 XBUFFER (w->buffer) != current_buffer, which looks suspicious. */
10917 window_outdated (struct window
*w
)
10919 return (w
->last_modified
< MODIFF
10920 || w
->last_overlay_modified
< OVERLAY_MODIFF
);
10923 /* Nonzero if W's buffer was changed but not saved or Transient Mark mode
10924 is enabled and mark of W's buffer was changed since last W's update. */
10927 window_buffer_changed (struct window
*w
)
10929 struct buffer
*b
= XBUFFER (w
->buffer
);
10931 eassert (BUFFER_LIVE_P (b
));
10933 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
)
10934 || ((!NILP (Vtransient_mark_mode
) && !NILP (BVAR (b
, mark_active
)))
10935 != !NILP (w
->region_showing
)));
10938 /* Nonzero if W has %c in its mode line and mode line should be updated. */
10941 mode_line_update_needed (struct window
*w
)
10943 return (!NILP (w
->column_number_displayed
)
10944 && !(PT
== w
->last_point
&& !window_outdated (w
))
10945 && (XFASTINT (w
->column_number_displayed
) != current_column ()));
10948 /***********************************************************************
10949 Mode Lines and Frame Titles
10950 ***********************************************************************/
10952 /* A buffer for constructing non-propertized mode-line strings and
10953 frame titles in it; allocated from the heap in init_xdisp and
10954 resized as needed in store_mode_line_noprop_char. */
10956 static char *mode_line_noprop_buf
;
10958 /* The buffer's end, and a current output position in it. */
10960 static char *mode_line_noprop_buf_end
;
10961 static char *mode_line_noprop_ptr
;
10963 #define MODE_LINE_NOPROP_LEN(start) \
10964 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10967 MODE_LINE_DISPLAY
= 0,
10971 } mode_line_target
;
10973 /* Alist that caches the results of :propertize.
10974 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10975 static Lisp_Object mode_line_proptrans_alist
;
10977 /* List of strings making up the mode-line. */
10978 static Lisp_Object mode_line_string_list
;
10980 /* Base face property when building propertized mode line string. */
10981 static Lisp_Object mode_line_string_face
;
10982 static Lisp_Object mode_line_string_face_prop
;
10985 /* Unwind data for mode line strings */
10987 static Lisp_Object Vmode_line_unwind_vector
;
10990 format_mode_line_unwind_data (struct frame
*target_frame
,
10991 struct buffer
*obuf
,
10993 int save_proptrans
)
10995 Lisp_Object vector
, tmp
;
10997 /* Reduce consing by keeping one vector in
10998 Vwith_echo_area_save_vector. */
10999 vector
= Vmode_line_unwind_vector
;
11000 Vmode_line_unwind_vector
= Qnil
;
11003 vector
= Fmake_vector (make_number (10), Qnil
);
11005 ASET (vector
, 0, make_number (mode_line_target
));
11006 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11007 ASET (vector
, 2, mode_line_string_list
);
11008 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11009 ASET (vector
, 4, mode_line_string_face
);
11010 ASET (vector
, 5, mode_line_string_face_prop
);
11013 XSETBUFFER (tmp
, obuf
);
11016 ASET (vector
, 6, tmp
);
11017 ASET (vector
, 7, owin
);
11020 /* Similarly to `with-selected-window', if the operation selects
11021 a window on another frame, we must restore that frame's
11022 selected window, and (for a tty) the top-frame. */
11023 ASET (vector
, 8, target_frame
->selected_window
);
11024 if (FRAME_TERMCAP_P (target_frame
))
11025 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11032 unwind_format_mode_line (Lisp_Object vector
)
11034 Lisp_Object old_window
= AREF (vector
, 7);
11035 Lisp_Object target_frame_window
= AREF (vector
, 8);
11036 Lisp_Object old_top_frame
= AREF (vector
, 9);
11038 mode_line_target
= XINT (AREF (vector
, 0));
11039 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11040 mode_line_string_list
= AREF (vector
, 2);
11041 if (! EQ (AREF (vector
, 3), Qt
))
11042 mode_line_proptrans_alist
= AREF (vector
, 3);
11043 mode_line_string_face
= AREF (vector
, 4);
11044 mode_line_string_face_prop
= AREF (vector
, 5);
11046 /* Select window before buffer, since it may change the buffer. */
11047 if (!NILP (old_window
))
11049 /* If the operation that we are unwinding had selected a window
11050 on a different frame, reset its frame-selected-window. For a
11051 text terminal, reset its top-frame if necessary. */
11052 if (!NILP (target_frame_window
))
11055 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11057 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11058 Fselect_window (target_frame_window
, Qt
);
11060 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11061 Fselect_frame (old_top_frame
, Qt
);
11064 Fselect_window (old_window
, Qt
);
11067 if (!NILP (AREF (vector
, 6)))
11069 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11070 ASET (vector
, 6, Qnil
);
11073 Vmode_line_unwind_vector
= vector
;
11078 /* Store a single character C for the frame title in mode_line_noprop_buf.
11079 Re-allocate mode_line_noprop_buf if necessary. */
11082 store_mode_line_noprop_char (char c
)
11084 /* If output position has reached the end of the allocated buffer,
11085 increase the buffer's size. */
11086 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11088 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11089 ptrdiff_t size
= len
;
11090 mode_line_noprop_buf
=
11091 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11092 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11093 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11096 *mode_line_noprop_ptr
++ = c
;
11100 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11101 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11102 characters that yield more columns than PRECISION; PRECISION <= 0
11103 means copy the whole string. Pad with spaces until FIELD_WIDTH
11104 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11105 pad. Called from display_mode_element when it is used to build a
11109 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11111 const unsigned char *str
= (const unsigned char *) string
;
11113 ptrdiff_t dummy
, nbytes
;
11115 /* Copy at most PRECISION chars from STR. */
11116 nbytes
= strlen (string
);
11117 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11119 store_mode_line_noprop_char (*str
++);
11121 /* Fill up with spaces until FIELD_WIDTH reached. */
11122 while (field_width
> 0
11123 && n
< field_width
)
11125 store_mode_line_noprop_char (' ');
11132 /***********************************************************************
11134 ***********************************************************************/
11136 #ifdef HAVE_WINDOW_SYSTEM
11138 /* Set the title of FRAME, if it has changed. The title format is
11139 Vicon_title_format if FRAME is iconified, otherwise it is
11140 frame_title_format. */
11143 x_consider_frame_title (Lisp_Object frame
)
11145 struct frame
*f
= XFRAME (frame
);
11147 if (FRAME_WINDOW_P (f
)
11148 || FRAME_MINIBUF_ONLY_P (f
)
11149 || f
->explicit_name
)
11151 /* Do we have more than one visible frame on this X display? */
11152 Lisp_Object tail
, other_frame
, fmt
;
11153 ptrdiff_t title_start
;
11157 ptrdiff_t count
= SPECPDL_INDEX ();
11159 FOR_EACH_FRAME (tail
, other_frame
)
11161 struct frame
*tf
= XFRAME (other_frame
);
11164 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11165 && !FRAME_MINIBUF_ONLY_P (tf
)
11166 && !EQ (other_frame
, tip_frame
)
11167 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11171 /* Set global variable indicating that multiple frames exist. */
11172 multiple_frames
= CONSP (tail
);
11174 /* Switch to the buffer of selected window of the frame. Set up
11175 mode_line_target so that display_mode_element will output into
11176 mode_line_noprop_buf; then display the title. */
11177 record_unwind_protect (unwind_format_mode_line
,
11178 format_mode_line_unwind_data
11179 (f
, current_buffer
, selected_window
, 0));
11181 Fselect_window (f
->selected_window
, Qt
);
11182 set_buffer_internal_1
11183 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
11184 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11186 mode_line_target
= MODE_LINE_TITLE
;
11187 title_start
= MODE_LINE_NOPROP_LEN (0);
11188 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11189 NULL
, DEFAULT_FACE_ID
);
11190 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11191 len
= MODE_LINE_NOPROP_LEN (title_start
);
11192 title
= mode_line_noprop_buf
+ title_start
;
11193 unbind_to (count
, Qnil
);
11195 /* Set the title only if it's changed. This avoids consing in
11196 the common case where it hasn't. (If it turns out that we've
11197 already wasted too much time by walking through the list with
11198 display_mode_element, then we might need to optimize at a
11199 higher level than this.) */
11200 if (! STRINGP (f
->name
)
11201 || SBYTES (f
->name
) != len
11202 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11203 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11207 #endif /* not HAVE_WINDOW_SYSTEM */
11210 /***********************************************************************
11212 ***********************************************************************/
11215 /* Prepare for redisplay by updating menu-bar item lists when
11216 appropriate. This can call eval. */
11219 prepare_menu_bars (void)
11222 struct gcpro gcpro1
, gcpro2
;
11224 Lisp_Object tooltip_frame
;
11226 #ifdef HAVE_WINDOW_SYSTEM
11227 tooltip_frame
= tip_frame
;
11229 tooltip_frame
= Qnil
;
11232 /* Update all frame titles based on their buffer names, etc. We do
11233 this before the menu bars so that the buffer-menu will show the
11234 up-to-date frame titles. */
11235 #ifdef HAVE_WINDOW_SYSTEM
11236 if (windows_or_buffers_changed
|| update_mode_lines
)
11238 Lisp_Object tail
, frame
;
11240 FOR_EACH_FRAME (tail
, frame
)
11242 f
= XFRAME (frame
);
11243 if (!EQ (frame
, tooltip_frame
)
11244 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
11245 x_consider_frame_title (frame
);
11248 #endif /* HAVE_WINDOW_SYSTEM */
11250 /* Update the menu bar item lists, if appropriate. This has to be
11251 done before any actual redisplay or generation of display lines. */
11252 all_windows
= (update_mode_lines
11253 || buffer_shared_and_changed ()
11254 || windows_or_buffers_changed
);
11257 Lisp_Object tail
, frame
;
11258 ptrdiff_t count
= SPECPDL_INDEX ();
11259 /* 1 means that update_menu_bar has run its hooks
11260 so any further calls to update_menu_bar shouldn't do so again. */
11261 int menu_bar_hooks_run
= 0;
11263 record_unwind_save_match_data ();
11265 FOR_EACH_FRAME (tail
, frame
)
11267 f
= XFRAME (frame
);
11269 /* Ignore tooltip frame. */
11270 if (EQ (frame
, tooltip_frame
))
11273 /* If a window on this frame changed size, report that to
11274 the user and clear the size-change flag. */
11275 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11277 Lisp_Object functions
;
11279 /* Clear flag first in case we get an error below. */
11280 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11281 functions
= Vwindow_size_change_functions
;
11282 GCPRO2 (tail
, functions
);
11284 while (CONSP (functions
))
11286 if (!EQ (XCAR (functions
), Qt
))
11287 call1 (XCAR (functions
), frame
);
11288 functions
= XCDR (functions
);
11294 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11295 #ifdef HAVE_WINDOW_SYSTEM
11296 update_tool_bar (f
, 0);
11299 if (windows_or_buffers_changed
11302 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->buffer
));
11307 unbind_to (count
, Qnil
);
11311 struct frame
*sf
= SELECTED_FRAME ();
11312 update_menu_bar (sf
, 1, 0);
11313 #ifdef HAVE_WINDOW_SYSTEM
11314 update_tool_bar (sf
, 1);
11320 /* Update the menu bar item list for frame F. This has to be done
11321 before we start to fill in any display lines, because it can call
11324 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11326 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11327 already ran the menu bar hooks for this redisplay, so there
11328 is no need to run them again. The return value is the
11329 updated value of this flag, to pass to the next call. */
11332 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11334 Lisp_Object window
;
11335 register struct window
*w
;
11337 /* If called recursively during a menu update, do nothing. This can
11338 happen when, for instance, an activate-menubar-hook causes a
11340 if (inhibit_menubar_update
)
11343 window
= FRAME_SELECTED_WINDOW (f
);
11344 w
= XWINDOW (window
);
11346 if (FRAME_WINDOW_P (f
)
11348 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11349 || defined (HAVE_NS) || defined (USE_GTK)
11350 FRAME_EXTERNAL_MENU_BAR (f
)
11352 FRAME_MENU_BAR_LINES (f
) > 0
11354 : FRAME_MENU_BAR_LINES (f
) > 0)
11356 /* If the user has switched buffers or windows, we need to
11357 recompute to reflect the new bindings. But we'll
11358 recompute when update_mode_lines is set too; that means
11359 that people can use force-mode-line-update to request
11360 that the menu bar be recomputed. The adverse effect on
11361 the rest of the redisplay algorithm is about the same as
11362 windows_or_buffers_changed anyway. */
11363 if (windows_or_buffers_changed
11364 /* This used to test w->update_mode_line, but we believe
11365 there is no need to recompute the menu in that case. */
11366 || update_mode_lines
11367 || window_buffer_changed (w
))
11369 struct buffer
*prev
= current_buffer
;
11370 ptrdiff_t count
= SPECPDL_INDEX ();
11372 specbind (Qinhibit_menubar_update
, Qt
);
11374 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11375 if (save_match_data
)
11376 record_unwind_save_match_data ();
11377 if (NILP (Voverriding_local_map_menu_flag
))
11379 specbind (Qoverriding_terminal_local_map
, Qnil
);
11380 specbind (Qoverriding_local_map
, Qnil
);
11385 /* Run the Lucid hook. */
11386 safe_run_hooks (Qactivate_menubar_hook
);
11388 /* If it has changed current-menubar from previous value,
11389 really recompute the menu-bar from the value. */
11390 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11391 call0 (Qrecompute_lucid_menubar
);
11393 safe_run_hooks (Qmenu_bar_update_hook
);
11398 XSETFRAME (Vmenu_updating_frame
, f
);
11399 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11401 /* Redisplay the menu bar in case we changed it. */
11402 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11403 || defined (HAVE_NS) || defined (USE_GTK)
11404 if (FRAME_WINDOW_P (f
))
11406 #if defined (HAVE_NS)
11407 /* All frames on Mac OS share the same menubar. So only
11408 the selected frame should be allowed to set it. */
11409 if (f
== SELECTED_FRAME ())
11411 set_frame_menubar (f
, 0, 0);
11414 /* On a terminal screen, the menu bar is an ordinary screen
11415 line, and this makes it get updated. */
11416 w
->update_mode_line
= 1;
11417 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11418 /* In the non-toolkit version, the menu bar is an ordinary screen
11419 line, and this makes it get updated. */
11420 w
->update_mode_line
= 1;
11421 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11423 unbind_to (count
, Qnil
);
11424 set_buffer_internal_1 (prev
);
11433 /***********************************************************************
11435 ***********************************************************************/
11437 #ifdef HAVE_WINDOW_SYSTEM
11440 Nominal cursor position -- where to draw output.
11441 HPOS and VPOS are window relative glyph matrix coordinates.
11442 X and Y are window relative pixel coordinates. */
11444 struct cursor_pos output_cursor
;
11448 Set the global variable output_cursor to CURSOR. All cursor
11449 positions are relative to updated_window. */
11452 set_output_cursor (struct cursor_pos
*cursor
)
11454 output_cursor
.hpos
= cursor
->hpos
;
11455 output_cursor
.vpos
= cursor
->vpos
;
11456 output_cursor
.x
= cursor
->x
;
11457 output_cursor
.y
= cursor
->y
;
11462 Set a nominal cursor position.
11464 HPOS and VPOS are column/row positions in a window glyph matrix. X
11465 and Y are window text area relative pixel positions.
11467 If this is done during an update, updated_window will contain the
11468 window that is being updated and the position is the future output
11469 cursor position for that window. If updated_window is null, use
11470 selected_window and display the cursor at the given position. */
11473 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11477 /* If updated_window is not set, work on selected_window. */
11478 if (updated_window
)
11479 w
= updated_window
;
11481 w
= XWINDOW (selected_window
);
11483 /* Set the output cursor. */
11484 output_cursor
.hpos
= hpos
;
11485 output_cursor
.vpos
= vpos
;
11486 output_cursor
.x
= x
;
11487 output_cursor
.y
= y
;
11489 /* If not called as part of an update, really display the cursor.
11490 This will also set the cursor position of W. */
11491 if (updated_window
== NULL
)
11494 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11495 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11496 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11501 #endif /* HAVE_WINDOW_SYSTEM */
11504 /***********************************************************************
11506 ***********************************************************************/
11508 #ifdef HAVE_WINDOW_SYSTEM
11510 /* Where the mouse was last time we reported a mouse event. */
11512 FRAME_PTR last_mouse_frame
;
11514 /* Tool-bar item index of the item on which a mouse button was pressed
11517 int last_tool_bar_item
;
11519 /* Select `frame' temporarily without running all the code in
11521 FIXME: Maybe do_switch_frame should be trimmed down similarly
11522 when `norecord' is set. */
11524 fast_set_selected_frame (Lisp_Object frame
)
11526 if (!EQ (selected_frame
, frame
))
11528 selected_frame
= frame
;
11529 selected_window
= XFRAME (frame
)->selected_window
;
11534 /* Update the tool-bar item list for frame F. This has to be done
11535 before we start to fill in any display lines. Called from
11536 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11537 and restore it here. */
11540 update_tool_bar (struct frame
*f
, int save_match_data
)
11542 #if defined (USE_GTK) || defined (HAVE_NS)
11543 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11545 int do_update
= WINDOWP (f
->tool_bar_window
)
11546 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11551 Lisp_Object window
;
11554 window
= FRAME_SELECTED_WINDOW (f
);
11555 w
= XWINDOW (window
);
11557 /* If the user has switched buffers or windows, we need to
11558 recompute to reflect the new bindings. But we'll
11559 recompute when update_mode_lines is set too; that means
11560 that people can use force-mode-line-update to request
11561 that the menu bar be recomputed. The adverse effect on
11562 the rest of the redisplay algorithm is about the same as
11563 windows_or_buffers_changed anyway. */
11564 if (windows_or_buffers_changed
11565 || w
->update_mode_line
11566 || update_mode_lines
11567 || window_buffer_changed (w
))
11569 struct buffer
*prev
= current_buffer
;
11570 ptrdiff_t count
= SPECPDL_INDEX ();
11571 Lisp_Object frame
, new_tool_bar
;
11572 int new_n_tool_bar
;
11573 struct gcpro gcpro1
;
11575 /* Set current_buffer to the buffer of the selected
11576 window of the frame, so that we get the right local
11578 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11580 /* Save match data, if we must. */
11581 if (save_match_data
)
11582 record_unwind_save_match_data ();
11584 /* Make sure that we don't accidentally use bogus keymaps. */
11585 if (NILP (Voverriding_local_map_menu_flag
))
11587 specbind (Qoverriding_terminal_local_map
, Qnil
);
11588 specbind (Qoverriding_local_map
, Qnil
);
11591 GCPRO1 (new_tool_bar
);
11593 /* We must temporarily set the selected frame to this frame
11594 before calling tool_bar_items, because the calculation of
11595 the tool-bar keymap uses the selected frame (see
11596 `tool-bar-make-keymap' in tool-bar.el). */
11597 eassert (EQ (selected_window
,
11598 /* Since we only explicitly preserve selected_frame,
11599 check that selected_window would be redundant. */
11600 XFRAME (selected_frame
)->selected_window
));
11601 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11602 XSETFRAME (frame
, f
);
11603 fast_set_selected_frame (frame
);
11605 /* Build desired tool-bar items from keymaps. */
11607 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11610 /* Redisplay the tool-bar if we changed it. */
11611 if (new_n_tool_bar
!= f
->n_tool_bar_items
11612 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11614 /* Redisplay that happens asynchronously due to an expose event
11615 may access f->tool_bar_items. Make sure we update both
11616 variables within BLOCK_INPUT so no such event interrupts. */
11618 fset_tool_bar_items (f
, new_tool_bar
);
11619 f
->n_tool_bar_items
= new_n_tool_bar
;
11620 w
->update_mode_line
= 1;
11626 unbind_to (count
, Qnil
);
11627 set_buffer_internal_1 (prev
);
11633 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11634 F's desired tool-bar contents. F->tool_bar_items must have
11635 been set up previously by calling prepare_menu_bars. */
11638 build_desired_tool_bar_string (struct frame
*f
)
11640 int i
, size
, size_needed
;
11641 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11642 Lisp_Object image
, plist
, props
;
11644 image
= plist
= props
= Qnil
;
11645 GCPRO3 (image
, plist
, props
);
11647 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11648 Otherwise, make a new string. */
11650 /* The size of the string we might be able to reuse. */
11651 size
= (STRINGP (f
->desired_tool_bar_string
)
11652 ? SCHARS (f
->desired_tool_bar_string
)
11655 /* We need one space in the string for each image. */
11656 size_needed
= f
->n_tool_bar_items
;
11658 /* Reuse f->desired_tool_bar_string, if possible. */
11659 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11660 fset_desired_tool_bar_string
11661 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11664 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11665 Fremove_text_properties (make_number (0), make_number (size
),
11666 props
, f
->desired_tool_bar_string
);
11669 /* Put a `display' property on the string for the images to display,
11670 put a `menu_item' property on tool-bar items with a value that
11671 is the index of the item in F's tool-bar item vector. */
11672 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11674 #define PROP(IDX) \
11675 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11677 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11678 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11679 int hmargin
, vmargin
, relief
, idx
, end
;
11681 /* If image is a vector, choose the image according to the
11683 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11684 if (VECTORP (image
))
11688 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11689 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11692 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11693 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11695 eassert (ASIZE (image
) >= idx
);
11696 image
= AREF (image
, idx
);
11701 /* Ignore invalid image specifications. */
11702 if (!valid_image_p (image
))
11705 /* Display the tool-bar button pressed, or depressed. */
11706 plist
= Fcopy_sequence (XCDR (image
));
11708 /* Compute margin and relief to draw. */
11709 relief
= (tool_bar_button_relief
>= 0
11710 ? tool_bar_button_relief
11711 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11712 hmargin
= vmargin
= relief
;
11714 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11715 INT_MAX
- max (hmargin
, vmargin
)))
11717 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11718 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11720 else if (CONSP (Vtool_bar_button_margin
))
11722 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11723 INT_MAX
- hmargin
))
11724 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11726 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11727 INT_MAX
- vmargin
))
11728 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11731 if (auto_raise_tool_bar_buttons_p
)
11733 /* Add a `:relief' property to the image spec if the item is
11737 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11744 /* If image is selected, display it pressed, i.e. with a
11745 negative relief. If it's not selected, display it with a
11747 plist
= Fplist_put (plist
, QCrelief
,
11749 ? make_number (-relief
)
11750 : make_number (relief
)));
11755 /* Put a margin around the image. */
11756 if (hmargin
|| vmargin
)
11758 if (hmargin
== vmargin
)
11759 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11761 plist
= Fplist_put (plist
, QCmargin
,
11762 Fcons (make_number (hmargin
),
11763 make_number (vmargin
)));
11766 /* If button is not enabled, and we don't have special images
11767 for the disabled state, make the image appear disabled by
11768 applying an appropriate algorithm to it. */
11769 if (!enabled_p
&& idx
< 0)
11770 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11772 /* Put a `display' text property on the string for the image to
11773 display. Put a `menu-item' property on the string that gives
11774 the start of this item's properties in the tool-bar items
11776 image
= Fcons (Qimage
, plist
);
11777 props
= list4 (Qdisplay
, image
,
11778 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11780 /* Let the last image hide all remaining spaces in the tool bar
11781 string. The string can be longer than needed when we reuse a
11782 previous string. */
11783 if (i
+ 1 == f
->n_tool_bar_items
)
11784 end
= SCHARS (f
->desired_tool_bar_string
);
11787 Fadd_text_properties (make_number (i
), make_number (end
),
11788 props
, f
->desired_tool_bar_string
);
11796 /* Display one line of the tool-bar of frame IT->f.
11798 HEIGHT specifies the desired height of the tool-bar line.
11799 If the actual height of the glyph row is less than HEIGHT, the
11800 row's height is increased to HEIGHT, and the icons are centered
11801 vertically in the new height.
11803 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11804 count a final empty row in case the tool-bar width exactly matches
11809 display_tool_bar_line (struct it
*it
, int height
)
11811 struct glyph_row
*row
= it
->glyph_row
;
11812 int max_x
= it
->last_visible_x
;
11813 struct glyph
*last
;
11815 prepare_desired_row (row
);
11816 row
->y
= it
->current_y
;
11818 /* Note that this isn't made use of if the face hasn't a box,
11819 so there's no need to check the face here. */
11820 it
->start_of_box_run_p
= 1;
11822 while (it
->current_x
< max_x
)
11824 int x
, n_glyphs_before
, i
, nglyphs
;
11825 struct it it_before
;
11827 /* Get the next display element. */
11828 if (!get_next_display_element (it
))
11830 /* Don't count empty row if we are counting needed tool-bar lines. */
11831 if (height
< 0 && !it
->hpos
)
11836 /* Produce glyphs. */
11837 n_glyphs_before
= row
->used
[TEXT_AREA
];
11840 PRODUCE_GLYPHS (it
);
11842 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11844 x
= it_before
.current_x
;
11845 while (i
< nglyphs
)
11847 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11849 if (x
+ glyph
->pixel_width
> max_x
)
11851 /* Glyph doesn't fit on line. Backtrack. */
11852 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11854 /* If this is the only glyph on this line, it will never fit on the
11855 tool-bar, so skip it. But ensure there is at least one glyph,
11856 so we don't accidentally disable the tool-bar. */
11857 if (n_glyphs_before
== 0
11858 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11864 x
+= glyph
->pixel_width
;
11868 /* Stop at line end. */
11869 if (ITERATOR_AT_END_OF_LINE_P (it
))
11872 set_iterator_to_next (it
, 1);
11877 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11879 /* Use default face for the border below the tool bar.
11881 FIXME: When auto-resize-tool-bars is grow-only, there is
11882 no additional border below the possibly empty tool-bar lines.
11883 So to make the extra empty lines look "normal", we have to
11884 use the tool-bar face for the border too. */
11885 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11886 it
->face_id
= DEFAULT_FACE_ID
;
11888 extend_face_to_end_of_line (it
);
11889 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11890 last
->right_box_line_p
= 1;
11891 if (last
== row
->glyphs
[TEXT_AREA
])
11892 last
->left_box_line_p
= 1;
11894 /* Make line the desired height and center it vertically. */
11895 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11897 /* Don't add more than one line height. */
11898 height
%= FRAME_LINE_HEIGHT (it
->f
);
11899 it
->max_ascent
+= height
/ 2;
11900 it
->max_descent
+= (height
+ 1) / 2;
11903 compute_line_metrics (it
);
11905 /* If line is empty, make it occupy the rest of the tool-bar. */
11906 if (!row
->displays_text_p
)
11908 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11909 row
->visible_height
= row
->height
;
11910 row
->ascent
= row
->phys_ascent
= 0;
11911 row
->extra_line_spacing
= 0;
11914 row
->full_width_p
= 1;
11915 row
->continued_p
= 0;
11916 row
->truncated_on_left_p
= 0;
11917 row
->truncated_on_right_p
= 0;
11919 it
->current_x
= it
->hpos
= 0;
11920 it
->current_y
+= row
->height
;
11926 /* Max tool-bar height. */
11928 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11929 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11931 /* Value is the number of screen lines needed to make all tool-bar
11932 items of frame F visible. The number of actual rows needed is
11933 returned in *N_ROWS if non-NULL. */
11936 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11938 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11940 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11941 the desired matrix, so use (unused) mode-line row as temporary row to
11942 avoid destroying the first tool-bar row. */
11943 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11945 /* Initialize an iterator for iteration over
11946 F->desired_tool_bar_string in the tool-bar window of frame F. */
11947 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11948 it
.first_visible_x
= 0;
11949 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11950 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11951 it
.paragraph_embedding
= L2R
;
11953 while (!ITERATOR_AT_END_P (&it
))
11955 clear_glyph_row (temp_row
);
11956 it
.glyph_row
= temp_row
;
11957 display_tool_bar_line (&it
, -1);
11959 clear_glyph_row (temp_row
);
11961 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11963 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11965 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11969 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11971 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
11972 If FRAME is nil or omitted, use the selected frame. */)
11973 (Lisp_Object frame
)
11975 struct frame
*f
= decode_any_frame (frame
);
11979 if (WINDOWP (f
->tool_bar_window
)
11980 && (w
= XWINDOW (f
->tool_bar_window
),
11981 WINDOW_TOTAL_LINES (w
) > 0))
11983 update_tool_bar (f
, 1);
11984 if (f
->n_tool_bar_items
)
11986 build_desired_tool_bar_string (f
);
11987 nlines
= tool_bar_lines_needed (f
, NULL
);
11991 return make_number (nlines
);
11995 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11996 height should be changed. */
11999 redisplay_tool_bar (struct frame
*f
)
12003 struct glyph_row
*row
;
12005 #if defined (USE_GTK) || defined (HAVE_NS)
12006 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12007 update_frame_tool_bar (f
);
12011 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12012 do anything. This means you must start with tool-bar-lines
12013 non-zero to get the auto-sizing effect. Or in other words, you
12014 can turn off tool-bars by specifying tool-bar-lines zero. */
12015 if (!WINDOWP (f
->tool_bar_window
)
12016 || (w
= XWINDOW (f
->tool_bar_window
),
12017 WINDOW_TOTAL_LINES (w
) == 0))
12020 /* Set up an iterator for the tool-bar window. */
12021 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12022 it
.first_visible_x
= 0;
12023 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
12024 row
= it
.glyph_row
;
12026 /* Build a string that represents the contents of the tool-bar. */
12027 build_desired_tool_bar_string (f
);
12028 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12029 /* FIXME: This should be controlled by a user option. But it
12030 doesn't make sense to have an R2L tool bar if the menu bar cannot
12031 be drawn also R2L, and making the menu bar R2L is tricky due
12032 toolkit-specific code that implements it. If an R2L tool bar is
12033 ever supported, display_tool_bar_line should also be augmented to
12034 call unproduce_glyphs like display_line and display_string
12036 it
.paragraph_embedding
= L2R
;
12038 if (f
->n_tool_bar_rows
== 0)
12042 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
12043 nlines
!= WINDOW_TOTAL_LINES (w
)))
12046 int old_height
= WINDOW_TOTAL_LINES (w
);
12048 XSETFRAME (frame
, f
);
12049 Fmodify_frame_parameters (frame
,
12050 Fcons (Fcons (Qtool_bar_lines
,
12051 make_number (nlines
)),
12053 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12055 clear_glyph_matrix (w
->desired_matrix
);
12056 fonts_changed_p
= 1;
12062 /* Display as many lines as needed to display all tool-bar items. */
12064 if (f
->n_tool_bar_rows
> 0)
12066 int border
, rows
, height
, extra
;
12068 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12069 border
= XINT (Vtool_bar_border
);
12070 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12071 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12072 else if (EQ (Vtool_bar_border
, Qborder_width
))
12073 border
= f
->border_width
;
12079 rows
= f
->n_tool_bar_rows
;
12080 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12081 extra
= it
.last_visible_y
- border
- height
* rows
;
12083 while (it
.current_y
< it
.last_visible_y
)
12086 if (extra
> 0 && rows
-- > 0)
12088 h
= (extra
+ rows
- 1) / rows
;
12091 display_tool_bar_line (&it
, height
+ h
);
12096 while (it
.current_y
< it
.last_visible_y
)
12097 display_tool_bar_line (&it
, 0);
12100 /* It doesn't make much sense to try scrolling in the tool-bar
12101 window, so don't do it. */
12102 w
->desired_matrix
->no_scrolling_p
= 1;
12103 w
->must_be_updated_p
= 1;
12105 if (!NILP (Vauto_resize_tool_bars
))
12107 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12108 int change_height_p
= 0;
12110 /* If we couldn't display everything, change the tool-bar's
12111 height if there is room for more. */
12112 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12113 && it
.current_y
< max_tool_bar_height
)
12114 change_height_p
= 1;
12116 row
= it
.glyph_row
- 1;
12118 /* If there are blank lines at the end, except for a partially
12119 visible blank line at the end that is smaller than
12120 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12121 if (!row
->displays_text_p
12122 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12123 change_height_p
= 1;
12125 /* If row displays tool-bar items, but is partially visible,
12126 change the tool-bar's height. */
12127 if (row
->displays_text_p
12128 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12129 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12130 change_height_p
= 1;
12132 /* Resize windows as needed by changing the `tool-bar-lines'
12133 frame parameter. */
12134 if (change_height_p
)
12137 int old_height
= WINDOW_TOTAL_LINES (w
);
12139 int nlines
= tool_bar_lines_needed (f
, &nrows
);
12141 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12142 && !f
->minimize_tool_bar_window_p
)
12143 ? (nlines
> old_height
)
12144 : (nlines
!= old_height
));
12145 f
->minimize_tool_bar_window_p
= 0;
12147 if (change_height_p
)
12149 XSETFRAME (frame
, f
);
12150 Fmodify_frame_parameters (frame
,
12151 Fcons (Fcons (Qtool_bar_lines
,
12152 make_number (nlines
)),
12154 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12156 clear_glyph_matrix (w
->desired_matrix
);
12157 f
->n_tool_bar_rows
= nrows
;
12158 fonts_changed_p
= 1;
12165 f
->minimize_tool_bar_window_p
= 0;
12170 /* Get information about the tool-bar item which is displayed in GLYPH
12171 on frame F. Return in *PROP_IDX the index where tool-bar item
12172 properties start in F->tool_bar_items. Value is zero if
12173 GLYPH doesn't display a tool-bar item. */
12176 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12182 /* This function can be called asynchronously, which means we must
12183 exclude any possibility that Fget_text_property signals an
12185 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12186 charpos
= max (0, charpos
);
12188 /* Get the text property `menu-item' at pos. The value of that
12189 property is the start index of this item's properties in
12190 F->tool_bar_items. */
12191 prop
= Fget_text_property (make_number (charpos
),
12192 Qmenu_item
, f
->current_tool_bar_string
);
12193 if (INTEGERP (prop
))
12195 *prop_idx
= XINT (prop
);
12205 /* Get information about the tool-bar item at position X/Y on frame F.
12206 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12207 the current matrix of the tool-bar window of F, or NULL if not
12208 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12209 item in F->tool_bar_items. Value is
12211 -1 if X/Y is not on a tool-bar item
12212 0 if X/Y is on the same item that was highlighted before.
12216 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12217 int *hpos
, int *vpos
, int *prop_idx
)
12219 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12220 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12223 /* Find the glyph under X/Y. */
12224 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12225 if (*glyph
== NULL
)
12228 /* Get the start of this tool-bar item's properties in
12229 f->tool_bar_items. */
12230 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12233 /* Is mouse on the highlighted item? */
12234 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12235 && *vpos
>= hlinfo
->mouse_face_beg_row
12236 && *vpos
<= hlinfo
->mouse_face_end_row
12237 && (*vpos
> hlinfo
->mouse_face_beg_row
12238 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12239 && (*vpos
< hlinfo
->mouse_face_end_row
12240 || *hpos
< hlinfo
->mouse_face_end_col
12241 || hlinfo
->mouse_face_past_end
))
12249 Handle mouse button event on the tool-bar of frame F, at
12250 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12251 0 for button release. MODIFIERS is event modifiers for button
12255 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12258 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12259 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12260 int hpos
, vpos
, prop_idx
;
12261 struct glyph
*glyph
;
12262 Lisp_Object enabled_p
;
12264 /* If not on the highlighted tool-bar item, return. */
12265 frame_to_window_pixel_xy (w
, &x
, &y
);
12266 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12269 /* If item is disabled, do nothing. */
12270 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12271 if (NILP (enabled_p
))
12276 /* Show item in pressed state. */
12277 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12278 last_tool_bar_item
= prop_idx
;
12282 Lisp_Object key
, frame
;
12283 struct input_event event
;
12284 EVENT_INIT (event
);
12286 /* Show item in released state. */
12287 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12289 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12291 XSETFRAME (frame
, f
);
12292 event
.kind
= TOOL_BAR_EVENT
;
12293 event
.frame_or_window
= frame
;
12295 kbd_buffer_store_event (&event
);
12297 event
.kind
= TOOL_BAR_EVENT
;
12298 event
.frame_or_window
= frame
;
12300 event
.modifiers
= modifiers
;
12301 kbd_buffer_store_event (&event
);
12302 last_tool_bar_item
= -1;
12307 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12308 tool-bar window-relative coordinates X/Y. Called from
12309 note_mouse_highlight. */
12312 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12314 Lisp_Object window
= f
->tool_bar_window
;
12315 struct window
*w
= XWINDOW (window
);
12316 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12317 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12319 struct glyph
*glyph
;
12320 struct glyph_row
*row
;
12322 Lisp_Object enabled_p
;
12324 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12325 int mouse_down_p
, rc
;
12327 /* Function note_mouse_highlight is called with negative X/Y
12328 values when mouse moves outside of the frame. */
12329 if (x
<= 0 || y
<= 0)
12331 clear_mouse_face (hlinfo
);
12335 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12338 /* Not on tool-bar item. */
12339 clear_mouse_face (hlinfo
);
12343 /* On same tool-bar item as before. */
12344 goto set_help_echo
;
12346 clear_mouse_face (hlinfo
);
12348 /* Mouse is down, but on different tool-bar item? */
12349 mouse_down_p
= (dpyinfo
->grabbed
12350 && f
== last_mouse_frame
12351 && FRAME_LIVE_P (f
));
12353 && last_tool_bar_item
!= prop_idx
)
12356 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12358 /* If tool-bar item is not enabled, don't highlight it. */
12359 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12360 if (!NILP (enabled_p
))
12362 /* Compute the x-position of the glyph. In front and past the
12363 image is a space. We include this in the highlighted area. */
12364 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12365 for (i
= x
= 0; i
< hpos
; ++i
)
12366 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12368 /* Record this as the current active region. */
12369 hlinfo
->mouse_face_beg_col
= hpos
;
12370 hlinfo
->mouse_face_beg_row
= vpos
;
12371 hlinfo
->mouse_face_beg_x
= x
;
12372 hlinfo
->mouse_face_beg_y
= row
->y
;
12373 hlinfo
->mouse_face_past_end
= 0;
12375 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12376 hlinfo
->mouse_face_end_row
= vpos
;
12377 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12378 hlinfo
->mouse_face_end_y
= row
->y
;
12379 hlinfo
->mouse_face_window
= window
;
12380 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12382 /* Display it as active. */
12383 show_mouse_face (hlinfo
, draw
);
12388 /* Set help_echo_string to a help string to display for this tool-bar item.
12389 XTread_socket does the rest. */
12390 help_echo_object
= help_echo_window
= Qnil
;
12391 help_echo_pos
= -1;
12392 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12393 if (NILP (help_echo_string
))
12394 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12397 #endif /* HAVE_WINDOW_SYSTEM */
12401 /************************************************************************
12402 Horizontal scrolling
12403 ************************************************************************/
12405 static int hscroll_window_tree (Lisp_Object
);
12406 static int hscroll_windows (Lisp_Object
);
12408 /* For all leaf windows in the window tree rooted at WINDOW, set their
12409 hscroll value so that PT is (i) visible in the window, and (ii) so
12410 that it is not within a certain margin at the window's left and
12411 right border. Value is non-zero if any window's hscroll has been
12415 hscroll_window_tree (Lisp_Object window
)
12417 int hscrolled_p
= 0;
12418 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12419 int hscroll_step_abs
= 0;
12420 double hscroll_step_rel
= 0;
12422 if (hscroll_relative_p
)
12424 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12425 if (hscroll_step_rel
< 0)
12427 hscroll_relative_p
= 0;
12428 hscroll_step_abs
= 0;
12431 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12433 hscroll_step_abs
= XINT (Vhscroll_step
);
12434 if (hscroll_step_abs
< 0)
12435 hscroll_step_abs
= 0;
12438 hscroll_step_abs
= 0;
12440 while (WINDOWP (window
))
12442 struct window
*w
= XWINDOW (window
);
12444 if (WINDOWP (w
->hchild
))
12445 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12446 else if (WINDOWP (w
->vchild
))
12447 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12448 else if (w
->cursor
.vpos
>= 0)
12451 int text_area_width
;
12452 struct glyph_row
*current_cursor_row
12453 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12454 struct glyph_row
*desired_cursor_row
12455 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12456 struct glyph_row
*cursor_row
12457 = (desired_cursor_row
->enabled_p
12458 ? desired_cursor_row
12459 : current_cursor_row
);
12460 int row_r2l_p
= cursor_row
->reversed_p
;
12462 text_area_width
= window_box_width (w
, TEXT_AREA
);
12464 /* Scroll when cursor is inside this scroll margin. */
12465 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12467 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12468 /* For left-to-right rows, hscroll when cursor is either
12469 (i) inside the right hscroll margin, or (ii) if it is
12470 inside the left margin and the window is already
12474 && w
->cursor
.x
<= h_margin
)
12475 || (cursor_row
->enabled_p
12476 && cursor_row
->truncated_on_right_p
12477 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12478 /* For right-to-left rows, the logic is similar,
12479 except that rules for scrolling to left and right
12480 are reversed. E.g., if cursor.x <= h_margin, we
12481 need to hscroll "to the right" unconditionally,
12482 and that will scroll the screen to the left so as
12483 to reveal the next portion of the row. */
12485 && ((cursor_row
->enabled_p
12486 /* FIXME: It is confusing to set the
12487 truncated_on_right_p flag when R2L rows
12488 are actually truncated on the left. */
12489 && cursor_row
->truncated_on_right_p
12490 && w
->cursor
.x
<= h_margin
)
12492 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12496 struct buffer
*saved_current_buffer
;
12500 /* Find point in a display of infinite width. */
12501 saved_current_buffer
= current_buffer
;
12502 current_buffer
= XBUFFER (w
->buffer
);
12504 if (w
== XWINDOW (selected_window
))
12507 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12509 /* Move iterator to pt starting at cursor_row->start in
12510 a line with infinite width. */
12511 init_to_row_start (&it
, w
, cursor_row
);
12512 it
.last_visible_x
= INFINITY
;
12513 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12514 current_buffer
= saved_current_buffer
;
12516 /* Position cursor in window. */
12517 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12518 hscroll
= max (0, (it
.current_x
12519 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12520 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12521 : (text_area_width
/ 2))))
12522 / FRAME_COLUMN_WIDTH (it
.f
);
12523 else if ((!row_r2l_p
12524 && w
->cursor
.x
>= text_area_width
- h_margin
)
12525 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12527 if (hscroll_relative_p
)
12528 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12531 wanted_x
= text_area_width
12532 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12535 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12539 if (hscroll_relative_p
)
12540 wanted_x
= text_area_width
* hscroll_step_rel
12543 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12546 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12548 hscroll
= max (hscroll
, w
->min_hscroll
);
12550 /* Don't prevent redisplay optimizations if hscroll
12551 hasn't changed, as it will unnecessarily slow down
12553 if (w
->hscroll
!= hscroll
)
12555 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12556 w
->hscroll
= hscroll
;
12565 /* Value is non-zero if hscroll of any leaf window has been changed. */
12566 return hscrolled_p
;
12570 /* Set hscroll so that cursor is visible and not inside horizontal
12571 scroll margins for all windows in the tree rooted at WINDOW. See
12572 also hscroll_window_tree above. Value is non-zero if any window's
12573 hscroll has been changed. If it has, desired matrices on the frame
12574 of WINDOW are cleared. */
12577 hscroll_windows (Lisp_Object window
)
12579 int hscrolled_p
= hscroll_window_tree (window
);
12581 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12582 return hscrolled_p
;
12587 /************************************************************************
12589 ************************************************************************/
12591 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12592 to a non-zero value. This is sometimes handy to have in a debugger
12597 /* First and last unchanged row for try_window_id. */
12599 static int debug_first_unchanged_at_end_vpos
;
12600 static int debug_last_unchanged_at_beg_vpos
;
12602 /* Delta vpos and y. */
12604 static int debug_dvpos
, debug_dy
;
12606 /* Delta in characters and bytes for try_window_id. */
12608 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12610 /* Values of window_end_pos and window_end_vpos at the end of
12613 static ptrdiff_t debug_end_vpos
;
12615 /* Append a string to W->desired_matrix->method. FMT is a printf
12616 format string. If trace_redisplay_p is non-zero also printf the
12617 resulting string to stderr. */
12619 static void debug_method_add (struct window
*, char const *, ...)
12620 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12623 debug_method_add (struct window
*w
, char const *fmt
, ...)
12625 char *method
= w
->desired_matrix
->method
;
12626 int len
= strlen (method
);
12627 int size
= sizeof w
->desired_matrix
->method
;
12628 int remaining
= size
- len
- 1;
12631 if (len
&& remaining
)
12634 --remaining
, ++len
;
12637 va_start (ap
, fmt
);
12638 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12641 if (trace_redisplay_p
)
12642 fprintf (stderr
, "%p (%s): %s\n",
12644 ((BUFFERP (w
->buffer
)
12645 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12646 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12651 #endif /* GLYPH_DEBUG */
12654 /* Value is non-zero if all changes in window W, which displays
12655 current_buffer, are in the text between START and END. START is a
12656 buffer position, END is given as a distance from Z. Used in
12657 redisplay_internal for display optimization. */
12660 text_outside_line_unchanged_p (struct window
*w
,
12661 ptrdiff_t start
, ptrdiff_t end
)
12663 int unchanged_p
= 1;
12665 /* If text or overlays have changed, see where. */
12666 if (window_outdated (w
))
12668 /* Gap in the line? */
12669 if (GPT
< start
|| Z
- GPT
< end
)
12672 /* Changes start in front of the line, or end after it? */
12674 && (BEG_UNCHANGED
< start
- 1
12675 || END_UNCHANGED
< end
))
12678 /* If selective display, can't optimize if changes start at the
12679 beginning of the line. */
12681 && INTEGERP (BVAR (current_buffer
, selective_display
))
12682 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12683 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12686 /* If there are overlays at the start or end of the line, these
12687 may have overlay strings with newlines in them. A change at
12688 START, for instance, may actually concern the display of such
12689 overlay strings as well, and they are displayed on different
12690 lines. So, quickly rule out this case. (For the future, it
12691 might be desirable to implement something more telling than
12692 just BEG/END_UNCHANGED.) */
12695 if (BEG
+ BEG_UNCHANGED
== start
12696 && overlay_touches_p (start
))
12698 if (END_UNCHANGED
== end
12699 && overlay_touches_p (Z
- end
))
12703 /* Under bidi reordering, adding or deleting a character in the
12704 beginning of a paragraph, before the first strong directional
12705 character, can change the base direction of the paragraph (unless
12706 the buffer specifies a fixed paragraph direction), which will
12707 require to redisplay the whole paragraph. It might be worthwhile
12708 to find the paragraph limits and widen the range of redisplayed
12709 lines to that, but for now just give up this optimization. */
12710 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12711 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12715 return unchanged_p
;
12719 /* Do a frame update, taking possible shortcuts into account. This is
12720 the main external entry point for redisplay.
12722 If the last redisplay displayed an echo area message and that message
12723 is no longer requested, we clear the echo area or bring back the
12724 mini-buffer if that is in use. */
12729 redisplay_internal ();
12734 overlay_arrow_string_or_property (Lisp_Object var
)
12738 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12741 return Voverlay_arrow_string
;
12744 /* Return 1 if there are any overlay-arrows in current_buffer. */
12746 overlay_arrow_in_current_buffer_p (void)
12750 for (vlist
= Voverlay_arrow_variable_list
;
12752 vlist
= XCDR (vlist
))
12754 Lisp_Object var
= XCAR (vlist
);
12757 if (!SYMBOLP (var
))
12759 val
= find_symbol_value (var
);
12761 && current_buffer
== XMARKER (val
)->buffer
)
12768 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12772 overlay_arrows_changed_p (void)
12776 for (vlist
= Voverlay_arrow_variable_list
;
12778 vlist
= XCDR (vlist
))
12780 Lisp_Object var
= XCAR (vlist
);
12781 Lisp_Object val
, pstr
;
12783 if (!SYMBOLP (var
))
12785 val
= find_symbol_value (var
);
12786 if (!MARKERP (val
))
12788 if (! EQ (COERCE_MARKER (val
),
12789 Fget (var
, Qlast_arrow_position
))
12790 || ! (pstr
= overlay_arrow_string_or_property (var
),
12791 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12797 /* Mark overlay arrows to be updated on next redisplay. */
12800 update_overlay_arrows (int up_to_date
)
12804 for (vlist
= Voverlay_arrow_variable_list
;
12806 vlist
= XCDR (vlist
))
12808 Lisp_Object var
= XCAR (vlist
);
12810 if (!SYMBOLP (var
))
12813 if (up_to_date
> 0)
12815 Lisp_Object val
= find_symbol_value (var
);
12816 Fput (var
, Qlast_arrow_position
,
12817 COERCE_MARKER (val
));
12818 Fput (var
, Qlast_arrow_string
,
12819 overlay_arrow_string_or_property (var
));
12821 else if (up_to_date
< 0
12822 || !NILP (Fget (var
, Qlast_arrow_position
)))
12824 Fput (var
, Qlast_arrow_position
, Qt
);
12825 Fput (var
, Qlast_arrow_string
, Qt
);
12831 /* Return overlay arrow string to display at row.
12832 Return integer (bitmap number) for arrow bitmap in left fringe.
12833 Return nil if no overlay arrow. */
12836 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12840 for (vlist
= Voverlay_arrow_variable_list
;
12842 vlist
= XCDR (vlist
))
12844 Lisp_Object var
= XCAR (vlist
);
12847 if (!SYMBOLP (var
))
12850 val
= find_symbol_value (var
);
12853 && current_buffer
== XMARKER (val
)->buffer
12854 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12856 if (FRAME_WINDOW_P (it
->f
)
12857 /* FIXME: if ROW->reversed_p is set, this should test
12858 the right fringe, not the left one. */
12859 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12861 #ifdef HAVE_WINDOW_SYSTEM
12862 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12865 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12866 return make_number (fringe_bitmap
);
12869 return make_number (-1); /* Use default arrow bitmap. */
12871 return overlay_arrow_string_or_property (var
);
12878 /* Return 1 if point moved out of or into a composition. Otherwise
12879 return 0. PREV_BUF and PREV_PT are the last point buffer and
12880 position. BUF and PT are the current point buffer and position. */
12883 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12884 struct buffer
*buf
, ptrdiff_t pt
)
12886 ptrdiff_t start
, end
;
12888 Lisp_Object buffer
;
12890 XSETBUFFER (buffer
, buf
);
12891 /* Check a composition at the last point if point moved within the
12893 if (prev_buf
== buf
)
12896 /* Point didn't move. */
12899 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12900 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12901 && COMPOSITION_VALID_P (start
, end
, prop
)
12902 && start
< prev_pt
&& end
> prev_pt
)
12903 /* The last point was within the composition. Return 1 iff
12904 point moved out of the composition. */
12905 return (pt
<= start
|| pt
>= end
);
12908 /* Check a composition at the current point. */
12909 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12910 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12911 && COMPOSITION_VALID_P (start
, end
, prop
)
12912 && start
< pt
&& end
> pt
);
12916 /* Reconsider the setting of B->clip_changed which is displayed
12920 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12922 if (b
->clip_changed
12923 && !NILP (w
->window_end_valid
)
12924 && w
->current_matrix
->buffer
== b
12925 && w
->current_matrix
->zv
== BUF_ZV (b
)
12926 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12927 b
->clip_changed
= 0;
12929 /* If display wasn't paused, and W is not a tool bar window, see if
12930 point has been moved into or out of a composition. In that case,
12931 we set b->clip_changed to 1 to force updating the screen. If
12932 b->clip_changed has already been set to 1, we can skip this
12934 if (!b
->clip_changed
12935 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12939 if (w
== XWINDOW (selected_window
))
12942 pt
= marker_position (w
->pointm
);
12944 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12945 || pt
!= w
->last_point
)
12946 && check_point_in_composition (w
->current_matrix
->buffer
,
12948 XBUFFER (w
->buffer
), pt
))
12949 b
->clip_changed
= 1;
12954 /* Select FRAME to forward the values of frame-local variables into C
12955 variables so that the redisplay routines can access those values
12959 select_frame_for_redisplay (Lisp_Object frame
)
12961 Lisp_Object tail
, tem
;
12962 Lisp_Object old
= selected_frame
;
12963 struct Lisp_Symbol
*sym
;
12965 eassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12967 selected_frame
= frame
;
12968 /* If redisplay causes scrolling, it sets point in the window, so we need to
12969 be careful with the selected-window's point handling. */
12970 select_window_1 (XFRAME (frame
)->selected_window
, 0);
12973 for (tail
= XFRAME (frame
)->param_alist
;
12974 CONSP (tail
); tail
= XCDR (tail
))
12975 if (CONSP (XCAR (tail
))
12976 && (tem
= XCAR (XCAR (tail
)),
12978 && (sym
= indirect_variable (XSYMBOL (tem
)),
12979 sym
->redirect
== SYMBOL_LOCALIZED
)
12980 && sym
->val
.blv
->frame_local
)
12981 /* Use find_symbol_value rather than Fsymbol_value
12982 to avoid an error if it is void. */
12983 find_symbol_value (tem
);
12984 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12987 /* Make sure that previously selected OLD_FRAME is selected unless it has been
12988 deleted (by an X connection failure during redisplay, for example). */
12991 ensure_selected_frame (Lisp_Object frame
)
12993 if (!EQ (frame
, selected_frame
) && FRAME_LIVE_P (XFRAME (frame
)))
12994 select_frame_for_redisplay (frame
);
12997 #define STOP_POLLING \
12998 do { if (! polling_stopped_here) stop_polling (); \
12999 polling_stopped_here = 1; } while (0)
13001 #define RESUME_POLLING \
13002 do { if (polling_stopped_here) start_polling (); \
13003 polling_stopped_here = 0; } while (0)
13006 /* Perhaps in the future avoid recentering windows if it
13007 is not necessary; currently that causes some problems. */
13010 redisplay_internal (void)
13012 struct window
*w
= XWINDOW (selected_window
);
13016 int must_finish
= 0;
13017 struct text_pos tlbufpos
, tlendpos
;
13018 int number_of_visible_frames
;
13019 ptrdiff_t count
, count1
;
13021 int polling_stopped_here
= 0;
13022 Lisp_Object tail
, frame
, old_frame
= selected_frame
;
13023 struct backtrace backtrace
;
13025 /* Non-zero means redisplay has to consider all windows on all
13026 frames. Zero means, only selected_window is considered. */
13027 int consider_all_windows_p
;
13029 /* Non-zero means redisplay has to redisplay the miniwindow. */
13030 int update_miniwindow_p
= 0;
13032 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13034 /* No redisplay if running in batch mode or frame is not yet fully
13035 initialized, or redisplay is explicitly turned off by setting
13036 Vinhibit_redisplay. */
13037 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13038 || !NILP (Vinhibit_redisplay
))
13041 /* Don't examine these until after testing Vinhibit_redisplay.
13042 When Emacs is shutting down, perhaps because its connection to
13043 X has dropped, we should not look at them at all. */
13044 fr
= XFRAME (w
->frame
);
13045 sf
= SELECTED_FRAME ();
13047 if (!fr
->glyphs_initialized_p
)
13050 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13051 if (popup_activated ())
13055 /* I don't think this happens but let's be paranoid. */
13056 if (redisplaying_p
)
13059 /* Record a function that clears redisplaying_p
13060 when we leave this function. */
13061 count
= SPECPDL_INDEX ();
13062 record_unwind_protect (unwind_redisplay
, selected_frame
);
13063 redisplaying_p
= 1;
13064 specbind (Qinhibit_free_realized_faces
, Qnil
);
13066 /* Record this function, so it appears on the profiler's backtraces. */
13067 backtrace
.next
= backtrace_list
;
13068 backtrace
.function
= Qredisplay_internal
;
13069 backtrace
.args
= &Qnil
;
13070 backtrace
.nargs
= 0;
13071 backtrace
.debug_on_exit
= 0;
13072 backtrace_list
= &backtrace
;
13074 FOR_EACH_FRAME (tail
, frame
)
13075 XFRAME (frame
)->already_hscrolled_p
= 0;
13078 /* Remember the currently selected window. */
13081 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
13082 selected_frame and selected_window to be temporarily out-of-sync so
13083 when we come back here via `goto retry', we need to resync because we
13084 may need to run Elisp code (via prepare_menu_bars). */
13085 ensure_selected_frame (old_frame
);
13088 reconsider_clip_changes (w
, current_buffer
);
13089 last_escape_glyph_frame
= NULL
;
13090 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13091 last_glyphless_glyph_frame
= NULL
;
13092 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13094 /* If new fonts have been loaded that make a glyph matrix adjustment
13095 necessary, do it. */
13096 if (fonts_changed_p
)
13098 adjust_glyphs (NULL
);
13099 ++windows_or_buffers_changed
;
13100 fonts_changed_p
= 0;
13103 /* If face_change_count is non-zero, init_iterator will free all
13104 realized faces, which includes the faces referenced from current
13105 matrices. So, we can't reuse current matrices in this case. */
13106 if (face_change_count
)
13107 ++windows_or_buffers_changed
;
13109 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13110 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13112 /* Since frames on a single ASCII terminal share the same
13113 display area, displaying a different frame means redisplay
13114 the whole thing. */
13115 windows_or_buffers_changed
++;
13116 SET_FRAME_GARBAGED (sf
);
13118 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13120 FRAME_TTY (sf
)->previous_frame
= sf
;
13123 /* Set the visible flags for all frames. Do this before checking for
13124 resized or garbaged frames; they want to know if their frames are
13125 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13126 number_of_visible_frames
= 0;
13128 FOR_EACH_FRAME (tail
, frame
)
13130 struct frame
*f
= XFRAME (frame
);
13132 FRAME_SAMPLE_VISIBILITY (f
);
13133 if (FRAME_VISIBLE_P (f
))
13134 ++number_of_visible_frames
;
13135 clear_desired_matrices (f
);
13138 /* Notice any pending interrupt request to change frame size. */
13139 do_pending_window_change (1);
13141 /* do_pending_window_change could change the selected_window due to
13142 frame resizing which makes the selected window too small. */
13143 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13146 reconsider_clip_changes (w
, current_buffer
);
13149 /* Clear frames marked as garbaged. */
13150 clear_garbaged_frames ();
13152 /* Build menubar and tool-bar items. */
13153 if (NILP (Vmemory_full
))
13154 prepare_menu_bars ();
13156 if (windows_or_buffers_changed
)
13157 update_mode_lines
++;
13159 /* Detect case that we need to write or remove a star in the mode line. */
13160 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13162 w
->update_mode_line
= 1;
13163 if (buffer_shared_and_changed ())
13164 update_mode_lines
++;
13167 /* Avoid invocation of point motion hooks by `current_column' below. */
13168 count1
= SPECPDL_INDEX ();
13169 specbind (Qinhibit_point_motion_hooks
, Qt
);
13171 if (mode_line_update_needed (w
))
13172 w
->update_mode_line
= 1;
13174 unbind_to (count1
, Qnil
);
13176 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
13178 consider_all_windows_p
= (update_mode_lines
13179 || buffer_shared_and_changed ()
13180 || cursor_type_changed
);
13182 /* If specs for an arrow have changed, do thorough redisplay
13183 to ensure we remove any arrow that should no longer exist. */
13184 if (overlay_arrows_changed_p ())
13185 consider_all_windows_p
= windows_or_buffers_changed
= 1;
13187 /* Normally the message* functions will have already displayed and
13188 updated the echo area, but the frame may have been trashed, or
13189 the update may have been preempted, so display the echo area
13190 again here. Checking message_cleared_p captures the case that
13191 the echo area should be cleared. */
13192 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13193 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13194 || (message_cleared_p
13195 && minibuf_level
== 0
13196 /* If the mini-window is currently selected, this means the
13197 echo-area doesn't show through. */
13198 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13200 int window_height_changed_p
= echo_area_display (0);
13202 if (message_cleared_p
)
13203 update_miniwindow_p
= 1;
13207 /* If we don't display the current message, don't clear the
13208 message_cleared_p flag, because, if we did, we wouldn't clear
13209 the echo area in the next redisplay which doesn't preserve
13211 if (!display_last_displayed_message_p
)
13212 message_cleared_p
= 0;
13214 if (fonts_changed_p
)
13216 else if (window_height_changed_p
)
13218 consider_all_windows_p
= 1;
13219 ++update_mode_lines
;
13220 ++windows_or_buffers_changed
;
13222 /* If window configuration was changed, frames may have been
13223 marked garbaged. Clear them or we will experience
13224 surprises wrt scrolling. */
13225 clear_garbaged_frames ();
13228 else if (EQ (selected_window
, minibuf_window
)
13229 && (current_buffer
->clip_changed
|| window_outdated (w
))
13230 && resize_mini_window (w
, 0))
13232 /* Resized active mini-window to fit the size of what it is
13233 showing if its contents might have changed. */
13235 /* FIXME: this causes all frames to be updated, which seems unnecessary
13236 since only the current frame needs to be considered. This function
13237 needs to be rewritten with two variables, consider_all_windows and
13238 consider_all_frames. */
13239 consider_all_windows_p
= 1;
13240 ++windows_or_buffers_changed
;
13241 ++update_mode_lines
;
13243 /* If window configuration was changed, frames may have been
13244 marked garbaged. Clear them or we will experience
13245 surprises wrt scrolling. */
13246 clear_garbaged_frames ();
13250 /* If showing the region, and mark has changed, we must redisplay
13251 the whole window. The assignment to this_line_start_pos prevents
13252 the optimization directly below this if-statement. */
13253 if (((!NILP (Vtransient_mark_mode
)
13254 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
13255 != !NILP (w
->region_showing
))
13256 || (!NILP (w
->region_showing
)
13257 && !EQ (w
->region_showing
,
13258 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
13259 CHARPOS (this_line_start_pos
) = 0;
13261 /* Optimize the case that only the line containing the cursor in the
13262 selected window has changed. Variables starting with this_ are
13263 set in display_line and record information about the line
13264 containing the cursor. */
13265 tlbufpos
= this_line_start_pos
;
13266 tlendpos
= this_line_end_pos
;
13267 if (!consider_all_windows_p
13268 && CHARPOS (tlbufpos
) > 0
13269 && !w
->update_mode_line
13270 && !current_buffer
->clip_changed
13271 && !current_buffer
->prevent_redisplay_optimizations_p
13272 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13273 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13274 /* Make sure recorded data applies to current buffer, etc. */
13275 && this_line_buffer
== current_buffer
13276 && current_buffer
== XBUFFER (w
->buffer
)
13278 && !w
->optional_new_start
13279 /* Point must be on the line that we have info recorded about. */
13280 && PT
>= CHARPOS (tlbufpos
)
13281 && PT
<= Z
- CHARPOS (tlendpos
)
13282 /* All text outside that line, including its final newline,
13283 must be unchanged. */
13284 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13285 CHARPOS (tlendpos
)))
13287 if (CHARPOS (tlbufpos
) > BEGV
13288 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13289 && (CHARPOS (tlbufpos
) == ZV
13290 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13291 /* Former continuation line has disappeared by becoming empty. */
13293 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13295 /* We have to handle the case of continuation around a
13296 wide-column character (see the comment in indent.c around
13299 For instance, in the following case:
13301 -------- Insert --------
13302 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13303 J_I_ ==> J_I_ `^^' are cursors.
13307 As we have to redraw the line above, we cannot use this
13311 int line_height_before
= this_line_pixel_height
;
13313 /* Note that start_display will handle the case that the
13314 line starting at tlbufpos is a continuation line. */
13315 start_display (&it
, w
, tlbufpos
);
13317 /* Implementation note: It this still necessary? */
13318 if (it
.current_x
!= this_line_start_x
)
13321 TRACE ((stderr
, "trying display optimization 1\n"));
13322 w
->cursor
.vpos
= -1;
13323 overlay_arrow_seen
= 0;
13324 it
.vpos
= this_line_vpos
;
13325 it
.current_y
= this_line_y
;
13326 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13327 display_line (&it
);
13329 /* If line contains point, is not continued,
13330 and ends at same distance from eob as before, we win. */
13331 if (w
->cursor
.vpos
>= 0
13332 /* Line is not continued, otherwise this_line_start_pos
13333 would have been set to 0 in display_line. */
13334 && CHARPOS (this_line_start_pos
)
13335 /* Line ends as before. */
13336 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13337 /* Line has same height as before. Otherwise other lines
13338 would have to be shifted up or down. */
13339 && this_line_pixel_height
== line_height_before
)
13341 /* If this is not the window's last line, we must adjust
13342 the charstarts of the lines below. */
13343 if (it
.current_y
< it
.last_visible_y
)
13345 struct glyph_row
*row
13346 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13347 ptrdiff_t delta
, delta_bytes
;
13349 /* We used to distinguish between two cases here,
13350 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13351 when the line ends in a newline or the end of the
13352 buffer's accessible portion. But both cases did
13353 the same, so they were collapsed. */
13355 - CHARPOS (tlendpos
)
13356 - MATRIX_ROW_START_CHARPOS (row
));
13357 delta_bytes
= (Z_BYTE
13358 - BYTEPOS (tlendpos
)
13359 - MATRIX_ROW_START_BYTEPOS (row
));
13361 increment_matrix_positions (w
->current_matrix
,
13362 this_line_vpos
+ 1,
13363 w
->current_matrix
->nrows
,
13364 delta
, delta_bytes
);
13367 /* If this row displays text now but previously didn't,
13368 or vice versa, w->window_end_vpos may have to be
13370 if ((it
.glyph_row
- 1)->displays_text_p
)
13372 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13373 wset_window_end_vpos (w
, make_number (this_line_vpos
));
13375 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13376 && this_line_vpos
> 0)
13377 wset_window_end_vpos (w
, make_number (this_line_vpos
- 1));
13378 wset_window_end_valid (w
, Qnil
);
13380 /* Update hint: No need to try to scroll in update_window. */
13381 w
->desired_matrix
->no_scrolling_p
= 1;
13384 *w
->desired_matrix
->method
= 0;
13385 debug_method_add (w
, "optimization 1");
13387 #ifdef HAVE_WINDOW_SYSTEM
13388 update_window_fringes (w
, 0);
13395 else if (/* Cursor position hasn't changed. */
13396 PT
== w
->last_point
13397 /* Make sure the cursor was last displayed
13398 in this window. Otherwise we have to reposition it. */
13399 && 0 <= w
->cursor
.vpos
13400 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13404 do_pending_window_change (1);
13405 /* If selected_window changed, redisplay again. */
13406 if (WINDOWP (selected_window
)
13407 && (w
= XWINDOW (selected_window
)) != sw
)
13410 /* We used to always goto end_of_redisplay here, but this
13411 isn't enough if we have a blinking cursor. */
13412 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13413 goto end_of_redisplay
;
13417 /* If highlighting the region, or if the cursor is in the echo area,
13418 then we can't just move the cursor. */
13419 else if (! (!NILP (Vtransient_mark_mode
)
13420 && !NILP (BVAR (current_buffer
, mark_active
)))
13421 && (EQ (selected_window
,
13422 BVAR (current_buffer
, last_selected_window
))
13423 || highlight_nonselected_windows
)
13424 && NILP (w
->region_showing
)
13425 && NILP (Vshow_trailing_whitespace
)
13426 && !cursor_in_echo_area
)
13429 struct glyph_row
*row
;
13431 /* Skip from tlbufpos to PT and see where it is. Note that
13432 PT may be in invisible text. If so, we will end at the
13433 next visible position. */
13434 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13435 NULL
, DEFAULT_FACE_ID
);
13436 it
.current_x
= this_line_start_x
;
13437 it
.current_y
= this_line_y
;
13438 it
.vpos
= this_line_vpos
;
13440 /* The call to move_it_to stops in front of PT, but
13441 moves over before-strings. */
13442 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13444 if (it
.vpos
== this_line_vpos
13445 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13448 eassert (this_line_vpos
== it
.vpos
);
13449 eassert (this_line_y
== it
.current_y
);
13450 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13452 *w
->desired_matrix
->method
= 0;
13453 debug_method_add (w
, "optimization 3");
13462 /* Text changed drastically or point moved off of line. */
13463 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13466 CHARPOS (this_line_start_pos
) = 0;
13467 consider_all_windows_p
|= buffer_shared_and_changed ();
13468 ++clear_face_cache_count
;
13469 #ifdef HAVE_WINDOW_SYSTEM
13470 ++clear_image_cache_count
;
13473 /* Build desired matrices, and update the display. If
13474 consider_all_windows_p is non-zero, do it for all windows on all
13475 frames. Otherwise do it for selected_window, only. */
13477 if (consider_all_windows_p
)
13479 FOR_EACH_FRAME (tail
, frame
)
13480 XFRAME (frame
)->updated_p
= 0;
13482 FOR_EACH_FRAME (tail
, frame
)
13484 struct frame
*f
= XFRAME (frame
);
13486 /* We don't have to do anything for unselected terminal
13488 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13489 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13492 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13494 /* Select the frame, for the sake of frame-local variables. */
13495 ensure_selected_frame (frame
);
13497 /* Mark all the scroll bars to be removed; we'll redeem
13498 the ones we want when we redisplay their windows. */
13499 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13500 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13502 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13503 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13505 /* The X error handler may have deleted that frame. */
13506 if (!FRAME_LIVE_P (f
))
13509 /* Any scroll bars which redisplay_windows should have
13510 nuked should now go away. */
13511 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13512 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13514 /* If fonts changed, display again. */
13515 /* ??? rms: I suspect it is a mistake to jump all the way
13516 back to retry here. It should just retry this frame. */
13517 if (fonts_changed_p
)
13520 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13522 /* See if we have to hscroll. */
13523 if (!f
->already_hscrolled_p
)
13525 f
->already_hscrolled_p
= 1;
13526 if (hscroll_windows (f
->root_window
))
13530 /* Prevent various kinds of signals during display
13531 update. stdio is not robust about handling
13532 signals, which can cause an apparent I/O
13534 if (interrupt_input
)
13535 unrequest_sigio ();
13538 /* Update the display. */
13539 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13540 pending
|= update_frame (f
, 0, 0);
13546 /* We played a bit fast-and-loose above and allowed selected_frame
13547 and selected_window to be temporarily out-of-sync but let's make
13548 sure this stays contained. */
13549 ensure_selected_frame (old_frame
);
13550 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13554 /* Do the mark_window_display_accurate after all windows have
13555 been redisplayed because this call resets flags in buffers
13556 which are needed for proper redisplay. */
13557 FOR_EACH_FRAME (tail
, frame
)
13559 struct frame
*f
= XFRAME (frame
);
13562 mark_window_display_accurate (f
->root_window
, 1);
13563 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13564 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13569 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13571 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13572 struct frame
*mini_frame
;
13574 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13575 /* Use list_of_error, not Qerror, so that
13576 we catch only errors and don't run the debugger. */
13577 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13579 redisplay_window_error
);
13580 if (update_miniwindow_p
)
13581 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13583 redisplay_window_error
);
13585 /* Compare desired and current matrices, perform output. */
13588 /* If fonts changed, display again. */
13589 if (fonts_changed_p
)
13592 /* Prevent various kinds of signals during display update.
13593 stdio is not robust about handling signals,
13594 which can cause an apparent I/O error. */
13595 if (interrupt_input
)
13596 unrequest_sigio ();
13599 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13601 if (hscroll_windows (selected_window
))
13604 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13605 pending
= update_frame (sf
, 0, 0);
13608 /* We may have called echo_area_display at the top of this
13609 function. If the echo area is on another frame, that may
13610 have put text on a frame other than the selected one, so the
13611 above call to update_frame would not have caught it. Catch
13613 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13614 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13616 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13618 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13619 pending
|= update_frame (mini_frame
, 0, 0);
13620 if (!pending
&& hscroll_windows (mini_window
))
13625 /* If display was paused because of pending input, make sure we do a
13626 thorough update the next time. */
13629 /* Prevent the optimization at the beginning of
13630 redisplay_internal that tries a single-line update of the
13631 line containing the cursor in the selected window. */
13632 CHARPOS (this_line_start_pos
) = 0;
13634 /* Let the overlay arrow be updated the next time. */
13635 update_overlay_arrows (0);
13637 /* If we pause after scrolling, some rows in the current
13638 matrices of some windows are not valid. */
13639 if (!WINDOW_FULL_WIDTH_P (w
)
13640 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13641 update_mode_lines
= 1;
13645 if (!consider_all_windows_p
)
13647 /* This has already been done above if
13648 consider_all_windows_p is set. */
13649 mark_window_display_accurate_1 (w
, 1);
13651 /* Say overlay arrows are up to date. */
13652 update_overlay_arrows (1);
13654 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13655 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13658 update_mode_lines
= 0;
13659 windows_or_buffers_changed
= 0;
13660 cursor_type_changed
= 0;
13663 /* Start SIGIO interrupts coming again. Having them off during the
13664 code above makes it less likely one will discard output, but not
13665 impossible, since there might be stuff in the system buffer here.
13666 But it is much hairier to try to do anything about that. */
13667 if (interrupt_input
)
13671 /* If a frame has become visible which was not before, redisplay
13672 again, so that we display it. Expose events for such a frame
13673 (which it gets when becoming visible) don't call the parts of
13674 redisplay constructing glyphs, so simply exposing a frame won't
13675 display anything in this case. So, we have to display these
13676 frames here explicitly. */
13681 FOR_EACH_FRAME (tail
, frame
)
13683 int this_is_visible
= 0;
13685 if (XFRAME (frame
)->visible
)
13686 this_is_visible
= 1;
13687 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13688 if (XFRAME (frame
)->visible
)
13689 this_is_visible
= 1;
13691 if (this_is_visible
)
13695 if (new_count
!= number_of_visible_frames
)
13696 windows_or_buffers_changed
++;
13699 /* Change frame size now if a change is pending. */
13700 do_pending_window_change (1);
13702 /* If we just did a pending size change, or have additional
13703 visible frames, or selected_window changed, redisplay again. */
13704 if ((windows_or_buffers_changed
&& !pending
)
13705 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13708 /* Clear the face and image caches.
13710 We used to do this only if consider_all_windows_p. But the cache
13711 needs to be cleared if a timer creates images in the current
13712 buffer (e.g. the test case in Bug#6230). */
13714 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13716 clear_face_cache (0);
13717 clear_face_cache_count
= 0;
13720 #ifdef HAVE_WINDOW_SYSTEM
13721 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13723 clear_image_caches (Qnil
);
13724 clear_image_cache_count
= 0;
13726 #endif /* HAVE_WINDOW_SYSTEM */
13729 backtrace_list
= backtrace
.next
;
13730 unbind_to (count
, Qnil
);
13735 /* Redisplay, but leave alone any recent echo area message unless
13736 another message has been requested in its place.
13738 This is useful in situations where you need to redisplay but no
13739 user action has occurred, making it inappropriate for the message
13740 area to be cleared. See tracking_off and
13741 wait_reading_process_output for examples of these situations.
13743 FROM_WHERE is an integer saying from where this function was
13744 called. This is useful for debugging. */
13747 redisplay_preserve_echo_area (int from_where
)
13749 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13751 if (!NILP (echo_area_buffer
[1]))
13753 /* We have a previously displayed message, but no current
13754 message. Redisplay the previous message. */
13755 display_last_displayed_message_p
= 1;
13756 redisplay_internal ();
13757 display_last_displayed_message_p
= 0;
13760 redisplay_internal ();
13762 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13763 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13764 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13768 /* Function registered with record_unwind_protect in redisplay_internal.
13769 Clear redisplaying_p. Also select the previously selected frame. */
13772 unwind_redisplay (Lisp_Object old_frame
)
13774 redisplaying_p
= 0;
13775 ensure_selected_frame (old_frame
);
13780 /* Mark the display of window W as accurate or inaccurate. If
13781 ACCURATE_P is non-zero mark display of W as accurate. If
13782 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13783 redisplay_internal is called. */
13786 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13788 if (BUFFERP (w
->buffer
))
13790 struct buffer
*b
= XBUFFER (w
->buffer
);
13792 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
13793 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
13795 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13799 b
->clip_changed
= 0;
13800 b
->prevent_redisplay_optimizations_p
= 0;
13802 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13803 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13804 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13805 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13807 w
->current_matrix
->buffer
= b
;
13808 w
->current_matrix
->begv
= BUF_BEGV (b
);
13809 w
->current_matrix
->zv
= BUF_ZV (b
);
13811 w
->last_cursor
= w
->cursor
;
13812 w
->last_cursor_off_p
= w
->cursor_off_p
;
13814 if (w
== XWINDOW (selected_window
))
13815 w
->last_point
= BUF_PT (b
);
13817 w
->last_point
= marker_position (w
->pointm
);
13823 wset_window_end_valid (w
, w
->buffer
);
13824 w
->update_mode_line
= 0;
13829 /* Mark the display of windows in the window tree rooted at WINDOW as
13830 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13831 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13832 be redisplayed the next time redisplay_internal is called. */
13835 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13839 for (; !NILP (window
); window
= w
->next
)
13841 w
= XWINDOW (window
);
13842 mark_window_display_accurate_1 (w
, accurate_p
);
13844 if (!NILP (w
->vchild
))
13845 mark_window_display_accurate (w
->vchild
, accurate_p
);
13846 if (!NILP (w
->hchild
))
13847 mark_window_display_accurate (w
->hchild
, accurate_p
);
13852 update_overlay_arrows (1);
13856 /* Force a thorough redisplay the next time by setting
13857 last_arrow_position and last_arrow_string to t, which is
13858 unequal to any useful value of Voverlay_arrow_... */
13859 update_overlay_arrows (-1);
13864 /* Return value in display table DP (Lisp_Char_Table *) for character
13865 C. Since a display table doesn't have any parent, we don't have to
13866 follow parent. Do not call this function directly but use the
13867 macro DISP_CHAR_VECTOR. */
13870 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13874 if (ASCII_CHAR_P (c
))
13877 if (SUB_CHAR_TABLE_P (val
))
13878 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13884 XSETCHAR_TABLE (table
, dp
);
13885 val
= char_table_ref (table
, c
);
13894 /***********************************************************************
13896 ***********************************************************************/
13898 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13901 redisplay_windows (Lisp_Object window
)
13903 while (!NILP (window
))
13905 struct window
*w
= XWINDOW (window
);
13907 if (!NILP (w
->hchild
))
13908 redisplay_windows (w
->hchild
);
13909 else if (!NILP (w
->vchild
))
13910 redisplay_windows (w
->vchild
);
13911 else if (!NILP (w
->buffer
))
13913 displayed_buffer
= XBUFFER (w
->buffer
);
13914 /* Use list_of_error, not Qerror, so that
13915 we catch only errors and don't run the debugger. */
13916 internal_condition_case_1 (redisplay_window_0
, window
,
13918 redisplay_window_error
);
13926 redisplay_window_error (Lisp_Object ignore
)
13928 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13933 redisplay_window_0 (Lisp_Object window
)
13935 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13936 redisplay_window (window
, 0);
13941 redisplay_window_1 (Lisp_Object window
)
13943 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13944 redisplay_window (window
, 1);
13949 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13950 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13951 which positions recorded in ROW differ from current buffer
13954 Return 0 if cursor is not on this row, 1 otherwise. */
13957 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13958 struct glyph_matrix
*matrix
,
13959 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13962 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13963 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13964 struct glyph
*cursor
= NULL
;
13965 /* The last known character position in row. */
13966 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13968 ptrdiff_t pt_old
= PT
- delta
;
13969 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13970 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13971 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13972 /* A glyph beyond the edge of TEXT_AREA which we should never
13974 struct glyph
*glyphs_end
= end
;
13975 /* Non-zero means we've found a match for cursor position, but that
13976 glyph has the avoid_cursor_p flag set. */
13977 int match_with_avoid_cursor
= 0;
13978 /* Non-zero means we've seen at least one glyph that came from a
13980 int string_seen
= 0;
13981 /* Largest and smallest buffer positions seen so far during scan of
13983 ptrdiff_t bpos_max
= pos_before
;
13984 ptrdiff_t bpos_min
= pos_after
;
13985 /* Last buffer position covered by an overlay string with an integer
13986 `cursor' property. */
13987 ptrdiff_t bpos_covered
= 0;
13988 /* Non-zero means the display string on which to display the cursor
13989 comes from a text property, not from an overlay. */
13990 int string_from_text_prop
= 0;
13992 /* Don't even try doing anything if called for a mode-line or
13993 header-line row, since the rest of the code isn't prepared to
13994 deal with such calamities. */
13995 eassert (!row
->mode_line_p
);
13996 if (row
->mode_line_p
)
13999 /* Skip over glyphs not having an object at the start and the end of
14000 the row. These are special glyphs like truncation marks on
14001 terminal frames. */
14002 if (row
->displays_text_p
)
14004 if (!row
->reversed_p
)
14007 && INTEGERP (glyph
->object
)
14008 && glyph
->charpos
< 0)
14010 x
+= glyph
->pixel_width
;
14014 && INTEGERP ((end
- 1)->object
)
14015 /* CHARPOS is zero for blanks and stretch glyphs
14016 inserted by extend_face_to_end_of_line. */
14017 && (end
- 1)->charpos
<= 0)
14019 glyph_before
= glyph
- 1;
14026 /* If the glyph row is reversed, we need to process it from back
14027 to front, so swap the edge pointers. */
14028 glyphs_end
= end
= glyph
- 1;
14029 glyph
+= row
->used
[TEXT_AREA
] - 1;
14031 while (glyph
> end
+ 1
14032 && INTEGERP (glyph
->object
)
14033 && glyph
->charpos
< 0)
14036 x
-= glyph
->pixel_width
;
14038 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14040 /* By default, in reversed rows we put the cursor on the
14041 rightmost (first in the reading order) glyph. */
14042 for (g
= end
+ 1; g
< glyph
; g
++)
14043 x
+= g
->pixel_width
;
14045 && INTEGERP ((end
+ 1)->object
)
14046 && (end
+ 1)->charpos
<= 0)
14048 glyph_before
= glyph
+ 1;
14052 else if (row
->reversed_p
)
14054 /* In R2L rows that don't display text, put the cursor on the
14055 rightmost glyph. Case in point: an empty last line that is
14056 part of an R2L paragraph. */
14058 /* Avoid placing the cursor on the last glyph of the row, where
14059 on terminal frames we hold the vertical border between
14060 adjacent windows. */
14061 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14062 && !WINDOW_RIGHTMOST_P (w
)
14063 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14065 x
= -1; /* will be computed below, at label compute_x */
14068 /* Step 1: Try to find the glyph whose character position
14069 corresponds to point. If that's not possible, find 2 glyphs
14070 whose character positions are the closest to point, one before
14071 point, the other after it. */
14072 if (!row
->reversed_p
)
14073 while (/* not marched to end of glyph row */
14075 /* glyph was not inserted by redisplay for internal purposes */
14076 && !INTEGERP (glyph
->object
))
14078 if (BUFFERP (glyph
->object
))
14080 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14082 if (glyph
->charpos
> bpos_max
)
14083 bpos_max
= glyph
->charpos
;
14084 if (glyph
->charpos
< bpos_min
)
14085 bpos_min
= glyph
->charpos
;
14086 if (!glyph
->avoid_cursor_p
)
14088 /* If we hit point, we've found the glyph on which to
14089 display the cursor. */
14092 match_with_avoid_cursor
= 0;
14095 /* See if we've found a better approximation to
14096 POS_BEFORE or to POS_AFTER. */
14097 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14099 pos_before
= glyph
->charpos
;
14100 glyph_before
= glyph
;
14102 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14104 pos_after
= glyph
->charpos
;
14105 glyph_after
= glyph
;
14108 else if (dpos
== 0)
14109 match_with_avoid_cursor
= 1;
14111 else if (STRINGP (glyph
->object
))
14113 Lisp_Object chprop
;
14114 ptrdiff_t glyph_pos
= glyph
->charpos
;
14116 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14118 if (!NILP (chprop
))
14120 /* If the string came from a `display' text property,
14121 look up the buffer position of that property and
14122 use that position to update bpos_max, as if we
14123 actually saw such a position in one of the row's
14124 glyphs. This helps with supporting integer values
14125 of `cursor' property on the display string in
14126 situations where most or all of the row's buffer
14127 text is completely covered by display properties,
14128 so that no glyph with valid buffer positions is
14129 ever seen in the row. */
14130 ptrdiff_t prop_pos
=
14131 string_buffer_position_lim (glyph
->object
, pos_before
,
14134 if (prop_pos
>= pos_before
)
14135 bpos_max
= prop_pos
- 1;
14137 if (INTEGERP (chprop
))
14139 bpos_covered
= bpos_max
+ XINT (chprop
);
14140 /* If the `cursor' property covers buffer positions up
14141 to and including point, we should display cursor on
14142 this glyph. Note that, if a `cursor' property on one
14143 of the string's characters has an integer value, we
14144 will break out of the loop below _before_ we get to
14145 the position match above. IOW, integer values of
14146 the `cursor' property override the "exact match for
14147 point" strategy of positioning the cursor. */
14148 /* Implementation note: bpos_max == pt_old when, e.g.,
14149 we are in an empty line, where bpos_max is set to
14150 MATRIX_ROW_START_CHARPOS, see above. */
14151 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14160 x
+= glyph
->pixel_width
;
14163 else if (glyph
> end
) /* row is reversed */
14164 while (!INTEGERP (glyph
->object
))
14166 if (BUFFERP (glyph
->object
))
14168 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14170 if (glyph
->charpos
> bpos_max
)
14171 bpos_max
= glyph
->charpos
;
14172 if (glyph
->charpos
< bpos_min
)
14173 bpos_min
= glyph
->charpos
;
14174 if (!glyph
->avoid_cursor_p
)
14178 match_with_avoid_cursor
= 0;
14181 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14183 pos_before
= glyph
->charpos
;
14184 glyph_before
= glyph
;
14186 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14188 pos_after
= glyph
->charpos
;
14189 glyph_after
= glyph
;
14192 else if (dpos
== 0)
14193 match_with_avoid_cursor
= 1;
14195 else if (STRINGP (glyph
->object
))
14197 Lisp_Object chprop
;
14198 ptrdiff_t glyph_pos
= glyph
->charpos
;
14200 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14202 if (!NILP (chprop
))
14204 ptrdiff_t prop_pos
=
14205 string_buffer_position_lim (glyph
->object
, pos_before
,
14208 if (prop_pos
>= pos_before
)
14209 bpos_max
= prop_pos
- 1;
14211 if (INTEGERP (chprop
))
14213 bpos_covered
= bpos_max
+ XINT (chprop
);
14214 /* If the `cursor' property covers buffer positions up
14215 to and including point, we should display cursor on
14217 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14226 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14228 x
--; /* can't use any pixel_width */
14231 x
-= glyph
->pixel_width
;
14234 /* Step 2: If we didn't find an exact match for point, we need to
14235 look for a proper place to put the cursor among glyphs between
14236 GLYPH_BEFORE and GLYPH_AFTER. */
14237 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14238 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14239 && !(bpos_max
< pt_old
&& pt_old
<= bpos_covered
))
14241 /* An empty line has a single glyph whose OBJECT is zero and
14242 whose CHARPOS is the position of a newline on that line.
14243 Note that on a TTY, there are more glyphs after that, which
14244 were produced by extend_face_to_end_of_line, but their
14245 CHARPOS is zero or negative. */
14247 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14248 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
14250 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14252 ptrdiff_t ellipsis_pos
;
14254 /* Scan back over the ellipsis glyphs. */
14255 if (!row
->reversed_p
)
14257 ellipsis_pos
= (glyph
- 1)->charpos
;
14258 while (glyph
> row
->glyphs
[TEXT_AREA
]
14259 && (glyph
- 1)->charpos
== ellipsis_pos
)
14260 glyph
--, x
-= glyph
->pixel_width
;
14261 /* That loop always goes one position too far, including
14262 the glyph before the ellipsis. So scan forward over
14264 x
+= glyph
->pixel_width
;
14267 else /* row is reversed */
14269 ellipsis_pos
= (glyph
+ 1)->charpos
;
14270 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14271 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14272 glyph
++, x
+= glyph
->pixel_width
;
14273 x
-= glyph
->pixel_width
;
14277 else if (match_with_avoid_cursor
)
14279 cursor
= glyph_after
;
14282 else if (string_seen
)
14284 int incr
= row
->reversed_p
? -1 : +1;
14286 /* Need to find the glyph that came out of a string which is
14287 present at point. That glyph is somewhere between
14288 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14289 positioned between POS_BEFORE and POS_AFTER in the
14291 struct glyph
*start
, *stop
;
14292 ptrdiff_t pos
= pos_before
;
14296 /* If the row ends in a newline from a display string,
14297 reordering could have moved the glyphs belonging to the
14298 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14299 in this case we extend the search to the last glyph in
14300 the row that was not inserted by redisplay. */
14301 if (row
->ends_in_newline_from_string_p
)
14304 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14307 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14308 correspond to POS_BEFORE and POS_AFTER, respectively. We
14309 need START and STOP in the order that corresponds to the
14310 row's direction as given by its reversed_p flag. If the
14311 directionality of characters between POS_BEFORE and
14312 POS_AFTER is the opposite of the row's base direction,
14313 these characters will have been reordered for display,
14314 and we need to reverse START and STOP. */
14315 if (!row
->reversed_p
)
14317 start
= min (glyph_before
, glyph_after
);
14318 stop
= max (glyph_before
, glyph_after
);
14322 start
= max (glyph_before
, glyph_after
);
14323 stop
= min (glyph_before
, glyph_after
);
14325 for (glyph
= start
+ incr
;
14326 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14329 /* Any glyphs that come from the buffer are here because
14330 of bidi reordering. Skip them, and only pay
14331 attention to glyphs that came from some string. */
14332 if (STRINGP (glyph
->object
))
14336 /* If the display property covers the newline, we
14337 need to search for it one position farther. */
14338 ptrdiff_t lim
= pos_after
14339 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14341 string_from_text_prop
= 0;
14342 str
= glyph
->object
;
14343 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14344 if (tem
== 0 /* from overlay */
14347 /* If the string from which this glyph came is
14348 found in the buffer at point, or at position
14349 that is closer to point than pos_after, then
14350 we've found the glyph we've been looking for.
14351 If it comes from an overlay (tem == 0), and
14352 it has the `cursor' property on one of its
14353 glyphs, record that glyph as a candidate for
14354 displaying the cursor. (As in the
14355 unidirectional version, we will display the
14356 cursor on the last candidate we find.) */
14359 || (tem
- pt_old
> 0 && tem
< pos_after
))
14361 /* The glyphs from this string could have
14362 been reordered. Find the one with the
14363 smallest string position. Or there could
14364 be a character in the string with the
14365 `cursor' property, which means display
14366 cursor on that character's glyph. */
14367 ptrdiff_t strpos
= glyph
->charpos
;
14372 string_from_text_prop
= 1;
14375 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14376 && EQ (glyph
->object
, str
);
14380 ptrdiff_t gpos
= glyph
->charpos
;
14382 cprop
= Fget_char_property (make_number (gpos
),
14390 if (tem
&& glyph
->charpos
< strpos
)
14392 strpos
= glyph
->charpos
;
14398 || (tem
- pt_old
> 0 && tem
< pos_after
))
14402 pos
= tem
+ 1; /* don't find previous instances */
14404 /* This string is not what we want; skip all of the
14405 glyphs that came from it. */
14406 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14407 && EQ (glyph
->object
, str
))
14414 /* If we reached the end of the line, and END was from a string,
14415 the cursor is not on this line. */
14417 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14418 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14419 && STRINGP (end
->object
)
14420 && row
->continued_p
)
14423 /* A truncated row may not include PT among its character positions.
14424 Setting the cursor inside the scroll margin will trigger
14425 recalculation of hscroll in hscroll_window_tree. But if a
14426 display string covers point, defer to the string-handling
14427 code below to figure this out. */
14428 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14430 cursor
= glyph_before
;
14433 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14434 /* Zero-width characters produce no glyphs. */
14436 && (row
->reversed_p
14437 ? glyph_after
> glyphs_end
14438 : glyph_after
< glyphs_end
)))
14440 cursor
= glyph_after
;
14446 if (cursor
!= NULL
)
14448 else if (glyph
== glyphs_end
14449 && pos_before
== pos_after
14450 && STRINGP ((row
->reversed_p
14451 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14452 : row
->glyphs
[TEXT_AREA
])->object
))
14454 /* If all the glyphs of this row came from strings, put the
14455 cursor on the first glyph of the row. This avoids having the
14456 cursor outside of the text area in this very rare and hard
14460 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14461 : row
->glyphs
[TEXT_AREA
];
14467 /* Need to compute x that corresponds to GLYPH. */
14468 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14470 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14472 x
+= g
->pixel_width
;
14476 /* ROW could be part of a continued line, which, under bidi
14477 reordering, might have other rows whose start and end charpos
14478 occlude point. Only set w->cursor if we found a better
14479 approximation to the cursor position than we have from previously
14480 examined candidate rows belonging to the same continued line. */
14481 if (/* we already have a candidate row */
14482 w
->cursor
.vpos
>= 0
14483 /* that candidate is not the row we are processing */
14484 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14485 /* Make sure cursor.vpos specifies a row whose start and end
14486 charpos occlude point, and it is valid candidate for being a
14487 cursor-row. This is because some callers of this function
14488 leave cursor.vpos at the row where the cursor was displayed
14489 during the last redisplay cycle. */
14490 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14491 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14492 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14495 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14497 /* Don't consider glyphs that are outside TEXT_AREA. */
14498 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14500 /* Keep the candidate whose buffer position is the closest to
14501 point or has the `cursor' property. */
14502 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14503 w
->cursor
.hpos
>= 0
14504 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14505 && ((BUFFERP (g1
->object
)
14506 && (g1
->charpos
== pt_old
/* an exact match always wins */
14507 || (BUFFERP (glyph
->object
)
14508 && eabs (g1
->charpos
- pt_old
)
14509 < eabs (glyph
->charpos
- pt_old
))))
14510 /* previous candidate is a glyph from a string that has
14511 a non-nil `cursor' property */
14512 || (STRINGP (g1
->object
)
14513 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14514 Qcursor
, g1
->object
))
14515 /* previous candidate is from the same display
14516 string as this one, and the display string
14517 came from a text property */
14518 || (EQ (g1
->object
, glyph
->object
)
14519 && string_from_text_prop
)
14520 /* this candidate is from newline and its
14521 position is not an exact match */
14522 || (INTEGERP (glyph
->object
)
14523 && glyph
->charpos
!= pt_old
)))))
14525 /* If this candidate gives an exact match, use that. */
14526 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14527 /* If this candidate is a glyph created for the
14528 terminating newline of a line, and point is on that
14529 newline, it wins because it's an exact match. */
14530 || (!row
->continued_p
14531 && INTEGERP (glyph
->object
)
14532 && glyph
->charpos
== 0
14533 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14534 /* Otherwise, keep the candidate that comes from a row
14535 spanning less buffer positions. This may win when one or
14536 both candidate positions are on glyphs that came from
14537 display strings, for which we cannot compare buffer
14539 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14540 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14541 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14544 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14546 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14547 w
->cursor
.y
= row
->y
+ dy
;
14549 if (w
== XWINDOW (selected_window
))
14551 if (!row
->continued_p
14552 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14555 this_line_buffer
= XBUFFER (w
->buffer
);
14557 CHARPOS (this_line_start_pos
)
14558 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14559 BYTEPOS (this_line_start_pos
)
14560 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14562 CHARPOS (this_line_end_pos
)
14563 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14564 BYTEPOS (this_line_end_pos
)
14565 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14567 this_line_y
= w
->cursor
.y
;
14568 this_line_pixel_height
= row
->height
;
14569 this_line_vpos
= w
->cursor
.vpos
;
14570 this_line_start_x
= row
->x
;
14573 CHARPOS (this_line_start_pos
) = 0;
14580 /* Run window scroll functions, if any, for WINDOW with new window
14581 start STARTP. Sets the window start of WINDOW to that position.
14583 We assume that the window's buffer is really current. */
14585 static struct text_pos
14586 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14588 struct window
*w
= XWINDOW (window
);
14589 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14591 if (current_buffer
!= XBUFFER (w
->buffer
))
14594 if (!NILP (Vwindow_scroll_functions
))
14596 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14597 make_number (CHARPOS (startp
)));
14598 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14599 /* In case the hook functions switch buffers. */
14600 set_buffer_internal (XBUFFER (w
->buffer
));
14607 /* Make sure the line containing the cursor is fully visible.
14608 A value of 1 means there is nothing to be done.
14609 (Either the line is fully visible, or it cannot be made so,
14610 or we cannot tell.)
14612 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14613 is higher than window.
14615 A value of 0 means the caller should do scrolling
14616 as if point had gone off the screen. */
14619 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14621 struct glyph_matrix
*matrix
;
14622 struct glyph_row
*row
;
14625 if (!make_cursor_line_fully_visible_p
)
14628 /* It's not always possible to find the cursor, e.g, when a window
14629 is full of overlay strings. Don't do anything in that case. */
14630 if (w
->cursor
.vpos
< 0)
14633 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14634 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14636 /* If the cursor row is not partially visible, there's nothing to do. */
14637 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14640 /* If the row the cursor is in is taller than the window's height,
14641 it's not clear what to do, so do nothing. */
14642 window_height
= window_box_height (w
);
14643 if (row
->height
>= window_height
)
14645 if (!force_p
|| MINI_WINDOW_P (w
)
14646 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14653 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14654 non-zero means only WINDOW is redisplayed in redisplay_internal.
14655 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14656 in redisplay_window to bring a partially visible line into view in
14657 the case that only the cursor has moved.
14659 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14660 last screen line's vertical height extends past the end of the screen.
14664 1 if scrolling succeeded
14666 0 if scrolling didn't find point.
14668 -1 if new fonts have been loaded so that we must interrupt
14669 redisplay, adjust glyph matrices, and try again. */
14675 SCROLLING_NEED_LARGER_MATRICES
14678 /* If scroll-conservatively is more than this, never recenter.
14680 If you change this, don't forget to update the doc string of
14681 `scroll-conservatively' and the Emacs manual. */
14682 #define SCROLL_LIMIT 100
14685 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14686 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14687 int temp_scroll_step
, int last_line_misfit
)
14689 struct window
*w
= XWINDOW (window
);
14690 struct frame
*f
= XFRAME (w
->frame
);
14691 struct text_pos pos
, startp
;
14693 int this_scroll_margin
, scroll_max
, rc
, height
;
14694 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14695 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14696 Lisp_Object aggressive
;
14697 /* We will never try scrolling more than this number of lines. */
14698 int scroll_limit
= SCROLL_LIMIT
;
14701 debug_method_add (w
, "try_scrolling");
14704 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14706 /* Compute scroll margin height in pixels. We scroll when point is
14707 within this distance from the top or bottom of the window. */
14708 if (scroll_margin
> 0)
14709 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14710 * FRAME_LINE_HEIGHT (f
);
14712 this_scroll_margin
= 0;
14714 /* Force arg_scroll_conservatively to have a reasonable value, to
14715 avoid scrolling too far away with slow move_it_* functions. Note
14716 that the user can supply scroll-conservatively equal to
14717 `most-positive-fixnum', which can be larger than INT_MAX. */
14718 if (arg_scroll_conservatively
> scroll_limit
)
14720 arg_scroll_conservatively
= scroll_limit
+ 1;
14721 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14723 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14724 /* Compute how much we should try to scroll maximally to bring
14725 point into view. */
14726 scroll_max
= (max (scroll_step
,
14727 max (arg_scroll_conservatively
, temp_scroll_step
))
14728 * FRAME_LINE_HEIGHT (f
));
14729 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14730 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14731 /* We're trying to scroll because of aggressive scrolling but no
14732 scroll_step is set. Choose an arbitrary one. */
14733 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14739 /* Decide whether to scroll down. */
14740 if (PT
> CHARPOS (startp
))
14742 int scroll_margin_y
;
14744 /* Compute the pixel ypos of the scroll margin, then move IT to
14745 either that ypos or PT, whichever comes first. */
14746 start_display (&it
, w
, startp
);
14747 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14748 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14749 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14750 (MOVE_TO_POS
| MOVE_TO_Y
));
14752 if (PT
> CHARPOS (it
.current
.pos
))
14754 int y0
= line_bottom_y (&it
);
14755 /* Compute how many pixels below window bottom to stop searching
14756 for PT. This avoids costly search for PT that is far away if
14757 the user limited scrolling by a small number of lines, but
14758 always finds PT if scroll_conservatively is set to a large
14759 number, such as most-positive-fixnum. */
14760 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14761 int y_to_move
= it
.last_visible_y
+ slack
;
14763 /* Compute the distance from the scroll margin to PT or to
14764 the scroll limit, whichever comes first. This should
14765 include the height of the cursor line, to make that line
14767 move_it_to (&it
, PT
, -1, y_to_move
,
14768 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14769 dy
= line_bottom_y (&it
) - y0
;
14771 if (dy
> scroll_max
)
14772 return SCROLLING_FAILED
;
14781 /* Point is in or below the bottom scroll margin, so move the
14782 window start down. If scrolling conservatively, move it just
14783 enough down to make point visible. If scroll_step is set,
14784 move it down by scroll_step. */
14785 if (arg_scroll_conservatively
)
14787 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14788 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14789 else if (scroll_step
|| temp_scroll_step
)
14790 amount_to_scroll
= scroll_max
;
14793 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14794 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14795 if (NUMBERP (aggressive
))
14797 double float_amount
= XFLOATINT (aggressive
) * height
;
14798 int aggressive_scroll
= float_amount
;
14799 if (aggressive_scroll
== 0 && float_amount
> 0)
14800 aggressive_scroll
= 1;
14801 /* Don't let point enter the scroll margin near top of
14802 the window. This could happen if the value of
14803 scroll_up_aggressively is too large and there are
14804 non-zero margins, because scroll_up_aggressively
14805 means put point that fraction of window height
14806 _from_the_bottom_margin_. */
14807 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14808 aggressive_scroll
= height
- 2*this_scroll_margin
;
14809 amount_to_scroll
= dy
+ aggressive_scroll
;
14813 if (amount_to_scroll
<= 0)
14814 return SCROLLING_FAILED
;
14816 start_display (&it
, w
, startp
);
14817 if (arg_scroll_conservatively
<= scroll_limit
)
14818 move_it_vertically (&it
, amount_to_scroll
);
14821 /* Extra precision for users who set scroll-conservatively
14822 to a large number: make sure the amount we scroll
14823 the window start is never less than amount_to_scroll,
14824 which was computed as distance from window bottom to
14825 point. This matters when lines at window top and lines
14826 below window bottom have different height. */
14828 void *it1data
= NULL
;
14829 /* We use a temporary it1 because line_bottom_y can modify
14830 its argument, if it moves one line down; see there. */
14833 SAVE_IT (it1
, it
, it1data
);
14834 start_y
= line_bottom_y (&it1
);
14836 RESTORE_IT (&it
, &it
, it1data
);
14837 move_it_by_lines (&it
, 1);
14838 SAVE_IT (it1
, it
, it1data
);
14839 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14842 /* If STARTP is unchanged, move it down another screen line. */
14843 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14844 move_it_by_lines (&it
, 1);
14845 startp
= it
.current
.pos
;
14849 struct text_pos scroll_margin_pos
= startp
;
14851 /* See if point is inside the scroll margin at the top of the
14853 if (this_scroll_margin
)
14855 start_display (&it
, w
, startp
);
14856 move_it_vertically (&it
, this_scroll_margin
);
14857 scroll_margin_pos
= it
.current
.pos
;
14860 if (PT
< CHARPOS (scroll_margin_pos
))
14862 /* Point is in the scroll margin at the top of the window or
14863 above what is displayed in the window. */
14866 /* Compute the vertical distance from PT to the scroll
14867 margin position. Move as far as scroll_max allows, or
14868 one screenful, or 10 screen lines, whichever is largest.
14869 Give up if distance is greater than scroll_max or if we
14870 didn't reach the scroll margin position. */
14871 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14872 start_display (&it
, w
, pos
);
14874 y_to_move
= max (it
.last_visible_y
,
14875 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14876 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14878 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14879 dy
= it
.current_y
- y0
;
14880 if (dy
> scroll_max
14881 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
14882 return SCROLLING_FAILED
;
14884 /* Compute new window start. */
14885 start_display (&it
, w
, startp
);
14887 if (arg_scroll_conservatively
)
14888 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14889 max (scroll_step
, temp_scroll_step
));
14890 else if (scroll_step
|| temp_scroll_step
)
14891 amount_to_scroll
= scroll_max
;
14894 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14895 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14896 if (NUMBERP (aggressive
))
14898 double float_amount
= XFLOATINT (aggressive
) * height
;
14899 int aggressive_scroll
= float_amount
;
14900 if (aggressive_scroll
== 0 && float_amount
> 0)
14901 aggressive_scroll
= 1;
14902 /* Don't let point enter the scroll margin near
14903 bottom of the window, if the value of
14904 scroll_down_aggressively happens to be too
14906 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14907 aggressive_scroll
= height
- 2*this_scroll_margin
;
14908 amount_to_scroll
= dy
+ aggressive_scroll
;
14912 if (amount_to_scroll
<= 0)
14913 return SCROLLING_FAILED
;
14915 move_it_vertically_backward (&it
, amount_to_scroll
);
14916 startp
= it
.current
.pos
;
14920 /* Run window scroll functions. */
14921 startp
= run_window_scroll_functions (window
, startp
);
14923 /* Display the window. Give up if new fonts are loaded, or if point
14925 if (!try_window (window
, startp
, 0))
14926 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14927 else if (w
->cursor
.vpos
< 0)
14929 clear_glyph_matrix (w
->desired_matrix
);
14930 rc
= SCROLLING_FAILED
;
14934 /* Maybe forget recorded base line for line number display. */
14935 if (!just_this_one_p
14936 || current_buffer
->clip_changed
14937 || BEG_UNCHANGED
< CHARPOS (startp
))
14938 wset_base_line_number (w
, Qnil
);
14940 /* If cursor ends up on a partially visible line,
14941 treat that as being off the bottom of the screen. */
14942 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14943 /* It's possible that the cursor is on the first line of the
14944 buffer, which is partially obscured due to a vscroll
14945 (Bug#7537). In that case, avoid looping forever . */
14946 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14948 clear_glyph_matrix (w
->desired_matrix
);
14949 ++extra_scroll_margin_lines
;
14952 rc
= SCROLLING_SUCCESS
;
14959 /* Compute a suitable window start for window W if display of W starts
14960 on a continuation line. Value is non-zero if a new window start
14963 The new window start will be computed, based on W's width, starting
14964 from the start of the continued line. It is the start of the
14965 screen line with the minimum distance from the old start W->start. */
14968 compute_window_start_on_continuation_line (struct window
*w
)
14970 struct text_pos pos
, start_pos
;
14971 int window_start_changed_p
= 0;
14973 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14975 /* If window start is on a continuation line... Window start may be
14976 < BEGV in case there's invisible text at the start of the
14977 buffer (M-x rmail, for example). */
14978 if (CHARPOS (start_pos
) > BEGV
14979 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14982 struct glyph_row
*row
;
14984 /* Handle the case that the window start is out of range. */
14985 if (CHARPOS (start_pos
) < BEGV
)
14986 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14987 else if (CHARPOS (start_pos
) > ZV
)
14988 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14990 /* Find the start of the continued line. This should be fast
14991 because scan_buffer is fast (newline cache). */
14992 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14993 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14994 row
, DEFAULT_FACE_ID
);
14995 reseat_at_previous_visible_line_start (&it
);
14997 /* If the line start is "too far" away from the window start,
14998 say it takes too much time to compute a new window start. */
14999 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15000 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15002 int min_distance
, distance
;
15004 /* Move forward by display lines to find the new window
15005 start. If window width was enlarged, the new start can
15006 be expected to be > the old start. If window width was
15007 decreased, the new window start will be < the old start.
15008 So, we're looking for the display line start with the
15009 minimum distance from the old window start. */
15010 pos
= it
.current
.pos
;
15011 min_distance
= INFINITY
;
15012 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15013 distance
< min_distance
)
15015 min_distance
= distance
;
15016 pos
= it
.current
.pos
;
15017 move_it_by_lines (&it
, 1);
15020 /* Set the window start there. */
15021 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15022 window_start_changed_p
= 1;
15026 return window_start_changed_p
;
15030 /* Try cursor movement in case text has not changed in window WINDOW,
15031 with window start STARTP. Value is
15033 CURSOR_MOVEMENT_SUCCESS if successful
15035 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15037 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15038 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15039 we want to scroll as if scroll-step were set to 1. See the code.
15041 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15042 which case we have to abort this redisplay, and adjust matrices
15047 CURSOR_MOVEMENT_SUCCESS
,
15048 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15049 CURSOR_MOVEMENT_MUST_SCROLL
,
15050 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15054 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15056 struct window
*w
= XWINDOW (window
);
15057 struct frame
*f
= XFRAME (w
->frame
);
15058 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15061 if (inhibit_try_cursor_movement
)
15065 /* Previously, there was a check for Lisp integer in the
15066 if-statement below. Now, this field is converted to
15067 ptrdiff_t, thus zero means invalid position in a buffer. */
15068 eassert (w
->last_point
> 0);
15070 /* Handle case where text has not changed, only point, and it has
15071 not moved off the frame. */
15072 if (/* Point may be in this window. */
15073 PT
>= CHARPOS (startp
)
15074 /* Selective display hasn't changed. */
15075 && !current_buffer
->clip_changed
15076 /* Function force-mode-line-update is used to force a thorough
15077 redisplay. It sets either windows_or_buffers_changed or
15078 update_mode_lines. So don't take a shortcut here for these
15080 && !update_mode_lines
15081 && !windows_or_buffers_changed
15082 && !cursor_type_changed
15083 /* Can't use this case if highlighting a region. When a
15084 region exists, cursor movement has to do more than just
15086 && markpos_of_region () < 0
15087 && NILP (w
->region_showing
)
15088 && NILP (Vshow_trailing_whitespace
)
15089 /* This code is not used for mini-buffer for the sake of the case
15090 of redisplaying to replace an echo area message; since in
15091 that case the mini-buffer contents per se are usually
15092 unchanged. This code is of no real use in the mini-buffer
15093 since the handling of this_line_start_pos, etc., in redisplay
15094 handles the same cases. */
15095 && !EQ (window
, minibuf_window
)
15096 /* When splitting windows or for new windows, it happens that
15097 redisplay is called with a nil window_end_vpos or one being
15098 larger than the window. This should really be fixed in
15099 window.c. I don't have this on my list, now, so we do
15100 approximately the same as the old redisplay code. --gerd. */
15101 && INTEGERP (w
->window_end_vpos
)
15102 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
15103 && (FRAME_WINDOW_P (f
)
15104 || !overlay_arrow_in_current_buffer_p ()))
15106 int this_scroll_margin
, top_scroll_margin
;
15107 struct glyph_row
*row
= NULL
;
15110 debug_method_add (w
, "cursor movement");
15113 /* Scroll if point within this distance from the top or bottom
15114 of the window. This is a pixel value. */
15115 if (scroll_margin
> 0)
15117 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15118 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15121 this_scroll_margin
= 0;
15123 top_scroll_margin
= this_scroll_margin
;
15124 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15125 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15127 /* Start with the row the cursor was displayed during the last
15128 not paused redisplay. Give up if that row is not valid. */
15129 if (w
->last_cursor
.vpos
< 0
15130 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
15131 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15134 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
15135 if (row
->mode_line_p
)
15137 if (!row
->enabled_p
)
15138 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15141 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15143 int scroll_p
= 0, must_scroll
= 0;
15144 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15146 if (PT
> w
->last_point
)
15148 /* Point has moved forward. */
15149 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15150 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15152 eassert (row
->enabled_p
);
15156 /* If the end position of a row equals the start
15157 position of the next row, and PT is at that position,
15158 we would rather display cursor in the next line. */
15159 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15160 && MATRIX_ROW_END_CHARPOS (row
) == PT
15161 && row
< w
->current_matrix
->rows
15162 + w
->current_matrix
->nrows
- 1
15163 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15164 && !cursor_row_p (row
))
15167 /* If within the scroll margin, scroll. Note that
15168 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15169 the next line would be drawn, and that
15170 this_scroll_margin can be zero. */
15171 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15172 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15173 /* Line is completely visible last line in window
15174 and PT is to be set in the next line. */
15175 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15176 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15177 && !row
->ends_at_zv_p
15178 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15181 else if (PT
< w
->last_point
)
15183 /* Cursor has to be moved backward. Note that PT >=
15184 CHARPOS (startp) because of the outer if-statement. */
15185 while (!row
->mode_line_p
15186 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15187 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15188 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15189 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15190 row
> w
->current_matrix
->rows
15191 && (row
-1)->ends_in_newline_from_string_p
))))
15192 && (row
->y
> top_scroll_margin
15193 || CHARPOS (startp
) == BEGV
))
15195 eassert (row
->enabled_p
);
15199 /* Consider the following case: Window starts at BEGV,
15200 there is invisible, intangible text at BEGV, so that
15201 display starts at some point START > BEGV. It can
15202 happen that we are called with PT somewhere between
15203 BEGV and START. Try to handle that case. */
15204 if (row
< w
->current_matrix
->rows
15205 || row
->mode_line_p
)
15207 row
= w
->current_matrix
->rows
;
15208 if (row
->mode_line_p
)
15212 /* Due to newlines in overlay strings, we may have to
15213 skip forward over overlay strings. */
15214 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15215 && MATRIX_ROW_END_CHARPOS (row
) == PT
15216 && !cursor_row_p (row
))
15219 /* If within the scroll margin, scroll. */
15220 if (row
->y
< top_scroll_margin
15221 && CHARPOS (startp
) != BEGV
)
15226 /* Cursor did not move. So don't scroll even if cursor line
15227 is partially visible, as it was so before. */
15228 rc
= CURSOR_MOVEMENT_SUCCESS
;
15231 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15232 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15234 /* if PT is not in the glyph row, give up. */
15235 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15238 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15239 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15241 struct glyph_row
*row1
;
15243 /* If rows are bidi-reordered and point moved, back up
15244 until we find a row that does not belong to a
15245 continuation line. This is because we must consider
15246 all rows of a continued line as candidates for the
15247 new cursor positioning, since row start and end
15248 positions change non-linearly with vertical position
15250 /* FIXME: Revisit this when glyph ``spilling'' in
15251 continuation lines' rows is implemented for
15252 bidi-reordered rows. */
15253 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15254 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15257 /* If we hit the beginning of the displayed portion
15258 without finding the first row of a continued
15262 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15265 eassert (row
->enabled_p
);
15270 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15271 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15272 /* Make sure this isn't a header line by any chance, since
15273 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15274 && !row
->mode_line_p
15275 && make_cursor_line_fully_visible_p
)
15277 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15278 && !row
->ends_at_zv_p
15279 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15280 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15281 else if (row
->height
> window_box_height (w
))
15283 /* If we end up in a partially visible line, let's
15284 make it fully visible, except when it's taller
15285 than the window, in which case we can't do much
15288 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15292 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15293 if (!cursor_row_fully_visible_p (w
, 0, 1))
15294 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15296 rc
= CURSOR_MOVEMENT_SUCCESS
;
15300 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15301 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15302 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15304 /* With bidi-reordered rows, there could be more than
15305 one candidate row whose start and end positions
15306 occlude point. We need to let set_cursor_from_row
15307 find the best candidate. */
15308 /* FIXME: Revisit this when glyph ``spilling'' in
15309 continuation lines' rows is implemented for
15310 bidi-reordered rows. */
15315 int at_zv_p
= 0, exact_match_p
= 0;
15317 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15318 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15319 && cursor_row_p (row
))
15320 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15322 /* As soon as we've found the exact match for point,
15323 or the first suitable row whose ends_at_zv_p flag
15324 is set, we are done. */
15326 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15328 && w
->cursor
.hpos
>= 0
15329 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15332 struct glyph_row
*candidate
=
15333 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15335 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15336 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15339 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15340 || (INTEGERP (g
->object
)
15341 && (g
->charpos
== PT
15342 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15344 if (rv
&& (at_zv_p
|| exact_match_p
))
15346 rc
= CURSOR_MOVEMENT_SUCCESS
;
15349 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15353 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15354 || row
->continued_p
)
15355 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15356 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15357 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15358 /* If we didn't find any candidate rows, or exited the
15359 loop before all the candidates were examined, signal
15360 to the caller that this method failed. */
15361 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15363 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15364 && !row
->continued_p
))
15365 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15367 rc
= CURSOR_MOVEMENT_SUCCESS
;
15373 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15375 rc
= CURSOR_MOVEMENT_SUCCESS
;
15380 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15381 && MATRIX_ROW_START_CHARPOS (row
) == PT
15382 && cursor_row_p (row
));
15390 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15394 set_vertical_scroll_bar (struct window
*w
)
15396 ptrdiff_t start
, end
, whole
;
15398 /* Calculate the start and end positions for the current window.
15399 At some point, it would be nice to choose between scrollbars
15400 which reflect the whole buffer size, with special markers
15401 indicating narrowing, and scrollbars which reflect only the
15404 Note that mini-buffers sometimes aren't displaying any text. */
15405 if (!MINI_WINDOW_P (w
)
15406 || (w
== XWINDOW (minibuf_window
)
15407 && NILP (echo_area_buffer
[0])))
15409 struct buffer
*buf
= XBUFFER (w
->buffer
);
15410 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15411 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15412 /* I don't think this is guaranteed to be right. For the
15413 moment, we'll pretend it is. */
15414 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15418 if (whole
< (end
- start
))
15419 whole
= end
- start
;
15422 start
= end
= whole
= 0;
15424 /* Indicate what this scroll bar ought to be displaying now. */
15425 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15426 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15427 (w
, end
- start
, whole
, start
);
15431 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15432 selected_window is redisplayed.
15434 We can return without actually redisplaying the window if
15435 fonts_changed_p. In that case, redisplay_internal will
15439 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15441 struct window
*w
= XWINDOW (window
);
15442 struct frame
*f
= XFRAME (w
->frame
);
15443 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15444 struct buffer
*old
= current_buffer
;
15445 struct text_pos lpoint
, opoint
, startp
;
15446 int update_mode_line
;
15449 /* Record it now because it's overwritten. */
15450 int current_matrix_up_to_date_p
= 0;
15451 int used_current_matrix_p
= 0;
15452 /* This is less strict than current_matrix_up_to_date_p.
15453 It indicates that the buffer contents and narrowing are unchanged. */
15454 int buffer_unchanged_p
= 0;
15455 int temp_scroll_step
= 0;
15456 ptrdiff_t count
= SPECPDL_INDEX ();
15458 int centering_position
= -1;
15459 int last_line_misfit
= 0;
15460 ptrdiff_t beg_unchanged
, end_unchanged
;
15462 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15465 /* W must be a leaf window here. */
15466 eassert (!NILP (w
->buffer
));
15468 *w
->desired_matrix
->method
= 0;
15472 reconsider_clip_changes (w
, buffer
);
15474 /* Has the mode line to be updated? */
15475 update_mode_line
= (w
->update_mode_line
15476 || update_mode_lines
15477 || buffer
->clip_changed
15478 || buffer
->prevent_redisplay_optimizations_p
);
15480 if (MINI_WINDOW_P (w
))
15482 if (w
== XWINDOW (echo_area_window
)
15483 && !NILP (echo_area_buffer
[0]))
15485 if (update_mode_line
)
15486 /* We may have to update a tty frame's menu bar or a
15487 tool-bar. Example `M-x C-h C-h C-g'. */
15488 goto finish_menu_bars
;
15490 /* We've already displayed the echo area glyphs in this window. */
15491 goto finish_scroll_bars
;
15493 else if ((w
!= XWINDOW (minibuf_window
)
15494 || minibuf_level
== 0)
15495 /* When buffer is nonempty, redisplay window normally. */
15496 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15497 /* Quail displays non-mini buffers in minibuffer window.
15498 In that case, redisplay the window normally. */
15499 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15501 /* W is a mini-buffer window, but it's not active, so clear
15503 int yb
= window_text_bottom_y (w
);
15504 struct glyph_row
*row
;
15507 for (y
= 0, row
= w
->desired_matrix
->rows
;
15509 y
+= row
->height
, ++row
)
15510 blank_row (w
, row
, y
);
15511 goto finish_scroll_bars
;
15514 clear_glyph_matrix (w
->desired_matrix
);
15517 /* Otherwise set up data on this window; select its buffer and point
15519 /* Really select the buffer, for the sake of buffer-local
15521 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15523 current_matrix_up_to_date_p
15524 = (!NILP (w
->window_end_valid
)
15525 && !current_buffer
->clip_changed
15526 && !current_buffer
->prevent_redisplay_optimizations_p
15527 && !window_outdated (w
));
15529 /* Run the window-bottom-change-functions
15530 if it is possible that the text on the screen has changed
15531 (either due to modification of the text, or any other reason). */
15532 if (!current_matrix_up_to_date_p
15533 && !NILP (Vwindow_text_change_functions
))
15535 safe_run_hooks (Qwindow_text_change_functions
);
15539 beg_unchanged
= BEG_UNCHANGED
;
15540 end_unchanged
= END_UNCHANGED
;
15542 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15544 specbind (Qinhibit_point_motion_hooks
, Qt
);
15547 = (!NILP (w
->window_end_valid
)
15548 && !current_buffer
->clip_changed
15549 && !window_outdated (w
));
15551 /* When windows_or_buffers_changed is non-zero, we can't rely on
15552 the window end being valid, so set it to nil there. */
15553 if (windows_or_buffers_changed
)
15555 /* If window starts on a continuation line, maybe adjust the
15556 window start in case the window's width changed. */
15557 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15558 compute_window_start_on_continuation_line (w
);
15560 wset_window_end_valid (w
, Qnil
);
15563 /* Some sanity checks. */
15564 CHECK_WINDOW_END (w
);
15565 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15567 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15570 if (mode_line_update_needed (w
))
15571 update_mode_line
= 1;
15573 /* Point refers normally to the selected window. For any other
15574 window, set up appropriate value. */
15575 if (!EQ (window
, selected_window
))
15577 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15578 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15582 new_pt_byte
= BEGV_BYTE
;
15583 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15585 else if (new_pt
> (ZV
- 1))
15588 new_pt_byte
= ZV_BYTE
;
15589 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15592 /* We don't use SET_PT so that the point-motion hooks don't run. */
15593 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15596 /* If any of the character widths specified in the display table
15597 have changed, invalidate the width run cache. It's true that
15598 this may be a bit late to catch such changes, but the rest of
15599 redisplay goes (non-fatally) haywire when the display table is
15600 changed, so why should we worry about doing any better? */
15601 if (current_buffer
->width_run_cache
)
15603 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15605 if (! disptab_matches_widthtab
15606 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15608 invalidate_region_cache (current_buffer
,
15609 current_buffer
->width_run_cache
,
15611 recompute_width_table (current_buffer
, disptab
);
15615 /* If window-start is screwed up, choose a new one. */
15616 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15619 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15621 /* If someone specified a new starting point but did not insist,
15622 check whether it can be used. */
15623 if (w
->optional_new_start
15624 && CHARPOS (startp
) >= BEGV
15625 && CHARPOS (startp
) <= ZV
)
15627 w
->optional_new_start
= 0;
15628 start_display (&it
, w
, startp
);
15629 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15630 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15631 if (IT_CHARPOS (it
) == PT
)
15632 w
->force_start
= 1;
15633 /* IT may overshoot PT if text at PT is invisible. */
15634 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15635 w
->force_start
= 1;
15640 /* Handle case where place to start displaying has been specified,
15641 unless the specified location is outside the accessible range. */
15642 if (w
->force_start
|| w
->frozen_window_start_p
)
15644 /* We set this later on if we have to adjust point. */
15647 w
->force_start
= 0;
15649 wset_window_end_valid (w
, Qnil
);
15651 /* Forget any recorded base line for line number display. */
15652 if (!buffer_unchanged_p
)
15653 wset_base_line_number (w
, Qnil
);
15655 /* Redisplay the mode line. Select the buffer properly for that.
15656 Also, run the hook window-scroll-functions
15657 because we have scrolled. */
15658 /* Note, we do this after clearing force_start because
15659 if there's an error, it is better to forget about force_start
15660 than to get into an infinite loop calling the hook functions
15661 and having them get more errors. */
15662 if (!update_mode_line
15663 || ! NILP (Vwindow_scroll_functions
))
15665 update_mode_line
= 1;
15666 w
->update_mode_line
= 1;
15667 startp
= run_window_scroll_functions (window
, startp
);
15670 w
->last_modified
= 0;
15671 w
->last_overlay_modified
= 0;
15672 if (CHARPOS (startp
) < BEGV
)
15673 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15674 else if (CHARPOS (startp
) > ZV
)
15675 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15677 /* Redisplay, then check if cursor has been set during the
15678 redisplay. Give up if new fonts were loaded. */
15679 /* We used to issue a CHECK_MARGINS argument to try_window here,
15680 but this causes scrolling to fail when point begins inside
15681 the scroll margin (bug#148) -- cyd */
15682 if (!try_window (window
, startp
, 0))
15684 w
->force_start
= 1;
15685 clear_glyph_matrix (w
->desired_matrix
);
15686 goto need_larger_matrices
;
15689 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15691 /* If point does not appear, try to move point so it does
15692 appear. The desired matrix has been built above, so we
15693 can use it here. */
15694 new_vpos
= window_box_height (w
) / 2;
15697 if (!cursor_row_fully_visible_p (w
, 0, 0))
15699 /* Point does appear, but on a line partly visible at end of window.
15700 Move it back to a fully-visible line. */
15701 new_vpos
= window_box_height (w
);
15703 else if (w
->cursor
.vpos
>=0)
15705 /* Some people insist on not letting point enter the scroll
15706 margin, even though this part handles windows that didn't
15708 struct frame
*f
= XFRAME (w
->frame
);
15709 int margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15710 int pixel_margin
= margin
* FRAME_LINE_HEIGHT (f
);
15711 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
15713 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
15714 below, which finds the row to move point to, advances by
15715 the Y coordinate of the _next_ row, see the definition of
15716 MATRIX_ROW_BOTTOM_Y. */
15717 if (w
->cursor
.vpos
< margin
+ header_line
)
15719 = pixel_margin
+ (header_line
15720 ? CURRENT_HEADER_LINE_HEIGHT (w
)
15721 : 0) + FRAME_LINE_HEIGHT (f
);
15724 int window_height
= window_box_height (w
);
15727 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15728 if (w
->cursor
.y
>= window_height
- pixel_margin
)
15729 new_vpos
= window_height
- pixel_margin
;
15733 /* If we need to move point for either of the above reasons,
15734 now actually do it. */
15737 struct glyph_row
*row
;
15739 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15740 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15743 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15744 MATRIX_ROW_START_BYTEPOS (row
));
15746 if (w
!= XWINDOW (selected_window
))
15747 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15748 else if (current_buffer
== old
)
15749 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15751 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15753 /* If we are highlighting the region, then we just changed
15754 the region, so redisplay to show it. */
15755 if (0 <= markpos_of_region ())
15757 clear_glyph_matrix (w
->desired_matrix
);
15758 if (!try_window (window
, startp
, 0))
15759 goto need_larger_matrices
;
15764 debug_method_add (w
, "forced window start");
15769 /* Handle case where text has not changed, only point, and it has
15770 not moved off the frame, and we are not retrying after hscroll.
15771 (current_matrix_up_to_date_p is nonzero when retrying.) */
15772 if (current_matrix_up_to_date_p
15773 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15774 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15778 case CURSOR_MOVEMENT_SUCCESS
:
15779 used_current_matrix_p
= 1;
15782 case CURSOR_MOVEMENT_MUST_SCROLL
:
15783 goto try_to_scroll
;
15789 /* If current starting point was originally the beginning of a line
15790 but no longer is, find a new starting point. */
15791 else if (w
->start_at_line_beg
15792 && !(CHARPOS (startp
) <= BEGV
15793 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15796 debug_method_add (w
, "recenter 1");
15801 /* Try scrolling with try_window_id. Value is > 0 if update has
15802 been done, it is -1 if we know that the same window start will
15803 not work. It is 0 if unsuccessful for some other reason. */
15804 else if ((tem
= try_window_id (w
)) != 0)
15807 debug_method_add (w
, "try_window_id %d", tem
);
15810 if (fonts_changed_p
)
15811 goto need_larger_matrices
;
15815 /* Otherwise try_window_id has returned -1 which means that we
15816 don't want the alternative below this comment to execute. */
15818 else if (CHARPOS (startp
) >= BEGV
15819 && CHARPOS (startp
) <= ZV
15820 && PT
>= CHARPOS (startp
)
15821 && (CHARPOS (startp
) < ZV
15822 /* Avoid starting at end of buffer. */
15823 || CHARPOS (startp
) == BEGV
15824 || !window_outdated (w
)))
15826 int d1
, d2
, d3
, d4
, d5
, d6
;
15828 /* If first window line is a continuation line, and window start
15829 is inside the modified region, but the first change is before
15830 current window start, we must select a new window start.
15832 However, if this is the result of a down-mouse event (e.g. by
15833 extending the mouse-drag-overlay), we don't want to select a
15834 new window start, since that would change the position under
15835 the mouse, resulting in an unwanted mouse-movement rather
15836 than a simple mouse-click. */
15837 if (!w
->start_at_line_beg
15838 && NILP (do_mouse_tracking
)
15839 && CHARPOS (startp
) > BEGV
15840 && CHARPOS (startp
) > BEG
+ beg_unchanged
15841 && CHARPOS (startp
) <= Z
- end_unchanged
15842 /* Even if w->start_at_line_beg is nil, a new window may
15843 start at a line_beg, since that's how set_buffer_window
15844 sets it. So, we need to check the return value of
15845 compute_window_start_on_continuation_line. (See also
15847 && XMARKER (w
->start
)->buffer
== current_buffer
15848 && compute_window_start_on_continuation_line (w
)
15849 /* It doesn't make sense to force the window start like we
15850 do at label force_start if it is already known that point
15851 will not be visible in the resulting window, because
15852 doing so will move point from its correct position
15853 instead of scrolling the window to bring point into view.
15855 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15857 w
->force_start
= 1;
15858 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15863 debug_method_add (w
, "same window start");
15866 /* Try to redisplay starting at same place as before.
15867 If point has not moved off frame, accept the results. */
15868 if (!current_matrix_up_to_date_p
15869 /* Don't use try_window_reusing_current_matrix in this case
15870 because a window scroll function can have changed the
15872 || !NILP (Vwindow_scroll_functions
)
15873 || MINI_WINDOW_P (w
)
15874 || !(used_current_matrix_p
15875 = try_window_reusing_current_matrix (w
)))
15877 IF_DEBUG (debug_method_add (w
, "1"));
15878 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15879 /* -1 means we need to scroll.
15880 0 means we need new matrices, but fonts_changed_p
15881 is set in that case, so we will detect it below. */
15882 goto try_to_scroll
;
15885 if (fonts_changed_p
)
15886 goto need_larger_matrices
;
15888 if (w
->cursor
.vpos
>= 0)
15890 if (!just_this_one_p
15891 || current_buffer
->clip_changed
15892 || BEG_UNCHANGED
< CHARPOS (startp
))
15893 /* Forget any recorded base line for line number display. */
15894 wset_base_line_number (w
, Qnil
);
15896 if (!cursor_row_fully_visible_p (w
, 1, 0))
15898 clear_glyph_matrix (w
->desired_matrix
);
15899 last_line_misfit
= 1;
15901 /* Drop through and scroll. */
15906 clear_glyph_matrix (w
->desired_matrix
);
15911 w
->last_modified
= 0;
15912 w
->last_overlay_modified
= 0;
15914 /* Redisplay the mode line. Select the buffer properly for that. */
15915 if (!update_mode_line
)
15917 update_mode_line
= 1;
15918 w
->update_mode_line
= 1;
15921 /* Try to scroll by specified few lines. */
15922 if ((scroll_conservatively
15923 || emacs_scroll_step
15924 || temp_scroll_step
15925 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15926 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15927 && CHARPOS (startp
) >= BEGV
15928 && CHARPOS (startp
) <= ZV
)
15930 /* The function returns -1 if new fonts were loaded, 1 if
15931 successful, 0 if not successful. */
15932 int ss
= try_scrolling (window
, just_this_one_p
,
15933 scroll_conservatively
,
15935 temp_scroll_step
, last_line_misfit
);
15938 case SCROLLING_SUCCESS
:
15941 case SCROLLING_NEED_LARGER_MATRICES
:
15942 goto need_larger_matrices
;
15944 case SCROLLING_FAILED
:
15952 /* Finally, just choose a place to start which positions point
15953 according to user preferences. */
15958 debug_method_add (w
, "recenter");
15961 /* w->vscroll = 0; */
15963 /* Forget any previously recorded base line for line number display. */
15964 if (!buffer_unchanged_p
)
15965 wset_base_line_number (w
, Qnil
);
15967 /* Determine the window start relative to point. */
15968 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15969 it
.current_y
= it
.last_visible_y
;
15970 if (centering_position
< 0)
15974 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15976 ptrdiff_t margin_pos
= CHARPOS (startp
);
15977 Lisp_Object aggressive
;
15980 /* If there is a scroll margin at the top of the window, find
15981 its character position. */
15983 /* Cannot call start_display if startp is not in the
15984 accessible region of the buffer. This can happen when we
15985 have just switched to a different buffer and/or changed
15986 its restriction. In that case, startp is initialized to
15987 the character position 1 (BEGV) because we did not yet
15988 have chance to display the buffer even once. */
15989 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15992 void *it1data
= NULL
;
15994 SAVE_IT (it1
, it
, it1data
);
15995 start_display (&it1
, w
, startp
);
15996 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15997 margin_pos
= IT_CHARPOS (it1
);
15998 RESTORE_IT (&it
, &it
, it1data
);
16000 scrolling_up
= PT
> margin_pos
;
16003 ? BVAR (current_buffer
, scroll_up_aggressively
)
16004 : BVAR (current_buffer
, scroll_down_aggressively
);
16006 if (!MINI_WINDOW_P (w
)
16007 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16011 /* Setting scroll-conservatively overrides
16012 scroll-*-aggressively. */
16013 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16015 double float_amount
= XFLOATINT (aggressive
);
16017 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16018 if (pt_offset
== 0 && float_amount
> 0)
16020 if (pt_offset
&& margin
> 0)
16023 /* Compute how much to move the window start backward from
16024 point so that point will be displayed where the user
16028 centering_position
= it
.last_visible_y
;
16030 centering_position
-= pt_offset
;
16031 centering_position
-=
16032 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
16033 + WINDOW_HEADER_LINE_HEIGHT (w
);
16034 /* Don't let point enter the scroll margin near top of
16036 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
16037 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
16040 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
16043 /* Set the window start half the height of the window backward
16045 centering_position
= window_box_height (w
) / 2;
16047 move_it_vertically_backward (&it
, centering_position
);
16049 eassert (IT_CHARPOS (it
) >= BEGV
);
16051 /* The function move_it_vertically_backward may move over more
16052 than the specified y-distance. If it->w is small, e.g. a
16053 mini-buffer window, we may end up in front of the window's
16054 display area. Start displaying at the start of the line
16055 containing PT in this case. */
16056 if (it
.current_y
<= 0)
16058 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16059 move_it_vertically_backward (&it
, 0);
16063 it
.current_x
= it
.hpos
= 0;
16065 /* Set the window start position here explicitly, to avoid an
16066 infinite loop in case the functions in window-scroll-functions
16068 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16070 /* Run scroll hooks. */
16071 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16073 /* Redisplay the window. */
16074 if (!current_matrix_up_to_date_p
16075 || windows_or_buffers_changed
16076 || cursor_type_changed
16077 /* Don't use try_window_reusing_current_matrix in this case
16078 because it can have changed the buffer. */
16079 || !NILP (Vwindow_scroll_functions
)
16080 || !just_this_one_p
16081 || MINI_WINDOW_P (w
)
16082 || !(used_current_matrix_p
16083 = try_window_reusing_current_matrix (w
)))
16084 try_window (window
, startp
, 0);
16086 /* If new fonts have been loaded (due to fontsets), give up. We
16087 have to start a new redisplay since we need to re-adjust glyph
16089 if (fonts_changed_p
)
16090 goto need_larger_matrices
;
16092 /* If cursor did not appear assume that the middle of the window is
16093 in the first line of the window. Do it again with the next line.
16094 (Imagine a window of height 100, displaying two lines of height
16095 60. Moving back 50 from it->last_visible_y will end in the first
16097 if (w
->cursor
.vpos
< 0)
16099 if (!NILP (w
->window_end_valid
)
16100 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
16102 clear_glyph_matrix (w
->desired_matrix
);
16103 move_it_by_lines (&it
, 1);
16104 try_window (window
, it
.current
.pos
, 0);
16106 else if (PT
< IT_CHARPOS (it
))
16108 clear_glyph_matrix (w
->desired_matrix
);
16109 move_it_by_lines (&it
, -1);
16110 try_window (window
, it
.current
.pos
, 0);
16114 /* Not much we can do about it. */
16118 /* Consider the following case: Window starts at BEGV, there is
16119 invisible, intangible text at BEGV, so that display starts at
16120 some point START > BEGV. It can happen that we are called with
16121 PT somewhere between BEGV and START. Try to handle that case. */
16122 if (w
->cursor
.vpos
< 0)
16124 struct glyph_row
*row
= w
->current_matrix
->rows
;
16125 if (row
->mode_line_p
)
16127 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16130 if (!cursor_row_fully_visible_p (w
, 0, 0))
16132 /* If vscroll is enabled, disable it and try again. */
16136 clear_glyph_matrix (w
->desired_matrix
);
16140 /* Users who set scroll-conservatively to a large number want
16141 point just above/below the scroll margin. If we ended up
16142 with point's row partially visible, move the window start to
16143 make that row fully visible and out of the margin. */
16144 if (scroll_conservatively
> SCROLL_LIMIT
)
16148 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
16150 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
16152 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16153 clear_glyph_matrix (w
->desired_matrix
);
16154 if (1 == try_window (window
, it
.current
.pos
,
16155 TRY_WINDOW_CHECK_MARGINS
))
16159 /* If centering point failed to make the whole line visible,
16160 put point at the top instead. That has to make the whole line
16161 visible, if it can be done. */
16162 if (centering_position
== 0)
16165 clear_glyph_matrix (w
->desired_matrix
);
16166 centering_position
= 0;
16172 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16173 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16174 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16176 /* Display the mode line, if we must. */
16177 if ((update_mode_line
16178 /* If window not full width, must redo its mode line
16179 if (a) the window to its side is being redone and
16180 (b) we do a frame-based redisplay. This is a consequence
16181 of how inverted lines are drawn in frame-based redisplay. */
16182 || (!just_this_one_p
16183 && !FRAME_WINDOW_P (f
)
16184 && !WINDOW_FULL_WIDTH_P (w
))
16185 /* Line number to display. */
16186 || INTEGERP (w
->base_line_pos
)
16187 /* Column number is displayed and different from the one displayed. */
16188 || (!NILP (w
->column_number_displayed
)
16189 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
16190 /* This means that the window has a mode line. */
16191 && (WINDOW_WANTS_MODELINE_P (w
)
16192 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16194 display_mode_lines (w
);
16196 /* If mode line height has changed, arrange for a thorough
16197 immediate redisplay using the correct mode line height. */
16198 if (WINDOW_WANTS_MODELINE_P (w
)
16199 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16201 fonts_changed_p
= 1;
16202 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16203 = DESIRED_MODE_LINE_HEIGHT (w
);
16206 /* If header line height has changed, arrange for a thorough
16207 immediate redisplay using the correct header line height. */
16208 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16209 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16211 fonts_changed_p
= 1;
16212 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16213 = DESIRED_HEADER_LINE_HEIGHT (w
);
16216 if (fonts_changed_p
)
16217 goto need_larger_matrices
;
16220 if (!line_number_displayed
16221 && !BUFFERP (w
->base_line_pos
))
16223 wset_base_line_pos (w
, Qnil
);
16224 wset_base_line_number (w
, Qnil
);
16229 /* When we reach a frame's selected window, redo the frame's menu bar. */
16230 if (update_mode_line
16231 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16233 int redisplay_menu_p
= 0;
16235 if (FRAME_WINDOW_P (f
))
16237 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16238 || defined (HAVE_NS) || defined (USE_GTK)
16239 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16241 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16245 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16247 if (redisplay_menu_p
)
16248 display_menu_bar (w
);
16250 #ifdef HAVE_WINDOW_SYSTEM
16251 if (FRAME_WINDOW_P (f
))
16253 #if defined (USE_GTK) || defined (HAVE_NS)
16254 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16255 redisplay_tool_bar (f
);
16257 if (WINDOWP (f
->tool_bar_window
)
16258 && (FRAME_TOOL_BAR_LINES (f
) > 0
16259 || !NILP (Vauto_resize_tool_bars
))
16260 && redisplay_tool_bar (f
))
16261 ignore_mouse_drag_p
= 1;
16267 #ifdef HAVE_WINDOW_SYSTEM
16268 if (FRAME_WINDOW_P (f
)
16269 && update_window_fringes (w
, (just_this_one_p
16270 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16271 || w
->pseudo_window_p
)))
16275 if (draw_window_fringes (w
, 1))
16276 x_draw_vertical_border (w
);
16280 #endif /* HAVE_WINDOW_SYSTEM */
16282 /* We go to this label, with fonts_changed_p set,
16283 if it is necessary to try again using larger glyph matrices.
16284 We have to redeem the scroll bar even in this case,
16285 because the loop in redisplay_internal expects that. */
16286 need_larger_matrices
:
16288 finish_scroll_bars
:
16290 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16292 /* Set the thumb's position and size. */
16293 set_vertical_scroll_bar (w
);
16295 /* Note that we actually used the scroll bar attached to this
16296 window, so it shouldn't be deleted at the end of redisplay. */
16297 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16298 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16301 /* Restore current_buffer and value of point in it. The window
16302 update may have changed the buffer, so first make sure `opoint'
16303 is still valid (Bug#6177). */
16304 if (CHARPOS (opoint
) < BEGV
)
16305 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16306 else if (CHARPOS (opoint
) > ZV
)
16307 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16309 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16311 set_buffer_internal_1 (old
);
16312 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16313 shorter. This can be caused by log truncation in *Messages*. */
16314 if (CHARPOS (lpoint
) <= ZV
)
16315 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16317 unbind_to (count
, Qnil
);
16321 /* Build the complete desired matrix of WINDOW with a window start
16322 buffer position POS.
16324 Value is 1 if successful. It is zero if fonts were loaded during
16325 redisplay which makes re-adjusting glyph matrices necessary, and -1
16326 if point would appear in the scroll margins.
16327 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16328 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16332 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16334 struct window
*w
= XWINDOW (window
);
16336 struct glyph_row
*last_text_row
= NULL
;
16337 struct frame
*f
= XFRAME (w
->frame
);
16339 /* Make POS the new window start. */
16340 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16342 /* Mark cursor position as unknown. No overlay arrow seen. */
16343 w
->cursor
.vpos
= -1;
16344 overlay_arrow_seen
= 0;
16346 /* Initialize iterator and info to start at POS. */
16347 start_display (&it
, w
, pos
);
16349 /* Display all lines of W. */
16350 while (it
.current_y
< it
.last_visible_y
)
16352 if (display_line (&it
))
16353 last_text_row
= it
.glyph_row
- 1;
16354 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16358 /* Don't let the cursor end in the scroll margins. */
16359 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16360 && !MINI_WINDOW_P (w
))
16362 int this_scroll_margin
;
16364 if (scroll_margin
> 0)
16366 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16367 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16370 this_scroll_margin
= 0;
16372 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16373 && w
->cursor
.y
< this_scroll_margin
16374 && CHARPOS (pos
) > BEGV
16375 && IT_CHARPOS (it
) < ZV
)
16376 /* rms: considering make_cursor_line_fully_visible_p here
16377 seems to give wrong results. We don't want to recenter
16378 when the last line is partly visible, we want to allow
16379 that case to be handled in the usual way. */
16380 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16382 w
->cursor
.vpos
= -1;
16383 clear_glyph_matrix (w
->desired_matrix
);
16388 /* If bottom moved off end of frame, change mode line percentage. */
16389 if (XFASTINT (w
->window_end_pos
) <= 0
16390 && Z
!= IT_CHARPOS (it
))
16391 w
->update_mode_line
= 1;
16393 /* Set window_end_pos to the offset of the last character displayed
16394 on the window from the end of current_buffer. Set
16395 window_end_vpos to its row number. */
16398 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16399 w
->window_end_bytepos
16400 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16401 wset_window_end_pos
16402 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16403 wset_window_end_vpos
16404 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
)));
16406 (MATRIX_ROW (w
->desired_matrix
,
16407 XFASTINT (w
->window_end_vpos
))->displays_text_p
);
16411 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16412 wset_window_end_pos (w
, make_number (Z
- ZV
));
16413 wset_window_end_vpos (w
, make_number (0));
16416 /* But that is not valid info until redisplay finishes. */
16417 wset_window_end_valid (w
, Qnil
);
16423 /************************************************************************
16424 Window redisplay reusing current matrix when buffer has not changed
16425 ************************************************************************/
16427 /* Try redisplay of window W showing an unchanged buffer with a
16428 different window start than the last time it was displayed by
16429 reusing its current matrix. Value is non-zero if successful.
16430 W->start is the new window start. */
16433 try_window_reusing_current_matrix (struct window
*w
)
16435 struct frame
*f
= XFRAME (w
->frame
);
16436 struct glyph_row
*bottom_row
;
16439 struct text_pos start
, new_start
;
16440 int nrows_scrolled
, i
;
16441 struct glyph_row
*last_text_row
;
16442 struct glyph_row
*last_reused_text_row
;
16443 struct glyph_row
*start_row
;
16444 int start_vpos
, min_y
, max_y
;
16447 if (inhibit_try_window_reusing
)
16451 if (/* This function doesn't handle terminal frames. */
16452 !FRAME_WINDOW_P (f
)
16453 /* Don't try to reuse the display if windows have been split
16455 || windows_or_buffers_changed
16456 || cursor_type_changed
)
16459 /* Can't do this if region may have changed. */
16460 if (0 <= markpos_of_region ()
16461 || !NILP (w
->region_showing
)
16462 || !NILP (Vshow_trailing_whitespace
))
16465 /* If top-line visibility has changed, give up. */
16466 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16467 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16470 /* Give up if old or new display is scrolled vertically. We could
16471 make this function handle this, but right now it doesn't. */
16472 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16473 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16476 /* The variable new_start now holds the new window start. The old
16477 start `start' can be determined from the current matrix. */
16478 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16479 start
= start_row
->minpos
;
16480 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16482 /* Clear the desired matrix for the display below. */
16483 clear_glyph_matrix (w
->desired_matrix
);
16485 if (CHARPOS (new_start
) <= CHARPOS (start
))
16487 /* Don't use this method if the display starts with an ellipsis
16488 displayed for invisible text. It's not easy to handle that case
16489 below, and it's certainly not worth the effort since this is
16490 not a frequent case. */
16491 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16494 IF_DEBUG (debug_method_add (w
, "twu1"));
16496 /* Display up to a row that can be reused. The variable
16497 last_text_row is set to the last row displayed that displays
16498 text. Note that it.vpos == 0 if or if not there is a
16499 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16500 start_display (&it
, w
, new_start
);
16501 w
->cursor
.vpos
= -1;
16502 last_text_row
= last_reused_text_row
= NULL
;
16504 while (it
.current_y
< it
.last_visible_y
16505 && !fonts_changed_p
)
16507 /* If we have reached into the characters in the START row,
16508 that means the line boundaries have changed. So we
16509 can't start copying with the row START. Maybe it will
16510 work to start copying with the following row. */
16511 while (IT_CHARPOS (it
) > CHARPOS (start
))
16513 /* Advance to the next row as the "start". */
16515 start
= start_row
->minpos
;
16516 /* If there are no more rows to try, or just one, give up. */
16517 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16518 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16519 || CHARPOS (start
) == ZV
)
16521 clear_glyph_matrix (w
->desired_matrix
);
16525 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16527 /* If we have reached alignment, we can copy the rest of the
16529 if (IT_CHARPOS (it
) == CHARPOS (start
)
16530 /* Don't accept "alignment" inside a display vector,
16531 since start_row could have started in the middle of
16532 that same display vector (thus their character
16533 positions match), and we have no way of telling if
16534 that is the case. */
16535 && it
.current
.dpvec_index
< 0)
16538 if (display_line (&it
))
16539 last_text_row
= it
.glyph_row
- 1;
16543 /* A value of current_y < last_visible_y means that we stopped
16544 at the previous window start, which in turn means that we
16545 have at least one reusable row. */
16546 if (it
.current_y
< it
.last_visible_y
)
16548 struct glyph_row
*row
;
16550 /* IT.vpos always starts from 0; it counts text lines. */
16551 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16553 /* Find PT if not already found in the lines displayed. */
16554 if (w
->cursor
.vpos
< 0)
16556 int dy
= it
.current_y
- start_row
->y
;
16558 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16559 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16561 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16562 dy
, nrows_scrolled
);
16565 clear_glyph_matrix (w
->desired_matrix
);
16570 /* Scroll the display. Do it before the current matrix is
16571 changed. The problem here is that update has not yet
16572 run, i.e. part of the current matrix is not up to date.
16573 scroll_run_hook will clear the cursor, and use the
16574 current matrix to get the height of the row the cursor is
16576 run
.current_y
= start_row
->y
;
16577 run
.desired_y
= it
.current_y
;
16578 run
.height
= it
.last_visible_y
- it
.current_y
;
16580 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16583 FRAME_RIF (f
)->update_window_begin_hook (w
);
16584 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16585 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16586 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16590 /* Shift current matrix down by nrows_scrolled lines. */
16591 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16592 rotate_matrix (w
->current_matrix
,
16594 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16597 /* Disable lines that must be updated. */
16598 for (i
= 0; i
< nrows_scrolled
; ++i
)
16599 (start_row
+ i
)->enabled_p
= 0;
16601 /* Re-compute Y positions. */
16602 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16603 max_y
= it
.last_visible_y
;
16604 for (row
= start_row
+ nrows_scrolled
;
16608 row
->y
= it
.current_y
;
16609 row
->visible_height
= row
->height
;
16611 if (row
->y
< min_y
)
16612 row
->visible_height
-= min_y
- row
->y
;
16613 if (row
->y
+ row
->height
> max_y
)
16614 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16615 if (row
->fringe_bitmap_periodic_p
)
16616 row
->redraw_fringe_bitmaps_p
= 1;
16618 it
.current_y
+= row
->height
;
16620 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16621 last_reused_text_row
= row
;
16622 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16626 /* Disable lines in the current matrix which are now
16627 below the window. */
16628 for (++row
; row
< bottom_row
; ++row
)
16629 row
->enabled_p
= row
->mode_line_p
= 0;
16632 /* Update window_end_pos etc.; last_reused_text_row is the last
16633 reused row from the current matrix containing text, if any.
16634 The value of last_text_row is the last displayed line
16635 containing text. */
16636 if (last_reused_text_row
)
16638 w
->window_end_bytepos
16639 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16640 wset_window_end_pos
16642 - MATRIX_ROW_END_CHARPOS (last_reused_text_row
)));
16643 wset_window_end_vpos
16644 (w
, make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16645 w
->current_matrix
)));
16647 else if (last_text_row
)
16649 w
->window_end_bytepos
16650 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16651 wset_window_end_pos
16652 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16653 wset_window_end_vpos
16654 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16655 w
->desired_matrix
)));
16659 /* This window must be completely empty. */
16660 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16661 wset_window_end_pos (w
, make_number (Z
- ZV
));
16662 wset_window_end_vpos (w
, make_number (0));
16664 wset_window_end_valid (w
, Qnil
);
16666 /* Update hint: don't try scrolling again in update_window. */
16667 w
->desired_matrix
->no_scrolling_p
= 1;
16670 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16674 else if (CHARPOS (new_start
) > CHARPOS (start
))
16676 struct glyph_row
*pt_row
, *row
;
16677 struct glyph_row
*first_reusable_row
;
16678 struct glyph_row
*first_row_to_display
;
16680 int yb
= window_text_bottom_y (w
);
16682 /* Find the row starting at new_start, if there is one. Don't
16683 reuse a partially visible line at the end. */
16684 first_reusable_row
= start_row
;
16685 while (first_reusable_row
->enabled_p
16686 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16687 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16688 < CHARPOS (new_start
)))
16689 ++first_reusable_row
;
16691 /* Give up if there is no row to reuse. */
16692 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16693 || !first_reusable_row
->enabled_p
16694 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16695 != CHARPOS (new_start
)))
16698 /* We can reuse fully visible rows beginning with
16699 first_reusable_row to the end of the window. Set
16700 first_row_to_display to the first row that cannot be reused.
16701 Set pt_row to the row containing point, if there is any. */
16703 for (first_row_to_display
= first_reusable_row
;
16704 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16705 ++first_row_to_display
)
16707 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16708 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16709 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16710 && first_row_to_display
->ends_at_zv_p
16711 && pt_row
== NULL
)))
16712 pt_row
= first_row_to_display
;
16715 /* Start displaying at the start of first_row_to_display. */
16716 eassert (first_row_to_display
->y
< yb
);
16717 init_to_row_start (&it
, w
, first_row_to_display
);
16719 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16721 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16723 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16724 + WINDOW_HEADER_LINE_HEIGHT (w
));
16726 /* Display lines beginning with first_row_to_display in the
16727 desired matrix. Set last_text_row to the last row displayed
16728 that displays text. */
16729 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16730 if (pt_row
== NULL
)
16731 w
->cursor
.vpos
= -1;
16732 last_text_row
= NULL
;
16733 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16734 if (display_line (&it
))
16735 last_text_row
= it
.glyph_row
- 1;
16737 /* If point is in a reused row, adjust y and vpos of the cursor
16741 w
->cursor
.vpos
-= nrows_scrolled
;
16742 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16745 /* Give up if point isn't in a row displayed or reused. (This
16746 also handles the case where w->cursor.vpos < nrows_scrolled
16747 after the calls to display_line, which can happen with scroll
16748 margins. See bug#1295.) */
16749 if (w
->cursor
.vpos
< 0)
16751 clear_glyph_matrix (w
->desired_matrix
);
16755 /* Scroll the display. */
16756 run
.current_y
= first_reusable_row
->y
;
16757 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16758 run
.height
= it
.last_visible_y
- run
.current_y
;
16759 dy
= run
.current_y
- run
.desired_y
;
16764 FRAME_RIF (f
)->update_window_begin_hook (w
);
16765 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16766 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16767 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16771 /* Adjust Y positions of reused rows. */
16772 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16773 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16774 max_y
= it
.last_visible_y
;
16775 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16778 row
->visible_height
= row
->height
;
16779 if (row
->y
< min_y
)
16780 row
->visible_height
-= min_y
- row
->y
;
16781 if (row
->y
+ row
->height
> max_y
)
16782 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16783 if (row
->fringe_bitmap_periodic_p
)
16784 row
->redraw_fringe_bitmaps_p
= 1;
16787 /* Scroll the current matrix. */
16788 eassert (nrows_scrolled
> 0);
16789 rotate_matrix (w
->current_matrix
,
16791 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16794 /* Disable rows not reused. */
16795 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16796 row
->enabled_p
= 0;
16798 /* Point may have moved to a different line, so we cannot assume that
16799 the previous cursor position is valid; locate the correct row. */
16802 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16804 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16805 && !row
->ends_at_zv_p
;
16809 w
->cursor
.y
= row
->y
;
16811 if (row
< bottom_row
)
16813 /* Can't simply scan the row for point with
16814 bidi-reordered glyph rows. Let set_cursor_from_row
16815 figure out where to put the cursor, and if it fails,
16817 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16819 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
16822 clear_glyph_matrix (w
->desired_matrix
);
16828 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16829 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16832 && (!BUFFERP (glyph
->object
)
16833 || glyph
->charpos
< PT
);
16837 w
->cursor
.x
+= glyph
->pixel_width
;
16843 /* Adjust window end. A null value of last_text_row means that
16844 the window end is in reused rows which in turn means that
16845 only its vpos can have changed. */
16848 w
->window_end_bytepos
16849 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16850 wset_window_end_pos
16851 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16852 wset_window_end_vpos
16853 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16854 w
->desired_matrix
)));
16858 wset_window_end_vpos
16859 (w
, make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
));
16862 wset_window_end_valid (w
, Qnil
);
16863 w
->desired_matrix
->no_scrolling_p
= 1;
16866 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16876 /************************************************************************
16877 Window redisplay reusing current matrix when buffer has changed
16878 ************************************************************************/
16880 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16881 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16882 ptrdiff_t *, ptrdiff_t *);
16883 static struct glyph_row
*
16884 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16885 struct glyph_row
*);
16888 /* Return the last row in MATRIX displaying text. If row START is
16889 non-null, start searching with that row. IT gives the dimensions
16890 of the display. Value is null if matrix is empty; otherwise it is
16891 a pointer to the row found. */
16893 static struct glyph_row
*
16894 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16895 struct glyph_row
*start
)
16897 struct glyph_row
*row
, *row_found
;
16899 /* Set row_found to the last row in IT->w's current matrix
16900 displaying text. The loop looks funny but think of partially
16903 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16904 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16906 eassert (row
->enabled_p
);
16908 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16917 /* Return the last row in the current matrix of W that is not affected
16918 by changes at the start of current_buffer that occurred since W's
16919 current matrix was built. Value is null if no such row exists.
16921 BEG_UNCHANGED us the number of characters unchanged at the start of
16922 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16923 first changed character in current_buffer. Characters at positions <
16924 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16925 when the current matrix was built. */
16927 static struct glyph_row
*
16928 find_last_unchanged_at_beg_row (struct window
*w
)
16930 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16931 struct glyph_row
*row
;
16932 struct glyph_row
*row_found
= NULL
;
16933 int yb
= window_text_bottom_y (w
);
16935 /* Find the last row displaying unchanged text. */
16936 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16937 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16938 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16941 if (/* If row ends before first_changed_pos, it is unchanged,
16942 except in some case. */
16943 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16944 /* When row ends in ZV and we write at ZV it is not
16946 && !row
->ends_at_zv_p
16947 /* When first_changed_pos is the end of a continued line,
16948 row is not unchanged because it may be no longer
16950 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16951 && (row
->continued_p
16952 || row
->exact_window_width_line_p
))
16953 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16954 needs to be recomputed, so don't consider this row as
16955 unchanged. This happens when the last line was
16956 bidi-reordered and was killed immediately before this
16957 redisplay cycle. In that case, ROW->end stores the
16958 buffer position of the first visual-order character of
16959 the killed text, which is now beyond ZV. */
16960 && CHARPOS (row
->end
.pos
) <= ZV
)
16963 /* Stop if last visible row. */
16964 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16972 /* Find the first glyph row in the current matrix of W that is not
16973 affected by changes at the end of current_buffer since the
16974 time W's current matrix was built.
16976 Return in *DELTA the number of chars by which buffer positions in
16977 unchanged text at the end of current_buffer must be adjusted.
16979 Return in *DELTA_BYTES the corresponding number of bytes.
16981 Value is null if no such row exists, i.e. all rows are affected by
16984 static struct glyph_row
*
16985 find_first_unchanged_at_end_row (struct window
*w
,
16986 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16988 struct glyph_row
*row
;
16989 struct glyph_row
*row_found
= NULL
;
16991 *delta
= *delta_bytes
= 0;
16993 /* Display must not have been paused, otherwise the current matrix
16994 is not up to date. */
16995 eassert (!NILP (w
->window_end_valid
));
16997 /* A value of window_end_pos >= END_UNCHANGED means that the window
16998 end is in the range of changed text. If so, there is no
16999 unchanged row at the end of W's current matrix. */
17000 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
17003 /* Set row to the last row in W's current matrix displaying text. */
17004 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17006 /* If matrix is entirely empty, no unchanged row exists. */
17007 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17009 /* The value of row is the last glyph row in the matrix having a
17010 meaningful buffer position in it. The end position of row
17011 corresponds to window_end_pos. This allows us to translate
17012 buffer positions in the current matrix to current buffer
17013 positions for characters not in changed text. */
17015 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17016 ptrdiff_t Z_BYTE_old
=
17017 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17018 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17019 struct glyph_row
*first_text_row
17020 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17022 *delta
= Z
- Z_old
;
17023 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17025 /* Set last_unchanged_pos to the buffer position of the last
17026 character in the buffer that has not been changed. Z is the
17027 index + 1 of the last character in current_buffer, i.e. by
17028 subtracting END_UNCHANGED we get the index of the last
17029 unchanged character, and we have to add BEG to get its buffer
17031 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17032 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17034 /* Search backward from ROW for a row displaying a line that
17035 starts at a minimum position >= last_unchanged_pos_old. */
17036 for (; row
> first_text_row
; --row
)
17038 /* This used to abort, but it can happen.
17039 It is ok to just stop the search instead here. KFS. */
17040 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17043 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17048 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17054 /* Make sure that glyph rows in the current matrix of window W
17055 reference the same glyph memory as corresponding rows in the
17056 frame's frame matrix. This function is called after scrolling W's
17057 current matrix on a terminal frame in try_window_id and
17058 try_window_reusing_current_matrix. */
17061 sync_frame_with_window_matrix_rows (struct window
*w
)
17063 struct frame
*f
= XFRAME (w
->frame
);
17064 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17066 /* Preconditions: W must be a leaf window and full-width. Its frame
17067 must have a frame matrix. */
17068 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
17069 eassert (WINDOW_FULL_WIDTH_P (w
));
17070 eassert (!FRAME_WINDOW_P (f
));
17072 /* If W is a full-width window, glyph pointers in W's current matrix
17073 have, by definition, to be the same as glyph pointers in the
17074 corresponding frame matrix. Note that frame matrices have no
17075 marginal areas (see build_frame_matrix). */
17076 window_row
= w
->current_matrix
->rows
;
17077 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17078 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17079 while (window_row
< window_row_end
)
17081 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17082 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17084 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17085 frame_row
->glyphs
[TEXT_AREA
] = start
;
17086 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17087 frame_row
->glyphs
[LAST_AREA
] = end
;
17089 /* Disable frame rows whose corresponding window rows have
17090 been disabled in try_window_id. */
17091 if (!window_row
->enabled_p
)
17092 frame_row
->enabled_p
= 0;
17094 ++window_row
, ++frame_row
;
17099 /* Find the glyph row in window W containing CHARPOS. Consider all
17100 rows between START and END (not inclusive). END null means search
17101 all rows to the end of the display area of W. Value is the row
17102 containing CHARPOS or null. */
17105 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17106 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17108 struct glyph_row
*row
= start
;
17109 struct glyph_row
*best_row
= NULL
;
17110 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
17113 /* If we happen to start on a header-line, skip that. */
17114 if (row
->mode_line_p
)
17117 if ((end
&& row
>= end
) || !row
->enabled_p
)
17120 last_y
= window_text_bottom_y (w
) - dy
;
17124 /* Give up if we have gone too far. */
17125 if (end
&& row
>= end
)
17127 /* This formerly returned if they were equal.
17128 I think that both quantities are of a "last plus one" type;
17129 if so, when they are equal, the row is within the screen. -- rms. */
17130 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17133 /* If it is in this row, return this row. */
17134 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17135 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17136 /* The end position of a row equals the start
17137 position of the next row. If CHARPOS is there, we
17138 would rather display it in the next line, except
17139 when this line ends in ZV. */
17140 && !row
->ends_at_zv_p
17141 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
17142 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17146 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17147 || (!best_row
&& !row
->continued_p
))
17149 /* In bidi-reordered rows, there could be several rows
17150 occluding point, all of them belonging to the same
17151 continued line. We need to find the row which fits
17152 CHARPOS the best. */
17153 for (g
= row
->glyphs
[TEXT_AREA
];
17154 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17157 if (!STRINGP (g
->object
))
17159 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17161 mindif
= eabs (g
->charpos
- charpos
);
17163 /* Exact match always wins. */
17170 else if (best_row
&& !row
->continued_p
)
17177 /* Try to redisplay window W by reusing its existing display. W's
17178 current matrix must be up to date when this function is called,
17179 i.e. window_end_valid must not be nil.
17183 1 if display has been updated
17184 0 if otherwise unsuccessful
17185 -1 if redisplay with same window start is known not to succeed
17187 The following steps are performed:
17189 1. Find the last row in the current matrix of W that is not
17190 affected by changes at the start of current_buffer. If no such row
17193 2. Find the first row in W's current matrix that is not affected by
17194 changes at the end of current_buffer. Maybe there is no such row.
17196 3. Display lines beginning with the row + 1 found in step 1 to the
17197 row found in step 2 or, if step 2 didn't find a row, to the end of
17200 4. If cursor is not known to appear on the window, give up.
17202 5. If display stopped at the row found in step 2, scroll the
17203 display and current matrix as needed.
17205 6. Maybe display some lines at the end of W, if we must. This can
17206 happen under various circumstances, like a partially visible line
17207 becoming fully visible, or because newly displayed lines are displayed
17208 in smaller font sizes.
17210 7. Update W's window end information. */
17213 try_window_id (struct window
*w
)
17215 struct frame
*f
= XFRAME (w
->frame
);
17216 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17217 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17218 struct glyph_row
*last_unchanged_at_beg_row
;
17219 struct glyph_row
*first_unchanged_at_end_row
;
17220 struct glyph_row
*row
;
17221 struct glyph_row
*bottom_row
;
17224 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17226 struct text_pos start_pos
;
17228 int first_unchanged_at_end_vpos
= 0;
17229 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17230 struct text_pos start
;
17231 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17234 if (inhibit_try_window_id
)
17238 /* This is handy for debugging. */
17240 #define GIVE_UP(X) \
17242 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17246 #define GIVE_UP(X) return 0
17249 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17251 /* Don't use this for mini-windows because these can show
17252 messages and mini-buffers, and we don't handle that here. */
17253 if (MINI_WINDOW_P (w
))
17256 /* This flag is used to prevent redisplay optimizations. */
17257 if (windows_or_buffers_changed
|| cursor_type_changed
)
17260 /* Verify that narrowing has not changed.
17261 Also verify that we were not told to prevent redisplay optimizations.
17262 It would be nice to further
17263 reduce the number of cases where this prevents try_window_id. */
17264 if (current_buffer
->clip_changed
17265 || current_buffer
->prevent_redisplay_optimizations_p
)
17268 /* Window must either use window-based redisplay or be full width. */
17269 if (!FRAME_WINDOW_P (f
)
17270 && (!FRAME_LINE_INS_DEL_OK (f
)
17271 || !WINDOW_FULL_WIDTH_P (w
)))
17274 /* Give up if point is known NOT to appear in W. */
17275 if (PT
< CHARPOS (start
))
17278 /* Another way to prevent redisplay optimizations. */
17279 if (w
->last_modified
== 0)
17282 /* Verify that window is not hscrolled. */
17283 if (w
->hscroll
!= 0)
17286 /* Verify that display wasn't paused. */
17287 if (NILP (w
->window_end_valid
))
17290 /* Can't use this if highlighting a region because a cursor movement
17291 will do more than just set the cursor. */
17292 if (0 <= markpos_of_region ())
17295 /* Likewise if highlighting trailing whitespace. */
17296 if (!NILP (Vshow_trailing_whitespace
))
17299 /* Likewise if showing a region. */
17300 if (!NILP (w
->region_showing
))
17303 /* Can't use this if overlay arrow position and/or string have
17305 if (overlay_arrows_changed_p ())
17308 /* When word-wrap is on, adding a space to the first word of a
17309 wrapped line can change the wrap position, altering the line
17310 above it. It might be worthwhile to handle this more
17311 intelligently, but for now just redisplay from scratch. */
17312 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
17315 /* Under bidi reordering, adding or deleting a character in the
17316 beginning of a paragraph, before the first strong directional
17317 character, can change the base direction of the paragraph (unless
17318 the buffer specifies a fixed paragraph direction), which will
17319 require to redisplay the whole paragraph. It might be worthwhile
17320 to find the paragraph limits and widen the range of redisplayed
17321 lines to that, but for now just give up this optimization and
17322 redisplay from scratch. */
17323 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17324 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
17327 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17328 only if buffer has really changed. The reason is that the gap is
17329 initially at Z for freshly visited files. The code below would
17330 set end_unchanged to 0 in that case. */
17331 if (MODIFF
> SAVE_MODIFF
17332 /* This seems to happen sometimes after saving a buffer. */
17333 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17335 if (GPT
- BEG
< BEG_UNCHANGED
)
17336 BEG_UNCHANGED
= GPT
- BEG
;
17337 if (Z
- GPT
< END_UNCHANGED
)
17338 END_UNCHANGED
= Z
- GPT
;
17341 /* The position of the first and last character that has been changed. */
17342 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17343 last_changed_charpos
= Z
- END_UNCHANGED
;
17345 /* If window starts after a line end, and the last change is in
17346 front of that newline, then changes don't affect the display.
17347 This case happens with stealth-fontification. Note that although
17348 the display is unchanged, glyph positions in the matrix have to
17349 be adjusted, of course. */
17350 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17351 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17352 && ((last_changed_charpos
< CHARPOS (start
)
17353 && CHARPOS (start
) == BEGV
)
17354 || (last_changed_charpos
< CHARPOS (start
) - 1
17355 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17357 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17358 struct glyph_row
*r0
;
17360 /* Compute how many chars/bytes have been added to or removed
17361 from the buffer. */
17362 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17363 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17364 Z_delta
= Z
- Z_old
;
17365 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17367 /* Give up if PT is not in the window. Note that it already has
17368 been checked at the start of try_window_id that PT is not in
17369 front of the window start. */
17370 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17373 /* If window start is unchanged, we can reuse the whole matrix
17374 as is, after adjusting glyph positions. No need to compute
17375 the window end again, since its offset from Z hasn't changed. */
17376 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17377 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17378 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17379 /* PT must not be in a partially visible line. */
17380 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17381 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17383 /* Adjust positions in the glyph matrix. */
17384 if (Z_delta
|| Z_delta_bytes
)
17386 struct glyph_row
*r1
17387 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17388 increment_matrix_positions (w
->current_matrix
,
17389 MATRIX_ROW_VPOS (r0
, current_matrix
),
17390 MATRIX_ROW_VPOS (r1
, current_matrix
),
17391 Z_delta
, Z_delta_bytes
);
17394 /* Set the cursor. */
17395 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17397 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17404 /* Handle the case that changes are all below what is displayed in
17405 the window, and that PT is in the window. This shortcut cannot
17406 be taken if ZV is visible in the window, and text has been added
17407 there that is visible in the window. */
17408 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17409 /* ZV is not visible in the window, or there are no
17410 changes at ZV, actually. */
17411 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17412 || first_changed_charpos
== last_changed_charpos
))
17414 struct glyph_row
*r0
;
17416 /* Give up if PT is not in the window. Note that it already has
17417 been checked at the start of try_window_id that PT is not in
17418 front of the window start. */
17419 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17422 /* If window start is unchanged, we can reuse the whole matrix
17423 as is, without changing glyph positions since no text has
17424 been added/removed in front of the window end. */
17425 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17426 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17427 /* PT must not be in a partially visible line. */
17428 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17429 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17431 /* We have to compute the window end anew since text
17432 could have been added/removed after it. */
17433 wset_window_end_pos
17434 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17435 w
->window_end_bytepos
17436 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17438 /* Set the cursor. */
17439 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17441 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17448 /* Give up if window start is in the changed area.
17450 The condition used to read
17452 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17454 but why that was tested escapes me at the moment. */
17455 if (CHARPOS (start
) >= first_changed_charpos
17456 && CHARPOS (start
) <= last_changed_charpos
)
17459 /* Check that window start agrees with the start of the first glyph
17460 row in its current matrix. Check this after we know the window
17461 start is not in changed text, otherwise positions would not be
17463 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17464 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17467 /* Give up if the window ends in strings. Overlay strings
17468 at the end are difficult to handle, so don't try. */
17469 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17470 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17473 /* Compute the position at which we have to start displaying new
17474 lines. Some of the lines at the top of the window might be
17475 reusable because they are not displaying changed text. Find the
17476 last row in W's current matrix not affected by changes at the
17477 start of current_buffer. Value is null if changes start in the
17478 first line of window. */
17479 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17480 if (last_unchanged_at_beg_row
)
17482 /* Avoid starting to display in the middle of a character, a TAB
17483 for instance. This is easier than to set up the iterator
17484 exactly, and it's not a frequent case, so the additional
17485 effort wouldn't really pay off. */
17486 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17487 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17488 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17489 --last_unchanged_at_beg_row
;
17491 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17494 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17496 start_pos
= it
.current
.pos
;
17498 /* Start displaying new lines in the desired matrix at the same
17499 vpos we would use in the current matrix, i.e. below
17500 last_unchanged_at_beg_row. */
17501 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17503 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17504 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17506 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17510 /* There are no reusable lines at the start of the window.
17511 Start displaying in the first text line. */
17512 start_display (&it
, w
, start
);
17513 it
.vpos
= it
.first_vpos
;
17514 start_pos
= it
.current
.pos
;
17517 /* Find the first row that is not affected by changes at the end of
17518 the buffer. Value will be null if there is no unchanged row, in
17519 which case we must redisplay to the end of the window. delta
17520 will be set to the value by which buffer positions beginning with
17521 first_unchanged_at_end_row have to be adjusted due to text
17523 first_unchanged_at_end_row
17524 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17525 IF_DEBUG (debug_delta
= delta
);
17526 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17528 /* Set stop_pos to the buffer position up to which we will have to
17529 display new lines. If first_unchanged_at_end_row != NULL, this
17530 is the buffer position of the start of the line displayed in that
17531 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17532 that we don't stop at a buffer position. */
17534 if (first_unchanged_at_end_row
)
17536 eassert (last_unchanged_at_beg_row
== NULL
17537 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17539 /* If this is a continuation line, move forward to the next one
17540 that isn't. Changes in lines above affect this line.
17541 Caution: this may move first_unchanged_at_end_row to a row
17542 not displaying text. */
17543 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17544 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17545 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17546 < it
.last_visible_y
))
17547 ++first_unchanged_at_end_row
;
17549 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17550 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17551 >= it
.last_visible_y
))
17552 first_unchanged_at_end_row
= NULL
;
17555 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17557 first_unchanged_at_end_vpos
17558 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17559 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17562 else if (last_unchanged_at_beg_row
== NULL
)
17568 /* Either there is no unchanged row at the end, or the one we have
17569 now displays text. This is a necessary condition for the window
17570 end pos calculation at the end of this function. */
17571 eassert (first_unchanged_at_end_row
== NULL
17572 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17574 debug_last_unchanged_at_beg_vpos
17575 = (last_unchanged_at_beg_row
17576 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17578 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17580 #endif /* GLYPH_DEBUG */
17583 /* Display new lines. Set last_text_row to the last new line
17584 displayed which has text on it, i.e. might end up as being the
17585 line where the window_end_vpos is. */
17586 w
->cursor
.vpos
= -1;
17587 last_text_row
= NULL
;
17588 overlay_arrow_seen
= 0;
17589 while (it
.current_y
< it
.last_visible_y
17590 && !fonts_changed_p
17591 && (first_unchanged_at_end_row
== NULL
17592 || IT_CHARPOS (it
) < stop_pos
))
17594 if (display_line (&it
))
17595 last_text_row
= it
.glyph_row
- 1;
17598 if (fonts_changed_p
)
17602 /* Compute differences in buffer positions, y-positions etc. for
17603 lines reused at the bottom of the window. Compute what we can
17605 if (first_unchanged_at_end_row
17606 /* No lines reused because we displayed everything up to the
17607 bottom of the window. */
17608 && it
.current_y
< it
.last_visible_y
)
17611 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17613 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17614 run
.current_y
= first_unchanged_at_end_row
->y
;
17615 run
.desired_y
= run
.current_y
+ dy
;
17616 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17620 delta
= delta_bytes
= dvpos
= dy
17621 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17622 first_unchanged_at_end_row
= NULL
;
17624 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17627 /* Find the cursor if not already found. We have to decide whether
17628 PT will appear on this window (it sometimes doesn't, but this is
17629 not a very frequent case.) This decision has to be made before
17630 the current matrix is altered. A value of cursor.vpos < 0 means
17631 that PT is either in one of the lines beginning at
17632 first_unchanged_at_end_row or below the window. Don't care for
17633 lines that might be displayed later at the window end; as
17634 mentioned, this is not a frequent case. */
17635 if (w
->cursor
.vpos
< 0)
17637 /* Cursor in unchanged rows at the top? */
17638 if (PT
< CHARPOS (start_pos
)
17639 && last_unchanged_at_beg_row
)
17641 row
= row_containing_pos (w
, PT
,
17642 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17643 last_unchanged_at_beg_row
+ 1, 0);
17645 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17648 /* Start from first_unchanged_at_end_row looking for PT. */
17649 else if (first_unchanged_at_end_row
)
17651 row
= row_containing_pos (w
, PT
- delta
,
17652 first_unchanged_at_end_row
, NULL
, 0);
17654 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17655 delta_bytes
, dy
, dvpos
);
17658 /* Give up if cursor was not found. */
17659 if (w
->cursor
.vpos
< 0)
17661 clear_glyph_matrix (w
->desired_matrix
);
17666 /* Don't let the cursor end in the scroll margins. */
17668 int this_scroll_margin
, cursor_height
;
17670 this_scroll_margin
=
17671 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17672 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17673 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17675 if ((w
->cursor
.y
< this_scroll_margin
17676 && CHARPOS (start
) > BEGV
)
17677 /* Old redisplay didn't take scroll margin into account at the bottom,
17678 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17679 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17680 ? cursor_height
+ this_scroll_margin
17681 : 1)) > it
.last_visible_y
)
17683 w
->cursor
.vpos
= -1;
17684 clear_glyph_matrix (w
->desired_matrix
);
17689 /* Scroll the display. Do it before changing the current matrix so
17690 that xterm.c doesn't get confused about where the cursor glyph is
17692 if (dy
&& run
.height
)
17696 if (FRAME_WINDOW_P (f
))
17698 FRAME_RIF (f
)->update_window_begin_hook (w
);
17699 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17700 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17701 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17705 /* Terminal frame. In this case, dvpos gives the number of
17706 lines to scroll by; dvpos < 0 means scroll up. */
17708 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17709 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17710 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17711 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17712 + window_internal_height (w
));
17714 #if defined (HAVE_GPM) || defined (MSDOS)
17715 x_clear_window_mouse_face (w
);
17717 /* Perform the operation on the screen. */
17720 /* Scroll last_unchanged_at_beg_row to the end of the
17721 window down dvpos lines. */
17722 set_terminal_window (f
, end
);
17724 /* On dumb terminals delete dvpos lines at the end
17725 before inserting dvpos empty lines. */
17726 if (!FRAME_SCROLL_REGION_OK (f
))
17727 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17729 /* Insert dvpos empty lines in front of
17730 last_unchanged_at_beg_row. */
17731 ins_del_lines (f
, from
, dvpos
);
17733 else if (dvpos
< 0)
17735 /* Scroll up last_unchanged_at_beg_vpos to the end of
17736 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17737 set_terminal_window (f
, end
);
17739 /* Delete dvpos lines in front of
17740 last_unchanged_at_beg_vpos. ins_del_lines will set
17741 the cursor to the given vpos and emit |dvpos| delete
17743 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17745 /* On a dumb terminal insert dvpos empty lines at the
17747 if (!FRAME_SCROLL_REGION_OK (f
))
17748 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17751 set_terminal_window (f
, 0);
17757 /* Shift reused rows of the current matrix to the right position.
17758 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17760 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17761 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17764 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17765 bottom_vpos
, dvpos
);
17766 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17769 else if (dvpos
> 0)
17771 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17772 bottom_vpos
, dvpos
);
17773 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17774 first_unchanged_at_end_vpos
+ dvpos
);
17777 /* For frame-based redisplay, make sure that current frame and window
17778 matrix are in sync with respect to glyph memory. */
17779 if (!FRAME_WINDOW_P (f
))
17780 sync_frame_with_window_matrix_rows (w
);
17782 /* Adjust buffer positions in reused rows. */
17783 if (delta
|| delta_bytes
)
17784 increment_matrix_positions (current_matrix
,
17785 first_unchanged_at_end_vpos
+ dvpos
,
17786 bottom_vpos
, delta
, delta_bytes
);
17788 /* Adjust Y positions. */
17790 shift_glyph_matrix (w
, current_matrix
,
17791 first_unchanged_at_end_vpos
+ dvpos
,
17794 if (first_unchanged_at_end_row
)
17796 first_unchanged_at_end_row
+= dvpos
;
17797 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17798 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17799 first_unchanged_at_end_row
= NULL
;
17802 /* If scrolling up, there may be some lines to display at the end of
17804 last_text_row_at_end
= NULL
;
17807 /* Scrolling up can leave for example a partially visible line
17808 at the end of the window to be redisplayed. */
17809 /* Set last_row to the glyph row in the current matrix where the
17810 window end line is found. It has been moved up or down in
17811 the matrix by dvpos. */
17812 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17813 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17815 /* If last_row is the window end line, it should display text. */
17816 eassert (last_row
->displays_text_p
);
17818 /* If window end line was partially visible before, begin
17819 displaying at that line. Otherwise begin displaying with the
17820 line following it. */
17821 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17823 init_to_row_start (&it
, w
, last_row
);
17824 it
.vpos
= last_vpos
;
17825 it
.current_y
= last_row
->y
;
17829 init_to_row_end (&it
, w
, last_row
);
17830 it
.vpos
= 1 + last_vpos
;
17831 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17835 /* We may start in a continuation line. If so, we have to
17836 get the right continuation_lines_width and current_x. */
17837 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17838 it
.hpos
= it
.current_x
= 0;
17840 /* Display the rest of the lines at the window end. */
17841 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17842 while (it
.current_y
< it
.last_visible_y
17843 && !fonts_changed_p
)
17845 /* Is it always sure that the display agrees with lines in
17846 the current matrix? I don't think so, so we mark rows
17847 displayed invalid in the current matrix by setting their
17848 enabled_p flag to zero. */
17849 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17850 if (display_line (&it
))
17851 last_text_row_at_end
= it
.glyph_row
- 1;
17855 /* Update window_end_pos and window_end_vpos. */
17856 if (first_unchanged_at_end_row
17857 && !last_text_row_at_end
)
17859 /* Window end line if one of the preserved rows from the current
17860 matrix. Set row to the last row displaying text in current
17861 matrix starting at first_unchanged_at_end_row, after
17863 eassert (first_unchanged_at_end_row
->displays_text_p
);
17864 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17865 first_unchanged_at_end_row
);
17866 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17868 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17869 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17870 wset_window_end_vpos
17871 (w
, make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
)));
17872 eassert (w
->window_end_bytepos
>= 0);
17873 IF_DEBUG (debug_method_add (w
, "A"));
17875 else if (last_text_row_at_end
)
17877 wset_window_end_pos
17878 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
)));
17879 w
->window_end_bytepos
17880 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17881 wset_window_end_vpos
17882 (w
, make_number (MATRIX_ROW_VPOS (last_text_row_at_end
,
17884 eassert (w
->window_end_bytepos
>= 0);
17885 IF_DEBUG (debug_method_add (w
, "B"));
17887 else if (last_text_row
)
17889 /* We have displayed either to the end of the window or at the
17890 end of the window, i.e. the last row with text is to be found
17891 in the desired matrix. */
17892 wset_window_end_pos
17893 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
17894 w
->window_end_bytepos
17895 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17896 wset_window_end_vpos
17897 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
)));
17898 eassert (w
->window_end_bytepos
>= 0);
17900 else if (first_unchanged_at_end_row
== NULL
17901 && last_text_row
== NULL
17902 && last_text_row_at_end
== NULL
)
17904 /* Displayed to end of window, but no line containing text was
17905 displayed. Lines were deleted at the end of the window. */
17906 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17907 int vpos
= XFASTINT (w
->window_end_vpos
);
17908 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17909 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17912 row
== NULL
&& vpos
>= first_vpos
;
17913 --vpos
, --current_row
, --desired_row
)
17915 if (desired_row
->enabled_p
)
17917 if (desired_row
->displays_text_p
)
17920 else if (current_row
->displays_text_p
)
17924 eassert (row
!= NULL
);
17925 wset_window_end_vpos (w
, make_number (vpos
+ 1));
17926 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17927 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17928 eassert (w
->window_end_bytepos
>= 0);
17929 IF_DEBUG (debug_method_add (w
, "C"));
17934 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17935 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17937 /* Record that display has not been completed. */
17938 wset_window_end_valid (w
, Qnil
);
17939 w
->desired_matrix
->no_scrolling_p
= 1;
17947 /***********************************************************************
17948 More debugging support
17949 ***********************************************************************/
17953 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17954 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17955 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17958 /* Dump the contents of glyph matrix MATRIX on stderr.
17960 GLYPHS 0 means don't show glyph contents.
17961 GLYPHS 1 means show glyphs in short form
17962 GLYPHS > 1 means show glyphs in long form. */
17965 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17968 for (i
= 0; i
< matrix
->nrows
; ++i
)
17969 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17973 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17974 the glyph row and area where the glyph comes from. */
17977 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17979 if (glyph
->type
== CHAR_GLYPH
)
17982 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17983 glyph
- row
->glyphs
[TEXT_AREA
],
17986 (BUFFERP (glyph
->object
)
17988 : (STRINGP (glyph
->object
)
17991 glyph
->pixel_width
,
17993 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17997 glyph
->left_box_line_p
,
17998 glyph
->right_box_line_p
);
18000 else if (glyph
->type
== STRETCH_GLYPH
)
18003 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18004 glyph
- row
->glyphs
[TEXT_AREA
],
18007 (BUFFERP (glyph
->object
)
18009 : (STRINGP (glyph
->object
)
18012 glyph
->pixel_width
,
18016 glyph
->left_box_line_p
,
18017 glyph
->right_box_line_p
);
18019 else if (glyph
->type
== IMAGE_GLYPH
)
18022 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18023 glyph
- row
->glyphs
[TEXT_AREA
],
18026 (BUFFERP (glyph
->object
)
18028 : (STRINGP (glyph
->object
)
18031 glyph
->pixel_width
,
18035 glyph
->left_box_line_p
,
18036 glyph
->right_box_line_p
);
18038 else if (glyph
->type
== COMPOSITE_GLYPH
)
18041 " %5td %4c %6"pI
"d %c %3d 0x%05x",
18042 glyph
- row
->glyphs
[TEXT_AREA
],
18045 (BUFFERP (glyph
->object
)
18047 : (STRINGP (glyph
->object
)
18050 glyph
->pixel_width
,
18052 if (glyph
->u
.cmp
.automatic
)
18055 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18056 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18058 glyph
->left_box_line_p
,
18059 glyph
->right_box_line_p
);
18064 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18065 GLYPHS 0 means don't show glyph contents.
18066 GLYPHS 1 means show glyphs in short form
18067 GLYPHS > 1 means show glyphs in long form. */
18070 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18074 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18075 fprintf (stderr
, "======================================================================\n");
18077 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18078 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18080 MATRIX_ROW_START_CHARPOS (row
),
18081 MATRIX_ROW_END_CHARPOS (row
),
18082 row
->used
[TEXT_AREA
],
18083 row
->contains_overlapping_glyphs_p
,
18085 row
->truncated_on_left_p
,
18086 row
->truncated_on_right_p
,
18088 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18089 row
->displays_text_p
,
18092 row
->ends_in_middle_of_char_p
,
18093 row
->starts_in_middle_of_char_p
,
18099 row
->visible_height
,
18102 fprintf (stderr
, "%9"pD
"d %5"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18103 row
->end
.overlay_string_index
,
18104 row
->continuation_lines_width
);
18105 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
18106 CHARPOS (row
->start
.string_pos
),
18107 CHARPOS (row
->end
.string_pos
));
18108 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
18109 row
->end
.dpvec_index
);
18116 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18118 struct glyph
*glyph
= row
->glyphs
[area
];
18119 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18121 /* Glyph for a line end in text. */
18122 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18125 if (glyph
< glyph_end
)
18126 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
18128 for (; glyph
< glyph_end
; ++glyph
)
18129 dump_glyph (row
, glyph
, area
);
18132 else if (glyphs
== 1)
18136 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18138 char *s
= alloca (row
->used
[area
] + 1);
18141 for (i
= 0; i
< row
->used
[area
]; ++i
)
18143 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18144 if (glyph
->type
== CHAR_GLYPH
18145 && glyph
->u
.ch
< 0x80
18146 && glyph
->u
.ch
>= ' ')
18147 s
[i
] = glyph
->u
.ch
;
18153 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18159 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18160 Sdump_glyph_matrix
, 0, 1, "p",
18161 doc
: /* Dump the current matrix of the selected window to stderr.
18162 Shows contents of glyph row structures. With non-nil
18163 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18164 glyphs in short form, otherwise show glyphs in long form. */)
18165 (Lisp_Object glyphs
)
18167 struct window
*w
= XWINDOW (selected_window
);
18168 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18170 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18171 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18172 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18173 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18174 fprintf (stderr
, "=============================================\n");
18175 dump_glyph_matrix (w
->current_matrix
,
18176 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18181 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18182 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18185 struct frame
*f
= XFRAME (selected_frame
);
18186 dump_glyph_matrix (f
->current_matrix
, 1);
18191 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18192 doc
: /* Dump glyph row ROW to stderr.
18193 GLYPH 0 means don't dump glyphs.
18194 GLYPH 1 means dump glyphs in short form.
18195 GLYPH > 1 or omitted means dump glyphs in long form. */)
18196 (Lisp_Object row
, Lisp_Object glyphs
)
18198 struct glyph_matrix
*matrix
;
18201 CHECK_NUMBER (row
);
18202 matrix
= XWINDOW (selected_window
)->current_matrix
;
18204 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18205 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18207 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18212 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18213 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18214 GLYPH 0 means don't dump glyphs.
18215 GLYPH 1 means dump glyphs in short form.
18216 GLYPH > 1 or omitted means dump glyphs in long form. */)
18217 (Lisp_Object row
, Lisp_Object glyphs
)
18219 struct frame
*sf
= SELECTED_FRAME ();
18220 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18223 CHECK_NUMBER (row
);
18225 if (vpos
>= 0 && vpos
< m
->nrows
)
18226 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18227 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18232 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18233 doc
: /* Toggle tracing of redisplay.
18234 With ARG, turn tracing on if and only if ARG is positive. */)
18238 trace_redisplay_p
= !trace_redisplay_p
;
18241 arg
= Fprefix_numeric_value (arg
);
18242 trace_redisplay_p
= XINT (arg
) > 0;
18249 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18250 doc
: /* Like `format', but print result to stderr.
18251 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18252 (ptrdiff_t nargs
, Lisp_Object
*args
)
18254 Lisp_Object s
= Fformat (nargs
, args
);
18255 fprintf (stderr
, "%s", SDATA (s
));
18259 #endif /* GLYPH_DEBUG */
18263 /***********************************************************************
18264 Building Desired Matrix Rows
18265 ***********************************************************************/
18267 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18268 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18270 static struct glyph_row
*
18271 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18273 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18274 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18275 struct buffer
*old
= current_buffer
;
18276 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18277 int arrow_len
= SCHARS (overlay_arrow_string
);
18278 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18279 const unsigned char *p
;
18282 int n_glyphs_before
;
18284 set_buffer_temp (buffer
);
18285 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18286 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18287 SET_TEXT_POS (it
.position
, 0, 0);
18289 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18291 while (p
< arrow_end
)
18293 Lisp_Object face
, ilisp
;
18295 /* Get the next character. */
18297 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18300 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18301 if (! ASCII_CHAR_P (it
.c
))
18302 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18306 /* Get its face. */
18307 ilisp
= make_number (p
- arrow_string
);
18308 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18309 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18311 /* Compute its width, get its glyphs. */
18312 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18313 SET_TEXT_POS (it
.position
, -1, -1);
18314 PRODUCE_GLYPHS (&it
);
18316 /* If this character doesn't fit any more in the line, we have
18317 to remove some glyphs. */
18318 if (it
.current_x
> it
.last_visible_x
)
18320 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18325 set_buffer_temp (old
);
18326 return it
.glyph_row
;
18330 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18331 glyphs to insert is determined by produce_special_glyphs. */
18334 insert_left_trunc_glyphs (struct it
*it
)
18336 struct it truncate_it
;
18337 struct glyph
*from
, *end
, *to
, *toend
;
18339 eassert (!FRAME_WINDOW_P (it
->f
)
18340 || (!it
->glyph_row
->reversed_p
18341 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18342 || (it
->glyph_row
->reversed_p
18343 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18345 /* Get the truncation glyphs. */
18347 truncate_it
.current_x
= 0;
18348 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18349 truncate_it
.glyph_row
= &scratch_glyph_row
;
18350 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18351 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18352 truncate_it
.object
= make_number (0);
18353 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18355 /* Overwrite glyphs from IT with truncation glyphs. */
18356 if (!it
->glyph_row
->reversed_p
)
18358 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18360 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18361 end
= from
+ tused
;
18362 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18363 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18364 if (FRAME_WINDOW_P (it
->f
))
18366 /* On GUI frames, when variable-size fonts are displayed,
18367 the truncation glyphs may need more pixels than the row's
18368 glyphs they overwrite. We overwrite more glyphs to free
18369 enough screen real estate, and enlarge the stretch glyph
18370 on the right (see display_line), if there is one, to
18371 preserve the screen position of the truncation glyphs on
18374 struct glyph
*g
= to
;
18377 /* The first glyph could be partially visible, in which case
18378 it->glyph_row->x will be negative. But we want the left
18379 truncation glyphs to be aligned at the left margin of the
18380 window, so we override the x coordinate at which the row
18382 it
->glyph_row
->x
= 0;
18383 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18385 w
+= g
->pixel_width
;
18388 if (g
- to
- tused
> 0)
18390 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18391 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18393 used
= it
->glyph_row
->used
[TEXT_AREA
];
18394 if (it
->glyph_row
->truncated_on_right_p
18395 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18396 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18399 int extra
= w
- it
->truncation_pixel_width
;
18401 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18408 /* There may be padding glyphs left over. Overwrite them too. */
18409 if (!FRAME_WINDOW_P (it
->f
))
18411 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18413 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18420 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18424 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18426 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18427 that back to front. */
18428 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18429 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18430 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18431 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18432 if (FRAME_WINDOW_P (it
->f
))
18435 struct glyph
*g
= to
;
18437 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18439 w
+= g
->pixel_width
;
18442 if (to
- g
- tused
> 0)
18444 if (it
->glyph_row
->truncated_on_right_p
18445 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18446 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18448 int extra
= w
- it
->truncation_pixel_width
;
18450 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18454 while (from
>= end
&& to
>= toend
)
18456 if (!FRAME_WINDOW_P (it
->f
))
18458 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18461 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18462 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18463 while (from
>= end
&& to
>= toend
)
18469 /* Need to free some room before prepending additional
18471 int move_by
= from
- end
+ 1;
18472 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18473 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18475 for ( ; g
>= g0
; g
--)
18477 while (from
>= end
)
18479 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18484 /* Compute the hash code for ROW. */
18486 row_hash (struct glyph_row
*row
)
18489 unsigned hashval
= 0;
18491 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18492 for (k
= 0; k
< row
->used
[area
]; ++k
)
18493 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18494 + row
->glyphs
[area
][k
].u
.val
18495 + row
->glyphs
[area
][k
].face_id
18496 + row
->glyphs
[area
][k
].padding_p
18497 + (row
->glyphs
[area
][k
].type
<< 2));
18502 /* Compute the pixel height and width of IT->glyph_row.
18504 Most of the time, ascent and height of a display line will be equal
18505 to the max_ascent and max_height values of the display iterator
18506 structure. This is not the case if
18508 1. We hit ZV without displaying anything. In this case, max_ascent
18509 and max_height will be zero.
18511 2. We have some glyphs that don't contribute to the line height.
18512 (The glyph row flag contributes_to_line_height_p is for future
18513 pixmap extensions).
18515 The first case is easily covered by using default values because in
18516 these cases, the line height does not really matter, except that it
18517 must not be zero. */
18520 compute_line_metrics (struct it
*it
)
18522 struct glyph_row
*row
= it
->glyph_row
;
18524 if (FRAME_WINDOW_P (it
->f
))
18526 int i
, min_y
, max_y
;
18528 /* The line may consist of one space only, that was added to
18529 place the cursor on it. If so, the row's height hasn't been
18531 if (row
->height
== 0)
18533 if (it
->max_ascent
+ it
->max_descent
== 0)
18534 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18535 row
->ascent
= it
->max_ascent
;
18536 row
->height
= it
->max_ascent
+ it
->max_descent
;
18537 row
->phys_ascent
= it
->max_phys_ascent
;
18538 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18539 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18542 /* Compute the width of this line. */
18543 row
->pixel_width
= row
->x
;
18544 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18545 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18547 eassert (row
->pixel_width
>= 0);
18548 eassert (row
->ascent
>= 0 && row
->height
> 0);
18550 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18551 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18553 /* If first line's physical ascent is larger than its logical
18554 ascent, use the physical ascent, and make the row taller.
18555 This makes accented characters fully visible. */
18556 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18557 && row
->phys_ascent
> row
->ascent
)
18559 row
->height
+= row
->phys_ascent
- row
->ascent
;
18560 row
->ascent
= row
->phys_ascent
;
18563 /* Compute how much of the line is visible. */
18564 row
->visible_height
= row
->height
;
18566 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18567 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18569 if (row
->y
< min_y
)
18570 row
->visible_height
-= min_y
- row
->y
;
18571 if (row
->y
+ row
->height
> max_y
)
18572 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18576 row
->pixel_width
= row
->used
[TEXT_AREA
];
18577 if (row
->continued_p
)
18578 row
->pixel_width
-= it
->continuation_pixel_width
;
18579 else if (row
->truncated_on_right_p
)
18580 row
->pixel_width
-= it
->truncation_pixel_width
;
18581 row
->ascent
= row
->phys_ascent
= 0;
18582 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18583 row
->extra_line_spacing
= 0;
18586 /* Compute a hash code for this row. */
18587 row
->hash
= row_hash (row
);
18589 it
->max_ascent
= it
->max_descent
= 0;
18590 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18594 /* Append one space to the glyph row of iterator IT if doing a
18595 window-based redisplay. The space has the same face as
18596 IT->face_id. Value is non-zero if a space was added.
18598 This function is called to make sure that there is always one glyph
18599 at the end of a glyph row that the cursor can be set on under
18600 window-systems. (If there weren't such a glyph we would not know
18601 how wide and tall a box cursor should be displayed).
18603 At the same time this space let's a nicely handle clearing to the
18604 end of the line if the row ends in italic text. */
18607 append_space_for_newline (struct it
*it
, int default_face_p
)
18609 if (FRAME_WINDOW_P (it
->f
))
18611 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18613 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18614 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18616 /* Save some values that must not be changed.
18617 Must save IT->c and IT->len because otherwise
18618 ITERATOR_AT_END_P wouldn't work anymore after
18619 append_space_for_newline has been called. */
18620 enum display_element_type saved_what
= it
->what
;
18621 int saved_c
= it
->c
, saved_len
= it
->len
;
18622 int saved_char_to_display
= it
->char_to_display
;
18623 int saved_x
= it
->current_x
;
18624 int saved_face_id
= it
->face_id
;
18625 int saved_box_end
= it
->end_of_box_run_p
;
18626 struct text_pos saved_pos
;
18627 Lisp_Object saved_object
;
18630 saved_object
= it
->object
;
18631 saved_pos
= it
->position
;
18633 it
->what
= IT_CHARACTER
;
18634 memset (&it
->position
, 0, sizeof it
->position
);
18635 it
->object
= make_number (0);
18636 it
->c
= it
->char_to_display
= ' ';
18639 /* If the default face was remapped, be sure to use the
18640 remapped face for the appended newline. */
18641 if (default_face_p
)
18642 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18643 else if (it
->face_before_selective_p
)
18644 it
->face_id
= it
->saved_face_id
;
18645 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18646 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18647 /* In R2L rows, we will prepend a stretch glyph that will
18648 have the end_of_box_run_p flag set for it, so there's no
18649 need for the appended newline glyph to have that flag
18651 if (it
->glyph_row
->reversed_p
18652 /* But if the appended newline glyph goes all the way to
18653 the end of the row, there will be no stretch glyph,
18654 so leave the box flag set. */
18655 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
18656 it
->end_of_box_run_p
= 0;
18658 PRODUCE_GLYPHS (it
);
18660 it
->override_ascent
= -1;
18661 it
->constrain_row_ascent_descent_p
= 0;
18662 it
->current_x
= saved_x
;
18663 it
->object
= saved_object
;
18664 it
->position
= saved_pos
;
18665 it
->what
= saved_what
;
18666 it
->face_id
= saved_face_id
;
18667 it
->len
= saved_len
;
18669 it
->char_to_display
= saved_char_to_display
;
18670 it
->end_of_box_run_p
= saved_box_end
;
18679 /* Extend the face of the last glyph in the text area of IT->glyph_row
18680 to the end of the display line. Called from display_line. If the
18681 glyph row is empty, add a space glyph to it so that we know the
18682 face to draw. Set the glyph row flag fill_line_p. If the glyph
18683 row is R2L, prepend a stretch glyph to cover the empty space to the
18684 left of the leftmost glyph. */
18687 extend_face_to_end_of_line (struct it
*it
)
18689 struct face
*face
, *default_face
;
18690 struct frame
*f
= it
->f
;
18692 /* If line is already filled, do nothing. Non window-system frames
18693 get a grace of one more ``pixel'' because their characters are
18694 1-``pixel'' wide, so they hit the equality too early. This grace
18695 is needed only for R2L rows that are not continued, to produce
18696 one extra blank where we could display the cursor. */
18697 if (it
->current_x
>= it
->last_visible_x
18698 + (!FRAME_WINDOW_P (f
)
18699 && it
->glyph_row
->reversed_p
18700 && !it
->glyph_row
->continued_p
))
18703 /* The default face, possibly remapped. */
18704 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18706 /* Face extension extends the background and box of IT->face_id
18707 to the end of the line. If the background equals the background
18708 of the frame, we don't have to do anything. */
18709 if (it
->face_before_selective_p
)
18710 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18712 face
= FACE_FROM_ID (f
, it
->face_id
);
18714 if (FRAME_WINDOW_P (f
)
18715 && it
->glyph_row
->displays_text_p
18716 && face
->box
== FACE_NO_BOX
18717 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18719 && !it
->glyph_row
->reversed_p
)
18722 /* Set the glyph row flag indicating that the face of the last glyph
18723 in the text area has to be drawn to the end of the text area. */
18724 it
->glyph_row
->fill_line_p
= 1;
18726 /* If current character of IT is not ASCII, make sure we have the
18727 ASCII face. This will be automatically undone the next time
18728 get_next_display_element returns a multibyte character. Note
18729 that the character will always be single byte in unibyte
18731 if (!ASCII_CHAR_P (it
->c
))
18733 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18736 if (FRAME_WINDOW_P (f
))
18738 /* If the row is empty, add a space with the current face of IT,
18739 so that we know which face to draw. */
18740 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18742 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18743 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18744 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18746 #ifdef HAVE_WINDOW_SYSTEM
18747 if (it
->glyph_row
->reversed_p
)
18749 /* Prepend a stretch glyph to the row, such that the
18750 rightmost glyph will be drawn flushed all the way to the
18751 right margin of the window. The stretch glyph that will
18752 occupy the empty space, if any, to the left of the
18754 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18755 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18756 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18758 int row_width
, stretch_ascent
, stretch_width
;
18759 struct text_pos saved_pos
;
18760 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
18762 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18763 row_width
+= g
->pixel_width
;
18764 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18765 if (stretch_width
> 0)
18768 (((it
->ascent
+ it
->descent
)
18769 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18770 saved_pos
= it
->position
;
18771 memset (&it
->position
, 0, sizeof it
->position
);
18772 saved_avoid_cursor
= it
->avoid_cursor_p
;
18773 it
->avoid_cursor_p
= 1;
18774 saved_face_id
= it
->face_id
;
18775 saved_box_start
= it
->start_of_box_run_p
;
18776 /* The last row's stretch glyph should get the default
18777 face, to avoid painting the rest of the window with
18778 the region face, if the region ends at ZV. */
18779 if (it
->glyph_row
->ends_at_zv_p
)
18780 it
->face_id
= default_face
->id
;
18782 it
->face_id
= face
->id
;
18783 it
->start_of_box_run_p
= 0;
18784 append_stretch_glyph (it
, make_number (0), stretch_width
,
18785 it
->ascent
+ it
->descent
, stretch_ascent
);
18786 it
->position
= saved_pos
;
18787 it
->avoid_cursor_p
= saved_avoid_cursor
;
18788 it
->face_id
= saved_face_id
;
18789 it
->start_of_box_run_p
= saved_box_start
;
18792 #endif /* HAVE_WINDOW_SYSTEM */
18796 /* Save some values that must not be changed. */
18797 int saved_x
= it
->current_x
;
18798 struct text_pos saved_pos
;
18799 Lisp_Object saved_object
;
18800 enum display_element_type saved_what
= it
->what
;
18801 int saved_face_id
= it
->face_id
;
18803 saved_object
= it
->object
;
18804 saved_pos
= it
->position
;
18806 it
->what
= IT_CHARACTER
;
18807 memset (&it
->position
, 0, sizeof it
->position
);
18808 it
->object
= make_number (0);
18809 it
->c
= it
->char_to_display
= ' ';
18811 /* The last row's blank glyphs should get the default face, to
18812 avoid painting the rest of the window with the region face,
18813 if the region ends at ZV. */
18814 if (it
->glyph_row
->ends_at_zv_p
)
18815 it
->face_id
= default_face
->id
;
18817 it
->face_id
= face
->id
;
18819 PRODUCE_GLYPHS (it
);
18821 while (it
->current_x
<= it
->last_visible_x
)
18822 PRODUCE_GLYPHS (it
);
18824 /* Don't count these blanks really. It would let us insert a left
18825 truncation glyph below and make us set the cursor on them, maybe. */
18826 it
->current_x
= saved_x
;
18827 it
->object
= saved_object
;
18828 it
->position
= saved_pos
;
18829 it
->what
= saved_what
;
18830 it
->face_id
= saved_face_id
;
18835 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18836 trailing whitespace. */
18839 trailing_whitespace_p (ptrdiff_t charpos
)
18841 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18844 while (bytepos
< ZV_BYTE
18845 && (c
= FETCH_CHAR (bytepos
),
18846 c
== ' ' || c
== '\t'))
18849 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18851 if (bytepos
!= PT_BYTE
)
18858 /* Highlight trailing whitespace, if any, in ROW. */
18861 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18863 int used
= row
->used
[TEXT_AREA
];
18867 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18868 struct glyph
*glyph
= start
+ used
- 1;
18870 if (row
->reversed_p
)
18872 /* Right-to-left rows need to be processed in the opposite
18873 direction, so swap the edge pointers. */
18875 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18878 /* Skip over glyphs inserted to display the cursor at the
18879 end of a line, for extending the face of the last glyph
18880 to the end of the line on terminals, and for truncation
18881 and continuation glyphs. */
18882 if (!row
->reversed_p
)
18884 while (glyph
>= start
18885 && glyph
->type
== CHAR_GLYPH
18886 && INTEGERP (glyph
->object
))
18891 while (glyph
<= start
18892 && glyph
->type
== CHAR_GLYPH
18893 && INTEGERP (glyph
->object
))
18897 /* If last glyph is a space or stretch, and it's trailing
18898 whitespace, set the face of all trailing whitespace glyphs in
18899 IT->glyph_row to `trailing-whitespace'. */
18900 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18901 && BUFFERP (glyph
->object
)
18902 && (glyph
->type
== STRETCH_GLYPH
18903 || (glyph
->type
== CHAR_GLYPH
18904 && glyph
->u
.ch
== ' '))
18905 && trailing_whitespace_p (glyph
->charpos
))
18907 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18911 if (!row
->reversed_p
)
18913 while (glyph
>= start
18914 && BUFFERP (glyph
->object
)
18915 && (glyph
->type
== STRETCH_GLYPH
18916 || (glyph
->type
== CHAR_GLYPH
18917 && glyph
->u
.ch
== ' ')))
18918 (glyph
--)->face_id
= face_id
;
18922 while (glyph
<= start
18923 && BUFFERP (glyph
->object
)
18924 && (glyph
->type
== STRETCH_GLYPH
18925 || (glyph
->type
== CHAR_GLYPH
18926 && glyph
->u
.ch
== ' ')))
18927 (glyph
++)->face_id
= face_id
;
18934 /* Value is non-zero if glyph row ROW should be
18935 used to hold the cursor. */
18938 cursor_row_p (struct glyph_row
*row
)
18942 if (PT
== CHARPOS (row
->end
.pos
)
18943 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18945 /* Suppose the row ends on a string.
18946 Unless the row is continued, that means it ends on a newline
18947 in the string. If it's anything other than a display string
18948 (e.g., a before-string from an overlay), we don't want the
18949 cursor there. (This heuristic seems to give the optimal
18950 behavior for the various types of multi-line strings.)
18951 One exception: if the string has `cursor' property on one of
18952 its characters, we _do_ want the cursor there. */
18953 if (CHARPOS (row
->end
.string_pos
) >= 0)
18955 if (row
->continued_p
)
18959 /* Check for `display' property. */
18960 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18961 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18962 struct glyph
*glyph
;
18965 for (glyph
= end
; glyph
>= beg
; --glyph
)
18966 if (STRINGP (glyph
->object
))
18969 = Fget_char_property (make_number (PT
),
18973 && display_prop_string_p (prop
, glyph
->object
));
18974 /* If there's a `cursor' property on one of the
18975 string's characters, this row is a cursor row,
18976 even though this is not a display string. */
18979 Lisp_Object s
= glyph
->object
;
18981 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18983 ptrdiff_t gpos
= glyph
->charpos
;
18985 if (!NILP (Fget_char_property (make_number (gpos
),
18997 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18999 /* If the row ends in middle of a real character,
19000 and the line is continued, we want the cursor here.
19001 That's because CHARPOS (ROW->end.pos) would equal
19002 PT if PT is before the character. */
19003 if (!row
->ends_in_ellipsis_p
)
19004 result
= row
->continued_p
;
19006 /* If the row ends in an ellipsis, then
19007 CHARPOS (ROW->end.pos) will equal point after the
19008 invisible text. We want that position to be displayed
19009 after the ellipsis. */
19012 /* If the row ends at ZV, display the cursor at the end of that
19013 row instead of at the start of the row below. */
19014 else if (row
->ends_at_zv_p
)
19025 /* Push the property PROP so that it will be rendered at the current
19026 position in IT. Return 1 if PROP was successfully pushed, 0
19027 otherwise. Called from handle_line_prefix to handle the
19028 `line-prefix' and `wrap-prefix' properties. */
19031 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19033 struct text_pos pos
=
19034 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19036 eassert (it
->method
== GET_FROM_BUFFER
19037 || it
->method
== GET_FROM_DISPLAY_VECTOR
19038 || it
->method
== GET_FROM_STRING
);
19040 /* We need to save the current buffer/string position, so it will be
19041 restored by pop_it, because iterate_out_of_display_property
19042 depends on that being set correctly, but some situations leave
19043 it->position not yet set when this function is called. */
19044 push_it (it
, &pos
);
19046 if (STRINGP (prop
))
19048 if (SCHARS (prop
) == 0)
19055 it
->string_from_prefix_prop_p
= 1;
19056 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19057 it
->current
.overlay_string_index
= -1;
19058 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19059 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19060 it
->method
= GET_FROM_STRING
;
19061 it
->stop_charpos
= 0;
19063 it
->base_level_stop
= 0;
19065 /* Force paragraph direction to be that of the parent
19067 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19068 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19070 it
->paragraph_embedding
= L2R
;
19072 /* Set up the bidi iterator for this display string. */
19075 it
->bidi_it
.string
.lstring
= it
->string
;
19076 it
->bidi_it
.string
.s
= NULL
;
19077 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19078 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19079 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19080 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19081 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19084 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19086 it
->method
= GET_FROM_STRETCH
;
19089 #ifdef HAVE_WINDOW_SYSTEM
19090 else if (IMAGEP (prop
))
19092 it
->what
= IT_IMAGE
;
19093 it
->image_id
= lookup_image (it
->f
, prop
);
19094 it
->method
= GET_FROM_IMAGE
;
19096 #endif /* HAVE_WINDOW_SYSTEM */
19099 pop_it (it
); /* bogus display property, give up */
19106 /* Return the character-property PROP at the current position in IT. */
19109 get_it_property (struct it
*it
, Lisp_Object prop
)
19111 Lisp_Object position
;
19113 if (STRINGP (it
->object
))
19114 position
= make_number (IT_STRING_CHARPOS (*it
));
19115 else if (BUFFERP (it
->object
))
19116 position
= make_number (IT_CHARPOS (*it
));
19120 return Fget_char_property (position
, prop
, it
->object
);
19123 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19126 handle_line_prefix (struct it
*it
)
19128 Lisp_Object prefix
;
19130 if (it
->continuation_lines_width
> 0)
19132 prefix
= get_it_property (it
, Qwrap_prefix
);
19134 prefix
= Vwrap_prefix
;
19138 prefix
= get_it_property (it
, Qline_prefix
);
19140 prefix
= Vline_prefix
;
19142 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19144 /* If the prefix is wider than the window, and we try to wrap
19145 it, it would acquire its own wrap prefix, and so on till the
19146 iterator stack overflows. So, don't wrap the prefix. */
19147 it
->line_wrap
= TRUNCATE
;
19148 it
->avoid_cursor_p
= 1;
19154 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19155 only for R2L lines from display_line and display_string, when they
19156 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19157 the line/string needs to be continued on the next glyph row. */
19159 unproduce_glyphs (struct it
*it
, int n
)
19161 struct glyph
*glyph
, *end
;
19163 eassert (it
->glyph_row
);
19164 eassert (it
->glyph_row
->reversed_p
);
19165 eassert (it
->area
== TEXT_AREA
);
19166 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19168 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19169 n
= it
->glyph_row
->used
[TEXT_AREA
];
19170 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19171 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19172 for ( ; glyph
< end
; glyph
++)
19173 glyph
[-n
] = *glyph
;
19176 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19177 and ROW->maxpos. */
19179 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19180 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19181 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19183 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19184 lines' rows is implemented for bidi-reordered rows. */
19186 /* ROW->minpos is the value of min_pos, the minimal buffer position
19187 we have in ROW, or ROW->start.pos if that is smaller. */
19188 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19189 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19191 /* We didn't find buffer positions smaller than ROW->start, or
19192 didn't find _any_ valid buffer positions in any of the glyphs,
19193 so we must trust the iterator's computed positions. */
19194 row
->minpos
= row
->start
.pos
;
19197 max_pos
= CHARPOS (it
->current
.pos
);
19198 max_bpos
= BYTEPOS (it
->current
.pos
);
19201 /* Here are the various use-cases for ending the row, and the
19202 corresponding values for ROW->maxpos:
19204 Line ends in a newline from buffer eol_pos + 1
19205 Line is continued from buffer max_pos + 1
19206 Line is truncated on right it->current.pos
19207 Line ends in a newline from string max_pos + 1(*)
19208 (*) + 1 only when line ends in a forward scan
19209 Line is continued from string max_pos
19210 Line is continued from display vector max_pos
19211 Line is entirely from a string min_pos == max_pos
19212 Line is entirely from a display vector min_pos == max_pos
19213 Line that ends at ZV ZV
19215 If you discover other use-cases, please add them here as
19217 if (row
->ends_at_zv_p
)
19218 row
->maxpos
= it
->current
.pos
;
19219 else if (row
->used
[TEXT_AREA
])
19221 int seen_this_string
= 0;
19222 struct glyph_row
*r1
= row
- 1;
19224 /* Did we see the same display string on the previous row? */
19225 if (STRINGP (it
->object
)
19226 /* this is not the first row */
19227 && row
> it
->w
->desired_matrix
->rows
19228 /* previous row is not the header line */
19229 && !r1
->mode_line_p
19230 /* previous row also ends in a newline from a string */
19231 && r1
->ends_in_newline_from_string_p
)
19233 struct glyph
*start
, *end
;
19235 /* Search for the last glyph of the previous row that came
19236 from buffer or string. Depending on whether the row is
19237 L2R or R2L, we need to process it front to back or the
19238 other way round. */
19239 if (!r1
->reversed_p
)
19241 start
= r1
->glyphs
[TEXT_AREA
];
19242 end
= start
+ r1
->used
[TEXT_AREA
];
19243 /* Glyphs inserted by redisplay have an integer (zero)
19244 as their object. */
19246 && INTEGERP ((end
- 1)->object
)
19247 && (end
- 1)->charpos
<= 0)
19251 if (EQ ((end
- 1)->object
, it
->object
))
19252 seen_this_string
= 1;
19255 /* If all the glyphs of the previous row were inserted
19256 by redisplay, it means the previous row was
19257 produced from a single newline, which is only
19258 possible if that newline came from the same string
19259 as the one which produced this ROW. */
19260 seen_this_string
= 1;
19264 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19265 start
= end
+ r1
->used
[TEXT_AREA
];
19267 && INTEGERP ((end
+ 1)->object
)
19268 && (end
+ 1)->charpos
<= 0)
19272 if (EQ ((end
+ 1)->object
, it
->object
))
19273 seen_this_string
= 1;
19276 seen_this_string
= 1;
19279 /* Take note of each display string that covers a newline only
19280 once, the first time we see it. This is for when a display
19281 string includes more than one newline in it. */
19282 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19284 /* If we were scanning the buffer forward when we displayed
19285 the string, we want to account for at least one buffer
19286 position that belongs to this row (position covered by
19287 the display string), so that cursor positioning will
19288 consider this row as a candidate when point is at the end
19289 of the visual line represented by this row. This is not
19290 required when scanning back, because max_pos will already
19291 have a much larger value. */
19292 if (CHARPOS (row
->end
.pos
) > max_pos
)
19293 INC_BOTH (max_pos
, max_bpos
);
19294 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19296 else if (CHARPOS (it
->eol_pos
) > 0)
19297 SET_TEXT_POS (row
->maxpos
,
19298 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19299 else if (row
->continued_p
)
19301 /* If max_pos is different from IT's current position, it
19302 means IT->method does not belong to the display element
19303 at max_pos. However, it also means that the display
19304 element at max_pos was displayed in its entirety on this
19305 line, which is equivalent to saying that the next line
19306 starts at the next buffer position. */
19307 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19308 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19311 INC_BOTH (max_pos
, max_bpos
);
19312 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19315 else if (row
->truncated_on_right_p
)
19316 /* display_line already called reseat_at_next_visible_line_start,
19317 which puts the iterator at the beginning of the next line, in
19318 the logical order. */
19319 row
->maxpos
= it
->current
.pos
;
19320 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19321 /* A line that is entirely from a string/image/stretch... */
19322 row
->maxpos
= row
->minpos
;
19327 row
->maxpos
= it
->current
.pos
;
19330 /* Construct the glyph row IT->glyph_row in the desired matrix of
19331 IT->w from text at the current position of IT. See dispextern.h
19332 for an overview of struct it. Value is non-zero if
19333 IT->glyph_row displays text, as opposed to a line displaying ZV
19337 display_line (struct it
*it
)
19339 struct glyph_row
*row
= it
->glyph_row
;
19340 Lisp_Object overlay_arrow_string
;
19342 void *wrap_data
= NULL
;
19343 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19344 int wrap_row_used
= -1;
19345 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19346 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19347 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19348 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19349 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19351 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19352 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19354 /* We always start displaying at hpos zero even if hscrolled. */
19355 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19357 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19358 >= it
->w
->desired_matrix
->nrows
)
19360 it
->w
->nrows_scale_factor
++;
19361 fonts_changed_p
= 1;
19365 /* Is IT->w showing the region? */
19366 wset_region_showing (it
->w
, it
->region_beg_charpos
> 0 ? Qt
: Qnil
);
19368 /* Clear the result glyph row and enable it. */
19369 prepare_desired_row (row
);
19371 row
->y
= it
->current_y
;
19372 row
->start
= it
->start
;
19373 row
->continuation_lines_width
= it
->continuation_lines_width
;
19374 row
->displays_text_p
= 1;
19375 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19376 it
->starts_in_middle_of_char_p
= 0;
19378 /* Arrange the overlays nicely for our purposes. Usually, we call
19379 display_line on only one line at a time, in which case this
19380 can't really hurt too much, or we call it on lines which appear
19381 one after another in the buffer, in which case all calls to
19382 recenter_overlay_lists but the first will be pretty cheap. */
19383 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19385 /* Move over display elements that are not visible because we are
19386 hscrolled. This may stop at an x-position < IT->first_visible_x
19387 if the first glyph is partially visible or if we hit a line end. */
19388 if (it
->current_x
< it
->first_visible_x
)
19390 enum move_it_result move_result
;
19392 this_line_min_pos
= row
->start
.pos
;
19393 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19394 MOVE_TO_POS
| MOVE_TO_X
);
19395 /* If we are under a large hscroll, move_it_in_display_line_to
19396 could hit the end of the line without reaching
19397 it->first_visible_x. Pretend that we did reach it. This is
19398 especially important on a TTY, where we will call
19399 extend_face_to_end_of_line, which needs to know how many
19400 blank glyphs to produce. */
19401 if (it
->current_x
< it
->first_visible_x
19402 && (move_result
== MOVE_NEWLINE_OR_CR
19403 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19404 it
->current_x
= it
->first_visible_x
;
19406 /* Record the smallest positions seen while we moved over
19407 display elements that are not visible. This is needed by
19408 redisplay_internal for optimizing the case where the cursor
19409 stays inside the same line. The rest of this function only
19410 considers positions that are actually displayed, so
19411 RECORD_MAX_MIN_POS will not otherwise record positions that
19412 are hscrolled to the left of the left edge of the window. */
19413 min_pos
= CHARPOS (this_line_min_pos
);
19414 min_bpos
= BYTEPOS (this_line_min_pos
);
19418 /* We only do this when not calling `move_it_in_display_line_to'
19419 above, because move_it_in_display_line_to calls
19420 handle_line_prefix itself. */
19421 handle_line_prefix (it
);
19424 /* Get the initial row height. This is either the height of the
19425 text hscrolled, if there is any, or zero. */
19426 row
->ascent
= it
->max_ascent
;
19427 row
->height
= it
->max_ascent
+ it
->max_descent
;
19428 row
->phys_ascent
= it
->max_phys_ascent
;
19429 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19430 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19432 /* Utility macro to record max and min buffer positions seen until now. */
19433 #define RECORD_MAX_MIN_POS(IT) \
19436 int composition_p = !STRINGP ((IT)->string) \
19437 && ((IT)->what == IT_COMPOSITION); \
19438 ptrdiff_t current_pos = \
19439 composition_p ? (IT)->cmp_it.charpos \
19440 : IT_CHARPOS (*(IT)); \
19441 ptrdiff_t current_bpos = \
19442 composition_p ? CHAR_TO_BYTE (current_pos) \
19443 : IT_BYTEPOS (*(IT)); \
19444 if (current_pos < min_pos) \
19446 min_pos = current_pos; \
19447 min_bpos = current_bpos; \
19449 if (IT_CHARPOS (*it) > max_pos) \
19451 max_pos = IT_CHARPOS (*it); \
19452 max_bpos = IT_BYTEPOS (*it); \
19457 /* Loop generating characters. The loop is left with IT on the next
19458 character to display. */
19461 int n_glyphs_before
, hpos_before
, x_before
;
19463 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19465 /* Retrieve the next thing to display. Value is zero if end of
19467 if (!get_next_display_element (it
))
19469 /* Maybe add a space at the end of this line that is used to
19470 display the cursor there under X. Set the charpos of the
19471 first glyph of blank lines not corresponding to any text
19473 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19474 row
->exact_window_width_line_p
= 1;
19475 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19476 || row
->used
[TEXT_AREA
] == 0)
19478 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19479 row
->displays_text_p
= 0;
19481 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19482 && (!MINI_WINDOW_P (it
->w
)
19483 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19484 row
->indicate_empty_line_p
= 1;
19487 it
->continuation_lines_width
= 0;
19488 row
->ends_at_zv_p
= 1;
19489 /* A row that displays right-to-left text must always have
19490 its last face extended all the way to the end of line,
19491 even if this row ends in ZV, because we still write to
19492 the screen left to right. We also need to extend the
19493 last face if the default face is remapped to some
19494 different face, otherwise the functions that clear
19495 portions of the screen will clear with the default face's
19496 background color. */
19497 if (row
->reversed_p
19498 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19499 extend_face_to_end_of_line (it
);
19503 /* Now, get the metrics of what we want to display. This also
19504 generates glyphs in `row' (which is IT->glyph_row). */
19505 n_glyphs_before
= row
->used
[TEXT_AREA
];
19508 /* Remember the line height so far in case the next element doesn't
19509 fit on the line. */
19510 if (it
->line_wrap
!= TRUNCATE
)
19512 ascent
= it
->max_ascent
;
19513 descent
= it
->max_descent
;
19514 phys_ascent
= it
->max_phys_ascent
;
19515 phys_descent
= it
->max_phys_descent
;
19517 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19519 if (IT_DISPLAYING_WHITESPACE (it
))
19523 SAVE_IT (wrap_it
, *it
, wrap_data
);
19525 wrap_row_used
= row
->used
[TEXT_AREA
];
19526 wrap_row_ascent
= row
->ascent
;
19527 wrap_row_height
= row
->height
;
19528 wrap_row_phys_ascent
= row
->phys_ascent
;
19529 wrap_row_phys_height
= row
->phys_height
;
19530 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19531 wrap_row_min_pos
= min_pos
;
19532 wrap_row_min_bpos
= min_bpos
;
19533 wrap_row_max_pos
= max_pos
;
19534 wrap_row_max_bpos
= max_bpos
;
19540 PRODUCE_GLYPHS (it
);
19542 /* If this display element was in marginal areas, continue with
19544 if (it
->area
!= TEXT_AREA
)
19546 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19547 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19548 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19549 row
->phys_height
= max (row
->phys_height
,
19550 it
->max_phys_ascent
+ it
->max_phys_descent
);
19551 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19552 it
->max_extra_line_spacing
);
19553 set_iterator_to_next (it
, 1);
19557 /* Does the display element fit on the line? If we truncate
19558 lines, we should draw past the right edge of the window. If
19559 we don't truncate, we want to stop so that we can display the
19560 continuation glyph before the right margin. If lines are
19561 continued, there are two possible strategies for characters
19562 resulting in more than 1 glyph (e.g. tabs): Display as many
19563 glyphs as possible in this line and leave the rest for the
19564 continuation line, or display the whole element in the next
19565 line. Original redisplay did the former, so we do it also. */
19566 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19567 hpos_before
= it
->hpos
;
19570 if (/* Not a newline. */
19572 /* Glyphs produced fit entirely in the line. */
19573 && it
->current_x
< it
->last_visible_x
)
19575 it
->hpos
+= nglyphs
;
19576 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19577 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19578 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19579 row
->phys_height
= max (row
->phys_height
,
19580 it
->max_phys_ascent
+ it
->max_phys_descent
);
19581 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19582 it
->max_extra_line_spacing
);
19583 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19584 row
->x
= x
- it
->first_visible_x
;
19585 /* Record the maximum and minimum buffer positions seen so
19586 far in glyphs that will be displayed by this row. */
19588 RECORD_MAX_MIN_POS (it
);
19593 struct glyph
*glyph
;
19595 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19597 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19598 new_x
= x
+ glyph
->pixel_width
;
19600 if (/* Lines are continued. */
19601 it
->line_wrap
!= TRUNCATE
19602 && (/* Glyph doesn't fit on the line. */
19603 new_x
> it
->last_visible_x
19604 /* Or it fits exactly on a window system frame. */
19605 || (new_x
== it
->last_visible_x
19606 && FRAME_WINDOW_P (it
->f
)
19607 && (row
->reversed_p
19608 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19609 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19611 /* End of a continued line. */
19614 || (new_x
== it
->last_visible_x
19615 && FRAME_WINDOW_P (it
->f
)
19616 && (row
->reversed_p
19617 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19618 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19620 /* Current glyph is the only one on the line or
19621 fits exactly on the line. We must continue
19622 the line because we can't draw the cursor
19623 after the glyph. */
19624 row
->continued_p
= 1;
19625 it
->current_x
= new_x
;
19626 it
->continuation_lines_width
+= new_x
;
19628 if (i
== nglyphs
- 1)
19630 /* If line-wrap is on, check if a previous
19631 wrap point was found. */
19632 if (wrap_row_used
> 0
19633 /* Even if there is a previous wrap
19634 point, continue the line here as
19635 usual, if (i) the previous character
19636 was a space or tab AND (ii) the
19637 current character is not. */
19639 || IT_DISPLAYING_WHITESPACE (it
)))
19642 /* Record the maximum and minimum buffer
19643 positions seen so far in glyphs that will be
19644 displayed by this row. */
19646 RECORD_MAX_MIN_POS (it
);
19647 set_iterator_to_next (it
, 1);
19648 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19650 if (!get_next_display_element (it
))
19652 row
->exact_window_width_line_p
= 1;
19653 it
->continuation_lines_width
= 0;
19654 row
->continued_p
= 0;
19655 row
->ends_at_zv_p
= 1;
19657 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19659 row
->continued_p
= 0;
19660 row
->exact_window_width_line_p
= 1;
19664 else if (it
->bidi_p
)
19665 RECORD_MAX_MIN_POS (it
);
19667 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19668 && !FRAME_WINDOW_P (it
->f
))
19670 /* A padding glyph that doesn't fit on this line.
19671 This means the whole character doesn't fit
19673 if (row
->reversed_p
)
19674 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19675 - n_glyphs_before
);
19676 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19678 /* Fill the rest of the row with continuation
19679 glyphs like in 20.x. */
19680 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19681 < row
->glyphs
[1 + TEXT_AREA
])
19682 produce_special_glyphs (it
, IT_CONTINUATION
);
19684 row
->continued_p
= 1;
19685 it
->current_x
= x_before
;
19686 it
->continuation_lines_width
+= x_before
;
19688 /* Restore the height to what it was before the
19689 element not fitting on the line. */
19690 it
->max_ascent
= ascent
;
19691 it
->max_descent
= descent
;
19692 it
->max_phys_ascent
= phys_ascent
;
19693 it
->max_phys_descent
= phys_descent
;
19695 else if (wrap_row_used
> 0)
19698 if (row
->reversed_p
)
19699 unproduce_glyphs (it
,
19700 row
->used
[TEXT_AREA
] - wrap_row_used
);
19701 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19702 it
->continuation_lines_width
+= wrap_x
;
19703 row
->used
[TEXT_AREA
] = wrap_row_used
;
19704 row
->ascent
= wrap_row_ascent
;
19705 row
->height
= wrap_row_height
;
19706 row
->phys_ascent
= wrap_row_phys_ascent
;
19707 row
->phys_height
= wrap_row_phys_height
;
19708 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19709 min_pos
= wrap_row_min_pos
;
19710 min_bpos
= wrap_row_min_bpos
;
19711 max_pos
= wrap_row_max_pos
;
19712 max_bpos
= wrap_row_max_bpos
;
19713 row
->continued_p
= 1;
19714 row
->ends_at_zv_p
= 0;
19715 row
->exact_window_width_line_p
= 0;
19716 it
->continuation_lines_width
+= x
;
19718 /* Make sure that a non-default face is extended
19719 up to the right margin of the window. */
19720 extend_face_to_end_of_line (it
);
19722 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19724 /* A TAB that extends past the right edge of the
19725 window. This produces a single glyph on
19726 window system frames. We leave the glyph in
19727 this row and let it fill the row, but don't
19728 consume the TAB. */
19729 if ((row
->reversed_p
19730 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19731 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19732 produce_special_glyphs (it
, IT_CONTINUATION
);
19733 it
->continuation_lines_width
+= it
->last_visible_x
;
19734 row
->ends_in_middle_of_char_p
= 1;
19735 row
->continued_p
= 1;
19736 glyph
->pixel_width
= it
->last_visible_x
- x
;
19737 it
->starts_in_middle_of_char_p
= 1;
19741 /* Something other than a TAB that draws past
19742 the right edge of the window. Restore
19743 positions to values before the element. */
19744 if (row
->reversed_p
)
19745 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19746 - (n_glyphs_before
+ i
));
19747 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19749 /* Display continuation glyphs. */
19750 it
->current_x
= x_before
;
19751 it
->continuation_lines_width
+= x
;
19752 if (!FRAME_WINDOW_P (it
->f
)
19753 || (row
->reversed_p
19754 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19755 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19756 produce_special_glyphs (it
, IT_CONTINUATION
);
19757 row
->continued_p
= 1;
19759 extend_face_to_end_of_line (it
);
19761 if (nglyphs
> 1 && i
> 0)
19763 row
->ends_in_middle_of_char_p
= 1;
19764 it
->starts_in_middle_of_char_p
= 1;
19767 /* Restore the height to what it was before the
19768 element not fitting on the line. */
19769 it
->max_ascent
= ascent
;
19770 it
->max_descent
= descent
;
19771 it
->max_phys_ascent
= phys_ascent
;
19772 it
->max_phys_descent
= phys_descent
;
19777 else if (new_x
> it
->first_visible_x
)
19779 /* Increment number of glyphs actually displayed. */
19782 /* Record the maximum and minimum buffer positions
19783 seen so far in glyphs that will be displayed by
19786 RECORD_MAX_MIN_POS (it
);
19788 if (x
< it
->first_visible_x
)
19789 /* Glyph is partially visible, i.e. row starts at
19790 negative X position. */
19791 row
->x
= x
- it
->first_visible_x
;
19795 /* Glyph is completely off the left margin of the
19796 window. This should not happen because of the
19797 move_it_in_display_line at the start of this
19798 function, unless the text display area of the
19799 window is empty. */
19800 eassert (it
->first_visible_x
<= it
->last_visible_x
);
19803 /* Even if this display element produced no glyphs at all,
19804 we want to record its position. */
19805 if (it
->bidi_p
&& nglyphs
== 0)
19806 RECORD_MAX_MIN_POS (it
);
19808 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19809 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19810 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19811 row
->phys_height
= max (row
->phys_height
,
19812 it
->max_phys_ascent
+ it
->max_phys_descent
);
19813 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19814 it
->max_extra_line_spacing
);
19816 /* End of this display line if row is continued. */
19817 if (row
->continued_p
|| row
->ends_at_zv_p
)
19822 /* Is this a line end? If yes, we're also done, after making
19823 sure that a non-default face is extended up to the right
19824 margin of the window. */
19825 if (ITERATOR_AT_END_OF_LINE_P (it
))
19827 int used_before
= row
->used
[TEXT_AREA
];
19829 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19831 /* Add a space at the end of the line that is used to
19832 display the cursor there. */
19833 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19834 append_space_for_newline (it
, 0);
19836 /* Extend the face to the end of the line. */
19837 extend_face_to_end_of_line (it
);
19839 /* Make sure we have the position. */
19840 if (used_before
== 0)
19841 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19843 /* Record the position of the newline, for use in
19845 it
->eol_pos
= it
->current
.pos
;
19847 /* Consume the line end. This skips over invisible lines. */
19848 set_iterator_to_next (it
, 1);
19849 it
->continuation_lines_width
= 0;
19853 /* Proceed with next display element. Note that this skips
19854 over lines invisible because of selective display. */
19855 set_iterator_to_next (it
, 1);
19857 /* If we truncate lines, we are done when the last displayed
19858 glyphs reach past the right margin of the window. */
19859 if (it
->line_wrap
== TRUNCATE
19860 && (FRAME_WINDOW_P (it
->f
) && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19861 ? (it
->current_x
>= it
->last_visible_x
)
19862 : (it
->current_x
> it
->last_visible_x
)))
19864 /* Maybe add truncation glyphs. */
19865 if (!FRAME_WINDOW_P (it
->f
)
19866 || (row
->reversed_p
19867 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19868 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19872 if (!row
->reversed_p
)
19874 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19875 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19880 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19881 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19883 /* Remove any padding glyphs at the front of ROW, to
19884 make room for the truncation glyphs we will be
19885 adding below. The loop below always inserts at
19886 least one truncation glyph, so also remove the
19887 last glyph added to ROW. */
19888 unproduce_glyphs (it
, i
+ 1);
19889 /* Adjust i for the loop below. */
19890 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19893 it
->current_x
= x_before
;
19894 if (!FRAME_WINDOW_P (it
->f
))
19896 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19898 row
->used
[TEXT_AREA
] = i
;
19899 produce_special_glyphs (it
, IT_TRUNCATION
);
19904 row
->used
[TEXT_AREA
] = i
;
19905 produce_special_glyphs (it
, IT_TRUNCATION
);
19908 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19910 /* Don't truncate if we can overflow newline into fringe. */
19911 if (!get_next_display_element (it
))
19913 it
->continuation_lines_width
= 0;
19914 row
->ends_at_zv_p
= 1;
19915 row
->exact_window_width_line_p
= 1;
19918 if (ITERATOR_AT_END_OF_LINE_P (it
))
19920 row
->exact_window_width_line_p
= 1;
19921 goto at_end_of_line
;
19923 it
->current_x
= x_before
;
19926 row
->truncated_on_right_p
= 1;
19927 it
->continuation_lines_width
= 0;
19928 reseat_at_next_visible_line_start (it
, 0);
19929 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19930 it
->hpos
= hpos_before
;
19936 bidi_unshelve_cache (wrap_data
, 1);
19938 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19939 at the left window margin. */
19940 if (it
->first_visible_x
19941 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19943 if (!FRAME_WINDOW_P (it
->f
)
19944 || (row
->reversed_p
19945 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19946 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
19947 insert_left_trunc_glyphs (it
);
19948 row
->truncated_on_left_p
= 1;
19951 /* Remember the position at which this line ends.
19953 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19954 cannot be before the call to find_row_edges below, since that is
19955 where these positions are determined. */
19956 row
->end
= it
->current
;
19959 row
->minpos
= row
->start
.pos
;
19960 row
->maxpos
= row
->end
.pos
;
19964 /* ROW->minpos and ROW->maxpos must be the smallest and
19965 `1 + the largest' buffer positions in ROW. But if ROW was
19966 bidi-reordered, these two positions can be anywhere in the
19967 row, so we must determine them now. */
19968 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19971 /* If the start of this line is the overlay arrow-position, then
19972 mark this glyph row as the one containing the overlay arrow.
19973 This is clearly a mess with variable size fonts. It would be
19974 better to let it be displayed like cursors under X. */
19975 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19976 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19977 !NILP (overlay_arrow_string
)))
19979 /* Overlay arrow in window redisplay is a fringe bitmap. */
19980 if (STRINGP (overlay_arrow_string
))
19982 struct glyph_row
*arrow_row
19983 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19984 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19985 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19986 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19987 struct glyph
*p2
, *end
;
19989 /* Copy the arrow glyphs. */
19990 while (glyph
< arrow_end
)
19993 /* Throw away padding glyphs. */
19995 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19996 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20002 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20007 eassert (INTEGERP (overlay_arrow_string
));
20008 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20010 overlay_arrow_seen
= 1;
20013 /* Highlight trailing whitespace. */
20014 if (!NILP (Vshow_trailing_whitespace
))
20015 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20017 /* Compute pixel dimensions of this line. */
20018 compute_line_metrics (it
);
20020 /* Implementation note: No changes in the glyphs of ROW or in their
20021 faces can be done past this point, because compute_line_metrics
20022 computes ROW's hash value and stores it within the glyph_row
20025 /* Record whether this row ends inside an ellipsis. */
20026 row
->ends_in_ellipsis_p
20027 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20028 && it
->ellipsis_p
);
20030 /* Save fringe bitmaps in this row. */
20031 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20032 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20033 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20034 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20036 it
->left_user_fringe_bitmap
= 0;
20037 it
->left_user_fringe_face_id
= 0;
20038 it
->right_user_fringe_bitmap
= 0;
20039 it
->right_user_fringe_face_id
= 0;
20041 /* Maybe set the cursor. */
20042 cvpos
= it
->w
->cursor
.vpos
;
20044 /* In bidi-reordered rows, keep checking for proper cursor
20045 position even if one has been found already, because buffer
20046 positions in such rows change non-linearly with ROW->VPOS,
20047 when a line is continued. One exception: when we are at ZV,
20048 display cursor on the first suitable glyph row, since all
20049 the empty rows after that also have their position set to ZV. */
20050 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20051 lines' rows is implemented for bidi-reordered rows. */
20053 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20054 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20055 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20056 && cursor_row_p (row
))
20057 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20059 /* Prepare for the next line. This line starts horizontally at (X
20060 HPOS) = (0 0). Vertical positions are incremented. As a
20061 convenience for the caller, IT->glyph_row is set to the next
20063 it
->current_x
= it
->hpos
= 0;
20064 it
->current_y
+= row
->height
;
20065 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20068 /* The next row should by default use the same value of the
20069 reversed_p flag as this one. set_iterator_to_next decides when
20070 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20071 the flag accordingly. */
20072 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20073 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20074 it
->start
= row
->end
;
20075 return row
->displays_text_p
;
20077 #undef RECORD_MAX_MIN_POS
20080 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20081 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20082 doc
: /* Return paragraph direction at point in BUFFER.
20083 Value is either `left-to-right' or `right-to-left'.
20084 If BUFFER is omitted or nil, it defaults to the current buffer.
20086 Paragraph direction determines how the text in the paragraph is displayed.
20087 In left-to-right paragraphs, text begins at the left margin of the window
20088 and the reading direction is generally left to right. In right-to-left
20089 paragraphs, text begins at the right margin and is read from right to left.
20091 See also `bidi-paragraph-direction'. */)
20092 (Lisp_Object buffer
)
20094 struct buffer
*buf
= current_buffer
;
20095 struct buffer
*old
= buf
;
20097 if (! NILP (buffer
))
20099 CHECK_BUFFER (buffer
);
20100 buf
= XBUFFER (buffer
);
20103 if (NILP (BVAR (buf
, bidi_display_reordering
))
20104 || NILP (BVAR (buf
, enable_multibyte_characters
))
20105 /* When we are loading loadup.el, the character property tables
20106 needed for bidi iteration are not yet available. */
20107 || !NILP (Vpurify_flag
))
20108 return Qleft_to_right
;
20109 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20110 return BVAR (buf
, bidi_paragraph_direction
);
20113 /* Determine the direction from buffer text. We could try to
20114 use current_matrix if it is up to date, but this seems fast
20115 enough as it is. */
20116 struct bidi_it itb
;
20117 ptrdiff_t pos
= BUF_PT (buf
);
20118 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20120 void *itb_data
= bidi_shelve_cache ();
20122 set_buffer_temp (buf
);
20123 /* bidi_paragraph_init finds the base direction of the paragraph
20124 by searching forward from paragraph start. We need the base
20125 direction of the current or _previous_ paragraph, so we need
20126 to make sure we are within that paragraph. To that end, find
20127 the previous non-empty line. */
20128 if (pos
>= ZV
&& pos
> BEGV
)
20131 bytepos
= CHAR_TO_BYTE (pos
);
20133 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20134 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20136 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20137 || c
== ' ' || c
== '\t' || c
== '\f')
20139 if (bytepos
<= BEGV_BYTE
)
20144 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20147 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20148 itb
.paragraph_dir
= NEUTRAL_DIR
;
20149 itb
.string
.s
= NULL
;
20150 itb
.string
.lstring
= Qnil
;
20151 itb
.string
.bufpos
= 0;
20152 itb
.string
.unibyte
= 0;
20153 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20154 bidi_unshelve_cache (itb_data
, 0);
20155 set_buffer_temp (old
);
20156 switch (itb
.paragraph_dir
)
20159 return Qleft_to_right
;
20162 return Qright_to_left
;
20172 /***********************************************************************
20174 ***********************************************************************/
20176 /* Redisplay the menu bar in the frame for window W.
20178 The menu bar of X frames that don't have X toolkit support is
20179 displayed in a special window W->frame->menu_bar_window.
20181 The menu bar of terminal frames is treated specially as far as
20182 glyph matrices are concerned. Menu bar lines are not part of
20183 windows, so the update is done directly on the frame matrix rows
20184 for the menu bar. */
20187 display_menu_bar (struct window
*w
)
20189 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20194 /* Don't do all this for graphical frames. */
20196 if (FRAME_W32_P (f
))
20199 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
20205 if (FRAME_NS_P (f
))
20207 #endif /* HAVE_NS */
20209 #ifdef USE_X_TOOLKIT
20210 eassert (!FRAME_WINDOW_P (f
));
20211 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
20212 it
.first_visible_x
= 0;
20213 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20214 #else /* not USE_X_TOOLKIT */
20215 if (FRAME_WINDOW_P (f
))
20217 /* Menu bar lines are displayed in the desired matrix of the
20218 dummy window menu_bar_window. */
20219 struct window
*menu_w
;
20220 eassert (WINDOWP (f
->menu_bar_window
));
20221 menu_w
= XWINDOW (f
->menu_bar_window
);
20222 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
20224 it
.first_visible_x
= 0;
20225 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20229 /* This is a TTY frame, i.e. character hpos/vpos are used as
20231 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
20233 it
.first_visible_x
= 0;
20234 it
.last_visible_x
= FRAME_COLS (f
);
20236 #endif /* not USE_X_TOOLKIT */
20238 /* FIXME: This should be controlled by a user option. See the
20239 comments in redisplay_tool_bar and display_mode_line about
20241 it
.paragraph_embedding
= L2R
;
20243 /* Clear all rows of the menu bar. */
20244 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
20246 struct glyph_row
*row
= it
.glyph_row
+ i
;
20247 clear_glyph_row (row
);
20248 row
->enabled_p
= 1;
20249 row
->full_width_p
= 1;
20252 /* Display all items of the menu bar. */
20253 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
20254 for (i
= 0; i
< ASIZE (items
); i
+= 4)
20256 Lisp_Object string
;
20258 /* Stop at nil string. */
20259 string
= AREF (items
, i
+ 1);
20263 /* Remember where item was displayed. */
20264 ASET (items
, i
+ 3, make_number (it
.hpos
));
20266 /* Display the item, pad with one space. */
20267 if (it
.current_x
< it
.last_visible_x
)
20268 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
20269 SCHARS (string
) + 1, 0, 0, -1);
20272 /* Fill out the line with spaces. */
20273 if (it
.current_x
< it
.last_visible_x
)
20274 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
20276 /* Compute the total height of the lines. */
20277 compute_line_metrics (&it
);
20282 /***********************************************************************
20284 ***********************************************************************/
20286 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20287 FORCE is non-zero, redisplay mode lines unconditionally.
20288 Otherwise, redisplay only mode lines that are garbaged. Value is
20289 the number of windows whose mode lines were redisplayed. */
20292 redisplay_mode_lines (Lisp_Object window
, int force
)
20296 while (!NILP (window
))
20298 struct window
*w
= XWINDOW (window
);
20300 if (WINDOWP (w
->hchild
))
20301 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
20302 else if (WINDOWP (w
->vchild
))
20303 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
20305 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20306 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20308 struct text_pos lpoint
;
20309 struct buffer
*old
= current_buffer
;
20311 /* Set the window's buffer for the mode line display. */
20312 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20313 set_buffer_internal_1 (XBUFFER (w
->buffer
));
20315 /* Point refers normally to the selected window. For any
20316 other window, set up appropriate value. */
20317 if (!EQ (window
, selected_window
))
20319 struct text_pos pt
;
20321 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20322 if (CHARPOS (pt
) < BEGV
)
20323 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
20324 else if (CHARPOS (pt
) > (ZV
- 1))
20325 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
20327 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20330 /* Display mode lines. */
20331 clear_glyph_matrix (w
->desired_matrix
);
20332 if (display_mode_lines (w
))
20335 w
->must_be_updated_p
= 1;
20338 /* Restore old settings. */
20339 set_buffer_internal_1 (old
);
20340 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20350 /* Display the mode and/or header line of window W. Value is the
20351 sum number of mode lines and header lines displayed. */
20354 display_mode_lines (struct window
*w
)
20356 Lisp_Object old_selected_window
= selected_window
;
20357 Lisp_Object old_selected_frame
= selected_frame
;
20358 Lisp_Object new_frame
= w
->frame
;
20359 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
20362 selected_frame
= new_frame
;
20363 /* FIXME: If we were to allow the mode-line's computation changing the buffer
20364 or window's point, then we'd need select_window_1 here as well. */
20365 XSETWINDOW (selected_window
, w
);
20366 XFRAME (new_frame
)->selected_window
= selected_window
;
20368 /* These will be set while the mode line specs are processed. */
20369 line_number_displayed
= 0;
20370 wset_column_number_displayed (w
, Qnil
);
20372 if (WINDOW_WANTS_MODELINE_P (w
))
20374 struct window
*sel_w
= XWINDOW (old_selected_window
);
20376 /* Select mode line face based on the real selected window. */
20377 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20378 BVAR (current_buffer
, mode_line_format
));
20382 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20384 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20385 BVAR (current_buffer
, header_line_format
));
20389 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
20390 selected_frame
= old_selected_frame
;
20391 selected_window
= old_selected_window
;
20396 /* Display mode or header line of window W. FACE_ID specifies which
20397 line to display; it is either MODE_LINE_FACE_ID or
20398 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20399 display. Value is the pixel height of the mode/header line
20403 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20407 ptrdiff_t count
= SPECPDL_INDEX ();
20409 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20410 /* Don't extend on a previously drawn mode-line.
20411 This may happen if called from pos_visible_p. */
20412 it
.glyph_row
->enabled_p
= 0;
20413 prepare_desired_row (it
.glyph_row
);
20415 it
.glyph_row
->mode_line_p
= 1;
20417 /* FIXME: This should be controlled by a user option. But
20418 supporting such an option is not trivial, since the mode line is
20419 made up of many separate strings. */
20420 it
.paragraph_embedding
= L2R
;
20422 record_unwind_protect (unwind_format_mode_line
,
20423 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
20425 mode_line_target
= MODE_LINE_DISPLAY
;
20427 /* Temporarily make frame's keyboard the current kboard so that
20428 kboard-local variables in the mode_line_format will get the right
20430 push_kboard (FRAME_KBOARD (it
.f
));
20431 record_unwind_save_match_data ();
20432 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20435 unbind_to (count
, Qnil
);
20437 /* Fill up with spaces. */
20438 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20440 compute_line_metrics (&it
);
20441 it
.glyph_row
->full_width_p
= 1;
20442 it
.glyph_row
->continued_p
= 0;
20443 it
.glyph_row
->truncated_on_left_p
= 0;
20444 it
.glyph_row
->truncated_on_right_p
= 0;
20446 /* Make a 3D mode-line have a shadow at its right end. */
20447 face
= FACE_FROM_ID (it
.f
, face_id
);
20448 extend_face_to_end_of_line (&it
);
20449 if (face
->box
!= FACE_NO_BOX
)
20451 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20452 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20453 last
->right_box_line_p
= 1;
20456 return it
.glyph_row
->height
;
20459 /* Move element ELT in LIST to the front of LIST.
20460 Return the updated list. */
20463 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20465 register Lisp_Object tail
, prev
;
20466 register Lisp_Object tem
;
20470 while (CONSP (tail
))
20476 /* Splice out the link TAIL. */
20478 list
= XCDR (tail
);
20480 Fsetcdr (prev
, XCDR (tail
));
20482 /* Now make it the first. */
20483 Fsetcdr (tail
, list
);
20488 tail
= XCDR (tail
);
20492 /* Not found--return unchanged LIST. */
20496 /* Contribute ELT to the mode line for window IT->w. How it
20497 translates into text depends on its data type.
20499 IT describes the display environment in which we display, as usual.
20501 DEPTH is the depth in recursion. It is used to prevent
20502 infinite recursion here.
20504 FIELD_WIDTH is the number of characters the display of ELT should
20505 occupy in the mode line, and PRECISION is the maximum number of
20506 characters to display from ELT's representation. See
20507 display_string for details.
20509 Returns the hpos of the end of the text generated by ELT.
20511 PROPS is a property list to add to any string we encounter.
20513 If RISKY is nonzero, remove (disregard) any properties in any string
20514 we encounter, and ignore :eval and :propertize.
20516 The global variable `mode_line_target' determines whether the
20517 output is passed to `store_mode_line_noprop',
20518 `store_mode_line_string', or `display_string'. */
20521 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20522 Lisp_Object elt
, Lisp_Object props
, int risky
)
20524 int n
= 0, field
, prec
;
20529 elt
= build_string ("*too-deep*");
20533 switch (XTYPE (elt
))
20537 /* A string: output it and check for %-constructs within it. */
20539 ptrdiff_t offset
= 0;
20541 if (SCHARS (elt
) > 0
20542 && (!NILP (props
) || risky
))
20544 Lisp_Object oprops
, aelt
;
20545 oprops
= Ftext_properties_at (make_number (0), elt
);
20547 /* If the starting string's properties are not what
20548 we want, translate the string. Also, if the string
20549 is risky, do that anyway. */
20551 if (NILP (Fequal (props
, oprops
)) || risky
)
20553 /* If the starting string has properties,
20554 merge the specified ones onto the existing ones. */
20555 if (! NILP (oprops
) && !risky
)
20559 oprops
= Fcopy_sequence (oprops
);
20561 while (CONSP (tem
))
20563 oprops
= Fplist_put (oprops
, XCAR (tem
),
20564 XCAR (XCDR (tem
)));
20565 tem
= XCDR (XCDR (tem
));
20570 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20571 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20573 /* AELT is what we want. Move it to the front
20574 without consing. */
20576 mode_line_proptrans_alist
20577 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20583 /* If AELT has the wrong props, it is useless.
20584 so get rid of it. */
20586 mode_line_proptrans_alist
20587 = Fdelq (aelt
, mode_line_proptrans_alist
);
20589 elt
= Fcopy_sequence (elt
);
20590 Fset_text_properties (make_number (0), Flength (elt
),
20592 /* Add this item to mode_line_proptrans_alist. */
20593 mode_line_proptrans_alist
20594 = Fcons (Fcons (elt
, props
),
20595 mode_line_proptrans_alist
);
20596 /* Truncate mode_line_proptrans_alist
20597 to at most 50 elements. */
20598 tem
= Fnthcdr (make_number (50),
20599 mode_line_proptrans_alist
);
20601 XSETCDR (tem
, Qnil
);
20610 prec
= precision
- n
;
20611 switch (mode_line_target
)
20613 case MODE_LINE_NOPROP
:
20614 case MODE_LINE_TITLE
:
20615 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20617 case MODE_LINE_STRING
:
20618 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20620 case MODE_LINE_DISPLAY
:
20621 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20622 0, prec
, 0, STRING_MULTIBYTE (elt
));
20629 /* Handle the non-literal case. */
20631 while ((precision
<= 0 || n
< precision
)
20632 && SREF (elt
, offset
) != 0
20633 && (mode_line_target
!= MODE_LINE_DISPLAY
20634 || it
->current_x
< it
->last_visible_x
))
20636 ptrdiff_t last_offset
= offset
;
20638 /* Advance to end of string or next format specifier. */
20639 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20642 if (offset
- 1 != last_offset
)
20644 ptrdiff_t nchars
, nbytes
;
20646 /* Output to end of string or up to '%'. Field width
20647 is length of string. Don't output more than
20648 PRECISION allows us. */
20651 prec
= c_string_width (SDATA (elt
) + last_offset
,
20652 offset
- last_offset
, precision
- n
,
20655 switch (mode_line_target
)
20657 case MODE_LINE_NOPROP
:
20658 case MODE_LINE_TITLE
:
20659 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20661 case MODE_LINE_STRING
:
20663 ptrdiff_t bytepos
= last_offset
;
20664 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20665 ptrdiff_t endpos
= (precision
<= 0
20666 ? string_byte_to_char (elt
, offset
)
20667 : charpos
+ nchars
);
20669 n
+= store_mode_line_string (NULL
,
20670 Fsubstring (elt
, make_number (charpos
),
20671 make_number (endpos
)),
20675 case MODE_LINE_DISPLAY
:
20677 ptrdiff_t bytepos
= last_offset
;
20678 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20680 if (precision
<= 0)
20681 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20682 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20684 STRING_MULTIBYTE (elt
));
20689 else /* c == '%' */
20691 ptrdiff_t percent_position
= offset
;
20693 /* Get the specified minimum width. Zero means
20696 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20697 field
= field
* 10 + c
- '0';
20699 /* Don't pad beyond the total padding allowed. */
20700 if (field_width
- n
> 0 && field
> field_width
- n
)
20701 field
= field_width
- n
;
20703 /* Note that either PRECISION <= 0 or N < PRECISION. */
20704 prec
= precision
- n
;
20707 n
+= display_mode_element (it
, depth
, field
, prec
,
20708 Vglobal_mode_string
, props
,
20713 ptrdiff_t bytepos
, charpos
;
20715 Lisp_Object string
;
20717 bytepos
= percent_position
;
20718 charpos
= (STRING_MULTIBYTE (elt
)
20719 ? string_byte_to_char (elt
, bytepos
)
20721 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20722 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20724 switch (mode_line_target
)
20726 case MODE_LINE_NOPROP
:
20727 case MODE_LINE_TITLE
:
20728 n
+= store_mode_line_noprop (spec
, field
, prec
);
20730 case MODE_LINE_STRING
:
20732 Lisp_Object tem
= build_string (spec
);
20733 props
= Ftext_properties_at (make_number (charpos
), elt
);
20734 /* Should only keep face property in props */
20735 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20738 case MODE_LINE_DISPLAY
:
20740 int nglyphs_before
, nwritten
;
20742 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20743 nwritten
= display_string (spec
, string
, elt
,
20748 /* Assign to the glyphs written above the
20749 string where the `%x' came from, position
20753 struct glyph
*glyph
20754 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20758 for (i
= 0; i
< nwritten
; ++i
)
20760 glyph
[i
].object
= elt
;
20761 glyph
[i
].charpos
= charpos
;
20778 /* A symbol: process the value of the symbol recursively
20779 as if it appeared here directly. Avoid error if symbol void.
20780 Special case: if value of symbol is a string, output the string
20783 register Lisp_Object tem
;
20785 /* If the variable is not marked as risky to set
20786 then its contents are risky to use. */
20787 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20790 tem
= Fboundp (elt
);
20793 tem
= Fsymbol_value (elt
);
20794 /* If value is a string, output that string literally:
20795 don't check for % within it. */
20799 if (!EQ (tem
, elt
))
20801 /* Give up right away for nil or t. */
20811 register Lisp_Object car
, tem
;
20813 /* A cons cell: five distinct cases.
20814 If first element is :eval or :propertize, do something special.
20815 If first element is a string or a cons, process all the elements
20816 and effectively concatenate them.
20817 If first element is a negative number, truncate displaying cdr to
20818 at most that many characters. If positive, pad (with spaces)
20819 to at least that many characters.
20820 If first element is a symbol, process the cadr or caddr recursively
20821 according to whether the symbol's value is non-nil or nil. */
20823 if (EQ (car
, QCeval
))
20825 /* An element of the form (:eval FORM) means evaluate FORM
20826 and use the result as mode line elements. */
20831 if (CONSP (XCDR (elt
)))
20834 spec
= safe_eval (XCAR (XCDR (elt
)));
20835 n
+= display_mode_element (it
, depth
, field_width
- n
,
20836 precision
- n
, spec
, props
,
20840 else if (EQ (car
, QCpropertize
))
20842 /* An element of the form (:propertize ELT PROPS...)
20843 means display ELT but applying properties PROPS. */
20848 if (CONSP (XCDR (elt
)))
20849 n
+= display_mode_element (it
, depth
, field_width
- n
,
20850 precision
- n
, XCAR (XCDR (elt
)),
20851 XCDR (XCDR (elt
)), risky
);
20853 else if (SYMBOLP (car
))
20855 tem
= Fboundp (car
);
20859 /* elt is now the cdr, and we know it is a cons cell.
20860 Use its car if CAR has a non-nil value. */
20863 tem
= Fsymbol_value (car
);
20870 /* Symbol's value is nil (or symbol is unbound)
20871 Get the cddr of the original list
20872 and if possible find the caddr and use that. */
20876 else if (!CONSP (elt
))
20881 else if (INTEGERP (car
))
20883 register int lim
= XINT (car
);
20887 /* Negative int means reduce maximum width. */
20888 if (precision
<= 0)
20891 precision
= min (precision
, -lim
);
20895 /* Padding specified. Don't let it be more than
20896 current maximum. */
20898 lim
= min (precision
, lim
);
20900 /* If that's more padding than already wanted, queue it.
20901 But don't reduce padding already specified even if
20902 that is beyond the current truncation point. */
20903 field_width
= max (lim
, field_width
);
20907 else if (STRINGP (car
) || CONSP (car
))
20909 Lisp_Object halftail
= elt
;
20913 && (precision
<= 0 || n
< precision
))
20915 n
+= display_mode_element (it
, depth
,
20916 /* Do padding only after the last
20917 element in the list. */
20918 (! CONSP (XCDR (elt
))
20921 precision
- n
, XCAR (elt
),
20925 if ((len
& 1) == 0)
20926 halftail
= XCDR (halftail
);
20927 /* Check for cycle. */
20928 if (EQ (halftail
, elt
))
20937 elt
= build_string ("*invalid*");
20941 /* Pad to FIELD_WIDTH. */
20942 if (field_width
> 0 && n
< field_width
)
20944 switch (mode_line_target
)
20946 case MODE_LINE_NOPROP
:
20947 case MODE_LINE_TITLE
:
20948 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20950 case MODE_LINE_STRING
:
20951 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20953 case MODE_LINE_DISPLAY
:
20954 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20963 /* Store a mode-line string element in mode_line_string_list.
20965 If STRING is non-null, display that C string. Otherwise, the Lisp
20966 string LISP_STRING is displayed.
20968 FIELD_WIDTH is the minimum number of output glyphs to produce.
20969 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20970 with spaces. FIELD_WIDTH <= 0 means don't pad.
20972 PRECISION is the maximum number of characters to output from
20973 STRING. PRECISION <= 0 means don't truncate the string.
20975 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20976 properties to the string.
20978 PROPS are the properties to add to the string.
20979 The mode_line_string_face face property is always added to the string.
20983 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20984 int field_width
, int precision
, Lisp_Object props
)
20989 if (string
!= NULL
)
20991 len
= strlen (string
);
20992 if (precision
> 0 && len
> precision
)
20994 lisp_string
= make_string (string
, len
);
20996 props
= mode_line_string_face_prop
;
20997 else if (!NILP (mode_line_string_face
))
20999 Lisp_Object face
= Fplist_get (props
, Qface
);
21000 props
= Fcopy_sequence (props
);
21002 face
= mode_line_string_face
;
21004 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
21005 props
= Fplist_put (props
, Qface
, face
);
21007 Fadd_text_properties (make_number (0), make_number (len
),
21008 props
, lisp_string
);
21012 len
= XFASTINT (Flength (lisp_string
));
21013 if (precision
> 0 && len
> precision
)
21016 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
21019 if (!NILP (mode_line_string_face
))
21023 props
= Ftext_properties_at (make_number (0), lisp_string
);
21024 face
= Fplist_get (props
, Qface
);
21026 face
= mode_line_string_face
;
21028 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
21029 props
= Fcons (Qface
, Fcons (face
, Qnil
));
21031 lisp_string
= Fcopy_sequence (lisp_string
);
21034 Fadd_text_properties (make_number (0), make_number (len
),
21035 props
, lisp_string
);
21040 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
21044 if (field_width
> len
)
21046 field_width
-= len
;
21047 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
21049 Fadd_text_properties (make_number (0), make_number (field_width
),
21050 props
, lisp_string
);
21051 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
21059 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
21061 doc
: /* Format a string out of a mode line format specification.
21062 First arg FORMAT specifies the mode line format (see `mode-line-format'
21063 for details) to use.
21065 By default, the format is evaluated for the currently selected window.
21067 Optional second arg FACE specifies the face property to put on all
21068 characters for which no face is specified. The value nil means the
21069 default face. The value t means whatever face the window's mode line
21070 currently uses (either `mode-line' or `mode-line-inactive',
21071 depending on whether the window is the selected window or not).
21072 An integer value means the value string has no text
21075 Optional third and fourth args WINDOW and BUFFER specify the window
21076 and buffer to use as the context for the formatting (defaults
21077 are the selected window and the WINDOW's buffer). */)
21078 (Lisp_Object format
, Lisp_Object face
,
21079 Lisp_Object window
, Lisp_Object buffer
)
21084 struct buffer
*old_buffer
= NULL
;
21086 int no_props
= INTEGERP (face
);
21087 ptrdiff_t count
= SPECPDL_INDEX ();
21089 int string_start
= 0;
21091 w
= decode_any_window (window
);
21092 XSETWINDOW (window
, w
);
21095 buffer
= w
->buffer
;
21096 CHECK_BUFFER (buffer
);
21098 /* Make formatting the modeline a non-op when noninteractive, otherwise
21099 there will be problems later caused by a partially initialized frame. */
21100 if (NILP (format
) || noninteractive
)
21101 return empty_unibyte_string
;
21106 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
21107 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
21108 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
21109 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
21110 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
21111 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
21112 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
21115 old_buffer
= current_buffer
;
21117 /* Save things including mode_line_proptrans_alist,
21118 and set that to nil so that we don't alter the outer value. */
21119 record_unwind_protect (unwind_format_mode_line
,
21120 format_mode_line_unwind_data
21121 (XFRAME (WINDOW_FRAME (w
)),
21122 old_buffer
, selected_window
, 1));
21123 mode_line_proptrans_alist
= Qnil
;
21125 Fselect_window (window
, Qt
);
21126 set_buffer_internal_1 (XBUFFER (buffer
));
21128 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21132 mode_line_target
= MODE_LINE_NOPROP
;
21133 mode_line_string_face_prop
= Qnil
;
21134 mode_line_string_list
= Qnil
;
21135 string_start
= MODE_LINE_NOPROP_LEN (0);
21139 mode_line_target
= MODE_LINE_STRING
;
21140 mode_line_string_list
= Qnil
;
21141 mode_line_string_face
= face
;
21142 mode_line_string_face_prop
21143 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
21146 push_kboard (FRAME_KBOARD (it
.f
));
21147 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21152 len
= MODE_LINE_NOPROP_LEN (string_start
);
21153 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
21157 mode_line_string_list
= Fnreverse (mode_line_string_list
);
21158 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
21159 empty_unibyte_string
);
21162 unbind_to (count
, Qnil
);
21166 /* Write a null-terminated, right justified decimal representation of
21167 the positive integer D to BUF using a minimal field width WIDTH. */
21170 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
21172 register char *p
= buf
;
21180 *p
++ = d
% 10 + '0';
21185 for (width
-= (int) (p
- buf
); width
> 0; --width
)
21196 /* Write a null-terminated, right justified decimal and "human
21197 readable" representation of the nonnegative integer D to BUF using
21198 a minimal field width WIDTH. D should be smaller than 999.5e24. */
21200 static const char power_letter
[] =
21214 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
21216 /* We aim to represent the nonnegative integer D as
21217 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
21218 ptrdiff_t quotient
= d
;
21220 /* -1 means: do not use TENTHS. */
21224 /* Length of QUOTIENT.TENTHS as a string. */
21230 if (1000 <= quotient
)
21232 /* Scale to the appropriate EXPONENT. */
21235 remainder
= quotient
% 1000;
21239 while (1000 <= quotient
);
21241 /* Round to nearest and decide whether to use TENTHS or not. */
21244 tenths
= remainder
/ 100;
21245 if (50 <= remainder
% 100)
21252 if (quotient
== 10)
21260 if (500 <= remainder
)
21262 if (quotient
< 999)
21273 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21274 if (tenths
== -1 && quotient
<= 99)
21281 p
= psuffix
= buf
+ max (width
, length
);
21283 /* Print EXPONENT. */
21284 *psuffix
++ = power_letter
[exponent
];
21287 /* Print TENTHS. */
21290 *--p
= '0' + tenths
;
21294 /* Print QUOTIENT. */
21297 int digit
= quotient
% 10;
21298 *--p
= '0' + digit
;
21300 while ((quotient
/= 10) != 0);
21302 /* Print leading spaces. */
21307 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21308 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21309 type of CODING_SYSTEM. Return updated pointer into BUF. */
21311 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21314 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21317 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21318 const unsigned char *eol_str
;
21320 /* The EOL conversion we are using. */
21321 Lisp_Object eoltype
;
21323 val
= CODING_SYSTEM_SPEC (coding_system
);
21326 if (!VECTORP (val
)) /* Not yet decided. */
21328 *buf
++ = multibyte
? '-' : ' ';
21330 eoltype
= eol_mnemonic_undecided
;
21331 /* Don't mention EOL conversion if it isn't decided. */
21336 Lisp_Object eolvalue
;
21338 attrs
= AREF (val
, 0);
21339 eolvalue
= AREF (val
, 2);
21342 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21347 /* The EOL conversion that is normal on this system. */
21349 if (NILP (eolvalue
)) /* Not yet decided. */
21350 eoltype
= eol_mnemonic_undecided
;
21351 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21352 eoltype
= eol_mnemonic_undecided
;
21353 else /* eolvalue is Qunix, Qdos, or Qmac. */
21354 eoltype
= (EQ (eolvalue
, Qunix
)
21355 ? eol_mnemonic_unix
21356 : (EQ (eolvalue
, Qdos
) == 1
21357 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21363 /* Mention the EOL conversion if it is not the usual one. */
21364 if (STRINGP (eoltype
))
21366 eol_str
= SDATA (eoltype
);
21367 eol_str_len
= SBYTES (eoltype
);
21369 else if (CHARACTERP (eoltype
))
21371 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
21372 int c
= XFASTINT (eoltype
);
21373 eol_str_len
= CHAR_STRING (c
, tmp
);
21378 eol_str
= invalid_eol_type
;
21379 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21381 memcpy (buf
, eol_str
, eol_str_len
);
21382 buf
+= eol_str_len
;
21388 /* Return a string for the output of a mode line %-spec for window W,
21389 generated by character C. FIELD_WIDTH > 0 means pad the string
21390 returned with spaces to that value. Return a Lisp string in
21391 *STRING if the resulting string is taken from that Lisp string.
21393 Note we operate on the current buffer for most purposes,
21394 the exception being w->base_line_pos. */
21396 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21398 static const char *
21399 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21400 Lisp_Object
*string
)
21403 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21404 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21405 /* We are going to use f->decode_mode_spec_buffer as the buffer to
21406 produce strings from numerical values, so limit preposterously
21407 large values of FIELD_WIDTH to avoid overrunning the buffer's
21408 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
21409 bytes plus the terminating null. */
21410 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
21411 struct buffer
*b
= current_buffer
;
21419 if (!NILP (BVAR (b
, read_only
)))
21421 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21426 /* This differs from %* only for a modified read-only buffer. */
21427 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21429 if (!NILP (BVAR (b
, read_only
)))
21434 /* This differs from %* in ignoring read-only-ness. */
21435 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21447 if (command_loop_level
> 5)
21449 p
= decode_mode_spec_buf
;
21450 for (i
= 0; i
< command_loop_level
; i
++)
21453 return decode_mode_spec_buf
;
21461 if (command_loop_level
> 5)
21463 p
= decode_mode_spec_buf
;
21464 for (i
= 0; i
< command_loop_level
; i
++)
21467 return decode_mode_spec_buf
;
21474 /* Let lots_of_dashes be a string of infinite length. */
21475 if (mode_line_target
== MODE_LINE_NOPROP
21476 || mode_line_target
== MODE_LINE_STRING
)
21478 if (field_width
<= 0
21479 || field_width
> sizeof (lots_of_dashes
))
21481 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21482 decode_mode_spec_buf
[i
] = '-';
21483 decode_mode_spec_buf
[i
] = '\0';
21484 return decode_mode_spec_buf
;
21487 return lots_of_dashes
;
21491 obj
= BVAR (b
, name
);
21495 /* %c and %l are ignored in `frame-title-format'.
21496 (In redisplay_internal, the frame title is drawn _before_ the
21497 windows are updated, so the stuff which depends on actual
21498 window contents (such as %l) may fail to render properly, or
21499 even crash emacs.) */
21500 if (mode_line_target
== MODE_LINE_TITLE
)
21504 ptrdiff_t col
= current_column ();
21505 wset_column_number_displayed (w
, make_number (col
));
21506 pint2str (decode_mode_spec_buf
, width
, col
);
21507 return decode_mode_spec_buf
;
21511 #ifndef SYSTEM_MALLOC
21513 if (NILP (Vmemory_full
))
21516 return "!MEM FULL! ";
21523 /* %F displays the frame name. */
21524 if (!NILP (f
->title
))
21525 return SSDATA (f
->title
);
21526 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21527 return SSDATA (f
->name
);
21531 obj
= BVAR (b
, filename
);
21536 ptrdiff_t size
= ZV
- BEGV
;
21537 pint2str (decode_mode_spec_buf
, width
, size
);
21538 return decode_mode_spec_buf
;
21543 ptrdiff_t size
= ZV
- BEGV
;
21544 pint2hrstr (decode_mode_spec_buf
, width
, size
);
21545 return decode_mode_spec_buf
;
21550 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21551 ptrdiff_t topline
, nlines
, height
;
21554 /* %c and %l are ignored in `frame-title-format'. */
21555 if (mode_line_target
== MODE_LINE_TITLE
)
21558 startpos
= marker_position (w
->start
);
21559 startpos_byte
= marker_byte_position (w
->start
);
21560 height
= WINDOW_TOTAL_LINES (w
);
21562 /* If we decided that this buffer isn't suitable for line numbers,
21563 don't forget that too fast. */
21564 if (EQ (w
->base_line_pos
, w
->buffer
))
21566 /* But do forget it, if the window shows a different buffer now. */
21567 else if (BUFFERP (w
->base_line_pos
))
21568 wset_base_line_pos (w
, Qnil
);
21570 /* If the buffer is very big, don't waste time. */
21571 if (INTEGERP (Vline_number_display_limit
)
21572 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21574 wset_base_line_pos (w
, Qnil
);
21575 wset_base_line_number (w
, Qnil
);
21579 if (INTEGERP (w
->base_line_number
)
21580 && INTEGERP (w
->base_line_pos
)
21581 && XFASTINT (w
->base_line_pos
) <= startpos
)
21583 line
= XFASTINT (w
->base_line_number
);
21584 linepos
= XFASTINT (w
->base_line_pos
);
21585 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21590 linepos
= BUF_BEGV (b
);
21591 linepos_byte
= BUF_BEGV_BYTE (b
);
21594 /* Count lines from base line to window start position. */
21595 nlines
= display_count_lines (linepos_byte
,
21599 topline
= nlines
+ line
;
21601 /* Determine a new base line, if the old one is too close
21602 or too far away, or if we did not have one.
21603 "Too close" means it's plausible a scroll-down would
21604 go back past it. */
21605 if (startpos
== BUF_BEGV (b
))
21607 wset_base_line_number (w
, make_number (topline
));
21608 wset_base_line_pos (w
, make_number (BUF_BEGV (b
)));
21610 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21611 || linepos
== BUF_BEGV (b
))
21613 ptrdiff_t limit
= BUF_BEGV (b
);
21614 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21615 ptrdiff_t position
;
21616 ptrdiff_t distance
=
21617 (height
* 2 + 30) * line_number_display_limit_width
;
21619 if (startpos
- distance
> limit
)
21621 limit
= startpos
- distance
;
21622 limit_byte
= CHAR_TO_BYTE (limit
);
21625 nlines
= display_count_lines (startpos_byte
,
21627 - (height
* 2 + 30),
21629 /* If we couldn't find the lines we wanted within
21630 line_number_display_limit_width chars per line,
21631 give up on line numbers for this window. */
21632 if (position
== limit_byte
&& limit
== startpos
- distance
)
21634 wset_base_line_pos (w
, w
->buffer
);
21635 wset_base_line_number (w
, Qnil
);
21639 wset_base_line_number (w
, make_number (topline
- nlines
));
21640 wset_base_line_pos (w
, make_number (BYTE_TO_CHAR (position
)));
21643 /* Now count lines from the start pos to point. */
21644 nlines
= display_count_lines (startpos_byte
,
21645 PT_BYTE
, PT
, &junk
);
21647 /* Record that we did display the line number. */
21648 line_number_displayed
= 1;
21650 /* Make the string to show. */
21651 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
21652 return decode_mode_spec_buf
;
21655 char* p
= decode_mode_spec_buf
;
21656 int pad
= width
- 2;
21662 return decode_mode_spec_buf
;
21668 obj
= BVAR (b
, mode_name
);
21672 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21678 ptrdiff_t pos
= marker_position (w
->start
);
21679 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21681 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21683 if (pos
<= BUF_BEGV (b
))
21688 else if (pos
<= BUF_BEGV (b
))
21692 if (total
> 1000000)
21693 /* Do it differently for a large value, to avoid overflow. */
21694 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21696 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21697 /* We can't normally display a 3-digit number,
21698 so get us a 2-digit number that is close. */
21701 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21702 return decode_mode_spec_buf
;
21706 /* Display percentage of size above the bottom of the screen. */
21709 ptrdiff_t toppos
= marker_position (w
->start
);
21710 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21711 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21713 if (botpos
>= BUF_ZV (b
))
21715 if (toppos
<= BUF_BEGV (b
))
21722 if (total
> 1000000)
21723 /* Do it differently for a large value, to avoid overflow. */
21724 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21726 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21727 /* We can't normally display a 3-digit number,
21728 so get us a 2-digit number that is close. */
21731 if (toppos
<= BUF_BEGV (b
))
21732 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21734 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21735 return decode_mode_spec_buf
;
21740 /* status of process */
21741 obj
= Fget_buffer_process (Fcurrent_buffer ());
21743 return "no process";
21745 obj
= Fsymbol_name (Fprocess_status (obj
));
21751 ptrdiff_t count
= inhibit_garbage_collection ();
21752 Lisp_Object val
= call1 (intern ("file-remote-p"),
21753 BVAR (current_buffer
, directory
));
21754 unbind_to (count
, Qnil
);
21762 case 't': /* indicate TEXT or BINARY */
21766 /* coding-system (not including end-of-line format) */
21768 /* coding-system (including end-of-line type) */
21770 int eol_flag
= (c
== 'Z');
21771 char *p
= decode_mode_spec_buf
;
21773 if (! FRAME_WINDOW_P (f
))
21775 /* No need to mention EOL here--the terminal never needs
21776 to do EOL conversion. */
21777 p
= decode_mode_spec_coding (CODING_ID_NAME
21778 (FRAME_KEYBOARD_CODING (f
)->id
),
21780 p
= decode_mode_spec_coding (CODING_ID_NAME
21781 (FRAME_TERMINAL_CODING (f
)->id
),
21784 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21787 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21788 #ifdef subprocesses
21789 obj
= Fget_buffer_process (Fcurrent_buffer ());
21790 if (PROCESSP (obj
))
21792 p
= decode_mode_spec_coding
21793 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
21794 p
= decode_mode_spec_coding
21795 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
21797 #endif /* subprocesses */
21800 return decode_mode_spec_buf
;
21807 return SSDATA (obj
);
21814 /* Count up to COUNT lines starting from START_BYTE.
21815 But don't go beyond LIMIT_BYTE.
21816 Return the number of lines thus found (always nonnegative).
21818 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21821 display_count_lines (ptrdiff_t start_byte
,
21822 ptrdiff_t limit_byte
, ptrdiff_t count
,
21823 ptrdiff_t *byte_pos_ptr
)
21825 register unsigned char *cursor
;
21826 unsigned char *base
;
21828 register ptrdiff_t ceiling
;
21829 register unsigned char *ceiling_addr
;
21830 ptrdiff_t orig_count
= count
;
21832 /* If we are not in selective display mode,
21833 check only for newlines. */
21834 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21835 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21839 while (start_byte
< limit_byte
)
21841 ceiling
= BUFFER_CEILING_OF (start_byte
);
21842 ceiling
= min (limit_byte
- 1, ceiling
);
21843 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21844 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21847 if (selective_display
)
21848 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21851 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21854 if (cursor
!= ceiling_addr
)
21858 start_byte
+= cursor
- base
+ 1;
21859 *byte_pos_ptr
= start_byte
;
21863 if (++cursor
== ceiling_addr
)
21869 start_byte
+= cursor
- base
;
21874 while (start_byte
> limit_byte
)
21876 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21877 ceiling
= max (limit_byte
, ceiling
);
21878 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21879 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21882 if (selective_display
)
21883 while (--cursor
!= ceiling_addr
21884 && *cursor
!= '\n' && *cursor
!= 015)
21887 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21890 if (cursor
!= ceiling_addr
)
21894 start_byte
+= cursor
- base
+ 1;
21895 *byte_pos_ptr
= start_byte
;
21896 /* When scanning backwards, we should
21897 not count the newline posterior to which we stop. */
21898 return - orig_count
- 1;
21904 /* Here we add 1 to compensate for the last decrement
21905 of CURSOR, which took it past the valid range. */
21906 start_byte
+= cursor
- base
+ 1;
21910 *byte_pos_ptr
= limit_byte
;
21913 return - orig_count
+ count
;
21914 return orig_count
- count
;
21920 /***********************************************************************
21922 ***********************************************************************/
21924 /* Display a NUL-terminated string, starting with index START.
21926 If STRING is non-null, display that C string. Otherwise, the Lisp
21927 string LISP_STRING is displayed. There's a case that STRING is
21928 non-null and LISP_STRING is not nil. It means STRING is a string
21929 data of LISP_STRING. In that case, we display LISP_STRING while
21930 ignoring its text properties.
21932 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21933 FACE_STRING. Display STRING or LISP_STRING with the face at
21934 FACE_STRING_POS in FACE_STRING:
21936 Display the string in the environment given by IT, but use the
21937 standard display table, temporarily.
21939 FIELD_WIDTH is the minimum number of output glyphs to produce.
21940 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21941 with spaces. If STRING has more characters, more than FIELD_WIDTH
21942 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21944 PRECISION is the maximum number of characters to output from
21945 STRING. PRECISION < 0 means don't truncate the string.
21947 This is roughly equivalent to printf format specifiers:
21949 FIELD_WIDTH PRECISION PRINTF
21950 ----------------------------------------
21956 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21957 display them, and < 0 means obey the current buffer's value of
21958 enable_multibyte_characters.
21960 Value is the number of columns displayed. */
21963 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21964 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
21965 int field_width
, int precision
, int max_x
, int multibyte
)
21967 int hpos_at_start
= it
->hpos
;
21968 int saved_face_id
= it
->face_id
;
21969 struct glyph_row
*row
= it
->glyph_row
;
21970 ptrdiff_t it_charpos
;
21972 /* Initialize the iterator IT for iteration over STRING beginning
21973 with index START. */
21974 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21975 precision
, field_width
, multibyte
);
21976 if (string
&& STRINGP (lisp_string
))
21977 /* LISP_STRING is the one returned by decode_mode_spec. We should
21978 ignore its text properties. */
21979 it
->stop_charpos
= it
->end_charpos
;
21981 /* If displaying STRING, set up the face of the iterator from
21982 FACE_STRING, if that's given. */
21983 if (STRINGP (face_string
))
21989 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21990 0, it
->region_beg_charpos
,
21991 it
->region_end_charpos
,
21992 &endptr
, it
->base_face_id
, 0);
21993 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21994 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21997 /* Set max_x to the maximum allowed X position. Don't let it go
21998 beyond the right edge of the window. */
22000 max_x
= it
->last_visible_x
;
22002 max_x
= min (max_x
, it
->last_visible_x
);
22004 /* Skip over display elements that are not visible. because IT->w is
22006 if (it
->current_x
< it
->first_visible_x
)
22007 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
22008 MOVE_TO_POS
| MOVE_TO_X
);
22010 row
->ascent
= it
->max_ascent
;
22011 row
->height
= it
->max_ascent
+ it
->max_descent
;
22012 row
->phys_ascent
= it
->max_phys_ascent
;
22013 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
22014 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
22016 if (STRINGP (it
->string
))
22017 it_charpos
= IT_STRING_CHARPOS (*it
);
22019 it_charpos
= IT_CHARPOS (*it
);
22021 /* This condition is for the case that we are called with current_x
22022 past last_visible_x. */
22023 while (it
->current_x
< max_x
)
22025 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
22027 /* Get the next display element. */
22028 if (!get_next_display_element (it
))
22031 /* Produce glyphs. */
22032 x_before
= it
->current_x
;
22033 n_glyphs_before
= row
->used
[TEXT_AREA
];
22034 PRODUCE_GLYPHS (it
);
22036 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
22039 while (i
< nglyphs
)
22041 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
22043 if (it
->line_wrap
!= TRUNCATE
22044 && x
+ glyph
->pixel_width
> max_x
)
22046 /* End of continued line or max_x reached. */
22047 if (CHAR_GLYPH_PADDING_P (*glyph
))
22049 /* A wide character is unbreakable. */
22050 if (row
->reversed_p
)
22051 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
22052 - n_glyphs_before
);
22053 row
->used
[TEXT_AREA
] = n_glyphs_before
;
22054 it
->current_x
= x_before
;
22058 if (row
->reversed_p
)
22059 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
22060 - (n_glyphs_before
+ i
));
22061 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
22066 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
22068 /* Glyph is at least partially visible. */
22070 if (x
< it
->first_visible_x
)
22071 row
->x
= x
- it
->first_visible_x
;
22075 /* Glyph is off the left margin of the display area.
22076 Should not happen. */
22080 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
22081 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
22082 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
22083 row
->phys_height
= max (row
->phys_height
,
22084 it
->max_phys_ascent
+ it
->max_phys_descent
);
22085 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
22086 it
->max_extra_line_spacing
);
22087 x
+= glyph
->pixel_width
;
22091 /* Stop if max_x reached. */
22095 /* Stop at line ends. */
22096 if (ITERATOR_AT_END_OF_LINE_P (it
))
22098 it
->continuation_lines_width
= 0;
22102 set_iterator_to_next (it
, 1);
22103 if (STRINGP (it
->string
))
22104 it_charpos
= IT_STRING_CHARPOS (*it
);
22106 it_charpos
= IT_CHARPOS (*it
);
22108 /* Stop if truncating at the right edge. */
22109 if (it
->line_wrap
== TRUNCATE
22110 && it
->current_x
>= it
->last_visible_x
)
22112 /* Add truncation mark, but don't do it if the line is
22113 truncated at a padding space. */
22114 if (it_charpos
< it
->string_nchars
)
22116 if (!FRAME_WINDOW_P (it
->f
))
22120 if (it
->current_x
> it
->last_visible_x
)
22122 if (!row
->reversed_p
)
22124 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
22125 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22130 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
22131 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22133 unproduce_glyphs (it
, ii
+ 1);
22134 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
22136 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
22138 row
->used
[TEXT_AREA
] = ii
;
22139 produce_special_glyphs (it
, IT_TRUNCATION
);
22142 produce_special_glyphs (it
, IT_TRUNCATION
);
22144 row
->truncated_on_right_p
= 1;
22150 /* Maybe insert a truncation at the left. */
22151 if (it
->first_visible_x
22154 if (!FRAME_WINDOW_P (it
->f
)
22155 || (row
->reversed_p
22156 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22157 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
22158 insert_left_trunc_glyphs (it
);
22159 row
->truncated_on_left_p
= 1;
22162 it
->face_id
= saved_face_id
;
22164 /* Value is number of columns displayed. */
22165 return it
->hpos
- hpos_at_start
;
22170 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
22171 appears as an element of LIST or as the car of an element of LIST.
22172 If PROPVAL is a list, compare each element against LIST in that
22173 way, and return 1/2 if any element of PROPVAL is found in LIST.
22174 Otherwise return 0. This function cannot quit.
22175 The return value is 2 if the text is invisible but with an ellipsis
22176 and 1 if it's invisible and without an ellipsis. */
22179 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
22181 register Lisp_Object tail
, proptail
;
22183 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22185 register Lisp_Object tem
;
22187 if (EQ (propval
, tem
))
22189 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
22190 return NILP (XCDR (tem
)) ? 1 : 2;
22193 if (CONSP (propval
))
22195 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
22197 Lisp_Object propelt
;
22198 propelt
= XCAR (proptail
);
22199 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22201 register Lisp_Object tem
;
22203 if (EQ (propelt
, tem
))
22205 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
22206 return NILP (XCDR (tem
)) ? 1 : 2;
22214 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
22215 doc
: /* Non-nil if the property makes the text invisible.
22216 POS-OR-PROP can be a marker or number, in which case it is taken to be
22217 a position in the current buffer and the value of the `invisible' property
22218 is checked; or it can be some other value, which is then presumed to be the
22219 value of the `invisible' property of the text of interest.
22220 The non-nil value returned can be t for truly invisible text or something
22221 else if the text is replaced by an ellipsis. */)
22222 (Lisp_Object pos_or_prop
)
22225 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
22226 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
22228 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
22229 return (invis
== 0 ? Qnil
22231 : make_number (invis
));
22234 /* Calculate a width or height in pixels from a specification using
22235 the following elements:
22238 NUM - a (fractional) multiple of the default font width/height
22239 (NUM) - specifies exactly NUM pixels
22240 UNIT - a fixed number of pixels, see below.
22241 ELEMENT - size of a display element in pixels, see below.
22242 (NUM . SPEC) - equals NUM * SPEC
22243 (+ SPEC SPEC ...) - add pixel values
22244 (- SPEC SPEC ...) - subtract pixel values
22245 (- SPEC) - negate pixel value
22248 INT or FLOAT - a number constant
22249 SYMBOL - use symbol's (buffer local) variable binding.
22252 in - pixels per inch *)
22253 mm - pixels per 1/1000 meter *)
22254 cm - pixels per 1/100 meter *)
22255 width - width of current font in pixels.
22256 height - height of current font in pixels.
22258 *) using the ratio(s) defined in display-pixels-per-inch.
22262 left-fringe - left fringe width in pixels
22263 right-fringe - right fringe width in pixels
22265 left-margin - left margin width in pixels
22266 right-margin - right margin width in pixels
22268 scroll-bar - scroll-bar area width in pixels
22272 Pixels corresponding to 5 inches:
22275 Total width of non-text areas on left side of window (if scroll-bar is on left):
22276 '(space :width (+ left-fringe left-margin scroll-bar))
22278 Align to first text column (in header line):
22279 '(space :align-to 0)
22281 Align to middle of text area minus half the width of variable `my-image'
22282 containing a loaded image:
22283 '(space :align-to (0.5 . (- text my-image)))
22285 Width of left margin minus width of 1 character in the default font:
22286 '(space :width (- left-margin 1))
22288 Width of left margin minus width of 2 characters in the current font:
22289 '(space :width (- left-margin (2 . width)))
22291 Center 1 character over left-margin (in header line):
22292 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22294 Different ways to express width of left fringe plus left margin minus one pixel:
22295 '(space :width (- (+ left-fringe left-margin) (1)))
22296 '(space :width (+ left-fringe left-margin (- (1))))
22297 '(space :width (+ left-fringe left-margin (-1)))
22301 #define NUMVAL(X) \
22302 ((INTEGERP (X) || FLOATP (X)) \
22307 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22308 struct font
*font
, int width_p
, int *align_to
)
22312 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22313 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22316 return OK_PIXELS (0);
22318 eassert (FRAME_LIVE_P (it
->f
));
22320 if (SYMBOLP (prop
))
22322 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22324 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22326 if (unit
[0] == 'i' && unit
[1] == 'n')
22328 else if (unit
[0] == 'm' && unit
[1] == 'm')
22330 else if (unit
[0] == 'c' && unit
[1] == 'm')
22337 #ifdef HAVE_WINDOW_SYSTEM
22338 if (FRAME_WINDOW_P (it
->f
)
22340 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
22341 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
22343 return OK_PIXELS (ppi
/ pixels
);
22346 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
22347 || (CONSP (Vdisplay_pixels_per_inch
)
22349 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
22350 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
22352 return OK_PIXELS (ppi
/ pixels
);
22358 #ifdef HAVE_WINDOW_SYSTEM
22359 if (EQ (prop
, Qheight
))
22360 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22361 if (EQ (prop
, Qwidth
))
22362 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22364 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22365 return OK_PIXELS (1);
22368 if (EQ (prop
, Qtext
))
22369 return OK_PIXELS (width_p
22370 ? window_box_width (it
->w
, TEXT_AREA
)
22371 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22373 if (align_to
&& *align_to
< 0)
22376 if (EQ (prop
, Qleft
))
22377 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22378 if (EQ (prop
, Qright
))
22379 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22380 if (EQ (prop
, Qcenter
))
22381 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22382 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22383 if (EQ (prop
, Qleft_fringe
))
22384 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22385 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22386 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22387 if (EQ (prop
, Qright_fringe
))
22388 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22389 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22390 : window_box_right_offset (it
->w
, TEXT_AREA
));
22391 if (EQ (prop
, Qleft_margin
))
22392 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22393 if (EQ (prop
, Qright_margin
))
22394 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22395 if (EQ (prop
, Qscroll_bar
))
22396 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22398 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22399 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22400 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22405 if (EQ (prop
, Qleft_fringe
))
22406 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22407 if (EQ (prop
, Qright_fringe
))
22408 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22409 if (EQ (prop
, Qleft_margin
))
22410 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22411 if (EQ (prop
, Qright_margin
))
22412 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22413 if (EQ (prop
, Qscroll_bar
))
22414 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22417 prop
= buffer_local_value_1 (prop
, it
->w
->buffer
);
22418 if (EQ (prop
, Qunbound
))
22422 if (INTEGERP (prop
) || FLOATP (prop
))
22424 int base_unit
= (width_p
22425 ? FRAME_COLUMN_WIDTH (it
->f
)
22426 : FRAME_LINE_HEIGHT (it
->f
));
22427 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22432 Lisp_Object car
= XCAR (prop
);
22433 Lisp_Object cdr
= XCDR (prop
);
22437 #ifdef HAVE_WINDOW_SYSTEM
22438 if (FRAME_WINDOW_P (it
->f
)
22439 && valid_image_p (prop
))
22441 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22442 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22444 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22447 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22453 while (CONSP (cdr
))
22455 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22456 font
, width_p
, align_to
))
22459 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22464 if (EQ (car
, Qminus
))
22466 return OK_PIXELS (pixels
);
22469 car
= buffer_local_value_1 (car
, it
->w
->buffer
);
22470 if (EQ (car
, Qunbound
))
22474 if (INTEGERP (car
) || FLOATP (car
))
22477 pixels
= XFLOATINT (car
);
22479 return OK_PIXELS (pixels
);
22480 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22481 font
, width_p
, align_to
))
22482 return OK_PIXELS (pixels
* fact
);
22493 /***********************************************************************
22495 ***********************************************************************/
22497 #ifdef HAVE_WINDOW_SYSTEM
22502 dump_glyph_string (struct glyph_string
*s
)
22504 fprintf (stderr
, "glyph string\n");
22505 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22506 s
->x
, s
->y
, s
->width
, s
->height
);
22507 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22508 fprintf (stderr
, " hl = %d\n", s
->hl
);
22509 fprintf (stderr
, " left overhang = %d, right = %d\n",
22510 s
->left_overhang
, s
->right_overhang
);
22511 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22512 fprintf (stderr
, " extends to end of line = %d\n",
22513 s
->extends_to_end_of_line_p
);
22514 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22515 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22518 #endif /* GLYPH_DEBUG */
22520 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22521 of XChar2b structures for S; it can't be allocated in
22522 init_glyph_string because it must be allocated via `alloca'. W
22523 is the window on which S is drawn. ROW and AREA are the glyph row
22524 and area within the row from which S is constructed. START is the
22525 index of the first glyph structure covered by S. HL is a
22526 face-override for drawing S. */
22529 #define OPTIONAL_HDC(hdc) HDC hdc,
22530 #define DECLARE_HDC(hdc) HDC hdc;
22531 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22532 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22535 #ifndef OPTIONAL_HDC
22536 #define OPTIONAL_HDC(hdc)
22537 #define DECLARE_HDC(hdc)
22538 #define ALLOCATE_HDC(hdc, f)
22539 #define RELEASE_HDC(hdc, f)
22543 init_glyph_string (struct glyph_string
*s
,
22545 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22546 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22548 memset (s
, 0, sizeof *s
);
22550 s
->f
= XFRAME (w
->frame
);
22554 s
->display
= FRAME_X_DISPLAY (s
->f
);
22555 s
->window
= FRAME_X_WINDOW (s
->f
);
22556 s
->char2b
= char2b
;
22560 s
->first_glyph
= row
->glyphs
[area
] + start
;
22561 s
->height
= row
->height
;
22562 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22563 s
->ybase
= s
->y
+ row
->ascent
;
22567 /* Append the list of glyph strings with head H and tail T to the list
22568 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22571 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22572 struct glyph_string
*h
, struct glyph_string
*t
)
22586 /* Prepend the list of glyph strings with head H and tail T to the
22587 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22591 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22592 struct glyph_string
*h
, struct glyph_string
*t
)
22606 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22607 Set *HEAD and *TAIL to the resulting list. */
22610 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22611 struct glyph_string
*s
)
22613 s
->next
= s
->prev
= NULL
;
22614 append_glyph_string_lists (head
, tail
, s
, s
);
22618 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22619 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22620 make sure that X resources for the face returned are allocated.
22621 Value is a pointer to a realized face that is ready for display if
22622 DISPLAY_P is non-zero. */
22624 static struct face
*
22625 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22626 XChar2b
*char2b
, int display_p
)
22628 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22632 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22634 if (code
!= FONT_INVALID_CODE
)
22635 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22637 STORE_XCHAR2B (char2b
, 0, 0);
22640 /* Make sure X resources of the face are allocated. */
22641 #ifdef HAVE_X_WINDOWS
22645 eassert (face
!= NULL
);
22646 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22653 /* Get face and two-byte form of character glyph GLYPH on frame F.
22654 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22655 a pointer to a realized face that is ready for display. */
22657 static struct face
*
22658 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22659 XChar2b
*char2b
, int *two_byte_p
)
22663 eassert (glyph
->type
== CHAR_GLYPH
);
22664 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22673 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22674 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22676 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22678 if (code
!= FONT_INVALID_CODE
)
22679 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22681 STORE_XCHAR2B (char2b
, 0, 0);
22684 /* Make sure X resources of the face are allocated. */
22685 eassert (face
!= NULL
);
22686 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22691 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22692 Return 1 if FONT has a glyph for C, otherwise return 0. */
22695 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22699 if (CHAR_BYTE8_P (c
))
22700 code
= CHAR_TO_BYTE8 (c
);
22702 code
= font
->driver
->encode_char (font
, c
);
22704 if (code
== FONT_INVALID_CODE
)
22706 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22711 /* Fill glyph string S with composition components specified by S->cmp.
22713 BASE_FACE is the base face of the composition.
22714 S->cmp_from is the index of the first component for S.
22716 OVERLAPS non-zero means S should draw the foreground only, and use
22717 its physical height for clipping. See also draw_glyphs.
22719 Value is the index of a component not in S. */
22722 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22726 /* For all glyphs of this composition, starting at the offset
22727 S->cmp_from, until we reach the end of the definition or encounter a
22728 glyph that requires the different face, add it to S. */
22733 s
->for_overlaps
= overlaps
;
22736 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22738 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22740 /* TAB in a composition means display glyphs with padding space
22741 on the left or right. */
22744 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22747 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22754 s
->font
= s
->face
->font
;
22756 else if (s
->face
!= face
)
22764 if (s
->face
== NULL
)
22766 s
->face
= base_face
->ascii_face
;
22767 s
->font
= s
->face
->font
;
22770 /* All glyph strings for the same composition has the same width,
22771 i.e. the width set for the first component of the composition. */
22772 s
->width
= s
->first_glyph
->pixel_width
;
22774 /* If the specified font could not be loaded, use the frame's
22775 default font, but record the fact that we couldn't load it in
22776 the glyph string so that we can draw rectangles for the
22777 characters of the glyph string. */
22778 if (s
->font
== NULL
)
22780 s
->font_not_found_p
= 1;
22781 s
->font
= FRAME_FONT (s
->f
);
22784 /* Adjust base line for subscript/superscript text. */
22785 s
->ybase
+= s
->first_glyph
->voffset
;
22787 /* This glyph string must always be drawn with 16-bit functions. */
22794 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22795 int start
, int end
, int overlaps
)
22797 struct glyph
*glyph
, *last
;
22798 Lisp_Object lgstring
;
22801 s
->for_overlaps
= overlaps
;
22802 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22803 last
= s
->row
->glyphs
[s
->area
] + end
;
22804 s
->cmp_id
= glyph
->u
.cmp
.id
;
22805 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22806 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22807 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22808 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22809 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22811 while (glyph
< last
22812 && glyph
->u
.cmp
.automatic
22813 && glyph
->u
.cmp
.id
== s
->cmp_id
22814 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22815 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22817 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22819 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22820 unsigned code
= LGLYPH_CODE (lglyph
);
22822 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22824 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22825 return glyph
- s
->row
->glyphs
[s
->area
];
22829 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22830 See the comment of fill_glyph_string for arguments.
22831 Value is the index of the first glyph not in S. */
22835 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22836 int start
, int end
, int overlaps
)
22838 struct glyph
*glyph
, *last
;
22841 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22842 s
->for_overlaps
= overlaps
;
22843 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22844 last
= s
->row
->glyphs
[s
->area
] + end
;
22845 voffset
= glyph
->voffset
;
22846 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22847 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
22849 s
->width
= glyph
->pixel_width
;
22851 while (glyph
< last
22852 && glyph
->type
== GLYPHLESS_GLYPH
22853 && glyph
->voffset
== voffset
22854 && glyph
->face_id
== face_id
)
22857 s
->width
+= glyph
->pixel_width
;
22860 s
->ybase
+= voffset
;
22861 return glyph
- s
->row
->glyphs
[s
->area
];
22865 /* Fill glyph string S from a sequence of character glyphs.
22867 FACE_ID is the face id of the string. START is the index of the
22868 first glyph to consider, END is the index of the last + 1.
22869 OVERLAPS non-zero means S should draw the foreground only, and use
22870 its physical height for clipping. See also draw_glyphs.
22872 Value is the index of the first glyph not in S. */
22875 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22876 int start
, int end
, int overlaps
)
22878 struct glyph
*glyph
, *last
;
22880 int glyph_not_available_p
;
22882 eassert (s
->f
== XFRAME (s
->w
->frame
));
22883 eassert (s
->nchars
== 0);
22884 eassert (start
>= 0 && end
> start
);
22886 s
->for_overlaps
= overlaps
;
22887 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22888 last
= s
->row
->glyphs
[s
->area
] + end
;
22889 voffset
= glyph
->voffset
;
22890 s
->padding_p
= glyph
->padding_p
;
22891 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22893 while (glyph
< last
22894 && glyph
->type
== CHAR_GLYPH
22895 && glyph
->voffset
== voffset
22896 /* Same face id implies same font, nowadays. */
22897 && glyph
->face_id
== face_id
22898 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22902 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22903 s
->char2b
+ s
->nchars
,
22905 s
->two_byte_p
= two_byte_p
;
22907 eassert (s
->nchars
<= end
- start
);
22908 s
->width
+= glyph
->pixel_width
;
22909 if (glyph
++->padding_p
!= s
->padding_p
)
22913 s
->font
= s
->face
->font
;
22915 /* If the specified font could not be loaded, use the frame's font,
22916 but record the fact that we couldn't load it in
22917 S->font_not_found_p so that we can draw rectangles for the
22918 characters of the glyph string. */
22919 if (s
->font
== NULL
|| glyph_not_available_p
)
22921 s
->font_not_found_p
= 1;
22922 s
->font
= FRAME_FONT (s
->f
);
22925 /* Adjust base line for subscript/superscript text. */
22926 s
->ybase
+= voffset
;
22928 eassert (s
->face
&& s
->face
->gc
);
22929 return glyph
- s
->row
->glyphs
[s
->area
];
22933 /* Fill glyph string S from image glyph S->first_glyph. */
22936 fill_image_glyph_string (struct glyph_string
*s
)
22938 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22939 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22941 s
->slice
= s
->first_glyph
->slice
.img
;
22942 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22943 s
->font
= s
->face
->font
;
22944 s
->width
= s
->first_glyph
->pixel_width
;
22946 /* Adjust base line for subscript/superscript text. */
22947 s
->ybase
+= s
->first_glyph
->voffset
;
22951 /* Fill glyph string S from a sequence of stretch glyphs.
22953 START is the index of the first glyph to consider,
22954 END is the index of the last + 1.
22956 Value is the index of the first glyph not in S. */
22959 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22961 struct glyph
*glyph
, *last
;
22962 int voffset
, face_id
;
22964 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22966 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22967 last
= s
->row
->glyphs
[s
->area
] + end
;
22968 face_id
= glyph
->face_id
;
22969 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22970 s
->font
= s
->face
->font
;
22971 s
->width
= glyph
->pixel_width
;
22973 voffset
= glyph
->voffset
;
22977 && glyph
->type
== STRETCH_GLYPH
22978 && glyph
->voffset
== voffset
22979 && glyph
->face_id
== face_id
);
22981 s
->width
+= glyph
->pixel_width
;
22983 /* Adjust base line for subscript/superscript text. */
22984 s
->ybase
+= voffset
;
22986 /* The case that face->gc == 0 is handled when drawing the glyph
22987 string by calling PREPARE_FACE_FOR_DISPLAY. */
22989 return glyph
- s
->row
->glyphs
[s
->area
];
22992 static struct font_metrics
*
22993 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22995 static struct font_metrics metrics
;
22996 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22998 if (! font
|| code
== FONT_INVALID_CODE
)
23000 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
23005 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
23006 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
23007 assumed to be zero. */
23010 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
23012 *left
= *right
= 0;
23014 if (glyph
->type
== CHAR_GLYPH
)
23018 struct font_metrics
*pcm
;
23020 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
23021 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
23023 if (pcm
->rbearing
> pcm
->width
)
23024 *right
= pcm
->rbearing
- pcm
->width
;
23025 if (pcm
->lbearing
< 0)
23026 *left
= -pcm
->lbearing
;
23029 else if (glyph
->type
== COMPOSITE_GLYPH
)
23031 if (! glyph
->u
.cmp
.automatic
)
23033 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
23035 if (cmp
->rbearing
> cmp
->pixel_width
)
23036 *right
= cmp
->rbearing
- cmp
->pixel_width
;
23037 if (cmp
->lbearing
< 0)
23038 *left
= - cmp
->lbearing
;
23042 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
23043 struct font_metrics metrics
;
23045 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
23046 glyph
->slice
.cmp
.to
+ 1, &metrics
);
23047 if (metrics
.rbearing
> metrics
.width
)
23048 *right
= metrics
.rbearing
- metrics
.width
;
23049 if (metrics
.lbearing
< 0)
23050 *left
= - metrics
.lbearing
;
23056 /* Return the index of the first glyph preceding glyph string S that
23057 is overwritten by S because of S's left overhang. Value is -1
23058 if no glyphs are overwritten. */
23061 left_overwritten (struct glyph_string
*s
)
23065 if (s
->left_overhang
)
23068 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23069 int first
= s
->first_glyph
- glyphs
;
23071 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
23072 x
-= glyphs
[i
].pixel_width
;
23083 /* Return the index of the first glyph preceding glyph string S that
23084 is overwriting S because of its right overhang. Value is -1 if no
23085 glyph in front of S overwrites S. */
23088 left_overwriting (struct glyph_string
*s
)
23091 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23092 int first
= s
->first_glyph
- glyphs
;
23096 for (i
= first
- 1; i
>= 0; --i
)
23099 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23102 x
-= glyphs
[i
].pixel_width
;
23109 /* Return the index of the last glyph following glyph string S that is
23110 overwritten by S because of S's right overhang. Value is -1 if
23111 no such glyph is found. */
23114 right_overwritten (struct glyph_string
*s
)
23118 if (s
->right_overhang
)
23121 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23122 int first
= (s
->first_glyph
- glyphs
23123 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23124 int end
= s
->row
->used
[s
->area
];
23126 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
23127 x
+= glyphs
[i
].pixel_width
;
23136 /* Return the index of the last glyph following glyph string S that
23137 overwrites S because of its left overhang. Value is negative
23138 if no such glyph is found. */
23141 right_overwriting (struct glyph_string
*s
)
23144 int end
= s
->row
->used
[s
->area
];
23145 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23146 int first
= (s
->first_glyph
- glyphs
23147 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23151 for (i
= first
; i
< end
; ++i
)
23154 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23157 x
+= glyphs
[i
].pixel_width
;
23164 /* Set background width of glyph string S. START is the index of the
23165 first glyph following S. LAST_X is the right-most x-position + 1
23166 in the drawing area. */
23169 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
23171 /* If the face of this glyph string has to be drawn to the end of
23172 the drawing area, set S->extends_to_end_of_line_p. */
23174 if (start
== s
->row
->used
[s
->area
]
23175 && s
->area
== TEXT_AREA
23176 && ((s
->row
->fill_line_p
23177 && (s
->hl
== DRAW_NORMAL_TEXT
23178 || s
->hl
== DRAW_IMAGE_RAISED
23179 || s
->hl
== DRAW_IMAGE_SUNKEN
))
23180 || s
->hl
== DRAW_MOUSE_FACE
))
23181 s
->extends_to_end_of_line_p
= 1;
23183 /* If S extends its face to the end of the line, set its
23184 background_width to the distance to the right edge of the drawing
23186 if (s
->extends_to_end_of_line_p
)
23187 s
->background_width
= last_x
- s
->x
+ 1;
23189 s
->background_width
= s
->width
;
23193 /* Compute overhangs and x-positions for glyph string S and its
23194 predecessors, or successors. X is the starting x-position for S.
23195 BACKWARD_P non-zero means process predecessors. */
23198 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
23204 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23205 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23215 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23216 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23226 /* The following macros are only called from draw_glyphs below.
23227 They reference the following parameters of that function directly:
23228 `w', `row', `area', and `overlap_p'
23229 as well as the following local variables:
23230 `s', `f', and `hdc' (in W32) */
23233 /* On W32, silently add local `hdc' variable to argument list of
23234 init_glyph_string. */
23235 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23236 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23238 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23239 init_glyph_string (s, char2b, w, row, area, start, hl)
23242 /* Add a glyph string for a stretch glyph to the list of strings
23243 between HEAD and TAIL. START is the index of the stretch glyph in
23244 row area AREA of glyph row ROW. END is the index of the last glyph
23245 in that glyph row area. X is the current output position assigned
23246 to the new glyph string constructed. HL overrides that face of the
23247 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23248 is the right-most x-position of the drawing area. */
23250 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23251 and below -- keep them on one line. */
23252 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23255 s = alloca (sizeof *s); \
23256 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23257 START = fill_stretch_glyph_string (s, START, END); \
23258 append_glyph_string (&HEAD, &TAIL, s); \
23264 /* Add a glyph string for an image glyph to the list of strings
23265 between HEAD and TAIL. START is the index of the image glyph in
23266 row area AREA of glyph row ROW. END is the index of the last glyph
23267 in that glyph row area. X is the current output position assigned
23268 to the new glyph string constructed. HL overrides that face of the
23269 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23270 is the right-most x-position of the drawing area. */
23272 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23275 s = alloca (sizeof *s); \
23276 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23277 fill_image_glyph_string (s); \
23278 append_glyph_string (&HEAD, &TAIL, s); \
23285 /* Add a glyph string for a sequence of character glyphs to the list
23286 of strings between HEAD and TAIL. START is the index of the first
23287 glyph in row area AREA of glyph row ROW that is part of the new
23288 glyph string. END is the index of the last glyph in that glyph row
23289 area. X is the current output position assigned to the new glyph
23290 string constructed. HL overrides that face of the glyph; e.g. it
23291 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23292 right-most x-position of the drawing area. */
23294 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23300 face_id = (row)->glyphs[area][START].face_id; \
23302 s = alloca (sizeof *s); \
23303 char2b = alloca ((END - START) * sizeof *char2b); \
23304 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23305 append_glyph_string (&HEAD, &TAIL, s); \
23307 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23312 /* Add a glyph string for a composite sequence to the list of strings
23313 between HEAD and TAIL. START is the index of the first glyph in
23314 row area AREA of glyph row ROW that is part of the new glyph
23315 string. END is the index of the last glyph in that glyph row area.
23316 X is the current output position assigned to the new glyph string
23317 constructed. HL overrides that face of the glyph; e.g. it is
23318 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23319 x-position of the drawing area. */
23321 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23323 int face_id = (row)->glyphs[area][START].face_id; \
23324 struct face *base_face = FACE_FROM_ID (f, face_id); \
23325 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23326 struct composition *cmp = composition_table[cmp_id]; \
23328 struct glyph_string *first_s = NULL; \
23331 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23333 /* Make glyph_strings for each glyph sequence that is drawable by \
23334 the same face, and append them to HEAD/TAIL. */ \
23335 for (n = 0; n < cmp->glyph_len;) \
23337 s = alloca (sizeof *s); \
23338 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23339 append_glyph_string (&(HEAD), &(TAIL), s); \
23345 n = fill_composite_glyph_string (s, base_face, overlaps); \
23353 /* Add a glyph string for a glyph-string sequence to the list of strings
23354 between HEAD and TAIL. */
23356 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23360 Lisp_Object gstring; \
23362 face_id = (row)->glyphs[area][START].face_id; \
23363 gstring = (composition_gstring_from_id \
23364 ((row)->glyphs[area][START].u.cmp.id)); \
23365 s = alloca (sizeof *s); \
23366 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23367 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23368 append_glyph_string (&(HEAD), &(TAIL), s); \
23370 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23374 /* Add a glyph string for a sequence of glyphless character's glyphs
23375 to the list of strings between HEAD and TAIL. The meanings of
23376 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23378 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23383 face_id = (row)->glyphs[area][START].face_id; \
23385 s = alloca (sizeof *s); \
23386 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23387 append_glyph_string (&HEAD, &TAIL, s); \
23389 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23395 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23396 of AREA of glyph row ROW on window W between indices START and END.
23397 HL overrides the face for drawing glyph strings, e.g. it is
23398 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23399 x-positions of the drawing area.
23401 This is an ugly monster macro construct because we must use alloca
23402 to allocate glyph strings (because draw_glyphs can be called
23403 asynchronously). */
23405 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23408 HEAD = TAIL = NULL; \
23409 while (START < END) \
23411 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23412 switch (first_glyph->type) \
23415 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23419 case COMPOSITE_GLYPH: \
23420 if (first_glyph->u.cmp.automatic) \
23421 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23424 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23428 case STRETCH_GLYPH: \
23429 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23433 case IMAGE_GLYPH: \
23434 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23438 case GLYPHLESS_GLYPH: \
23439 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23449 set_glyph_string_background_width (s, START, LAST_X); \
23456 /* Draw glyphs between START and END in AREA of ROW on window W,
23457 starting at x-position X. X is relative to AREA in W. HL is a
23458 face-override with the following meaning:
23460 DRAW_NORMAL_TEXT draw normally
23461 DRAW_CURSOR draw in cursor face
23462 DRAW_MOUSE_FACE draw in mouse face.
23463 DRAW_INVERSE_VIDEO draw in mode line face
23464 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23465 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23467 If OVERLAPS is non-zero, draw only the foreground of characters and
23468 clip to the physical height of ROW. Non-zero value also defines
23469 the overlapping part to be drawn:
23471 OVERLAPS_PRED overlap with preceding rows
23472 OVERLAPS_SUCC overlap with succeeding rows
23473 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23474 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23476 Value is the x-position reached, relative to AREA of W. */
23479 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23480 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23481 enum draw_glyphs_face hl
, int overlaps
)
23483 struct glyph_string
*head
, *tail
;
23484 struct glyph_string
*s
;
23485 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23486 int i
, j
, x_reached
, last_x
, area_left
= 0;
23487 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23490 ALLOCATE_HDC (hdc
, f
);
23492 /* Let's rather be paranoid than getting a SEGV. */
23493 end
= min (end
, row
->used
[area
]);
23494 start
= clip_to_bounds (0, start
, end
);
23496 /* Translate X to frame coordinates. Set last_x to the right
23497 end of the drawing area. */
23498 if (row
->full_width_p
)
23500 /* X is relative to the left edge of W, without scroll bars
23502 area_left
= WINDOW_LEFT_EDGE_X (w
);
23503 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23507 area_left
= window_box_left (w
, area
);
23508 last_x
= area_left
+ window_box_width (w
, area
);
23512 /* Build a doubly-linked list of glyph_string structures between
23513 head and tail from what we have to draw. Note that the macro
23514 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23515 the reason we use a separate variable `i'. */
23517 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23519 x_reached
= tail
->x
+ tail
->background_width
;
23523 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23524 the row, redraw some glyphs in front or following the glyph
23525 strings built above. */
23526 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23528 struct glyph_string
*h
, *t
;
23529 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23530 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23531 int check_mouse_face
= 0;
23534 /* If mouse highlighting is on, we may need to draw adjacent
23535 glyphs using mouse-face highlighting. */
23536 if (area
== TEXT_AREA
&& row
->mouse_face_p
23537 && hlinfo
->mouse_face_beg_row
>= 0
23538 && hlinfo
->mouse_face_end_row
>= 0)
23540 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23542 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23543 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23545 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23547 check_mouse_face
= 1;
23548 mouse_beg_col
= (row
== mouse_beg_row
)
23549 ? hlinfo
->mouse_face_beg_col
: 0;
23550 mouse_end_col
= (row
== mouse_end_row
)
23551 ? hlinfo
->mouse_face_end_col
23552 : row
->used
[TEXT_AREA
];
23556 /* Compute overhangs for all glyph strings. */
23557 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23558 for (s
= head
; s
; s
= s
->next
)
23559 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23561 /* Prepend glyph strings for glyphs in front of the first glyph
23562 string that are overwritten because of the first glyph
23563 string's left overhang. The background of all strings
23564 prepended must be drawn because the first glyph string
23566 i
= left_overwritten (head
);
23569 enum draw_glyphs_face overlap_hl
;
23571 /* If this row contains mouse highlighting, attempt to draw
23572 the overlapped glyphs with the correct highlight. This
23573 code fails if the overlap encompasses more than one glyph
23574 and mouse-highlight spans only some of these glyphs.
23575 However, making it work perfectly involves a lot more
23576 code, and I don't know if the pathological case occurs in
23577 practice, so we'll stick to this for now. --- cyd */
23578 if (check_mouse_face
23579 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23580 overlap_hl
= DRAW_MOUSE_FACE
;
23582 overlap_hl
= DRAW_NORMAL_TEXT
;
23585 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23586 overlap_hl
, dummy_x
, last_x
);
23588 compute_overhangs_and_x (t
, head
->x
, 1);
23589 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23593 /* Prepend glyph strings for glyphs in front of the first glyph
23594 string that overwrite that glyph string because of their
23595 right overhang. For these strings, only the foreground must
23596 be drawn, because it draws over the glyph string at `head'.
23597 The background must not be drawn because this would overwrite
23598 right overhangs of preceding glyphs for which no glyph
23600 i
= left_overwriting (head
);
23603 enum draw_glyphs_face overlap_hl
;
23605 if (check_mouse_face
23606 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23607 overlap_hl
= DRAW_MOUSE_FACE
;
23609 overlap_hl
= DRAW_NORMAL_TEXT
;
23612 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23613 overlap_hl
, dummy_x
, last_x
);
23614 for (s
= h
; s
; s
= s
->next
)
23615 s
->background_filled_p
= 1;
23616 compute_overhangs_and_x (t
, head
->x
, 1);
23617 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23620 /* Append glyphs strings for glyphs following the last glyph
23621 string tail that are overwritten by tail. The background of
23622 these strings has to be drawn because tail's foreground draws
23624 i
= right_overwritten (tail
);
23627 enum draw_glyphs_face overlap_hl
;
23629 if (check_mouse_face
23630 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23631 overlap_hl
= DRAW_MOUSE_FACE
;
23633 overlap_hl
= DRAW_NORMAL_TEXT
;
23635 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23636 overlap_hl
, x
, last_x
);
23637 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23638 we don't have `end = i;' here. */
23639 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23640 append_glyph_string_lists (&head
, &tail
, h
, t
);
23644 /* Append glyph strings for glyphs following the last glyph
23645 string tail that overwrite tail. The foreground of such
23646 glyphs has to be drawn because it writes into the background
23647 of tail. The background must not be drawn because it could
23648 paint over the foreground of following glyphs. */
23649 i
= right_overwriting (tail
);
23652 enum draw_glyphs_face overlap_hl
;
23653 if (check_mouse_face
23654 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23655 overlap_hl
= DRAW_MOUSE_FACE
;
23657 overlap_hl
= DRAW_NORMAL_TEXT
;
23660 i
++; /* We must include the Ith glyph. */
23661 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23662 overlap_hl
, x
, last_x
);
23663 for (s
= h
; s
; s
= s
->next
)
23664 s
->background_filled_p
= 1;
23665 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23666 append_glyph_string_lists (&head
, &tail
, h
, t
);
23668 if (clip_head
|| clip_tail
)
23669 for (s
= head
; s
; s
= s
->next
)
23671 s
->clip_head
= clip_head
;
23672 s
->clip_tail
= clip_tail
;
23676 /* Draw all strings. */
23677 for (s
= head
; s
; s
= s
->next
)
23678 FRAME_RIF (f
)->draw_glyph_string (s
);
23681 /* When focus a sole frame and move horizontally, this sets on_p to 0
23682 causing a failure to erase prev cursor position. */
23683 if (area
== TEXT_AREA
23684 && !row
->full_width_p
23685 /* When drawing overlapping rows, only the glyph strings'
23686 foreground is drawn, which doesn't erase a cursor
23690 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23691 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23692 : (tail
? tail
->x
+ tail
->background_width
: x
));
23696 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23697 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23701 /* Value is the x-position up to which drawn, relative to AREA of W.
23702 This doesn't include parts drawn because of overhangs. */
23703 if (row
->full_width_p
)
23704 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23706 x_reached
-= area_left
;
23708 RELEASE_HDC (hdc
, f
);
23713 /* Expand row matrix if too narrow. Don't expand if area
23716 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23718 if (!fonts_changed_p \
23719 && (it->glyph_row->glyphs[area] \
23720 < it->glyph_row->glyphs[area + 1])) \
23722 it->w->ncols_scale_factor++; \
23723 fonts_changed_p = 1; \
23727 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23728 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23731 append_glyph (struct it
*it
)
23733 struct glyph
*glyph
;
23734 enum glyph_row_area area
= it
->area
;
23736 eassert (it
->glyph_row
);
23737 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23739 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23740 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23742 /* If the glyph row is reversed, we need to prepend the glyph
23743 rather than append it. */
23744 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23748 /* Make room for the additional glyph. */
23749 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23751 glyph
= it
->glyph_row
->glyphs
[area
];
23753 glyph
->charpos
= CHARPOS (it
->position
);
23754 glyph
->object
= it
->object
;
23755 if (it
->pixel_width
> 0)
23757 glyph
->pixel_width
= it
->pixel_width
;
23758 glyph
->padding_p
= 0;
23762 /* Assure at least 1-pixel width. Otherwise, cursor can't
23763 be displayed correctly. */
23764 glyph
->pixel_width
= 1;
23765 glyph
->padding_p
= 1;
23767 glyph
->ascent
= it
->ascent
;
23768 glyph
->descent
= it
->descent
;
23769 glyph
->voffset
= it
->voffset
;
23770 glyph
->type
= CHAR_GLYPH
;
23771 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23772 glyph
->multibyte_p
= it
->multibyte_p
;
23773 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23775 /* In R2L rows, the left and the right box edges need to be
23776 drawn in reverse direction. */
23777 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23778 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23782 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23783 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23785 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23786 || it
->phys_descent
> it
->descent
);
23787 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23788 glyph
->face_id
= it
->face_id
;
23789 glyph
->u
.ch
= it
->char_to_display
;
23790 glyph
->slice
.img
= null_glyph_slice
;
23791 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23794 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23795 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23797 glyph
->bidi_type
= it
->bidi_it
.type
;
23801 glyph
->resolved_level
= 0;
23802 glyph
->bidi_type
= UNKNOWN_BT
;
23804 ++it
->glyph_row
->used
[area
];
23807 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23810 /* Store one glyph for the composition IT->cmp_it.id in
23811 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23815 append_composite_glyph (struct it
*it
)
23817 struct glyph
*glyph
;
23818 enum glyph_row_area area
= it
->area
;
23820 eassert (it
->glyph_row
);
23822 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23823 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23825 /* If the glyph row is reversed, we need to prepend the glyph
23826 rather than append it. */
23827 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23831 /* Make room for the new glyph. */
23832 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23834 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23836 glyph
->charpos
= it
->cmp_it
.charpos
;
23837 glyph
->object
= it
->object
;
23838 glyph
->pixel_width
= it
->pixel_width
;
23839 glyph
->ascent
= it
->ascent
;
23840 glyph
->descent
= it
->descent
;
23841 glyph
->voffset
= it
->voffset
;
23842 glyph
->type
= COMPOSITE_GLYPH
;
23843 if (it
->cmp_it
.ch
< 0)
23845 glyph
->u
.cmp
.automatic
= 0;
23846 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23847 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23851 glyph
->u
.cmp
.automatic
= 1;
23852 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23853 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23854 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23856 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23857 glyph
->multibyte_p
= it
->multibyte_p
;
23858 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23860 /* In R2L rows, the left and the right box edges need to be
23861 drawn in reverse direction. */
23862 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23863 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23867 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23868 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23870 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23871 || it
->phys_descent
> it
->descent
);
23872 glyph
->padding_p
= 0;
23873 glyph
->glyph_not_available_p
= 0;
23874 glyph
->face_id
= it
->face_id
;
23875 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23878 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23879 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23881 glyph
->bidi_type
= it
->bidi_it
.type
;
23883 ++it
->glyph_row
->used
[area
];
23886 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23890 /* Change IT->ascent and IT->height according to the setting of
23894 take_vertical_position_into_account (struct it
*it
)
23898 if (it
->voffset
< 0)
23899 /* Increase the ascent so that we can display the text higher
23901 it
->ascent
-= it
->voffset
;
23903 /* Increase the descent so that we can display the text lower
23905 it
->descent
+= it
->voffset
;
23910 /* Produce glyphs/get display metrics for the image IT is loaded with.
23911 See the description of struct display_iterator in dispextern.h for
23912 an overview of struct display_iterator. */
23915 produce_image_glyph (struct it
*it
)
23919 int glyph_ascent
, crop
;
23920 struct glyph_slice slice
;
23922 eassert (it
->what
== IT_IMAGE
);
23924 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23926 /* Make sure X resources of the face is loaded. */
23927 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23929 if (it
->image_id
< 0)
23931 /* Fringe bitmap. */
23932 it
->ascent
= it
->phys_ascent
= 0;
23933 it
->descent
= it
->phys_descent
= 0;
23934 it
->pixel_width
= 0;
23939 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23941 /* Make sure X resources of the image is loaded. */
23942 prepare_image_for_display (it
->f
, img
);
23944 slice
.x
= slice
.y
= 0;
23945 slice
.width
= img
->width
;
23946 slice
.height
= img
->height
;
23948 if (INTEGERP (it
->slice
.x
))
23949 slice
.x
= XINT (it
->slice
.x
);
23950 else if (FLOATP (it
->slice
.x
))
23951 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23953 if (INTEGERP (it
->slice
.y
))
23954 slice
.y
= XINT (it
->slice
.y
);
23955 else if (FLOATP (it
->slice
.y
))
23956 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23958 if (INTEGERP (it
->slice
.width
))
23959 slice
.width
= XINT (it
->slice
.width
);
23960 else if (FLOATP (it
->slice
.width
))
23961 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23963 if (INTEGERP (it
->slice
.height
))
23964 slice
.height
= XINT (it
->slice
.height
);
23965 else if (FLOATP (it
->slice
.height
))
23966 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23968 if (slice
.x
>= img
->width
)
23969 slice
.x
= img
->width
;
23970 if (slice
.y
>= img
->height
)
23971 slice
.y
= img
->height
;
23972 if (slice
.x
+ slice
.width
>= img
->width
)
23973 slice
.width
= img
->width
- slice
.x
;
23974 if (slice
.y
+ slice
.height
> img
->height
)
23975 slice
.height
= img
->height
- slice
.y
;
23977 if (slice
.width
== 0 || slice
.height
== 0)
23980 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23982 it
->descent
= slice
.height
- glyph_ascent
;
23984 it
->descent
+= img
->vmargin
;
23985 if (slice
.y
+ slice
.height
== img
->height
)
23986 it
->descent
+= img
->vmargin
;
23987 it
->phys_descent
= it
->descent
;
23989 it
->pixel_width
= slice
.width
;
23991 it
->pixel_width
+= img
->hmargin
;
23992 if (slice
.x
+ slice
.width
== img
->width
)
23993 it
->pixel_width
+= img
->hmargin
;
23995 /* It's quite possible for images to have an ascent greater than
23996 their height, so don't get confused in that case. */
23997 if (it
->descent
< 0)
24002 if (face
->box
!= FACE_NO_BOX
)
24004 if (face
->box_line_width
> 0)
24007 it
->ascent
+= face
->box_line_width
;
24008 if (slice
.y
+ slice
.height
== img
->height
)
24009 it
->descent
+= face
->box_line_width
;
24012 if (it
->start_of_box_run_p
&& slice
.x
== 0)
24013 it
->pixel_width
+= eabs (face
->box_line_width
);
24014 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
24015 it
->pixel_width
+= eabs (face
->box_line_width
);
24018 take_vertical_position_into_account (it
);
24020 /* Automatically crop wide image glyphs at right edge so we can
24021 draw the cursor on same display row. */
24022 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
24023 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
24025 it
->pixel_width
-= crop
;
24026 slice
.width
-= crop
;
24031 struct glyph
*glyph
;
24032 enum glyph_row_area area
= it
->area
;
24034 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24035 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24037 glyph
->charpos
= CHARPOS (it
->position
);
24038 glyph
->object
= it
->object
;
24039 glyph
->pixel_width
= it
->pixel_width
;
24040 glyph
->ascent
= glyph_ascent
;
24041 glyph
->descent
= it
->descent
;
24042 glyph
->voffset
= it
->voffset
;
24043 glyph
->type
= IMAGE_GLYPH
;
24044 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24045 glyph
->multibyte_p
= it
->multibyte_p
;
24046 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24048 /* In R2L rows, the left and the right box edges need to be
24049 drawn in reverse direction. */
24050 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24051 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24055 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24056 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24058 glyph
->overlaps_vertically_p
= 0;
24059 glyph
->padding_p
= 0;
24060 glyph
->glyph_not_available_p
= 0;
24061 glyph
->face_id
= it
->face_id
;
24062 glyph
->u
.img_id
= img
->id
;
24063 glyph
->slice
.img
= slice
;
24064 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24067 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24068 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24070 glyph
->bidi_type
= it
->bidi_it
.type
;
24072 ++it
->glyph_row
->used
[area
];
24075 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24080 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
24081 of the glyph, WIDTH and HEIGHT are the width and height of the
24082 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
24085 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
24086 int width
, int height
, int ascent
)
24088 struct glyph
*glyph
;
24089 enum glyph_row_area area
= it
->area
;
24091 eassert (ascent
>= 0 && ascent
<= height
);
24093 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24094 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24096 /* If the glyph row is reversed, we need to prepend the glyph
24097 rather than append it. */
24098 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24102 /* Make room for the additional glyph. */
24103 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24105 glyph
= it
->glyph_row
->glyphs
[area
];
24107 glyph
->charpos
= CHARPOS (it
->position
);
24108 glyph
->object
= object
;
24109 glyph
->pixel_width
= width
;
24110 glyph
->ascent
= ascent
;
24111 glyph
->descent
= height
- ascent
;
24112 glyph
->voffset
= it
->voffset
;
24113 glyph
->type
= STRETCH_GLYPH
;
24114 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24115 glyph
->multibyte_p
= it
->multibyte_p
;
24116 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24118 /* In R2L rows, the left and the right box edges need to be
24119 drawn in reverse direction. */
24120 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24121 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24125 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24126 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24128 glyph
->overlaps_vertically_p
= 0;
24129 glyph
->padding_p
= 0;
24130 glyph
->glyph_not_available_p
= 0;
24131 glyph
->face_id
= it
->face_id
;
24132 glyph
->u
.stretch
.ascent
= ascent
;
24133 glyph
->u
.stretch
.height
= height
;
24134 glyph
->slice
.img
= null_glyph_slice
;
24135 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24138 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24139 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24141 glyph
->bidi_type
= it
->bidi_it
.type
;
24145 glyph
->resolved_level
= 0;
24146 glyph
->bidi_type
= UNKNOWN_BT
;
24148 ++it
->glyph_row
->used
[area
];
24151 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24154 #endif /* HAVE_WINDOW_SYSTEM */
24156 /* Produce a stretch glyph for iterator IT. IT->object is the value
24157 of the glyph property displayed. The value must be a list
24158 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
24161 1. `:width WIDTH' specifies that the space should be WIDTH *
24162 canonical char width wide. WIDTH may be an integer or floating
24165 2. `:relative-width FACTOR' specifies that the width of the stretch
24166 should be computed from the width of the first character having the
24167 `glyph' property, and should be FACTOR times that width.
24169 3. `:align-to HPOS' specifies that the space should be wide enough
24170 to reach HPOS, a value in canonical character units.
24172 Exactly one of the above pairs must be present.
24174 4. `:height HEIGHT' specifies that the height of the stretch produced
24175 should be HEIGHT, measured in canonical character units.
24177 5. `:relative-height FACTOR' specifies that the height of the
24178 stretch should be FACTOR times the height of the characters having
24179 the glyph property.
24181 Either none or exactly one of 4 or 5 must be present.
24183 6. `:ascent ASCENT' specifies that ASCENT percent of the height
24184 of the stretch should be used for the ascent of the stretch.
24185 ASCENT must be in the range 0 <= ASCENT <= 100. */
24188 produce_stretch_glyph (struct it
*it
)
24190 /* (space :width WIDTH :height HEIGHT ...) */
24191 Lisp_Object prop
, plist
;
24192 int width
= 0, height
= 0, align_to
= -1;
24193 int zero_width_ok_p
= 0;
24195 struct font
*font
= NULL
;
24197 #ifdef HAVE_WINDOW_SYSTEM
24199 int zero_height_ok_p
= 0;
24201 if (FRAME_WINDOW_P (it
->f
))
24203 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24204 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24205 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24209 /* List should start with `space'. */
24210 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
24211 plist
= XCDR (it
->object
);
24213 /* Compute the width of the stretch. */
24214 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
24215 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
24217 /* Absolute width `:width WIDTH' specified and valid. */
24218 zero_width_ok_p
= 1;
24221 #ifdef HAVE_WINDOW_SYSTEM
24222 else if (FRAME_WINDOW_P (it
->f
)
24223 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
24225 /* Relative width `:relative-width FACTOR' specified and valid.
24226 Compute the width of the characters having the `glyph'
24229 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
24232 if (it
->multibyte_p
)
24233 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
24236 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
24237 if (! ASCII_CHAR_P (it2
.c
))
24238 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
24241 it2
.glyph_row
= NULL
;
24242 it2
.what
= IT_CHARACTER
;
24243 x_produce_glyphs (&it2
);
24244 width
= NUMVAL (prop
) * it2
.pixel_width
;
24246 #endif /* HAVE_WINDOW_SYSTEM */
24247 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
24248 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
24250 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
24251 align_to
= (align_to
< 0
24253 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
24254 else if (align_to
< 0)
24255 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
24256 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
24257 zero_width_ok_p
= 1;
24260 /* Nothing specified -> width defaults to canonical char width. */
24261 width
= FRAME_COLUMN_WIDTH (it
->f
);
24263 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
24266 #ifdef HAVE_WINDOW_SYSTEM
24267 /* Compute height. */
24268 if (FRAME_WINDOW_P (it
->f
))
24270 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
24271 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24274 zero_height_ok_p
= 1;
24276 else if (prop
= Fplist_get (plist
, QCrelative_height
),
24278 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
24280 height
= FONT_HEIGHT (font
);
24282 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
24285 /* Compute percentage of height used for ascent. If
24286 `:ascent ASCENT' is present and valid, use that. Otherwise,
24287 derive the ascent from the font in use. */
24288 if (prop
= Fplist_get (plist
, QCascent
),
24289 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
24290 ascent
= height
* NUMVAL (prop
) / 100.0;
24291 else if (!NILP (prop
)
24292 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24293 ascent
= min (max (0, (int)tem
), height
);
24295 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
24298 #endif /* HAVE_WINDOW_SYSTEM */
24301 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24302 && it
->current_x
+ width
> it
->last_visible_x
)
24304 width
= it
->last_visible_x
- it
->current_x
;
24305 #ifdef HAVE_WINDOW_SYSTEM
24306 /* Subtract one more pixel from the stretch width, but only on
24307 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24308 width
-= FRAME_WINDOW_P (it
->f
);
24312 if (width
> 0 && height
> 0 && it
->glyph_row
)
24314 Lisp_Object o_object
= it
->object
;
24315 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24318 if (!STRINGP (object
))
24319 object
= it
->w
->buffer
;
24320 #ifdef HAVE_WINDOW_SYSTEM
24321 if (FRAME_WINDOW_P (it
->f
))
24322 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24326 it
->object
= object
;
24327 it
->char_to_display
= ' ';
24328 it
->pixel_width
= it
->len
= 1;
24330 tty_append_glyph (it
);
24331 it
->object
= o_object
;
24335 it
->pixel_width
= width
;
24336 #ifdef HAVE_WINDOW_SYSTEM
24337 if (FRAME_WINDOW_P (it
->f
))
24339 it
->ascent
= it
->phys_ascent
= ascent
;
24340 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24341 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24342 take_vertical_position_into_account (it
);
24346 it
->nglyphs
= width
;
24349 /* Get information about special display element WHAT in an
24350 environment described by IT. WHAT is one of IT_TRUNCATION or
24351 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24352 non-null glyph_row member. This function ensures that fields like
24353 face_id, c, len of IT are left untouched. */
24356 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
24363 temp_it
.object
= make_number (0);
24364 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
24366 if (what
== IT_CONTINUATION
)
24368 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24369 if (it
->bidi_it
.paragraph_dir
== R2L
)
24370 SET_GLYPH_FROM_CHAR (glyph
, '/');
24372 SET_GLYPH_FROM_CHAR (glyph
, '\\');
24374 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24376 /* FIXME: Should we mirror GC for R2L lines? */
24377 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24378 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24381 else if (what
== IT_TRUNCATION
)
24383 /* Truncation glyph. */
24384 SET_GLYPH_FROM_CHAR (glyph
, '$');
24386 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24388 /* FIXME: Should we mirror GC for R2L lines? */
24389 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24390 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24396 #ifdef HAVE_WINDOW_SYSTEM
24397 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24398 is turned off, we precede the truncation/continuation glyphs by a
24399 stretch glyph whose width is computed such that these special
24400 glyphs are aligned at the window margin, even when very different
24401 fonts are used in different glyph rows. */
24402 if (FRAME_WINDOW_P (temp_it
.f
)
24403 /* init_iterator calls this with it->glyph_row == NULL, and it
24404 wants only the pixel width of the truncation/continuation
24406 && temp_it
.glyph_row
24407 /* insert_left_trunc_glyphs calls us at the beginning of the
24408 row, and it has its own calculation of the stretch glyph
24410 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
24411 && (temp_it
.glyph_row
->reversed_p
24412 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
24413 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
24415 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
24417 if (stretch_width
> 0)
24419 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
24420 struct font
*font
=
24421 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
24422 int stretch_ascent
=
24423 (((temp_it
.ascent
+ temp_it
.descent
)
24424 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
24426 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
24427 temp_it
.ascent
+ temp_it
.descent
,
24434 temp_it
.what
= IT_CHARACTER
;
24436 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
24437 temp_it
.face_id
= GLYPH_FACE (glyph
);
24438 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
24440 PRODUCE_GLYPHS (&temp_it
);
24441 it
->pixel_width
= temp_it
.pixel_width
;
24442 it
->nglyphs
= temp_it
.pixel_width
;
24445 #ifdef HAVE_WINDOW_SYSTEM
24447 /* Calculate line-height and line-spacing properties.
24448 An integer value specifies explicit pixel value.
24449 A float value specifies relative value to current face height.
24450 A cons (float . face-name) specifies relative value to
24451 height of specified face font.
24453 Returns height in pixels, or nil. */
24457 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24458 int boff
, int override
)
24460 Lisp_Object face_name
= Qnil
;
24461 int ascent
, descent
, height
;
24463 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24468 face_name
= XCAR (val
);
24470 if (!NUMBERP (val
))
24471 val
= make_number (1);
24472 if (NILP (face_name
))
24474 height
= it
->ascent
+ it
->descent
;
24479 if (NILP (face_name
))
24481 font
= FRAME_FONT (it
->f
);
24482 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24484 else if (EQ (face_name
, Qt
))
24493 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24495 return make_number (-1);
24497 face
= FACE_FROM_ID (it
->f
, face_id
);
24500 return make_number (-1);
24501 boff
= font
->baseline_offset
;
24502 if (font
->vertical_centering
)
24503 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24506 ascent
= FONT_BASE (font
) + boff
;
24507 descent
= FONT_DESCENT (font
) - boff
;
24511 it
->override_ascent
= ascent
;
24512 it
->override_descent
= descent
;
24513 it
->override_boff
= boff
;
24516 height
= ascent
+ descent
;
24520 height
= (int)(XFLOAT_DATA (val
) * height
);
24521 else if (INTEGERP (val
))
24522 height
*= XINT (val
);
24524 return make_number (height
);
24528 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24529 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24530 and only if this is for a character for which no font was found.
24532 If the display method (it->glyphless_method) is
24533 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24534 length of the acronym or the hexadecimal string, UPPER_XOFF and
24535 UPPER_YOFF are pixel offsets for the upper part of the string,
24536 LOWER_XOFF and LOWER_YOFF are for the lower part.
24538 For the other display methods, LEN through LOWER_YOFF are zero. */
24541 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24542 short upper_xoff
, short upper_yoff
,
24543 short lower_xoff
, short lower_yoff
)
24545 struct glyph
*glyph
;
24546 enum glyph_row_area area
= it
->area
;
24548 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24549 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24551 /* If the glyph row is reversed, we need to prepend the glyph
24552 rather than append it. */
24553 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24557 /* Make room for the additional glyph. */
24558 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24560 glyph
= it
->glyph_row
->glyphs
[area
];
24562 glyph
->charpos
= CHARPOS (it
->position
);
24563 glyph
->object
= it
->object
;
24564 glyph
->pixel_width
= it
->pixel_width
;
24565 glyph
->ascent
= it
->ascent
;
24566 glyph
->descent
= it
->descent
;
24567 glyph
->voffset
= it
->voffset
;
24568 glyph
->type
= GLYPHLESS_GLYPH
;
24569 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24570 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24571 glyph
->u
.glyphless
.len
= len
;
24572 glyph
->u
.glyphless
.ch
= it
->c
;
24573 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24574 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24575 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24576 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24577 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24578 glyph
->multibyte_p
= it
->multibyte_p
;
24579 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24581 /* In R2L rows, the left and the right box edges need to be
24582 drawn in reverse direction. */
24583 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24584 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24588 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24589 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24591 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24592 || it
->phys_descent
> it
->descent
);
24593 glyph
->padding_p
= 0;
24594 glyph
->glyph_not_available_p
= 0;
24595 glyph
->face_id
= face_id
;
24596 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24599 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24600 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24602 glyph
->bidi_type
= it
->bidi_it
.type
;
24604 ++it
->glyph_row
->used
[area
];
24607 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24611 /* Produce a glyph for a glyphless character for iterator IT.
24612 IT->glyphless_method specifies which method to use for displaying
24613 the character. See the description of enum
24614 glyphless_display_method in dispextern.h for the detail.
24616 FOR_NO_FONT is nonzero if and only if this is for a character for
24617 which no font was found. ACRONYM, if non-nil, is an acronym string
24618 for the character. */
24621 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24626 int base_width
, base_height
, width
, height
;
24627 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24630 /* Get the metrics of the base font. We always refer to the current
24632 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24633 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24634 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24635 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24636 base_height
= it
->ascent
+ it
->descent
;
24637 base_width
= font
->average_width
;
24639 /* Get a face ID for the glyph by utilizing a cache (the same way as
24640 done for `escape-glyph' in get_next_display_element). */
24641 if (it
->f
== last_glyphless_glyph_frame
24642 && it
->face_id
== last_glyphless_glyph_face_id
)
24644 face_id
= last_glyphless_glyph_merged_face_id
;
24648 /* Merge the `glyphless-char' face into the current face. */
24649 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24650 last_glyphless_glyph_frame
= it
->f
;
24651 last_glyphless_glyph_face_id
= it
->face_id
;
24652 last_glyphless_glyph_merged_face_id
= face_id
;
24655 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24657 it
->pixel_width
= THIN_SPACE_WIDTH
;
24659 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24661 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24663 width
= CHAR_WIDTH (it
->c
);
24666 else if (width
> 4)
24668 it
->pixel_width
= base_width
* width
;
24670 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24676 unsigned int code
[6];
24678 int ascent
, descent
;
24679 struct font_metrics metrics_upper
, metrics_lower
;
24681 face
= FACE_FROM_ID (it
->f
, face_id
);
24682 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24683 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24685 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24687 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24688 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24689 if (CONSP (acronym
))
24690 acronym
= XCAR (acronym
);
24691 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24695 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24696 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24699 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24700 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24701 upper_len
= (len
+ 1) / 2;
24702 font
->driver
->text_extents (font
, code
, upper_len
,
24704 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24709 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24710 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24711 upper_xoff
= upper_yoff
= 2; /* the typical case */
24712 if (base_width
>= width
)
24714 /* Align the upper to the left, the lower to the right. */
24715 it
->pixel_width
= base_width
;
24716 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24720 /* Center the shorter one. */
24721 it
->pixel_width
= width
;
24722 if (metrics_upper
.width
>= metrics_lower
.width
)
24723 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24726 /* FIXME: This code doesn't look right. It formerly was
24727 missing the "lower_xoff = 0;", which couldn't have
24728 been right since it left lower_xoff uninitialized. */
24730 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24734 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24735 top, bottom, and between upper and lower strings. */
24736 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24737 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24738 /* Center vertically.
24739 H:base_height, D:base_descent
24740 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24742 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24743 descent = D - H/2 + h/2;
24744 lower_yoff = descent - 2 - ld;
24745 upper_yoff = lower_yoff - la - 1 - ud; */
24746 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24747 descent
= it
->descent
- (base_height
- height
) / 2;
24748 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24749 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24750 - metrics_upper
.descent
);
24751 /* Don't make the height shorter than the base height. */
24752 if (height
> base_height
)
24754 it
->ascent
= ascent
;
24755 it
->descent
= descent
;
24759 it
->phys_ascent
= it
->ascent
;
24760 it
->phys_descent
= it
->descent
;
24762 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24763 upper_xoff
, upper_yoff
,
24764 lower_xoff
, lower_yoff
);
24766 take_vertical_position_into_account (it
);
24771 Produce glyphs/get display metrics for the display element IT is
24772 loaded with. See the description of struct it in dispextern.h
24773 for an overview of struct it. */
24776 x_produce_glyphs (struct it
*it
)
24778 int extra_line_spacing
= it
->extra_line_spacing
;
24780 it
->glyph_not_available_p
= 0;
24782 if (it
->what
== IT_CHARACTER
)
24785 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24786 struct font
*font
= face
->font
;
24787 struct font_metrics
*pcm
= NULL
;
24788 int boff
; /* baseline offset */
24792 /* When no suitable font is found, display this character by
24793 the method specified in the first extra slot of
24794 Vglyphless_char_display. */
24795 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24797 eassert (it
->what
== IT_GLYPHLESS
);
24798 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24802 boff
= font
->baseline_offset
;
24803 if (font
->vertical_centering
)
24804 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24806 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24812 if (it
->override_ascent
>= 0)
24814 it
->ascent
= it
->override_ascent
;
24815 it
->descent
= it
->override_descent
;
24816 boff
= it
->override_boff
;
24820 it
->ascent
= FONT_BASE (font
) + boff
;
24821 it
->descent
= FONT_DESCENT (font
) - boff
;
24824 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24826 pcm
= get_per_char_metric (font
, &char2b
);
24827 if (pcm
->width
== 0
24828 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24834 it
->phys_ascent
= pcm
->ascent
+ boff
;
24835 it
->phys_descent
= pcm
->descent
- boff
;
24836 it
->pixel_width
= pcm
->width
;
24840 it
->glyph_not_available_p
= 1;
24841 it
->phys_ascent
= it
->ascent
;
24842 it
->phys_descent
= it
->descent
;
24843 it
->pixel_width
= font
->space_width
;
24846 if (it
->constrain_row_ascent_descent_p
)
24848 if (it
->descent
> it
->max_descent
)
24850 it
->ascent
+= it
->descent
- it
->max_descent
;
24851 it
->descent
= it
->max_descent
;
24853 if (it
->ascent
> it
->max_ascent
)
24855 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24856 it
->ascent
= it
->max_ascent
;
24858 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24859 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24860 extra_line_spacing
= 0;
24863 /* If this is a space inside a region of text with
24864 `space-width' property, change its width. */
24865 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24867 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24869 /* If face has a box, add the box thickness to the character
24870 height. If character has a box line to the left and/or
24871 right, add the box line width to the character's width. */
24872 if (face
->box
!= FACE_NO_BOX
)
24874 int thick
= face
->box_line_width
;
24878 it
->ascent
+= thick
;
24879 it
->descent
+= thick
;
24884 if (it
->start_of_box_run_p
)
24885 it
->pixel_width
+= thick
;
24886 if (it
->end_of_box_run_p
)
24887 it
->pixel_width
+= thick
;
24890 /* If face has an overline, add the height of the overline
24891 (1 pixel) and a 1 pixel margin to the character height. */
24892 if (face
->overline_p
)
24893 it
->ascent
+= overline_margin
;
24895 if (it
->constrain_row_ascent_descent_p
)
24897 if (it
->ascent
> it
->max_ascent
)
24898 it
->ascent
= it
->max_ascent
;
24899 if (it
->descent
> it
->max_descent
)
24900 it
->descent
= it
->max_descent
;
24903 take_vertical_position_into_account (it
);
24905 /* If we have to actually produce glyphs, do it. */
24910 /* Translate a space with a `space-width' property
24911 into a stretch glyph. */
24912 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24913 / FONT_HEIGHT (font
));
24914 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24915 it
->ascent
+ it
->descent
, ascent
);
24920 /* If characters with lbearing or rbearing are displayed
24921 in this line, record that fact in a flag of the
24922 glyph row. This is used to optimize X output code. */
24923 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24924 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24926 if (! stretched_p
&& it
->pixel_width
== 0)
24927 /* We assure that all visible glyphs have at least 1-pixel
24929 it
->pixel_width
= 1;
24931 else if (it
->char_to_display
== '\n')
24933 /* A newline has no width, but we need the height of the
24934 line. But if previous part of the line sets a height,
24935 don't increase that height */
24937 Lisp_Object height
;
24938 Lisp_Object total_height
= Qnil
;
24940 it
->override_ascent
= -1;
24941 it
->pixel_width
= 0;
24944 height
= get_it_property (it
, Qline_height
);
24945 /* Split (line-height total-height) list */
24947 && CONSP (XCDR (height
))
24948 && NILP (XCDR (XCDR (height
))))
24950 total_height
= XCAR (XCDR (height
));
24951 height
= XCAR (height
);
24953 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24955 if (it
->override_ascent
>= 0)
24957 it
->ascent
= it
->override_ascent
;
24958 it
->descent
= it
->override_descent
;
24959 boff
= it
->override_boff
;
24963 it
->ascent
= FONT_BASE (font
) + boff
;
24964 it
->descent
= FONT_DESCENT (font
) - boff
;
24967 if (EQ (height
, Qt
))
24969 if (it
->descent
> it
->max_descent
)
24971 it
->ascent
+= it
->descent
- it
->max_descent
;
24972 it
->descent
= it
->max_descent
;
24974 if (it
->ascent
> it
->max_ascent
)
24976 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24977 it
->ascent
= it
->max_ascent
;
24979 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24980 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24981 it
->constrain_row_ascent_descent_p
= 1;
24982 extra_line_spacing
= 0;
24986 Lisp_Object spacing
;
24988 it
->phys_ascent
= it
->ascent
;
24989 it
->phys_descent
= it
->descent
;
24991 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24992 && face
->box
!= FACE_NO_BOX
24993 && face
->box_line_width
> 0)
24995 it
->ascent
+= face
->box_line_width
;
24996 it
->descent
+= face
->box_line_width
;
24999 && XINT (height
) > it
->ascent
+ it
->descent
)
25000 it
->ascent
= XINT (height
) - it
->descent
;
25002 if (!NILP (total_height
))
25003 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
25006 spacing
= get_it_property (it
, Qline_spacing
);
25007 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
25009 if (INTEGERP (spacing
))
25011 extra_line_spacing
= XINT (spacing
);
25012 if (!NILP (total_height
))
25013 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
25017 else /* i.e. (it->char_to_display == '\t') */
25019 if (font
->space_width
> 0)
25021 int tab_width
= it
->tab_width
* font
->space_width
;
25022 int x
= it
->current_x
+ it
->continuation_lines_width
;
25023 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
25025 /* If the distance from the current position to the next tab
25026 stop is less than a space character width, use the
25027 tab stop after that. */
25028 if (next_tab_x
- x
< font
->space_width
)
25029 next_tab_x
+= tab_width
;
25031 it
->pixel_width
= next_tab_x
- x
;
25033 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
25034 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
25038 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
25039 it
->ascent
+ it
->descent
, it
->ascent
);
25044 it
->pixel_width
= 0;
25049 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
25051 /* A static composition.
25053 Note: A composition is represented as one glyph in the
25054 glyph matrix. There are no padding glyphs.
25056 Important note: pixel_width, ascent, and descent are the
25057 values of what is drawn by draw_glyphs (i.e. the values of
25058 the overall glyphs composed). */
25059 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25060 int boff
; /* baseline offset */
25061 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
25062 int glyph_len
= cmp
->glyph_len
;
25063 struct font
*font
= face
->font
;
25067 /* If we have not yet calculated pixel size data of glyphs of
25068 the composition for the current face font, calculate them
25069 now. Theoretically, we have to check all fonts for the
25070 glyphs, but that requires much time and memory space. So,
25071 here we check only the font of the first glyph. This may
25072 lead to incorrect display, but it's very rare, and C-l
25073 (recenter-top-bottom) can correct the display anyway. */
25074 if (! cmp
->font
|| cmp
->font
!= font
)
25076 /* Ascent and descent of the font of the first character
25077 of this composition (adjusted by baseline offset).
25078 Ascent and descent of overall glyphs should not be less
25079 than these, respectively. */
25080 int font_ascent
, font_descent
, font_height
;
25081 /* Bounding box of the overall glyphs. */
25082 int leftmost
, rightmost
, lowest
, highest
;
25083 int lbearing
, rbearing
;
25084 int i
, width
, ascent
, descent
;
25085 int left_padded
= 0, right_padded
= 0;
25086 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
25088 struct font_metrics
*pcm
;
25089 int font_not_found_p
;
25092 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
25093 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
25095 if (glyph_len
< cmp
->glyph_len
)
25097 for (i
= 0; i
< glyph_len
; i
++)
25099 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
25101 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25106 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
25107 : IT_CHARPOS (*it
));
25108 /* If no suitable font is found, use the default font. */
25109 font_not_found_p
= font
== NULL
;
25110 if (font_not_found_p
)
25112 face
= face
->ascii_face
;
25115 boff
= font
->baseline_offset
;
25116 if (font
->vertical_centering
)
25117 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25118 font_ascent
= FONT_BASE (font
) + boff
;
25119 font_descent
= FONT_DESCENT (font
) - boff
;
25120 font_height
= FONT_HEIGHT (font
);
25125 if (! font_not_found_p
)
25127 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
25129 pcm
= get_per_char_metric (font
, &char2b
);
25132 /* Initialize the bounding box. */
25135 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
25136 ascent
= pcm
->ascent
;
25137 descent
= pcm
->descent
;
25138 lbearing
= pcm
->lbearing
;
25139 rbearing
= pcm
->rbearing
;
25143 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
25144 ascent
= FONT_BASE (font
);
25145 descent
= FONT_DESCENT (font
);
25152 lowest
= - descent
+ boff
;
25153 highest
= ascent
+ boff
;
25155 if (! font_not_found_p
25156 && font
->default_ascent
25157 && CHAR_TABLE_P (Vuse_default_ascent
)
25158 && !NILP (Faref (Vuse_default_ascent
,
25159 make_number (it
->char_to_display
))))
25160 highest
= font
->default_ascent
+ boff
;
25162 /* Draw the first glyph at the normal position. It may be
25163 shifted to right later if some other glyphs are drawn
25165 cmp
->offsets
[i
* 2] = 0;
25166 cmp
->offsets
[i
* 2 + 1] = boff
;
25167 cmp
->lbearing
= lbearing
;
25168 cmp
->rbearing
= rbearing
;
25170 /* Set cmp->offsets for the remaining glyphs. */
25171 for (i
++; i
< glyph_len
; i
++)
25173 int left
, right
, btm
, top
;
25174 int ch
= COMPOSITION_GLYPH (cmp
, i
);
25176 struct face
*this_face
;
25180 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
25181 this_face
= FACE_FROM_ID (it
->f
, face_id
);
25182 font
= this_face
->font
;
25188 get_char_face_and_encoding (it
->f
, ch
, face_id
,
25190 pcm
= get_per_char_metric (font
, &char2b
);
25193 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25196 width
= pcm
->width
;
25197 ascent
= pcm
->ascent
;
25198 descent
= pcm
->descent
;
25199 lbearing
= pcm
->lbearing
;
25200 rbearing
= pcm
->rbearing
;
25201 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
25203 /* Relative composition with or without
25204 alternate chars. */
25205 left
= (leftmost
+ rightmost
- width
) / 2;
25206 btm
= - descent
+ boff
;
25207 if (font
->relative_compose
25208 && (! CHAR_TABLE_P (Vignore_relative_composition
)
25209 || NILP (Faref (Vignore_relative_composition
,
25210 make_number (ch
)))))
25213 if (- descent
>= font
->relative_compose
)
25214 /* One extra pixel between two glyphs. */
25216 else if (ascent
<= 0)
25217 /* One extra pixel between two glyphs. */
25218 btm
= lowest
- 1 - ascent
- descent
;
25223 /* A composition rule is specified by an integer
25224 value that encodes global and new reference
25225 points (GREF and NREF). GREF and NREF are
25226 specified by numbers as below:
25228 0---1---2 -- ascent
25232 9--10--11 -- center
25234 ---3---4---5--- baseline
25236 6---7---8 -- descent
25238 int rule
= COMPOSITION_RULE (cmp
, i
);
25239 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
25241 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
25242 grefx
= gref
% 3, nrefx
= nref
% 3;
25243 grefy
= gref
/ 3, nrefy
= nref
/ 3;
25245 xoff
= font_height
* (xoff
- 128) / 256;
25247 yoff
= font_height
* (yoff
- 128) / 256;
25250 + grefx
* (rightmost
- leftmost
) / 2
25251 - nrefx
* width
/ 2
25254 btm
= ((grefy
== 0 ? highest
25256 : grefy
== 2 ? lowest
25257 : (highest
+ lowest
) / 2)
25258 - (nrefy
== 0 ? ascent
+ descent
25259 : nrefy
== 1 ? descent
- boff
25261 : (ascent
+ descent
) / 2)
25265 cmp
->offsets
[i
* 2] = left
;
25266 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
25268 /* Update the bounding box of the overall glyphs. */
25271 right
= left
+ width
;
25272 if (left
< leftmost
)
25274 if (right
> rightmost
)
25277 top
= btm
+ descent
+ ascent
;
25283 if (cmp
->lbearing
> left
+ lbearing
)
25284 cmp
->lbearing
= left
+ lbearing
;
25285 if (cmp
->rbearing
< left
+ rbearing
)
25286 cmp
->rbearing
= left
+ rbearing
;
25290 /* If there are glyphs whose x-offsets are negative,
25291 shift all glyphs to the right and make all x-offsets
25295 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25296 cmp
->offsets
[i
* 2] -= leftmost
;
25297 rightmost
-= leftmost
;
25298 cmp
->lbearing
-= leftmost
;
25299 cmp
->rbearing
-= leftmost
;
25302 if (left_padded
&& cmp
->lbearing
< 0)
25304 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25305 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
25306 rightmost
-= cmp
->lbearing
;
25307 cmp
->rbearing
-= cmp
->lbearing
;
25310 if (right_padded
&& rightmost
< cmp
->rbearing
)
25312 rightmost
= cmp
->rbearing
;
25315 cmp
->pixel_width
= rightmost
;
25316 cmp
->ascent
= highest
;
25317 cmp
->descent
= - lowest
;
25318 if (cmp
->ascent
< font_ascent
)
25319 cmp
->ascent
= font_ascent
;
25320 if (cmp
->descent
< font_descent
)
25321 cmp
->descent
= font_descent
;
25325 && (cmp
->lbearing
< 0
25326 || cmp
->rbearing
> cmp
->pixel_width
))
25327 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25329 it
->pixel_width
= cmp
->pixel_width
;
25330 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
25331 it
->descent
= it
->phys_descent
= cmp
->descent
;
25332 if (face
->box
!= FACE_NO_BOX
)
25334 int thick
= face
->box_line_width
;
25338 it
->ascent
+= thick
;
25339 it
->descent
+= thick
;
25344 if (it
->start_of_box_run_p
)
25345 it
->pixel_width
+= thick
;
25346 if (it
->end_of_box_run_p
)
25347 it
->pixel_width
+= thick
;
25350 /* If face has an overline, add the height of the overline
25351 (1 pixel) and a 1 pixel margin to the character height. */
25352 if (face
->overline_p
)
25353 it
->ascent
+= overline_margin
;
25355 take_vertical_position_into_account (it
);
25356 if (it
->ascent
< 0)
25358 if (it
->descent
< 0)
25361 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
25362 append_composite_glyph (it
);
25364 else if (it
->what
== IT_COMPOSITION
)
25366 /* A dynamic (automatic) composition. */
25367 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25368 Lisp_Object gstring
;
25369 struct font_metrics metrics
;
25373 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
25375 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
25378 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
25379 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25380 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
25381 it
->descent
= it
->phys_descent
= metrics
.descent
;
25382 if (face
->box
!= FACE_NO_BOX
)
25384 int thick
= face
->box_line_width
;
25388 it
->ascent
+= thick
;
25389 it
->descent
+= thick
;
25394 if (it
->start_of_box_run_p
)
25395 it
->pixel_width
+= thick
;
25396 if (it
->end_of_box_run_p
)
25397 it
->pixel_width
+= thick
;
25399 /* If face has an overline, add the height of the overline
25400 (1 pixel) and a 1 pixel margin to the character height. */
25401 if (face
->overline_p
)
25402 it
->ascent
+= overline_margin
;
25403 take_vertical_position_into_account (it
);
25404 if (it
->ascent
< 0)
25406 if (it
->descent
< 0)
25410 append_composite_glyph (it
);
25412 else if (it
->what
== IT_GLYPHLESS
)
25413 produce_glyphless_glyph (it
, 0, Qnil
);
25414 else if (it
->what
== IT_IMAGE
)
25415 produce_image_glyph (it
);
25416 else if (it
->what
== IT_STRETCH
)
25417 produce_stretch_glyph (it
);
25420 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25421 because this isn't true for images with `:ascent 100'. */
25422 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
25423 if (it
->area
== TEXT_AREA
)
25424 it
->current_x
+= it
->pixel_width
;
25426 if (extra_line_spacing
> 0)
25428 it
->descent
+= extra_line_spacing
;
25429 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25430 it
->max_extra_line_spacing
= extra_line_spacing
;
25433 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25434 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25435 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25436 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25440 Output LEN glyphs starting at START at the nominal cursor position.
25441 Advance the nominal cursor over the text. The global variable
25442 updated_window contains the window being updated, updated_row is
25443 the glyph row being updated, and updated_area is the area of that
25444 row being updated. */
25447 x_write_glyphs (struct glyph
*start
, int len
)
25449 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25451 eassert (updated_window
&& updated_row
);
25452 /* When the window is hscrolled, cursor hpos can legitimately be out
25453 of bounds, but we draw the cursor at the corresponding window
25454 margin in that case. */
25455 if (!updated_row
->reversed_p
&& chpos
< 0)
25457 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25458 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25462 /* Write glyphs. */
25464 hpos
= start
- updated_row
->glyphs
[updated_area
];
25465 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25466 updated_row
, updated_area
,
25468 DRAW_NORMAL_TEXT
, 0);
25470 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25471 if (updated_area
== TEXT_AREA
25472 && updated_window
->phys_cursor_on_p
25473 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25475 && chpos
< hpos
+ len
)
25476 updated_window
->phys_cursor_on_p
= 0;
25480 /* Advance the output cursor. */
25481 output_cursor
.hpos
+= len
;
25482 output_cursor
.x
= x
;
25487 Insert LEN glyphs from START at the nominal cursor position. */
25490 x_insert_glyphs (struct glyph
*start
, int len
)
25494 int line_height
, shift_by_width
, shifted_region_width
;
25495 struct glyph_row
*row
;
25496 struct glyph
*glyph
;
25497 int frame_x
, frame_y
;
25500 eassert (updated_window
&& updated_row
);
25502 w
= updated_window
;
25503 f
= XFRAME (WINDOW_FRAME (w
));
25505 /* Get the height of the line we are in. */
25507 line_height
= row
->height
;
25509 /* Get the width of the glyphs to insert. */
25510 shift_by_width
= 0;
25511 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25512 shift_by_width
+= glyph
->pixel_width
;
25514 /* Get the width of the region to shift right. */
25515 shifted_region_width
= (window_box_width (w
, updated_area
)
25520 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25521 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25523 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25524 line_height
, shift_by_width
);
25526 /* Write the glyphs. */
25527 hpos
= start
- row
->glyphs
[updated_area
];
25528 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25530 DRAW_NORMAL_TEXT
, 0);
25532 /* Advance the output cursor. */
25533 output_cursor
.hpos
+= len
;
25534 output_cursor
.x
+= shift_by_width
;
25540 Erase the current text line from the nominal cursor position
25541 (inclusive) to pixel column TO_X (exclusive). The idea is that
25542 everything from TO_X onward is already erased.
25544 TO_X is a pixel position relative to updated_area of
25545 updated_window. TO_X == -1 means clear to the end of this area. */
25548 x_clear_end_of_line (int to_x
)
25551 struct window
*w
= updated_window
;
25552 int max_x
, min_y
, max_y
;
25553 int from_x
, from_y
, to_y
;
25555 eassert (updated_window
&& updated_row
);
25556 f
= XFRAME (w
->frame
);
25558 if (updated_row
->full_width_p
)
25559 max_x
= WINDOW_TOTAL_WIDTH (w
);
25561 max_x
= window_box_width (w
, updated_area
);
25562 max_y
= window_text_bottom_y (w
);
25564 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25565 of window. For TO_X > 0, truncate to end of drawing area. */
25571 to_x
= min (to_x
, max_x
);
25573 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25575 /* Notice if the cursor will be cleared by this operation. */
25576 if (!updated_row
->full_width_p
)
25577 notice_overwritten_cursor (w
, updated_area
,
25578 output_cursor
.x
, -1,
25580 MATRIX_ROW_BOTTOM_Y (updated_row
));
25582 from_x
= output_cursor
.x
;
25584 /* Translate to frame coordinates. */
25585 if (updated_row
->full_width_p
)
25587 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25588 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25592 int area_left
= window_box_left (w
, updated_area
);
25593 from_x
+= area_left
;
25597 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25598 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25599 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25601 /* Prevent inadvertently clearing to end of the X window. */
25602 if (to_x
> from_x
&& to_y
> from_y
)
25605 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25606 to_x
- from_x
, to_y
- from_y
);
25611 #endif /* HAVE_WINDOW_SYSTEM */
25615 /***********************************************************************
25617 ***********************************************************************/
25619 /* Value is the internal representation of the specified cursor type
25620 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25621 of the bar cursor. */
25623 static enum text_cursor_kinds
25624 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25626 enum text_cursor_kinds type
;
25631 if (EQ (arg
, Qbox
))
25632 return FILLED_BOX_CURSOR
;
25634 if (EQ (arg
, Qhollow
))
25635 return HOLLOW_BOX_CURSOR
;
25637 if (EQ (arg
, Qbar
))
25644 && EQ (XCAR (arg
), Qbar
)
25645 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25647 *width
= XINT (XCDR (arg
));
25651 if (EQ (arg
, Qhbar
))
25654 return HBAR_CURSOR
;
25658 && EQ (XCAR (arg
), Qhbar
)
25659 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25661 *width
= XINT (XCDR (arg
));
25662 return HBAR_CURSOR
;
25665 /* Treat anything unknown as "hollow box cursor".
25666 It was bad to signal an error; people have trouble fixing
25667 .Xdefaults with Emacs, when it has something bad in it. */
25668 type
= HOLLOW_BOX_CURSOR
;
25673 /* Set the default cursor types for specified frame. */
25675 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25680 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25681 FRAME_CURSOR_WIDTH (f
) = width
;
25683 /* By default, set up the blink-off state depending on the on-state. */
25685 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25688 FRAME_BLINK_OFF_CURSOR (f
)
25689 = get_specified_cursor_type (XCDR (tem
), &width
);
25690 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25693 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25697 #ifdef HAVE_WINDOW_SYSTEM
25699 /* Return the cursor we want to be displayed in window W. Return
25700 width of bar/hbar cursor through WIDTH arg. Return with
25701 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25702 (i.e. if the `system caret' should track this cursor).
25704 In a mini-buffer window, we want the cursor only to appear if we
25705 are reading input from this window. For the selected window, we
25706 want the cursor type given by the frame parameter or buffer local
25707 setting of cursor-type. If explicitly marked off, draw no cursor.
25708 In all other cases, we want a hollow box cursor. */
25710 static enum text_cursor_kinds
25711 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25712 int *active_cursor
)
25714 struct frame
*f
= XFRAME (w
->frame
);
25715 struct buffer
*b
= XBUFFER (w
->buffer
);
25716 int cursor_type
= DEFAULT_CURSOR
;
25717 Lisp_Object alt_cursor
;
25718 int non_selected
= 0;
25720 *active_cursor
= 1;
25723 if (cursor_in_echo_area
25724 && FRAME_HAS_MINIBUF_P (f
)
25725 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25727 if (w
== XWINDOW (echo_area_window
))
25729 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25731 *width
= FRAME_CURSOR_WIDTH (f
);
25732 return FRAME_DESIRED_CURSOR (f
);
25735 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25738 *active_cursor
= 0;
25742 /* Detect a nonselected window or nonselected frame. */
25743 else if (w
!= XWINDOW (f
->selected_window
)
25744 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25746 *active_cursor
= 0;
25748 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25754 /* Never display a cursor in a window in which cursor-type is nil. */
25755 if (NILP (BVAR (b
, cursor_type
)))
25758 /* Get the normal cursor type for this window. */
25759 if (EQ (BVAR (b
, cursor_type
), Qt
))
25761 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25762 *width
= FRAME_CURSOR_WIDTH (f
);
25765 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25767 /* Use cursor-in-non-selected-windows instead
25768 for non-selected window or frame. */
25771 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25772 if (!EQ (Qt
, alt_cursor
))
25773 return get_specified_cursor_type (alt_cursor
, width
);
25774 /* t means modify the normal cursor type. */
25775 if (cursor_type
== FILLED_BOX_CURSOR
)
25776 cursor_type
= HOLLOW_BOX_CURSOR
;
25777 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25779 return cursor_type
;
25782 /* Use normal cursor if not blinked off. */
25783 if (!w
->cursor_off_p
)
25785 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25787 if (cursor_type
== FILLED_BOX_CURSOR
)
25789 /* Using a block cursor on large images can be very annoying.
25790 So use a hollow cursor for "large" images.
25791 If image is not transparent (no mask), also use hollow cursor. */
25792 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25793 if (img
!= NULL
&& IMAGEP (img
->spec
))
25795 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25796 where N = size of default frame font size.
25797 This should cover most of the "tiny" icons people may use. */
25799 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25800 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25801 cursor_type
= HOLLOW_BOX_CURSOR
;
25804 else if (cursor_type
!= NO_CURSOR
)
25806 /* Display current only supports BOX and HOLLOW cursors for images.
25807 So for now, unconditionally use a HOLLOW cursor when cursor is
25808 not a solid box cursor. */
25809 cursor_type
= HOLLOW_BOX_CURSOR
;
25812 return cursor_type
;
25815 /* Cursor is blinked off, so determine how to "toggle" it. */
25817 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25818 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25819 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25821 /* Then see if frame has specified a specific blink off cursor type. */
25822 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25824 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25825 return FRAME_BLINK_OFF_CURSOR (f
);
25829 /* Some people liked having a permanently visible blinking cursor,
25830 while others had very strong opinions against it. So it was
25831 decided to remove it. KFS 2003-09-03 */
25833 /* Finally perform built-in cursor blinking:
25834 filled box <-> hollow box
25835 wide [h]bar <-> narrow [h]bar
25836 narrow [h]bar <-> no cursor
25837 other type <-> no cursor */
25839 if (cursor_type
== FILLED_BOX_CURSOR
)
25840 return HOLLOW_BOX_CURSOR
;
25842 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25845 return cursor_type
;
25853 /* Notice when the text cursor of window W has been completely
25854 overwritten by a drawing operation that outputs glyphs in AREA
25855 starting at X0 and ending at X1 in the line starting at Y0 and
25856 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25857 the rest of the line after X0 has been written. Y coordinates
25858 are window-relative. */
25861 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25862 int x0
, int x1
, int y0
, int y1
)
25864 int cx0
, cx1
, cy0
, cy1
;
25865 struct glyph_row
*row
;
25867 if (!w
->phys_cursor_on_p
)
25869 if (area
!= TEXT_AREA
)
25872 if (w
->phys_cursor
.vpos
< 0
25873 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25874 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25875 !(row
->enabled_p
&& row
->displays_text_p
)))
25878 if (row
->cursor_in_fringe_p
)
25880 row
->cursor_in_fringe_p
= 0;
25881 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25882 w
->phys_cursor_on_p
= 0;
25886 cx0
= w
->phys_cursor
.x
;
25887 cx1
= cx0
+ w
->phys_cursor_width
;
25888 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25891 /* The cursor image will be completely removed from the
25892 screen if the output area intersects the cursor area in
25893 y-direction. When we draw in [y0 y1[, and some part of
25894 the cursor is at y < y0, that part must have been drawn
25895 before. When scrolling, the cursor is erased before
25896 actually scrolling, so we don't come here. When not
25897 scrolling, the rows above the old cursor row must have
25898 changed, and in this case these rows must have written
25899 over the cursor image.
25901 Likewise if part of the cursor is below y1, with the
25902 exception of the cursor being in the first blank row at
25903 the buffer and window end because update_text_area
25904 doesn't draw that row. (Except when it does, but
25905 that's handled in update_text_area.) */
25907 cy0
= w
->phys_cursor
.y
;
25908 cy1
= cy0
+ w
->phys_cursor_height
;
25909 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25912 w
->phys_cursor_on_p
= 0;
25915 #endif /* HAVE_WINDOW_SYSTEM */
25918 /************************************************************************
25920 ************************************************************************/
25922 #ifdef HAVE_WINDOW_SYSTEM
25925 Fix the display of area AREA of overlapping row ROW in window W
25926 with respect to the overlapping part OVERLAPS. */
25929 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25930 enum glyph_row_area area
, int overlaps
)
25937 for (i
= 0; i
< row
->used
[area
];)
25939 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25941 int start
= i
, start_x
= x
;
25945 x
+= row
->glyphs
[area
][i
].pixel_width
;
25948 while (i
< row
->used
[area
]
25949 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25951 draw_glyphs (w
, start_x
, row
, area
,
25953 DRAW_NORMAL_TEXT
, overlaps
);
25957 x
+= row
->glyphs
[area
][i
].pixel_width
;
25967 Draw the cursor glyph of window W in glyph row ROW. See the
25968 comment of draw_glyphs for the meaning of HL. */
25971 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25972 enum draw_glyphs_face hl
)
25974 /* If cursor hpos is out of bounds, don't draw garbage. This can
25975 happen in mini-buffer windows when switching between echo area
25976 glyphs and mini-buffer. */
25977 if ((row
->reversed_p
25978 ? (w
->phys_cursor
.hpos
>= 0)
25979 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25981 int on_p
= w
->phys_cursor_on_p
;
25983 int hpos
= w
->phys_cursor
.hpos
;
25985 /* When the window is hscrolled, cursor hpos can legitimately be
25986 out of bounds, but we draw the cursor at the corresponding
25987 window margin in that case. */
25988 if (!row
->reversed_p
&& hpos
< 0)
25990 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25991 hpos
= row
->used
[TEXT_AREA
] - 1;
25993 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25995 w
->phys_cursor_on_p
= on_p
;
25997 if (hl
== DRAW_CURSOR
)
25998 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25999 /* When we erase the cursor, and ROW is overlapped by other
26000 rows, make sure that these overlapping parts of other rows
26002 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
26004 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
26006 if (row
> w
->current_matrix
->rows
26007 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
26008 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
26009 OVERLAPS_ERASED_CURSOR
);
26011 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
26012 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
26013 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
26014 OVERLAPS_ERASED_CURSOR
);
26021 Erase the image of a cursor of window W from the screen. */
26024 erase_phys_cursor (struct window
*w
)
26026 struct frame
*f
= XFRAME (w
->frame
);
26027 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26028 int hpos
= w
->phys_cursor
.hpos
;
26029 int vpos
= w
->phys_cursor
.vpos
;
26030 int mouse_face_here_p
= 0;
26031 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
26032 struct glyph_row
*cursor_row
;
26033 struct glyph
*cursor_glyph
;
26034 enum draw_glyphs_face hl
;
26036 /* No cursor displayed or row invalidated => nothing to do on the
26038 if (w
->phys_cursor_type
== NO_CURSOR
)
26039 goto mark_cursor_off
;
26041 /* VPOS >= active_glyphs->nrows means that window has been resized.
26042 Don't bother to erase the cursor. */
26043 if (vpos
>= active_glyphs
->nrows
)
26044 goto mark_cursor_off
;
26046 /* If row containing cursor is marked invalid, there is nothing we
26048 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
26049 if (!cursor_row
->enabled_p
)
26050 goto mark_cursor_off
;
26052 /* If line spacing is > 0, old cursor may only be partially visible in
26053 window after split-window. So adjust visible height. */
26054 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
26055 window_text_bottom_y (w
) - cursor_row
->y
);
26057 /* If row is completely invisible, don't attempt to delete a cursor which
26058 isn't there. This can happen if cursor is at top of a window, and
26059 we switch to a buffer with a header line in that window. */
26060 if (cursor_row
->visible_height
<= 0)
26061 goto mark_cursor_off
;
26063 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
26064 if (cursor_row
->cursor_in_fringe_p
)
26066 cursor_row
->cursor_in_fringe_p
= 0;
26067 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
26068 goto mark_cursor_off
;
26071 /* This can happen when the new row is shorter than the old one.
26072 In this case, either draw_glyphs or clear_end_of_line
26073 should have cleared the cursor. Note that we wouldn't be
26074 able to erase the cursor in this case because we don't have a
26075 cursor glyph at hand. */
26076 if ((cursor_row
->reversed_p
26077 ? (w
->phys_cursor
.hpos
< 0)
26078 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
26079 goto mark_cursor_off
;
26081 /* When the window is hscrolled, cursor hpos can legitimately be out
26082 of bounds, but we draw the cursor at the corresponding window
26083 margin in that case. */
26084 if (!cursor_row
->reversed_p
&& hpos
< 0)
26086 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
26087 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
26089 /* If the cursor is in the mouse face area, redisplay that when
26090 we clear the cursor. */
26091 if (! NILP (hlinfo
->mouse_face_window
)
26092 && coords_in_mouse_face_p (w
, hpos
, vpos
)
26093 /* Don't redraw the cursor's spot in mouse face if it is at the
26094 end of a line (on a newline). The cursor appears there, but
26095 mouse highlighting does not. */
26096 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
26097 mouse_face_here_p
= 1;
26099 /* Maybe clear the display under the cursor. */
26100 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
26103 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
26106 cursor_glyph
= get_phys_cursor_glyph (w
);
26107 if (cursor_glyph
== NULL
)
26108 goto mark_cursor_off
;
26110 width
= cursor_glyph
->pixel_width
;
26111 left_x
= window_box_left_offset (w
, TEXT_AREA
);
26112 x
= w
->phys_cursor
.x
;
26114 width
-= left_x
- x
;
26115 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
26116 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
26117 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
26120 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
26123 /* Erase the cursor by redrawing the character underneath it. */
26124 if (mouse_face_here_p
)
26125 hl
= DRAW_MOUSE_FACE
;
26127 hl
= DRAW_NORMAL_TEXT
;
26128 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
26131 w
->phys_cursor_on_p
= 0;
26132 w
->phys_cursor_type
= NO_CURSOR
;
26137 Display or clear cursor of window W. If ON is zero, clear the
26138 cursor. If it is non-zero, display the cursor. If ON is nonzero,
26139 where to put the cursor is specified by HPOS, VPOS, X and Y. */
26142 display_and_set_cursor (struct window
*w
, int on
,
26143 int hpos
, int vpos
, int x
, int y
)
26145 struct frame
*f
= XFRAME (w
->frame
);
26146 int new_cursor_type
;
26147 int new_cursor_width
;
26149 struct glyph_row
*glyph_row
;
26150 struct glyph
*glyph
;
26152 /* This is pointless on invisible frames, and dangerous on garbaged
26153 windows and frames; in the latter case, the frame or window may
26154 be in the midst of changing its size, and x and y may be off the
26156 if (! FRAME_VISIBLE_P (f
)
26157 || FRAME_GARBAGED_P (f
)
26158 || vpos
>= w
->current_matrix
->nrows
26159 || hpos
>= w
->current_matrix
->matrix_w
)
26162 /* If cursor is off and we want it off, return quickly. */
26163 if (!on
&& !w
->phys_cursor_on_p
)
26166 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26167 /* If cursor row is not enabled, we don't really know where to
26168 display the cursor. */
26169 if (!glyph_row
->enabled_p
)
26171 w
->phys_cursor_on_p
= 0;
26176 if (!glyph_row
->exact_window_width_line_p
26177 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
26178 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
26180 eassert (input_blocked_p ());
26182 /* Set new_cursor_type to the cursor we want to be displayed. */
26183 new_cursor_type
= get_window_cursor_type (w
, glyph
,
26184 &new_cursor_width
, &active_cursor
);
26186 /* If cursor is currently being shown and we don't want it to be or
26187 it is in the wrong place, or the cursor type is not what we want,
26189 if (w
->phys_cursor_on_p
26191 || w
->phys_cursor
.x
!= x
26192 || w
->phys_cursor
.y
!= y
26193 || new_cursor_type
!= w
->phys_cursor_type
26194 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
26195 && new_cursor_width
!= w
->phys_cursor_width
)))
26196 erase_phys_cursor (w
);
26198 /* Don't check phys_cursor_on_p here because that flag is only set
26199 to zero in some cases where we know that the cursor has been
26200 completely erased, to avoid the extra work of erasing the cursor
26201 twice. In other words, phys_cursor_on_p can be 1 and the cursor
26202 still not be visible, or it has only been partly erased. */
26205 w
->phys_cursor_ascent
= glyph_row
->ascent
;
26206 w
->phys_cursor_height
= glyph_row
->height
;
26208 /* Set phys_cursor_.* before x_draw_.* is called because some
26209 of them may need the information. */
26210 w
->phys_cursor
.x
= x
;
26211 w
->phys_cursor
.y
= glyph_row
->y
;
26212 w
->phys_cursor
.hpos
= hpos
;
26213 w
->phys_cursor
.vpos
= vpos
;
26216 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
26217 new_cursor_type
, new_cursor_width
,
26218 on
, active_cursor
);
26222 /* Switch the display of W's cursor on or off, according to the value
26226 update_window_cursor (struct window
*w
, int on
)
26228 /* Don't update cursor in windows whose frame is in the process
26229 of being deleted. */
26230 if (w
->current_matrix
)
26232 int hpos
= w
->phys_cursor
.hpos
;
26233 int vpos
= w
->phys_cursor
.vpos
;
26234 struct glyph_row
*row
;
26236 if (vpos
>= w
->current_matrix
->nrows
26237 || hpos
>= w
->current_matrix
->matrix_w
)
26240 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26242 /* When the window is hscrolled, cursor hpos can legitimately be
26243 out of bounds, but we draw the cursor at the corresponding
26244 window margin in that case. */
26245 if (!row
->reversed_p
&& hpos
< 0)
26247 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26248 hpos
= row
->used
[TEXT_AREA
] - 1;
26251 display_and_set_cursor (w
, on
, hpos
, vpos
,
26252 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26258 /* Call update_window_cursor with parameter ON_P on all leaf windows
26259 in the window tree rooted at W. */
26262 update_cursor_in_window_tree (struct window
*w
, int on_p
)
26266 if (!NILP (w
->hchild
))
26267 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
26268 else if (!NILP (w
->vchild
))
26269 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
26271 update_window_cursor (w
, on_p
);
26273 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
26279 Display the cursor on window W, or clear it, according to ON_P.
26280 Don't change the cursor's position. */
26283 x_update_cursor (struct frame
*f
, int on_p
)
26285 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
26290 Clear the cursor of window W to background color, and mark the
26291 cursor as not shown. This is used when the text where the cursor
26292 is about to be rewritten. */
26295 x_clear_cursor (struct window
*w
)
26297 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
26298 update_window_cursor (w
, 0);
26301 #endif /* HAVE_WINDOW_SYSTEM */
26303 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26306 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
26307 int start_hpos
, int end_hpos
,
26308 enum draw_glyphs_face draw
)
26310 #ifdef HAVE_WINDOW_SYSTEM
26311 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
26313 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
26317 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26318 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
26322 /* Display the active region described by mouse_face_* according to DRAW. */
26325 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
26327 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
26328 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26330 if (/* If window is in the process of being destroyed, don't bother
26332 w
->current_matrix
!= NULL
26333 /* Don't update mouse highlight if hidden */
26334 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
26335 /* Recognize when we are called to operate on rows that don't exist
26336 anymore. This can happen when a window is split. */
26337 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
26339 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
26340 struct glyph_row
*row
, *first
, *last
;
26342 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
26343 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
26345 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
26347 int start_hpos
, end_hpos
, start_x
;
26349 /* For all but the first row, the highlight starts at column 0. */
26352 /* R2L rows have BEG and END in reversed order, but the
26353 screen drawing geometry is always left to right. So
26354 we need to mirror the beginning and end of the
26355 highlighted area in R2L rows. */
26356 if (!row
->reversed_p
)
26358 start_hpos
= hlinfo
->mouse_face_beg_col
;
26359 start_x
= hlinfo
->mouse_face_beg_x
;
26361 else if (row
== last
)
26363 start_hpos
= hlinfo
->mouse_face_end_col
;
26364 start_x
= hlinfo
->mouse_face_end_x
;
26372 else if (row
->reversed_p
&& row
== last
)
26374 start_hpos
= hlinfo
->mouse_face_end_col
;
26375 start_x
= hlinfo
->mouse_face_end_x
;
26385 if (!row
->reversed_p
)
26386 end_hpos
= hlinfo
->mouse_face_end_col
;
26387 else if (row
== first
)
26388 end_hpos
= hlinfo
->mouse_face_beg_col
;
26391 end_hpos
= row
->used
[TEXT_AREA
];
26392 if (draw
== DRAW_NORMAL_TEXT
)
26393 row
->fill_line_p
= 1; /* Clear to end of line */
26396 else if (row
->reversed_p
&& row
== first
)
26397 end_hpos
= hlinfo
->mouse_face_beg_col
;
26400 end_hpos
= row
->used
[TEXT_AREA
];
26401 if (draw
== DRAW_NORMAL_TEXT
)
26402 row
->fill_line_p
= 1; /* Clear to end of line */
26405 if (end_hpos
> start_hpos
)
26407 draw_row_with_mouse_face (w
, start_x
, row
,
26408 start_hpos
, end_hpos
, draw
);
26411 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26415 #ifdef HAVE_WINDOW_SYSTEM
26416 /* When we've written over the cursor, arrange for it to
26417 be displayed again. */
26418 if (FRAME_WINDOW_P (f
)
26419 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26421 int hpos
= w
->phys_cursor
.hpos
;
26423 /* When the window is hscrolled, cursor hpos can legitimately be
26424 out of bounds, but we draw the cursor at the corresponding
26425 window margin in that case. */
26426 if (!row
->reversed_p
&& hpos
< 0)
26428 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26429 hpos
= row
->used
[TEXT_AREA
] - 1;
26432 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26433 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26436 #endif /* HAVE_WINDOW_SYSTEM */
26439 #ifdef HAVE_WINDOW_SYSTEM
26440 /* Change the mouse cursor. */
26441 if (FRAME_WINDOW_P (f
))
26443 if (draw
== DRAW_NORMAL_TEXT
26444 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26445 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26446 else if (draw
== DRAW_MOUSE_FACE
)
26447 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26449 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26451 #endif /* HAVE_WINDOW_SYSTEM */
26455 Clear out the mouse-highlighted active region.
26456 Redraw it un-highlighted first. Value is non-zero if mouse
26457 face was actually drawn unhighlighted. */
26460 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26464 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26466 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26470 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26471 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26472 hlinfo
->mouse_face_window
= Qnil
;
26473 hlinfo
->mouse_face_overlay
= Qnil
;
26477 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26478 within the mouse face on that window. */
26480 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26482 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26484 /* Quickly resolve the easy cases. */
26485 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26486 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26488 if (vpos
< hlinfo
->mouse_face_beg_row
26489 || vpos
> hlinfo
->mouse_face_end_row
)
26491 if (vpos
> hlinfo
->mouse_face_beg_row
26492 && vpos
< hlinfo
->mouse_face_end_row
)
26495 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26497 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26499 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26502 else if ((vpos
== hlinfo
->mouse_face_beg_row
26503 && hpos
>= hlinfo
->mouse_face_beg_col
)
26504 || (vpos
== hlinfo
->mouse_face_end_row
26505 && hpos
< hlinfo
->mouse_face_end_col
))
26510 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26512 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26515 else if ((vpos
== hlinfo
->mouse_face_beg_row
26516 && hpos
<= hlinfo
->mouse_face_beg_col
)
26517 || (vpos
== hlinfo
->mouse_face_end_row
26518 && hpos
> hlinfo
->mouse_face_end_col
))
26526 Non-zero if physical cursor of window W is within mouse face. */
26529 cursor_in_mouse_face_p (struct window
*w
)
26531 int hpos
= w
->phys_cursor
.hpos
;
26532 int vpos
= w
->phys_cursor
.vpos
;
26533 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26535 /* When the window is hscrolled, cursor hpos can legitimately be out
26536 of bounds, but we draw the cursor at the corresponding window
26537 margin in that case. */
26538 if (!row
->reversed_p
&& hpos
< 0)
26540 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26541 hpos
= row
->used
[TEXT_AREA
] - 1;
26543 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26548 /* Find the glyph rows START_ROW and END_ROW of window W that display
26549 characters between buffer positions START_CHARPOS and END_CHARPOS
26550 (excluding END_CHARPOS). DISP_STRING is a display string that
26551 covers these buffer positions. This is similar to
26552 row_containing_pos, but is more accurate when bidi reordering makes
26553 buffer positions change non-linearly with glyph rows. */
26555 rows_from_pos_range (struct window
*w
,
26556 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26557 Lisp_Object disp_string
,
26558 struct glyph_row
**start
, struct glyph_row
**end
)
26560 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26561 int last_y
= window_text_bottom_y (w
);
26562 struct glyph_row
*row
;
26567 while (!first
->enabled_p
26568 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26571 /* Find the START row. */
26573 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26576 /* A row can potentially be the START row if the range of the
26577 characters it displays intersects the range
26578 [START_CHARPOS..END_CHARPOS). */
26579 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26580 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26581 /* See the commentary in row_containing_pos, for the
26582 explanation of the complicated way to check whether
26583 some position is beyond the end of the characters
26584 displayed by a row. */
26585 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26586 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26587 && !row
->ends_at_zv_p
26588 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26589 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26590 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26591 && !row
->ends_at_zv_p
26592 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26594 /* Found a candidate row. Now make sure at least one of the
26595 glyphs it displays has a charpos from the range
26596 [START_CHARPOS..END_CHARPOS).
26598 This is not obvious because bidi reordering could make
26599 buffer positions of a row be 1,2,3,102,101,100, and if we
26600 want to highlight characters in [50..60), we don't want
26601 this row, even though [50..60) does intersect [1..103),
26602 the range of character positions given by the row's start
26603 and end positions. */
26604 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26605 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26609 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26610 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26611 /* A glyph that comes from DISP_STRING is by
26612 definition to be highlighted. */
26613 || EQ (g
->object
, disp_string
))
26622 /* Find the END row. */
26624 /* If the last row is partially visible, start looking for END
26625 from that row, instead of starting from FIRST. */
26626 && !(row
->enabled_p
26627 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26629 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26631 struct glyph_row
*next
= row
+ 1;
26632 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26634 if (!next
->enabled_p
26635 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26636 /* The first row >= START whose range of displayed characters
26637 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26638 is the row END + 1. */
26639 || (start_charpos
< next_start
26640 && end_charpos
< next_start
)
26641 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26642 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26643 && !next
->ends_at_zv_p
26644 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26645 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26646 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26647 && !next
->ends_at_zv_p
26648 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26655 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26656 but none of the characters it displays are in the range, it is
26658 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26659 struct glyph
*s
= g
;
26660 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26664 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26665 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26666 /* If the buffer position of the first glyph in
26667 the row is equal to END_CHARPOS, it means
26668 the last character to be highlighted is the
26669 newline of ROW, and we must consider NEXT as
26671 || (((!next
->reversed_p
&& g
== s
)
26672 || (next
->reversed_p
&& g
== e
- 1))
26673 && (g
->charpos
== end_charpos
26674 /* Special case for when NEXT is an
26675 empty line at ZV. */
26676 || (g
->charpos
== -1
26677 && !row
->ends_at_zv_p
26678 && next_start
== end_charpos
)))))
26679 /* A glyph that comes from DISP_STRING is by
26680 definition to be highlighted. */
26681 || EQ (g
->object
, disp_string
))
26690 /* The first row that ends at ZV must be the last to be
26692 else if (next
->ends_at_zv_p
)
26701 /* This function sets the mouse_face_* elements of HLINFO, assuming
26702 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26703 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26704 for the overlay or run of text properties specifying the mouse
26705 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26706 before-string and after-string that must also be highlighted.
26707 DISP_STRING, if non-nil, is a display string that may cover some
26708 or all of the highlighted text. */
26711 mouse_face_from_buffer_pos (Lisp_Object window
,
26712 Mouse_HLInfo
*hlinfo
,
26713 ptrdiff_t mouse_charpos
,
26714 ptrdiff_t start_charpos
,
26715 ptrdiff_t end_charpos
,
26716 Lisp_Object before_string
,
26717 Lisp_Object after_string
,
26718 Lisp_Object disp_string
)
26720 struct window
*w
= XWINDOW (window
);
26721 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26722 struct glyph_row
*r1
, *r2
;
26723 struct glyph
*glyph
, *end
;
26724 ptrdiff_t ignore
, pos
;
26727 eassert (NILP (disp_string
) || STRINGP (disp_string
));
26728 eassert (NILP (before_string
) || STRINGP (before_string
));
26729 eassert (NILP (after_string
) || STRINGP (after_string
));
26731 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26732 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26734 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26735 /* If the before-string or display-string contains newlines,
26736 rows_from_pos_range skips to its last row. Move back. */
26737 if (!NILP (before_string
) || !NILP (disp_string
))
26739 struct glyph_row
*prev
;
26740 while ((prev
= r1
- 1, prev
>= first
)
26741 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26742 && prev
->used
[TEXT_AREA
] > 0)
26744 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26745 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26746 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26748 || !(EQ (glyph
->object
, before_string
)
26749 || EQ (glyph
->object
, disp_string
)))
26756 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26757 hlinfo
->mouse_face_past_end
= 1;
26759 else if (!NILP (after_string
))
26761 /* If the after-string has newlines, advance to its last row. */
26762 struct glyph_row
*next
;
26763 struct glyph_row
*last
26764 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26766 for (next
= r2
+ 1;
26768 && next
->used
[TEXT_AREA
] > 0
26769 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26773 /* The rest of the display engine assumes that mouse_face_beg_row is
26774 either above mouse_face_end_row or identical to it. But with
26775 bidi-reordered continued lines, the row for START_CHARPOS could
26776 be below the row for END_CHARPOS. If so, swap the rows and store
26777 them in correct order. */
26780 struct glyph_row
*tem
= r2
;
26786 hlinfo
->mouse_face_beg_y
= r1
->y
;
26787 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26788 hlinfo
->mouse_face_end_y
= r2
->y
;
26789 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26791 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26792 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26793 could be anywhere in the row and in any order. The strategy
26794 below is to find the leftmost and the rightmost glyph that
26795 belongs to either of these 3 strings, or whose position is
26796 between START_CHARPOS and END_CHARPOS, and highlight all the
26797 glyphs between those two. This may cover more than just the text
26798 between START_CHARPOS and END_CHARPOS if the range of characters
26799 strides the bidi level boundary, e.g. if the beginning is in R2L
26800 text while the end is in L2R text or vice versa. */
26801 if (!r1
->reversed_p
)
26803 /* This row is in a left to right paragraph. Scan it left to
26805 glyph
= r1
->glyphs
[TEXT_AREA
];
26806 end
= glyph
+ r1
->used
[TEXT_AREA
];
26809 /* Skip truncation glyphs at the start of the glyph row. */
26810 if (r1
->displays_text_p
)
26812 && INTEGERP (glyph
->object
)
26813 && glyph
->charpos
< 0;
26815 x
+= glyph
->pixel_width
;
26817 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26818 or DISP_STRING, and the first glyph from buffer whose
26819 position is between START_CHARPOS and END_CHARPOS. */
26821 && !INTEGERP (glyph
->object
)
26822 && !EQ (glyph
->object
, disp_string
)
26823 && !(BUFFERP (glyph
->object
)
26824 && (glyph
->charpos
>= start_charpos
26825 && glyph
->charpos
< end_charpos
));
26828 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26829 are present at buffer positions between START_CHARPOS and
26830 END_CHARPOS, or if they come from an overlay. */
26831 if (EQ (glyph
->object
, before_string
))
26833 pos
= string_buffer_position (before_string
,
26835 /* If pos == 0, it means before_string came from an
26836 overlay, not from a buffer position. */
26837 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26840 else if (EQ (glyph
->object
, after_string
))
26842 pos
= string_buffer_position (after_string
, end_charpos
);
26843 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26846 x
+= glyph
->pixel_width
;
26848 hlinfo
->mouse_face_beg_x
= x
;
26849 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26853 /* This row is in a right to left paragraph. Scan it right to
26857 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26858 glyph
= end
+ r1
->used
[TEXT_AREA
];
26860 /* Skip truncation glyphs at the start of the glyph row. */
26861 if (r1
->displays_text_p
)
26863 && INTEGERP (glyph
->object
)
26864 && glyph
->charpos
< 0;
26868 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26869 or DISP_STRING, and the first glyph from buffer whose
26870 position is between START_CHARPOS and END_CHARPOS. */
26872 && !INTEGERP (glyph
->object
)
26873 && !EQ (glyph
->object
, disp_string
)
26874 && !(BUFFERP (glyph
->object
)
26875 && (glyph
->charpos
>= start_charpos
26876 && glyph
->charpos
< end_charpos
));
26879 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26880 are present at buffer positions between START_CHARPOS and
26881 END_CHARPOS, or if they come from an overlay. */
26882 if (EQ (glyph
->object
, before_string
))
26884 pos
= string_buffer_position (before_string
, start_charpos
);
26885 /* If pos == 0, it means before_string came from an
26886 overlay, not from a buffer position. */
26887 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26890 else if (EQ (glyph
->object
, after_string
))
26892 pos
= string_buffer_position (after_string
, end_charpos
);
26893 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26898 glyph
++; /* first glyph to the right of the highlighted area */
26899 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26900 x
+= g
->pixel_width
;
26901 hlinfo
->mouse_face_beg_x
= x
;
26902 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26905 /* If the highlight ends in a different row, compute GLYPH and END
26906 for the end row. Otherwise, reuse the values computed above for
26907 the row where the highlight begins. */
26910 if (!r2
->reversed_p
)
26912 glyph
= r2
->glyphs
[TEXT_AREA
];
26913 end
= glyph
+ r2
->used
[TEXT_AREA
];
26918 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26919 glyph
= end
+ r2
->used
[TEXT_AREA
];
26923 if (!r2
->reversed_p
)
26925 /* Skip truncation and continuation glyphs near the end of the
26926 row, and also blanks and stretch glyphs inserted by
26927 extend_face_to_end_of_line. */
26929 && INTEGERP ((end
- 1)->object
))
26931 /* Scan the rest of the glyph row from the end, looking for the
26932 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26933 DISP_STRING, or whose position is between START_CHARPOS
26937 && !INTEGERP (end
->object
)
26938 && !EQ (end
->object
, disp_string
)
26939 && !(BUFFERP (end
->object
)
26940 && (end
->charpos
>= start_charpos
26941 && end
->charpos
< end_charpos
));
26944 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26945 are present at buffer positions between START_CHARPOS and
26946 END_CHARPOS, or if they come from an overlay. */
26947 if (EQ (end
->object
, before_string
))
26949 pos
= string_buffer_position (before_string
, start_charpos
);
26950 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26953 else if (EQ (end
->object
, after_string
))
26955 pos
= string_buffer_position (after_string
, end_charpos
);
26956 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26960 /* Find the X coordinate of the last glyph to be highlighted. */
26961 for (; glyph
<= end
; ++glyph
)
26962 x
+= glyph
->pixel_width
;
26964 hlinfo
->mouse_face_end_x
= x
;
26965 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26969 /* Skip truncation and continuation glyphs near the end of the
26970 row, and also blanks and stretch glyphs inserted by
26971 extend_face_to_end_of_line. */
26975 && INTEGERP (end
->object
))
26977 x
+= end
->pixel_width
;
26980 /* Scan the rest of the glyph row from the end, looking for the
26981 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26982 DISP_STRING, or whose position is between START_CHARPOS
26986 && !INTEGERP (end
->object
)
26987 && !EQ (end
->object
, disp_string
)
26988 && !(BUFFERP (end
->object
)
26989 && (end
->charpos
>= start_charpos
26990 && end
->charpos
< end_charpos
));
26993 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26994 are present at buffer positions between START_CHARPOS and
26995 END_CHARPOS, or if they come from an overlay. */
26996 if (EQ (end
->object
, before_string
))
26998 pos
= string_buffer_position (before_string
, start_charpos
);
26999 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27002 else if (EQ (end
->object
, after_string
))
27004 pos
= string_buffer_position (after_string
, end_charpos
);
27005 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27008 x
+= end
->pixel_width
;
27010 /* If we exited the above loop because we arrived at the last
27011 glyph of the row, and its buffer position is still not in
27012 range, it means the last character in range is the preceding
27013 newline. Bump the end column and x values to get past the
27016 && BUFFERP (end
->object
)
27017 && (end
->charpos
< start_charpos
27018 || end
->charpos
>= end_charpos
))
27020 x
+= end
->pixel_width
;
27023 hlinfo
->mouse_face_end_x
= x
;
27024 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
27027 hlinfo
->mouse_face_window
= window
;
27028 hlinfo
->mouse_face_face_id
27029 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
27031 !hlinfo
->mouse_face_hidden
, -1);
27032 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27035 /* The following function is not used anymore (replaced with
27036 mouse_face_from_string_pos), but I leave it here for the time
27037 being, in case someone would. */
27039 #if 0 /* not used */
27041 /* Find the position of the glyph for position POS in OBJECT in
27042 window W's current matrix, and return in *X, *Y the pixel
27043 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
27045 RIGHT_P non-zero means return the position of the right edge of the
27046 glyph, RIGHT_P zero means return the left edge position.
27048 If no glyph for POS exists in the matrix, return the position of
27049 the glyph with the next smaller position that is in the matrix, if
27050 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
27051 exists in the matrix, return the position of the glyph with the
27052 next larger position in OBJECT.
27054 Value is non-zero if a glyph was found. */
27057 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
27058 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
27060 int yb
= window_text_bottom_y (w
);
27061 struct glyph_row
*r
;
27062 struct glyph
*best_glyph
= NULL
;
27063 struct glyph_row
*best_row
= NULL
;
27066 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27067 r
->enabled_p
&& r
->y
< yb
;
27070 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
27071 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
27074 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27075 if (EQ (g
->object
, object
))
27077 if (g
->charpos
== pos
)
27084 else if (best_glyph
== NULL
27085 || ((eabs (g
->charpos
- pos
)
27086 < eabs (best_glyph
->charpos
- pos
))
27089 : g
->charpos
> pos
)))
27103 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
27107 *x
+= best_glyph
->pixel_width
;
27112 *vpos
= best_row
- w
->current_matrix
->rows
;
27115 return best_glyph
!= NULL
;
27117 #endif /* not used */
27119 /* Find the positions of the first and the last glyphs in window W's
27120 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
27121 (assumed to be a string), and return in HLINFO's mouse_face_*
27122 members the pixel and column/row coordinates of those glyphs. */
27125 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
27126 Lisp_Object object
,
27127 ptrdiff_t startpos
, ptrdiff_t endpos
)
27129 int yb
= window_text_bottom_y (w
);
27130 struct glyph_row
*r
;
27131 struct glyph
*g
, *e
;
27135 /* Find the glyph row with at least one position in the range
27136 [STARTPOS..ENDPOS], and the first glyph in that row whose
27137 position belongs to that range. */
27138 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27139 r
->enabled_p
&& r
->y
< yb
;
27142 if (!r
->reversed_p
)
27144 g
= r
->glyphs
[TEXT_AREA
];
27145 e
= g
+ r
->used
[TEXT_AREA
];
27146 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27147 if (EQ (g
->object
, object
)
27148 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27150 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27151 hlinfo
->mouse_face_beg_y
= r
->y
;
27152 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27153 hlinfo
->mouse_face_beg_x
= gx
;
27162 e
= r
->glyphs
[TEXT_AREA
];
27163 g
= e
+ r
->used
[TEXT_AREA
];
27164 for ( ; g
> e
; --g
)
27165 if (EQ ((g
-1)->object
, object
)
27166 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
27168 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27169 hlinfo
->mouse_face_beg_y
= r
->y
;
27170 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27171 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
27172 gx
+= g1
->pixel_width
;
27173 hlinfo
->mouse_face_beg_x
= gx
;
27185 /* Starting with the next row, look for the first row which does NOT
27186 include any glyphs whose positions are in the range. */
27187 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
27189 g
= r
->glyphs
[TEXT_AREA
];
27190 e
= g
+ r
->used
[TEXT_AREA
];
27192 for ( ; g
< e
; ++g
)
27193 if (EQ (g
->object
, object
)
27194 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27203 /* The highlighted region ends on the previous row. */
27206 /* Set the end row and its vertical pixel coordinate. */
27207 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
27208 hlinfo
->mouse_face_end_y
= r
->y
;
27210 /* Compute and set the end column and the end column's horizontal
27211 pixel coordinate. */
27212 if (!r
->reversed_p
)
27214 g
= r
->glyphs
[TEXT_AREA
];
27215 e
= g
+ r
->used
[TEXT_AREA
];
27216 for ( ; e
> g
; --e
)
27217 if (EQ ((e
-1)->object
, object
)
27218 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
27220 hlinfo
->mouse_face_end_col
= e
- g
;
27222 for (gx
= r
->x
; g
< e
; ++g
)
27223 gx
+= g
->pixel_width
;
27224 hlinfo
->mouse_face_end_x
= gx
;
27228 e
= r
->glyphs
[TEXT_AREA
];
27229 g
= e
+ r
->used
[TEXT_AREA
];
27230 for (gx
= r
->x
; e
< g
; ++e
)
27232 if (EQ (e
->object
, object
)
27233 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
27235 gx
+= e
->pixel_width
;
27237 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
27238 hlinfo
->mouse_face_end_x
= gx
;
27242 #ifdef HAVE_WINDOW_SYSTEM
27244 /* See if position X, Y is within a hot-spot of an image. */
27247 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
27249 if (!CONSP (hot_spot
))
27252 if (EQ (XCAR (hot_spot
), Qrect
))
27254 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27255 Lisp_Object rect
= XCDR (hot_spot
);
27259 if (!CONSP (XCAR (rect
)))
27261 if (!CONSP (XCDR (rect
)))
27263 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
27265 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
27267 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
27269 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
27273 else if (EQ (XCAR (hot_spot
), Qcircle
))
27275 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27276 Lisp_Object circ
= XCDR (hot_spot
);
27277 Lisp_Object lr
, lx0
, ly0
;
27279 && CONSP (XCAR (circ
))
27280 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
27281 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
27282 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
27284 double r
= XFLOATINT (lr
);
27285 double dx
= XINT (lx0
) - x
;
27286 double dy
= XINT (ly0
) - y
;
27287 return (dx
* dx
+ dy
* dy
<= r
* r
);
27290 else if (EQ (XCAR (hot_spot
), Qpoly
))
27292 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27293 if (VECTORP (XCDR (hot_spot
)))
27295 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
27296 Lisp_Object
*poly
= v
->contents
;
27297 ptrdiff_t n
= v
->header
.size
;
27300 Lisp_Object lx
, ly
;
27303 /* Need an even number of coordinates, and at least 3 edges. */
27304 if (n
< 6 || n
& 1)
27307 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27308 If count is odd, we are inside polygon. Pixels on edges
27309 may or may not be included depending on actual geometry of the
27311 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
27312 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
27314 x0
= XINT (lx
), y0
= XINT (ly
);
27315 for (i
= 0; i
< n
; i
+= 2)
27317 int x1
= x0
, y1
= y0
;
27318 if ((lx
= poly
[i
], !INTEGERP (lx
))
27319 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
27321 x0
= XINT (lx
), y0
= XINT (ly
);
27323 /* Does this segment cross the X line? */
27331 if (y
> y0
&& y
> y1
)
27333 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
27343 find_hot_spot (Lisp_Object map
, int x
, int y
)
27345 while (CONSP (map
))
27347 if (CONSP (XCAR (map
))
27348 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
27356 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
27358 doc
: /* Lookup in image map MAP coordinates X and Y.
27359 An image map is an alist where each element has the format (AREA ID PLIST).
27360 An AREA is specified as either a rectangle, a circle, or a polygon:
27361 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27362 pixel coordinates of the upper left and bottom right corners.
27363 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27364 and the radius of the circle; r may be a float or integer.
27365 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27366 vector describes one corner in the polygon.
27367 Returns the alist element for the first matching AREA in MAP. */)
27368 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
27376 return find_hot_spot (map
,
27377 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
27378 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
27382 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27384 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
27386 /* Do not change cursor shape while dragging mouse. */
27387 if (!NILP (do_mouse_tracking
))
27390 if (!NILP (pointer
))
27392 if (EQ (pointer
, Qarrow
))
27393 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27394 else if (EQ (pointer
, Qhand
))
27395 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27396 else if (EQ (pointer
, Qtext
))
27397 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27398 else if (EQ (pointer
, intern ("hdrag")))
27399 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27400 #ifdef HAVE_X_WINDOWS
27401 else if (EQ (pointer
, intern ("vdrag")))
27402 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27404 else if (EQ (pointer
, intern ("hourglass")))
27405 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27406 else if (EQ (pointer
, Qmodeline
))
27407 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27409 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27412 if (cursor
!= No_Cursor
)
27413 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27416 #endif /* HAVE_WINDOW_SYSTEM */
27418 /* Take proper action when mouse has moved to the mode or header line
27419 or marginal area AREA of window W, x-position X and y-position Y.
27420 X is relative to the start of the text display area of W, so the
27421 width of bitmap areas and scroll bars must be subtracted to get a
27422 position relative to the start of the mode line. */
27425 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27426 enum window_part area
)
27428 struct window
*w
= XWINDOW (window
);
27429 struct frame
*f
= XFRAME (w
->frame
);
27430 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27431 #ifdef HAVE_WINDOW_SYSTEM
27432 Display_Info
*dpyinfo
;
27434 Cursor cursor
= No_Cursor
;
27435 Lisp_Object pointer
= Qnil
;
27436 int dx
, dy
, width
, height
;
27438 Lisp_Object string
, object
= Qnil
;
27439 Lisp_Object pos
IF_LINT (= Qnil
), help
;
27441 Lisp_Object mouse_face
;
27442 int original_x_pixel
= x
;
27443 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27444 struct glyph_row
*row
IF_LINT (= 0);
27446 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27451 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27452 returns them in row/column units! */
27453 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27454 &object
, &dx
, &dy
, &width
, &height
);
27456 row
= (area
== ON_MODE_LINE
27457 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27458 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27460 /* Find the glyph under the mouse pointer. */
27461 if (row
->mode_line_p
&& row
->enabled_p
)
27463 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27464 end
= glyph
+ row
->used
[TEXT_AREA
];
27466 for (x0
= original_x_pixel
;
27467 glyph
< end
&& x0
>= glyph
->pixel_width
;
27469 x0
-= glyph
->pixel_width
;
27477 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27478 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27479 returns them in row/column units! */
27480 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27481 &object
, &dx
, &dy
, &width
, &height
);
27486 #ifdef HAVE_WINDOW_SYSTEM
27487 if (IMAGEP (object
))
27489 Lisp_Object image_map
, hotspot
;
27490 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27492 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27494 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27498 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27499 If so, we could look for mouse-enter, mouse-leave
27500 properties in PLIST (and do something...). */
27501 hotspot
= XCDR (hotspot
);
27502 if (CONSP (hotspot
)
27503 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27505 pointer
= Fplist_get (plist
, Qpointer
);
27506 if (NILP (pointer
))
27508 help
= Fplist_get (plist
, Qhelp_echo
);
27511 help_echo_string
= help
;
27512 XSETWINDOW (help_echo_window
, w
);
27513 help_echo_object
= w
->buffer
;
27514 help_echo_pos
= charpos
;
27518 if (NILP (pointer
))
27519 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27521 #endif /* HAVE_WINDOW_SYSTEM */
27523 if (STRINGP (string
))
27524 pos
= make_number (charpos
);
27526 /* Set the help text and mouse pointer. If the mouse is on a part
27527 of the mode line without any text (e.g. past the right edge of
27528 the mode line text), use the default help text and pointer. */
27529 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27531 /* Arrange to display the help by setting the global variables
27532 help_echo_string, help_echo_object, and help_echo_pos. */
27535 if (STRINGP (string
))
27536 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27540 help_echo_string
= help
;
27541 XSETWINDOW (help_echo_window
, w
);
27542 help_echo_object
= string
;
27543 help_echo_pos
= charpos
;
27545 else if (area
== ON_MODE_LINE
)
27547 Lisp_Object default_help
27548 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27551 if (STRINGP (default_help
))
27553 help_echo_string
= default_help
;
27554 XSETWINDOW (help_echo_window
, w
);
27555 help_echo_object
= Qnil
;
27556 help_echo_pos
= -1;
27561 #ifdef HAVE_WINDOW_SYSTEM
27562 /* Change the mouse pointer according to what is under it. */
27563 if (FRAME_WINDOW_P (f
))
27565 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27566 if (STRINGP (string
))
27568 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27570 if (NILP (pointer
))
27571 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27573 /* Change the mouse pointer according to what is under X/Y. */
27575 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27578 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27579 if (!KEYMAPP (map
))
27580 map
= Fget_text_property (pos
, Qkeymap
, string
);
27581 if (!KEYMAPP (map
))
27582 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27586 /* Default mode-line pointer. */
27587 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27592 /* Change the mouse face according to what is under X/Y. */
27593 if (STRINGP (string
))
27595 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27596 if (!NILP (mouse_face
)
27597 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27602 struct glyph
* tmp_glyph
;
27606 int total_pixel_width
;
27607 ptrdiff_t begpos
, endpos
, ignore
;
27611 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27612 Qmouse_face
, string
, Qnil
);
27618 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27620 endpos
= SCHARS (string
);
27624 /* Calculate the glyph position GPOS of GLYPH in the
27625 displayed string, relative to the beginning of the
27626 highlighted part of the string.
27628 Note: GPOS is different from CHARPOS. CHARPOS is the
27629 position of GLYPH in the internal string object. A mode
27630 line string format has structures which are converted to
27631 a flattened string by the Emacs Lisp interpreter. The
27632 internal string is an element of those structures. The
27633 displayed string is the flattened string. */
27634 tmp_glyph
= row_start_glyph
;
27635 while (tmp_glyph
< glyph
27636 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27637 && begpos
<= tmp_glyph
->charpos
27638 && tmp_glyph
->charpos
< endpos
)))
27640 gpos
= glyph
- tmp_glyph
;
27642 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27643 the highlighted part of the displayed string to which
27644 GLYPH belongs. Note: GSEQ_LENGTH is different from
27645 SCHARS (STRING), because the latter returns the length of
27646 the internal string. */
27647 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27649 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27650 && begpos
<= tmp_glyph
->charpos
27651 && tmp_glyph
->charpos
< endpos
));
27654 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27656 /* Calculate the total pixel width of all the glyphs between
27657 the beginning of the highlighted area and GLYPH. */
27658 total_pixel_width
= 0;
27659 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27660 total_pixel_width
+= tmp_glyph
->pixel_width
;
27662 /* Pre calculation of re-rendering position. Note: X is in
27663 column units here, after the call to mode_line_string or
27664 marginal_area_string. */
27666 vpos
= (area
== ON_MODE_LINE
27667 ? (w
->current_matrix
)->nrows
- 1
27670 /* If GLYPH's position is included in the region that is
27671 already drawn in mouse face, we have nothing to do. */
27672 if ( EQ (window
, hlinfo
->mouse_face_window
)
27673 && (!row
->reversed_p
27674 ? (hlinfo
->mouse_face_beg_col
<= hpos
27675 && hpos
< hlinfo
->mouse_face_end_col
)
27676 /* In R2L rows we swap BEG and END, see below. */
27677 : (hlinfo
->mouse_face_end_col
<= hpos
27678 && hpos
< hlinfo
->mouse_face_beg_col
))
27679 && hlinfo
->mouse_face_beg_row
== vpos
)
27682 if (clear_mouse_face (hlinfo
))
27683 cursor
= No_Cursor
;
27685 if (!row
->reversed_p
)
27687 hlinfo
->mouse_face_beg_col
= hpos
;
27688 hlinfo
->mouse_face_beg_x
= original_x_pixel
27689 - (total_pixel_width
+ dx
);
27690 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27691 hlinfo
->mouse_face_end_x
= 0;
27695 /* In R2L rows, show_mouse_face expects BEG and END
27696 coordinates to be swapped. */
27697 hlinfo
->mouse_face_end_col
= hpos
;
27698 hlinfo
->mouse_face_end_x
= original_x_pixel
27699 - (total_pixel_width
+ dx
);
27700 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27701 hlinfo
->mouse_face_beg_x
= 0;
27704 hlinfo
->mouse_face_beg_row
= vpos
;
27705 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27706 hlinfo
->mouse_face_beg_y
= 0;
27707 hlinfo
->mouse_face_end_y
= 0;
27708 hlinfo
->mouse_face_past_end
= 0;
27709 hlinfo
->mouse_face_window
= window
;
27711 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27717 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27719 if (NILP (pointer
))
27722 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27723 clear_mouse_face (hlinfo
);
27725 #ifdef HAVE_WINDOW_SYSTEM
27726 if (FRAME_WINDOW_P (f
))
27727 define_frame_cursor1 (f
, cursor
, pointer
);
27733 Take proper action when the mouse has moved to position X, Y on
27734 frame F as regards highlighting characters that have mouse-face
27735 properties. Also de-highlighting chars where the mouse was before.
27736 X and Y can be negative or out of range. */
27739 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27741 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27742 enum window_part part
= ON_NOTHING
;
27743 Lisp_Object window
;
27745 Cursor cursor
= No_Cursor
;
27746 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27749 /* When a menu is active, don't highlight because this looks odd. */
27750 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27751 if (popup_activated ())
27755 if (NILP (Vmouse_highlight
)
27756 || !f
->glyphs_initialized_p
27757 || f
->pointer_invisible
)
27760 hlinfo
->mouse_face_mouse_x
= x
;
27761 hlinfo
->mouse_face_mouse_y
= y
;
27762 hlinfo
->mouse_face_mouse_frame
= f
;
27764 if (hlinfo
->mouse_face_defer
)
27767 /* Which window is that in? */
27768 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27770 /* If displaying active text in another window, clear that. */
27771 if (! EQ (window
, hlinfo
->mouse_face_window
)
27772 /* Also clear if we move out of text area in same window. */
27773 || (!NILP (hlinfo
->mouse_face_window
)
27776 && part
!= ON_MODE_LINE
27777 && part
!= ON_HEADER_LINE
))
27778 clear_mouse_face (hlinfo
);
27780 /* Not on a window -> return. */
27781 if (!WINDOWP (window
))
27784 /* Reset help_echo_string. It will get recomputed below. */
27785 help_echo_string
= Qnil
;
27787 /* Convert to window-relative pixel coordinates. */
27788 w
= XWINDOW (window
);
27789 frame_to_window_pixel_xy (w
, &x
, &y
);
27791 #ifdef HAVE_WINDOW_SYSTEM
27792 /* Handle tool-bar window differently since it doesn't display a
27794 if (EQ (window
, f
->tool_bar_window
))
27796 note_tool_bar_highlight (f
, x
, y
);
27801 /* Mouse is on the mode, header line or margin? */
27802 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27803 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27805 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27809 #ifdef HAVE_WINDOW_SYSTEM
27810 if (part
== ON_VERTICAL_BORDER
)
27812 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27813 help_echo_string
= build_string ("drag-mouse-1: resize");
27815 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27816 || part
== ON_SCROLL_BAR
)
27817 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27819 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27822 /* Are we in a window whose display is up to date?
27823 And verify the buffer's text has not changed. */
27824 b
= XBUFFER (w
->buffer
);
27825 if (part
== ON_TEXT
27826 && EQ (w
->window_end_valid
, w
->buffer
)
27827 && w
->last_modified
== BUF_MODIFF (b
)
27828 && w
->last_overlay_modified
== BUF_OVERLAY_MODIFF (b
))
27830 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27832 struct glyph
*glyph
;
27833 Lisp_Object object
;
27834 Lisp_Object mouse_face
= Qnil
, position
;
27835 Lisp_Object
*overlay_vec
= NULL
;
27836 ptrdiff_t i
, noverlays
;
27837 struct buffer
*obuf
;
27838 ptrdiff_t obegv
, ozv
;
27841 /* Find the glyph under X/Y. */
27842 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27844 #ifdef HAVE_WINDOW_SYSTEM
27845 /* Look for :pointer property on image. */
27846 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27848 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27849 if (img
!= NULL
&& IMAGEP (img
->spec
))
27851 Lisp_Object image_map
, hotspot
;
27852 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27854 && (hotspot
= find_hot_spot (image_map
,
27855 glyph
->slice
.img
.x
+ dx
,
27856 glyph
->slice
.img
.y
+ dy
),
27858 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27862 /* Could check XCAR (hotspot) to see if we enter/leave
27864 If so, we could look for mouse-enter, mouse-leave
27865 properties in PLIST (and do something...). */
27866 hotspot
= XCDR (hotspot
);
27867 if (CONSP (hotspot
)
27868 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27870 pointer
= Fplist_get (plist
, Qpointer
);
27871 if (NILP (pointer
))
27873 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27874 if (!NILP (help_echo_string
))
27876 help_echo_window
= window
;
27877 help_echo_object
= glyph
->object
;
27878 help_echo_pos
= glyph
->charpos
;
27882 if (NILP (pointer
))
27883 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27886 #endif /* HAVE_WINDOW_SYSTEM */
27888 /* Clear mouse face if X/Y not over text. */
27890 || area
!= TEXT_AREA
27891 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27892 /* Glyph's OBJECT is an integer for glyphs inserted by the
27893 display engine for its internal purposes, like truncation
27894 and continuation glyphs and blanks beyond the end of
27895 line's text on text terminals. If we are over such a
27896 glyph, we are not over any text. */
27897 || INTEGERP (glyph
->object
)
27898 /* R2L rows have a stretch glyph at their front, which
27899 stands for no text, whereas L2R rows have no glyphs at
27900 all beyond the end of text. Treat such stretch glyphs
27901 like we do with NULL glyphs in L2R rows. */
27902 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27903 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27904 && glyph
->type
== STRETCH_GLYPH
27905 && glyph
->avoid_cursor_p
))
27907 if (clear_mouse_face (hlinfo
))
27908 cursor
= No_Cursor
;
27909 #ifdef HAVE_WINDOW_SYSTEM
27910 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27912 if (area
!= TEXT_AREA
)
27913 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27915 pointer
= Vvoid_text_area_pointer
;
27921 pos
= glyph
->charpos
;
27922 object
= glyph
->object
;
27923 if (!STRINGP (object
) && !BUFFERP (object
))
27926 /* If we get an out-of-range value, return now; avoid an error. */
27927 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27930 /* Make the window's buffer temporarily current for
27931 overlays_at and compute_char_face. */
27932 obuf
= current_buffer
;
27933 current_buffer
= b
;
27939 /* Is this char mouse-active or does it have help-echo? */
27940 position
= make_number (pos
);
27942 if (BUFFERP (object
))
27944 /* Put all the overlays we want in a vector in overlay_vec. */
27945 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27946 /* Sort overlays into increasing priority order. */
27947 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27952 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27955 cursor
= No_Cursor
;
27957 /* Check mouse-face highlighting. */
27959 /* If there exists an overlay with mouse-face overlapping
27960 the one we are currently highlighting, we have to
27961 check if we enter the overlapping overlay, and then
27962 highlight only that. */
27963 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27964 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27966 /* Find the highest priority overlay with a mouse-face. */
27967 Lisp_Object overlay
= Qnil
;
27968 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27970 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27971 if (!NILP (mouse_face
))
27972 overlay
= overlay_vec
[i
];
27975 /* If we're highlighting the same overlay as before, there's
27976 no need to do that again. */
27977 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27978 goto check_help_echo
;
27979 hlinfo
->mouse_face_overlay
= overlay
;
27981 /* Clear the display of the old active region, if any. */
27982 if (clear_mouse_face (hlinfo
))
27983 cursor
= No_Cursor
;
27985 /* If no overlay applies, get a text property. */
27986 if (NILP (overlay
))
27987 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27989 /* Next, compute the bounds of the mouse highlighting and
27991 if (!NILP (mouse_face
) && STRINGP (object
))
27993 /* The mouse-highlighting comes from a display string
27994 with a mouse-face. */
27998 s
= Fprevious_single_property_change
27999 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
28000 e
= Fnext_single_property_change
28001 (position
, Qmouse_face
, object
, Qnil
);
28003 s
= make_number (0);
28005 e
= make_number (SCHARS (object
) - 1);
28006 mouse_face_from_string_pos (w
, hlinfo
, object
,
28007 XINT (s
), XINT (e
));
28008 hlinfo
->mouse_face_past_end
= 0;
28009 hlinfo
->mouse_face_window
= window
;
28010 hlinfo
->mouse_face_face_id
28011 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
28012 glyph
->face_id
, 1);
28013 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28014 cursor
= No_Cursor
;
28018 /* The mouse-highlighting, if any, comes from an overlay
28019 or text property in the buffer. */
28020 Lisp_Object buffer
IF_LINT (= Qnil
);
28021 Lisp_Object disp_string
IF_LINT (= Qnil
);
28023 if (STRINGP (object
))
28025 /* If we are on a display string with no mouse-face,
28026 check if the text under it has one. */
28027 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
28028 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28029 pos
= string_buffer_position (object
, start
);
28032 mouse_face
= get_char_property_and_overlay
28033 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
28034 buffer
= w
->buffer
;
28035 disp_string
= object
;
28041 disp_string
= Qnil
;
28044 if (!NILP (mouse_face
))
28046 Lisp_Object before
, after
;
28047 Lisp_Object before_string
, after_string
;
28048 /* To correctly find the limits of mouse highlight
28049 in a bidi-reordered buffer, we must not use the
28050 optimization of limiting the search in
28051 previous-single-property-change and
28052 next-single-property-change, because
28053 rows_from_pos_range needs the real start and end
28054 positions to DTRT in this case. That's because
28055 the first row visible in a window does not
28056 necessarily display the character whose position
28057 is the smallest. */
28059 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
28060 ? Fmarker_position (w
->start
)
28063 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
28064 ? make_number (BUF_Z (XBUFFER (buffer
))
28065 - XFASTINT (w
->window_end_pos
))
28068 if (NILP (overlay
))
28070 /* Handle the text property case. */
28071 before
= Fprevious_single_property_change
28072 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
28073 after
= Fnext_single_property_change
28074 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
28075 before_string
= after_string
= Qnil
;
28079 /* Handle the overlay case. */
28080 before
= Foverlay_start (overlay
);
28081 after
= Foverlay_end (overlay
);
28082 before_string
= Foverlay_get (overlay
, Qbefore_string
);
28083 after_string
= Foverlay_get (overlay
, Qafter_string
);
28085 if (!STRINGP (before_string
)) before_string
= Qnil
;
28086 if (!STRINGP (after_string
)) after_string
= Qnil
;
28089 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
28092 : XFASTINT (before
),
28094 ? BUF_Z (XBUFFER (buffer
))
28095 : XFASTINT (after
),
28096 before_string
, after_string
,
28098 cursor
= No_Cursor
;
28105 /* Look for a `help-echo' property. */
28106 if (NILP (help_echo_string
)) {
28107 Lisp_Object help
, overlay
;
28109 /* Check overlays first. */
28110 help
= overlay
= Qnil
;
28111 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
28113 overlay
= overlay_vec
[i
];
28114 help
= Foverlay_get (overlay
, Qhelp_echo
);
28119 help_echo_string
= help
;
28120 help_echo_window
= window
;
28121 help_echo_object
= overlay
;
28122 help_echo_pos
= pos
;
28126 Lisp_Object obj
= glyph
->object
;
28127 ptrdiff_t charpos
= glyph
->charpos
;
28129 /* Try text properties. */
28132 && charpos
< SCHARS (obj
))
28134 help
= Fget_text_property (make_number (charpos
),
28138 /* If the string itself doesn't specify a help-echo,
28139 see if the buffer text ``under'' it does. */
28140 struct glyph_row
*r
28141 = MATRIX_ROW (w
->current_matrix
, vpos
);
28142 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28143 ptrdiff_t p
= string_buffer_position (obj
, start
);
28146 help
= Fget_char_property (make_number (p
),
28147 Qhelp_echo
, w
->buffer
);
28156 else if (BUFFERP (obj
)
28159 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
28164 help_echo_string
= help
;
28165 help_echo_window
= window
;
28166 help_echo_object
= obj
;
28167 help_echo_pos
= charpos
;
28172 #ifdef HAVE_WINDOW_SYSTEM
28173 /* Look for a `pointer' property. */
28174 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28176 /* Check overlays first. */
28177 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
28178 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
28180 if (NILP (pointer
))
28182 Lisp_Object obj
= glyph
->object
;
28183 ptrdiff_t charpos
= glyph
->charpos
;
28185 /* Try text properties. */
28188 && charpos
< SCHARS (obj
))
28190 pointer
= Fget_text_property (make_number (charpos
),
28192 if (NILP (pointer
))
28194 /* If the string itself doesn't specify a pointer,
28195 see if the buffer text ``under'' it does. */
28196 struct glyph_row
*r
28197 = MATRIX_ROW (w
->current_matrix
, vpos
);
28198 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28199 ptrdiff_t p
= string_buffer_position (obj
, start
);
28201 pointer
= Fget_char_property (make_number (p
),
28202 Qpointer
, w
->buffer
);
28205 else if (BUFFERP (obj
)
28208 pointer
= Fget_text_property (make_number (charpos
),
28212 #endif /* HAVE_WINDOW_SYSTEM */
28216 current_buffer
= obuf
;
28221 #ifdef HAVE_WINDOW_SYSTEM
28222 if (FRAME_WINDOW_P (f
))
28223 define_frame_cursor1 (f
, cursor
, pointer
);
28225 /* This is here to prevent a compiler error, about "label at end of
28226 compound statement". */
28233 Clear any mouse-face on window W. This function is part of the
28234 redisplay interface, and is called from try_window_id and similar
28235 functions to ensure the mouse-highlight is off. */
28238 x_clear_window_mouse_face (struct window
*w
)
28240 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28241 Lisp_Object window
;
28244 XSETWINDOW (window
, w
);
28245 if (EQ (window
, hlinfo
->mouse_face_window
))
28246 clear_mouse_face (hlinfo
);
28252 Just discard the mouse face information for frame F, if any.
28253 This is used when the size of F is changed. */
28256 cancel_mouse_face (struct frame
*f
)
28258 Lisp_Object window
;
28259 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28261 window
= hlinfo
->mouse_face_window
;
28262 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
28264 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28265 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28266 hlinfo
->mouse_face_window
= Qnil
;
28272 /***********************************************************************
28274 ***********************************************************************/
28276 #ifdef HAVE_WINDOW_SYSTEM
28278 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28279 which intersects rectangle R. R is in window-relative coordinates. */
28282 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
28283 enum glyph_row_area area
)
28285 struct glyph
*first
= row
->glyphs
[area
];
28286 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
28287 struct glyph
*last
;
28288 int first_x
, start_x
, x
;
28290 if (area
== TEXT_AREA
&& row
->fill_line_p
)
28291 /* If row extends face to end of line write the whole line. */
28292 draw_glyphs (w
, 0, row
, area
,
28293 0, row
->used
[area
],
28294 DRAW_NORMAL_TEXT
, 0);
28297 /* Set START_X to the window-relative start position for drawing glyphs of
28298 AREA. The first glyph of the text area can be partially visible.
28299 The first glyphs of other areas cannot. */
28300 start_x
= window_box_left_offset (w
, area
);
28302 if (area
== TEXT_AREA
)
28305 /* Find the first glyph that must be redrawn. */
28307 && x
+ first
->pixel_width
< r
->x
)
28309 x
+= first
->pixel_width
;
28313 /* Find the last one. */
28317 && x
< r
->x
+ r
->width
)
28319 x
+= last
->pixel_width
;
28325 draw_glyphs (w
, first_x
- start_x
, row
, area
,
28326 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
28327 DRAW_NORMAL_TEXT
, 0);
28332 /* Redraw the parts of the glyph row ROW on window W intersecting
28333 rectangle R. R is in window-relative coordinates. Value is
28334 non-zero if mouse-face was overwritten. */
28337 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
28339 eassert (row
->enabled_p
);
28341 if (row
->mode_line_p
|| w
->pseudo_window_p
)
28342 draw_glyphs (w
, 0, row
, TEXT_AREA
,
28343 0, row
->used
[TEXT_AREA
],
28344 DRAW_NORMAL_TEXT
, 0);
28347 if (row
->used
[LEFT_MARGIN_AREA
])
28348 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
28349 if (row
->used
[TEXT_AREA
])
28350 expose_area (w
, row
, r
, TEXT_AREA
);
28351 if (row
->used
[RIGHT_MARGIN_AREA
])
28352 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
28353 draw_row_fringe_bitmaps (w
, row
);
28356 return row
->mouse_face_p
;
28360 /* Redraw those parts of glyphs rows during expose event handling that
28361 overlap other rows. Redrawing of an exposed line writes over parts
28362 of lines overlapping that exposed line; this function fixes that.
28364 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28365 row in W's current matrix that is exposed and overlaps other rows.
28366 LAST_OVERLAPPING_ROW is the last such row. */
28369 expose_overlaps (struct window
*w
,
28370 struct glyph_row
*first_overlapping_row
,
28371 struct glyph_row
*last_overlapping_row
,
28374 struct glyph_row
*row
;
28376 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
28377 if (row
->overlapping_p
)
28379 eassert (row
->enabled_p
&& !row
->mode_line_p
);
28382 if (row
->used
[LEFT_MARGIN_AREA
])
28383 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
28385 if (row
->used
[TEXT_AREA
])
28386 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
28388 if (row
->used
[RIGHT_MARGIN_AREA
])
28389 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
28395 /* Return non-zero if W's cursor intersects rectangle R. */
28398 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
28400 XRectangle cr
, result
;
28401 struct glyph
*cursor_glyph
;
28402 struct glyph_row
*row
;
28404 if (w
->phys_cursor
.vpos
>= 0
28405 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
28406 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
28408 && row
->cursor_in_fringe_p
)
28410 /* Cursor is in the fringe. */
28411 cr
.x
= window_box_right_offset (w
,
28412 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
28413 ? RIGHT_MARGIN_AREA
28416 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
28417 cr
.height
= row
->height
;
28418 return x_intersect_rectangles (&cr
, r
, &result
);
28421 cursor_glyph
= get_phys_cursor_glyph (w
);
28424 /* r is relative to W's box, but w->phys_cursor.x is relative
28425 to left edge of W's TEXT area. Adjust it. */
28426 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28427 cr
.y
= w
->phys_cursor
.y
;
28428 cr
.width
= cursor_glyph
->pixel_width
;
28429 cr
.height
= w
->phys_cursor_height
;
28430 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28431 I assume the effect is the same -- and this is portable. */
28432 return x_intersect_rectangles (&cr
, r
, &result
);
28434 /* If we don't understand the format, pretend we're not in the hot-spot. */
28440 Draw a vertical window border to the right of window W if W doesn't
28441 have vertical scroll bars. */
28444 x_draw_vertical_border (struct window
*w
)
28446 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28448 /* We could do better, if we knew what type of scroll-bar the adjacent
28449 windows (on either side) have... But we don't :-(
28450 However, I think this works ok. ++KFS 2003-04-25 */
28452 /* Redraw borders between horizontally adjacent windows. Don't
28453 do it for frames with vertical scroll bars because either the
28454 right scroll bar of a window, or the left scroll bar of its
28455 neighbor will suffice as a border. */
28456 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28459 if (!WINDOW_RIGHTMOST_P (w
)
28460 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28462 int x0
, x1
, y0
, y1
;
28464 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28467 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28470 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28472 else if (!WINDOW_LEFTMOST_P (w
)
28473 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28475 int x0
, x1
, y0
, y1
;
28477 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28480 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28483 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28488 /* Redraw the part of window W intersection rectangle FR. Pixel
28489 coordinates in FR are frame-relative. Call this function with
28490 input blocked. Value is non-zero if the exposure overwrites
28494 expose_window (struct window
*w
, XRectangle
*fr
)
28496 struct frame
*f
= XFRAME (w
->frame
);
28498 int mouse_face_overwritten_p
= 0;
28500 /* If window is not yet fully initialized, do nothing. This can
28501 happen when toolkit scroll bars are used and a window is split.
28502 Reconfiguring the scroll bar will generate an expose for a newly
28504 if (w
->current_matrix
== NULL
)
28507 /* When we're currently updating the window, display and current
28508 matrix usually don't agree. Arrange for a thorough display
28510 if (w
== updated_window
)
28512 SET_FRAME_GARBAGED (f
);
28516 /* Frame-relative pixel rectangle of W. */
28517 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28518 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28519 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28520 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28522 if (x_intersect_rectangles (fr
, &wr
, &r
))
28524 int yb
= window_text_bottom_y (w
);
28525 struct glyph_row
*row
;
28526 int cursor_cleared_p
, phys_cursor_on_p
;
28527 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28529 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28530 r
.x
, r
.y
, r
.width
, r
.height
));
28532 /* Convert to window coordinates. */
28533 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28534 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28536 /* Turn off the cursor. */
28537 if (!w
->pseudo_window_p
28538 && phys_cursor_in_rect_p (w
, &r
))
28540 x_clear_cursor (w
);
28541 cursor_cleared_p
= 1;
28544 cursor_cleared_p
= 0;
28546 /* If the row containing the cursor extends face to end of line,
28547 then expose_area might overwrite the cursor outside the
28548 rectangle and thus notice_overwritten_cursor might clear
28549 w->phys_cursor_on_p. We remember the original value and
28550 check later if it is changed. */
28551 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28553 /* Update lines intersecting rectangle R. */
28554 first_overlapping_row
= last_overlapping_row
= NULL
;
28555 for (row
= w
->current_matrix
->rows
;
28560 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28562 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28563 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28564 || (r
.y
>= y0
&& r
.y
< y1
)
28565 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28567 /* A header line may be overlapping, but there is no need
28568 to fix overlapping areas for them. KFS 2005-02-12 */
28569 if (row
->overlapping_p
&& !row
->mode_line_p
)
28571 if (first_overlapping_row
== NULL
)
28572 first_overlapping_row
= row
;
28573 last_overlapping_row
= row
;
28577 if (expose_line (w
, row
, &r
))
28578 mouse_face_overwritten_p
= 1;
28581 else if (row
->overlapping_p
)
28583 /* We must redraw a row overlapping the exposed area. */
28585 ? y0
+ row
->phys_height
> r
.y
28586 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28588 if (first_overlapping_row
== NULL
)
28589 first_overlapping_row
= row
;
28590 last_overlapping_row
= row
;
28598 /* Display the mode line if there is one. */
28599 if (WINDOW_WANTS_MODELINE_P (w
)
28600 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28602 && row
->y
< r
.y
+ r
.height
)
28604 if (expose_line (w
, row
, &r
))
28605 mouse_face_overwritten_p
= 1;
28608 if (!w
->pseudo_window_p
)
28610 /* Fix the display of overlapping rows. */
28611 if (first_overlapping_row
)
28612 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28615 /* Draw border between windows. */
28616 x_draw_vertical_border (w
);
28618 /* Turn the cursor on again. */
28619 if (cursor_cleared_p
28620 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28621 update_window_cursor (w
, 1);
28625 return mouse_face_overwritten_p
;
28630 /* Redraw (parts) of all windows in the window tree rooted at W that
28631 intersect R. R contains frame pixel coordinates. Value is
28632 non-zero if the exposure overwrites mouse-face. */
28635 expose_window_tree (struct window
*w
, XRectangle
*r
)
28637 struct frame
*f
= XFRAME (w
->frame
);
28638 int mouse_face_overwritten_p
= 0;
28640 while (w
&& !FRAME_GARBAGED_P (f
))
28642 if (!NILP (w
->hchild
))
28643 mouse_face_overwritten_p
28644 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28645 else if (!NILP (w
->vchild
))
28646 mouse_face_overwritten_p
28647 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28649 mouse_face_overwritten_p
|= expose_window (w
, r
);
28651 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28654 return mouse_face_overwritten_p
;
28659 Redisplay an exposed area of frame F. X and Y are the upper-left
28660 corner of the exposed rectangle. W and H are width and height of
28661 the exposed area. All are pixel values. W or H zero means redraw
28662 the entire frame. */
28665 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28668 int mouse_face_overwritten_p
= 0;
28670 TRACE ((stderr
, "expose_frame "));
28672 /* No need to redraw if frame will be redrawn soon. */
28673 if (FRAME_GARBAGED_P (f
))
28675 TRACE ((stderr
, " garbaged\n"));
28679 /* If basic faces haven't been realized yet, there is no point in
28680 trying to redraw anything. This can happen when we get an expose
28681 event while Emacs is starting, e.g. by moving another window. */
28682 if (FRAME_FACE_CACHE (f
) == NULL
28683 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28685 TRACE ((stderr
, " no faces\n"));
28689 if (w
== 0 || h
== 0)
28692 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28693 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28703 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28704 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28706 if (WINDOWP (f
->tool_bar_window
))
28707 mouse_face_overwritten_p
28708 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28710 #ifdef HAVE_X_WINDOWS
28712 #ifndef USE_X_TOOLKIT
28713 if (WINDOWP (f
->menu_bar_window
))
28714 mouse_face_overwritten_p
28715 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28716 #endif /* not USE_X_TOOLKIT */
28720 /* Some window managers support a focus-follows-mouse style with
28721 delayed raising of frames. Imagine a partially obscured frame,
28722 and moving the mouse into partially obscured mouse-face on that
28723 frame. The visible part of the mouse-face will be highlighted,
28724 then the WM raises the obscured frame. With at least one WM, KDE
28725 2.1, Emacs is not getting any event for the raising of the frame
28726 (even tried with SubstructureRedirectMask), only Expose events.
28727 These expose events will draw text normally, i.e. not
28728 highlighted. Which means we must redo the highlight here.
28729 Subsume it under ``we love X''. --gerd 2001-08-15 */
28730 /* Included in Windows version because Windows most likely does not
28731 do the right thing if any third party tool offers
28732 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28733 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28735 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28736 if (f
== hlinfo
->mouse_face_mouse_frame
)
28738 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28739 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28740 clear_mouse_face (hlinfo
);
28741 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28748 Determine the intersection of two rectangles R1 and R2. Return
28749 the intersection in *RESULT. Value is non-zero if RESULT is not
28753 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28755 XRectangle
*left
, *right
;
28756 XRectangle
*upper
, *lower
;
28757 int intersection_p
= 0;
28759 /* Rearrange so that R1 is the left-most rectangle. */
28761 left
= r1
, right
= r2
;
28763 left
= r2
, right
= r1
;
28765 /* X0 of the intersection is right.x0, if this is inside R1,
28766 otherwise there is no intersection. */
28767 if (right
->x
<= left
->x
+ left
->width
)
28769 result
->x
= right
->x
;
28771 /* The right end of the intersection is the minimum of
28772 the right ends of left and right. */
28773 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28776 /* Same game for Y. */
28778 upper
= r1
, lower
= r2
;
28780 upper
= r2
, lower
= r1
;
28782 /* The upper end of the intersection is lower.y0, if this is inside
28783 of upper. Otherwise, there is no intersection. */
28784 if (lower
->y
<= upper
->y
+ upper
->height
)
28786 result
->y
= lower
->y
;
28788 /* The lower end of the intersection is the minimum of the lower
28789 ends of upper and lower. */
28790 result
->height
= (min (lower
->y
+ lower
->height
,
28791 upper
->y
+ upper
->height
)
28793 intersection_p
= 1;
28797 return intersection_p
;
28800 #endif /* HAVE_WINDOW_SYSTEM */
28803 /***********************************************************************
28805 ***********************************************************************/
28808 syms_of_xdisp (void)
28810 Vwith_echo_area_save_vector
= Qnil
;
28811 staticpro (&Vwith_echo_area_save_vector
);
28813 Vmessage_stack
= Qnil
;
28814 staticpro (&Vmessage_stack
);
28816 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28817 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
28819 message_dolog_marker1
= Fmake_marker ();
28820 staticpro (&message_dolog_marker1
);
28821 message_dolog_marker2
= Fmake_marker ();
28822 staticpro (&message_dolog_marker2
);
28823 message_dolog_marker3
= Fmake_marker ();
28824 staticpro (&message_dolog_marker3
);
28827 defsubr (&Sdump_frame_glyph_matrix
);
28828 defsubr (&Sdump_glyph_matrix
);
28829 defsubr (&Sdump_glyph_row
);
28830 defsubr (&Sdump_tool_bar_row
);
28831 defsubr (&Strace_redisplay
);
28832 defsubr (&Strace_to_stderr
);
28834 #ifdef HAVE_WINDOW_SYSTEM
28835 defsubr (&Stool_bar_lines_needed
);
28836 defsubr (&Slookup_image_map
);
28838 defsubr (&Sformat_mode_line
);
28839 defsubr (&Sinvisible_p
);
28840 defsubr (&Scurrent_bidi_paragraph_direction
);
28842 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28843 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28844 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28845 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28846 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28847 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28848 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28849 DEFSYM (Qeval
, "eval");
28850 DEFSYM (QCdata
, ":data");
28851 DEFSYM (Qdisplay
, "display");
28852 DEFSYM (Qspace_width
, "space-width");
28853 DEFSYM (Qraise
, "raise");
28854 DEFSYM (Qslice
, "slice");
28855 DEFSYM (Qspace
, "space");
28856 DEFSYM (Qmargin
, "margin");
28857 DEFSYM (Qpointer
, "pointer");
28858 DEFSYM (Qleft_margin
, "left-margin");
28859 DEFSYM (Qright_margin
, "right-margin");
28860 DEFSYM (Qcenter
, "center");
28861 DEFSYM (Qline_height
, "line-height");
28862 DEFSYM (QCalign_to
, ":align-to");
28863 DEFSYM (QCrelative_width
, ":relative-width");
28864 DEFSYM (QCrelative_height
, ":relative-height");
28865 DEFSYM (QCeval
, ":eval");
28866 DEFSYM (QCpropertize
, ":propertize");
28867 DEFSYM (QCfile
, ":file");
28868 DEFSYM (Qfontified
, "fontified");
28869 DEFSYM (Qfontification_functions
, "fontification-functions");
28870 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28871 DEFSYM (Qescape_glyph
, "escape-glyph");
28872 DEFSYM (Qnobreak_space
, "nobreak-space");
28873 DEFSYM (Qimage
, "image");
28874 DEFSYM (Qtext
, "text");
28875 DEFSYM (Qboth
, "both");
28876 DEFSYM (Qboth_horiz
, "both-horiz");
28877 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28878 DEFSYM (QCmap
, ":map");
28879 DEFSYM (QCpointer
, ":pointer");
28880 DEFSYM (Qrect
, "rect");
28881 DEFSYM (Qcircle
, "circle");
28882 DEFSYM (Qpoly
, "poly");
28883 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28884 DEFSYM (Qgrow_only
, "grow-only");
28885 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28886 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28887 DEFSYM (Qposition
, "position");
28888 DEFSYM (Qbuffer_position
, "buffer-position");
28889 DEFSYM (Qobject
, "object");
28890 DEFSYM (Qbar
, "bar");
28891 DEFSYM (Qhbar
, "hbar");
28892 DEFSYM (Qbox
, "box");
28893 DEFSYM (Qhollow
, "hollow");
28894 DEFSYM (Qhand
, "hand");
28895 DEFSYM (Qarrow
, "arrow");
28896 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28898 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28899 Fcons (intern_c_string ("void-variable"), Qnil
)),
28901 staticpro (&list_of_error
);
28903 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28904 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28905 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28906 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28908 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28909 staticpro (&echo_buffer
[0]);
28910 staticpro (&echo_buffer
[1]);
28912 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28913 staticpro (&echo_area_buffer
[0]);
28914 staticpro (&echo_area_buffer
[1]);
28916 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
28917 staticpro (&Vmessages_buffer_name
);
28919 mode_line_proptrans_alist
= Qnil
;
28920 staticpro (&mode_line_proptrans_alist
);
28921 mode_line_string_list
= Qnil
;
28922 staticpro (&mode_line_string_list
);
28923 mode_line_string_face
= Qnil
;
28924 staticpro (&mode_line_string_face
);
28925 mode_line_string_face_prop
= Qnil
;
28926 staticpro (&mode_line_string_face_prop
);
28927 Vmode_line_unwind_vector
= Qnil
;
28928 staticpro (&Vmode_line_unwind_vector
);
28930 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
28932 help_echo_string
= Qnil
;
28933 staticpro (&help_echo_string
);
28934 help_echo_object
= Qnil
;
28935 staticpro (&help_echo_object
);
28936 help_echo_window
= Qnil
;
28937 staticpro (&help_echo_window
);
28938 previous_help_echo_string
= Qnil
;
28939 staticpro (&previous_help_echo_string
);
28940 help_echo_pos
= -1;
28942 DEFSYM (Qright_to_left
, "right-to-left");
28943 DEFSYM (Qleft_to_right
, "left-to-right");
28945 #ifdef HAVE_WINDOW_SYSTEM
28946 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28947 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
28948 For example, if a block cursor is over a tab, it will be drawn as
28949 wide as that tab on the display. */);
28950 x_stretch_cursor_p
= 0;
28953 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28954 doc
: /* Non-nil means highlight trailing whitespace.
28955 The face used for trailing whitespace is `trailing-whitespace'. */);
28956 Vshow_trailing_whitespace
= Qnil
;
28958 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28959 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28960 If the value is t, Emacs highlights non-ASCII chars which have the
28961 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28962 or `escape-glyph' face respectively.
28964 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28965 U+2011 (non-breaking hyphen) are affected.
28967 Any other non-nil value means to display these characters as a escape
28968 glyph followed by an ordinary space or hyphen.
28970 A value of nil means no special handling of these characters. */);
28971 Vnobreak_char_display
= Qt
;
28973 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28974 doc
: /* The pointer shape to show in void text areas.
28975 A value of nil means to show the text pointer. Other options are `arrow',
28976 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28977 Vvoid_text_area_pointer
= Qarrow
;
28979 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28980 doc
: /* Non-nil means don't actually do any redisplay.
28981 This is used for internal purposes. */);
28982 Vinhibit_redisplay
= Qnil
;
28984 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28985 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28986 Vglobal_mode_string
= Qnil
;
28988 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28989 doc
: /* Marker for where to display an arrow on top of the buffer text.
28990 This must be the beginning of a line in order to work.
28991 See also `overlay-arrow-string'. */);
28992 Voverlay_arrow_position
= Qnil
;
28994 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28995 doc
: /* String to display as an arrow in non-window frames.
28996 See also `overlay-arrow-position'. */);
28997 Voverlay_arrow_string
= build_pure_c_string ("=>");
28999 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
29000 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
29001 The symbols on this list are examined during redisplay to determine
29002 where to display overlay arrows. */);
29003 Voverlay_arrow_variable_list
29004 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
29006 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
29007 doc
: /* The number of lines to try scrolling a window by when point moves out.
29008 If that fails to bring point back on frame, point is centered instead.
29009 If this is zero, point is always centered after it moves off frame.
29010 If you want scrolling to always be a line at a time, you should set
29011 `scroll-conservatively' to a large value rather than set this to 1. */);
29013 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
29014 doc
: /* Scroll up to this many lines, to bring point back on screen.
29015 If point moves off-screen, redisplay will scroll by up to
29016 `scroll-conservatively' lines in order to bring point just barely
29017 onto the screen again. If that cannot be done, then redisplay
29018 recenters point as usual.
29020 If the value is greater than 100, redisplay will never recenter point,
29021 but will always scroll just enough text to bring point into view, even
29022 if you move far away.
29024 A value of zero means always recenter point if it moves off screen. */);
29025 scroll_conservatively
= 0;
29027 DEFVAR_INT ("scroll-margin", scroll_margin
,
29028 doc
: /* Number of lines of margin at the top and bottom of a window.
29029 Recenter the window whenever point gets within this many lines
29030 of the top or bottom of the window. */);
29033 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
29034 doc
: /* Pixels per inch value for non-window system displays.
29035 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
29036 Vdisplay_pixels_per_inch
= make_float (72.0);
29039 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
29042 DEFVAR_LISP ("truncate-partial-width-windows",
29043 Vtruncate_partial_width_windows
,
29044 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
29045 For an integer value, truncate lines in each window narrower than the
29046 full frame width, provided the window width is less than that integer;
29047 otherwise, respect the value of `truncate-lines'.
29049 For any other non-nil value, truncate lines in all windows that do
29050 not span the full frame width.
29052 A value of nil means to respect the value of `truncate-lines'.
29054 If `word-wrap' is enabled, you might want to reduce this. */);
29055 Vtruncate_partial_width_windows
= make_number (50);
29057 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
29058 doc
: /* Maximum buffer size for which line number should be displayed.
29059 If the buffer is bigger than this, the line number does not appear
29060 in the mode line. A value of nil means no limit. */);
29061 Vline_number_display_limit
= Qnil
;
29063 DEFVAR_INT ("line-number-display-limit-width",
29064 line_number_display_limit_width
,
29065 doc
: /* Maximum line width (in characters) for line number display.
29066 If the average length of the lines near point is bigger than this, then the
29067 line number may be omitted from the mode line. */);
29068 line_number_display_limit_width
= 200;
29070 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
29071 doc
: /* Non-nil means highlight region even in nonselected windows. */);
29072 highlight_nonselected_windows
= 0;
29074 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
29075 doc
: /* Non-nil if more than one frame is visible on this display.
29076 Minibuffer-only frames don't count, but iconified frames do.
29077 This variable is not guaranteed to be accurate except while processing
29078 `frame-title-format' and `icon-title-format'. */);
29080 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
29081 doc
: /* Template for displaying the title bar of visible frames.
29082 \(Assuming the window manager supports this feature.)
29084 This variable has the same structure as `mode-line-format', except that
29085 the %c and %l constructs are ignored. It is used only on frames for
29086 which no explicit name has been set \(see `modify-frame-parameters'). */);
29088 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
29089 doc
: /* Template for displaying the title bar of an iconified frame.
29090 \(Assuming the window manager supports this feature.)
29091 This variable has the same structure as `mode-line-format' (which see),
29092 and is used only on frames for which no explicit name has been set
29093 \(see `modify-frame-parameters'). */);
29095 = Vframe_title_format
29096 = listn (CONSTYPE_PURE
, 3,
29097 intern_c_string ("multiple-frames"),
29098 build_pure_c_string ("%b"),
29099 listn (CONSTYPE_PURE
, 4,
29100 empty_unibyte_string
,
29101 intern_c_string ("invocation-name"),
29102 build_pure_c_string ("@"),
29103 intern_c_string ("system-name")));
29105 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
29106 doc
: /* Maximum number of lines to keep in the message log buffer.
29107 If nil, disable message logging. If t, log messages but don't truncate
29108 the buffer when it becomes large. */);
29109 Vmessage_log_max
= make_number (1000);
29111 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
29112 doc
: /* Functions called before redisplay, if window sizes have changed.
29113 The value should be a list of functions that take one argument.
29114 Just before redisplay, for each frame, if any of its windows have changed
29115 size since the last redisplay, or have been split or deleted,
29116 all the functions in the list are called, with the frame as argument. */);
29117 Vwindow_size_change_functions
= Qnil
;
29119 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
29120 doc
: /* List of functions to call before redisplaying a window with scrolling.
29121 Each function is called with two arguments, the window and its new
29122 display-start position. Note that these functions are also called by
29123 `set-window-buffer'. Also note that the value of `window-end' is not
29124 valid when these functions are called.
29126 Warning: Do not use this feature to alter the way the window
29127 is scrolled. It is not designed for that, and such use probably won't
29129 Vwindow_scroll_functions
= Qnil
;
29131 DEFVAR_LISP ("window-text-change-functions",
29132 Vwindow_text_change_functions
,
29133 doc
: /* Functions to call in redisplay when text in the window might change. */);
29134 Vwindow_text_change_functions
= Qnil
;
29136 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
29137 doc
: /* Functions called when redisplay of a window reaches the end trigger.
29138 Each function is called with two arguments, the window and the end trigger value.
29139 See `set-window-redisplay-end-trigger'. */);
29140 Vredisplay_end_trigger_functions
= Qnil
;
29142 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
29143 doc
: /* Non-nil means autoselect window with mouse pointer.
29144 If nil, do not autoselect windows.
29145 A positive number means delay autoselection by that many seconds: a
29146 window is autoselected only after the mouse has remained in that
29147 window for the duration of the delay.
29148 A negative number has a similar effect, but causes windows to be
29149 autoselected only after the mouse has stopped moving. \(Because of
29150 the way Emacs compares mouse events, you will occasionally wait twice
29151 that time before the window gets selected.\)
29152 Any other value means to autoselect window instantaneously when the
29153 mouse pointer enters it.
29155 Autoselection selects the minibuffer only if it is active, and never
29156 unselects the minibuffer if it is active.
29158 When customizing this variable make sure that the actual value of
29159 `focus-follows-mouse' matches the behavior of your window manager. */);
29160 Vmouse_autoselect_window
= Qnil
;
29162 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
29163 doc
: /* Non-nil means automatically resize tool-bars.
29164 This dynamically changes the tool-bar's height to the minimum height
29165 that is needed to make all tool-bar items visible.
29166 If value is `grow-only', the tool-bar's height is only increased
29167 automatically; to decrease the tool-bar height, use \\[recenter]. */);
29168 Vauto_resize_tool_bars
= Qt
;
29170 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
29171 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
29172 auto_raise_tool_bar_buttons_p
= 1;
29174 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
29175 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
29176 make_cursor_line_fully_visible_p
= 1;
29178 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
29179 doc
: /* Border below tool-bar in pixels.
29180 If an integer, use it as the height of the border.
29181 If it is one of `internal-border-width' or `border-width', use the
29182 value of the corresponding frame parameter.
29183 Otherwise, no border is added below the tool-bar. */);
29184 Vtool_bar_border
= Qinternal_border_width
;
29186 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
29187 doc
: /* Margin around tool-bar buttons in pixels.
29188 If an integer, use that for both horizontal and vertical margins.
29189 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
29190 HORZ specifying the horizontal margin, and VERT specifying the
29191 vertical margin. */);
29192 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
29194 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
29195 doc
: /* Relief thickness of tool-bar buttons. */);
29196 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
29198 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
29199 doc
: /* Tool bar style to use.
29201 image - show images only
29202 text - show text only
29203 both - show both, text below image
29204 both-horiz - show text to the right of the image
29205 text-image-horiz - show text to the left of the image
29206 any other - use system default or image if no system default.
29208 This variable only affects the GTK+ toolkit version of Emacs. */);
29209 Vtool_bar_style
= Qnil
;
29211 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
29212 doc
: /* Maximum number of characters a label can have to be shown.
29213 The tool bar style must also show labels for this to have any effect, see
29214 `tool-bar-style'. */);
29215 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
29217 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
29218 doc
: /* List of functions to call to fontify regions of text.
29219 Each function is called with one argument POS. Functions must
29220 fontify a region starting at POS in the current buffer, and give
29221 fontified regions the property `fontified'. */);
29222 Vfontification_functions
= Qnil
;
29223 Fmake_variable_buffer_local (Qfontification_functions
);
29225 DEFVAR_BOOL ("unibyte-display-via-language-environment",
29226 unibyte_display_via_language_environment
,
29227 doc
: /* Non-nil means display unibyte text according to language environment.
29228 Specifically, this means that raw bytes in the range 160-255 decimal
29229 are displayed by converting them to the equivalent multibyte characters
29230 according to the current language environment. As a result, they are
29231 displayed according to the current fontset.
29233 Note that this variable affects only how these bytes are displayed,
29234 but does not change the fact they are interpreted as raw bytes. */);
29235 unibyte_display_via_language_environment
= 0;
29237 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
29238 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29239 If a float, it specifies a fraction of the mini-window frame's height.
29240 If an integer, it specifies a number of lines. */);
29241 Vmax_mini_window_height
= make_float (0.25);
29243 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
29244 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
29245 A value of nil means don't automatically resize mini-windows.
29246 A value of t means resize them to fit the text displayed in them.
29247 A value of `grow-only', the default, means let mini-windows grow only;
29248 they return to their normal size when the minibuffer is closed, or the
29249 echo area becomes empty. */);
29250 Vresize_mini_windows
= Qgrow_only
;
29252 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
29253 doc
: /* Alist specifying how to blink the cursor off.
29254 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29255 `cursor-type' frame-parameter or variable equals ON-STATE,
29256 comparing using `equal', Emacs uses OFF-STATE to specify
29257 how to blink it off. ON-STATE and OFF-STATE are values for
29258 the `cursor-type' frame parameter.
29260 If a frame's ON-STATE has no entry in this list,
29261 the frame's other specifications determine how to blink the cursor off. */);
29262 Vblink_cursor_alist
= Qnil
;
29264 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
29265 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
29266 If non-nil, windows are automatically scrolled horizontally to make
29267 point visible. */);
29268 automatic_hscrolling_p
= 1;
29269 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
29271 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
29272 doc
: /* How many columns away from the window edge point is allowed to get
29273 before automatic hscrolling will horizontally scroll the window. */);
29274 hscroll_margin
= 5;
29276 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
29277 doc
: /* How many columns to scroll the window when point gets too close to the edge.
29278 When point is less than `hscroll-margin' columns from the window
29279 edge, automatic hscrolling will scroll the window by the amount of columns
29280 determined by this variable. If its value is a positive integer, scroll that
29281 many columns. If it's a positive floating-point number, it specifies the
29282 fraction of the window's width to scroll. If it's nil or zero, point will be
29283 centered horizontally after the scroll. Any other value, including negative
29284 numbers, are treated as if the value were zero.
29286 Automatic hscrolling always moves point outside the scroll margin, so if
29287 point was more than scroll step columns inside the margin, the window will
29288 scroll more than the value given by the scroll step.
29290 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29291 and `scroll-right' overrides this variable's effect. */);
29292 Vhscroll_step
= make_number (0);
29294 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
29295 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
29296 Bind this around calls to `message' to let it take effect. */);
29297 message_truncate_lines
= 0;
29299 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
29300 doc
: /* Normal hook run to update the menu bar definitions.
29301 Redisplay runs this hook before it redisplays the menu bar.
29302 This is used to update submenus such as Buffers,
29303 whose contents depend on various data. */);
29304 Vmenu_bar_update_hook
= Qnil
;
29306 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
29307 doc
: /* Frame for which we are updating a menu.
29308 The enable predicate for a menu binding should check this variable. */);
29309 Vmenu_updating_frame
= Qnil
;
29311 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
29312 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
29313 inhibit_menubar_update
= 0;
29315 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
29316 doc
: /* Prefix prepended to all continuation lines at display time.
29317 The value may be a string, an image, or a stretch-glyph; it is
29318 interpreted in the same way as the value of a `display' text property.
29320 This variable is overridden by any `wrap-prefix' text or overlay
29323 To add a prefix to non-continuation lines, use `line-prefix'. */);
29324 Vwrap_prefix
= Qnil
;
29325 DEFSYM (Qwrap_prefix
, "wrap-prefix");
29326 Fmake_variable_buffer_local (Qwrap_prefix
);
29328 DEFVAR_LISP ("line-prefix", Vline_prefix
,
29329 doc
: /* Prefix prepended to all non-continuation lines at display time.
29330 The value may be a string, an image, or a stretch-glyph; it is
29331 interpreted in the same way as the value of a `display' text property.
29333 This variable is overridden by any `line-prefix' text or overlay
29336 To add a prefix to continuation lines, use `wrap-prefix'. */);
29337 Vline_prefix
= Qnil
;
29338 DEFSYM (Qline_prefix
, "line-prefix");
29339 Fmake_variable_buffer_local (Qline_prefix
);
29341 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
29342 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
29343 inhibit_eval_during_redisplay
= 0;
29345 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
29346 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
29347 inhibit_free_realized_faces
= 0;
29350 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
29351 doc
: /* Inhibit try_window_id display optimization. */);
29352 inhibit_try_window_id
= 0;
29354 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
29355 doc
: /* Inhibit try_window_reusing display optimization. */);
29356 inhibit_try_window_reusing
= 0;
29358 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
29359 doc
: /* Inhibit try_cursor_movement display optimization. */);
29360 inhibit_try_cursor_movement
= 0;
29361 #endif /* GLYPH_DEBUG */
29363 DEFVAR_INT ("overline-margin", overline_margin
,
29364 doc
: /* Space between overline and text, in pixels.
29365 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29366 margin to the character height. */);
29367 overline_margin
= 2;
29369 DEFVAR_INT ("underline-minimum-offset",
29370 underline_minimum_offset
,
29371 doc
: /* Minimum distance between baseline and underline.
29372 This can improve legibility of underlined text at small font sizes,
29373 particularly when using variable `x-use-underline-position-properties'
29374 with fonts that specify an UNDERLINE_POSITION relatively close to the
29375 baseline. The default value is 1. */);
29376 underline_minimum_offset
= 1;
29378 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
29379 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29380 This feature only works when on a window system that can change
29381 cursor shapes. */);
29382 display_hourglass_p
= 1;
29384 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
29385 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29386 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
29388 hourglass_atimer
= NULL
;
29389 hourglass_shown_p
= 0;
29391 DEFSYM (Qglyphless_char
, "glyphless-char");
29392 DEFSYM (Qhex_code
, "hex-code");
29393 DEFSYM (Qempty_box
, "empty-box");
29394 DEFSYM (Qthin_space
, "thin-space");
29395 DEFSYM (Qzero_width
, "zero-width");
29397 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
29398 /* Intern this now in case it isn't already done.
29399 Setting this variable twice is harmless.
29400 But don't staticpro it here--that is done in alloc.c. */
29401 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
29402 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
29404 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
29405 doc
: /* Char-table defining glyphless characters.
29406 Each element, if non-nil, should be one of the following:
29407 an ASCII acronym string: display this string in a box
29408 `hex-code': display the hexadecimal code of a character in a box
29409 `empty-box': display as an empty box
29410 `thin-space': display as 1-pixel width space
29411 `zero-width': don't display
29412 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29413 display method for graphical terminals and text terminals respectively.
29414 GRAPHICAL and TEXT should each have one of the values listed above.
29416 The char-table has one extra slot to control the display of a character for
29417 which no font is found. This slot only takes effect on graphical terminals.
29418 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29419 `thin-space'. The default is `empty-box'. */);
29420 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29421 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29424 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
29425 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
29426 Vdebug_on_message
= Qnil
;
29430 /* Initialize this module when Emacs starts. */
29435 current_header_line_height
= current_mode_line_height
= -1;
29437 CHARPOS (this_line_start_pos
) = 0;
29439 if (!noninteractive
)
29441 struct window
*m
= XWINDOW (minibuf_window
);
29442 Lisp_Object frame
= m
->frame
;
29443 struct frame
*f
= XFRAME (frame
);
29444 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29445 struct window
*r
= XWINDOW (root
);
29448 echo_area_window
= minibuf_window
;
29450 wset_top_line (r
, make_number (FRAME_TOP_MARGIN (f
)));
29452 (r
, make_number (FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
)));
29453 wset_total_cols (r
, make_number (FRAME_COLS (f
)));
29454 wset_top_line (m
, make_number (FRAME_LINES (f
) - 1));
29455 wset_total_lines (m
, make_number (1));
29456 wset_total_cols (m
, make_number (FRAME_COLS (f
)));
29458 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29459 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29460 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29462 /* The default ellipsis glyphs `...'. */
29463 for (i
= 0; i
< 3; ++i
)
29464 default_invis_vector
[i
] = make_number ('.');
29468 /* Allocate the buffer for frame titles.
29469 Also used for `format-mode-line'. */
29471 mode_line_noprop_buf
= xmalloc (size
);
29472 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29473 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29474 mode_line_target
= MODE_LINE_DISPLAY
;
29477 help_echo_showing_p
= 0;
29480 /* Platform-independent portion of hourglass implementation. */
29482 /* Cancel a currently active hourglass timer, and start a new one. */
29484 start_hourglass (void)
29486 #if defined (HAVE_WINDOW_SYSTEM)
29489 cancel_hourglass ();
29491 if (INTEGERP (Vhourglass_delay
)
29492 && XINT (Vhourglass_delay
) > 0)
29493 delay
= make_emacs_time (min (XINT (Vhourglass_delay
),
29494 TYPE_MAXIMUM (time_t)),
29496 else if (FLOATP (Vhourglass_delay
)
29497 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29498 delay
= EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (Vhourglass_delay
));
29500 delay
= make_emacs_time (DEFAULT_HOURGLASS_DELAY
, 0);
29504 extern void w32_note_current_window (void);
29505 w32_note_current_window ();
29507 #endif /* HAVE_NTGUI */
29509 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29510 show_hourglass
, NULL
);
29515 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29518 cancel_hourglass (void)
29520 #if defined (HAVE_WINDOW_SYSTEM)
29521 if (hourglass_atimer
)
29523 cancel_atimer (hourglass_atimer
);
29524 hourglass_atimer
= NULL
;
29527 if (hourglass_shown_p
)