1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2013 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code.
36 The following diagram shows how redisplay code is invoked. As you
37 can see, Lisp calls redisplay and vice versa. Under window systems
38 like X, some portions of the redisplay code are also called
39 asynchronously during mouse movement or expose events. It is very
40 important that these code parts do NOT use the C library (malloc,
41 free) because many C libraries under Unix are not reentrant. They
42 may also NOT call functions of the Lisp interpreter which could
43 change the interpreter's state. If you don't follow these rules,
44 you will encounter bugs which are very hard to explain.
46 +--------------+ redisplay +----------------+
47 | Lisp machine |---------------->| Redisplay code |<--+
48 +--------------+ (xdisp.c) +----------------+ |
50 +----------------------------------+ |
51 Don't use this path when called |
54 expose_window (asynchronous) |
56 X expose events -----+
58 What does redisplay do? Obviously, it has to figure out somehow what
59 has been changed since the last time the display has been updated,
60 and to make these changes visible. Preferably it would do that in
61 a moderately intelligent way, i.e. fast.
63 Changes in buffer text can be deduced from window and buffer
64 structures, and from some global variables like `beg_unchanged' and
65 `end_unchanged'. The contents of the display are additionally
66 recorded in a `glyph matrix', a two-dimensional matrix of glyph
67 structures. Each row in such a matrix corresponds to a line on the
68 display, and each glyph in a row corresponds to a column displaying
69 a character, an image, or what else. This matrix is called the
70 `current glyph matrix' or `current matrix' in redisplay
73 For buffer parts that have been changed since the last update, a
74 second glyph matrix is constructed, the so called `desired glyph
75 matrix' or short `desired matrix'. Current and desired matrix are
76 then compared to find a cheap way to update the display, e.g. by
77 reusing part of the display by scrolling lines.
79 You will find a lot of redisplay optimizations when you start
80 looking at the innards of redisplay. The overall goal of all these
81 optimizations is to make redisplay fast because it is done
82 frequently. Some of these optimizations are implemented by the
87 This function tries to update the display if the text in the
88 window did not change and did not scroll, only point moved, and
89 it did not move off the displayed portion of the text.
91 . try_window_reusing_current_matrix
93 This function reuses the current matrix of a window when text
94 has not changed, but the window start changed (e.g., due to
99 This function attempts to redisplay a window by reusing parts of
100 its existing display. It finds and reuses the part that was not
101 changed, and redraws the rest.
105 This function performs the full redisplay of a single window
106 assuming that its fonts were not changed and that the cursor
107 will not end up in the scroll margins. (Loading fonts requires
108 re-adjustment of dimensions of glyph matrices, which makes this
109 method impossible to use.)
111 These optimizations are tried in sequence (some can be skipped if
112 it is known that they are not applicable). If none of the
113 optimizations were successful, redisplay calls redisplay_windows,
114 which performs a full redisplay of all windows.
118 Desired matrices are always built per Emacs window. The function
119 `display_line' is the central function to look at if you are
120 interested. It constructs one row in a desired matrix given an
121 iterator structure containing both a buffer position and a
122 description of the environment in which the text is to be
123 displayed. But this is too early, read on.
125 Characters and pixmaps displayed for a range of buffer text depend
126 on various settings of buffers and windows, on overlays and text
127 properties, on display tables, on selective display. The good news
128 is that all this hairy stuff is hidden behind a small set of
129 interface functions taking an iterator structure (struct it)
132 Iteration over things to be displayed is then simple. It is
133 started by initializing an iterator with a call to init_iterator,
134 passing it the buffer position where to start iteration. For
135 iteration over strings, pass -1 as the position to init_iterator,
136 and call reseat_to_string when the string is ready, to initialize
137 the iterator for that string. Thereafter, calls to
138 get_next_display_element fill the iterator structure with relevant
139 information about the next thing to display. Calls to
140 set_iterator_to_next move the iterator to the next thing.
142 Besides this, an iterator also contains information about the
143 display environment in which glyphs for display elements are to be
144 produced. It has fields for the width and height of the display,
145 the information whether long lines are truncated or continued, a
146 current X and Y position, and lots of other stuff you can better
149 Glyphs in a desired matrix are normally constructed in a loop
150 calling get_next_display_element and then PRODUCE_GLYPHS. The call
151 to PRODUCE_GLYPHS will fill the iterator structure with pixel
152 information about the element being displayed and at the same time
153 produce glyphs for it. If the display element fits on the line
154 being displayed, set_iterator_to_next is called next, otherwise the
155 glyphs produced are discarded. The function display_line is the
156 workhorse of filling glyph rows in the desired matrix with glyphs.
157 In addition to producing glyphs, it also handles line truncation
158 and continuation, word wrap, and cursor positioning (for the
159 latter, see also set_cursor_from_row).
163 That just couldn't be all, could it? What about terminal types not
164 supporting operations on sub-windows of the screen? To update the
165 display on such a terminal, window-based glyph matrices are not
166 well suited. To be able to reuse part of the display (scrolling
167 lines up and down), we must instead have a view of the whole
168 screen. This is what `frame matrices' are for. They are a trick.
170 Frames on terminals like above have a glyph pool. Windows on such
171 a frame sub-allocate their glyph memory from their frame's glyph
172 pool. The frame itself is given its own glyph matrices. By
173 coincidence---or maybe something else---rows in window glyph
174 matrices are slices of corresponding rows in frame matrices. Thus
175 writing to window matrices implicitly updates a frame matrix which
176 provides us with the view of the whole screen that we originally
177 wanted to have without having to move many bytes around. To be
178 honest, there is a little bit more done, but not much more. If you
179 plan to extend that code, take a look at dispnew.c. The function
180 build_frame_matrix is a good starting point.
182 Bidirectional display.
184 Bidirectional display adds quite some hair to this already complex
185 design. The good news are that a large portion of that hairy stuff
186 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
187 reordering engine which is called by set_iterator_to_next and
188 returns the next character to display in the visual order. See
189 commentary on bidi.c for more details. As far as redisplay is
190 concerned, the effect of calling bidi_move_to_visually_next, the
191 main interface of the reordering engine, is that the iterator gets
192 magically placed on the buffer or string position that is to be
193 displayed next. In other words, a linear iteration through the
194 buffer/string is replaced with a non-linear one. All the rest of
195 the redisplay is oblivious to the bidi reordering.
197 Well, almost oblivious---there are still complications, most of
198 them due to the fact that buffer and string positions no longer
199 change monotonously with glyph indices in a glyph row. Moreover,
200 for continued lines, the buffer positions may not even be
201 monotonously changing with vertical positions. Also, accounting
202 for face changes, overlays, etc. becomes more complex because
203 non-linear iteration could potentially skip many positions with
204 changes, and then cross them again on the way back...
206 One other prominent effect of bidirectional display is that some
207 paragraphs of text need to be displayed starting at the right
208 margin of the window---the so-called right-to-left, or R2L
209 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
210 which have their reversed_p flag set. The bidi reordering engine
211 produces characters in such rows starting from the character which
212 should be the rightmost on display. PRODUCE_GLYPHS then reverses
213 the order, when it fills up the glyph row whose reversed_p flag is
214 set, by prepending each new glyph to what is already there, instead
215 of appending it. When the glyph row is complete, the function
216 extend_face_to_end_of_line fills the empty space to the left of the
217 leftmost character with special glyphs, which will display as,
218 well, empty. On text terminals, these special glyphs are simply
219 blank characters. On graphics terminals, there's a single stretch
220 glyph of a suitably computed width. Both the blanks and the
221 stretch glyph are given the face of the background of the line.
222 This way, the terminal-specific back-end can still draw the glyphs
223 left to right, even for R2L lines.
225 Bidirectional display and character compositions
227 Some scripts cannot be displayed by drawing each character
228 individually, because adjacent characters change each other's shape
229 on display. For example, Arabic and Indic scripts belong to this
232 Emacs display supports this by providing "character compositions",
233 most of which is implemented in composite.c. During the buffer
234 scan that delivers characters to PRODUCE_GLYPHS, if the next
235 character to be delivered is a composed character, the iteration
236 calls composition_reseat_it and next_element_from_composition. If
237 they succeed to compose the character with one or more of the
238 following characters, the whole sequence of characters that where
239 composed is recorded in the `struct composition_it' object that is
240 part of the buffer iterator. The composed sequence could produce
241 one or more font glyphs (called "grapheme clusters") on the screen.
242 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
243 in the direction corresponding to the current bidi scan direction
244 (recorded in the scan_dir member of the `struct bidi_it' object
245 that is part of the buffer iterator). In particular, if the bidi
246 iterator currently scans the buffer backwards, the grapheme
247 clusters are delivered back to front. This reorders the grapheme
248 clusters as appropriate for the current bidi context. Note that
249 this means that the grapheme clusters are always stored in the
250 LGSTRING object (see composite.c) in the logical order.
252 Moving an iterator in bidirectional text
253 without producing glyphs
255 Note one important detail mentioned above: that the bidi reordering
256 engine, driven by the iterator, produces characters in R2L rows
257 starting at the character that will be the rightmost on display.
258 As far as the iterator is concerned, the geometry of such rows is
259 still left to right, i.e. the iterator "thinks" the first character
260 is at the leftmost pixel position. The iterator does not know that
261 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
262 delivers. This is important when functions from the move_it_*
263 family are used to get to certain screen position or to match
264 screen coordinates with buffer coordinates: these functions use the
265 iterator geometry, which is left to right even in R2L paragraphs.
266 This works well with most callers of move_it_*, because they need
267 to get to a specific column, and columns are still numbered in the
268 reading order, i.e. the rightmost character in a R2L paragraph is
269 still column zero. But some callers do not get well with this; a
270 notable example is mouse clicks that need to find the character
271 that corresponds to certain pixel coordinates. See
272 buffer_posn_from_coords in dispnew.c for how this is handled. */
280 #include "keyboard.h"
283 #include "termchar.h"
284 #include "dispextern.h"
285 #include "character.h"
289 #include "commands.h"
293 #include "termhooks.h"
294 #include "termopts.h"
295 #include "intervals.h"
298 #include "region-cache.h"
301 #include "blockinput.h"
303 #ifdef HAVE_X_WINDOWS
318 #ifndef FRAME_X_OUTPUT
319 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
322 #define INFINITY 10000000
324 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
325 Lisp_Object Qwindow_scroll_functions
;
326 static Lisp_Object Qwindow_text_change_functions
;
327 static Lisp_Object Qredisplay_end_trigger_functions
;
328 Lisp_Object Qinhibit_point_motion_hooks
;
329 static Lisp_Object QCeval
, QCpropertize
;
330 Lisp_Object QCfile
, QCdata
;
331 static Lisp_Object Qfontified
;
332 static Lisp_Object Qgrow_only
;
333 static Lisp_Object Qinhibit_eval_during_redisplay
;
334 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
335 static Lisp_Object Qright_to_left
, Qleft_to_right
;
338 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 /* Pointer shapes. */
341 static Lisp_Object Qarrow
, Qhand
;
344 /* Holds the list (error). */
345 static Lisp_Object list_of_error
;
347 static Lisp_Object Qfontification_functions
;
349 static Lisp_Object Qwrap_prefix
;
350 static Lisp_Object Qline_prefix
;
351 static Lisp_Object Qredisplay_internal
;
353 /* Non-nil means don't actually do any redisplay. */
355 Lisp_Object Qinhibit_redisplay
;
357 /* Names of text properties relevant for redisplay. */
359 Lisp_Object Qdisplay
;
361 Lisp_Object Qspace
, QCalign_to
;
362 static Lisp_Object QCrelative_width
, QCrelative_height
;
363 Lisp_Object Qleft_margin
, Qright_margin
;
364 static Lisp_Object Qspace_width
, Qraise
;
365 static Lisp_Object Qslice
;
367 static Lisp_Object Qmargin
, Qpointer
;
368 static Lisp_Object Qline_height
;
370 #ifdef HAVE_WINDOW_SYSTEM
372 /* Test if overflow newline into fringe. Called with iterator IT
373 at or past right window margin, and with IT->current_x set. */
375 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
376 (!NILP (Voverflow_newline_into_fringe) \
377 && FRAME_WINDOW_P ((IT)->f) \
378 && ((IT)->bidi_it.paragraph_dir == R2L \
379 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
380 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
381 && (IT)->current_x == (IT)->last_visible_x \
382 && (IT)->line_wrap != WORD_WRAP)
384 #else /* !HAVE_WINDOW_SYSTEM */
385 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
386 #endif /* HAVE_WINDOW_SYSTEM */
388 /* Test if the display element loaded in IT, or the underlying buffer
389 or string character, is a space or a TAB character. This is used
390 to determine where word wrapping can occur. */
392 #define IT_DISPLAYING_WHITESPACE(it) \
393 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
394 || ((STRINGP (it->string) \
395 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
396 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
398 && (it->s[IT_BYTEPOS (*it)] == ' ' \
399 || it->s[IT_BYTEPOS (*it)] == '\t')) \
400 || (IT_BYTEPOS (*it) < ZV_BYTE \
401 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
402 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
404 /* Name of the face used to highlight trailing whitespace. */
406 static Lisp_Object Qtrailing_whitespace
;
408 /* Name and number of the face used to highlight escape glyphs. */
410 static Lisp_Object Qescape_glyph
;
412 /* Name and number of the face used to highlight non-breaking spaces. */
414 static Lisp_Object Qnobreak_space
;
416 /* The symbol `image' which is the car of the lists used to represent
417 images in Lisp. Also a tool bar style. */
421 /* The image map types. */
423 static Lisp_Object QCpointer
;
424 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
426 /* Tool bar styles */
427 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
429 /* Non-zero means print newline to stdout before next mini-buffer
432 int noninteractive_need_newline
;
434 /* Non-zero means print newline to message log before next message. */
436 static int message_log_need_newline
;
438 /* Three markers that message_dolog uses.
439 It could allocate them itself, but that causes trouble
440 in handling memory-full errors. */
441 static Lisp_Object message_dolog_marker1
;
442 static Lisp_Object message_dolog_marker2
;
443 static Lisp_Object message_dolog_marker3
;
445 /* The buffer position of the first character appearing entirely or
446 partially on the line of the selected window which contains the
447 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
448 redisplay optimization in redisplay_internal. */
450 static struct text_pos this_line_start_pos
;
452 /* Number of characters past the end of the line above, including the
453 terminating newline. */
455 static struct text_pos this_line_end_pos
;
457 /* The vertical positions and the height of this line. */
459 static int this_line_vpos
;
460 static int this_line_y
;
461 static int this_line_pixel_height
;
463 /* X position at which this display line starts. Usually zero;
464 negative if first character is partially visible. */
466 static int this_line_start_x
;
468 /* The smallest character position seen by move_it_* functions as they
469 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
470 hscrolled lines, see display_line. */
472 static struct text_pos this_line_min_pos
;
474 /* Buffer that this_line_.* variables are referring to. */
476 static struct buffer
*this_line_buffer
;
479 /* Values of those variables at last redisplay are stored as
480 properties on `overlay-arrow-position' symbol. However, if
481 Voverlay_arrow_position is a marker, last-arrow-position is its
482 numerical position. */
484 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
486 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
487 properties on a symbol in overlay-arrow-variable-list. */
489 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
491 Lisp_Object Qmenu_bar_update_hook
;
493 /* Nonzero if an overlay arrow has been displayed in this window. */
495 static int overlay_arrow_seen
;
497 /* Vector containing glyphs for an ellipsis `...'. */
499 static Lisp_Object default_invis_vector
[3];
501 /* This is the window where the echo area message was displayed. It
502 is always a mini-buffer window, but it may not be the same window
503 currently active as a mini-buffer. */
505 Lisp_Object echo_area_window
;
507 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
508 pushes the current message and the value of
509 message_enable_multibyte on the stack, the function restore_message
510 pops the stack and displays MESSAGE again. */
512 static Lisp_Object Vmessage_stack
;
514 /* Nonzero means multibyte characters were enabled when the echo area
515 message was specified. */
517 static int message_enable_multibyte
;
519 /* Nonzero if we should redraw the mode lines on the next redisplay. */
521 int update_mode_lines
;
523 /* Nonzero if window sizes or contents have changed since last
524 redisplay that finished. */
526 int windows_or_buffers_changed
;
528 /* Nonzero means a frame's cursor type has been changed. */
530 int cursor_type_changed
;
532 /* Nonzero after display_mode_line if %l was used and it displayed a
535 static int line_number_displayed
;
537 /* The name of the *Messages* buffer, a string. */
539 static Lisp_Object Vmessages_buffer_name
;
541 /* Current, index 0, and last displayed echo area message. Either
542 buffers from echo_buffers, or nil to indicate no message. */
544 Lisp_Object echo_area_buffer
[2];
546 /* The buffers referenced from echo_area_buffer. */
548 static Lisp_Object echo_buffer
[2];
550 /* A vector saved used in with_area_buffer to reduce consing. */
552 static Lisp_Object Vwith_echo_area_save_vector
;
554 /* Non-zero means display_echo_area should display the last echo area
555 message again. Set by redisplay_preserve_echo_area. */
557 static int display_last_displayed_message_p
;
559 /* Nonzero if echo area is being used by print; zero if being used by
562 static int message_buf_print
;
564 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
566 static Lisp_Object Qinhibit_menubar_update
;
567 static Lisp_Object Qmessage_truncate_lines
;
569 /* Set to 1 in clear_message to make redisplay_internal aware
570 of an emptied echo area. */
572 static int message_cleared_p
;
574 /* A scratch glyph row with contents used for generating truncation
575 glyphs. Also used in direct_output_for_insert. */
577 #define MAX_SCRATCH_GLYPHS 100
578 static struct glyph_row scratch_glyph_row
;
579 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
581 /* Ascent and height of the last line processed by move_it_to. */
583 static int last_height
;
585 /* Non-zero if there's a help-echo in the echo area. */
587 int help_echo_showing_p
;
589 /* If >= 0, computed, exact values of mode-line and header-line height
590 to use in the macros CURRENT_MODE_LINE_HEIGHT and
591 CURRENT_HEADER_LINE_HEIGHT. */
593 int current_mode_line_height
, current_header_line_height
;
595 /* The maximum distance to look ahead for text properties. Values
596 that are too small let us call compute_char_face and similar
597 functions too often which is expensive. Values that are too large
598 let us call compute_char_face and alike too often because we
599 might not be interested in text properties that far away. */
601 #define TEXT_PROP_DISTANCE_LIMIT 100
603 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
604 iterator state and later restore it. This is needed because the
605 bidi iterator on bidi.c keeps a stacked cache of its states, which
606 is really a singleton. When we use scratch iterator objects to
607 move around the buffer, we can cause the bidi cache to be pushed or
608 popped, and therefore we need to restore the cache state when we
609 return to the original iterator. */
610 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
613 bidi_unshelve_cache (CACHE, 1); \
615 CACHE = bidi_shelve_cache (); \
618 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
620 if (pITORIG != pITCOPY) \
621 *(pITORIG) = *(pITCOPY); \
622 bidi_unshelve_cache (CACHE, 0); \
628 /* Non-zero means print traces of redisplay if compiled with
629 GLYPH_DEBUG defined. */
631 int trace_redisplay_p
;
633 #endif /* GLYPH_DEBUG */
635 #ifdef DEBUG_TRACE_MOVE
636 /* Non-zero means trace with TRACE_MOVE to stderr. */
639 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
641 #define TRACE_MOVE(x) (void) 0
644 static Lisp_Object Qauto_hscroll_mode
;
646 /* Buffer being redisplayed -- for redisplay_window_error. */
648 static struct buffer
*displayed_buffer
;
650 /* Value returned from text property handlers (see below). */
655 HANDLED_RECOMPUTE_PROPS
,
656 HANDLED_OVERLAY_STRING_CONSUMED
,
660 /* A description of text properties that redisplay is interested
665 /* The name of the property. */
668 /* A unique index for the property. */
671 /* A handler function called to set up iterator IT from the property
672 at IT's current position. Value is used to steer handle_stop. */
673 enum prop_handled (*handler
) (struct it
*it
);
676 static enum prop_handled
handle_face_prop (struct it
*);
677 static enum prop_handled
handle_invisible_prop (struct it
*);
678 static enum prop_handled
handle_display_prop (struct it
*);
679 static enum prop_handled
handle_composition_prop (struct it
*);
680 static enum prop_handled
handle_overlay_change (struct it
*);
681 static enum prop_handled
handle_fontified_prop (struct it
*);
683 /* Properties handled by iterators. */
685 static struct props it_props
[] =
687 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
688 /* Handle `face' before `display' because some sub-properties of
689 `display' need to know the face. */
690 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
691 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
692 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
693 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
697 /* Value is the position described by X. If X is a marker, value is
698 the marker_position of X. Otherwise, value is X. */
700 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
702 /* Enumeration returned by some move_it_.* functions internally. */
706 /* Not used. Undefined value. */
709 /* Move ended at the requested buffer position or ZV. */
710 MOVE_POS_MATCH_OR_ZV
,
712 /* Move ended at the requested X pixel position. */
715 /* Move within a line ended at the end of a line that must be
719 /* Move within a line ended at the end of a line that would
720 be displayed truncated. */
723 /* Move within a line ended at a line end. */
727 /* This counter is used to clear the face cache every once in a while
728 in redisplay_internal. It is incremented for each redisplay.
729 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
732 #define CLEAR_FACE_CACHE_COUNT 500
733 static int clear_face_cache_count
;
735 /* Similarly for the image cache. */
737 #ifdef HAVE_WINDOW_SYSTEM
738 #define CLEAR_IMAGE_CACHE_COUNT 101
739 static int clear_image_cache_count
;
741 /* Null glyph slice */
742 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
745 /* True while redisplay_internal is in progress. */
749 static Lisp_Object Qinhibit_free_realized_faces
;
750 static Lisp_Object Qmode_line_default_help_echo
;
752 /* If a string, XTread_socket generates an event to display that string.
753 (The display is done in read_char.) */
755 Lisp_Object help_echo_string
;
756 Lisp_Object help_echo_window
;
757 Lisp_Object help_echo_object
;
758 ptrdiff_t help_echo_pos
;
760 /* Temporary variable for XTread_socket. */
762 Lisp_Object previous_help_echo_string
;
764 /* Platform-independent portion of hourglass implementation. */
766 /* Non-zero means an hourglass cursor is currently shown. */
767 int hourglass_shown_p
;
769 /* If non-null, an asynchronous timer that, when it expires, displays
770 an hourglass cursor on all frames. */
771 struct atimer
*hourglass_atimer
;
773 /* Name of the face used to display glyphless characters. */
774 Lisp_Object Qglyphless_char
;
776 /* Symbol for the purpose of Vglyphless_char_display. */
777 static Lisp_Object Qglyphless_char_display
;
779 /* Method symbols for Vglyphless_char_display. */
780 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
782 /* Default pixel width of `thin-space' display method. */
783 #define THIN_SPACE_WIDTH 1
785 /* Default number of seconds to wait before displaying an hourglass
787 #define DEFAULT_HOURGLASS_DELAY 1
790 /* Function prototypes. */
792 static void setup_for_ellipsis (struct it
*, int);
793 static void set_iterator_to_next (struct it
*, int);
794 static void mark_window_display_accurate_1 (struct window
*, int);
795 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
796 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
797 static int cursor_row_p (struct glyph_row
*);
798 static int redisplay_mode_lines (Lisp_Object
, int);
799 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
801 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
803 static void handle_line_prefix (struct it
*);
805 static void pint2str (char *, int, ptrdiff_t);
806 static void pint2hrstr (char *, int, ptrdiff_t);
807 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
809 static void reconsider_clip_changes (struct window
*, struct buffer
*);
810 static int text_outside_line_unchanged_p (struct window
*,
811 ptrdiff_t, ptrdiff_t);
812 static void store_mode_line_noprop_char (char);
813 static int store_mode_line_noprop (const char *, int, int);
814 static void handle_stop (struct it
*);
815 static void handle_stop_backwards (struct it
*, ptrdiff_t);
816 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
817 static void ensure_echo_area_buffers (void);
818 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
819 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
820 static int with_echo_area_buffer (struct window
*, int,
821 int (*) (ptrdiff_t, Lisp_Object
),
822 ptrdiff_t, Lisp_Object
);
823 static void clear_garbaged_frames (void);
824 static int current_message_1 (ptrdiff_t, Lisp_Object
);
825 static void pop_message (void);
826 static int truncate_message_1 (ptrdiff_t, Lisp_Object
);
827 static void set_message (Lisp_Object
);
828 static int set_message_1 (ptrdiff_t, Lisp_Object
);
829 static int display_echo_area (struct window
*);
830 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
);
831 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
832 static Lisp_Object
unwind_redisplay (Lisp_Object
);
833 static int string_char_and_length (const unsigned char *, int *);
834 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
836 static int compute_window_start_on_continuation_line (struct window
*);
837 static void insert_left_trunc_glyphs (struct it
*);
838 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
840 static void extend_face_to_end_of_line (struct it
*);
841 static int append_space_for_newline (struct it
*, int);
842 static int cursor_row_fully_visible_p (struct window
*, int, int);
843 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
844 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
845 static int trailing_whitespace_p (ptrdiff_t);
846 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
847 static void push_it (struct it
*, struct text_pos
*);
848 static void iterate_out_of_display_property (struct it
*);
849 static void pop_it (struct it
*);
850 static void sync_frame_with_window_matrix_rows (struct window
*);
851 static void redisplay_internal (void);
852 static int echo_area_display (int);
853 static void redisplay_windows (Lisp_Object
);
854 static void redisplay_window (Lisp_Object
, int);
855 static Lisp_Object
redisplay_window_error (Lisp_Object
);
856 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
857 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
858 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
859 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
861 static int update_menu_bar (struct frame
*, int, int);
862 static int try_window_reusing_current_matrix (struct window
*);
863 static int try_window_id (struct window
*);
864 static int display_line (struct it
*);
865 static int display_mode_lines (struct window
*);
866 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
867 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
868 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
869 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
870 static void display_menu_bar (struct window
*);
871 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
873 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
874 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
875 static void compute_line_metrics (struct it
*);
876 static void run_redisplay_end_trigger_hook (struct it
*);
877 static int get_overlay_strings (struct it
*, ptrdiff_t);
878 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
879 static void next_overlay_string (struct it
*);
880 static void reseat (struct it
*, struct text_pos
, int);
881 static void reseat_1 (struct it
*, struct text_pos
, int);
882 static void back_to_previous_visible_line_start (struct it
*);
883 void reseat_at_previous_visible_line_start (struct it
*);
884 static void reseat_at_next_visible_line_start (struct it
*, int);
885 static int next_element_from_ellipsis (struct it
*);
886 static int next_element_from_display_vector (struct it
*);
887 static int next_element_from_string (struct it
*);
888 static int next_element_from_c_string (struct it
*);
889 static int next_element_from_buffer (struct it
*);
890 static int next_element_from_composition (struct it
*);
891 static int next_element_from_image (struct it
*);
892 static int next_element_from_stretch (struct it
*);
893 static void load_overlay_strings (struct it
*, ptrdiff_t);
894 static int init_from_display_pos (struct it
*, struct window
*,
895 struct display_pos
*);
896 static void reseat_to_string (struct it
*, const char *,
897 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
898 static int get_next_display_element (struct it
*);
899 static enum move_it_result
900 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
901 enum move_operation_enum
);
902 void move_it_vertically_backward (struct it
*, int);
903 static void get_visually_first_element (struct it
*);
904 static void init_to_row_start (struct it
*, struct window
*,
906 static int init_to_row_end (struct it
*, struct window
*,
908 static void back_to_previous_line_start (struct it
*);
909 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
910 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
911 Lisp_Object
, ptrdiff_t);
912 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
913 static struct text_pos
c_string_pos (ptrdiff_t, const char *, bool);
914 static ptrdiff_t number_of_chars (const char *, bool);
915 static void compute_stop_pos (struct it
*);
916 static void compute_string_pos (struct text_pos
*, struct text_pos
,
918 static int face_before_or_after_it_pos (struct it
*, int);
919 static ptrdiff_t next_overlay_change (ptrdiff_t);
920 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
921 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
922 static int handle_single_display_spec (struct it
*, Lisp_Object
,
923 Lisp_Object
, Lisp_Object
,
924 struct text_pos
*, ptrdiff_t, int, int);
925 static int underlying_face_id (struct it
*);
926 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
929 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
930 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
932 #ifdef HAVE_WINDOW_SYSTEM
934 static void x_consider_frame_title (Lisp_Object
);
935 static int tool_bar_lines_needed (struct frame
*, int *);
936 static void update_tool_bar (struct frame
*, int);
937 static void build_desired_tool_bar_string (struct frame
*f
);
938 static int redisplay_tool_bar (struct frame
*);
939 static void display_tool_bar_line (struct it
*, int);
940 static void notice_overwritten_cursor (struct window
*,
943 static void append_stretch_glyph (struct it
*, Lisp_Object
,
947 #endif /* HAVE_WINDOW_SYSTEM */
949 static void produce_special_glyphs (struct it
*, enum display_element_type
);
950 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
951 static int coords_in_mouse_face_p (struct window
*, int, int);
955 /***********************************************************************
956 Window display dimensions
957 ***********************************************************************/
959 /* Return the bottom boundary y-position for text lines in window W.
960 This is the first y position at which a line cannot start.
961 It is relative to the top of the window.
963 This is the height of W minus the height of a mode line, if any. */
966 window_text_bottom_y (struct window
*w
)
968 int height
= WINDOW_TOTAL_HEIGHT (w
);
970 if (WINDOW_WANTS_MODELINE_P (w
))
971 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
975 /* Return the pixel width of display area AREA of window W. AREA < 0
976 means return the total width of W, not including fringes to
977 the left and right of the window. */
980 window_box_width (struct window
*w
, int area
)
982 int cols
= w
->total_cols
;
985 if (!w
->pseudo_window_p
)
987 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
989 if (area
== TEXT_AREA
)
991 if (INTEGERP (w
->left_margin_cols
))
992 cols
-= XFASTINT (w
->left_margin_cols
);
993 if (INTEGERP (w
->right_margin_cols
))
994 cols
-= XFASTINT (w
->right_margin_cols
);
995 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
997 else if (area
== LEFT_MARGIN_AREA
)
999 cols
= (INTEGERP (w
->left_margin_cols
)
1000 ? XFASTINT (w
->left_margin_cols
) : 0);
1003 else if (area
== RIGHT_MARGIN_AREA
)
1005 cols
= (INTEGERP (w
->right_margin_cols
)
1006 ? XFASTINT (w
->right_margin_cols
) : 0);
1011 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1015 /* Return the pixel height of the display area of window W, not
1016 including mode lines of W, if any. */
1019 window_box_height (struct window
*w
)
1021 struct frame
*f
= XFRAME (w
->frame
);
1022 int height
= WINDOW_TOTAL_HEIGHT (w
);
1024 eassert (height
>= 0);
1026 /* Note: the code below that determines the mode-line/header-line
1027 height is essentially the same as that contained in the macro
1028 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1029 the appropriate glyph row has its `mode_line_p' flag set,
1030 and if it doesn't, uses estimate_mode_line_height instead. */
1032 if (WINDOW_WANTS_MODELINE_P (w
))
1034 struct glyph_row
*ml_row
1035 = (w
->current_matrix
&& w
->current_matrix
->rows
1036 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1038 if (ml_row
&& ml_row
->mode_line_p
)
1039 height
-= ml_row
->height
;
1041 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1044 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1046 struct glyph_row
*hl_row
1047 = (w
->current_matrix
&& w
->current_matrix
->rows
1048 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1050 if (hl_row
&& hl_row
->mode_line_p
)
1051 height
-= hl_row
->height
;
1053 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1056 /* With a very small font and a mode-line that's taller than
1057 default, we might end up with a negative height. */
1058 return max (0, height
);
1061 /* Return the window-relative coordinate of the left edge of display
1062 area AREA of window W. AREA < 0 means return the left edge of the
1063 whole window, to the right of the left fringe of W. */
1066 window_box_left_offset (struct window
*w
, int area
)
1070 if (w
->pseudo_window_p
)
1073 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1075 if (area
== TEXT_AREA
)
1076 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1077 + window_box_width (w
, LEFT_MARGIN_AREA
));
1078 else if (area
== RIGHT_MARGIN_AREA
)
1079 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1080 + window_box_width (w
, LEFT_MARGIN_AREA
)
1081 + window_box_width (w
, TEXT_AREA
)
1082 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1084 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1085 else if (area
== LEFT_MARGIN_AREA
1086 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1087 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1093 /* Return the window-relative coordinate of the right edge of display
1094 area AREA of window W. AREA < 0 means return the right edge of the
1095 whole window, to the left of the right fringe of W. */
1098 window_box_right_offset (struct window
*w
, int area
)
1100 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1103 /* Return the frame-relative coordinate of the left edge of display
1104 area AREA of window W. AREA < 0 means return the left edge of the
1105 whole window, to the right of the left fringe of W. */
1108 window_box_left (struct window
*w
, int area
)
1110 struct frame
*f
= XFRAME (w
->frame
);
1113 if (w
->pseudo_window_p
)
1114 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1116 x
= (WINDOW_LEFT_EDGE_X (w
)
1117 + window_box_left_offset (w
, area
));
1123 /* Return the frame-relative coordinate of the right edge of display
1124 area AREA of window W. AREA < 0 means return the right edge of the
1125 whole window, to the left of the right fringe of W. */
1128 window_box_right (struct window
*w
, int area
)
1130 return window_box_left (w
, area
) + window_box_width (w
, area
);
1133 /* Get the bounding box of the display area AREA of window W, without
1134 mode lines, in frame-relative coordinates. AREA < 0 means the
1135 whole window, not including the left and right fringes of
1136 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1137 coordinates of the upper-left corner of the box. Return in
1138 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1141 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1142 int *box_width
, int *box_height
)
1145 *box_width
= window_box_width (w
, area
);
1147 *box_height
= window_box_height (w
);
1149 *box_x
= window_box_left (w
, area
);
1152 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1153 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1154 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1159 /* Get the bounding box of the display area AREA of window W, without
1160 mode lines. AREA < 0 means the whole window, not including the
1161 left and right fringe of the window. Return in *TOP_LEFT_X
1162 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1163 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1164 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1168 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1169 int *bottom_right_x
, int *bottom_right_y
)
1171 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1173 *bottom_right_x
+= *top_left_x
;
1174 *bottom_right_y
+= *top_left_y
;
1179 /***********************************************************************
1181 ***********************************************************************/
1183 /* Return the bottom y-position of the line the iterator IT is in.
1184 This can modify IT's settings. */
1187 line_bottom_y (struct it
*it
)
1189 int line_height
= it
->max_ascent
+ it
->max_descent
;
1190 int line_top_y
= it
->current_y
;
1192 if (line_height
== 0)
1195 line_height
= last_height
;
1196 else if (IT_CHARPOS (*it
) < ZV
)
1198 move_it_by_lines (it
, 1);
1199 line_height
= (it
->max_ascent
|| it
->max_descent
1200 ? it
->max_ascent
+ it
->max_descent
1205 struct glyph_row
*row
= it
->glyph_row
;
1207 /* Use the default character height. */
1208 it
->glyph_row
= NULL
;
1209 it
->what
= IT_CHARACTER
;
1212 PRODUCE_GLYPHS (it
);
1213 line_height
= it
->ascent
+ it
->descent
;
1214 it
->glyph_row
= row
;
1218 return line_top_y
+ line_height
;
1221 /* Subroutine of pos_visible_p below. Extracts a display string, if
1222 any, from the display spec given as its argument. */
1224 string_from_display_spec (Lisp_Object spec
)
1228 while (CONSP (spec
))
1230 if (STRINGP (XCAR (spec
)))
1235 else if (VECTORP (spec
))
1239 for (i
= 0; i
< ASIZE (spec
); i
++)
1241 if (STRINGP (AREF (spec
, i
)))
1242 return AREF (spec
, i
);
1251 /* Limit insanely large values of W->hscroll on frame F to the largest
1252 value that will still prevent first_visible_x and last_visible_x of
1253 'struct it' from overflowing an int. */
1255 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1257 ptrdiff_t window_hscroll
= w
->hscroll
;
1258 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1259 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1261 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1262 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1264 return window_hscroll
;
1267 /* Return 1 if position CHARPOS is visible in window W.
1268 CHARPOS < 0 means return info about WINDOW_END position.
1269 If visible, set *X and *Y to pixel coordinates of top left corner.
1270 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1271 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1274 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1275 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1278 void *itdata
= bidi_shelve_cache ();
1279 struct text_pos top
;
1281 struct buffer
*old_buffer
= NULL
;
1283 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1286 if (XBUFFER (w
->contents
) != current_buffer
)
1288 old_buffer
= current_buffer
;
1289 set_buffer_internal_1 (XBUFFER (w
->contents
));
1292 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1293 /* Scrolling a minibuffer window via scroll bar when the echo area
1294 shows long text sometimes resets the minibuffer contents behind
1296 if (CHARPOS (top
) > ZV
)
1297 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1299 /* Compute exact mode line heights. */
1300 if (WINDOW_WANTS_MODELINE_P (w
))
1301 current_mode_line_height
1302 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1303 BVAR (current_buffer
, mode_line_format
));
1305 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1306 current_header_line_height
1307 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1308 BVAR (current_buffer
, header_line_format
));
1310 start_display (&it
, w
, top
);
1311 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1312 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1315 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1316 && IT_CHARPOS (it
) >= charpos
)
1317 /* When scanning backwards under bidi iteration, move_it_to
1318 stops at or _before_ CHARPOS, because it stops at or to
1319 the _right_ of the character at CHARPOS. */
1320 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1321 && IT_CHARPOS (it
) <= charpos
)))
1323 /* We have reached CHARPOS, or passed it. How the call to
1324 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1325 or covered by a display property, move_it_to stops at the end
1326 of the invisible text, to the right of CHARPOS. (ii) If
1327 CHARPOS is in a display vector, move_it_to stops on its last
1329 int top_x
= it
.current_x
;
1330 int top_y
= it
.current_y
;
1331 /* Calling line_bottom_y may change it.method, it.position, etc. */
1332 enum it_method it_method
= it
.method
;
1333 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1334 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1336 if (top_y
< window_top_y
)
1337 visible_p
= bottom_y
> window_top_y
;
1338 else if (top_y
< it
.last_visible_y
)
1340 if (bottom_y
>= it
.last_visible_y
1341 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1342 && IT_CHARPOS (it
) < charpos
)
1344 /* When the last line of the window is scanned backwards
1345 under bidi iteration, we could be duped into thinking
1346 that we have passed CHARPOS, when in fact move_it_to
1347 simply stopped short of CHARPOS because it reached
1348 last_visible_y. To see if that's what happened, we call
1349 move_it_to again with a slightly larger vertical limit,
1350 and see if it actually moved vertically; if it did, we
1351 didn't really reach CHARPOS, which is beyond window end. */
1352 struct it save_it
= it
;
1353 /* Why 10? because we don't know how many canonical lines
1354 will the height of the next line(s) be. So we guess. */
1355 int ten_more_lines
=
1356 10 * FRAME_LINE_HEIGHT (XFRAME (WINDOW_FRAME (w
)));
1358 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1359 MOVE_TO_POS
| MOVE_TO_Y
);
1360 if (it
.current_y
> top_y
)
1367 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1369 /* We stopped on the last glyph of a display vector.
1370 Try and recompute. Hack alert! */
1371 if (charpos
< 2 || top
.charpos
>= charpos
)
1372 top_x
= it
.glyph_row
->x
;
1376 start_display (&it2
, w
, top
);
1377 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1378 get_next_display_element (&it2
);
1379 PRODUCE_GLYPHS (&it2
);
1380 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1381 || it2
.current_x
> it2
.last_visible_x
)
1382 top_x
= it
.glyph_row
->x
;
1385 top_x
= it2
.current_x
;
1386 top_y
= it2
.current_y
;
1390 else if (IT_CHARPOS (it
) != charpos
)
1392 Lisp_Object cpos
= make_number (charpos
);
1393 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1394 Lisp_Object string
= string_from_display_spec (spec
);
1395 bool newline_in_string
1397 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1398 /* The tricky code below is needed because there's a
1399 discrepancy between move_it_to and how we set cursor
1400 when the display line ends in a newline from a
1401 display string. move_it_to will stop _after_ such
1402 display strings, whereas set_cursor_from_row
1403 conspires with cursor_row_p to place the cursor on
1404 the first glyph produced from the display string. */
1406 /* We have overshoot PT because it is covered by a
1407 display property whose value is a string. If the
1408 string includes embedded newlines, we are also in the
1409 wrong display line. Backtrack to the correct line,
1410 where the display string begins. */
1411 if (newline_in_string
)
1413 Lisp_Object startpos
, endpos
;
1414 EMACS_INT start
, end
;
1418 /* Find the first and the last buffer positions
1419 covered by the display string. */
1421 Fnext_single_char_property_change (cpos
, Qdisplay
,
1424 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1426 start
= XFASTINT (startpos
);
1427 end
= XFASTINT (endpos
);
1428 /* Move to the last buffer position before the
1429 display property. */
1430 start_display (&it3
, w
, top
);
1431 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1432 /* Move forward one more line if the position before
1433 the display string is a newline or if it is the
1434 rightmost character on a line that is
1435 continued or word-wrapped. */
1436 if (it3
.method
== GET_FROM_BUFFER
1438 move_it_by_lines (&it3
, 1);
1439 else if (move_it_in_display_line_to (&it3
, -1,
1443 == MOVE_LINE_CONTINUED
)
1445 move_it_by_lines (&it3
, 1);
1446 /* When we are under word-wrap, the #$@%!
1447 move_it_by_lines moves 2 lines, so we need to
1449 if (it3
.line_wrap
== WORD_WRAP
)
1450 move_it_by_lines (&it3
, -1);
1453 /* Record the vertical coordinate of the display
1454 line where we wound up. */
1455 top_y
= it3
.current_y
;
1458 /* When characters are reordered for display,
1459 the character displayed to the left of the
1460 display string could be _after_ the display
1461 property in the logical order. Use the
1462 smallest vertical position of these two. */
1463 start_display (&it3
, w
, top
);
1464 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1465 if (it3
.current_y
< top_y
)
1466 top_y
= it3
.current_y
;
1468 /* Move from the top of the window to the beginning
1469 of the display line where the display string
1471 start_display (&it3
, w
, top
);
1472 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1473 /* If it3_moved stays zero after the 'while' loop
1474 below, that means we already were at a newline
1475 before the loop (e.g., the display string begins
1476 with a newline), so we don't need to (and cannot)
1477 inspect the glyphs of it3.glyph_row, because
1478 PRODUCE_GLYPHS will not produce anything for a
1479 newline, and thus it3.glyph_row stays at its
1480 stale content it got at top of the window. */
1482 /* Finally, advance the iterator until we hit the
1483 first display element whose character position is
1484 CHARPOS, or until the first newline from the
1485 display string, which signals the end of the
1487 while (get_next_display_element (&it3
))
1489 PRODUCE_GLYPHS (&it3
);
1490 if (IT_CHARPOS (it3
) == charpos
1491 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1494 set_iterator_to_next (&it3
, 0);
1496 top_x
= it3
.current_x
- it3
.pixel_width
;
1497 /* Normally, we would exit the above loop because we
1498 found the display element whose character
1499 position is CHARPOS. For the contingency that we
1500 didn't, and stopped at the first newline from the
1501 display string, move back over the glyphs
1502 produced from the string, until we find the
1503 rightmost glyph not from the string. */
1505 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1507 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1508 + it3
.glyph_row
->used
[TEXT_AREA
];
1510 while (EQ ((g
- 1)->object
, string
))
1513 top_x
-= g
->pixel_width
;
1515 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1516 + it3
.glyph_row
->used
[TEXT_AREA
]);
1522 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1523 *rtop
= max (0, window_top_y
- top_y
);
1524 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1525 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1526 - max (top_y
, window_top_y
)));
1532 /* We were asked to provide info about WINDOW_END. */
1534 void *it2data
= NULL
;
1536 SAVE_IT (it2
, it
, it2data
);
1537 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1538 move_it_by_lines (&it
, 1);
1539 if (charpos
< IT_CHARPOS (it
)
1540 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1543 RESTORE_IT (&it2
, &it2
, it2data
);
1544 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1546 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1547 *rtop
= max (0, -it2
.current_y
);
1548 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1549 - it
.last_visible_y
));
1550 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1552 - max (it2
.current_y
,
1553 WINDOW_HEADER_LINE_HEIGHT (w
))));
1557 bidi_unshelve_cache (it2data
, 1);
1559 bidi_unshelve_cache (itdata
, 0);
1562 set_buffer_internal_1 (old_buffer
);
1564 current_header_line_height
= current_mode_line_height
= -1;
1566 if (visible_p
&& w
->hscroll
> 0)
1568 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1569 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1572 /* Debugging code. */
1574 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1575 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1577 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1584 /* Return the next character from STR. Return in *LEN the length of
1585 the character. This is like STRING_CHAR_AND_LENGTH but never
1586 returns an invalid character. If we find one, we return a `?', but
1587 with the length of the invalid character. */
1590 string_char_and_length (const unsigned char *str
, int *len
)
1594 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1595 if (!CHAR_VALID_P (c
))
1596 /* We may not change the length here because other places in Emacs
1597 don't use this function, i.e. they silently accept invalid
1606 /* Given a position POS containing a valid character and byte position
1607 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1609 static struct text_pos
1610 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1612 eassert (STRINGP (string
) && nchars
>= 0);
1614 if (STRING_MULTIBYTE (string
))
1616 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1621 string_char_and_length (p
, &len
);
1624 BYTEPOS (pos
) += len
;
1628 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1634 /* Value is the text position, i.e. character and byte position,
1635 for character position CHARPOS in STRING. */
1637 static struct text_pos
1638 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1640 struct text_pos pos
;
1641 eassert (STRINGP (string
));
1642 eassert (charpos
>= 0);
1643 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1648 /* Value is a text position, i.e. character and byte position, for
1649 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1650 means recognize multibyte characters. */
1652 static struct text_pos
1653 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1655 struct text_pos pos
;
1657 eassert (s
!= NULL
);
1658 eassert (charpos
>= 0);
1664 SET_TEXT_POS (pos
, 0, 0);
1667 string_char_and_length ((const unsigned char *) s
, &len
);
1670 BYTEPOS (pos
) += len
;
1674 SET_TEXT_POS (pos
, charpos
, charpos
);
1680 /* Value is the number of characters in C string S. MULTIBYTE_P
1681 non-zero means recognize multibyte characters. */
1684 number_of_chars (const char *s
, bool multibyte_p
)
1690 ptrdiff_t rest
= strlen (s
);
1692 const unsigned char *p
= (const unsigned char *) s
;
1694 for (nchars
= 0; rest
> 0; ++nchars
)
1696 string_char_and_length (p
, &len
);
1697 rest
-= len
, p
+= len
;
1701 nchars
= strlen (s
);
1707 /* Compute byte position NEWPOS->bytepos corresponding to
1708 NEWPOS->charpos. POS is a known position in string STRING.
1709 NEWPOS->charpos must be >= POS.charpos. */
1712 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1714 eassert (STRINGP (string
));
1715 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1717 if (STRING_MULTIBYTE (string
))
1718 *newpos
= string_pos_nchars_ahead (pos
, string
,
1719 CHARPOS (*newpos
) - CHARPOS (pos
));
1721 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1725 Return an estimation of the pixel height of mode or header lines on
1726 frame F. FACE_ID specifies what line's height to estimate. */
1729 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1731 #ifdef HAVE_WINDOW_SYSTEM
1732 if (FRAME_WINDOW_P (f
))
1734 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1736 /* This function is called so early when Emacs starts that the face
1737 cache and mode line face are not yet initialized. */
1738 if (FRAME_FACE_CACHE (f
))
1740 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1744 height
= FONT_HEIGHT (face
->font
);
1745 if (face
->box_line_width
> 0)
1746 height
+= 2 * face
->box_line_width
;
1757 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1758 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1759 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1760 not force the value into range. */
1763 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1764 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1767 #ifdef HAVE_WINDOW_SYSTEM
1768 if (FRAME_WINDOW_P (f
))
1770 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1771 even for negative values. */
1773 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1775 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1777 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1778 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1781 STORE_NATIVE_RECT (*bounds
,
1782 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1783 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1784 FRAME_COLUMN_WIDTH (f
) - 1,
1785 FRAME_LINE_HEIGHT (f
) - 1);
1791 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1792 pix_x
= FRAME_TOTAL_COLS (f
);
1796 else if (pix_y
> FRAME_LINES (f
))
1797 pix_y
= FRAME_LINES (f
);
1807 /* Find the glyph under window-relative coordinates X/Y in window W.
1808 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1809 strings. Return in *HPOS and *VPOS the row and column number of
1810 the glyph found. Return in *AREA the glyph area containing X.
1811 Value is a pointer to the glyph found or null if X/Y is not on
1812 text, or we can't tell because W's current matrix is not up to
1817 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1818 int *dx
, int *dy
, int *area
)
1820 struct glyph
*glyph
, *end
;
1821 struct glyph_row
*row
= NULL
;
1824 /* Find row containing Y. Give up if some row is not enabled. */
1825 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1827 row
= MATRIX_ROW (w
->current_matrix
, i
);
1828 if (!row
->enabled_p
)
1830 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1837 /* Give up if Y is not in the window. */
1838 if (i
== w
->current_matrix
->nrows
)
1841 /* Get the glyph area containing X. */
1842 if (w
->pseudo_window_p
)
1849 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1851 *area
= LEFT_MARGIN_AREA
;
1852 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1854 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1857 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1861 *area
= RIGHT_MARGIN_AREA
;
1862 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1866 /* Find glyph containing X. */
1867 glyph
= row
->glyphs
[*area
];
1868 end
= glyph
+ row
->used
[*area
];
1870 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1872 x
-= glyph
->pixel_width
;
1882 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1885 *hpos
= glyph
- row
->glyphs
[*area
];
1889 /* Convert frame-relative x/y to coordinates relative to window W.
1890 Takes pseudo-windows into account. */
1893 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1895 if (w
->pseudo_window_p
)
1897 /* A pseudo-window is always full-width, and starts at the
1898 left edge of the frame, plus a frame border. */
1899 struct frame
*f
= XFRAME (w
->frame
);
1900 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1901 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1905 *x
-= WINDOW_LEFT_EDGE_X (w
);
1906 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1910 #ifdef HAVE_WINDOW_SYSTEM
1913 Return in RECTS[] at most N clipping rectangles for glyph string S.
1914 Return the number of stored rectangles. */
1917 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1924 if (s
->row
->full_width_p
)
1926 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1927 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1928 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1930 /* Unless displaying a mode or menu bar line, which are always
1931 fully visible, clip to the visible part of the row. */
1932 if (s
->w
->pseudo_window_p
)
1933 r
.height
= s
->row
->visible_height
;
1935 r
.height
= s
->height
;
1939 /* This is a text line that may be partially visible. */
1940 r
.x
= window_box_left (s
->w
, s
->area
);
1941 r
.width
= window_box_width (s
->w
, s
->area
);
1942 r
.height
= s
->row
->visible_height
;
1946 if (r
.x
< s
->clip_head
->x
)
1948 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1949 r
.width
-= s
->clip_head
->x
- r
.x
;
1952 r
.x
= s
->clip_head
->x
;
1955 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1957 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1958 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1963 /* If S draws overlapping rows, it's sufficient to use the top and
1964 bottom of the window for clipping because this glyph string
1965 intentionally draws over other lines. */
1966 if (s
->for_overlaps
)
1968 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1969 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1971 /* Alas, the above simple strategy does not work for the
1972 environments with anti-aliased text: if the same text is
1973 drawn onto the same place multiple times, it gets thicker.
1974 If the overlap we are processing is for the erased cursor, we
1975 take the intersection with the rectangle of the cursor. */
1976 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1978 XRectangle rc
, r_save
= r
;
1980 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1981 rc
.y
= s
->w
->phys_cursor
.y
;
1982 rc
.width
= s
->w
->phys_cursor_width
;
1983 rc
.height
= s
->w
->phys_cursor_height
;
1985 x_intersect_rectangles (&r_save
, &rc
, &r
);
1990 /* Don't use S->y for clipping because it doesn't take partially
1991 visible lines into account. For example, it can be negative for
1992 partially visible lines at the top of a window. */
1993 if (!s
->row
->full_width_p
1994 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1995 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1997 r
.y
= max (0, s
->row
->y
);
2000 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2002 /* If drawing the cursor, don't let glyph draw outside its
2003 advertised boundaries. Cleartype does this under some circumstances. */
2004 if (s
->hl
== DRAW_CURSOR
)
2006 struct glyph
*glyph
= s
->first_glyph
;
2011 r
.width
-= s
->x
- r
.x
;
2014 r
.width
= min (r
.width
, glyph
->pixel_width
);
2016 /* If r.y is below window bottom, ensure that we still see a cursor. */
2017 height
= min (glyph
->ascent
+ glyph
->descent
,
2018 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2019 max_y
= window_text_bottom_y (s
->w
) - height
;
2020 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2021 if (s
->ybase
- glyph
->ascent
> max_y
)
2028 /* Don't draw cursor glyph taller than our actual glyph. */
2029 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2030 if (height
< r
.height
)
2032 max_y
= r
.y
+ r
.height
;
2033 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2034 r
.height
= min (max_y
- r
.y
, height
);
2041 XRectangle r_save
= r
;
2043 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2047 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2048 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2050 #ifdef CONVERT_FROM_XRECT
2051 CONVERT_FROM_XRECT (r
, *rects
);
2059 /* If we are processing overlapping and allowed to return
2060 multiple clipping rectangles, we exclude the row of the glyph
2061 string from the clipping rectangle. This is to avoid drawing
2062 the same text on the environment with anti-aliasing. */
2063 #ifdef CONVERT_FROM_XRECT
2066 XRectangle
*rs
= rects
;
2068 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2070 if (s
->for_overlaps
& OVERLAPS_PRED
)
2073 if (r
.y
+ r
.height
> row_y
)
2076 rs
[i
].height
= row_y
- r
.y
;
2082 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2085 if (r
.y
< row_y
+ s
->row
->visible_height
)
2087 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2089 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2090 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2099 #ifdef CONVERT_FROM_XRECT
2100 for (i
= 0; i
< n
; i
++)
2101 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2108 Return in *NR the clipping rectangle for glyph string S. */
2111 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2113 get_glyph_string_clip_rects (s
, nr
, 1);
2118 Return the position and height of the phys cursor in window W.
2119 Set w->phys_cursor_width to width of phys cursor.
2123 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2124 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2126 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2127 int x
, y
, wd
, h
, h0
, y0
;
2129 /* Compute the width of the rectangle to draw. If on a stretch
2130 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2131 rectangle as wide as the glyph, but use a canonical character
2133 wd
= glyph
->pixel_width
- 1;
2134 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2138 x
= w
->phys_cursor
.x
;
2145 if (glyph
->type
== STRETCH_GLYPH
2146 && !x_stretch_cursor_p
)
2147 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2148 w
->phys_cursor_width
= wd
;
2150 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2152 /* If y is below window bottom, ensure that we still see a cursor. */
2153 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2155 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2156 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2158 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2161 h
= max (h
- (y0
- y
) + 1, h0
);
2166 y0
= window_text_bottom_y (w
) - h0
;
2174 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2175 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2180 * Remember which glyph the mouse is over.
2184 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2188 struct glyph_row
*r
, *gr
, *end_row
;
2189 enum window_part part
;
2190 enum glyph_row_area area
;
2191 int x
, y
, width
, height
;
2193 /* Try to determine frame pixel position and size of the glyph under
2194 frame pixel coordinates X/Y on frame F. */
2196 if (!f
->glyphs_initialized_p
2197 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2200 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2201 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2205 w
= XWINDOW (window
);
2206 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2207 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2209 x
= window_relative_x_coord (w
, part
, gx
);
2210 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2212 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2213 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2215 if (w
->pseudo_window_p
)
2218 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2224 case ON_LEFT_MARGIN
:
2225 area
= LEFT_MARGIN_AREA
;
2228 case ON_RIGHT_MARGIN
:
2229 area
= RIGHT_MARGIN_AREA
;
2232 case ON_HEADER_LINE
:
2234 gr
= (part
== ON_HEADER_LINE
2235 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2236 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2239 goto text_glyph_row_found
;
2246 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2247 if (r
->y
+ r
->height
> y
)
2253 text_glyph_row_found
:
2256 struct glyph
*g
= gr
->glyphs
[area
];
2257 struct glyph
*end
= g
+ gr
->used
[area
];
2259 height
= gr
->height
;
2260 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2261 if (gx
+ g
->pixel_width
> x
)
2266 if (g
->type
== IMAGE_GLYPH
)
2268 /* Don't remember when mouse is over image, as
2269 image may have hot-spots. */
2270 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2273 width
= g
->pixel_width
;
2277 /* Use nominal char spacing at end of line. */
2279 gx
+= (x
/ width
) * width
;
2282 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2283 gx
+= window_box_left_offset (w
, area
);
2287 /* Use nominal line height at end of window. */
2288 gx
= (x
/ width
) * width
;
2290 gy
+= (y
/ height
) * height
;
2294 case ON_LEFT_FRINGE
:
2295 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2296 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2297 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2298 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2301 case ON_RIGHT_FRINGE
:
2302 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2303 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2304 : window_box_right_offset (w
, TEXT_AREA
));
2305 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2309 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2311 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2312 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2313 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2315 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2319 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2320 if (r
->y
+ r
->height
> y
)
2327 height
= gr
->height
;
2330 /* Use nominal line height at end of window. */
2332 gy
+= (y
/ height
) * height
;
2339 /* If there is no glyph under the mouse, then we divide the screen
2340 into a grid of the smallest glyph in the frame, and use that
2343 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2344 round down even for negative values. */
2350 gx
= (gx
/ width
) * width
;
2351 gy
= (gy
/ height
) * height
;
2356 gx
+= WINDOW_LEFT_EDGE_X (w
);
2357 gy
+= WINDOW_TOP_EDGE_Y (w
);
2360 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2362 /* Visible feedback for debugging. */
2365 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2366 f
->output_data
.x
->normal_gc
,
2367 gx
, gy
, width
, height
);
2373 #endif /* HAVE_WINDOW_SYSTEM */
2376 /***********************************************************************
2377 Lisp form evaluation
2378 ***********************************************************************/
2380 /* Error handler for safe_eval and safe_call. */
2383 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2385 add_to_log ("Error during redisplay: %S signaled %S",
2386 Flist (nargs
, args
), arg
);
2390 /* Call function FUNC with the rest of NARGS - 1 arguments
2391 following. Return the result, or nil if something went
2392 wrong. Prevent redisplay during the evaluation. */
2395 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2399 if (inhibit_eval_during_redisplay
)
2405 ptrdiff_t count
= SPECPDL_INDEX ();
2406 struct gcpro gcpro1
;
2407 Lisp_Object
*args
= alloca (nargs
* word_size
);
2410 va_start (ap
, func
);
2411 for (i
= 1; i
< nargs
; i
++)
2412 args
[i
] = va_arg (ap
, Lisp_Object
);
2416 gcpro1
.nvars
= nargs
;
2417 specbind (Qinhibit_redisplay
, Qt
);
2418 /* Use Qt to ensure debugger does not run,
2419 so there is no possibility of wanting to redisplay. */
2420 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2423 val
= unbind_to (count
, val
);
2430 /* Call function FN with one argument ARG.
2431 Return the result, or nil if something went wrong. */
2434 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2436 return safe_call (2, fn
, arg
);
2439 static Lisp_Object Qeval
;
2442 safe_eval (Lisp_Object sexpr
)
2444 return safe_call1 (Qeval
, sexpr
);
2447 /* Call function FN with two arguments ARG1 and ARG2.
2448 Return the result, or nil if something went wrong. */
2451 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2453 return safe_call (3, fn
, arg1
, arg2
);
2458 /***********************************************************************
2460 ***********************************************************************/
2464 /* Define CHECK_IT to perform sanity checks on iterators.
2465 This is for debugging. It is too slow to do unconditionally. */
2468 check_it (struct it
*it
)
2470 if (it
->method
== GET_FROM_STRING
)
2472 eassert (STRINGP (it
->string
));
2473 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2477 eassert (IT_STRING_CHARPOS (*it
) < 0);
2478 if (it
->method
== GET_FROM_BUFFER
)
2480 /* Check that character and byte positions agree. */
2481 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2486 eassert (it
->current
.dpvec_index
>= 0);
2488 eassert (it
->current
.dpvec_index
< 0);
2491 #define CHECK_IT(IT) check_it ((IT))
2495 #define CHECK_IT(IT) (void) 0
2500 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2502 /* Check that the window end of window W is what we expect it
2503 to be---the last row in the current matrix displaying text. */
2506 check_window_end (struct window
*w
)
2508 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2510 struct glyph_row
*row
;
2511 eassert ((row
= MATRIX_ROW (w
->current_matrix
,
2512 XFASTINT (w
->window_end_vpos
)),
2514 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2515 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2519 #define CHECK_WINDOW_END(W) check_window_end ((W))
2523 #define CHECK_WINDOW_END(W) (void) 0
2525 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2527 /* Return mark position if current buffer has the region of non-zero length,
2531 markpos_of_region (void)
2533 if (!NILP (Vtransient_mark_mode
)
2534 && !NILP (BVAR (current_buffer
, mark_active
))
2535 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= NULL
)
2537 ptrdiff_t markpos
= XMARKER (BVAR (current_buffer
, mark
))->charpos
;
2545 /***********************************************************************
2546 Iterator initialization
2547 ***********************************************************************/
2549 /* Initialize IT for displaying current_buffer in window W, starting
2550 at character position CHARPOS. CHARPOS < 0 means that no buffer
2551 position is specified which is useful when the iterator is assigned
2552 a position later. BYTEPOS is the byte position corresponding to
2555 If ROW is not null, calls to produce_glyphs with IT as parameter
2556 will produce glyphs in that row.
2558 BASE_FACE_ID is the id of a base face to use. It must be one of
2559 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2560 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2561 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2563 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2564 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2565 will be initialized to use the corresponding mode line glyph row of
2566 the desired matrix of W. */
2569 init_iterator (struct it
*it
, struct window
*w
,
2570 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2571 struct glyph_row
*row
, enum face_id base_face_id
)
2574 enum face_id remapped_base_face_id
= base_face_id
;
2576 /* Some precondition checks. */
2577 eassert (w
!= NULL
&& it
!= NULL
);
2578 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2581 /* If face attributes have been changed since the last redisplay,
2582 free realized faces now because they depend on face definitions
2583 that might have changed. Don't free faces while there might be
2584 desired matrices pending which reference these faces. */
2585 if (face_change_count
&& !inhibit_free_realized_faces
)
2587 face_change_count
= 0;
2588 free_all_realized_faces (Qnil
);
2591 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2592 if (! NILP (Vface_remapping_alist
))
2593 remapped_base_face_id
2594 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2596 /* Use one of the mode line rows of W's desired matrix if
2600 if (base_face_id
== MODE_LINE_FACE_ID
2601 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2602 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2603 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2604 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2608 memset (it
, 0, sizeof *it
);
2609 it
->current
.overlay_string_index
= -1;
2610 it
->current
.dpvec_index
= -1;
2611 it
->base_face_id
= remapped_base_face_id
;
2613 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2614 it
->paragraph_embedding
= L2R
;
2615 it
->bidi_it
.string
.lstring
= Qnil
;
2616 it
->bidi_it
.string
.s
= NULL
;
2617 it
->bidi_it
.string
.bufpos
= 0;
2619 /* The window in which we iterate over current_buffer: */
2620 XSETWINDOW (it
->window
, w
);
2622 it
->f
= XFRAME (w
->frame
);
2626 /* Extra space between lines (on window systems only). */
2627 if (base_face_id
== DEFAULT_FACE_ID
2628 && FRAME_WINDOW_P (it
->f
))
2630 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2631 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2632 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2633 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2634 * FRAME_LINE_HEIGHT (it
->f
));
2635 else if (it
->f
->extra_line_spacing
> 0)
2636 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2637 it
->max_extra_line_spacing
= 0;
2640 /* If realized faces have been removed, e.g. because of face
2641 attribute changes of named faces, recompute them. When running
2642 in batch mode, the face cache of the initial frame is null. If
2643 we happen to get called, make a dummy face cache. */
2644 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2645 init_frame_faces (it
->f
);
2646 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2647 recompute_basic_faces (it
->f
);
2649 /* Current value of the `slice', `space-width', and 'height' properties. */
2650 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2651 it
->space_width
= Qnil
;
2652 it
->font_height
= Qnil
;
2653 it
->override_ascent
= -1;
2655 /* Are control characters displayed as `^C'? */
2656 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2658 /* -1 means everything between a CR and the following line end
2659 is invisible. >0 means lines indented more than this value are
2661 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2663 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2665 : (!NILP (BVAR (current_buffer
, selective_display
))
2667 it
->selective_display_ellipsis_p
2668 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2670 /* Display table to use. */
2671 it
->dp
= window_display_table (w
);
2673 /* Are multibyte characters enabled in current_buffer? */
2674 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2676 /* If visible region is of non-zero length, set IT->region_beg_charpos
2677 and IT->region_end_charpos to the start and end of a visible region
2678 in window IT->w. Set both to -1 to indicate no region. */
2679 markpos
= markpos_of_region ();
2681 /* Maybe highlight only in selected window. */
2682 && (/* Either show region everywhere. */
2683 highlight_nonselected_windows
2684 /* Or show region in the selected window. */
2685 || w
== XWINDOW (selected_window
)
2686 /* Or show the region if we are in the mini-buffer and W is
2687 the window the mini-buffer refers to. */
2688 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2689 && WINDOWP (minibuf_selected_window
)
2690 && w
== XWINDOW (minibuf_selected_window
))))
2692 it
->region_beg_charpos
= min (PT
, markpos
);
2693 it
->region_end_charpos
= max (PT
, markpos
);
2696 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2698 /* Get the position at which the redisplay_end_trigger hook should
2699 be run, if it is to be run at all. */
2700 if (MARKERP (w
->redisplay_end_trigger
)
2701 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2702 it
->redisplay_end_trigger_charpos
2703 = marker_position (w
->redisplay_end_trigger
);
2704 else if (INTEGERP (w
->redisplay_end_trigger
))
2705 it
->redisplay_end_trigger_charpos
=
2706 clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
), PTRDIFF_MAX
);
2708 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2710 /* Are lines in the display truncated? */
2711 if (base_face_id
!= DEFAULT_FACE_ID
2713 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2714 && ((!NILP (Vtruncate_partial_width_windows
)
2715 && !INTEGERP (Vtruncate_partial_width_windows
))
2716 || (INTEGERP (Vtruncate_partial_width_windows
)
2717 && (WINDOW_TOTAL_COLS (it
->w
)
2718 < XINT (Vtruncate_partial_width_windows
))))))
2719 it
->line_wrap
= TRUNCATE
;
2720 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2721 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2722 ? WINDOW_WRAP
: WORD_WRAP
;
2724 it
->line_wrap
= TRUNCATE
;
2726 /* Get dimensions of truncation and continuation glyphs. These are
2727 displayed as fringe bitmaps under X, but we need them for such
2728 frames when the fringes are turned off. But leave the dimensions
2729 zero for tooltip frames, as these glyphs look ugly there and also
2730 sabotage calculations of tooltip dimensions in x-show-tip. */
2731 #ifdef HAVE_WINDOW_SYSTEM
2732 if (!(FRAME_WINDOW_P (it
->f
)
2733 && FRAMEP (tip_frame
)
2734 && it
->f
== XFRAME (tip_frame
)))
2737 if (it
->line_wrap
== TRUNCATE
)
2739 /* We will need the truncation glyph. */
2740 eassert (it
->glyph_row
== NULL
);
2741 produce_special_glyphs (it
, IT_TRUNCATION
);
2742 it
->truncation_pixel_width
= it
->pixel_width
;
2746 /* We will need the continuation glyph. */
2747 eassert (it
->glyph_row
== NULL
);
2748 produce_special_glyphs (it
, IT_CONTINUATION
);
2749 it
->continuation_pixel_width
= it
->pixel_width
;
2753 /* Reset these values to zero because the produce_special_glyphs
2754 above has changed them. */
2755 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2756 it
->phys_ascent
= it
->phys_descent
= 0;
2758 /* Set this after getting the dimensions of truncation and
2759 continuation glyphs, so that we don't produce glyphs when calling
2760 produce_special_glyphs, above. */
2761 it
->glyph_row
= row
;
2762 it
->area
= TEXT_AREA
;
2764 /* Forget any previous info about this row being reversed. */
2766 it
->glyph_row
->reversed_p
= 0;
2768 /* Get the dimensions of the display area. The display area
2769 consists of the visible window area plus a horizontally scrolled
2770 part to the left of the window. All x-values are relative to the
2771 start of this total display area. */
2772 if (base_face_id
!= DEFAULT_FACE_ID
)
2774 /* Mode lines, menu bar in terminal frames. */
2775 it
->first_visible_x
= 0;
2776 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2780 it
->first_visible_x
=
2781 window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2782 it
->last_visible_x
= (it
->first_visible_x
2783 + window_box_width (w
, TEXT_AREA
));
2785 /* If we truncate lines, leave room for the truncation glyph(s) at
2786 the right margin. Otherwise, leave room for the continuation
2787 glyph(s). Done only if the window has no fringes. Since we
2788 don't know at this point whether there will be any R2L lines in
2789 the window, we reserve space for truncation/continuation glyphs
2790 even if only one of the fringes is absent. */
2791 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
2792 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
2794 if (it
->line_wrap
== TRUNCATE
)
2795 it
->last_visible_x
-= it
->truncation_pixel_width
;
2797 it
->last_visible_x
-= it
->continuation_pixel_width
;
2800 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2801 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2804 /* Leave room for a border glyph. */
2805 if (!FRAME_WINDOW_P (it
->f
)
2806 && !WINDOW_RIGHTMOST_P (it
->w
))
2807 it
->last_visible_x
-= 1;
2809 it
->last_visible_y
= window_text_bottom_y (w
);
2811 /* For mode lines and alike, arrange for the first glyph having a
2812 left box line if the face specifies a box. */
2813 if (base_face_id
!= DEFAULT_FACE_ID
)
2817 it
->face_id
= remapped_base_face_id
;
2819 /* If we have a boxed mode line, make the first character appear
2820 with a left box line. */
2821 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2822 if (face
->box
!= FACE_NO_BOX
)
2823 it
->start_of_box_run_p
= 1;
2826 /* If a buffer position was specified, set the iterator there,
2827 getting overlays and face properties from that position. */
2828 if (charpos
>= BUF_BEG (current_buffer
))
2830 it
->end_charpos
= ZV
;
2831 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2832 IT_CHARPOS (*it
) = charpos
;
2833 IT_BYTEPOS (*it
) = bytepos
;
2835 /* We will rely on `reseat' to set this up properly, via
2836 handle_face_prop. */
2837 it
->face_id
= it
->base_face_id
;
2839 it
->start
= it
->current
;
2840 /* Do we need to reorder bidirectional text? Not if this is a
2841 unibyte buffer: by definition, none of the single-byte
2842 characters are strong R2L, so no reordering is needed. And
2843 bidi.c doesn't support unibyte buffers anyway. Also, don't
2844 reorder while we are loading loadup.el, since the tables of
2845 character properties needed for reordering are not yet
2849 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2852 /* If we are to reorder bidirectional text, init the bidi
2856 /* Note the paragraph direction that this buffer wants to
2858 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2860 it
->paragraph_embedding
= L2R
;
2861 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2863 it
->paragraph_embedding
= R2L
;
2865 it
->paragraph_embedding
= NEUTRAL_DIR
;
2866 bidi_unshelve_cache (NULL
, 0);
2867 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2871 /* Compute faces etc. */
2872 reseat (it
, it
->current
.pos
, 1);
2879 /* Initialize IT for the display of window W with window start POS. */
2882 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2884 struct glyph_row
*row
;
2885 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2887 row
= w
->desired_matrix
->rows
+ first_vpos
;
2888 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2889 it
->first_vpos
= first_vpos
;
2891 /* Don't reseat to previous visible line start if current start
2892 position is in a string or image. */
2893 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2895 int start_at_line_beg_p
;
2896 int first_y
= it
->current_y
;
2898 /* If window start is not at a line start, skip forward to POS to
2899 get the correct continuation lines width. */
2900 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2901 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2902 if (!start_at_line_beg_p
)
2906 reseat_at_previous_visible_line_start (it
);
2907 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2909 new_x
= it
->current_x
+ it
->pixel_width
;
2911 /* If lines are continued, this line may end in the middle
2912 of a multi-glyph character (e.g. a control character
2913 displayed as \003, or in the middle of an overlay
2914 string). In this case move_it_to above will not have
2915 taken us to the start of the continuation line but to the
2916 end of the continued line. */
2917 if (it
->current_x
> 0
2918 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2919 && (/* And glyph doesn't fit on the line. */
2920 new_x
> it
->last_visible_x
2921 /* Or it fits exactly and we're on a window
2923 || (new_x
== it
->last_visible_x
2924 && FRAME_WINDOW_P (it
->f
)
2925 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2926 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2927 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2929 if ((it
->current
.dpvec_index
>= 0
2930 || it
->current
.overlay_string_index
>= 0)
2931 /* If we are on a newline from a display vector or
2932 overlay string, then we are already at the end of
2933 a screen line; no need to go to the next line in
2934 that case, as this line is not really continued.
2935 (If we do go to the next line, C-e will not DTRT.) */
2938 set_iterator_to_next (it
, 1);
2939 move_it_in_display_line_to (it
, -1, -1, 0);
2942 it
->continuation_lines_width
+= it
->current_x
;
2944 /* If the character at POS is displayed via a display
2945 vector, move_it_to above stops at the final glyph of
2946 IT->dpvec. To make the caller redisplay that character
2947 again (a.k.a. start at POS), we need to reset the
2948 dpvec_index to the beginning of IT->dpvec. */
2949 else if (it
->current
.dpvec_index
>= 0)
2950 it
->current
.dpvec_index
= 0;
2952 /* We're starting a new display line, not affected by the
2953 height of the continued line, so clear the appropriate
2954 fields in the iterator structure. */
2955 it
->max_ascent
= it
->max_descent
= 0;
2956 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2958 it
->current_y
= first_y
;
2960 it
->current_x
= it
->hpos
= 0;
2966 /* Return 1 if POS is a position in ellipses displayed for invisible
2967 text. W is the window we display, for text property lookup. */
2970 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2972 Lisp_Object prop
, window
;
2974 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
2976 /* If POS specifies a position in a display vector, this might
2977 be for an ellipsis displayed for invisible text. We won't
2978 get the iterator set up for delivering that ellipsis unless
2979 we make sure that it gets aware of the invisible text. */
2980 if (pos
->dpvec_index
>= 0
2981 && pos
->overlay_string_index
< 0
2982 && CHARPOS (pos
->string_pos
) < 0
2984 && (XSETWINDOW (window
, w
),
2985 prop
= Fget_char_property (make_number (charpos
),
2986 Qinvisible
, window
),
2987 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2989 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2991 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2998 /* Initialize IT for stepping through current_buffer in window W,
2999 starting at position POS that includes overlay string and display
3000 vector/ control character translation position information. Value
3001 is zero if there are overlay strings with newlines at POS. */
3004 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3006 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3007 int i
, overlay_strings_with_newlines
= 0;
3009 /* If POS specifies a position in a display vector, this might
3010 be for an ellipsis displayed for invisible text. We won't
3011 get the iterator set up for delivering that ellipsis unless
3012 we make sure that it gets aware of the invisible text. */
3013 if (in_ellipses_for_invisible_text_p (pos
, w
))
3019 /* Keep in mind: the call to reseat in init_iterator skips invisible
3020 text, so we might end up at a position different from POS. This
3021 is only a problem when POS is a row start after a newline and an
3022 overlay starts there with an after-string, and the overlay has an
3023 invisible property. Since we don't skip invisible text in
3024 display_line and elsewhere immediately after consuming the
3025 newline before the row start, such a POS will not be in a string,
3026 but the call to init_iterator below will move us to the
3028 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3030 /* This only scans the current chunk -- it should scan all chunks.
3031 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3032 to 16 in 22.1 to make this a lesser problem. */
3033 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3035 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3036 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3038 while (s
< e
&& *s
!= '\n')
3043 overlay_strings_with_newlines
= 1;
3048 /* If position is within an overlay string, set up IT to the right
3050 if (pos
->overlay_string_index
>= 0)
3054 /* If the first overlay string happens to have a `display'
3055 property for an image, the iterator will be set up for that
3056 image, and we have to undo that setup first before we can
3057 correct the overlay string index. */
3058 if (it
->method
== GET_FROM_IMAGE
)
3061 /* We already have the first chunk of overlay strings in
3062 IT->overlay_strings. Load more until the one for
3063 pos->overlay_string_index is in IT->overlay_strings. */
3064 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3066 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3067 it
->current
.overlay_string_index
= 0;
3070 load_overlay_strings (it
, 0);
3071 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3075 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3076 relative_index
= (it
->current
.overlay_string_index
3077 % OVERLAY_STRING_CHUNK_SIZE
);
3078 it
->string
= it
->overlay_strings
[relative_index
];
3079 eassert (STRINGP (it
->string
));
3080 it
->current
.string_pos
= pos
->string_pos
;
3081 it
->method
= GET_FROM_STRING
;
3082 it
->end_charpos
= SCHARS (it
->string
);
3083 /* Set up the bidi iterator for this overlay string. */
3086 it
->bidi_it
.string
.lstring
= it
->string
;
3087 it
->bidi_it
.string
.s
= NULL
;
3088 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3089 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3090 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3091 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3092 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3093 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3095 /* Synchronize the state of the bidi iterator with
3096 pos->string_pos. For any string position other than
3097 zero, this will be done automagically when we resume
3098 iteration over the string and get_visually_first_element
3099 is called. But if string_pos is zero, and the string is
3100 to be reordered for display, we need to resync manually,
3101 since it could be that the iteration state recorded in
3102 pos ended at string_pos of 0 moving backwards in string. */
3103 if (CHARPOS (pos
->string_pos
) == 0)
3105 get_visually_first_element (it
);
3106 if (IT_STRING_CHARPOS (*it
) != 0)
3109 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3110 bidi_move_to_visually_next (&it
->bidi_it
);
3111 } while (it
->bidi_it
.charpos
!= 0);
3113 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3114 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3118 if (CHARPOS (pos
->string_pos
) >= 0)
3120 /* Recorded position is not in an overlay string, but in another
3121 string. This can only be a string from a `display' property.
3122 IT should already be filled with that string. */
3123 it
->current
.string_pos
= pos
->string_pos
;
3124 eassert (STRINGP (it
->string
));
3126 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3127 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3130 /* Restore position in display vector translations, control
3131 character translations or ellipses. */
3132 if (pos
->dpvec_index
>= 0)
3134 if (it
->dpvec
== NULL
)
3135 get_next_display_element (it
);
3136 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3137 it
->current
.dpvec_index
= pos
->dpvec_index
;
3141 return !overlay_strings_with_newlines
;
3145 /* Initialize IT for stepping through current_buffer in window W
3146 starting at ROW->start. */
3149 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3151 init_from_display_pos (it
, w
, &row
->start
);
3152 it
->start
= row
->start
;
3153 it
->continuation_lines_width
= row
->continuation_lines_width
;
3158 /* Initialize IT for stepping through current_buffer in window W
3159 starting in the line following ROW, i.e. starting at ROW->end.
3160 Value is zero if there are overlay strings with newlines at ROW's
3164 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3168 if (init_from_display_pos (it
, w
, &row
->end
))
3170 if (row
->continued_p
)
3171 it
->continuation_lines_width
3172 = row
->continuation_lines_width
+ row
->pixel_width
;
3183 /***********************************************************************
3185 ***********************************************************************/
3187 /* Called when IT reaches IT->stop_charpos. Handle text property and
3188 overlay changes. Set IT->stop_charpos to the next position where
3192 handle_stop (struct it
*it
)
3194 enum prop_handled handled
;
3195 int handle_overlay_change_p
;
3199 it
->current
.dpvec_index
= -1;
3200 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3201 it
->ignore_overlay_strings_at_pos_p
= 0;
3204 /* Use face of preceding text for ellipsis (if invisible) */
3205 if (it
->selective_display_ellipsis_p
)
3206 it
->saved_face_id
= it
->face_id
;
3210 handled
= HANDLED_NORMALLY
;
3212 /* Call text property handlers. */
3213 for (p
= it_props
; p
->handler
; ++p
)
3215 handled
= p
->handler (it
);
3217 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3219 else if (handled
== HANDLED_RETURN
)
3221 /* We still want to show before and after strings from
3222 overlays even if the actual buffer text is replaced. */
3223 if (!handle_overlay_change_p
3225 /* Don't call get_overlay_strings_1 if we already
3226 have overlay strings loaded, because doing so
3227 will load them again and push the iterator state
3228 onto the stack one more time, which is not
3229 expected by the rest of the code that processes
3231 || (it
->current
.overlay_string_index
< 0
3232 ? !get_overlay_strings_1 (it
, 0, 0)
3236 setup_for_ellipsis (it
, 0);
3237 /* When handling a display spec, we might load an
3238 empty string. In that case, discard it here. We
3239 used to discard it in handle_single_display_spec,
3240 but that causes get_overlay_strings_1, above, to
3241 ignore overlay strings that we must check. */
3242 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3246 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3250 it
->ignore_overlay_strings_at_pos_p
= 1;
3251 it
->string_from_display_prop_p
= 0;
3252 it
->from_disp_prop_p
= 0;
3253 handle_overlay_change_p
= 0;
3255 handled
= HANDLED_RECOMPUTE_PROPS
;
3258 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3259 handle_overlay_change_p
= 0;
3262 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3264 /* Don't check for overlay strings below when set to deliver
3265 characters from a display vector. */
3266 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3267 handle_overlay_change_p
= 0;
3269 /* Handle overlay changes.
3270 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3271 if it finds overlays. */
3272 if (handle_overlay_change_p
)
3273 handled
= handle_overlay_change (it
);
3278 setup_for_ellipsis (it
, 0);
3282 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3284 /* Determine where to stop next. */
3285 if (handled
== HANDLED_NORMALLY
)
3286 compute_stop_pos (it
);
3290 /* Compute IT->stop_charpos from text property and overlay change
3291 information for IT's current position. */
3294 compute_stop_pos (struct it
*it
)
3296 register INTERVAL iv
, next_iv
;
3297 Lisp_Object object
, limit
, position
;
3298 ptrdiff_t charpos
, bytepos
;
3300 if (STRINGP (it
->string
))
3302 /* Strings are usually short, so don't limit the search for
3304 it
->stop_charpos
= it
->end_charpos
;
3305 object
= it
->string
;
3307 charpos
= IT_STRING_CHARPOS (*it
);
3308 bytepos
= IT_STRING_BYTEPOS (*it
);
3314 /* If end_charpos is out of range for some reason, such as a
3315 misbehaving display function, rationalize it (Bug#5984). */
3316 if (it
->end_charpos
> ZV
)
3317 it
->end_charpos
= ZV
;
3318 it
->stop_charpos
= it
->end_charpos
;
3320 /* If next overlay change is in front of the current stop pos
3321 (which is IT->end_charpos), stop there. Note: value of
3322 next_overlay_change is point-max if no overlay change
3324 charpos
= IT_CHARPOS (*it
);
3325 bytepos
= IT_BYTEPOS (*it
);
3326 pos
= next_overlay_change (charpos
);
3327 if (pos
< it
->stop_charpos
)
3328 it
->stop_charpos
= pos
;
3330 /* If showing the region, we have to stop at the region
3331 start or end because the face might change there. */
3332 if (it
->region_beg_charpos
> 0)
3334 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3335 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3336 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3337 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3340 /* Set up variables for computing the stop position from text
3341 property changes. */
3342 XSETBUFFER (object
, current_buffer
);
3343 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3346 /* Get the interval containing IT's position. Value is a null
3347 interval if there isn't such an interval. */
3348 position
= make_number (charpos
);
3349 iv
= validate_interval_range (object
, &position
, &position
, 0);
3352 Lisp_Object values_here
[LAST_PROP_IDX
];
3355 /* Get properties here. */
3356 for (p
= it_props
; p
->handler
; ++p
)
3357 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3359 /* Look for an interval following iv that has different
3361 for (next_iv
= next_interval (iv
);
3364 || XFASTINT (limit
) > next_iv
->position
));
3365 next_iv
= next_interval (next_iv
))
3367 for (p
= it_props
; p
->handler
; ++p
)
3369 Lisp_Object new_value
;
3371 new_value
= textget (next_iv
->plist
, *p
->name
);
3372 if (!EQ (values_here
[p
->idx
], new_value
))
3382 if (INTEGERP (limit
)
3383 && next_iv
->position
>= XFASTINT (limit
))
3384 /* No text property change up to limit. */
3385 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3387 /* Text properties change in next_iv. */
3388 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3392 if (it
->cmp_it
.id
< 0)
3394 ptrdiff_t stoppos
= it
->end_charpos
;
3396 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3398 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3399 stoppos
, it
->string
);
3402 eassert (STRINGP (it
->string
)
3403 || (it
->stop_charpos
>= BEGV
3404 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3408 /* Return the position of the next overlay change after POS in
3409 current_buffer. Value is point-max if no overlay change
3410 follows. This is like `next-overlay-change' but doesn't use
3414 next_overlay_change (ptrdiff_t pos
)
3416 ptrdiff_t i
, noverlays
;
3418 Lisp_Object
*overlays
;
3420 /* Get all overlays at the given position. */
3421 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3423 /* If any of these overlays ends before endpos,
3424 use its ending point instead. */
3425 for (i
= 0; i
< noverlays
; ++i
)
3430 oend
= OVERLAY_END (overlays
[i
]);
3431 oendpos
= OVERLAY_POSITION (oend
);
3432 endpos
= min (endpos
, oendpos
);
3438 /* How many characters forward to search for a display property or
3439 display string. Searching too far forward makes the bidi display
3440 sluggish, especially in small windows. */
3441 #define MAX_DISP_SCAN 250
3443 /* Return the character position of a display string at or after
3444 position specified by POSITION. If no display string exists at or
3445 after POSITION, return ZV. A display string is either an overlay
3446 with `display' property whose value is a string, or a `display'
3447 text property whose value is a string. STRING is data about the
3448 string to iterate; if STRING->lstring is nil, we are iterating a
3449 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3450 on a GUI frame. DISP_PROP is set to zero if we searched
3451 MAX_DISP_SCAN characters forward without finding any display
3452 strings, non-zero otherwise. It is set to 2 if the display string
3453 uses any kind of `(space ...)' spec that will produce a stretch of
3454 white space in the text area. */
3456 compute_display_string_pos (struct text_pos
*position
,
3457 struct bidi_string_data
*string
,
3458 int frame_window_p
, int *disp_prop
)
3460 /* OBJECT = nil means current buffer. */
3461 Lisp_Object object
=
3462 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3463 Lisp_Object pos
, spec
, limpos
;
3464 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3465 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3466 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3467 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3469 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3470 struct text_pos tpos
;
3476 /* We don't support display properties whose values are strings
3477 that have display string properties. */
3478 || string
->from_disp_str
3479 /* C strings cannot have display properties. */
3480 || (string
->s
&& !STRINGP (object
)))
3486 /* If the character at CHARPOS is where the display string begins,
3488 pos
= make_number (charpos
);
3489 if (STRINGP (object
))
3490 bufpos
= string
->bufpos
;
3494 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3496 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3499 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3507 /* Look forward for the first character with a `display' property
3508 that will replace the underlying text when displayed. */
3509 limpos
= make_number (lim
);
3511 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3512 CHARPOS (tpos
) = XFASTINT (pos
);
3513 if (CHARPOS (tpos
) >= lim
)
3518 if (STRINGP (object
))
3519 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3521 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3522 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3523 if (!STRINGP (object
))
3524 bufpos
= CHARPOS (tpos
);
3525 } while (NILP (spec
)
3526 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3527 bufpos
, frame_window_p
)));
3531 return CHARPOS (tpos
);
3534 /* Return the character position of the end of the display string that
3535 started at CHARPOS. If there's no display string at CHARPOS,
3536 return -1. A display string is either an overlay with `display'
3537 property whose value is a string or a `display' text property whose
3538 value is a string. */
3540 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3542 /* OBJECT = nil means current buffer. */
3543 Lisp_Object object
=
3544 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3545 Lisp_Object pos
= make_number (charpos
);
3547 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3549 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3552 /* It could happen that the display property or overlay was removed
3553 since we found it in compute_display_string_pos above. One way
3554 this can happen is if JIT font-lock was called (through
3555 handle_fontified_prop), and jit-lock-functions remove text
3556 properties or overlays from the portion of buffer that includes
3557 CHARPOS. Muse mode is known to do that, for example. In this
3558 case, we return -1 to the caller, to signal that no display
3559 string is actually present at CHARPOS. See bidi_fetch_char for
3560 how this is handled.
3562 An alternative would be to never look for display properties past
3563 it->stop_charpos. But neither compute_display_string_pos nor
3564 bidi_fetch_char that calls it know or care where the next
3566 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3569 /* Look forward for the first character where the `display' property
3571 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3573 return XFASTINT (pos
);
3578 /***********************************************************************
3580 ***********************************************************************/
3582 /* Handle changes in the `fontified' property of the current buffer by
3583 calling hook functions from Qfontification_functions to fontify
3586 static enum prop_handled
3587 handle_fontified_prop (struct it
*it
)
3589 Lisp_Object prop
, pos
;
3590 enum prop_handled handled
= HANDLED_NORMALLY
;
3592 if (!NILP (Vmemory_full
))
3595 /* Get the value of the `fontified' property at IT's current buffer
3596 position. (The `fontified' property doesn't have a special
3597 meaning in strings.) If the value is nil, call functions from
3598 Qfontification_functions. */
3599 if (!STRINGP (it
->string
)
3601 && !NILP (Vfontification_functions
)
3602 && !NILP (Vrun_hooks
)
3603 && (pos
= make_number (IT_CHARPOS (*it
)),
3604 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3605 /* Ignore the special cased nil value always present at EOB since
3606 no amount of fontifying will be able to change it. */
3607 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3609 ptrdiff_t count
= SPECPDL_INDEX ();
3611 struct buffer
*obuf
= current_buffer
;
3612 int begv
= BEGV
, zv
= ZV
;
3613 int old_clip_changed
= current_buffer
->clip_changed
;
3615 val
= Vfontification_functions
;
3616 specbind (Qfontification_functions
, Qnil
);
3618 eassert (it
->end_charpos
== ZV
);
3620 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3621 safe_call1 (val
, pos
);
3624 Lisp_Object fns
, fn
;
3625 struct gcpro gcpro1
, gcpro2
;
3630 for (; CONSP (val
); val
= XCDR (val
))
3636 /* A value of t indicates this hook has a local
3637 binding; it means to run the global binding too.
3638 In a global value, t should not occur. If it
3639 does, we must ignore it to avoid an endless
3641 for (fns
= Fdefault_value (Qfontification_functions
);
3647 safe_call1 (fn
, pos
);
3651 safe_call1 (fn
, pos
);
3657 unbind_to (count
, Qnil
);
3659 /* Fontification functions routinely call `save-restriction'.
3660 Normally, this tags clip_changed, which can confuse redisplay
3661 (see discussion in Bug#6671). Since we don't perform any
3662 special handling of fontification changes in the case where
3663 `save-restriction' isn't called, there's no point doing so in
3664 this case either. So, if the buffer's restrictions are
3665 actually left unchanged, reset clip_changed. */
3666 if (obuf
== current_buffer
)
3668 if (begv
== BEGV
&& zv
== ZV
)
3669 current_buffer
->clip_changed
= old_clip_changed
;
3671 /* There isn't much we can reasonably do to protect against
3672 misbehaving fontification, but here's a fig leaf. */
3673 else if (BUFFER_LIVE_P (obuf
))
3674 set_buffer_internal_1 (obuf
);
3676 /* The fontification code may have added/removed text.
3677 It could do even a lot worse, but let's at least protect against
3678 the most obvious case where only the text past `pos' gets changed',
3679 as is/was done in grep.el where some escapes sequences are turned
3680 into face properties (bug#7876). */
3681 it
->end_charpos
= ZV
;
3683 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3684 something. This avoids an endless loop if they failed to
3685 fontify the text for which reason ever. */
3686 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3687 handled
= HANDLED_RECOMPUTE_PROPS
;
3695 /***********************************************************************
3697 ***********************************************************************/
3699 /* Set up iterator IT from face properties at its current position.
3700 Called from handle_stop. */
3702 static enum prop_handled
3703 handle_face_prop (struct it
*it
)
3706 ptrdiff_t next_stop
;
3708 if (!STRINGP (it
->string
))
3711 = face_at_buffer_position (it
->w
,
3713 it
->region_beg_charpos
,
3714 it
->region_end_charpos
,
3717 + TEXT_PROP_DISTANCE_LIMIT
),
3718 0, it
->base_face_id
);
3720 /* Is this a start of a run of characters with box face?
3721 Caveat: this can be called for a freshly initialized
3722 iterator; face_id is -1 in this case. We know that the new
3723 face will not change until limit, i.e. if the new face has a
3724 box, all characters up to limit will have one. But, as
3725 usual, we don't know whether limit is really the end. */
3726 if (new_face_id
!= it
->face_id
)
3728 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3729 /* If it->face_id is -1, old_face below will be NULL, see
3730 the definition of FACE_FROM_ID. This will happen if this
3731 is the initial call that gets the face. */
3732 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3734 /* If the value of face_id of the iterator is -1, we have to
3735 look in front of IT's position and see whether there is a
3736 face there that's different from new_face_id. */
3737 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3739 int prev_face_id
= face_before_it_pos (it
);
3741 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3744 /* If the new face has a box, but the old face does not,
3745 this is the start of a run of characters with box face,
3746 i.e. this character has a shadow on the left side. */
3747 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3748 && (old_face
== NULL
|| !old_face
->box
));
3749 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3757 Lisp_Object from_overlay
3758 = (it
->current
.overlay_string_index
>= 0
3759 ? it
->string_overlays
[it
->current
.overlay_string_index
3760 % OVERLAY_STRING_CHUNK_SIZE
]
3763 /* See if we got to this string directly or indirectly from
3764 an overlay property. That includes the before-string or
3765 after-string of an overlay, strings in display properties
3766 provided by an overlay, their text properties, etc.
3768 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3769 if (! NILP (from_overlay
))
3770 for (i
= it
->sp
- 1; i
>= 0; i
--)
3772 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3774 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3775 % OVERLAY_STRING_CHUNK_SIZE
];
3776 else if (! NILP (it
->stack
[i
].from_overlay
))
3777 from_overlay
= it
->stack
[i
].from_overlay
;
3779 if (!NILP (from_overlay
))
3783 if (! NILP (from_overlay
))
3785 bufpos
= IT_CHARPOS (*it
);
3786 /* For a string from an overlay, the base face depends
3787 only on text properties and ignores overlays. */
3789 = face_for_overlay_string (it
->w
,
3791 it
->region_beg_charpos
,
3792 it
->region_end_charpos
,
3795 + TEXT_PROP_DISTANCE_LIMIT
),
3803 /* For strings from a `display' property, use the face at
3804 IT's current buffer position as the base face to merge
3805 with, so that overlay strings appear in the same face as
3806 surrounding text, unless they specify their own
3808 base_face_id
= it
->string_from_prefix_prop_p
3810 : underlying_face_id (it
);
3813 new_face_id
= face_at_string_position (it
->w
,
3815 IT_STRING_CHARPOS (*it
),
3817 it
->region_beg_charpos
,
3818 it
->region_end_charpos
,
3822 /* Is this a start of a run of characters with box? Caveat:
3823 this can be called for a freshly allocated iterator; face_id
3824 is -1 is this case. We know that the new face will not
3825 change until the next check pos, i.e. if the new face has a
3826 box, all characters up to that position will have a
3827 box. But, as usual, we don't know whether that position
3828 is really the end. */
3829 if (new_face_id
!= it
->face_id
)
3831 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3832 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3834 /* If new face has a box but old face hasn't, this is the
3835 start of a run of characters with box, i.e. it has a
3836 shadow on the left side. */
3837 it
->start_of_box_run_p
3838 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3839 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3843 it
->face_id
= new_face_id
;
3844 return HANDLED_NORMALLY
;
3848 /* Return the ID of the face ``underlying'' IT's current position,
3849 which is in a string. If the iterator is associated with a
3850 buffer, return the face at IT's current buffer position.
3851 Otherwise, use the iterator's base_face_id. */
3854 underlying_face_id (struct it
*it
)
3856 int face_id
= it
->base_face_id
, i
;
3858 eassert (STRINGP (it
->string
));
3860 for (i
= it
->sp
- 1; i
>= 0; --i
)
3861 if (NILP (it
->stack
[i
].string
))
3862 face_id
= it
->stack
[i
].face_id
;
3868 /* Compute the face one character before or after the current position
3869 of IT, in the visual order. BEFORE_P non-zero means get the face
3870 in front (to the left in L2R paragraphs, to the right in R2L
3871 paragraphs) of IT's screen position. Value is the ID of the face. */
3874 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3877 ptrdiff_t next_check_charpos
;
3879 void *it_copy_data
= NULL
;
3881 eassert (it
->s
== NULL
);
3883 if (STRINGP (it
->string
))
3885 ptrdiff_t bufpos
, charpos
;
3888 /* No face change past the end of the string (for the case
3889 we are padding with spaces). No face change before the
3891 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3892 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3897 /* Set charpos to the position before or after IT's current
3898 position, in the logical order, which in the non-bidi
3899 case is the same as the visual order. */
3901 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3902 else if (it
->what
== IT_COMPOSITION
)
3903 /* For composition, we must check the character after the
3905 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3907 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3913 /* With bidi iteration, the character before the current
3914 in the visual order cannot be found by simple
3915 iteration, because "reverse" reordering is not
3916 supported. Instead, we need to use the move_it_*
3917 family of functions. */
3918 /* Ignore face changes before the first visible
3919 character on this display line. */
3920 if (it
->current_x
<= it
->first_visible_x
)
3922 SAVE_IT (it_copy
, *it
, it_copy_data
);
3923 /* Implementation note: Since move_it_in_display_line
3924 works in the iterator geometry, and thinks the first
3925 character is always the leftmost, even in R2L lines,
3926 we don't need to distinguish between the R2L and L2R
3928 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3929 it_copy
.current_x
- 1, MOVE_TO_X
);
3930 charpos
= IT_STRING_CHARPOS (it_copy
);
3931 RESTORE_IT (it
, it
, it_copy_data
);
3935 /* Set charpos to the string position of the character
3936 that comes after IT's current position in the visual
3938 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3942 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3944 charpos
= it_copy
.bidi_it
.charpos
;
3947 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3949 if (it
->current
.overlay_string_index
>= 0)
3950 bufpos
= IT_CHARPOS (*it
);
3954 base_face_id
= underlying_face_id (it
);
3956 /* Get the face for ASCII, or unibyte. */
3957 face_id
= face_at_string_position (it
->w
,
3961 it
->region_beg_charpos
,
3962 it
->region_end_charpos
,
3963 &next_check_charpos
,
3966 /* Correct the face for charsets different from ASCII. Do it
3967 for the multibyte case only. The face returned above is
3968 suitable for unibyte text if IT->string is unibyte. */
3969 if (STRING_MULTIBYTE (it
->string
))
3971 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3972 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3974 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3976 c
= string_char_and_length (p
, &len
);
3977 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3982 struct text_pos pos
;
3984 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3985 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3988 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3989 pos
= it
->current
.pos
;
3994 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3997 if (it
->what
== IT_COMPOSITION
)
3999 /* For composition, we must check the position after
4001 pos
.charpos
+= it
->cmp_it
.nchars
;
4002 pos
.bytepos
+= it
->len
;
4005 INC_TEXT_POS (pos
, it
->multibyte_p
);
4012 /* With bidi iteration, the character before the current
4013 in the visual order cannot be found by simple
4014 iteration, because "reverse" reordering is not
4015 supported. Instead, we need to use the move_it_*
4016 family of functions. */
4017 /* Ignore face changes before the first visible
4018 character on this display line. */
4019 if (it
->current_x
<= it
->first_visible_x
)
4021 SAVE_IT (it_copy
, *it
, it_copy_data
);
4022 /* Implementation note: Since move_it_in_display_line
4023 works in the iterator geometry, and thinks the first
4024 character is always the leftmost, even in R2L lines,
4025 we don't need to distinguish between the R2L and L2R
4027 move_it_in_display_line (&it_copy
, ZV
,
4028 it_copy
.current_x
- 1, MOVE_TO_X
);
4029 pos
= it_copy
.current
.pos
;
4030 RESTORE_IT (it
, it
, it_copy_data
);
4034 /* Set charpos to the buffer position of the character
4035 that comes after IT's current position in the visual
4037 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4041 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4044 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4047 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4049 /* Determine face for CHARSET_ASCII, or unibyte. */
4050 face_id
= face_at_buffer_position (it
->w
,
4052 it
->region_beg_charpos
,
4053 it
->region_end_charpos
,
4054 &next_check_charpos
,
4057 /* Correct the face for charsets different from ASCII. Do it
4058 for the multibyte case only. The face returned above is
4059 suitable for unibyte text if current_buffer is unibyte. */
4060 if (it
->multibyte_p
)
4062 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4063 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4064 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4073 /***********************************************************************
4075 ***********************************************************************/
4077 /* Set up iterator IT from invisible properties at its current
4078 position. Called from handle_stop. */
4080 static enum prop_handled
4081 handle_invisible_prop (struct it
*it
)
4083 enum prop_handled handled
= HANDLED_NORMALLY
;
4087 if (STRINGP (it
->string
))
4089 Lisp_Object end_charpos
, limit
, charpos
;
4091 /* Get the value of the invisible text property at the
4092 current position. Value will be nil if there is no such
4094 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4095 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4096 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4098 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4100 /* Record whether we have to display an ellipsis for the
4102 int display_ellipsis_p
= (invis_p
== 2);
4103 ptrdiff_t len
, endpos
;
4105 handled
= HANDLED_RECOMPUTE_PROPS
;
4107 /* Get the position at which the next visible text can be
4108 found in IT->string, if any. */
4109 endpos
= len
= SCHARS (it
->string
);
4110 XSETINT (limit
, len
);
4113 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4115 if (INTEGERP (end_charpos
))
4117 endpos
= XFASTINT (end_charpos
);
4118 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4119 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4121 display_ellipsis_p
= 1;
4124 while (invis_p
&& endpos
< len
);
4126 if (display_ellipsis_p
)
4131 /* Text at END_CHARPOS is visible. Move IT there. */
4132 struct text_pos old
;
4135 old
= it
->current
.string_pos
;
4136 oldpos
= CHARPOS (old
);
4139 if (it
->bidi_it
.first_elt
4140 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4141 bidi_paragraph_init (it
->paragraph_embedding
,
4143 /* Bidi-iterate out of the invisible text. */
4146 bidi_move_to_visually_next (&it
->bidi_it
);
4148 while (oldpos
<= it
->bidi_it
.charpos
4149 && it
->bidi_it
.charpos
< endpos
);
4151 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4152 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4153 if (IT_CHARPOS (*it
) >= endpos
)
4154 it
->prev_stop
= endpos
;
4158 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4159 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4164 /* The rest of the string is invisible. If this is an
4165 overlay string, proceed with the next overlay string
4166 or whatever comes and return a character from there. */
4167 if (it
->current
.overlay_string_index
>= 0
4168 && !display_ellipsis_p
)
4170 next_overlay_string (it
);
4171 /* Don't check for overlay strings when we just
4172 finished processing them. */
4173 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4177 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4178 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4185 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4186 Lisp_Object pos
, overlay
;
4188 /* First of all, is there invisible text at this position? */
4189 tem
= start_charpos
= IT_CHARPOS (*it
);
4190 pos
= make_number (tem
);
4191 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4193 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4195 /* If we are on invisible text, skip over it. */
4196 if (invis_p
&& start_charpos
< it
->end_charpos
)
4198 /* Record whether we have to display an ellipsis for the
4200 int display_ellipsis_p
= invis_p
== 2;
4202 handled
= HANDLED_RECOMPUTE_PROPS
;
4204 /* Loop skipping over invisible text. The loop is left at
4205 ZV or with IT on the first char being visible again. */
4208 /* Try to skip some invisible text. Return value is the
4209 position reached which can be equal to where we start
4210 if there is nothing invisible there. This skips both
4211 over invisible text properties and overlays with
4212 invisible property. */
4213 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4215 /* If we skipped nothing at all we weren't at invisible
4216 text in the first place. If everything to the end of
4217 the buffer was skipped, end the loop. */
4218 if (newpos
== tem
|| newpos
>= ZV
)
4222 /* We skipped some characters but not necessarily
4223 all there are. Check if we ended up on visible
4224 text. Fget_char_property returns the property of
4225 the char before the given position, i.e. if we
4226 get invis_p = 0, this means that the char at
4227 newpos is visible. */
4228 pos
= make_number (newpos
);
4229 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4230 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4233 /* If we ended up on invisible text, proceed to
4234 skip starting with next_stop. */
4238 /* If there are adjacent invisible texts, don't lose the
4239 second one's ellipsis. */
4241 display_ellipsis_p
= 1;
4245 /* The position newpos is now either ZV or on visible text. */
4248 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4250 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4252 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4254 /* If the invisible text ends on a newline or on a
4255 character after a newline, we can avoid the costly,
4256 character by character, bidi iteration to NEWPOS, and
4257 instead simply reseat the iterator there. That's
4258 because all bidi reordering information is tossed at
4259 the newline. This is a big win for modes that hide
4260 complete lines, like Outline, Org, etc. */
4261 if (on_newline
|| after_newline
)
4263 struct text_pos tpos
;
4264 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4266 SET_TEXT_POS (tpos
, newpos
, bpos
);
4267 reseat_1 (it
, tpos
, 0);
4268 /* If we reseat on a newline/ZV, we need to prep the
4269 bidi iterator for advancing to the next character
4270 after the newline/EOB, keeping the current paragraph
4271 direction (so that PRODUCE_GLYPHS does TRT wrt
4272 prepending/appending glyphs to a glyph row). */
4275 it
->bidi_it
.first_elt
= 0;
4276 it
->bidi_it
.paragraph_dir
= pdir
;
4277 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4278 it
->bidi_it
.nchars
= 1;
4279 it
->bidi_it
.ch_len
= 1;
4282 else /* Must use the slow method. */
4284 /* With bidi iteration, the region of invisible text
4285 could start and/or end in the middle of a
4286 non-base embedding level. Therefore, we need to
4287 skip invisible text using the bidi iterator,
4288 starting at IT's current position, until we find
4289 ourselves outside of the invisible text.
4290 Skipping invisible text _after_ bidi iteration
4291 avoids affecting the visual order of the
4292 displayed text when invisible properties are
4293 added or removed. */
4294 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4296 /* If we were `reseat'ed to a new paragraph,
4297 determine the paragraph base direction. We
4298 need to do it now because
4299 next_element_from_buffer may not have a
4300 chance to do it, if we are going to skip any
4301 text at the beginning, which resets the
4303 bidi_paragraph_init (it
->paragraph_embedding
,
4308 bidi_move_to_visually_next (&it
->bidi_it
);
4310 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4311 && it
->bidi_it
.charpos
< newpos
);
4312 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4313 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4314 /* If we overstepped NEWPOS, record its position in
4315 the iterator, so that we skip invisible text if
4316 later the bidi iteration lands us in the
4317 invisible region again. */
4318 if (IT_CHARPOS (*it
) >= newpos
)
4319 it
->prev_stop
= newpos
;
4324 IT_CHARPOS (*it
) = newpos
;
4325 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4328 /* If there are before-strings at the start of invisible
4329 text, and the text is invisible because of a text
4330 property, arrange to show before-strings because 20.x did
4331 it that way. (If the text is invisible because of an
4332 overlay property instead of a text property, this is
4333 already handled in the overlay code.) */
4335 && get_overlay_strings (it
, it
->stop_charpos
))
4337 handled
= HANDLED_RECOMPUTE_PROPS
;
4338 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4340 else if (display_ellipsis_p
)
4342 /* Make sure that the glyphs of the ellipsis will get
4343 correct `charpos' values. If we would not update
4344 it->position here, the glyphs would belong to the
4345 last visible character _before_ the invisible
4346 text, which confuses `set_cursor_from_row'.
4348 We use the last invisible position instead of the
4349 first because this way the cursor is always drawn on
4350 the first "." of the ellipsis, whenever PT is inside
4351 the invisible text. Otherwise the cursor would be
4352 placed _after_ the ellipsis when the point is after the
4353 first invisible character. */
4354 if (!STRINGP (it
->object
))
4356 it
->position
.charpos
= newpos
- 1;
4357 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4360 /* Let the ellipsis display before
4361 considering any properties of the following char.
4362 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4363 handled
= HANDLED_RETURN
;
4372 /* Make iterator IT return `...' next.
4373 Replaces LEN characters from buffer. */
4376 setup_for_ellipsis (struct it
*it
, int len
)
4378 /* Use the display table definition for `...'. Invalid glyphs
4379 will be handled by the method returning elements from dpvec. */
4380 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4382 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4383 it
->dpvec
= v
->contents
;
4384 it
->dpend
= v
->contents
+ v
->header
.size
;
4388 /* Default `...'. */
4389 it
->dpvec
= default_invis_vector
;
4390 it
->dpend
= default_invis_vector
+ 3;
4393 it
->dpvec_char_len
= len
;
4394 it
->current
.dpvec_index
= 0;
4395 it
->dpvec_face_id
= -1;
4397 /* Remember the current face id in case glyphs specify faces.
4398 IT's face is restored in set_iterator_to_next.
4399 saved_face_id was set to preceding char's face in handle_stop. */
4400 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4401 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4403 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4409 /***********************************************************************
4411 ***********************************************************************/
4413 /* Set up iterator IT from `display' property at its current position.
4414 Called from handle_stop.
4415 We return HANDLED_RETURN if some part of the display property
4416 overrides the display of the buffer text itself.
4417 Otherwise we return HANDLED_NORMALLY. */
4419 static enum prop_handled
4420 handle_display_prop (struct it
*it
)
4422 Lisp_Object propval
, object
, overlay
;
4423 struct text_pos
*position
;
4425 /* Nonzero if some property replaces the display of the text itself. */
4426 int display_replaced_p
= 0;
4428 if (STRINGP (it
->string
))
4430 object
= it
->string
;
4431 position
= &it
->current
.string_pos
;
4432 bufpos
= CHARPOS (it
->current
.pos
);
4436 XSETWINDOW (object
, it
->w
);
4437 position
= &it
->current
.pos
;
4438 bufpos
= CHARPOS (*position
);
4441 /* Reset those iterator values set from display property values. */
4442 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4443 it
->space_width
= Qnil
;
4444 it
->font_height
= Qnil
;
4447 /* We don't support recursive `display' properties, i.e. string
4448 values that have a string `display' property, that have a string
4449 `display' property etc. */
4450 if (!it
->string_from_display_prop_p
)
4451 it
->area
= TEXT_AREA
;
4453 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4454 Qdisplay
, object
, &overlay
);
4456 return HANDLED_NORMALLY
;
4457 /* Now OVERLAY is the overlay that gave us this property, or nil
4458 if it was a text property. */
4460 if (!STRINGP (it
->string
))
4461 object
= it
->w
->contents
;
4463 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4465 FRAME_WINDOW_P (it
->f
));
4467 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4470 /* Subroutine of handle_display_prop. Returns non-zero if the display
4471 specification in SPEC is a replacing specification, i.e. it would
4472 replace the text covered by `display' property with something else,
4473 such as an image or a display string. If SPEC includes any kind or
4474 `(space ...) specification, the value is 2; this is used by
4475 compute_display_string_pos, which see.
4477 See handle_single_display_spec for documentation of arguments.
4478 frame_window_p is non-zero if the window being redisplayed is on a
4479 GUI frame; this argument is used only if IT is NULL, see below.
4481 IT can be NULL, if this is called by the bidi reordering code
4482 through compute_display_string_pos, which see. In that case, this
4483 function only examines SPEC, but does not otherwise "handle" it, in
4484 the sense that it doesn't set up members of IT from the display
4487 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4488 Lisp_Object overlay
, struct text_pos
*position
,
4489 ptrdiff_t bufpos
, int frame_window_p
)
4491 int replacing_p
= 0;
4495 /* Simple specifications. */
4496 && !EQ (XCAR (spec
), Qimage
)
4497 && !EQ (XCAR (spec
), Qspace
)
4498 && !EQ (XCAR (spec
), Qwhen
)
4499 && !EQ (XCAR (spec
), Qslice
)
4500 && !EQ (XCAR (spec
), Qspace_width
)
4501 && !EQ (XCAR (spec
), Qheight
)
4502 && !EQ (XCAR (spec
), Qraise
)
4503 /* Marginal area specifications. */
4504 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4505 && !EQ (XCAR (spec
), Qleft_fringe
)
4506 && !EQ (XCAR (spec
), Qright_fringe
)
4507 && !NILP (XCAR (spec
)))
4509 for (; CONSP (spec
); spec
= XCDR (spec
))
4511 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4512 overlay
, position
, bufpos
,
4513 replacing_p
, frame_window_p
)))
4516 /* If some text in a string is replaced, `position' no
4517 longer points to the position of `object'. */
4518 if (!it
|| STRINGP (object
))
4523 else if (VECTORP (spec
))
4526 for (i
= 0; i
< ASIZE (spec
); ++i
)
4527 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4528 overlay
, position
, bufpos
,
4529 replacing_p
, frame_window_p
)))
4532 /* If some text in a string is replaced, `position' no
4533 longer points to the position of `object'. */
4534 if (!it
|| STRINGP (object
))
4540 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4541 position
, bufpos
, 0,
4549 /* Value is the position of the end of the `display' property starting
4550 at START_POS in OBJECT. */
4552 static struct text_pos
4553 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4556 struct text_pos end_pos
;
4558 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4559 Qdisplay
, object
, Qnil
);
4560 CHARPOS (end_pos
) = XFASTINT (end
);
4561 if (STRINGP (object
))
4562 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4564 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4570 /* Set up IT from a single `display' property specification SPEC. OBJECT
4571 is the object in which the `display' property was found. *POSITION
4572 is the position in OBJECT at which the `display' property was found.
4573 BUFPOS is the buffer position of OBJECT (different from POSITION if
4574 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4575 previously saw a display specification which already replaced text
4576 display with something else, for example an image; we ignore such
4577 properties after the first one has been processed.
4579 OVERLAY is the overlay this `display' property came from,
4580 or nil if it was a text property.
4582 If SPEC is a `space' or `image' specification, and in some other
4583 cases too, set *POSITION to the position where the `display'
4586 If IT is NULL, only examine the property specification in SPEC, but
4587 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4588 is intended to be displayed in a window on a GUI frame.
4590 Value is non-zero if something was found which replaces the display
4591 of buffer or string text. */
4594 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4595 Lisp_Object overlay
, struct text_pos
*position
,
4596 ptrdiff_t bufpos
, int display_replaced_p
,
4600 Lisp_Object location
, value
;
4601 struct text_pos start_pos
= *position
;
4604 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4605 If the result is non-nil, use VALUE instead of SPEC. */
4607 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4616 if (!NILP (form
) && !EQ (form
, Qt
))
4618 ptrdiff_t count
= SPECPDL_INDEX ();
4619 struct gcpro gcpro1
;
4621 /* Bind `object' to the object having the `display' property, a
4622 buffer or string. Bind `position' to the position in the
4623 object where the property was found, and `buffer-position'
4624 to the current position in the buffer. */
4627 XSETBUFFER (object
, current_buffer
);
4628 specbind (Qobject
, object
);
4629 specbind (Qposition
, make_number (CHARPOS (*position
)));
4630 specbind (Qbuffer_position
, make_number (bufpos
));
4632 form
= safe_eval (form
);
4634 unbind_to (count
, Qnil
);
4640 /* Handle `(height HEIGHT)' specifications. */
4642 && EQ (XCAR (spec
), Qheight
)
4643 && CONSP (XCDR (spec
)))
4647 if (!FRAME_WINDOW_P (it
->f
))
4650 it
->font_height
= XCAR (XCDR (spec
));
4651 if (!NILP (it
->font_height
))
4653 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4654 int new_height
= -1;
4656 if (CONSP (it
->font_height
)
4657 && (EQ (XCAR (it
->font_height
), Qplus
)
4658 || EQ (XCAR (it
->font_height
), Qminus
))
4659 && CONSP (XCDR (it
->font_height
))
4660 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4662 /* `(+ N)' or `(- N)' where N is an integer. */
4663 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4664 if (EQ (XCAR (it
->font_height
), Qplus
))
4666 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4668 else if (FUNCTIONP (it
->font_height
))
4670 /* Call function with current height as argument.
4671 Value is the new height. */
4673 height
= safe_call1 (it
->font_height
,
4674 face
->lface
[LFACE_HEIGHT_INDEX
]);
4675 if (NUMBERP (height
))
4676 new_height
= XFLOATINT (height
);
4678 else if (NUMBERP (it
->font_height
))
4680 /* Value is a multiple of the canonical char height. */
4683 f
= FACE_FROM_ID (it
->f
,
4684 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4685 new_height
= (XFLOATINT (it
->font_height
)
4686 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4690 /* Evaluate IT->font_height with `height' bound to the
4691 current specified height to get the new height. */
4692 ptrdiff_t count
= SPECPDL_INDEX ();
4694 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4695 value
= safe_eval (it
->font_height
);
4696 unbind_to (count
, Qnil
);
4698 if (NUMBERP (value
))
4699 new_height
= XFLOATINT (value
);
4703 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4710 /* Handle `(space-width WIDTH)'. */
4712 && EQ (XCAR (spec
), Qspace_width
)
4713 && CONSP (XCDR (spec
)))
4717 if (!FRAME_WINDOW_P (it
->f
))
4720 value
= XCAR (XCDR (spec
));
4721 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4722 it
->space_width
= value
;
4728 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4730 && EQ (XCAR (spec
), Qslice
))
4736 if (!FRAME_WINDOW_P (it
->f
))
4739 if (tem
= XCDR (spec
), CONSP (tem
))
4741 it
->slice
.x
= XCAR (tem
);
4742 if (tem
= XCDR (tem
), CONSP (tem
))
4744 it
->slice
.y
= XCAR (tem
);
4745 if (tem
= XCDR (tem
), CONSP (tem
))
4747 it
->slice
.width
= XCAR (tem
);
4748 if (tem
= XCDR (tem
), CONSP (tem
))
4749 it
->slice
.height
= XCAR (tem
);
4758 /* Handle `(raise FACTOR)'. */
4760 && EQ (XCAR (spec
), Qraise
)
4761 && CONSP (XCDR (spec
)))
4765 if (!FRAME_WINDOW_P (it
->f
))
4768 #ifdef HAVE_WINDOW_SYSTEM
4769 value
= XCAR (XCDR (spec
));
4770 if (NUMBERP (value
))
4772 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4773 it
->voffset
= - (XFLOATINT (value
)
4774 * (FONT_HEIGHT (face
->font
)));
4776 #endif /* HAVE_WINDOW_SYSTEM */
4782 /* Don't handle the other kinds of display specifications
4783 inside a string that we got from a `display' property. */
4784 if (it
&& it
->string_from_display_prop_p
)
4787 /* Characters having this form of property are not displayed, so
4788 we have to find the end of the property. */
4791 start_pos
= *position
;
4792 *position
= display_prop_end (it
, object
, start_pos
);
4796 /* Stop the scan at that end position--we assume that all
4797 text properties change there. */
4799 it
->stop_charpos
= position
->charpos
;
4801 /* Handle `(left-fringe BITMAP [FACE])'
4802 and `(right-fringe BITMAP [FACE])'. */
4804 && (EQ (XCAR (spec
), Qleft_fringe
)
4805 || EQ (XCAR (spec
), Qright_fringe
))
4806 && CONSP (XCDR (spec
)))
4812 if (!FRAME_WINDOW_P (it
->f
))
4813 /* If we return here, POSITION has been advanced
4814 across the text with this property. */
4816 /* Synchronize the bidi iterator with POSITION. This is
4817 needed because we are not going to push the iterator
4818 on behalf of this display property, so there will be
4819 no pop_it call to do this synchronization for us. */
4822 it
->position
= *position
;
4823 iterate_out_of_display_property (it
);
4824 *position
= it
->position
;
4829 else if (!frame_window_p
)
4832 #ifdef HAVE_WINDOW_SYSTEM
4833 value
= XCAR (XCDR (spec
));
4834 if (!SYMBOLP (value
)
4835 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4836 /* If we return here, POSITION has been advanced
4837 across the text with this property. */
4839 if (it
&& it
->bidi_p
)
4841 it
->position
= *position
;
4842 iterate_out_of_display_property (it
);
4843 *position
= it
->position
;
4850 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4852 if (CONSP (XCDR (XCDR (spec
))))
4854 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4855 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4861 /* Save current settings of IT so that we can restore them
4862 when we are finished with the glyph property value. */
4863 push_it (it
, position
);
4865 it
->area
= TEXT_AREA
;
4866 it
->what
= IT_IMAGE
;
4867 it
->image_id
= -1; /* no image */
4868 it
->position
= start_pos
;
4869 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
4870 it
->method
= GET_FROM_IMAGE
;
4871 it
->from_overlay
= Qnil
;
4872 it
->face_id
= face_id
;
4873 it
->from_disp_prop_p
= 1;
4875 /* Say that we haven't consumed the characters with
4876 `display' property yet. The call to pop_it in
4877 set_iterator_to_next will clean this up. */
4878 *position
= start_pos
;
4880 if (EQ (XCAR (spec
), Qleft_fringe
))
4882 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4883 it
->left_user_fringe_face_id
= face_id
;
4887 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4888 it
->right_user_fringe_face_id
= face_id
;
4891 #endif /* HAVE_WINDOW_SYSTEM */
4895 /* Prepare to handle `((margin left-margin) ...)',
4896 `((margin right-margin) ...)' and `((margin nil) ...)'
4897 prefixes for display specifications. */
4898 location
= Qunbound
;
4899 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4903 value
= XCDR (spec
);
4905 value
= XCAR (value
);
4908 if (EQ (XCAR (tem
), Qmargin
)
4909 && (tem
= XCDR (tem
),
4910 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4912 || EQ (tem
, Qleft_margin
)
4913 || EQ (tem
, Qright_margin
))))
4917 if (EQ (location
, Qunbound
))
4923 /* After this point, VALUE is the property after any
4924 margin prefix has been stripped. It must be a string,
4925 an image specification, or `(space ...)'.
4927 LOCATION specifies where to display: `left-margin',
4928 `right-margin' or nil. */
4930 valid_p
= (STRINGP (value
)
4931 #ifdef HAVE_WINDOW_SYSTEM
4932 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4933 && valid_image_p (value
))
4934 #endif /* not HAVE_WINDOW_SYSTEM */
4935 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4937 if (valid_p
&& !display_replaced_p
)
4943 /* Callers need to know whether the display spec is any kind
4944 of `(space ...)' spec that is about to affect text-area
4946 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4951 /* Save current settings of IT so that we can restore them
4952 when we are finished with the glyph property value. */
4953 push_it (it
, position
);
4954 it
->from_overlay
= overlay
;
4955 it
->from_disp_prop_p
= 1;
4957 if (NILP (location
))
4958 it
->area
= TEXT_AREA
;
4959 else if (EQ (location
, Qleft_margin
))
4960 it
->area
= LEFT_MARGIN_AREA
;
4962 it
->area
= RIGHT_MARGIN_AREA
;
4964 if (STRINGP (value
))
4967 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4968 it
->current
.overlay_string_index
= -1;
4969 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4970 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4971 it
->method
= GET_FROM_STRING
;
4972 it
->stop_charpos
= 0;
4974 it
->base_level_stop
= 0;
4975 it
->string_from_display_prop_p
= 1;
4976 /* Say that we haven't consumed the characters with
4977 `display' property yet. The call to pop_it in
4978 set_iterator_to_next will clean this up. */
4979 if (BUFFERP (object
))
4980 *position
= start_pos
;
4982 /* Force paragraph direction to be that of the parent
4983 object. If the parent object's paragraph direction is
4984 not yet determined, default to L2R. */
4985 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4986 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4988 it
->paragraph_embedding
= L2R
;
4990 /* Set up the bidi iterator for this display string. */
4993 it
->bidi_it
.string
.lstring
= it
->string
;
4994 it
->bidi_it
.string
.s
= NULL
;
4995 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4996 it
->bidi_it
.string
.bufpos
= bufpos
;
4997 it
->bidi_it
.string
.from_disp_str
= 1;
4998 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4999 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5002 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5004 it
->method
= GET_FROM_STRETCH
;
5006 *position
= it
->position
= start_pos
;
5007 retval
= 1 + (it
->area
== TEXT_AREA
);
5009 #ifdef HAVE_WINDOW_SYSTEM
5012 it
->what
= IT_IMAGE
;
5013 it
->image_id
= lookup_image (it
->f
, value
);
5014 it
->position
= start_pos
;
5015 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5016 it
->method
= GET_FROM_IMAGE
;
5018 /* Say that we haven't consumed the characters with
5019 `display' property yet. The call to pop_it in
5020 set_iterator_to_next will clean this up. */
5021 *position
= start_pos
;
5023 #endif /* HAVE_WINDOW_SYSTEM */
5028 /* Invalid property or property not supported. Restore
5029 POSITION to what it was before. */
5030 *position
= start_pos
;
5034 /* Check if PROP is a display property value whose text should be
5035 treated as intangible. OVERLAY is the overlay from which PROP
5036 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5037 specify the buffer position covered by PROP. */
5040 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5041 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5043 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5044 struct text_pos position
;
5046 SET_TEXT_POS (position
, charpos
, bytepos
);
5047 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5048 &position
, charpos
, frame_window_p
);
5052 /* Return 1 if PROP is a display sub-property value containing STRING.
5054 Implementation note: this and the following function are really
5055 special cases of handle_display_spec and
5056 handle_single_display_spec, and should ideally use the same code.
5057 Until they do, these two pairs must be consistent and must be
5058 modified in sync. */
5061 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5063 if (EQ (string
, prop
))
5066 /* Skip over `when FORM'. */
5067 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5072 /* Actually, the condition following `when' should be eval'ed,
5073 like handle_single_display_spec does, and we should return
5074 zero if it evaluates to nil. However, this function is
5075 called only when the buffer was already displayed and some
5076 glyph in the glyph matrix was found to come from a display
5077 string. Therefore, the condition was already evaluated, and
5078 the result was non-nil, otherwise the display string wouldn't
5079 have been displayed and we would have never been called for
5080 this property. Thus, we can skip the evaluation and assume
5081 its result is non-nil. */
5086 /* Skip over `margin LOCATION'. */
5087 if (EQ (XCAR (prop
), Qmargin
))
5098 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5102 /* Return 1 if STRING appears in the `display' property PROP. */
5105 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5108 && !EQ (XCAR (prop
), Qwhen
)
5109 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5111 /* A list of sub-properties. */
5112 while (CONSP (prop
))
5114 if (single_display_spec_string_p (XCAR (prop
), string
))
5119 else if (VECTORP (prop
))
5121 /* A vector of sub-properties. */
5123 for (i
= 0; i
< ASIZE (prop
); ++i
)
5124 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5128 return single_display_spec_string_p (prop
, string
);
5133 /* Look for STRING in overlays and text properties in the current
5134 buffer, between character positions FROM and TO (excluding TO).
5135 BACK_P non-zero means look back (in this case, TO is supposed to be
5137 Value is the first character position where STRING was found, or
5138 zero if it wasn't found before hitting TO.
5140 This function may only use code that doesn't eval because it is
5141 called asynchronously from note_mouse_highlight. */
5144 string_buffer_position_lim (Lisp_Object string
,
5145 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5147 Lisp_Object limit
, prop
, pos
;
5150 pos
= make_number (max (from
, BEGV
));
5152 if (!back_p
) /* looking forward */
5154 limit
= make_number (min (to
, ZV
));
5155 while (!found
&& !EQ (pos
, limit
))
5157 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5158 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5161 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5165 else /* looking back */
5167 limit
= make_number (max (to
, BEGV
));
5168 while (!found
&& !EQ (pos
, limit
))
5170 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5171 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5174 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5179 return found
? XINT (pos
) : 0;
5182 /* Determine which buffer position in current buffer STRING comes from.
5183 AROUND_CHARPOS is an approximate position where it could come from.
5184 Value is the buffer position or 0 if it couldn't be determined.
5186 This function is necessary because we don't record buffer positions
5187 in glyphs generated from strings (to keep struct glyph small).
5188 This function may only use code that doesn't eval because it is
5189 called asynchronously from note_mouse_highlight. */
5192 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5194 const int MAX_DISTANCE
= 1000;
5195 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5196 around_charpos
+ MAX_DISTANCE
,
5200 found
= string_buffer_position_lim (string
, around_charpos
,
5201 around_charpos
- MAX_DISTANCE
, 1);
5207 /***********************************************************************
5208 `composition' property
5209 ***********************************************************************/
5211 /* Set up iterator IT from `composition' property at its current
5212 position. Called from handle_stop. */
5214 static enum prop_handled
5215 handle_composition_prop (struct it
*it
)
5217 Lisp_Object prop
, string
;
5218 ptrdiff_t pos
, pos_byte
, start
, end
;
5220 if (STRINGP (it
->string
))
5224 pos
= IT_STRING_CHARPOS (*it
);
5225 pos_byte
= IT_STRING_BYTEPOS (*it
);
5226 string
= it
->string
;
5227 s
= SDATA (string
) + pos_byte
;
5228 it
->c
= STRING_CHAR (s
);
5232 pos
= IT_CHARPOS (*it
);
5233 pos_byte
= IT_BYTEPOS (*it
);
5235 it
->c
= FETCH_CHAR (pos_byte
);
5238 /* If there's a valid composition and point is not inside of the
5239 composition (in the case that the composition is from the current
5240 buffer), draw a glyph composed from the composition components. */
5241 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5242 && COMPOSITION_VALID_P (start
, end
, prop
)
5243 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5246 /* As we can't handle this situation (perhaps font-lock added
5247 a new composition), we just return here hoping that next
5248 redisplay will detect this composition much earlier. */
5249 return HANDLED_NORMALLY
;
5252 if (STRINGP (it
->string
))
5253 pos_byte
= string_char_to_byte (it
->string
, start
);
5255 pos_byte
= CHAR_TO_BYTE (start
);
5257 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5260 if (it
->cmp_it
.id
>= 0)
5263 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5264 it
->cmp_it
.nglyphs
= -1;
5268 return HANDLED_NORMALLY
;
5273 /***********************************************************************
5275 ***********************************************************************/
5277 /* The following structure is used to record overlay strings for
5278 later sorting in load_overlay_strings. */
5280 struct overlay_entry
5282 Lisp_Object overlay
;
5289 /* Set up iterator IT from overlay strings at its current position.
5290 Called from handle_stop. */
5292 static enum prop_handled
5293 handle_overlay_change (struct it
*it
)
5295 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5296 return HANDLED_RECOMPUTE_PROPS
;
5298 return HANDLED_NORMALLY
;
5302 /* Set up the next overlay string for delivery by IT, if there is an
5303 overlay string to deliver. Called by set_iterator_to_next when the
5304 end of the current overlay string is reached. If there are more
5305 overlay strings to display, IT->string and
5306 IT->current.overlay_string_index are set appropriately here.
5307 Otherwise IT->string is set to nil. */
5310 next_overlay_string (struct it
*it
)
5312 ++it
->current
.overlay_string_index
;
5313 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5315 /* No more overlay strings. Restore IT's settings to what
5316 they were before overlay strings were processed, and
5317 continue to deliver from current_buffer. */
5319 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5322 || (NILP (it
->string
)
5323 && it
->method
== GET_FROM_BUFFER
5324 && it
->stop_charpos
>= BEGV
5325 && it
->stop_charpos
<= it
->end_charpos
));
5326 it
->current
.overlay_string_index
= -1;
5327 it
->n_overlay_strings
= 0;
5328 it
->overlay_strings_charpos
= -1;
5329 /* If there's an empty display string on the stack, pop the
5330 stack, to resync the bidi iterator with IT's position. Such
5331 empty strings are pushed onto the stack in
5332 get_overlay_strings_1. */
5333 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5336 /* If we're at the end of the buffer, record that we have
5337 processed the overlay strings there already, so that
5338 next_element_from_buffer doesn't try it again. */
5339 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5340 it
->overlay_strings_at_end_processed_p
= 1;
5344 /* There are more overlay strings to process. If
5345 IT->current.overlay_string_index has advanced to a position
5346 where we must load IT->overlay_strings with more strings, do
5347 it. We must load at the IT->overlay_strings_charpos where
5348 IT->n_overlay_strings was originally computed; when invisible
5349 text is present, this might not be IT_CHARPOS (Bug#7016). */
5350 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5352 if (it
->current
.overlay_string_index
&& i
== 0)
5353 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5355 /* Initialize IT to deliver display elements from the overlay
5357 it
->string
= it
->overlay_strings
[i
];
5358 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5359 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5360 it
->method
= GET_FROM_STRING
;
5361 it
->stop_charpos
= 0;
5362 it
->end_charpos
= SCHARS (it
->string
);
5363 if (it
->cmp_it
.stop_pos
>= 0)
5364 it
->cmp_it
.stop_pos
= 0;
5366 it
->base_level_stop
= 0;
5368 /* Set up the bidi iterator for this overlay string. */
5371 it
->bidi_it
.string
.lstring
= it
->string
;
5372 it
->bidi_it
.string
.s
= NULL
;
5373 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5374 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5375 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5376 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5377 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5385 /* Compare two overlay_entry structures E1 and E2. Used as a
5386 comparison function for qsort in load_overlay_strings. Overlay
5387 strings for the same position are sorted so that
5389 1. All after-strings come in front of before-strings, except
5390 when they come from the same overlay.
5392 2. Within after-strings, strings are sorted so that overlay strings
5393 from overlays with higher priorities come first.
5395 2. Within before-strings, strings are sorted so that overlay
5396 strings from overlays with higher priorities come last.
5398 Value is analogous to strcmp. */
5402 compare_overlay_entries (const void *e1
, const void *e2
)
5404 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5405 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5408 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5410 /* Let after-strings appear in front of before-strings if
5411 they come from different overlays. */
5412 if (EQ (entry1
->overlay
, entry2
->overlay
))
5413 result
= entry1
->after_string_p
? 1 : -1;
5415 result
= entry1
->after_string_p
? -1 : 1;
5417 else if (entry1
->priority
!= entry2
->priority
)
5419 if (entry1
->after_string_p
)
5420 /* After-strings sorted in order of decreasing priority. */
5421 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5423 /* Before-strings sorted in order of increasing priority. */
5424 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5433 /* Load the vector IT->overlay_strings with overlay strings from IT's
5434 current buffer position, or from CHARPOS if that is > 0. Set
5435 IT->n_overlays to the total number of overlay strings found.
5437 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5438 a time. On entry into load_overlay_strings,
5439 IT->current.overlay_string_index gives the number of overlay
5440 strings that have already been loaded by previous calls to this
5443 IT->add_overlay_start contains an additional overlay start
5444 position to consider for taking overlay strings from, if non-zero.
5445 This position comes into play when the overlay has an `invisible'
5446 property, and both before and after-strings. When we've skipped to
5447 the end of the overlay, because of its `invisible' property, we
5448 nevertheless want its before-string to appear.
5449 IT->add_overlay_start will contain the overlay start position
5452 Overlay strings are sorted so that after-string strings come in
5453 front of before-string strings. Within before and after-strings,
5454 strings are sorted by overlay priority. See also function
5455 compare_overlay_entries. */
5458 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5460 Lisp_Object overlay
, window
, str
, invisible
;
5461 struct Lisp_Overlay
*ov
;
5462 ptrdiff_t start
, end
;
5463 ptrdiff_t size
= 20;
5464 ptrdiff_t n
= 0, i
, j
;
5466 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5470 charpos
= IT_CHARPOS (*it
);
5472 /* Append the overlay string STRING of overlay OVERLAY to vector
5473 `entries' which has size `size' and currently contains `n'
5474 elements. AFTER_P non-zero means STRING is an after-string of
5476 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5479 Lisp_Object priority; \
5483 struct overlay_entry *old = entries; \
5484 SAFE_NALLOCA (entries, 2, size); \
5485 memcpy (entries, old, size * sizeof *entries); \
5489 entries[n].string = (STRING); \
5490 entries[n].overlay = (OVERLAY); \
5491 priority = Foverlay_get ((OVERLAY), Qpriority); \
5492 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5493 entries[n].after_string_p = (AFTER_P); \
5498 /* Process overlay before the overlay center. */
5499 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5501 XSETMISC (overlay
, ov
);
5502 eassert (OVERLAYP (overlay
));
5503 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5504 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5509 /* Skip this overlay if it doesn't start or end at IT's current
5511 if (end
!= charpos
&& start
!= charpos
)
5514 /* Skip this overlay if it doesn't apply to IT->w. */
5515 window
= Foverlay_get (overlay
, Qwindow
);
5516 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5519 /* If the text ``under'' the overlay is invisible, both before-
5520 and after-strings from this overlay are visible; start and
5521 end position are indistinguishable. */
5522 invisible
= Foverlay_get (overlay
, Qinvisible
);
5523 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5525 /* If overlay has a non-empty before-string, record it. */
5526 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5527 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5529 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5531 /* If overlay has a non-empty after-string, record it. */
5532 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5533 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5535 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5538 /* Process overlays after the overlay center. */
5539 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5541 XSETMISC (overlay
, ov
);
5542 eassert (OVERLAYP (overlay
));
5543 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5544 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5546 if (start
> charpos
)
5549 /* Skip this overlay if it doesn't start or end at IT's current
5551 if (end
!= charpos
&& start
!= charpos
)
5554 /* Skip this overlay if it doesn't apply to IT->w. */
5555 window
= Foverlay_get (overlay
, Qwindow
);
5556 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5559 /* If the text ``under'' the overlay is invisible, it has a zero
5560 dimension, and both before- and after-strings apply. */
5561 invisible
= Foverlay_get (overlay
, Qinvisible
);
5562 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5564 /* If overlay has a non-empty before-string, record it. */
5565 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5566 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5568 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5570 /* If overlay has a non-empty after-string, record it. */
5571 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5572 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5574 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5577 #undef RECORD_OVERLAY_STRING
5581 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5583 /* Record number of overlay strings, and where we computed it. */
5584 it
->n_overlay_strings
= n
;
5585 it
->overlay_strings_charpos
= charpos
;
5587 /* IT->current.overlay_string_index is the number of overlay strings
5588 that have already been consumed by IT. Copy some of the
5589 remaining overlay strings to IT->overlay_strings. */
5591 j
= it
->current
.overlay_string_index
;
5592 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5594 it
->overlay_strings
[i
] = entries
[j
].string
;
5595 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5603 /* Get the first chunk of overlay strings at IT's current buffer
5604 position, or at CHARPOS if that is > 0. Value is non-zero if at
5605 least one overlay string was found. */
5608 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5610 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5611 process. This fills IT->overlay_strings with strings, and sets
5612 IT->n_overlay_strings to the total number of strings to process.
5613 IT->pos.overlay_string_index has to be set temporarily to zero
5614 because load_overlay_strings needs this; it must be set to -1
5615 when no overlay strings are found because a zero value would
5616 indicate a position in the first overlay string. */
5617 it
->current
.overlay_string_index
= 0;
5618 load_overlay_strings (it
, charpos
);
5620 /* If we found overlay strings, set up IT to deliver display
5621 elements from the first one. Otherwise set up IT to deliver
5622 from current_buffer. */
5623 if (it
->n_overlay_strings
)
5625 /* Make sure we know settings in current_buffer, so that we can
5626 restore meaningful values when we're done with the overlay
5629 compute_stop_pos (it
);
5630 eassert (it
->face_id
>= 0);
5632 /* Save IT's settings. They are restored after all overlay
5633 strings have been processed. */
5634 eassert (!compute_stop_p
|| it
->sp
== 0);
5636 /* When called from handle_stop, there might be an empty display
5637 string loaded. In that case, don't bother saving it. But
5638 don't use this optimization with the bidi iterator, since we
5639 need the corresponding pop_it call to resync the bidi
5640 iterator's position with IT's position, after we are done
5641 with the overlay strings. (The corresponding call to pop_it
5642 in case of an empty display string is in
5643 next_overlay_string.) */
5645 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5648 /* Set up IT to deliver display elements from the first overlay
5650 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5651 it
->string
= it
->overlay_strings
[0];
5652 it
->from_overlay
= Qnil
;
5653 it
->stop_charpos
= 0;
5654 eassert (STRINGP (it
->string
));
5655 it
->end_charpos
= SCHARS (it
->string
);
5657 it
->base_level_stop
= 0;
5658 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5659 it
->method
= GET_FROM_STRING
;
5660 it
->from_disp_prop_p
= 0;
5662 /* Force paragraph direction to be that of the parent
5664 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5665 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5667 it
->paragraph_embedding
= L2R
;
5669 /* Set up the bidi iterator for this overlay string. */
5672 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5674 it
->bidi_it
.string
.lstring
= it
->string
;
5675 it
->bidi_it
.string
.s
= NULL
;
5676 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5677 it
->bidi_it
.string
.bufpos
= pos
;
5678 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5679 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5680 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5685 it
->current
.overlay_string_index
= -1;
5690 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5693 it
->method
= GET_FROM_BUFFER
;
5695 (void) get_overlay_strings_1 (it
, charpos
, 1);
5699 /* Value is non-zero if we found at least one overlay string. */
5700 return STRINGP (it
->string
);
5705 /***********************************************************************
5706 Saving and restoring state
5707 ***********************************************************************/
5709 /* Save current settings of IT on IT->stack. Called, for example,
5710 before setting up IT for an overlay string, to be able to restore
5711 IT's settings to what they were after the overlay string has been
5712 processed. If POSITION is non-NULL, it is the position to save on
5713 the stack instead of IT->position. */
5716 push_it (struct it
*it
, struct text_pos
*position
)
5718 struct iterator_stack_entry
*p
;
5720 eassert (it
->sp
< IT_STACK_SIZE
);
5721 p
= it
->stack
+ it
->sp
;
5723 p
->stop_charpos
= it
->stop_charpos
;
5724 p
->prev_stop
= it
->prev_stop
;
5725 p
->base_level_stop
= it
->base_level_stop
;
5726 p
->cmp_it
= it
->cmp_it
;
5727 eassert (it
->face_id
>= 0);
5728 p
->face_id
= it
->face_id
;
5729 p
->string
= it
->string
;
5730 p
->method
= it
->method
;
5731 p
->from_overlay
= it
->from_overlay
;
5734 case GET_FROM_IMAGE
:
5735 p
->u
.image
.object
= it
->object
;
5736 p
->u
.image
.image_id
= it
->image_id
;
5737 p
->u
.image
.slice
= it
->slice
;
5739 case GET_FROM_STRETCH
:
5740 p
->u
.stretch
.object
= it
->object
;
5743 p
->position
= position
? *position
: it
->position
;
5744 p
->current
= it
->current
;
5745 p
->end_charpos
= it
->end_charpos
;
5746 p
->string_nchars
= it
->string_nchars
;
5748 p
->multibyte_p
= it
->multibyte_p
;
5749 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5750 p
->space_width
= it
->space_width
;
5751 p
->font_height
= it
->font_height
;
5752 p
->voffset
= it
->voffset
;
5753 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5754 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5755 p
->display_ellipsis_p
= 0;
5756 p
->line_wrap
= it
->line_wrap
;
5757 p
->bidi_p
= it
->bidi_p
;
5758 p
->paragraph_embedding
= it
->paragraph_embedding
;
5759 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5762 /* Save the state of the bidi iterator as well. */
5764 bidi_push_it (&it
->bidi_it
);
5768 iterate_out_of_display_property (struct it
*it
)
5770 int buffer_p
= !STRINGP (it
->string
);
5771 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5772 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5774 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5776 /* Maybe initialize paragraph direction. If we are at the beginning
5777 of a new paragraph, next_element_from_buffer may not have a
5778 chance to do that. */
5779 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5780 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5781 /* prev_stop can be zero, so check against BEGV as well. */
5782 while (it
->bidi_it
.charpos
>= bob
5783 && it
->prev_stop
<= it
->bidi_it
.charpos
5784 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5785 && it
->bidi_it
.charpos
< eob
)
5786 bidi_move_to_visually_next (&it
->bidi_it
);
5787 /* Record the stop_pos we just crossed, for when we cross it
5789 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5790 it
->prev_stop
= CHARPOS (it
->position
);
5791 /* If we ended up not where pop_it put us, resync IT's
5792 positional members with the bidi iterator. */
5793 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5794 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5796 it
->current
.pos
= it
->position
;
5798 it
->current
.string_pos
= it
->position
;
5801 /* Restore IT's settings from IT->stack. Called, for example, when no
5802 more overlay strings must be processed, and we return to delivering
5803 display elements from a buffer, or when the end of a string from a
5804 `display' property is reached and we return to delivering display
5805 elements from an overlay string, or from a buffer. */
5808 pop_it (struct it
*it
)
5810 struct iterator_stack_entry
*p
;
5811 int from_display_prop
= it
->from_disp_prop_p
;
5813 eassert (it
->sp
> 0);
5815 p
= it
->stack
+ it
->sp
;
5816 it
->stop_charpos
= p
->stop_charpos
;
5817 it
->prev_stop
= p
->prev_stop
;
5818 it
->base_level_stop
= p
->base_level_stop
;
5819 it
->cmp_it
= p
->cmp_it
;
5820 it
->face_id
= p
->face_id
;
5821 it
->current
= p
->current
;
5822 it
->position
= p
->position
;
5823 it
->string
= p
->string
;
5824 it
->from_overlay
= p
->from_overlay
;
5825 if (NILP (it
->string
))
5826 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5827 it
->method
= p
->method
;
5830 case GET_FROM_IMAGE
:
5831 it
->image_id
= p
->u
.image
.image_id
;
5832 it
->object
= p
->u
.image
.object
;
5833 it
->slice
= p
->u
.image
.slice
;
5835 case GET_FROM_STRETCH
:
5836 it
->object
= p
->u
.stretch
.object
;
5838 case GET_FROM_BUFFER
:
5839 it
->object
= it
->w
->contents
;
5841 case GET_FROM_STRING
:
5842 it
->object
= it
->string
;
5844 case GET_FROM_DISPLAY_VECTOR
:
5846 it
->method
= GET_FROM_C_STRING
;
5847 else if (STRINGP (it
->string
))
5848 it
->method
= GET_FROM_STRING
;
5851 it
->method
= GET_FROM_BUFFER
;
5852 it
->object
= it
->w
->contents
;
5855 it
->end_charpos
= p
->end_charpos
;
5856 it
->string_nchars
= p
->string_nchars
;
5858 it
->multibyte_p
= p
->multibyte_p
;
5859 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5860 it
->space_width
= p
->space_width
;
5861 it
->font_height
= p
->font_height
;
5862 it
->voffset
= p
->voffset
;
5863 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5864 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5865 it
->line_wrap
= p
->line_wrap
;
5866 it
->bidi_p
= p
->bidi_p
;
5867 it
->paragraph_embedding
= p
->paragraph_embedding
;
5868 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5871 bidi_pop_it (&it
->bidi_it
);
5872 /* Bidi-iterate until we get out of the portion of text, if any,
5873 covered by a `display' text property or by an overlay with
5874 `display' property. (We cannot just jump there, because the
5875 internal coherency of the bidi iterator state can not be
5876 preserved across such jumps.) We also must determine the
5877 paragraph base direction if the overlay we just processed is
5878 at the beginning of a new paragraph. */
5879 if (from_display_prop
5880 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5881 iterate_out_of_display_property (it
);
5883 eassert ((BUFFERP (it
->object
)
5884 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5885 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5886 || (STRINGP (it
->object
)
5887 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5888 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5889 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5895 /***********************************************************************
5897 ***********************************************************************/
5899 /* Set IT's current position to the previous line start. */
5902 back_to_previous_line_start (struct it
*it
)
5904 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
5907 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
5911 /* Move IT to the next line start.
5913 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5914 we skipped over part of the text (as opposed to moving the iterator
5915 continuously over the text). Otherwise, don't change the value
5918 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5919 iterator on the newline, if it was found.
5921 Newlines may come from buffer text, overlay strings, or strings
5922 displayed via the `display' property. That's the reason we can't
5923 simply use find_newline_no_quit.
5925 Note that this function may not skip over invisible text that is so
5926 because of text properties and immediately follows a newline. If
5927 it would, function reseat_at_next_visible_line_start, when called
5928 from set_iterator_to_next, would effectively make invisible
5929 characters following a newline part of the wrong glyph row, which
5930 leads to wrong cursor motion. */
5933 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5934 struct bidi_it
*bidi_it_prev
)
5936 ptrdiff_t old_selective
;
5937 int newline_found_p
, n
;
5938 const int MAX_NEWLINE_DISTANCE
= 500;
5940 /* If already on a newline, just consume it to avoid unintended
5941 skipping over invisible text below. */
5942 if (it
->what
== IT_CHARACTER
5944 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5946 if (it
->bidi_p
&& bidi_it_prev
)
5947 *bidi_it_prev
= it
->bidi_it
;
5948 set_iterator_to_next (it
, 0);
5953 /* Don't handle selective display in the following. It's (a)
5954 unnecessary because it's done by the caller, and (b) leads to an
5955 infinite recursion because next_element_from_ellipsis indirectly
5956 calls this function. */
5957 old_selective
= it
->selective
;
5960 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5961 from buffer text. */
5962 for (n
= newline_found_p
= 0;
5963 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5964 n
+= STRINGP (it
->string
) ? 0 : 1)
5966 if (!get_next_display_element (it
))
5968 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5969 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5970 *bidi_it_prev
= it
->bidi_it
;
5971 set_iterator_to_next (it
, 0);
5974 /* If we didn't find a newline near enough, see if we can use a
5976 if (!newline_found_p
)
5978 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
5979 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
5983 eassert (!STRINGP (it
->string
));
5985 /* If there isn't any `display' property in sight, and no
5986 overlays, we can just use the position of the newline in
5988 if (it
->stop_charpos
>= limit
5989 || ((pos
= Fnext_single_property_change (make_number (start
),
5991 make_number (limit
)),
5993 && next_overlay_change (start
) == ZV
))
5997 IT_CHARPOS (*it
) = limit
;
5998 IT_BYTEPOS (*it
) = bytepos
;
6002 struct bidi_it bprev
;
6004 /* Help bidi.c avoid expensive searches for display
6005 properties and overlays, by telling it that there are
6006 none up to `limit'. */
6007 if (it
->bidi_it
.disp_pos
< limit
)
6009 it
->bidi_it
.disp_pos
= limit
;
6010 it
->bidi_it
.disp_prop
= 0;
6013 bprev
= it
->bidi_it
;
6014 bidi_move_to_visually_next (&it
->bidi_it
);
6015 } while (it
->bidi_it
.charpos
!= limit
);
6016 IT_CHARPOS (*it
) = limit
;
6017 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6019 *bidi_it_prev
= bprev
;
6021 *skipped_p
= newline_found_p
= 1;
6025 while (get_next_display_element (it
)
6026 && !newline_found_p
)
6028 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6029 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6030 *bidi_it_prev
= it
->bidi_it
;
6031 set_iterator_to_next (it
, 0);
6036 it
->selective
= old_selective
;
6037 return newline_found_p
;
6041 /* Set IT's current position to the previous visible line start. Skip
6042 invisible text that is so either due to text properties or due to
6043 selective display. Caution: this does not change IT->current_x and
6047 back_to_previous_visible_line_start (struct it
*it
)
6049 while (IT_CHARPOS (*it
) > BEGV
)
6051 back_to_previous_line_start (it
);
6053 if (IT_CHARPOS (*it
) <= BEGV
)
6056 /* If selective > 0, then lines indented more than its value are
6058 if (it
->selective
> 0
6059 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6063 /* Check the newline before point for invisibility. */
6066 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6067 Qinvisible
, it
->window
);
6068 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6072 if (IT_CHARPOS (*it
) <= BEGV
)
6077 void *it2data
= NULL
;
6080 Lisp_Object val
, overlay
;
6082 SAVE_IT (it2
, *it
, it2data
);
6084 /* If newline is part of a composition, continue from start of composition */
6085 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6086 && beg
< IT_CHARPOS (*it
))
6089 /* If newline is replaced by a display property, find start of overlay
6090 or interval and continue search from that point. */
6091 pos
= --IT_CHARPOS (it2
);
6094 bidi_unshelve_cache (NULL
, 0);
6095 it2
.string_from_display_prop_p
= 0;
6096 it2
.from_disp_prop_p
= 0;
6097 if (handle_display_prop (&it2
) == HANDLED_RETURN
6098 && !NILP (val
= get_char_property_and_overlay
6099 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6100 && (OVERLAYP (overlay
)
6101 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6102 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6104 RESTORE_IT (it
, it
, it2data
);
6108 /* Newline is not replaced by anything -- so we are done. */
6109 RESTORE_IT (it
, it
, it2data
);
6115 IT_CHARPOS (*it
) = beg
;
6116 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6120 it
->continuation_lines_width
= 0;
6122 eassert (IT_CHARPOS (*it
) >= BEGV
);
6123 eassert (IT_CHARPOS (*it
) == BEGV
6124 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6129 /* Reseat iterator IT at the previous visible line start. Skip
6130 invisible text that is so either due to text properties or due to
6131 selective display. At the end, update IT's overlay information,
6132 face information etc. */
6135 reseat_at_previous_visible_line_start (struct it
*it
)
6137 back_to_previous_visible_line_start (it
);
6138 reseat (it
, it
->current
.pos
, 1);
6143 /* Reseat iterator IT on the next visible line start in the current
6144 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6145 preceding the line start. Skip over invisible text that is so
6146 because of selective display. Compute faces, overlays etc at the
6147 new position. Note that this function does not skip over text that
6148 is invisible because of text properties. */
6151 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6153 int newline_found_p
, skipped_p
= 0;
6154 struct bidi_it bidi_it_prev
;
6156 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6158 /* Skip over lines that are invisible because they are indented
6159 more than the value of IT->selective. */
6160 if (it
->selective
> 0)
6161 while (IT_CHARPOS (*it
) < ZV
6162 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6165 eassert (IT_BYTEPOS (*it
) == BEGV
6166 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6168 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6171 /* Position on the newline if that's what's requested. */
6172 if (on_newline_p
&& newline_found_p
)
6174 if (STRINGP (it
->string
))
6176 if (IT_STRING_CHARPOS (*it
) > 0)
6180 --IT_STRING_CHARPOS (*it
);
6181 --IT_STRING_BYTEPOS (*it
);
6185 /* We need to restore the bidi iterator to the state
6186 it had on the newline, and resync the IT's
6187 position with that. */
6188 it
->bidi_it
= bidi_it_prev
;
6189 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6190 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6194 else if (IT_CHARPOS (*it
) > BEGV
)
6203 /* We need to restore the bidi iterator to the state it
6204 had on the newline and resync IT with that. */
6205 it
->bidi_it
= bidi_it_prev
;
6206 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6207 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6209 reseat (it
, it
->current
.pos
, 0);
6213 reseat (it
, it
->current
.pos
, 0);
6220 /***********************************************************************
6221 Changing an iterator's position
6222 ***********************************************************************/
6224 /* Change IT's current position to POS in current_buffer. If FORCE_P
6225 is non-zero, always check for text properties at the new position.
6226 Otherwise, text properties are only looked up if POS >=
6227 IT->check_charpos of a property. */
6230 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6232 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6234 reseat_1 (it
, pos
, 0);
6236 /* Determine where to check text properties. Avoid doing it
6237 where possible because text property lookup is very expensive. */
6239 || CHARPOS (pos
) > it
->stop_charpos
6240 || CHARPOS (pos
) < original_pos
)
6244 /* For bidi iteration, we need to prime prev_stop and
6245 base_level_stop with our best estimations. */
6246 /* Implementation note: Of course, POS is not necessarily a
6247 stop position, so assigning prev_pos to it is a lie; we
6248 should have called compute_stop_backwards. However, if
6249 the current buffer does not include any R2L characters,
6250 that call would be a waste of cycles, because the
6251 iterator will never move back, and thus never cross this
6252 "fake" stop position. So we delay that backward search
6253 until the time we really need it, in next_element_from_buffer. */
6254 if (CHARPOS (pos
) != it
->prev_stop
)
6255 it
->prev_stop
= CHARPOS (pos
);
6256 if (CHARPOS (pos
) < it
->base_level_stop
)
6257 it
->base_level_stop
= 0; /* meaning it's unknown */
6263 it
->prev_stop
= it
->base_level_stop
= 0;
6272 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6273 IT->stop_pos to POS, also. */
6276 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6278 /* Don't call this function when scanning a C string. */
6279 eassert (it
->s
== NULL
);
6281 /* POS must be a reasonable value. */
6282 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6284 it
->current
.pos
= it
->position
= pos
;
6285 it
->end_charpos
= ZV
;
6287 it
->current
.dpvec_index
= -1;
6288 it
->current
.overlay_string_index
= -1;
6289 IT_STRING_CHARPOS (*it
) = -1;
6290 IT_STRING_BYTEPOS (*it
) = -1;
6292 it
->method
= GET_FROM_BUFFER
;
6293 it
->object
= it
->w
->contents
;
6294 it
->area
= TEXT_AREA
;
6295 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6297 it
->string_from_display_prop_p
= 0;
6298 it
->string_from_prefix_prop_p
= 0;
6300 it
->from_disp_prop_p
= 0;
6301 it
->face_before_selective_p
= 0;
6304 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6306 bidi_unshelve_cache (NULL
, 0);
6307 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6308 it
->bidi_it
.string
.s
= NULL
;
6309 it
->bidi_it
.string
.lstring
= Qnil
;
6310 it
->bidi_it
.string
.bufpos
= 0;
6311 it
->bidi_it
.string
.unibyte
= 0;
6316 it
->stop_charpos
= CHARPOS (pos
);
6317 it
->base_level_stop
= CHARPOS (pos
);
6319 /* This make the information stored in it->cmp_it invalidate. */
6324 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6325 If S is non-null, it is a C string to iterate over. Otherwise,
6326 STRING gives a Lisp string to iterate over.
6328 If PRECISION > 0, don't return more then PRECISION number of
6329 characters from the string.
6331 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6332 characters have been returned. FIELD_WIDTH < 0 means an infinite
6335 MULTIBYTE = 0 means disable processing of multibyte characters,
6336 MULTIBYTE > 0 means enable it,
6337 MULTIBYTE < 0 means use IT->multibyte_p.
6339 IT must be initialized via a prior call to init_iterator before
6340 calling this function. */
6343 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6344 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6347 /* No region in strings. */
6348 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6350 /* No text property checks performed by default, but see below. */
6351 it
->stop_charpos
= -1;
6353 /* Set iterator position and end position. */
6354 memset (&it
->current
, 0, sizeof it
->current
);
6355 it
->current
.overlay_string_index
= -1;
6356 it
->current
.dpvec_index
= -1;
6357 eassert (charpos
>= 0);
6359 /* If STRING is specified, use its multibyteness, otherwise use the
6360 setting of MULTIBYTE, if specified. */
6362 it
->multibyte_p
= multibyte
> 0;
6364 /* Bidirectional reordering of strings is controlled by the default
6365 value of bidi-display-reordering. Don't try to reorder while
6366 loading loadup.el, as the necessary character property tables are
6367 not yet available. */
6370 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6374 eassert (STRINGP (string
));
6375 it
->string
= string
;
6377 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6378 it
->method
= GET_FROM_STRING
;
6379 it
->current
.string_pos
= string_pos (charpos
, string
);
6383 it
->bidi_it
.string
.lstring
= string
;
6384 it
->bidi_it
.string
.s
= NULL
;
6385 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6386 it
->bidi_it
.string
.bufpos
= 0;
6387 it
->bidi_it
.string
.from_disp_str
= 0;
6388 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6389 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6390 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6395 it
->s
= (const unsigned char *) s
;
6398 /* Note that we use IT->current.pos, not it->current.string_pos,
6399 for displaying C strings. */
6400 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6401 if (it
->multibyte_p
)
6403 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6404 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6408 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6409 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6414 it
->bidi_it
.string
.lstring
= Qnil
;
6415 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6416 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6417 it
->bidi_it
.string
.bufpos
= 0;
6418 it
->bidi_it
.string
.from_disp_str
= 0;
6419 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6420 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6423 it
->method
= GET_FROM_C_STRING
;
6426 /* PRECISION > 0 means don't return more than PRECISION characters
6428 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6430 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6432 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6435 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6436 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6437 FIELD_WIDTH < 0 means infinite field width. This is useful for
6438 padding with `-' at the end of a mode line. */
6439 if (field_width
< 0)
6440 field_width
= INFINITY
;
6441 /* Implementation note: We deliberately don't enlarge
6442 it->bidi_it.string.schars here to fit it->end_charpos, because
6443 the bidi iterator cannot produce characters out of thin air. */
6444 if (field_width
> it
->end_charpos
- charpos
)
6445 it
->end_charpos
= charpos
+ field_width
;
6447 /* Use the standard display table for displaying strings. */
6448 if (DISP_TABLE_P (Vstandard_display_table
))
6449 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6451 it
->stop_charpos
= charpos
;
6452 it
->prev_stop
= charpos
;
6453 it
->base_level_stop
= 0;
6456 it
->bidi_it
.first_elt
= 1;
6457 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6458 it
->bidi_it
.disp_pos
= -1;
6460 if (s
== NULL
&& it
->multibyte_p
)
6462 ptrdiff_t endpos
= SCHARS (it
->string
);
6463 if (endpos
> it
->end_charpos
)
6464 endpos
= it
->end_charpos
;
6465 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6473 /***********************************************************************
6475 ***********************************************************************/
6477 /* Map enum it_method value to corresponding next_element_from_* function. */
6479 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6481 next_element_from_buffer
,
6482 next_element_from_display_vector
,
6483 next_element_from_string
,
6484 next_element_from_c_string
,
6485 next_element_from_image
,
6486 next_element_from_stretch
6489 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6492 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6493 (possibly with the following characters). */
6495 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6496 ((IT)->cmp_it.id >= 0 \
6497 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6498 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6499 END_CHARPOS, (IT)->w, \
6500 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6504 /* Lookup the char-table Vglyphless_char_display for character C (-1
6505 if we want information for no-font case), and return the display
6506 method symbol. By side-effect, update it->what and
6507 it->glyphless_method. This function is called from
6508 get_next_display_element for each character element, and from
6509 x_produce_glyphs when no suitable font was found. */
6512 lookup_glyphless_char_display (int c
, struct it
*it
)
6514 Lisp_Object glyphless_method
= Qnil
;
6516 if (CHAR_TABLE_P (Vglyphless_char_display
)
6517 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6521 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6522 if (CONSP (glyphless_method
))
6523 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6524 ? XCAR (glyphless_method
)
6525 : XCDR (glyphless_method
);
6528 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6532 if (NILP (glyphless_method
))
6535 /* The default is to display the character by a proper font. */
6537 /* The default for the no-font case is to display an empty box. */
6538 glyphless_method
= Qempty_box
;
6540 if (EQ (glyphless_method
, Qzero_width
))
6543 return glyphless_method
;
6544 /* This method can't be used for the no-font case. */
6545 glyphless_method
= Qempty_box
;
6547 if (EQ (glyphless_method
, Qthin_space
))
6548 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6549 else if (EQ (glyphless_method
, Qempty_box
))
6550 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6551 else if (EQ (glyphless_method
, Qhex_code
))
6552 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6553 else if (STRINGP (glyphless_method
))
6554 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6557 /* Invalid value. We use the default method. */
6558 glyphless_method
= Qnil
;
6561 it
->what
= IT_GLYPHLESS
;
6562 return glyphless_method
;
6565 /* Load IT's display element fields with information about the next
6566 display element from the current position of IT. Value is zero if
6567 end of buffer (or C string) is reached. */
6569 static struct frame
*last_escape_glyph_frame
= NULL
;
6570 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6571 static int last_escape_glyph_merged_face_id
= 0;
6573 struct frame
*last_glyphless_glyph_frame
= NULL
;
6574 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6575 int last_glyphless_glyph_merged_face_id
= 0;
6578 get_next_display_element (struct it
*it
)
6580 /* Non-zero means that we found a display element. Zero means that
6581 we hit the end of what we iterate over. Performance note: the
6582 function pointer `method' used here turns out to be faster than
6583 using a sequence of if-statements. */
6587 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6589 if (it
->what
== IT_CHARACTER
)
6591 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6592 and only if (a) the resolved directionality of that character
6594 /* FIXME: Do we need an exception for characters from display
6596 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6597 it
->c
= bidi_mirror_char (it
->c
);
6598 /* Map via display table or translate control characters.
6599 IT->c, IT->len etc. have been set to the next character by
6600 the function call above. If we have a display table, and it
6601 contains an entry for IT->c, translate it. Don't do this if
6602 IT->c itself comes from a display table, otherwise we could
6603 end up in an infinite recursion. (An alternative could be to
6604 count the recursion depth of this function and signal an
6605 error when a certain maximum depth is reached.) Is it worth
6607 if (success_p
&& it
->dpvec
== NULL
)
6610 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6611 int nonascii_space_p
= 0;
6612 int nonascii_hyphen_p
= 0;
6613 int c
= it
->c
; /* This is the character to display. */
6615 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6617 eassert (SINGLE_BYTE_CHAR_P (c
));
6618 if (unibyte_display_via_language_environment
)
6620 c
= DECODE_CHAR (unibyte
, c
);
6622 c
= BYTE8_TO_CHAR (it
->c
);
6625 c
= BYTE8_TO_CHAR (it
->c
);
6629 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6632 struct Lisp_Vector
*v
= XVECTOR (dv
);
6634 /* Return the first character from the display table
6635 entry, if not empty. If empty, don't display the
6636 current character. */
6639 it
->dpvec_char_len
= it
->len
;
6640 it
->dpvec
= v
->contents
;
6641 it
->dpend
= v
->contents
+ v
->header
.size
;
6642 it
->current
.dpvec_index
= 0;
6643 it
->dpvec_face_id
= -1;
6644 it
->saved_face_id
= it
->face_id
;
6645 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6650 set_iterator_to_next (it
, 0);
6655 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6657 if (it
->what
== IT_GLYPHLESS
)
6659 /* Don't display this character. */
6660 set_iterator_to_next (it
, 0);
6664 /* If `nobreak-char-display' is non-nil, we display
6665 non-ASCII spaces and hyphens specially. */
6666 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6669 nonascii_space_p
= 1;
6670 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6671 nonascii_hyphen_p
= 1;
6674 /* Translate control characters into `\003' or `^C' form.
6675 Control characters coming from a display table entry are
6676 currently not translated because we use IT->dpvec to hold
6677 the translation. This could easily be changed but I
6678 don't believe that it is worth doing.
6680 The characters handled by `nobreak-char-display' must be
6683 Non-printable characters and raw-byte characters are also
6684 translated to octal form. */
6685 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6686 ? (it
->area
!= TEXT_AREA
6687 /* In mode line, treat \n, \t like other crl chars. */
6690 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6691 || (c
!= '\n' && c
!= '\t'))
6693 || nonascii_hyphen_p
6695 || ! CHAR_PRINTABLE_P (c
))))
6697 /* C is a control character, non-ASCII space/hyphen,
6698 raw-byte, or a non-printable character which must be
6699 displayed either as '\003' or as `^C' where the '\\'
6700 and '^' can be defined in the display table. Fill
6701 IT->ctl_chars with glyphs for what we have to
6702 display. Then, set IT->dpvec to these glyphs. */
6709 /* Handle control characters with ^. */
6711 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6715 g
= '^'; /* default glyph for Control */
6716 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6718 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6720 g
= GLYPH_CODE_CHAR (gc
);
6721 lface_id
= GLYPH_CODE_FACE (gc
);
6725 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6727 else if (it
->f
== last_escape_glyph_frame
6728 && it
->face_id
== last_escape_glyph_face_id
)
6730 face_id
= last_escape_glyph_merged_face_id
;
6734 /* Merge the escape-glyph face into the current face. */
6735 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6737 last_escape_glyph_frame
= it
->f
;
6738 last_escape_glyph_face_id
= it
->face_id
;
6739 last_escape_glyph_merged_face_id
= face_id
;
6742 XSETINT (it
->ctl_chars
[0], g
);
6743 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6745 goto display_control
;
6748 /* Handle non-ascii space in the mode where it only gets
6751 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6753 /* Merge `nobreak-space' into the current face. */
6754 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6756 XSETINT (it
->ctl_chars
[0], ' ');
6758 goto display_control
;
6761 /* Handle sequences that start with the "escape glyph". */
6763 /* the default escape glyph is \. */
6764 escape_glyph
= '\\';
6767 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6769 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6770 lface_id
= GLYPH_CODE_FACE (gc
);
6774 /* The display table specified a face.
6775 Merge it into face_id and also into escape_glyph. */
6776 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6779 else if (it
->f
== last_escape_glyph_frame
6780 && it
->face_id
== last_escape_glyph_face_id
)
6782 face_id
= last_escape_glyph_merged_face_id
;
6786 /* Merge the escape-glyph face into the current face. */
6787 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6789 last_escape_glyph_frame
= it
->f
;
6790 last_escape_glyph_face_id
= it
->face_id
;
6791 last_escape_glyph_merged_face_id
= face_id
;
6794 /* Draw non-ASCII hyphen with just highlighting: */
6796 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6798 XSETINT (it
->ctl_chars
[0], '-');
6800 goto display_control
;
6803 /* Draw non-ASCII space/hyphen with escape glyph: */
6805 if (nonascii_space_p
|| nonascii_hyphen_p
)
6807 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6808 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6810 goto display_control
;
6817 if (CHAR_BYTE8_P (c
))
6818 /* Display \200 instead of \17777600. */
6819 c
= CHAR_TO_BYTE8 (c
);
6820 len
= sprintf (str
, "%03o", c
);
6822 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6823 for (i
= 0; i
< len
; i
++)
6824 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6829 /* Set up IT->dpvec and return first character from it. */
6830 it
->dpvec_char_len
= it
->len
;
6831 it
->dpvec
= it
->ctl_chars
;
6832 it
->dpend
= it
->dpvec
+ ctl_len
;
6833 it
->current
.dpvec_index
= 0;
6834 it
->dpvec_face_id
= face_id
;
6835 it
->saved_face_id
= it
->face_id
;
6836 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6840 it
->char_to_display
= c
;
6844 it
->char_to_display
= it
->c
;
6848 /* Adjust face id for a multibyte character. There are no multibyte
6849 character in unibyte text. */
6850 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6853 && FRAME_WINDOW_P (it
->f
))
6855 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6857 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6859 /* Automatic composition with glyph-string. */
6860 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6862 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6866 ptrdiff_t pos
= (it
->s
? -1
6867 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6868 : IT_CHARPOS (*it
));
6871 if (it
->what
== IT_CHARACTER
)
6872 c
= it
->char_to_display
;
6875 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6879 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6880 /* TAB in a composition means display glyphs with
6881 padding space on the left or right. */
6882 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6885 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6890 /* Is this character the last one of a run of characters with
6891 box? If yes, set IT->end_of_box_run_p to 1. */
6895 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6897 int face_id
= underlying_face_id (it
);
6898 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6902 if (face
->box
== FACE_NO_BOX
)
6904 /* If the box comes from face properties in a
6905 display string, check faces in that string. */
6906 int string_face_id
= face_after_it_pos (it
);
6907 it
->end_of_box_run_p
6908 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6911 /* Otherwise, the box comes from the underlying face.
6912 If this is the last string character displayed, check
6913 the next buffer location. */
6914 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6915 && (it
->current
.overlay_string_index
6916 == it
->n_overlay_strings
- 1))
6920 struct text_pos pos
= it
->current
.pos
;
6921 INC_TEXT_POS (pos
, it
->multibyte_p
);
6923 next_face_id
= face_at_buffer_position
6924 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6925 it
->region_end_charpos
, &ignore
,
6926 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6928 it
->end_of_box_run_p
6929 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6936 int face_id
= face_after_it_pos (it
);
6937 it
->end_of_box_run_p
6938 = (face_id
!= it
->face_id
6939 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6942 /* If we reached the end of the object we've been iterating (e.g., a
6943 display string or an overlay string), and there's something on
6944 IT->stack, proceed with what's on the stack. It doesn't make
6945 sense to return zero if there's unprocessed stuff on the stack,
6946 because otherwise that stuff will never be displayed. */
6947 if (!success_p
&& it
->sp
> 0)
6949 set_iterator_to_next (it
, 0);
6950 success_p
= get_next_display_element (it
);
6953 /* Value is 0 if end of buffer or string reached. */
6958 /* Move IT to the next display element.
6960 RESEAT_P non-zero means if called on a newline in buffer text,
6961 skip to the next visible line start.
6963 Functions get_next_display_element and set_iterator_to_next are
6964 separate because I find this arrangement easier to handle than a
6965 get_next_display_element function that also increments IT's
6966 position. The way it is we can first look at an iterator's current
6967 display element, decide whether it fits on a line, and if it does,
6968 increment the iterator position. The other way around we probably
6969 would either need a flag indicating whether the iterator has to be
6970 incremented the next time, or we would have to implement a
6971 decrement position function which would not be easy to write. */
6974 set_iterator_to_next (struct it
*it
, int reseat_p
)
6976 /* Reset flags indicating start and end of a sequence of characters
6977 with box. Reset them at the start of this function because
6978 moving the iterator to a new position might set them. */
6979 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6983 case GET_FROM_BUFFER
:
6984 /* The current display element of IT is a character from
6985 current_buffer. Advance in the buffer, and maybe skip over
6986 invisible lines that are so because of selective display. */
6987 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6988 reseat_at_next_visible_line_start (it
, 0);
6989 else if (it
->cmp_it
.id
>= 0)
6991 /* We are currently getting glyphs from a composition. */
6996 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6997 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6998 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7000 it
->cmp_it
.from
= it
->cmp_it
.to
;
7005 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7007 it
->end_charpos
, Qnil
);
7010 else if (! it
->cmp_it
.reversed_p
)
7012 /* Composition created while scanning forward. */
7013 /* Update IT's char/byte positions to point to the first
7014 character of the next grapheme cluster, or to the
7015 character visually after the current composition. */
7016 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7017 bidi_move_to_visually_next (&it
->bidi_it
);
7018 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7019 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7021 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7023 /* Proceed to the next grapheme cluster. */
7024 it
->cmp_it
.from
= it
->cmp_it
.to
;
7028 /* No more grapheme clusters in this composition.
7029 Find the next stop position. */
7030 ptrdiff_t stop
= it
->end_charpos
;
7031 if (it
->bidi_it
.scan_dir
< 0)
7032 /* Now we are scanning backward and don't know
7035 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7036 IT_BYTEPOS (*it
), stop
, Qnil
);
7041 /* Composition created while scanning backward. */
7042 /* Update IT's char/byte positions to point to the last
7043 character of the previous grapheme cluster, or the
7044 character visually after the current composition. */
7045 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7046 bidi_move_to_visually_next (&it
->bidi_it
);
7047 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7048 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7049 if (it
->cmp_it
.from
> 0)
7051 /* Proceed to the previous grapheme cluster. */
7052 it
->cmp_it
.to
= it
->cmp_it
.from
;
7056 /* No more grapheme clusters in this composition.
7057 Find the next stop position. */
7058 ptrdiff_t stop
= it
->end_charpos
;
7059 if (it
->bidi_it
.scan_dir
< 0)
7060 /* Now we are scanning backward and don't know
7063 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7064 IT_BYTEPOS (*it
), stop
, Qnil
);
7070 eassert (it
->len
!= 0);
7074 IT_BYTEPOS (*it
) += it
->len
;
7075 IT_CHARPOS (*it
) += 1;
7079 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7080 /* If this is a new paragraph, determine its base
7081 direction (a.k.a. its base embedding level). */
7082 if (it
->bidi_it
.new_paragraph
)
7083 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7084 bidi_move_to_visually_next (&it
->bidi_it
);
7085 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7086 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7087 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7089 /* As the scan direction was changed, we must
7090 re-compute the stop position for composition. */
7091 ptrdiff_t stop
= it
->end_charpos
;
7092 if (it
->bidi_it
.scan_dir
< 0)
7094 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7095 IT_BYTEPOS (*it
), stop
, Qnil
);
7098 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7102 case GET_FROM_C_STRING
:
7103 /* Current display element of IT is from a C string. */
7105 /* If the string position is beyond string's end, it means
7106 next_element_from_c_string is padding the string with
7107 blanks, in which case we bypass the bidi iterator,
7108 because it cannot deal with such virtual characters. */
7109 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7111 IT_BYTEPOS (*it
) += it
->len
;
7112 IT_CHARPOS (*it
) += 1;
7116 bidi_move_to_visually_next (&it
->bidi_it
);
7117 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7118 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7122 case GET_FROM_DISPLAY_VECTOR
:
7123 /* Current display element of IT is from a display table entry.
7124 Advance in the display table definition. Reset it to null if
7125 end reached, and continue with characters from buffers/
7127 ++it
->current
.dpvec_index
;
7129 /* Restore face of the iterator to what they were before the
7130 display vector entry (these entries may contain faces). */
7131 it
->face_id
= it
->saved_face_id
;
7133 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7135 int recheck_faces
= it
->ellipsis_p
;
7138 it
->method
= GET_FROM_C_STRING
;
7139 else if (STRINGP (it
->string
))
7140 it
->method
= GET_FROM_STRING
;
7143 it
->method
= GET_FROM_BUFFER
;
7144 it
->object
= it
->w
->contents
;
7148 it
->current
.dpvec_index
= -1;
7150 /* Skip over characters which were displayed via IT->dpvec. */
7151 if (it
->dpvec_char_len
< 0)
7152 reseat_at_next_visible_line_start (it
, 1);
7153 else if (it
->dpvec_char_len
> 0)
7155 if (it
->method
== GET_FROM_STRING
7156 && it
->n_overlay_strings
> 0)
7157 it
->ignore_overlay_strings_at_pos_p
= 1;
7158 it
->len
= it
->dpvec_char_len
;
7159 set_iterator_to_next (it
, reseat_p
);
7162 /* Maybe recheck faces after display vector */
7164 it
->stop_charpos
= IT_CHARPOS (*it
);
7168 case GET_FROM_STRING
:
7169 /* Current display element is a character from a Lisp string. */
7170 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7171 /* Don't advance past string end. These conditions are true
7172 when set_iterator_to_next is called at the end of
7173 get_next_display_element, in which case the Lisp string is
7174 already exhausted, and all we want is pop the iterator
7176 if (it
->current
.overlay_string_index
>= 0)
7178 /* This is an overlay string, so there's no padding with
7179 spaces, and the number of characters in the string is
7180 where the string ends. */
7181 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7182 goto consider_string_end
;
7186 /* Not an overlay string. There could be padding, so test
7187 against it->end_charpos . */
7188 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7189 goto consider_string_end
;
7191 if (it
->cmp_it
.id
>= 0)
7197 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7198 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7199 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7200 it
->cmp_it
.from
= it
->cmp_it
.to
;
7204 composition_compute_stop_pos (&it
->cmp_it
,
7205 IT_STRING_CHARPOS (*it
),
7206 IT_STRING_BYTEPOS (*it
),
7207 it
->end_charpos
, it
->string
);
7210 else if (! it
->cmp_it
.reversed_p
)
7212 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7213 bidi_move_to_visually_next (&it
->bidi_it
);
7214 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7215 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7217 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7218 it
->cmp_it
.from
= it
->cmp_it
.to
;
7221 ptrdiff_t stop
= it
->end_charpos
;
7222 if (it
->bidi_it
.scan_dir
< 0)
7224 composition_compute_stop_pos (&it
->cmp_it
,
7225 IT_STRING_CHARPOS (*it
),
7226 IT_STRING_BYTEPOS (*it
), stop
,
7232 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7233 bidi_move_to_visually_next (&it
->bidi_it
);
7234 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7235 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7236 if (it
->cmp_it
.from
> 0)
7237 it
->cmp_it
.to
= it
->cmp_it
.from
;
7240 ptrdiff_t stop
= it
->end_charpos
;
7241 if (it
->bidi_it
.scan_dir
< 0)
7243 composition_compute_stop_pos (&it
->cmp_it
,
7244 IT_STRING_CHARPOS (*it
),
7245 IT_STRING_BYTEPOS (*it
), stop
,
7253 /* If the string position is beyond string's end, it
7254 means next_element_from_string is padding the string
7255 with blanks, in which case we bypass the bidi
7256 iterator, because it cannot deal with such virtual
7258 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7260 IT_STRING_BYTEPOS (*it
) += it
->len
;
7261 IT_STRING_CHARPOS (*it
) += 1;
7265 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7267 bidi_move_to_visually_next (&it
->bidi_it
);
7268 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7269 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7270 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7272 ptrdiff_t stop
= it
->end_charpos
;
7274 if (it
->bidi_it
.scan_dir
< 0)
7276 composition_compute_stop_pos (&it
->cmp_it
,
7277 IT_STRING_CHARPOS (*it
),
7278 IT_STRING_BYTEPOS (*it
), stop
,
7284 consider_string_end
:
7286 if (it
->current
.overlay_string_index
>= 0)
7288 /* IT->string is an overlay string. Advance to the
7289 next, if there is one. */
7290 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7293 next_overlay_string (it
);
7295 setup_for_ellipsis (it
, 0);
7300 /* IT->string is not an overlay string. If we reached
7301 its end, and there is something on IT->stack, proceed
7302 with what is on the stack. This can be either another
7303 string, this time an overlay string, or a buffer. */
7304 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7308 if (it
->method
== GET_FROM_STRING
)
7309 goto consider_string_end
;
7314 case GET_FROM_IMAGE
:
7315 case GET_FROM_STRETCH
:
7316 /* The position etc with which we have to proceed are on
7317 the stack. The position may be at the end of a string,
7318 if the `display' property takes up the whole string. */
7319 eassert (it
->sp
> 0);
7321 if (it
->method
== GET_FROM_STRING
)
7322 goto consider_string_end
;
7326 /* There are no other methods defined, so this should be a bug. */
7330 eassert (it
->method
!= GET_FROM_STRING
7331 || (STRINGP (it
->string
)
7332 && IT_STRING_CHARPOS (*it
) >= 0));
7335 /* Load IT's display element fields with information about the next
7336 display element which comes from a display table entry or from the
7337 result of translating a control character to one of the forms `^C'
7340 IT->dpvec holds the glyphs to return as characters.
7341 IT->saved_face_id holds the face id before the display vector--it
7342 is restored into IT->face_id in set_iterator_to_next. */
7345 next_element_from_display_vector (struct it
*it
)
7350 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7352 it
->face_id
= it
->saved_face_id
;
7354 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7355 That seemed totally bogus - so I changed it... */
7356 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7358 if (GLYPH_CODE_P (gc
))
7360 it
->c
= GLYPH_CODE_CHAR (gc
);
7361 it
->len
= CHAR_BYTES (it
->c
);
7363 /* The entry may contain a face id to use. Such a face id is
7364 the id of a Lisp face, not a realized face. A face id of
7365 zero means no face is specified. */
7366 if (it
->dpvec_face_id
>= 0)
7367 it
->face_id
= it
->dpvec_face_id
;
7370 int lface_id
= GLYPH_CODE_FACE (gc
);
7372 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7377 /* Display table entry is invalid. Return a space. */
7378 it
->c
= ' ', it
->len
= 1;
7380 /* Don't change position and object of the iterator here. They are
7381 still the values of the character that had this display table
7382 entry or was translated, and that's what we want. */
7383 it
->what
= IT_CHARACTER
;
7387 /* Get the first element of string/buffer in the visual order, after
7388 being reseated to a new position in a string or a buffer. */
7390 get_visually_first_element (struct it
*it
)
7392 int string_p
= STRINGP (it
->string
) || it
->s
;
7393 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7394 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7396 if (STRINGP (it
->string
))
7398 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7399 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7403 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7404 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7407 if (it
->bidi_it
.charpos
== eob
)
7409 /* Nothing to do, but reset the FIRST_ELT flag, like
7410 bidi_paragraph_init does, because we are not going to
7412 it
->bidi_it
.first_elt
= 0;
7414 else if (it
->bidi_it
.charpos
== bob
7416 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7417 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7419 /* If we are at the beginning of a line/string, we can produce
7420 the next element right away. */
7421 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7422 bidi_move_to_visually_next (&it
->bidi_it
);
7426 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7428 /* We need to prime the bidi iterator starting at the line's or
7429 string's beginning, before we will be able to produce the
7432 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7434 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7435 IT_BYTEPOS (*it
), -1,
7436 &it
->bidi_it
.bytepos
);
7437 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7440 /* Now return to buffer/string position where we were asked
7441 to get the next display element, and produce that. */
7442 bidi_move_to_visually_next (&it
->bidi_it
);
7444 while (it
->bidi_it
.bytepos
!= orig_bytepos
7445 && it
->bidi_it
.charpos
< eob
);
7448 /* Adjust IT's position information to where we ended up. */
7449 if (STRINGP (it
->string
))
7451 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7452 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7456 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7457 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7460 if (STRINGP (it
->string
) || !it
->s
)
7462 ptrdiff_t stop
, charpos
, bytepos
;
7464 if (STRINGP (it
->string
))
7467 stop
= SCHARS (it
->string
);
7468 if (stop
> it
->end_charpos
)
7469 stop
= it
->end_charpos
;
7470 charpos
= IT_STRING_CHARPOS (*it
);
7471 bytepos
= IT_STRING_BYTEPOS (*it
);
7475 stop
= it
->end_charpos
;
7476 charpos
= IT_CHARPOS (*it
);
7477 bytepos
= IT_BYTEPOS (*it
);
7479 if (it
->bidi_it
.scan_dir
< 0)
7481 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7486 /* Load IT with the next display element from Lisp string IT->string.
7487 IT->current.string_pos is the current position within the string.
7488 If IT->current.overlay_string_index >= 0, the Lisp string is an
7492 next_element_from_string (struct it
*it
)
7494 struct text_pos position
;
7496 eassert (STRINGP (it
->string
));
7497 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7498 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7499 position
= it
->current
.string_pos
;
7501 /* With bidi reordering, the character to display might not be the
7502 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7503 that we were reseat()ed to a new string, whose paragraph
7504 direction is not known. */
7505 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7507 get_visually_first_element (it
);
7508 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7511 /* Time to check for invisible text? */
7512 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7514 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7517 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7518 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7520 /* With bidi non-linear iteration, we could find
7521 ourselves far beyond the last computed stop_charpos,
7522 with several other stop positions in between that we
7523 missed. Scan them all now, in buffer's logical
7524 order, until we find and handle the last stop_charpos
7525 that precedes our current position. */
7526 handle_stop_backwards (it
, it
->stop_charpos
);
7527 return GET_NEXT_DISPLAY_ELEMENT (it
);
7533 /* Take note of the stop position we just moved
7534 across, for when we will move back across it. */
7535 it
->prev_stop
= it
->stop_charpos
;
7536 /* If we are at base paragraph embedding level, take
7537 note of the last stop position seen at this
7539 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7540 it
->base_level_stop
= it
->stop_charpos
;
7544 /* Since a handler may have changed IT->method, we must
7546 return GET_NEXT_DISPLAY_ELEMENT (it
);
7550 /* If we are before prev_stop, we may have overstepped
7551 on our way backwards a stop_pos, and if so, we need
7552 to handle that stop_pos. */
7553 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7554 /* We can sometimes back up for reasons that have nothing
7555 to do with bidi reordering. E.g., compositions. The
7556 code below is only needed when we are above the base
7557 embedding level, so test for that explicitly. */
7558 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7560 /* If we lost track of base_level_stop, we have no better
7561 place for handle_stop_backwards to start from than string
7562 beginning. This happens, e.g., when we were reseated to
7563 the previous screenful of text by vertical-motion. */
7564 if (it
->base_level_stop
<= 0
7565 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7566 it
->base_level_stop
= 0;
7567 handle_stop_backwards (it
, it
->base_level_stop
);
7568 return GET_NEXT_DISPLAY_ELEMENT (it
);
7572 if (it
->current
.overlay_string_index
>= 0)
7574 /* Get the next character from an overlay string. In overlay
7575 strings, there is no field width or padding with spaces to
7577 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7582 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7583 IT_STRING_BYTEPOS (*it
),
7584 it
->bidi_it
.scan_dir
< 0
7586 : SCHARS (it
->string
))
7587 && next_element_from_composition (it
))
7591 else if (STRING_MULTIBYTE (it
->string
))
7593 const unsigned char *s
= (SDATA (it
->string
)
7594 + IT_STRING_BYTEPOS (*it
));
7595 it
->c
= string_char_and_length (s
, &it
->len
);
7599 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7605 /* Get the next character from a Lisp string that is not an
7606 overlay string. Such strings come from the mode line, for
7607 example. We may have to pad with spaces, or truncate the
7608 string. See also next_element_from_c_string. */
7609 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7614 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7616 /* Pad with spaces. */
7617 it
->c
= ' ', it
->len
= 1;
7618 CHARPOS (position
) = BYTEPOS (position
) = -1;
7620 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7621 IT_STRING_BYTEPOS (*it
),
7622 it
->bidi_it
.scan_dir
< 0
7624 : it
->string_nchars
)
7625 && next_element_from_composition (it
))
7629 else if (STRING_MULTIBYTE (it
->string
))
7631 const unsigned char *s
= (SDATA (it
->string
)
7632 + IT_STRING_BYTEPOS (*it
));
7633 it
->c
= string_char_and_length (s
, &it
->len
);
7637 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7642 /* Record what we have and where it came from. */
7643 it
->what
= IT_CHARACTER
;
7644 it
->object
= it
->string
;
7645 it
->position
= position
;
7650 /* Load IT with next display element from C string IT->s.
7651 IT->string_nchars is the maximum number of characters to return
7652 from the string. IT->end_charpos may be greater than
7653 IT->string_nchars when this function is called, in which case we
7654 may have to return padding spaces. Value is zero if end of string
7655 reached, including padding spaces. */
7658 next_element_from_c_string (struct it
*it
)
7663 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7664 it
->what
= IT_CHARACTER
;
7665 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7668 /* With bidi reordering, the character to display might not be the
7669 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7670 we were reseated to a new string, whose paragraph direction is
7672 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7673 get_visually_first_element (it
);
7675 /* IT's position can be greater than IT->string_nchars in case a
7676 field width or precision has been specified when the iterator was
7678 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7680 /* End of the game. */
7684 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7686 /* Pad with spaces. */
7687 it
->c
= ' ', it
->len
= 1;
7688 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7690 else if (it
->multibyte_p
)
7691 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7693 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7699 /* Set up IT to return characters from an ellipsis, if appropriate.
7700 The definition of the ellipsis glyphs may come from a display table
7701 entry. This function fills IT with the first glyph from the
7702 ellipsis if an ellipsis is to be displayed. */
7705 next_element_from_ellipsis (struct it
*it
)
7707 if (it
->selective_display_ellipsis_p
)
7708 setup_for_ellipsis (it
, it
->len
);
7711 /* The face at the current position may be different from the
7712 face we find after the invisible text. Remember what it
7713 was in IT->saved_face_id, and signal that it's there by
7714 setting face_before_selective_p. */
7715 it
->saved_face_id
= it
->face_id
;
7716 it
->method
= GET_FROM_BUFFER
;
7717 it
->object
= it
->w
->contents
;
7718 reseat_at_next_visible_line_start (it
, 1);
7719 it
->face_before_selective_p
= 1;
7722 return GET_NEXT_DISPLAY_ELEMENT (it
);
7726 /* Deliver an image display element. The iterator IT is already
7727 filled with image information (done in handle_display_prop). Value
7732 next_element_from_image (struct it
*it
)
7734 it
->what
= IT_IMAGE
;
7735 it
->ignore_overlay_strings_at_pos_p
= 0;
7740 /* Fill iterator IT with next display element from a stretch glyph
7741 property. IT->object is the value of the text property. Value is
7745 next_element_from_stretch (struct it
*it
)
7747 it
->what
= IT_STRETCH
;
7751 /* Scan backwards from IT's current position until we find a stop
7752 position, or until BEGV. This is called when we find ourself
7753 before both the last known prev_stop and base_level_stop while
7754 reordering bidirectional text. */
7757 compute_stop_pos_backwards (struct it
*it
)
7759 const int SCAN_BACK_LIMIT
= 1000;
7760 struct text_pos pos
;
7761 struct display_pos save_current
= it
->current
;
7762 struct text_pos save_position
= it
->position
;
7763 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7764 ptrdiff_t where_we_are
= charpos
;
7765 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7766 ptrdiff_t save_end_pos
= it
->end_charpos
;
7768 eassert (NILP (it
->string
) && !it
->s
);
7769 eassert (it
->bidi_p
);
7773 it
->end_charpos
= min (charpos
+ 1, ZV
);
7774 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7775 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
7776 reseat_1 (it
, pos
, 0);
7777 compute_stop_pos (it
);
7778 /* We must advance forward, right? */
7779 if (it
->stop_charpos
<= charpos
)
7782 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7784 if (it
->stop_charpos
<= where_we_are
)
7785 it
->prev_stop
= it
->stop_charpos
;
7787 it
->prev_stop
= BEGV
;
7789 it
->current
= save_current
;
7790 it
->position
= save_position
;
7791 it
->stop_charpos
= save_stop_pos
;
7792 it
->end_charpos
= save_end_pos
;
7795 /* Scan forward from CHARPOS in the current buffer/string, until we
7796 find a stop position > current IT's position. Then handle the stop
7797 position before that. This is called when we bump into a stop
7798 position while reordering bidirectional text. CHARPOS should be
7799 the last previously processed stop_pos (or BEGV/0, if none were
7800 processed yet) whose position is less that IT's current
7804 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7806 int bufp
= !STRINGP (it
->string
);
7807 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7808 struct display_pos save_current
= it
->current
;
7809 struct text_pos save_position
= it
->position
;
7810 struct text_pos pos1
;
7811 ptrdiff_t next_stop
;
7813 /* Scan in strict logical order. */
7814 eassert (it
->bidi_p
);
7818 it
->prev_stop
= charpos
;
7821 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7822 reseat_1 (it
, pos1
, 0);
7825 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7826 compute_stop_pos (it
);
7827 /* We must advance forward, right? */
7828 if (it
->stop_charpos
<= it
->prev_stop
)
7830 charpos
= it
->stop_charpos
;
7832 while (charpos
<= where_we_are
);
7835 it
->current
= save_current
;
7836 it
->position
= save_position
;
7837 next_stop
= it
->stop_charpos
;
7838 it
->stop_charpos
= it
->prev_stop
;
7840 it
->stop_charpos
= next_stop
;
7843 /* Load IT with the next display element from current_buffer. Value
7844 is zero if end of buffer reached. IT->stop_charpos is the next
7845 position at which to stop and check for text properties or buffer
7849 next_element_from_buffer (struct it
*it
)
7853 eassert (IT_CHARPOS (*it
) >= BEGV
);
7854 eassert (NILP (it
->string
) && !it
->s
);
7855 eassert (!it
->bidi_p
7856 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7857 && it
->bidi_it
.string
.s
== NULL
));
7859 /* With bidi reordering, the character to display might not be the
7860 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7861 we were reseat()ed to a new buffer position, which is potentially
7862 a different paragraph. */
7863 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7865 get_visually_first_element (it
);
7866 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7869 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7871 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7873 int overlay_strings_follow_p
;
7875 /* End of the game, except when overlay strings follow that
7876 haven't been returned yet. */
7877 if (it
->overlay_strings_at_end_processed_p
)
7878 overlay_strings_follow_p
= 0;
7881 it
->overlay_strings_at_end_processed_p
= 1;
7882 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7885 if (overlay_strings_follow_p
)
7886 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7890 it
->position
= it
->current
.pos
;
7894 else if (!(!it
->bidi_p
7895 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7896 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7898 /* With bidi non-linear iteration, we could find ourselves
7899 far beyond the last computed stop_charpos, with several
7900 other stop positions in between that we missed. Scan
7901 them all now, in buffer's logical order, until we find
7902 and handle the last stop_charpos that precedes our
7903 current position. */
7904 handle_stop_backwards (it
, it
->stop_charpos
);
7905 return GET_NEXT_DISPLAY_ELEMENT (it
);
7911 /* Take note of the stop position we just moved across,
7912 for when we will move back across it. */
7913 it
->prev_stop
= it
->stop_charpos
;
7914 /* If we are at base paragraph embedding level, take
7915 note of the last stop position seen at this
7917 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7918 it
->base_level_stop
= it
->stop_charpos
;
7921 return GET_NEXT_DISPLAY_ELEMENT (it
);
7925 /* If we are before prev_stop, we may have overstepped on
7926 our way backwards a stop_pos, and if so, we need to
7927 handle that stop_pos. */
7928 && IT_CHARPOS (*it
) < it
->prev_stop
7929 /* We can sometimes back up for reasons that have nothing
7930 to do with bidi reordering. E.g., compositions. The
7931 code below is only needed when we are above the base
7932 embedding level, so test for that explicitly. */
7933 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7935 if (it
->base_level_stop
<= 0
7936 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7938 /* If we lost track of base_level_stop, we need to find
7939 prev_stop by looking backwards. This happens, e.g., when
7940 we were reseated to the previous screenful of text by
7942 it
->base_level_stop
= BEGV
;
7943 compute_stop_pos_backwards (it
);
7944 handle_stop_backwards (it
, it
->prev_stop
);
7947 handle_stop_backwards (it
, it
->base_level_stop
);
7948 return GET_NEXT_DISPLAY_ELEMENT (it
);
7952 /* No face changes, overlays etc. in sight, so just return a
7953 character from current_buffer. */
7957 /* Maybe run the redisplay end trigger hook. Performance note:
7958 This doesn't seem to cost measurable time. */
7959 if (it
->redisplay_end_trigger_charpos
7961 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7962 run_redisplay_end_trigger_hook (it
);
7964 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7965 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7967 && next_element_from_composition (it
))
7972 /* Get the next character, maybe multibyte. */
7973 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7974 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7975 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7977 it
->c
= *p
, it
->len
= 1;
7979 /* Record what we have and where it came from. */
7980 it
->what
= IT_CHARACTER
;
7981 it
->object
= it
->w
->contents
;
7982 it
->position
= it
->current
.pos
;
7984 /* Normally we return the character found above, except when we
7985 really want to return an ellipsis for selective display. */
7990 /* A value of selective > 0 means hide lines indented more
7991 than that number of columns. */
7992 if (it
->selective
> 0
7993 && IT_CHARPOS (*it
) + 1 < ZV
7994 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7995 IT_BYTEPOS (*it
) + 1,
7998 success_p
= next_element_from_ellipsis (it
);
7999 it
->dpvec_char_len
= -1;
8002 else if (it
->c
== '\r' && it
->selective
== -1)
8004 /* A value of selective == -1 means that everything from the
8005 CR to the end of the line is invisible, with maybe an
8006 ellipsis displayed for it. */
8007 success_p
= next_element_from_ellipsis (it
);
8008 it
->dpvec_char_len
= -1;
8013 /* Value is zero if end of buffer reached. */
8014 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8019 /* Run the redisplay end trigger hook for IT. */
8022 run_redisplay_end_trigger_hook (struct it
*it
)
8024 Lisp_Object args
[3];
8026 /* IT->glyph_row should be non-null, i.e. we should be actually
8027 displaying something, or otherwise we should not run the hook. */
8028 eassert (it
->glyph_row
);
8030 /* Set up hook arguments. */
8031 args
[0] = Qredisplay_end_trigger_functions
;
8032 args
[1] = it
->window
;
8033 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8034 it
->redisplay_end_trigger_charpos
= 0;
8036 /* Since we are *trying* to run these functions, don't try to run
8037 them again, even if they get an error. */
8038 wset_redisplay_end_trigger (it
->w
, Qnil
);
8039 Frun_hook_with_args (3, args
);
8041 /* Notice if it changed the face of the character we are on. */
8042 handle_face_prop (it
);
8046 /* Deliver a composition display element. Unlike the other
8047 next_element_from_XXX, this function is not registered in the array
8048 get_next_element[]. It is called from next_element_from_buffer and
8049 next_element_from_string when necessary. */
8052 next_element_from_composition (struct it
*it
)
8054 it
->what
= IT_COMPOSITION
;
8055 it
->len
= it
->cmp_it
.nbytes
;
8056 if (STRINGP (it
->string
))
8060 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8061 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8064 it
->position
= it
->current
.string_pos
;
8065 it
->object
= it
->string
;
8066 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8067 IT_STRING_BYTEPOS (*it
), it
->string
);
8073 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8074 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8077 if (it
->bidi_it
.new_paragraph
)
8078 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8079 /* Resync the bidi iterator with IT's new position.
8080 FIXME: this doesn't support bidirectional text. */
8081 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8082 bidi_move_to_visually_next (&it
->bidi_it
);
8086 it
->position
= it
->current
.pos
;
8087 it
->object
= it
->w
->contents
;
8088 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8089 IT_BYTEPOS (*it
), Qnil
);
8096 /***********************************************************************
8097 Moving an iterator without producing glyphs
8098 ***********************************************************************/
8100 /* Check if iterator is at a position corresponding to a valid buffer
8101 position after some move_it_ call. */
8103 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8104 ((it)->method == GET_FROM_STRING \
8105 ? IT_STRING_CHARPOS (*it) == 0 \
8109 /* Move iterator IT to a specified buffer or X position within one
8110 line on the display without producing glyphs.
8112 OP should be a bit mask including some or all of these bits:
8113 MOVE_TO_X: Stop upon reaching x-position TO_X.
8114 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8115 Regardless of OP's value, stop upon reaching the end of the display line.
8117 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8118 This means, in particular, that TO_X includes window's horizontal
8121 The return value has several possible values that
8122 say what condition caused the scan to stop:
8124 MOVE_POS_MATCH_OR_ZV
8125 - when TO_POS or ZV was reached.
8128 -when TO_X was reached before TO_POS or ZV were reached.
8131 - when we reached the end of the display area and the line must
8135 - when we reached the end of the display area and the line is
8139 - when we stopped at a line end, i.e. a newline or a CR and selective
8142 static enum move_it_result
8143 move_it_in_display_line_to (struct it
*it
,
8144 ptrdiff_t to_charpos
, int to_x
,
8145 enum move_operation_enum op
)
8147 enum move_it_result result
= MOVE_UNDEFINED
;
8148 struct glyph_row
*saved_glyph_row
;
8149 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8150 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8151 void *ppos_data
= NULL
;
8153 enum it_method prev_method
= it
->method
;
8154 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8155 int saw_smaller_pos
= prev_pos
< to_charpos
;
8157 /* Don't produce glyphs in produce_glyphs. */
8158 saved_glyph_row
= it
->glyph_row
;
8159 it
->glyph_row
= NULL
;
8161 /* Use wrap_it to save a copy of IT wherever a word wrap could
8162 occur. Use atpos_it to save a copy of IT at the desired buffer
8163 position, if found, so that we can scan ahead and check if the
8164 word later overshoots the window edge. Use atx_it similarly, for
8170 /* Use ppos_it under bidi reordering to save a copy of IT for the
8171 position > CHARPOS that is the closest to CHARPOS. We restore
8172 that position in IT when we have scanned the entire display line
8173 without finding a match for CHARPOS and all the character
8174 positions are greater than CHARPOS. */
8177 SAVE_IT (ppos_it
, *it
, ppos_data
);
8178 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8179 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8180 SAVE_IT (ppos_it
, *it
, ppos_data
);
8183 #define BUFFER_POS_REACHED_P() \
8184 ((op & MOVE_TO_POS) != 0 \
8185 && BUFFERP (it->object) \
8186 && (IT_CHARPOS (*it) == to_charpos \
8188 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8189 && IT_CHARPOS (*it) > to_charpos) \
8190 || (it->what == IT_COMPOSITION \
8191 && ((IT_CHARPOS (*it) > to_charpos \
8192 && to_charpos >= it->cmp_it.charpos) \
8193 || (IT_CHARPOS (*it) < to_charpos \
8194 && to_charpos <= it->cmp_it.charpos)))) \
8195 && (it->method == GET_FROM_BUFFER \
8196 || (it->method == GET_FROM_DISPLAY_VECTOR \
8197 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8199 /* If there's a line-/wrap-prefix, handle it. */
8200 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8201 && it
->current_y
< it
->last_visible_y
)
8202 handle_line_prefix (it
);
8204 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8205 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8209 int x
, i
, ascent
= 0, descent
= 0;
8211 /* Utility macro to reset an iterator with x, ascent, and descent. */
8212 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8213 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8214 (IT)->max_descent = descent)
8216 /* Stop if we move beyond TO_CHARPOS (after an image or a
8217 display string or stretch glyph). */
8218 if ((op
& MOVE_TO_POS
) != 0
8219 && BUFFERP (it
->object
)
8220 && it
->method
== GET_FROM_BUFFER
8222 /* When the iterator is at base embedding level, we
8223 are guaranteed that characters are delivered for
8224 display in strictly increasing order of their
8225 buffer positions. */
8226 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8227 && IT_CHARPOS (*it
) > to_charpos
)
8229 && (prev_method
== GET_FROM_IMAGE
8230 || prev_method
== GET_FROM_STRETCH
8231 || prev_method
== GET_FROM_STRING
)
8232 /* Passed TO_CHARPOS from left to right. */
8233 && ((prev_pos
< to_charpos
8234 && IT_CHARPOS (*it
) > to_charpos
)
8235 /* Passed TO_CHARPOS from right to left. */
8236 || (prev_pos
> to_charpos
8237 && IT_CHARPOS (*it
) < to_charpos
)))))
8239 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8241 result
= MOVE_POS_MATCH_OR_ZV
;
8244 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8245 /* If wrap_it is valid, the current position might be in a
8246 word that is wrapped. So, save the iterator in
8247 atpos_it and continue to see if wrapping happens. */
8248 SAVE_IT (atpos_it
, *it
, atpos_data
);
8251 /* Stop when ZV reached.
8252 We used to stop here when TO_CHARPOS reached as well, but that is
8253 too soon if this glyph does not fit on this line. So we handle it
8254 explicitly below. */
8255 if (!get_next_display_element (it
))
8257 result
= MOVE_POS_MATCH_OR_ZV
;
8261 if (it
->line_wrap
== TRUNCATE
)
8263 if (BUFFER_POS_REACHED_P ())
8265 result
= MOVE_POS_MATCH_OR_ZV
;
8271 if (it
->line_wrap
== WORD_WRAP
)
8273 if (IT_DISPLAYING_WHITESPACE (it
))
8277 /* We have reached a glyph that follows one or more
8278 whitespace characters. If the position is
8279 already found, we are done. */
8280 if (atpos_it
.sp
>= 0)
8282 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8283 result
= MOVE_POS_MATCH_OR_ZV
;
8288 RESTORE_IT (it
, &atx_it
, atx_data
);
8289 result
= MOVE_X_REACHED
;
8292 /* Otherwise, we can wrap here. */
8293 SAVE_IT (wrap_it
, *it
, wrap_data
);
8299 /* Remember the line height for the current line, in case
8300 the next element doesn't fit on the line. */
8301 ascent
= it
->max_ascent
;
8302 descent
= it
->max_descent
;
8304 /* The call to produce_glyphs will get the metrics of the
8305 display element IT is loaded with. Record the x-position
8306 before this display element, in case it doesn't fit on the
8310 PRODUCE_GLYPHS (it
);
8312 if (it
->area
!= TEXT_AREA
)
8314 prev_method
= it
->method
;
8315 if (it
->method
== GET_FROM_BUFFER
)
8316 prev_pos
= IT_CHARPOS (*it
);
8317 set_iterator_to_next (it
, 1);
8318 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8319 SET_TEXT_POS (this_line_min_pos
,
8320 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8322 && (op
& MOVE_TO_POS
)
8323 && IT_CHARPOS (*it
) > to_charpos
8324 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8325 SAVE_IT (ppos_it
, *it
, ppos_data
);
8329 /* The number of glyphs we get back in IT->nglyphs will normally
8330 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8331 character on a terminal frame, or (iii) a line end. For the
8332 second case, IT->nglyphs - 1 padding glyphs will be present.
8333 (On X frames, there is only one glyph produced for a
8334 composite character.)
8336 The behavior implemented below means, for continuation lines,
8337 that as many spaces of a TAB as fit on the current line are
8338 displayed there. For terminal frames, as many glyphs of a
8339 multi-glyph character are displayed in the current line, too.
8340 This is what the old redisplay code did, and we keep it that
8341 way. Under X, the whole shape of a complex character must
8342 fit on the line or it will be completely displayed in the
8345 Note that both for tabs and padding glyphs, all glyphs have
8349 /* More than one glyph or glyph doesn't fit on line. All
8350 glyphs have the same width. */
8351 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8353 int x_before_this_char
= x
;
8354 int hpos_before_this_char
= it
->hpos
;
8356 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8358 new_x
= x
+ single_glyph_width
;
8360 /* We want to leave anything reaching TO_X to the caller. */
8361 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8363 if (BUFFER_POS_REACHED_P ())
8365 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8366 goto buffer_pos_reached
;
8367 if (atpos_it
.sp
< 0)
8369 SAVE_IT (atpos_it
, *it
, atpos_data
);
8370 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8375 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8378 result
= MOVE_X_REACHED
;
8383 SAVE_IT (atx_it
, *it
, atx_data
);
8384 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8389 if (/* Lines are continued. */
8390 it
->line_wrap
!= TRUNCATE
8391 && (/* And glyph doesn't fit on the line. */
8392 new_x
> it
->last_visible_x
8393 /* Or it fits exactly and we're on a window
8395 || (new_x
== it
->last_visible_x
8396 && FRAME_WINDOW_P (it
->f
)
8397 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8398 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8399 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8401 if (/* IT->hpos == 0 means the very first glyph
8402 doesn't fit on the line, e.g. a wide image. */
8404 || (new_x
== it
->last_visible_x
8405 && FRAME_WINDOW_P (it
->f
)))
8408 it
->current_x
= new_x
;
8410 /* The character's last glyph just barely fits
8412 if (i
== it
->nglyphs
- 1)
8414 /* If this is the destination position,
8415 return a position *before* it in this row,
8416 now that we know it fits in this row. */
8417 if (BUFFER_POS_REACHED_P ())
8419 if (it
->line_wrap
!= WORD_WRAP
8422 it
->hpos
= hpos_before_this_char
;
8423 it
->current_x
= x_before_this_char
;
8424 result
= MOVE_POS_MATCH_OR_ZV
;
8427 if (it
->line_wrap
== WORD_WRAP
8430 SAVE_IT (atpos_it
, *it
, atpos_data
);
8431 atpos_it
.current_x
= x_before_this_char
;
8432 atpos_it
.hpos
= hpos_before_this_char
;
8436 prev_method
= it
->method
;
8437 if (it
->method
== GET_FROM_BUFFER
)
8438 prev_pos
= IT_CHARPOS (*it
);
8439 set_iterator_to_next (it
, 1);
8440 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8441 SET_TEXT_POS (this_line_min_pos
,
8442 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8443 /* On graphical terminals, newlines may
8444 "overflow" into the fringe if
8445 overflow-newline-into-fringe is non-nil.
8446 On text terminals, and on graphical
8447 terminals with no right margin, newlines
8448 may overflow into the last glyph on the
8450 if (!FRAME_WINDOW_P (it
->f
)
8452 && it
->bidi_it
.paragraph_dir
== R2L
)
8453 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8454 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8455 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8457 if (!get_next_display_element (it
))
8459 result
= MOVE_POS_MATCH_OR_ZV
;
8462 if (BUFFER_POS_REACHED_P ())
8464 if (ITERATOR_AT_END_OF_LINE_P (it
))
8465 result
= MOVE_POS_MATCH_OR_ZV
;
8467 result
= MOVE_LINE_CONTINUED
;
8470 if (ITERATOR_AT_END_OF_LINE_P (it
))
8472 result
= MOVE_NEWLINE_OR_CR
;
8479 IT_RESET_X_ASCENT_DESCENT (it
);
8481 if (wrap_it
.sp
>= 0)
8483 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8488 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8490 result
= MOVE_LINE_CONTINUED
;
8494 if (BUFFER_POS_REACHED_P ())
8496 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8497 goto buffer_pos_reached
;
8498 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8500 SAVE_IT (atpos_it
, *it
, atpos_data
);
8501 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8505 if (new_x
> it
->first_visible_x
)
8507 /* Glyph is visible. Increment number of glyphs that
8508 would be displayed. */
8513 if (result
!= MOVE_UNDEFINED
)
8516 else if (BUFFER_POS_REACHED_P ())
8519 IT_RESET_X_ASCENT_DESCENT (it
);
8520 result
= MOVE_POS_MATCH_OR_ZV
;
8523 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8525 /* Stop when TO_X specified and reached. This check is
8526 necessary here because of lines consisting of a line end,
8527 only. The line end will not produce any glyphs and we
8528 would never get MOVE_X_REACHED. */
8529 eassert (it
->nglyphs
== 0);
8530 result
= MOVE_X_REACHED
;
8534 /* Is this a line end? If yes, we're done. */
8535 if (ITERATOR_AT_END_OF_LINE_P (it
))
8537 /* If we are past TO_CHARPOS, but never saw any character
8538 positions smaller than TO_CHARPOS, return
8539 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8541 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8543 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8545 if (IT_CHARPOS (ppos_it
) < ZV
)
8547 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8548 result
= MOVE_POS_MATCH_OR_ZV
;
8551 goto buffer_pos_reached
;
8553 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8554 && IT_CHARPOS (*it
) > to_charpos
)
8555 goto buffer_pos_reached
;
8557 result
= MOVE_NEWLINE_OR_CR
;
8560 result
= MOVE_NEWLINE_OR_CR
;
8564 prev_method
= it
->method
;
8565 if (it
->method
== GET_FROM_BUFFER
)
8566 prev_pos
= IT_CHARPOS (*it
);
8567 /* The current display element has been consumed. Advance
8569 set_iterator_to_next (it
, 1);
8570 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8571 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8572 if (IT_CHARPOS (*it
) < to_charpos
)
8573 saw_smaller_pos
= 1;
8575 && (op
& MOVE_TO_POS
)
8576 && IT_CHARPOS (*it
) >= to_charpos
8577 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8578 SAVE_IT (ppos_it
, *it
, ppos_data
);
8580 /* Stop if lines are truncated and IT's current x-position is
8581 past the right edge of the window now. */
8582 if (it
->line_wrap
== TRUNCATE
8583 && it
->current_x
>= it
->last_visible_x
)
8585 if (!FRAME_WINDOW_P (it
->f
)
8586 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8587 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8588 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8589 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8593 if ((at_eob_p
= !get_next_display_element (it
))
8594 || BUFFER_POS_REACHED_P ()
8595 /* If we are past TO_CHARPOS, but never saw any
8596 character positions smaller than TO_CHARPOS,
8597 return MOVE_POS_MATCH_OR_ZV, like the
8598 unidirectional display did. */
8599 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8601 && IT_CHARPOS (*it
) > to_charpos
))
8604 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8605 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8606 result
= MOVE_POS_MATCH_OR_ZV
;
8609 if (ITERATOR_AT_END_OF_LINE_P (it
))
8611 result
= MOVE_NEWLINE_OR_CR
;
8615 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8617 && IT_CHARPOS (*it
) > to_charpos
)
8619 if (IT_CHARPOS (ppos_it
) < ZV
)
8620 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8621 result
= MOVE_POS_MATCH_OR_ZV
;
8624 result
= MOVE_LINE_TRUNCATED
;
8627 #undef IT_RESET_X_ASCENT_DESCENT
8630 #undef BUFFER_POS_REACHED_P
8632 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8633 restore the saved iterator. */
8634 if (atpos_it
.sp
>= 0)
8635 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8636 else if (atx_it
.sp
>= 0)
8637 RESTORE_IT (it
, &atx_it
, atx_data
);
8642 bidi_unshelve_cache (atpos_data
, 1);
8644 bidi_unshelve_cache (atx_data
, 1);
8646 bidi_unshelve_cache (wrap_data
, 1);
8648 bidi_unshelve_cache (ppos_data
, 1);
8650 /* Restore the iterator settings altered at the beginning of this
8652 it
->glyph_row
= saved_glyph_row
;
8656 /* For external use. */
8658 move_it_in_display_line (struct it
*it
,
8659 ptrdiff_t to_charpos
, int to_x
,
8660 enum move_operation_enum op
)
8662 if (it
->line_wrap
== WORD_WRAP
8663 && (op
& MOVE_TO_X
))
8666 void *save_data
= NULL
;
8669 SAVE_IT (save_it
, *it
, save_data
);
8670 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8671 /* When word-wrap is on, TO_X may lie past the end
8672 of a wrapped line. Then it->current is the
8673 character on the next line, so backtrack to the
8674 space before the wrap point. */
8675 if (skip
== MOVE_LINE_CONTINUED
)
8677 int prev_x
= max (it
->current_x
- 1, 0);
8678 RESTORE_IT (it
, &save_it
, save_data
);
8679 move_it_in_display_line_to
8680 (it
, -1, prev_x
, MOVE_TO_X
);
8683 bidi_unshelve_cache (save_data
, 1);
8686 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8690 /* Move IT forward until it satisfies one or more of the criteria in
8691 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8693 OP is a bit-mask that specifies where to stop, and in particular,
8694 which of those four position arguments makes a difference. See the
8695 description of enum move_operation_enum.
8697 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8698 screen line, this function will set IT to the next position that is
8699 displayed to the right of TO_CHARPOS on the screen. */
8702 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8704 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8705 int line_height
, line_start_x
= 0, reached
= 0;
8706 void *backup_data
= NULL
;
8710 if (op
& MOVE_TO_VPOS
)
8712 /* If no TO_CHARPOS and no TO_X specified, stop at the
8713 start of the line TO_VPOS. */
8714 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8716 if (it
->vpos
== to_vpos
)
8722 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8726 /* TO_VPOS >= 0 means stop at TO_X in the line at
8727 TO_VPOS, or at TO_POS, whichever comes first. */
8728 if (it
->vpos
== to_vpos
)
8734 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8736 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8741 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8743 /* We have reached TO_X but not in the line we want. */
8744 skip
= move_it_in_display_line_to (it
, to_charpos
,
8746 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8754 else if (op
& MOVE_TO_Y
)
8756 struct it it_backup
;
8758 if (it
->line_wrap
== WORD_WRAP
)
8759 SAVE_IT (it_backup
, *it
, backup_data
);
8761 /* TO_Y specified means stop at TO_X in the line containing
8762 TO_Y---or at TO_CHARPOS if this is reached first. The
8763 problem is that we can't really tell whether the line
8764 contains TO_Y before we have completely scanned it, and
8765 this may skip past TO_X. What we do is to first scan to
8768 If TO_X is not specified, use a TO_X of zero. The reason
8769 is to make the outcome of this function more predictable.
8770 If we didn't use TO_X == 0, we would stop at the end of
8771 the line which is probably not what a caller would expect
8773 skip
= move_it_in_display_line_to
8774 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8775 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8777 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8778 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8780 else if (skip
== MOVE_X_REACHED
)
8782 /* If TO_X was reached, we want to know whether TO_Y is
8783 in the line. We know this is the case if the already
8784 scanned glyphs make the line tall enough. Otherwise,
8785 we must check by scanning the rest of the line. */
8786 line_height
= it
->max_ascent
+ it
->max_descent
;
8787 if (to_y
>= it
->current_y
8788 && to_y
< it
->current_y
+ line_height
)
8793 SAVE_IT (it_backup
, *it
, backup_data
);
8794 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8795 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8797 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8798 line_height
= it
->max_ascent
+ it
->max_descent
;
8799 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8801 if (to_y
>= it
->current_y
8802 && to_y
< it
->current_y
+ line_height
)
8804 /* If TO_Y is in this line and TO_X was reached
8805 above, we scanned too far. We have to restore
8806 IT's settings to the ones before skipping. But
8807 keep the more accurate values of max_ascent and
8808 max_descent we've found while skipping the rest
8809 of the line, for the sake of callers, such as
8810 pos_visible_p, that need to know the line
8812 int max_ascent
= it
->max_ascent
;
8813 int max_descent
= it
->max_descent
;
8815 RESTORE_IT (it
, &it_backup
, backup_data
);
8816 it
->max_ascent
= max_ascent
;
8817 it
->max_descent
= max_descent
;
8823 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8829 /* Check whether TO_Y is in this line. */
8830 line_height
= it
->max_ascent
+ it
->max_descent
;
8831 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8833 if (to_y
>= it
->current_y
8834 && to_y
< it
->current_y
+ line_height
)
8836 /* When word-wrap is on, TO_X may lie past the end
8837 of a wrapped line. Then it->current is the
8838 character on the next line, so backtrack to the
8839 space before the wrap point. */
8840 if (skip
== MOVE_LINE_CONTINUED
8841 && it
->line_wrap
== WORD_WRAP
)
8843 int prev_x
= max (it
->current_x
- 1, 0);
8844 RESTORE_IT (it
, &it_backup
, backup_data
);
8845 skip
= move_it_in_display_line_to
8846 (it
, -1, prev_x
, MOVE_TO_X
);
8855 else if (BUFFERP (it
->object
)
8856 && (it
->method
== GET_FROM_BUFFER
8857 || it
->method
== GET_FROM_STRETCH
)
8858 && IT_CHARPOS (*it
) >= to_charpos
8859 /* Under bidi iteration, a call to set_iterator_to_next
8860 can scan far beyond to_charpos if the initial
8861 portion of the next line needs to be reordered. In
8862 that case, give move_it_in_display_line_to another
8865 && it
->bidi_it
.scan_dir
== -1))
8866 skip
= MOVE_POS_MATCH_OR_ZV
;
8868 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8872 case MOVE_POS_MATCH_OR_ZV
:
8876 case MOVE_NEWLINE_OR_CR
:
8877 set_iterator_to_next (it
, 1);
8878 it
->continuation_lines_width
= 0;
8881 case MOVE_LINE_TRUNCATED
:
8882 it
->continuation_lines_width
= 0;
8883 reseat_at_next_visible_line_start (it
, 0);
8884 if ((op
& MOVE_TO_POS
) != 0
8885 && IT_CHARPOS (*it
) > to_charpos
)
8892 case MOVE_LINE_CONTINUED
:
8893 /* For continued lines ending in a tab, some of the glyphs
8894 associated with the tab are displayed on the current
8895 line. Since it->current_x does not include these glyphs,
8896 we use it->last_visible_x instead. */
8899 it
->continuation_lines_width
+= it
->last_visible_x
;
8900 /* When moving by vpos, ensure that the iterator really
8901 advances to the next line (bug#847, bug#969). Fixme:
8902 do we need to do this in other circumstances? */
8903 if (it
->current_x
!= it
->last_visible_x
8904 && (op
& MOVE_TO_VPOS
)
8905 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8907 line_start_x
= it
->current_x
+ it
->pixel_width
8908 - it
->last_visible_x
;
8909 set_iterator_to_next (it
, 0);
8913 it
->continuation_lines_width
+= it
->current_x
;
8920 /* Reset/increment for the next run. */
8921 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8922 it
->current_x
= line_start_x
;
8925 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8927 last_height
= it
->max_ascent
+ it
->max_descent
;
8928 it
->max_ascent
= it
->max_descent
= 0;
8933 /* On text terminals, we may stop at the end of a line in the middle
8934 of a multi-character glyph. If the glyph itself is continued,
8935 i.e. it is actually displayed on the next line, don't treat this
8936 stopping point as valid; move to the next line instead (unless
8937 that brings us offscreen). */
8938 if (!FRAME_WINDOW_P (it
->f
)
8940 && IT_CHARPOS (*it
) == to_charpos
8941 && it
->what
== IT_CHARACTER
8943 && it
->line_wrap
== WINDOW_WRAP
8944 && it
->current_x
== it
->last_visible_x
- 1
8947 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8949 it
->continuation_lines_width
+= it
->current_x
;
8950 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8951 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8953 last_height
= it
->max_ascent
+ it
->max_descent
;
8957 bidi_unshelve_cache (backup_data
, 1);
8959 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8963 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8965 If DY > 0, move IT backward at least that many pixels. DY = 0
8966 means move IT backward to the preceding line start or BEGV. This
8967 function may move over more than DY pixels if IT->current_y - DY
8968 ends up in the middle of a line; in this case IT->current_y will be
8969 set to the top of the line moved to. */
8972 move_it_vertically_backward (struct it
*it
, int dy
)
8976 void *it2data
= NULL
, *it3data
= NULL
;
8977 ptrdiff_t start_pos
;
8979 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
8980 ptrdiff_t pos_limit
;
8985 start_pos
= IT_CHARPOS (*it
);
8987 /* Estimate how many newlines we must move back. */
8988 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8989 if (it
->line_wrap
== TRUNCATE
)
8992 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
8994 /* Set the iterator's position that many lines back. But don't go
8995 back more than NLINES full screen lines -- this wins a day with
8996 buffers which have very long lines. */
8997 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
8998 back_to_previous_visible_line_start (it
);
9000 /* Reseat the iterator here. When moving backward, we don't want
9001 reseat to skip forward over invisible text, set up the iterator
9002 to deliver from overlay strings at the new position etc. So,
9003 use reseat_1 here. */
9004 reseat_1 (it
, it
->current
.pos
, 1);
9006 /* We are now surely at a line start. */
9007 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9008 reordering is in effect. */
9009 it
->continuation_lines_width
= 0;
9011 /* Move forward and see what y-distance we moved. First move to the
9012 start of the next line so that we get its height. We need this
9013 height to be able to tell whether we reached the specified
9015 SAVE_IT (it2
, *it
, it2data
);
9016 it2
.max_ascent
= it2
.max_descent
= 0;
9019 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9020 MOVE_TO_POS
| MOVE_TO_VPOS
);
9022 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9023 /* If we are in a display string which starts at START_POS,
9024 and that display string includes a newline, and we are
9025 right after that newline (i.e. at the beginning of a
9026 display line), exit the loop, because otherwise we will
9027 infloop, since move_it_to will see that it is already at
9028 START_POS and will not move. */
9029 || (it2
.method
== GET_FROM_STRING
9030 && IT_CHARPOS (it2
) == start_pos
9031 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9032 eassert (IT_CHARPOS (*it
) >= BEGV
);
9033 SAVE_IT (it3
, it2
, it3data
);
9035 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9036 eassert (IT_CHARPOS (*it
) >= BEGV
);
9037 /* H is the actual vertical distance from the position in *IT
9038 and the starting position. */
9039 h
= it2
.current_y
- it
->current_y
;
9040 /* NLINES is the distance in number of lines. */
9041 nlines
= it2
.vpos
- it
->vpos
;
9043 /* Correct IT's y and vpos position
9044 so that they are relative to the starting point. */
9050 /* DY == 0 means move to the start of the screen line. The
9051 value of nlines is > 0 if continuation lines were involved,
9052 or if the original IT position was at start of a line. */
9053 RESTORE_IT (it
, it
, it2data
);
9055 move_it_by_lines (it
, nlines
);
9056 /* The above code moves us to some position NLINES down,
9057 usually to its first glyph (leftmost in an L2R line), but
9058 that's not necessarily the start of the line, under bidi
9059 reordering. We want to get to the character position
9060 that is immediately after the newline of the previous
9063 && !it
->continuation_lines_width
9064 && !STRINGP (it
->string
)
9065 && IT_CHARPOS (*it
) > BEGV
9066 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9068 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9071 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9072 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9074 bidi_unshelve_cache (it3data
, 1);
9078 /* The y-position we try to reach, relative to *IT.
9079 Note that H has been subtracted in front of the if-statement. */
9080 int target_y
= it
->current_y
+ h
- dy
;
9081 int y0
= it3
.current_y
;
9085 RESTORE_IT (&it3
, &it3
, it3data
);
9086 y1
= line_bottom_y (&it3
);
9087 line_height
= y1
- y0
;
9088 RESTORE_IT (it
, it
, it2data
);
9089 /* If we did not reach target_y, try to move further backward if
9090 we can. If we moved too far backward, try to move forward. */
9091 if (target_y
< it
->current_y
9092 /* This is heuristic. In a window that's 3 lines high, with
9093 a line height of 13 pixels each, recentering with point
9094 on the bottom line will try to move -39/2 = 19 pixels
9095 backward. Try to avoid moving into the first line. */
9096 && (it
->current_y
- target_y
9097 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9098 && IT_CHARPOS (*it
) > BEGV
)
9100 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9101 target_y
- it
->current_y
));
9102 dy
= it
->current_y
- target_y
;
9103 goto move_further_back
;
9105 else if (target_y
>= it
->current_y
+ line_height
9106 && IT_CHARPOS (*it
) < ZV
)
9108 /* Should move forward by at least one line, maybe more.
9110 Note: Calling move_it_by_lines can be expensive on
9111 terminal frames, where compute_motion is used (via
9112 vmotion) to do the job, when there are very long lines
9113 and truncate-lines is nil. That's the reason for
9114 treating terminal frames specially here. */
9116 if (!FRAME_WINDOW_P (it
->f
))
9117 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9122 move_it_by_lines (it
, 1);
9124 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9131 /* Move IT by a specified amount of pixel lines DY. DY negative means
9132 move backwards. DY = 0 means move to start of screen line. At the
9133 end, IT will be on the start of a screen line. */
9136 move_it_vertically (struct it
*it
, int dy
)
9139 move_it_vertically_backward (it
, -dy
);
9142 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9143 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9144 MOVE_TO_POS
| MOVE_TO_Y
);
9145 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9147 /* If buffer ends in ZV without a newline, move to the start of
9148 the line to satisfy the post-condition. */
9149 if (IT_CHARPOS (*it
) == ZV
9151 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9152 move_it_by_lines (it
, 0);
9157 /* Move iterator IT past the end of the text line it is in. */
9160 move_it_past_eol (struct it
*it
)
9162 enum move_it_result rc
;
9164 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9165 if (rc
== MOVE_NEWLINE_OR_CR
)
9166 set_iterator_to_next (it
, 0);
9170 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9171 negative means move up. DVPOS == 0 means move to the start of the
9174 Optimization idea: If we would know that IT->f doesn't use
9175 a face with proportional font, we could be faster for
9176 truncate-lines nil. */
9179 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9182 /* The commented-out optimization uses vmotion on terminals. This
9183 gives bad results, because elements like it->what, on which
9184 callers such as pos_visible_p rely, aren't updated. */
9185 /* struct position pos;
9186 if (!FRAME_WINDOW_P (it->f))
9188 struct text_pos textpos;
9190 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9191 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9192 reseat (it, textpos, 1);
9193 it->vpos += pos.vpos;
9194 it->current_y += pos.vpos;
9200 /* DVPOS == 0 means move to the start of the screen line. */
9201 move_it_vertically_backward (it
, 0);
9202 /* Let next call to line_bottom_y calculate real line height */
9207 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9208 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9210 /* Only move to the next buffer position if we ended up in a
9211 string from display property, not in an overlay string
9212 (before-string or after-string). That is because the
9213 latter don't conceal the underlying buffer position, so
9214 we can ask to move the iterator to the exact position we
9215 are interested in. Note that, even if we are already at
9216 IT_CHARPOS (*it), the call below is not a no-op, as it
9217 will detect that we are at the end of the string, pop the
9218 iterator, and compute it->current_x and it->hpos
9220 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9221 -1, -1, -1, MOVE_TO_POS
);
9227 void *it2data
= NULL
;
9228 ptrdiff_t start_charpos
, i
;
9230 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9231 ptrdiff_t pos_limit
;
9233 /* Start at the beginning of the screen line containing IT's
9234 position. This may actually move vertically backwards,
9235 in case of overlays, so adjust dvpos accordingly. */
9237 move_it_vertically_backward (it
, 0);
9240 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9241 screen lines, and reseat the iterator there. */
9242 start_charpos
= IT_CHARPOS (*it
);
9243 if (it
->line_wrap
== TRUNCATE
)
9246 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9247 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9248 back_to_previous_visible_line_start (it
);
9249 reseat (it
, it
->current
.pos
, 1);
9251 /* Move further back if we end up in a string or an image. */
9252 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9254 /* First try to move to start of display line. */
9256 move_it_vertically_backward (it
, 0);
9258 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9260 /* If start of line is still in string or image,
9261 move further back. */
9262 back_to_previous_visible_line_start (it
);
9263 reseat (it
, it
->current
.pos
, 1);
9267 it
->current_x
= it
->hpos
= 0;
9269 /* Above call may have moved too far if continuation lines
9270 are involved. Scan forward and see if it did. */
9271 SAVE_IT (it2
, *it
, it2data
);
9272 it2
.vpos
= it2
.current_y
= 0;
9273 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9274 it
->vpos
-= it2
.vpos
;
9275 it
->current_y
-= it2
.current_y
;
9276 it
->current_x
= it
->hpos
= 0;
9278 /* If we moved too far back, move IT some lines forward. */
9279 if (it2
.vpos
> -dvpos
)
9281 int delta
= it2
.vpos
+ dvpos
;
9283 RESTORE_IT (&it2
, &it2
, it2data
);
9284 SAVE_IT (it2
, *it
, it2data
);
9285 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9286 /* Move back again if we got too far ahead. */
9287 if (IT_CHARPOS (*it
) >= start_charpos
)
9288 RESTORE_IT (it
, &it2
, it2data
);
9290 bidi_unshelve_cache (it2data
, 1);
9293 RESTORE_IT (it
, it
, it2data
);
9297 /* Return 1 if IT points into the middle of a display vector. */
9300 in_display_vector_p (struct it
*it
)
9302 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9303 && it
->current
.dpvec_index
> 0
9304 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9308 /***********************************************************************
9310 ***********************************************************************/
9313 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9317 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9319 Lisp_Object args
[3];
9320 Lisp_Object msg
, fmt
;
9323 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9327 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9329 args
[0] = fmt
= build_string (format
);
9332 msg
= Fformat (3, args
);
9334 len
= SBYTES (msg
) + 1;
9335 buffer
= SAFE_ALLOCA (len
);
9336 memcpy (buffer
, SDATA (msg
), len
);
9338 message_dolog (buffer
, len
- 1, 1, 0);
9345 /* Output a newline in the *Messages* buffer if "needs" one. */
9348 message_log_maybe_newline (void)
9350 if (message_log_need_newline
)
9351 message_dolog ("", 0, 1, 0);
9355 /* Add a string M of length NBYTES to the message log, optionally
9356 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9357 true, means interpret the contents of M as multibyte. This
9358 function calls low-level routines in order to bypass text property
9359 hooks, etc. which might not be safe to run.
9361 This may GC (insert may run before/after change hooks),
9362 so the buffer M must NOT point to a Lisp string. */
9365 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9367 const unsigned char *msg
= (const unsigned char *) m
;
9369 if (!NILP (Vmemory_full
))
9372 if (!NILP (Vmessage_log_max
))
9374 struct buffer
*oldbuf
;
9375 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9376 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9377 ptrdiff_t point_at_end
= 0;
9378 ptrdiff_t zv_at_end
= 0;
9379 Lisp_Object old_deactivate_mark
;
9381 struct gcpro gcpro1
;
9383 old_deactivate_mark
= Vdeactivate_mark
;
9384 oldbuf
= current_buffer
;
9385 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9386 bset_undo_list (current_buffer
, Qt
);
9388 oldpoint
= message_dolog_marker1
;
9389 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9390 oldbegv
= message_dolog_marker2
;
9391 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9392 oldzv
= message_dolog_marker3
;
9393 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9394 GCPRO1 (old_deactivate_mark
);
9402 BEGV_BYTE
= BEG_BYTE
;
9405 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9407 /* Insert the string--maybe converting multibyte to single byte
9408 or vice versa, so that all the text fits the buffer. */
9410 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9416 /* Convert a multibyte string to single-byte
9417 for the *Message* buffer. */
9418 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9420 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9421 work
[0] = (ASCII_CHAR_P (c
)
9423 : multibyte_char_to_unibyte (c
));
9424 insert_1_both (work
, 1, 1, 1, 0, 0);
9427 else if (! multibyte
9428 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9432 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9433 /* Convert a single-byte string to multibyte
9434 for the *Message* buffer. */
9435 for (i
= 0; i
< nbytes
; i
++)
9438 MAKE_CHAR_MULTIBYTE (c
);
9439 char_bytes
= CHAR_STRING (c
, str
);
9440 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9444 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
9448 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9451 insert_1_both ("\n", 1, 1, 1, 0, 0);
9453 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9455 this_bol_byte
= PT_BYTE
;
9457 /* See if this line duplicates the previous one.
9458 If so, combine duplicates. */
9461 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9463 prev_bol_byte
= PT_BYTE
;
9465 dups
= message_log_check_duplicate (prev_bol_byte
,
9469 del_range_both (prev_bol
, prev_bol_byte
,
9470 this_bol
, this_bol_byte
, 0);
9473 char dupstr
[sizeof " [ times]"
9474 + INT_STRLEN_BOUND (printmax_t
)];
9476 /* If you change this format, don't forget to also
9477 change message_log_check_duplicate. */
9478 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9479 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9480 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
9485 /* If we have more than the desired maximum number of lines
9486 in the *Messages* buffer now, delete the oldest ones.
9487 This is safe because we don't have undo in this buffer. */
9489 if (NATNUMP (Vmessage_log_max
))
9491 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9492 -XFASTINT (Vmessage_log_max
) - 1, 0);
9493 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9496 BEGV
= marker_position (oldbegv
);
9497 BEGV_BYTE
= marker_byte_position (oldbegv
);
9506 ZV
= marker_position (oldzv
);
9507 ZV_BYTE
= marker_byte_position (oldzv
);
9511 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9513 /* We can't do Fgoto_char (oldpoint) because it will run some
9515 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
9516 marker_byte_position (oldpoint
));
9519 unchain_marker (XMARKER (oldpoint
));
9520 unchain_marker (XMARKER (oldbegv
));
9521 unchain_marker (XMARKER (oldzv
));
9523 shown
= buffer_window_count (current_buffer
) > 0;
9524 set_buffer_internal (oldbuf
);
9526 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9527 message_log_need_newline
= !nlflag
;
9528 Vdeactivate_mark
= old_deactivate_mark
;
9533 /* We are at the end of the buffer after just having inserted a newline.
9534 (Note: We depend on the fact we won't be crossing the gap.)
9535 Check to see if the most recent message looks a lot like the previous one.
9536 Return 0 if different, 1 if the new one should just replace it, or a
9537 value N > 1 if we should also append " [N times]". */
9540 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9543 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9545 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9546 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9548 for (i
= 0; i
< len
; i
++)
9550 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
9558 if (*p1
++ == ' ' && *p1
++ == '[')
9561 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9562 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9569 /* Display an echo area message M with a specified length of NBYTES
9570 bytes. The string may include null characters. If M is not a
9571 string, clear out any existing message, and let the mini-buffer
9574 This function cancels echoing. */
9577 message3 (Lisp_Object m
)
9579 struct gcpro gcpro1
;
9582 clear_message (1,1);
9585 /* First flush out any partial line written with print. */
9586 message_log_maybe_newline ();
9589 ptrdiff_t nbytes
= SBYTES (m
);
9590 bool multibyte
= STRING_MULTIBYTE (m
);
9592 char *buffer
= SAFE_ALLOCA (nbytes
);
9593 memcpy (buffer
, SDATA (m
), nbytes
);
9594 message_dolog (buffer
, nbytes
, 1, multibyte
);
9603 /* The non-logging version of message3.
9604 This does not cancel echoing, because it is used for echoing.
9605 Perhaps we need to make a separate function for echoing
9606 and make this cancel echoing. */
9609 message3_nolog (Lisp_Object m
)
9611 struct frame
*sf
= SELECTED_FRAME ();
9613 if (FRAME_INITIAL_P (sf
))
9615 if (noninteractive_need_newline
)
9616 putc ('\n', stderr
);
9617 noninteractive_need_newline
= 0;
9619 fwrite (SDATA (m
), SBYTES (m
), 1, stderr
);
9620 if (cursor_in_echo_area
== 0)
9621 fprintf (stderr
, "\n");
9624 /* Error messages get reported properly by cmd_error, so this must be just an
9625 informative message; if the frame hasn't really been initialized yet, just
9627 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
9629 /* Get the frame containing the mini-buffer
9630 that the selected frame is using. */
9631 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9632 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
9633 struct frame
*f
= XFRAME (frame
);
9635 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
9636 Fmake_frame_visible (frame
);
9638 if (STRINGP (m
) && SCHARS (m
) > 0)
9641 if (minibuffer_auto_raise
)
9642 Fraise_frame (frame
);
9643 /* Assume we are not echoing.
9644 (If we are, echo_now will override this.) */
9645 echo_message_buffer
= Qnil
;
9648 clear_message (1, 1);
9650 do_pending_window_change (0);
9651 echo_area_display (1);
9652 do_pending_window_change (0);
9653 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
9654 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9659 /* Display a null-terminated echo area message M. If M is 0, clear
9660 out any existing message, and let the mini-buffer text show through.
9662 The buffer M must continue to exist until after the echo area gets
9663 cleared or some other message gets displayed there. Do not pass
9664 text that is stored in a Lisp string. Do not pass text in a buffer
9665 that was alloca'd. */
9668 message1 (const char *m
)
9670 message3 (m
? make_unibyte_string (m
, strlen (m
)) : Qnil
);
9674 /* The non-logging counterpart of message1. */
9677 message1_nolog (const char *m
)
9679 message3_nolog (m
? make_unibyte_string (m
, strlen (m
)) : Qnil
);
9682 /* Display a message M which contains a single %s
9683 which gets replaced with STRING. */
9686 message_with_string (const char *m
, Lisp_Object string
, int log
)
9688 CHECK_STRING (string
);
9694 if (noninteractive_need_newline
)
9695 putc ('\n', stderr
);
9696 noninteractive_need_newline
= 0;
9697 fprintf (stderr
, m
, SDATA (string
));
9698 if (!cursor_in_echo_area
)
9699 fprintf (stderr
, "\n");
9703 else if (INTERACTIVE
)
9705 /* The frame whose minibuffer we're going to display the message on.
9706 It may be larger than the selected frame, so we need
9707 to use its buffer, not the selected frame's buffer. */
9708 Lisp_Object mini_window
;
9709 struct frame
*f
, *sf
= SELECTED_FRAME ();
9711 /* Get the frame containing the minibuffer
9712 that the selected frame is using. */
9713 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9714 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9716 /* Error messages get reported properly by cmd_error, so this must be
9717 just an informative message; if the frame hasn't really been
9718 initialized yet, just toss it. */
9719 if (f
->glyphs_initialized_p
)
9721 Lisp_Object args
[2], msg
;
9722 struct gcpro gcpro1
, gcpro2
;
9724 args
[0] = build_string (m
);
9725 args
[1] = msg
= string
;
9726 GCPRO2 (args
[0], msg
);
9729 msg
= Fformat (2, args
);
9734 message3_nolog (msg
);
9738 /* Print should start at the beginning of the message
9739 buffer next time. */
9740 message_buf_print
= 0;
9746 /* Dump an informative message to the minibuf. If M is 0, clear out
9747 any existing message, and let the mini-buffer text show through. */
9750 vmessage (const char *m
, va_list ap
)
9756 if (noninteractive_need_newline
)
9757 putc ('\n', stderr
);
9758 noninteractive_need_newline
= 0;
9759 vfprintf (stderr
, m
, ap
);
9760 if (cursor_in_echo_area
== 0)
9761 fprintf (stderr
, "\n");
9765 else if (INTERACTIVE
)
9767 /* The frame whose mini-buffer we're going to display the message
9768 on. It may be larger than the selected frame, so we need to
9769 use its buffer, not the selected frame's buffer. */
9770 Lisp_Object mini_window
;
9771 struct frame
*f
, *sf
= SELECTED_FRAME ();
9773 /* Get the frame containing the mini-buffer
9774 that the selected frame is using. */
9775 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9776 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9778 /* Error messages get reported properly by cmd_error, so this must be
9779 just an informative message; if the frame hasn't really been
9780 initialized yet, just toss it. */
9781 if (f
->glyphs_initialized_p
)
9786 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
9787 char *message_buf
= alloca (maxsize
+ 1);
9789 len
= doprnt (message_buf
, maxsize
, m
, (char *)0, ap
);
9791 message3 (make_string (message_buf
, len
));
9796 /* Print should start at the beginning of the message
9797 buffer next time. */
9798 message_buf_print
= 0;
9804 message (const char *m
, ...)
9814 /* The non-logging version of message. */
9817 message_nolog (const char *m
, ...)
9819 Lisp_Object old_log_max
;
9822 old_log_max
= Vmessage_log_max
;
9823 Vmessage_log_max
= Qnil
;
9825 Vmessage_log_max
= old_log_max
;
9831 /* Display the current message in the current mini-buffer. This is
9832 only called from error handlers in process.c, and is not time
9836 update_echo_area (void)
9838 if (!NILP (echo_area_buffer
[0]))
9841 string
= Fcurrent_message ();
9847 /* Make sure echo area buffers in `echo_buffers' are live.
9848 If they aren't, make new ones. */
9851 ensure_echo_area_buffers (void)
9855 for (i
= 0; i
< 2; ++i
)
9856 if (!BUFFERP (echo_buffer
[i
])
9857 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
9860 Lisp_Object old_buffer
;
9863 old_buffer
= echo_buffer
[i
];
9864 echo_buffer
[i
] = Fget_buffer_create
9865 (make_formatted_string (name
, " *Echo Area %d*", i
));
9866 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
9867 /* to force word wrap in echo area -
9868 it was decided to postpone this*/
9869 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9871 for (j
= 0; j
< 2; ++j
)
9872 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9873 echo_area_buffer
[j
] = echo_buffer
[i
];
9878 /* Call FN with args A1..A2 with either the current or last displayed
9879 echo_area_buffer as current buffer.
9881 WHICH zero means use the current message buffer
9882 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9883 from echo_buffer[] and clear it.
9885 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9886 suitable buffer from echo_buffer[] and clear it.
9888 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9889 that the current message becomes the last displayed one, make
9890 choose a suitable buffer for echo_area_buffer[0], and clear it.
9892 Value is what FN returns. */
9895 with_echo_area_buffer (struct window
*w
, int which
,
9896 int (*fn
) (ptrdiff_t, Lisp_Object
),
9897 ptrdiff_t a1
, Lisp_Object a2
)
9900 int this_one
, the_other
, clear_buffer_p
, rc
;
9901 ptrdiff_t count
= SPECPDL_INDEX ();
9903 /* If buffers aren't live, make new ones. */
9904 ensure_echo_area_buffers ();
9909 this_one
= 0, the_other
= 1;
9911 this_one
= 1, the_other
= 0;
9914 this_one
= 0, the_other
= 1;
9917 /* We need a fresh one in case the current echo buffer equals
9918 the one containing the last displayed echo area message. */
9919 if (!NILP (echo_area_buffer
[this_one
])
9920 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9921 echo_area_buffer
[this_one
] = Qnil
;
9924 /* Choose a suitable buffer from echo_buffer[] is we don't
9926 if (NILP (echo_area_buffer
[this_one
]))
9928 echo_area_buffer
[this_one
]
9929 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9930 ? echo_buffer
[the_other
]
9931 : echo_buffer
[this_one
]);
9935 buffer
= echo_area_buffer
[this_one
];
9937 /* Don't get confused by reusing the buffer used for echoing
9938 for a different purpose. */
9939 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9942 record_unwind_protect (unwind_with_echo_area_buffer
,
9943 with_echo_area_buffer_unwind_data (w
));
9945 /* Make the echo area buffer current. Note that for display
9946 purposes, it is not necessary that the displayed window's buffer
9947 == current_buffer, except for text property lookup. So, let's
9948 only set that buffer temporarily here without doing a full
9949 Fset_window_buffer. We must also change w->pointm, though,
9950 because otherwise an assertions in unshow_buffer fails, and Emacs
9952 set_buffer_internal_1 (XBUFFER (buffer
));
9955 wset_buffer (w
, buffer
);
9956 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9959 bset_undo_list (current_buffer
, Qt
);
9960 bset_read_only (current_buffer
, Qnil
);
9961 specbind (Qinhibit_read_only
, Qt
);
9962 specbind (Qinhibit_modification_hooks
, Qt
);
9964 if (clear_buffer_p
&& Z
> BEG
)
9967 eassert (BEGV
>= BEG
);
9968 eassert (ZV
<= Z
&& ZV
>= BEGV
);
9972 eassert (BEGV
>= BEG
);
9973 eassert (ZV
<= Z
&& ZV
>= BEGV
);
9975 unbind_to (count
, Qnil
);
9980 /* Save state that should be preserved around the call to the function
9981 FN called in with_echo_area_buffer. */
9984 with_echo_area_buffer_unwind_data (struct window
*w
)
9987 Lisp_Object vector
, tmp
;
9989 /* Reduce consing by keeping one vector in
9990 Vwith_echo_area_save_vector. */
9991 vector
= Vwith_echo_area_save_vector
;
9992 Vwith_echo_area_save_vector
= Qnil
;
9995 vector
= Fmake_vector (make_number (9), Qnil
);
9997 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9998 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9999 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10003 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10004 ASET (vector
, i
, w
->contents
); ++i
;
10005 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10006 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10007 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10008 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10013 for (; i
< end
; ++i
)
10014 ASET (vector
, i
, Qnil
);
10017 eassert (i
== ASIZE (vector
));
10022 /* Restore global state from VECTOR which was created by
10023 with_echo_area_buffer_unwind_data. */
10026 unwind_with_echo_area_buffer (Lisp_Object vector
)
10028 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10029 Vdeactivate_mark
= AREF (vector
, 1);
10030 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10032 if (WINDOWP (AREF (vector
, 3)))
10035 Lisp_Object buffer
;
10037 w
= XWINDOW (AREF (vector
, 3));
10038 buffer
= AREF (vector
, 4);
10040 wset_buffer (w
, buffer
);
10041 set_marker_both (w
->pointm
, buffer
,
10042 XFASTINT (AREF (vector
, 5)),
10043 XFASTINT (AREF (vector
, 6)));
10044 set_marker_both (w
->start
, buffer
,
10045 XFASTINT (AREF (vector
, 7)),
10046 XFASTINT (AREF (vector
, 8)));
10049 Vwith_echo_area_save_vector
= vector
;
10054 /* Set up the echo area for use by print functions. MULTIBYTE_P
10055 non-zero means we will print multibyte. */
10058 setup_echo_area_for_printing (int multibyte_p
)
10060 /* If we can't find an echo area any more, exit. */
10061 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10062 Fkill_emacs (Qnil
);
10064 ensure_echo_area_buffers ();
10066 if (!message_buf_print
)
10068 /* A message has been output since the last time we printed.
10069 Choose a fresh echo area buffer. */
10070 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10071 echo_area_buffer
[0] = echo_buffer
[1];
10073 echo_area_buffer
[0] = echo_buffer
[0];
10075 /* Switch to that buffer and clear it. */
10076 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10077 bset_truncate_lines (current_buffer
, Qnil
);
10081 ptrdiff_t count
= SPECPDL_INDEX ();
10082 specbind (Qinhibit_read_only
, Qt
);
10083 /* Note that undo recording is always disabled. */
10084 del_range (BEG
, Z
);
10085 unbind_to (count
, Qnil
);
10087 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10089 /* Set up the buffer for the multibyteness we need. */
10091 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10092 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10094 /* Raise the frame containing the echo area. */
10095 if (minibuffer_auto_raise
)
10097 struct frame
*sf
= SELECTED_FRAME ();
10098 Lisp_Object mini_window
;
10099 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10100 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10103 message_log_maybe_newline ();
10104 message_buf_print
= 1;
10108 if (NILP (echo_area_buffer
[0]))
10110 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10111 echo_area_buffer
[0] = echo_buffer
[1];
10113 echo_area_buffer
[0] = echo_buffer
[0];
10116 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10118 /* Someone switched buffers between print requests. */
10119 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10120 bset_truncate_lines (current_buffer
, Qnil
);
10126 /* Display an echo area message in window W. Value is non-zero if W's
10127 height is changed. If display_last_displayed_message_p is
10128 non-zero, display the message that was last displayed, otherwise
10129 display the current message. */
10132 display_echo_area (struct window
*w
)
10134 int i
, no_message_p
, window_height_changed_p
;
10136 /* Temporarily disable garbage collections while displaying the echo
10137 area. This is done because a GC can print a message itself.
10138 That message would modify the echo area buffer's contents while a
10139 redisplay of the buffer is going on, and seriously confuse
10141 ptrdiff_t count
= inhibit_garbage_collection ();
10143 /* If there is no message, we must call display_echo_area_1
10144 nevertheless because it resizes the window. But we will have to
10145 reset the echo_area_buffer in question to nil at the end because
10146 with_echo_area_buffer will sets it to an empty buffer. */
10147 i
= display_last_displayed_message_p
? 1 : 0;
10148 no_message_p
= NILP (echo_area_buffer
[i
]);
10150 window_height_changed_p
10151 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10152 display_echo_area_1
,
10153 (intptr_t) w
, Qnil
);
10156 echo_area_buffer
[i
] = Qnil
;
10158 unbind_to (count
, Qnil
);
10159 return window_height_changed_p
;
10163 /* Helper for display_echo_area. Display the current buffer which
10164 contains the current echo area message in window W, a mini-window,
10165 a pointer to which is passed in A1. A2..A4 are currently not used.
10166 Change the height of W so that all of the message is displayed.
10167 Value is non-zero if height of W was changed. */
10170 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10173 struct window
*w
= (struct window
*) i1
;
10174 Lisp_Object window
;
10175 struct text_pos start
;
10176 int window_height_changed_p
= 0;
10178 /* Do this before displaying, so that we have a large enough glyph
10179 matrix for the display. If we can't get enough space for the
10180 whole text, display the last N lines. That works by setting w->start. */
10181 window_height_changed_p
= resize_mini_window (w
, 0);
10183 /* Use the starting position chosen by resize_mini_window. */
10184 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10187 clear_glyph_matrix (w
->desired_matrix
);
10188 XSETWINDOW (window
, w
);
10189 try_window (window
, start
, 0);
10191 return window_height_changed_p
;
10195 /* Resize the echo area window to exactly the size needed for the
10196 currently displayed message, if there is one. If a mini-buffer
10197 is active, don't shrink it. */
10200 resize_echo_area_exactly (void)
10202 if (BUFFERP (echo_area_buffer
[0])
10203 && WINDOWP (echo_area_window
))
10205 struct window
*w
= XWINDOW (echo_area_window
);
10207 Lisp_Object resize_exactly
;
10209 if (minibuf_level
== 0)
10210 resize_exactly
= Qt
;
10212 resize_exactly
= Qnil
;
10214 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10215 (intptr_t) w
, resize_exactly
);
10218 ++windows_or_buffers_changed
;
10219 ++update_mode_lines
;
10220 redisplay_internal ();
10226 /* Callback function for with_echo_area_buffer, when used from
10227 resize_echo_area_exactly. A1 contains a pointer to the window to
10228 resize, EXACTLY non-nil means resize the mini-window exactly to the
10229 size of the text displayed. A3 and A4 are not used. Value is what
10230 resize_mini_window returns. */
10233 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10236 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10240 /* Resize mini-window W to fit the size of its contents. EXACT_P
10241 means size the window exactly to the size needed. Otherwise, it's
10242 only enlarged until W's buffer is empty.
10244 Set W->start to the right place to begin display. If the whole
10245 contents fit, start at the beginning. Otherwise, start so as
10246 to make the end of the contents appear. This is particularly
10247 important for y-or-n-p, but seems desirable generally.
10249 Value is non-zero if the window height has been changed. */
10252 resize_mini_window (struct window
*w
, int exact_p
)
10254 struct frame
*f
= XFRAME (w
->frame
);
10255 int window_height_changed_p
= 0;
10257 eassert (MINI_WINDOW_P (w
));
10259 /* By default, start display at the beginning. */
10260 set_marker_both (w
->start
, w
->contents
,
10261 BUF_BEGV (XBUFFER (w
->contents
)),
10262 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10264 /* Don't resize windows while redisplaying a window; it would
10265 confuse redisplay functions when the size of the window they are
10266 displaying changes from under them. Such a resizing can happen,
10267 for instance, when which-func prints a long message while
10268 we are running fontification-functions. We're running these
10269 functions with safe_call which binds inhibit-redisplay to t. */
10270 if (!NILP (Vinhibit_redisplay
))
10273 /* Nil means don't try to resize. */
10274 if (NILP (Vresize_mini_windows
)
10275 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10278 if (!FRAME_MINIBUF_ONLY_P (f
))
10281 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10282 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10284 EMACS_INT max_height
;
10285 int unit
= FRAME_LINE_HEIGHT (f
);
10286 struct text_pos start
;
10287 struct buffer
*old_current_buffer
= NULL
;
10289 if (current_buffer
!= XBUFFER (w
->contents
))
10291 old_current_buffer
= current_buffer
;
10292 set_buffer_internal (XBUFFER (w
->contents
));
10295 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10297 /* Compute the max. number of lines specified by the user. */
10298 if (FLOATP (Vmax_mini_window_height
))
10299 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10300 else if (INTEGERP (Vmax_mini_window_height
))
10301 max_height
= XINT (Vmax_mini_window_height
);
10303 max_height
= total_height
/ 4;
10305 /* Correct that max. height if it's bogus. */
10306 max_height
= clip_to_bounds (1, max_height
, total_height
);
10308 /* Find out the height of the text in the window. */
10309 if (it
.line_wrap
== TRUNCATE
)
10314 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10315 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10316 height
= it
.current_y
+ last_height
;
10318 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10319 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10320 height
= (height
+ unit
- 1) / unit
;
10323 /* Compute a suitable window start. */
10324 if (height
> max_height
)
10326 height
= max_height
;
10327 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10328 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10329 start
= it
.current
.pos
;
10332 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10333 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10335 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10337 /* Let it grow only, until we display an empty message, in which
10338 case the window shrinks again. */
10339 if (height
> WINDOW_TOTAL_LINES (w
))
10341 int old_height
= WINDOW_TOTAL_LINES (w
);
10342 freeze_window_starts (f
, 1);
10343 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10344 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10346 else if (height
< WINDOW_TOTAL_LINES (w
)
10347 && (exact_p
|| BEGV
== ZV
))
10349 int old_height
= WINDOW_TOTAL_LINES (w
);
10350 freeze_window_starts (f
, 0);
10351 shrink_mini_window (w
);
10352 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10357 /* Always resize to exact size needed. */
10358 if (height
> WINDOW_TOTAL_LINES (w
))
10360 int old_height
= WINDOW_TOTAL_LINES (w
);
10361 freeze_window_starts (f
, 1);
10362 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10363 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10365 else if (height
< WINDOW_TOTAL_LINES (w
))
10367 int old_height
= WINDOW_TOTAL_LINES (w
);
10368 freeze_window_starts (f
, 0);
10369 shrink_mini_window (w
);
10373 freeze_window_starts (f
, 1);
10374 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10377 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10381 if (old_current_buffer
)
10382 set_buffer_internal (old_current_buffer
);
10385 return window_height_changed_p
;
10389 /* Value is the current message, a string, or nil if there is no
10390 current message. */
10393 current_message (void)
10397 if (!BUFFERP (echo_area_buffer
[0]))
10401 with_echo_area_buffer (0, 0, current_message_1
,
10402 (intptr_t) &msg
, Qnil
);
10404 echo_area_buffer
[0] = Qnil
;
10412 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10415 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10418 *msg
= make_buffer_string (BEG
, Z
, 1);
10425 /* Push the current message on Vmessage_stack for later restoration
10426 by restore_message. Value is non-zero if the current message isn't
10427 empty. This is a relatively infrequent operation, so it's not
10428 worth optimizing. */
10431 push_message (void)
10433 Lisp_Object msg
= current_message ();
10434 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10435 return STRINGP (msg
);
10439 /* Restore message display from the top of Vmessage_stack. */
10442 restore_message (void)
10444 eassert (CONSP (Vmessage_stack
));
10445 message3_nolog (XCAR (Vmessage_stack
));
10449 /* Handler for record_unwind_protect calling pop_message. */
10452 pop_message_unwind (Lisp_Object dummy
)
10458 /* Pop the top-most entry off Vmessage_stack. */
10463 eassert (CONSP (Vmessage_stack
));
10464 Vmessage_stack
= XCDR (Vmessage_stack
);
10468 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10469 exits. If the stack is not empty, we have a missing pop_message
10473 check_message_stack (void)
10475 if (!NILP (Vmessage_stack
))
10480 /* Truncate to NCHARS what will be displayed in the echo area the next
10481 time we display it---but don't redisplay it now. */
10484 truncate_echo_area (ptrdiff_t nchars
)
10487 echo_area_buffer
[0] = Qnil
;
10488 else if (!noninteractive
10490 && !NILP (echo_area_buffer
[0]))
10492 struct frame
*sf
= SELECTED_FRAME ();
10493 /* Error messages get reported properly by cmd_error, so this must be
10494 just an informative message; if the frame hasn't really been
10495 initialized yet, just toss it. */
10496 if (sf
->glyphs_initialized_p
)
10497 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
10502 /* Helper function for truncate_echo_area. Truncate the current
10503 message to at most NCHARS characters. */
10506 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
10508 if (BEG
+ nchars
< Z
)
10509 del_range (BEG
+ nchars
, Z
);
10511 echo_area_buffer
[0] = Qnil
;
10515 /* Set the current message to STRING. */
10518 set_message (Lisp_Object string
)
10520 eassert (STRINGP (string
));
10522 message_enable_multibyte
= STRING_MULTIBYTE (string
);
10524 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
10525 message_buf_print
= 0;
10526 help_echo_showing_p
= 0;
10528 if (STRINGP (Vdebug_on_message
)
10529 && STRINGP (string
)
10530 && fast_string_match (Vdebug_on_message
, string
) >= 0)
10531 call_debugger (list2 (Qerror
, string
));
10535 /* Helper function for set_message. First argument is ignored and second
10536 argument has the same meaning as for set_message.
10537 This function is called with the echo area buffer being current. */
10540 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
10542 eassert (STRINGP (string
));
10544 /* Change multibyteness of the echo buffer appropriately. */
10545 if (message_enable_multibyte
10546 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10547 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10549 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
10550 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10551 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
10553 /* Insert new message at BEG. */
10554 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10556 /* This function takes care of single/multibyte conversion.
10557 We just have to ensure that the echo area buffer has the right
10558 setting of enable_multibyte_characters. */
10559 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
10565 /* Clear messages. CURRENT_P non-zero means clear the current
10566 message. LAST_DISPLAYED_P non-zero means clear the message
10570 clear_message (int current_p
, int last_displayed_p
)
10574 echo_area_buffer
[0] = Qnil
;
10575 message_cleared_p
= 1;
10578 if (last_displayed_p
)
10579 echo_area_buffer
[1] = Qnil
;
10581 message_buf_print
= 0;
10584 /* Clear garbaged frames.
10586 This function is used where the old redisplay called
10587 redraw_garbaged_frames which in turn called redraw_frame which in
10588 turn called clear_frame. The call to clear_frame was a source of
10589 flickering. I believe a clear_frame is not necessary. It should
10590 suffice in the new redisplay to invalidate all current matrices,
10591 and ensure a complete redisplay of all windows. */
10594 clear_garbaged_frames (void)
10596 if (frame_garbaged
)
10598 Lisp_Object tail
, frame
;
10599 int changed_count
= 0;
10601 FOR_EACH_FRAME (tail
, frame
)
10603 struct frame
*f
= XFRAME (frame
);
10605 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10610 f
->force_flush_display_p
= 1;
10612 clear_current_matrices (f
);
10619 frame_garbaged
= 0;
10621 ++windows_or_buffers_changed
;
10626 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10627 is non-zero update selected_frame. Value is non-zero if the
10628 mini-windows height has been changed. */
10631 echo_area_display (int update_frame_p
)
10633 Lisp_Object mini_window
;
10636 int window_height_changed_p
= 0;
10637 struct frame
*sf
= SELECTED_FRAME ();
10639 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10640 w
= XWINDOW (mini_window
);
10641 f
= XFRAME (WINDOW_FRAME (w
));
10643 /* Don't display if frame is invisible or not yet initialized. */
10644 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10647 #ifdef HAVE_WINDOW_SYSTEM
10648 /* When Emacs starts, selected_frame may be the initial terminal
10649 frame. If we let this through, a message would be displayed on
10651 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10653 #endif /* HAVE_WINDOW_SYSTEM */
10655 /* Redraw garbaged frames. */
10656 clear_garbaged_frames ();
10658 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10660 echo_area_window
= mini_window
;
10661 window_height_changed_p
= display_echo_area (w
);
10662 w
->must_be_updated_p
= 1;
10664 /* Update the display, unless called from redisplay_internal.
10665 Also don't update the screen during redisplay itself. The
10666 update will happen at the end of redisplay, and an update
10667 here could cause confusion. */
10668 if (update_frame_p
&& !redisplaying_p
)
10672 /* If the display update has been interrupted by pending
10673 input, update mode lines in the frame. Due to the
10674 pending input, it might have been that redisplay hasn't
10675 been called, so that mode lines above the echo area are
10676 garbaged. This looks odd, so we prevent it here. */
10677 if (!display_completed
)
10678 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10680 if (window_height_changed_p
10681 /* Don't do this if Emacs is shutting down. Redisplay
10682 needs to run hooks. */
10683 && !NILP (Vrun_hooks
))
10685 /* Must update other windows. Likewise as in other
10686 cases, don't let this update be interrupted by
10688 ptrdiff_t count
= SPECPDL_INDEX ();
10689 specbind (Qredisplay_dont_pause
, Qt
);
10690 windows_or_buffers_changed
= 1;
10691 redisplay_internal ();
10692 unbind_to (count
, Qnil
);
10694 else if (FRAME_WINDOW_P (f
) && n
== 0)
10696 /* Window configuration is the same as before.
10697 Can do with a display update of the echo area,
10698 unless we displayed some mode lines. */
10699 update_single_window (w
, 1);
10700 FRAME_RIF (f
)->flush_display (f
);
10703 update_frame (f
, 1, 1);
10705 /* If cursor is in the echo area, make sure that the next
10706 redisplay displays the minibuffer, so that the cursor will
10707 be replaced with what the minibuffer wants. */
10708 if (cursor_in_echo_area
)
10709 ++windows_or_buffers_changed
;
10712 else if (!EQ (mini_window
, selected_window
))
10713 windows_or_buffers_changed
++;
10715 /* Last displayed message is now the current message. */
10716 echo_area_buffer
[1] = echo_area_buffer
[0];
10717 /* Inform read_char that we're not echoing. */
10718 echo_message_buffer
= Qnil
;
10720 /* Prevent redisplay optimization in redisplay_internal by resetting
10721 this_line_start_pos. This is done because the mini-buffer now
10722 displays the message instead of its buffer text. */
10723 if (EQ (mini_window
, selected_window
))
10724 CHARPOS (this_line_start_pos
) = 0;
10726 return window_height_changed_p
;
10729 /* Nonzero if the current window's buffer is shown in more than one
10730 window and was modified since last redisplay. */
10733 buffer_shared_and_changed (void)
10735 return (buffer_window_count (current_buffer
) > 1
10736 && UNCHANGED_MODIFIED
< MODIFF
);
10739 /* Nonzero if W doesn't reflect the actual state of current buffer due
10740 to its text or overlays change. FIXME: this may be called when
10741 XBUFFER (w->contents) != current_buffer, which looks suspicious. */
10744 window_outdated (struct window
*w
)
10746 return (w
->last_modified
< MODIFF
10747 || w
->last_overlay_modified
< OVERLAY_MODIFF
);
10750 /* Nonzero if W's buffer was changed but not saved or Transient Mark mode
10751 is enabled and mark of W's buffer was changed since last W's update. */
10754 window_buffer_changed (struct window
*w
)
10756 struct buffer
*b
= XBUFFER (w
->contents
);
10758 eassert (BUFFER_LIVE_P (b
));
10760 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
)
10761 || ((!NILP (Vtransient_mark_mode
) && !NILP (BVAR (b
, mark_active
)))
10762 != (w
->region_showing
!= 0)));
10765 /* Nonzero if W has %c in its mode line and mode line should be updated. */
10768 mode_line_update_needed (struct window
*w
)
10770 return (w
->column_number_displayed
!= -1
10771 && !(PT
== w
->last_point
&& !window_outdated (w
))
10772 && (w
->column_number_displayed
!= current_column ()));
10775 /***********************************************************************
10776 Mode Lines and Frame Titles
10777 ***********************************************************************/
10779 /* A buffer for constructing non-propertized mode-line strings and
10780 frame titles in it; allocated from the heap in init_xdisp and
10781 resized as needed in store_mode_line_noprop_char. */
10783 static char *mode_line_noprop_buf
;
10785 /* The buffer's end, and a current output position in it. */
10787 static char *mode_line_noprop_buf_end
;
10788 static char *mode_line_noprop_ptr
;
10790 #define MODE_LINE_NOPROP_LEN(start) \
10791 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10794 MODE_LINE_DISPLAY
= 0,
10798 } mode_line_target
;
10800 /* Alist that caches the results of :propertize.
10801 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10802 static Lisp_Object mode_line_proptrans_alist
;
10804 /* List of strings making up the mode-line. */
10805 static Lisp_Object mode_line_string_list
;
10807 /* Base face property when building propertized mode line string. */
10808 static Lisp_Object mode_line_string_face
;
10809 static Lisp_Object mode_line_string_face_prop
;
10812 /* Unwind data for mode line strings */
10814 static Lisp_Object Vmode_line_unwind_vector
;
10817 format_mode_line_unwind_data (struct frame
*target_frame
,
10818 struct buffer
*obuf
,
10820 int save_proptrans
)
10822 Lisp_Object vector
, tmp
;
10824 /* Reduce consing by keeping one vector in
10825 Vwith_echo_area_save_vector. */
10826 vector
= Vmode_line_unwind_vector
;
10827 Vmode_line_unwind_vector
= Qnil
;
10830 vector
= Fmake_vector (make_number (10), Qnil
);
10832 ASET (vector
, 0, make_number (mode_line_target
));
10833 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10834 ASET (vector
, 2, mode_line_string_list
);
10835 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10836 ASET (vector
, 4, mode_line_string_face
);
10837 ASET (vector
, 5, mode_line_string_face_prop
);
10840 XSETBUFFER (tmp
, obuf
);
10843 ASET (vector
, 6, tmp
);
10844 ASET (vector
, 7, owin
);
10847 /* Similarly to `with-selected-window', if the operation selects
10848 a window on another frame, we must restore that frame's
10849 selected window, and (for a tty) the top-frame. */
10850 ASET (vector
, 8, target_frame
->selected_window
);
10851 if (FRAME_TERMCAP_P (target_frame
))
10852 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
10859 unwind_format_mode_line (Lisp_Object vector
)
10861 Lisp_Object old_window
= AREF (vector
, 7);
10862 Lisp_Object target_frame_window
= AREF (vector
, 8);
10863 Lisp_Object old_top_frame
= AREF (vector
, 9);
10865 mode_line_target
= XINT (AREF (vector
, 0));
10866 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10867 mode_line_string_list
= AREF (vector
, 2);
10868 if (! EQ (AREF (vector
, 3), Qt
))
10869 mode_line_proptrans_alist
= AREF (vector
, 3);
10870 mode_line_string_face
= AREF (vector
, 4);
10871 mode_line_string_face_prop
= AREF (vector
, 5);
10873 /* Select window before buffer, since it may change the buffer. */
10874 if (!NILP (old_window
))
10876 /* If the operation that we are unwinding had selected a window
10877 on a different frame, reset its frame-selected-window. For a
10878 text terminal, reset its top-frame if necessary. */
10879 if (!NILP (target_frame_window
))
10882 = WINDOW_FRAME (XWINDOW (target_frame_window
));
10884 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
10885 Fselect_window (target_frame_window
, Qt
);
10887 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
10888 Fselect_frame (old_top_frame
, Qt
);
10891 Fselect_window (old_window
, Qt
);
10894 if (!NILP (AREF (vector
, 6)))
10896 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10897 ASET (vector
, 6, Qnil
);
10900 Vmode_line_unwind_vector
= vector
;
10905 /* Store a single character C for the frame title in mode_line_noprop_buf.
10906 Re-allocate mode_line_noprop_buf if necessary. */
10909 store_mode_line_noprop_char (char c
)
10911 /* If output position has reached the end of the allocated buffer,
10912 increase the buffer's size. */
10913 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10915 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10916 ptrdiff_t size
= len
;
10917 mode_line_noprop_buf
=
10918 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10919 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10920 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10923 *mode_line_noprop_ptr
++ = c
;
10927 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10928 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10929 characters that yield more columns than PRECISION; PRECISION <= 0
10930 means copy the whole string. Pad with spaces until FIELD_WIDTH
10931 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10932 pad. Called from display_mode_element when it is used to build a
10936 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10938 const unsigned char *str
= (const unsigned char *) string
;
10940 ptrdiff_t dummy
, nbytes
;
10942 /* Copy at most PRECISION chars from STR. */
10943 nbytes
= strlen (string
);
10944 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10946 store_mode_line_noprop_char (*str
++);
10948 /* Fill up with spaces until FIELD_WIDTH reached. */
10949 while (field_width
> 0
10950 && n
< field_width
)
10952 store_mode_line_noprop_char (' ');
10959 /***********************************************************************
10961 ***********************************************************************/
10963 #ifdef HAVE_WINDOW_SYSTEM
10965 /* Set the title of FRAME, if it has changed. The title format is
10966 Vicon_title_format if FRAME is iconified, otherwise it is
10967 frame_title_format. */
10970 x_consider_frame_title (Lisp_Object frame
)
10972 struct frame
*f
= XFRAME (frame
);
10974 if (FRAME_WINDOW_P (f
)
10975 || FRAME_MINIBUF_ONLY_P (f
)
10976 || f
->explicit_name
)
10978 /* Do we have more than one visible frame on this X display? */
10979 Lisp_Object tail
, other_frame
, fmt
;
10980 ptrdiff_t title_start
;
10984 ptrdiff_t count
= SPECPDL_INDEX ();
10986 FOR_EACH_FRAME (tail
, other_frame
)
10988 struct frame
*tf
= XFRAME (other_frame
);
10991 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10992 && !FRAME_MINIBUF_ONLY_P (tf
)
10993 && !EQ (other_frame
, tip_frame
)
10994 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10998 /* Set global variable indicating that multiple frames exist. */
10999 multiple_frames
= CONSP (tail
);
11001 /* Switch to the buffer of selected window of the frame. Set up
11002 mode_line_target so that display_mode_element will output into
11003 mode_line_noprop_buf; then display the title. */
11004 record_unwind_protect (unwind_format_mode_line
,
11005 format_mode_line_unwind_data
11006 (f
, current_buffer
, selected_window
, 0));
11008 Fselect_window (f
->selected_window
, Qt
);
11009 set_buffer_internal_1
11010 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11011 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11013 mode_line_target
= MODE_LINE_TITLE
;
11014 title_start
= MODE_LINE_NOPROP_LEN (0);
11015 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11016 NULL
, DEFAULT_FACE_ID
);
11017 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11018 len
= MODE_LINE_NOPROP_LEN (title_start
);
11019 title
= mode_line_noprop_buf
+ title_start
;
11020 unbind_to (count
, Qnil
);
11022 /* Set the title only if it's changed. This avoids consing in
11023 the common case where it hasn't. (If it turns out that we've
11024 already wasted too much time by walking through the list with
11025 display_mode_element, then we might need to optimize at a
11026 higher level than this.) */
11027 if (! STRINGP (f
->name
)
11028 || SBYTES (f
->name
) != len
11029 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11030 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11034 #endif /* not HAVE_WINDOW_SYSTEM */
11037 /***********************************************************************
11039 ***********************************************************************/
11042 /* Prepare for redisplay by updating menu-bar item lists when
11043 appropriate. This can call eval. */
11046 prepare_menu_bars (void)
11049 struct gcpro gcpro1
, gcpro2
;
11051 Lisp_Object tooltip_frame
;
11053 #ifdef HAVE_WINDOW_SYSTEM
11054 tooltip_frame
= tip_frame
;
11056 tooltip_frame
= Qnil
;
11059 /* Update all frame titles based on their buffer names, etc. We do
11060 this before the menu bars so that the buffer-menu will show the
11061 up-to-date frame titles. */
11062 #ifdef HAVE_WINDOW_SYSTEM
11063 if (windows_or_buffers_changed
|| update_mode_lines
)
11065 Lisp_Object tail
, frame
;
11067 FOR_EACH_FRAME (tail
, frame
)
11069 f
= XFRAME (frame
);
11070 if (!EQ (frame
, tooltip_frame
)
11071 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
11072 x_consider_frame_title (frame
);
11075 #endif /* HAVE_WINDOW_SYSTEM */
11077 /* Update the menu bar item lists, if appropriate. This has to be
11078 done before any actual redisplay or generation of display lines. */
11079 all_windows
= (update_mode_lines
11080 || buffer_shared_and_changed ()
11081 || windows_or_buffers_changed
);
11084 Lisp_Object tail
, frame
;
11085 ptrdiff_t count
= SPECPDL_INDEX ();
11086 /* 1 means that update_menu_bar has run its hooks
11087 so any further calls to update_menu_bar shouldn't do so again. */
11088 int menu_bar_hooks_run
= 0;
11090 record_unwind_save_match_data ();
11092 FOR_EACH_FRAME (tail
, frame
)
11094 f
= XFRAME (frame
);
11096 /* Ignore tooltip frame. */
11097 if (EQ (frame
, tooltip_frame
))
11100 /* If a window on this frame changed size, report that to
11101 the user and clear the size-change flag. */
11102 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11104 Lisp_Object functions
;
11106 /* Clear flag first in case we get an error below. */
11107 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11108 functions
= Vwindow_size_change_functions
;
11109 GCPRO2 (tail
, functions
);
11111 while (CONSP (functions
))
11113 if (!EQ (XCAR (functions
), Qt
))
11114 call1 (XCAR (functions
), frame
);
11115 functions
= XCDR (functions
);
11121 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11122 #ifdef HAVE_WINDOW_SYSTEM
11123 update_tool_bar (f
, 0);
11126 if (windows_or_buffers_changed
11129 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11134 unbind_to (count
, Qnil
);
11138 struct frame
*sf
= SELECTED_FRAME ();
11139 update_menu_bar (sf
, 1, 0);
11140 #ifdef HAVE_WINDOW_SYSTEM
11141 update_tool_bar (sf
, 1);
11147 /* Update the menu bar item list for frame F. This has to be done
11148 before we start to fill in any display lines, because it can call
11151 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11153 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11154 already ran the menu bar hooks for this redisplay, so there
11155 is no need to run them again. The return value is the
11156 updated value of this flag, to pass to the next call. */
11159 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11161 Lisp_Object window
;
11162 register struct window
*w
;
11164 /* If called recursively during a menu update, do nothing. This can
11165 happen when, for instance, an activate-menubar-hook causes a
11167 if (inhibit_menubar_update
)
11170 window
= FRAME_SELECTED_WINDOW (f
);
11171 w
= XWINDOW (window
);
11173 if (FRAME_WINDOW_P (f
)
11175 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11176 || defined (HAVE_NS) || defined (USE_GTK)
11177 FRAME_EXTERNAL_MENU_BAR (f
)
11179 FRAME_MENU_BAR_LINES (f
) > 0
11181 : FRAME_MENU_BAR_LINES (f
) > 0)
11183 /* If the user has switched buffers or windows, we need to
11184 recompute to reflect the new bindings. But we'll
11185 recompute when update_mode_lines is set too; that means
11186 that people can use force-mode-line-update to request
11187 that the menu bar be recomputed. The adverse effect on
11188 the rest of the redisplay algorithm is about the same as
11189 windows_or_buffers_changed anyway. */
11190 if (windows_or_buffers_changed
11191 /* This used to test w->update_mode_line, but we believe
11192 there is no need to recompute the menu in that case. */
11193 || update_mode_lines
11194 || window_buffer_changed (w
))
11196 struct buffer
*prev
= current_buffer
;
11197 ptrdiff_t count
= SPECPDL_INDEX ();
11199 specbind (Qinhibit_menubar_update
, Qt
);
11201 set_buffer_internal_1 (XBUFFER (w
->contents
));
11202 if (save_match_data
)
11203 record_unwind_save_match_data ();
11204 if (NILP (Voverriding_local_map_menu_flag
))
11206 specbind (Qoverriding_terminal_local_map
, Qnil
);
11207 specbind (Qoverriding_local_map
, Qnil
);
11212 /* Run the Lucid hook. */
11213 safe_run_hooks (Qactivate_menubar_hook
);
11215 /* If it has changed current-menubar from previous value,
11216 really recompute the menu-bar from the value. */
11217 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11218 call0 (Qrecompute_lucid_menubar
);
11220 safe_run_hooks (Qmenu_bar_update_hook
);
11225 XSETFRAME (Vmenu_updating_frame
, f
);
11226 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11228 /* Redisplay the menu bar in case we changed it. */
11229 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11230 || defined (HAVE_NS) || defined (USE_GTK)
11231 if (FRAME_WINDOW_P (f
))
11233 #if defined (HAVE_NS)
11234 /* All frames on Mac OS share the same menubar. So only
11235 the selected frame should be allowed to set it. */
11236 if (f
== SELECTED_FRAME ())
11238 set_frame_menubar (f
, 0, 0);
11241 /* On a terminal screen, the menu bar is an ordinary screen
11242 line, and this makes it get updated. */
11243 w
->update_mode_line
= 1;
11244 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11245 /* In the non-toolkit version, the menu bar is an ordinary screen
11246 line, and this makes it get updated. */
11247 w
->update_mode_line
= 1;
11248 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11250 unbind_to (count
, Qnil
);
11251 set_buffer_internal_1 (prev
);
11260 /***********************************************************************
11262 ***********************************************************************/
11264 #ifdef HAVE_WINDOW_SYSTEM
11267 Nominal cursor position -- where to draw output.
11268 HPOS and VPOS are window relative glyph matrix coordinates.
11269 X and Y are window relative pixel coordinates. */
11271 struct cursor_pos output_cursor
;
11275 Set the global variable output_cursor to CURSOR. All cursor
11276 positions are relative to updated_window. */
11279 set_output_cursor (struct cursor_pos
*cursor
)
11281 output_cursor
.hpos
= cursor
->hpos
;
11282 output_cursor
.vpos
= cursor
->vpos
;
11283 output_cursor
.x
= cursor
->x
;
11284 output_cursor
.y
= cursor
->y
;
11289 Set a nominal cursor position.
11291 HPOS and VPOS are column/row positions in a window glyph matrix. X
11292 and Y are window text area relative pixel positions.
11294 If this is done during an update, updated_window will contain the
11295 window that is being updated and the position is the future output
11296 cursor position for that window. If updated_window is null, use
11297 selected_window and display the cursor at the given position. */
11300 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11304 /* If updated_window is not set, work on selected_window. */
11305 if (updated_window
)
11306 w
= updated_window
;
11308 w
= XWINDOW (selected_window
);
11310 /* Set the output cursor. */
11311 output_cursor
.hpos
= hpos
;
11312 output_cursor
.vpos
= vpos
;
11313 output_cursor
.x
= x
;
11314 output_cursor
.y
= y
;
11316 /* If not called as part of an update, really display the cursor.
11317 This will also set the cursor position of W. */
11318 if (updated_window
== NULL
)
11321 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11322 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11323 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11328 #endif /* HAVE_WINDOW_SYSTEM */
11331 /***********************************************************************
11333 ***********************************************************************/
11335 #ifdef HAVE_WINDOW_SYSTEM
11337 /* Where the mouse was last time we reported a mouse event. */
11339 FRAME_PTR last_mouse_frame
;
11341 /* Tool-bar item index of the item on which a mouse button was pressed
11344 int last_tool_bar_item
;
11346 /* Select `frame' temporarily without running all the code in
11348 FIXME: Maybe do_switch_frame should be trimmed down similarly
11349 when `norecord' is set. */
11351 fast_set_selected_frame (Lisp_Object frame
)
11353 if (!EQ (selected_frame
, frame
))
11355 selected_frame
= frame
;
11356 selected_window
= XFRAME (frame
)->selected_window
;
11361 /* Update the tool-bar item list for frame F. This has to be done
11362 before we start to fill in any display lines. Called from
11363 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11364 and restore it here. */
11367 update_tool_bar (struct frame
*f
, int save_match_data
)
11369 #if defined (USE_GTK) || defined (HAVE_NS)
11370 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11372 int do_update
= WINDOWP (f
->tool_bar_window
)
11373 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11378 Lisp_Object window
;
11381 window
= FRAME_SELECTED_WINDOW (f
);
11382 w
= XWINDOW (window
);
11384 /* If the user has switched buffers or windows, we need to
11385 recompute to reflect the new bindings. But we'll
11386 recompute when update_mode_lines is set too; that means
11387 that people can use force-mode-line-update to request
11388 that the menu bar be recomputed. The adverse effect on
11389 the rest of the redisplay algorithm is about the same as
11390 windows_or_buffers_changed anyway. */
11391 if (windows_or_buffers_changed
11392 || w
->update_mode_line
11393 || update_mode_lines
11394 || window_buffer_changed (w
))
11396 struct buffer
*prev
= current_buffer
;
11397 ptrdiff_t count
= SPECPDL_INDEX ();
11398 Lisp_Object frame
, new_tool_bar
;
11399 int new_n_tool_bar
;
11400 struct gcpro gcpro1
;
11402 /* Set current_buffer to the buffer of the selected
11403 window of the frame, so that we get the right local
11405 set_buffer_internal_1 (XBUFFER (w
->contents
));
11407 /* Save match data, if we must. */
11408 if (save_match_data
)
11409 record_unwind_save_match_data ();
11411 /* Make sure that we don't accidentally use bogus keymaps. */
11412 if (NILP (Voverriding_local_map_menu_flag
))
11414 specbind (Qoverriding_terminal_local_map
, Qnil
);
11415 specbind (Qoverriding_local_map
, Qnil
);
11418 GCPRO1 (new_tool_bar
);
11420 /* We must temporarily set the selected frame to this frame
11421 before calling tool_bar_items, because the calculation of
11422 the tool-bar keymap uses the selected frame (see
11423 `tool-bar-make-keymap' in tool-bar.el). */
11424 eassert (EQ (selected_window
,
11425 /* Since we only explicitly preserve selected_frame,
11426 check that selected_window would be redundant. */
11427 XFRAME (selected_frame
)->selected_window
));
11428 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11429 XSETFRAME (frame
, f
);
11430 fast_set_selected_frame (frame
);
11432 /* Build desired tool-bar items from keymaps. */
11434 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11437 /* Redisplay the tool-bar if we changed it. */
11438 if (new_n_tool_bar
!= f
->n_tool_bar_items
11439 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11441 /* Redisplay that happens asynchronously due to an expose event
11442 may access f->tool_bar_items. Make sure we update both
11443 variables within BLOCK_INPUT so no such event interrupts. */
11445 fset_tool_bar_items (f
, new_tool_bar
);
11446 f
->n_tool_bar_items
= new_n_tool_bar
;
11447 w
->update_mode_line
= 1;
11453 unbind_to (count
, Qnil
);
11454 set_buffer_internal_1 (prev
);
11460 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11461 F's desired tool-bar contents. F->tool_bar_items must have
11462 been set up previously by calling prepare_menu_bars. */
11465 build_desired_tool_bar_string (struct frame
*f
)
11467 int i
, size
, size_needed
;
11468 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11469 Lisp_Object image
, plist
, props
;
11471 image
= plist
= props
= Qnil
;
11472 GCPRO3 (image
, plist
, props
);
11474 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11475 Otherwise, make a new string. */
11477 /* The size of the string we might be able to reuse. */
11478 size
= (STRINGP (f
->desired_tool_bar_string
)
11479 ? SCHARS (f
->desired_tool_bar_string
)
11482 /* We need one space in the string for each image. */
11483 size_needed
= f
->n_tool_bar_items
;
11485 /* Reuse f->desired_tool_bar_string, if possible. */
11486 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11487 fset_desired_tool_bar_string
11488 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11491 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11492 Fremove_text_properties (make_number (0), make_number (size
),
11493 props
, f
->desired_tool_bar_string
);
11496 /* Put a `display' property on the string for the images to display,
11497 put a `menu_item' property on tool-bar items with a value that
11498 is the index of the item in F's tool-bar item vector. */
11499 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11501 #define PROP(IDX) \
11502 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11504 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11505 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11506 int hmargin
, vmargin
, relief
, idx
, end
;
11508 /* If image is a vector, choose the image according to the
11510 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11511 if (VECTORP (image
))
11515 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11516 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11519 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11520 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11522 eassert (ASIZE (image
) >= idx
);
11523 image
= AREF (image
, idx
);
11528 /* Ignore invalid image specifications. */
11529 if (!valid_image_p (image
))
11532 /* Display the tool-bar button pressed, or depressed. */
11533 plist
= Fcopy_sequence (XCDR (image
));
11535 /* Compute margin and relief to draw. */
11536 relief
= (tool_bar_button_relief
>= 0
11537 ? tool_bar_button_relief
11538 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11539 hmargin
= vmargin
= relief
;
11541 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11542 INT_MAX
- max (hmargin
, vmargin
)))
11544 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11545 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11547 else if (CONSP (Vtool_bar_button_margin
))
11549 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11550 INT_MAX
- hmargin
))
11551 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11553 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11554 INT_MAX
- vmargin
))
11555 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11558 if (auto_raise_tool_bar_buttons_p
)
11560 /* Add a `:relief' property to the image spec if the item is
11564 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11571 /* If image is selected, display it pressed, i.e. with a
11572 negative relief. If it's not selected, display it with a
11574 plist
= Fplist_put (plist
, QCrelief
,
11576 ? make_number (-relief
)
11577 : make_number (relief
)));
11582 /* Put a margin around the image. */
11583 if (hmargin
|| vmargin
)
11585 if (hmargin
== vmargin
)
11586 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11588 plist
= Fplist_put (plist
, QCmargin
,
11589 Fcons (make_number (hmargin
),
11590 make_number (vmargin
)));
11593 /* If button is not enabled, and we don't have special images
11594 for the disabled state, make the image appear disabled by
11595 applying an appropriate algorithm to it. */
11596 if (!enabled_p
&& idx
< 0)
11597 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11599 /* Put a `display' text property on the string for the image to
11600 display. Put a `menu-item' property on the string that gives
11601 the start of this item's properties in the tool-bar items
11603 image
= Fcons (Qimage
, plist
);
11604 props
= list4 (Qdisplay
, image
,
11605 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11607 /* Let the last image hide all remaining spaces in the tool bar
11608 string. The string can be longer than needed when we reuse a
11609 previous string. */
11610 if (i
+ 1 == f
->n_tool_bar_items
)
11611 end
= SCHARS (f
->desired_tool_bar_string
);
11614 Fadd_text_properties (make_number (i
), make_number (end
),
11615 props
, f
->desired_tool_bar_string
);
11623 /* Display one line of the tool-bar of frame IT->f.
11625 HEIGHT specifies the desired height of the tool-bar line.
11626 If the actual height of the glyph row is less than HEIGHT, the
11627 row's height is increased to HEIGHT, and the icons are centered
11628 vertically in the new height.
11630 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11631 count a final empty row in case the tool-bar width exactly matches
11636 display_tool_bar_line (struct it
*it
, int height
)
11638 struct glyph_row
*row
= it
->glyph_row
;
11639 int max_x
= it
->last_visible_x
;
11640 struct glyph
*last
;
11642 prepare_desired_row (row
);
11643 row
->y
= it
->current_y
;
11645 /* Note that this isn't made use of if the face hasn't a box,
11646 so there's no need to check the face here. */
11647 it
->start_of_box_run_p
= 1;
11649 while (it
->current_x
< max_x
)
11651 int x
, n_glyphs_before
, i
, nglyphs
;
11652 struct it it_before
;
11654 /* Get the next display element. */
11655 if (!get_next_display_element (it
))
11657 /* Don't count empty row if we are counting needed tool-bar lines. */
11658 if (height
< 0 && !it
->hpos
)
11663 /* Produce glyphs. */
11664 n_glyphs_before
= row
->used
[TEXT_AREA
];
11667 PRODUCE_GLYPHS (it
);
11669 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11671 x
= it_before
.current_x
;
11672 while (i
< nglyphs
)
11674 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11676 if (x
+ glyph
->pixel_width
> max_x
)
11678 /* Glyph doesn't fit on line. Backtrack. */
11679 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11681 /* If this is the only glyph on this line, it will never fit on the
11682 tool-bar, so skip it. But ensure there is at least one glyph,
11683 so we don't accidentally disable the tool-bar. */
11684 if (n_glyphs_before
== 0
11685 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11691 x
+= glyph
->pixel_width
;
11695 /* Stop at line end. */
11696 if (ITERATOR_AT_END_OF_LINE_P (it
))
11699 set_iterator_to_next (it
, 1);
11704 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11706 /* Use default face for the border below the tool bar.
11708 FIXME: When auto-resize-tool-bars is grow-only, there is
11709 no additional border below the possibly empty tool-bar lines.
11710 So to make the extra empty lines look "normal", we have to
11711 use the tool-bar face for the border too. */
11712 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
11713 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11714 it
->face_id
= DEFAULT_FACE_ID
;
11716 extend_face_to_end_of_line (it
);
11717 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11718 last
->right_box_line_p
= 1;
11719 if (last
== row
->glyphs
[TEXT_AREA
])
11720 last
->left_box_line_p
= 1;
11722 /* Make line the desired height and center it vertically. */
11723 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11725 /* Don't add more than one line height. */
11726 height
%= FRAME_LINE_HEIGHT (it
->f
);
11727 it
->max_ascent
+= height
/ 2;
11728 it
->max_descent
+= (height
+ 1) / 2;
11731 compute_line_metrics (it
);
11733 /* If line is empty, make it occupy the rest of the tool-bar. */
11734 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
11736 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11737 row
->visible_height
= row
->height
;
11738 row
->ascent
= row
->phys_ascent
= 0;
11739 row
->extra_line_spacing
= 0;
11742 row
->full_width_p
= 1;
11743 row
->continued_p
= 0;
11744 row
->truncated_on_left_p
= 0;
11745 row
->truncated_on_right_p
= 0;
11747 it
->current_x
= it
->hpos
= 0;
11748 it
->current_y
+= row
->height
;
11754 /* Max tool-bar height. */
11756 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11757 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11759 /* Value is the number of screen lines needed to make all tool-bar
11760 items of frame F visible. The number of actual rows needed is
11761 returned in *N_ROWS if non-NULL. */
11764 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11766 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11768 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11769 the desired matrix, so use (unused) mode-line row as temporary row to
11770 avoid destroying the first tool-bar row. */
11771 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11773 /* Initialize an iterator for iteration over
11774 F->desired_tool_bar_string in the tool-bar window of frame F. */
11775 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11776 it
.first_visible_x
= 0;
11777 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11778 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11779 it
.paragraph_embedding
= L2R
;
11781 while (!ITERATOR_AT_END_P (&it
))
11783 clear_glyph_row (temp_row
);
11784 it
.glyph_row
= temp_row
;
11785 display_tool_bar_line (&it
, -1);
11787 clear_glyph_row (temp_row
);
11789 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11791 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11793 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11797 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11799 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
11800 If FRAME is nil or omitted, use the selected frame. */)
11801 (Lisp_Object frame
)
11803 struct frame
*f
= decode_any_frame (frame
);
11807 if (WINDOWP (f
->tool_bar_window
)
11808 && (w
= XWINDOW (f
->tool_bar_window
),
11809 WINDOW_TOTAL_LINES (w
) > 0))
11811 update_tool_bar (f
, 1);
11812 if (f
->n_tool_bar_items
)
11814 build_desired_tool_bar_string (f
);
11815 nlines
= tool_bar_lines_needed (f
, NULL
);
11819 return make_number (nlines
);
11823 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11824 height should be changed. */
11827 redisplay_tool_bar (struct frame
*f
)
11831 struct glyph_row
*row
;
11833 #if defined (USE_GTK) || defined (HAVE_NS)
11834 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11835 update_frame_tool_bar (f
);
11839 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11840 do anything. This means you must start with tool-bar-lines
11841 non-zero to get the auto-sizing effect. Or in other words, you
11842 can turn off tool-bars by specifying tool-bar-lines zero. */
11843 if (!WINDOWP (f
->tool_bar_window
)
11844 || (w
= XWINDOW (f
->tool_bar_window
),
11845 WINDOW_TOTAL_LINES (w
) == 0))
11848 /* Set up an iterator for the tool-bar window. */
11849 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11850 it
.first_visible_x
= 0;
11851 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11852 row
= it
.glyph_row
;
11854 /* Build a string that represents the contents of the tool-bar. */
11855 build_desired_tool_bar_string (f
);
11856 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11857 /* FIXME: This should be controlled by a user option. But it
11858 doesn't make sense to have an R2L tool bar if the menu bar cannot
11859 be drawn also R2L, and making the menu bar R2L is tricky due
11860 toolkit-specific code that implements it. If an R2L tool bar is
11861 ever supported, display_tool_bar_line should also be augmented to
11862 call unproduce_glyphs like display_line and display_string
11864 it
.paragraph_embedding
= L2R
;
11866 if (f
->n_tool_bar_rows
== 0)
11870 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11871 nlines
!= WINDOW_TOTAL_LINES (w
)))
11874 int old_height
= WINDOW_TOTAL_LINES (w
);
11876 XSETFRAME (frame
, f
);
11877 Fmodify_frame_parameters (frame
,
11878 Fcons (Fcons (Qtool_bar_lines
,
11879 make_number (nlines
)),
11881 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11883 clear_glyph_matrix (w
->desired_matrix
);
11884 fonts_changed_p
= 1;
11890 /* Display as many lines as needed to display all tool-bar items. */
11892 if (f
->n_tool_bar_rows
> 0)
11894 int border
, rows
, height
, extra
;
11896 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
11897 border
= XINT (Vtool_bar_border
);
11898 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11899 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11900 else if (EQ (Vtool_bar_border
, Qborder_width
))
11901 border
= f
->border_width
;
11907 rows
= f
->n_tool_bar_rows
;
11908 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11909 extra
= it
.last_visible_y
- border
- height
* rows
;
11911 while (it
.current_y
< it
.last_visible_y
)
11914 if (extra
> 0 && rows
-- > 0)
11916 h
= (extra
+ rows
- 1) / rows
;
11919 display_tool_bar_line (&it
, height
+ h
);
11924 while (it
.current_y
< it
.last_visible_y
)
11925 display_tool_bar_line (&it
, 0);
11928 /* It doesn't make much sense to try scrolling in the tool-bar
11929 window, so don't do it. */
11930 w
->desired_matrix
->no_scrolling_p
= 1;
11931 w
->must_be_updated_p
= 1;
11933 if (!NILP (Vauto_resize_tool_bars
))
11935 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11936 int change_height_p
= 0;
11938 /* If we couldn't display everything, change the tool-bar's
11939 height if there is room for more. */
11940 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11941 && it
.current_y
< max_tool_bar_height
)
11942 change_height_p
= 1;
11944 row
= it
.glyph_row
- 1;
11946 /* If there are blank lines at the end, except for a partially
11947 visible blank line at the end that is smaller than
11948 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11949 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
11950 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11951 change_height_p
= 1;
11953 /* If row displays tool-bar items, but is partially visible,
11954 change the tool-bar's height. */
11955 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
11956 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11957 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11958 change_height_p
= 1;
11960 /* Resize windows as needed by changing the `tool-bar-lines'
11961 frame parameter. */
11962 if (change_height_p
)
11965 int old_height
= WINDOW_TOTAL_LINES (w
);
11967 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11969 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11970 && !f
->minimize_tool_bar_window_p
)
11971 ? (nlines
> old_height
)
11972 : (nlines
!= old_height
));
11973 f
->minimize_tool_bar_window_p
= 0;
11975 if (change_height_p
)
11977 XSETFRAME (frame
, f
);
11978 Fmodify_frame_parameters (frame
,
11979 Fcons (Fcons (Qtool_bar_lines
,
11980 make_number (nlines
)),
11982 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11984 clear_glyph_matrix (w
->desired_matrix
);
11985 f
->n_tool_bar_rows
= nrows
;
11986 fonts_changed_p
= 1;
11993 f
->minimize_tool_bar_window_p
= 0;
11998 /* Get information about the tool-bar item which is displayed in GLYPH
11999 on frame F. Return in *PROP_IDX the index where tool-bar item
12000 properties start in F->tool_bar_items. Value is zero if
12001 GLYPH doesn't display a tool-bar item. */
12004 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12010 /* This function can be called asynchronously, which means we must
12011 exclude any possibility that Fget_text_property signals an
12013 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12014 charpos
= max (0, charpos
);
12016 /* Get the text property `menu-item' at pos. The value of that
12017 property is the start index of this item's properties in
12018 F->tool_bar_items. */
12019 prop
= Fget_text_property (make_number (charpos
),
12020 Qmenu_item
, f
->current_tool_bar_string
);
12021 if (INTEGERP (prop
))
12023 *prop_idx
= XINT (prop
);
12033 /* Get information about the tool-bar item at position X/Y on frame F.
12034 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12035 the current matrix of the tool-bar window of F, or NULL if not
12036 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12037 item in F->tool_bar_items. Value is
12039 -1 if X/Y is not on a tool-bar item
12040 0 if X/Y is on the same item that was highlighted before.
12044 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12045 int *hpos
, int *vpos
, int *prop_idx
)
12047 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12048 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12051 /* Find the glyph under X/Y. */
12052 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12053 if (*glyph
== NULL
)
12056 /* Get the start of this tool-bar item's properties in
12057 f->tool_bar_items. */
12058 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12061 /* Is mouse on the highlighted item? */
12062 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12063 && *vpos
>= hlinfo
->mouse_face_beg_row
12064 && *vpos
<= hlinfo
->mouse_face_end_row
12065 && (*vpos
> hlinfo
->mouse_face_beg_row
12066 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12067 && (*vpos
< hlinfo
->mouse_face_end_row
12068 || *hpos
< hlinfo
->mouse_face_end_col
12069 || hlinfo
->mouse_face_past_end
))
12077 Handle mouse button event on the tool-bar of frame F, at
12078 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12079 0 for button release. MODIFIERS is event modifiers for button
12083 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12086 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12087 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12088 int hpos
, vpos
, prop_idx
;
12089 struct glyph
*glyph
;
12090 Lisp_Object enabled_p
;
12092 /* If not on the highlighted tool-bar item, return. */
12093 frame_to_window_pixel_xy (w
, &x
, &y
);
12094 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12097 /* If item is disabled, do nothing. */
12098 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12099 if (NILP (enabled_p
))
12104 /* Show item in pressed state. */
12105 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12106 last_tool_bar_item
= prop_idx
;
12110 Lisp_Object key
, frame
;
12111 struct input_event event
;
12112 EVENT_INIT (event
);
12114 /* Show item in released state. */
12115 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12117 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12119 XSETFRAME (frame
, f
);
12120 event
.kind
= TOOL_BAR_EVENT
;
12121 event
.frame_or_window
= frame
;
12123 kbd_buffer_store_event (&event
);
12125 event
.kind
= TOOL_BAR_EVENT
;
12126 event
.frame_or_window
= frame
;
12128 event
.modifiers
= modifiers
;
12129 kbd_buffer_store_event (&event
);
12130 last_tool_bar_item
= -1;
12135 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12136 tool-bar window-relative coordinates X/Y. Called from
12137 note_mouse_highlight. */
12140 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12142 Lisp_Object window
= f
->tool_bar_window
;
12143 struct window
*w
= XWINDOW (window
);
12144 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12145 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12147 struct glyph
*glyph
;
12148 struct glyph_row
*row
;
12150 Lisp_Object enabled_p
;
12152 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12153 int mouse_down_p
, rc
;
12155 /* Function note_mouse_highlight is called with negative X/Y
12156 values when mouse moves outside of the frame. */
12157 if (x
<= 0 || y
<= 0)
12159 clear_mouse_face (hlinfo
);
12163 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12166 /* Not on tool-bar item. */
12167 clear_mouse_face (hlinfo
);
12171 /* On same tool-bar item as before. */
12172 goto set_help_echo
;
12174 clear_mouse_face (hlinfo
);
12176 /* Mouse is down, but on different tool-bar item? */
12177 mouse_down_p
= (dpyinfo
->grabbed
12178 && f
== last_mouse_frame
12179 && FRAME_LIVE_P (f
));
12181 && last_tool_bar_item
!= prop_idx
)
12184 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12186 /* If tool-bar item is not enabled, don't highlight it. */
12187 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12188 if (!NILP (enabled_p
))
12190 /* Compute the x-position of the glyph. In front and past the
12191 image is a space. We include this in the highlighted area. */
12192 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12193 for (i
= x
= 0; i
< hpos
; ++i
)
12194 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12196 /* Record this as the current active region. */
12197 hlinfo
->mouse_face_beg_col
= hpos
;
12198 hlinfo
->mouse_face_beg_row
= vpos
;
12199 hlinfo
->mouse_face_beg_x
= x
;
12200 hlinfo
->mouse_face_beg_y
= row
->y
;
12201 hlinfo
->mouse_face_past_end
= 0;
12203 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12204 hlinfo
->mouse_face_end_row
= vpos
;
12205 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12206 hlinfo
->mouse_face_end_y
= row
->y
;
12207 hlinfo
->mouse_face_window
= window
;
12208 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12210 /* Display it as active. */
12211 show_mouse_face (hlinfo
, draw
);
12216 /* Set help_echo_string to a help string to display for this tool-bar item.
12217 XTread_socket does the rest. */
12218 help_echo_object
= help_echo_window
= Qnil
;
12219 help_echo_pos
= -1;
12220 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12221 if (NILP (help_echo_string
))
12222 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12225 #endif /* HAVE_WINDOW_SYSTEM */
12229 /************************************************************************
12230 Horizontal scrolling
12231 ************************************************************************/
12233 static int hscroll_window_tree (Lisp_Object
);
12234 static int hscroll_windows (Lisp_Object
);
12236 /* For all leaf windows in the window tree rooted at WINDOW, set their
12237 hscroll value so that PT is (i) visible in the window, and (ii) so
12238 that it is not within a certain margin at the window's left and
12239 right border. Value is non-zero if any window's hscroll has been
12243 hscroll_window_tree (Lisp_Object window
)
12245 int hscrolled_p
= 0;
12246 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12247 int hscroll_step_abs
= 0;
12248 double hscroll_step_rel
= 0;
12250 if (hscroll_relative_p
)
12252 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12253 if (hscroll_step_rel
< 0)
12255 hscroll_relative_p
= 0;
12256 hscroll_step_abs
= 0;
12259 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12261 hscroll_step_abs
= XINT (Vhscroll_step
);
12262 if (hscroll_step_abs
< 0)
12263 hscroll_step_abs
= 0;
12266 hscroll_step_abs
= 0;
12268 while (WINDOWP (window
))
12270 struct window
*w
= XWINDOW (window
);
12272 if (WINDOWP (w
->contents
))
12273 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12274 else if (w
->cursor
.vpos
>= 0)
12277 int text_area_width
;
12278 struct glyph_row
*current_cursor_row
12279 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12280 struct glyph_row
*desired_cursor_row
12281 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12282 struct glyph_row
*cursor_row
12283 = (desired_cursor_row
->enabled_p
12284 ? desired_cursor_row
12285 : current_cursor_row
);
12286 int row_r2l_p
= cursor_row
->reversed_p
;
12288 text_area_width
= window_box_width (w
, TEXT_AREA
);
12290 /* Scroll when cursor is inside this scroll margin. */
12291 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12293 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12294 /* For left-to-right rows, hscroll when cursor is either
12295 (i) inside the right hscroll margin, or (ii) if it is
12296 inside the left margin and the window is already
12300 && w
->cursor
.x
<= h_margin
)
12301 || (cursor_row
->enabled_p
12302 && cursor_row
->truncated_on_right_p
12303 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12304 /* For right-to-left rows, the logic is similar,
12305 except that rules for scrolling to left and right
12306 are reversed. E.g., if cursor.x <= h_margin, we
12307 need to hscroll "to the right" unconditionally,
12308 and that will scroll the screen to the left so as
12309 to reveal the next portion of the row. */
12311 && ((cursor_row
->enabled_p
12312 /* FIXME: It is confusing to set the
12313 truncated_on_right_p flag when R2L rows
12314 are actually truncated on the left. */
12315 && cursor_row
->truncated_on_right_p
12316 && w
->cursor
.x
<= h_margin
)
12318 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12322 struct buffer
*saved_current_buffer
;
12326 /* Find point in a display of infinite width. */
12327 saved_current_buffer
= current_buffer
;
12328 current_buffer
= XBUFFER (w
->contents
);
12330 if (w
== XWINDOW (selected_window
))
12333 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12335 /* Move iterator to pt starting at cursor_row->start in
12336 a line with infinite width. */
12337 init_to_row_start (&it
, w
, cursor_row
);
12338 it
.last_visible_x
= INFINITY
;
12339 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12340 current_buffer
= saved_current_buffer
;
12342 /* Position cursor in window. */
12343 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12344 hscroll
= max (0, (it
.current_x
12345 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12346 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12347 : (text_area_width
/ 2))))
12348 / FRAME_COLUMN_WIDTH (it
.f
);
12349 else if ((!row_r2l_p
12350 && w
->cursor
.x
>= text_area_width
- h_margin
)
12351 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12353 if (hscroll_relative_p
)
12354 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12357 wanted_x
= text_area_width
12358 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12361 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12365 if (hscroll_relative_p
)
12366 wanted_x
= text_area_width
* hscroll_step_rel
12369 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12372 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12374 hscroll
= max (hscroll
, w
->min_hscroll
);
12376 /* Don't prevent redisplay optimizations if hscroll
12377 hasn't changed, as it will unnecessarily slow down
12379 if (w
->hscroll
!= hscroll
)
12381 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12382 w
->hscroll
= hscroll
;
12391 /* Value is non-zero if hscroll of any leaf window has been changed. */
12392 return hscrolled_p
;
12396 /* Set hscroll so that cursor is visible and not inside horizontal
12397 scroll margins for all windows in the tree rooted at WINDOW. See
12398 also hscroll_window_tree above. Value is non-zero if any window's
12399 hscroll has been changed. If it has, desired matrices on the frame
12400 of WINDOW are cleared. */
12403 hscroll_windows (Lisp_Object window
)
12405 int hscrolled_p
= hscroll_window_tree (window
);
12407 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12408 return hscrolled_p
;
12413 /************************************************************************
12415 ************************************************************************/
12417 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12418 to a non-zero value. This is sometimes handy to have in a debugger
12423 /* First and last unchanged row for try_window_id. */
12425 static int debug_first_unchanged_at_end_vpos
;
12426 static int debug_last_unchanged_at_beg_vpos
;
12428 /* Delta vpos and y. */
12430 static int debug_dvpos
, debug_dy
;
12432 /* Delta in characters and bytes for try_window_id. */
12434 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12436 /* Values of window_end_pos and window_end_vpos at the end of
12439 static ptrdiff_t debug_end_vpos
;
12441 /* Append a string to W->desired_matrix->method. FMT is a printf
12442 format string. If trace_redisplay_p is non-zero also printf the
12443 resulting string to stderr. */
12445 static void debug_method_add (struct window
*, char const *, ...)
12446 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12449 debug_method_add (struct window
*w
, char const *fmt
, ...)
12451 char *method
= w
->desired_matrix
->method
;
12452 int len
= strlen (method
);
12453 int size
= sizeof w
->desired_matrix
->method
;
12454 int remaining
= size
- len
- 1;
12457 if (len
&& remaining
)
12460 --remaining
, ++len
;
12463 va_start (ap
, fmt
);
12464 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12467 if (trace_redisplay_p
)
12468 fprintf (stderr
, "%p (%s): %s\n",
12470 ((BUFFERP (w
->contents
)
12471 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
12472 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
12477 #endif /* GLYPH_DEBUG */
12480 /* Value is non-zero if all changes in window W, which displays
12481 current_buffer, are in the text between START and END. START is a
12482 buffer position, END is given as a distance from Z. Used in
12483 redisplay_internal for display optimization. */
12486 text_outside_line_unchanged_p (struct window
*w
,
12487 ptrdiff_t start
, ptrdiff_t end
)
12489 int unchanged_p
= 1;
12491 /* If text or overlays have changed, see where. */
12492 if (window_outdated (w
))
12494 /* Gap in the line? */
12495 if (GPT
< start
|| Z
- GPT
< end
)
12498 /* Changes start in front of the line, or end after it? */
12500 && (BEG_UNCHANGED
< start
- 1
12501 || END_UNCHANGED
< end
))
12504 /* If selective display, can't optimize if changes start at the
12505 beginning of the line. */
12507 && INTEGERP (BVAR (current_buffer
, selective_display
))
12508 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12509 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12512 /* If there are overlays at the start or end of the line, these
12513 may have overlay strings with newlines in them. A change at
12514 START, for instance, may actually concern the display of such
12515 overlay strings as well, and they are displayed on different
12516 lines. So, quickly rule out this case. (For the future, it
12517 might be desirable to implement something more telling than
12518 just BEG/END_UNCHANGED.) */
12521 if (BEG
+ BEG_UNCHANGED
== start
12522 && overlay_touches_p (start
))
12524 if (END_UNCHANGED
== end
12525 && overlay_touches_p (Z
- end
))
12529 /* Under bidi reordering, adding or deleting a character in the
12530 beginning of a paragraph, before the first strong directional
12531 character, can change the base direction of the paragraph (unless
12532 the buffer specifies a fixed paragraph direction), which will
12533 require to redisplay the whole paragraph. It might be worthwhile
12534 to find the paragraph limits and widen the range of redisplayed
12535 lines to that, but for now just give up this optimization. */
12536 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
12537 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
12541 return unchanged_p
;
12545 /* Do a frame update, taking possible shortcuts into account. This is
12546 the main external entry point for redisplay.
12548 If the last redisplay displayed an echo area message and that message
12549 is no longer requested, we clear the echo area or bring back the
12550 mini-buffer if that is in use. */
12555 redisplay_internal ();
12560 overlay_arrow_string_or_property (Lisp_Object var
)
12564 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12567 return Voverlay_arrow_string
;
12570 /* Return 1 if there are any overlay-arrows in current_buffer. */
12572 overlay_arrow_in_current_buffer_p (void)
12576 for (vlist
= Voverlay_arrow_variable_list
;
12578 vlist
= XCDR (vlist
))
12580 Lisp_Object var
= XCAR (vlist
);
12583 if (!SYMBOLP (var
))
12585 val
= find_symbol_value (var
);
12587 && current_buffer
== XMARKER (val
)->buffer
)
12594 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12598 overlay_arrows_changed_p (void)
12602 for (vlist
= Voverlay_arrow_variable_list
;
12604 vlist
= XCDR (vlist
))
12606 Lisp_Object var
= XCAR (vlist
);
12607 Lisp_Object val
, pstr
;
12609 if (!SYMBOLP (var
))
12611 val
= find_symbol_value (var
);
12612 if (!MARKERP (val
))
12614 if (! EQ (COERCE_MARKER (val
),
12615 Fget (var
, Qlast_arrow_position
))
12616 || ! (pstr
= overlay_arrow_string_or_property (var
),
12617 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12623 /* Mark overlay arrows to be updated on next redisplay. */
12626 update_overlay_arrows (int up_to_date
)
12630 for (vlist
= Voverlay_arrow_variable_list
;
12632 vlist
= XCDR (vlist
))
12634 Lisp_Object var
= XCAR (vlist
);
12636 if (!SYMBOLP (var
))
12639 if (up_to_date
> 0)
12641 Lisp_Object val
= find_symbol_value (var
);
12642 Fput (var
, Qlast_arrow_position
,
12643 COERCE_MARKER (val
));
12644 Fput (var
, Qlast_arrow_string
,
12645 overlay_arrow_string_or_property (var
));
12647 else if (up_to_date
< 0
12648 || !NILP (Fget (var
, Qlast_arrow_position
)))
12650 Fput (var
, Qlast_arrow_position
, Qt
);
12651 Fput (var
, Qlast_arrow_string
, Qt
);
12657 /* Return overlay arrow string to display at row.
12658 Return integer (bitmap number) for arrow bitmap in left fringe.
12659 Return nil if no overlay arrow. */
12662 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12666 for (vlist
= Voverlay_arrow_variable_list
;
12668 vlist
= XCDR (vlist
))
12670 Lisp_Object var
= XCAR (vlist
);
12673 if (!SYMBOLP (var
))
12676 val
= find_symbol_value (var
);
12679 && current_buffer
== XMARKER (val
)->buffer
12680 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12682 if (FRAME_WINDOW_P (it
->f
)
12683 /* FIXME: if ROW->reversed_p is set, this should test
12684 the right fringe, not the left one. */
12685 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12687 #ifdef HAVE_WINDOW_SYSTEM
12688 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12691 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12692 return make_number (fringe_bitmap
);
12695 return make_number (-1); /* Use default arrow bitmap. */
12697 return overlay_arrow_string_or_property (var
);
12704 /* Return 1 if point moved out of or into a composition. Otherwise
12705 return 0. PREV_BUF and PREV_PT are the last point buffer and
12706 position. BUF and PT are the current point buffer and position. */
12709 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12710 struct buffer
*buf
, ptrdiff_t pt
)
12712 ptrdiff_t start
, end
;
12714 Lisp_Object buffer
;
12716 XSETBUFFER (buffer
, buf
);
12717 /* Check a composition at the last point if point moved within the
12719 if (prev_buf
== buf
)
12722 /* Point didn't move. */
12725 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12726 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12727 && COMPOSITION_VALID_P (start
, end
, prop
)
12728 && start
< prev_pt
&& end
> prev_pt
)
12729 /* The last point was within the composition. Return 1 iff
12730 point moved out of the composition. */
12731 return (pt
<= start
|| pt
>= end
);
12734 /* Check a composition at the current point. */
12735 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12736 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12737 && COMPOSITION_VALID_P (start
, end
, prop
)
12738 && start
< pt
&& end
> pt
);
12742 /* Reconsider the setting of B->clip_changed which is displayed
12746 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12748 if (b
->clip_changed
12749 && w
->window_end_valid
12750 && w
->current_matrix
->buffer
== b
12751 && w
->current_matrix
->zv
== BUF_ZV (b
)
12752 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12753 b
->clip_changed
= 0;
12755 /* If display wasn't paused, and W is not a tool bar window, see if
12756 point has been moved into or out of a composition. In that case,
12757 we set b->clip_changed to 1 to force updating the screen. If
12758 b->clip_changed has already been set to 1, we can skip this
12760 if (!b
->clip_changed
&& BUFFERP (w
->contents
) && w
->window_end_valid
)
12764 if (w
== XWINDOW (selected_window
))
12767 pt
= marker_position (w
->pointm
);
12769 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->contents
)
12770 || pt
!= w
->last_point
)
12771 && check_point_in_composition (w
->current_matrix
->buffer
,
12773 XBUFFER (w
->contents
), pt
))
12774 b
->clip_changed
= 1;
12779 #define STOP_POLLING \
12780 do { if (! polling_stopped_here) stop_polling (); \
12781 polling_stopped_here = 1; } while (0)
12783 #define RESUME_POLLING \
12784 do { if (polling_stopped_here) start_polling (); \
12785 polling_stopped_here = 0; } while (0)
12788 /* Perhaps in the future avoid recentering windows if it
12789 is not necessary; currently that causes some problems. */
12792 redisplay_internal (void)
12794 struct window
*w
= XWINDOW (selected_window
);
12798 int must_finish
= 0;
12799 struct text_pos tlbufpos
, tlendpos
;
12800 int number_of_visible_frames
;
12801 ptrdiff_t count
, count1
;
12803 int polling_stopped_here
= 0;
12804 Lisp_Object tail
, frame
;
12805 struct backtrace backtrace
;
12807 /* Non-zero means redisplay has to consider all windows on all
12808 frames. Zero means, only selected_window is considered. */
12809 int consider_all_windows_p
;
12811 /* Non-zero means redisplay has to redisplay the miniwindow. */
12812 int update_miniwindow_p
= 0;
12814 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12816 /* No redisplay if running in batch mode or frame is not yet fully
12817 initialized, or redisplay is explicitly turned off by setting
12818 Vinhibit_redisplay. */
12819 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12820 || !NILP (Vinhibit_redisplay
))
12823 /* Don't examine these until after testing Vinhibit_redisplay.
12824 When Emacs is shutting down, perhaps because its connection to
12825 X has dropped, we should not look at them at all. */
12826 fr
= XFRAME (w
->frame
);
12827 sf
= SELECTED_FRAME ();
12829 if (!fr
->glyphs_initialized_p
)
12832 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12833 if (popup_activated ())
12837 /* I don't think this happens but let's be paranoid. */
12838 if (redisplaying_p
)
12841 /* Record a function that clears redisplaying_p
12842 when we leave this function. */
12843 count
= SPECPDL_INDEX ();
12844 record_unwind_protect (unwind_redisplay
, selected_frame
);
12845 redisplaying_p
= 1;
12846 specbind (Qinhibit_free_realized_faces
, Qnil
);
12848 /* Record this function, so it appears on the profiler's backtraces. */
12849 backtrace
.next
= backtrace_list
;
12850 backtrace
.function
= Qredisplay_internal
;
12851 backtrace
.args
= &Qnil
;
12852 backtrace
.nargs
= 0;
12853 backtrace
.debug_on_exit
= 0;
12854 backtrace_list
= &backtrace
;
12856 FOR_EACH_FRAME (tail
, frame
)
12857 XFRAME (frame
)->already_hscrolled_p
= 0;
12860 /* Remember the currently selected window. */
12864 reconsider_clip_changes (w
, current_buffer
);
12865 last_escape_glyph_frame
= NULL
;
12866 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12867 last_glyphless_glyph_frame
= NULL
;
12868 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12870 /* If new fonts have been loaded that make a glyph matrix adjustment
12871 necessary, do it. */
12872 if (fonts_changed_p
)
12874 adjust_glyphs (NULL
);
12875 ++windows_or_buffers_changed
;
12876 fonts_changed_p
= 0;
12879 /* If face_change_count is non-zero, init_iterator will free all
12880 realized faces, which includes the faces referenced from current
12881 matrices. So, we can't reuse current matrices in this case. */
12882 if (face_change_count
)
12883 ++windows_or_buffers_changed
;
12885 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12886 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12888 /* Since frames on a single ASCII terminal share the same
12889 display area, displaying a different frame means redisplay
12890 the whole thing. */
12891 windows_or_buffers_changed
++;
12892 SET_FRAME_GARBAGED (sf
);
12894 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12896 FRAME_TTY (sf
)->previous_frame
= sf
;
12899 /* Set the visible flags for all frames. Do this before checking for
12900 resized or garbaged frames; they want to know if their frames are
12901 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
12902 number_of_visible_frames
= 0;
12904 FOR_EACH_FRAME (tail
, frame
)
12906 struct frame
*f
= XFRAME (frame
);
12908 if (FRAME_VISIBLE_P (f
))
12909 ++number_of_visible_frames
;
12910 clear_desired_matrices (f
);
12913 /* Notice any pending interrupt request to change frame size. */
12914 do_pending_window_change (1);
12916 /* do_pending_window_change could change the selected_window due to
12917 frame resizing which makes the selected window too small. */
12918 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12921 reconsider_clip_changes (w
, current_buffer
);
12924 /* Clear frames marked as garbaged. */
12925 clear_garbaged_frames ();
12927 /* Build menubar and tool-bar items. */
12928 if (NILP (Vmemory_full
))
12929 prepare_menu_bars ();
12931 if (windows_or_buffers_changed
)
12932 update_mode_lines
++;
12934 /* Detect case that we need to write or remove a star in the mode line. */
12935 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
12937 w
->update_mode_line
= 1;
12938 if (buffer_shared_and_changed ())
12939 update_mode_lines
++;
12942 /* Avoid invocation of point motion hooks by `current_column' below. */
12943 count1
= SPECPDL_INDEX ();
12944 specbind (Qinhibit_point_motion_hooks
, Qt
);
12946 if (mode_line_update_needed (w
))
12947 w
->update_mode_line
= 1;
12949 unbind_to (count1
, Qnil
);
12951 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12953 consider_all_windows_p
= (update_mode_lines
12954 || buffer_shared_and_changed ()
12955 || cursor_type_changed
);
12957 /* If specs for an arrow have changed, do thorough redisplay
12958 to ensure we remove any arrow that should no longer exist. */
12959 if (overlay_arrows_changed_p ())
12960 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12962 /* Normally the message* functions will have already displayed and
12963 updated the echo area, but the frame may have been trashed, or
12964 the update may have been preempted, so display the echo area
12965 again here. Checking message_cleared_p captures the case that
12966 the echo area should be cleared. */
12967 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12968 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12969 || (message_cleared_p
12970 && minibuf_level
== 0
12971 /* If the mini-window is currently selected, this means the
12972 echo-area doesn't show through. */
12973 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12975 int window_height_changed_p
= echo_area_display (0);
12977 if (message_cleared_p
)
12978 update_miniwindow_p
= 1;
12982 /* If we don't display the current message, don't clear the
12983 message_cleared_p flag, because, if we did, we wouldn't clear
12984 the echo area in the next redisplay which doesn't preserve
12986 if (!display_last_displayed_message_p
)
12987 message_cleared_p
= 0;
12989 if (fonts_changed_p
)
12991 else if (window_height_changed_p
)
12993 consider_all_windows_p
= 1;
12994 ++update_mode_lines
;
12995 ++windows_or_buffers_changed
;
12997 /* If window configuration was changed, frames may have been
12998 marked garbaged. Clear them or we will experience
12999 surprises wrt scrolling. */
13000 clear_garbaged_frames ();
13003 else if (EQ (selected_window
, minibuf_window
)
13004 && (current_buffer
->clip_changed
|| window_outdated (w
))
13005 && resize_mini_window (w
, 0))
13007 /* Resized active mini-window to fit the size of what it is
13008 showing if its contents might have changed. */
13010 /* FIXME: this causes all frames to be updated, which seems unnecessary
13011 since only the current frame needs to be considered. This function
13012 needs to be rewritten with two variables, consider_all_windows and
13013 consider_all_frames. */
13014 consider_all_windows_p
= 1;
13015 ++windows_or_buffers_changed
;
13016 ++update_mode_lines
;
13018 /* If window configuration was changed, frames may have been
13019 marked garbaged. Clear them or we will experience
13020 surprises wrt scrolling. */
13021 clear_garbaged_frames ();
13024 /* If showing the region, and mark has changed, we must redisplay
13025 the whole window. The assignment to this_line_start_pos prevents
13026 the optimization directly below this if-statement. */
13027 if (((!NILP (Vtransient_mark_mode
)
13028 && !NILP (BVAR (XBUFFER (w
->contents
), mark_active
)))
13029 != (w
->region_showing
> 0))
13030 || (w
->region_showing
13031 && w
->region_showing
13032 != XINT (Fmarker_position (BVAR (XBUFFER (w
->contents
), mark
)))))
13033 CHARPOS (this_line_start_pos
) = 0;
13035 /* Optimize the case that only the line containing the cursor in the
13036 selected window has changed. Variables starting with this_ are
13037 set in display_line and record information about the line
13038 containing the cursor. */
13039 tlbufpos
= this_line_start_pos
;
13040 tlendpos
= this_line_end_pos
;
13041 if (!consider_all_windows_p
13042 && CHARPOS (tlbufpos
) > 0
13043 && !w
->update_mode_line
13044 && !current_buffer
->clip_changed
13045 && !current_buffer
->prevent_redisplay_optimizations_p
13046 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13047 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13048 /* Make sure recorded data applies to current buffer, etc. */
13049 && this_line_buffer
== current_buffer
13050 && current_buffer
== XBUFFER (w
->contents
)
13052 && !w
->optional_new_start
13053 /* Point must be on the line that we have info recorded about. */
13054 && PT
>= CHARPOS (tlbufpos
)
13055 && PT
<= Z
- CHARPOS (tlendpos
)
13056 /* All text outside that line, including its final newline,
13057 must be unchanged. */
13058 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13059 CHARPOS (tlendpos
)))
13061 if (CHARPOS (tlbufpos
) > BEGV
13062 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13063 && (CHARPOS (tlbufpos
) == ZV
13064 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13065 /* Former continuation line has disappeared by becoming empty. */
13067 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13069 /* We have to handle the case of continuation around a
13070 wide-column character (see the comment in indent.c around
13073 For instance, in the following case:
13075 -------- Insert --------
13076 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13077 J_I_ ==> J_I_ `^^' are cursors.
13081 As we have to redraw the line above, we cannot use this
13085 int line_height_before
= this_line_pixel_height
;
13087 /* Note that start_display will handle the case that the
13088 line starting at tlbufpos is a continuation line. */
13089 start_display (&it
, w
, tlbufpos
);
13091 /* Implementation note: It this still necessary? */
13092 if (it
.current_x
!= this_line_start_x
)
13095 TRACE ((stderr
, "trying display optimization 1\n"));
13096 w
->cursor
.vpos
= -1;
13097 overlay_arrow_seen
= 0;
13098 it
.vpos
= this_line_vpos
;
13099 it
.current_y
= this_line_y
;
13100 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13101 display_line (&it
);
13103 /* If line contains point, is not continued,
13104 and ends at same distance from eob as before, we win. */
13105 if (w
->cursor
.vpos
>= 0
13106 /* Line is not continued, otherwise this_line_start_pos
13107 would have been set to 0 in display_line. */
13108 && CHARPOS (this_line_start_pos
)
13109 /* Line ends as before. */
13110 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13111 /* Line has same height as before. Otherwise other lines
13112 would have to be shifted up or down. */
13113 && this_line_pixel_height
== line_height_before
)
13115 /* If this is not the window's last line, we must adjust
13116 the charstarts of the lines below. */
13117 if (it
.current_y
< it
.last_visible_y
)
13119 struct glyph_row
*row
13120 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13121 ptrdiff_t delta
, delta_bytes
;
13123 /* We used to distinguish between two cases here,
13124 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13125 when the line ends in a newline or the end of the
13126 buffer's accessible portion. But both cases did
13127 the same, so they were collapsed. */
13129 - CHARPOS (tlendpos
)
13130 - MATRIX_ROW_START_CHARPOS (row
));
13131 delta_bytes
= (Z_BYTE
13132 - BYTEPOS (tlendpos
)
13133 - MATRIX_ROW_START_BYTEPOS (row
));
13135 increment_matrix_positions (w
->current_matrix
,
13136 this_line_vpos
+ 1,
13137 w
->current_matrix
->nrows
,
13138 delta
, delta_bytes
);
13141 /* If this row displays text now but previously didn't,
13142 or vice versa, w->window_end_vpos may have to be
13144 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13146 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13147 wset_window_end_vpos (w
, make_number (this_line_vpos
));
13149 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13150 && this_line_vpos
> 0)
13151 wset_window_end_vpos (w
, make_number (this_line_vpos
- 1));
13152 w
->window_end_valid
= 0;
13154 /* Update hint: No need to try to scroll in update_window. */
13155 w
->desired_matrix
->no_scrolling_p
= 1;
13158 *w
->desired_matrix
->method
= 0;
13159 debug_method_add (w
, "optimization 1");
13161 #ifdef HAVE_WINDOW_SYSTEM
13162 update_window_fringes (w
, 0);
13169 else if (/* Cursor position hasn't changed. */
13170 PT
== w
->last_point
13171 /* Make sure the cursor was last displayed
13172 in this window. Otherwise we have to reposition it. */
13173 && w
->cursor
.vpos
>= 0
13174 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13178 do_pending_window_change (1);
13179 /* If selected_window changed, redisplay again. */
13180 if (WINDOWP (selected_window
)
13181 && (w
= XWINDOW (selected_window
)) != sw
)
13184 /* We used to always goto end_of_redisplay here, but this
13185 isn't enough if we have a blinking cursor. */
13186 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13187 goto end_of_redisplay
;
13191 /* If highlighting the region, or if the cursor is in the echo area,
13192 then we can't just move the cursor. */
13193 else if (! (!NILP (Vtransient_mark_mode
)
13194 && !NILP (BVAR (current_buffer
, mark_active
)))
13195 && (EQ (selected_window
,
13196 BVAR (current_buffer
, last_selected_window
))
13197 || highlight_nonselected_windows
)
13198 && !w
->region_showing
13199 && NILP (Vshow_trailing_whitespace
)
13200 && !cursor_in_echo_area
)
13203 struct glyph_row
*row
;
13205 /* Skip from tlbufpos to PT and see where it is. Note that
13206 PT may be in invisible text. If so, we will end at the
13207 next visible position. */
13208 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13209 NULL
, DEFAULT_FACE_ID
);
13210 it
.current_x
= this_line_start_x
;
13211 it
.current_y
= this_line_y
;
13212 it
.vpos
= this_line_vpos
;
13214 /* The call to move_it_to stops in front of PT, but
13215 moves over before-strings. */
13216 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13218 if (it
.vpos
== this_line_vpos
13219 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13222 eassert (this_line_vpos
== it
.vpos
);
13223 eassert (this_line_y
== it
.current_y
);
13224 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13226 *w
->desired_matrix
->method
= 0;
13227 debug_method_add (w
, "optimization 3");
13236 /* Text changed drastically or point moved off of line. */
13237 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13240 CHARPOS (this_line_start_pos
) = 0;
13241 consider_all_windows_p
|= buffer_shared_and_changed ();
13242 ++clear_face_cache_count
;
13243 #ifdef HAVE_WINDOW_SYSTEM
13244 ++clear_image_cache_count
;
13247 /* Build desired matrices, and update the display. If
13248 consider_all_windows_p is non-zero, do it for all windows on all
13249 frames. Otherwise do it for selected_window, only. */
13251 if (consider_all_windows_p
)
13253 FOR_EACH_FRAME (tail
, frame
)
13254 XFRAME (frame
)->updated_p
= 0;
13256 FOR_EACH_FRAME (tail
, frame
)
13258 struct frame
*f
= XFRAME (frame
);
13260 /* We don't have to do anything for unselected terminal
13262 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13263 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13266 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13268 /* Mark all the scroll bars to be removed; we'll redeem
13269 the ones we want when we redisplay their windows. */
13270 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13271 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13273 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13274 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13276 /* The X error handler may have deleted that frame. */
13277 if (!FRAME_LIVE_P (f
))
13280 /* Any scroll bars which redisplay_windows should have
13281 nuked should now go away. */
13282 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13283 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13285 /* If fonts changed, display again. */
13286 /* ??? rms: I suspect it is a mistake to jump all the way
13287 back to retry here. It should just retry this frame. */
13288 if (fonts_changed_p
)
13291 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13293 /* See if we have to hscroll. */
13294 if (!f
->already_hscrolled_p
)
13296 f
->already_hscrolled_p
= 1;
13297 if (hscroll_windows (f
->root_window
))
13301 /* Prevent various kinds of signals during display
13302 update. stdio is not robust about handling
13303 signals, which can cause an apparent I/O
13305 if (interrupt_input
)
13306 unrequest_sigio ();
13309 /* Update the display. */
13310 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13311 pending
|= update_frame (f
, 0, 0);
13317 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13321 /* Do the mark_window_display_accurate after all windows have
13322 been redisplayed because this call resets flags in buffers
13323 which are needed for proper redisplay. */
13324 FOR_EACH_FRAME (tail
, frame
)
13326 struct frame
*f
= XFRAME (frame
);
13329 mark_window_display_accurate (f
->root_window
, 1);
13330 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13331 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13336 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13338 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13339 struct frame
*mini_frame
;
13341 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13342 /* Use list_of_error, not Qerror, so that
13343 we catch only errors and don't run the debugger. */
13344 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13346 redisplay_window_error
);
13347 if (update_miniwindow_p
)
13348 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13350 redisplay_window_error
);
13352 /* Compare desired and current matrices, perform output. */
13355 /* If fonts changed, display again. */
13356 if (fonts_changed_p
)
13359 /* Prevent various kinds of signals during display update.
13360 stdio is not robust about handling signals,
13361 which can cause an apparent I/O error. */
13362 if (interrupt_input
)
13363 unrequest_sigio ();
13366 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13368 if (hscroll_windows (selected_window
))
13371 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13372 pending
= update_frame (sf
, 0, 0);
13375 /* We may have called echo_area_display at the top of this
13376 function. If the echo area is on another frame, that may
13377 have put text on a frame other than the selected one, so the
13378 above call to update_frame would not have caught it. Catch
13380 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13381 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13383 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13385 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13386 pending
|= update_frame (mini_frame
, 0, 0);
13387 if (!pending
&& hscroll_windows (mini_window
))
13392 /* If display was paused because of pending input, make sure we do a
13393 thorough update the next time. */
13396 /* Prevent the optimization at the beginning of
13397 redisplay_internal that tries a single-line update of the
13398 line containing the cursor in the selected window. */
13399 CHARPOS (this_line_start_pos
) = 0;
13401 /* Let the overlay arrow be updated the next time. */
13402 update_overlay_arrows (0);
13404 /* If we pause after scrolling, some rows in the current
13405 matrices of some windows are not valid. */
13406 if (!WINDOW_FULL_WIDTH_P (w
)
13407 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13408 update_mode_lines
= 1;
13412 if (!consider_all_windows_p
)
13414 /* This has already been done above if
13415 consider_all_windows_p is set. */
13416 mark_window_display_accurate_1 (w
, 1);
13418 /* Say overlay arrows are up to date. */
13419 update_overlay_arrows (1);
13421 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13422 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13425 update_mode_lines
= 0;
13426 windows_or_buffers_changed
= 0;
13427 cursor_type_changed
= 0;
13430 /* Start SIGIO interrupts coming again. Having them off during the
13431 code above makes it less likely one will discard output, but not
13432 impossible, since there might be stuff in the system buffer here.
13433 But it is much hairier to try to do anything about that. */
13434 if (interrupt_input
)
13438 /* If a frame has become visible which was not before, redisplay
13439 again, so that we display it. Expose events for such a frame
13440 (which it gets when becoming visible) don't call the parts of
13441 redisplay constructing glyphs, so simply exposing a frame won't
13442 display anything in this case. So, we have to display these
13443 frames here explicitly. */
13448 FOR_EACH_FRAME (tail
, frame
)
13450 int this_is_visible
= 0;
13452 if (XFRAME (frame
)->visible
)
13453 this_is_visible
= 1;
13455 if (this_is_visible
)
13459 if (new_count
!= number_of_visible_frames
)
13460 windows_or_buffers_changed
++;
13463 /* Change frame size now if a change is pending. */
13464 do_pending_window_change (1);
13466 /* If we just did a pending size change, or have additional
13467 visible frames, or selected_window changed, redisplay again. */
13468 if ((windows_or_buffers_changed
&& !pending
)
13469 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13472 /* Clear the face and image caches.
13474 We used to do this only if consider_all_windows_p. But the cache
13475 needs to be cleared if a timer creates images in the current
13476 buffer (e.g. the test case in Bug#6230). */
13478 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13480 clear_face_cache (0);
13481 clear_face_cache_count
= 0;
13484 #ifdef HAVE_WINDOW_SYSTEM
13485 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13487 clear_image_caches (Qnil
);
13488 clear_image_cache_count
= 0;
13490 #endif /* HAVE_WINDOW_SYSTEM */
13493 backtrace_list
= backtrace
.next
;
13494 unbind_to (count
, Qnil
);
13499 /* Redisplay, but leave alone any recent echo area message unless
13500 another message has been requested in its place.
13502 This is useful in situations where you need to redisplay but no
13503 user action has occurred, making it inappropriate for the message
13504 area to be cleared. See tracking_off and
13505 wait_reading_process_output for examples of these situations.
13507 FROM_WHERE is an integer saying from where this function was
13508 called. This is useful for debugging. */
13511 redisplay_preserve_echo_area (int from_where
)
13513 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13515 if (!NILP (echo_area_buffer
[1]))
13517 /* We have a previously displayed message, but no current
13518 message. Redisplay the previous message. */
13519 display_last_displayed_message_p
= 1;
13520 redisplay_internal ();
13521 display_last_displayed_message_p
= 0;
13524 redisplay_internal ();
13526 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13527 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13528 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13532 /* Function registered with record_unwind_protect in redisplay_internal.
13533 Clear redisplaying_p. Also select the previously selected frame. */
13536 unwind_redisplay (Lisp_Object old_frame
)
13538 redisplaying_p
= 0;
13543 /* Mark the display of leaf window W as accurate or inaccurate.
13544 If ACCURATE_P is non-zero mark display of W as accurate. If
13545 ACCURATE_P is zero, arrange for W to be redisplayed the next
13546 time redisplay_internal is called. */
13549 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13551 struct buffer
*b
= XBUFFER (w
->contents
);
13553 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
13554 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
13555 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13559 b
->clip_changed
= 0;
13560 b
->prevent_redisplay_optimizations_p
= 0;
13562 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13563 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13564 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13565 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13567 w
->current_matrix
->buffer
= b
;
13568 w
->current_matrix
->begv
= BUF_BEGV (b
);
13569 w
->current_matrix
->zv
= BUF_ZV (b
);
13571 w
->last_cursor
= w
->cursor
;
13572 w
->last_cursor_off_p
= w
->cursor_off_p
;
13574 if (w
== XWINDOW (selected_window
))
13575 w
->last_point
= BUF_PT (b
);
13577 w
->last_point
= marker_position (w
->pointm
);
13579 w
->window_end_valid
= 1;
13580 w
->update_mode_line
= 0;
13585 /* Mark the display of windows in the window tree rooted at WINDOW as
13586 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13587 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13588 be redisplayed the next time redisplay_internal is called. */
13591 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13595 for (; !NILP (window
); window
= w
->next
)
13597 w
= XWINDOW (window
);
13598 if (WINDOWP (w
->contents
))
13599 mark_window_display_accurate (w
->contents
, accurate_p
);
13601 mark_window_display_accurate_1 (w
, accurate_p
);
13605 update_overlay_arrows (1);
13607 /* Force a thorough redisplay the next time by setting
13608 last_arrow_position and last_arrow_string to t, which is
13609 unequal to any useful value of Voverlay_arrow_... */
13610 update_overlay_arrows (-1);
13614 /* Return value in display table DP (Lisp_Char_Table *) for character
13615 C. Since a display table doesn't have any parent, we don't have to
13616 follow parent. Do not call this function directly but use the
13617 macro DISP_CHAR_VECTOR. */
13620 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13624 if (ASCII_CHAR_P (c
))
13627 if (SUB_CHAR_TABLE_P (val
))
13628 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13634 XSETCHAR_TABLE (table
, dp
);
13635 val
= char_table_ref (table
, c
);
13644 /***********************************************************************
13646 ***********************************************************************/
13648 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13651 redisplay_windows (Lisp_Object window
)
13653 while (!NILP (window
))
13655 struct window
*w
= XWINDOW (window
);
13657 if (WINDOWP (w
->contents
))
13658 redisplay_windows (w
->contents
);
13659 else if (BUFFERP (w
->contents
))
13661 displayed_buffer
= XBUFFER (w
->contents
);
13662 /* Use list_of_error, not Qerror, so that
13663 we catch only errors and don't run the debugger. */
13664 internal_condition_case_1 (redisplay_window_0
, window
,
13666 redisplay_window_error
);
13674 redisplay_window_error (Lisp_Object ignore
)
13676 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13681 redisplay_window_0 (Lisp_Object window
)
13683 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13684 redisplay_window (window
, 0);
13689 redisplay_window_1 (Lisp_Object window
)
13691 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13692 redisplay_window (window
, 1);
13697 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13698 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13699 which positions recorded in ROW differ from current buffer
13702 Return 0 if cursor is not on this row, 1 otherwise. */
13705 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13706 struct glyph_matrix
*matrix
,
13707 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13710 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13711 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13712 struct glyph
*cursor
= NULL
;
13713 /* The last known character position in row. */
13714 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13716 ptrdiff_t pt_old
= PT
- delta
;
13717 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13718 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13719 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13720 /* A glyph beyond the edge of TEXT_AREA which we should never
13722 struct glyph
*glyphs_end
= end
;
13723 /* Non-zero means we've found a match for cursor position, but that
13724 glyph has the avoid_cursor_p flag set. */
13725 int match_with_avoid_cursor
= 0;
13726 /* Non-zero means we've seen at least one glyph that came from a
13728 int string_seen
= 0;
13729 /* Largest and smallest buffer positions seen so far during scan of
13731 ptrdiff_t bpos_max
= pos_before
;
13732 ptrdiff_t bpos_min
= pos_after
;
13733 /* Last buffer position covered by an overlay string with an integer
13734 `cursor' property. */
13735 ptrdiff_t bpos_covered
= 0;
13736 /* Non-zero means the display string on which to display the cursor
13737 comes from a text property, not from an overlay. */
13738 int string_from_text_prop
= 0;
13740 /* Don't even try doing anything if called for a mode-line or
13741 header-line row, since the rest of the code isn't prepared to
13742 deal with such calamities. */
13743 eassert (!row
->mode_line_p
);
13744 if (row
->mode_line_p
)
13747 /* Skip over glyphs not having an object at the start and the end of
13748 the row. These are special glyphs like truncation marks on
13749 terminal frames. */
13750 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
13752 if (!row
->reversed_p
)
13755 && INTEGERP (glyph
->object
)
13756 && glyph
->charpos
< 0)
13758 x
+= glyph
->pixel_width
;
13762 && INTEGERP ((end
- 1)->object
)
13763 /* CHARPOS is zero for blanks and stretch glyphs
13764 inserted by extend_face_to_end_of_line. */
13765 && (end
- 1)->charpos
<= 0)
13767 glyph_before
= glyph
- 1;
13774 /* If the glyph row is reversed, we need to process it from back
13775 to front, so swap the edge pointers. */
13776 glyphs_end
= end
= glyph
- 1;
13777 glyph
+= row
->used
[TEXT_AREA
] - 1;
13779 while (glyph
> end
+ 1
13780 && INTEGERP (glyph
->object
)
13781 && glyph
->charpos
< 0)
13784 x
-= glyph
->pixel_width
;
13786 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13788 /* By default, in reversed rows we put the cursor on the
13789 rightmost (first in the reading order) glyph. */
13790 for (g
= end
+ 1; g
< glyph
; g
++)
13791 x
+= g
->pixel_width
;
13793 && INTEGERP ((end
+ 1)->object
)
13794 && (end
+ 1)->charpos
<= 0)
13796 glyph_before
= glyph
+ 1;
13800 else if (row
->reversed_p
)
13802 /* In R2L rows that don't display text, put the cursor on the
13803 rightmost glyph. Case in point: an empty last line that is
13804 part of an R2L paragraph. */
13806 /* Avoid placing the cursor on the last glyph of the row, where
13807 on terminal frames we hold the vertical border between
13808 adjacent windows. */
13809 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13810 && !WINDOW_RIGHTMOST_P (w
)
13811 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13813 x
= -1; /* will be computed below, at label compute_x */
13816 /* Step 1: Try to find the glyph whose character position
13817 corresponds to point. If that's not possible, find 2 glyphs
13818 whose character positions are the closest to point, one before
13819 point, the other after it. */
13820 if (!row
->reversed_p
)
13821 while (/* not marched to end of glyph row */
13823 /* glyph was not inserted by redisplay for internal purposes */
13824 && !INTEGERP (glyph
->object
))
13826 if (BUFFERP (glyph
->object
))
13828 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
13830 if (glyph
->charpos
> bpos_max
)
13831 bpos_max
= glyph
->charpos
;
13832 if (glyph
->charpos
< bpos_min
)
13833 bpos_min
= glyph
->charpos
;
13834 if (!glyph
->avoid_cursor_p
)
13836 /* If we hit point, we've found the glyph on which to
13837 display the cursor. */
13840 match_with_avoid_cursor
= 0;
13843 /* See if we've found a better approximation to
13844 POS_BEFORE or to POS_AFTER. */
13845 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13847 pos_before
= glyph
->charpos
;
13848 glyph_before
= glyph
;
13850 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
13852 pos_after
= glyph
->charpos
;
13853 glyph_after
= glyph
;
13856 else if (dpos
== 0)
13857 match_with_avoid_cursor
= 1;
13859 else if (STRINGP (glyph
->object
))
13861 Lisp_Object chprop
;
13862 ptrdiff_t glyph_pos
= glyph
->charpos
;
13864 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13866 if (!NILP (chprop
))
13868 /* If the string came from a `display' text property,
13869 look up the buffer position of that property and
13870 use that position to update bpos_max, as if we
13871 actually saw such a position in one of the row's
13872 glyphs. This helps with supporting integer values
13873 of `cursor' property on the display string in
13874 situations where most or all of the row's buffer
13875 text is completely covered by display properties,
13876 so that no glyph with valid buffer positions is
13877 ever seen in the row. */
13878 ptrdiff_t prop_pos
=
13879 string_buffer_position_lim (glyph
->object
, pos_before
,
13882 if (prop_pos
>= pos_before
)
13883 bpos_max
= prop_pos
- 1;
13885 if (INTEGERP (chprop
))
13887 bpos_covered
= bpos_max
+ XINT (chprop
);
13888 /* If the `cursor' property covers buffer positions up
13889 to and including point, we should display cursor on
13890 this glyph. Note that, if a `cursor' property on one
13891 of the string's characters has an integer value, we
13892 will break out of the loop below _before_ we get to
13893 the position match above. IOW, integer values of
13894 the `cursor' property override the "exact match for
13895 point" strategy of positioning the cursor. */
13896 /* Implementation note: bpos_max == pt_old when, e.g.,
13897 we are in an empty line, where bpos_max is set to
13898 MATRIX_ROW_START_CHARPOS, see above. */
13899 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13908 x
+= glyph
->pixel_width
;
13911 else if (glyph
> end
) /* row is reversed */
13912 while (!INTEGERP (glyph
->object
))
13914 if (BUFFERP (glyph
->object
))
13916 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
13918 if (glyph
->charpos
> bpos_max
)
13919 bpos_max
= glyph
->charpos
;
13920 if (glyph
->charpos
< bpos_min
)
13921 bpos_min
= glyph
->charpos
;
13922 if (!glyph
->avoid_cursor_p
)
13926 match_with_avoid_cursor
= 0;
13929 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13931 pos_before
= glyph
->charpos
;
13932 glyph_before
= glyph
;
13934 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
13936 pos_after
= glyph
->charpos
;
13937 glyph_after
= glyph
;
13940 else if (dpos
== 0)
13941 match_with_avoid_cursor
= 1;
13943 else if (STRINGP (glyph
->object
))
13945 Lisp_Object chprop
;
13946 ptrdiff_t glyph_pos
= glyph
->charpos
;
13948 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13950 if (!NILP (chprop
))
13952 ptrdiff_t prop_pos
=
13953 string_buffer_position_lim (glyph
->object
, pos_before
,
13956 if (prop_pos
>= pos_before
)
13957 bpos_max
= prop_pos
- 1;
13959 if (INTEGERP (chprop
))
13961 bpos_covered
= bpos_max
+ XINT (chprop
);
13962 /* If the `cursor' property covers buffer positions up
13963 to and including point, we should display cursor on
13965 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13974 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13976 x
--; /* can't use any pixel_width */
13979 x
-= glyph
->pixel_width
;
13982 /* Step 2: If we didn't find an exact match for point, we need to
13983 look for a proper place to put the cursor among glyphs between
13984 GLYPH_BEFORE and GLYPH_AFTER. */
13985 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13986 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13987 && !(bpos_max
< pt_old
&& pt_old
<= bpos_covered
))
13989 /* An empty line has a single glyph whose OBJECT is zero and
13990 whose CHARPOS is the position of a newline on that line.
13991 Note that on a TTY, there are more glyphs after that, which
13992 were produced by extend_face_to_end_of_line, but their
13993 CHARPOS is zero or negative. */
13995 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13996 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
13997 /* On a TTY, continued and truncated rows also have a glyph at
13998 their end whose OBJECT is zero and whose CHARPOS is
13999 positive (the continuation and truncation glyphs), but such
14000 rows are obviously not "empty". */
14001 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14003 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14005 ptrdiff_t ellipsis_pos
;
14007 /* Scan back over the ellipsis glyphs. */
14008 if (!row
->reversed_p
)
14010 ellipsis_pos
= (glyph
- 1)->charpos
;
14011 while (glyph
> row
->glyphs
[TEXT_AREA
]
14012 && (glyph
- 1)->charpos
== ellipsis_pos
)
14013 glyph
--, x
-= glyph
->pixel_width
;
14014 /* That loop always goes one position too far, including
14015 the glyph before the ellipsis. So scan forward over
14017 x
+= glyph
->pixel_width
;
14020 else /* row is reversed */
14022 ellipsis_pos
= (glyph
+ 1)->charpos
;
14023 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14024 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14025 glyph
++, x
+= glyph
->pixel_width
;
14026 x
-= glyph
->pixel_width
;
14030 else if (match_with_avoid_cursor
)
14032 cursor
= glyph_after
;
14035 else if (string_seen
)
14037 int incr
= row
->reversed_p
? -1 : +1;
14039 /* Need to find the glyph that came out of a string which is
14040 present at point. That glyph is somewhere between
14041 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14042 positioned between POS_BEFORE and POS_AFTER in the
14044 struct glyph
*start
, *stop
;
14045 ptrdiff_t pos
= pos_before
;
14049 /* If the row ends in a newline from a display string,
14050 reordering could have moved the glyphs belonging to the
14051 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14052 in this case we extend the search to the last glyph in
14053 the row that was not inserted by redisplay. */
14054 if (row
->ends_in_newline_from_string_p
)
14057 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14060 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14061 correspond to POS_BEFORE and POS_AFTER, respectively. We
14062 need START and STOP in the order that corresponds to the
14063 row's direction as given by its reversed_p flag. If the
14064 directionality of characters between POS_BEFORE and
14065 POS_AFTER is the opposite of the row's base direction,
14066 these characters will have been reordered for display,
14067 and we need to reverse START and STOP. */
14068 if (!row
->reversed_p
)
14070 start
= min (glyph_before
, glyph_after
);
14071 stop
= max (glyph_before
, glyph_after
);
14075 start
= max (glyph_before
, glyph_after
);
14076 stop
= min (glyph_before
, glyph_after
);
14078 for (glyph
= start
+ incr
;
14079 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14082 /* Any glyphs that come from the buffer are here because
14083 of bidi reordering. Skip them, and only pay
14084 attention to glyphs that came from some string. */
14085 if (STRINGP (glyph
->object
))
14089 /* If the display property covers the newline, we
14090 need to search for it one position farther. */
14091 ptrdiff_t lim
= pos_after
14092 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14094 string_from_text_prop
= 0;
14095 str
= glyph
->object
;
14096 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14097 if (tem
== 0 /* from overlay */
14100 /* If the string from which this glyph came is
14101 found in the buffer at point, or at position
14102 that is closer to point than pos_after, then
14103 we've found the glyph we've been looking for.
14104 If it comes from an overlay (tem == 0), and
14105 it has the `cursor' property on one of its
14106 glyphs, record that glyph as a candidate for
14107 displaying the cursor. (As in the
14108 unidirectional version, we will display the
14109 cursor on the last candidate we find.) */
14112 || (tem
- pt_old
> 0 && tem
< pos_after
))
14114 /* The glyphs from this string could have
14115 been reordered. Find the one with the
14116 smallest string position. Or there could
14117 be a character in the string with the
14118 `cursor' property, which means display
14119 cursor on that character's glyph. */
14120 ptrdiff_t strpos
= glyph
->charpos
;
14125 string_from_text_prop
= 1;
14128 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14129 && EQ (glyph
->object
, str
);
14133 ptrdiff_t gpos
= glyph
->charpos
;
14135 cprop
= Fget_char_property (make_number (gpos
),
14143 if (tem
&& glyph
->charpos
< strpos
)
14145 strpos
= glyph
->charpos
;
14151 || (tem
- pt_old
> 0 && tem
< pos_after
))
14155 pos
= tem
+ 1; /* don't find previous instances */
14157 /* This string is not what we want; skip all of the
14158 glyphs that came from it. */
14159 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14160 && EQ (glyph
->object
, str
))
14167 /* If we reached the end of the line, and END was from a string,
14168 the cursor is not on this line. */
14170 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14171 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14172 && STRINGP (end
->object
)
14173 && row
->continued_p
)
14176 /* A truncated row may not include PT among its character positions.
14177 Setting the cursor inside the scroll margin will trigger
14178 recalculation of hscroll in hscroll_window_tree. But if a
14179 display string covers point, defer to the string-handling
14180 code below to figure this out. */
14181 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14183 cursor
= glyph_before
;
14186 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14187 /* Zero-width characters produce no glyphs. */
14189 && (row
->reversed_p
14190 ? glyph_after
> glyphs_end
14191 : glyph_after
< glyphs_end
)))
14193 cursor
= glyph_after
;
14199 if (cursor
!= NULL
)
14201 else if (glyph
== glyphs_end
14202 && pos_before
== pos_after
14203 && STRINGP ((row
->reversed_p
14204 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14205 : row
->glyphs
[TEXT_AREA
])->object
))
14207 /* If all the glyphs of this row came from strings, put the
14208 cursor on the first glyph of the row. This avoids having the
14209 cursor outside of the text area in this very rare and hard
14213 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14214 : row
->glyphs
[TEXT_AREA
];
14220 /* Need to compute x that corresponds to GLYPH. */
14221 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14223 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14225 x
+= g
->pixel_width
;
14229 /* ROW could be part of a continued line, which, under bidi
14230 reordering, might have other rows whose start and end charpos
14231 occlude point. Only set w->cursor if we found a better
14232 approximation to the cursor position than we have from previously
14233 examined candidate rows belonging to the same continued line. */
14234 if (/* we already have a candidate row */
14235 w
->cursor
.vpos
>= 0
14236 /* that candidate is not the row we are processing */
14237 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14238 /* Make sure cursor.vpos specifies a row whose start and end
14239 charpos occlude point, and it is valid candidate for being a
14240 cursor-row. This is because some callers of this function
14241 leave cursor.vpos at the row where the cursor was displayed
14242 during the last redisplay cycle. */
14243 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14244 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14245 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14248 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14250 /* Don't consider glyphs that are outside TEXT_AREA. */
14251 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14253 /* Keep the candidate whose buffer position is the closest to
14254 point or has the `cursor' property. */
14255 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14256 w
->cursor
.hpos
>= 0
14257 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14258 && ((BUFFERP (g1
->object
)
14259 && (g1
->charpos
== pt_old
/* an exact match always wins */
14260 || (BUFFERP (glyph
->object
)
14261 && eabs (g1
->charpos
- pt_old
)
14262 < eabs (glyph
->charpos
- pt_old
))))
14263 /* previous candidate is a glyph from a string that has
14264 a non-nil `cursor' property */
14265 || (STRINGP (g1
->object
)
14266 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14267 Qcursor
, g1
->object
))
14268 /* previous candidate is from the same display
14269 string as this one, and the display string
14270 came from a text property */
14271 || (EQ (g1
->object
, glyph
->object
)
14272 && string_from_text_prop
)
14273 /* this candidate is from newline and its
14274 position is not an exact match */
14275 || (INTEGERP (glyph
->object
)
14276 && glyph
->charpos
!= pt_old
)))))
14278 /* If this candidate gives an exact match, use that. */
14279 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14280 /* If this candidate is a glyph created for the
14281 terminating newline of a line, and point is on that
14282 newline, it wins because it's an exact match. */
14283 || (!row
->continued_p
14284 && INTEGERP (glyph
->object
)
14285 && glyph
->charpos
== 0
14286 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14287 /* Otherwise, keep the candidate that comes from a row
14288 spanning less buffer positions. This may win when one or
14289 both candidate positions are on glyphs that came from
14290 display strings, for which we cannot compare buffer
14292 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14293 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14294 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14297 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14299 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14300 w
->cursor
.y
= row
->y
+ dy
;
14302 if (w
== XWINDOW (selected_window
))
14304 if (!row
->continued_p
14305 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14308 this_line_buffer
= XBUFFER (w
->contents
);
14310 CHARPOS (this_line_start_pos
)
14311 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14312 BYTEPOS (this_line_start_pos
)
14313 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14315 CHARPOS (this_line_end_pos
)
14316 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14317 BYTEPOS (this_line_end_pos
)
14318 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14320 this_line_y
= w
->cursor
.y
;
14321 this_line_pixel_height
= row
->height
;
14322 this_line_vpos
= w
->cursor
.vpos
;
14323 this_line_start_x
= row
->x
;
14326 CHARPOS (this_line_start_pos
) = 0;
14333 /* Run window scroll functions, if any, for WINDOW with new window
14334 start STARTP. Sets the window start of WINDOW to that position.
14336 We assume that the window's buffer is really current. */
14338 static struct text_pos
14339 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14341 struct window
*w
= XWINDOW (window
);
14342 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14344 if (current_buffer
!= XBUFFER (w
->contents
))
14347 if (!NILP (Vwindow_scroll_functions
))
14349 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14350 make_number (CHARPOS (startp
)));
14351 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14352 /* In case the hook functions switch buffers. */
14353 set_buffer_internal (XBUFFER (w
->contents
));
14360 /* Make sure the line containing the cursor is fully visible.
14361 A value of 1 means there is nothing to be done.
14362 (Either the line is fully visible, or it cannot be made so,
14363 or we cannot tell.)
14365 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14366 is higher than window.
14368 A value of 0 means the caller should do scrolling
14369 as if point had gone off the screen. */
14372 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14374 struct glyph_matrix
*matrix
;
14375 struct glyph_row
*row
;
14378 if (!make_cursor_line_fully_visible_p
)
14381 /* It's not always possible to find the cursor, e.g, when a window
14382 is full of overlay strings. Don't do anything in that case. */
14383 if (w
->cursor
.vpos
< 0)
14386 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14387 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14389 /* If the cursor row is not partially visible, there's nothing to do. */
14390 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14393 /* If the row the cursor is in is taller than the window's height,
14394 it's not clear what to do, so do nothing. */
14395 window_height
= window_box_height (w
);
14396 if (row
->height
>= window_height
)
14398 if (!force_p
|| MINI_WINDOW_P (w
)
14399 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14406 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14407 non-zero means only WINDOW is redisplayed in redisplay_internal.
14408 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14409 in redisplay_window to bring a partially visible line into view in
14410 the case that only the cursor has moved.
14412 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14413 last screen line's vertical height extends past the end of the screen.
14417 1 if scrolling succeeded
14419 0 if scrolling didn't find point.
14421 -1 if new fonts have been loaded so that we must interrupt
14422 redisplay, adjust glyph matrices, and try again. */
14428 SCROLLING_NEED_LARGER_MATRICES
14431 /* If scroll-conservatively is more than this, never recenter.
14433 If you change this, don't forget to update the doc string of
14434 `scroll-conservatively' and the Emacs manual. */
14435 #define SCROLL_LIMIT 100
14438 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14439 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14440 int temp_scroll_step
, int last_line_misfit
)
14442 struct window
*w
= XWINDOW (window
);
14443 struct frame
*f
= XFRAME (w
->frame
);
14444 struct text_pos pos
, startp
;
14446 int this_scroll_margin
, scroll_max
, rc
, height
;
14447 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14448 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14449 Lisp_Object aggressive
;
14450 /* We will never try scrolling more than this number of lines. */
14451 int scroll_limit
= SCROLL_LIMIT
;
14454 debug_method_add (w
, "try_scrolling");
14457 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14459 /* Compute scroll margin height in pixels. We scroll when point is
14460 within this distance from the top or bottom of the window. */
14461 if (scroll_margin
> 0)
14462 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14463 * FRAME_LINE_HEIGHT (f
);
14465 this_scroll_margin
= 0;
14467 /* Force arg_scroll_conservatively to have a reasonable value, to
14468 avoid scrolling too far away with slow move_it_* functions. Note
14469 that the user can supply scroll-conservatively equal to
14470 `most-positive-fixnum', which can be larger than INT_MAX. */
14471 if (arg_scroll_conservatively
> scroll_limit
)
14473 arg_scroll_conservatively
= scroll_limit
+ 1;
14474 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14476 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14477 /* Compute how much we should try to scroll maximally to bring
14478 point into view. */
14479 scroll_max
= (max (scroll_step
,
14480 max (arg_scroll_conservatively
, temp_scroll_step
))
14481 * FRAME_LINE_HEIGHT (f
));
14482 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14483 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14484 /* We're trying to scroll because of aggressive scrolling but no
14485 scroll_step is set. Choose an arbitrary one. */
14486 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14492 /* Decide whether to scroll down. */
14493 if (PT
> CHARPOS (startp
))
14495 int scroll_margin_y
;
14497 /* Compute the pixel ypos of the scroll margin, then move IT to
14498 either that ypos or PT, whichever comes first. */
14499 start_display (&it
, w
, startp
);
14500 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14501 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14502 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14503 (MOVE_TO_POS
| MOVE_TO_Y
));
14505 if (PT
> CHARPOS (it
.current
.pos
))
14507 int y0
= line_bottom_y (&it
);
14508 /* Compute how many pixels below window bottom to stop searching
14509 for PT. This avoids costly search for PT that is far away if
14510 the user limited scrolling by a small number of lines, but
14511 always finds PT if scroll_conservatively is set to a large
14512 number, such as most-positive-fixnum. */
14513 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14514 int y_to_move
= it
.last_visible_y
+ slack
;
14516 /* Compute the distance from the scroll margin to PT or to
14517 the scroll limit, whichever comes first. This should
14518 include the height of the cursor line, to make that line
14520 move_it_to (&it
, PT
, -1, y_to_move
,
14521 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14522 dy
= line_bottom_y (&it
) - y0
;
14524 if (dy
> scroll_max
)
14525 return SCROLLING_FAILED
;
14534 /* Point is in or below the bottom scroll margin, so move the
14535 window start down. If scrolling conservatively, move it just
14536 enough down to make point visible. If scroll_step is set,
14537 move it down by scroll_step. */
14538 if (arg_scroll_conservatively
)
14540 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14541 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14542 else if (scroll_step
|| temp_scroll_step
)
14543 amount_to_scroll
= scroll_max
;
14546 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14547 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14548 if (NUMBERP (aggressive
))
14550 double float_amount
= XFLOATINT (aggressive
) * height
;
14551 int aggressive_scroll
= float_amount
;
14552 if (aggressive_scroll
== 0 && float_amount
> 0)
14553 aggressive_scroll
= 1;
14554 /* Don't let point enter the scroll margin near top of
14555 the window. This could happen if the value of
14556 scroll_up_aggressively is too large and there are
14557 non-zero margins, because scroll_up_aggressively
14558 means put point that fraction of window height
14559 _from_the_bottom_margin_. */
14560 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14561 aggressive_scroll
= height
- 2*this_scroll_margin
;
14562 amount_to_scroll
= dy
+ aggressive_scroll
;
14566 if (amount_to_scroll
<= 0)
14567 return SCROLLING_FAILED
;
14569 start_display (&it
, w
, startp
);
14570 if (arg_scroll_conservatively
<= scroll_limit
)
14571 move_it_vertically (&it
, amount_to_scroll
);
14574 /* Extra precision for users who set scroll-conservatively
14575 to a large number: make sure the amount we scroll
14576 the window start is never less than amount_to_scroll,
14577 which was computed as distance from window bottom to
14578 point. This matters when lines at window top and lines
14579 below window bottom have different height. */
14581 void *it1data
= NULL
;
14582 /* We use a temporary it1 because line_bottom_y can modify
14583 its argument, if it moves one line down; see there. */
14586 SAVE_IT (it1
, it
, it1data
);
14587 start_y
= line_bottom_y (&it1
);
14589 RESTORE_IT (&it
, &it
, it1data
);
14590 move_it_by_lines (&it
, 1);
14591 SAVE_IT (it1
, it
, it1data
);
14592 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14595 /* If STARTP is unchanged, move it down another screen line. */
14596 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14597 move_it_by_lines (&it
, 1);
14598 startp
= it
.current
.pos
;
14602 struct text_pos scroll_margin_pos
= startp
;
14605 /* See if point is inside the scroll margin at the top of the
14607 if (this_scroll_margin
)
14611 start_display (&it
, w
, startp
);
14612 y_start
= it
.current_y
;
14613 move_it_vertically (&it
, this_scroll_margin
);
14614 scroll_margin_pos
= it
.current
.pos
;
14615 /* If we didn't move enough before hitting ZV, request
14616 additional amount of scroll, to move point out of the
14618 if (IT_CHARPOS (it
) == ZV
14619 && it
.current_y
- y_start
< this_scroll_margin
)
14620 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
14623 if (PT
< CHARPOS (scroll_margin_pos
))
14625 /* Point is in the scroll margin at the top of the window or
14626 above what is displayed in the window. */
14629 /* Compute the vertical distance from PT to the scroll
14630 margin position. Move as far as scroll_max allows, or
14631 one screenful, or 10 screen lines, whichever is largest.
14632 Give up if distance is greater than scroll_max or if we
14633 didn't reach the scroll margin position. */
14634 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14635 start_display (&it
, w
, pos
);
14637 y_to_move
= max (it
.last_visible_y
,
14638 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14639 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14641 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14642 dy
= it
.current_y
- y0
;
14643 if (dy
> scroll_max
14644 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
14645 return SCROLLING_FAILED
;
14647 /* Additional scroll for when ZV was too close to point. */
14650 /* Compute new window start. */
14651 start_display (&it
, w
, startp
);
14653 if (arg_scroll_conservatively
)
14654 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14655 max (scroll_step
, temp_scroll_step
));
14656 else if (scroll_step
|| temp_scroll_step
)
14657 amount_to_scroll
= scroll_max
;
14660 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14661 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14662 if (NUMBERP (aggressive
))
14664 double float_amount
= XFLOATINT (aggressive
) * height
;
14665 int aggressive_scroll
= float_amount
;
14666 if (aggressive_scroll
== 0 && float_amount
> 0)
14667 aggressive_scroll
= 1;
14668 /* Don't let point enter the scroll margin near
14669 bottom of the window, if the value of
14670 scroll_down_aggressively happens to be too
14672 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14673 aggressive_scroll
= height
- 2*this_scroll_margin
;
14674 amount_to_scroll
= dy
+ aggressive_scroll
;
14678 if (amount_to_scroll
<= 0)
14679 return SCROLLING_FAILED
;
14681 move_it_vertically_backward (&it
, amount_to_scroll
);
14682 startp
= it
.current
.pos
;
14686 /* Run window scroll functions. */
14687 startp
= run_window_scroll_functions (window
, startp
);
14689 /* Display the window. Give up if new fonts are loaded, or if point
14691 if (!try_window (window
, startp
, 0))
14692 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14693 else if (w
->cursor
.vpos
< 0)
14695 clear_glyph_matrix (w
->desired_matrix
);
14696 rc
= SCROLLING_FAILED
;
14700 /* Maybe forget recorded base line for line number display. */
14701 if (!just_this_one_p
14702 || current_buffer
->clip_changed
14703 || BEG_UNCHANGED
< CHARPOS (startp
))
14704 w
->base_line_number
= 0;
14706 /* If cursor ends up on a partially visible line,
14707 treat that as being off the bottom of the screen. */
14708 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14709 /* It's possible that the cursor is on the first line of the
14710 buffer, which is partially obscured due to a vscroll
14711 (Bug#7537). In that case, avoid looping forever . */
14712 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14714 clear_glyph_matrix (w
->desired_matrix
);
14715 ++extra_scroll_margin_lines
;
14718 rc
= SCROLLING_SUCCESS
;
14725 /* Compute a suitable window start for window W if display of W starts
14726 on a continuation line. Value is non-zero if a new window start
14729 The new window start will be computed, based on W's width, starting
14730 from the start of the continued line. It is the start of the
14731 screen line with the minimum distance from the old start W->start. */
14734 compute_window_start_on_continuation_line (struct window
*w
)
14736 struct text_pos pos
, start_pos
;
14737 int window_start_changed_p
= 0;
14739 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14741 /* If window start is on a continuation line... Window start may be
14742 < BEGV in case there's invisible text at the start of the
14743 buffer (M-x rmail, for example). */
14744 if (CHARPOS (start_pos
) > BEGV
14745 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14748 struct glyph_row
*row
;
14750 /* Handle the case that the window start is out of range. */
14751 if (CHARPOS (start_pos
) < BEGV
)
14752 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14753 else if (CHARPOS (start_pos
) > ZV
)
14754 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14756 /* Find the start of the continued line. This should be fast
14757 because find_newline is fast (newline cache). */
14758 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14759 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14760 row
, DEFAULT_FACE_ID
);
14761 reseat_at_previous_visible_line_start (&it
);
14763 /* If the line start is "too far" away from the window start,
14764 say it takes too much time to compute a new window start. */
14765 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14766 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14768 int min_distance
, distance
;
14770 /* Move forward by display lines to find the new window
14771 start. If window width was enlarged, the new start can
14772 be expected to be > the old start. If window width was
14773 decreased, the new window start will be < the old start.
14774 So, we're looking for the display line start with the
14775 minimum distance from the old window start. */
14776 pos
= it
.current
.pos
;
14777 min_distance
= INFINITY
;
14778 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14779 distance
< min_distance
)
14781 min_distance
= distance
;
14782 pos
= it
.current
.pos
;
14783 move_it_by_lines (&it
, 1);
14786 /* Set the window start there. */
14787 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14788 window_start_changed_p
= 1;
14792 return window_start_changed_p
;
14796 /* Try cursor movement in case text has not changed in window WINDOW,
14797 with window start STARTP. Value is
14799 CURSOR_MOVEMENT_SUCCESS if successful
14801 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14803 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14804 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14805 we want to scroll as if scroll-step were set to 1. See the code.
14807 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14808 which case we have to abort this redisplay, and adjust matrices
14813 CURSOR_MOVEMENT_SUCCESS
,
14814 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14815 CURSOR_MOVEMENT_MUST_SCROLL
,
14816 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14820 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14822 struct window
*w
= XWINDOW (window
);
14823 struct frame
*f
= XFRAME (w
->frame
);
14824 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14827 if (inhibit_try_cursor_movement
)
14831 /* Previously, there was a check for Lisp integer in the
14832 if-statement below. Now, this field is converted to
14833 ptrdiff_t, thus zero means invalid position in a buffer. */
14834 eassert (w
->last_point
> 0);
14836 /* Handle case where text has not changed, only point, and it has
14837 not moved off the frame. */
14838 if (/* Point may be in this window. */
14839 PT
>= CHARPOS (startp
)
14840 /* Selective display hasn't changed. */
14841 && !current_buffer
->clip_changed
14842 /* Function force-mode-line-update is used to force a thorough
14843 redisplay. It sets either windows_or_buffers_changed or
14844 update_mode_lines. So don't take a shortcut here for these
14846 && !update_mode_lines
14847 && !windows_or_buffers_changed
14848 && !cursor_type_changed
14849 /* Can't use this case if highlighting a region. When a
14850 region exists, cursor movement has to do more than just
14852 && markpos_of_region () < 0
14853 && !w
->region_showing
14854 && NILP (Vshow_trailing_whitespace
)
14855 /* This code is not used for mini-buffer for the sake of the case
14856 of redisplaying to replace an echo area message; since in
14857 that case the mini-buffer contents per se are usually
14858 unchanged. This code is of no real use in the mini-buffer
14859 since the handling of this_line_start_pos, etc., in redisplay
14860 handles the same cases. */
14861 && !EQ (window
, minibuf_window
)
14862 /* When splitting windows or for new windows, it happens that
14863 redisplay is called with a nil window_end_vpos or one being
14864 larger than the window. This should really be fixed in
14865 window.c. I don't have this on my list, now, so we do
14866 approximately the same as the old redisplay code. --gerd. */
14867 && INTEGERP (w
->window_end_vpos
)
14868 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14869 && (FRAME_WINDOW_P (f
)
14870 || !overlay_arrow_in_current_buffer_p ()))
14872 int this_scroll_margin
, top_scroll_margin
;
14873 struct glyph_row
*row
= NULL
;
14876 debug_method_add (w
, "cursor movement");
14879 /* Scroll if point within this distance from the top or bottom
14880 of the window. This is a pixel value. */
14881 if (scroll_margin
> 0)
14883 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14884 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14887 this_scroll_margin
= 0;
14889 top_scroll_margin
= this_scroll_margin
;
14890 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14891 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14893 /* Start with the row the cursor was displayed during the last
14894 not paused redisplay. Give up if that row is not valid. */
14895 if (w
->last_cursor
.vpos
< 0
14896 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14897 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14900 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14901 if (row
->mode_line_p
)
14903 if (!row
->enabled_p
)
14904 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14907 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14909 int scroll_p
= 0, must_scroll
= 0;
14910 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14912 if (PT
> w
->last_point
)
14914 /* Point has moved forward. */
14915 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14916 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14918 eassert (row
->enabled_p
);
14922 /* If the end position of a row equals the start
14923 position of the next row, and PT is at that position,
14924 we would rather display cursor in the next line. */
14925 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14926 && MATRIX_ROW_END_CHARPOS (row
) == PT
14927 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
14928 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14929 && !cursor_row_p (row
))
14932 /* If within the scroll margin, scroll. Note that
14933 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14934 the next line would be drawn, and that
14935 this_scroll_margin can be zero. */
14936 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14937 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14938 /* Line is completely visible last line in window
14939 and PT is to be set in the next line. */
14940 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14941 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14942 && !row
->ends_at_zv_p
14943 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14946 else if (PT
< w
->last_point
)
14948 /* Cursor has to be moved backward. Note that PT >=
14949 CHARPOS (startp) because of the outer if-statement. */
14950 while (!row
->mode_line_p
14951 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14952 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14953 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14954 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14955 row
> w
->current_matrix
->rows
14956 && (row
-1)->ends_in_newline_from_string_p
))))
14957 && (row
->y
> top_scroll_margin
14958 || CHARPOS (startp
) == BEGV
))
14960 eassert (row
->enabled_p
);
14964 /* Consider the following case: Window starts at BEGV,
14965 there is invisible, intangible text at BEGV, so that
14966 display starts at some point START > BEGV. It can
14967 happen that we are called with PT somewhere between
14968 BEGV and START. Try to handle that case. */
14969 if (row
< w
->current_matrix
->rows
14970 || row
->mode_line_p
)
14972 row
= w
->current_matrix
->rows
;
14973 if (row
->mode_line_p
)
14977 /* Due to newlines in overlay strings, we may have to
14978 skip forward over overlay strings. */
14979 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14980 && MATRIX_ROW_END_CHARPOS (row
) == PT
14981 && !cursor_row_p (row
))
14984 /* If within the scroll margin, scroll. */
14985 if (row
->y
< top_scroll_margin
14986 && CHARPOS (startp
) != BEGV
)
14991 /* Cursor did not move. So don't scroll even if cursor line
14992 is partially visible, as it was so before. */
14993 rc
= CURSOR_MOVEMENT_SUCCESS
;
14996 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14997 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14999 /* if PT is not in the glyph row, give up. */
15000 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15003 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15004 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15006 struct glyph_row
*row1
;
15008 /* If rows are bidi-reordered and point moved, back up
15009 until we find a row that does not belong to a
15010 continuation line. This is because we must consider
15011 all rows of a continued line as candidates for the
15012 new cursor positioning, since row start and end
15013 positions change non-linearly with vertical position
15015 /* FIXME: Revisit this when glyph ``spilling'' in
15016 continuation lines' rows is implemented for
15017 bidi-reordered rows. */
15018 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15019 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15022 /* If we hit the beginning of the displayed portion
15023 without finding the first row of a continued
15027 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15030 eassert (row
->enabled_p
);
15035 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15036 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15037 /* Make sure this isn't a header line by any chance, since
15038 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15039 && !row
->mode_line_p
15040 && make_cursor_line_fully_visible_p
)
15042 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15043 && !row
->ends_at_zv_p
15044 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15045 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15046 else if (row
->height
> window_box_height (w
))
15048 /* If we end up in a partially visible line, let's
15049 make it fully visible, except when it's taller
15050 than the window, in which case we can't do much
15053 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15057 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15058 if (!cursor_row_fully_visible_p (w
, 0, 1))
15059 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15061 rc
= CURSOR_MOVEMENT_SUCCESS
;
15065 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15066 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15067 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15069 /* With bidi-reordered rows, there could be more than
15070 one candidate row whose start and end positions
15071 occlude point. We need to let set_cursor_from_row
15072 find the best candidate. */
15073 /* FIXME: Revisit this when glyph ``spilling'' in
15074 continuation lines' rows is implemented for
15075 bidi-reordered rows. */
15080 int at_zv_p
= 0, exact_match_p
= 0;
15082 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15083 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15084 && cursor_row_p (row
))
15085 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15087 /* As soon as we've found the exact match for point,
15088 or the first suitable row whose ends_at_zv_p flag
15089 is set, we are done. */
15091 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15093 && w
->cursor
.hpos
>= 0
15094 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15097 struct glyph_row
*candidate
=
15098 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15100 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15101 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15104 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15105 || (INTEGERP (g
->object
)
15106 && (g
->charpos
== PT
15107 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15109 if (rv
&& (at_zv_p
|| exact_match_p
))
15111 rc
= CURSOR_MOVEMENT_SUCCESS
;
15114 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15118 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15119 || row
->continued_p
)
15120 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15121 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15122 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15123 /* If we didn't find any candidate rows, or exited the
15124 loop before all the candidates were examined, signal
15125 to the caller that this method failed. */
15126 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15128 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15129 && !row
->continued_p
))
15130 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15132 rc
= CURSOR_MOVEMENT_SUCCESS
;
15138 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15140 rc
= CURSOR_MOVEMENT_SUCCESS
;
15145 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15146 && MATRIX_ROW_START_CHARPOS (row
) == PT
15147 && cursor_row_p (row
));
15155 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15159 set_vertical_scroll_bar (struct window
*w
)
15161 ptrdiff_t start
, end
, whole
;
15163 /* Calculate the start and end positions for the current window.
15164 At some point, it would be nice to choose between scrollbars
15165 which reflect the whole buffer size, with special markers
15166 indicating narrowing, and scrollbars which reflect only the
15169 Note that mini-buffers sometimes aren't displaying any text. */
15170 if (!MINI_WINDOW_P (w
)
15171 || (w
== XWINDOW (minibuf_window
)
15172 && NILP (echo_area_buffer
[0])))
15174 struct buffer
*buf
= XBUFFER (w
->contents
);
15175 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15176 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15177 /* I don't think this is guaranteed to be right. For the
15178 moment, we'll pretend it is. */
15179 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15183 if (whole
< (end
- start
))
15184 whole
= end
- start
;
15187 start
= end
= whole
= 0;
15189 /* Indicate what this scroll bar ought to be displaying now. */
15190 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15191 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15192 (w
, end
- start
, whole
, start
);
15196 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15197 selected_window is redisplayed.
15199 We can return without actually redisplaying the window if
15200 fonts_changed_p. In that case, redisplay_internal will
15204 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15206 struct window
*w
= XWINDOW (window
);
15207 struct frame
*f
= XFRAME (w
->frame
);
15208 struct buffer
*buffer
= XBUFFER (w
->contents
);
15209 struct buffer
*old
= current_buffer
;
15210 struct text_pos lpoint
, opoint
, startp
;
15211 int update_mode_line
;
15214 /* Record it now because it's overwritten. */
15215 int current_matrix_up_to_date_p
= 0;
15216 int used_current_matrix_p
= 0;
15217 /* This is less strict than current_matrix_up_to_date_p.
15218 It indicates that the buffer contents and narrowing are unchanged. */
15219 int buffer_unchanged_p
= 0;
15220 int temp_scroll_step
= 0;
15221 ptrdiff_t count
= SPECPDL_INDEX ();
15223 int centering_position
= -1;
15224 int last_line_misfit
= 0;
15225 ptrdiff_t beg_unchanged
, end_unchanged
;
15227 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15231 *w
->desired_matrix
->method
= 0;
15234 /* Make sure that both W's markers are valid. */
15235 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15236 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15239 reconsider_clip_changes (w
, buffer
);
15241 /* Has the mode line to be updated? */
15242 update_mode_line
= (w
->update_mode_line
15243 || update_mode_lines
15244 || buffer
->clip_changed
15245 || buffer
->prevent_redisplay_optimizations_p
);
15247 if (MINI_WINDOW_P (w
))
15249 if (w
== XWINDOW (echo_area_window
)
15250 && !NILP (echo_area_buffer
[0]))
15252 if (update_mode_line
)
15253 /* We may have to update a tty frame's menu bar or a
15254 tool-bar. Example `M-x C-h C-h C-g'. */
15255 goto finish_menu_bars
;
15257 /* We've already displayed the echo area glyphs in this window. */
15258 goto finish_scroll_bars
;
15260 else if ((w
!= XWINDOW (minibuf_window
)
15261 || minibuf_level
== 0)
15262 /* When buffer is nonempty, redisplay window normally. */
15263 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15264 /* Quail displays non-mini buffers in minibuffer window.
15265 In that case, redisplay the window normally. */
15266 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15268 /* W is a mini-buffer window, but it's not active, so clear
15270 int yb
= window_text_bottom_y (w
);
15271 struct glyph_row
*row
;
15274 for (y
= 0, row
= w
->desired_matrix
->rows
;
15276 y
+= row
->height
, ++row
)
15277 blank_row (w
, row
, y
);
15278 goto finish_scroll_bars
;
15281 clear_glyph_matrix (w
->desired_matrix
);
15284 /* Otherwise set up data on this window; select its buffer and point
15286 /* Really select the buffer, for the sake of buffer-local
15288 set_buffer_internal_1 (XBUFFER (w
->contents
));
15290 current_matrix_up_to_date_p
15291 = (w
->window_end_valid
15292 && !current_buffer
->clip_changed
15293 && !current_buffer
->prevent_redisplay_optimizations_p
15294 && !window_outdated (w
));
15296 /* Run the window-bottom-change-functions
15297 if it is possible that the text on the screen has changed
15298 (either due to modification of the text, or any other reason). */
15299 if (!current_matrix_up_to_date_p
15300 && !NILP (Vwindow_text_change_functions
))
15302 safe_run_hooks (Qwindow_text_change_functions
);
15306 beg_unchanged
= BEG_UNCHANGED
;
15307 end_unchanged
= END_UNCHANGED
;
15309 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15311 specbind (Qinhibit_point_motion_hooks
, Qt
);
15314 = (w
->window_end_valid
15315 && !current_buffer
->clip_changed
15316 && !window_outdated (w
));
15318 /* When windows_or_buffers_changed is non-zero, we can't rely on
15319 the window end being valid, so set it to nil there. */
15320 if (windows_or_buffers_changed
)
15322 /* If window starts on a continuation line, maybe adjust the
15323 window start in case the window's width changed. */
15324 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15325 compute_window_start_on_continuation_line (w
);
15327 w
->window_end_valid
= 0;
15330 /* Some sanity checks. */
15331 CHECK_WINDOW_END (w
);
15332 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15334 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15337 if (mode_line_update_needed (w
))
15338 update_mode_line
= 1;
15340 /* Point refers normally to the selected window. For any other
15341 window, set up appropriate value. */
15342 if (!EQ (window
, selected_window
))
15344 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15345 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15349 new_pt_byte
= BEGV_BYTE
;
15350 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15352 else if (new_pt
> (ZV
- 1))
15355 new_pt_byte
= ZV_BYTE
;
15356 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15359 /* We don't use SET_PT so that the point-motion hooks don't run. */
15360 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15363 /* If any of the character widths specified in the display table
15364 have changed, invalidate the width run cache. It's true that
15365 this may be a bit late to catch such changes, but the rest of
15366 redisplay goes (non-fatally) haywire when the display table is
15367 changed, so why should we worry about doing any better? */
15368 if (current_buffer
->width_run_cache
)
15370 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15372 if (! disptab_matches_widthtab
15373 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15375 invalidate_region_cache (current_buffer
,
15376 current_buffer
->width_run_cache
,
15378 recompute_width_table (current_buffer
, disptab
);
15382 /* If window-start is screwed up, choose a new one. */
15383 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15386 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15388 /* If someone specified a new starting point but did not insist,
15389 check whether it can be used. */
15390 if (w
->optional_new_start
15391 && CHARPOS (startp
) >= BEGV
15392 && CHARPOS (startp
) <= ZV
)
15394 w
->optional_new_start
= 0;
15395 start_display (&it
, w
, startp
);
15396 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15397 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15398 if (IT_CHARPOS (it
) == PT
)
15399 w
->force_start
= 1;
15400 /* IT may overshoot PT if text at PT is invisible. */
15401 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15402 w
->force_start
= 1;
15407 /* Handle case where place to start displaying has been specified,
15408 unless the specified location is outside the accessible range. */
15409 if (w
->force_start
|| w
->frozen_window_start_p
)
15411 /* We set this later on if we have to adjust point. */
15414 w
->force_start
= 0;
15416 w
->window_end_valid
= 0;
15418 /* Forget any recorded base line for line number display. */
15419 if (!buffer_unchanged_p
)
15420 w
->base_line_number
= 0;
15422 /* Redisplay the mode line. Select the buffer properly for that.
15423 Also, run the hook window-scroll-functions
15424 because we have scrolled. */
15425 /* Note, we do this after clearing force_start because
15426 if there's an error, it is better to forget about force_start
15427 than to get into an infinite loop calling the hook functions
15428 and having them get more errors. */
15429 if (!update_mode_line
15430 || ! NILP (Vwindow_scroll_functions
))
15432 update_mode_line
= 1;
15433 w
->update_mode_line
= 1;
15434 startp
= run_window_scroll_functions (window
, startp
);
15437 w
->last_modified
= 0;
15438 w
->last_overlay_modified
= 0;
15439 if (CHARPOS (startp
) < BEGV
)
15440 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15441 else if (CHARPOS (startp
) > ZV
)
15442 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15444 /* Redisplay, then check if cursor has been set during the
15445 redisplay. Give up if new fonts were loaded. */
15446 /* We used to issue a CHECK_MARGINS argument to try_window here,
15447 but this causes scrolling to fail when point begins inside
15448 the scroll margin (bug#148) -- cyd */
15449 if (!try_window (window
, startp
, 0))
15451 w
->force_start
= 1;
15452 clear_glyph_matrix (w
->desired_matrix
);
15453 goto need_larger_matrices
;
15456 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15458 /* If point does not appear, try to move point so it does
15459 appear. The desired matrix has been built above, so we
15460 can use it here. */
15461 new_vpos
= window_box_height (w
) / 2;
15464 if (!cursor_row_fully_visible_p (w
, 0, 0))
15466 /* Point does appear, but on a line partly visible at end of window.
15467 Move it back to a fully-visible line. */
15468 new_vpos
= window_box_height (w
);
15470 else if (w
->cursor
.vpos
>=0)
15472 /* Some people insist on not letting point enter the scroll
15473 margin, even though this part handles windows that didn't
15475 int margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15476 int pixel_margin
= margin
* FRAME_LINE_HEIGHT (f
);
15477 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
15479 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
15480 below, which finds the row to move point to, advances by
15481 the Y coordinate of the _next_ row, see the definition of
15482 MATRIX_ROW_BOTTOM_Y. */
15483 if (w
->cursor
.vpos
< margin
+ header_line
)
15485 = pixel_margin
+ (header_line
15486 ? CURRENT_HEADER_LINE_HEIGHT (w
)
15487 : 0) + FRAME_LINE_HEIGHT (f
);
15490 int window_height
= window_box_height (w
);
15493 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15494 if (w
->cursor
.y
>= window_height
- pixel_margin
)
15495 new_vpos
= window_height
- pixel_margin
;
15499 /* If we need to move point for either of the above reasons,
15500 now actually do it. */
15503 struct glyph_row
*row
;
15505 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15506 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15509 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15510 MATRIX_ROW_START_BYTEPOS (row
));
15512 if (w
!= XWINDOW (selected_window
))
15513 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15514 else if (current_buffer
== old
)
15515 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15517 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15519 /* If we are highlighting the region, then we just changed
15520 the region, so redisplay to show it. */
15521 if (markpos_of_region () >= 0)
15523 clear_glyph_matrix (w
->desired_matrix
);
15524 if (!try_window (window
, startp
, 0))
15525 goto need_larger_matrices
;
15530 debug_method_add (w
, "forced window start");
15535 /* Handle case where text has not changed, only point, and it has
15536 not moved off the frame, and we are not retrying after hscroll.
15537 (current_matrix_up_to_date_p is nonzero when retrying.) */
15538 if (current_matrix_up_to_date_p
15539 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15540 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15544 case CURSOR_MOVEMENT_SUCCESS
:
15545 used_current_matrix_p
= 1;
15548 case CURSOR_MOVEMENT_MUST_SCROLL
:
15549 goto try_to_scroll
;
15555 /* If current starting point was originally the beginning of a line
15556 but no longer is, find a new starting point. */
15557 else if (w
->start_at_line_beg
15558 && !(CHARPOS (startp
) <= BEGV
15559 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15562 debug_method_add (w
, "recenter 1");
15567 /* Try scrolling with try_window_id. Value is > 0 if update has
15568 been done, it is -1 if we know that the same window start will
15569 not work. It is 0 if unsuccessful for some other reason. */
15570 else if ((tem
= try_window_id (w
)) != 0)
15573 debug_method_add (w
, "try_window_id %d", tem
);
15576 if (fonts_changed_p
)
15577 goto need_larger_matrices
;
15581 /* Otherwise try_window_id has returned -1 which means that we
15582 don't want the alternative below this comment to execute. */
15584 else if (CHARPOS (startp
) >= BEGV
15585 && CHARPOS (startp
) <= ZV
15586 && PT
>= CHARPOS (startp
)
15587 && (CHARPOS (startp
) < ZV
15588 /* Avoid starting at end of buffer. */
15589 || CHARPOS (startp
) == BEGV
15590 || !window_outdated (w
)))
15592 int d1
, d2
, d3
, d4
, d5
, d6
;
15594 /* If first window line is a continuation line, and window start
15595 is inside the modified region, but the first change is before
15596 current window start, we must select a new window start.
15598 However, if this is the result of a down-mouse event (e.g. by
15599 extending the mouse-drag-overlay), we don't want to select a
15600 new window start, since that would change the position under
15601 the mouse, resulting in an unwanted mouse-movement rather
15602 than a simple mouse-click. */
15603 if (!w
->start_at_line_beg
15604 && NILP (do_mouse_tracking
)
15605 && CHARPOS (startp
) > BEGV
15606 && CHARPOS (startp
) > BEG
+ beg_unchanged
15607 && CHARPOS (startp
) <= Z
- end_unchanged
15608 /* Even if w->start_at_line_beg is nil, a new window may
15609 start at a line_beg, since that's how set_buffer_window
15610 sets it. So, we need to check the return value of
15611 compute_window_start_on_continuation_line. (See also
15613 && XMARKER (w
->start
)->buffer
== current_buffer
15614 && compute_window_start_on_continuation_line (w
)
15615 /* It doesn't make sense to force the window start like we
15616 do at label force_start if it is already known that point
15617 will not be visible in the resulting window, because
15618 doing so will move point from its correct position
15619 instead of scrolling the window to bring point into view.
15621 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15623 w
->force_start
= 1;
15624 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15629 debug_method_add (w
, "same window start");
15632 /* Try to redisplay starting at same place as before.
15633 If point has not moved off frame, accept the results. */
15634 if (!current_matrix_up_to_date_p
15635 /* Don't use try_window_reusing_current_matrix in this case
15636 because a window scroll function can have changed the
15638 || !NILP (Vwindow_scroll_functions
)
15639 || MINI_WINDOW_P (w
)
15640 || !(used_current_matrix_p
15641 = try_window_reusing_current_matrix (w
)))
15643 IF_DEBUG (debug_method_add (w
, "1"));
15644 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15645 /* -1 means we need to scroll.
15646 0 means we need new matrices, but fonts_changed_p
15647 is set in that case, so we will detect it below. */
15648 goto try_to_scroll
;
15651 if (fonts_changed_p
)
15652 goto need_larger_matrices
;
15654 if (w
->cursor
.vpos
>= 0)
15656 if (!just_this_one_p
15657 || current_buffer
->clip_changed
15658 || BEG_UNCHANGED
< CHARPOS (startp
))
15659 /* Forget any recorded base line for line number display. */
15660 w
->base_line_number
= 0;
15662 if (!cursor_row_fully_visible_p (w
, 1, 0))
15664 clear_glyph_matrix (w
->desired_matrix
);
15665 last_line_misfit
= 1;
15667 /* Drop through and scroll. */
15672 clear_glyph_matrix (w
->desired_matrix
);
15677 w
->last_modified
= 0;
15678 w
->last_overlay_modified
= 0;
15680 /* Redisplay the mode line. Select the buffer properly for that. */
15681 if (!update_mode_line
)
15683 update_mode_line
= 1;
15684 w
->update_mode_line
= 1;
15687 /* Try to scroll by specified few lines. */
15688 if ((scroll_conservatively
15689 || emacs_scroll_step
15690 || temp_scroll_step
15691 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15692 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15693 && CHARPOS (startp
) >= BEGV
15694 && CHARPOS (startp
) <= ZV
)
15696 /* The function returns -1 if new fonts were loaded, 1 if
15697 successful, 0 if not successful. */
15698 int ss
= try_scrolling (window
, just_this_one_p
,
15699 scroll_conservatively
,
15701 temp_scroll_step
, last_line_misfit
);
15704 case SCROLLING_SUCCESS
:
15707 case SCROLLING_NEED_LARGER_MATRICES
:
15708 goto need_larger_matrices
;
15710 case SCROLLING_FAILED
:
15718 /* Finally, just choose a place to start which positions point
15719 according to user preferences. */
15724 debug_method_add (w
, "recenter");
15727 /* Forget any previously recorded base line for line number display. */
15728 if (!buffer_unchanged_p
)
15729 w
->base_line_number
= 0;
15731 /* Determine the window start relative to point. */
15732 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15733 it
.current_y
= it
.last_visible_y
;
15734 if (centering_position
< 0)
15738 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15740 ptrdiff_t margin_pos
= CHARPOS (startp
);
15741 Lisp_Object aggressive
;
15744 /* If there is a scroll margin at the top of the window, find
15745 its character position. */
15747 /* Cannot call start_display if startp is not in the
15748 accessible region of the buffer. This can happen when we
15749 have just switched to a different buffer and/or changed
15750 its restriction. In that case, startp is initialized to
15751 the character position 1 (BEGV) because we did not yet
15752 have chance to display the buffer even once. */
15753 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15756 void *it1data
= NULL
;
15758 SAVE_IT (it1
, it
, it1data
);
15759 start_display (&it1
, w
, startp
);
15760 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15761 margin_pos
= IT_CHARPOS (it1
);
15762 RESTORE_IT (&it
, &it
, it1data
);
15764 scrolling_up
= PT
> margin_pos
;
15767 ? BVAR (current_buffer
, scroll_up_aggressively
)
15768 : BVAR (current_buffer
, scroll_down_aggressively
);
15770 if (!MINI_WINDOW_P (w
)
15771 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15775 /* Setting scroll-conservatively overrides
15776 scroll-*-aggressively. */
15777 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15779 double float_amount
= XFLOATINT (aggressive
);
15781 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15782 if (pt_offset
== 0 && float_amount
> 0)
15784 if (pt_offset
&& margin
> 0)
15787 /* Compute how much to move the window start backward from
15788 point so that point will be displayed where the user
15792 centering_position
= it
.last_visible_y
;
15794 centering_position
-= pt_offset
;
15795 centering_position
-=
15796 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15797 + WINDOW_HEADER_LINE_HEIGHT (w
);
15798 /* Don't let point enter the scroll margin near top of
15800 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15801 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15804 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15807 /* Set the window start half the height of the window backward
15809 centering_position
= window_box_height (w
) / 2;
15811 move_it_vertically_backward (&it
, centering_position
);
15813 eassert (IT_CHARPOS (it
) >= BEGV
);
15815 /* The function move_it_vertically_backward may move over more
15816 than the specified y-distance. If it->w is small, e.g. a
15817 mini-buffer window, we may end up in front of the window's
15818 display area. Start displaying at the start of the line
15819 containing PT in this case. */
15820 if (it
.current_y
<= 0)
15822 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15823 move_it_vertically_backward (&it
, 0);
15827 it
.current_x
= it
.hpos
= 0;
15829 /* Set the window start position here explicitly, to avoid an
15830 infinite loop in case the functions in window-scroll-functions
15832 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15834 /* Run scroll hooks. */
15835 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15837 /* Redisplay the window. */
15838 if (!current_matrix_up_to_date_p
15839 || windows_or_buffers_changed
15840 || cursor_type_changed
15841 /* Don't use try_window_reusing_current_matrix in this case
15842 because it can have changed the buffer. */
15843 || !NILP (Vwindow_scroll_functions
)
15844 || !just_this_one_p
15845 || MINI_WINDOW_P (w
)
15846 || !(used_current_matrix_p
15847 = try_window_reusing_current_matrix (w
)))
15848 try_window (window
, startp
, 0);
15850 /* If new fonts have been loaded (due to fontsets), give up. We
15851 have to start a new redisplay since we need to re-adjust glyph
15853 if (fonts_changed_p
)
15854 goto need_larger_matrices
;
15856 /* If cursor did not appear assume that the middle of the window is
15857 in the first line of the window. Do it again with the next line.
15858 (Imagine a window of height 100, displaying two lines of height
15859 60. Moving back 50 from it->last_visible_y will end in the first
15861 if (w
->cursor
.vpos
< 0)
15863 if (w
->window_end_valid
&& PT
>= Z
- XFASTINT (w
->window_end_pos
))
15865 clear_glyph_matrix (w
->desired_matrix
);
15866 move_it_by_lines (&it
, 1);
15867 try_window (window
, it
.current
.pos
, 0);
15869 else if (PT
< IT_CHARPOS (it
))
15871 clear_glyph_matrix (w
->desired_matrix
);
15872 move_it_by_lines (&it
, -1);
15873 try_window (window
, it
.current
.pos
, 0);
15877 /* Not much we can do about it. */
15881 /* Consider the following case: Window starts at BEGV, there is
15882 invisible, intangible text at BEGV, so that display starts at
15883 some point START > BEGV. It can happen that we are called with
15884 PT somewhere between BEGV and START. Try to handle that case. */
15885 if (w
->cursor
.vpos
< 0)
15887 struct glyph_row
*row
= w
->current_matrix
->rows
;
15888 if (row
->mode_line_p
)
15890 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15893 if (!cursor_row_fully_visible_p (w
, 0, 0))
15895 /* If vscroll is enabled, disable it and try again. */
15899 clear_glyph_matrix (w
->desired_matrix
);
15903 /* Users who set scroll-conservatively to a large number want
15904 point just above/below the scroll margin. If we ended up
15905 with point's row partially visible, move the window start to
15906 make that row fully visible and out of the margin. */
15907 if (scroll_conservatively
> SCROLL_LIMIT
)
15911 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15913 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
15915 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
15916 clear_glyph_matrix (w
->desired_matrix
);
15917 if (1 == try_window (window
, it
.current
.pos
,
15918 TRY_WINDOW_CHECK_MARGINS
))
15922 /* If centering point failed to make the whole line visible,
15923 put point at the top instead. That has to make the whole line
15924 visible, if it can be done. */
15925 if (centering_position
== 0)
15928 clear_glyph_matrix (w
->desired_matrix
);
15929 centering_position
= 0;
15935 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15936 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
15937 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
15939 /* Display the mode line, if we must. */
15940 if ((update_mode_line
15941 /* If window not full width, must redo its mode line
15942 if (a) the window to its side is being redone and
15943 (b) we do a frame-based redisplay. This is a consequence
15944 of how inverted lines are drawn in frame-based redisplay. */
15945 || (!just_this_one_p
15946 && !FRAME_WINDOW_P (f
)
15947 && !WINDOW_FULL_WIDTH_P (w
))
15948 /* Line number to display. */
15949 || w
->base_line_pos
> 0
15950 /* Column number is displayed and different from the one displayed. */
15951 || (w
->column_number_displayed
!= -1
15952 && (w
->column_number_displayed
!= current_column ())))
15953 /* This means that the window has a mode line. */
15954 && (WINDOW_WANTS_MODELINE_P (w
)
15955 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15957 display_mode_lines (w
);
15959 /* If mode line height has changed, arrange for a thorough
15960 immediate redisplay using the correct mode line height. */
15961 if (WINDOW_WANTS_MODELINE_P (w
)
15962 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15964 fonts_changed_p
= 1;
15965 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15966 = DESIRED_MODE_LINE_HEIGHT (w
);
15969 /* If header line height has changed, arrange for a thorough
15970 immediate redisplay using the correct header line height. */
15971 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15972 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15974 fonts_changed_p
= 1;
15975 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15976 = DESIRED_HEADER_LINE_HEIGHT (w
);
15979 if (fonts_changed_p
)
15980 goto need_larger_matrices
;
15983 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
15985 w
->base_line_pos
= 0;
15986 w
->base_line_number
= 0;
15991 /* When we reach a frame's selected window, redo the frame's menu bar. */
15992 if (update_mode_line
15993 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15995 int redisplay_menu_p
= 0;
15997 if (FRAME_WINDOW_P (f
))
15999 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16000 || defined (HAVE_NS) || defined (USE_GTK)
16001 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16003 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16007 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16009 if (redisplay_menu_p
)
16010 display_menu_bar (w
);
16012 #ifdef HAVE_WINDOW_SYSTEM
16013 if (FRAME_WINDOW_P (f
))
16015 #if defined (USE_GTK) || defined (HAVE_NS)
16016 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16017 redisplay_tool_bar (f
);
16019 if (WINDOWP (f
->tool_bar_window
)
16020 && (FRAME_TOOL_BAR_LINES (f
) > 0
16021 || !NILP (Vauto_resize_tool_bars
))
16022 && redisplay_tool_bar (f
))
16023 ignore_mouse_drag_p
= 1;
16029 #ifdef HAVE_WINDOW_SYSTEM
16030 if (FRAME_WINDOW_P (f
)
16031 && update_window_fringes (w
, (just_this_one_p
16032 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16033 || w
->pseudo_window_p
)))
16037 if (draw_window_fringes (w
, 1))
16038 x_draw_vertical_border (w
);
16042 #endif /* HAVE_WINDOW_SYSTEM */
16044 /* We go to this label, with fonts_changed_p set,
16045 if it is necessary to try again using larger glyph matrices.
16046 We have to redeem the scroll bar even in this case,
16047 because the loop in redisplay_internal expects that. */
16048 need_larger_matrices
:
16050 finish_scroll_bars
:
16052 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16054 /* Set the thumb's position and size. */
16055 set_vertical_scroll_bar (w
);
16057 /* Note that we actually used the scroll bar attached to this
16058 window, so it shouldn't be deleted at the end of redisplay. */
16059 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16060 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16063 /* Restore current_buffer and value of point in it. The window
16064 update may have changed the buffer, so first make sure `opoint'
16065 is still valid (Bug#6177). */
16066 if (CHARPOS (opoint
) < BEGV
)
16067 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16068 else if (CHARPOS (opoint
) > ZV
)
16069 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16071 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16073 set_buffer_internal_1 (old
);
16074 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16075 shorter. This can be caused by log truncation in *Messages*. */
16076 if (CHARPOS (lpoint
) <= ZV
)
16077 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16079 unbind_to (count
, Qnil
);
16083 /* Build the complete desired matrix of WINDOW with a window start
16084 buffer position POS.
16086 Value is 1 if successful. It is zero if fonts were loaded during
16087 redisplay which makes re-adjusting glyph matrices necessary, and -1
16088 if point would appear in the scroll margins.
16089 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16090 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16094 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16096 struct window
*w
= XWINDOW (window
);
16098 struct glyph_row
*last_text_row
= NULL
;
16099 struct frame
*f
= XFRAME (w
->frame
);
16101 /* Make POS the new window start. */
16102 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16104 /* Mark cursor position as unknown. No overlay arrow seen. */
16105 w
->cursor
.vpos
= -1;
16106 overlay_arrow_seen
= 0;
16108 /* Initialize iterator and info to start at POS. */
16109 start_display (&it
, w
, pos
);
16111 /* Display all lines of W. */
16112 while (it
.current_y
< it
.last_visible_y
)
16114 if (display_line (&it
))
16115 last_text_row
= it
.glyph_row
- 1;
16116 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16120 /* Don't let the cursor end in the scroll margins. */
16121 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16122 && !MINI_WINDOW_P (w
))
16124 int this_scroll_margin
;
16126 if (scroll_margin
> 0)
16128 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16129 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16132 this_scroll_margin
= 0;
16134 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16135 && w
->cursor
.y
< this_scroll_margin
16136 && CHARPOS (pos
) > BEGV
16137 && IT_CHARPOS (it
) < ZV
)
16138 /* rms: considering make_cursor_line_fully_visible_p here
16139 seems to give wrong results. We don't want to recenter
16140 when the last line is partly visible, we want to allow
16141 that case to be handled in the usual way. */
16142 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16144 w
->cursor
.vpos
= -1;
16145 clear_glyph_matrix (w
->desired_matrix
);
16150 /* If bottom moved off end of frame, change mode line percentage. */
16151 if (XFASTINT (w
->window_end_pos
) <= 0
16152 && Z
!= IT_CHARPOS (it
))
16153 w
->update_mode_line
= 1;
16155 /* Set window_end_pos to the offset of the last character displayed
16156 on the window from the end of current_buffer. Set
16157 window_end_vpos to its row number. */
16160 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16161 w
->window_end_bytepos
16162 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16163 wset_window_end_pos
16164 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16165 wset_window_end_vpos
16166 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
)));
16168 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16169 XFASTINT (w
->window_end_vpos
))));
16173 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16174 wset_window_end_pos (w
, make_number (Z
- ZV
));
16175 wset_window_end_vpos (w
, make_number (0));
16178 /* But that is not valid info until redisplay finishes. */
16179 w
->window_end_valid
= 0;
16185 /************************************************************************
16186 Window redisplay reusing current matrix when buffer has not changed
16187 ************************************************************************/
16189 /* Try redisplay of window W showing an unchanged buffer with a
16190 different window start than the last time it was displayed by
16191 reusing its current matrix. Value is non-zero if successful.
16192 W->start is the new window start. */
16195 try_window_reusing_current_matrix (struct window
*w
)
16197 struct frame
*f
= XFRAME (w
->frame
);
16198 struct glyph_row
*bottom_row
;
16201 struct text_pos start
, new_start
;
16202 int nrows_scrolled
, i
;
16203 struct glyph_row
*last_text_row
;
16204 struct glyph_row
*last_reused_text_row
;
16205 struct glyph_row
*start_row
;
16206 int start_vpos
, min_y
, max_y
;
16209 if (inhibit_try_window_reusing
)
16213 if (/* This function doesn't handle terminal frames. */
16214 !FRAME_WINDOW_P (f
)
16215 /* Don't try to reuse the display if windows have been split
16217 || windows_or_buffers_changed
16218 || cursor_type_changed
)
16221 /* Can't do this if region may have changed. */
16222 if (markpos_of_region () >= 0
16223 || w
->region_showing
16224 || !NILP (Vshow_trailing_whitespace
))
16227 /* If top-line visibility has changed, give up. */
16228 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16229 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16232 /* Give up if old or new display is scrolled vertically. We could
16233 make this function handle this, but right now it doesn't. */
16234 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16235 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16238 /* The variable new_start now holds the new window start. The old
16239 start `start' can be determined from the current matrix. */
16240 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16241 start
= start_row
->minpos
;
16242 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16244 /* Clear the desired matrix for the display below. */
16245 clear_glyph_matrix (w
->desired_matrix
);
16247 if (CHARPOS (new_start
) <= CHARPOS (start
))
16249 /* Don't use this method if the display starts with an ellipsis
16250 displayed for invisible text. It's not easy to handle that case
16251 below, and it's certainly not worth the effort since this is
16252 not a frequent case. */
16253 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16256 IF_DEBUG (debug_method_add (w
, "twu1"));
16258 /* Display up to a row that can be reused. The variable
16259 last_text_row is set to the last row displayed that displays
16260 text. Note that it.vpos == 0 if or if not there is a
16261 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16262 start_display (&it
, w
, new_start
);
16263 w
->cursor
.vpos
= -1;
16264 last_text_row
= last_reused_text_row
= NULL
;
16266 while (it
.current_y
< it
.last_visible_y
16267 && !fonts_changed_p
)
16269 /* If we have reached into the characters in the START row,
16270 that means the line boundaries have changed. So we
16271 can't start copying with the row START. Maybe it will
16272 work to start copying with the following row. */
16273 while (IT_CHARPOS (it
) > CHARPOS (start
))
16275 /* Advance to the next row as the "start". */
16277 start
= start_row
->minpos
;
16278 /* If there are no more rows to try, or just one, give up. */
16279 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16280 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16281 || CHARPOS (start
) == ZV
)
16283 clear_glyph_matrix (w
->desired_matrix
);
16287 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16289 /* If we have reached alignment, we can copy the rest of the
16291 if (IT_CHARPOS (it
) == CHARPOS (start
)
16292 /* Don't accept "alignment" inside a display vector,
16293 since start_row could have started in the middle of
16294 that same display vector (thus their character
16295 positions match), and we have no way of telling if
16296 that is the case. */
16297 && it
.current
.dpvec_index
< 0)
16300 if (display_line (&it
))
16301 last_text_row
= it
.glyph_row
- 1;
16305 /* A value of current_y < last_visible_y means that we stopped
16306 at the previous window start, which in turn means that we
16307 have at least one reusable row. */
16308 if (it
.current_y
< it
.last_visible_y
)
16310 struct glyph_row
*row
;
16312 /* IT.vpos always starts from 0; it counts text lines. */
16313 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16315 /* Find PT if not already found in the lines displayed. */
16316 if (w
->cursor
.vpos
< 0)
16318 int dy
= it
.current_y
- start_row
->y
;
16320 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16321 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16323 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16324 dy
, nrows_scrolled
);
16327 clear_glyph_matrix (w
->desired_matrix
);
16332 /* Scroll the display. Do it before the current matrix is
16333 changed. The problem here is that update has not yet
16334 run, i.e. part of the current matrix is not up to date.
16335 scroll_run_hook will clear the cursor, and use the
16336 current matrix to get the height of the row the cursor is
16338 run
.current_y
= start_row
->y
;
16339 run
.desired_y
= it
.current_y
;
16340 run
.height
= it
.last_visible_y
- it
.current_y
;
16342 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16345 FRAME_RIF (f
)->update_window_begin_hook (w
);
16346 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16347 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16348 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16352 /* Shift current matrix down by nrows_scrolled lines. */
16353 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16354 rotate_matrix (w
->current_matrix
,
16356 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16359 /* Disable lines that must be updated. */
16360 for (i
= 0; i
< nrows_scrolled
; ++i
)
16361 (start_row
+ i
)->enabled_p
= 0;
16363 /* Re-compute Y positions. */
16364 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16365 max_y
= it
.last_visible_y
;
16366 for (row
= start_row
+ nrows_scrolled
;
16370 row
->y
= it
.current_y
;
16371 row
->visible_height
= row
->height
;
16373 if (row
->y
< min_y
)
16374 row
->visible_height
-= min_y
- row
->y
;
16375 if (row
->y
+ row
->height
> max_y
)
16376 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16377 if (row
->fringe_bitmap_periodic_p
)
16378 row
->redraw_fringe_bitmaps_p
= 1;
16380 it
.current_y
+= row
->height
;
16382 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16383 last_reused_text_row
= row
;
16384 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16388 /* Disable lines in the current matrix which are now
16389 below the window. */
16390 for (++row
; row
< bottom_row
; ++row
)
16391 row
->enabled_p
= row
->mode_line_p
= 0;
16394 /* Update window_end_pos etc.; last_reused_text_row is the last
16395 reused row from the current matrix containing text, if any.
16396 The value of last_text_row is the last displayed line
16397 containing text. */
16398 if (last_reused_text_row
)
16400 w
->window_end_bytepos
16401 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16402 wset_window_end_pos
16404 - MATRIX_ROW_END_CHARPOS (last_reused_text_row
)));
16405 wset_window_end_vpos
16406 (w
, make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16407 w
->current_matrix
)));
16409 else if (last_text_row
)
16411 w
->window_end_bytepos
16412 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16413 wset_window_end_pos
16414 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16415 wset_window_end_vpos
16416 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16417 w
->desired_matrix
)));
16421 /* This window must be completely empty. */
16422 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16423 wset_window_end_pos (w
, make_number (Z
- ZV
));
16424 wset_window_end_vpos (w
, make_number (0));
16426 w
->window_end_valid
= 0;
16428 /* Update hint: don't try scrolling again in update_window. */
16429 w
->desired_matrix
->no_scrolling_p
= 1;
16432 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16436 else if (CHARPOS (new_start
) > CHARPOS (start
))
16438 struct glyph_row
*pt_row
, *row
;
16439 struct glyph_row
*first_reusable_row
;
16440 struct glyph_row
*first_row_to_display
;
16442 int yb
= window_text_bottom_y (w
);
16444 /* Find the row starting at new_start, if there is one. Don't
16445 reuse a partially visible line at the end. */
16446 first_reusable_row
= start_row
;
16447 while (first_reusable_row
->enabled_p
16448 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16449 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16450 < CHARPOS (new_start
)))
16451 ++first_reusable_row
;
16453 /* Give up if there is no row to reuse. */
16454 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16455 || !first_reusable_row
->enabled_p
16456 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16457 != CHARPOS (new_start
)))
16460 /* We can reuse fully visible rows beginning with
16461 first_reusable_row to the end of the window. Set
16462 first_row_to_display to the first row that cannot be reused.
16463 Set pt_row to the row containing point, if there is any. */
16465 for (first_row_to_display
= first_reusable_row
;
16466 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16467 ++first_row_to_display
)
16469 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16470 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16471 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16472 && first_row_to_display
->ends_at_zv_p
16473 && pt_row
== NULL
)))
16474 pt_row
= first_row_to_display
;
16477 /* Start displaying at the start of first_row_to_display. */
16478 eassert (first_row_to_display
->y
< yb
);
16479 init_to_row_start (&it
, w
, first_row_to_display
);
16481 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16483 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16485 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16486 + WINDOW_HEADER_LINE_HEIGHT (w
));
16488 /* Display lines beginning with first_row_to_display in the
16489 desired matrix. Set last_text_row to the last row displayed
16490 that displays text. */
16491 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16492 if (pt_row
== NULL
)
16493 w
->cursor
.vpos
= -1;
16494 last_text_row
= NULL
;
16495 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16496 if (display_line (&it
))
16497 last_text_row
= it
.glyph_row
- 1;
16499 /* If point is in a reused row, adjust y and vpos of the cursor
16503 w
->cursor
.vpos
-= nrows_scrolled
;
16504 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16507 /* Give up if point isn't in a row displayed or reused. (This
16508 also handles the case where w->cursor.vpos < nrows_scrolled
16509 after the calls to display_line, which can happen with scroll
16510 margins. See bug#1295.) */
16511 if (w
->cursor
.vpos
< 0)
16513 clear_glyph_matrix (w
->desired_matrix
);
16517 /* Scroll the display. */
16518 run
.current_y
= first_reusable_row
->y
;
16519 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16520 run
.height
= it
.last_visible_y
- run
.current_y
;
16521 dy
= run
.current_y
- run
.desired_y
;
16526 FRAME_RIF (f
)->update_window_begin_hook (w
);
16527 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16528 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16529 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16533 /* Adjust Y positions of reused rows. */
16534 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16535 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16536 max_y
= it
.last_visible_y
;
16537 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16540 row
->visible_height
= row
->height
;
16541 if (row
->y
< min_y
)
16542 row
->visible_height
-= min_y
- row
->y
;
16543 if (row
->y
+ row
->height
> max_y
)
16544 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16545 if (row
->fringe_bitmap_periodic_p
)
16546 row
->redraw_fringe_bitmaps_p
= 1;
16549 /* Scroll the current matrix. */
16550 eassert (nrows_scrolled
> 0);
16551 rotate_matrix (w
->current_matrix
,
16553 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16556 /* Disable rows not reused. */
16557 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16558 row
->enabled_p
= 0;
16560 /* Point may have moved to a different line, so we cannot assume that
16561 the previous cursor position is valid; locate the correct row. */
16564 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16566 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16567 && !row
->ends_at_zv_p
;
16571 w
->cursor
.y
= row
->y
;
16573 if (row
< bottom_row
)
16575 /* Can't simply scan the row for point with
16576 bidi-reordered glyph rows. Let set_cursor_from_row
16577 figure out where to put the cursor, and if it fails,
16579 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
16581 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
16584 clear_glyph_matrix (w
->desired_matrix
);
16590 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16591 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16594 && (!BUFFERP (glyph
->object
)
16595 || glyph
->charpos
< PT
);
16599 w
->cursor
.x
+= glyph
->pixel_width
;
16605 /* Adjust window end. A null value of last_text_row means that
16606 the window end is in reused rows which in turn means that
16607 only its vpos can have changed. */
16610 w
->window_end_bytepos
16611 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16612 wset_window_end_pos
16613 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16614 wset_window_end_vpos
16615 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16616 w
->desired_matrix
)));
16620 wset_window_end_vpos
16621 (w
, make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
));
16624 w
->window_end_valid
= 0;
16625 w
->desired_matrix
->no_scrolling_p
= 1;
16628 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16638 /************************************************************************
16639 Window redisplay reusing current matrix when buffer has changed
16640 ************************************************************************/
16642 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16643 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16644 ptrdiff_t *, ptrdiff_t *);
16645 static struct glyph_row
*
16646 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16647 struct glyph_row
*);
16650 /* Return the last row in MATRIX displaying text. If row START is
16651 non-null, start searching with that row. IT gives the dimensions
16652 of the display. Value is null if matrix is empty; otherwise it is
16653 a pointer to the row found. */
16655 static struct glyph_row
*
16656 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16657 struct glyph_row
*start
)
16659 struct glyph_row
*row
, *row_found
;
16661 /* Set row_found to the last row in IT->w's current matrix
16662 displaying text. The loop looks funny but think of partially
16665 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16666 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16668 eassert (row
->enabled_p
);
16670 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16679 /* Return the last row in the current matrix of W that is not affected
16680 by changes at the start of current_buffer that occurred since W's
16681 current matrix was built. Value is null if no such row exists.
16683 BEG_UNCHANGED us the number of characters unchanged at the start of
16684 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16685 first changed character in current_buffer. Characters at positions <
16686 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16687 when the current matrix was built. */
16689 static struct glyph_row
*
16690 find_last_unchanged_at_beg_row (struct window
*w
)
16692 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16693 struct glyph_row
*row
;
16694 struct glyph_row
*row_found
= NULL
;
16695 int yb
= window_text_bottom_y (w
);
16697 /* Find the last row displaying unchanged text. */
16698 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16699 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16700 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16703 if (/* If row ends before first_changed_pos, it is unchanged,
16704 except in some case. */
16705 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16706 /* When row ends in ZV and we write at ZV it is not
16708 && !row
->ends_at_zv_p
16709 /* When first_changed_pos is the end of a continued line,
16710 row is not unchanged because it may be no longer
16712 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16713 && (row
->continued_p
16714 || row
->exact_window_width_line_p
))
16715 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16716 needs to be recomputed, so don't consider this row as
16717 unchanged. This happens when the last line was
16718 bidi-reordered and was killed immediately before this
16719 redisplay cycle. In that case, ROW->end stores the
16720 buffer position of the first visual-order character of
16721 the killed text, which is now beyond ZV. */
16722 && CHARPOS (row
->end
.pos
) <= ZV
)
16725 /* Stop if last visible row. */
16726 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16734 /* Find the first glyph row in the current matrix of W that is not
16735 affected by changes at the end of current_buffer since the
16736 time W's current matrix was built.
16738 Return in *DELTA the number of chars by which buffer positions in
16739 unchanged text at the end of current_buffer must be adjusted.
16741 Return in *DELTA_BYTES the corresponding number of bytes.
16743 Value is null if no such row exists, i.e. all rows are affected by
16746 static struct glyph_row
*
16747 find_first_unchanged_at_end_row (struct window
*w
,
16748 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16750 struct glyph_row
*row
;
16751 struct glyph_row
*row_found
= NULL
;
16753 *delta
= *delta_bytes
= 0;
16755 /* Display must not have been paused, otherwise the current matrix
16756 is not up to date. */
16757 eassert (w
->window_end_valid
);
16759 /* A value of window_end_pos >= END_UNCHANGED means that the window
16760 end is in the range of changed text. If so, there is no
16761 unchanged row at the end of W's current matrix. */
16762 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16765 /* Set row to the last row in W's current matrix displaying text. */
16766 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16768 /* If matrix is entirely empty, no unchanged row exists. */
16769 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16771 /* The value of row is the last glyph row in the matrix having a
16772 meaningful buffer position in it. The end position of row
16773 corresponds to window_end_pos. This allows us to translate
16774 buffer positions in the current matrix to current buffer
16775 positions for characters not in changed text. */
16777 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16778 ptrdiff_t Z_BYTE_old
=
16779 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16780 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
16781 struct glyph_row
*first_text_row
16782 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16784 *delta
= Z
- Z_old
;
16785 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16787 /* Set last_unchanged_pos to the buffer position of the last
16788 character in the buffer that has not been changed. Z is the
16789 index + 1 of the last character in current_buffer, i.e. by
16790 subtracting END_UNCHANGED we get the index of the last
16791 unchanged character, and we have to add BEG to get its buffer
16793 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16794 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16796 /* Search backward from ROW for a row displaying a line that
16797 starts at a minimum position >= last_unchanged_pos_old. */
16798 for (; row
> first_text_row
; --row
)
16800 /* This used to abort, but it can happen.
16801 It is ok to just stop the search instead here. KFS. */
16802 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16805 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16810 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16816 /* Make sure that glyph rows in the current matrix of window W
16817 reference the same glyph memory as corresponding rows in the
16818 frame's frame matrix. This function is called after scrolling W's
16819 current matrix on a terminal frame in try_window_id and
16820 try_window_reusing_current_matrix. */
16823 sync_frame_with_window_matrix_rows (struct window
*w
)
16825 struct frame
*f
= XFRAME (w
->frame
);
16826 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16828 /* Preconditions: W must be a leaf window and full-width. Its frame
16829 must have a frame matrix. */
16830 eassert (BUFFERP (w
->contents
));
16831 eassert (WINDOW_FULL_WIDTH_P (w
));
16832 eassert (!FRAME_WINDOW_P (f
));
16834 /* If W is a full-width window, glyph pointers in W's current matrix
16835 have, by definition, to be the same as glyph pointers in the
16836 corresponding frame matrix. Note that frame matrices have no
16837 marginal areas (see build_frame_matrix). */
16838 window_row
= w
->current_matrix
->rows
;
16839 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16840 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16841 while (window_row
< window_row_end
)
16843 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16844 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16846 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16847 frame_row
->glyphs
[TEXT_AREA
] = start
;
16848 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16849 frame_row
->glyphs
[LAST_AREA
] = end
;
16851 /* Disable frame rows whose corresponding window rows have
16852 been disabled in try_window_id. */
16853 if (!window_row
->enabled_p
)
16854 frame_row
->enabled_p
= 0;
16856 ++window_row
, ++frame_row
;
16861 /* Find the glyph row in window W containing CHARPOS. Consider all
16862 rows between START and END (not inclusive). END null means search
16863 all rows to the end of the display area of W. Value is the row
16864 containing CHARPOS or null. */
16867 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
16868 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16870 struct glyph_row
*row
= start
;
16871 struct glyph_row
*best_row
= NULL
;
16872 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
16875 /* If we happen to start on a header-line, skip that. */
16876 if (row
->mode_line_p
)
16879 if ((end
&& row
>= end
) || !row
->enabled_p
)
16882 last_y
= window_text_bottom_y (w
) - dy
;
16886 /* Give up if we have gone too far. */
16887 if (end
&& row
>= end
)
16889 /* This formerly returned if they were equal.
16890 I think that both quantities are of a "last plus one" type;
16891 if so, when they are equal, the row is within the screen. -- rms. */
16892 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16895 /* If it is in this row, return this row. */
16896 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16897 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16898 /* The end position of a row equals the start
16899 position of the next row. If CHARPOS is there, we
16900 would rather display it in the next line, except
16901 when this line ends in ZV. */
16902 && !row
->ends_at_zv_p
16903 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16904 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16908 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
16909 || (!best_row
&& !row
->continued_p
))
16911 /* In bidi-reordered rows, there could be several rows
16912 occluding point, all of them belonging to the same
16913 continued line. We need to find the row which fits
16914 CHARPOS the best. */
16915 for (g
= row
->glyphs
[TEXT_AREA
];
16916 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16919 if (!STRINGP (g
->object
))
16921 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16923 mindif
= eabs (g
->charpos
- charpos
);
16925 /* Exact match always wins. */
16932 else if (best_row
&& !row
->continued_p
)
16939 /* Try to redisplay window W by reusing its existing display. W's
16940 current matrix must be up to date when this function is called,
16941 i.e. window_end_valid must be nonzero.
16945 1 if display has been updated
16946 0 if otherwise unsuccessful
16947 -1 if redisplay with same window start is known not to succeed
16949 The following steps are performed:
16951 1. Find the last row in the current matrix of W that is not
16952 affected by changes at the start of current_buffer. If no such row
16955 2. Find the first row in W's current matrix that is not affected by
16956 changes at the end of current_buffer. Maybe there is no such row.
16958 3. Display lines beginning with the row + 1 found in step 1 to the
16959 row found in step 2 or, if step 2 didn't find a row, to the end of
16962 4. If cursor is not known to appear on the window, give up.
16964 5. If display stopped at the row found in step 2, scroll the
16965 display and current matrix as needed.
16967 6. Maybe display some lines at the end of W, if we must. This can
16968 happen under various circumstances, like a partially visible line
16969 becoming fully visible, or because newly displayed lines are displayed
16970 in smaller font sizes.
16972 7. Update W's window end information. */
16975 try_window_id (struct window
*w
)
16977 struct frame
*f
= XFRAME (w
->frame
);
16978 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16979 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16980 struct glyph_row
*last_unchanged_at_beg_row
;
16981 struct glyph_row
*first_unchanged_at_end_row
;
16982 struct glyph_row
*row
;
16983 struct glyph_row
*bottom_row
;
16986 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
16988 struct text_pos start_pos
;
16990 int first_unchanged_at_end_vpos
= 0;
16991 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16992 struct text_pos start
;
16993 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
16996 if (inhibit_try_window_id
)
17000 /* This is handy for debugging. */
17002 #define GIVE_UP(X) \
17004 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17008 #define GIVE_UP(X) return 0
17011 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17013 /* Don't use this for mini-windows because these can show
17014 messages and mini-buffers, and we don't handle that here. */
17015 if (MINI_WINDOW_P (w
))
17018 /* This flag is used to prevent redisplay optimizations. */
17019 if (windows_or_buffers_changed
|| cursor_type_changed
)
17022 /* Verify that narrowing has not changed.
17023 Also verify that we were not told to prevent redisplay optimizations.
17024 It would be nice to further
17025 reduce the number of cases where this prevents try_window_id. */
17026 if (current_buffer
->clip_changed
17027 || current_buffer
->prevent_redisplay_optimizations_p
)
17030 /* Window must either use window-based redisplay or be full width. */
17031 if (!FRAME_WINDOW_P (f
)
17032 && (!FRAME_LINE_INS_DEL_OK (f
)
17033 || !WINDOW_FULL_WIDTH_P (w
)))
17036 /* Give up if point is known NOT to appear in W. */
17037 if (PT
< CHARPOS (start
))
17040 /* Another way to prevent redisplay optimizations. */
17041 if (w
->last_modified
== 0)
17044 /* Verify that window is not hscrolled. */
17045 if (w
->hscroll
!= 0)
17048 /* Verify that display wasn't paused. */
17049 if (!w
->window_end_valid
)
17052 /* Can't use this if highlighting a region because a cursor movement
17053 will do more than just set the cursor. */
17054 if (markpos_of_region () >= 0)
17057 /* Likewise if highlighting trailing whitespace. */
17058 if (!NILP (Vshow_trailing_whitespace
))
17061 /* Likewise if showing a region. */
17062 if (w
->region_showing
)
17065 /* Can't use this if overlay arrow position and/or string have
17067 if (overlay_arrows_changed_p ())
17070 /* When word-wrap is on, adding a space to the first word of a
17071 wrapped line can change the wrap position, altering the line
17072 above it. It might be worthwhile to handle this more
17073 intelligently, but for now just redisplay from scratch. */
17074 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17077 /* Under bidi reordering, adding or deleting a character in the
17078 beginning of a paragraph, before the first strong directional
17079 character, can change the base direction of the paragraph (unless
17080 the buffer specifies a fixed paragraph direction), which will
17081 require to redisplay the whole paragraph. It might be worthwhile
17082 to find the paragraph limits and widen the range of redisplayed
17083 lines to that, but for now just give up this optimization and
17084 redisplay from scratch. */
17085 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17086 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17089 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17090 only if buffer has really changed. The reason is that the gap is
17091 initially at Z for freshly visited files. The code below would
17092 set end_unchanged to 0 in that case. */
17093 if (MODIFF
> SAVE_MODIFF
17094 /* This seems to happen sometimes after saving a buffer. */
17095 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17097 if (GPT
- BEG
< BEG_UNCHANGED
)
17098 BEG_UNCHANGED
= GPT
- BEG
;
17099 if (Z
- GPT
< END_UNCHANGED
)
17100 END_UNCHANGED
= Z
- GPT
;
17103 /* The position of the first and last character that has been changed. */
17104 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17105 last_changed_charpos
= Z
- END_UNCHANGED
;
17107 /* If window starts after a line end, and the last change is in
17108 front of that newline, then changes don't affect the display.
17109 This case happens with stealth-fontification. Note that although
17110 the display is unchanged, glyph positions in the matrix have to
17111 be adjusted, of course. */
17112 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17113 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17114 && ((last_changed_charpos
< CHARPOS (start
)
17115 && CHARPOS (start
) == BEGV
)
17116 || (last_changed_charpos
< CHARPOS (start
) - 1
17117 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17119 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17120 struct glyph_row
*r0
;
17122 /* Compute how many chars/bytes have been added to or removed
17123 from the buffer. */
17124 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17125 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17126 Z_delta
= Z
- Z_old
;
17127 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17129 /* Give up if PT is not in the window. Note that it already has
17130 been checked at the start of try_window_id that PT is not in
17131 front of the window start. */
17132 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17135 /* If window start is unchanged, we can reuse the whole matrix
17136 as is, after adjusting glyph positions. No need to compute
17137 the window end again, since its offset from Z hasn't changed. */
17138 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17139 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17140 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17141 /* PT must not be in a partially visible line. */
17142 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17143 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17145 /* Adjust positions in the glyph matrix. */
17146 if (Z_delta
|| Z_delta_bytes
)
17148 struct glyph_row
*r1
17149 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17150 increment_matrix_positions (w
->current_matrix
,
17151 MATRIX_ROW_VPOS (r0
, current_matrix
),
17152 MATRIX_ROW_VPOS (r1
, current_matrix
),
17153 Z_delta
, Z_delta_bytes
);
17156 /* Set the cursor. */
17157 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17159 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17166 /* Handle the case that changes are all below what is displayed in
17167 the window, and that PT is in the window. This shortcut cannot
17168 be taken if ZV is visible in the window, and text has been added
17169 there that is visible in the window. */
17170 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17171 /* ZV is not visible in the window, or there are no
17172 changes at ZV, actually. */
17173 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17174 || first_changed_charpos
== last_changed_charpos
))
17176 struct glyph_row
*r0
;
17178 /* Give up if PT is not in the window. Note that it already has
17179 been checked at the start of try_window_id that PT is not in
17180 front of the window start. */
17181 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17184 /* If window start is unchanged, we can reuse the whole matrix
17185 as is, without changing glyph positions since no text has
17186 been added/removed in front of the window end. */
17187 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17188 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17189 /* PT must not be in a partially visible line. */
17190 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17191 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17193 /* We have to compute the window end anew since text
17194 could have been added/removed after it. */
17195 wset_window_end_pos
17196 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17197 w
->window_end_bytepos
17198 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17200 /* Set the cursor. */
17201 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17203 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17210 /* Give up if window start is in the changed area.
17212 The condition used to read
17214 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17216 but why that was tested escapes me at the moment. */
17217 if (CHARPOS (start
) >= first_changed_charpos
17218 && CHARPOS (start
) <= last_changed_charpos
)
17221 /* Check that window start agrees with the start of the first glyph
17222 row in its current matrix. Check this after we know the window
17223 start is not in changed text, otherwise positions would not be
17225 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17226 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17229 /* Give up if the window ends in strings. Overlay strings
17230 at the end are difficult to handle, so don't try. */
17231 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17232 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17235 /* Compute the position at which we have to start displaying new
17236 lines. Some of the lines at the top of the window might be
17237 reusable because they are not displaying changed text. Find the
17238 last row in W's current matrix not affected by changes at the
17239 start of current_buffer. Value is null if changes start in the
17240 first line of window. */
17241 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17242 if (last_unchanged_at_beg_row
)
17244 /* Avoid starting to display in the middle of a character, a TAB
17245 for instance. This is easier than to set up the iterator
17246 exactly, and it's not a frequent case, so the additional
17247 effort wouldn't really pay off. */
17248 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17249 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17250 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17251 --last_unchanged_at_beg_row
;
17253 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17256 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17258 start_pos
= it
.current
.pos
;
17260 /* Start displaying new lines in the desired matrix at the same
17261 vpos we would use in the current matrix, i.e. below
17262 last_unchanged_at_beg_row. */
17263 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17265 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17266 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17268 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17272 /* There are no reusable lines at the start of the window.
17273 Start displaying in the first text line. */
17274 start_display (&it
, w
, start
);
17275 it
.vpos
= it
.first_vpos
;
17276 start_pos
= it
.current
.pos
;
17279 /* Find the first row that is not affected by changes at the end of
17280 the buffer. Value will be null if there is no unchanged row, in
17281 which case we must redisplay to the end of the window. delta
17282 will be set to the value by which buffer positions beginning with
17283 first_unchanged_at_end_row have to be adjusted due to text
17285 first_unchanged_at_end_row
17286 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17287 IF_DEBUG (debug_delta
= delta
);
17288 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17290 /* Set stop_pos to the buffer position up to which we will have to
17291 display new lines. If first_unchanged_at_end_row != NULL, this
17292 is the buffer position of the start of the line displayed in that
17293 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17294 that we don't stop at a buffer position. */
17296 if (first_unchanged_at_end_row
)
17298 eassert (last_unchanged_at_beg_row
== NULL
17299 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17301 /* If this is a continuation line, move forward to the next one
17302 that isn't. Changes in lines above affect this line.
17303 Caution: this may move first_unchanged_at_end_row to a row
17304 not displaying text. */
17305 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17306 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17307 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17308 < it
.last_visible_y
))
17309 ++first_unchanged_at_end_row
;
17311 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17312 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17313 >= it
.last_visible_y
))
17314 first_unchanged_at_end_row
= NULL
;
17317 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17319 first_unchanged_at_end_vpos
17320 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17321 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17324 else if (last_unchanged_at_beg_row
== NULL
)
17330 /* Either there is no unchanged row at the end, or the one we have
17331 now displays text. This is a necessary condition for the window
17332 end pos calculation at the end of this function. */
17333 eassert (first_unchanged_at_end_row
== NULL
17334 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17336 debug_last_unchanged_at_beg_vpos
17337 = (last_unchanged_at_beg_row
17338 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17340 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17342 #endif /* GLYPH_DEBUG */
17345 /* Display new lines. Set last_text_row to the last new line
17346 displayed which has text on it, i.e. might end up as being the
17347 line where the window_end_vpos is. */
17348 w
->cursor
.vpos
= -1;
17349 last_text_row
= NULL
;
17350 overlay_arrow_seen
= 0;
17351 while (it
.current_y
< it
.last_visible_y
17352 && !fonts_changed_p
17353 && (first_unchanged_at_end_row
== NULL
17354 || IT_CHARPOS (it
) < stop_pos
))
17356 if (display_line (&it
))
17357 last_text_row
= it
.glyph_row
- 1;
17360 if (fonts_changed_p
)
17364 /* Compute differences in buffer positions, y-positions etc. for
17365 lines reused at the bottom of the window. Compute what we can
17367 if (first_unchanged_at_end_row
17368 /* No lines reused because we displayed everything up to the
17369 bottom of the window. */
17370 && it
.current_y
< it
.last_visible_y
)
17373 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17375 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17376 run
.current_y
= first_unchanged_at_end_row
->y
;
17377 run
.desired_y
= run
.current_y
+ dy
;
17378 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17382 delta
= delta_bytes
= dvpos
= dy
17383 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17384 first_unchanged_at_end_row
= NULL
;
17386 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17389 /* Find the cursor if not already found. We have to decide whether
17390 PT will appear on this window (it sometimes doesn't, but this is
17391 not a very frequent case.) This decision has to be made before
17392 the current matrix is altered. A value of cursor.vpos < 0 means
17393 that PT is either in one of the lines beginning at
17394 first_unchanged_at_end_row or below the window. Don't care for
17395 lines that might be displayed later at the window end; as
17396 mentioned, this is not a frequent case. */
17397 if (w
->cursor
.vpos
< 0)
17399 /* Cursor in unchanged rows at the top? */
17400 if (PT
< CHARPOS (start_pos
)
17401 && last_unchanged_at_beg_row
)
17403 row
= row_containing_pos (w
, PT
,
17404 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17405 last_unchanged_at_beg_row
+ 1, 0);
17407 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17410 /* Start from first_unchanged_at_end_row looking for PT. */
17411 else if (first_unchanged_at_end_row
)
17413 row
= row_containing_pos (w
, PT
- delta
,
17414 first_unchanged_at_end_row
, NULL
, 0);
17416 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17417 delta_bytes
, dy
, dvpos
);
17420 /* Give up if cursor was not found. */
17421 if (w
->cursor
.vpos
< 0)
17423 clear_glyph_matrix (w
->desired_matrix
);
17428 /* Don't let the cursor end in the scroll margins. */
17430 int this_scroll_margin
, cursor_height
;
17432 this_scroll_margin
=
17433 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17434 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17435 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17437 if ((w
->cursor
.y
< this_scroll_margin
17438 && CHARPOS (start
) > BEGV
)
17439 /* Old redisplay didn't take scroll margin into account at the bottom,
17440 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17441 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17442 ? cursor_height
+ this_scroll_margin
17443 : 1)) > it
.last_visible_y
)
17445 w
->cursor
.vpos
= -1;
17446 clear_glyph_matrix (w
->desired_matrix
);
17451 /* Scroll the display. Do it before changing the current matrix so
17452 that xterm.c doesn't get confused about where the cursor glyph is
17454 if (dy
&& run
.height
)
17458 if (FRAME_WINDOW_P (f
))
17460 FRAME_RIF (f
)->update_window_begin_hook (w
);
17461 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17462 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17463 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17467 /* Terminal frame. In this case, dvpos gives the number of
17468 lines to scroll by; dvpos < 0 means scroll up. */
17470 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17471 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17472 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17473 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17474 + window_internal_height (w
));
17476 #if defined (HAVE_GPM) || defined (MSDOS)
17477 x_clear_window_mouse_face (w
);
17479 /* Perform the operation on the screen. */
17482 /* Scroll last_unchanged_at_beg_row to the end of the
17483 window down dvpos lines. */
17484 set_terminal_window (f
, end
);
17486 /* On dumb terminals delete dvpos lines at the end
17487 before inserting dvpos empty lines. */
17488 if (!FRAME_SCROLL_REGION_OK (f
))
17489 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17491 /* Insert dvpos empty lines in front of
17492 last_unchanged_at_beg_row. */
17493 ins_del_lines (f
, from
, dvpos
);
17495 else if (dvpos
< 0)
17497 /* Scroll up last_unchanged_at_beg_vpos to the end of
17498 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17499 set_terminal_window (f
, end
);
17501 /* Delete dvpos lines in front of
17502 last_unchanged_at_beg_vpos. ins_del_lines will set
17503 the cursor to the given vpos and emit |dvpos| delete
17505 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17507 /* On a dumb terminal insert dvpos empty lines at the
17509 if (!FRAME_SCROLL_REGION_OK (f
))
17510 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17513 set_terminal_window (f
, 0);
17519 /* Shift reused rows of the current matrix to the right position.
17520 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17522 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17523 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17526 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17527 bottom_vpos
, dvpos
);
17528 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17531 else if (dvpos
> 0)
17533 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17534 bottom_vpos
, dvpos
);
17535 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17536 first_unchanged_at_end_vpos
+ dvpos
);
17539 /* For frame-based redisplay, make sure that current frame and window
17540 matrix are in sync with respect to glyph memory. */
17541 if (!FRAME_WINDOW_P (f
))
17542 sync_frame_with_window_matrix_rows (w
);
17544 /* Adjust buffer positions in reused rows. */
17545 if (delta
|| delta_bytes
)
17546 increment_matrix_positions (current_matrix
,
17547 first_unchanged_at_end_vpos
+ dvpos
,
17548 bottom_vpos
, delta
, delta_bytes
);
17550 /* Adjust Y positions. */
17552 shift_glyph_matrix (w
, current_matrix
,
17553 first_unchanged_at_end_vpos
+ dvpos
,
17556 if (first_unchanged_at_end_row
)
17558 first_unchanged_at_end_row
+= dvpos
;
17559 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17560 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17561 first_unchanged_at_end_row
= NULL
;
17564 /* If scrolling up, there may be some lines to display at the end of
17566 last_text_row_at_end
= NULL
;
17569 /* Scrolling up can leave for example a partially visible line
17570 at the end of the window to be redisplayed. */
17571 /* Set last_row to the glyph row in the current matrix where the
17572 window end line is found. It has been moved up or down in
17573 the matrix by dvpos. */
17574 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17575 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17577 /* If last_row is the window end line, it should display text. */
17578 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
17580 /* If window end line was partially visible before, begin
17581 displaying at that line. Otherwise begin displaying with the
17582 line following it. */
17583 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17585 init_to_row_start (&it
, w
, last_row
);
17586 it
.vpos
= last_vpos
;
17587 it
.current_y
= last_row
->y
;
17591 init_to_row_end (&it
, w
, last_row
);
17592 it
.vpos
= 1 + last_vpos
;
17593 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17597 /* We may start in a continuation line. If so, we have to
17598 get the right continuation_lines_width and current_x. */
17599 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17600 it
.hpos
= it
.current_x
= 0;
17602 /* Display the rest of the lines at the window end. */
17603 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17604 while (it
.current_y
< it
.last_visible_y
17605 && !fonts_changed_p
)
17607 /* Is it always sure that the display agrees with lines in
17608 the current matrix? I don't think so, so we mark rows
17609 displayed invalid in the current matrix by setting their
17610 enabled_p flag to zero. */
17611 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17612 if (display_line (&it
))
17613 last_text_row_at_end
= it
.glyph_row
- 1;
17617 /* Update window_end_pos and window_end_vpos. */
17618 if (first_unchanged_at_end_row
17619 && !last_text_row_at_end
)
17621 /* Window end line if one of the preserved rows from the current
17622 matrix. Set row to the last row displaying text in current
17623 matrix starting at first_unchanged_at_end_row, after
17625 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17626 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17627 first_unchanged_at_end_row
);
17628 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17630 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17631 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17632 wset_window_end_vpos
17633 (w
, make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
)));
17634 eassert (w
->window_end_bytepos
>= 0);
17635 IF_DEBUG (debug_method_add (w
, "A"));
17637 else if (last_text_row_at_end
)
17639 wset_window_end_pos
17640 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
)));
17641 w
->window_end_bytepos
17642 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17643 wset_window_end_vpos
17644 (w
, make_number (MATRIX_ROW_VPOS (last_text_row_at_end
,
17646 eassert (w
->window_end_bytepos
>= 0);
17647 IF_DEBUG (debug_method_add (w
, "B"));
17649 else if (last_text_row
)
17651 /* We have displayed either to the end of the window or at the
17652 end of the window, i.e. the last row with text is to be found
17653 in the desired matrix. */
17654 wset_window_end_pos
17655 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
17656 w
->window_end_bytepos
17657 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17658 wset_window_end_vpos
17659 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
)));
17660 eassert (w
->window_end_bytepos
>= 0);
17662 else if (first_unchanged_at_end_row
== NULL
17663 && last_text_row
== NULL
17664 && last_text_row_at_end
== NULL
)
17666 /* Displayed to end of window, but no line containing text was
17667 displayed. Lines were deleted at the end of the window. */
17668 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17669 int vpos
= XFASTINT (w
->window_end_vpos
);
17670 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17671 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17674 row
== NULL
&& vpos
>= first_vpos
;
17675 --vpos
, --current_row
, --desired_row
)
17677 if (desired_row
->enabled_p
)
17679 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
17682 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
17686 eassert (row
!= NULL
);
17687 wset_window_end_vpos (w
, make_number (vpos
+ 1));
17688 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17689 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17690 eassert (w
->window_end_bytepos
>= 0);
17691 IF_DEBUG (debug_method_add (w
, "C"));
17696 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17697 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17699 /* Record that display has not been completed. */
17700 w
->window_end_valid
= 0;
17701 w
->desired_matrix
->no_scrolling_p
= 1;
17709 /***********************************************************************
17710 More debugging support
17711 ***********************************************************************/
17715 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17716 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17717 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17720 /* Dump the contents of glyph matrix MATRIX on stderr.
17722 GLYPHS 0 means don't show glyph contents.
17723 GLYPHS 1 means show glyphs in short form
17724 GLYPHS > 1 means show glyphs in long form. */
17727 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17730 for (i
= 0; i
< matrix
->nrows
; ++i
)
17731 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17735 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17736 the glyph row and area where the glyph comes from. */
17739 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17741 if (glyph
->type
== CHAR_GLYPH
17742 || glyph
->type
== GLYPHLESS_GLYPH
)
17745 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
17746 glyph
- row
->glyphs
[TEXT_AREA
],
17747 (glyph
->type
== CHAR_GLYPH
17751 (BUFFERP (glyph
->object
)
17753 : (STRINGP (glyph
->object
)
17755 : (INTEGERP (glyph
->object
)
17758 glyph
->pixel_width
,
17760 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17764 glyph
->left_box_line_p
,
17765 glyph
->right_box_line_p
);
17767 else if (glyph
->type
== STRETCH_GLYPH
)
17770 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
17771 glyph
- row
->glyphs
[TEXT_AREA
],
17774 (BUFFERP (glyph
->object
)
17776 : (STRINGP (glyph
->object
)
17778 : (INTEGERP (glyph
->object
)
17781 glyph
->pixel_width
,
17785 glyph
->left_box_line_p
,
17786 glyph
->right_box_line_p
);
17788 else if (glyph
->type
== IMAGE_GLYPH
)
17791 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
17792 glyph
- row
->glyphs
[TEXT_AREA
],
17795 (BUFFERP (glyph
->object
)
17797 : (STRINGP (glyph
->object
)
17799 : (INTEGERP (glyph
->object
)
17802 glyph
->pixel_width
,
17806 glyph
->left_box_line_p
,
17807 glyph
->right_box_line_p
);
17809 else if (glyph
->type
== COMPOSITE_GLYPH
)
17812 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
17813 glyph
- row
->glyphs
[TEXT_AREA
],
17816 (BUFFERP (glyph
->object
)
17818 : (STRINGP (glyph
->object
)
17820 : (INTEGERP (glyph
->object
)
17823 glyph
->pixel_width
,
17825 if (glyph
->u
.cmp
.automatic
)
17828 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17829 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17831 glyph
->left_box_line_p
,
17832 glyph
->right_box_line_p
);
17837 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17838 GLYPHS 0 means don't show glyph contents.
17839 GLYPHS 1 means show glyphs in short form
17840 GLYPHS > 1 means show glyphs in long form. */
17843 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17847 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17848 fprintf (stderr
, "==============================================================================\n");
17850 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17851 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17853 MATRIX_ROW_START_CHARPOS (row
),
17854 MATRIX_ROW_END_CHARPOS (row
),
17855 row
->used
[TEXT_AREA
],
17856 row
->contains_overlapping_glyphs_p
,
17858 row
->truncated_on_left_p
,
17859 row
->truncated_on_right_p
,
17861 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17862 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
17865 row
->ends_in_middle_of_char_p
,
17866 row
->starts_in_middle_of_char_p
,
17872 row
->visible_height
,
17875 /* The next 3 lines should align to "Start" in the header. */
17876 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
17877 row
->end
.overlay_string_index
,
17878 row
->continuation_lines_width
);
17879 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
17880 CHARPOS (row
->start
.string_pos
),
17881 CHARPOS (row
->end
.string_pos
));
17882 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
17883 row
->end
.dpvec_index
);
17890 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17892 struct glyph
*glyph
= row
->glyphs
[area
];
17893 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17895 /* Glyph for a line end in text. */
17896 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17899 if (glyph
< glyph_end
)
17900 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
17902 for (; glyph
< glyph_end
; ++glyph
)
17903 dump_glyph (row
, glyph
, area
);
17906 else if (glyphs
== 1)
17910 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17912 char *s
= alloca (row
->used
[area
] + 4);
17915 for (i
= 0; i
< row
->used
[area
]; ++i
)
17917 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17918 if (i
== row
->used
[area
] - 1
17919 && area
== TEXT_AREA
17920 && INTEGERP (glyph
->object
)
17921 && glyph
->type
== CHAR_GLYPH
17922 && glyph
->u
.ch
== ' ')
17924 strcpy (&s
[i
], "[\\n]");
17927 else if (glyph
->type
== CHAR_GLYPH
17928 && glyph
->u
.ch
< 0x80
17929 && glyph
->u
.ch
>= ' ')
17930 s
[i
] = glyph
->u
.ch
;
17936 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17942 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17943 Sdump_glyph_matrix
, 0, 1, "p",
17944 doc
: /* Dump the current matrix of the selected window to stderr.
17945 Shows contents of glyph row structures. With non-nil
17946 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17947 glyphs in short form, otherwise show glyphs in long form. */)
17948 (Lisp_Object glyphs
)
17950 struct window
*w
= XWINDOW (selected_window
);
17951 struct buffer
*buffer
= XBUFFER (w
->contents
);
17953 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17954 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17955 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17956 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17957 fprintf (stderr
, "=============================================\n");
17958 dump_glyph_matrix (w
->current_matrix
,
17959 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
17964 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17965 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17968 struct frame
*f
= XFRAME (selected_frame
);
17969 dump_glyph_matrix (f
->current_matrix
, 1);
17974 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17975 doc
: /* Dump glyph row ROW to stderr.
17976 GLYPH 0 means don't dump glyphs.
17977 GLYPH 1 means dump glyphs in short form.
17978 GLYPH > 1 or omitted means dump glyphs in long form. */)
17979 (Lisp_Object row
, Lisp_Object glyphs
)
17981 struct glyph_matrix
*matrix
;
17984 CHECK_NUMBER (row
);
17985 matrix
= XWINDOW (selected_window
)->current_matrix
;
17987 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17988 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17990 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
17995 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17996 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17997 GLYPH 0 means don't dump glyphs.
17998 GLYPH 1 means dump glyphs in short form.
17999 GLYPH > 1 or omitted means dump glyphs in long form. */)
18000 (Lisp_Object row
, Lisp_Object glyphs
)
18002 struct frame
*sf
= SELECTED_FRAME ();
18003 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18006 CHECK_NUMBER (row
);
18008 if (vpos
>= 0 && vpos
< m
->nrows
)
18009 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18010 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18015 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18016 doc
: /* Toggle tracing of redisplay.
18017 With ARG, turn tracing on if and only if ARG is positive. */)
18021 trace_redisplay_p
= !trace_redisplay_p
;
18024 arg
= Fprefix_numeric_value (arg
);
18025 trace_redisplay_p
= XINT (arg
) > 0;
18032 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18033 doc
: /* Like `format', but print result to stderr.
18034 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18035 (ptrdiff_t nargs
, Lisp_Object
*args
)
18037 Lisp_Object s
= Fformat (nargs
, args
);
18038 fprintf (stderr
, "%s", SDATA (s
));
18042 #endif /* GLYPH_DEBUG */
18046 /***********************************************************************
18047 Building Desired Matrix Rows
18048 ***********************************************************************/
18050 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18051 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18053 static struct glyph_row
*
18054 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18056 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18057 struct buffer
*buffer
= XBUFFER (w
->contents
);
18058 struct buffer
*old
= current_buffer
;
18059 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18060 int arrow_len
= SCHARS (overlay_arrow_string
);
18061 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18062 const unsigned char *p
;
18065 int n_glyphs_before
;
18067 set_buffer_temp (buffer
);
18068 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18069 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18070 SET_TEXT_POS (it
.position
, 0, 0);
18072 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18074 while (p
< arrow_end
)
18076 Lisp_Object face
, ilisp
;
18078 /* Get the next character. */
18080 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18083 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18084 if (! ASCII_CHAR_P (it
.c
))
18085 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18089 /* Get its face. */
18090 ilisp
= make_number (p
- arrow_string
);
18091 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18092 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18094 /* Compute its width, get its glyphs. */
18095 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18096 SET_TEXT_POS (it
.position
, -1, -1);
18097 PRODUCE_GLYPHS (&it
);
18099 /* If this character doesn't fit any more in the line, we have
18100 to remove some glyphs. */
18101 if (it
.current_x
> it
.last_visible_x
)
18103 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18108 set_buffer_temp (old
);
18109 return it
.glyph_row
;
18113 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18114 glyphs to insert is determined by produce_special_glyphs. */
18117 insert_left_trunc_glyphs (struct it
*it
)
18119 struct it truncate_it
;
18120 struct glyph
*from
, *end
, *to
, *toend
;
18122 eassert (!FRAME_WINDOW_P (it
->f
)
18123 || (!it
->glyph_row
->reversed_p
18124 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18125 || (it
->glyph_row
->reversed_p
18126 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18128 /* Get the truncation glyphs. */
18130 truncate_it
.current_x
= 0;
18131 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18132 truncate_it
.glyph_row
= &scratch_glyph_row
;
18133 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18134 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18135 truncate_it
.object
= make_number (0);
18136 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18138 /* Overwrite glyphs from IT with truncation glyphs. */
18139 if (!it
->glyph_row
->reversed_p
)
18141 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18143 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18144 end
= from
+ tused
;
18145 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18146 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18147 if (FRAME_WINDOW_P (it
->f
))
18149 /* On GUI frames, when variable-size fonts are displayed,
18150 the truncation glyphs may need more pixels than the row's
18151 glyphs they overwrite. We overwrite more glyphs to free
18152 enough screen real estate, and enlarge the stretch glyph
18153 on the right (see display_line), if there is one, to
18154 preserve the screen position of the truncation glyphs on
18157 struct glyph
*g
= to
;
18160 /* The first glyph could be partially visible, in which case
18161 it->glyph_row->x will be negative. But we want the left
18162 truncation glyphs to be aligned at the left margin of the
18163 window, so we override the x coordinate at which the row
18165 it
->glyph_row
->x
= 0;
18166 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18168 w
+= g
->pixel_width
;
18171 if (g
- to
- tused
> 0)
18173 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18174 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18176 used
= it
->glyph_row
->used
[TEXT_AREA
];
18177 if (it
->glyph_row
->truncated_on_right_p
18178 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18179 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18182 int extra
= w
- it
->truncation_pixel_width
;
18184 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18191 /* There may be padding glyphs left over. Overwrite them too. */
18192 if (!FRAME_WINDOW_P (it
->f
))
18194 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18196 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18203 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18207 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18209 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18210 that back to front. */
18211 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18212 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18213 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18214 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18215 if (FRAME_WINDOW_P (it
->f
))
18218 struct glyph
*g
= to
;
18220 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18222 w
+= g
->pixel_width
;
18225 if (to
- g
- tused
> 0)
18227 if (it
->glyph_row
->truncated_on_right_p
18228 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18229 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18231 int extra
= w
- it
->truncation_pixel_width
;
18233 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18237 while (from
>= end
&& to
>= toend
)
18239 if (!FRAME_WINDOW_P (it
->f
))
18241 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18244 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18245 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18246 while (from
>= end
&& to
>= toend
)
18252 /* Need to free some room before prepending additional
18254 int move_by
= from
- end
+ 1;
18255 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18256 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18258 for ( ; g
>= g0
; g
--)
18260 while (from
>= end
)
18262 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18267 /* Compute the hash code for ROW. */
18269 row_hash (struct glyph_row
*row
)
18272 unsigned hashval
= 0;
18274 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18275 for (k
= 0; k
< row
->used
[area
]; ++k
)
18276 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18277 + row
->glyphs
[area
][k
].u
.val
18278 + row
->glyphs
[area
][k
].face_id
18279 + row
->glyphs
[area
][k
].padding_p
18280 + (row
->glyphs
[area
][k
].type
<< 2));
18285 /* Compute the pixel height and width of IT->glyph_row.
18287 Most of the time, ascent and height of a display line will be equal
18288 to the max_ascent and max_height values of the display iterator
18289 structure. This is not the case if
18291 1. We hit ZV without displaying anything. In this case, max_ascent
18292 and max_height will be zero.
18294 2. We have some glyphs that don't contribute to the line height.
18295 (The glyph row flag contributes_to_line_height_p is for future
18296 pixmap extensions).
18298 The first case is easily covered by using default values because in
18299 these cases, the line height does not really matter, except that it
18300 must not be zero. */
18303 compute_line_metrics (struct it
*it
)
18305 struct glyph_row
*row
= it
->glyph_row
;
18307 if (FRAME_WINDOW_P (it
->f
))
18309 int i
, min_y
, max_y
;
18311 /* The line may consist of one space only, that was added to
18312 place the cursor on it. If so, the row's height hasn't been
18314 if (row
->height
== 0)
18316 if (it
->max_ascent
+ it
->max_descent
== 0)
18317 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18318 row
->ascent
= it
->max_ascent
;
18319 row
->height
= it
->max_ascent
+ it
->max_descent
;
18320 row
->phys_ascent
= it
->max_phys_ascent
;
18321 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18322 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18325 /* Compute the width of this line. */
18326 row
->pixel_width
= row
->x
;
18327 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18328 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18330 eassert (row
->pixel_width
>= 0);
18331 eassert (row
->ascent
>= 0 && row
->height
> 0);
18333 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18334 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18336 /* If first line's physical ascent is larger than its logical
18337 ascent, use the physical ascent, and make the row taller.
18338 This makes accented characters fully visible. */
18339 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18340 && row
->phys_ascent
> row
->ascent
)
18342 row
->height
+= row
->phys_ascent
- row
->ascent
;
18343 row
->ascent
= row
->phys_ascent
;
18346 /* Compute how much of the line is visible. */
18347 row
->visible_height
= row
->height
;
18349 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18350 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18352 if (row
->y
< min_y
)
18353 row
->visible_height
-= min_y
- row
->y
;
18354 if (row
->y
+ row
->height
> max_y
)
18355 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18359 row
->pixel_width
= row
->used
[TEXT_AREA
];
18360 if (row
->continued_p
)
18361 row
->pixel_width
-= it
->continuation_pixel_width
;
18362 else if (row
->truncated_on_right_p
)
18363 row
->pixel_width
-= it
->truncation_pixel_width
;
18364 row
->ascent
= row
->phys_ascent
= 0;
18365 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18366 row
->extra_line_spacing
= 0;
18369 /* Compute a hash code for this row. */
18370 row
->hash
= row_hash (row
);
18372 it
->max_ascent
= it
->max_descent
= 0;
18373 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18377 /* Append one space to the glyph row of iterator IT if doing a
18378 window-based redisplay. The space has the same face as
18379 IT->face_id. Value is non-zero if a space was added.
18381 This function is called to make sure that there is always one glyph
18382 at the end of a glyph row that the cursor can be set on under
18383 window-systems. (If there weren't such a glyph we would not know
18384 how wide and tall a box cursor should be displayed).
18386 At the same time this space let's a nicely handle clearing to the
18387 end of the line if the row ends in italic text. */
18390 append_space_for_newline (struct it
*it
, int default_face_p
)
18392 if (FRAME_WINDOW_P (it
->f
))
18394 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18396 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18397 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18399 /* Save some values that must not be changed.
18400 Must save IT->c and IT->len because otherwise
18401 ITERATOR_AT_END_P wouldn't work anymore after
18402 append_space_for_newline has been called. */
18403 enum display_element_type saved_what
= it
->what
;
18404 int saved_c
= it
->c
, saved_len
= it
->len
;
18405 int saved_char_to_display
= it
->char_to_display
;
18406 int saved_x
= it
->current_x
;
18407 int saved_face_id
= it
->face_id
;
18408 int saved_box_end
= it
->end_of_box_run_p
;
18409 struct text_pos saved_pos
;
18410 Lisp_Object saved_object
;
18413 saved_object
= it
->object
;
18414 saved_pos
= it
->position
;
18416 it
->what
= IT_CHARACTER
;
18417 memset (&it
->position
, 0, sizeof it
->position
);
18418 it
->object
= make_number (0);
18419 it
->c
= it
->char_to_display
= ' ';
18422 /* If the default face was remapped, be sure to use the
18423 remapped face for the appended newline. */
18424 if (default_face_p
)
18425 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18426 else if (it
->face_before_selective_p
)
18427 it
->face_id
= it
->saved_face_id
;
18428 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18429 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18430 /* In R2L rows, we will prepend a stretch glyph that will
18431 have the end_of_box_run_p flag set for it, so there's no
18432 need for the appended newline glyph to have that flag
18434 if (it
->glyph_row
->reversed_p
18435 /* But if the appended newline glyph goes all the way to
18436 the end of the row, there will be no stretch glyph,
18437 so leave the box flag set. */
18438 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
18439 it
->end_of_box_run_p
= 0;
18441 PRODUCE_GLYPHS (it
);
18443 it
->override_ascent
= -1;
18444 it
->constrain_row_ascent_descent_p
= 0;
18445 it
->current_x
= saved_x
;
18446 it
->object
= saved_object
;
18447 it
->position
= saved_pos
;
18448 it
->what
= saved_what
;
18449 it
->face_id
= saved_face_id
;
18450 it
->len
= saved_len
;
18452 it
->char_to_display
= saved_char_to_display
;
18453 it
->end_of_box_run_p
= saved_box_end
;
18462 /* Extend the face of the last glyph in the text area of IT->glyph_row
18463 to the end of the display line. Called from display_line. If the
18464 glyph row is empty, add a space glyph to it so that we know the
18465 face to draw. Set the glyph row flag fill_line_p. If the glyph
18466 row is R2L, prepend a stretch glyph to cover the empty space to the
18467 left of the leftmost glyph. */
18470 extend_face_to_end_of_line (struct it
*it
)
18472 struct face
*face
, *default_face
;
18473 struct frame
*f
= it
->f
;
18475 /* If line is already filled, do nothing. Non window-system frames
18476 get a grace of one more ``pixel'' because their characters are
18477 1-``pixel'' wide, so they hit the equality too early. This grace
18478 is needed only for R2L rows that are not continued, to produce
18479 one extra blank where we could display the cursor. */
18480 if (it
->current_x
>= it
->last_visible_x
18481 + (!FRAME_WINDOW_P (f
)
18482 && it
->glyph_row
->reversed_p
18483 && !it
->glyph_row
->continued_p
))
18486 /* The default face, possibly remapped. */
18487 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18489 /* Face extension extends the background and box of IT->face_id
18490 to the end of the line. If the background equals the background
18491 of the frame, we don't have to do anything. */
18492 if (it
->face_before_selective_p
)
18493 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18495 face
= FACE_FROM_ID (f
, it
->face_id
);
18497 if (FRAME_WINDOW_P (f
)
18498 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
18499 && face
->box
== FACE_NO_BOX
18500 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18502 && !it
->glyph_row
->reversed_p
)
18505 /* Set the glyph row flag indicating that the face of the last glyph
18506 in the text area has to be drawn to the end of the text area. */
18507 it
->glyph_row
->fill_line_p
= 1;
18509 /* If current character of IT is not ASCII, make sure we have the
18510 ASCII face. This will be automatically undone the next time
18511 get_next_display_element returns a multibyte character. Note
18512 that the character will always be single byte in unibyte
18514 if (!ASCII_CHAR_P (it
->c
))
18516 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18519 if (FRAME_WINDOW_P (f
))
18521 /* If the row is empty, add a space with the current face of IT,
18522 so that we know which face to draw. */
18523 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18525 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18526 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18527 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18529 #ifdef HAVE_WINDOW_SYSTEM
18530 if (it
->glyph_row
->reversed_p
)
18532 /* Prepend a stretch glyph to the row, such that the
18533 rightmost glyph will be drawn flushed all the way to the
18534 right margin of the window. The stretch glyph that will
18535 occupy the empty space, if any, to the left of the
18537 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18538 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18539 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18541 int row_width
, stretch_ascent
, stretch_width
;
18542 struct text_pos saved_pos
;
18543 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
18545 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18546 row_width
+= g
->pixel_width
;
18547 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18548 if (stretch_width
> 0)
18551 (((it
->ascent
+ it
->descent
)
18552 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18553 saved_pos
= it
->position
;
18554 memset (&it
->position
, 0, sizeof it
->position
);
18555 saved_avoid_cursor
= it
->avoid_cursor_p
;
18556 it
->avoid_cursor_p
= 1;
18557 saved_face_id
= it
->face_id
;
18558 saved_box_start
= it
->start_of_box_run_p
;
18559 /* The last row's stretch glyph should get the default
18560 face, to avoid painting the rest of the window with
18561 the region face, if the region ends at ZV. */
18562 if (it
->glyph_row
->ends_at_zv_p
)
18563 it
->face_id
= default_face
->id
;
18565 it
->face_id
= face
->id
;
18566 it
->start_of_box_run_p
= 0;
18567 append_stretch_glyph (it
, make_number (0), stretch_width
,
18568 it
->ascent
+ it
->descent
, stretch_ascent
);
18569 it
->position
= saved_pos
;
18570 it
->avoid_cursor_p
= saved_avoid_cursor
;
18571 it
->face_id
= saved_face_id
;
18572 it
->start_of_box_run_p
= saved_box_start
;
18575 #endif /* HAVE_WINDOW_SYSTEM */
18579 /* Save some values that must not be changed. */
18580 int saved_x
= it
->current_x
;
18581 struct text_pos saved_pos
;
18582 Lisp_Object saved_object
;
18583 enum display_element_type saved_what
= it
->what
;
18584 int saved_face_id
= it
->face_id
;
18586 saved_object
= it
->object
;
18587 saved_pos
= it
->position
;
18589 it
->what
= IT_CHARACTER
;
18590 memset (&it
->position
, 0, sizeof it
->position
);
18591 it
->object
= make_number (0);
18592 it
->c
= it
->char_to_display
= ' ';
18594 /* The last row's blank glyphs should get the default face, to
18595 avoid painting the rest of the window with the region face,
18596 if the region ends at ZV. */
18597 if (it
->glyph_row
->ends_at_zv_p
)
18598 it
->face_id
= default_face
->id
;
18600 it
->face_id
= face
->id
;
18602 PRODUCE_GLYPHS (it
);
18604 while (it
->current_x
<= it
->last_visible_x
)
18605 PRODUCE_GLYPHS (it
);
18607 /* Don't count these blanks really. It would let us insert a left
18608 truncation glyph below and make us set the cursor on them, maybe. */
18609 it
->current_x
= saved_x
;
18610 it
->object
= saved_object
;
18611 it
->position
= saved_pos
;
18612 it
->what
= saved_what
;
18613 it
->face_id
= saved_face_id
;
18618 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18619 trailing whitespace. */
18622 trailing_whitespace_p (ptrdiff_t charpos
)
18624 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18627 while (bytepos
< ZV_BYTE
18628 && (c
= FETCH_CHAR (bytepos
),
18629 c
== ' ' || c
== '\t'))
18632 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18634 if (bytepos
!= PT_BYTE
)
18641 /* Highlight trailing whitespace, if any, in ROW. */
18644 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18646 int used
= row
->used
[TEXT_AREA
];
18650 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18651 struct glyph
*glyph
= start
+ used
- 1;
18653 if (row
->reversed_p
)
18655 /* Right-to-left rows need to be processed in the opposite
18656 direction, so swap the edge pointers. */
18658 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18661 /* Skip over glyphs inserted to display the cursor at the
18662 end of a line, for extending the face of the last glyph
18663 to the end of the line on terminals, and for truncation
18664 and continuation glyphs. */
18665 if (!row
->reversed_p
)
18667 while (glyph
>= start
18668 && glyph
->type
== CHAR_GLYPH
18669 && INTEGERP (glyph
->object
))
18674 while (glyph
<= start
18675 && glyph
->type
== CHAR_GLYPH
18676 && INTEGERP (glyph
->object
))
18680 /* If last glyph is a space or stretch, and it's trailing
18681 whitespace, set the face of all trailing whitespace glyphs in
18682 IT->glyph_row to `trailing-whitespace'. */
18683 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18684 && BUFFERP (glyph
->object
)
18685 && (glyph
->type
== STRETCH_GLYPH
18686 || (glyph
->type
== CHAR_GLYPH
18687 && glyph
->u
.ch
== ' '))
18688 && trailing_whitespace_p (glyph
->charpos
))
18690 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18694 if (!row
->reversed_p
)
18696 while (glyph
>= start
18697 && BUFFERP (glyph
->object
)
18698 && (glyph
->type
== STRETCH_GLYPH
18699 || (glyph
->type
== CHAR_GLYPH
18700 && glyph
->u
.ch
== ' ')))
18701 (glyph
--)->face_id
= face_id
;
18705 while (glyph
<= start
18706 && BUFFERP (glyph
->object
)
18707 && (glyph
->type
== STRETCH_GLYPH
18708 || (glyph
->type
== CHAR_GLYPH
18709 && glyph
->u
.ch
== ' ')))
18710 (glyph
++)->face_id
= face_id
;
18717 /* Value is non-zero if glyph row ROW should be
18718 used to hold the cursor. */
18721 cursor_row_p (struct glyph_row
*row
)
18725 if (PT
== CHARPOS (row
->end
.pos
)
18726 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18728 /* Suppose the row ends on a string.
18729 Unless the row is continued, that means it ends on a newline
18730 in the string. If it's anything other than a display string
18731 (e.g., a before-string from an overlay), we don't want the
18732 cursor there. (This heuristic seems to give the optimal
18733 behavior for the various types of multi-line strings.)
18734 One exception: if the string has `cursor' property on one of
18735 its characters, we _do_ want the cursor there. */
18736 if (CHARPOS (row
->end
.string_pos
) >= 0)
18738 if (row
->continued_p
)
18742 /* Check for `display' property. */
18743 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18744 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18745 struct glyph
*glyph
;
18748 for (glyph
= end
; glyph
>= beg
; --glyph
)
18749 if (STRINGP (glyph
->object
))
18752 = Fget_char_property (make_number (PT
),
18756 && display_prop_string_p (prop
, glyph
->object
));
18757 /* If there's a `cursor' property on one of the
18758 string's characters, this row is a cursor row,
18759 even though this is not a display string. */
18762 Lisp_Object s
= glyph
->object
;
18764 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18766 ptrdiff_t gpos
= glyph
->charpos
;
18768 if (!NILP (Fget_char_property (make_number (gpos
),
18780 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18782 /* If the row ends in middle of a real character,
18783 and the line is continued, we want the cursor here.
18784 That's because CHARPOS (ROW->end.pos) would equal
18785 PT if PT is before the character. */
18786 if (!row
->ends_in_ellipsis_p
)
18787 result
= row
->continued_p
;
18789 /* If the row ends in an ellipsis, then
18790 CHARPOS (ROW->end.pos) will equal point after the
18791 invisible text. We want that position to be displayed
18792 after the ellipsis. */
18795 /* If the row ends at ZV, display the cursor at the end of that
18796 row instead of at the start of the row below. */
18797 else if (row
->ends_at_zv_p
)
18808 /* Push the property PROP so that it will be rendered at the current
18809 position in IT. Return 1 if PROP was successfully pushed, 0
18810 otherwise. Called from handle_line_prefix to handle the
18811 `line-prefix' and `wrap-prefix' properties. */
18814 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18816 struct text_pos pos
=
18817 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18819 eassert (it
->method
== GET_FROM_BUFFER
18820 || it
->method
== GET_FROM_DISPLAY_VECTOR
18821 || it
->method
== GET_FROM_STRING
);
18823 /* We need to save the current buffer/string position, so it will be
18824 restored by pop_it, because iterate_out_of_display_property
18825 depends on that being set correctly, but some situations leave
18826 it->position not yet set when this function is called. */
18827 push_it (it
, &pos
);
18829 if (STRINGP (prop
))
18831 if (SCHARS (prop
) == 0)
18838 it
->string_from_prefix_prop_p
= 1;
18839 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18840 it
->current
.overlay_string_index
= -1;
18841 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18842 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18843 it
->method
= GET_FROM_STRING
;
18844 it
->stop_charpos
= 0;
18846 it
->base_level_stop
= 0;
18848 /* Force paragraph direction to be that of the parent
18850 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18851 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18853 it
->paragraph_embedding
= L2R
;
18855 /* Set up the bidi iterator for this display string. */
18858 it
->bidi_it
.string
.lstring
= it
->string
;
18859 it
->bidi_it
.string
.s
= NULL
;
18860 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18861 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18862 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18863 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18864 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18867 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18869 it
->method
= GET_FROM_STRETCH
;
18872 #ifdef HAVE_WINDOW_SYSTEM
18873 else if (IMAGEP (prop
))
18875 it
->what
= IT_IMAGE
;
18876 it
->image_id
= lookup_image (it
->f
, prop
);
18877 it
->method
= GET_FROM_IMAGE
;
18879 #endif /* HAVE_WINDOW_SYSTEM */
18882 pop_it (it
); /* bogus display property, give up */
18889 /* Return the character-property PROP at the current position in IT. */
18892 get_it_property (struct it
*it
, Lisp_Object prop
)
18894 Lisp_Object position
;
18896 if (STRINGP (it
->object
))
18897 position
= make_number (IT_STRING_CHARPOS (*it
));
18898 else if (BUFFERP (it
->object
))
18899 position
= make_number (IT_CHARPOS (*it
));
18903 return Fget_char_property (position
, prop
, it
->object
);
18906 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18909 handle_line_prefix (struct it
*it
)
18911 Lisp_Object prefix
;
18913 if (it
->continuation_lines_width
> 0)
18915 prefix
= get_it_property (it
, Qwrap_prefix
);
18917 prefix
= Vwrap_prefix
;
18921 prefix
= get_it_property (it
, Qline_prefix
);
18923 prefix
= Vline_prefix
;
18925 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
18927 /* If the prefix is wider than the window, and we try to wrap
18928 it, it would acquire its own wrap prefix, and so on till the
18929 iterator stack overflows. So, don't wrap the prefix. */
18930 it
->line_wrap
= TRUNCATE
;
18931 it
->avoid_cursor_p
= 1;
18937 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18938 only for R2L lines from display_line and display_string, when they
18939 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18940 the line/string needs to be continued on the next glyph row. */
18942 unproduce_glyphs (struct it
*it
, int n
)
18944 struct glyph
*glyph
, *end
;
18946 eassert (it
->glyph_row
);
18947 eassert (it
->glyph_row
->reversed_p
);
18948 eassert (it
->area
== TEXT_AREA
);
18949 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18951 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18952 n
= it
->glyph_row
->used
[TEXT_AREA
];
18953 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18954 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18955 for ( ; glyph
< end
; glyph
++)
18956 glyph
[-n
] = *glyph
;
18959 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18960 and ROW->maxpos. */
18962 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18963 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
18964 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
18966 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18967 lines' rows is implemented for bidi-reordered rows. */
18969 /* ROW->minpos is the value of min_pos, the minimal buffer position
18970 we have in ROW, or ROW->start.pos if that is smaller. */
18971 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18972 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18974 /* We didn't find buffer positions smaller than ROW->start, or
18975 didn't find _any_ valid buffer positions in any of the glyphs,
18976 so we must trust the iterator's computed positions. */
18977 row
->minpos
= row
->start
.pos
;
18980 max_pos
= CHARPOS (it
->current
.pos
);
18981 max_bpos
= BYTEPOS (it
->current
.pos
);
18984 /* Here are the various use-cases for ending the row, and the
18985 corresponding values for ROW->maxpos:
18987 Line ends in a newline from buffer eol_pos + 1
18988 Line is continued from buffer max_pos + 1
18989 Line is truncated on right it->current.pos
18990 Line ends in a newline from string max_pos + 1(*)
18991 (*) + 1 only when line ends in a forward scan
18992 Line is continued from string max_pos
18993 Line is continued from display vector max_pos
18994 Line is entirely from a string min_pos == max_pos
18995 Line is entirely from a display vector min_pos == max_pos
18996 Line that ends at ZV ZV
18998 If you discover other use-cases, please add them here as
19000 if (row
->ends_at_zv_p
)
19001 row
->maxpos
= it
->current
.pos
;
19002 else if (row
->used
[TEXT_AREA
])
19004 int seen_this_string
= 0;
19005 struct glyph_row
*r1
= row
- 1;
19007 /* Did we see the same display string on the previous row? */
19008 if (STRINGP (it
->object
)
19009 /* this is not the first row */
19010 && row
> it
->w
->desired_matrix
->rows
19011 /* previous row is not the header line */
19012 && !r1
->mode_line_p
19013 /* previous row also ends in a newline from a string */
19014 && r1
->ends_in_newline_from_string_p
)
19016 struct glyph
*start
, *end
;
19018 /* Search for the last glyph of the previous row that came
19019 from buffer or string. Depending on whether the row is
19020 L2R or R2L, we need to process it front to back or the
19021 other way round. */
19022 if (!r1
->reversed_p
)
19024 start
= r1
->glyphs
[TEXT_AREA
];
19025 end
= start
+ r1
->used
[TEXT_AREA
];
19026 /* Glyphs inserted by redisplay have an integer (zero)
19027 as their object. */
19029 && INTEGERP ((end
- 1)->object
)
19030 && (end
- 1)->charpos
<= 0)
19034 if (EQ ((end
- 1)->object
, it
->object
))
19035 seen_this_string
= 1;
19038 /* If all the glyphs of the previous row were inserted
19039 by redisplay, it means the previous row was
19040 produced from a single newline, which is only
19041 possible if that newline came from the same string
19042 as the one which produced this ROW. */
19043 seen_this_string
= 1;
19047 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19048 start
= end
+ r1
->used
[TEXT_AREA
];
19050 && INTEGERP ((end
+ 1)->object
)
19051 && (end
+ 1)->charpos
<= 0)
19055 if (EQ ((end
+ 1)->object
, it
->object
))
19056 seen_this_string
= 1;
19059 seen_this_string
= 1;
19062 /* Take note of each display string that covers a newline only
19063 once, the first time we see it. This is for when a display
19064 string includes more than one newline in it. */
19065 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19067 /* If we were scanning the buffer forward when we displayed
19068 the string, we want to account for at least one buffer
19069 position that belongs to this row (position covered by
19070 the display string), so that cursor positioning will
19071 consider this row as a candidate when point is at the end
19072 of the visual line represented by this row. This is not
19073 required when scanning back, because max_pos will already
19074 have a much larger value. */
19075 if (CHARPOS (row
->end
.pos
) > max_pos
)
19076 INC_BOTH (max_pos
, max_bpos
);
19077 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19079 else if (CHARPOS (it
->eol_pos
) > 0)
19080 SET_TEXT_POS (row
->maxpos
,
19081 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19082 else if (row
->continued_p
)
19084 /* If max_pos is different from IT's current position, it
19085 means IT->method does not belong to the display element
19086 at max_pos. However, it also means that the display
19087 element at max_pos was displayed in its entirety on this
19088 line, which is equivalent to saying that the next line
19089 starts at the next buffer position. */
19090 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19091 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19094 INC_BOTH (max_pos
, max_bpos
);
19095 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19098 else if (row
->truncated_on_right_p
)
19099 /* display_line already called reseat_at_next_visible_line_start,
19100 which puts the iterator at the beginning of the next line, in
19101 the logical order. */
19102 row
->maxpos
= it
->current
.pos
;
19103 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19104 /* A line that is entirely from a string/image/stretch... */
19105 row
->maxpos
= row
->minpos
;
19110 row
->maxpos
= it
->current
.pos
;
19113 /* Construct the glyph row IT->glyph_row in the desired matrix of
19114 IT->w from text at the current position of IT. See dispextern.h
19115 for an overview of struct it. Value is non-zero if
19116 IT->glyph_row displays text, as opposed to a line displaying ZV
19120 display_line (struct it
*it
)
19122 struct glyph_row
*row
= it
->glyph_row
;
19123 Lisp_Object overlay_arrow_string
;
19125 void *wrap_data
= NULL
;
19126 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19127 int wrap_row_used
= -1;
19128 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19129 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19130 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19131 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19132 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19134 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19135 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19137 /* We always start displaying at hpos zero even if hscrolled. */
19138 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19140 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19141 >= it
->w
->desired_matrix
->nrows
)
19143 it
->w
->nrows_scale_factor
++;
19144 fonts_changed_p
= 1;
19148 /* Is IT->w showing the region? */
19149 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? it
->region_beg_charpos
: 0;
19151 /* Clear the result glyph row and enable it. */
19152 prepare_desired_row (row
);
19154 row
->y
= it
->current_y
;
19155 row
->start
= it
->start
;
19156 row
->continuation_lines_width
= it
->continuation_lines_width
;
19157 row
->displays_text_p
= 1;
19158 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19159 it
->starts_in_middle_of_char_p
= 0;
19161 /* Arrange the overlays nicely for our purposes. Usually, we call
19162 display_line on only one line at a time, in which case this
19163 can't really hurt too much, or we call it on lines which appear
19164 one after another in the buffer, in which case all calls to
19165 recenter_overlay_lists but the first will be pretty cheap. */
19166 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19168 /* Move over display elements that are not visible because we are
19169 hscrolled. This may stop at an x-position < IT->first_visible_x
19170 if the first glyph is partially visible or if we hit a line end. */
19171 if (it
->current_x
< it
->first_visible_x
)
19173 enum move_it_result move_result
;
19175 this_line_min_pos
= row
->start
.pos
;
19176 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19177 MOVE_TO_POS
| MOVE_TO_X
);
19178 /* If we are under a large hscroll, move_it_in_display_line_to
19179 could hit the end of the line without reaching
19180 it->first_visible_x. Pretend that we did reach it. This is
19181 especially important on a TTY, where we will call
19182 extend_face_to_end_of_line, which needs to know how many
19183 blank glyphs to produce. */
19184 if (it
->current_x
< it
->first_visible_x
19185 && (move_result
== MOVE_NEWLINE_OR_CR
19186 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19187 it
->current_x
= it
->first_visible_x
;
19189 /* Record the smallest positions seen while we moved over
19190 display elements that are not visible. This is needed by
19191 redisplay_internal for optimizing the case where the cursor
19192 stays inside the same line. The rest of this function only
19193 considers positions that are actually displayed, so
19194 RECORD_MAX_MIN_POS will not otherwise record positions that
19195 are hscrolled to the left of the left edge of the window. */
19196 min_pos
= CHARPOS (this_line_min_pos
);
19197 min_bpos
= BYTEPOS (this_line_min_pos
);
19201 /* We only do this when not calling `move_it_in_display_line_to'
19202 above, because move_it_in_display_line_to calls
19203 handle_line_prefix itself. */
19204 handle_line_prefix (it
);
19207 /* Get the initial row height. This is either the height of the
19208 text hscrolled, if there is any, or zero. */
19209 row
->ascent
= it
->max_ascent
;
19210 row
->height
= it
->max_ascent
+ it
->max_descent
;
19211 row
->phys_ascent
= it
->max_phys_ascent
;
19212 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19213 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19215 /* Utility macro to record max and min buffer positions seen until now. */
19216 #define RECORD_MAX_MIN_POS(IT) \
19219 int composition_p = !STRINGP ((IT)->string) \
19220 && ((IT)->what == IT_COMPOSITION); \
19221 ptrdiff_t current_pos = \
19222 composition_p ? (IT)->cmp_it.charpos \
19223 : IT_CHARPOS (*(IT)); \
19224 ptrdiff_t current_bpos = \
19225 composition_p ? CHAR_TO_BYTE (current_pos) \
19226 : IT_BYTEPOS (*(IT)); \
19227 if (current_pos < min_pos) \
19229 min_pos = current_pos; \
19230 min_bpos = current_bpos; \
19232 if (IT_CHARPOS (*it) > max_pos) \
19234 max_pos = IT_CHARPOS (*it); \
19235 max_bpos = IT_BYTEPOS (*it); \
19240 /* Loop generating characters. The loop is left with IT on the next
19241 character to display. */
19244 int n_glyphs_before
, hpos_before
, x_before
;
19246 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19248 /* Retrieve the next thing to display. Value is zero if end of
19250 if (!get_next_display_element (it
))
19252 /* Maybe add a space at the end of this line that is used to
19253 display the cursor there under X. Set the charpos of the
19254 first glyph of blank lines not corresponding to any text
19256 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19257 row
->exact_window_width_line_p
= 1;
19258 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19259 || row
->used
[TEXT_AREA
] == 0)
19261 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19262 row
->displays_text_p
= 0;
19264 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
19265 && (!MINI_WINDOW_P (it
->w
)
19266 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19267 row
->indicate_empty_line_p
= 1;
19270 it
->continuation_lines_width
= 0;
19271 row
->ends_at_zv_p
= 1;
19272 /* A row that displays right-to-left text must always have
19273 its last face extended all the way to the end of line,
19274 even if this row ends in ZV, because we still write to
19275 the screen left to right. We also need to extend the
19276 last face if the default face is remapped to some
19277 different face, otherwise the functions that clear
19278 portions of the screen will clear with the default face's
19279 background color. */
19280 if (row
->reversed_p
19281 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19282 extend_face_to_end_of_line (it
);
19286 /* Now, get the metrics of what we want to display. This also
19287 generates glyphs in `row' (which is IT->glyph_row). */
19288 n_glyphs_before
= row
->used
[TEXT_AREA
];
19291 /* Remember the line height so far in case the next element doesn't
19292 fit on the line. */
19293 if (it
->line_wrap
!= TRUNCATE
)
19295 ascent
= it
->max_ascent
;
19296 descent
= it
->max_descent
;
19297 phys_ascent
= it
->max_phys_ascent
;
19298 phys_descent
= it
->max_phys_descent
;
19300 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19302 if (IT_DISPLAYING_WHITESPACE (it
))
19306 SAVE_IT (wrap_it
, *it
, wrap_data
);
19308 wrap_row_used
= row
->used
[TEXT_AREA
];
19309 wrap_row_ascent
= row
->ascent
;
19310 wrap_row_height
= row
->height
;
19311 wrap_row_phys_ascent
= row
->phys_ascent
;
19312 wrap_row_phys_height
= row
->phys_height
;
19313 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19314 wrap_row_min_pos
= min_pos
;
19315 wrap_row_min_bpos
= min_bpos
;
19316 wrap_row_max_pos
= max_pos
;
19317 wrap_row_max_bpos
= max_bpos
;
19323 PRODUCE_GLYPHS (it
);
19325 /* If this display element was in marginal areas, continue with
19327 if (it
->area
!= TEXT_AREA
)
19329 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19330 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19331 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19332 row
->phys_height
= max (row
->phys_height
,
19333 it
->max_phys_ascent
+ it
->max_phys_descent
);
19334 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19335 it
->max_extra_line_spacing
);
19336 set_iterator_to_next (it
, 1);
19340 /* Does the display element fit on the line? If we truncate
19341 lines, we should draw past the right edge of the window. If
19342 we don't truncate, we want to stop so that we can display the
19343 continuation glyph before the right margin. If lines are
19344 continued, there are two possible strategies for characters
19345 resulting in more than 1 glyph (e.g. tabs): Display as many
19346 glyphs as possible in this line and leave the rest for the
19347 continuation line, or display the whole element in the next
19348 line. Original redisplay did the former, so we do it also. */
19349 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19350 hpos_before
= it
->hpos
;
19353 if (/* Not a newline. */
19355 /* Glyphs produced fit entirely in the line. */
19356 && it
->current_x
< it
->last_visible_x
)
19358 it
->hpos
+= nglyphs
;
19359 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19360 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19361 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19362 row
->phys_height
= max (row
->phys_height
,
19363 it
->max_phys_ascent
+ it
->max_phys_descent
);
19364 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19365 it
->max_extra_line_spacing
);
19366 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19367 row
->x
= x
- it
->first_visible_x
;
19368 /* Record the maximum and minimum buffer positions seen so
19369 far in glyphs that will be displayed by this row. */
19371 RECORD_MAX_MIN_POS (it
);
19376 struct glyph
*glyph
;
19378 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19380 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19381 new_x
= x
+ glyph
->pixel_width
;
19383 if (/* Lines are continued. */
19384 it
->line_wrap
!= TRUNCATE
19385 && (/* Glyph doesn't fit on the line. */
19386 new_x
> it
->last_visible_x
19387 /* Or it fits exactly on a window system frame. */
19388 || (new_x
== it
->last_visible_x
19389 && FRAME_WINDOW_P (it
->f
)
19390 && (row
->reversed_p
19391 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19392 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19394 /* End of a continued line. */
19397 || (new_x
== it
->last_visible_x
19398 && FRAME_WINDOW_P (it
->f
)
19399 && (row
->reversed_p
19400 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19401 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19403 /* Current glyph is the only one on the line or
19404 fits exactly on the line. We must continue
19405 the line because we can't draw the cursor
19406 after the glyph. */
19407 row
->continued_p
= 1;
19408 it
->current_x
= new_x
;
19409 it
->continuation_lines_width
+= new_x
;
19411 if (i
== nglyphs
- 1)
19413 /* If line-wrap is on, check if a previous
19414 wrap point was found. */
19415 if (wrap_row_used
> 0
19416 /* Even if there is a previous wrap
19417 point, continue the line here as
19418 usual, if (i) the previous character
19419 was a space or tab AND (ii) the
19420 current character is not. */
19422 || IT_DISPLAYING_WHITESPACE (it
)))
19425 /* Record the maximum and minimum buffer
19426 positions seen so far in glyphs that will be
19427 displayed by this row. */
19429 RECORD_MAX_MIN_POS (it
);
19430 set_iterator_to_next (it
, 1);
19431 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19433 if (!get_next_display_element (it
))
19435 row
->exact_window_width_line_p
= 1;
19436 it
->continuation_lines_width
= 0;
19437 row
->continued_p
= 0;
19438 row
->ends_at_zv_p
= 1;
19440 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19442 row
->continued_p
= 0;
19443 row
->exact_window_width_line_p
= 1;
19447 else if (it
->bidi_p
)
19448 RECORD_MAX_MIN_POS (it
);
19450 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19451 && !FRAME_WINDOW_P (it
->f
))
19453 /* A padding glyph that doesn't fit on this line.
19454 This means the whole character doesn't fit
19456 if (row
->reversed_p
)
19457 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19458 - n_glyphs_before
);
19459 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19461 /* Fill the rest of the row with continuation
19462 glyphs like in 20.x. */
19463 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19464 < row
->glyphs
[1 + TEXT_AREA
])
19465 produce_special_glyphs (it
, IT_CONTINUATION
);
19467 row
->continued_p
= 1;
19468 it
->current_x
= x_before
;
19469 it
->continuation_lines_width
+= x_before
;
19471 /* Restore the height to what it was before the
19472 element not fitting on the line. */
19473 it
->max_ascent
= ascent
;
19474 it
->max_descent
= descent
;
19475 it
->max_phys_ascent
= phys_ascent
;
19476 it
->max_phys_descent
= phys_descent
;
19478 else if (wrap_row_used
> 0)
19481 if (row
->reversed_p
)
19482 unproduce_glyphs (it
,
19483 row
->used
[TEXT_AREA
] - wrap_row_used
);
19484 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19485 it
->continuation_lines_width
+= wrap_x
;
19486 row
->used
[TEXT_AREA
] = wrap_row_used
;
19487 row
->ascent
= wrap_row_ascent
;
19488 row
->height
= wrap_row_height
;
19489 row
->phys_ascent
= wrap_row_phys_ascent
;
19490 row
->phys_height
= wrap_row_phys_height
;
19491 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19492 min_pos
= wrap_row_min_pos
;
19493 min_bpos
= wrap_row_min_bpos
;
19494 max_pos
= wrap_row_max_pos
;
19495 max_bpos
= wrap_row_max_bpos
;
19496 row
->continued_p
= 1;
19497 row
->ends_at_zv_p
= 0;
19498 row
->exact_window_width_line_p
= 0;
19499 it
->continuation_lines_width
+= x
;
19501 /* Make sure that a non-default face is extended
19502 up to the right margin of the window. */
19503 extend_face_to_end_of_line (it
);
19505 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19507 /* A TAB that extends past the right edge of the
19508 window. This produces a single glyph on
19509 window system frames. We leave the glyph in
19510 this row and let it fill the row, but don't
19511 consume the TAB. */
19512 if ((row
->reversed_p
19513 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19514 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19515 produce_special_glyphs (it
, IT_CONTINUATION
);
19516 it
->continuation_lines_width
+= it
->last_visible_x
;
19517 row
->ends_in_middle_of_char_p
= 1;
19518 row
->continued_p
= 1;
19519 glyph
->pixel_width
= it
->last_visible_x
- x
;
19520 it
->starts_in_middle_of_char_p
= 1;
19524 /* Something other than a TAB that draws past
19525 the right edge of the window. Restore
19526 positions to values before the element. */
19527 if (row
->reversed_p
)
19528 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19529 - (n_glyphs_before
+ i
));
19530 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19532 /* Display continuation glyphs. */
19533 it
->current_x
= x_before
;
19534 it
->continuation_lines_width
+= x
;
19535 if (!FRAME_WINDOW_P (it
->f
)
19536 || (row
->reversed_p
19537 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19538 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19539 produce_special_glyphs (it
, IT_CONTINUATION
);
19540 row
->continued_p
= 1;
19542 extend_face_to_end_of_line (it
);
19544 if (nglyphs
> 1 && i
> 0)
19546 row
->ends_in_middle_of_char_p
= 1;
19547 it
->starts_in_middle_of_char_p
= 1;
19550 /* Restore the height to what it was before the
19551 element not fitting on the line. */
19552 it
->max_ascent
= ascent
;
19553 it
->max_descent
= descent
;
19554 it
->max_phys_ascent
= phys_ascent
;
19555 it
->max_phys_descent
= phys_descent
;
19560 else if (new_x
> it
->first_visible_x
)
19562 /* Increment number of glyphs actually displayed. */
19565 /* Record the maximum and minimum buffer positions
19566 seen so far in glyphs that will be displayed by
19569 RECORD_MAX_MIN_POS (it
);
19571 if (x
< it
->first_visible_x
)
19572 /* Glyph is partially visible, i.e. row starts at
19573 negative X position. */
19574 row
->x
= x
- it
->first_visible_x
;
19578 /* Glyph is completely off the left margin of the
19579 window. This should not happen because of the
19580 move_it_in_display_line at the start of this
19581 function, unless the text display area of the
19582 window is empty. */
19583 eassert (it
->first_visible_x
<= it
->last_visible_x
);
19586 /* Even if this display element produced no glyphs at all,
19587 we want to record its position. */
19588 if (it
->bidi_p
&& nglyphs
== 0)
19589 RECORD_MAX_MIN_POS (it
);
19591 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19592 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19593 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19594 row
->phys_height
= max (row
->phys_height
,
19595 it
->max_phys_ascent
+ it
->max_phys_descent
);
19596 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19597 it
->max_extra_line_spacing
);
19599 /* End of this display line if row is continued. */
19600 if (row
->continued_p
|| row
->ends_at_zv_p
)
19605 /* Is this a line end? If yes, we're also done, after making
19606 sure that a non-default face is extended up to the right
19607 margin of the window. */
19608 if (ITERATOR_AT_END_OF_LINE_P (it
))
19610 int used_before
= row
->used
[TEXT_AREA
];
19612 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19614 /* Add a space at the end of the line that is used to
19615 display the cursor there. */
19616 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19617 append_space_for_newline (it
, 0);
19619 /* Extend the face to the end of the line. */
19620 extend_face_to_end_of_line (it
);
19622 /* Make sure we have the position. */
19623 if (used_before
== 0)
19624 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19626 /* Record the position of the newline, for use in
19628 it
->eol_pos
= it
->current
.pos
;
19630 /* Consume the line end. This skips over invisible lines. */
19631 set_iterator_to_next (it
, 1);
19632 it
->continuation_lines_width
= 0;
19636 /* Proceed with next display element. Note that this skips
19637 over lines invisible because of selective display. */
19638 set_iterator_to_next (it
, 1);
19640 /* If we truncate lines, we are done when the last displayed
19641 glyphs reach past the right margin of the window. */
19642 if (it
->line_wrap
== TRUNCATE
19643 && (FRAME_WINDOW_P (it
->f
) && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19644 ? (it
->current_x
>= it
->last_visible_x
)
19645 : (it
->current_x
> it
->last_visible_x
)))
19647 /* Maybe add truncation glyphs. */
19648 if (!FRAME_WINDOW_P (it
->f
)
19649 || (row
->reversed_p
19650 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19651 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19655 if (!row
->reversed_p
)
19657 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19658 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19663 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19664 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19666 /* Remove any padding glyphs at the front of ROW, to
19667 make room for the truncation glyphs we will be
19668 adding below. The loop below always inserts at
19669 least one truncation glyph, so also remove the
19670 last glyph added to ROW. */
19671 unproduce_glyphs (it
, i
+ 1);
19672 /* Adjust i for the loop below. */
19673 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19676 it
->current_x
= x_before
;
19677 if (!FRAME_WINDOW_P (it
->f
))
19679 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19681 row
->used
[TEXT_AREA
] = i
;
19682 produce_special_glyphs (it
, IT_TRUNCATION
);
19687 row
->used
[TEXT_AREA
] = i
;
19688 produce_special_glyphs (it
, IT_TRUNCATION
);
19691 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19693 /* Don't truncate if we can overflow newline into fringe. */
19694 if (!get_next_display_element (it
))
19696 it
->continuation_lines_width
= 0;
19697 row
->ends_at_zv_p
= 1;
19698 row
->exact_window_width_line_p
= 1;
19701 if (ITERATOR_AT_END_OF_LINE_P (it
))
19703 row
->exact_window_width_line_p
= 1;
19704 goto at_end_of_line
;
19706 it
->current_x
= x_before
;
19709 row
->truncated_on_right_p
= 1;
19710 it
->continuation_lines_width
= 0;
19711 reseat_at_next_visible_line_start (it
, 0);
19712 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19713 it
->hpos
= hpos_before
;
19719 bidi_unshelve_cache (wrap_data
, 1);
19721 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19722 at the left window margin. */
19723 if (it
->first_visible_x
19724 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19726 if (!FRAME_WINDOW_P (it
->f
)
19727 || (row
->reversed_p
19728 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19729 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
19730 insert_left_trunc_glyphs (it
);
19731 row
->truncated_on_left_p
= 1;
19734 /* Remember the position at which this line ends.
19736 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19737 cannot be before the call to find_row_edges below, since that is
19738 where these positions are determined. */
19739 row
->end
= it
->current
;
19742 row
->minpos
= row
->start
.pos
;
19743 row
->maxpos
= row
->end
.pos
;
19747 /* ROW->minpos and ROW->maxpos must be the smallest and
19748 `1 + the largest' buffer positions in ROW. But if ROW was
19749 bidi-reordered, these two positions can be anywhere in the
19750 row, so we must determine them now. */
19751 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19754 /* If the start of this line is the overlay arrow-position, then
19755 mark this glyph row as the one containing the overlay arrow.
19756 This is clearly a mess with variable size fonts. It would be
19757 better to let it be displayed like cursors under X. */
19758 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
19759 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19760 !NILP (overlay_arrow_string
)))
19762 /* Overlay arrow in window redisplay is a fringe bitmap. */
19763 if (STRINGP (overlay_arrow_string
))
19765 struct glyph_row
*arrow_row
19766 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19767 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19768 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19769 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19770 struct glyph
*p2
, *end
;
19772 /* Copy the arrow glyphs. */
19773 while (glyph
< arrow_end
)
19776 /* Throw away padding glyphs. */
19778 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19779 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19785 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19790 eassert (INTEGERP (overlay_arrow_string
));
19791 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19793 overlay_arrow_seen
= 1;
19796 /* Highlight trailing whitespace. */
19797 if (!NILP (Vshow_trailing_whitespace
))
19798 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19800 /* Compute pixel dimensions of this line. */
19801 compute_line_metrics (it
);
19803 /* Implementation note: No changes in the glyphs of ROW or in their
19804 faces can be done past this point, because compute_line_metrics
19805 computes ROW's hash value and stores it within the glyph_row
19808 /* Record whether this row ends inside an ellipsis. */
19809 row
->ends_in_ellipsis_p
19810 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19811 && it
->ellipsis_p
);
19813 /* Save fringe bitmaps in this row. */
19814 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19815 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19816 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19817 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19819 it
->left_user_fringe_bitmap
= 0;
19820 it
->left_user_fringe_face_id
= 0;
19821 it
->right_user_fringe_bitmap
= 0;
19822 it
->right_user_fringe_face_id
= 0;
19824 /* Maybe set the cursor. */
19825 cvpos
= it
->w
->cursor
.vpos
;
19827 /* In bidi-reordered rows, keep checking for proper cursor
19828 position even if one has been found already, because buffer
19829 positions in such rows change non-linearly with ROW->VPOS,
19830 when a line is continued. One exception: when we are at ZV,
19831 display cursor on the first suitable glyph row, since all
19832 the empty rows after that also have their position set to ZV. */
19833 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19834 lines' rows is implemented for bidi-reordered rows. */
19836 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19837 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19838 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19839 && cursor_row_p (row
))
19840 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19842 /* Prepare for the next line. This line starts horizontally at (X
19843 HPOS) = (0 0). Vertical positions are incremented. As a
19844 convenience for the caller, IT->glyph_row is set to the next
19846 it
->current_x
= it
->hpos
= 0;
19847 it
->current_y
+= row
->height
;
19848 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19851 /* The next row should by default use the same value of the
19852 reversed_p flag as this one. set_iterator_to_next decides when
19853 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19854 the flag accordingly. */
19855 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19856 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19857 it
->start
= row
->end
;
19858 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
19860 #undef RECORD_MAX_MIN_POS
19863 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19864 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19865 doc
: /* Return paragraph direction at point in BUFFER.
19866 Value is either `left-to-right' or `right-to-left'.
19867 If BUFFER is omitted or nil, it defaults to the current buffer.
19869 Paragraph direction determines how the text in the paragraph is displayed.
19870 In left-to-right paragraphs, text begins at the left margin of the window
19871 and the reading direction is generally left to right. In right-to-left
19872 paragraphs, text begins at the right margin and is read from right to left.
19874 See also `bidi-paragraph-direction'. */)
19875 (Lisp_Object buffer
)
19877 struct buffer
*buf
= current_buffer
;
19878 struct buffer
*old
= buf
;
19880 if (! NILP (buffer
))
19882 CHECK_BUFFER (buffer
);
19883 buf
= XBUFFER (buffer
);
19886 if (NILP (BVAR (buf
, bidi_display_reordering
))
19887 || NILP (BVAR (buf
, enable_multibyte_characters
))
19888 /* When we are loading loadup.el, the character property tables
19889 needed for bidi iteration are not yet available. */
19890 || !NILP (Vpurify_flag
))
19891 return Qleft_to_right
;
19892 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19893 return BVAR (buf
, bidi_paragraph_direction
);
19896 /* Determine the direction from buffer text. We could try to
19897 use current_matrix if it is up to date, but this seems fast
19898 enough as it is. */
19899 struct bidi_it itb
;
19900 ptrdiff_t pos
= BUF_PT (buf
);
19901 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
19903 void *itb_data
= bidi_shelve_cache ();
19905 set_buffer_temp (buf
);
19906 /* bidi_paragraph_init finds the base direction of the paragraph
19907 by searching forward from paragraph start. We need the base
19908 direction of the current or _previous_ paragraph, so we need
19909 to make sure we are within that paragraph. To that end, find
19910 the previous non-empty line. */
19911 if (pos
>= ZV
&& pos
> BEGV
)
19912 DEC_BOTH (pos
, bytepos
);
19913 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19914 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19916 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19917 || c
== ' ' || c
== '\t' || c
== '\f')
19919 if (bytepos
<= BEGV_BYTE
)
19924 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19927 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19928 itb
.paragraph_dir
= NEUTRAL_DIR
;
19929 itb
.string
.s
= NULL
;
19930 itb
.string
.lstring
= Qnil
;
19931 itb
.string
.bufpos
= 0;
19932 itb
.string
.unibyte
= 0;
19933 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19934 bidi_unshelve_cache (itb_data
, 0);
19935 set_buffer_temp (old
);
19936 switch (itb
.paragraph_dir
)
19939 return Qleft_to_right
;
19942 return Qright_to_left
;
19952 /***********************************************************************
19954 ***********************************************************************/
19956 /* Redisplay the menu bar in the frame for window W.
19958 The menu bar of X frames that don't have X toolkit support is
19959 displayed in a special window W->frame->menu_bar_window.
19961 The menu bar of terminal frames is treated specially as far as
19962 glyph matrices are concerned. Menu bar lines are not part of
19963 windows, so the update is done directly on the frame matrix rows
19964 for the menu bar. */
19967 display_menu_bar (struct window
*w
)
19969 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19974 /* Don't do all this for graphical frames. */
19976 if (FRAME_W32_P (f
))
19979 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19985 if (FRAME_NS_P (f
))
19987 #endif /* HAVE_NS */
19989 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19990 eassert (!FRAME_WINDOW_P (f
));
19991 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19992 it
.first_visible_x
= 0;
19993 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19994 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
19995 if (FRAME_WINDOW_P (f
))
19997 /* Menu bar lines are displayed in the desired matrix of the
19998 dummy window menu_bar_window. */
19999 struct window
*menu_w
;
20000 menu_w
= XWINDOW (f
->menu_bar_window
);
20001 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
20003 it
.first_visible_x
= 0;
20004 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20007 #endif /* not USE_X_TOOLKIT and not USE_GTK */
20009 /* This is a TTY frame, i.e. character hpos/vpos are used as
20011 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
20013 it
.first_visible_x
= 0;
20014 it
.last_visible_x
= FRAME_COLS (f
);
20017 /* FIXME: This should be controlled by a user option. See the
20018 comments in redisplay_tool_bar and display_mode_line about
20020 it
.paragraph_embedding
= L2R
;
20022 /* Clear all rows of the menu bar. */
20023 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
20025 struct glyph_row
*row
= it
.glyph_row
+ i
;
20026 clear_glyph_row (row
);
20027 row
->enabled_p
= 1;
20028 row
->full_width_p
= 1;
20031 /* Display all items of the menu bar. */
20032 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
20033 for (i
= 0; i
< ASIZE (items
); i
+= 4)
20035 Lisp_Object string
;
20037 /* Stop at nil string. */
20038 string
= AREF (items
, i
+ 1);
20042 /* Remember where item was displayed. */
20043 ASET (items
, i
+ 3, make_number (it
.hpos
));
20045 /* Display the item, pad with one space. */
20046 if (it
.current_x
< it
.last_visible_x
)
20047 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
20048 SCHARS (string
) + 1, 0, 0, -1);
20051 /* Fill out the line with spaces. */
20052 if (it
.current_x
< it
.last_visible_x
)
20053 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
20055 /* Compute the total height of the lines. */
20056 compute_line_metrics (&it
);
20061 /***********************************************************************
20063 ***********************************************************************/
20065 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20066 FORCE is non-zero, redisplay mode lines unconditionally.
20067 Otherwise, redisplay only mode lines that are garbaged. Value is
20068 the number of windows whose mode lines were redisplayed. */
20071 redisplay_mode_lines (Lisp_Object window
, int force
)
20075 while (!NILP (window
))
20077 struct window
*w
= XWINDOW (window
);
20079 if (WINDOWP (w
->contents
))
20080 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
20082 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20083 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20085 struct text_pos lpoint
;
20086 struct buffer
*old
= current_buffer
;
20088 /* Set the window's buffer for the mode line display. */
20089 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20090 set_buffer_internal_1 (XBUFFER (w
->contents
));
20092 /* Point refers normally to the selected window. For any
20093 other window, set up appropriate value. */
20094 if (!EQ (window
, selected_window
))
20096 struct text_pos pt
;
20098 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20099 if (CHARPOS (pt
) < BEGV
)
20100 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
20101 else if (CHARPOS (pt
) > (ZV
- 1))
20102 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
20104 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20107 /* Display mode lines. */
20108 clear_glyph_matrix (w
->desired_matrix
);
20109 if (display_mode_lines (w
))
20112 w
->must_be_updated_p
= 1;
20115 /* Restore old settings. */
20116 set_buffer_internal_1 (old
);
20117 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20127 /* Display the mode and/or header line of window W. Value is the
20128 sum number of mode lines and header lines displayed. */
20131 display_mode_lines (struct window
*w
)
20133 Lisp_Object old_selected_window
= selected_window
;
20134 Lisp_Object old_selected_frame
= selected_frame
;
20135 Lisp_Object new_frame
= w
->frame
;
20136 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
20139 selected_frame
= new_frame
;
20140 /* FIXME: If we were to allow the mode-line's computation changing the buffer
20141 or window's point, then we'd need select_window_1 here as well. */
20142 XSETWINDOW (selected_window
, w
);
20143 XFRAME (new_frame
)->selected_window
= selected_window
;
20145 /* These will be set while the mode line specs are processed. */
20146 line_number_displayed
= 0;
20147 w
->column_number_displayed
= -1;
20149 if (WINDOW_WANTS_MODELINE_P (w
))
20151 struct window
*sel_w
= XWINDOW (old_selected_window
);
20153 /* Select mode line face based on the real selected window. */
20154 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20155 BVAR (current_buffer
, mode_line_format
));
20159 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20161 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20162 BVAR (current_buffer
, header_line_format
));
20166 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
20167 selected_frame
= old_selected_frame
;
20168 selected_window
= old_selected_window
;
20173 /* Display mode or header line of window W. FACE_ID specifies which
20174 line to display; it is either MODE_LINE_FACE_ID or
20175 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20176 display. Value is the pixel height of the mode/header line
20180 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20184 ptrdiff_t count
= SPECPDL_INDEX ();
20186 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20187 /* Don't extend on a previously drawn mode-line.
20188 This may happen if called from pos_visible_p. */
20189 it
.glyph_row
->enabled_p
= 0;
20190 prepare_desired_row (it
.glyph_row
);
20192 it
.glyph_row
->mode_line_p
= 1;
20194 /* FIXME: This should be controlled by a user option. But
20195 supporting such an option is not trivial, since the mode line is
20196 made up of many separate strings. */
20197 it
.paragraph_embedding
= L2R
;
20199 record_unwind_protect (unwind_format_mode_line
,
20200 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
20202 mode_line_target
= MODE_LINE_DISPLAY
;
20204 /* Temporarily make frame's keyboard the current kboard so that
20205 kboard-local variables in the mode_line_format will get the right
20207 push_kboard (FRAME_KBOARD (it
.f
));
20208 record_unwind_save_match_data ();
20209 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20212 unbind_to (count
, Qnil
);
20214 /* Fill up with spaces. */
20215 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20217 compute_line_metrics (&it
);
20218 it
.glyph_row
->full_width_p
= 1;
20219 it
.glyph_row
->continued_p
= 0;
20220 it
.glyph_row
->truncated_on_left_p
= 0;
20221 it
.glyph_row
->truncated_on_right_p
= 0;
20223 /* Make a 3D mode-line have a shadow at its right end. */
20224 face
= FACE_FROM_ID (it
.f
, face_id
);
20225 extend_face_to_end_of_line (&it
);
20226 if (face
->box
!= FACE_NO_BOX
)
20228 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20229 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20230 last
->right_box_line_p
= 1;
20233 return it
.glyph_row
->height
;
20236 /* Move element ELT in LIST to the front of LIST.
20237 Return the updated list. */
20240 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20242 register Lisp_Object tail
, prev
;
20243 register Lisp_Object tem
;
20247 while (CONSP (tail
))
20253 /* Splice out the link TAIL. */
20255 list
= XCDR (tail
);
20257 Fsetcdr (prev
, XCDR (tail
));
20259 /* Now make it the first. */
20260 Fsetcdr (tail
, list
);
20265 tail
= XCDR (tail
);
20269 /* Not found--return unchanged LIST. */
20273 /* Contribute ELT to the mode line for window IT->w. How it
20274 translates into text depends on its data type.
20276 IT describes the display environment in which we display, as usual.
20278 DEPTH is the depth in recursion. It is used to prevent
20279 infinite recursion here.
20281 FIELD_WIDTH is the number of characters the display of ELT should
20282 occupy in the mode line, and PRECISION is the maximum number of
20283 characters to display from ELT's representation. See
20284 display_string for details.
20286 Returns the hpos of the end of the text generated by ELT.
20288 PROPS is a property list to add to any string we encounter.
20290 If RISKY is nonzero, remove (disregard) any properties in any string
20291 we encounter, and ignore :eval and :propertize.
20293 The global variable `mode_line_target' determines whether the
20294 output is passed to `store_mode_line_noprop',
20295 `store_mode_line_string', or `display_string'. */
20298 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20299 Lisp_Object elt
, Lisp_Object props
, int risky
)
20301 int n
= 0, field
, prec
;
20306 elt
= build_string ("*too-deep*");
20310 switch (XTYPE (elt
))
20314 /* A string: output it and check for %-constructs within it. */
20316 ptrdiff_t offset
= 0;
20318 if (SCHARS (elt
) > 0
20319 && (!NILP (props
) || risky
))
20321 Lisp_Object oprops
, aelt
;
20322 oprops
= Ftext_properties_at (make_number (0), elt
);
20324 /* If the starting string's properties are not what
20325 we want, translate the string. Also, if the string
20326 is risky, do that anyway. */
20328 if (NILP (Fequal (props
, oprops
)) || risky
)
20330 /* If the starting string has properties,
20331 merge the specified ones onto the existing ones. */
20332 if (! NILP (oprops
) && !risky
)
20336 oprops
= Fcopy_sequence (oprops
);
20338 while (CONSP (tem
))
20340 oprops
= Fplist_put (oprops
, XCAR (tem
),
20341 XCAR (XCDR (tem
)));
20342 tem
= XCDR (XCDR (tem
));
20347 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20348 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20350 /* AELT is what we want. Move it to the front
20351 without consing. */
20353 mode_line_proptrans_alist
20354 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20360 /* If AELT has the wrong props, it is useless.
20361 so get rid of it. */
20363 mode_line_proptrans_alist
20364 = Fdelq (aelt
, mode_line_proptrans_alist
);
20366 elt
= Fcopy_sequence (elt
);
20367 Fset_text_properties (make_number (0), Flength (elt
),
20369 /* Add this item to mode_line_proptrans_alist. */
20370 mode_line_proptrans_alist
20371 = Fcons (Fcons (elt
, props
),
20372 mode_line_proptrans_alist
);
20373 /* Truncate mode_line_proptrans_alist
20374 to at most 50 elements. */
20375 tem
= Fnthcdr (make_number (50),
20376 mode_line_proptrans_alist
);
20378 XSETCDR (tem
, Qnil
);
20387 prec
= precision
- n
;
20388 switch (mode_line_target
)
20390 case MODE_LINE_NOPROP
:
20391 case MODE_LINE_TITLE
:
20392 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20394 case MODE_LINE_STRING
:
20395 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20397 case MODE_LINE_DISPLAY
:
20398 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20399 0, prec
, 0, STRING_MULTIBYTE (elt
));
20406 /* Handle the non-literal case. */
20408 while ((precision
<= 0 || n
< precision
)
20409 && SREF (elt
, offset
) != 0
20410 && (mode_line_target
!= MODE_LINE_DISPLAY
20411 || it
->current_x
< it
->last_visible_x
))
20413 ptrdiff_t last_offset
= offset
;
20415 /* Advance to end of string or next format specifier. */
20416 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20419 if (offset
- 1 != last_offset
)
20421 ptrdiff_t nchars
, nbytes
;
20423 /* Output to end of string or up to '%'. Field width
20424 is length of string. Don't output more than
20425 PRECISION allows us. */
20428 prec
= c_string_width (SDATA (elt
) + last_offset
,
20429 offset
- last_offset
, precision
- n
,
20432 switch (mode_line_target
)
20434 case MODE_LINE_NOPROP
:
20435 case MODE_LINE_TITLE
:
20436 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20438 case MODE_LINE_STRING
:
20440 ptrdiff_t bytepos
= last_offset
;
20441 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20442 ptrdiff_t endpos
= (precision
<= 0
20443 ? string_byte_to_char (elt
, offset
)
20444 : charpos
+ nchars
);
20446 n
+= store_mode_line_string (NULL
,
20447 Fsubstring (elt
, make_number (charpos
),
20448 make_number (endpos
)),
20452 case MODE_LINE_DISPLAY
:
20454 ptrdiff_t bytepos
= last_offset
;
20455 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20457 if (precision
<= 0)
20458 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20459 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20461 STRING_MULTIBYTE (elt
));
20466 else /* c == '%' */
20468 ptrdiff_t percent_position
= offset
;
20470 /* Get the specified minimum width. Zero means
20473 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20474 field
= field
* 10 + c
- '0';
20476 /* Don't pad beyond the total padding allowed. */
20477 if (field_width
- n
> 0 && field
> field_width
- n
)
20478 field
= field_width
- n
;
20480 /* Note that either PRECISION <= 0 or N < PRECISION. */
20481 prec
= precision
- n
;
20484 n
+= display_mode_element (it
, depth
, field
, prec
,
20485 Vglobal_mode_string
, props
,
20490 ptrdiff_t bytepos
, charpos
;
20492 Lisp_Object string
;
20494 bytepos
= percent_position
;
20495 charpos
= (STRING_MULTIBYTE (elt
)
20496 ? string_byte_to_char (elt
, bytepos
)
20498 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20499 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20501 switch (mode_line_target
)
20503 case MODE_LINE_NOPROP
:
20504 case MODE_LINE_TITLE
:
20505 n
+= store_mode_line_noprop (spec
, field
, prec
);
20507 case MODE_LINE_STRING
:
20509 Lisp_Object tem
= build_string (spec
);
20510 props
= Ftext_properties_at (make_number (charpos
), elt
);
20511 /* Should only keep face property in props */
20512 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20515 case MODE_LINE_DISPLAY
:
20517 int nglyphs_before
, nwritten
;
20519 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20520 nwritten
= display_string (spec
, string
, elt
,
20525 /* Assign to the glyphs written above the
20526 string where the `%x' came from, position
20530 struct glyph
*glyph
20531 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20535 for (i
= 0; i
< nwritten
; ++i
)
20537 glyph
[i
].object
= elt
;
20538 glyph
[i
].charpos
= charpos
;
20555 /* A symbol: process the value of the symbol recursively
20556 as if it appeared here directly. Avoid error if symbol void.
20557 Special case: if value of symbol is a string, output the string
20560 register Lisp_Object tem
;
20562 /* If the variable is not marked as risky to set
20563 then its contents are risky to use. */
20564 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20567 tem
= Fboundp (elt
);
20570 tem
= Fsymbol_value (elt
);
20571 /* If value is a string, output that string literally:
20572 don't check for % within it. */
20576 if (!EQ (tem
, elt
))
20578 /* Give up right away for nil or t. */
20588 register Lisp_Object car
, tem
;
20590 /* A cons cell: five distinct cases.
20591 If first element is :eval or :propertize, do something special.
20592 If first element is a string or a cons, process all the elements
20593 and effectively concatenate them.
20594 If first element is a negative number, truncate displaying cdr to
20595 at most that many characters. If positive, pad (with spaces)
20596 to at least that many characters.
20597 If first element is a symbol, process the cadr or caddr recursively
20598 according to whether the symbol's value is non-nil or nil. */
20600 if (EQ (car
, QCeval
))
20602 /* An element of the form (:eval FORM) means evaluate FORM
20603 and use the result as mode line elements. */
20608 if (CONSP (XCDR (elt
)))
20611 spec
= safe_eval (XCAR (XCDR (elt
)));
20612 n
+= display_mode_element (it
, depth
, field_width
- n
,
20613 precision
- n
, spec
, props
,
20617 else if (EQ (car
, QCpropertize
))
20619 /* An element of the form (:propertize ELT PROPS...)
20620 means display ELT but applying properties PROPS. */
20625 if (CONSP (XCDR (elt
)))
20626 n
+= display_mode_element (it
, depth
, field_width
- n
,
20627 precision
- n
, XCAR (XCDR (elt
)),
20628 XCDR (XCDR (elt
)), risky
);
20630 else if (SYMBOLP (car
))
20632 tem
= Fboundp (car
);
20636 /* elt is now the cdr, and we know it is a cons cell.
20637 Use its car if CAR has a non-nil value. */
20640 tem
= Fsymbol_value (car
);
20647 /* Symbol's value is nil (or symbol is unbound)
20648 Get the cddr of the original list
20649 and if possible find the caddr and use that. */
20653 else if (!CONSP (elt
))
20658 else if (INTEGERP (car
))
20660 register int lim
= XINT (car
);
20664 /* Negative int means reduce maximum width. */
20665 if (precision
<= 0)
20668 precision
= min (precision
, -lim
);
20672 /* Padding specified. Don't let it be more than
20673 current maximum. */
20675 lim
= min (precision
, lim
);
20677 /* If that's more padding than already wanted, queue it.
20678 But don't reduce padding already specified even if
20679 that is beyond the current truncation point. */
20680 field_width
= max (lim
, field_width
);
20684 else if (STRINGP (car
) || CONSP (car
))
20686 Lisp_Object halftail
= elt
;
20690 && (precision
<= 0 || n
< precision
))
20692 n
+= display_mode_element (it
, depth
,
20693 /* Do padding only after the last
20694 element in the list. */
20695 (! CONSP (XCDR (elt
))
20698 precision
- n
, XCAR (elt
),
20702 if ((len
& 1) == 0)
20703 halftail
= XCDR (halftail
);
20704 /* Check for cycle. */
20705 if (EQ (halftail
, elt
))
20714 elt
= build_string ("*invalid*");
20718 /* Pad to FIELD_WIDTH. */
20719 if (field_width
> 0 && n
< field_width
)
20721 switch (mode_line_target
)
20723 case MODE_LINE_NOPROP
:
20724 case MODE_LINE_TITLE
:
20725 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20727 case MODE_LINE_STRING
:
20728 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20730 case MODE_LINE_DISPLAY
:
20731 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20740 /* Store a mode-line string element in mode_line_string_list.
20742 If STRING is non-null, display that C string. Otherwise, the Lisp
20743 string LISP_STRING is displayed.
20745 FIELD_WIDTH is the minimum number of output glyphs to produce.
20746 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20747 with spaces. FIELD_WIDTH <= 0 means don't pad.
20749 PRECISION is the maximum number of characters to output from
20750 STRING. PRECISION <= 0 means don't truncate the string.
20752 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20753 properties to the string.
20755 PROPS are the properties to add to the string.
20756 The mode_line_string_face face property is always added to the string.
20760 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20761 int field_width
, int precision
, Lisp_Object props
)
20766 if (string
!= NULL
)
20768 len
= strlen (string
);
20769 if (precision
> 0 && len
> precision
)
20771 lisp_string
= make_string (string
, len
);
20773 props
= mode_line_string_face_prop
;
20774 else if (!NILP (mode_line_string_face
))
20776 Lisp_Object face
= Fplist_get (props
, Qface
);
20777 props
= Fcopy_sequence (props
);
20779 face
= mode_line_string_face
;
20781 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20782 props
= Fplist_put (props
, Qface
, face
);
20784 Fadd_text_properties (make_number (0), make_number (len
),
20785 props
, lisp_string
);
20789 len
= XFASTINT (Flength (lisp_string
));
20790 if (precision
> 0 && len
> precision
)
20793 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20796 if (!NILP (mode_line_string_face
))
20800 props
= Ftext_properties_at (make_number (0), lisp_string
);
20801 face
= Fplist_get (props
, Qface
);
20803 face
= mode_line_string_face
;
20805 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20806 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20808 lisp_string
= Fcopy_sequence (lisp_string
);
20811 Fadd_text_properties (make_number (0), make_number (len
),
20812 props
, lisp_string
);
20817 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20821 if (field_width
> len
)
20823 field_width
-= len
;
20824 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20826 Fadd_text_properties (make_number (0), make_number (field_width
),
20827 props
, lisp_string
);
20828 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20836 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20838 doc
: /* Format a string out of a mode line format specification.
20839 First arg FORMAT specifies the mode line format (see `mode-line-format'
20840 for details) to use.
20842 By default, the format is evaluated for the currently selected window.
20844 Optional second arg FACE specifies the face property to put on all
20845 characters for which no face is specified. The value nil means the
20846 default face. The value t means whatever face the window's mode line
20847 currently uses (either `mode-line' or `mode-line-inactive',
20848 depending on whether the window is the selected window or not).
20849 An integer value means the value string has no text
20852 Optional third and fourth args WINDOW and BUFFER specify the window
20853 and buffer to use as the context for the formatting (defaults
20854 are the selected window and the WINDOW's buffer). */)
20855 (Lisp_Object format
, Lisp_Object face
,
20856 Lisp_Object window
, Lisp_Object buffer
)
20861 struct buffer
*old_buffer
= NULL
;
20863 int no_props
= INTEGERP (face
);
20864 ptrdiff_t count
= SPECPDL_INDEX ();
20866 int string_start
= 0;
20868 w
= decode_any_window (window
);
20869 XSETWINDOW (window
, w
);
20872 buffer
= w
->contents
;
20873 CHECK_BUFFER (buffer
);
20875 /* Make formatting the modeline a non-op when noninteractive, otherwise
20876 there will be problems later caused by a partially initialized frame. */
20877 if (NILP (format
) || noninteractive
)
20878 return empty_unibyte_string
;
20883 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20884 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20885 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20886 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20887 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20888 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20889 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20892 old_buffer
= current_buffer
;
20894 /* Save things including mode_line_proptrans_alist,
20895 and set that to nil so that we don't alter the outer value. */
20896 record_unwind_protect (unwind_format_mode_line
,
20897 format_mode_line_unwind_data
20898 (XFRAME (WINDOW_FRAME (w
)),
20899 old_buffer
, selected_window
, 1));
20900 mode_line_proptrans_alist
= Qnil
;
20902 Fselect_window (window
, Qt
);
20903 set_buffer_internal_1 (XBUFFER (buffer
));
20905 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20909 mode_line_target
= MODE_LINE_NOPROP
;
20910 mode_line_string_face_prop
= Qnil
;
20911 mode_line_string_list
= Qnil
;
20912 string_start
= MODE_LINE_NOPROP_LEN (0);
20916 mode_line_target
= MODE_LINE_STRING
;
20917 mode_line_string_list
= Qnil
;
20918 mode_line_string_face
= face
;
20919 mode_line_string_face_prop
20920 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20923 push_kboard (FRAME_KBOARD (it
.f
));
20924 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20929 len
= MODE_LINE_NOPROP_LEN (string_start
);
20930 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20934 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20935 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20936 empty_unibyte_string
);
20939 unbind_to (count
, Qnil
);
20943 /* Write a null-terminated, right justified decimal representation of
20944 the positive integer D to BUF using a minimal field width WIDTH. */
20947 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
20949 register char *p
= buf
;
20957 *p
++ = d
% 10 + '0';
20962 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20973 /* Write a null-terminated, right justified decimal and "human
20974 readable" representation of the nonnegative integer D to BUF using
20975 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20977 static const char power_letter
[] =
20991 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
20993 /* We aim to represent the nonnegative integer D as
20994 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20995 ptrdiff_t quotient
= d
;
20997 /* -1 means: do not use TENTHS. */
21001 /* Length of QUOTIENT.TENTHS as a string. */
21007 if (quotient
>= 1000)
21009 /* Scale to the appropriate EXPONENT. */
21012 remainder
= quotient
% 1000;
21016 while (quotient
>= 1000);
21018 /* Round to nearest and decide whether to use TENTHS or not. */
21021 tenths
= remainder
/ 100;
21022 if (remainder
% 100 >= 50)
21029 if (quotient
== 10)
21037 if (remainder
>= 500)
21039 if (quotient
< 999)
21050 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21051 if (tenths
== -1 && quotient
<= 99)
21058 p
= psuffix
= buf
+ max (width
, length
);
21060 /* Print EXPONENT. */
21061 *psuffix
++ = power_letter
[exponent
];
21064 /* Print TENTHS. */
21067 *--p
= '0' + tenths
;
21071 /* Print QUOTIENT. */
21074 int digit
= quotient
% 10;
21075 *--p
= '0' + digit
;
21077 while ((quotient
/= 10) != 0);
21079 /* Print leading spaces. */
21084 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21085 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21086 type of CODING_SYSTEM. Return updated pointer into BUF. */
21088 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21091 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21094 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21095 const unsigned char *eol_str
;
21097 /* The EOL conversion we are using. */
21098 Lisp_Object eoltype
;
21100 val
= CODING_SYSTEM_SPEC (coding_system
);
21103 if (!VECTORP (val
)) /* Not yet decided. */
21105 *buf
++ = multibyte
? '-' : ' ';
21107 eoltype
= eol_mnemonic_undecided
;
21108 /* Don't mention EOL conversion if it isn't decided. */
21113 Lisp_Object eolvalue
;
21115 attrs
= AREF (val
, 0);
21116 eolvalue
= AREF (val
, 2);
21119 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21124 /* The EOL conversion that is normal on this system. */
21126 if (NILP (eolvalue
)) /* Not yet decided. */
21127 eoltype
= eol_mnemonic_undecided
;
21128 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21129 eoltype
= eol_mnemonic_undecided
;
21130 else /* eolvalue is Qunix, Qdos, or Qmac. */
21131 eoltype
= (EQ (eolvalue
, Qunix
)
21132 ? eol_mnemonic_unix
21133 : (EQ (eolvalue
, Qdos
) == 1
21134 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21140 /* Mention the EOL conversion if it is not the usual one. */
21141 if (STRINGP (eoltype
))
21143 eol_str
= SDATA (eoltype
);
21144 eol_str_len
= SBYTES (eoltype
);
21146 else if (CHARACTERP (eoltype
))
21148 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
21149 int c
= XFASTINT (eoltype
);
21150 eol_str_len
= CHAR_STRING (c
, tmp
);
21155 eol_str
= invalid_eol_type
;
21156 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21158 memcpy (buf
, eol_str
, eol_str_len
);
21159 buf
+= eol_str_len
;
21165 /* Return a string for the output of a mode line %-spec for window W,
21166 generated by character C. FIELD_WIDTH > 0 means pad the string
21167 returned with spaces to that value. Return a Lisp string in
21168 *STRING if the resulting string is taken from that Lisp string.
21170 Note we operate on the current buffer for most purposes. */
21172 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21174 static const char *
21175 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21176 Lisp_Object
*string
)
21179 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21180 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21181 /* We are going to use f->decode_mode_spec_buffer as the buffer to
21182 produce strings from numerical values, so limit preposterously
21183 large values of FIELD_WIDTH to avoid overrunning the buffer's
21184 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
21185 bytes plus the terminating null. */
21186 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
21187 struct buffer
*b
= current_buffer
;
21195 if (!NILP (BVAR (b
, read_only
)))
21197 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21202 /* This differs from %* only for a modified read-only buffer. */
21203 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21205 if (!NILP (BVAR (b
, read_only
)))
21210 /* This differs from %* in ignoring read-only-ness. */
21211 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21223 if (command_loop_level
> 5)
21225 p
= decode_mode_spec_buf
;
21226 for (i
= 0; i
< command_loop_level
; i
++)
21229 return decode_mode_spec_buf
;
21237 if (command_loop_level
> 5)
21239 p
= decode_mode_spec_buf
;
21240 for (i
= 0; i
< command_loop_level
; i
++)
21243 return decode_mode_spec_buf
;
21250 /* Let lots_of_dashes be a string of infinite length. */
21251 if (mode_line_target
== MODE_LINE_NOPROP
21252 || mode_line_target
== MODE_LINE_STRING
)
21254 if (field_width
<= 0
21255 || field_width
> sizeof (lots_of_dashes
))
21257 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21258 decode_mode_spec_buf
[i
] = '-';
21259 decode_mode_spec_buf
[i
] = '\0';
21260 return decode_mode_spec_buf
;
21263 return lots_of_dashes
;
21267 obj
= BVAR (b
, name
);
21271 /* %c and %l are ignored in `frame-title-format'.
21272 (In redisplay_internal, the frame title is drawn _before_ the
21273 windows are updated, so the stuff which depends on actual
21274 window contents (such as %l) may fail to render properly, or
21275 even crash emacs.) */
21276 if (mode_line_target
== MODE_LINE_TITLE
)
21280 ptrdiff_t col
= current_column ();
21281 w
->column_number_displayed
= col
;
21282 pint2str (decode_mode_spec_buf
, width
, col
);
21283 return decode_mode_spec_buf
;
21287 #ifndef SYSTEM_MALLOC
21289 if (NILP (Vmemory_full
))
21292 return "!MEM FULL! ";
21299 /* %F displays the frame name. */
21300 if (!NILP (f
->title
))
21301 return SSDATA (f
->title
);
21302 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21303 return SSDATA (f
->name
);
21307 obj
= BVAR (b
, filename
);
21312 ptrdiff_t size
= ZV
- BEGV
;
21313 pint2str (decode_mode_spec_buf
, width
, size
);
21314 return decode_mode_spec_buf
;
21319 ptrdiff_t size
= ZV
- BEGV
;
21320 pint2hrstr (decode_mode_spec_buf
, width
, size
);
21321 return decode_mode_spec_buf
;
21326 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21327 ptrdiff_t topline
, nlines
, height
;
21330 /* %c and %l are ignored in `frame-title-format'. */
21331 if (mode_line_target
== MODE_LINE_TITLE
)
21334 startpos
= marker_position (w
->start
);
21335 startpos_byte
= marker_byte_position (w
->start
);
21336 height
= WINDOW_TOTAL_LINES (w
);
21338 /* If we decided that this buffer isn't suitable for line numbers,
21339 don't forget that too fast. */
21340 if (w
->base_line_pos
== -1)
21343 /* If the buffer is very big, don't waste time. */
21344 if (INTEGERP (Vline_number_display_limit
)
21345 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21347 w
->base_line_pos
= 0;
21348 w
->base_line_number
= 0;
21352 if (w
->base_line_number
> 0
21353 && w
->base_line_pos
> 0
21354 && w
->base_line_pos
<= startpos
)
21356 line
= w
->base_line_number
;
21357 linepos
= w
->base_line_pos
;
21358 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21363 linepos
= BUF_BEGV (b
);
21364 linepos_byte
= BUF_BEGV_BYTE (b
);
21367 /* Count lines from base line to window start position. */
21368 nlines
= display_count_lines (linepos_byte
,
21372 topline
= nlines
+ line
;
21374 /* Determine a new base line, if the old one is too close
21375 or too far away, or if we did not have one.
21376 "Too close" means it's plausible a scroll-down would
21377 go back past it. */
21378 if (startpos
== BUF_BEGV (b
))
21380 w
->base_line_number
= topline
;
21381 w
->base_line_pos
= BUF_BEGV (b
);
21383 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21384 || linepos
== BUF_BEGV (b
))
21386 ptrdiff_t limit
= BUF_BEGV (b
);
21387 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21388 ptrdiff_t position
;
21389 ptrdiff_t distance
=
21390 (height
* 2 + 30) * line_number_display_limit_width
;
21392 if (startpos
- distance
> limit
)
21394 limit
= startpos
- distance
;
21395 limit_byte
= CHAR_TO_BYTE (limit
);
21398 nlines
= display_count_lines (startpos_byte
,
21400 - (height
* 2 + 30),
21402 /* If we couldn't find the lines we wanted within
21403 line_number_display_limit_width chars per line,
21404 give up on line numbers for this window. */
21405 if (position
== limit_byte
&& limit
== startpos
- distance
)
21407 w
->base_line_pos
= -1;
21408 w
->base_line_number
= 0;
21412 w
->base_line_number
= topline
- nlines
;
21413 w
->base_line_pos
= BYTE_TO_CHAR (position
);
21416 /* Now count lines from the start pos to point. */
21417 nlines
= display_count_lines (startpos_byte
,
21418 PT_BYTE
, PT
, &junk
);
21420 /* Record that we did display the line number. */
21421 line_number_displayed
= 1;
21423 /* Make the string to show. */
21424 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
21425 return decode_mode_spec_buf
;
21428 char* p
= decode_mode_spec_buf
;
21429 int pad
= width
- 2;
21435 return decode_mode_spec_buf
;
21441 obj
= BVAR (b
, mode_name
);
21445 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21451 ptrdiff_t pos
= marker_position (w
->start
);
21452 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21454 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21456 if (pos
<= BUF_BEGV (b
))
21461 else if (pos
<= BUF_BEGV (b
))
21465 if (total
> 1000000)
21466 /* Do it differently for a large value, to avoid overflow. */
21467 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21469 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21470 /* We can't normally display a 3-digit number,
21471 so get us a 2-digit number that is close. */
21474 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21475 return decode_mode_spec_buf
;
21479 /* Display percentage of size above the bottom of the screen. */
21482 ptrdiff_t toppos
= marker_position (w
->start
);
21483 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21484 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21486 if (botpos
>= BUF_ZV (b
))
21488 if (toppos
<= BUF_BEGV (b
))
21495 if (total
> 1000000)
21496 /* Do it differently for a large value, to avoid overflow. */
21497 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21499 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21500 /* We can't normally display a 3-digit number,
21501 so get us a 2-digit number that is close. */
21504 if (toppos
<= BUF_BEGV (b
))
21505 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21507 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21508 return decode_mode_spec_buf
;
21513 /* status of process */
21514 obj
= Fget_buffer_process (Fcurrent_buffer ());
21516 return "no process";
21518 obj
= Fsymbol_name (Fprocess_status (obj
));
21524 ptrdiff_t count
= inhibit_garbage_collection ();
21525 Lisp_Object val
= call1 (intern ("file-remote-p"),
21526 BVAR (current_buffer
, directory
));
21527 unbind_to (count
, Qnil
);
21536 /* coding-system (not including end-of-line format) */
21538 /* coding-system (including end-of-line type) */
21540 int eol_flag
= (c
== 'Z');
21541 char *p
= decode_mode_spec_buf
;
21543 if (! FRAME_WINDOW_P (f
))
21545 /* No need to mention EOL here--the terminal never needs
21546 to do EOL conversion. */
21547 p
= decode_mode_spec_coding (CODING_ID_NAME
21548 (FRAME_KEYBOARD_CODING (f
)->id
),
21550 p
= decode_mode_spec_coding (CODING_ID_NAME
21551 (FRAME_TERMINAL_CODING (f
)->id
),
21554 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21557 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21558 #ifdef subprocesses
21559 obj
= Fget_buffer_process (Fcurrent_buffer ());
21560 if (PROCESSP (obj
))
21562 p
= decode_mode_spec_coding
21563 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
21564 p
= decode_mode_spec_coding
21565 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
21567 #endif /* subprocesses */
21570 return decode_mode_spec_buf
;
21577 return SSDATA (obj
);
21584 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
21585 means count lines back from START_BYTE. But don't go beyond
21586 LIMIT_BYTE. Return the number of lines thus found (always
21589 Set *BYTE_POS_PTR to the byte position where we stopped. This is
21590 either the position COUNT lines after/before START_BYTE, if we
21591 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
21595 display_count_lines (ptrdiff_t start_byte
,
21596 ptrdiff_t limit_byte
, ptrdiff_t count
,
21597 ptrdiff_t *byte_pos_ptr
)
21599 register unsigned char *cursor
;
21600 unsigned char *base
;
21602 register ptrdiff_t ceiling
;
21603 register unsigned char *ceiling_addr
;
21604 ptrdiff_t orig_count
= count
;
21606 /* If we are not in selective display mode,
21607 check only for newlines. */
21608 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21609 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21613 while (start_byte
< limit_byte
)
21615 ceiling
= BUFFER_CEILING_OF (start_byte
);
21616 ceiling
= min (limit_byte
- 1, ceiling
);
21617 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21618 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21622 if (selective_display
)
21624 while (*cursor
!= '\n' && *cursor
!= 015
21625 && ++cursor
!= ceiling_addr
)
21627 if (cursor
== ceiling_addr
)
21632 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
21641 start_byte
+= cursor
- base
;
21642 *byte_pos_ptr
= start_byte
;
21646 while (cursor
< ceiling_addr
);
21648 start_byte
+= ceiling_addr
- base
;
21653 while (start_byte
> limit_byte
)
21655 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21656 ceiling
= max (limit_byte
, ceiling
);
21657 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
21658 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21661 if (selective_display
)
21663 while (--cursor
>= ceiling_addr
21664 && *cursor
!= '\n' && *cursor
!= 015)
21666 if (cursor
< ceiling_addr
)
21671 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
21678 start_byte
+= cursor
- base
+ 1;
21679 *byte_pos_ptr
= start_byte
;
21680 /* When scanning backwards, we should
21681 not count the newline posterior to which we stop. */
21682 return - orig_count
- 1;
21685 start_byte
+= ceiling_addr
- base
;
21689 *byte_pos_ptr
= limit_byte
;
21692 return - orig_count
+ count
;
21693 return orig_count
- count
;
21699 /***********************************************************************
21701 ***********************************************************************/
21703 /* Display a NUL-terminated string, starting with index START.
21705 If STRING is non-null, display that C string. Otherwise, the Lisp
21706 string LISP_STRING is displayed. There's a case that STRING is
21707 non-null and LISP_STRING is not nil. It means STRING is a string
21708 data of LISP_STRING. In that case, we display LISP_STRING while
21709 ignoring its text properties.
21711 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21712 FACE_STRING. Display STRING or LISP_STRING with the face at
21713 FACE_STRING_POS in FACE_STRING:
21715 Display the string in the environment given by IT, but use the
21716 standard display table, temporarily.
21718 FIELD_WIDTH is the minimum number of output glyphs to produce.
21719 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21720 with spaces. If STRING has more characters, more than FIELD_WIDTH
21721 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21723 PRECISION is the maximum number of characters to output from
21724 STRING. PRECISION < 0 means don't truncate the string.
21726 This is roughly equivalent to printf format specifiers:
21728 FIELD_WIDTH PRECISION PRINTF
21729 ----------------------------------------
21735 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21736 display them, and < 0 means obey the current buffer's value of
21737 enable_multibyte_characters.
21739 Value is the number of columns displayed. */
21742 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21743 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
21744 int field_width
, int precision
, int max_x
, int multibyte
)
21746 int hpos_at_start
= it
->hpos
;
21747 int saved_face_id
= it
->face_id
;
21748 struct glyph_row
*row
= it
->glyph_row
;
21749 ptrdiff_t it_charpos
;
21751 /* Initialize the iterator IT for iteration over STRING beginning
21752 with index START. */
21753 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21754 precision
, field_width
, multibyte
);
21755 if (string
&& STRINGP (lisp_string
))
21756 /* LISP_STRING is the one returned by decode_mode_spec. We should
21757 ignore its text properties. */
21758 it
->stop_charpos
= it
->end_charpos
;
21760 /* If displaying STRING, set up the face of the iterator from
21761 FACE_STRING, if that's given. */
21762 if (STRINGP (face_string
))
21768 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21769 0, it
->region_beg_charpos
,
21770 it
->region_end_charpos
,
21771 &endptr
, it
->base_face_id
, 0);
21772 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21773 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21776 /* Set max_x to the maximum allowed X position. Don't let it go
21777 beyond the right edge of the window. */
21779 max_x
= it
->last_visible_x
;
21781 max_x
= min (max_x
, it
->last_visible_x
);
21783 /* Skip over display elements that are not visible. because IT->w is
21785 if (it
->current_x
< it
->first_visible_x
)
21786 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21787 MOVE_TO_POS
| MOVE_TO_X
);
21789 row
->ascent
= it
->max_ascent
;
21790 row
->height
= it
->max_ascent
+ it
->max_descent
;
21791 row
->phys_ascent
= it
->max_phys_ascent
;
21792 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21793 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21795 if (STRINGP (it
->string
))
21796 it_charpos
= IT_STRING_CHARPOS (*it
);
21798 it_charpos
= IT_CHARPOS (*it
);
21800 /* This condition is for the case that we are called with current_x
21801 past last_visible_x. */
21802 while (it
->current_x
< max_x
)
21804 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21806 /* Get the next display element. */
21807 if (!get_next_display_element (it
))
21810 /* Produce glyphs. */
21811 x_before
= it
->current_x
;
21812 n_glyphs_before
= row
->used
[TEXT_AREA
];
21813 PRODUCE_GLYPHS (it
);
21815 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21818 while (i
< nglyphs
)
21820 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21822 if (it
->line_wrap
!= TRUNCATE
21823 && x
+ glyph
->pixel_width
> max_x
)
21825 /* End of continued line or max_x reached. */
21826 if (CHAR_GLYPH_PADDING_P (*glyph
))
21828 /* A wide character is unbreakable. */
21829 if (row
->reversed_p
)
21830 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21831 - n_glyphs_before
);
21832 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21833 it
->current_x
= x_before
;
21837 if (row
->reversed_p
)
21838 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21839 - (n_glyphs_before
+ i
));
21840 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21845 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21847 /* Glyph is at least partially visible. */
21849 if (x
< it
->first_visible_x
)
21850 row
->x
= x
- it
->first_visible_x
;
21854 /* Glyph is off the left margin of the display area.
21855 Should not happen. */
21859 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21860 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21861 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21862 row
->phys_height
= max (row
->phys_height
,
21863 it
->max_phys_ascent
+ it
->max_phys_descent
);
21864 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21865 it
->max_extra_line_spacing
);
21866 x
+= glyph
->pixel_width
;
21870 /* Stop if max_x reached. */
21874 /* Stop at line ends. */
21875 if (ITERATOR_AT_END_OF_LINE_P (it
))
21877 it
->continuation_lines_width
= 0;
21881 set_iterator_to_next (it
, 1);
21882 if (STRINGP (it
->string
))
21883 it_charpos
= IT_STRING_CHARPOS (*it
);
21885 it_charpos
= IT_CHARPOS (*it
);
21887 /* Stop if truncating at the right edge. */
21888 if (it
->line_wrap
== TRUNCATE
21889 && it
->current_x
>= it
->last_visible_x
)
21891 /* Add truncation mark, but don't do it if the line is
21892 truncated at a padding space. */
21893 if (it_charpos
< it
->string_nchars
)
21895 if (!FRAME_WINDOW_P (it
->f
))
21899 if (it
->current_x
> it
->last_visible_x
)
21901 if (!row
->reversed_p
)
21903 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21904 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21909 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21910 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21912 unproduce_glyphs (it
, ii
+ 1);
21913 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21915 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21917 row
->used
[TEXT_AREA
] = ii
;
21918 produce_special_glyphs (it
, IT_TRUNCATION
);
21921 produce_special_glyphs (it
, IT_TRUNCATION
);
21923 row
->truncated_on_right_p
= 1;
21929 /* Maybe insert a truncation at the left. */
21930 if (it
->first_visible_x
21933 if (!FRAME_WINDOW_P (it
->f
)
21934 || (row
->reversed_p
21935 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21936 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
21937 insert_left_trunc_glyphs (it
);
21938 row
->truncated_on_left_p
= 1;
21941 it
->face_id
= saved_face_id
;
21943 /* Value is number of columns displayed. */
21944 return it
->hpos
- hpos_at_start
;
21949 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21950 appears as an element of LIST or as the car of an element of LIST.
21951 If PROPVAL is a list, compare each element against LIST in that
21952 way, and return 1/2 if any element of PROPVAL is found in LIST.
21953 Otherwise return 0. This function cannot quit.
21954 The return value is 2 if the text is invisible but with an ellipsis
21955 and 1 if it's invisible and without an ellipsis. */
21958 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21960 register Lisp_Object tail
, proptail
;
21962 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21964 register Lisp_Object tem
;
21966 if (EQ (propval
, tem
))
21968 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21969 return NILP (XCDR (tem
)) ? 1 : 2;
21972 if (CONSP (propval
))
21974 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21976 Lisp_Object propelt
;
21977 propelt
= XCAR (proptail
);
21978 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21980 register Lisp_Object tem
;
21982 if (EQ (propelt
, tem
))
21984 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21985 return NILP (XCDR (tem
)) ? 1 : 2;
21993 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21994 doc
: /* Non-nil if the property makes the text invisible.
21995 POS-OR-PROP can be a marker or number, in which case it is taken to be
21996 a position in the current buffer and the value of the `invisible' property
21997 is checked; or it can be some other value, which is then presumed to be the
21998 value of the `invisible' property of the text of interest.
21999 The non-nil value returned can be t for truly invisible text or something
22000 else if the text is replaced by an ellipsis. */)
22001 (Lisp_Object pos_or_prop
)
22004 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
22005 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
22007 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
22008 return (invis
== 0 ? Qnil
22010 : make_number (invis
));
22013 /* Calculate a width or height in pixels from a specification using
22014 the following elements:
22017 NUM - a (fractional) multiple of the default font width/height
22018 (NUM) - specifies exactly NUM pixels
22019 UNIT - a fixed number of pixels, see below.
22020 ELEMENT - size of a display element in pixels, see below.
22021 (NUM . SPEC) - equals NUM * SPEC
22022 (+ SPEC SPEC ...) - add pixel values
22023 (- SPEC SPEC ...) - subtract pixel values
22024 (- SPEC) - negate pixel value
22027 INT or FLOAT - a number constant
22028 SYMBOL - use symbol's (buffer local) variable binding.
22031 in - pixels per inch *)
22032 mm - pixels per 1/1000 meter *)
22033 cm - pixels per 1/100 meter *)
22034 width - width of current font in pixels.
22035 height - height of current font in pixels.
22037 *) using the ratio(s) defined in display-pixels-per-inch.
22041 left-fringe - left fringe width in pixels
22042 right-fringe - right fringe width in pixels
22044 left-margin - left margin width in pixels
22045 right-margin - right margin width in pixels
22047 scroll-bar - scroll-bar area width in pixels
22051 Pixels corresponding to 5 inches:
22054 Total width of non-text areas on left side of window (if scroll-bar is on left):
22055 '(space :width (+ left-fringe left-margin scroll-bar))
22057 Align to first text column (in header line):
22058 '(space :align-to 0)
22060 Align to middle of text area minus half the width of variable `my-image'
22061 containing a loaded image:
22062 '(space :align-to (0.5 . (- text my-image)))
22064 Width of left margin minus width of 1 character in the default font:
22065 '(space :width (- left-margin 1))
22067 Width of left margin minus width of 2 characters in the current font:
22068 '(space :width (- left-margin (2 . width)))
22070 Center 1 character over left-margin (in header line):
22071 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22073 Different ways to express width of left fringe plus left margin minus one pixel:
22074 '(space :width (- (+ left-fringe left-margin) (1)))
22075 '(space :width (+ left-fringe left-margin (- (1))))
22076 '(space :width (+ left-fringe left-margin (-1)))
22081 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22082 struct font
*font
, int width_p
, int *align_to
)
22086 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22087 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22090 return OK_PIXELS (0);
22092 eassert (FRAME_LIVE_P (it
->f
));
22094 if (SYMBOLP (prop
))
22096 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22098 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22100 if (unit
[0] == 'i' && unit
[1] == 'n')
22102 else if (unit
[0] == 'm' && unit
[1] == 'm')
22104 else if (unit
[0] == 'c' && unit
[1] == 'm')
22110 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
22111 : FRAME_RES_Y (it
->f
));
22114 return OK_PIXELS (ppi
/ pixels
);
22119 #ifdef HAVE_WINDOW_SYSTEM
22120 if (EQ (prop
, Qheight
))
22121 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22122 if (EQ (prop
, Qwidth
))
22123 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22125 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22126 return OK_PIXELS (1);
22129 if (EQ (prop
, Qtext
))
22130 return OK_PIXELS (width_p
22131 ? window_box_width (it
->w
, TEXT_AREA
)
22132 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22134 if (align_to
&& *align_to
< 0)
22137 if (EQ (prop
, Qleft
))
22138 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22139 if (EQ (prop
, Qright
))
22140 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22141 if (EQ (prop
, Qcenter
))
22142 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22143 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22144 if (EQ (prop
, Qleft_fringe
))
22145 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22146 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22147 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22148 if (EQ (prop
, Qright_fringe
))
22149 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22150 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22151 : window_box_right_offset (it
->w
, TEXT_AREA
));
22152 if (EQ (prop
, Qleft_margin
))
22153 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22154 if (EQ (prop
, Qright_margin
))
22155 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22156 if (EQ (prop
, Qscroll_bar
))
22157 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22159 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22160 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22161 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22166 if (EQ (prop
, Qleft_fringe
))
22167 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22168 if (EQ (prop
, Qright_fringe
))
22169 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22170 if (EQ (prop
, Qleft_margin
))
22171 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22172 if (EQ (prop
, Qright_margin
))
22173 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22174 if (EQ (prop
, Qscroll_bar
))
22175 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22178 prop
= buffer_local_value_1 (prop
, it
->w
->contents
);
22179 if (EQ (prop
, Qunbound
))
22183 if (INTEGERP (prop
) || FLOATP (prop
))
22185 int base_unit
= (width_p
22186 ? FRAME_COLUMN_WIDTH (it
->f
)
22187 : FRAME_LINE_HEIGHT (it
->f
));
22188 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22193 Lisp_Object car
= XCAR (prop
);
22194 Lisp_Object cdr
= XCDR (prop
);
22198 #ifdef HAVE_WINDOW_SYSTEM
22199 if (FRAME_WINDOW_P (it
->f
)
22200 && valid_image_p (prop
))
22202 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22203 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22205 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22208 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22214 while (CONSP (cdr
))
22216 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22217 font
, width_p
, align_to
))
22220 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22225 if (EQ (car
, Qminus
))
22227 return OK_PIXELS (pixels
);
22230 car
= buffer_local_value_1 (car
, it
->w
->contents
);
22231 if (EQ (car
, Qunbound
))
22235 if (INTEGERP (car
) || FLOATP (car
))
22238 pixels
= XFLOATINT (car
);
22240 return OK_PIXELS (pixels
);
22241 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22242 font
, width_p
, align_to
))
22243 return OK_PIXELS (pixels
* fact
);
22254 /***********************************************************************
22256 ***********************************************************************/
22258 #ifdef HAVE_WINDOW_SYSTEM
22263 dump_glyph_string (struct glyph_string
*s
)
22265 fprintf (stderr
, "glyph string\n");
22266 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22267 s
->x
, s
->y
, s
->width
, s
->height
);
22268 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22269 fprintf (stderr
, " hl = %d\n", s
->hl
);
22270 fprintf (stderr
, " left overhang = %d, right = %d\n",
22271 s
->left_overhang
, s
->right_overhang
);
22272 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22273 fprintf (stderr
, " extends to end of line = %d\n",
22274 s
->extends_to_end_of_line_p
);
22275 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22276 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22279 #endif /* GLYPH_DEBUG */
22281 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22282 of XChar2b structures for S; it can't be allocated in
22283 init_glyph_string because it must be allocated via `alloca'. W
22284 is the window on which S is drawn. ROW and AREA are the glyph row
22285 and area within the row from which S is constructed. START is the
22286 index of the first glyph structure covered by S. HL is a
22287 face-override for drawing S. */
22290 #define OPTIONAL_HDC(hdc) HDC hdc,
22291 #define DECLARE_HDC(hdc) HDC hdc;
22292 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22293 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22296 #ifndef OPTIONAL_HDC
22297 #define OPTIONAL_HDC(hdc)
22298 #define DECLARE_HDC(hdc)
22299 #define ALLOCATE_HDC(hdc, f)
22300 #define RELEASE_HDC(hdc, f)
22304 init_glyph_string (struct glyph_string
*s
,
22306 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22307 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22309 memset (s
, 0, sizeof *s
);
22311 s
->f
= XFRAME (w
->frame
);
22315 s
->display
= FRAME_X_DISPLAY (s
->f
);
22316 s
->window
= FRAME_X_WINDOW (s
->f
);
22317 s
->char2b
= char2b
;
22321 s
->first_glyph
= row
->glyphs
[area
] + start
;
22322 s
->height
= row
->height
;
22323 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22324 s
->ybase
= s
->y
+ row
->ascent
;
22328 /* Append the list of glyph strings with head H and tail T to the list
22329 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22332 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22333 struct glyph_string
*h
, struct glyph_string
*t
)
22347 /* Prepend the list of glyph strings with head H and tail T to the
22348 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22352 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22353 struct glyph_string
*h
, struct glyph_string
*t
)
22367 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22368 Set *HEAD and *TAIL to the resulting list. */
22371 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22372 struct glyph_string
*s
)
22374 s
->next
= s
->prev
= NULL
;
22375 append_glyph_string_lists (head
, tail
, s
, s
);
22379 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22380 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22381 make sure that X resources for the face returned are allocated.
22382 Value is a pointer to a realized face that is ready for display if
22383 DISPLAY_P is non-zero. */
22385 static struct face
*
22386 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22387 XChar2b
*char2b
, int display_p
)
22389 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22394 code
= face
->font
->driver
->encode_char (face
->font
, c
);
22396 if (code
== FONT_INVALID_CODE
)
22399 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22401 /* Make sure X resources of the face are allocated. */
22402 #ifdef HAVE_X_WINDOWS
22406 eassert (face
!= NULL
);
22407 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22414 /* Get face and two-byte form of character glyph GLYPH on frame F.
22415 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22416 a pointer to a realized face that is ready for display. */
22418 static struct face
*
22419 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22420 XChar2b
*char2b
, int *two_byte_p
)
22425 eassert (glyph
->type
== CHAR_GLYPH
);
22426 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22428 /* Make sure X resources of the face are allocated. */
22429 eassert (face
!= NULL
);
22430 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22437 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22438 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22440 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22442 if (code
== FONT_INVALID_CODE
)
22446 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22451 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22452 Return 1 if FONT has a glyph for C, otherwise return 0. */
22455 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22459 if (CHAR_BYTE8_P (c
))
22460 code
= CHAR_TO_BYTE8 (c
);
22462 code
= font
->driver
->encode_char (font
, c
);
22464 if (code
== FONT_INVALID_CODE
)
22466 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22471 /* Fill glyph string S with composition components specified by S->cmp.
22473 BASE_FACE is the base face of the composition.
22474 S->cmp_from is the index of the first component for S.
22476 OVERLAPS non-zero means S should draw the foreground only, and use
22477 its physical height for clipping. See also draw_glyphs.
22479 Value is the index of a component not in S. */
22482 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22486 /* For all glyphs of this composition, starting at the offset
22487 S->cmp_from, until we reach the end of the definition or encounter a
22488 glyph that requires the different face, add it to S. */
22493 s
->for_overlaps
= overlaps
;
22496 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22498 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22500 /* TAB in a composition means display glyphs with padding space
22501 on the left or right. */
22504 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22507 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22514 s
->font
= s
->face
->font
;
22516 else if (s
->face
!= face
)
22524 if (s
->face
== NULL
)
22526 s
->face
= base_face
->ascii_face
;
22527 s
->font
= s
->face
->font
;
22530 /* All glyph strings for the same composition has the same width,
22531 i.e. the width set for the first component of the composition. */
22532 s
->width
= s
->first_glyph
->pixel_width
;
22534 /* If the specified font could not be loaded, use the frame's
22535 default font, but record the fact that we couldn't load it in
22536 the glyph string so that we can draw rectangles for the
22537 characters of the glyph string. */
22538 if (s
->font
== NULL
)
22540 s
->font_not_found_p
= 1;
22541 s
->font
= FRAME_FONT (s
->f
);
22544 /* Adjust base line for subscript/superscript text. */
22545 s
->ybase
+= s
->first_glyph
->voffset
;
22547 /* This glyph string must always be drawn with 16-bit functions. */
22554 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22555 int start
, int end
, int overlaps
)
22557 struct glyph
*glyph
, *last
;
22558 Lisp_Object lgstring
;
22561 s
->for_overlaps
= overlaps
;
22562 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22563 last
= s
->row
->glyphs
[s
->area
] + end
;
22564 s
->cmp_id
= glyph
->u
.cmp
.id
;
22565 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22566 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22567 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22568 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22569 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22571 while (glyph
< last
22572 && glyph
->u
.cmp
.automatic
22573 && glyph
->u
.cmp
.id
== s
->cmp_id
22574 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22575 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22577 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22579 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22580 unsigned code
= LGLYPH_CODE (lglyph
);
22582 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22584 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22585 return glyph
- s
->row
->glyphs
[s
->area
];
22589 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22590 See the comment of fill_glyph_string for arguments.
22591 Value is the index of the first glyph not in S. */
22595 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22596 int start
, int end
, int overlaps
)
22598 struct glyph
*glyph
, *last
;
22601 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22602 s
->for_overlaps
= overlaps
;
22603 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22604 last
= s
->row
->glyphs
[s
->area
] + end
;
22605 voffset
= glyph
->voffset
;
22606 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22607 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
22609 s
->width
= glyph
->pixel_width
;
22611 while (glyph
< last
22612 && glyph
->type
== GLYPHLESS_GLYPH
22613 && glyph
->voffset
== voffset
22614 && glyph
->face_id
== face_id
)
22617 s
->width
+= glyph
->pixel_width
;
22620 s
->ybase
+= voffset
;
22621 return glyph
- s
->row
->glyphs
[s
->area
];
22625 /* Fill glyph string S from a sequence of character glyphs.
22627 FACE_ID is the face id of the string. START is the index of the
22628 first glyph to consider, END is the index of the last + 1.
22629 OVERLAPS non-zero means S should draw the foreground only, and use
22630 its physical height for clipping. See also draw_glyphs.
22632 Value is the index of the first glyph not in S. */
22635 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22636 int start
, int end
, int overlaps
)
22638 struct glyph
*glyph
, *last
;
22640 int glyph_not_available_p
;
22642 eassert (s
->f
== XFRAME (s
->w
->frame
));
22643 eassert (s
->nchars
== 0);
22644 eassert (start
>= 0 && end
> start
);
22646 s
->for_overlaps
= overlaps
;
22647 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22648 last
= s
->row
->glyphs
[s
->area
] + end
;
22649 voffset
= glyph
->voffset
;
22650 s
->padding_p
= glyph
->padding_p
;
22651 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22653 while (glyph
< last
22654 && glyph
->type
== CHAR_GLYPH
22655 && glyph
->voffset
== voffset
22656 /* Same face id implies same font, nowadays. */
22657 && glyph
->face_id
== face_id
22658 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22662 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22663 s
->char2b
+ s
->nchars
,
22665 s
->two_byte_p
= two_byte_p
;
22667 eassert (s
->nchars
<= end
- start
);
22668 s
->width
+= glyph
->pixel_width
;
22669 if (glyph
++->padding_p
!= s
->padding_p
)
22673 s
->font
= s
->face
->font
;
22675 /* If the specified font could not be loaded, use the frame's font,
22676 but record the fact that we couldn't load it in
22677 S->font_not_found_p so that we can draw rectangles for the
22678 characters of the glyph string. */
22679 if (s
->font
== NULL
|| glyph_not_available_p
)
22681 s
->font_not_found_p
= 1;
22682 s
->font
= FRAME_FONT (s
->f
);
22685 /* Adjust base line for subscript/superscript text. */
22686 s
->ybase
+= voffset
;
22688 eassert (s
->face
&& s
->face
->gc
);
22689 return glyph
- s
->row
->glyphs
[s
->area
];
22693 /* Fill glyph string S from image glyph S->first_glyph. */
22696 fill_image_glyph_string (struct glyph_string
*s
)
22698 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22699 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22701 s
->slice
= s
->first_glyph
->slice
.img
;
22702 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22703 s
->font
= s
->face
->font
;
22704 s
->width
= s
->first_glyph
->pixel_width
;
22706 /* Adjust base line for subscript/superscript text. */
22707 s
->ybase
+= s
->first_glyph
->voffset
;
22711 /* Fill glyph string S from a sequence of stretch glyphs.
22713 START is the index of the first glyph to consider,
22714 END is the index of the last + 1.
22716 Value is the index of the first glyph not in S. */
22719 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22721 struct glyph
*glyph
, *last
;
22722 int voffset
, face_id
;
22724 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22726 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22727 last
= s
->row
->glyphs
[s
->area
] + end
;
22728 face_id
= glyph
->face_id
;
22729 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22730 s
->font
= s
->face
->font
;
22731 s
->width
= glyph
->pixel_width
;
22733 voffset
= glyph
->voffset
;
22737 && glyph
->type
== STRETCH_GLYPH
22738 && glyph
->voffset
== voffset
22739 && glyph
->face_id
== face_id
);
22741 s
->width
+= glyph
->pixel_width
;
22743 /* Adjust base line for subscript/superscript text. */
22744 s
->ybase
+= voffset
;
22746 /* The case that face->gc == 0 is handled when drawing the glyph
22747 string by calling PREPARE_FACE_FOR_DISPLAY. */
22749 return glyph
- s
->row
->glyphs
[s
->area
];
22752 static struct font_metrics
*
22753 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22755 static struct font_metrics metrics
;
22760 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22761 if (code
== FONT_INVALID_CODE
)
22763 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22768 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22769 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22770 assumed to be zero. */
22773 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22775 *left
= *right
= 0;
22777 if (glyph
->type
== CHAR_GLYPH
)
22781 struct font_metrics
*pcm
;
22783 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22784 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22786 if (pcm
->rbearing
> pcm
->width
)
22787 *right
= pcm
->rbearing
- pcm
->width
;
22788 if (pcm
->lbearing
< 0)
22789 *left
= -pcm
->lbearing
;
22792 else if (glyph
->type
== COMPOSITE_GLYPH
)
22794 if (! glyph
->u
.cmp
.automatic
)
22796 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22798 if (cmp
->rbearing
> cmp
->pixel_width
)
22799 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22800 if (cmp
->lbearing
< 0)
22801 *left
= - cmp
->lbearing
;
22805 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22806 struct font_metrics metrics
;
22808 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22809 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22810 if (metrics
.rbearing
> metrics
.width
)
22811 *right
= metrics
.rbearing
- metrics
.width
;
22812 if (metrics
.lbearing
< 0)
22813 *left
= - metrics
.lbearing
;
22819 /* Return the index of the first glyph preceding glyph string S that
22820 is overwritten by S because of S's left overhang. Value is -1
22821 if no glyphs are overwritten. */
22824 left_overwritten (struct glyph_string
*s
)
22828 if (s
->left_overhang
)
22831 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22832 int first
= s
->first_glyph
- glyphs
;
22834 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22835 x
-= glyphs
[i
].pixel_width
;
22846 /* Return the index of the first glyph preceding glyph string S that
22847 is overwriting S because of its right overhang. Value is -1 if no
22848 glyph in front of S overwrites S. */
22851 left_overwriting (struct glyph_string
*s
)
22854 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22855 int first
= s
->first_glyph
- glyphs
;
22859 for (i
= first
- 1; i
>= 0; --i
)
22862 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22865 x
-= glyphs
[i
].pixel_width
;
22872 /* Return the index of the last glyph following glyph string S that is
22873 overwritten by S because of S's right overhang. Value is -1 if
22874 no such glyph is found. */
22877 right_overwritten (struct glyph_string
*s
)
22881 if (s
->right_overhang
)
22884 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22885 int first
= (s
->first_glyph
- glyphs
22886 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
22887 int end
= s
->row
->used
[s
->area
];
22889 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22890 x
+= glyphs
[i
].pixel_width
;
22899 /* Return the index of the last glyph following glyph string S that
22900 overwrites S because of its left overhang. Value is negative
22901 if no such glyph is found. */
22904 right_overwriting (struct glyph_string
*s
)
22907 int end
= s
->row
->used
[s
->area
];
22908 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22909 int first
= (s
->first_glyph
- glyphs
22910 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
22914 for (i
= first
; i
< end
; ++i
)
22917 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22920 x
+= glyphs
[i
].pixel_width
;
22927 /* Set background width of glyph string S. START is the index of the
22928 first glyph following S. LAST_X is the right-most x-position + 1
22929 in the drawing area. */
22932 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22934 /* If the face of this glyph string has to be drawn to the end of
22935 the drawing area, set S->extends_to_end_of_line_p. */
22937 if (start
== s
->row
->used
[s
->area
]
22938 && s
->area
== TEXT_AREA
22939 && ((s
->row
->fill_line_p
22940 && (s
->hl
== DRAW_NORMAL_TEXT
22941 || s
->hl
== DRAW_IMAGE_RAISED
22942 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22943 || s
->hl
== DRAW_MOUSE_FACE
))
22944 s
->extends_to_end_of_line_p
= 1;
22946 /* If S extends its face to the end of the line, set its
22947 background_width to the distance to the right edge of the drawing
22949 if (s
->extends_to_end_of_line_p
)
22950 s
->background_width
= last_x
- s
->x
+ 1;
22952 s
->background_width
= s
->width
;
22956 /* Compute overhangs and x-positions for glyph string S and its
22957 predecessors, or successors. X is the starting x-position for S.
22958 BACKWARD_P non-zero means process predecessors. */
22961 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22967 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22968 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22978 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22979 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22989 /* The following macros are only called from draw_glyphs below.
22990 They reference the following parameters of that function directly:
22991 `w', `row', `area', and `overlap_p'
22992 as well as the following local variables:
22993 `s', `f', and `hdc' (in W32) */
22996 /* On W32, silently add local `hdc' variable to argument list of
22997 init_glyph_string. */
22998 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22999 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23001 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23002 init_glyph_string (s, char2b, w, row, area, start, hl)
23005 /* Add a glyph string for a stretch glyph to the list of strings
23006 between HEAD and TAIL. START is the index of the stretch glyph in
23007 row area AREA of glyph row ROW. END is the index of the last glyph
23008 in that glyph row area. X is the current output position assigned
23009 to the new glyph string constructed. HL overrides that face of the
23010 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23011 is the right-most x-position of the drawing area. */
23013 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23014 and below -- keep them on one line. */
23015 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23018 s = alloca (sizeof *s); \
23019 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23020 START = fill_stretch_glyph_string (s, START, END); \
23021 append_glyph_string (&HEAD, &TAIL, s); \
23027 /* Add a glyph string for an image glyph to the list of strings
23028 between HEAD and TAIL. START is the index of the image glyph in
23029 row area AREA of glyph row ROW. END is the index of the last glyph
23030 in that glyph row area. X is the current output position assigned
23031 to the new glyph string constructed. HL overrides that face of the
23032 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23033 is the right-most x-position of the drawing area. */
23035 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23038 s = alloca (sizeof *s); \
23039 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23040 fill_image_glyph_string (s); \
23041 append_glyph_string (&HEAD, &TAIL, s); \
23048 /* Add a glyph string for a sequence of character glyphs to the list
23049 of strings between HEAD and TAIL. START is the index of the first
23050 glyph in row area AREA of glyph row ROW that is part of the new
23051 glyph string. END is the index of the last glyph in that glyph row
23052 area. X is the current output position assigned to the new glyph
23053 string constructed. HL overrides that face of the glyph; e.g. it
23054 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23055 right-most x-position of the drawing area. */
23057 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23063 face_id = (row)->glyphs[area][START].face_id; \
23065 s = alloca (sizeof *s); \
23066 char2b = alloca ((END - START) * sizeof *char2b); \
23067 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23068 append_glyph_string (&HEAD, &TAIL, s); \
23070 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23075 /* Add a glyph string for a composite sequence to the list of strings
23076 between HEAD and TAIL. START is the index of the first glyph in
23077 row area AREA of glyph row ROW that is part of the new glyph
23078 string. END is the index of the last glyph in that glyph row area.
23079 X is the current output position assigned to the new glyph string
23080 constructed. HL overrides that face of the glyph; e.g. it is
23081 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23082 x-position of the drawing area. */
23084 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23086 int face_id = (row)->glyphs[area][START].face_id; \
23087 struct face *base_face = FACE_FROM_ID (f, face_id); \
23088 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23089 struct composition *cmp = composition_table[cmp_id]; \
23091 struct glyph_string *first_s = NULL; \
23094 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23096 /* Make glyph_strings for each glyph sequence that is drawable by \
23097 the same face, and append them to HEAD/TAIL. */ \
23098 for (n = 0; n < cmp->glyph_len;) \
23100 s = alloca (sizeof *s); \
23101 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23102 append_glyph_string (&(HEAD), &(TAIL), s); \
23108 n = fill_composite_glyph_string (s, base_face, overlaps); \
23116 /* Add a glyph string for a glyph-string sequence to the list of strings
23117 between HEAD and TAIL. */
23119 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23123 Lisp_Object gstring; \
23125 face_id = (row)->glyphs[area][START].face_id; \
23126 gstring = (composition_gstring_from_id \
23127 ((row)->glyphs[area][START].u.cmp.id)); \
23128 s = alloca (sizeof *s); \
23129 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23130 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23131 append_glyph_string (&(HEAD), &(TAIL), s); \
23133 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23137 /* Add a glyph string for a sequence of glyphless character's glyphs
23138 to the list of strings between HEAD and TAIL. The meanings of
23139 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23141 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23146 face_id = (row)->glyphs[area][START].face_id; \
23148 s = alloca (sizeof *s); \
23149 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23150 append_glyph_string (&HEAD, &TAIL, s); \
23152 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23158 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23159 of AREA of glyph row ROW on window W between indices START and END.
23160 HL overrides the face for drawing glyph strings, e.g. it is
23161 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23162 x-positions of the drawing area.
23164 This is an ugly monster macro construct because we must use alloca
23165 to allocate glyph strings (because draw_glyphs can be called
23166 asynchronously). */
23168 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23171 HEAD = TAIL = NULL; \
23172 while (START < END) \
23174 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23175 switch (first_glyph->type) \
23178 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23182 case COMPOSITE_GLYPH: \
23183 if (first_glyph->u.cmp.automatic) \
23184 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23187 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23191 case STRETCH_GLYPH: \
23192 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23196 case IMAGE_GLYPH: \
23197 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23201 case GLYPHLESS_GLYPH: \
23202 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23212 set_glyph_string_background_width (s, START, LAST_X); \
23219 /* Draw glyphs between START and END in AREA of ROW on window W,
23220 starting at x-position X. X is relative to AREA in W. HL is a
23221 face-override with the following meaning:
23223 DRAW_NORMAL_TEXT draw normally
23224 DRAW_CURSOR draw in cursor face
23225 DRAW_MOUSE_FACE draw in mouse face.
23226 DRAW_INVERSE_VIDEO draw in mode line face
23227 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23228 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23230 If OVERLAPS is non-zero, draw only the foreground of characters and
23231 clip to the physical height of ROW. Non-zero value also defines
23232 the overlapping part to be drawn:
23234 OVERLAPS_PRED overlap with preceding rows
23235 OVERLAPS_SUCC overlap with succeeding rows
23236 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23237 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23239 Value is the x-position reached, relative to AREA of W. */
23242 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23243 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23244 enum draw_glyphs_face hl
, int overlaps
)
23246 struct glyph_string
*head
, *tail
;
23247 struct glyph_string
*s
;
23248 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23249 int i
, j
, x_reached
, last_x
, area_left
= 0;
23250 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23253 ALLOCATE_HDC (hdc
, f
);
23255 /* Let's rather be paranoid than getting a SEGV. */
23256 end
= min (end
, row
->used
[area
]);
23257 start
= clip_to_bounds (0, start
, end
);
23259 /* Translate X to frame coordinates. Set last_x to the right
23260 end of the drawing area. */
23261 if (row
->full_width_p
)
23263 /* X is relative to the left edge of W, without scroll bars
23265 area_left
= WINDOW_LEFT_EDGE_X (w
);
23266 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23270 area_left
= window_box_left (w
, area
);
23271 last_x
= area_left
+ window_box_width (w
, area
);
23275 /* Build a doubly-linked list of glyph_string structures between
23276 head and tail from what we have to draw. Note that the macro
23277 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23278 the reason we use a separate variable `i'. */
23280 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23282 x_reached
= tail
->x
+ tail
->background_width
;
23286 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23287 the row, redraw some glyphs in front or following the glyph
23288 strings built above. */
23289 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23291 struct glyph_string
*h
, *t
;
23292 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23293 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23294 int check_mouse_face
= 0;
23297 /* If mouse highlighting is on, we may need to draw adjacent
23298 glyphs using mouse-face highlighting. */
23299 if (area
== TEXT_AREA
&& row
->mouse_face_p
23300 && hlinfo
->mouse_face_beg_row
>= 0
23301 && hlinfo
->mouse_face_end_row
>= 0)
23303 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23305 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23306 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23308 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23310 check_mouse_face
= 1;
23311 mouse_beg_col
= (row
== mouse_beg_row
)
23312 ? hlinfo
->mouse_face_beg_col
: 0;
23313 mouse_end_col
= (row
== mouse_end_row
)
23314 ? hlinfo
->mouse_face_end_col
23315 : row
->used
[TEXT_AREA
];
23319 /* Compute overhangs for all glyph strings. */
23320 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23321 for (s
= head
; s
; s
= s
->next
)
23322 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23324 /* Prepend glyph strings for glyphs in front of the first glyph
23325 string that are overwritten because of the first glyph
23326 string's left overhang. The background of all strings
23327 prepended must be drawn because the first glyph string
23329 i
= left_overwritten (head
);
23332 enum draw_glyphs_face overlap_hl
;
23334 /* If this row contains mouse highlighting, attempt to draw
23335 the overlapped glyphs with the correct highlight. This
23336 code fails if the overlap encompasses more than one glyph
23337 and mouse-highlight spans only some of these glyphs.
23338 However, making it work perfectly involves a lot more
23339 code, and I don't know if the pathological case occurs in
23340 practice, so we'll stick to this for now. --- cyd */
23341 if (check_mouse_face
23342 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23343 overlap_hl
= DRAW_MOUSE_FACE
;
23345 overlap_hl
= DRAW_NORMAL_TEXT
;
23348 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23349 overlap_hl
, dummy_x
, last_x
);
23351 compute_overhangs_and_x (t
, head
->x
, 1);
23352 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23356 /* Prepend glyph strings for glyphs in front of the first glyph
23357 string that overwrite that glyph string because of their
23358 right overhang. For these strings, only the foreground must
23359 be drawn, because it draws over the glyph string at `head'.
23360 The background must not be drawn because this would overwrite
23361 right overhangs of preceding glyphs for which no glyph
23363 i
= left_overwriting (head
);
23366 enum draw_glyphs_face overlap_hl
;
23368 if (check_mouse_face
23369 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23370 overlap_hl
= DRAW_MOUSE_FACE
;
23372 overlap_hl
= DRAW_NORMAL_TEXT
;
23375 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23376 overlap_hl
, dummy_x
, last_x
);
23377 for (s
= h
; s
; s
= s
->next
)
23378 s
->background_filled_p
= 1;
23379 compute_overhangs_and_x (t
, head
->x
, 1);
23380 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23383 /* Append glyphs strings for glyphs following the last glyph
23384 string tail that are overwritten by tail. The background of
23385 these strings has to be drawn because tail's foreground draws
23387 i
= right_overwritten (tail
);
23390 enum draw_glyphs_face overlap_hl
;
23392 if (check_mouse_face
23393 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23394 overlap_hl
= DRAW_MOUSE_FACE
;
23396 overlap_hl
= DRAW_NORMAL_TEXT
;
23398 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23399 overlap_hl
, x
, last_x
);
23400 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23401 we don't have `end = i;' here. */
23402 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23403 append_glyph_string_lists (&head
, &tail
, h
, t
);
23407 /* Append glyph strings for glyphs following the last glyph
23408 string tail that overwrite tail. The foreground of such
23409 glyphs has to be drawn because it writes into the background
23410 of tail. The background must not be drawn because it could
23411 paint over the foreground of following glyphs. */
23412 i
= right_overwriting (tail
);
23415 enum draw_glyphs_face overlap_hl
;
23416 if (check_mouse_face
23417 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23418 overlap_hl
= DRAW_MOUSE_FACE
;
23420 overlap_hl
= DRAW_NORMAL_TEXT
;
23423 i
++; /* We must include the Ith glyph. */
23424 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23425 overlap_hl
, x
, last_x
);
23426 for (s
= h
; s
; s
= s
->next
)
23427 s
->background_filled_p
= 1;
23428 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23429 append_glyph_string_lists (&head
, &tail
, h
, t
);
23431 if (clip_head
|| clip_tail
)
23432 for (s
= head
; s
; s
= s
->next
)
23434 s
->clip_head
= clip_head
;
23435 s
->clip_tail
= clip_tail
;
23439 /* Draw all strings. */
23440 for (s
= head
; s
; s
= s
->next
)
23441 FRAME_RIF (f
)->draw_glyph_string (s
);
23444 /* When focus a sole frame and move horizontally, this sets on_p to 0
23445 causing a failure to erase prev cursor position. */
23446 if (area
== TEXT_AREA
23447 && !row
->full_width_p
23448 /* When drawing overlapping rows, only the glyph strings'
23449 foreground is drawn, which doesn't erase a cursor
23453 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23454 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23455 : (tail
? tail
->x
+ tail
->background_width
: x
));
23459 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23460 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23464 /* Value is the x-position up to which drawn, relative to AREA of W.
23465 This doesn't include parts drawn because of overhangs. */
23466 if (row
->full_width_p
)
23467 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23469 x_reached
-= area_left
;
23471 RELEASE_HDC (hdc
, f
);
23476 /* Expand row matrix if too narrow. Don't expand if area
23479 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23481 if (!fonts_changed_p \
23482 && (it->glyph_row->glyphs[area] \
23483 < it->glyph_row->glyphs[area + 1])) \
23485 it->w->ncols_scale_factor++; \
23486 fonts_changed_p = 1; \
23490 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23491 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23494 append_glyph (struct it
*it
)
23496 struct glyph
*glyph
;
23497 enum glyph_row_area area
= it
->area
;
23499 eassert (it
->glyph_row
);
23500 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23502 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23503 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23505 /* If the glyph row is reversed, we need to prepend the glyph
23506 rather than append it. */
23507 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23511 /* Make room for the additional glyph. */
23512 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23514 glyph
= it
->glyph_row
->glyphs
[area
];
23516 glyph
->charpos
= CHARPOS (it
->position
);
23517 glyph
->object
= it
->object
;
23518 if (it
->pixel_width
> 0)
23520 glyph
->pixel_width
= it
->pixel_width
;
23521 glyph
->padding_p
= 0;
23525 /* Assure at least 1-pixel width. Otherwise, cursor can't
23526 be displayed correctly. */
23527 glyph
->pixel_width
= 1;
23528 glyph
->padding_p
= 1;
23530 glyph
->ascent
= it
->ascent
;
23531 glyph
->descent
= it
->descent
;
23532 glyph
->voffset
= it
->voffset
;
23533 glyph
->type
= CHAR_GLYPH
;
23534 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23535 glyph
->multibyte_p
= it
->multibyte_p
;
23536 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23538 /* In R2L rows, the left and the right box edges need to be
23539 drawn in reverse direction. */
23540 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23541 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23545 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23546 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23548 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23549 || it
->phys_descent
> it
->descent
);
23550 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23551 glyph
->face_id
= it
->face_id
;
23552 glyph
->u
.ch
= it
->char_to_display
;
23553 glyph
->slice
.img
= null_glyph_slice
;
23554 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23557 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23558 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23560 glyph
->bidi_type
= it
->bidi_it
.type
;
23564 glyph
->resolved_level
= 0;
23565 glyph
->bidi_type
= UNKNOWN_BT
;
23567 ++it
->glyph_row
->used
[area
];
23570 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23573 /* Store one glyph for the composition IT->cmp_it.id in
23574 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23578 append_composite_glyph (struct it
*it
)
23580 struct glyph
*glyph
;
23581 enum glyph_row_area area
= it
->area
;
23583 eassert (it
->glyph_row
);
23585 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23586 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23588 /* If the glyph row is reversed, we need to prepend the glyph
23589 rather than append it. */
23590 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23594 /* Make room for the new glyph. */
23595 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23597 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23599 glyph
->charpos
= it
->cmp_it
.charpos
;
23600 glyph
->object
= it
->object
;
23601 glyph
->pixel_width
= it
->pixel_width
;
23602 glyph
->ascent
= it
->ascent
;
23603 glyph
->descent
= it
->descent
;
23604 glyph
->voffset
= it
->voffset
;
23605 glyph
->type
= COMPOSITE_GLYPH
;
23606 if (it
->cmp_it
.ch
< 0)
23608 glyph
->u
.cmp
.automatic
= 0;
23609 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23610 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23614 glyph
->u
.cmp
.automatic
= 1;
23615 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23616 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23617 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23619 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23620 glyph
->multibyte_p
= it
->multibyte_p
;
23621 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23623 /* In R2L rows, the left and the right box edges need to be
23624 drawn in reverse direction. */
23625 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23626 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23630 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23631 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23633 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23634 || it
->phys_descent
> it
->descent
);
23635 glyph
->padding_p
= 0;
23636 glyph
->glyph_not_available_p
= 0;
23637 glyph
->face_id
= it
->face_id
;
23638 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23641 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23642 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23644 glyph
->bidi_type
= it
->bidi_it
.type
;
23646 ++it
->glyph_row
->used
[area
];
23649 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23653 /* Change IT->ascent and IT->height according to the setting of
23657 take_vertical_position_into_account (struct it
*it
)
23661 if (it
->voffset
< 0)
23662 /* Increase the ascent so that we can display the text higher
23664 it
->ascent
-= it
->voffset
;
23666 /* Increase the descent so that we can display the text lower
23668 it
->descent
+= it
->voffset
;
23673 /* Produce glyphs/get display metrics for the image IT is loaded with.
23674 See the description of struct display_iterator in dispextern.h for
23675 an overview of struct display_iterator. */
23678 produce_image_glyph (struct it
*it
)
23682 int glyph_ascent
, crop
;
23683 struct glyph_slice slice
;
23685 eassert (it
->what
== IT_IMAGE
);
23687 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23689 /* Make sure X resources of the face is loaded. */
23690 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23692 if (it
->image_id
< 0)
23694 /* Fringe bitmap. */
23695 it
->ascent
= it
->phys_ascent
= 0;
23696 it
->descent
= it
->phys_descent
= 0;
23697 it
->pixel_width
= 0;
23702 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23704 /* Make sure X resources of the image is loaded. */
23705 prepare_image_for_display (it
->f
, img
);
23707 slice
.x
= slice
.y
= 0;
23708 slice
.width
= img
->width
;
23709 slice
.height
= img
->height
;
23711 if (INTEGERP (it
->slice
.x
))
23712 slice
.x
= XINT (it
->slice
.x
);
23713 else if (FLOATP (it
->slice
.x
))
23714 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23716 if (INTEGERP (it
->slice
.y
))
23717 slice
.y
= XINT (it
->slice
.y
);
23718 else if (FLOATP (it
->slice
.y
))
23719 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23721 if (INTEGERP (it
->slice
.width
))
23722 slice
.width
= XINT (it
->slice
.width
);
23723 else if (FLOATP (it
->slice
.width
))
23724 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23726 if (INTEGERP (it
->slice
.height
))
23727 slice
.height
= XINT (it
->slice
.height
);
23728 else if (FLOATP (it
->slice
.height
))
23729 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23731 if (slice
.x
>= img
->width
)
23732 slice
.x
= img
->width
;
23733 if (slice
.y
>= img
->height
)
23734 slice
.y
= img
->height
;
23735 if (slice
.x
+ slice
.width
>= img
->width
)
23736 slice
.width
= img
->width
- slice
.x
;
23737 if (slice
.y
+ slice
.height
> img
->height
)
23738 slice
.height
= img
->height
- slice
.y
;
23740 if (slice
.width
== 0 || slice
.height
== 0)
23743 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23745 it
->descent
= slice
.height
- glyph_ascent
;
23747 it
->descent
+= img
->vmargin
;
23748 if (slice
.y
+ slice
.height
== img
->height
)
23749 it
->descent
+= img
->vmargin
;
23750 it
->phys_descent
= it
->descent
;
23752 it
->pixel_width
= slice
.width
;
23754 it
->pixel_width
+= img
->hmargin
;
23755 if (slice
.x
+ slice
.width
== img
->width
)
23756 it
->pixel_width
+= img
->hmargin
;
23758 /* It's quite possible for images to have an ascent greater than
23759 their height, so don't get confused in that case. */
23760 if (it
->descent
< 0)
23765 if (face
->box
!= FACE_NO_BOX
)
23767 if (face
->box_line_width
> 0)
23770 it
->ascent
+= face
->box_line_width
;
23771 if (slice
.y
+ slice
.height
== img
->height
)
23772 it
->descent
+= face
->box_line_width
;
23775 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23776 it
->pixel_width
+= eabs (face
->box_line_width
);
23777 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23778 it
->pixel_width
+= eabs (face
->box_line_width
);
23781 take_vertical_position_into_account (it
);
23783 /* Automatically crop wide image glyphs at right edge so we can
23784 draw the cursor on same display row. */
23785 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23786 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23788 it
->pixel_width
-= crop
;
23789 slice
.width
-= crop
;
23794 struct glyph
*glyph
;
23795 enum glyph_row_area area
= it
->area
;
23797 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23798 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23800 glyph
->charpos
= CHARPOS (it
->position
);
23801 glyph
->object
= it
->object
;
23802 glyph
->pixel_width
= it
->pixel_width
;
23803 glyph
->ascent
= glyph_ascent
;
23804 glyph
->descent
= it
->descent
;
23805 glyph
->voffset
= it
->voffset
;
23806 glyph
->type
= IMAGE_GLYPH
;
23807 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23808 glyph
->multibyte_p
= it
->multibyte_p
;
23809 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23811 /* In R2L rows, the left and the right box edges need to be
23812 drawn in reverse direction. */
23813 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23814 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23818 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23819 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23821 glyph
->overlaps_vertically_p
= 0;
23822 glyph
->padding_p
= 0;
23823 glyph
->glyph_not_available_p
= 0;
23824 glyph
->face_id
= it
->face_id
;
23825 glyph
->u
.img_id
= img
->id
;
23826 glyph
->slice
.img
= slice
;
23827 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23830 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23831 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23833 glyph
->bidi_type
= it
->bidi_it
.type
;
23835 ++it
->glyph_row
->used
[area
];
23838 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23843 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23844 of the glyph, WIDTH and HEIGHT are the width and height of the
23845 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23848 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23849 int width
, int height
, int ascent
)
23851 struct glyph
*glyph
;
23852 enum glyph_row_area area
= it
->area
;
23854 eassert (ascent
>= 0 && ascent
<= height
);
23856 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23857 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23859 /* If the glyph row is reversed, we need to prepend the glyph
23860 rather than append it. */
23861 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23865 /* Make room for the additional glyph. */
23866 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23868 glyph
= it
->glyph_row
->glyphs
[area
];
23870 glyph
->charpos
= CHARPOS (it
->position
);
23871 glyph
->object
= object
;
23872 glyph
->pixel_width
= width
;
23873 glyph
->ascent
= ascent
;
23874 glyph
->descent
= height
- ascent
;
23875 glyph
->voffset
= it
->voffset
;
23876 glyph
->type
= STRETCH_GLYPH
;
23877 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23878 glyph
->multibyte_p
= it
->multibyte_p
;
23879 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23881 /* In R2L rows, the left and the right box edges need to be
23882 drawn in reverse direction. */
23883 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23884 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23888 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23889 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23891 glyph
->overlaps_vertically_p
= 0;
23892 glyph
->padding_p
= 0;
23893 glyph
->glyph_not_available_p
= 0;
23894 glyph
->face_id
= it
->face_id
;
23895 glyph
->u
.stretch
.ascent
= ascent
;
23896 glyph
->u
.stretch
.height
= height
;
23897 glyph
->slice
.img
= null_glyph_slice
;
23898 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23901 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23902 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23904 glyph
->bidi_type
= it
->bidi_it
.type
;
23908 glyph
->resolved_level
= 0;
23909 glyph
->bidi_type
= UNKNOWN_BT
;
23911 ++it
->glyph_row
->used
[area
];
23914 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23917 #endif /* HAVE_WINDOW_SYSTEM */
23919 /* Produce a stretch glyph for iterator IT. IT->object is the value
23920 of the glyph property displayed. The value must be a list
23921 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23924 1. `:width WIDTH' specifies that the space should be WIDTH *
23925 canonical char width wide. WIDTH may be an integer or floating
23928 2. `:relative-width FACTOR' specifies that the width of the stretch
23929 should be computed from the width of the first character having the
23930 `glyph' property, and should be FACTOR times that width.
23932 3. `:align-to HPOS' specifies that the space should be wide enough
23933 to reach HPOS, a value in canonical character units.
23935 Exactly one of the above pairs must be present.
23937 4. `:height HEIGHT' specifies that the height of the stretch produced
23938 should be HEIGHT, measured in canonical character units.
23940 5. `:relative-height FACTOR' specifies that the height of the
23941 stretch should be FACTOR times the height of the characters having
23942 the glyph property.
23944 Either none or exactly one of 4 or 5 must be present.
23946 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23947 of the stretch should be used for the ascent of the stretch.
23948 ASCENT must be in the range 0 <= ASCENT <= 100. */
23951 produce_stretch_glyph (struct it
*it
)
23953 /* (space :width WIDTH :height HEIGHT ...) */
23954 Lisp_Object prop
, plist
;
23955 int width
= 0, height
= 0, align_to
= -1;
23956 int zero_width_ok_p
= 0;
23958 struct font
*font
= NULL
;
23960 #ifdef HAVE_WINDOW_SYSTEM
23962 int zero_height_ok_p
= 0;
23964 if (FRAME_WINDOW_P (it
->f
))
23966 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23967 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23968 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23972 /* List should start with `space'. */
23973 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23974 plist
= XCDR (it
->object
);
23976 /* Compute the width of the stretch. */
23977 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23978 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23980 /* Absolute width `:width WIDTH' specified and valid. */
23981 zero_width_ok_p
= 1;
23984 #ifdef HAVE_WINDOW_SYSTEM
23985 else if (FRAME_WINDOW_P (it
->f
)
23986 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23988 /* Relative width `:relative-width FACTOR' specified and valid.
23989 Compute the width of the characters having the `glyph'
23992 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23995 if (it
->multibyte_p
)
23996 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23999 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
24000 if (! ASCII_CHAR_P (it2
.c
))
24001 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
24004 it2
.glyph_row
= NULL
;
24005 it2
.what
= IT_CHARACTER
;
24006 x_produce_glyphs (&it2
);
24007 width
= NUMVAL (prop
) * it2
.pixel_width
;
24009 #endif /* HAVE_WINDOW_SYSTEM */
24010 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
24011 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
24013 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
24014 align_to
= (align_to
< 0
24016 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
24017 else if (align_to
< 0)
24018 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
24019 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
24020 zero_width_ok_p
= 1;
24023 /* Nothing specified -> width defaults to canonical char width. */
24024 width
= FRAME_COLUMN_WIDTH (it
->f
);
24026 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
24029 #ifdef HAVE_WINDOW_SYSTEM
24030 /* Compute height. */
24031 if (FRAME_WINDOW_P (it
->f
))
24033 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
24034 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24037 zero_height_ok_p
= 1;
24039 else if (prop
= Fplist_get (plist
, QCrelative_height
),
24041 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
24043 height
= FONT_HEIGHT (font
);
24045 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
24048 /* Compute percentage of height used for ascent. If
24049 `:ascent ASCENT' is present and valid, use that. Otherwise,
24050 derive the ascent from the font in use. */
24051 if (prop
= Fplist_get (plist
, QCascent
),
24052 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
24053 ascent
= height
* NUMVAL (prop
) / 100.0;
24054 else if (!NILP (prop
)
24055 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24056 ascent
= min (max (0, (int)tem
), height
);
24058 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
24061 #endif /* HAVE_WINDOW_SYSTEM */
24064 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24065 && it
->current_x
+ width
> it
->last_visible_x
)
24067 width
= it
->last_visible_x
- it
->current_x
;
24068 #ifdef HAVE_WINDOW_SYSTEM
24069 /* Subtract one more pixel from the stretch width, but only on
24070 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24071 width
-= FRAME_WINDOW_P (it
->f
);
24075 if (width
> 0 && height
> 0 && it
->glyph_row
)
24077 Lisp_Object o_object
= it
->object
;
24078 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24081 if (!STRINGP (object
))
24082 object
= it
->w
->contents
;
24083 #ifdef HAVE_WINDOW_SYSTEM
24084 if (FRAME_WINDOW_P (it
->f
))
24085 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24089 it
->object
= object
;
24090 it
->char_to_display
= ' ';
24091 it
->pixel_width
= it
->len
= 1;
24093 tty_append_glyph (it
);
24094 it
->object
= o_object
;
24098 it
->pixel_width
= width
;
24099 #ifdef HAVE_WINDOW_SYSTEM
24100 if (FRAME_WINDOW_P (it
->f
))
24102 it
->ascent
= it
->phys_ascent
= ascent
;
24103 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24104 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24105 take_vertical_position_into_account (it
);
24109 it
->nglyphs
= width
;
24112 /* Get information about special display element WHAT in an
24113 environment described by IT. WHAT is one of IT_TRUNCATION or
24114 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24115 non-null glyph_row member. This function ensures that fields like
24116 face_id, c, len of IT are left untouched. */
24119 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
24126 temp_it
.object
= make_number (0);
24127 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
24129 if (what
== IT_CONTINUATION
)
24131 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24132 if (it
->bidi_it
.paragraph_dir
== R2L
)
24133 SET_GLYPH_FROM_CHAR (glyph
, '/');
24135 SET_GLYPH_FROM_CHAR (glyph
, '\\');
24137 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24139 /* FIXME: Should we mirror GC for R2L lines? */
24140 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24141 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24144 else if (what
== IT_TRUNCATION
)
24146 /* Truncation glyph. */
24147 SET_GLYPH_FROM_CHAR (glyph
, '$');
24149 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24151 /* FIXME: Should we mirror GC for R2L lines? */
24152 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24153 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24159 #ifdef HAVE_WINDOW_SYSTEM
24160 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24161 is turned off, we precede the truncation/continuation glyphs by a
24162 stretch glyph whose width is computed such that these special
24163 glyphs are aligned at the window margin, even when very different
24164 fonts are used in different glyph rows. */
24165 if (FRAME_WINDOW_P (temp_it
.f
)
24166 /* init_iterator calls this with it->glyph_row == NULL, and it
24167 wants only the pixel width of the truncation/continuation
24169 && temp_it
.glyph_row
24170 /* insert_left_trunc_glyphs calls us at the beginning of the
24171 row, and it has its own calculation of the stretch glyph
24173 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
24174 && (temp_it
.glyph_row
->reversed_p
24175 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
24176 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
24178 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
24180 if (stretch_width
> 0)
24182 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
24183 struct font
*font
=
24184 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
24185 int stretch_ascent
=
24186 (((temp_it
.ascent
+ temp_it
.descent
)
24187 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
24189 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
24190 temp_it
.ascent
+ temp_it
.descent
,
24197 temp_it
.what
= IT_CHARACTER
;
24199 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
24200 temp_it
.face_id
= GLYPH_FACE (glyph
);
24201 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
24203 PRODUCE_GLYPHS (&temp_it
);
24204 it
->pixel_width
= temp_it
.pixel_width
;
24205 it
->nglyphs
= temp_it
.pixel_width
;
24208 #ifdef HAVE_WINDOW_SYSTEM
24210 /* Calculate line-height and line-spacing properties.
24211 An integer value specifies explicit pixel value.
24212 A float value specifies relative value to current face height.
24213 A cons (float . face-name) specifies relative value to
24214 height of specified face font.
24216 Returns height in pixels, or nil. */
24220 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24221 int boff
, int override
)
24223 Lisp_Object face_name
= Qnil
;
24224 int ascent
, descent
, height
;
24226 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24231 face_name
= XCAR (val
);
24233 if (!NUMBERP (val
))
24234 val
= make_number (1);
24235 if (NILP (face_name
))
24237 height
= it
->ascent
+ it
->descent
;
24242 if (NILP (face_name
))
24244 font
= FRAME_FONT (it
->f
);
24245 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24247 else if (EQ (face_name
, Qt
))
24256 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24258 return make_number (-1);
24260 face
= FACE_FROM_ID (it
->f
, face_id
);
24263 return make_number (-1);
24264 boff
= font
->baseline_offset
;
24265 if (font
->vertical_centering
)
24266 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24269 ascent
= FONT_BASE (font
) + boff
;
24270 descent
= FONT_DESCENT (font
) - boff
;
24274 it
->override_ascent
= ascent
;
24275 it
->override_descent
= descent
;
24276 it
->override_boff
= boff
;
24279 height
= ascent
+ descent
;
24283 height
= (int)(XFLOAT_DATA (val
) * height
);
24284 else if (INTEGERP (val
))
24285 height
*= XINT (val
);
24287 return make_number (height
);
24291 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24292 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24293 and only if this is for a character for which no font was found.
24295 If the display method (it->glyphless_method) is
24296 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24297 length of the acronym or the hexadecimal string, UPPER_XOFF and
24298 UPPER_YOFF are pixel offsets for the upper part of the string,
24299 LOWER_XOFF and LOWER_YOFF are for the lower part.
24301 For the other display methods, LEN through LOWER_YOFF are zero. */
24304 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24305 short upper_xoff
, short upper_yoff
,
24306 short lower_xoff
, short lower_yoff
)
24308 struct glyph
*glyph
;
24309 enum glyph_row_area area
= it
->area
;
24311 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24312 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24314 /* If the glyph row is reversed, we need to prepend the glyph
24315 rather than append it. */
24316 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24320 /* Make room for the additional glyph. */
24321 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24323 glyph
= it
->glyph_row
->glyphs
[area
];
24325 glyph
->charpos
= CHARPOS (it
->position
);
24326 glyph
->object
= it
->object
;
24327 glyph
->pixel_width
= it
->pixel_width
;
24328 glyph
->ascent
= it
->ascent
;
24329 glyph
->descent
= it
->descent
;
24330 glyph
->voffset
= it
->voffset
;
24331 glyph
->type
= GLYPHLESS_GLYPH
;
24332 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24333 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24334 glyph
->u
.glyphless
.len
= len
;
24335 glyph
->u
.glyphless
.ch
= it
->c
;
24336 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24337 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24338 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24339 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24340 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24341 glyph
->multibyte_p
= it
->multibyte_p
;
24342 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24344 /* In R2L rows, the left and the right box edges need to be
24345 drawn in reverse direction. */
24346 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24347 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24351 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24352 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24354 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24355 || it
->phys_descent
> it
->descent
);
24356 glyph
->padding_p
= 0;
24357 glyph
->glyph_not_available_p
= 0;
24358 glyph
->face_id
= face_id
;
24359 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24362 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24363 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24365 glyph
->bidi_type
= it
->bidi_it
.type
;
24367 ++it
->glyph_row
->used
[area
];
24370 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24374 /* Produce a glyph for a glyphless character for iterator IT.
24375 IT->glyphless_method specifies which method to use for displaying
24376 the character. See the description of enum
24377 glyphless_display_method in dispextern.h for the detail.
24379 FOR_NO_FONT is nonzero if and only if this is for a character for
24380 which no font was found. ACRONYM, if non-nil, is an acronym string
24381 for the character. */
24384 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24389 int base_width
, base_height
, width
, height
;
24390 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24393 /* Get the metrics of the base font. We always refer to the current
24395 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24396 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24397 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24398 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24399 base_height
= it
->ascent
+ it
->descent
;
24400 base_width
= font
->average_width
;
24402 /* Get a face ID for the glyph by utilizing a cache (the same way as
24403 done for `escape-glyph' in get_next_display_element). */
24404 if (it
->f
== last_glyphless_glyph_frame
24405 && it
->face_id
== last_glyphless_glyph_face_id
)
24407 face_id
= last_glyphless_glyph_merged_face_id
;
24411 /* Merge the `glyphless-char' face into the current face. */
24412 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24413 last_glyphless_glyph_frame
= it
->f
;
24414 last_glyphless_glyph_face_id
= it
->face_id
;
24415 last_glyphless_glyph_merged_face_id
= face_id
;
24418 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24420 it
->pixel_width
= THIN_SPACE_WIDTH
;
24422 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24424 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24426 width
= CHAR_WIDTH (it
->c
);
24429 else if (width
> 4)
24431 it
->pixel_width
= base_width
* width
;
24433 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24439 unsigned int code
[6];
24441 int ascent
, descent
;
24442 struct font_metrics metrics_upper
, metrics_lower
;
24444 face
= FACE_FROM_ID (it
->f
, face_id
);
24445 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24446 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24448 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24450 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24451 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24452 if (CONSP (acronym
))
24453 acronym
= XCAR (acronym
);
24454 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24458 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24459 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24462 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24463 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24464 upper_len
= (len
+ 1) / 2;
24465 font
->driver
->text_extents (font
, code
, upper_len
,
24467 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24472 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24473 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24474 upper_xoff
= upper_yoff
= 2; /* the typical case */
24475 if (base_width
>= width
)
24477 /* Align the upper to the left, the lower to the right. */
24478 it
->pixel_width
= base_width
;
24479 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24483 /* Center the shorter one. */
24484 it
->pixel_width
= width
;
24485 if (metrics_upper
.width
>= metrics_lower
.width
)
24486 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24489 /* FIXME: This code doesn't look right. It formerly was
24490 missing the "lower_xoff = 0;", which couldn't have
24491 been right since it left lower_xoff uninitialized. */
24493 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24497 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24498 top, bottom, and between upper and lower strings. */
24499 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24500 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24501 /* Center vertically.
24502 H:base_height, D:base_descent
24503 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24505 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24506 descent = D - H/2 + h/2;
24507 lower_yoff = descent - 2 - ld;
24508 upper_yoff = lower_yoff - la - 1 - ud; */
24509 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24510 descent
= it
->descent
- (base_height
- height
) / 2;
24511 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24512 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24513 - metrics_upper
.descent
);
24514 /* Don't make the height shorter than the base height. */
24515 if (height
> base_height
)
24517 it
->ascent
= ascent
;
24518 it
->descent
= descent
;
24522 it
->phys_ascent
= it
->ascent
;
24523 it
->phys_descent
= it
->descent
;
24525 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24526 upper_xoff
, upper_yoff
,
24527 lower_xoff
, lower_yoff
);
24529 take_vertical_position_into_account (it
);
24534 Produce glyphs/get display metrics for the display element IT is
24535 loaded with. See the description of struct it in dispextern.h
24536 for an overview of struct it. */
24539 x_produce_glyphs (struct it
*it
)
24541 int extra_line_spacing
= it
->extra_line_spacing
;
24543 it
->glyph_not_available_p
= 0;
24545 if (it
->what
== IT_CHARACTER
)
24548 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24549 struct font
*font
= face
->font
;
24550 struct font_metrics
*pcm
= NULL
;
24551 int boff
; /* baseline offset */
24555 /* When no suitable font is found, display this character by
24556 the method specified in the first extra slot of
24557 Vglyphless_char_display. */
24558 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24560 eassert (it
->what
== IT_GLYPHLESS
);
24561 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24565 boff
= font
->baseline_offset
;
24566 if (font
->vertical_centering
)
24567 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24569 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24575 if (it
->override_ascent
>= 0)
24577 it
->ascent
= it
->override_ascent
;
24578 it
->descent
= it
->override_descent
;
24579 boff
= it
->override_boff
;
24583 it
->ascent
= FONT_BASE (font
) + boff
;
24584 it
->descent
= FONT_DESCENT (font
) - boff
;
24587 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24589 pcm
= get_per_char_metric (font
, &char2b
);
24590 if (pcm
->width
== 0
24591 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24597 it
->phys_ascent
= pcm
->ascent
+ boff
;
24598 it
->phys_descent
= pcm
->descent
- boff
;
24599 it
->pixel_width
= pcm
->width
;
24603 it
->glyph_not_available_p
= 1;
24604 it
->phys_ascent
= it
->ascent
;
24605 it
->phys_descent
= it
->descent
;
24606 it
->pixel_width
= font
->space_width
;
24609 if (it
->constrain_row_ascent_descent_p
)
24611 if (it
->descent
> it
->max_descent
)
24613 it
->ascent
+= it
->descent
- it
->max_descent
;
24614 it
->descent
= it
->max_descent
;
24616 if (it
->ascent
> it
->max_ascent
)
24618 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24619 it
->ascent
= it
->max_ascent
;
24621 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24622 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24623 extra_line_spacing
= 0;
24626 /* If this is a space inside a region of text with
24627 `space-width' property, change its width. */
24628 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24630 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24632 /* If face has a box, add the box thickness to the character
24633 height. If character has a box line to the left and/or
24634 right, add the box line width to the character's width. */
24635 if (face
->box
!= FACE_NO_BOX
)
24637 int thick
= face
->box_line_width
;
24641 it
->ascent
+= thick
;
24642 it
->descent
+= thick
;
24647 if (it
->start_of_box_run_p
)
24648 it
->pixel_width
+= thick
;
24649 if (it
->end_of_box_run_p
)
24650 it
->pixel_width
+= thick
;
24653 /* If face has an overline, add the height of the overline
24654 (1 pixel) and a 1 pixel margin to the character height. */
24655 if (face
->overline_p
)
24656 it
->ascent
+= overline_margin
;
24658 if (it
->constrain_row_ascent_descent_p
)
24660 if (it
->ascent
> it
->max_ascent
)
24661 it
->ascent
= it
->max_ascent
;
24662 if (it
->descent
> it
->max_descent
)
24663 it
->descent
= it
->max_descent
;
24666 take_vertical_position_into_account (it
);
24668 /* If we have to actually produce glyphs, do it. */
24673 /* Translate a space with a `space-width' property
24674 into a stretch glyph. */
24675 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24676 / FONT_HEIGHT (font
));
24677 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24678 it
->ascent
+ it
->descent
, ascent
);
24683 /* If characters with lbearing or rbearing are displayed
24684 in this line, record that fact in a flag of the
24685 glyph row. This is used to optimize X output code. */
24686 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24687 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24689 if (! stretched_p
&& it
->pixel_width
== 0)
24690 /* We assure that all visible glyphs have at least 1-pixel
24692 it
->pixel_width
= 1;
24694 else if (it
->char_to_display
== '\n')
24696 /* A newline has no width, but we need the height of the
24697 line. But if previous part of the line sets a height,
24698 don't increase that height */
24700 Lisp_Object height
;
24701 Lisp_Object total_height
= Qnil
;
24703 it
->override_ascent
= -1;
24704 it
->pixel_width
= 0;
24707 height
= get_it_property (it
, Qline_height
);
24708 /* Split (line-height total-height) list */
24710 && CONSP (XCDR (height
))
24711 && NILP (XCDR (XCDR (height
))))
24713 total_height
= XCAR (XCDR (height
));
24714 height
= XCAR (height
);
24716 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24718 if (it
->override_ascent
>= 0)
24720 it
->ascent
= it
->override_ascent
;
24721 it
->descent
= it
->override_descent
;
24722 boff
= it
->override_boff
;
24726 it
->ascent
= FONT_BASE (font
) + boff
;
24727 it
->descent
= FONT_DESCENT (font
) - boff
;
24730 if (EQ (height
, Qt
))
24732 if (it
->descent
> it
->max_descent
)
24734 it
->ascent
+= it
->descent
- it
->max_descent
;
24735 it
->descent
= it
->max_descent
;
24737 if (it
->ascent
> it
->max_ascent
)
24739 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24740 it
->ascent
= it
->max_ascent
;
24742 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24743 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24744 it
->constrain_row_ascent_descent_p
= 1;
24745 extra_line_spacing
= 0;
24749 Lisp_Object spacing
;
24751 it
->phys_ascent
= it
->ascent
;
24752 it
->phys_descent
= it
->descent
;
24754 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24755 && face
->box
!= FACE_NO_BOX
24756 && face
->box_line_width
> 0)
24758 it
->ascent
+= face
->box_line_width
;
24759 it
->descent
+= face
->box_line_width
;
24762 && XINT (height
) > it
->ascent
+ it
->descent
)
24763 it
->ascent
= XINT (height
) - it
->descent
;
24765 if (!NILP (total_height
))
24766 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24769 spacing
= get_it_property (it
, Qline_spacing
);
24770 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24772 if (INTEGERP (spacing
))
24774 extra_line_spacing
= XINT (spacing
);
24775 if (!NILP (total_height
))
24776 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24780 else /* i.e. (it->char_to_display == '\t') */
24782 if (font
->space_width
> 0)
24784 int tab_width
= it
->tab_width
* font
->space_width
;
24785 int x
= it
->current_x
+ it
->continuation_lines_width
;
24786 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24788 /* If the distance from the current position to the next tab
24789 stop is less than a space character width, use the
24790 tab stop after that. */
24791 if (next_tab_x
- x
< font
->space_width
)
24792 next_tab_x
+= tab_width
;
24794 it
->pixel_width
= next_tab_x
- x
;
24796 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24797 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24801 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24802 it
->ascent
+ it
->descent
, it
->ascent
);
24807 it
->pixel_width
= 0;
24812 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24814 /* A static composition.
24816 Note: A composition is represented as one glyph in the
24817 glyph matrix. There are no padding glyphs.
24819 Important note: pixel_width, ascent, and descent are the
24820 values of what is drawn by draw_glyphs (i.e. the values of
24821 the overall glyphs composed). */
24822 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24823 int boff
; /* baseline offset */
24824 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24825 int glyph_len
= cmp
->glyph_len
;
24826 struct font
*font
= face
->font
;
24830 /* If we have not yet calculated pixel size data of glyphs of
24831 the composition for the current face font, calculate them
24832 now. Theoretically, we have to check all fonts for the
24833 glyphs, but that requires much time and memory space. So,
24834 here we check only the font of the first glyph. This may
24835 lead to incorrect display, but it's very rare, and C-l
24836 (recenter-top-bottom) can correct the display anyway. */
24837 if (! cmp
->font
|| cmp
->font
!= font
)
24839 /* Ascent and descent of the font of the first character
24840 of this composition (adjusted by baseline offset).
24841 Ascent and descent of overall glyphs should not be less
24842 than these, respectively. */
24843 int font_ascent
, font_descent
, font_height
;
24844 /* Bounding box of the overall glyphs. */
24845 int leftmost
, rightmost
, lowest
, highest
;
24846 int lbearing
, rbearing
;
24847 int i
, width
, ascent
, descent
;
24848 int left_padded
= 0, right_padded
= 0;
24849 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24851 struct font_metrics
*pcm
;
24852 int font_not_found_p
;
24855 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24856 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24858 if (glyph_len
< cmp
->glyph_len
)
24860 for (i
= 0; i
< glyph_len
; i
++)
24862 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24864 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24869 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24870 : IT_CHARPOS (*it
));
24871 /* If no suitable font is found, use the default font. */
24872 font_not_found_p
= font
== NULL
;
24873 if (font_not_found_p
)
24875 face
= face
->ascii_face
;
24878 boff
= font
->baseline_offset
;
24879 if (font
->vertical_centering
)
24880 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24881 font_ascent
= FONT_BASE (font
) + boff
;
24882 font_descent
= FONT_DESCENT (font
) - boff
;
24883 font_height
= FONT_HEIGHT (font
);
24888 if (! font_not_found_p
)
24890 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24892 pcm
= get_per_char_metric (font
, &char2b
);
24895 /* Initialize the bounding box. */
24898 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
24899 ascent
= pcm
->ascent
;
24900 descent
= pcm
->descent
;
24901 lbearing
= pcm
->lbearing
;
24902 rbearing
= pcm
->rbearing
;
24906 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
24907 ascent
= FONT_BASE (font
);
24908 descent
= FONT_DESCENT (font
);
24915 lowest
= - descent
+ boff
;
24916 highest
= ascent
+ boff
;
24918 if (! font_not_found_p
24919 && font
->default_ascent
24920 && CHAR_TABLE_P (Vuse_default_ascent
)
24921 && !NILP (Faref (Vuse_default_ascent
,
24922 make_number (it
->char_to_display
))))
24923 highest
= font
->default_ascent
+ boff
;
24925 /* Draw the first glyph at the normal position. It may be
24926 shifted to right later if some other glyphs are drawn
24928 cmp
->offsets
[i
* 2] = 0;
24929 cmp
->offsets
[i
* 2 + 1] = boff
;
24930 cmp
->lbearing
= lbearing
;
24931 cmp
->rbearing
= rbearing
;
24933 /* Set cmp->offsets for the remaining glyphs. */
24934 for (i
++; i
< glyph_len
; i
++)
24936 int left
, right
, btm
, top
;
24937 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24939 struct face
*this_face
;
24943 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24944 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24945 font
= this_face
->font
;
24951 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24953 pcm
= get_per_char_metric (font
, &char2b
);
24956 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24959 width
= pcm
->width
;
24960 ascent
= pcm
->ascent
;
24961 descent
= pcm
->descent
;
24962 lbearing
= pcm
->lbearing
;
24963 rbearing
= pcm
->rbearing
;
24964 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24966 /* Relative composition with or without
24967 alternate chars. */
24968 left
= (leftmost
+ rightmost
- width
) / 2;
24969 btm
= - descent
+ boff
;
24970 if (font
->relative_compose
24971 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24972 || NILP (Faref (Vignore_relative_composition
,
24973 make_number (ch
)))))
24976 if (- descent
>= font
->relative_compose
)
24977 /* One extra pixel between two glyphs. */
24979 else if (ascent
<= 0)
24980 /* One extra pixel between two glyphs. */
24981 btm
= lowest
- 1 - ascent
- descent
;
24986 /* A composition rule is specified by an integer
24987 value that encodes global and new reference
24988 points (GREF and NREF). GREF and NREF are
24989 specified by numbers as below:
24991 0---1---2 -- ascent
24995 9--10--11 -- center
24997 ---3---4---5--- baseline
24999 6---7---8 -- descent
25001 int rule
= COMPOSITION_RULE (cmp
, i
);
25002 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
25004 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
25005 grefx
= gref
% 3, nrefx
= nref
% 3;
25006 grefy
= gref
/ 3, nrefy
= nref
/ 3;
25008 xoff
= font_height
* (xoff
- 128) / 256;
25010 yoff
= font_height
* (yoff
- 128) / 256;
25013 + grefx
* (rightmost
- leftmost
) / 2
25014 - nrefx
* width
/ 2
25017 btm
= ((grefy
== 0 ? highest
25019 : grefy
== 2 ? lowest
25020 : (highest
+ lowest
) / 2)
25021 - (nrefy
== 0 ? ascent
+ descent
25022 : nrefy
== 1 ? descent
- boff
25024 : (ascent
+ descent
) / 2)
25028 cmp
->offsets
[i
* 2] = left
;
25029 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
25031 /* Update the bounding box of the overall glyphs. */
25034 right
= left
+ width
;
25035 if (left
< leftmost
)
25037 if (right
> rightmost
)
25040 top
= btm
+ descent
+ ascent
;
25046 if (cmp
->lbearing
> left
+ lbearing
)
25047 cmp
->lbearing
= left
+ lbearing
;
25048 if (cmp
->rbearing
< left
+ rbearing
)
25049 cmp
->rbearing
= left
+ rbearing
;
25053 /* If there are glyphs whose x-offsets are negative,
25054 shift all glyphs to the right and make all x-offsets
25058 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25059 cmp
->offsets
[i
* 2] -= leftmost
;
25060 rightmost
-= leftmost
;
25061 cmp
->lbearing
-= leftmost
;
25062 cmp
->rbearing
-= leftmost
;
25065 if (left_padded
&& cmp
->lbearing
< 0)
25067 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25068 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
25069 rightmost
-= cmp
->lbearing
;
25070 cmp
->rbearing
-= cmp
->lbearing
;
25073 if (right_padded
&& rightmost
< cmp
->rbearing
)
25075 rightmost
= cmp
->rbearing
;
25078 cmp
->pixel_width
= rightmost
;
25079 cmp
->ascent
= highest
;
25080 cmp
->descent
= - lowest
;
25081 if (cmp
->ascent
< font_ascent
)
25082 cmp
->ascent
= font_ascent
;
25083 if (cmp
->descent
< font_descent
)
25084 cmp
->descent
= font_descent
;
25088 && (cmp
->lbearing
< 0
25089 || cmp
->rbearing
> cmp
->pixel_width
))
25090 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25092 it
->pixel_width
= cmp
->pixel_width
;
25093 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
25094 it
->descent
= it
->phys_descent
= cmp
->descent
;
25095 if (face
->box
!= FACE_NO_BOX
)
25097 int thick
= face
->box_line_width
;
25101 it
->ascent
+= thick
;
25102 it
->descent
+= thick
;
25107 if (it
->start_of_box_run_p
)
25108 it
->pixel_width
+= thick
;
25109 if (it
->end_of_box_run_p
)
25110 it
->pixel_width
+= thick
;
25113 /* If face has an overline, add the height of the overline
25114 (1 pixel) and a 1 pixel margin to the character height. */
25115 if (face
->overline_p
)
25116 it
->ascent
+= overline_margin
;
25118 take_vertical_position_into_account (it
);
25119 if (it
->ascent
< 0)
25121 if (it
->descent
< 0)
25124 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
25125 append_composite_glyph (it
);
25127 else if (it
->what
== IT_COMPOSITION
)
25129 /* A dynamic (automatic) composition. */
25130 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25131 Lisp_Object gstring
;
25132 struct font_metrics metrics
;
25136 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
25138 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
25141 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
25142 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25143 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
25144 it
->descent
= it
->phys_descent
= metrics
.descent
;
25145 if (face
->box
!= FACE_NO_BOX
)
25147 int thick
= face
->box_line_width
;
25151 it
->ascent
+= thick
;
25152 it
->descent
+= thick
;
25157 if (it
->start_of_box_run_p
)
25158 it
->pixel_width
+= thick
;
25159 if (it
->end_of_box_run_p
)
25160 it
->pixel_width
+= thick
;
25162 /* If face has an overline, add the height of the overline
25163 (1 pixel) and a 1 pixel margin to the character height. */
25164 if (face
->overline_p
)
25165 it
->ascent
+= overline_margin
;
25166 take_vertical_position_into_account (it
);
25167 if (it
->ascent
< 0)
25169 if (it
->descent
< 0)
25173 append_composite_glyph (it
);
25175 else if (it
->what
== IT_GLYPHLESS
)
25176 produce_glyphless_glyph (it
, 0, Qnil
);
25177 else if (it
->what
== IT_IMAGE
)
25178 produce_image_glyph (it
);
25179 else if (it
->what
== IT_STRETCH
)
25180 produce_stretch_glyph (it
);
25183 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25184 because this isn't true for images with `:ascent 100'. */
25185 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
25186 if (it
->area
== TEXT_AREA
)
25187 it
->current_x
+= it
->pixel_width
;
25189 if (extra_line_spacing
> 0)
25191 it
->descent
+= extra_line_spacing
;
25192 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25193 it
->max_extra_line_spacing
= extra_line_spacing
;
25196 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25197 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25198 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25199 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25203 Output LEN glyphs starting at START at the nominal cursor position.
25204 Advance the nominal cursor over the text. The global variable
25205 updated_window contains the window being updated, updated_row is
25206 the glyph row being updated, and updated_area is the area of that
25207 row being updated. */
25210 x_write_glyphs (struct glyph
*start
, int len
)
25212 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25214 eassert (updated_window
&& updated_row
);
25215 /* When the window is hscrolled, cursor hpos can legitimately be out
25216 of bounds, but we draw the cursor at the corresponding window
25217 margin in that case. */
25218 if (!updated_row
->reversed_p
&& chpos
< 0)
25220 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25221 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25225 /* Write glyphs. */
25227 hpos
= start
- updated_row
->glyphs
[updated_area
];
25228 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25229 updated_row
, updated_area
,
25231 DRAW_NORMAL_TEXT
, 0);
25233 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25234 if (updated_area
== TEXT_AREA
25235 && updated_window
->phys_cursor_on_p
25236 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25238 && chpos
< hpos
+ len
)
25239 updated_window
->phys_cursor_on_p
= 0;
25243 /* Advance the output cursor. */
25244 output_cursor
.hpos
+= len
;
25245 output_cursor
.x
= x
;
25250 Insert LEN glyphs from START at the nominal cursor position. */
25253 x_insert_glyphs (struct glyph
*start
, int len
)
25257 int line_height
, shift_by_width
, shifted_region_width
;
25258 struct glyph_row
*row
;
25259 struct glyph
*glyph
;
25260 int frame_x
, frame_y
;
25263 eassert (updated_window
&& updated_row
);
25265 w
= updated_window
;
25266 f
= XFRAME (WINDOW_FRAME (w
));
25268 /* Get the height of the line we are in. */
25270 line_height
= row
->height
;
25272 /* Get the width of the glyphs to insert. */
25273 shift_by_width
= 0;
25274 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25275 shift_by_width
+= glyph
->pixel_width
;
25277 /* Get the width of the region to shift right. */
25278 shifted_region_width
= (window_box_width (w
, updated_area
)
25283 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25284 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25286 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25287 line_height
, shift_by_width
);
25289 /* Write the glyphs. */
25290 hpos
= start
- row
->glyphs
[updated_area
];
25291 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25293 DRAW_NORMAL_TEXT
, 0);
25295 /* Advance the output cursor. */
25296 output_cursor
.hpos
+= len
;
25297 output_cursor
.x
+= shift_by_width
;
25303 Erase the current text line from the nominal cursor position
25304 (inclusive) to pixel column TO_X (exclusive). The idea is that
25305 everything from TO_X onward is already erased.
25307 TO_X is a pixel position relative to updated_area of
25308 updated_window. TO_X == -1 means clear to the end of this area. */
25311 x_clear_end_of_line (int to_x
)
25314 struct window
*w
= updated_window
;
25315 int max_x
, min_y
, max_y
;
25316 int from_x
, from_y
, to_y
;
25318 eassert (updated_window
&& updated_row
);
25319 f
= XFRAME (w
->frame
);
25321 if (updated_row
->full_width_p
)
25322 max_x
= WINDOW_TOTAL_WIDTH (w
);
25324 max_x
= window_box_width (w
, updated_area
);
25325 max_y
= window_text_bottom_y (w
);
25327 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25328 of window. For TO_X > 0, truncate to end of drawing area. */
25334 to_x
= min (to_x
, max_x
);
25336 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25338 /* Notice if the cursor will be cleared by this operation. */
25339 if (!updated_row
->full_width_p
)
25340 notice_overwritten_cursor (w
, updated_area
,
25341 output_cursor
.x
, -1,
25343 MATRIX_ROW_BOTTOM_Y (updated_row
));
25345 from_x
= output_cursor
.x
;
25347 /* Translate to frame coordinates. */
25348 if (updated_row
->full_width_p
)
25350 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25351 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25355 int area_left
= window_box_left (w
, updated_area
);
25356 from_x
+= area_left
;
25360 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25361 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25362 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25364 /* Prevent inadvertently clearing to end of the X window. */
25365 if (to_x
> from_x
&& to_y
> from_y
)
25368 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25369 to_x
- from_x
, to_y
- from_y
);
25374 #endif /* HAVE_WINDOW_SYSTEM */
25378 /***********************************************************************
25380 ***********************************************************************/
25382 /* Value is the internal representation of the specified cursor type
25383 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25384 of the bar cursor. */
25386 static enum text_cursor_kinds
25387 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25389 enum text_cursor_kinds type
;
25394 if (EQ (arg
, Qbox
))
25395 return FILLED_BOX_CURSOR
;
25397 if (EQ (arg
, Qhollow
))
25398 return HOLLOW_BOX_CURSOR
;
25400 if (EQ (arg
, Qbar
))
25407 && EQ (XCAR (arg
), Qbar
)
25408 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25410 *width
= XINT (XCDR (arg
));
25414 if (EQ (arg
, Qhbar
))
25417 return HBAR_CURSOR
;
25421 && EQ (XCAR (arg
), Qhbar
)
25422 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25424 *width
= XINT (XCDR (arg
));
25425 return HBAR_CURSOR
;
25428 /* Treat anything unknown as "hollow box cursor".
25429 It was bad to signal an error; people have trouble fixing
25430 .Xdefaults with Emacs, when it has something bad in it. */
25431 type
= HOLLOW_BOX_CURSOR
;
25436 /* Set the default cursor types for specified frame. */
25438 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25443 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25444 FRAME_CURSOR_WIDTH (f
) = width
;
25446 /* By default, set up the blink-off state depending on the on-state. */
25448 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25451 FRAME_BLINK_OFF_CURSOR (f
)
25452 = get_specified_cursor_type (XCDR (tem
), &width
);
25453 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25456 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25460 #ifdef HAVE_WINDOW_SYSTEM
25462 /* Return the cursor we want to be displayed in window W. Return
25463 width of bar/hbar cursor through WIDTH arg. Return with
25464 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25465 (i.e. if the `system caret' should track this cursor).
25467 In a mini-buffer window, we want the cursor only to appear if we
25468 are reading input from this window. For the selected window, we
25469 want the cursor type given by the frame parameter or buffer local
25470 setting of cursor-type. If explicitly marked off, draw no cursor.
25471 In all other cases, we want a hollow box cursor. */
25473 static enum text_cursor_kinds
25474 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25475 int *active_cursor
)
25477 struct frame
*f
= XFRAME (w
->frame
);
25478 struct buffer
*b
= XBUFFER (w
->contents
);
25479 int cursor_type
= DEFAULT_CURSOR
;
25480 Lisp_Object alt_cursor
;
25481 int non_selected
= 0;
25483 *active_cursor
= 1;
25486 if (cursor_in_echo_area
25487 && FRAME_HAS_MINIBUF_P (f
)
25488 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25490 if (w
== XWINDOW (echo_area_window
))
25492 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25494 *width
= FRAME_CURSOR_WIDTH (f
);
25495 return FRAME_DESIRED_CURSOR (f
);
25498 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25501 *active_cursor
= 0;
25505 /* Detect a nonselected window or nonselected frame. */
25506 else if (w
!= XWINDOW (f
->selected_window
)
25507 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25509 *active_cursor
= 0;
25511 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25517 /* Never display a cursor in a window in which cursor-type is nil. */
25518 if (NILP (BVAR (b
, cursor_type
)))
25521 /* Get the normal cursor type for this window. */
25522 if (EQ (BVAR (b
, cursor_type
), Qt
))
25524 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25525 *width
= FRAME_CURSOR_WIDTH (f
);
25528 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25530 /* Use cursor-in-non-selected-windows instead
25531 for non-selected window or frame. */
25534 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25535 if (!EQ (Qt
, alt_cursor
))
25536 return get_specified_cursor_type (alt_cursor
, width
);
25537 /* t means modify the normal cursor type. */
25538 if (cursor_type
== FILLED_BOX_CURSOR
)
25539 cursor_type
= HOLLOW_BOX_CURSOR
;
25540 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25542 return cursor_type
;
25545 /* Use normal cursor if not blinked off. */
25546 if (!w
->cursor_off_p
)
25548 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25550 if (cursor_type
== FILLED_BOX_CURSOR
)
25552 /* Using a block cursor on large images can be very annoying.
25553 So use a hollow cursor for "large" images.
25554 If image is not transparent (no mask), also use hollow cursor. */
25555 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25556 if (img
!= NULL
&& IMAGEP (img
->spec
))
25558 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25559 where N = size of default frame font size.
25560 This should cover most of the "tiny" icons people may use. */
25562 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25563 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25564 cursor_type
= HOLLOW_BOX_CURSOR
;
25567 else if (cursor_type
!= NO_CURSOR
)
25569 /* Display current only supports BOX and HOLLOW cursors for images.
25570 So for now, unconditionally use a HOLLOW cursor when cursor is
25571 not a solid box cursor. */
25572 cursor_type
= HOLLOW_BOX_CURSOR
;
25575 return cursor_type
;
25578 /* Cursor is blinked off, so determine how to "toggle" it. */
25580 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25581 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25582 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25584 /* Then see if frame has specified a specific blink off cursor type. */
25585 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25587 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25588 return FRAME_BLINK_OFF_CURSOR (f
);
25592 /* Some people liked having a permanently visible blinking cursor,
25593 while others had very strong opinions against it. So it was
25594 decided to remove it. KFS 2003-09-03 */
25596 /* Finally perform built-in cursor blinking:
25597 filled box <-> hollow box
25598 wide [h]bar <-> narrow [h]bar
25599 narrow [h]bar <-> no cursor
25600 other type <-> no cursor */
25602 if (cursor_type
== FILLED_BOX_CURSOR
)
25603 return HOLLOW_BOX_CURSOR
;
25605 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25608 return cursor_type
;
25616 /* Notice when the text cursor of window W has been completely
25617 overwritten by a drawing operation that outputs glyphs in AREA
25618 starting at X0 and ending at X1 in the line starting at Y0 and
25619 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25620 the rest of the line after X0 has been written. Y coordinates
25621 are window-relative. */
25624 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25625 int x0
, int x1
, int y0
, int y1
)
25627 int cx0
, cx1
, cy0
, cy1
;
25628 struct glyph_row
*row
;
25630 if (!w
->phys_cursor_on_p
)
25632 if (area
!= TEXT_AREA
)
25635 if (w
->phys_cursor
.vpos
< 0
25636 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25637 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25638 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
25641 if (row
->cursor_in_fringe_p
)
25643 row
->cursor_in_fringe_p
= 0;
25644 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25645 w
->phys_cursor_on_p
= 0;
25649 cx0
= w
->phys_cursor
.x
;
25650 cx1
= cx0
+ w
->phys_cursor_width
;
25651 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25654 /* The cursor image will be completely removed from the
25655 screen if the output area intersects the cursor area in
25656 y-direction. When we draw in [y0 y1[, and some part of
25657 the cursor is at y < y0, that part must have been drawn
25658 before. When scrolling, the cursor is erased before
25659 actually scrolling, so we don't come here. When not
25660 scrolling, the rows above the old cursor row must have
25661 changed, and in this case these rows must have written
25662 over the cursor image.
25664 Likewise if part of the cursor is below y1, with the
25665 exception of the cursor being in the first blank row at
25666 the buffer and window end because update_text_area
25667 doesn't draw that row. (Except when it does, but
25668 that's handled in update_text_area.) */
25670 cy0
= w
->phys_cursor
.y
;
25671 cy1
= cy0
+ w
->phys_cursor_height
;
25672 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25675 w
->phys_cursor_on_p
= 0;
25678 #endif /* HAVE_WINDOW_SYSTEM */
25681 /************************************************************************
25683 ************************************************************************/
25685 #ifdef HAVE_WINDOW_SYSTEM
25688 Fix the display of area AREA of overlapping row ROW in window W
25689 with respect to the overlapping part OVERLAPS. */
25692 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25693 enum glyph_row_area area
, int overlaps
)
25700 for (i
= 0; i
< row
->used
[area
];)
25702 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25704 int start
= i
, start_x
= x
;
25708 x
+= row
->glyphs
[area
][i
].pixel_width
;
25711 while (i
< row
->used
[area
]
25712 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25714 draw_glyphs (w
, start_x
, row
, area
,
25716 DRAW_NORMAL_TEXT
, overlaps
);
25720 x
+= row
->glyphs
[area
][i
].pixel_width
;
25730 Draw the cursor glyph of window W in glyph row ROW. See the
25731 comment of draw_glyphs for the meaning of HL. */
25734 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25735 enum draw_glyphs_face hl
)
25737 /* If cursor hpos is out of bounds, don't draw garbage. This can
25738 happen in mini-buffer windows when switching between echo area
25739 glyphs and mini-buffer. */
25740 if ((row
->reversed_p
25741 ? (w
->phys_cursor
.hpos
>= 0)
25742 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25744 int on_p
= w
->phys_cursor_on_p
;
25746 int hpos
= w
->phys_cursor
.hpos
;
25748 /* When the window is hscrolled, cursor hpos can legitimately be
25749 out of bounds, but we draw the cursor at the corresponding
25750 window margin in that case. */
25751 if (!row
->reversed_p
&& hpos
< 0)
25753 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25754 hpos
= row
->used
[TEXT_AREA
] - 1;
25756 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25758 w
->phys_cursor_on_p
= on_p
;
25760 if (hl
== DRAW_CURSOR
)
25761 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25762 /* When we erase the cursor, and ROW is overlapped by other
25763 rows, make sure that these overlapping parts of other rows
25765 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25767 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25769 if (row
> w
->current_matrix
->rows
25770 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25771 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25772 OVERLAPS_ERASED_CURSOR
);
25774 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25775 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25776 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25777 OVERLAPS_ERASED_CURSOR
);
25784 Erase the image of a cursor of window W from the screen. */
25787 erase_phys_cursor (struct window
*w
)
25789 struct frame
*f
= XFRAME (w
->frame
);
25790 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25791 int hpos
= w
->phys_cursor
.hpos
;
25792 int vpos
= w
->phys_cursor
.vpos
;
25793 int mouse_face_here_p
= 0;
25794 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25795 struct glyph_row
*cursor_row
;
25796 struct glyph
*cursor_glyph
;
25797 enum draw_glyphs_face hl
;
25799 /* No cursor displayed or row invalidated => nothing to do on the
25801 if (w
->phys_cursor_type
== NO_CURSOR
)
25802 goto mark_cursor_off
;
25804 /* VPOS >= active_glyphs->nrows means that window has been resized.
25805 Don't bother to erase the cursor. */
25806 if (vpos
>= active_glyphs
->nrows
)
25807 goto mark_cursor_off
;
25809 /* If row containing cursor is marked invalid, there is nothing we
25811 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25812 if (!cursor_row
->enabled_p
)
25813 goto mark_cursor_off
;
25815 /* If line spacing is > 0, old cursor may only be partially visible in
25816 window after split-window. So adjust visible height. */
25817 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25818 window_text_bottom_y (w
) - cursor_row
->y
);
25820 /* If row is completely invisible, don't attempt to delete a cursor which
25821 isn't there. This can happen if cursor is at top of a window, and
25822 we switch to a buffer with a header line in that window. */
25823 if (cursor_row
->visible_height
<= 0)
25824 goto mark_cursor_off
;
25826 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25827 if (cursor_row
->cursor_in_fringe_p
)
25829 cursor_row
->cursor_in_fringe_p
= 0;
25830 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25831 goto mark_cursor_off
;
25834 /* This can happen when the new row is shorter than the old one.
25835 In this case, either draw_glyphs or clear_end_of_line
25836 should have cleared the cursor. Note that we wouldn't be
25837 able to erase the cursor in this case because we don't have a
25838 cursor glyph at hand. */
25839 if ((cursor_row
->reversed_p
25840 ? (w
->phys_cursor
.hpos
< 0)
25841 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25842 goto mark_cursor_off
;
25844 /* When the window is hscrolled, cursor hpos can legitimately be out
25845 of bounds, but we draw the cursor at the corresponding window
25846 margin in that case. */
25847 if (!cursor_row
->reversed_p
&& hpos
< 0)
25849 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25850 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25852 /* If the cursor is in the mouse face area, redisplay that when
25853 we clear the cursor. */
25854 if (! NILP (hlinfo
->mouse_face_window
)
25855 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25856 /* Don't redraw the cursor's spot in mouse face if it is at the
25857 end of a line (on a newline). The cursor appears there, but
25858 mouse highlighting does not. */
25859 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25860 mouse_face_here_p
= 1;
25862 /* Maybe clear the display under the cursor. */
25863 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25866 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25869 cursor_glyph
= get_phys_cursor_glyph (w
);
25870 if (cursor_glyph
== NULL
)
25871 goto mark_cursor_off
;
25873 width
= cursor_glyph
->pixel_width
;
25874 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25875 x
= w
->phys_cursor
.x
;
25877 width
-= left_x
- x
;
25878 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25879 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25880 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25883 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25886 /* Erase the cursor by redrawing the character underneath it. */
25887 if (mouse_face_here_p
)
25888 hl
= DRAW_MOUSE_FACE
;
25890 hl
= DRAW_NORMAL_TEXT
;
25891 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25894 w
->phys_cursor_on_p
= 0;
25895 w
->phys_cursor_type
= NO_CURSOR
;
25900 Display or clear cursor of window W. If ON is zero, clear the
25901 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25902 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25905 display_and_set_cursor (struct window
*w
, int on
,
25906 int hpos
, int vpos
, int x
, int y
)
25908 struct frame
*f
= XFRAME (w
->frame
);
25909 int new_cursor_type
;
25910 int new_cursor_width
;
25912 struct glyph_row
*glyph_row
;
25913 struct glyph
*glyph
;
25915 /* This is pointless on invisible frames, and dangerous on garbaged
25916 windows and frames; in the latter case, the frame or window may
25917 be in the midst of changing its size, and x and y may be off the
25919 if (! FRAME_VISIBLE_P (f
)
25920 || FRAME_GARBAGED_P (f
)
25921 || vpos
>= w
->current_matrix
->nrows
25922 || hpos
>= w
->current_matrix
->matrix_w
)
25925 /* If cursor is off and we want it off, return quickly. */
25926 if (!on
&& !w
->phys_cursor_on_p
)
25929 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25930 /* If cursor row is not enabled, we don't really know where to
25931 display the cursor. */
25932 if (!glyph_row
->enabled_p
)
25934 w
->phys_cursor_on_p
= 0;
25939 if (!glyph_row
->exact_window_width_line_p
25940 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25941 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25943 eassert (input_blocked_p ());
25945 /* Set new_cursor_type to the cursor we want to be displayed. */
25946 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25947 &new_cursor_width
, &active_cursor
);
25949 /* If cursor is currently being shown and we don't want it to be or
25950 it is in the wrong place, or the cursor type is not what we want,
25952 if (w
->phys_cursor_on_p
25954 || w
->phys_cursor
.x
!= x
25955 || w
->phys_cursor
.y
!= y
25956 || new_cursor_type
!= w
->phys_cursor_type
25957 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25958 && new_cursor_width
!= w
->phys_cursor_width
)))
25959 erase_phys_cursor (w
);
25961 /* Don't check phys_cursor_on_p here because that flag is only set
25962 to zero in some cases where we know that the cursor has been
25963 completely erased, to avoid the extra work of erasing the cursor
25964 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25965 still not be visible, or it has only been partly erased. */
25968 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25969 w
->phys_cursor_height
= glyph_row
->height
;
25971 /* Set phys_cursor_.* before x_draw_.* is called because some
25972 of them may need the information. */
25973 w
->phys_cursor
.x
= x
;
25974 w
->phys_cursor
.y
= glyph_row
->y
;
25975 w
->phys_cursor
.hpos
= hpos
;
25976 w
->phys_cursor
.vpos
= vpos
;
25979 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25980 new_cursor_type
, new_cursor_width
,
25981 on
, active_cursor
);
25985 /* Switch the display of W's cursor on or off, according to the value
25989 update_window_cursor (struct window
*w
, int on
)
25991 /* Don't update cursor in windows whose frame is in the process
25992 of being deleted. */
25993 if (w
->current_matrix
)
25995 int hpos
= w
->phys_cursor
.hpos
;
25996 int vpos
= w
->phys_cursor
.vpos
;
25997 struct glyph_row
*row
;
25999 if (vpos
>= w
->current_matrix
->nrows
26000 || hpos
>= w
->current_matrix
->matrix_w
)
26003 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26005 /* When the window is hscrolled, cursor hpos can legitimately be
26006 out of bounds, but we draw the cursor at the corresponding
26007 window margin in that case. */
26008 if (!row
->reversed_p
&& hpos
< 0)
26010 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26011 hpos
= row
->used
[TEXT_AREA
] - 1;
26014 display_and_set_cursor (w
, on
, hpos
, vpos
,
26015 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26021 /* Call update_window_cursor with parameter ON_P on all leaf windows
26022 in the window tree rooted at W. */
26025 update_cursor_in_window_tree (struct window
*w
, int on_p
)
26029 if (WINDOWP (w
->contents
))
26030 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
26032 update_window_cursor (w
, on_p
);
26034 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
26040 Display the cursor on window W, or clear it, according to ON_P.
26041 Don't change the cursor's position. */
26044 x_update_cursor (struct frame
*f
, int on_p
)
26046 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
26051 Clear the cursor of window W to background color, and mark the
26052 cursor as not shown. This is used when the text where the cursor
26053 is about to be rewritten. */
26056 x_clear_cursor (struct window
*w
)
26058 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
26059 update_window_cursor (w
, 0);
26062 #endif /* HAVE_WINDOW_SYSTEM */
26064 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26067 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
26068 int start_hpos
, int end_hpos
,
26069 enum draw_glyphs_face draw
)
26071 #ifdef HAVE_WINDOW_SYSTEM
26072 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
26074 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
26078 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26079 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
26083 /* Display the active region described by mouse_face_* according to DRAW. */
26086 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
26088 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
26089 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26091 if (/* If window is in the process of being destroyed, don't bother
26093 w
->current_matrix
!= NULL
26094 /* Don't update mouse highlight if hidden */
26095 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
26096 /* Recognize when we are called to operate on rows that don't exist
26097 anymore. This can happen when a window is split. */
26098 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
26100 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
26101 struct glyph_row
*row
, *first
, *last
;
26103 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
26104 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
26106 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
26108 int start_hpos
, end_hpos
, start_x
;
26110 /* For all but the first row, the highlight starts at column 0. */
26113 /* R2L rows have BEG and END in reversed order, but the
26114 screen drawing geometry is always left to right. So
26115 we need to mirror the beginning and end of the
26116 highlighted area in R2L rows. */
26117 if (!row
->reversed_p
)
26119 start_hpos
= hlinfo
->mouse_face_beg_col
;
26120 start_x
= hlinfo
->mouse_face_beg_x
;
26122 else if (row
== last
)
26124 start_hpos
= hlinfo
->mouse_face_end_col
;
26125 start_x
= hlinfo
->mouse_face_end_x
;
26133 else if (row
->reversed_p
&& row
== last
)
26135 start_hpos
= hlinfo
->mouse_face_end_col
;
26136 start_x
= hlinfo
->mouse_face_end_x
;
26146 if (!row
->reversed_p
)
26147 end_hpos
= hlinfo
->mouse_face_end_col
;
26148 else if (row
== first
)
26149 end_hpos
= hlinfo
->mouse_face_beg_col
;
26152 end_hpos
= row
->used
[TEXT_AREA
];
26153 if (draw
== DRAW_NORMAL_TEXT
)
26154 row
->fill_line_p
= 1; /* Clear to end of line */
26157 else if (row
->reversed_p
&& row
== first
)
26158 end_hpos
= hlinfo
->mouse_face_beg_col
;
26161 end_hpos
= row
->used
[TEXT_AREA
];
26162 if (draw
== DRAW_NORMAL_TEXT
)
26163 row
->fill_line_p
= 1; /* Clear to end of line */
26166 if (end_hpos
> start_hpos
)
26168 draw_row_with_mouse_face (w
, start_x
, row
,
26169 start_hpos
, end_hpos
, draw
);
26172 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26176 #ifdef HAVE_WINDOW_SYSTEM
26177 /* When we've written over the cursor, arrange for it to
26178 be displayed again. */
26179 if (FRAME_WINDOW_P (f
)
26180 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26182 int hpos
= w
->phys_cursor
.hpos
;
26184 /* When the window is hscrolled, cursor hpos can legitimately be
26185 out of bounds, but we draw the cursor at the corresponding
26186 window margin in that case. */
26187 if (!row
->reversed_p
&& hpos
< 0)
26189 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26190 hpos
= row
->used
[TEXT_AREA
] - 1;
26193 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26194 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26197 #endif /* HAVE_WINDOW_SYSTEM */
26200 #ifdef HAVE_WINDOW_SYSTEM
26201 /* Change the mouse cursor. */
26202 if (FRAME_WINDOW_P (f
))
26204 if (draw
== DRAW_NORMAL_TEXT
26205 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26206 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26207 else if (draw
== DRAW_MOUSE_FACE
)
26208 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26210 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26212 #endif /* HAVE_WINDOW_SYSTEM */
26216 Clear out the mouse-highlighted active region.
26217 Redraw it un-highlighted first. Value is non-zero if mouse
26218 face was actually drawn unhighlighted. */
26221 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26225 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26227 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26231 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26232 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26233 hlinfo
->mouse_face_window
= Qnil
;
26234 hlinfo
->mouse_face_overlay
= Qnil
;
26238 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26239 within the mouse face on that window. */
26241 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26243 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26245 /* Quickly resolve the easy cases. */
26246 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26247 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26249 if (vpos
< hlinfo
->mouse_face_beg_row
26250 || vpos
> hlinfo
->mouse_face_end_row
)
26252 if (vpos
> hlinfo
->mouse_face_beg_row
26253 && vpos
< hlinfo
->mouse_face_end_row
)
26256 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26258 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26260 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26263 else if ((vpos
== hlinfo
->mouse_face_beg_row
26264 && hpos
>= hlinfo
->mouse_face_beg_col
)
26265 || (vpos
== hlinfo
->mouse_face_end_row
26266 && hpos
< hlinfo
->mouse_face_end_col
))
26271 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26273 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26276 else if ((vpos
== hlinfo
->mouse_face_beg_row
26277 && hpos
<= hlinfo
->mouse_face_beg_col
)
26278 || (vpos
== hlinfo
->mouse_face_end_row
26279 && hpos
> hlinfo
->mouse_face_end_col
))
26287 Non-zero if physical cursor of window W is within mouse face. */
26290 cursor_in_mouse_face_p (struct window
*w
)
26292 int hpos
= w
->phys_cursor
.hpos
;
26293 int vpos
= w
->phys_cursor
.vpos
;
26294 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26296 /* When the window is hscrolled, cursor hpos can legitimately be out
26297 of bounds, but we draw the cursor at the corresponding window
26298 margin in that case. */
26299 if (!row
->reversed_p
&& hpos
< 0)
26301 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26302 hpos
= row
->used
[TEXT_AREA
] - 1;
26304 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26309 /* Find the glyph rows START_ROW and END_ROW of window W that display
26310 characters between buffer positions START_CHARPOS and END_CHARPOS
26311 (excluding END_CHARPOS). DISP_STRING is a display string that
26312 covers these buffer positions. This is similar to
26313 row_containing_pos, but is more accurate when bidi reordering makes
26314 buffer positions change non-linearly with glyph rows. */
26316 rows_from_pos_range (struct window
*w
,
26317 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26318 Lisp_Object disp_string
,
26319 struct glyph_row
**start
, struct glyph_row
**end
)
26321 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26322 int last_y
= window_text_bottom_y (w
);
26323 struct glyph_row
*row
;
26328 while (!first
->enabled_p
26329 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26332 /* Find the START row. */
26334 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26337 /* A row can potentially be the START row if the range of the
26338 characters it displays intersects the range
26339 [START_CHARPOS..END_CHARPOS). */
26340 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26341 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26342 /* See the commentary in row_containing_pos, for the
26343 explanation of the complicated way to check whether
26344 some position is beyond the end of the characters
26345 displayed by a row. */
26346 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26347 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26348 && !row
->ends_at_zv_p
26349 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26350 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26351 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26352 && !row
->ends_at_zv_p
26353 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26355 /* Found a candidate row. Now make sure at least one of the
26356 glyphs it displays has a charpos from the range
26357 [START_CHARPOS..END_CHARPOS).
26359 This is not obvious because bidi reordering could make
26360 buffer positions of a row be 1,2,3,102,101,100, and if we
26361 want to highlight characters in [50..60), we don't want
26362 this row, even though [50..60) does intersect [1..103),
26363 the range of character positions given by the row's start
26364 and end positions. */
26365 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26366 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26370 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26371 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26372 /* A glyph that comes from DISP_STRING is by
26373 definition to be highlighted. */
26374 || EQ (g
->object
, disp_string
))
26383 /* Find the END row. */
26385 /* If the last row is partially visible, start looking for END
26386 from that row, instead of starting from FIRST. */
26387 && !(row
->enabled_p
26388 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26390 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26392 struct glyph_row
*next
= row
+ 1;
26393 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26395 if (!next
->enabled_p
26396 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26397 /* The first row >= START whose range of displayed characters
26398 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26399 is the row END + 1. */
26400 || (start_charpos
< next_start
26401 && end_charpos
< next_start
)
26402 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26403 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26404 && !next
->ends_at_zv_p
26405 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26406 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26407 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26408 && !next
->ends_at_zv_p
26409 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26416 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26417 but none of the characters it displays are in the range, it is
26419 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26420 struct glyph
*s
= g
;
26421 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26425 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26426 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26427 /* If the buffer position of the first glyph in
26428 the row is equal to END_CHARPOS, it means
26429 the last character to be highlighted is the
26430 newline of ROW, and we must consider NEXT as
26432 || (((!next
->reversed_p
&& g
== s
)
26433 || (next
->reversed_p
&& g
== e
- 1))
26434 && (g
->charpos
== end_charpos
26435 /* Special case for when NEXT is an
26436 empty line at ZV. */
26437 || (g
->charpos
== -1
26438 && !row
->ends_at_zv_p
26439 && next_start
== end_charpos
)))))
26440 /* A glyph that comes from DISP_STRING is by
26441 definition to be highlighted. */
26442 || EQ (g
->object
, disp_string
))
26451 /* The first row that ends at ZV must be the last to be
26453 else if (next
->ends_at_zv_p
)
26462 /* This function sets the mouse_face_* elements of HLINFO, assuming
26463 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26464 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26465 for the overlay or run of text properties specifying the mouse
26466 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26467 before-string and after-string that must also be highlighted.
26468 DISP_STRING, if non-nil, is a display string that may cover some
26469 or all of the highlighted text. */
26472 mouse_face_from_buffer_pos (Lisp_Object window
,
26473 Mouse_HLInfo
*hlinfo
,
26474 ptrdiff_t mouse_charpos
,
26475 ptrdiff_t start_charpos
,
26476 ptrdiff_t end_charpos
,
26477 Lisp_Object before_string
,
26478 Lisp_Object after_string
,
26479 Lisp_Object disp_string
)
26481 struct window
*w
= XWINDOW (window
);
26482 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26483 struct glyph_row
*r1
, *r2
;
26484 struct glyph
*glyph
, *end
;
26485 ptrdiff_t ignore
, pos
;
26488 eassert (NILP (disp_string
) || STRINGP (disp_string
));
26489 eassert (NILP (before_string
) || STRINGP (before_string
));
26490 eassert (NILP (after_string
) || STRINGP (after_string
));
26492 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26493 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26495 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26496 /* If the before-string or display-string contains newlines,
26497 rows_from_pos_range skips to its last row. Move back. */
26498 if (!NILP (before_string
) || !NILP (disp_string
))
26500 struct glyph_row
*prev
;
26501 while ((prev
= r1
- 1, prev
>= first
)
26502 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26503 && prev
->used
[TEXT_AREA
] > 0)
26505 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26506 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26507 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26509 || !(EQ (glyph
->object
, before_string
)
26510 || EQ (glyph
->object
, disp_string
)))
26517 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26518 hlinfo
->mouse_face_past_end
= 1;
26520 else if (!NILP (after_string
))
26522 /* If the after-string has newlines, advance to its last row. */
26523 struct glyph_row
*next
;
26524 struct glyph_row
*last
26525 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26527 for (next
= r2
+ 1;
26529 && next
->used
[TEXT_AREA
] > 0
26530 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26534 /* The rest of the display engine assumes that mouse_face_beg_row is
26535 either above mouse_face_end_row or identical to it. But with
26536 bidi-reordered continued lines, the row for START_CHARPOS could
26537 be below the row for END_CHARPOS. If so, swap the rows and store
26538 them in correct order. */
26541 struct glyph_row
*tem
= r2
;
26547 hlinfo
->mouse_face_beg_y
= r1
->y
;
26548 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26549 hlinfo
->mouse_face_end_y
= r2
->y
;
26550 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26552 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26553 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26554 could be anywhere in the row and in any order. The strategy
26555 below is to find the leftmost and the rightmost glyph that
26556 belongs to either of these 3 strings, or whose position is
26557 between START_CHARPOS and END_CHARPOS, and highlight all the
26558 glyphs between those two. This may cover more than just the text
26559 between START_CHARPOS and END_CHARPOS if the range of characters
26560 strides the bidi level boundary, e.g. if the beginning is in R2L
26561 text while the end is in L2R text or vice versa. */
26562 if (!r1
->reversed_p
)
26564 /* This row is in a left to right paragraph. Scan it left to
26566 glyph
= r1
->glyphs
[TEXT_AREA
];
26567 end
= glyph
+ r1
->used
[TEXT_AREA
];
26570 /* Skip truncation glyphs at the start of the glyph row. */
26571 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
26573 && INTEGERP (glyph
->object
)
26574 && glyph
->charpos
< 0;
26576 x
+= glyph
->pixel_width
;
26578 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26579 or DISP_STRING, and the first glyph from buffer whose
26580 position is between START_CHARPOS and END_CHARPOS. */
26582 && !INTEGERP (glyph
->object
)
26583 && !EQ (glyph
->object
, disp_string
)
26584 && !(BUFFERP (glyph
->object
)
26585 && (glyph
->charpos
>= start_charpos
26586 && glyph
->charpos
< end_charpos
));
26589 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26590 are present at buffer positions between START_CHARPOS and
26591 END_CHARPOS, or if they come from an overlay. */
26592 if (EQ (glyph
->object
, before_string
))
26594 pos
= string_buffer_position (before_string
,
26596 /* If pos == 0, it means before_string came from an
26597 overlay, not from a buffer position. */
26598 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26601 else if (EQ (glyph
->object
, after_string
))
26603 pos
= string_buffer_position (after_string
, end_charpos
);
26604 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26607 x
+= glyph
->pixel_width
;
26609 hlinfo
->mouse_face_beg_x
= x
;
26610 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26614 /* This row is in a right to left paragraph. Scan it right to
26618 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26619 glyph
= end
+ r1
->used
[TEXT_AREA
];
26621 /* Skip truncation glyphs at the start of the glyph row. */
26622 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
26624 && INTEGERP (glyph
->object
)
26625 && glyph
->charpos
< 0;
26629 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26630 or DISP_STRING, and the first glyph from buffer whose
26631 position is between START_CHARPOS and END_CHARPOS. */
26633 && !INTEGERP (glyph
->object
)
26634 && !EQ (glyph
->object
, disp_string
)
26635 && !(BUFFERP (glyph
->object
)
26636 && (glyph
->charpos
>= start_charpos
26637 && glyph
->charpos
< end_charpos
));
26640 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26641 are present at buffer positions between START_CHARPOS and
26642 END_CHARPOS, or if they come from an overlay. */
26643 if (EQ (glyph
->object
, before_string
))
26645 pos
= string_buffer_position (before_string
, start_charpos
);
26646 /* If pos == 0, it means before_string came from an
26647 overlay, not from a buffer position. */
26648 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26651 else if (EQ (glyph
->object
, after_string
))
26653 pos
= string_buffer_position (after_string
, end_charpos
);
26654 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26659 glyph
++; /* first glyph to the right of the highlighted area */
26660 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26661 x
+= g
->pixel_width
;
26662 hlinfo
->mouse_face_beg_x
= x
;
26663 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26666 /* If the highlight ends in a different row, compute GLYPH and END
26667 for the end row. Otherwise, reuse the values computed above for
26668 the row where the highlight begins. */
26671 if (!r2
->reversed_p
)
26673 glyph
= r2
->glyphs
[TEXT_AREA
];
26674 end
= glyph
+ r2
->used
[TEXT_AREA
];
26679 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26680 glyph
= end
+ r2
->used
[TEXT_AREA
];
26684 if (!r2
->reversed_p
)
26686 /* Skip truncation and continuation glyphs near the end of the
26687 row, and also blanks and stretch glyphs inserted by
26688 extend_face_to_end_of_line. */
26690 && INTEGERP ((end
- 1)->object
))
26692 /* Scan the rest of the glyph row from the end, looking for the
26693 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26694 DISP_STRING, or whose position is between START_CHARPOS
26698 && !INTEGERP (end
->object
)
26699 && !EQ (end
->object
, disp_string
)
26700 && !(BUFFERP (end
->object
)
26701 && (end
->charpos
>= start_charpos
26702 && end
->charpos
< end_charpos
));
26705 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26706 are present at buffer positions between START_CHARPOS and
26707 END_CHARPOS, or if they come from an overlay. */
26708 if (EQ (end
->object
, before_string
))
26710 pos
= string_buffer_position (before_string
, start_charpos
);
26711 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26714 else if (EQ (end
->object
, after_string
))
26716 pos
= string_buffer_position (after_string
, end_charpos
);
26717 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26721 /* Find the X coordinate of the last glyph to be highlighted. */
26722 for (; glyph
<= end
; ++glyph
)
26723 x
+= glyph
->pixel_width
;
26725 hlinfo
->mouse_face_end_x
= x
;
26726 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26730 /* Skip truncation and continuation glyphs near the end of the
26731 row, and also blanks and stretch glyphs inserted by
26732 extend_face_to_end_of_line. */
26736 && INTEGERP (end
->object
))
26738 x
+= end
->pixel_width
;
26741 /* Scan the rest of the glyph row from the end, looking for the
26742 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26743 DISP_STRING, or whose position is between START_CHARPOS
26747 && !INTEGERP (end
->object
)
26748 && !EQ (end
->object
, disp_string
)
26749 && !(BUFFERP (end
->object
)
26750 && (end
->charpos
>= start_charpos
26751 && end
->charpos
< end_charpos
));
26754 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26755 are present at buffer positions between START_CHARPOS and
26756 END_CHARPOS, or if they come from an overlay. */
26757 if (EQ (end
->object
, before_string
))
26759 pos
= string_buffer_position (before_string
, start_charpos
);
26760 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26763 else if (EQ (end
->object
, after_string
))
26765 pos
= string_buffer_position (after_string
, end_charpos
);
26766 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26769 x
+= end
->pixel_width
;
26771 /* If we exited the above loop because we arrived at the last
26772 glyph of the row, and its buffer position is still not in
26773 range, it means the last character in range is the preceding
26774 newline. Bump the end column and x values to get past the
26777 && BUFFERP (end
->object
)
26778 && (end
->charpos
< start_charpos
26779 || end
->charpos
>= end_charpos
))
26781 x
+= end
->pixel_width
;
26784 hlinfo
->mouse_face_end_x
= x
;
26785 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26788 hlinfo
->mouse_face_window
= window
;
26789 hlinfo
->mouse_face_face_id
26790 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26792 !hlinfo
->mouse_face_hidden
, -1);
26793 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26796 /* The following function is not used anymore (replaced with
26797 mouse_face_from_string_pos), but I leave it here for the time
26798 being, in case someone would. */
26800 #if 0 /* not used */
26802 /* Find the position of the glyph for position POS in OBJECT in
26803 window W's current matrix, and return in *X, *Y the pixel
26804 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26806 RIGHT_P non-zero means return the position of the right edge of the
26807 glyph, RIGHT_P zero means return the left edge position.
26809 If no glyph for POS exists in the matrix, return the position of
26810 the glyph with the next smaller position that is in the matrix, if
26811 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26812 exists in the matrix, return the position of the glyph with the
26813 next larger position in OBJECT.
26815 Value is non-zero if a glyph was found. */
26818 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
26819 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26821 int yb
= window_text_bottom_y (w
);
26822 struct glyph_row
*r
;
26823 struct glyph
*best_glyph
= NULL
;
26824 struct glyph_row
*best_row
= NULL
;
26827 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26828 r
->enabled_p
&& r
->y
< yb
;
26831 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26832 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26835 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26836 if (EQ (g
->object
, object
))
26838 if (g
->charpos
== pos
)
26845 else if (best_glyph
== NULL
26846 || ((eabs (g
->charpos
- pos
)
26847 < eabs (best_glyph
->charpos
- pos
))
26850 : g
->charpos
> pos
)))
26864 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26868 *x
+= best_glyph
->pixel_width
;
26873 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
26876 return best_glyph
!= NULL
;
26878 #endif /* not used */
26880 /* Find the positions of the first and the last glyphs in window W's
26881 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26882 (assumed to be a string), and return in HLINFO's mouse_face_*
26883 members the pixel and column/row coordinates of those glyphs. */
26886 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26887 Lisp_Object object
,
26888 ptrdiff_t startpos
, ptrdiff_t endpos
)
26890 int yb
= window_text_bottom_y (w
);
26891 struct glyph_row
*r
;
26892 struct glyph
*g
, *e
;
26896 /* Find the glyph row with at least one position in the range
26897 [STARTPOS..ENDPOS], and the first glyph in that row whose
26898 position belongs to that range. */
26899 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26900 r
->enabled_p
&& r
->y
< yb
;
26903 if (!r
->reversed_p
)
26905 g
= r
->glyphs
[TEXT_AREA
];
26906 e
= g
+ r
->used
[TEXT_AREA
];
26907 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26908 if (EQ (g
->object
, object
)
26909 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26911 hlinfo
->mouse_face_beg_row
26912 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
26913 hlinfo
->mouse_face_beg_y
= r
->y
;
26914 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26915 hlinfo
->mouse_face_beg_x
= gx
;
26924 e
= r
->glyphs
[TEXT_AREA
];
26925 g
= e
+ r
->used
[TEXT_AREA
];
26926 for ( ; g
> e
; --g
)
26927 if (EQ ((g
-1)->object
, object
)
26928 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26930 hlinfo
->mouse_face_beg_row
26931 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
26932 hlinfo
->mouse_face_beg_y
= r
->y
;
26933 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26934 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26935 gx
+= g1
->pixel_width
;
26936 hlinfo
->mouse_face_beg_x
= gx
;
26948 /* Starting with the next row, look for the first row which does NOT
26949 include any glyphs whose positions are in the range. */
26950 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26952 g
= r
->glyphs
[TEXT_AREA
];
26953 e
= g
+ r
->used
[TEXT_AREA
];
26955 for ( ; g
< e
; ++g
)
26956 if (EQ (g
->object
, object
)
26957 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26966 /* The highlighted region ends on the previous row. */
26969 /* Set the end row and its vertical pixel coordinate. */
26970 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
26971 hlinfo
->mouse_face_end_y
= r
->y
;
26973 /* Compute and set the end column and the end column's horizontal
26974 pixel coordinate. */
26975 if (!r
->reversed_p
)
26977 g
= r
->glyphs
[TEXT_AREA
];
26978 e
= g
+ r
->used
[TEXT_AREA
];
26979 for ( ; e
> g
; --e
)
26980 if (EQ ((e
-1)->object
, object
)
26981 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26983 hlinfo
->mouse_face_end_col
= e
- g
;
26985 for (gx
= r
->x
; g
< e
; ++g
)
26986 gx
+= g
->pixel_width
;
26987 hlinfo
->mouse_face_end_x
= gx
;
26991 e
= r
->glyphs
[TEXT_AREA
];
26992 g
= e
+ r
->used
[TEXT_AREA
];
26993 for (gx
= r
->x
; e
< g
; ++e
)
26995 if (EQ (e
->object
, object
)
26996 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26998 gx
+= e
->pixel_width
;
27000 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
27001 hlinfo
->mouse_face_end_x
= gx
;
27005 #ifdef HAVE_WINDOW_SYSTEM
27007 /* See if position X, Y is within a hot-spot of an image. */
27010 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
27012 if (!CONSP (hot_spot
))
27015 if (EQ (XCAR (hot_spot
), Qrect
))
27017 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27018 Lisp_Object rect
= XCDR (hot_spot
);
27022 if (!CONSP (XCAR (rect
)))
27024 if (!CONSP (XCDR (rect
)))
27026 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
27028 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
27030 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
27032 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
27036 else if (EQ (XCAR (hot_spot
), Qcircle
))
27038 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27039 Lisp_Object circ
= XCDR (hot_spot
);
27040 Lisp_Object lr
, lx0
, ly0
;
27042 && CONSP (XCAR (circ
))
27043 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
27044 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
27045 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
27047 double r
= XFLOATINT (lr
);
27048 double dx
= XINT (lx0
) - x
;
27049 double dy
= XINT (ly0
) - y
;
27050 return (dx
* dx
+ dy
* dy
<= r
* r
);
27053 else if (EQ (XCAR (hot_spot
), Qpoly
))
27055 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27056 if (VECTORP (XCDR (hot_spot
)))
27058 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
27059 Lisp_Object
*poly
= v
->contents
;
27060 ptrdiff_t n
= v
->header
.size
;
27063 Lisp_Object lx
, ly
;
27066 /* Need an even number of coordinates, and at least 3 edges. */
27067 if (n
< 6 || n
& 1)
27070 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27071 If count is odd, we are inside polygon. Pixels on edges
27072 may or may not be included depending on actual geometry of the
27074 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
27075 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
27077 x0
= XINT (lx
), y0
= XINT (ly
);
27078 for (i
= 0; i
< n
; i
+= 2)
27080 int x1
= x0
, y1
= y0
;
27081 if ((lx
= poly
[i
], !INTEGERP (lx
))
27082 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
27084 x0
= XINT (lx
), y0
= XINT (ly
);
27086 /* Does this segment cross the X line? */
27094 if (y
> y0
&& y
> y1
)
27096 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
27106 find_hot_spot (Lisp_Object map
, int x
, int y
)
27108 while (CONSP (map
))
27110 if (CONSP (XCAR (map
))
27111 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
27119 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
27121 doc
: /* Lookup in image map MAP coordinates X and Y.
27122 An image map is an alist where each element has the format (AREA ID PLIST).
27123 An AREA is specified as either a rectangle, a circle, or a polygon:
27124 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27125 pixel coordinates of the upper left and bottom right corners.
27126 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27127 and the radius of the circle; r may be a float or integer.
27128 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27129 vector describes one corner in the polygon.
27130 Returns the alist element for the first matching AREA in MAP. */)
27131 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
27139 return find_hot_spot (map
,
27140 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
27141 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
27145 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27147 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
27149 /* Do not change cursor shape while dragging mouse. */
27150 if (!NILP (do_mouse_tracking
))
27153 if (!NILP (pointer
))
27155 if (EQ (pointer
, Qarrow
))
27156 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27157 else if (EQ (pointer
, Qhand
))
27158 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27159 else if (EQ (pointer
, Qtext
))
27160 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27161 else if (EQ (pointer
, intern ("hdrag")))
27162 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27163 #ifdef HAVE_X_WINDOWS
27164 else if (EQ (pointer
, intern ("vdrag")))
27165 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27167 else if (EQ (pointer
, intern ("hourglass")))
27168 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27169 else if (EQ (pointer
, Qmodeline
))
27170 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27172 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27175 if (cursor
!= No_Cursor
)
27176 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27179 #endif /* HAVE_WINDOW_SYSTEM */
27181 /* Take proper action when mouse has moved to the mode or header line
27182 or marginal area AREA of window W, x-position X and y-position Y.
27183 X is relative to the start of the text display area of W, so the
27184 width of bitmap areas and scroll bars must be subtracted to get a
27185 position relative to the start of the mode line. */
27188 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27189 enum window_part area
)
27191 struct window
*w
= XWINDOW (window
);
27192 struct frame
*f
= XFRAME (w
->frame
);
27193 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27194 #ifdef HAVE_WINDOW_SYSTEM
27195 Display_Info
*dpyinfo
;
27197 Cursor cursor
= No_Cursor
;
27198 Lisp_Object pointer
= Qnil
;
27199 int dx
, dy
, width
, height
;
27201 Lisp_Object string
, object
= Qnil
;
27202 Lisp_Object pos
IF_LINT (= Qnil
), help
;
27204 Lisp_Object mouse_face
;
27205 int original_x_pixel
= x
;
27206 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27207 struct glyph_row
*row
IF_LINT (= 0);
27209 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27214 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27215 returns them in row/column units! */
27216 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27217 &object
, &dx
, &dy
, &width
, &height
);
27219 row
= (area
== ON_MODE_LINE
27220 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27221 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27223 /* Find the glyph under the mouse pointer. */
27224 if (row
->mode_line_p
&& row
->enabled_p
)
27226 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27227 end
= glyph
+ row
->used
[TEXT_AREA
];
27229 for (x0
= original_x_pixel
;
27230 glyph
< end
&& x0
>= glyph
->pixel_width
;
27232 x0
-= glyph
->pixel_width
;
27240 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27241 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27242 returns them in row/column units! */
27243 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27244 &object
, &dx
, &dy
, &width
, &height
);
27249 #ifdef HAVE_WINDOW_SYSTEM
27250 if (IMAGEP (object
))
27252 Lisp_Object image_map
, hotspot
;
27253 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27255 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27257 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27261 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27262 If so, we could look for mouse-enter, mouse-leave
27263 properties in PLIST (and do something...). */
27264 hotspot
= XCDR (hotspot
);
27265 if (CONSP (hotspot
)
27266 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27268 pointer
= Fplist_get (plist
, Qpointer
);
27269 if (NILP (pointer
))
27271 help
= Fplist_get (plist
, Qhelp_echo
);
27274 help_echo_string
= help
;
27275 XSETWINDOW (help_echo_window
, w
);
27276 help_echo_object
= w
->contents
;
27277 help_echo_pos
= charpos
;
27281 if (NILP (pointer
))
27282 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27284 #endif /* HAVE_WINDOW_SYSTEM */
27286 if (STRINGP (string
))
27287 pos
= make_number (charpos
);
27289 /* Set the help text and mouse pointer. If the mouse is on a part
27290 of the mode line without any text (e.g. past the right edge of
27291 the mode line text), use the default help text and pointer. */
27292 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27294 /* Arrange to display the help by setting the global variables
27295 help_echo_string, help_echo_object, and help_echo_pos. */
27298 if (STRINGP (string
))
27299 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27303 help_echo_string
= help
;
27304 XSETWINDOW (help_echo_window
, w
);
27305 help_echo_object
= string
;
27306 help_echo_pos
= charpos
;
27308 else if (area
== ON_MODE_LINE
)
27310 Lisp_Object default_help
27311 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27314 if (STRINGP (default_help
))
27316 help_echo_string
= default_help
;
27317 XSETWINDOW (help_echo_window
, w
);
27318 help_echo_object
= Qnil
;
27319 help_echo_pos
= -1;
27324 #ifdef HAVE_WINDOW_SYSTEM
27325 /* Change the mouse pointer according to what is under it. */
27326 if (FRAME_WINDOW_P (f
))
27328 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27329 if (STRINGP (string
))
27331 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27333 if (NILP (pointer
))
27334 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27336 /* Change the mouse pointer according to what is under X/Y. */
27338 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27341 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27342 if (!KEYMAPP (map
))
27343 map
= Fget_text_property (pos
, Qkeymap
, string
);
27344 if (!KEYMAPP (map
))
27345 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27349 /* Default mode-line pointer. */
27350 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27355 /* Change the mouse face according to what is under X/Y. */
27356 if (STRINGP (string
))
27358 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27359 if (!NILP (mouse_face
)
27360 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27365 struct glyph
* tmp_glyph
;
27369 int total_pixel_width
;
27370 ptrdiff_t begpos
, endpos
, ignore
;
27374 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27375 Qmouse_face
, string
, Qnil
);
27381 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27383 endpos
= SCHARS (string
);
27387 /* Calculate the glyph position GPOS of GLYPH in the
27388 displayed string, relative to the beginning of the
27389 highlighted part of the string.
27391 Note: GPOS is different from CHARPOS. CHARPOS is the
27392 position of GLYPH in the internal string object. A mode
27393 line string format has structures which are converted to
27394 a flattened string by the Emacs Lisp interpreter. The
27395 internal string is an element of those structures. The
27396 displayed string is the flattened string. */
27397 tmp_glyph
= row_start_glyph
;
27398 while (tmp_glyph
< glyph
27399 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27400 && begpos
<= tmp_glyph
->charpos
27401 && tmp_glyph
->charpos
< endpos
)))
27403 gpos
= glyph
- tmp_glyph
;
27405 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27406 the highlighted part of the displayed string to which
27407 GLYPH belongs. Note: GSEQ_LENGTH is different from
27408 SCHARS (STRING), because the latter returns the length of
27409 the internal string. */
27410 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27412 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27413 && begpos
<= tmp_glyph
->charpos
27414 && tmp_glyph
->charpos
< endpos
));
27417 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27419 /* Calculate the total pixel width of all the glyphs between
27420 the beginning of the highlighted area and GLYPH. */
27421 total_pixel_width
= 0;
27422 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27423 total_pixel_width
+= tmp_glyph
->pixel_width
;
27425 /* Pre calculation of re-rendering position. Note: X is in
27426 column units here, after the call to mode_line_string or
27427 marginal_area_string. */
27429 vpos
= (area
== ON_MODE_LINE
27430 ? (w
->current_matrix
)->nrows
- 1
27433 /* If GLYPH's position is included in the region that is
27434 already drawn in mouse face, we have nothing to do. */
27435 if ( EQ (window
, hlinfo
->mouse_face_window
)
27436 && (!row
->reversed_p
27437 ? (hlinfo
->mouse_face_beg_col
<= hpos
27438 && hpos
< hlinfo
->mouse_face_end_col
)
27439 /* In R2L rows we swap BEG and END, see below. */
27440 : (hlinfo
->mouse_face_end_col
<= hpos
27441 && hpos
< hlinfo
->mouse_face_beg_col
))
27442 && hlinfo
->mouse_face_beg_row
== vpos
)
27445 if (clear_mouse_face (hlinfo
))
27446 cursor
= No_Cursor
;
27448 if (!row
->reversed_p
)
27450 hlinfo
->mouse_face_beg_col
= hpos
;
27451 hlinfo
->mouse_face_beg_x
= original_x_pixel
27452 - (total_pixel_width
+ dx
);
27453 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27454 hlinfo
->mouse_face_end_x
= 0;
27458 /* In R2L rows, show_mouse_face expects BEG and END
27459 coordinates to be swapped. */
27460 hlinfo
->mouse_face_end_col
= hpos
;
27461 hlinfo
->mouse_face_end_x
= original_x_pixel
27462 - (total_pixel_width
+ dx
);
27463 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27464 hlinfo
->mouse_face_beg_x
= 0;
27467 hlinfo
->mouse_face_beg_row
= vpos
;
27468 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27469 hlinfo
->mouse_face_beg_y
= 0;
27470 hlinfo
->mouse_face_end_y
= 0;
27471 hlinfo
->mouse_face_past_end
= 0;
27472 hlinfo
->mouse_face_window
= window
;
27474 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27480 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27482 if (NILP (pointer
))
27485 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27486 clear_mouse_face (hlinfo
);
27488 #ifdef HAVE_WINDOW_SYSTEM
27489 if (FRAME_WINDOW_P (f
))
27490 define_frame_cursor1 (f
, cursor
, pointer
);
27496 Take proper action when the mouse has moved to position X, Y on
27497 frame F as regards highlighting characters that have mouse-face
27498 properties. Also de-highlighting chars where the mouse was before.
27499 X and Y can be negative or out of range. */
27502 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27504 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27505 enum window_part part
= ON_NOTHING
;
27506 Lisp_Object window
;
27508 Cursor cursor
= No_Cursor
;
27509 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27512 /* When a menu is active, don't highlight because this looks odd. */
27513 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27514 if (popup_activated ())
27518 if (NILP (Vmouse_highlight
)
27519 || !f
->glyphs_initialized_p
27520 || f
->pointer_invisible
)
27523 hlinfo
->mouse_face_mouse_x
= x
;
27524 hlinfo
->mouse_face_mouse_y
= y
;
27525 hlinfo
->mouse_face_mouse_frame
= f
;
27527 if (hlinfo
->mouse_face_defer
)
27530 /* Which window is that in? */
27531 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27533 /* If displaying active text in another window, clear that. */
27534 if (! EQ (window
, hlinfo
->mouse_face_window
)
27535 /* Also clear if we move out of text area in same window. */
27536 || (!NILP (hlinfo
->mouse_face_window
)
27539 && part
!= ON_MODE_LINE
27540 && part
!= ON_HEADER_LINE
))
27541 clear_mouse_face (hlinfo
);
27543 /* Not on a window -> return. */
27544 if (!WINDOWP (window
))
27547 /* Reset help_echo_string. It will get recomputed below. */
27548 help_echo_string
= Qnil
;
27550 /* Convert to window-relative pixel coordinates. */
27551 w
= XWINDOW (window
);
27552 frame_to_window_pixel_xy (w
, &x
, &y
);
27554 #ifdef HAVE_WINDOW_SYSTEM
27555 /* Handle tool-bar window differently since it doesn't display a
27557 if (EQ (window
, f
->tool_bar_window
))
27559 note_tool_bar_highlight (f
, x
, y
);
27564 /* Mouse is on the mode, header line or margin? */
27565 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27566 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27568 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27572 #ifdef HAVE_WINDOW_SYSTEM
27573 if (part
== ON_VERTICAL_BORDER
)
27575 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27576 help_echo_string
= build_string ("drag-mouse-1: resize");
27578 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27579 || part
== ON_SCROLL_BAR
)
27580 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27582 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27585 /* Are we in a window whose display is up to date?
27586 And verify the buffer's text has not changed. */
27587 b
= XBUFFER (w
->contents
);
27588 if (part
== ON_TEXT
27589 && w
->window_end_valid
27590 && w
->last_modified
== BUF_MODIFF (b
)
27591 && w
->last_overlay_modified
== BUF_OVERLAY_MODIFF (b
))
27593 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27595 struct glyph
*glyph
;
27596 Lisp_Object object
;
27597 Lisp_Object mouse_face
= Qnil
, position
;
27598 Lisp_Object
*overlay_vec
= NULL
;
27599 ptrdiff_t i
, noverlays
;
27600 struct buffer
*obuf
;
27601 ptrdiff_t obegv
, ozv
;
27604 /* Find the glyph under X/Y. */
27605 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27607 #ifdef HAVE_WINDOW_SYSTEM
27608 /* Look for :pointer property on image. */
27609 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27611 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27612 if (img
!= NULL
&& IMAGEP (img
->spec
))
27614 Lisp_Object image_map
, hotspot
;
27615 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27617 && (hotspot
= find_hot_spot (image_map
,
27618 glyph
->slice
.img
.x
+ dx
,
27619 glyph
->slice
.img
.y
+ dy
),
27621 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27625 /* Could check XCAR (hotspot) to see if we enter/leave
27627 If so, we could look for mouse-enter, mouse-leave
27628 properties in PLIST (and do something...). */
27629 hotspot
= XCDR (hotspot
);
27630 if (CONSP (hotspot
)
27631 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27633 pointer
= Fplist_get (plist
, Qpointer
);
27634 if (NILP (pointer
))
27636 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27637 if (!NILP (help_echo_string
))
27639 help_echo_window
= window
;
27640 help_echo_object
= glyph
->object
;
27641 help_echo_pos
= glyph
->charpos
;
27645 if (NILP (pointer
))
27646 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27649 #endif /* HAVE_WINDOW_SYSTEM */
27651 /* Clear mouse face if X/Y not over text. */
27653 || area
!= TEXT_AREA
27654 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
27655 /* Glyph's OBJECT is an integer for glyphs inserted by the
27656 display engine for its internal purposes, like truncation
27657 and continuation glyphs and blanks beyond the end of
27658 line's text on text terminals. If we are over such a
27659 glyph, we are not over any text. */
27660 || INTEGERP (glyph
->object
)
27661 /* R2L rows have a stretch glyph at their front, which
27662 stands for no text, whereas L2R rows have no glyphs at
27663 all beyond the end of text. Treat such stretch glyphs
27664 like we do with NULL glyphs in L2R rows. */
27665 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27666 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
27667 && glyph
->type
== STRETCH_GLYPH
27668 && glyph
->avoid_cursor_p
))
27670 if (clear_mouse_face (hlinfo
))
27671 cursor
= No_Cursor
;
27672 #ifdef HAVE_WINDOW_SYSTEM
27673 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27675 if (area
!= TEXT_AREA
)
27676 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27678 pointer
= Vvoid_text_area_pointer
;
27684 pos
= glyph
->charpos
;
27685 object
= glyph
->object
;
27686 if (!STRINGP (object
) && !BUFFERP (object
))
27689 /* If we get an out-of-range value, return now; avoid an error. */
27690 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27693 /* Make the window's buffer temporarily current for
27694 overlays_at and compute_char_face. */
27695 obuf
= current_buffer
;
27696 current_buffer
= b
;
27702 /* Is this char mouse-active or does it have help-echo? */
27703 position
= make_number (pos
);
27705 if (BUFFERP (object
))
27707 /* Put all the overlays we want in a vector in overlay_vec. */
27708 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27709 /* Sort overlays into increasing priority order. */
27710 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27715 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27718 cursor
= No_Cursor
;
27720 /* Check mouse-face highlighting. */
27722 /* If there exists an overlay with mouse-face overlapping
27723 the one we are currently highlighting, we have to
27724 check if we enter the overlapping overlay, and then
27725 highlight only that. */
27726 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27727 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27729 /* Find the highest priority overlay with a mouse-face. */
27730 Lisp_Object overlay
= Qnil
;
27731 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27733 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27734 if (!NILP (mouse_face
))
27735 overlay
= overlay_vec
[i
];
27738 /* If we're highlighting the same overlay as before, there's
27739 no need to do that again. */
27740 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27741 goto check_help_echo
;
27742 hlinfo
->mouse_face_overlay
= overlay
;
27744 /* Clear the display of the old active region, if any. */
27745 if (clear_mouse_face (hlinfo
))
27746 cursor
= No_Cursor
;
27748 /* If no overlay applies, get a text property. */
27749 if (NILP (overlay
))
27750 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27752 /* Next, compute the bounds of the mouse highlighting and
27754 if (!NILP (mouse_face
) && STRINGP (object
))
27756 /* The mouse-highlighting comes from a display string
27757 with a mouse-face. */
27761 s
= Fprevious_single_property_change
27762 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27763 e
= Fnext_single_property_change
27764 (position
, Qmouse_face
, object
, Qnil
);
27766 s
= make_number (0);
27768 e
= make_number (SCHARS (object
) - 1);
27769 mouse_face_from_string_pos (w
, hlinfo
, object
,
27770 XINT (s
), XINT (e
));
27771 hlinfo
->mouse_face_past_end
= 0;
27772 hlinfo
->mouse_face_window
= window
;
27773 hlinfo
->mouse_face_face_id
27774 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27775 glyph
->face_id
, 1);
27776 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27777 cursor
= No_Cursor
;
27781 /* The mouse-highlighting, if any, comes from an overlay
27782 or text property in the buffer. */
27783 Lisp_Object buffer
IF_LINT (= Qnil
);
27784 Lisp_Object disp_string
IF_LINT (= Qnil
);
27786 if (STRINGP (object
))
27788 /* If we are on a display string with no mouse-face,
27789 check if the text under it has one. */
27790 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27791 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27792 pos
= string_buffer_position (object
, start
);
27795 mouse_face
= get_char_property_and_overlay
27796 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
27797 buffer
= w
->contents
;
27798 disp_string
= object
;
27804 disp_string
= Qnil
;
27807 if (!NILP (mouse_face
))
27809 Lisp_Object before
, after
;
27810 Lisp_Object before_string
, after_string
;
27811 /* To correctly find the limits of mouse highlight
27812 in a bidi-reordered buffer, we must not use the
27813 optimization of limiting the search in
27814 previous-single-property-change and
27815 next-single-property-change, because
27816 rows_from_pos_range needs the real start and end
27817 positions to DTRT in this case. That's because
27818 the first row visible in a window does not
27819 necessarily display the character whose position
27820 is the smallest. */
27822 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27823 ? Fmarker_position (w
->start
)
27826 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27827 ? make_number (BUF_Z (XBUFFER (buffer
))
27828 - XFASTINT (w
->window_end_pos
))
27831 if (NILP (overlay
))
27833 /* Handle the text property case. */
27834 before
= Fprevious_single_property_change
27835 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27836 after
= Fnext_single_property_change
27837 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27838 before_string
= after_string
= Qnil
;
27842 /* Handle the overlay case. */
27843 before
= Foverlay_start (overlay
);
27844 after
= Foverlay_end (overlay
);
27845 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27846 after_string
= Foverlay_get (overlay
, Qafter_string
);
27848 if (!STRINGP (before_string
)) before_string
= Qnil
;
27849 if (!STRINGP (after_string
)) after_string
= Qnil
;
27852 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27855 : XFASTINT (before
),
27857 ? BUF_Z (XBUFFER (buffer
))
27858 : XFASTINT (after
),
27859 before_string
, after_string
,
27861 cursor
= No_Cursor
;
27868 /* Look for a `help-echo' property. */
27869 if (NILP (help_echo_string
)) {
27870 Lisp_Object help
, overlay
;
27872 /* Check overlays first. */
27873 help
= overlay
= Qnil
;
27874 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27876 overlay
= overlay_vec
[i
];
27877 help
= Foverlay_get (overlay
, Qhelp_echo
);
27882 help_echo_string
= help
;
27883 help_echo_window
= window
;
27884 help_echo_object
= overlay
;
27885 help_echo_pos
= pos
;
27889 Lisp_Object obj
= glyph
->object
;
27890 ptrdiff_t charpos
= glyph
->charpos
;
27892 /* Try text properties. */
27895 && charpos
< SCHARS (obj
))
27897 help
= Fget_text_property (make_number (charpos
),
27901 /* If the string itself doesn't specify a help-echo,
27902 see if the buffer text ``under'' it does. */
27903 struct glyph_row
*r
27904 = MATRIX_ROW (w
->current_matrix
, vpos
);
27905 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27906 ptrdiff_t p
= string_buffer_position (obj
, start
);
27909 help
= Fget_char_property (make_number (p
),
27910 Qhelp_echo
, w
->contents
);
27919 else if (BUFFERP (obj
)
27922 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27927 help_echo_string
= help
;
27928 help_echo_window
= window
;
27929 help_echo_object
= obj
;
27930 help_echo_pos
= charpos
;
27935 #ifdef HAVE_WINDOW_SYSTEM
27936 /* Look for a `pointer' property. */
27937 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27939 /* Check overlays first. */
27940 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27941 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27943 if (NILP (pointer
))
27945 Lisp_Object obj
= glyph
->object
;
27946 ptrdiff_t charpos
= glyph
->charpos
;
27948 /* Try text properties. */
27951 && charpos
< SCHARS (obj
))
27953 pointer
= Fget_text_property (make_number (charpos
),
27955 if (NILP (pointer
))
27957 /* If the string itself doesn't specify a pointer,
27958 see if the buffer text ``under'' it does. */
27959 struct glyph_row
*r
27960 = MATRIX_ROW (w
->current_matrix
, vpos
);
27961 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27962 ptrdiff_t p
= string_buffer_position (obj
, start
);
27964 pointer
= Fget_char_property (make_number (p
),
27965 Qpointer
, w
->contents
);
27968 else if (BUFFERP (obj
)
27971 pointer
= Fget_text_property (make_number (charpos
),
27975 #endif /* HAVE_WINDOW_SYSTEM */
27979 current_buffer
= obuf
;
27984 #ifdef HAVE_WINDOW_SYSTEM
27985 if (FRAME_WINDOW_P (f
))
27986 define_frame_cursor1 (f
, cursor
, pointer
);
27988 /* This is here to prevent a compiler error, about "label at end of
27989 compound statement". */
27996 Clear any mouse-face on window W. This function is part of the
27997 redisplay interface, and is called from try_window_id and similar
27998 functions to ensure the mouse-highlight is off. */
28001 x_clear_window_mouse_face (struct window
*w
)
28003 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28004 Lisp_Object window
;
28007 XSETWINDOW (window
, w
);
28008 if (EQ (window
, hlinfo
->mouse_face_window
))
28009 clear_mouse_face (hlinfo
);
28015 Just discard the mouse face information for frame F, if any.
28016 This is used when the size of F is changed. */
28019 cancel_mouse_face (struct frame
*f
)
28021 Lisp_Object window
;
28022 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28024 window
= hlinfo
->mouse_face_window
;
28025 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
28027 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28028 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28029 hlinfo
->mouse_face_window
= Qnil
;
28035 /***********************************************************************
28037 ***********************************************************************/
28039 #ifdef HAVE_WINDOW_SYSTEM
28041 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28042 which intersects rectangle R. R is in window-relative coordinates. */
28045 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
28046 enum glyph_row_area area
)
28048 struct glyph
*first
= row
->glyphs
[area
];
28049 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
28050 struct glyph
*last
;
28051 int first_x
, start_x
, x
;
28053 if (area
== TEXT_AREA
&& row
->fill_line_p
)
28054 /* If row extends face to end of line write the whole line. */
28055 draw_glyphs (w
, 0, row
, area
,
28056 0, row
->used
[area
],
28057 DRAW_NORMAL_TEXT
, 0);
28060 /* Set START_X to the window-relative start position for drawing glyphs of
28061 AREA. The first glyph of the text area can be partially visible.
28062 The first glyphs of other areas cannot. */
28063 start_x
= window_box_left_offset (w
, area
);
28065 if (area
== TEXT_AREA
)
28068 /* Find the first glyph that must be redrawn. */
28070 && x
+ first
->pixel_width
< r
->x
)
28072 x
+= first
->pixel_width
;
28076 /* Find the last one. */
28080 && x
< r
->x
+ r
->width
)
28082 x
+= last
->pixel_width
;
28088 draw_glyphs (w
, first_x
- start_x
, row
, area
,
28089 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
28090 DRAW_NORMAL_TEXT
, 0);
28095 /* Redraw the parts of the glyph row ROW on window W intersecting
28096 rectangle R. R is in window-relative coordinates. Value is
28097 non-zero if mouse-face was overwritten. */
28100 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
28102 eassert (row
->enabled_p
);
28104 if (row
->mode_line_p
|| w
->pseudo_window_p
)
28105 draw_glyphs (w
, 0, row
, TEXT_AREA
,
28106 0, row
->used
[TEXT_AREA
],
28107 DRAW_NORMAL_TEXT
, 0);
28110 if (row
->used
[LEFT_MARGIN_AREA
])
28111 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
28112 if (row
->used
[TEXT_AREA
])
28113 expose_area (w
, row
, r
, TEXT_AREA
);
28114 if (row
->used
[RIGHT_MARGIN_AREA
])
28115 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
28116 draw_row_fringe_bitmaps (w
, row
);
28119 return row
->mouse_face_p
;
28123 /* Redraw those parts of glyphs rows during expose event handling that
28124 overlap other rows. Redrawing of an exposed line writes over parts
28125 of lines overlapping that exposed line; this function fixes that.
28127 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28128 row in W's current matrix that is exposed and overlaps other rows.
28129 LAST_OVERLAPPING_ROW is the last such row. */
28132 expose_overlaps (struct window
*w
,
28133 struct glyph_row
*first_overlapping_row
,
28134 struct glyph_row
*last_overlapping_row
,
28137 struct glyph_row
*row
;
28139 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
28140 if (row
->overlapping_p
)
28142 eassert (row
->enabled_p
&& !row
->mode_line_p
);
28145 if (row
->used
[LEFT_MARGIN_AREA
])
28146 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
28148 if (row
->used
[TEXT_AREA
])
28149 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
28151 if (row
->used
[RIGHT_MARGIN_AREA
])
28152 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
28158 /* Return non-zero if W's cursor intersects rectangle R. */
28161 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
28163 XRectangle cr
, result
;
28164 struct glyph
*cursor_glyph
;
28165 struct glyph_row
*row
;
28167 if (w
->phys_cursor
.vpos
>= 0
28168 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
28169 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
28171 && row
->cursor_in_fringe_p
)
28173 /* Cursor is in the fringe. */
28174 cr
.x
= window_box_right_offset (w
,
28175 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
28176 ? RIGHT_MARGIN_AREA
28179 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
28180 cr
.height
= row
->height
;
28181 return x_intersect_rectangles (&cr
, r
, &result
);
28184 cursor_glyph
= get_phys_cursor_glyph (w
);
28187 /* r is relative to W's box, but w->phys_cursor.x is relative
28188 to left edge of W's TEXT area. Adjust it. */
28189 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28190 cr
.y
= w
->phys_cursor
.y
;
28191 cr
.width
= cursor_glyph
->pixel_width
;
28192 cr
.height
= w
->phys_cursor_height
;
28193 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28194 I assume the effect is the same -- and this is portable. */
28195 return x_intersect_rectangles (&cr
, r
, &result
);
28197 /* If we don't understand the format, pretend we're not in the hot-spot. */
28203 Draw a vertical window border to the right of window W if W doesn't
28204 have vertical scroll bars. */
28207 x_draw_vertical_border (struct window
*w
)
28209 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28211 /* We could do better, if we knew what type of scroll-bar the adjacent
28212 windows (on either side) have... But we don't :-(
28213 However, I think this works ok. ++KFS 2003-04-25 */
28215 /* Redraw borders between horizontally adjacent windows. Don't
28216 do it for frames with vertical scroll bars because either the
28217 right scroll bar of a window, or the left scroll bar of its
28218 neighbor will suffice as a border. */
28219 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28222 /* Note: It is necessary to redraw both the left and the right
28223 borders, for when only this single window W is being
28225 if (!WINDOW_RIGHTMOST_P (w
)
28226 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28228 int x0
, x1
, y0
, y1
;
28230 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28233 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28236 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28238 if (!WINDOW_LEFTMOST_P (w
)
28239 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28241 int x0
, x1
, y0
, y1
;
28243 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28246 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28249 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28254 /* Redraw the part of window W intersection rectangle FR. Pixel
28255 coordinates in FR are frame-relative. Call this function with
28256 input blocked. Value is non-zero if the exposure overwrites
28260 expose_window (struct window
*w
, XRectangle
*fr
)
28262 struct frame
*f
= XFRAME (w
->frame
);
28264 int mouse_face_overwritten_p
= 0;
28266 /* If window is not yet fully initialized, do nothing. This can
28267 happen when toolkit scroll bars are used and a window is split.
28268 Reconfiguring the scroll bar will generate an expose for a newly
28270 if (w
->current_matrix
== NULL
)
28273 /* When we're currently updating the window, display and current
28274 matrix usually don't agree. Arrange for a thorough display
28276 if (w
== updated_window
)
28278 SET_FRAME_GARBAGED (f
);
28282 /* Frame-relative pixel rectangle of W. */
28283 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28284 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28285 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28286 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28288 if (x_intersect_rectangles (fr
, &wr
, &r
))
28290 int yb
= window_text_bottom_y (w
);
28291 struct glyph_row
*row
;
28292 int cursor_cleared_p
, phys_cursor_on_p
;
28293 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28295 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28296 r
.x
, r
.y
, r
.width
, r
.height
));
28298 /* Convert to window coordinates. */
28299 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28300 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28302 /* Turn off the cursor. */
28303 if (!w
->pseudo_window_p
28304 && phys_cursor_in_rect_p (w
, &r
))
28306 x_clear_cursor (w
);
28307 cursor_cleared_p
= 1;
28310 cursor_cleared_p
= 0;
28312 /* If the row containing the cursor extends face to end of line,
28313 then expose_area might overwrite the cursor outside the
28314 rectangle and thus notice_overwritten_cursor might clear
28315 w->phys_cursor_on_p. We remember the original value and
28316 check later if it is changed. */
28317 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28319 /* Update lines intersecting rectangle R. */
28320 first_overlapping_row
= last_overlapping_row
= NULL
;
28321 for (row
= w
->current_matrix
->rows
;
28326 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28328 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28329 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28330 || (r
.y
>= y0
&& r
.y
< y1
)
28331 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28333 /* A header line may be overlapping, but there is no need
28334 to fix overlapping areas for them. KFS 2005-02-12 */
28335 if (row
->overlapping_p
&& !row
->mode_line_p
)
28337 if (first_overlapping_row
== NULL
)
28338 first_overlapping_row
= row
;
28339 last_overlapping_row
= row
;
28343 if (expose_line (w
, row
, &r
))
28344 mouse_face_overwritten_p
= 1;
28347 else if (row
->overlapping_p
)
28349 /* We must redraw a row overlapping the exposed area. */
28351 ? y0
+ row
->phys_height
> r
.y
28352 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28354 if (first_overlapping_row
== NULL
)
28355 first_overlapping_row
= row
;
28356 last_overlapping_row
= row
;
28364 /* Display the mode line if there is one. */
28365 if (WINDOW_WANTS_MODELINE_P (w
)
28366 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28368 && row
->y
< r
.y
+ r
.height
)
28370 if (expose_line (w
, row
, &r
))
28371 mouse_face_overwritten_p
= 1;
28374 if (!w
->pseudo_window_p
)
28376 /* Fix the display of overlapping rows. */
28377 if (first_overlapping_row
)
28378 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28381 /* Draw border between windows. */
28382 x_draw_vertical_border (w
);
28384 /* Turn the cursor on again. */
28385 if (cursor_cleared_p
28386 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28387 update_window_cursor (w
, 1);
28391 return mouse_face_overwritten_p
;
28396 /* Redraw (parts) of all windows in the window tree rooted at W that
28397 intersect R. R contains frame pixel coordinates. Value is
28398 non-zero if the exposure overwrites mouse-face. */
28401 expose_window_tree (struct window
*w
, XRectangle
*r
)
28403 struct frame
*f
= XFRAME (w
->frame
);
28404 int mouse_face_overwritten_p
= 0;
28406 while (w
&& !FRAME_GARBAGED_P (f
))
28408 if (WINDOWP (w
->contents
))
28409 mouse_face_overwritten_p
28410 |= expose_window_tree (XWINDOW (w
->contents
), r
);
28412 mouse_face_overwritten_p
|= expose_window (w
, r
);
28414 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28417 return mouse_face_overwritten_p
;
28422 Redisplay an exposed area of frame F. X and Y are the upper-left
28423 corner of the exposed rectangle. W and H are width and height of
28424 the exposed area. All are pixel values. W or H zero means redraw
28425 the entire frame. */
28428 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28431 int mouse_face_overwritten_p
= 0;
28433 TRACE ((stderr
, "expose_frame "));
28435 /* No need to redraw if frame will be redrawn soon. */
28436 if (FRAME_GARBAGED_P (f
))
28438 TRACE ((stderr
, " garbaged\n"));
28442 /* If basic faces haven't been realized yet, there is no point in
28443 trying to redraw anything. This can happen when we get an expose
28444 event while Emacs is starting, e.g. by moving another window. */
28445 if (FRAME_FACE_CACHE (f
) == NULL
28446 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28448 TRACE ((stderr
, " no faces\n"));
28452 if (w
== 0 || h
== 0)
28455 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28456 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28466 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28467 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28469 if (WINDOWP (f
->tool_bar_window
))
28470 mouse_face_overwritten_p
28471 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28473 #ifdef HAVE_X_WINDOWS
28475 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
28476 if (WINDOWP (f
->menu_bar_window
))
28477 mouse_face_overwritten_p
28478 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28479 #endif /* not USE_X_TOOLKIT and not USE_GTK */
28483 /* Some window managers support a focus-follows-mouse style with
28484 delayed raising of frames. Imagine a partially obscured frame,
28485 and moving the mouse into partially obscured mouse-face on that
28486 frame. The visible part of the mouse-face will be highlighted,
28487 then the WM raises the obscured frame. With at least one WM, KDE
28488 2.1, Emacs is not getting any event for the raising of the frame
28489 (even tried with SubstructureRedirectMask), only Expose events.
28490 These expose events will draw text normally, i.e. not
28491 highlighted. Which means we must redo the highlight here.
28492 Subsume it under ``we love X''. --gerd 2001-08-15 */
28493 /* Included in Windows version because Windows most likely does not
28494 do the right thing if any third party tool offers
28495 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28496 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28498 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28499 if (f
== hlinfo
->mouse_face_mouse_frame
)
28501 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28502 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28503 clear_mouse_face (hlinfo
);
28504 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28511 Determine the intersection of two rectangles R1 and R2. Return
28512 the intersection in *RESULT. Value is non-zero if RESULT is not
28516 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28518 XRectangle
*left
, *right
;
28519 XRectangle
*upper
, *lower
;
28520 int intersection_p
= 0;
28522 /* Rearrange so that R1 is the left-most rectangle. */
28524 left
= r1
, right
= r2
;
28526 left
= r2
, right
= r1
;
28528 /* X0 of the intersection is right.x0, if this is inside R1,
28529 otherwise there is no intersection. */
28530 if (right
->x
<= left
->x
+ left
->width
)
28532 result
->x
= right
->x
;
28534 /* The right end of the intersection is the minimum of
28535 the right ends of left and right. */
28536 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28539 /* Same game for Y. */
28541 upper
= r1
, lower
= r2
;
28543 upper
= r2
, lower
= r1
;
28545 /* The upper end of the intersection is lower.y0, if this is inside
28546 of upper. Otherwise, there is no intersection. */
28547 if (lower
->y
<= upper
->y
+ upper
->height
)
28549 result
->y
= lower
->y
;
28551 /* The lower end of the intersection is the minimum of the lower
28552 ends of upper and lower. */
28553 result
->height
= (min (lower
->y
+ lower
->height
,
28554 upper
->y
+ upper
->height
)
28556 intersection_p
= 1;
28560 return intersection_p
;
28563 #endif /* HAVE_WINDOW_SYSTEM */
28566 /***********************************************************************
28568 ***********************************************************************/
28571 syms_of_xdisp (void)
28573 Vwith_echo_area_save_vector
= Qnil
;
28574 staticpro (&Vwith_echo_area_save_vector
);
28576 Vmessage_stack
= Qnil
;
28577 staticpro (&Vmessage_stack
);
28579 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28580 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
28582 message_dolog_marker1
= Fmake_marker ();
28583 staticpro (&message_dolog_marker1
);
28584 message_dolog_marker2
= Fmake_marker ();
28585 staticpro (&message_dolog_marker2
);
28586 message_dolog_marker3
= Fmake_marker ();
28587 staticpro (&message_dolog_marker3
);
28590 defsubr (&Sdump_frame_glyph_matrix
);
28591 defsubr (&Sdump_glyph_matrix
);
28592 defsubr (&Sdump_glyph_row
);
28593 defsubr (&Sdump_tool_bar_row
);
28594 defsubr (&Strace_redisplay
);
28595 defsubr (&Strace_to_stderr
);
28597 #ifdef HAVE_WINDOW_SYSTEM
28598 defsubr (&Stool_bar_lines_needed
);
28599 defsubr (&Slookup_image_map
);
28601 defsubr (&Sformat_mode_line
);
28602 defsubr (&Sinvisible_p
);
28603 defsubr (&Scurrent_bidi_paragraph_direction
);
28605 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28606 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28607 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28608 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28609 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28610 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28611 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28612 DEFSYM (Qeval
, "eval");
28613 DEFSYM (QCdata
, ":data");
28614 DEFSYM (Qdisplay
, "display");
28615 DEFSYM (Qspace_width
, "space-width");
28616 DEFSYM (Qraise
, "raise");
28617 DEFSYM (Qslice
, "slice");
28618 DEFSYM (Qspace
, "space");
28619 DEFSYM (Qmargin
, "margin");
28620 DEFSYM (Qpointer
, "pointer");
28621 DEFSYM (Qleft_margin
, "left-margin");
28622 DEFSYM (Qright_margin
, "right-margin");
28623 DEFSYM (Qcenter
, "center");
28624 DEFSYM (Qline_height
, "line-height");
28625 DEFSYM (QCalign_to
, ":align-to");
28626 DEFSYM (QCrelative_width
, ":relative-width");
28627 DEFSYM (QCrelative_height
, ":relative-height");
28628 DEFSYM (QCeval
, ":eval");
28629 DEFSYM (QCpropertize
, ":propertize");
28630 DEFSYM (QCfile
, ":file");
28631 DEFSYM (Qfontified
, "fontified");
28632 DEFSYM (Qfontification_functions
, "fontification-functions");
28633 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28634 DEFSYM (Qescape_glyph
, "escape-glyph");
28635 DEFSYM (Qnobreak_space
, "nobreak-space");
28636 DEFSYM (Qimage
, "image");
28637 DEFSYM (Qtext
, "text");
28638 DEFSYM (Qboth
, "both");
28639 DEFSYM (Qboth_horiz
, "both-horiz");
28640 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28641 DEFSYM (QCmap
, ":map");
28642 DEFSYM (QCpointer
, ":pointer");
28643 DEFSYM (Qrect
, "rect");
28644 DEFSYM (Qcircle
, "circle");
28645 DEFSYM (Qpoly
, "poly");
28646 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28647 DEFSYM (Qgrow_only
, "grow-only");
28648 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28649 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28650 DEFSYM (Qposition
, "position");
28651 DEFSYM (Qbuffer_position
, "buffer-position");
28652 DEFSYM (Qobject
, "object");
28653 DEFSYM (Qbar
, "bar");
28654 DEFSYM (Qhbar
, "hbar");
28655 DEFSYM (Qbox
, "box");
28656 DEFSYM (Qhollow
, "hollow");
28657 DEFSYM (Qhand
, "hand");
28658 DEFSYM (Qarrow
, "arrow");
28659 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28661 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28662 Fcons (intern_c_string ("void-variable"), Qnil
)),
28664 staticpro (&list_of_error
);
28666 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28667 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28668 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28669 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28671 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28672 staticpro (&echo_buffer
[0]);
28673 staticpro (&echo_buffer
[1]);
28675 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28676 staticpro (&echo_area_buffer
[0]);
28677 staticpro (&echo_area_buffer
[1]);
28679 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
28680 staticpro (&Vmessages_buffer_name
);
28682 mode_line_proptrans_alist
= Qnil
;
28683 staticpro (&mode_line_proptrans_alist
);
28684 mode_line_string_list
= Qnil
;
28685 staticpro (&mode_line_string_list
);
28686 mode_line_string_face
= Qnil
;
28687 staticpro (&mode_line_string_face
);
28688 mode_line_string_face_prop
= Qnil
;
28689 staticpro (&mode_line_string_face_prop
);
28690 Vmode_line_unwind_vector
= Qnil
;
28691 staticpro (&Vmode_line_unwind_vector
);
28693 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
28695 help_echo_string
= Qnil
;
28696 staticpro (&help_echo_string
);
28697 help_echo_object
= Qnil
;
28698 staticpro (&help_echo_object
);
28699 help_echo_window
= Qnil
;
28700 staticpro (&help_echo_window
);
28701 previous_help_echo_string
= Qnil
;
28702 staticpro (&previous_help_echo_string
);
28703 help_echo_pos
= -1;
28705 DEFSYM (Qright_to_left
, "right-to-left");
28706 DEFSYM (Qleft_to_right
, "left-to-right");
28708 #ifdef HAVE_WINDOW_SYSTEM
28709 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28710 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
28711 For example, if a block cursor is over a tab, it will be drawn as
28712 wide as that tab on the display. */);
28713 x_stretch_cursor_p
= 0;
28716 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28717 doc
: /* Non-nil means highlight trailing whitespace.
28718 The face used for trailing whitespace is `trailing-whitespace'. */);
28719 Vshow_trailing_whitespace
= Qnil
;
28721 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28722 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28723 If the value is t, Emacs highlights non-ASCII chars which have the
28724 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28725 or `escape-glyph' face respectively.
28727 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28728 U+2011 (non-breaking hyphen) are affected.
28730 Any other non-nil value means to display these characters as a escape
28731 glyph followed by an ordinary space or hyphen.
28733 A value of nil means no special handling of these characters. */);
28734 Vnobreak_char_display
= Qt
;
28736 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28737 doc
: /* The pointer shape to show in void text areas.
28738 A value of nil means to show the text pointer. Other options are `arrow',
28739 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28740 Vvoid_text_area_pointer
= Qarrow
;
28742 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28743 doc
: /* Non-nil means don't actually do any redisplay.
28744 This is used for internal purposes. */);
28745 Vinhibit_redisplay
= Qnil
;
28747 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28748 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28749 Vglobal_mode_string
= Qnil
;
28751 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28752 doc
: /* Marker for where to display an arrow on top of the buffer text.
28753 This must be the beginning of a line in order to work.
28754 See also `overlay-arrow-string'. */);
28755 Voverlay_arrow_position
= Qnil
;
28757 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28758 doc
: /* String to display as an arrow in non-window frames.
28759 See also `overlay-arrow-position'. */);
28760 Voverlay_arrow_string
= build_pure_c_string ("=>");
28762 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28763 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28764 The symbols on this list are examined during redisplay to determine
28765 where to display overlay arrows. */);
28766 Voverlay_arrow_variable_list
28767 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28769 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28770 doc
: /* The number of lines to try scrolling a window by when point moves out.
28771 If that fails to bring point back on frame, point is centered instead.
28772 If this is zero, point is always centered after it moves off frame.
28773 If you want scrolling to always be a line at a time, you should set
28774 `scroll-conservatively' to a large value rather than set this to 1. */);
28776 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28777 doc
: /* Scroll up to this many lines, to bring point back on screen.
28778 If point moves off-screen, redisplay will scroll by up to
28779 `scroll-conservatively' lines in order to bring point just barely
28780 onto the screen again. If that cannot be done, then redisplay
28781 recenters point as usual.
28783 If the value is greater than 100, redisplay will never recenter point,
28784 but will always scroll just enough text to bring point into view, even
28785 if you move far away.
28787 A value of zero means always recenter point if it moves off screen. */);
28788 scroll_conservatively
= 0;
28790 DEFVAR_INT ("scroll-margin", scroll_margin
,
28791 doc
: /* Number of lines of margin at the top and bottom of a window.
28792 Recenter the window whenever point gets within this many lines
28793 of the top or bottom of the window. */);
28796 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28797 doc
: /* Pixels per inch value for non-window system displays.
28798 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28799 Vdisplay_pixels_per_inch
= make_float (72.0);
28802 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28805 DEFVAR_LISP ("truncate-partial-width-windows",
28806 Vtruncate_partial_width_windows
,
28807 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28808 For an integer value, truncate lines in each window narrower than the
28809 full frame width, provided the window width is less than that integer;
28810 otherwise, respect the value of `truncate-lines'.
28812 For any other non-nil value, truncate lines in all windows that do
28813 not span the full frame width.
28815 A value of nil means to respect the value of `truncate-lines'.
28817 If `word-wrap' is enabled, you might want to reduce this. */);
28818 Vtruncate_partial_width_windows
= make_number (50);
28820 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28821 doc
: /* Maximum buffer size for which line number should be displayed.
28822 If the buffer is bigger than this, the line number does not appear
28823 in the mode line. A value of nil means no limit. */);
28824 Vline_number_display_limit
= Qnil
;
28826 DEFVAR_INT ("line-number-display-limit-width",
28827 line_number_display_limit_width
,
28828 doc
: /* Maximum line width (in characters) for line number display.
28829 If the average length of the lines near point is bigger than this, then the
28830 line number may be omitted from the mode line. */);
28831 line_number_display_limit_width
= 200;
28833 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28834 doc
: /* Non-nil means highlight region even in nonselected windows. */);
28835 highlight_nonselected_windows
= 0;
28837 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28838 doc
: /* Non-nil if more than one frame is visible on this display.
28839 Minibuffer-only frames don't count, but iconified frames do.
28840 This variable is not guaranteed to be accurate except while processing
28841 `frame-title-format' and `icon-title-format'. */);
28843 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28844 doc
: /* Template for displaying the title bar of visible frames.
28845 \(Assuming the window manager supports this feature.)
28847 This variable has the same structure as `mode-line-format', except that
28848 the %c and %l constructs are ignored. It is used only on frames for
28849 which no explicit name has been set \(see `modify-frame-parameters'). */);
28851 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28852 doc
: /* Template for displaying the title bar of an iconified frame.
28853 \(Assuming the window manager supports this feature.)
28854 This variable has the same structure as `mode-line-format' (which see),
28855 and is used only on frames for which no explicit name has been set
28856 \(see `modify-frame-parameters'). */);
28858 = Vframe_title_format
28859 = listn (CONSTYPE_PURE
, 3,
28860 intern_c_string ("multiple-frames"),
28861 build_pure_c_string ("%b"),
28862 listn (CONSTYPE_PURE
, 4,
28863 empty_unibyte_string
,
28864 intern_c_string ("invocation-name"),
28865 build_pure_c_string ("@"),
28866 intern_c_string ("system-name")));
28868 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28869 doc
: /* Maximum number of lines to keep in the message log buffer.
28870 If nil, disable message logging. If t, log messages but don't truncate
28871 the buffer when it becomes large. */);
28872 Vmessage_log_max
= make_number (1000);
28874 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28875 doc
: /* Functions called before redisplay, if window sizes have changed.
28876 The value should be a list of functions that take one argument.
28877 Just before redisplay, for each frame, if any of its windows have changed
28878 size since the last redisplay, or have been split or deleted,
28879 all the functions in the list are called, with the frame as argument. */);
28880 Vwindow_size_change_functions
= Qnil
;
28882 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28883 doc
: /* List of functions to call before redisplaying a window with scrolling.
28884 Each function is called with two arguments, the window and its new
28885 display-start position. Note that these functions are also called by
28886 `set-window-buffer'. Also note that the value of `window-end' is not
28887 valid when these functions are called.
28889 Warning: Do not use this feature to alter the way the window
28890 is scrolled. It is not designed for that, and such use probably won't
28892 Vwindow_scroll_functions
= Qnil
;
28894 DEFVAR_LISP ("window-text-change-functions",
28895 Vwindow_text_change_functions
,
28896 doc
: /* Functions to call in redisplay when text in the window might change. */);
28897 Vwindow_text_change_functions
= Qnil
;
28899 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28900 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28901 Each function is called with two arguments, the window and the end trigger value.
28902 See `set-window-redisplay-end-trigger'. */);
28903 Vredisplay_end_trigger_functions
= Qnil
;
28905 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28906 doc
: /* Non-nil means autoselect window with mouse pointer.
28907 If nil, do not autoselect windows.
28908 A positive number means delay autoselection by that many seconds: a
28909 window is autoselected only after the mouse has remained in that
28910 window for the duration of the delay.
28911 A negative number has a similar effect, but causes windows to be
28912 autoselected only after the mouse has stopped moving. \(Because of
28913 the way Emacs compares mouse events, you will occasionally wait twice
28914 that time before the window gets selected.\)
28915 Any other value means to autoselect window instantaneously when the
28916 mouse pointer enters it.
28918 Autoselection selects the minibuffer only if it is active, and never
28919 unselects the minibuffer if it is active.
28921 When customizing this variable make sure that the actual value of
28922 `focus-follows-mouse' matches the behavior of your window manager. */);
28923 Vmouse_autoselect_window
= Qnil
;
28925 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28926 doc
: /* Non-nil means automatically resize tool-bars.
28927 This dynamically changes the tool-bar's height to the minimum height
28928 that is needed to make all tool-bar items visible.
28929 If value is `grow-only', the tool-bar's height is only increased
28930 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28931 Vauto_resize_tool_bars
= Qt
;
28933 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28934 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28935 auto_raise_tool_bar_buttons_p
= 1;
28937 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28938 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28939 make_cursor_line_fully_visible_p
= 1;
28941 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28942 doc
: /* Border below tool-bar in pixels.
28943 If an integer, use it as the height of the border.
28944 If it is one of `internal-border-width' or `border-width', use the
28945 value of the corresponding frame parameter.
28946 Otherwise, no border is added below the tool-bar. */);
28947 Vtool_bar_border
= Qinternal_border_width
;
28949 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28950 doc
: /* Margin around tool-bar buttons in pixels.
28951 If an integer, use that for both horizontal and vertical margins.
28952 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28953 HORZ specifying the horizontal margin, and VERT specifying the
28954 vertical margin. */);
28955 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28957 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28958 doc
: /* Relief thickness of tool-bar buttons. */);
28959 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28961 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28962 doc
: /* Tool bar style to use.
28964 image - show images only
28965 text - show text only
28966 both - show both, text below image
28967 both-horiz - show text to the right of the image
28968 text-image-horiz - show text to the left of the image
28969 any other - use system default or image if no system default.
28971 This variable only affects the GTK+ toolkit version of Emacs. */);
28972 Vtool_bar_style
= Qnil
;
28974 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28975 doc
: /* Maximum number of characters a label can have to be shown.
28976 The tool bar style must also show labels for this to have any effect, see
28977 `tool-bar-style'. */);
28978 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28980 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28981 doc
: /* List of functions to call to fontify regions of text.
28982 Each function is called with one argument POS. Functions must
28983 fontify a region starting at POS in the current buffer, and give
28984 fontified regions the property `fontified'. */);
28985 Vfontification_functions
= Qnil
;
28986 Fmake_variable_buffer_local (Qfontification_functions
);
28988 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28989 unibyte_display_via_language_environment
,
28990 doc
: /* Non-nil means display unibyte text according to language environment.
28991 Specifically, this means that raw bytes in the range 160-255 decimal
28992 are displayed by converting them to the equivalent multibyte characters
28993 according to the current language environment. As a result, they are
28994 displayed according to the current fontset.
28996 Note that this variable affects only how these bytes are displayed,
28997 but does not change the fact they are interpreted as raw bytes. */);
28998 unibyte_display_via_language_environment
= 0;
29000 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
29001 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29002 If a float, it specifies a fraction of the mini-window frame's height.
29003 If an integer, it specifies a number of lines. */);
29004 Vmax_mini_window_height
= make_float (0.25);
29006 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
29007 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
29008 A value of nil means don't automatically resize mini-windows.
29009 A value of t means resize them to fit the text displayed in them.
29010 A value of `grow-only', the default, means let mini-windows grow only;
29011 they return to their normal size when the minibuffer is closed, or the
29012 echo area becomes empty. */);
29013 Vresize_mini_windows
= Qgrow_only
;
29015 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
29016 doc
: /* Alist specifying how to blink the cursor off.
29017 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29018 `cursor-type' frame-parameter or variable equals ON-STATE,
29019 comparing using `equal', Emacs uses OFF-STATE to specify
29020 how to blink it off. ON-STATE and OFF-STATE are values for
29021 the `cursor-type' frame parameter.
29023 If a frame's ON-STATE has no entry in this list,
29024 the frame's other specifications determine how to blink the cursor off. */);
29025 Vblink_cursor_alist
= Qnil
;
29027 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
29028 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
29029 If non-nil, windows are automatically scrolled horizontally to make
29030 point visible. */);
29031 automatic_hscrolling_p
= 1;
29032 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
29034 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
29035 doc
: /* How many columns away from the window edge point is allowed to get
29036 before automatic hscrolling will horizontally scroll the window. */);
29037 hscroll_margin
= 5;
29039 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
29040 doc
: /* How many columns to scroll the window when point gets too close to the edge.
29041 When point is less than `hscroll-margin' columns from the window
29042 edge, automatic hscrolling will scroll the window by the amount of columns
29043 determined by this variable. If its value is a positive integer, scroll that
29044 many columns. If it's a positive floating-point number, it specifies the
29045 fraction of the window's width to scroll. If it's nil or zero, point will be
29046 centered horizontally after the scroll. Any other value, including negative
29047 numbers, are treated as if the value were zero.
29049 Automatic hscrolling always moves point outside the scroll margin, so if
29050 point was more than scroll step columns inside the margin, the window will
29051 scroll more than the value given by the scroll step.
29053 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29054 and `scroll-right' overrides this variable's effect. */);
29055 Vhscroll_step
= make_number (0);
29057 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
29058 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
29059 Bind this around calls to `message' to let it take effect. */);
29060 message_truncate_lines
= 0;
29062 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
29063 doc
: /* Normal hook run to update the menu bar definitions.
29064 Redisplay runs this hook before it redisplays the menu bar.
29065 This is used to update submenus such as Buffers,
29066 whose contents depend on various data. */);
29067 Vmenu_bar_update_hook
= Qnil
;
29069 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
29070 doc
: /* Frame for which we are updating a menu.
29071 The enable predicate for a menu binding should check this variable. */);
29072 Vmenu_updating_frame
= Qnil
;
29074 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
29075 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
29076 inhibit_menubar_update
= 0;
29078 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
29079 doc
: /* Prefix prepended to all continuation lines at display time.
29080 The value may be a string, an image, or a stretch-glyph; it is
29081 interpreted in the same way as the value of a `display' text property.
29083 This variable is overridden by any `wrap-prefix' text or overlay
29086 To add a prefix to non-continuation lines, use `line-prefix'. */);
29087 Vwrap_prefix
= Qnil
;
29088 DEFSYM (Qwrap_prefix
, "wrap-prefix");
29089 Fmake_variable_buffer_local (Qwrap_prefix
);
29091 DEFVAR_LISP ("line-prefix", Vline_prefix
,
29092 doc
: /* Prefix prepended to all non-continuation lines at display time.
29093 The value may be a string, an image, or a stretch-glyph; it is
29094 interpreted in the same way as the value of a `display' text property.
29096 This variable is overridden by any `line-prefix' text or overlay
29099 To add a prefix to continuation lines, use `wrap-prefix'. */);
29100 Vline_prefix
= Qnil
;
29101 DEFSYM (Qline_prefix
, "line-prefix");
29102 Fmake_variable_buffer_local (Qline_prefix
);
29104 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
29105 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
29106 inhibit_eval_during_redisplay
= 0;
29108 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
29109 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
29110 inhibit_free_realized_faces
= 0;
29113 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
29114 doc
: /* Inhibit try_window_id display optimization. */);
29115 inhibit_try_window_id
= 0;
29117 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
29118 doc
: /* Inhibit try_window_reusing display optimization. */);
29119 inhibit_try_window_reusing
= 0;
29121 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
29122 doc
: /* Inhibit try_cursor_movement display optimization. */);
29123 inhibit_try_cursor_movement
= 0;
29124 #endif /* GLYPH_DEBUG */
29126 DEFVAR_INT ("overline-margin", overline_margin
,
29127 doc
: /* Space between overline and text, in pixels.
29128 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29129 margin to the character height. */);
29130 overline_margin
= 2;
29132 DEFVAR_INT ("underline-minimum-offset",
29133 underline_minimum_offset
,
29134 doc
: /* Minimum distance between baseline and underline.
29135 This can improve legibility of underlined text at small font sizes,
29136 particularly when using variable `x-use-underline-position-properties'
29137 with fonts that specify an UNDERLINE_POSITION relatively close to the
29138 baseline. The default value is 1. */);
29139 underline_minimum_offset
= 1;
29141 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
29142 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29143 This feature only works when on a window system that can change
29144 cursor shapes. */);
29145 display_hourglass_p
= 1;
29147 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
29148 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29149 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
29151 hourglass_atimer
= NULL
;
29152 hourglass_shown_p
= 0;
29154 DEFSYM (Qglyphless_char
, "glyphless-char");
29155 DEFSYM (Qhex_code
, "hex-code");
29156 DEFSYM (Qempty_box
, "empty-box");
29157 DEFSYM (Qthin_space
, "thin-space");
29158 DEFSYM (Qzero_width
, "zero-width");
29160 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
29161 /* Intern this now in case it isn't already done.
29162 Setting this variable twice is harmless.
29163 But don't staticpro it here--that is done in alloc.c. */
29164 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
29165 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
29167 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
29168 doc
: /* Char-table defining glyphless characters.
29169 Each element, if non-nil, should be one of the following:
29170 an ASCII acronym string: display this string in a box
29171 `hex-code': display the hexadecimal code of a character in a box
29172 `empty-box': display as an empty box
29173 `thin-space': display as 1-pixel width space
29174 `zero-width': don't display
29175 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29176 display method for graphical terminals and text terminals respectively.
29177 GRAPHICAL and TEXT should each have one of the values listed above.
29179 The char-table has one extra slot to control the display of a character for
29180 which no font is found. This slot only takes effect on graphical terminals.
29181 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29182 `thin-space'. The default is `empty-box'. */);
29183 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29184 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29187 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
29188 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
29189 Vdebug_on_message
= Qnil
;
29193 /* Initialize this module when Emacs starts. */
29198 current_header_line_height
= current_mode_line_height
= -1;
29200 CHARPOS (this_line_start_pos
) = 0;
29202 if (!noninteractive
)
29204 struct window
*m
= XWINDOW (minibuf_window
);
29205 Lisp_Object frame
= m
->frame
;
29206 struct frame
*f
= XFRAME (frame
);
29207 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29208 struct window
*r
= XWINDOW (root
);
29211 echo_area_window
= minibuf_window
;
29213 r
->top_line
= FRAME_TOP_MARGIN (f
);
29214 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
29215 r
->total_cols
= FRAME_COLS (f
);
29217 m
->top_line
= FRAME_LINES (f
) - 1;
29218 m
->total_lines
= 1;
29219 m
->total_cols
= FRAME_COLS (f
);
29221 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29222 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29223 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29225 /* The default ellipsis glyphs `...'. */
29226 for (i
= 0; i
< 3; ++i
)
29227 default_invis_vector
[i
] = make_number ('.');
29231 /* Allocate the buffer for frame titles.
29232 Also used for `format-mode-line'. */
29234 mode_line_noprop_buf
= xmalloc (size
);
29235 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29236 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29237 mode_line_target
= MODE_LINE_DISPLAY
;
29240 help_echo_showing_p
= 0;
29243 /* Platform-independent portion of hourglass implementation. */
29245 /* Cancel a currently active hourglass timer, and start a new one. */
29247 start_hourglass (void)
29249 #if defined (HAVE_WINDOW_SYSTEM)
29252 cancel_hourglass ();
29254 if (INTEGERP (Vhourglass_delay
)
29255 && XINT (Vhourglass_delay
) > 0)
29256 delay
= make_emacs_time (min (XINT (Vhourglass_delay
),
29257 TYPE_MAXIMUM (time_t)),
29259 else if (FLOATP (Vhourglass_delay
)
29260 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29261 delay
= EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (Vhourglass_delay
));
29263 delay
= make_emacs_time (DEFAULT_HOURGLASS_DELAY
, 0);
29267 extern void w32_note_current_window (void);
29268 w32_note_current_window ();
29270 #endif /* HAVE_NTGUI */
29272 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29273 show_hourglass
, NULL
);
29278 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29281 cancel_hourglass (void)
29283 #if defined (HAVE_WINDOW_SYSTEM)
29284 if (hourglass_atimer
)
29286 cancel_atimer (hourglass_atimer
);
29287 hourglass_atimer
= NULL
;
29290 if (hourglass_shown_p
)