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_max_ascent
, 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
= XFASTINT (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
->buffer
) != current_buffer
)
1288 old_buffer
= current_buffer
;
1289 set_buffer_internal_1 (XBUFFER (w
->buffer
));
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
2553 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
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 IT_CHARPOS (*it
) = charpos
;
2833 /* We will rely on `reseat' to set this up properly, via
2834 handle_face_prop. */
2835 it
->face_id
= it
->base_face_id
;
2837 /* Compute byte position if not specified. */
2838 if (bytepos
< charpos
)
2839 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2841 IT_BYTEPOS (*it
) = bytepos
;
2843 it
->start
= it
->current
;
2844 /* Do we need to reorder bidirectional text? Not if this is a
2845 unibyte buffer: by definition, none of the single-byte
2846 characters are strong R2L, so no reordering is needed. And
2847 bidi.c doesn't support unibyte buffers anyway. Also, don't
2848 reorder while we are loading loadup.el, since the tables of
2849 character properties needed for reordering are not yet
2853 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2856 /* If we are to reorder bidirectional text, init the bidi
2860 /* Note the paragraph direction that this buffer wants to
2862 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2864 it
->paragraph_embedding
= L2R
;
2865 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2867 it
->paragraph_embedding
= R2L
;
2869 it
->paragraph_embedding
= NEUTRAL_DIR
;
2870 bidi_unshelve_cache (NULL
, 0);
2871 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2875 /* Compute faces etc. */
2876 reseat (it
, it
->current
.pos
, 1);
2883 /* Initialize IT for the display of window W with window start POS. */
2886 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2888 struct glyph_row
*row
;
2889 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2891 row
= w
->desired_matrix
->rows
+ first_vpos
;
2892 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2893 it
->first_vpos
= first_vpos
;
2895 /* Don't reseat to previous visible line start if current start
2896 position is in a string or image. */
2897 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2899 int start_at_line_beg_p
;
2900 int first_y
= it
->current_y
;
2902 /* If window start is not at a line start, skip forward to POS to
2903 get the correct continuation lines width. */
2904 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2905 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2906 if (!start_at_line_beg_p
)
2910 reseat_at_previous_visible_line_start (it
);
2911 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2913 new_x
= it
->current_x
+ it
->pixel_width
;
2915 /* If lines are continued, this line may end in the middle
2916 of a multi-glyph character (e.g. a control character
2917 displayed as \003, or in the middle of an overlay
2918 string). In this case move_it_to above will not have
2919 taken us to the start of the continuation line but to the
2920 end of the continued line. */
2921 if (it
->current_x
> 0
2922 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2923 && (/* And glyph doesn't fit on the line. */
2924 new_x
> it
->last_visible_x
2925 /* Or it fits exactly and we're on a window
2927 || (new_x
== it
->last_visible_x
2928 && FRAME_WINDOW_P (it
->f
)
2929 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2930 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2931 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2933 if ((it
->current
.dpvec_index
>= 0
2934 || it
->current
.overlay_string_index
>= 0)
2935 /* If we are on a newline from a display vector or
2936 overlay string, then we are already at the end of
2937 a screen line; no need to go to the next line in
2938 that case, as this line is not really continued.
2939 (If we do go to the next line, C-e will not DTRT.) */
2942 set_iterator_to_next (it
, 1);
2943 move_it_in_display_line_to (it
, -1, -1, 0);
2946 it
->continuation_lines_width
+= it
->current_x
;
2948 /* If the character at POS is displayed via a display
2949 vector, move_it_to above stops at the final glyph of
2950 IT->dpvec. To make the caller redisplay that character
2951 again (a.k.a. start at POS), we need to reset the
2952 dpvec_index to the beginning of IT->dpvec. */
2953 else if (it
->current
.dpvec_index
>= 0)
2954 it
->current
.dpvec_index
= 0;
2956 /* We're starting a new display line, not affected by the
2957 height of the continued line, so clear the appropriate
2958 fields in the iterator structure. */
2959 it
->max_ascent
= it
->max_descent
= 0;
2960 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2962 it
->current_y
= first_y
;
2964 it
->current_x
= it
->hpos
= 0;
2970 /* Return 1 if POS is a position in ellipses displayed for invisible
2971 text. W is the window we display, for text property lookup. */
2974 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2976 Lisp_Object prop
, window
;
2978 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
2980 /* If POS specifies a position in a display vector, this might
2981 be for an ellipsis displayed for invisible text. We won't
2982 get the iterator set up for delivering that ellipsis unless
2983 we make sure that it gets aware of the invisible text. */
2984 if (pos
->dpvec_index
>= 0
2985 && pos
->overlay_string_index
< 0
2986 && CHARPOS (pos
->string_pos
) < 0
2988 && (XSETWINDOW (window
, w
),
2989 prop
= Fget_char_property (make_number (charpos
),
2990 Qinvisible
, window
),
2991 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2993 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2995 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3002 /* Initialize IT for stepping through current_buffer in window W,
3003 starting at position POS that includes overlay string and display
3004 vector/ control character translation position information. Value
3005 is zero if there are overlay strings with newlines at POS. */
3008 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3010 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3011 int i
, overlay_strings_with_newlines
= 0;
3013 /* If POS specifies a position in a display vector, this might
3014 be for an ellipsis displayed for invisible text. We won't
3015 get the iterator set up for delivering that ellipsis unless
3016 we make sure that it gets aware of the invisible text. */
3017 if (in_ellipses_for_invisible_text_p (pos
, w
))
3023 /* Keep in mind: the call to reseat in init_iterator skips invisible
3024 text, so we might end up at a position different from POS. This
3025 is only a problem when POS is a row start after a newline and an
3026 overlay starts there with an after-string, and the overlay has an
3027 invisible property. Since we don't skip invisible text in
3028 display_line and elsewhere immediately after consuming the
3029 newline before the row start, such a POS will not be in a string,
3030 but the call to init_iterator below will move us to the
3032 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3034 /* This only scans the current chunk -- it should scan all chunks.
3035 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3036 to 16 in 22.1 to make this a lesser problem. */
3037 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3039 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3040 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3042 while (s
< e
&& *s
!= '\n')
3047 overlay_strings_with_newlines
= 1;
3052 /* If position is within an overlay string, set up IT to the right
3054 if (pos
->overlay_string_index
>= 0)
3058 /* If the first overlay string happens to have a `display'
3059 property for an image, the iterator will be set up for that
3060 image, and we have to undo that setup first before we can
3061 correct the overlay string index. */
3062 if (it
->method
== GET_FROM_IMAGE
)
3065 /* We already have the first chunk of overlay strings in
3066 IT->overlay_strings. Load more until the one for
3067 pos->overlay_string_index is in IT->overlay_strings. */
3068 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3070 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3071 it
->current
.overlay_string_index
= 0;
3074 load_overlay_strings (it
, 0);
3075 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3079 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3080 relative_index
= (it
->current
.overlay_string_index
3081 % OVERLAY_STRING_CHUNK_SIZE
);
3082 it
->string
= it
->overlay_strings
[relative_index
];
3083 eassert (STRINGP (it
->string
));
3084 it
->current
.string_pos
= pos
->string_pos
;
3085 it
->method
= GET_FROM_STRING
;
3086 it
->end_charpos
= SCHARS (it
->string
);
3087 /* Set up the bidi iterator for this overlay string. */
3090 it
->bidi_it
.string
.lstring
= it
->string
;
3091 it
->bidi_it
.string
.s
= NULL
;
3092 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3093 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3094 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3095 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3096 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3097 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3099 /* Synchronize the state of the bidi iterator with
3100 pos->string_pos. For any string position other than
3101 zero, this will be done automagically when we resume
3102 iteration over the string and get_visually_first_element
3103 is called. But if string_pos is zero, and the string is
3104 to be reordered for display, we need to resync manually,
3105 since it could be that the iteration state recorded in
3106 pos ended at string_pos of 0 moving backwards in string. */
3107 if (CHARPOS (pos
->string_pos
) == 0)
3109 get_visually_first_element (it
);
3110 if (IT_STRING_CHARPOS (*it
) != 0)
3113 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3114 bidi_move_to_visually_next (&it
->bidi_it
);
3115 } while (it
->bidi_it
.charpos
!= 0);
3117 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3118 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3122 if (CHARPOS (pos
->string_pos
) >= 0)
3124 /* Recorded position is not in an overlay string, but in another
3125 string. This can only be a string from a `display' property.
3126 IT should already be filled with that string. */
3127 it
->current
.string_pos
= pos
->string_pos
;
3128 eassert (STRINGP (it
->string
));
3130 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3131 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3134 /* Restore position in display vector translations, control
3135 character translations or ellipses. */
3136 if (pos
->dpvec_index
>= 0)
3138 if (it
->dpvec
== NULL
)
3139 get_next_display_element (it
);
3140 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3141 it
->current
.dpvec_index
= pos
->dpvec_index
;
3145 return !overlay_strings_with_newlines
;
3149 /* Initialize IT for stepping through current_buffer in window W
3150 starting at ROW->start. */
3153 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3155 init_from_display_pos (it
, w
, &row
->start
);
3156 it
->start
= row
->start
;
3157 it
->continuation_lines_width
= row
->continuation_lines_width
;
3162 /* Initialize IT for stepping through current_buffer in window W
3163 starting in the line following ROW, i.e. starting at ROW->end.
3164 Value is zero if there are overlay strings with newlines at ROW's
3168 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3172 if (init_from_display_pos (it
, w
, &row
->end
))
3174 if (row
->continued_p
)
3175 it
->continuation_lines_width
3176 = row
->continuation_lines_width
+ row
->pixel_width
;
3187 /***********************************************************************
3189 ***********************************************************************/
3191 /* Called when IT reaches IT->stop_charpos. Handle text property and
3192 overlay changes. Set IT->stop_charpos to the next position where
3196 handle_stop (struct it
*it
)
3198 enum prop_handled handled
;
3199 int handle_overlay_change_p
;
3203 it
->current
.dpvec_index
= -1;
3204 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3205 it
->ignore_overlay_strings_at_pos_p
= 0;
3208 /* Use face of preceding text for ellipsis (if invisible) */
3209 if (it
->selective_display_ellipsis_p
)
3210 it
->saved_face_id
= it
->face_id
;
3214 handled
= HANDLED_NORMALLY
;
3216 /* Call text property handlers. */
3217 for (p
= it_props
; p
->handler
; ++p
)
3219 handled
= p
->handler (it
);
3221 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3223 else if (handled
== HANDLED_RETURN
)
3225 /* We still want to show before and after strings from
3226 overlays even if the actual buffer text is replaced. */
3227 if (!handle_overlay_change_p
3229 /* Don't call get_overlay_strings_1 if we already
3230 have overlay strings loaded, because doing so
3231 will load them again and push the iterator state
3232 onto the stack one more time, which is not
3233 expected by the rest of the code that processes
3235 || (it
->current
.overlay_string_index
< 0
3236 ? !get_overlay_strings_1 (it
, 0, 0)
3240 setup_for_ellipsis (it
, 0);
3241 /* When handling a display spec, we might load an
3242 empty string. In that case, discard it here. We
3243 used to discard it in handle_single_display_spec,
3244 but that causes get_overlay_strings_1, above, to
3245 ignore overlay strings that we must check. */
3246 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3250 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3254 it
->ignore_overlay_strings_at_pos_p
= 1;
3255 it
->string_from_display_prop_p
= 0;
3256 it
->from_disp_prop_p
= 0;
3257 handle_overlay_change_p
= 0;
3259 handled
= HANDLED_RECOMPUTE_PROPS
;
3262 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3263 handle_overlay_change_p
= 0;
3266 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3268 /* Don't check for overlay strings below when set to deliver
3269 characters from a display vector. */
3270 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3271 handle_overlay_change_p
= 0;
3273 /* Handle overlay changes.
3274 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3275 if it finds overlays. */
3276 if (handle_overlay_change_p
)
3277 handled
= handle_overlay_change (it
);
3282 setup_for_ellipsis (it
, 0);
3286 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3288 /* Determine where to stop next. */
3289 if (handled
== HANDLED_NORMALLY
)
3290 compute_stop_pos (it
);
3294 /* Compute IT->stop_charpos from text property and overlay change
3295 information for IT's current position. */
3298 compute_stop_pos (struct it
*it
)
3300 register INTERVAL iv
, next_iv
;
3301 Lisp_Object object
, limit
, position
;
3302 ptrdiff_t charpos
, bytepos
;
3304 if (STRINGP (it
->string
))
3306 /* Strings are usually short, so don't limit the search for
3308 it
->stop_charpos
= it
->end_charpos
;
3309 object
= it
->string
;
3311 charpos
= IT_STRING_CHARPOS (*it
);
3312 bytepos
= IT_STRING_BYTEPOS (*it
);
3318 /* If end_charpos is out of range for some reason, such as a
3319 misbehaving display function, rationalize it (Bug#5984). */
3320 if (it
->end_charpos
> ZV
)
3321 it
->end_charpos
= ZV
;
3322 it
->stop_charpos
= it
->end_charpos
;
3324 /* If next overlay change is in front of the current stop pos
3325 (which is IT->end_charpos), stop there. Note: value of
3326 next_overlay_change is point-max if no overlay change
3328 charpos
= IT_CHARPOS (*it
);
3329 bytepos
= IT_BYTEPOS (*it
);
3330 pos
= next_overlay_change (charpos
);
3331 if (pos
< it
->stop_charpos
)
3332 it
->stop_charpos
= pos
;
3334 /* If showing the region, we have to stop at the region
3335 start or end because the face might change there. */
3336 if (it
->region_beg_charpos
> 0)
3338 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3339 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3340 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3341 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3344 /* Set up variables for computing the stop position from text
3345 property changes. */
3346 XSETBUFFER (object
, current_buffer
);
3347 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3350 /* Get the interval containing IT's position. Value is a null
3351 interval if there isn't such an interval. */
3352 position
= make_number (charpos
);
3353 iv
= validate_interval_range (object
, &position
, &position
, 0);
3356 Lisp_Object values_here
[LAST_PROP_IDX
];
3359 /* Get properties here. */
3360 for (p
= it_props
; p
->handler
; ++p
)
3361 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3363 /* Look for an interval following iv that has different
3365 for (next_iv
= next_interval (iv
);
3368 || XFASTINT (limit
) > next_iv
->position
));
3369 next_iv
= next_interval (next_iv
))
3371 for (p
= it_props
; p
->handler
; ++p
)
3373 Lisp_Object new_value
;
3375 new_value
= textget (next_iv
->plist
, *p
->name
);
3376 if (!EQ (values_here
[p
->idx
], new_value
))
3386 if (INTEGERP (limit
)
3387 && next_iv
->position
>= XFASTINT (limit
))
3388 /* No text property change up to limit. */
3389 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3391 /* Text properties change in next_iv. */
3392 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3396 if (it
->cmp_it
.id
< 0)
3398 ptrdiff_t stoppos
= it
->end_charpos
;
3400 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3402 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3403 stoppos
, it
->string
);
3406 eassert (STRINGP (it
->string
)
3407 || (it
->stop_charpos
>= BEGV
3408 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3412 /* Return the position of the next overlay change after POS in
3413 current_buffer. Value is point-max if no overlay change
3414 follows. This is like `next-overlay-change' but doesn't use
3418 next_overlay_change (ptrdiff_t pos
)
3420 ptrdiff_t i
, noverlays
;
3422 Lisp_Object
*overlays
;
3424 /* Get all overlays at the given position. */
3425 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3427 /* If any of these overlays ends before endpos,
3428 use its ending point instead. */
3429 for (i
= 0; i
< noverlays
; ++i
)
3434 oend
= OVERLAY_END (overlays
[i
]);
3435 oendpos
= OVERLAY_POSITION (oend
);
3436 endpos
= min (endpos
, oendpos
);
3442 /* How many characters forward to search for a display property or
3443 display string. Searching too far forward makes the bidi display
3444 sluggish, especially in small windows. */
3445 #define MAX_DISP_SCAN 250
3447 /* Return the character position of a display string at or after
3448 position specified by POSITION. If no display string exists at or
3449 after POSITION, return ZV. A display string is either an overlay
3450 with `display' property whose value is a string, or a `display'
3451 text property whose value is a string. STRING is data about the
3452 string to iterate; if STRING->lstring is nil, we are iterating a
3453 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3454 on a GUI frame. DISP_PROP is set to zero if we searched
3455 MAX_DISP_SCAN characters forward without finding any display
3456 strings, non-zero otherwise. It is set to 2 if the display string
3457 uses any kind of `(space ...)' spec that will produce a stretch of
3458 white space in the text area. */
3460 compute_display_string_pos (struct text_pos
*position
,
3461 struct bidi_string_data
*string
,
3462 int frame_window_p
, int *disp_prop
)
3464 /* OBJECT = nil means current buffer. */
3465 Lisp_Object object
=
3466 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3467 Lisp_Object pos
, spec
, limpos
;
3468 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3469 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3470 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3471 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3473 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3474 struct text_pos tpos
;
3480 /* We don't support display properties whose values are strings
3481 that have display string properties. */
3482 || string
->from_disp_str
3483 /* C strings cannot have display properties. */
3484 || (string
->s
&& !STRINGP (object
)))
3490 /* If the character at CHARPOS is where the display string begins,
3492 pos
= make_number (charpos
);
3493 if (STRINGP (object
))
3494 bufpos
= string
->bufpos
;
3498 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3500 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3503 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3511 /* Look forward for the first character with a `display' property
3512 that will replace the underlying text when displayed. */
3513 limpos
= make_number (lim
);
3515 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3516 CHARPOS (tpos
) = XFASTINT (pos
);
3517 if (CHARPOS (tpos
) >= lim
)
3522 if (STRINGP (object
))
3523 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3525 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3526 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3527 if (!STRINGP (object
))
3528 bufpos
= CHARPOS (tpos
);
3529 } while (NILP (spec
)
3530 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3531 bufpos
, frame_window_p
)));
3535 return CHARPOS (tpos
);
3538 /* Return the character position of the end of the display string that
3539 started at CHARPOS. If there's no display string at CHARPOS,
3540 return -1. A display string is either an overlay with `display'
3541 property whose value is a string or a `display' text property whose
3542 value is a string. */
3544 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3546 /* OBJECT = nil means current buffer. */
3547 Lisp_Object object
=
3548 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3549 Lisp_Object pos
= make_number (charpos
);
3551 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3553 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3556 /* It could happen that the display property or overlay was removed
3557 since we found it in compute_display_string_pos above. One way
3558 this can happen is if JIT font-lock was called (through
3559 handle_fontified_prop), and jit-lock-functions remove text
3560 properties or overlays from the portion of buffer that includes
3561 CHARPOS. Muse mode is known to do that, for example. In this
3562 case, we return -1 to the caller, to signal that no display
3563 string is actually present at CHARPOS. See bidi_fetch_char for
3564 how this is handled.
3566 An alternative would be to never look for display properties past
3567 it->stop_charpos. But neither compute_display_string_pos nor
3568 bidi_fetch_char that calls it know or care where the next
3570 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3573 /* Look forward for the first character where the `display' property
3575 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3577 return XFASTINT (pos
);
3582 /***********************************************************************
3584 ***********************************************************************/
3586 /* Handle changes in the `fontified' property of the current buffer by
3587 calling hook functions from Qfontification_functions to fontify
3590 static enum prop_handled
3591 handle_fontified_prop (struct it
*it
)
3593 Lisp_Object prop
, pos
;
3594 enum prop_handled handled
= HANDLED_NORMALLY
;
3596 if (!NILP (Vmemory_full
))
3599 /* Get the value of the `fontified' property at IT's current buffer
3600 position. (The `fontified' property doesn't have a special
3601 meaning in strings.) If the value is nil, call functions from
3602 Qfontification_functions. */
3603 if (!STRINGP (it
->string
)
3605 && !NILP (Vfontification_functions
)
3606 && !NILP (Vrun_hooks
)
3607 && (pos
= make_number (IT_CHARPOS (*it
)),
3608 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3609 /* Ignore the special cased nil value always present at EOB since
3610 no amount of fontifying will be able to change it. */
3611 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3613 ptrdiff_t count
= SPECPDL_INDEX ();
3615 struct buffer
*obuf
= current_buffer
;
3616 int begv
= BEGV
, zv
= ZV
;
3617 int old_clip_changed
= current_buffer
->clip_changed
;
3619 val
= Vfontification_functions
;
3620 specbind (Qfontification_functions
, Qnil
);
3622 eassert (it
->end_charpos
== ZV
);
3624 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3625 safe_call1 (val
, pos
);
3628 Lisp_Object fns
, fn
;
3629 struct gcpro gcpro1
, gcpro2
;
3634 for (; CONSP (val
); val
= XCDR (val
))
3640 /* A value of t indicates this hook has a local
3641 binding; it means to run the global binding too.
3642 In a global value, t should not occur. If it
3643 does, we must ignore it to avoid an endless
3645 for (fns
= Fdefault_value (Qfontification_functions
);
3651 safe_call1 (fn
, pos
);
3655 safe_call1 (fn
, pos
);
3661 unbind_to (count
, Qnil
);
3663 /* Fontification functions routinely call `save-restriction'.
3664 Normally, this tags clip_changed, which can confuse redisplay
3665 (see discussion in Bug#6671). Since we don't perform any
3666 special handling of fontification changes in the case where
3667 `save-restriction' isn't called, there's no point doing so in
3668 this case either. So, if the buffer's restrictions are
3669 actually left unchanged, reset clip_changed. */
3670 if (obuf
== current_buffer
)
3672 if (begv
== BEGV
&& zv
== ZV
)
3673 current_buffer
->clip_changed
= old_clip_changed
;
3675 /* There isn't much we can reasonably do to protect against
3676 misbehaving fontification, but here's a fig leaf. */
3677 else if (BUFFER_LIVE_P (obuf
))
3678 set_buffer_internal_1 (obuf
);
3680 /* The fontification code may have added/removed text.
3681 It could do even a lot worse, but let's at least protect against
3682 the most obvious case where only the text past `pos' gets changed',
3683 as is/was done in grep.el where some escapes sequences are turned
3684 into face properties (bug#7876). */
3685 it
->end_charpos
= ZV
;
3687 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3688 something. This avoids an endless loop if they failed to
3689 fontify the text for which reason ever. */
3690 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3691 handled
= HANDLED_RECOMPUTE_PROPS
;
3699 /***********************************************************************
3701 ***********************************************************************/
3703 /* Set up iterator IT from face properties at its current position.
3704 Called from handle_stop. */
3706 static enum prop_handled
3707 handle_face_prop (struct it
*it
)
3710 ptrdiff_t next_stop
;
3712 if (!STRINGP (it
->string
))
3715 = face_at_buffer_position (it
->w
,
3717 it
->region_beg_charpos
,
3718 it
->region_end_charpos
,
3721 + TEXT_PROP_DISTANCE_LIMIT
),
3722 0, it
->base_face_id
);
3724 /* Is this a start of a run of characters with box face?
3725 Caveat: this can be called for a freshly initialized
3726 iterator; face_id is -1 in this case. We know that the new
3727 face will not change until limit, i.e. if the new face has a
3728 box, all characters up to limit will have one. But, as
3729 usual, we don't know whether limit is really the end. */
3730 if (new_face_id
!= it
->face_id
)
3732 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3733 /* If it->face_id is -1, old_face below will be NULL, see
3734 the definition of FACE_FROM_ID. This will happen if this
3735 is the initial call that gets the face. */
3736 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3738 /* If the value of face_id of the iterator is -1, we have to
3739 look in front of IT's position and see whether there is a
3740 face there that's different from new_face_id. */
3741 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3743 int prev_face_id
= face_before_it_pos (it
);
3745 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3748 /* If the new face has a box, but the old face does not,
3749 this is the start of a run of characters with box face,
3750 i.e. this character has a shadow on the left side. */
3751 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3752 && (old_face
== NULL
|| !old_face
->box
));
3753 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3761 Lisp_Object from_overlay
3762 = (it
->current
.overlay_string_index
>= 0
3763 ? it
->string_overlays
[it
->current
.overlay_string_index
3764 % OVERLAY_STRING_CHUNK_SIZE
]
3767 /* See if we got to this string directly or indirectly from
3768 an overlay property. That includes the before-string or
3769 after-string of an overlay, strings in display properties
3770 provided by an overlay, their text properties, etc.
3772 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3773 if (! NILP (from_overlay
))
3774 for (i
= it
->sp
- 1; i
>= 0; i
--)
3776 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3778 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3779 % OVERLAY_STRING_CHUNK_SIZE
];
3780 else if (! NILP (it
->stack
[i
].from_overlay
))
3781 from_overlay
= it
->stack
[i
].from_overlay
;
3783 if (!NILP (from_overlay
))
3787 if (! NILP (from_overlay
))
3789 bufpos
= IT_CHARPOS (*it
);
3790 /* For a string from an overlay, the base face depends
3791 only on text properties and ignores overlays. */
3793 = face_for_overlay_string (it
->w
,
3795 it
->region_beg_charpos
,
3796 it
->region_end_charpos
,
3799 + TEXT_PROP_DISTANCE_LIMIT
),
3807 /* For strings from a `display' property, use the face at
3808 IT's current buffer position as the base face to merge
3809 with, so that overlay strings appear in the same face as
3810 surrounding text, unless they specify their own
3812 base_face_id
= it
->string_from_prefix_prop_p
3814 : underlying_face_id (it
);
3817 new_face_id
= face_at_string_position (it
->w
,
3819 IT_STRING_CHARPOS (*it
),
3821 it
->region_beg_charpos
,
3822 it
->region_end_charpos
,
3826 /* Is this a start of a run of characters with box? Caveat:
3827 this can be called for a freshly allocated iterator; face_id
3828 is -1 is this case. We know that the new face will not
3829 change until the next check pos, i.e. if the new face has a
3830 box, all characters up to that position will have a
3831 box. But, as usual, we don't know whether that position
3832 is really the end. */
3833 if (new_face_id
!= it
->face_id
)
3835 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3836 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3838 /* If new face has a box but old face hasn't, this is the
3839 start of a run of characters with box, i.e. it has a
3840 shadow on the left side. */
3841 it
->start_of_box_run_p
3842 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3843 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3847 it
->face_id
= new_face_id
;
3848 return HANDLED_NORMALLY
;
3852 /* Return the ID of the face ``underlying'' IT's current position,
3853 which is in a string. If the iterator is associated with a
3854 buffer, return the face at IT's current buffer position.
3855 Otherwise, use the iterator's base_face_id. */
3858 underlying_face_id (struct it
*it
)
3860 int face_id
= it
->base_face_id
, i
;
3862 eassert (STRINGP (it
->string
));
3864 for (i
= it
->sp
- 1; i
>= 0; --i
)
3865 if (NILP (it
->stack
[i
].string
))
3866 face_id
= it
->stack
[i
].face_id
;
3872 /* Compute the face one character before or after the current position
3873 of IT, in the visual order. BEFORE_P non-zero means get the face
3874 in front (to the left in L2R paragraphs, to the right in R2L
3875 paragraphs) of IT's screen position. Value is the ID of the face. */
3878 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3881 ptrdiff_t next_check_charpos
;
3883 void *it_copy_data
= NULL
;
3885 eassert (it
->s
== NULL
);
3887 if (STRINGP (it
->string
))
3889 ptrdiff_t bufpos
, charpos
;
3892 /* No face change past the end of the string (for the case
3893 we are padding with spaces). No face change before the
3895 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3896 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3901 /* Set charpos to the position before or after IT's current
3902 position, in the logical order, which in the non-bidi
3903 case is the same as the visual order. */
3905 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3906 else if (it
->what
== IT_COMPOSITION
)
3907 /* For composition, we must check the character after the
3909 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3911 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3917 /* With bidi iteration, the character before the current
3918 in the visual order cannot be found by simple
3919 iteration, because "reverse" reordering is not
3920 supported. Instead, we need to use the move_it_*
3921 family of functions. */
3922 /* Ignore face changes before the first visible
3923 character on this display line. */
3924 if (it
->current_x
<= it
->first_visible_x
)
3926 SAVE_IT (it_copy
, *it
, it_copy_data
);
3927 /* Implementation note: Since move_it_in_display_line
3928 works in the iterator geometry, and thinks the first
3929 character is always the leftmost, even in R2L lines,
3930 we don't need to distinguish between the R2L and L2R
3932 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3933 it_copy
.current_x
- 1, MOVE_TO_X
);
3934 charpos
= IT_STRING_CHARPOS (it_copy
);
3935 RESTORE_IT (it
, it
, it_copy_data
);
3939 /* Set charpos to the string position of the character
3940 that comes after IT's current position in the visual
3942 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3946 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3948 charpos
= it_copy
.bidi_it
.charpos
;
3951 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3953 if (it
->current
.overlay_string_index
>= 0)
3954 bufpos
= IT_CHARPOS (*it
);
3958 base_face_id
= underlying_face_id (it
);
3960 /* Get the face for ASCII, or unibyte. */
3961 face_id
= face_at_string_position (it
->w
,
3965 it
->region_beg_charpos
,
3966 it
->region_end_charpos
,
3967 &next_check_charpos
,
3970 /* Correct the face for charsets different from ASCII. Do it
3971 for the multibyte case only. The face returned above is
3972 suitable for unibyte text if IT->string is unibyte. */
3973 if (STRING_MULTIBYTE (it
->string
))
3975 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3976 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3978 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3980 c
= string_char_and_length (p
, &len
);
3981 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3986 struct text_pos pos
;
3988 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3989 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3992 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3993 pos
= it
->current
.pos
;
3998 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4001 if (it
->what
== IT_COMPOSITION
)
4003 /* For composition, we must check the position after
4005 pos
.charpos
+= it
->cmp_it
.nchars
;
4006 pos
.bytepos
+= it
->len
;
4009 INC_TEXT_POS (pos
, it
->multibyte_p
);
4016 /* With bidi iteration, the character before the current
4017 in the visual order cannot be found by simple
4018 iteration, because "reverse" reordering is not
4019 supported. Instead, we need to use the move_it_*
4020 family of functions. */
4021 /* Ignore face changes before the first visible
4022 character on this display line. */
4023 if (it
->current_x
<= it
->first_visible_x
)
4025 SAVE_IT (it_copy
, *it
, it_copy_data
);
4026 /* Implementation note: Since move_it_in_display_line
4027 works in the iterator geometry, and thinks the first
4028 character is always the leftmost, even in R2L lines,
4029 we don't need to distinguish between the R2L and L2R
4031 move_it_in_display_line (&it_copy
, ZV
,
4032 it_copy
.current_x
- 1, MOVE_TO_X
);
4033 pos
= it_copy
.current
.pos
;
4034 RESTORE_IT (it
, it
, it_copy_data
);
4038 /* Set charpos to the buffer position of the character
4039 that comes after IT's current position in the visual
4041 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4045 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4048 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4051 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4053 /* Determine face for CHARSET_ASCII, or unibyte. */
4054 face_id
= face_at_buffer_position (it
->w
,
4056 it
->region_beg_charpos
,
4057 it
->region_end_charpos
,
4058 &next_check_charpos
,
4061 /* Correct the face for charsets different from ASCII. Do it
4062 for the multibyte case only. The face returned above is
4063 suitable for unibyte text if current_buffer is unibyte. */
4064 if (it
->multibyte_p
)
4066 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4067 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4068 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4077 /***********************************************************************
4079 ***********************************************************************/
4081 /* Set up iterator IT from invisible properties at its current
4082 position. Called from handle_stop. */
4084 static enum prop_handled
4085 handle_invisible_prop (struct it
*it
)
4087 enum prop_handled handled
= HANDLED_NORMALLY
;
4091 if (STRINGP (it
->string
))
4093 Lisp_Object end_charpos
, limit
, charpos
;
4095 /* Get the value of the invisible text property at the
4096 current position. Value will be nil if there is no such
4098 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4099 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4100 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4102 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4104 /* Record whether we have to display an ellipsis for the
4106 int display_ellipsis_p
= (invis_p
== 2);
4107 ptrdiff_t len
, endpos
;
4109 handled
= HANDLED_RECOMPUTE_PROPS
;
4111 /* Get the position at which the next visible text can be
4112 found in IT->string, if any. */
4113 endpos
= len
= SCHARS (it
->string
);
4114 XSETINT (limit
, len
);
4117 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4119 if (INTEGERP (end_charpos
))
4121 endpos
= XFASTINT (end_charpos
);
4122 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4123 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4125 display_ellipsis_p
= 1;
4128 while (invis_p
&& endpos
< len
);
4130 if (display_ellipsis_p
)
4135 /* Text at END_CHARPOS is visible. Move IT there. */
4136 struct text_pos old
;
4139 old
= it
->current
.string_pos
;
4140 oldpos
= CHARPOS (old
);
4143 if (it
->bidi_it
.first_elt
4144 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4145 bidi_paragraph_init (it
->paragraph_embedding
,
4147 /* Bidi-iterate out of the invisible text. */
4150 bidi_move_to_visually_next (&it
->bidi_it
);
4152 while (oldpos
<= it
->bidi_it
.charpos
4153 && it
->bidi_it
.charpos
< endpos
);
4155 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4156 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4157 if (IT_CHARPOS (*it
) >= endpos
)
4158 it
->prev_stop
= endpos
;
4162 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4163 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4168 /* The rest of the string is invisible. If this is an
4169 overlay string, proceed with the next overlay string
4170 or whatever comes and return a character from there. */
4171 if (it
->current
.overlay_string_index
>= 0
4172 && !display_ellipsis_p
)
4174 next_overlay_string (it
);
4175 /* Don't check for overlay strings when we just
4176 finished processing them. */
4177 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4181 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4182 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4189 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4190 Lisp_Object pos
, overlay
;
4192 /* First of all, is there invisible text at this position? */
4193 tem
= start_charpos
= IT_CHARPOS (*it
);
4194 pos
= make_number (tem
);
4195 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4197 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4199 /* If we are on invisible text, skip over it. */
4200 if (invis_p
&& start_charpos
< it
->end_charpos
)
4202 /* Record whether we have to display an ellipsis for the
4204 int display_ellipsis_p
= invis_p
== 2;
4206 handled
= HANDLED_RECOMPUTE_PROPS
;
4208 /* Loop skipping over invisible text. The loop is left at
4209 ZV or with IT on the first char being visible again. */
4212 /* Try to skip some invisible text. Return value is the
4213 position reached which can be equal to where we start
4214 if there is nothing invisible there. This skips both
4215 over invisible text properties and overlays with
4216 invisible property. */
4217 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4219 /* If we skipped nothing at all we weren't at invisible
4220 text in the first place. If everything to the end of
4221 the buffer was skipped, end the loop. */
4222 if (newpos
== tem
|| newpos
>= ZV
)
4226 /* We skipped some characters but not necessarily
4227 all there are. Check if we ended up on visible
4228 text. Fget_char_property returns the property of
4229 the char before the given position, i.e. if we
4230 get invis_p = 0, this means that the char at
4231 newpos is visible. */
4232 pos
= make_number (newpos
);
4233 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4234 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4237 /* If we ended up on invisible text, proceed to
4238 skip starting with next_stop. */
4242 /* If there are adjacent invisible texts, don't lose the
4243 second one's ellipsis. */
4245 display_ellipsis_p
= 1;
4249 /* The position newpos is now either ZV or on visible text. */
4252 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4254 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4256 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4258 /* If the invisible text ends on a newline or on a
4259 character after a newline, we can avoid the costly,
4260 character by character, bidi iteration to NEWPOS, and
4261 instead simply reseat the iterator there. That's
4262 because all bidi reordering information is tossed at
4263 the newline. This is a big win for modes that hide
4264 complete lines, like Outline, Org, etc. */
4265 if (on_newline
|| after_newline
)
4267 struct text_pos tpos
;
4268 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4270 SET_TEXT_POS (tpos
, newpos
, bpos
);
4271 reseat_1 (it
, tpos
, 0);
4272 /* If we reseat on a newline/ZV, we need to prep the
4273 bidi iterator for advancing to the next character
4274 after the newline/EOB, keeping the current paragraph
4275 direction (so that PRODUCE_GLYPHS does TRT wrt
4276 prepending/appending glyphs to a glyph row). */
4279 it
->bidi_it
.first_elt
= 0;
4280 it
->bidi_it
.paragraph_dir
= pdir
;
4281 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4282 it
->bidi_it
.nchars
= 1;
4283 it
->bidi_it
.ch_len
= 1;
4286 else /* Must use the slow method. */
4288 /* With bidi iteration, the region of invisible text
4289 could start and/or end in the middle of a
4290 non-base embedding level. Therefore, we need to
4291 skip invisible text using the bidi iterator,
4292 starting at IT's current position, until we find
4293 ourselves outside of the invisible text.
4294 Skipping invisible text _after_ bidi iteration
4295 avoids affecting the visual order of the
4296 displayed text when invisible properties are
4297 added or removed. */
4298 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4300 /* If we were `reseat'ed to a new paragraph,
4301 determine the paragraph base direction. We
4302 need to do it now because
4303 next_element_from_buffer may not have a
4304 chance to do it, if we are going to skip any
4305 text at the beginning, which resets the
4307 bidi_paragraph_init (it
->paragraph_embedding
,
4312 bidi_move_to_visually_next (&it
->bidi_it
);
4314 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4315 && it
->bidi_it
.charpos
< newpos
);
4316 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4317 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4318 /* If we overstepped NEWPOS, record its position in
4319 the iterator, so that we skip invisible text if
4320 later the bidi iteration lands us in the
4321 invisible region again. */
4322 if (IT_CHARPOS (*it
) >= newpos
)
4323 it
->prev_stop
= newpos
;
4328 IT_CHARPOS (*it
) = newpos
;
4329 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4332 /* If there are before-strings at the start of invisible
4333 text, and the text is invisible because of a text
4334 property, arrange to show before-strings because 20.x did
4335 it that way. (If the text is invisible because of an
4336 overlay property instead of a text property, this is
4337 already handled in the overlay code.) */
4339 && get_overlay_strings (it
, it
->stop_charpos
))
4341 handled
= HANDLED_RECOMPUTE_PROPS
;
4342 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4344 else if (display_ellipsis_p
)
4346 /* Make sure that the glyphs of the ellipsis will get
4347 correct `charpos' values. If we would not update
4348 it->position here, the glyphs would belong to the
4349 last visible character _before_ the invisible
4350 text, which confuses `set_cursor_from_row'.
4352 We use the last invisible position instead of the
4353 first because this way the cursor is always drawn on
4354 the first "." of the ellipsis, whenever PT is inside
4355 the invisible text. Otherwise the cursor would be
4356 placed _after_ the ellipsis when the point is after the
4357 first invisible character. */
4358 if (!STRINGP (it
->object
))
4360 it
->position
.charpos
= newpos
- 1;
4361 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4364 /* Let the ellipsis display before
4365 considering any properties of the following char.
4366 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4367 handled
= HANDLED_RETURN
;
4376 /* Make iterator IT return `...' next.
4377 Replaces LEN characters from buffer. */
4380 setup_for_ellipsis (struct it
*it
, int len
)
4382 /* Use the display table definition for `...'. Invalid glyphs
4383 will be handled by the method returning elements from dpvec. */
4384 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4386 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4387 it
->dpvec
= v
->contents
;
4388 it
->dpend
= v
->contents
+ v
->header
.size
;
4392 /* Default `...'. */
4393 it
->dpvec
= default_invis_vector
;
4394 it
->dpend
= default_invis_vector
+ 3;
4397 it
->dpvec_char_len
= len
;
4398 it
->current
.dpvec_index
= 0;
4399 it
->dpvec_face_id
= -1;
4401 /* Remember the current face id in case glyphs specify faces.
4402 IT's face is restored in set_iterator_to_next.
4403 saved_face_id was set to preceding char's face in handle_stop. */
4404 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4405 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4407 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4413 /***********************************************************************
4415 ***********************************************************************/
4417 /* Set up iterator IT from `display' property at its current position.
4418 Called from handle_stop.
4419 We return HANDLED_RETURN if some part of the display property
4420 overrides the display of the buffer text itself.
4421 Otherwise we return HANDLED_NORMALLY. */
4423 static enum prop_handled
4424 handle_display_prop (struct it
*it
)
4426 Lisp_Object propval
, object
, overlay
;
4427 struct text_pos
*position
;
4429 /* Nonzero if some property replaces the display of the text itself. */
4430 int display_replaced_p
= 0;
4432 if (STRINGP (it
->string
))
4434 object
= it
->string
;
4435 position
= &it
->current
.string_pos
;
4436 bufpos
= CHARPOS (it
->current
.pos
);
4440 XSETWINDOW (object
, it
->w
);
4441 position
= &it
->current
.pos
;
4442 bufpos
= CHARPOS (*position
);
4445 /* Reset those iterator values set from display property values. */
4446 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4447 it
->space_width
= Qnil
;
4448 it
->font_height
= Qnil
;
4451 /* We don't support recursive `display' properties, i.e. string
4452 values that have a string `display' property, that have a string
4453 `display' property etc. */
4454 if (!it
->string_from_display_prop_p
)
4455 it
->area
= TEXT_AREA
;
4457 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4458 Qdisplay
, object
, &overlay
);
4460 return HANDLED_NORMALLY
;
4461 /* Now OVERLAY is the overlay that gave us this property, or nil
4462 if it was a text property. */
4464 if (!STRINGP (it
->string
))
4465 object
= it
->w
->buffer
;
4467 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4469 FRAME_WINDOW_P (it
->f
));
4471 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4474 /* Subroutine of handle_display_prop. Returns non-zero if the display
4475 specification in SPEC is a replacing specification, i.e. it would
4476 replace the text covered by `display' property with something else,
4477 such as an image or a display string. If SPEC includes any kind or
4478 `(space ...) specification, the value is 2; this is used by
4479 compute_display_string_pos, which see.
4481 See handle_single_display_spec for documentation of arguments.
4482 frame_window_p is non-zero if the window being redisplayed is on a
4483 GUI frame; this argument is used only if IT is NULL, see below.
4485 IT can be NULL, if this is called by the bidi reordering code
4486 through compute_display_string_pos, which see. In that case, this
4487 function only examines SPEC, but does not otherwise "handle" it, in
4488 the sense that it doesn't set up members of IT from the display
4491 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4492 Lisp_Object overlay
, struct text_pos
*position
,
4493 ptrdiff_t bufpos
, int frame_window_p
)
4495 int replacing_p
= 0;
4499 /* Simple specifications. */
4500 && !EQ (XCAR (spec
), Qimage
)
4501 && !EQ (XCAR (spec
), Qspace
)
4502 && !EQ (XCAR (spec
), Qwhen
)
4503 && !EQ (XCAR (spec
), Qslice
)
4504 && !EQ (XCAR (spec
), Qspace_width
)
4505 && !EQ (XCAR (spec
), Qheight
)
4506 && !EQ (XCAR (spec
), Qraise
)
4507 /* Marginal area specifications. */
4508 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4509 && !EQ (XCAR (spec
), Qleft_fringe
)
4510 && !EQ (XCAR (spec
), Qright_fringe
)
4511 && !NILP (XCAR (spec
)))
4513 for (; CONSP (spec
); spec
= XCDR (spec
))
4515 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4516 overlay
, position
, bufpos
,
4517 replacing_p
, frame_window_p
)))
4520 /* If some text in a string is replaced, `position' no
4521 longer points to the position of `object'. */
4522 if (!it
|| STRINGP (object
))
4527 else if (VECTORP (spec
))
4530 for (i
= 0; i
< ASIZE (spec
); ++i
)
4531 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4532 overlay
, position
, bufpos
,
4533 replacing_p
, frame_window_p
)))
4536 /* If some text in a string is replaced, `position' no
4537 longer points to the position of `object'. */
4538 if (!it
|| STRINGP (object
))
4544 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4545 position
, bufpos
, 0,
4553 /* Value is the position of the end of the `display' property starting
4554 at START_POS in OBJECT. */
4556 static struct text_pos
4557 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4560 struct text_pos end_pos
;
4562 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4563 Qdisplay
, object
, Qnil
);
4564 CHARPOS (end_pos
) = XFASTINT (end
);
4565 if (STRINGP (object
))
4566 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4568 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4574 /* Set up IT from a single `display' property specification SPEC. OBJECT
4575 is the object in which the `display' property was found. *POSITION
4576 is the position in OBJECT at which the `display' property was found.
4577 BUFPOS is the buffer position of OBJECT (different from POSITION if
4578 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4579 previously saw a display specification which already replaced text
4580 display with something else, for example an image; we ignore such
4581 properties after the first one has been processed.
4583 OVERLAY is the overlay this `display' property came from,
4584 or nil if it was a text property.
4586 If SPEC is a `space' or `image' specification, and in some other
4587 cases too, set *POSITION to the position where the `display'
4590 If IT is NULL, only examine the property specification in SPEC, but
4591 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4592 is intended to be displayed in a window on a GUI frame.
4594 Value is non-zero if something was found which replaces the display
4595 of buffer or string text. */
4598 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4599 Lisp_Object overlay
, struct text_pos
*position
,
4600 ptrdiff_t bufpos
, int display_replaced_p
,
4604 Lisp_Object location
, value
;
4605 struct text_pos start_pos
= *position
;
4608 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4609 If the result is non-nil, use VALUE instead of SPEC. */
4611 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4620 if (!NILP (form
) && !EQ (form
, Qt
))
4622 ptrdiff_t count
= SPECPDL_INDEX ();
4623 struct gcpro gcpro1
;
4625 /* Bind `object' to the object having the `display' property, a
4626 buffer or string. Bind `position' to the position in the
4627 object where the property was found, and `buffer-position'
4628 to the current position in the buffer. */
4631 XSETBUFFER (object
, current_buffer
);
4632 specbind (Qobject
, object
);
4633 specbind (Qposition
, make_number (CHARPOS (*position
)));
4634 specbind (Qbuffer_position
, make_number (bufpos
));
4636 form
= safe_eval (form
);
4638 unbind_to (count
, Qnil
);
4644 /* Handle `(height HEIGHT)' specifications. */
4646 && EQ (XCAR (spec
), Qheight
)
4647 && CONSP (XCDR (spec
)))
4651 if (!FRAME_WINDOW_P (it
->f
))
4654 it
->font_height
= XCAR (XCDR (spec
));
4655 if (!NILP (it
->font_height
))
4657 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4658 int new_height
= -1;
4660 if (CONSP (it
->font_height
)
4661 && (EQ (XCAR (it
->font_height
), Qplus
)
4662 || EQ (XCAR (it
->font_height
), Qminus
))
4663 && CONSP (XCDR (it
->font_height
))
4664 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4666 /* `(+ N)' or `(- N)' where N is an integer. */
4667 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4668 if (EQ (XCAR (it
->font_height
), Qplus
))
4670 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4672 else if (FUNCTIONP (it
->font_height
))
4674 /* Call function with current height as argument.
4675 Value is the new height. */
4677 height
= safe_call1 (it
->font_height
,
4678 face
->lface
[LFACE_HEIGHT_INDEX
]);
4679 if (NUMBERP (height
))
4680 new_height
= XFLOATINT (height
);
4682 else if (NUMBERP (it
->font_height
))
4684 /* Value is a multiple of the canonical char height. */
4687 f
= FACE_FROM_ID (it
->f
,
4688 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4689 new_height
= (XFLOATINT (it
->font_height
)
4690 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4694 /* Evaluate IT->font_height with `height' bound to the
4695 current specified height to get the new height. */
4696 ptrdiff_t count
= SPECPDL_INDEX ();
4698 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4699 value
= safe_eval (it
->font_height
);
4700 unbind_to (count
, Qnil
);
4702 if (NUMBERP (value
))
4703 new_height
= XFLOATINT (value
);
4707 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4714 /* Handle `(space-width WIDTH)'. */
4716 && EQ (XCAR (spec
), Qspace_width
)
4717 && CONSP (XCDR (spec
)))
4721 if (!FRAME_WINDOW_P (it
->f
))
4724 value
= XCAR (XCDR (spec
));
4725 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4726 it
->space_width
= value
;
4732 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4734 && EQ (XCAR (spec
), Qslice
))
4740 if (!FRAME_WINDOW_P (it
->f
))
4743 if (tem
= XCDR (spec
), CONSP (tem
))
4745 it
->slice
.x
= XCAR (tem
);
4746 if (tem
= XCDR (tem
), CONSP (tem
))
4748 it
->slice
.y
= XCAR (tem
);
4749 if (tem
= XCDR (tem
), CONSP (tem
))
4751 it
->slice
.width
= XCAR (tem
);
4752 if (tem
= XCDR (tem
), CONSP (tem
))
4753 it
->slice
.height
= XCAR (tem
);
4762 /* Handle `(raise FACTOR)'. */
4764 && EQ (XCAR (spec
), Qraise
)
4765 && CONSP (XCDR (spec
)))
4769 if (!FRAME_WINDOW_P (it
->f
))
4772 #ifdef HAVE_WINDOW_SYSTEM
4773 value
= XCAR (XCDR (spec
));
4774 if (NUMBERP (value
))
4776 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4777 it
->voffset
= - (XFLOATINT (value
)
4778 * (FONT_HEIGHT (face
->font
)));
4780 #endif /* HAVE_WINDOW_SYSTEM */
4786 /* Don't handle the other kinds of display specifications
4787 inside a string that we got from a `display' property. */
4788 if (it
&& it
->string_from_display_prop_p
)
4791 /* Characters having this form of property are not displayed, so
4792 we have to find the end of the property. */
4795 start_pos
= *position
;
4796 *position
= display_prop_end (it
, object
, start_pos
);
4800 /* Stop the scan at that end position--we assume that all
4801 text properties change there. */
4803 it
->stop_charpos
= position
->charpos
;
4805 /* Handle `(left-fringe BITMAP [FACE])'
4806 and `(right-fringe BITMAP [FACE])'. */
4808 && (EQ (XCAR (spec
), Qleft_fringe
)
4809 || EQ (XCAR (spec
), Qright_fringe
))
4810 && CONSP (XCDR (spec
)))
4816 if (!FRAME_WINDOW_P (it
->f
))
4817 /* If we return here, POSITION has been advanced
4818 across the text with this property. */
4820 /* Synchronize the bidi iterator with POSITION. This is
4821 needed because we are not going to push the iterator
4822 on behalf of this display property, so there will be
4823 no pop_it call to do this synchronization for us. */
4826 it
->position
= *position
;
4827 iterate_out_of_display_property (it
);
4828 *position
= it
->position
;
4833 else if (!frame_window_p
)
4836 #ifdef HAVE_WINDOW_SYSTEM
4837 value
= XCAR (XCDR (spec
));
4838 if (!SYMBOLP (value
)
4839 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4840 /* If we return here, POSITION has been advanced
4841 across the text with this property. */
4843 if (it
&& it
->bidi_p
)
4845 it
->position
= *position
;
4846 iterate_out_of_display_property (it
);
4847 *position
= it
->position
;
4854 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4856 if (CONSP (XCDR (XCDR (spec
))))
4858 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4859 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4865 /* Save current settings of IT so that we can restore them
4866 when we are finished with the glyph property value. */
4867 push_it (it
, position
);
4869 it
->area
= TEXT_AREA
;
4870 it
->what
= IT_IMAGE
;
4871 it
->image_id
= -1; /* no image */
4872 it
->position
= start_pos
;
4873 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4874 it
->method
= GET_FROM_IMAGE
;
4875 it
->from_overlay
= Qnil
;
4876 it
->face_id
= face_id
;
4877 it
->from_disp_prop_p
= 1;
4879 /* Say that we haven't consumed the characters with
4880 `display' property yet. The call to pop_it in
4881 set_iterator_to_next will clean this up. */
4882 *position
= start_pos
;
4884 if (EQ (XCAR (spec
), Qleft_fringe
))
4886 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4887 it
->left_user_fringe_face_id
= face_id
;
4891 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4892 it
->right_user_fringe_face_id
= face_id
;
4895 #endif /* HAVE_WINDOW_SYSTEM */
4899 /* Prepare to handle `((margin left-margin) ...)',
4900 `((margin right-margin) ...)' and `((margin nil) ...)'
4901 prefixes for display specifications. */
4902 location
= Qunbound
;
4903 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4907 value
= XCDR (spec
);
4909 value
= XCAR (value
);
4912 if (EQ (XCAR (tem
), Qmargin
)
4913 && (tem
= XCDR (tem
),
4914 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4916 || EQ (tem
, Qleft_margin
)
4917 || EQ (tem
, Qright_margin
))))
4921 if (EQ (location
, Qunbound
))
4927 /* After this point, VALUE is the property after any
4928 margin prefix has been stripped. It must be a string,
4929 an image specification, or `(space ...)'.
4931 LOCATION specifies where to display: `left-margin',
4932 `right-margin' or nil. */
4934 valid_p
= (STRINGP (value
)
4935 #ifdef HAVE_WINDOW_SYSTEM
4936 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4937 && valid_image_p (value
))
4938 #endif /* not HAVE_WINDOW_SYSTEM */
4939 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4941 if (valid_p
&& !display_replaced_p
)
4947 /* Callers need to know whether the display spec is any kind
4948 of `(space ...)' spec that is about to affect text-area
4950 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4955 /* Save current settings of IT so that we can restore them
4956 when we are finished with the glyph property value. */
4957 push_it (it
, position
);
4958 it
->from_overlay
= overlay
;
4959 it
->from_disp_prop_p
= 1;
4961 if (NILP (location
))
4962 it
->area
= TEXT_AREA
;
4963 else if (EQ (location
, Qleft_margin
))
4964 it
->area
= LEFT_MARGIN_AREA
;
4966 it
->area
= RIGHT_MARGIN_AREA
;
4968 if (STRINGP (value
))
4971 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4972 it
->current
.overlay_string_index
= -1;
4973 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4974 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4975 it
->method
= GET_FROM_STRING
;
4976 it
->stop_charpos
= 0;
4978 it
->base_level_stop
= 0;
4979 it
->string_from_display_prop_p
= 1;
4980 /* Say that we haven't consumed the characters with
4981 `display' property yet. The call to pop_it in
4982 set_iterator_to_next will clean this up. */
4983 if (BUFFERP (object
))
4984 *position
= start_pos
;
4986 /* Force paragraph direction to be that of the parent
4987 object. If the parent object's paragraph direction is
4988 not yet determined, default to L2R. */
4989 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4990 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4992 it
->paragraph_embedding
= L2R
;
4994 /* Set up the bidi iterator for this display string. */
4997 it
->bidi_it
.string
.lstring
= it
->string
;
4998 it
->bidi_it
.string
.s
= NULL
;
4999 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5000 it
->bidi_it
.string
.bufpos
= bufpos
;
5001 it
->bidi_it
.string
.from_disp_str
= 1;
5002 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5003 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5006 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5008 it
->method
= GET_FROM_STRETCH
;
5010 *position
= it
->position
= start_pos
;
5011 retval
= 1 + (it
->area
== TEXT_AREA
);
5013 #ifdef HAVE_WINDOW_SYSTEM
5016 it
->what
= IT_IMAGE
;
5017 it
->image_id
= lookup_image (it
->f
, value
);
5018 it
->position
= start_pos
;
5019 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
5020 it
->method
= GET_FROM_IMAGE
;
5022 /* Say that we haven't consumed the characters with
5023 `display' property yet. The call to pop_it in
5024 set_iterator_to_next will clean this up. */
5025 *position
= start_pos
;
5027 #endif /* HAVE_WINDOW_SYSTEM */
5032 /* Invalid property or property not supported. Restore
5033 POSITION to what it was before. */
5034 *position
= start_pos
;
5038 /* Check if PROP is a display property value whose text should be
5039 treated as intangible. OVERLAY is the overlay from which PROP
5040 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5041 specify the buffer position covered by PROP. */
5044 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5045 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5047 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5048 struct text_pos position
;
5050 SET_TEXT_POS (position
, charpos
, bytepos
);
5051 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5052 &position
, charpos
, frame_window_p
);
5056 /* Return 1 if PROP is a display sub-property value containing STRING.
5058 Implementation note: this and the following function are really
5059 special cases of handle_display_spec and
5060 handle_single_display_spec, and should ideally use the same code.
5061 Until they do, these two pairs must be consistent and must be
5062 modified in sync. */
5065 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5067 if (EQ (string
, prop
))
5070 /* Skip over `when FORM'. */
5071 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5076 /* Actually, the condition following `when' should be eval'ed,
5077 like handle_single_display_spec does, and we should return
5078 zero if it evaluates to nil. However, this function is
5079 called only when the buffer was already displayed and some
5080 glyph in the glyph matrix was found to come from a display
5081 string. Therefore, the condition was already evaluated, and
5082 the result was non-nil, otherwise the display string wouldn't
5083 have been displayed and we would have never been called for
5084 this property. Thus, we can skip the evaluation and assume
5085 its result is non-nil. */
5090 /* Skip over `margin LOCATION'. */
5091 if (EQ (XCAR (prop
), Qmargin
))
5102 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5106 /* Return 1 if STRING appears in the `display' property PROP. */
5109 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5112 && !EQ (XCAR (prop
), Qwhen
)
5113 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5115 /* A list of sub-properties. */
5116 while (CONSP (prop
))
5118 if (single_display_spec_string_p (XCAR (prop
), string
))
5123 else if (VECTORP (prop
))
5125 /* A vector of sub-properties. */
5127 for (i
= 0; i
< ASIZE (prop
); ++i
)
5128 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5132 return single_display_spec_string_p (prop
, string
);
5137 /* Look for STRING in overlays and text properties in the current
5138 buffer, between character positions FROM and TO (excluding TO).
5139 BACK_P non-zero means look back (in this case, TO is supposed to be
5141 Value is the first character position where STRING was found, or
5142 zero if it wasn't found before hitting TO.
5144 This function may only use code that doesn't eval because it is
5145 called asynchronously from note_mouse_highlight. */
5148 string_buffer_position_lim (Lisp_Object string
,
5149 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5151 Lisp_Object limit
, prop
, pos
;
5154 pos
= make_number (max (from
, BEGV
));
5156 if (!back_p
) /* looking forward */
5158 limit
= make_number (min (to
, ZV
));
5159 while (!found
&& !EQ (pos
, limit
))
5161 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5162 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5165 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5169 else /* looking back */
5171 limit
= make_number (max (to
, BEGV
));
5172 while (!found
&& !EQ (pos
, limit
))
5174 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5175 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5178 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5183 return found
? XINT (pos
) : 0;
5186 /* Determine which buffer position in current buffer STRING comes from.
5187 AROUND_CHARPOS is an approximate position where it could come from.
5188 Value is the buffer position or 0 if it couldn't be determined.
5190 This function is necessary because we don't record buffer positions
5191 in glyphs generated from strings (to keep struct glyph small).
5192 This function may only use code that doesn't eval because it is
5193 called asynchronously from note_mouse_highlight. */
5196 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5198 const int MAX_DISTANCE
= 1000;
5199 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5200 around_charpos
+ MAX_DISTANCE
,
5204 found
= string_buffer_position_lim (string
, around_charpos
,
5205 around_charpos
- MAX_DISTANCE
, 1);
5211 /***********************************************************************
5212 `composition' property
5213 ***********************************************************************/
5215 /* Set up iterator IT from `composition' property at its current
5216 position. Called from handle_stop. */
5218 static enum prop_handled
5219 handle_composition_prop (struct it
*it
)
5221 Lisp_Object prop
, string
;
5222 ptrdiff_t pos
, pos_byte
, start
, end
;
5224 if (STRINGP (it
->string
))
5228 pos
= IT_STRING_CHARPOS (*it
);
5229 pos_byte
= IT_STRING_BYTEPOS (*it
);
5230 string
= it
->string
;
5231 s
= SDATA (string
) + pos_byte
;
5232 it
->c
= STRING_CHAR (s
);
5236 pos
= IT_CHARPOS (*it
);
5237 pos_byte
= IT_BYTEPOS (*it
);
5239 it
->c
= FETCH_CHAR (pos_byte
);
5242 /* If there's a valid composition and point is not inside of the
5243 composition (in the case that the composition is from the current
5244 buffer), draw a glyph composed from the composition components. */
5245 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5246 && COMPOSITION_VALID_P (start
, end
, prop
)
5247 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5250 /* As we can't handle this situation (perhaps font-lock added
5251 a new composition), we just return here hoping that next
5252 redisplay will detect this composition much earlier. */
5253 return HANDLED_NORMALLY
;
5256 if (STRINGP (it
->string
))
5257 pos_byte
= string_char_to_byte (it
->string
, start
);
5259 pos_byte
= CHAR_TO_BYTE (start
);
5261 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5264 if (it
->cmp_it
.id
>= 0)
5267 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5268 it
->cmp_it
.nglyphs
= -1;
5272 return HANDLED_NORMALLY
;
5277 /***********************************************************************
5279 ***********************************************************************/
5281 /* The following structure is used to record overlay strings for
5282 later sorting in load_overlay_strings. */
5284 struct overlay_entry
5286 Lisp_Object overlay
;
5293 /* Set up iterator IT from overlay strings at its current position.
5294 Called from handle_stop. */
5296 static enum prop_handled
5297 handle_overlay_change (struct it
*it
)
5299 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5300 return HANDLED_RECOMPUTE_PROPS
;
5302 return HANDLED_NORMALLY
;
5306 /* Set up the next overlay string for delivery by IT, if there is an
5307 overlay string to deliver. Called by set_iterator_to_next when the
5308 end of the current overlay string is reached. If there are more
5309 overlay strings to display, IT->string and
5310 IT->current.overlay_string_index are set appropriately here.
5311 Otherwise IT->string is set to nil. */
5314 next_overlay_string (struct it
*it
)
5316 ++it
->current
.overlay_string_index
;
5317 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5319 /* No more overlay strings. Restore IT's settings to what
5320 they were before overlay strings were processed, and
5321 continue to deliver from current_buffer. */
5323 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5326 || (NILP (it
->string
)
5327 && it
->method
== GET_FROM_BUFFER
5328 && it
->stop_charpos
>= BEGV
5329 && it
->stop_charpos
<= it
->end_charpos
));
5330 it
->current
.overlay_string_index
= -1;
5331 it
->n_overlay_strings
= 0;
5332 it
->overlay_strings_charpos
= -1;
5333 /* If there's an empty display string on the stack, pop the
5334 stack, to resync the bidi iterator with IT's position. Such
5335 empty strings are pushed onto the stack in
5336 get_overlay_strings_1. */
5337 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5340 /* If we're at the end of the buffer, record that we have
5341 processed the overlay strings there already, so that
5342 next_element_from_buffer doesn't try it again. */
5343 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5344 it
->overlay_strings_at_end_processed_p
= 1;
5348 /* There are more overlay strings to process. If
5349 IT->current.overlay_string_index has advanced to a position
5350 where we must load IT->overlay_strings with more strings, do
5351 it. We must load at the IT->overlay_strings_charpos where
5352 IT->n_overlay_strings was originally computed; when invisible
5353 text is present, this might not be IT_CHARPOS (Bug#7016). */
5354 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5356 if (it
->current
.overlay_string_index
&& i
== 0)
5357 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5359 /* Initialize IT to deliver display elements from the overlay
5361 it
->string
= it
->overlay_strings
[i
];
5362 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5363 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5364 it
->method
= GET_FROM_STRING
;
5365 it
->stop_charpos
= 0;
5366 it
->end_charpos
= SCHARS (it
->string
);
5367 if (it
->cmp_it
.stop_pos
>= 0)
5368 it
->cmp_it
.stop_pos
= 0;
5370 it
->base_level_stop
= 0;
5372 /* Set up the bidi iterator for this overlay string. */
5375 it
->bidi_it
.string
.lstring
= it
->string
;
5376 it
->bidi_it
.string
.s
= NULL
;
5377 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5378 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5379 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5380 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5381 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5389 /* Compare two overlay_entry structures E1 and E2. Used as a
5390 comparison function for qsort in load_overlay_strings. Overlay
5391 strings for the same position are sorted so that
5393 1. All after-strings come in front of before-strings, except
5394 when they come from the same overlay.
5396 2. Within after-strings, strings are sorted so that overlay strings
5397 from overlays with higher priorities come first.
5399 2. Within before-strings, strings are sorted so that overlay
5400 strings from overlays with higher priorities come last.
5402 Value is analogous to strcmp. */
5406 compare_overlay_entries (const void *e1
, const void *e2
)
5408 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5409 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5412 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5414 /* Let after-strings appear in front of before-strings if
5415 they come from different overlays. */
5416 if (EQ (entry1
->overlay
, entry2
->overlay
))
5417 result
= entry1
->after_string_p
? 1 : -1;
5419 result
= entry1
->after_string_p
? -1 : 1;
5421 else if (entry1
->priority
!= entry2
->priority
)
5423 if (entry1
->after_string_p
)
5424 /* After-strings sorted in order of decreasing priority. */
5425 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5427 /* Before-strings sorted in order of increasing priority. */
5428 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5437 /* Load the vector IT->overlay_strings with overlay strings from IT's
5438 current buffer position, or from CHARPOS if that is > 0. Set
5439 IT->n_overlays to the total number of overlay strings found.
5441 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5442 a time. On entry into load_overlay_strings,
5443 IT->current.overlay_string_index gives the number of overlay
5444 strings that have already been loaded by previous calls to this
5447 IT->add_overlay_start contains an additional overlay start
5448 position to consider for taking overlay strings from, if non-zero.
5449 This position comes into play when the overlay has an `invisible'
5450 property, and both before and after-strings. When we've skipped to
5451 the end of the overlay, because of its `invisible' property, we
5452 nevertheless want its before-string to appear.
5453 IT->add_overlay_start will contain the overlay start position
5456 Overlay strings are sorted so that after-string strings come in
5457 front of before-string strings. Within before and after-strings,
5458 strings are sorted by overlay priority. See also function
5459 compare_overlay_entries. */
5462 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5464 Lisp_Object overlay
, window
, str
, invisible
;
5465 struct Lisp_Overlay
*ov
;
5466 ptrdiff_t start
, end
;
5467 ptrdiff_t size
= 20;
5468 ptrdiff_t n
= 0, i
, j
;
5470 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5474 charpos
= IT_CHARPOS (*it
);
5476 /* Append the overlay string STRING of overlay OVERLAY to vector
5477 `entries' which has size `size' and currently contains `n'
5478 elements. AFTER_P non-zero means STRING is an after-string of
5480 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5483 Lisp_Object priority; \
5487 struct overlay_entry *old = entries; \
5488 SAFE_NALLOCA (entries, 2, size); \
5489 memcpy (entries, old, size * sizeof *entries); \
5493 entries[n].string = (STRING); \
5494 entries[n].overlay = (OVERLAY); \
5495 priority = Foverlay_get ((OVERLAY), Qpriority); \
5496 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5497 entries[n].after_string_p = (AFTER_P); \
5502 /* Process overlay before the overlay center. */
5503 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5505 XSETMISC (overlay
, ov
);
5506 eassert (OVERLAYP (overlay
));
5507 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5508 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5513 /* Skip this overlay if it doesn't start or end at IT's current
5515 if (end
!= charpos
&& start
!= charpos
)
5518 /* Skip this overlay if it doesn't apply to IT->w. */
5519 window
= Foverlay_get (overlay
, Qwindow
);
5520 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5523 /* If the text ``under'' the overlay is invisible, both before-
5524 and after-strings from this overlay are visible; start and
5525 end position are indistinguishable. */
5526 invisible
= Foverlay_get (overlay
, Qinvisible
);
5527 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5529 /* If overlay has a non-empty before-string, record it. */
5530 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5531 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5533 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5535 /* If overlay has a non-empty after-string, record it. */
5536 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5537 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5539 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5542 /* Process overlays after the overlay center. */
5543 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5545 XSETMISC (overlay
, ov
);
5546 eassert (OVERLAYP (overlay
));
5547 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5548 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5550 if (start
> charpos
)
5553 /* Skip this overlay if it doesn't start or end at IT's current
5555 if (end
!= charpos
&& start
!= charpos
)
5558 /* Skip this overlay if it doesn't apply to IT->w. */
5559 window
= Foverlay_get (overlay
, Qwindow
);
5560 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5563 /* If the text ``under'' the overlay is invisible, it has a zero
5564 dimension, and both before- and after-strings apply. */
5565 invisible
= Foverlay_get (overlay
, Qinvisible
);
5566 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5568 /* If overlay has a non-empty before-string, record it. */
5569 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5570 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5572 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5574 /* If overlay has a non-empty after-string, record it. */
5575 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5576 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5578 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5581 #undef RECORD_OVERLAY_STRING
5585 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5587 /* Record number of overlay strings, and where we computed it. */
5588 it
->n_overlay_strings
= n
;
5589 it
->overlay_strings_charpos
= charpos
;
5591 /* IT->current.overlay_string_index is the number of overlay strings
5592 that have already been consumed by IT. Copy some of the
5593 remaining overlay strings to IT->overlay_strings. */
5595 j
= it
->current
.overlay_string_index
;
5596 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5598 it
->overlay_strings
[i
] = entries
[j
].string
;
5599 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5607 /* Get the first chunk of overlay strings at IT's current buffer
5608 position, or at CHARPOS if that is > 0. Value is non-zero if at
5609 least one overlay string was found. */
5612 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5614 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5615 process. This fills IT->overlay_strings with strings, and sets
5616 IT->n_overlay_strings to the total number of strings to process.
5617 IT->pos.overlay_string_index has to be set temporarily to zero
5618 because load_overlay_strings needs this; it must be set to -1
5619 when no overlay strings are found because a zero value would
5620 indicate a position in the first overlay string. */
5621 it
->current
.overlay_string_index
= 0;
5622 load_overlay_strings (it
, charpos
);
5624 /* If we found overlay strings, set up IT to deliver display
5625 elements from the first one. Otherwise set up IT to deliver
5626 from current_buffer. */
5627 if (it
->n_overlay_strings
)
5629 /* Make sure we know settings in current_buffer, so that we can
5630 restore meaningful values when we're done with the overlay
5633 compute_stop_pos (it
);
5634 eassert (it
->face_id
>= 0);
5636 /* Save IT's settings. They are restored after all overlay
5637 strings have been processed. */
5638 eassert (!compute_stop_p
|| it
->sp
== 0);
5640 /* When called from handle_stop, there might be an empty display
5641 string loaded. In that case, don't bother saving it. But
5642 don't use this optimization with the bidi iterator, since we
5643 need the corresponding pop_it call to resync the bidi
5644 iterator's position with IT's position, after we are done
5645 with the overlay strings. (The corresponding call to pop_it
5646 in case of an empty display string is in
5647 next_overlay_string.) */
5649 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5652 /* Set up IT to deliver display elements from the first overlay
5654 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5655 it
->string
= it
->overlay_strings
[0];
5656 it
->from_overlay
= Qnil
;
5657 it
->stop_charpos
= 0;
5658 eassert (STRINGP (it
->string
));
5659 it
->end_charpos
= SCHARS (it
->string
);
5661 it
->base_level_stop
= 0;
5662 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5663 it
->method
= GET_FROM_STRING
;
5664 it
->from_disp_prop_p
= 0;
5666 /* Force paragraph direction to be that of the parent
5668 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5669 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5671 it
->paragraph_embedding
= L2R
;
5673 /* Set up the bidi iterator for this overlay string. */
5676 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5678 it
->bidi_it
.string
.lstring
= it
->string
;
5679 it
->bidi_it
.string
.s
= NULL
;
5680 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5681 it
->bidi_it
.string
.bufpos
= pos
;
5682 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5683 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5684 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5689 it
->current
.overlay_string_index
= -1;
5694 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5697 it
->method
= GET_FROM_BUFFER
;
5699 (void) get_overlay_strings_1 (it
, charpos
, 1);
5703 /* Value is non-zero if we found at least one overlay string. */
5704 return STRINGP (it
->string
);
5709 /***********************************************************************
5710 Saving and restoring state
5711 ***********************************************************************/
5713 /* Save current settings of IT on IT->stack. Called, for example,
5714 before setting up IT for an overlay string, to be able to restore
5715 IT's settings to what they were after the overlay string has been
5716 processed. If POSITION is non-NULL, it is the position to save on
5717 the stack instead of IT->position. */
5720 push_it (struct it
*it
, struct text_pos
*position
)
5722 struct iterator_stack_entry
*p
;
5724 eassert (it
->sp
< IT_STACK_SIZE
);
5725 p
= it
->stack
+ it
->sp
;
5727 p
->stop_charpos
= it
->stop_charpos
;
5728 p
->prev_stop
= it
->prev_stop
;
5729 p
->base_level_stop
= it
->base_level_stop
;
5730 p
->cmp_it
= it
->cmp_it
;
5731 eassert (it
->face_id
>= 0);
5732 p
->face_id
= it
->face_id
;
5733 p
->string
= it
->string
;
5734 p
->method
= it
->method
;
5735 p
->from_overlay
= it
->from_overlay
;
5738 case GET_FROM_IMAGE
:
5739 p
->u
.image
.object
= it
->object
;
5740 p
->u
.image
.image_id
= it
->image_id
;
5741 p
->u
.image
.slice
= it
->slice
;
5743 case GET_FROM_STRETCH
:
5744 p
->u
.stretch
.object
= it
->object
;
5747 p
->position
= position
? *position
: it
->position
;
5748 p
->current
= it
->current
;
5749 p
->end_charpos
= it
->end_charpos
;
5750 p
->string_nchars
= it
->string_nchars
;
5752 p
->multibyte_p
= it
->multibyte_p
;
5753 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5754 p
->space_width
= it
->space_width
;
5755 p
->font_height
= it
->font_height
;
5756 p
->voffset
= it
->voffset
;
5757 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5758 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5759 p
->display_ellipsis_p
= 0;
5760 p
->line_wrap
= it
->line_wrap
;
5761 p
->bidi_p
= it
->bidi_p
;
5762 p
->paragraph_embedding
= it
->paragraph_embedding
;
5763 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5766 /* Save the state of the bidi iterator as well. */
5768 bidi_push_it (&it
->bidi_it
);
5772 iterate_out_of_display_property (struct it
*it
)
5774 int buffer_p
= !STRINGP (it
->string
);
5775 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5776 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5778 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5780 /* Maybe initialize paragraph direction. If we are at the beginning
5781 of a new paragraph, next_element_from_buffer may not have a
5782 chance to do that. */
5783 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5784 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5785 /* prev_stop can be zero, so check against BEGV as well. */
5786 while (it
->bidi_it
.charpos
>= bob
5787 && it
->prev_stop
<= it
->bidi_it
.charpos
5788 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5789 && it
->bidi_it
.charpos
< eob
)
5790 bidi_move_to_visually_next (&it
->bidi_it
);
5791 /* Record the stop_pos we just crossed, for when we cross it
5793 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5794 it
->prev_stop
= CHARPOS (it
->position
);
5795 /* If we ended up not where pop_it put us, resync IT's
5796 positional members with the bidi iterator. */
5797 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5798 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5800 it
->current
.pos
= it
->position
;
5802 it
->current
.string_pos
= it
->position
;
5805 /* Restore IT's settings from IT->stack. Called, for example, when no
5806 more overlay strings must be processed, and we return to delivering
5807 display elements from a buffer, or when the end of a string from a
5808 `display' property is reached and we return to delivering display
5809 elements from an overlay string, or from a buffer. */
5812 pop_it (struct it
*it
)
5814 struct iterator_stack_entry
*p
;
5815 int from_display_prop
= it
->from_disp_prop_p
;
5817 eassert (it
->sp
> 0);
5819 p
= it
->stack
+ it
->sp
;
5820 it
->stop_charpos
= p
->stop_charpos
;
5821 it
->prev_stop
= p
->prev_stop
;
5822 it
->base_level_stop
= p
->base_level_stop
;
5823 it
->cmp_it
= p
->cmp_it
;
5824 it
->face_id
= p
->face_id
;
5825 it
->current
= p
->current
;
5826 it
->position
= p
->position
;
5827 it
->string
= p
->string
;
5828 it
->from_overlay
= p
->from_overlay
;
5829 if (NILP (it
->string
))
5830 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5831 it
->method
= p
->method
;
5834 case GET_FROM_IMAGE
:
5835 it
->image_id
= p
->u
.image
.image_id
;
5836 it
->object
= p
->u
.image
.object
;
5837 it
->slice
= p
->u
.image
.slice
;
5839 case GET_FROM_STRETCH
:
5840 it
->object
= p
->u
.stretch
.object
;
5842 case GET_FROM_BUFFER
:
5843 it
->object
= it
->w
->buffer
;
5845 case GET_FROM_STRING
:
5846 it
->object
= it
->string
;
5848 case GET_FROM_DISPLAY_VECTOR
:
5850 it
->method
= GET_FROM_C_STRING
;
5851 else if (STRINGP (it
->string
))
5852 it
->method
= GET_FROM_STRING
;
5855 it
->method
= GET_FROM_BUFFER
;
5856 it
->object
= it
->w
->buffer
;
5859 it
->end_charpos
= p
->end_charpos
;
5860 it
->string_nchars
= p
->string_nchars
;
5862 it
->multibyte_p
= p
->multibyte_p
;
5863 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5864 it
->space_width
= p
->space_width
;
5865 it
->font_height
= p
->font_height
;
5866 it
->voffset
= p
->voffset
;
5867 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5868 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5869 it
->line_wrap
= p
->line_wrap
;
5870 it
->bidi_p
= p
->bidi_p
;
5871 it
->paragraph_embedding
= p
->paragraph_embedding
;
5872 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5875 bidi_pop_it (&it
->bidi_it
);
5876 /* Bidi-iterate until we get out of the portion of text, if any,
5877 covered by a `display' text property or by an overlay with
5878 `display' property. (We cannot just jump there, because the
5879 internal coherency of the bidi iterator state can not be
5880 preserved across such jumps.) We also must determine the
5881 paragraph base direction if the overlay we just processed is
5882 at the beginning of a new paragraph. */
5883 if (from_display_prop
5884 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5885 iterate_out_of_display_property (it
);
5887 eassert ((BUFFERP (it
->object
)
5888 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5889 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5890 || (STRINGP (it
->object
)
5891 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5892 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5893 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5899 /***********************************************************************
5901 ***********************************************************************/
5903 /* Set IT's current position to the previous line start. */
5906 back_to_previous_line_start (struct it
*it
)
5909 = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1,
5910 -1, &IT_BYTEPOS (*it
));
5914 /* Move IT to the next line start.
5916 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5917 we skipped over part of the text (as opposed to moving the iterator
5918 continuously over the text). Otherwise, don't change the value
5921 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5922 iterator on the newline, if it was found.
5924 Newlines may come from buffer text, overlay strings, or strings
5925 displayed via the `display' property. That's the reason we can't
5926 simply use find_next_newline_no_quit.
5928 Note that this function may not skip over invisible text that is so
5929 because of text properties and immediately follows a newline. If
5930 it would, function reseat_at_next_visible_line_start, when called
5931 from set_iterator_to_next, would effectively make invisible
5932 characters following a newline part of the wrong glyph row, which
5933 leads to wrong cursor motion. */
5936 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5937 struct bidi_it
*bidi_it_prev
)
5939 ptrdiff_t old_selective
;
5940 int newline_found_p
, n
;
5941 const int MAX_NEWLINE_DISTANCE
= 500;
5943 /* If already on a newline, just consume it to avoid unintended
5944 skipping over invisible text below. */
5945 if (it
->what
== IT_CHARACTER
5947 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5949 if (it
->bidi_p
&& bidi_it_prev
)
5950 *bidi_it_prev
= it
->bidi_it
;
5951 set_iterator_to_next (it
, 0);
5956 /* Don't handle selective display in the following. It's (a)
5957 unnecessary because it's done by the caller, and (b) leads to an
5958 infinite recursion because next_element_from_ellipsis indirectly
5959 calls this function. */
5960 old_selective
= it
->selective
;
5963 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5964 from buffer text. */
5965 for (n
= newline_found_p
= 0;
5966 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5967 n
+= STRINGP (it
->string
) ? 0 : 1)
5969 if (!get_next_display_element (it
))
5971 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5972 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5973 *bidi_it_prev
= it
->bidi_it
;
5974 set_iterator_to_next (it
, 0);
5977 /* If we didn't find a newline near enough, see if we can use a
5979 if (!newline_found_p
)
5981 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
5982 ptrdiff_t limit
= find_next_newline_no_quit (start
, 1, &bytepos
);
5985 eassert (!STRINGP (it
->string
));
5987 /* If there isn't any `display' property in sight, and no
5988 overlays, we can just use the position of the newline in
5990 if (it
->stop_charpos
>= limit
5991 || ((pos
= Fnext_single_property_change (make_number (start
),
5993 make_number (limit
)),
5995 && next_overlay_change (start
) == ZV
))
5999 IT_CHARPOS (*it
) = limit
;
6000 IT_BYTEPOS (*it
) = bytepos
;
6004 struct bidi_it bprev
;
6006 /* Help bidi.c avoid expensive searches for display
6007 properties and overlays, by telling it that there are
6008 none up to `limit'. */
6009 if (it
->bidi_it
.disp_pos
< limit
)
6011 it
->bidi_it
.disp_pos
= limit
;
6012 it
->bidi_it
.disp_prop
= 0;
6015 bprev
= it
->bidi_it
;
6016 bidi_move_to_visually_next (&it
->bidi_it
);
6017 } while (it
->bidi_it
.charpos
!= limit
);
6018 IT_CHARPOS (*it
) = limit
;
6019 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6021 *bidi_it_prev
= bprev
;
6023 *skipped_p
= newline_found_p
= 1;
6027 while (get_next_display_element (it
)
6028 && !newline_found_p
)
6030 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6031 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6032 *bidi_it_prev
= it
->bidi_it
;
6033 set_iterator_to_next (it
, 0);
6038 it
->selective
= old_selective
;
6039 return newline_found_p
;
6043 /* Set IT's current position to the previous visible line start. Skip
6044 invisible text that is so either due to text properties or due to
6045 selective display. Caution: this does not change IT->current_x and
6049 back_to_previous_visible_line_start (struct it
*it
)
6051 while (IT_CHARPOS (*it
) > BEGV
)
6053 back_to_previous_line_start (it
);
6055 if (IT_CHARPOS (*it
) <= BEGV
)
6058 /* If selective > 0, then lines indented more than its value are
6060 if (it
->selective
> 0
6061 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6065 /* Check the newline before point for invisibility. */
6068 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6069 Qinvisible
, it
->window
);
6070 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6074 if (IT_CHARPOS (*it
) <= BEGV
)
6079 void *it2data
= NULL
;
6082 Lisp_Object val
, overlay
;
6084 SAVE_IT (it2
, *it
, it2data
);
6086 /* If newline is part of a composition, continue from start of composition */
6087 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6088 && beg
< IT_CHARPOS (*it
))
6091 /* If newline is replaced by a display property, find start of overlay
6092 or interval and continue search from that point. */
6093 pos
= --IT_CHARPOS (it2
);
6096 bidi_unshelve_cache (NULL
, 0);
6097 it2
.string_from_display_prop_p
= 0;
6098 it2
.from_disp_prop_p
= 0;
6099 if (handle_display_prop (&it2
) == HANDLED_RETURN
6100 && !NILP (val
= get_char_property_and_overlay
6101 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6102 && (OVERLAYP (overlay
)
6103 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6104 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6106 RESTORE_IT (it
, it
, it2data
);
6110 /* Newline is not replaced by anything -- so we are done. */
6111 RESTORE_IT (it
, it
, it2data
);
6117 IT_CHARPOS (*it
) = beg
;
6118 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6122 it
->continuation_lines_width
= 0;
6124 eassert (IT_CHARPOS (*it
) >= BEGV
);
6125 eassert (IT_CHARPOS (*it
) == BEGV
6126 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6131 /* Reseat iterator IT at the previous visible line start. Skip
6132 invisible text that is so either due to text properties or due to
6133 selective display. At the end, update IT's overlay information,
6134 face information etc. */
6137 reseat_at_previous_visible_line_start (struct it
*it
)
6139 back_to_previous_visible_line_start (it
);
6140 reseat (it
, it
->current
.pos
, 1);
6145 /* Reseat iterator IT on the next visible line start in the current
6146 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6147 preceding the line start. Skip over invisible text that is so
6148 because of selective display. Compute faces, overlays etc at the
6149 new position. Note that this function does not skip over text that
6150 is invisible because of text properties. */
6153 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6155 int newline_found_p
, skipped_p
= 0;
6156 struct bidi_it bidi_it_prev
;
6158 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6160 /* Skip over lines that are invisible because they are indented
6161 more than the value of IT->selective. */
6162 if (it
->selective
> 0)
6163 while (IT_CHARPOS (*it
) < ZV
6164 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6167 eassert (IT_BYTEPOS (*it
) == BEGV
6168 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6170 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6173 /* Position on the newline if that's what's requested. */
6174 if (on_newline_p
&& newline_found_p
)
6176 if (STRINGP (it
->string
))
6178 if (IT_STRING_CHARPOS (*it
) > 0)
6182 --IT_STRING_CHARPOS (*it
);
6183 --IT_STRING_BYTEPOS (*it
);
6187 /* We need to restore the bidi iterator to the state
6188 it had on the newline, and resync the IT's
6189 position with that. */
6190 it
->bidi_it
= bidi_it_prev
;
6191 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6192 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6196 else if (IT_CHARPOS (*it
) > BEGV
)
6205 /* We need to restore the bidi iterator to the state it
6206 had on the newline and resync IT with that. */
6207 it
->bidi_it
= bidi_it_prev
;
6208 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6209 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6211 reseat (it
, it
->current
.pos
, 0);
6215 reseat (it
, it
->current
.pos
, 0);
6222 /***********************************************************************
6223 Changing an iterator's position
6224 ***********************************************************************/
6226 /* Change IT's current position to POS in current_buffer. If FORCE_P
6227 is non-zero, always check for text properties at the new position.
6228 Otherwise, text properties are only looked up if POS >=
6229 IT->check_charpos of a property. */
6232 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6234 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6236 reseat_1 (it
, pos
, 0);
6238 /* Determine where to check text properties. Avoid doing it
6239 where possible because text property lookup is very expensive. */
6241 || CHARPOS (pos
) > it
->stop_charpos
6242 || CHARPOS (pos
) < original_pos
)
6246 /* For bidi iteration, we need to prime prev_stop and
6247 base_level_stop with our best estimations. */
6248 /* Implementation note: Of course, POS is not necessarily a
6249 stop position, so assigning prev_pos to it is a lie; we
6250 should have called compute_stop_backwards. However, if
6251 the current buffer does not include any R2L characters,
6252 that call would be a waste of cycles, because the
6253 iterator will never move back, and thus never cross this
6254 "fake" stop position. So we delay that backward search
6255 until the time we really need it, in next_element_from_buffer. */
6256 if (CHARPOS (pos
) != it
->prev_stop
)
6257 it
->prev_stop
= CHARPOS (pos
);
6258 if (CHARPOS (pos
) < it
->base_level_stop
)
6259 it
->base_level_stop
= 0; /* meaning it's unknown */
6265 it
->prev_stop
= it
->base_level_stop
= 0;
6274 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6275 IT->stop_pos to POS, also. */
6278 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6280 /* Don't call this function when scanning a C string. */
6281 eassert (it
->s
== NULL
);
6283 /* POS must be a reasonable value. */
6284 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6286 it
->current
.pos
= it
->position
= pos
;
6287 it
->end_charpos
= ZV
;
6289 it
->current
.dpvec_index
= -1;
6290 it
->current
.overlay_string_index
= -1;
6291 IT_STRING_CHARPOS (*it
) = -1;
6292 IT_STRING_BYTEPOS (*it
) = -1;
6294 it
->method
= GET_FROM_BUFFER
;
6295 it
->object
= it
->w
->buffer
;
6296 it
->area
= TEXT_AREA
;
6297 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6299 it
->string_from_display_prop_p
= 0;
6300 it
->string_from_prefix_prop_p
= 0;
6302 it
->from_disp_prop_p
= 0;
6303 it
->face_before_selective_p
= 0;
6306 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6308 bidi_unshelve_cache (NULL
, 0);
6309 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6310 it
->bidi_it
.string
.s
= NULL
;
6311 it
->bidi_it
.string
.lstring
= Qnil
;
6312 it
->bidi_it
.string
.bufpos
= 0;
6313 it
->bidi_it
.string
.unibyte
= 0;
6318 it
->stop_charpos
= CHARPOS (pos
);
6319 it
->base_level_stop
= CHARPOS (pos
);
6321 /* This make the information stored in it->cmp_it invalidate. */
6326 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6327 If S is non-null, it is a C string to iterate over. Otherwise,
6328 STRING gives a Lisp string to iterate over.
6330 If PRECISION > 0, don't return more then PRECISION number of
6331 characters from the string.
6333 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6334 characters have been returned. FIELD_WIDTH < 0 means an infinite
6337 MULTIBYTE = 0 means disable processing of multibyte characters,
6338 MULTIBYTE > 0 means enable it,
6339 MULTIBYTE < 0 means use IT->multibyte_p.
6341 IT must be initialized via a prior call to init_iterator before
6342 calling this function. */
6345 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6346 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6349 /* No region in strings. */
6350 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6352 /* No text property checks performed by default, but see below. */
6353 it
->stop_charpos
= -1;
6355 /* Set iterator position and end position. */
6356 memset (&it
->current
, 0, sizeof it
->current
);
6357 it
->current
.overlay_string_index
= -1;
6358 it
->current
.dpvec_index
= -1;
6359 eassert (charpos
>= 0);
6361 /* If STRING is specified, use its multibyteness, otherwise use the
6362 setting of MULTIBYTE, if specified. */
6364 it
->multibyte_p
= multibyte
> 0;
6366 /* Bidirectional reordering of strings is controlled by the default
6367 value of bidi-display-reordering. Don't try to reorder while
6368 loading loadup.el, as the necessary character property tables are
6369 not yet available. */
6372 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6376 eassert (STRINGP (string
));
6377 it
->string
= string
;
6379 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6380 it
->method
= GET_FROM_STRING
;
6381 it
->current
.string_pos
= string_pos (charpos
, string
);
6385 it
->bidi_it
.string
.lstring
= string
;
6386 it
->bidi_it
.string
.s
= NULL
;
6387 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6388 it
->bidi_it
.string
.bufpos
= 0;
6389 it
->bidi_it
.string
.from_disp_str
= 0;
6390 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6391 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6392 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6397 it
->s
= (const unsigned char *) s
;
6400 /* Note that we use IT->current.pos, not it->current.string_pos,
6401 for displaying C strings. */
6402 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6403 if (it
->multibyte_p
)
6405 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6406 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6410 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6411 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6416 it
->bidi_it
.string
.lstring
= Qnil
;
6417 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6418 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6419 it
->bidi_it
.string
.bufpos
= 0;
6420 it
->bidi_it
.string
.from_disp_str
= 0;
6421 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6422 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6425 it
->method
= GET_FROM_C_STRING
;
6428 /* PRECISION > 0 means don't return more than PRECISION characters
6430 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6432 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6434 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6437 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6438 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6439 FIELD_WIDTH < 0 means infinite field width. This is useful for
6440 padding with `-' at the end of a mode line. */
6441 if (field_width
< 0)
6442 field_width
= INFINITY
;
6443 /* Implementation note: We deliberately don't enlarge
6444 it->bidi_it.string.schars here to fit it->end_charpos, because
6445 the bidi iterator cannot produce characters out of thin air. */
6446 if (field_width
> it
->end_charpos
- charpos
)
6447 it
->end_charpos
= charpos
+ field_width
;
6449 /* Use the standard display table for displaying strings. */
6450 if (DISP_TABLE_P (Vstandard_display_table
))
6451 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6453 it
->stop_charpos
= charpos
;
6454 it
->prev_stop
= charpos
;
6455 it
->base_level_stop
= 0;
6458 it
->bidi_it
.first_elt
= 1;
6459 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6460 it
->bidi_it
.disp_pos
= -1;
6462 if (s
== NULL
&& it
->multibyte_p
)
6464 ptrdiff_t endpos
= SCHARS (it
->string
);
6465 if (endpos
> it
->end_charpos
)
6466 endpos
= it
->end_charpos
;
6467 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6475 /***********************************************************************
6477 ***********************************************************************/
6479 /* Map enum it_method value to corresponding next_element_from_* function. */
6481 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6483 next_element_from_buffer
,
6484 next_element_from_display_vector
,
6485 next_element_from_string
,
6486 next_element_from_c_string
,
6487 next_element_from_image
,
6488 next_element_from_stretch
6491 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6494 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6495 (possibly with the following characters). */
6497 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6498 ((IT)->cmp_it.id >= 0 \
6499 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6500 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6501 END_CHARPOS, (IT)->w, \
6502 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6506 /* Lookup the char-table Vglyphless_char_display for character C (-1
6507 if we want information for no-font case), and return the display
6508 method symbol. By side-effect, update it->what and
6509 it->glyphless_method. This function is called from
6510 get_next_display_element for each character element, and from
6511 x_produce_glyphs when no suitable font was found. */
6514 lookup_glyphless_char_display (int c
, struct it
*it
)
6516 Lisp_Object glyphless_method
= Qnil
;
6518 if (CHAR_TABLE_P (Vglyphless_char_display
)
6519 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6523 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6524 if (CONSP (glyphless_method
))
6525 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6526 ? XCAR (glyphless_method
)
6527 : XCDR (glyphless_method
);
6530 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6534 if (NILP (glyphless_method
))
6537 /* The default is to display the character by a proper font. */
6539 /* The default for the no-font case is to display an empty box. */
6540 glyphless_method
= Qempty_box
;
6542 if (EQ (glyphless_method
, Qzero_width
))
6545 return glyphless_method
;
6546 /* This method can't be used for the no-font case. */
6547 glyphless_method
= Qempty_box
;
6549 if (EQ (glyphless_method
, Qthin_space
))
6550 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6551 else if (EQ (glyphless_method
, Qempty_box
))
6552 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6553 else if (EQ (glyphless_method
, Qhex_code
))
6554 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6555 else if (STRINGP (glyphless_method
))
6556 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6559 /* Invalid value. We use the default method. */
6560 glyphless_method
= Qnil
;
6563 it
->what
= IT_GLYPHLESS
;
6564 return glyphless_method
;
6567 /* Load IT's display element fields with information about the next
6568 display element from the current position of IT. Value is zero if
6569 end of buffer (or C string) is reached. */
6571 static struct frame
*last_escape_glyph_frame
= NULL
;
6572 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6573 static int last_escape_glyph_merged_face_id
= 0;
6575 struct frame
*last_glyphless_glyph_frame
= NULL
;
6576 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6577 int last_glyphless_glyph_merged_face_id
= 0;
6580 get_next_display_element (struct it
*it
)
6582 /* Non-zero means that we found a display element. Zero means that
6583 we hit the end of what we iterate over. Performance note: the
6584 function pointer `method' used here turns out to be faster than
6585 using a sequence of if-statements. */
6589 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6591 if (it
->what
== IT_CHARACTER
)
6593 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6594 and only if (a) the resolved directionality of that character
6596 /* FIXME: Do we need an exception for characters from display
6598 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6599 it
->c
= bidi_mirror_char (it
->c
);
6600 /* Map via display table or translate control characters.
6601 IT->c, IT->len etc. have been set to the next character by
6602 the function call above. If we have a display table, and it
6603 contains an entry for IT->c, translate it. Don't do this if
6604 IT->c itself comes from a display table, otherwise we could
6605 end up in an infinite recursion. (An alternative could be to
6606 count the recursion depth of this function and signal an
6607 error when a certain maximum depth is reached.) Is it worth
6609 if (success_p
&& it
->dpvec
== NULL
)
6612 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6613 int nonascii_space_p
= 0;
6614 int nonascii_hyphen_p
= 0;
6615 int c
= it
->c
; /* This is the character to display. */
6617 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6619 eassert (SINGLE_BYTE_CHAR_P (c
));
6620 if (unibyte_display_via_language_environment
)
6622 c
= DECODE_CHAR (unibyte
, c
);
6624 c
= BYTE8_TO_CHAR (it
->c
);
6627 c
= BYTE8_TO_CHAR (it
->c
);
6631 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6634 struct Lisp_Vector
*v
= XVECTOR (dv
);
6636 /* Return the first character from the display table
6637 entry, if not empty. If empty, don't display the
6638 current character. */
6641 it
->dpvec_char_len
= it
->len
;
6642 it
->dpvec
= v
->contents
;
6643 it
->dpend
= v
->contents
+ v
->header
.size
;
6644 it
->current
.dpvec_index
= 0;
6645 it
->dpvec_face_id
= -1;
6646 it
->saved_face_id
= it
->face_id
;
6647 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6652 set_iterator_to_next (it
, 0);
6657 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6659 if (it
->what
== IT_GLYPHLESS
)
6661 /* Don't display this character. */
6662 set_iterator_to_next (it
, 0);
6666 /* If `nobreak-char-display' is non-nil, we display
6667 non-ASCII spaces and hyphens specially. */
6668 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6671 nonascii_space_p
= 1;
6672 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6673 nonascii_hyphen_p
= 1;
6676 /* Translate control characters into `\003' or `^C' form.
6677 Control characters coming from a display table entry are
6678 currently not translated because we use IT->dpvec to hold
6679 the translation. This could easily be changed but I
6680 don't believe that it is worth doing.
6682 The characters handled by `nobreak-char-display' must be
6685 Non-printable characters and raw-byte characters are also
6686 translated to octal form. */
6687 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6688 ? (it
->area
!= TEXT_AREA
6689 /* In mode line, treat \n, \t like other crl chars. */
6692 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6693 || (c
!= '\n' && c
!= '\t'))
6695 || nonascii_hyphen_p
6697 || ! CHAR_PRINTABLE_P (c
))))
6699 /* C is a control character, non-ASCII space/hyphen,
6700 raw-byte, or a non-printable character which must be
6701 displayed either as '\003' or as `^C' where the '\\'
6702 and '^' can be defined in the display table. Fill
6703 IT->ctl_chars with glyphs for what we have to
6704 display. Then, set IT->dpvec to these glyphs. */
6711 /* Handle control characters with ^. */
6713 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6717 g
= '^'; /* default glyph for Control */
6718 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6720 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6722 g
= GLYPH_CODE_CHAR (gc
);
6723 lface_id
= GLYPH_CODE_FACE (gc
);
6727 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6729 else if (it
->f
== last_escape_glyph_frame
6730 && it
->face_id
== last_escape_glyph_face_id
)
6732 face_id
= last_escape_glyph_merged_face_id
;
6736 /* Merge the escape-glyph face into the current face. */
6737 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6739 last_escape_glyph_frame
= it
->f
;
6740 last_escape_glyph_face_id
= it
->face_id
;
6741 last_escape_glyph_merged_face_id
= face_id
;
6744 XSETINT (it
->ctl_chars
[0], g
);
6745 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6747 goto display_control
;
6750 /* Handle non-ascii space in the mode where it only gets
6753 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6755 /* Merge `nobreak-space' into the current face. */
6756 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6758 XSETINT (it
->ctl_chars
[0], ' ');
6760 goto display_control
;
6763 /* Handle sequences that start with the "escape glyph". */
6765 /* the default escape glyph is \. */
6766 escape_glyph
= '\\';
6769 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6771 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6772 lface_id
= GLYPH_CODE_FACE (gc
);
6776 /* The display table specified a face.
6777 Merge it into face_id and also into escape_glyph. */
6778 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6781 else if (it
->f
== last_escape_glyph_frame
6782 && it
->face_id
== last_escape_glyph_face_id
)
6784 face_id
= last_escape_glyph_merged_face_id
;
6788 /* Merge the escape-glyph face into the current face. */
6789 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6791 last_escape_glyph_frame
= it
->f
;
6792 last_escape_glyph_face_id
= it
->face_id
;
6793 last_escape_glyph_merged_face_id
= face_id
;
6796 /* Draw non-ASCII hyphen with just highlighting: */
6798 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6800 XSETINT (it
->ctl_chars
[0], '-');
6802 goto display_control
;
6805 /* Draw non-ASCII space/hyphen with escape glyph: */
6807 if (nonascii_space_p
|| nonascii_hyphen_p
)
6809 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6810 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6812 goto display_control
;
6819 if (CHAR_BYTE8_P (c
))
6820 /* Display \200 instead of \17777600. */
6821 c
= CHAR_TO_BYTE8 (c
);
6822 len
= sprintf (str
, "%03o", c
);
6824 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6825 for (i
= 0; i
< len
; i
++)
6826 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6831 /* Set up IT->dpvec and return first character from it. */
6832 it
->dpvec_char_len
= it
->len
;
6833 it
->dpvec
= it
->ctl_chars
;
6834 it
->dpend
= it
->dpvec
+ ctl_len
;
6835 it
->current
.dpvec_index
= 0;
6836 it
->dpvec_face_id
= face_id
;
6837 it
->saved_face_id
= it
->face_id
;
6838 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6842 it
->char_to_display
= c
;
6846 it
->char_to_display
= it
->c
;
6850 /* Adjust face id for a multibyte character. There are no multibyte
6851 character in unibyte text. */
6852 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6855 && FRAME_WINDOW_P (it
->f
))
6857 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6859 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6861 /* Automatic composition with glyph-string. */
6862 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6864 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6868 ptrdiff_t pos
= (it
->s
? -1
6869 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6870 : IT_CHARPOS (*it
));
6873 if (it
->what
== IT_CHARACTER
)
6874 c
= it
->char_to_display
;
6877 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6881 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6882 /* TAB in a composition means display glyphs with
6883 padding space on the left or right. */
6884 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6887 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6892 /* Is this character the last one of a run of characters with
6893 box? If yes, set IT->end_of_box_run_p to 1. */
6897 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6899 int face_id
= underlying_face_id (it
);
6900 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6904 if (face
->box
== FACE_NO_BOX
)
6906 /* If the box comes from face properties in a
6907 display string, check faces in that string. */
6908 int string_face_id
= face_after_it_pos (it
);
6909 it
->end_of_box_run_p
6910 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6913 /* Otherwise, the box comes from the underlying face.
6914 If this is the last string character displayed, check
6915 the next buffer location. */
6916 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6917 && (it
->current
.overlay_string_index
6918 == it
->n_overlay_strings
- 1))
6922 struct text_pos pos
= it
->current
.pos
;
6923 INC_TEXT_POS (pos
, it
->multibyte_p
);
6925 next_face_id
= face_at_buffer_position
6926 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6927 it
->region_end_charpos
, &ignore
,
6928 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6930 it
->end_of_box_run_p
6931 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6938 int face_id
= face_after_it_pos (it
);
6939 it
->end_of_box_run_p
6940 = (face_id
!= it
->face_id
6941 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6944 /* If we reached the end of the object we've been iterating (e.g., a
6945 display string or an overlay string), and there's something on
6946 IT->stack, proceed with what's on the stack. It doesn't make
6947 sense to return zero if there's unprocessed stuff on the stack,
6948 because otherwise that stuff will never be displayed. */
6949 if (!success_p
&& it
->sp
> 0)
6951 set_iterator_to_next (it
, 0);
6952 success_p
= get_next_display_element (it
);
6955 /* Value is 0 if end of buffer or string reached. */
6960 /* Move IT to the next display element.
6962 RESEAT_P non-zero means if called on a newline in buffer text,
6963 skip to the next visible line start.
6965 Functions get_next_display_element and set_iterator_to_next are
6966 separate because I find this arrangement easier to handle than a
6967 get_next_display_element function that also increments IT's
6968 position. The way it is we can first look at an iterator's current
6969 display element, decide whether it fits on a line, and if it does,
6970 increment the iterator position. The other way around we probably
6971 would either need a flag indicating whether the iterator has to be
6972 incremented the next time, or we would have to implement a
6973 decrement position function which would not be easy to write. */
6976 set_iterator_to_next (struct it
*it
, int reseat_p
)
6978 /* Reset flags indicating start and end of a sequence of characters
6979 with box. Reset them at the start of this function because
6980 moving the iterator to a new position might set them. */
6981 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6985 case GET_FROM_BUFFER
:
6986 /* The current display element of IT is a character from
6987 current_buffer. Advance in the buffer, and maybe skip over
6988 invisible lines that are so because of selective display. */
6989 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6990 reseat_at_next_visible_line_start (it
, 0);
6991 else if (it
->cmp_it
.id
>= 0)
6993 /* We are currently getting glyphs from a composition. */
6998 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6999 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7000 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7002 it
->cmp_it
.from
= it
->cmp_it
.to
;
7007 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7009 it
->end_charpos
, Qnil
);
7012 else if (! it
->cmp_it
.reversed_p
)
7014 /* Composition created while scanning forward. */
7015 /* Update IT's char/byte positions to point to the first
7016 character of the next grapheme cluster, or to the
7017 character visually after the current composition. */
7018 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7019 bidi_move_to_visually_next (&it
->bidi_it
);
7020 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7021 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7023 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7025 /* Proceed to the next grapheme cluster. */
7026 it
->cmp_it
.from
= it
->cmp_it
.to
;
7030 /* No more grapheme clusters in this composition.
7031 Find the next stop position. */
7032 ptrdiff_t stop
= it
->end_charpos
;
7033 if (it
->bidi_it
.scan_dir
< 0)
7034 /* Now we are scanning backward and don't know
7037 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7038 IT_BYTEPOS (*it
), stop
, Qnil
);
7043 /* Composition created while scanning backward. */
7044 /* Update IT's char/byte positions to point to the last
7045 character of the previous grapheme cluster, or the
7046 character visually after the current composition. */
7047 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7048 bidi_move_to_visually_next (&it
->bidi_it
);
7049 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7050 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7051 if (it
->cmp_it
.from
> 0)
7053 /* Proceed to the previous grapheme cluster. */
7054 it
->cmp_it
.to
= it
->cmp_it
.from
;
7058 /* No more grapheme clusters in this composition.
7059 Find the next stop position. */
7060 ptrdiff_t stop
= it
->end_charpos
;
7061 if (it
->bidi_it
.scan_dir
< 0)
7062 /* Now we are scanning backward and don't know
7065 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7066 IT_BYTEPOS (*it
), stop
, Qnil
);
7072 eassert (it
->len
!= 0);
7076 IT_BYTEPOS (*it
) += it
->len
;
7077 IT_CHARPOS (*it
) += 1;
7081 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7082 /* If this is a new paragraph, determine its base
7083 direction (a.k.a. its base embedding level). */
7084 if (it
->bidi_it
.new_paragraph
)
7085 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7086 bidi_move_to_visually_next (&it
->bidi_it
);
7087 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7088 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7089 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7091 /* As the scan direction was changed, we must
7092 re-compute the stop position for composition. */
7093 ptrdiff_t stop
= it
->end_charpos
;
7094 if (it
->bidi_it
.scan_dir
< 0)
7096 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7097 IT_BYTEPOS (*it
), stop
, Qnil
);
7100 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7104 case GET_FROM_C_STRING
:
7105 /* Current display element of IT is from a C string. */
7107 /* If the string position is beyond string's end, it means
7108 next_element_from_c_string is padding the string with
7109 blanks, in which case we bypass the bidi iterator,
7110 because it cannot deal with such virtual characters. */
7111 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7113 IT_BYTEPOS (*it
) += it
->len
;
7114 IT_CHARPOS (*it
) += 1;
7118 bidi_move_to_visually_next (&it
->bidi_it
);
7119 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7120 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7124 case GET_FROM_DISPLAY_VECTOR
:
7125 /* Current display element of IT is from a display table entry.
7126 Advance in the display table definition. Reset it to null if
7127 end reached, and continue with characters from buffers/
7129 ++it
->current
.dpvec_index
;
7131 /* Restore face of the iterator to what they were before the
7132 display vector entry (these entries may contain faces). */
7133 it
->face_id
= it
->saved_face_id
;
7135 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7137 int recheck_faces
= it
->ellipsis_p
;
7140 it
->method
= GET_FROM_C_STRING
;
7141 else if (STRINGP (it
->string
))
7142 it
->method
= GET_FROM_STRING
;
7145 it
->method
= GET_FROM_BUFFER
;
7146 it
->object
= it
->w
->buffer
;
7150 it
->current
.dpvec_index
= -1;
7152 /* Skip over characters which were displayed via IT->dpvec. */
7153 if (it
->dpvec_char_len
< 0)
7154 reseat_at_next_visible_line_start (it
, 1);
7155 else if (it
->dpvec_char_len
> 0)
7157 if (it
->method
== GET_FROM_STRING
7158 && it
->n_overlay_strings
> 0)
7159 it
->ignore_overlay_strings_at_pos_p
= 1;
7160 it
->len
= it
->dpvec_char_len
;
7161 set_iterator_to_next (it
, reseat_p
);
7164 /* Maybe recheck faces after display vector */
7166 it
->stop_charpos
= IT_CHARPOS (*it
);
7170 case GET_FROM_STRING
:
7171 /* Current display element is a character from a Lisp string. */
7172 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7173 /* Don't advance past string end. These conditions are true
7174 when set_iterator_to_next is called at the end of
7175 get_next_display_element, in which case the Lisp string is
7176 already exhausted, and all we want is pop the iterator
7178 if (it
->current
.overlay_string_index
>= 0)
7180 /* This is an overlay string, so there's no padding with
7181 spaces, and the number of characters in the string is
7182 where the string ends. */
7183 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7184 goto consider_string_end
;
7188 /* Not an overlay string. There could be padding, so test
7189 against it->end_charpos . */
7190 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7191 goto consider_string_end
;
7193 if (it
->cmp_it
.id
>= 0)
7199 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7200 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7201 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7202 it
->cmp_it
.from
= it
->cmp_it
.to
;
7206 composition_compute_stop_pos (&it
->cmp_it
,
7207 IT_STRING_CHARPOS (*it
),
7208 IT_STRING_BYTEPOS (*it
),
7209 it
->end_charpos
, it
->string
);
7212 else if (! it
->cmp_it
.reversed_p
)
7214 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7215 bidi_move_to_visually_next (&it
->bidi_it
);
7216 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7217 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7219 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7220 it
->cmp_it
.from
= it
->cmp_it
.to
;
7223 ptrdiff_t stop
= it
->end_charpos
;
7224 if (it
->bidi_it
.scan_dir
< 0)
7226 composition_compute_stop_pos (&it
->cmp_it
,
7227 IT_STRING_CHARPOS (*it
),
7228 IT_STRING_BYTEPOS (*it
), stop
,
7234 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7235 bidi_move_to_visually_next (&it
->bidi_it
);
7236 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7237 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7238 if (it
->cmp_it
.from
> 0)
7239 it
->cmp_it
.to
= it
->cmp_it
.from
;
7242 ptrdiff_t stop
= it
->end_charpos
;
7243 if (it
->bidi_it
.scan_dir
< 0)
7245 composition_compute_stop_pos (&it
->cmp_it
,
7246 IT_STRING_CHARPOS (*it
),
7247 IT_STRING_BYTEPOS (*it
), stop
,
7255 /* If the string position is beyond string's end, it
7256 means next_element_from_string is padding the string
7257 with blanks, in which case we bypass the bidi
7258 iterator, because it cannot deal with such virtual
7260 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7262 IT_STRING_BYTEPOS (*it
) += it
->len
;
7263 IT_STRING_CHARPOS (*it
) += 1;
7267 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7269 bidi_move_to_visually_next (&it
->bidi_it
);
7270 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7271 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7272 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7274 ptrdiff_t stop
= it
->end_charpos
;
7276 if (it
->bidi_it
.scan_dir
< 0)
7278 composition_compute_stop_pos (&it
->cmp_it
,
7279 IT_STRING_CHARPOS (*it
),
7280 IT_STRING_BYTEPOS (*it
), stop
,
7286 consider_string_end
:
7288 if (it
->current
.overlay_string_index
>= 0)
7290 /* IT->string is an overlay string. Advance to the
7291 next, if there is one. */
7292 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7295 next_overlay_string (it
);
7297 setup_for_ellipsis (it
, 0);
7302 /* IT->string is not an overlay string. If we reached
7303 its end, and there is something on IT->stack, proceed
7304 with what is on the stack. This can be either another
7305 string, this time an overlay string, or a buffer. */
7306 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7310 if (it
->method
== GET_FROM_STRING
)
7311 goto consider_string_end
;
7316 case GET_FROM_IMAGE
:
7317 case GET_FROM_STRETCH
:
7318 /* The position etc with which we have to proceed are on
7319 the stack. The position may be at the end of a string,
7320 if the `display' property takes up the whole string. */
7321 eassert (it
->sp
> 0);
7323 if (it
->method
== GET_FROM_STRING
)
7324 goto consider_string_end
;
7328 /* There are no other methods defined, so this should be a bug. */
7332 eassert (it
->method
!= GET_FROM_STRING
7333 || (STRINGP (it
->string
)
7334 && IT_STRING_CHARPOS (*it
) >= 0));
7337 /* Load IT's display element fields with information about the next
7338 display element which comes from a display table entry or from the
7339 result of translating a control character to one of the forms `^C'
7342 IT->dpvec holds the glyphs to return as characters.
7343 IT->saved_face_id holds the face id before the display vector--it
7344 is restored into IT->face_id in set_iterator_to_next. */
7347 next_element_from_display_vector (struct it
*it
)
7352 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7354 it
->face_id
= it
->saved_face_id
;
7356 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7357 That seemed totally bogus - so I changed it... */
7358 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7360 if (GLYPH_CODE_P (gc
))
7362 it
->c
= GLYPH_CODE_CHAR (gc
);
7363 it
->len
= CHAR_BYTES (it
->c
);
7365 /* The entry may contain a face id to use. Such a face id is
7366 the id of a Lisp face, not a realized face. A face id of
7367 zero means no face is specified. */
7368 if (it
->dpvec_face_id
>= 0)
7369 it
->face_id
= it
->dpvec_face_id
;
7372 int lface_id
= GLYPH_CODE_FACE (gc
);
7374 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7379 /* Display table entry is invalid. Return a space. */
7380 it
->c
= ' ', it
->len
= 1;
7382 /* Don't change position and object of the iterator here. They are
7383 still the values of the character that had this display table
7384 entry or was translated, and that's what we want. */
7385 it
->what
= IT_CHARACTER
;
7389 /* Get the first element of string/buffer in the visual order, after
7390 being reseated to a new position in a string or a buffer. */
7392 get_visually_first_element (struct it
*it
)
7394 int string_p
= STRINGP (it
->string
) || it
->s
;
7395 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7396 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7398 if (STRINGP (it
->string
))
7400 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7401 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7405 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7406 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7409 if (it
->bidi_it
.charpos
== eob
)
7411 /* Nothing to do, but reset the FIRST_ELT flag, like
7412 bidi_paragraph_init does, because we are not going to
7414 it
->bidi_it
.first_elt
= 0;
7416 else if (it
->bidi_it
.charpos
== bob
7418 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7419 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7421 /* If we are at the beginning of a line/string, we can produce
7422 the next element right away. */
7423 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7424 bidi_move_to_visually_next (&it
->bidi_it
);
7428 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7430 /* We need to prime the bidi iterator starting at the line's or
7431 string's beginning, before we will be able to produce the
7434 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7437 = find_next_newline_no_quit (IT_CHARPOS (*it
), -1,
7438 &it
->bidi_it
.bytepos
);
7439 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7442 /* Now return to buffer/string position where we were asked
7443 to get the next display element, and produce that. */
7444 bidi_move_to_visually_next (&it
->bidi_it
);
7446 while (it
->bidi_it
.bytepos
!= orig_bytepos
7447 && it
->bidi_it
.charpos
< eob
);
7450 /* Adjust IT's position information to where we ended up. */
7451 if (STRINGP (it
->string
))
7453 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7454 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7458 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7459 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7462 if (STRINGP (it
->string
) || !it
->s
)
7464 ptrdiff_t stop
, charpos
, bytepos
;
7466 if (STRINGP (it
->string
))
7469 stop
= SCHARS (it
->string
);
7470 if (stop
> it
->end_charpos
)
7471 stop
= it
->end_charpos
;
7472 charpos
= IT_STRING_CHARPOS (*it
);
7473 bytepos
= IT_STRING_BYTEPOS (*it
);
7477 stop
= it
->end_charpos
;
7478 charpos
= IT_CHARPOS (*it
);
7479 bytepos
= IT_BYTEPOS (*it
);
7481 if (it
->bidi_it
.scan_dir
< 0)
7483 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7488 /* Load IT with the next display element from Lisp string IT->string.
7489 IT->current.string_pos is the current position within the string.
7490 If IT->current.overlay_string_index >= 0, the Lisp string is an
7494 next_element_from_string (struct it
*it
)
7496 struct text_pos position
;
7498 eassert (STRINGP (it
->string
));
7499 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7500 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7501 position
= it
->current
.string_pos
;
7503 /* With bidi reordering, the character to display might not be the
7504 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7505 that we were reseat()ed to a new string, whose paragraph
7506 direction is not known. */
7507 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7509 get_visually_first_element (it
);
7510 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7513 /* Time to check for invisible text? */
7514 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7516 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7519 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7520 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7522 /* With bidi non-linear iteration, we could find
7523 ourselves far beyond the last computed stop_charpos,
7524 with several other stop positions in between that we
7525 missed. Scan them all now, in buffer's logical
7526 order, until we find and handle the last stop_charpos
7527 that precedes our current position. */
7528 handle_stop_backwards (it
, it
->stop_charpos
);
7529 return GET_NEXT_DISPLAY_ELEMENT (it
);
7535 /* Take note of the stop position we just moved
7536 across, for when we will move back across it. */
7537 it
->prev_stop
= it
->stop_charpos
;
7538 /* If we are at base paragraph embedding level, take
7539 note of the last stop position seen at this
7541 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7542 it
->base_level_stop
= it
->stop_charpos
;
7546 /* Since a handler may have changed IT->method, we must
7548 return GET_NEXT_DISPLAY_ELEMENT (it
);
7552 /* If we are before prev_stop, we may have overstepped
7553 on our way backwards a stop_pos, and if so, we need
7554 to handle that stop_pos. */
7555 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7556 /* We can sometimes back up for reasons that have nothing
7557 to do with bidi reordering. E.g., compositions. The
7558 code below is only needed when we are above the base
7559 embedding level, so test for that explicitly. */
7560 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7562 /* If we lost track of base_level_stop, we have no better
7563 place for handle_stop_backwards to start from than string
7564 beginning. This happens, e.g., when we were reseated to
7565 the previous screenful of text by vertical-motion. */
7566 if (it
->base_level_stop
<= 0
7567 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7568 it
->base_level_stop
= 0;
7569 handle_stop_backwards (it
, it
->base_level_stop
);
7570 return GET_NEXT_DISPLAY_ELEMENT (it
);
7574 if (it
->current
.overlay_string_index
>= 0)
7576 /* Get the next character from an overlay string. In overlay
7577 strings, there is no field width or padding with spaces to
7579 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7584 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7585 IT_STRING_BYTEPOS (*it
),
7586 it
->bidi_it
.scan_dir
< 0
7588 : SCHARS (it
->string
))
7589 && next_element_from_composition (it
))
7593 else if (STRING_MULTIBYTE (it
->string
))
7595 const unsigned char *s
= (SDATA (it
->string
)
7596 + IT_STRING_BYTEPOS (*it
));
7597 it
->c
= string_char_and_length (s
, &it
->len
);
7601 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7607 /* Get the next character from a Lisp string that is not an
7608 overlay string. Such strings come from the mode line, for
7609 example. We may have to pad with spaces, or truncate the
7610 string. See also next_element_from_c_string. */
7611 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7616 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7618 /* Pad with spaces. */
7619 it
->c
= ' ', it
->len
= 1;
7620 CHARPOS (position
) = BYTEPOS (position
) = -1;
7622 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7623 IT_STRING_BYTEPOS (*it
),
7624 it
->bidi_it
.scan_dir
< 0
7626 : it
->string_nchars
)
7627 && next_element_from_composition (it
))
7631 else if (STRING_MULTIBYTE (it
->string
))
7633 const unsigned char *s
= (SDATA (it
->string
)
7634 + IT_STRING_BYTEPOS (*it
));
7635 it
->c
= string_char_and_length (s
, &it
->len
);
7639 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7644 /* Record what we have and where it came from. */
7645 it
->what
= IT_CHARACTER
;
7646 it
->object
= it
->string
;
7647 it
->position
= position
;
7652 /* Load IT with next display element from C string IT->s.
7653 IT->string_nchars is the maximum number of characters to return
7654 from the string. IT->end_charpos may be greater than
7655 IT->string_nchars when this function is called, in which case we
7656 may have to return padding spaces. Value is zero if end of string
7657 reached, including padding spaces. */
7660 next_element_from_c_string (struct it
*it
)
7665 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7666 it
->what
= IT_CHARACTER
;
7667 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7670 /* With bidi reordering, the character to display might not be the
7671 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7672 we were reseated to a new string, whose paragraph direction is
7674 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7675 get_visually_first_element (it
);
7677 /* IT's position can be greater than IT->string_nchars in case a
7678 field width or precision has been specified when the iterator was
7680 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7682 /* End of the game. */
7686 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7688 /* Pad with spaces. */
7689 it
->c
= ' ', it
->len
= 1;
7690 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7692 else if (it
->multibyte_p
)
7693 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7695 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7701 /* Set up IT to return characters from an ellipsis, if appropriate.
7702 The definition of the ellipsis glyphs may come from a display table
7703 entry. This function fills IT with the first glyph from the
7704 ellipsis if an ellipsis is to be displayed. */
7707 next_element_from_ellipsis (struct it
*it
)
7709 if (it
->selective_display_ellipsis_p
)
7710 setup_for_ellipsis (it
, it
->len
);
7713 /* The face at the current position may be different from the
7714 face we find after the invisible text. Remember what it
7715 was in IT->saved_face_id, and signal that it's there by
7716 setting face_before_selective_p. */
7717 it
->saved_face_id
= it
->face_id
;
7718 it
->method
= GET_FROM_BUFFER
;
7719 it
->object
= it
->w
->buffer
;
7720 reseat_at_next_visible_line_start (it
, 1);
7721 it
->face_before_selective_p
= 1;
7724 return GET_NEXT_DISPLAY_ELEMENT (it
);
7728 /* Deliver an image display element. The iterator IT is already
7729 filled with image information (done in handle_display_prop). Value
7734 next_element_from_image (struct it
*it
)
7736 it
->what
= IT_IMAGE
;
7737 it
->ignore_overlay_strings_at_pos_p
= 0;
7742 /* Fill iterator IT with next display element from a stretch glyph
7743 property. IT->object is the value of the text property. Value is
7747 next_element_from_stretch (struct it
*it
)
7749 it
->what
= IT_STRETCH
;
7753 /* Scan backwards from IT's current position until we find a stop
7754 position, or until BEGV. This is called when we find ourself
7755 before both the last known prev_stop and base_level_stop while
7756 reordering bidirectional text. */
7759 compute_stop_pos_backwards (struct it
*it
)
7761 const int SCAN_BACK_LIMIT
= 1000;
7762 struct text_pos pos
;
7763 struct display_pos save_current
= it
->current
;
7764 struct text_pos save_position
= it
->position
;
7765 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7766 ptrdiff_t where_we_are
= charpos
;
7767 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7768 ptrdiff_t save_end_pos
= it
->end_charpos
;
7770 eassert (NILP (it
->string
) && !it
->s
);
7771 eassert (it
->bidi_p
);
7775 it
->end_charpos
= min (charpos
+ 1, ZV
);
7776 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7777 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
7778 reseat_1 (it
, pos
, 0);
7779 compute_stop_pos (it
);
7780 /* We must advance forward, right? */
7781 if (it
->stop_charpos
<= charpos
)
7784 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7786 if (it
->stop_charpos
<= where_we_are
)
7787 it
->prev_stop
= it
->stop_charpos
;
7789 it
->prev_stop
= BEGV
;
7791 it
->current
= save_current
;
7792 it
->position
= save_position
;
7793 it
->stop_charpos
= save_stop_pos
;
7794 it
->end_charpos
= save_end_pos
;
7797 /* Scan forward from CHARPOS in the current buffer/string, until we
7798 find a stop position > current IT's position. Then handle the stop
7799 position before that. This is called when we bump into a stop
7800 position while reordering bidirectional text. CHARPOS should be
7801 the last previously processed stop_pos (or BEGV/0, if none were
7802 processed yet) whose position is less that IT's current
7806 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7808 int bufp
= !STRINGP (it
->string
);
7809 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7810 struct display_pos save_current
= it
->current
;
7811 struct text_pos save_position
= it
->position
;
7812 struct text_pos pos1
;
7813 ptrdiff_t next_stop
;
7815 /* Scan in strict logical order. */
7816 eassert (it
->bidi_p
);
7820 it
->prev_stop
= charpos
;
7823 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7824 reseat_1 (it
, pos1
, 0);
7827 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7828 compute_stop_pos (it
);
7829 /* We must advance forward, right? */
7830 if (it
->stop_charpos
<= it
->prev_stop
)
7832 charpos
= it
->stop_charpos
;
7834 while (charpos
<= where_we_are
);
7837 it
->current
= save_current
;
7838 it
->position
= save_position
;
7839 next_stop
= it
->stop_charpos
;
7840 it
->stop_charpos
= it
->prev_stop
;
7842 it
->stop_charpos
= next_stop
;
7845 /* Load IT with the next display element from current_buffer. Value
7846 is zero if end of buffer reached. IT->stop_charpos is the next
7847 position at which to stop and check for text properties or buffer
7851 next_element_from_buffer (struct it
*it
)
7855 eassert (IT_CHARPOS (*it
) >= BEGV
);
7856 eassert (NILP (it
->string
) && !it
->s
);
7857 eassert (!it
->bidi_p
7858 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7859 && it
->bidi_it
.string
.s
== NULL
));
7861 /* With bidi reordering, the character to display might not be the
7862 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7863 we were reseat()ed to a new buffer position, which is potentially
7864 a different paragraph. */
7865 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7867 get_visually_first_element (it
);
7868 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7871 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7873 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7875 int overlay_strings_follow_p
;
7877 /* End of the game, except when overlay strings follow that
7878 haven't been returned yet. */
7879 if (it
->overlay_strings_at_end_processed_p
)
7880 overlay_strings_follow_p
= 0;
7883 it
->overlay_strings_at_end_processed_p
= 1;
7884 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7887 if (overlay_strings_follow_p
)
7888 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7892 it
->position
= it
->current
.pos
;
7896 else if (!(!it
->bidi_p
7897 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7898 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7900 /* With bidi non-linear iteration, we could find ourselves
7901 far beyond the last computed stop_charpos, with several
7902 other stop positions in between that we missed. Scan
7903 them all now, in buffer's logical order, until we find
7904 and handle the last stop_charpos that precedes our
7905 current position. */
7906 handle_stop_backwards (it
, it
->stop_charpos
);
7907 return GET_NEXT_DISPLAY_ELEMENT (it
);
7913 /* Take note of the stop position we just moved across,
7914 for when we will move back across it. */
7915 it
->prev_stop
= it
->stop_charpos
;
7916 /* If we are at base paragraph embedding level, take
7917 note of the last stop position seen at this
7919 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7920 it
->base_level_stop
= it
->stop_charpos
;
7923 return GET_NEXT_DISPLAY_ELEMENT (it
);
7927 /* If we are before prev_stop, we may have overstepped on
7928 our way backwards a stop_pos, and if so, we need to
7929 handle that stop_pos. */
7930 && IT_CHARPOS (*it
) < it
->prev_stop
7931 /* We can sometimes back up for reasons that have nothing
7932 to do with bidi reordering. E.g., compositions. The
7933 code below is only needed when we are above the base
7934 embedding level, so test for that explicitly. */
7935 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7937 if (it
->base_level_stop
<= 0
7938 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7940 /* If we lost track of base_level_stop, we need to find
7941 prev_stop by looking backwards. This happens, e.g., when
7942 we were reseated to the previous screenful of text by
7944 it
->base_level_stop
= BEGV
;
7945 compute_stop_pos_backwards (it
);
7946 handle_stop_backwards (it
, it
->prev_stop
);
7949 handle_stop_backwards (it
, it
->base_level_stop
);
7950 return GET_NEXT_DISPLAY_ELEMENT (it
);
7954 /* No face changes, overlays etc. in sight, so just return a
7955 character from current_buffer. */
7959 /* Maybe run the redisplay end trigger hook. Performance note:
7960 This doesn't seem to cost measurable time. */
7961 if (it
->redisplay_end_trigger_charpos
7963 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7964 run_redisplay_end_trigger_hook (it
);
7966 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7967 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7969 && next_element_from_composition (it
))
7974 /* Get the next character, maybe multibyte. */
7975 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7976 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7977 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7979 it
->c
= *p
, it
->len
= 1;
7981 /* Record what we have and where it came from. */
7982 it
->what
= IT_CHARACTER
;
7983 it
->object
= it
->w
->buffer
;
7984 it
->position
= it
->current
.pos
;
7986 /* Normally we return the character found above, except when we
7987 really want to return an ellipsis for selective display. */
7992 /* A value of selective > 0 means hide lines indented more
7993 than that number of columns. */
7994 if (it
->selective
> 0
7995 && IT_CHARPOS (*it
) + 1 < ZV
7996 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7997 IT_BYTEPOS (*it
) + 1,
8000 success_p
= next_element_from_ellipsis (it
);
8001 it
->dpvec_char_len
= -1;
8004 else if (it
->c
== '\r' && it
->selective
== -1)
8006 /* A value of selective == -1 means that everything from the
8007 CR to the end of the line is invisible, with maybe an
8008 ellipsis displayed for it. */
8009 success_p
= next_element_from_ellipsis (it
);
8010 it
->dpvec_char_len
= -1;
8015 /* Value is zero if end of buffer reached. */
8016 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8021 /* Run the redisplay end trigger hook for IT. */
8024 run_redisplay_end_trigger_hook (struct it
*it
)
8026 Lisp_Object args
[3];
8028 /* IT->glyph_row should be non-null, i.e. we should be actually
8029 displaying something, or otherwise we should not run the hook. */
8030 eassert (it
->glyph_row
);
8032 /* Set up hook arguments. */
8033 args
[0] = Qredisplay_end_trigger_functions
;
8034 args
[1] = it
->window
;
8035 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8036 it
->redisplay_end_trigger_charpos
= 0;
8038 /* Since we are *trying* to run these functions, don't try to run
8039 them again, even if they get an error. */
8040 wset_redisplay_end_trigger (it
->w
, Qnil
);
8041 Frun_hook_with_args (3, args
);
8043 /* Notice if it changed the face of the character we are on. */
8044 handle_face_prop (it
);
8048 /* Deliver a composition display element. Unlike the other
8049 next_element_from_XXX, this function is not registered in the array
8050 get_next_element[]. It is called from next_element_from_buffer and
8051 next_element_from_string when necessary. */
8054 next_element_from_composition (struct it
*it
)
8056 it
->what
= IT_COMPOSITION
;
8057 it
->len
= it
->cmp_it
.nbytes
;
8058 if (STRINGP (it
->string
))
8062 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8063 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8066 it
->position
= it
->current
.string_pos
;
8067 it
->object
= it
->string
;
8068 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8069 IT_STRING_BYTEPOS (*it
), it
->string
);
8075 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8076 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8079 if (it
->bidi_it
.new_paragraph
)
8080 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8081 /* Resync the bidi iterator with IT's new position.
8082 FIXME: this doesn't support bidirectional text. */
8083 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8084 bidi_move_to_visually_next (&it
->bidi_it
);
8088 it
->position
= it
->current
.pos
;
8089 it
->object
= it
->w
->buffer
;
8090 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8091 IT_BYTEPOS (*it
), Qnil
);
8098 /***********************************************************************
8099 Moving an iterator without producing glyphs
8100 ***********************************************************************/
8102 /* Check if iterator is at a position corresponding to a valid buffer
8103 position after some move_it_ call. */
8105 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8106 ((it)->method == GET_FROM_STRING \
8107 ? IT_STRING_CHARPOS (*it) == 0 \
8111 /* Move iterator IT to a specified buffer or X position within one
8112 line on the display without producing glyphs.
8114 OP should be a bit mask including some or all of these bits:
8115 MOVE_TO_X: Stop upon reaching x-position TO_X.
8116 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8117 Regardless of OP's value, stop upon reaching the end of the display line.
8119 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8120 This means, in particular, that TO_X includes window's horizontal
8123 The return value has several possible values that
8124 say what condition caused the scan to stop:
8126 MOVE_POS_MATCH_OR_ZV
8127 - when TO_POS or ZV was reached.
8130 -when TO_X was reached before TO_POS or ZV were reached.
8133 - when we reached the end of the display area and the line must
8137 - when we reached the end of the display area and the line is
8141 - when we stopped at a line end, i.e. a newline or a CR and selective
8144 static enum move_it_result
8145 move_it_in_display_line_to (struct it
*it
,
8146 ptrdiff_t to_charpos
, int to_x
,
8147 enum move_operation_enum op
)
8149 enum move_it_result result
= MOVE_UNDEFINED
;
8150 struct glyph_row
*saved_glyph_row
;
8151 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8152 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8153 void *ppos_data
= NULL
;
8155 enum it_method prev_method
= it
->method
;
8156 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8157 int saw_smaller_pos
= prev_pos
< to_charpos
;
8159 /* Don't produce glyphs in produce_glyphs. */
8160 saved_glyph_row
= it
->glyph_row
;
8161 it
->glyph_row
= NULL
;
8163 /* Use wrap_it to save a copy of IT wherever a word wrap could
8164 occur. Use atpos_it to save a copy of IT at the desired buffer
8165 position, if found, so that we can scan ahead and check if the
8166 word later overshoots the window edge. Use atx_it similarly, for
8172 /* Use ppos_it under bidi reordering to save a copy of IT for the
8173 position > CHARPOS that is the closest to CHARPOS. We restore
8174 that position in IT when we have scanned the entire display line
8175 without finding a match for CHARPOS and all the character
8176 positions are greater than CHARPOS. */
8179 SAVE_IT (ppos_it
, *it
, ppos_data
);
8180 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8181 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8182 SAVE_IT (ppos_it
, *it
, ppos_data
);
8185 #define BUFFER_POS_REACHED_P() \
8186 ((op & MOVE_TO_POS) != 0 \
8187 && BUFFERP (it->object) \
8188 && (IT_CHARPOS (*it) == to_charpos \
8190 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8191 && IT_CHARPOS (*it) > to_charpos) \
8192 || (it->what == IT_COMPOSITION \
8193 && ((IT_CHARPOS (*it) > to_charpos \
8194 && to_charpos >= it->cmp_it.charpos) \
8195 || (IT_CHARPOS (*it) < to_charpos \
8196 && to_charpos <= it->cmp_it.charpos)))) \
8197 && (it->method == GET_FROM_BUFFER \
8198 || (it->method == GET_FROM_DISPLAY_VECTOR \
8199 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8201 /* If there's a line-/wrap-prefix, handle it. */
8202 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8203 && it
->current_y
< it
->last_visible_y
)
8204 handle_line_prefix (it
);
8206 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8207 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8211 int x
, i
, ascent
= 0, descent
= 0;
8213 /* Utility macro to reset an iterator with x, ascent, and descent. */
8214 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8215 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8216 (IT)->max_descent = descent)
8218 /* Stop if we move beyond TO_CHARPOS (after an image or a
8219 display string or stretch glyph). */
8220 if ((op
& MOVE_TO_POS
) != 0
8221 && BUFFERP (it
->object
)
8222 && it
->method
== GET_FROM_BUFFER
8224 /* When the iterator is at base embedding level, we
8225 are guaranteed that characters are delivered for
8226 display in strictly increasing order of their
8227 buffer positions. */
8228 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8229 && IT_CHARPOS (*it
) > to_charpos
)
8231 && (prev_method
== GET_FROM_IMAGE
8232 || prev_method
== GET_FROM_STRETCH
8233 || prev_method
== GET_FROM_STRING
)
8234 /* Passed TO_CHARPOS from left to right. */
8235 && ((prev_pos
< to_charpos
8236 && IT_CHARPOS (*it
) > to_charpos
)
8237 /* Passed TO_CHARPOS from right to left. */
8238 || (prev_pos
> to_charpos
8239 && IT_CHARPOS (*it
) < to_charpos
)))))
8241 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8243 result
= MOVE_POS_MATCH_OR_ZV
;
8246 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8247 /* If wrap_it is valid, the current position might be in a
8248 word that is wrapped. So, save the iterator in
8249 atpos_it and continue to see if wrapping happens. */
8250 SAVE_IT (atpos_it
, *it
, atpos_data
);
8253 /* Stop when ZV reached.
8254 We used to stop here when TO_CHARPOS reached as well, but that is
8255 too soon if this glyph does not fit on this line. So we handle it
8256 explicitly below. */
8257 if (!get_next_display_element (it
))
8259 result
= MOVE_POS_MATCH_OR_ZV
;
8263 if (it
->line_wrap
== TRUNCATE
)
8265 if (BUFFER_POS_REACHED_P ())
8267 result
= MOVE_POS_MATCH_OR_ZV
;
8273 if (it
->line_wrap
== WORD_WRAP
)
8275 if (IT_DISPLAYING_WHITESPACE (it
))
8279 /* We have reached a glyph that follows one or more
8280 whitespace characters. If the position is
8281 already found, we are done. */
8282 if (atpos_it
.sp
>= 0)
8284 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8285 result
= MOVE_POS_MATCH_OR_ZV
;
8290 RESTORE_IT (it
, &atx_it
, atx_data
);
8291 result
= MOVE_X_REACHED
;
8294 /* Otherwise, we can wrap here. */
8295 SAVE_IT (wrap_it
, *it
, wrap_data
);
8301 /* Remember the line height for the current line, in case
8302 the next element doesn't fit on the line. */
8303 ascent
= it
->max_ascent
;
8304 descent
= it
->max_descent
;
8306 /* The call to produce_glyphs will get the metrics of the
8307 display element IT is loaded with. Record the x-position
8308 before this display element, in case it doesn't fit on the
8312 PRODUCE_GLYPHS (it
);
8314 if (it
->area
!= TEXT_AREA
)
8316 prev_method
= it
->method
;
8317 if (it
->method
== GET_FROM_BUFFER
)
8318 prev_pos
= IT_CHARPOS (*it
);
8319 set_iterator_to_next (it
, 1);
8320 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8321 SET_TEXT_POS (this_line_min_pos
,
8322 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8324 && (op
& MOVE_TO_POS
)
8325 && IT_CHARPOS (*it
) > to_charpos
8326 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8327 SAVE_IT (ppos_it
, *it
, ppos_data
);
8331 /* The number of glyphs we get back in IT->nglyphs will normally
8332 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8333 character on a terminal frame, or (iii) a line end. For the
8334 second case, IT->nglyphs - 1 padding glyphs will be present.
8335 (On X frames, there is only one glyph produced for a
8336 composite character.)
8338 The behavior implemented below means, for continuation lines,
8339 that as many spaces of a TAB as fit on the current line are
8340 displayed there. For terminal frames, as many glyphs of a
8341 multi-glyph character are displayed in the current line, too.
8342 This is what the old redisplay code did, and we keep it that
8343 way. Under X, the whole shape of a complex character must
8344 fit on the line or it will be completely displayed in the
8347 Note that both for tabs and padding glyphs, all glyphs have
8351 /* More than one glyph or glyph doesn't fit on line. All
8352 glyphs have the same width. */
8353 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8355 int x_before_this_char
= x
;
8356 int hpos_before_this_char
= it
->hpos
;
8358 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8360 new_x
= x
+ single_glyph_width
;
8362 /* We want to leave anything reaching TO_X to the caller. */
8363 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8365 if (BUFFER_POS_REACHED_P ())
8367 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8368 goto buffer_pos_reached
;
8369 if (atpos_it
.sp
< 0)
8371 SAVE_IT (atpos_it
, *it
, atpos_data
);
8372 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8377 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8380 result
= MOVE_X_REACHED
;
8385 SAVE_IT (atx_it
, *it
, atx_data
);
8386 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8391 if (/* Lines are continued. */
8392 it
->line_wrap
!= TRUNCATE
8393 && (/* And glyph doesn't fit on the line. */
8394 new_x
> it
->last_visible_x
8395 /* Or it fits exactly and we're on a window
8397 || (new_x
== it
->last_visible_x
8398 && FRAME_WINDOW_P (it
->f
)
8399 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8400 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8401 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8403 if (/* IT->hpos == 0 means the very first glyph
8404 doesn't fit on the line, e.g. a wide image. */
8406 || (new_x
== it
->last_visible_x
8407 && FRAME_WINDOW_P (it
->f
)))
8410 it
->current_x
= new_x
;
8412 /* The character's last glyph just barely fits
8414 if (i
== it
->nglyphs
- 1)
8416 /* If this is the destination position,
8417 return a position *before* it in this row,
8418 now that we know it fits in this row. */
8419 if (BUFFER_POS_REACHED_P ())
8421 if (it
->line_wrap
!= WORD_WRAP
8424 it
->hpos
= hpos_before_this_char
;
8425 it
->current_x
= x_before_this_char
;
8426 result
= MOVE_POS_MATCH_OR_ZV
;
8429 if (it
->line_wrap
== WORD_WRAP
8432 SAVE_IT (atpos_it
, *it
, atpos_data
);
8433 atpos_it
.current_x
= x_before_this_char
;
8434 atpos_it
.hpos
= hpos_before_this_char
;
8438 prev_method
= it
->method
;
8439 if (it
->method
== GET_FROM_BUFFER
)
8440 prev_pos
= IT_CHARPOS (*it
);
8441 set_iterator_to_next (it
, 1);
8442 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8443 SET_TEXT_POS (this_line_min_pos
,
8444 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8445 /* On graphical terminals, newlines may
8446 "overflow" into the fringe if
8447 overflow-newline-into-fringe is non-nil.
8448 On text terminals, and on graphical
8449 terminals with no right margin, newlines
8450 may overflow into the last glyph on the
8452 if (!FRAME_WINDOW_P (it
->f
)
8454 && it
->bidi_it
.paragraph_dir
== R2L
)
8455 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8456 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8457 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8459 if (!get_next_display_element (it
))
8461 result
= MOVE_POS_MATCH_OR_ZV
;
8464 if (BUFFER_POS_REACHED_P ())
8466 if (ITERATOR_AT_END_OF_LINE_P (it
))
8467 result
= MOVE_POS_MATCH_OR_ZV
;
8469 result
= MOVE_LINE_CONTINUED
;
8472 if (ITERATOR_AT_END_OF_LINE_P (it
))
8474 result
= MOVE_NEWLINE_OR_CR
;
8481 IT_RESET_X_ASCENT_DESCENT (it
);
8483 if (wrap_it
.sp
>= 0)
8485 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8490 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8492 result
= MOVE_LINE_CONTINUED
;
8496 if (BUFFER_POS_REACHED_P ())
8498 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8499 goto buffer_pos_reached
;
8500 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8502 SAVE_IT (atpos_it
, *it
, atpos_data
);
8503 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8507 if (new_x
> it
->first_visible_x
)
8509 /* Glyph is visible. Increment number of glyphs that
8510 would be displayed. */
8515 if (result
!= MOVE_UNDEFINED
)
8518 else if (BUFFER_POS_REACHED_P ())
8521 IT_RESET_X_ASCENT_DESCENT (it
);
8522 result
= MOVE_POS_MATCH_OR_ZV
;
8525 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8527 /* Stop when TO_X specified and reached. This check is
8528 necessary here because of lines consisting of a line end,
8529 only. The line end will not produce any glyphs and we
8530 would never get MOVE_X_REACHED. */
8531 eassert (it
->nglyphs
== 0);
8532 result
= MOVE_X_REACHED
;
8536 /* Is this a line end? If yes, we're done. */
8537 if (ITERATOR_AT_END_OF_LINE_P (it
))
8539 /* If we are past TO_CHARPOS, but never saw any character
8540 positions smaller than TO_CHARPOS, return
8541 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8543 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8545 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8547 if (IT_CHARPOS (ppos_it
) < ZV
)
8549 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8550 result
= MOVE_POS_MATCH_OR_ZV
;
8553 goto buffer_pos_reached
;
8555 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8556 && IT_CHARPOS (*it
) > to_charpos
)
8557 goto buffer_pos_reached
;
8559 result
= MOVE_NEWLINE_OR_CR
;
8562 result
= MOVE_NEWLINE_OR_CR
;
8566 prev_method
= it
->method
;
8567 if (it
->method
== GET_FROM_BUFFER
)
8568 prev_pos
= IT_CHARPOS (*it
);
8569 /* The current display element has been consumed. Advance
8571 set_iterator_to_next (it
, 1);
8572 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8573 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8574 if (IT_CHARPOS (*it
) < to_charpos
)
8575 saw_smaller_pos
= 1;
8577 && (op
& MOVE_TO_POS
)
8578 && IT_CHARPOS (*it
) >= to_charpos
8579 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8580 SAVE_IT (ppos_it
, *it
, ppos_data
);
8582 /* Stop if lines are truncated and IT's current x-position is
8583 past the right edge of the window now. */
8584 if (it
->line_wrap
== TRUNCATE
8585 && it
->current_x
>= it
->last_visible_x
)
8587 if (!FRAME_WINDOW_P (it
->f
)
8588 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8589 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8590 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8591 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8595 if ((at_eob_p
= !get_next_display_element (it
))
8596 || BUFFER_POS_REACHED_P ()
8597 /* If we are past TO_CHARPOS, but never saw any
8598 character positions smaller than TO_CHARPOS,
8599 return MOVE_POS_MATCH_OR_ZV, like the
8600 unidirectional display did. */
8601 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8603 && IT_CHARPOS (*it
) > to_charpos
))
8606 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8607 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8608 result
= MOVE_POS_MATCH_OR_ZV
;
8611 if (ITERATOR_AT_END_OF_LINE_P (it
))
8613 result
= MOVE_NEWLINE_OR_CR
;
8617 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8619 && IT_CHARPOS (*it
) > to_charpos
)
8621 if (IT_CHARPOS (ppos_it
) < ZV
)
8622 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8623 result
= MOVE_POS_MATCH_OR_ZV
;
8626 result
= MOVE_LINE_TRUNCATED
;
8629 #undef IT_RESET_X_ASCENT_DESCENT
8632 #undef BUFFER_POS_REACHED_P
8634 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8635 restore the saved iterator. */
8636 if (atpos_it
.sp
>= 0)
8637 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8638 else if (atx_it
.sp
>= 0)
8639 RESTORE_IT (it
, &atx_it
, atx_data
);
8644 bidi_unshelve_cache (atpos_data
, 1);
8646 bidi_unshelve_cache (atx_data
, 1);
8648 bidi_unshelve_cache (wrap_data
, 1);
8650 bidi_unshelve_cache (ppos_data
, 1);
8652 /* Restore the iterator settings altered at the beginning of this
8654 it
->glyph_row
= saved_glyph_row
;
8658 /* For external use. */
8660 move_it_in_display_line (struct it
*it
,
8661 ptrdiff_t to_charpos
, int to_x
,
8662 enum move_operation_enum op
)
8664 if (it
->line_wrap
== WORD_WRAP
8665 && (op
& MOVE_TO_X
))
8668 void *save_data
= NULL
;
8671 SAVE_IT (save_it
, *it
, save_data
);
8672 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8673 /* When word-wrap is on, TO_X may lie past the end
8674 of a wrapped line. Then it->current is the
8675 character on the next line, so backtrack to the
8676 space before the wrap point. */
8677 if (skip
== MOVE_LINE_CONTINUED
)
8679 int prev_x
= max (it
->current_x
- 1, 0);
8680 RESTORE_IT (it
, &save_it
, save_data
);
8681 move_it_in_display_line_to
8682 (it
, -1, prev_x
, MOVE_TO_X
);
8685 bidi_unshelve_cache (save_data
, 1);
8688 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8692 /* Move IT forward until it satisfies one or more of the criteria in
8693 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8695 OP is a bit-mask that specifies where to stop, and in particular,
8696 which of those four position arguments makes a difference. See the
8697 description of enum move_operation_enum.
8699 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8700 screen line, this function will set IT to the next position that is
8701 displayed to the right of TO_CHARPOS on the screen. */
8704 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8706 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8707 int line_height
, line_start_x
= 0, reached
= 0;
8708 void *backup_data
= NULL
;
8712 if (op
& MOVE_TO_VPOS
)
8714 /* If no TO_CHARPOS and no TO_X specified, stop at the
8715 start of the line TO_VPOS. */
8716 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8718 if (it
->vpos
== to_vpos
)
8724 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8728 /* TO_VPOS >= 0 means stop at TO_X in the line at
8729 TO_VPOS, or at TO_POS, whichever comes first. */
8730 if (it
->vpos
== to_vpos
)
8736 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8738 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8743 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8745 /* We have reached TO_X but not in the line we want. */
8746 skip
= move_it_in_display_line_to (it
, to_charpos
,
8748 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8756 else if (op
& MOVE_TO_Y
)
8758 struct it it_backup
;
8760 if (it
->line_wrap
== WORD_WRAP
)
8761 SAVE_IT (it_backup
, *it
, backup_data
);
8763 /* TO_Y specified means stop at TO_X in the line containing
8764 TO_Y---or at TO_CHARPOS if this is reached first. The
8765 problem is that we can't really tell whether the line
8766 contains TO_Y before we have completely scanned it, and
8767 this may skip past TO_X. What we do is to first scan to
8770 If TO_X is not specified, use a TO_X of zero. The reason
8771 is to make the outcome of this function more predictable.
8772 If we didn't use TO_X == 0, we would stop at the end of
8773 the line which is probably not what a caller would expect
8775 skip
= move_it_in_display_line_to
8776 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8777 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8779 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8780 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8782 else if (skip
== MOVE_X_REACHED
)
8784 /* If TO_X was reached, we want to know whether TO_Y is
8785 in the line. We know this is the case if the already
8786 scanned glyphs make the line tall enough. Otherwise,
8787 we must check by scanning the rest of the line. */
8788 line_height
= it
->max_ascent
+ it
->max_descent
;
8789 if (to_y
>= it
->current_y
8790 && to_y
< it
->current_y
+ line_height
)
8795 SAVE_IT (it_backup
, *it
, backup_data
);
8796 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8797 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8799 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8800 line_height
= it
->max_ascent
+ it
->max_descent
;
8801 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8803 if (to_y
>= it
->current_y
8804 && to_y
< it
->current_y
+ line_height
)
8806 /* If TO_Y is in this line and TO_X was reached
8807 above, we scanned too far. We have to restore
8808 IT's settings to the ones before skipping. But
8809 keep the more accurate values of max_ascent and
8810 max_descent we've found while skipping the rest
8811 of the line, for the sake of callers, such as
8812 pos_visible_p, that need to know the line
8814 int max_ascent
= it
->max_ascent
;
8815 int max_descent
= it
->max_descent
;
8817 RESTORE_IT (it
, &it_backup
, backup_data
);
8818 it
->max_ascent
= max_ascent
;
8819 it
->max_descent
= max_descent
;
8825 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8831 /* Check whether TO_Y is in this line. */
8832 line_height
= it
->max_ascent
+ it
->max_descent
;
8833 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8835 if (to_y
>= it
->current_y
8836 && to_y
< it
->current_y
+ line_height
)
8838 /* When word-wrap is on, TO_X may lie past the end
8839 of a wrapped line. Then it->current is the
8840 character on the next line, so backtrack to the
8841 space before the wrap point. */
8842 if (skip
== MOVE_LINE_CONTINUED
8843 && it
->line_wrap
== WORD_WRAP
)
8845 int prev_x
= max (it
->current_x
- 1, 0);
8846 RESTORE_IT (it
, &it_backup
, backup_data
);
8847 skip
= move_it_in_display_line_to
8848 (it
, -1, prev_x
, MOVE_TO_X
);
8857 else if (BUFFERP (it
->object
)
8858 && (it
->method
== GET_FROM_BUFFER
8859 || it
->method
== GET_FROM_STRETCH
)
8860 && IT_CHARPOS (*it
) >= to_charpos
8861 /* Under bidi iteration, a call to set_iterator_to_next
8862 can scan far beyond to_charpos if the initial
8863 portion of the next line needs to be reordered. In
8864 that case, give move_it_in_display_line_to another
8867 && it
->bidi_it
.scan_dir
== -1))
8868 skip
= MOVE_POS_MATCH_OR_ZV
;
8870 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8874 case MOVE_POS_MATCH_OR_ZV
:
8878 case MOVE_NEWLINE_OR_CR
:
8879 set_iterator_to_next (it
, 1);
8880 it
->continuation_lines_width
= 0;
8883 case MOVE_LINE_TRUNCATED
:
8884 it
->continuation_lines_width
= 0;
8885 reseat_at_next_visible_line_start (it
, 0);
8886 if ((op
& MOVE_TO_POS
) != 0
8887 && IT_CHARPOS (*it
) > to_charpos
)
8894 case MOVE_LINE_CONTINUED
:
8895 /* For continued lines ending in a tab, some of the glyphs
8896 associated with the tab are displayed on the current
8897 line. Since it->current_x does not include these glyphs,
8898 we use it->last_visible_x instead. */
8901 it
->continuation_lines_width
+= it
->last_visible_x
;
8902 /* When moving by vpos, ensure that the iterator really
8903 advances to the next line (bug#847, bug#969). Fixme:
8904 do we need to do this in other circumstances? */
8905 if (it
->current_x
!= it
->last_visible_x
8906 && (op
& MOVE_TO_VPOS
)
8907 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8909 line_start_x
= it
->current_x
+ it
->pixel_width
8910 - it
->last_visible_x
;
8911 set_iterator_to_next (it
, 0);
8915 it
->continuation_lines_width
+= it
->current_x
;
8922 /* Reset/increment for the next run. */
8923 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8924 it
->current_x
= line_start_x
;
8927 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8929 last_height
= it
->max_ascent
+ it
->max_descent
;
8930 last_max_ascent
= it
->max_ascent
;
8931 it
->max_ascent
= it
->max_descent
= 0;
8936 /* On text terminals, we may stop at the end of a line in the middle
8937 of a multi-character glyph. If the glyph itself is continued,
8938 i.e. it is actually displayed on the next line, don't treat this
8939 stopping point as valid; move to the next line instead (unless
8940 that brings us offscreen). */
8941 if (!FRAME_WINDOW_P (it
->f
)
8943 && IT_CHARPOS (*it
) == to_charpos
8944 && it
->what
== IT_CHARACTER
8946 && it
->line_wrap
== WINDOW_WRAP
8947 && it
->current_x
== it
->last_visible_x
- 1
8950 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8952 it
->continuation_lines_width
+= it
->current_x
;
8953 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8954 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8956 last_height
= it
->max_ascent
+ it
->max_descent
;
8957 last_max_ascent
= it
->max_ascent
;
8961 bidi_unshelve_cache (backup_data
, 1);
8963 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8967 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8969 If DY > 0, move IT backward at least that many pixels. DY = 0
8970 means move IT backward to the preceding line start or BEGV. This
8971 function may move over more than DY pixels if IT->current_y - DY
8972 ends up in the middle of a line; in this case IT->current_y will be
8973 set to the top of the line moved to. */
8976 move_it_vertically_backward (struct it
*it
, int dy
)
8980 void *it2data
= NULL
, *it3data
= NULL
;
8981 ptrdiff_t start_pos
;
8983 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
8984 ptrdiff_t pos_limit
;
8989 start_pos
= IT_CHARPOS (*it
);
8991 /* Estimate how many newlines we must move back. */
8992 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8993 if (it
->line_wrap
== TRUNCATE
)
8996 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
8998 /* Set the iterator's position that many lines back. But don't go
8999 back more than NLINES full screen lines -- this wins a day with
9000 buffers which have very long lines. */
9001 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9002 back_to_previous_visible_line_start (it
);
9004 /* Reseat the iterator here. When moving backward, we don't want
9005 reseat to skip forward over invisible text, set up the iterator
9006 to deliver from overlay strings at the new position etc. So,
9007 use reseat_1 here. */
9008 reseat_1 (it
, it
->current
.pos
, 1);
9010 /* We are now surely at a line start. */
9011 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9012 reordering is in effect. */
9013 it
->continuation_lines_width
= 0;
9015 /* Move forward and see what y-distance we moved. First move to the
9016 start of the next line so that we get its height. We need this
9017 height to be able to tell whether we reached the specified
9019 SAVE_IT (it2
, *it
, it2data
);
9020 it2
.max_ascent
= it2
.max_descent
= 0;
9023 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9024 MOVE_TO_POS
| MOVE_TO_VPOS
);
9026 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9027 /* If we are in a display string which starts at START_POS,
9028 and that display string includes a newline, and we are
9029 right after that newline (i.e. at the beginning of a
9030 display line), exit the loop, because otherwise we will
9031 infloop, since move_it_to will see that it is already at
9032 START_POS and will not move. */
9033 || (it2
.method
== GET_FROM_STRING
9034 && IT_CHARPOS (it2
) == start_pos
9035 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9036 eassert (IT_CHARPOS (*it
) >= BEGV
);
9037 SAVE_IT (it3
, it2
, it3data
);
9039 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9040 eassert (IT_CHARPOS (*it
) >= BEGV
);
9041 /* H is the actual vertical distance from the position in *IT
9042 and the starting position. */
9043 h
= it2
.current_y
- it
->current_y
;
9044 /* NLINES is the distance in number of lines. */
9045 nlines
= it2
.vpos
- it
->vpos
;
9047 /* Correct IT's y and vpos position
9048 so that they are relative to the starting point. */
9054 /* DY == 0 means move to the start of the screen line. The
9055 value of nlines is > 0 if continuation lines were involved,
9056 or if the original IT position was at start of a line. */
9057 RESTORE_IT (it
, it
, it2data
);
9059 move_it_by_lines (it
, nlines
);
9060 /* The above code moves us to some position NLINES down,
9061 usually to its first glyph (leftmost in an L2R line), but
9062 that's not necessarily the start of the line, under bidi
9063 reordering. We want to get to the character position
9064 that is immediately after the newline of the previous
9067 && !it
->continuation_lines_width
9068 && !STRINGP (it
->string
)
9069 && IT_CHARPOS (*it
) > BEGV
9070 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9073 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1, NULL
);
9075 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
9077 bidi_unshelve_cache (it3data
, 1);
9081 /* The y-position we try to reach, relative to *IT.
9082 Note that H has been subtracted in front of the if-statement. */
9083 int target_y
= it
->current_y
+ h
- dy
;
9084 int y0
= it3
.current_y
;
9088 RESTORE_IT (&it3
, &it3
, it3data
);
9089 y1
= line_bottom_y (&it3
);
9090 line_height
= y1
- y0
;
9091 RESTORE_IT (it
, it
, it2data
);
9092 /* If we did not reach target_y, try to move further backward if
9093 we can. If we moved too far backward, try to move forward. */
9094 if (target_y
< it
->current_y
9095 /* This is heuristic. In a window that's 3 lines high, with
9096 a line height of 13 pixels each, recentering with point
9097 on the bottom line will try to move -39/2 = 19 pixels
9098 backward. Try to avoid moving into the first line. */
9099 && (it
->current_y
- target_y
9100 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9101 && IT_CHARPOS (*it
) > BEGV
)
9103 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9104 target_y
- it
->current_y
));
9105 dy
= it
->current_y
- target_y
;
9106 goto move_further_back
;
9108 else if (target_y
>= it
->current_y
+ line_height
9109 && IT_CHARPOS (*it
) < ZV
)
9111 /* Should move forward by at least one line, maybe more.
9113 Note: Calling move_it_by_lines can be expensive on
9114 terminal frames, where compute_motion is used (via
9115 vmotion) to do the job, when there are very long lines
9116 and truncate-lines is nil. That's the reason for
9117 treating terminal frames specially here. */
9119 if (!FRAME_WINDOW_P (it
->f
))
9120 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9125 move_it_by_lines (it
, 1);
9127 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9134 /* Move IT by a specified amount of pixel lines DY. DY negative means
9135 move backwards. DY = 0 means move to start of screen line. At the
9136 end, IT will be on the start of a screen line. */
9139 move_it_vertically (struct it
*it
, int dy
)
9142 move_it_vertically_backward (it
, -dy
);
9145 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9146 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9147 MOVE_TO_POS
| MOVE_TO_Y
);
9148 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9150 /* If buffer ends in ZV without a newline, move to the start of
9151 the line to satisfy the post-condition. */
9152 if (IT_CHARPOS (*it
) == ZV
9154 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9155 move_it_by_lines (it
, 0);
9160 /* Move iterator IT past the end of the text line it is in. */
9163 move_it_past_eol (struct it
*it
)
9165 enum move_it_result rc
;
9167 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9168 if (rc
== MOVE_NEWLINE_OR_CR
)
9169 set_iterator_to_next (it
, 0);
9173 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9174 negative means move up. DVPOS == 0 means move to the start of the
9177 Optimization idea: If we would know that IT->f doesn't use
9178 a face with proportional font, we could be faster for
9179 truncate-lines nil. */
9182 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9185 /* The commented-out optimization uses vmotion on terminals. This
9186 gives bad results, because elements like it->what, on which
9187 callers such as pos_visible_p rely, aren't updated. */
9188 /* struct position pos;
9189 if (!FRAME_WINDOW_P (it->f))
9191 struct text_pos textpos;
9193 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9194 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9195 reseat (it, textpos, 1);
9196 it->vpos += pos.vpos;
9197 it->current_y += pos.vpos;
9203 /* DVPOS == 0 means move to the start of the screen line. */
9204 move_it_vertically_backward (it
, 0);
9205 /* Let next call to line_bottom_y calculate real line height */
9210 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9211 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9213 /* Only move to the next buffer position if we ended up in a
9214 string from display property, not in an overlay string
9215 (before-string or after-string). That is because the
9216 latter don't conceal the underlying buffer position, so
9217 we can ask to move the iterator to the exact position we
9218 are interested in. Note that, even if we are already at
9219 IT_CHARPOS (*it), the call below is not a no-op, as it
9220 will detect that we are at the end of the string, pop the
9221 iterator, and compute it->current_x and it->hpos
9223 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9224 -1, -1, -1, MOVE_TO_POS
);
9230 void *it2data
= NULL
;
9231 ptrdiff_t start_charpos
, i
;
9233 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9234 ptrdiff_t pos_limit
;
9236 /* Start at the beginning of the screen line containing IT's
9237 position. This may actually move vertically backwards,
9238 in case of overlays, so adjust dvpos accordingly. */
9240 move_it_vertically_backward (it
, 0);
9243 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9244 screen lines, and reseat the iterator there. */
9245 start_charpos
= IT_CHARPOS (*it
);
9246 if (it
->line_wrap
== TRUNCATE
)
9249 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9250 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9251 back_to_previous_visible_line_start (it
);
9252 reseat (it
, it
->current
.pos
, 1);
9254 /* Move further back if we end up in a string or an image. */
9255 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9257 /* First try to move to start of display line. */
9259 move_it_vertically_backward (it
, 0);
9261 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9263 /* If start of line is still in string or image,
9264 move further back. */
9265 back_to_previous_visible_line_start (it
);
9266 reseat (it
, it
->current
.pos
, 1);
9270 it
->current_x
= it
->hpos
= 0;
9272 /* Above call may have moved too far if continuation lines
9273 are involved. Scan forward and see if it did. */
9274 SAVE_IT (it2
, *it
, it2data
);
9275 it2
.vpos
= it2
.current_y
= 0;
9276 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9277 it
->vpos
-= it2
.vpos
;
9278 it
->current_y
-= it2
.current_y
;
9279 it
->current_x
= it
->hpos
= 0;
9281 /* If we moved too far back, move IT some lines forward. */
9282 if (it2
.vpos
> -dvpos
)
9284 int delta
= it2
.vpos
+ dvpos
;
9286 RESTORE_IT (&it2
, &it2
, it2data
);
9287 SAVE_IT (it2
, *it
, it2data
);
9288 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9289 /* Move back again if we got too far ahead. */
9290 if (IT_CHARPOS (*it
) >= start_charpos
)
9291 RESTORE_IT (it
, &it2
, it2data
);
9293 bidi_unshelve_cache (it2data
, 1);
9296 RESTORE_IT (it
, it
, it2data
);
9300 /* Return 1 if IT points into the middle of a display vector. */
9303 in_display_vector_p (struct it
*it
)
9305 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9306 && it
->current
.dpvec_index
> 0
9307 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9311 /***********************************************************************
9313 ***********************************************************************/
9316 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9320 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9322 Lisp_Object args
[3];
9323 Lisp_Object msg
, fmt
;
9326 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9330 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9332 args
[0] = fmt
= build_string (format
);
9335 msg
= Fformat (3, args
);
9337 len
= SBYTES (msg
) + 1;
9338 buffer
= SAFE_ALLOCA (len
);
9339 memcpy (buffer
, SDATA (msg
), len
);
9341 message_dolog (buffer
, len
- 1, 1, 0);
9348 /* Output a newline in the *Messages* buffer if "needs" one. */
9351 message_log_maybe_newline (void)
9353 if (message_log_need_newline
)
9354 message_dolog ("", 0, 1, 0);
9358 /* Add a string M of length NBYTES to the message log, optionally
9359 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9360 true, means interpret the contents of M as multibyte. This
9361 function calls low-level routines in order to bypass text property
9362 hooks, etc. which might not be safe to run.
9364 This may GC (insert may run before/after change hooks),
9365 so the buffer M must NOT point to a Lisp string. */
9368 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9370 const unsigned char *msg
= (const unsigned char *) m
;
9372 if (!NILP (Vmemory_full
))
9375 if (!NILP (Vmessage_log_max
))
9377 struct buffer
*oldbuf
;
9378 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9379 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9380 ptrdiff_t point_at_end
= 0;
9381 ptrdiff_t zv_at_end
= 0;
9382 Lisp_Object old_deactivate_mark
;
9384 struct gcpro gcpro1
;
9386 old_deactivate_mark
= Vdeactivate_mark
;
9387 oldbuf
= current_buffer
;
9388 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9389 bset_undo_list (current_buffer
, Qt
);
9391 oldpoint
= message_dolog_marker1
;
9392 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9393 oldbegv
= message_dolog_marker2
;
9394 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9395 oldzv
= message_dolog_marker3
;
9396 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9397 GCPRO1 (old_deactivate_mark
);
9405 BEGV_BYTE
= BEG_BYTE
;
9408 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9410 /* Insert the string--maybe converting multibyte to single byte
9411 or vice versa, so that all the text fits the buffer. */
9413 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9419 /* Convert a multibyte string to single-byte
9420 for the *Message* buffer. */
9421 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9423 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9424 work
[0] = (ASCII_CHAR_P (c
)
9426 : multibyte_char_to_unibyte (c
));
9427 insert_1_both (work
, 1, 1, 1, 0, 0);
9430 else if (! multibyte
9431 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9435 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9436 /* Convert a single-byte string to multibyte
9437 for the *Message* buffer. */
9438 for (i
= 0; i
< nbytes
; i
++)
9441 MAKE_CHAR_MULTIBYTE (c
);
9442 char_bytes
= CHAR_STRING (c
, str
);
9443 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9447 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
9451 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9454 insert_1_both ("\n", 1, 1, 1, 0, 0);
9456 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9458 this_bol_byte
= PT_BYTE
;
9460 /* See if this line duplicates the previous one.
9461 If so, combine duplicates. */
9464 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9466 prev_bol_byte
= PT_BYTE
;
9468 dups
= message_log_check_duplicate (prev_bol_byte
,
9472 del_range_both (prev_bol
, prev_bol_byte
,
9473 this_bol
, this_bol_byte
, 0);
9476 char dupstr
[sizeof " [ times]"
9477 + INT_STRLEN_BOUND (printmax_t
)];
9479 /* If you change this format, don't forget to also
9480 change message_log_check_duplicate. */
9481 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9482 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9483 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
9488 /* If we have more than the desired maximum number of lines
9489 in the *Messages* buffer now, delete the oldest ones.
9490 This is safe because we don't have undo in this buffer. */
9492 if (NATNUMP (Vmessage_log_max
))
9494 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9495 -XFASTINT (Vmessage_log_max
) - 1, 0);
9496 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9499 BEGV
= marker_position (oldbegv
);
9500 BEGV_BYTE
= marker_byte_position (oldbegv
);
9509 ZV
= marker_position (oldzv
);
9510 ZV_BYTE
= marker_byte_position (oldzv
);
9514 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9516 /* We can't do Fgoto_char (oldpoint) because it will run some
9518 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
9519 marker_byte_position (oldpoint
));
9522 unchain_marker (XMARKER (oldpoint
));
9523 unchain_marker (XMARKER (oldbegv
));
9524 unchain_marker (XMARKER (oldzv
));
9526 shown
= buffer_window_count (current_buffer
) > 0;
9527 set_buffer_internal (oldbuf
);
9529 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9530 message_log_need_newline
= !nlflag
;
9531 Vdeactivate_mark
= old_deactivate_mark
;
9536 /* We are at the end of the buffer after just having inserted a newline.
9537 (Note: We depend on the fact we won't be crossing the gap.)
9538 Check to see if the most recent message looks a lot like the previous one.
9539 Return 0 if different, 1 if the new one should just replace it, or a
9540 value N > 1 if we should also append " [N times]". */
9543 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9546 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9548 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9549 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9551 for (i
= 0; i
< len
; i
++)
9553 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
9561 if (*p1
++ == ' ' && *p1
++ == '[')
9564 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9565 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9572 /* Display an echo area message M with a specified length of NBYTES
9573 bytes. The string may include null characters. If M is not a
9574 string, clear out any existing message, and let the mini-buffer
9577 This function cancels echoing. */
9580 message3 (Lisp_Object m
)
9582 struct gcpro gcpro1
;
9585 clear_message (1,1);
9588 /* First flush out any partial line written with print. */
9589 message_log_maybe_newline ();
9592 ptrdiff_t nbytes
= SBYTES (m
);
9593 bool multibyte
= STRING_MULTIBYTE (m
);
9595 char *buffer
= SAFE_ALLOCA (nbytes
);
9596 memcpy (buffer
, SDATA (m
), nbytes
);
9597 message_dolog (buffer
, nbytes
, 1, multibyte
);
9606 /* The non-logging version of message3.
9607 This does not cancel echoing, because it is used for echoing.
9608 Perhaps we need to make a separate function for echoing
9609 and make this cancel echoing. */
9612 message3_nolog (Lisp_Object m
)
9614 struct frame
*sf
= SELECTED_FRAME ();
9616 if (FRAME_INITIAL_P (sf
))
9618 if (noninteractive_need_newline
)
9619 putc ('\n', stderr
);
9620 noninteractive_need_newline
= 0;
9622 fwrite (SDATA (m
), SBYTES (m
), 1, stderr
);
9623 if (cursor_in_echo_area
== 0)
9624 fprintf (stderr
, "\n");
9627 /* Error messages get reported properly by cmd_error, so this must be just an
9628 informative message; if the frame hasn't really been initialized yet, just
9630 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
9632 /* Get the frame containing the mini-buffer
9633 that the selected frame is using. */
9634 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9635 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
9636 struct frame
*f
= XFRAME (frame
);
9638 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
9639 Fmake_frame_visible (frame
);
9641 if (STRINGP (m
) && SCHARS (m
) > 0)
9644 if (minibuffer_auto_raise
)
9645 Fraise_frame (frame
);
9646 /* Assume we are not echoing.
9647 (If we are, echo_now will override this.) */
9648 echo_message_buffer
= Qnil
;
9651 clear_message (1, 1);
9653 do_pending_window_change (0);
9654 echo_area_display (1);
9655 do_pending_window_change (0);
9656 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
9657 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9662 /* Display a null-terminated echo area message M. If M is 0, clear
9663 out any existing message, and let the mini-buffer text show through.
9665 The buffer M must continue to exist until after the echo area gets
9666 cleared or some other message gets displayed there. Do not pass
9667 text that is stored in a Lisp string. Do not pass text in a buffer
9668 that was alloca'd. */
9671 message1 (const char *m
)
9673 message3 (m
? make_unibyte_string (m
, strlen (m
)) : Qnil
);
9677 /* The non-logging counterpart of message1. */
9680 message1_nolog (const char *m
)
9682 message3_nolog (m
? make_unibyte_string (m
, strlen (m
)) : Qnil
);
9685 /* Display a message M which contains a single %s
9686 which gets replaced with STRING. */
9689 message_with_string (const char *m
, Lisp_Object string
, int log
)
9691 CHECK_STRING (string
);
9697 if (noninteractive_need_newline
)
9698 putc ('\n', stderr
);
9699 noninteractive_need_newline
= 0;
9700 fprintf (stderr
, m
, SDATA (string
));
9701 if (!cursor_in_echo_area
)
9702 fprintf (stderr
, "\n");
9706 else if (INTERACTIVE
)
9708 /* The frame whose minibuffer we're going to display the message on.
9709 It may be larger than the selected frame, so we need
9710 to use its buffer, not the selected frame's buffer. */
9711 Lisp_Object mini_window
;
9712 struct frame
*f
, *sf
= SELECTED_FRAME ();
9714 /* Get the frame containing the minibuffer
9715 that the selected frame is using. */
9716 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9717 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9719 /* Error messages get reported properly by cmd_error, so this must be
9720 just an informative message; if the frame hasn't really been
9721 initialized yet, just toss it. */
9722 if (f
->glyphs_initialized_p
)
9724 Lisp_Object args
[2], msg
;
9725 struct gcpro gcpro1
, gcpro2
;
9727 args
[0] = build_string (m
);
9728 args
[1] = msg
= string
;
9729 GCPRO2 (args
[0], msg
);
9732 msg
= Fformat (2, args
);
9737 message3_nolog (msg
);
9741 /* Print should start at the beginning of the message
9742 buffer next time. */
9743 message_buf_print
= 0;
9749 /* Dump an informative message to the minibuf. If M is 0, clear out
9750 any existing message, and let the mini-buffer text show through. */
9753 vmessage (const char *m
, va_list ap
)
9759 if (noninteractive_need_newline
)
9760 putc ('\n', stderr
);
9761 noninteractive_need_newline
= 0;
9762 vfprintf (stderr
, m
, ap
);
9763 if (cursor_in_echo_area
== 0)
9764 fprintf (stderr
, "\n");
9768 else if (INTERACTIVE
)
9770 /* The frame whose mini-buffer we're going to display the message
9771 on. It may be larger than the selected frame, so we need to
9772 use its buffer, not the selected frame's buffer. */
9773 Lisp_Object mini_window
;
9774 struct frame
*f
, *sf
= SELECTED_FRAME ();
9776 /* Get the frame containing the mini-buffer
9777 that the selected frame is using. */
9778 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9779 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9781 /* Error messages get reported properly by cmd_error, so this must be
9782 just an informative message; if the frame hasn't really been
9783 initialized yet, just toss it. */
9784 if (f
->glyphs_initialized_p
)
9789 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
9790 char *message_buf
= alloca (maxsize
+ 1);
9792 len
= doprnt (message_buf
, maxsize
, m
, (char *)0, ap
);
9794 message3 (make_string (message_buf
, len
));
9799 /* Print should start at the beginning of the message
9800 buffer next time. */
9801 message_buf_print
= 0;
9807 message (const char *m
, ...)
9817 /* The non-logging version of message. */
9820 message_nolog (const char *m
, ...)
9822 Lisp_Object old_log_max
;
9825 old_log_max
= Vmessage_log_max
;
9826 Vmessage_log_max
= Qnil
;
9828 Vmessage_log_max
= old_log_max
;
9834 /* Display the current message in the current mini-buffer. This is
9835 only called from error handlers in process.c, and is not time
9839 update_echo_area (void)
9841 if (!NILP (echo_area_buffer
[0]))
9844 string
= Fcurrent_message ();
9850 /* Make sure echo area buffers in `echo_buffers' are live.
9851 If they aren't, make new ones. */
9854 ensure_echo_area_buffers (void)
9858 for (i
= 0; i
< 2; ++i
)
9859 if (!BUFFERP (echo_buffer
[i
])
9860 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
9863 Lisp_Object old_buffer
;
9866 old_buffer
= echo_buffer
[i
];
9867 echo_buffer
[i
] = Fget_buffer_create
9868 (make_formatted_string (name
, " *Echo Area %d*", i
));
9869 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
9870 /* to force word wrap in echo area -
9871 it was decided to postpone this*/
9872 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9874 for (j
= 0; j
< 2; ++j
)
9875 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9876 echo_area_buffer
[j
] = echo_buffer
[i
];
9881 /* Call FN with args A1..A2 with either the current or last displayed
9882 echo_area_buffer as current buffer.
9884 WHICH zero means use the current message buffer
9885 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9886 from echo_buffer[] and clear it.
9888 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9889 suitable buffer from echo_buffer[] and clear it.
9891 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9892 that the current message becomes the last displayed one, make
9893 choose a suitable buffer for echo_area_buffer[0], and clear it.
9895 Value is what FN returns. */
9898 with_echo_area_buffer (struct window
*w
, int which
,
9899 int (*fn
) (ptrdiff_t, Lisp_Object
),
9900 ptrdiff_t a1
, Lisp_Object a2
)
9903 int this_one
, the_other
, clear_buffer_p
, rc
;
9904 ptrdiff_t count
= SPECPDL_INDEX ();
9906 /* If buffers aren't live, make new ones. */
9907 ensure_echo_area_buffers ();
9912 this_one
= 0, the_other
= 1;
9914 this_one
= 1, the_other
= 0;
9917 this_one
= 0, the_other
= 1;
9920 /* We need a fresh one in case the current echo buffer equals
9921 the one containing the last displayed echo area message. */
9922 if (!NILP (echo_area_buffer
[this_one
])
9923 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9924 echo_area_buffer
[this_one
] = Qnil
;
9927 /* Choose a suitable buffer from echo_buffer[] is we don't
9929 if (NILP (echo_area_buffer
[this_one
]))
9931 echo_area_buffer
[this_one
]
9932 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9933 ? echo_buffer
[the_other
]
9934 : echo_buffer
[this_one
]);
9938 buffer
= echo_area_buffer
[this_one
];
9940 /* Don't get confused by reusing the buffer used for echoing
9941 for a different purpose. */
9942 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9945 record_unwind_protect (unwind_with_echo_area_buffer
,
9946 with_echo_area_buffer_unwind_data (w
));
9948 /* Make the echo area buffer current. Note that for display
9949 purposes, it is not necessary that the displayed window's buffer
9950 == current_buffer, except for text property lookup. So, let's
9951 only set that buffer temporarily here without doing a full
9952 Fset_window_buffer. We must also change w->pointm, though,
9953 because otherwise an assertions in unshow_buffer fails, and Emacs
9955 set_buffer_internal_1 (XBUFFER (buffer
));
9958 wset_buffer (w
, buffer
);
9959 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9962 bset_undo_list (current_buffer
, Qt
);
9963 bset_read_only (current_buffer
, Qnil
);
9964 specbind (Qinhibit_read_only
, Qt
);
9965 specbind (Qinhibit_modification_hooks
, Qt
);
9967 if (clear_buffer_p
&& Z
> BEG
)
9970 eassert (BEGV
>= BEG
);
9971 eassert (ZV
<= Z
&& ZV
>= BEGV
);
9975 eassert (BEGV
>= BEG
);
9976 eassert (ZV
<= Z
&& ZV
>= BEGV
);
9978 unbind_to (count
, Qnil
);
9983 /* Save state that should be preserved around the call to the function
9984 FN called in with_echo_area_buffer. */
9987 with_echo_area_buffer_unwind_data (struct window
*w
)
9990 Lisp_Object vector
, tmp
;
9992 /* Reduce consing by keeping one vector in
9993 Vwith_echo_area_save_vector. */
9994 vector
= Vwith_echo_area_save_vector
;
9995 Vwith_echo_area_save_vector
= Qnil
;
9998 vector
= Fmake_vector (make_number (7), Qnil
);
10000 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10001 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10002 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10006 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10007 ASET (vector
, i
, w
->buffer
); ++i
;
10008 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10009 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10014 for (; i
< end
; ++i
)
10015 ASET (vector
, i
, Qnil
);
10018 eassert (i
== ASIZE (vector
));
10023 /* Restore global state from VECTOR which was created by
10024 with_echo_area_buffer_unwind_data. */
10027 unwind_with_echo_area_buffer (Lisp_Object vector
)
10029 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10030 Vdeactivate_mark
= AREF (vector
, 1);
10031 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10033 if (WINDOWP (AREF (vector
, 3)))
10036 Lisp_Object buffer
, charpos
, bytepos
;
10038 w
= XWINDOW (AREF (vector
, 3));
10039 buffer
= AREF (vector
, 4);
10040 charpos
= AREF (vector
, 5);
10041 bytepos
= AREF (vector
, 6);
10043 wset_buffer (w
, buffer
);
10044 set_marker_both (w
->pointm
, buffer
,
10045 XFASTINT (charpos
), XFASTINT (bytepos
));
10048 Vwith_echo_area_save_vector
= vector
;
10053 /* Set up the echo area for use by print functions. MULTIBYTE_P
10054 non-zero means we will print multibyte. */
10057 setup_echo_area_for_printing (int multibyte_p
)
10059 /* If we can't find an echo area any more, exit. */
10060 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10061 Fkill_emacs (Qnil
);
10063 ensure_echo_area_buffers ();
10065 if (!message_buf_print
)
10067 /* A message has been output since the last time we printed.
10068 Choose a fresh echo area buffer. */
10069 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10070 echo_area_buffer
[0] = echo_buffer
[1];
10072 echo_area_buffer
[0] = echo_buffer
[0];
10074 /* Switch to that buffer and clear it. */
10075 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10076 bset_truncate_lines (current_buffer
, Qnil
);
10080 ptrdiff_t count
= SPECPDL_INDEX ();
10081 specbind (Qinhibit_read_only
, Qt
);
10082 /* Note that undo recording is always disabled. */
10083 del_range (BEG
, Z
);
10084 unbind_to (count
, Qnil
);
10086 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10088 /* Set up the buffer for the multibyteness we need. */
10090 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10091 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10093 /* Raise the frame containing the echo area. */
10094 if (minibuffer_auto_raise
)
10096 struct frame
*sf
= SELECTED_FRAME ();
10097 Lisp_Object mini_window
;
10098 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10099 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10102 message_log_maybe_newline ();
10103 message_buf_print
= 1;
10107 if (NILP (echo_area_buffer
[0]))
10109 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10110 echo_area_buffer
[0] = echo_buffer
[1];
10112 echo_area_buffer
[0] = echo_buffer
[0];
10115 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10117 /* Someone switched buffers between print requests. */
10118 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10119 bset_truncate_lines (current_buffer
, Qnil
);
10125 /* Display an echo area message in window W. Value is non-zero if W's
10126 height is changed. If display_last_displayed_message_p is
10127 non-zero, display the message that was last displayed, otherwise
10128 display the current message. */
10131 display_echo_area (struct window
*w
)
10133 int i
, no_message_p
, window_height_changed_p
;
10135 /* Temporarily disable garbage collections while displaying the echo
10136 area. This is done because a GC can print a message itself.
10137 That message would modify the echo area buffer's contents while a
10138 redisplay of the buffer is going on, and seriously confuse
10140 ptrdiff_t count
= inhibit_garbage_collection ();
10142 /* If there is no message, we must call display_echo_area_1
10143 nevertheless because it resizes the window. But we will have to
10144 reset the echo_area_buffer in question to nil at the end because
10145 with_echo_area_buffer will sets it to an empty buffer. */
10146 i
= display_last_displayed_message_p
? 1 : 0;
10147 no_message_p
= NILP (echo_area_buffer
[i
]);
10149 window_height_changed_p
10150 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10151 display_echo_area_1
,
10152 (intptr_t) w
, Qnil
);
10155 echo_area_buffer
[i
] = Qnil
;
10157 unbind_to (count
, Qnil
);
10158 return window_height_changed_p
;
10162 /* Helper for display_echo_area. Display the current buffer which
10163 contains the current echo area message in window W, a mini-window,
10164 a pointer to which is passed in A1. A2..A4 are currently not used.
10165 Change the height of W so that all of the message is displayed.
10166 Value is non-zero if height of W was changed. */
10169 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10172 struct window
*w
= (struct window
*) i1
;
10173 Lisp_Object window
;
10174 struct text_pos start
;
10175 int window_height_changed_p
= 0;
10177 /* Do this before displaying, so that we have a large enough glyph
10178 matrix for the display. If we can't get enough space for the
10179 whole text, display the last N lines. That works by setting w->start. */
10180 window_height_changed_p
= resize_mini_window (w
, 0);
10182 /* Use the starting position chosen by resize_mini_window. */
10183 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10186 clear_glyph_matrix (w
->desired_matrix
);
10187 XSETWINDOW (window
, w
);
10188 try_window (window
, start
, 0);
10190 return window_height_changed_p
;
10194 /* Resize the echo area window to exactly the size needed for the
10195 currently displayed message, if there is one. If a mini-buffer
10196 is active, don't shrink it. */
10199 resize_echo_area_exactly (void)
10201 if (BUFFERP (echo_area_buffer
[0])
10202 && WINDOWP (echo_area_window
))
10204 struct window
*w
= XWINDOW (echo_area_window
);
10206 Lisp_Object resize_exactly
;
10208 if (minibuf_level
== 0)
10209 resize_exactly
= Qt
;
10211 resize_exactly
= Qnil
;
10213 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10214 (intptr_t) w
, resize_exactly
);
10217 ++windows_or_buffers_changed
;
10218 ++update_mode_lines
;
10219 redisplay_internal ();
10225 /* Callback function for with_echo_area_buffer, when used from
10226 resize_echo_area_exactly. A1 contains a pointer to the window to
10227 resize, EXACTLY non-nil means resize the mini-window exactly to the
10228 size of the text displayed. A3 and A4 are not used. Value is what
10229 resize_mini_window returns. */
10232 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10235 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10239 /* Resize mini-window W to fit the size of its contents. EXACT_P
10240 means size the window exactly to the size needed. Otherwise, it's
10241 only enlarged until W's buffer is empty.
10243 Set W->start to the right place to begin display. If the whole
10244 contents fit, start at the beginning. Otherwise, start so as
10245 to make the end of the contents appear. This is particularly
10246 important for y-or-n-p, but seems desirable generally.
10248 Value is non-zero if the window height has been changed. */
10251 resize_mini_window (struct window
*w
, int exact_p
)
10253 struct frame
*f
= XFRAME (w
->frame
);
10254 int window_height_changed_p
= 0;
10256 eassert (MINI_WINDOW_P (w
));
10258 /* By default, start display at the beginning. */
10259 set_marker_both (w
->start
, w
->buffer
,
10260 BUF_BEGV (XBUFFER (w
->buffer
)),
10261 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10263 /* Don't resize windows while redisplaying a window; it would
10264 confuse redisplay functions when the size of the window they are
10265 displaying changes from under them. Such a resizing can happen,
10266 for instance, when which-func prints a long message while
10267 we are running fontification-functions. We're running these
10268 functions with safe_call which binds inhibit-redisplay to t. */
10269 if (!NILP (Vinhibit_redisplay
))
10272 /* Nil means don't try to resize. */
10273 if (NILP (Vresize_mini_windows
)
10274 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10277 if (!FRAME_MINIBUF_ONLY_P (f
))
10280 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10281 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10283 EMACS_INT max_height
;
10284 int unit
= FRAME_LINE_HEIGHT (f
);
10285 struct text_pos start
;
10286 struct buffer
*old_current_buffer
= NULL
;
10288 if (current_buffer
!= XBUFFER (w
->buffer
))
10290 old_current_buffer
= current_buffer
;
10291 set_buffer_internal (XBUFFER (w
->buffer
));
10294 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10296 /* Compute the max. number of lines specified by the user. */
10297 if (FLOATP (Vmax_mini_window_height
))
10298 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10299 else if (INTEGERP (Vmax_mini_window_height
))
10300 max_height
= XINT (Vmax_mini_window_height
);
10302 max_height
= total_height
/ 4;
10304 /* Correct that max. height if it's bogus. */
10305 max_height
= clip_to_bounds (1, max_height
, total_height
);
10307 /* Find out the height of the text in the window. */
10308 if (it
.line_wrap
== TRUNCATE
)
10313 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10314 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10315 height
= it
.current_y
+ last_height
;
10317 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10318 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10319 height
= (height
+ unit
- 1) / unit
;
10322 /* Compute a suitable window start. */
10323 if (height
> max_height
)
10325 height
= max_height
;
10326 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10327 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10328 start
= it
.current
.pos
;
10331 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10332 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10334 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10336 /* Let it grow only, until we display an empty message, in which
10337 case the window shrinks again. */
10338 if (height
> WINDOW_TOTAL_LINES (w
))
10340 int old_height
= WINDOW_TOTAL_LINES (w
);
10341 freeze_window_starts (f
, 1);
10342 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10343 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10345 else if (height
< WINDOW_TOTAL_LINES (w
)
10346 && (exact_p
|| BEGV
== ZV
))
10348 int old_height
= WINDOW_TOTAL_LINES (w
);
10349 freeze_window_starts (f
, 0);
10350 shrink_mini_window (w
);
10351 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10356 /* Always resize to exact size needed. */
10357 if (height
> WINDOW_TOTAL_LINES (w
))
10359 int old_height
= WINDOW_TOTAL_LINES (w
);
10360 freeze_window_starts (f
, 1);
10361 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10362 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10364 else if (height
< WINDOW_TOTAL_LINES (w
))
10366 int old_height
= WINDOW_TOTAL_LINES (w
);
10367 freeze_window_starts (f
, 0);
10368 shrink_mini_window (w
);
10372 freeze_window_starts (f
, 1);
10373 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10376 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10380 if (old_current_buffer
)
10381 set_buffer_internal (old_current_buffer
);
10384 return window_height_changed_p
;
10388 /* Value is the current message, a string, or nil if there is no
10389 current message. */
10392 current_message (void)
10396 if (!BUFFERP (echo_area_buffer
[0]))
10400 with_echo_area_buffer (0, 0, current_message_1
,
10401 (intptr_t) &msg
, Qnil
);
10403 echo_area_buffer
[0] = Qnil
;
10411 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10414 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10417 *msg
= make_buffer_string (BEG
, Z
, 1);
10424 /* Push the current message on Vmessage_stack for later restoration
10425 by restore_message. Value is non-zero if the current message isn't
10426 empty. This is a relatively infrequent operation, so it's not
10427 worth optimizing. */
10430 push_message (void)
10432 Lisp_Object msg
= current_message ();
10433 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10434 return STRINGP (msg
);
10438 /* Restore message display from the top of Vmessage_stack. */
10441 restore_message (void)
10443 eassert (CONSP (Vmessage_stack
));
10444 message3_nolog (XCAR (Vmessage_stack
));
10448 /* Handler for record_unwind_protect calling pop_message. */
10451 pop_message_unwind (Lisp_Object dummy
)
10457 /* Pop the top-most entry off Vmessage_stack. */
10462 eassert (CONSP (Vmessage_stack
));
10463 Vmessage_stack
= XCDR (Vmessage_stack
);
10467 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10468 exits. If the stack is not empty, we have a missing pop_message
10472 check_message_stack (void)
10474 if (!NILP (Vmessage_stack
))
10479 /* Truncate to NCHARS what will be displayed in the echo area the next
10480 time we display it---but don't redisplay it now. */
10483 truncate_echo_area (ptrdiff_t nchars
)
10486 echo_area_buffer
[0] = Qnil
;
10487 else if (!noninteractive
10489 && !NILP (echo_area_buffer
[0]))
10491 struct frame
*sf
= SELECTED_FRAME ();
10492 /* Error messages get reported properly by cmd_error, so this must be
10493 just an informative message; if the frame hasn't really been
10494 initialized yet, just toss it. */
10495 if (sf
->glyphs_initialized_p
)
10496 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
10501 /* Helper function for truncate_echo_area. Truncate the current
10502 message to at most NCHARS characters. */
10505 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
10507 if (BEG
+ nchars
< Z
)
10508 del_range (BEG
+ nchars
, Z
);
10510 echo_area_buffer
[0] = Qnil
;
10514 /* Set the current message to STRING. */
10517 set_message (Lisp_Object string
)
10519 eassert (STRINGP (string
));
10521 message_enable_multibyte
= STRING_MULTIBYTE (string
);
10523 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
10524 message_buf_print
= 0;
10525 help_echo_showing_p
= 0;
10527 if (STRINGP (Vdebug_on_message
)
10528 && fast_string_match (Vdebug_on_message
, string
) >= 0)
10529 call_debugger (list2 (Qerror
, string
));
10533 /* Helper function for set_message. First argument is ignored and second
10534 argument has the same meaning as for set_message.
10535 This function is called with the echo area buffer being current. */
10538 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
10540 eassert (STRINGP (string
));
10542 /* Change multibyteness of the echo buffer appropriately. */
10543 if (message_enable_multibyte
10544 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10545 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10547 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
10548 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10549 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
10551 /* Insert new message at BEG. */
10552 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10554 /* This function takes care of single/multibyte conversion.
10555 We just have to ensure that the echo area buffer has the right
10556 setting of enable_multibyte_characters. */
10557 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
10563 /* Clear messages. CURRENT_P non-zero means clear the current
10564 message. LAST_DISPLAYED_P non-zero means clear the message
10568 clear_message (int current_p
, int last_displayed_p
)
10572 echo_area_buffer
[0] = Qnil
;
10573 message_cleared_p
= 1;
10576 if (last_displayed_p
)
10577 echo_area_buffer
[1] = Qnil
;
10579 message_buf_print
= 0;
10582 /* Clear garbaged frames.
10584 This function is used where the old redisplay called
10585 redraw_garbaged_frames which in turn called redraw_frame which in
10586 turn called clear_frame. The call to clear_frame was a source of
10587 flickering. I believe a clear_frame is not necessary. It should
10588 suffice in the new redisplay to invalidate all current matrices,
10589 and ensure a complete redisplay of all windows. */
10592 clear_garbaged_frames (void)
10594 if (frame_garbaged
)
10596 Lisp_Object tail
, frame
;
10597 int changed_count
= 0;
10599 FOR_EACH_FRAME (tail
, frame
)
10601 struct frame
*f
= XFRAME (frame
);
10603 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10608 f
->force_flush_display_p
= 1;
10610 clear_current_matrices (f
);
10617 frame_garbaged
= 0;
10619 ++windows_or_buffers_changed
;
10624 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10625 is non-zero update selected_frame. Value is non-zero if the
10626 mini-windows height has been changed. */
10629 echo_area_display (int update_frame_p
)
10631 Lisp_Object mini_window
;
10634 int window_height_changed_p
= 0;
10635 struct frame
*sf
= SELECTED_FRAME ();
10637 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10638 w
= XWINDOW (mini_window
);
10639 f
= XFRAME (WINDOW_FRAME (w
));
10641 /* Don't display if frame is invisible or not yet initialized. */
10642 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10645 #ifdef HAVE_WINDOW_SYSTEM
10646 /* When Emacs starts, selected_frame may be the initial terminal
10647 frame. If we let this through, a message would be displayed on
10649 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10651 #endif /* HAVE_WINDOW_SYSTEM */
10653 /* Redraw garbaged frames. */
10654 clear_garbaged_frames ();
10656 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10658 echo_area_window
= mini_window
;
10659 window_height_changed_p
= display_echo_area (w
);
10660 w
->must_be_updated_p
= 1;
10662 /* Update the display, unless called from redisplay_internal.
10663 Also don't update the screen during redisplay itself. The
10664 update will happen at the end of redisplay, and an update
10665 here could cause confusion. */
10666 if (update_frame_p
&& !redisplaying_p
)
10670 /* If the display update has been interrupted by pending
10671 input, update mode lines in the frame. Due to the
10672 pending input, it might have been that redisplay hasn't
10673 been called, so that mode lines above the echo area are
10674 garbaged. This looks odd, so we prevent it here. */
10675 if (!display_completed
)
10676 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10678 if (window_height_changed_p
10679 /* Don't do this if Emacs is shutting down. Redisplay
10680 needs to run hooks. */
10681 && !NILP (Vrun_hooks
))
10683 /* Must update other windows. Likewise as in other
10684 cases, don't let this update be interrupted by
10686 ptrdiff_t count
= SPECPDL_INDEX ();
10687 specbind (Qredisplay_dont_pause
, Qt
);
10688 windows_or_buffers_changed
= 1;
10689 redisplay_internal ();
10690 unbind_to (count
, Qnil
);
10692 else if (FRAME_WINDOW_P (f
) && n
== 0)
10694 /* Window configuration is the same as before.
10695 Can do with a display update of the echo area,
10696 unless we displayed some mode lines. */
10697 update_single_window (w
, 1);
10698 FRAME_RIF (f
)->flush_display (f
);
10701 update_frame (f
, 1, 1);
10703 /* If cursor is in the echo area, make sure that the next
10704 redisplay displays the minibuffer, so that the cursor will
10705 be replaced with what the minibuffer wants. */
10706 if (cursor_in_echo_area
)
10707 ++windows_or_buffers_changed
;
10710 else if (!EQ (mini_window
, selected_window
))
10711 windows_or_buffers_changed
++;
10713 /* Last displayed message is now the current message. */
10714 echo_area_buffer
[1] = echo_area_buffer
[0];
10715 /* Inform read_char that we're not echoing. */
10716 echo_message_buffer
= Qnil
;
10718 /* Prevent redisplay optimization in redisplay_internal by resetting
10719 this_line_start_pos. This is done because the mini-buffer now
10720 displays the message instead of its buffer text. */
10721 if (EQ (mini_window
, selected_window
))
10722 CHARPOS (this_line_start_pos
) = 0;
10724 return window_height_changed_p
;
10727 /* Nonzero if the current window's buffer is shown in more than one
10728 window and was modified since last redisplay. */
10731 buffer_shared_and_changed (void)
10733 return (buffer_window_count (current_buffer
) > 1
10734 && UNCHANGED_MODIFIED
< MODIFF
);
10737 /* Nonzero if W doesn't reflect the actual state of current buffer due
10738 to its text or overlays change. FIXME: this may be called when
10739 XBUFFER (w->buffer) != current_buffer, which looks suspicious. */
10742 window_outdated (struct window
*w
)
10744 return (w
->last_modified
< MODIFF
10745 || w
->last_overlay_modified
< OVERLAY_MODIFF
);
10748 /* Nonzero if W's buffer was changed but not saved or Transient Mark mode
10749 is enabled and mark of W's buffer was changed since last W's update. */
10752 window_buffer_changed (struct window
*w
)
10754 struct buffer
*b
= XBUFFER (w
->buffer
);
10756 eassert (BUFFER_LIVE_P (b
));
10758 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
)
10759 || ((!NILP (Vtransient_mark_mode
) && !NILP (BVAR (b
, mark_active
)))
10760 != (w
->region_showing
!= 0)));
10763 /* Nonzero if W has %c in its mode line and mode line should be updated. */
10766 mode_line_update_needed (struct window
*w
)
10768 return (w
->column_number_displayed
!= -1
10769 && !(PT
== w
->last_point
&& !window_outdated (w
))
10770 && (w
->column_number_displayed
!= current_column ()));
10773 /***********************************************************************
10774 Mode Lines and Frame Titles
10775 ***********************************************************************/
10777 /* A buffer for constructing non-propertized mode-line strings and
10778 frame titles in it; allocated from the heap in init_xdisp and
10779 resized as needed in store_mode_line_noprop_char. */
10781 static char *mode_line_noprop_buf
;
10783 /* The buffer's end, and a current output position in it. */
10785 static char *mode_line_noprop_buf_end
;
10786 static char *mode_line_noprop_ptr
;
10788 #define MODE_LINE_NOPROP_LEN(start) \
10789 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10792 MODE_LINE_DISPLAY
= 0,
10796 } mode_line_target
;
10798 /* Alist that caches the results of :propertize.
10799 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10800 static Lisp_Object mode_line_proptrans_alist
;
10802 /* List of strings making up the mode-line. */
10803 static Lisp_Object mode_line_string_list
;
10805 /* Base face property when building propertized mode line string. */
10806 static Lisp_Object mode_line_string_face
;
10807 static Lisp_Object mode_line_string_face_prop
;
10810 /* Unwind data for mode line strings */
10812 static Lisp_Object Vmode_line_unwind_vector
;
10815 format_mode_line_unwind_data (struct frame
*target_frame
,
10816 struct buffer
*obuf
,
10818 int save_proptrans
)
10820 Lisp_Object vector
, tmp
;
10822 /* Reduce consing by keeping one vector in
10823 Vwith_echo_area_save_vector. */
10824 vector
= Vmode_line_unwind_vector
;
10825 Vmode_line_unwind_vector
= Qnil
;
10828 vector
= Fmake_vector (make_number (10), Qnil
);
10830 ASET (vector
, 0, make_number (mode_line_target
));
10831 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10832 ASET (vector
, 2, mode_line_string_list
);
10833 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10834 ASET (vector
, 4, mode_line_string_face
);
10835 ASET (vector
, 5, mode_line_string_face_prop
);
10838 XSETBUFFER (tmp
, obuf
);
10841 ASET (vector
, 6, tmp
);
10842 ASET (vector
, 7, owin
);
10845 /* Similarly to `with-selected-window', if the operation selects
10846 a window on another frame, we must restore that frame's
10847 selected window, and (for a tty) the top-frame. */
10848 ASET (vector
, 8, target_frame
->selected_window
);
10849 if (FRAME_TERMCAP_P (target_frame
))
10850 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
10857 unwind_format_mode_line (Lisp_Object vector
)
10859 Lisp_Object old_window
= AREF (vector
, 7);
10860 Lisp_Object target_frame_window
= AREF (vector
, 8);
10861 Lisp_Object old_top_frame
= AREF (vector
, 9);
10863 mode_line_target
= XINT (AREF (vector
, 0));
10864 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10865 mode_line_string_list
= AREF (vector
, 2);
10866 if (! EQ (AREF (vector
, 3), Qt
))
10867 mode_line_proptrans_alist
= AREF (vector
, 3);
10868 mode_line_string_face
= AREF (vector
, 4);
10869 mode_line_string_face_prop
= AREF (vector
, 5);
10871 /* Select window before buffer, since it may change the buffer. */
10872 if (!NILP (old_window
))
10874 /* If the operation that we are unwinding had selected a window
10875 on a different frame, reset its frame-selected-window. For a
10876 text terminal, reset its top-frame if necessary. */
10877 if (!NILP (target_frame_window
))
10880 = WINDOW_FRAME (XWINDOW (target_frame_window
));
10882 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
10883 Fselect_window (target_frame_window
, Qt
);
10885 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
10886 Fselect_frame (old_top_frame
, Qt
);
10889 Fselect_window (old_window
, Qt
);
10892 if (!NILP (AREF (vector
, 6)))
10894 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10895 ASET (vector
, 6, Qnil
);
10898 Vmode_line_unwind_vector
= vector
;
10903 /* Store a single character C for the frame title in mode_line_noprop_buf.
10904 Re-allocate mode_line_noprop_buf if necessary. */
10907 store_mode_line_noprop_char (char c
)
10909 /* If output position has reached the end of the allocated buffer,
10910 increase the buffer's size. */
10911 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10913 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10914 ptrdiff_t size
= len
;
10915 mode_line_noprop_buf
=
10916 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10917 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10918 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10921 *mode_line_noprop_ptr
++ = c
;
10925 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10926 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10927 characters that yield more columns than PRECISION; PRECISION <= 0
10928 means copy the whole string. Pad with spaces until FIELD_WIDTH
10929 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10930 pad. Called from display_mode_element when it is used to build a
10934 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10936 const unsigned char *str
= (const unsigned char *) string
;
10938 ptrdiff_t dummy
, nbytes
;
10940 /* Copy at most PRECISION chars from STR. */
10941 nbytes
= strlen (string
);
10942 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10944 store_mode_line_noprop_char (*str
++);
10946 /* Fill up with spaces until FIELD_WIDTH reached. */
10947 while (field_width
> 0
10948 && n
< field_width
)
10950 store_mode_line_noprop_char (' ');
10957 /***********************************************************************
10959 ***********************************************************************/
10961 #ifdef HAVE_WINDOW_SYSTEM
10963 /* Set the title of FRAME, if it has changed. The title format is
10964 Vicon_title_format if FRAME is iconified, otherwise it is
10965 frame_title_format. */
10968 x_consider_frame_title (Lisp_Object frame
)
10970 struct frame
*f
= XFRAME (frame
);
10972 if (FRAME_WINDOW_P (f
)
10973 || FRAME_MINIBUF_ONLY_P (f
)
10974 || f
->explicit_name
)
10976 /* Do we have more than one visible frame on this X display? */
10977 Lisp_Object tail
, other_frame
, fmt
;
10978 ptrdiff_t title_start
;
10982 ptrdiff_t count
= SPECPDL_INDEX ();
10984 FOR_EACH_FRAME (tail
, other_frame
)
10986 struct frame
*tf
= XFRAME (other_frame
);
10989 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10990 && !FRAME_MINIBUF_ONLY_P (tf
)
10991 && !EQ (other_frame
, tip_frame
)
10992 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10996 /* Set global variable indicating that multiple frames exist. */
10997 multiple_frames
= CONSP (tail
);
10999 /* Switch to the buffer of selected window of the frame. Set up
11000 mode_line_target so that display_mode_element will output into
11001 mode_line_noprop_buf; then display the title. */
11002 record_unwind_protect (unwind_format_mode_line
,
11003 format_mode_line_unwind_data
11004 (f
, current_buffer
, selected_window
, 0));
11006 Fselect_window (f
->selected_window
, Qt
);
11007 set_buffer_internal_1
11008 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
11009 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11011 mode_line_target
= MODE_LINE_TITLE
;
11012 title_start
= MODE_LINE_NOPROP_LEN (0);
11013 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11014 NULL
, DEFAULT_FACE_ID
);
11015 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11016 len
= MODE_LINE_NOPROP_LEN (title_start
);
11017 title
= mode_line_noprop_buf
+ title_start
;
11018 unbind_to (count
, Qnil
);
11020 /* Set the title only if it's changed. This avoids consing in
11021 the common case where it hasn't. (If it turns out that we've
11022 already wasted too much time by walking through the list with
11023 display_mode_element, then we might need to optimize at a
11024 higher level than this.) */
11025 if (! STRINGP (f
->name
)
11026 || SBYTES (f
->name
) != len
11027 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11028 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11032 #endif /* not HAVE_WINDOW_SYSTEM */
11035 /***********************************************************************
11037 ***********************************************************************/
11040 /* Prepare for redisplay by updating menu-bar item lists when
11041 appropriate. This can call eval. */
11044 prepare_menu_bars (void)
11047 struct gcpro gcpro1
, gcpro2
;
11049 Lisp_Object tooltip_frame
;
11051 #ifdef HAVE_WINDOW_SYSTEM
11052 tooltip_frame
= tip_frame
;
11054 tooltip_frame
= Qnil
;
11057 /* Update all frame titles based on their buffer names, etc. We do
11058 this before the menu bars so that the buffer-menu will show the
11059 up-to-date frame titles. */
11060 #ifdef HAVE_WINDOW_SYSTEM
11061 if (windows_or_buffers_changed
|| update_mode_lines
)
11063 Lisp_Object tail
, frame
;
11065 FOR_EACH_FRAME (tail
, frame
)
11067 f
= XFRAME (frame
);
11068 if (!EQ (frame
, tooltip_frame
)
11069 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
11070 x_consider_frame_title (frame
);
11073 #endif /* HAVE_WINDOW_SYSTEM */
11075 /* Update the menu bar item lists, if appropriate. This has to be
11076 done before any actual redisplay or generation of display lines. */
11077 all_windows
= (update_mode_lines
11078 || buffer_shared_and_changed ()
11079 || windows_or_buffers_changed
);
11082 Lisp_Object tail
, frame
;
11083 ptrdiff_t count
= SPECPDL_INDEX ();
11084 /* 1 means that update_menu_bar has run its hooks
11085 so any further calls to update_menu_bar shouldn't do so again. */
11086 int menu_bar_hooks_run
= 0;
11088 record_unwind_save_match_data ();
11090 FOR_EACH_FRAME (tail
, frame
)
11092 f
= XFRAME (frame
);
11094 /* Ignore tooltip frame. */
11095 if (EQ (frame
, tooltip_frame
))
11098 /* If a window on this frame changed size, report that to
11099 the user and clear the size-change flag. */
11100 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11102 Lisp_Object functions
;
11104 /* Clear flag first in case we get an error below. */
11105 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11106 functions
= Vwindow_size_change_functions
;
11107 GCPRO2 (tail
, functions
);
11109 while (CONSP (functions
))
11111 if (!EQ (XCAR (functions
), Qt
))
11112 call1 (XCAR (functions
), frame
);
11113 functions
= XCDR (functions
);
11119 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11120 #ifdef HAVE_WINDOW_SYSTEM
11121 update_tool_bar (f
, 0);
11124 if (windows_or_buffers_changed
11127 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->buffer
));
11132 unbind_to (count
, Qnil
);
11136 struct frame
*sf
= SELECTED_FRAME ();
11137 update_menu_bar (sf
, 1, 0);
11138 #ifdef HAVE_WINDOW_SYSTEM
11139 update_tool_bar (sf
, 1);
11145 /* Update the menu bar item list for frame F. This has to be done
11146 before we start to fill in any display lines, because it can call
11149 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11151 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11152 already ran the menu bar hooks for this redisplay, so there
11153 is no need to run them again. The return value is the
11154 updated value of this flag, to pass to the next call. */
11157 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11159 Lisp_Object window
;
11160 register struct window
*w
;
11162 /* If called recursively during a menu update, do nothing. This can
11163 happen when, for instance, an activate-menubar-hook causes a
11165 if (inhibit_menubar_update
)
11168 window
= FRAME_SELECTED_WINDOW (f
);
11169 w
= XWINDOW (window
);
11171 if (FRAME_WINDOW_P (f
)
11173 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11174 || defined (HAVE_NS) || defined (USE_GTK)
11175 FRAME_EXTERNAL_MENU_BAR (f
)
11177 FRAME_MENU_BAR_LINES (f
) > 0
11179 : FRAME_MENU_BAR_LINES (f
) > 0)
11181 /* If the user has switched buffers or windows, we need to
11182 recompute to reflect the new bindings. But we'll
11183 recompute when update_mode_lines is set too; that means
11184 that people can use force-mode-line-update to request
11185 that the menu bar be recomputed. The adverse effect on
11186 the rest of the redisplay algorithm is about the same as
11187 windows_or_buffers_changed anyway. */
11188 if (windows_or_buffers_changed
11189 /* This used to test w->update_mode_line, but we believe
11190 there is no need to recompute the menu in that case. */
11191 || update_mode_lines
11192 || window_buffer_changed (w
))
11194 struct buffer
*prev
= current_buffer
;
11195 ptrdiff_t count
= SPECPDL_INDEX ();
11197 specbind (Qinhibit_menubar_update
, Qt
);
11199 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11200 if (save_match_data
)
11201 record_unwind_save_match_data ();
11202 if (NILP (Voverriding_local_map_menu_flag
))
11204 specbind (Qoverriding_terminal_local_map
, Qnil
);
11205 specbind (Qoverriding_local_map
, Qnil
);
11210 /* Run the Lucid hook. */
11211 safe_run_hooks (Qactivate_menubar_hook
);
11213 /* If it has changed current-menubar from previous value,
11214 really recompute the menu-bar from the value. */
11215 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11216 call0 (Qrecompute_lucid_menubar
);
11218 safe_run_hooks (Qmenu_bar_update_hook
);
11223 XSETFRAME (Vmenu_updating_frame
, f
);
11224 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11226 /* Redisplay the menu bar in case we changed it. */
11227 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11228 || defined (HAVE_NS) || defined (USE_GTK)
11229 if (FRAME_WINDOW_P (f
))
11231 #if defined (HAVE_NS)
11232 /* All frames on Mac OS share the same menubar. So only
11233 the selected frame should be allowed to set it. */
11234 if (f
== SELECTED_FRAME ())
11236 set_frame_menubar (f
, 0, 0);
11239 /* On a terminal screen, the menu bar is an ordinary screen
11240 line, and this makes it get updated. */
11241 w
->update_mode_line
= 1;
11242 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11243 /* In the non-toolkit version, the menu bar is an ordinary screen
11244 line, and this makes it get updated. */
11245 w
->update_mode_line
= 1;
11246 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11248 unbind_to (count
, Qnil
);
11249 set_buffer_internal_1 (prev
);
11258 /***********************************************************************
11260 ***********************************************************************/
11262 #ifdef HAVE_WINDOW_SYSTEM
11265 Nominal cursor position -- where to draw output.
11266 HPOS and VPOS are window relative glyph matrix coordinates.
11267 X and Y are window relative pixel coordinates. */
11269 struct cursor_pos output_cursor
;
11273 Set the global variable output_cursor to CURSOR. All cursor
11274 positions are relative to updated_window. */
11277 set_output_cursor (struct cursor_pos
*cursor
)
11279 output_cursor
.hpos
= cursor
->hpos
;
11280 output_cursor
.vpos
= cursor
->vpos
;
11281 output_cursor
.x
= cursor
->x
;
11282 output_cursor
.y
= cursor
->y
;
11287 Set a nominal cursor position.
11289 HPOS and VPOS are column/row positions in a window glyph matrix. X
11290 and Y are window text area relative pixel positions.
11292 If this is done during an update, updated_window will contain the
11293 window that is being updated and the position is the future output
11294 cursor position for that window. If updated_window is null, use
11295 selected_window and display the cursor at the given position. */
11298 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11302 /* If updated_window is not set, work on selected_window. */
11303 if (updated_window
)
11304 w
= updated_window
;
11306 w
= XWINDOW (selected_window
);
11308 /* Set the output cursor. */
11309 output_cursor
.hpos
= hpos
;
11310 output_cursor
.vpos
= vpos
;
11311 output_cursor
.x
= x
;
11312 output_cursor
.y
= y
;
11314 /* If not called as part of an update, really display the cursor.
11315 This will also set the cursor position of W. */
11316 if (updated_window
== NULL
)
11319 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11320 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11321 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11326 #endif /* HAVE_WINDOW_SYSTEM */
11329 /***********************************************************************
11331 ***********************************************************************/
11333 #ifdef HAVE_WINDOW_SYSTEM
11335 /* Where the mouse was last time we reported a mouse event. */
11337 FRAME_PTR last_mouse_frame
;
11339 /* Tool-bar item index of the item on which a mouse button was pressed
11342 int last_tool_bar_item
;
11344 /* Select `frame' temporarily without running all the code in
11346 FIXME: Maybe do_switch_frame should be trimmed down similarly
11347 when `norecord' is set. */
11349 fast_set_selected_frame (Lisp_Object frame
)
11351 if (!EQ (selected_frame
, frame
))
11353 selected_frame
= frame
;
11354 selected_window
= XFRAME (frame
)->selected_window
;
11359 /* Update the tool-bar item list for frame F. This has to be done
11360 before we start to fill in any display lines. Called from
11361 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11362 and restore it here. */
11365 update_tool_bar (struct frame
*f
, int save_match_data
)
11367 #if defined (USE_GTK) || defined (HAVE_NS)
11368 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11370 int do_update
= WINDOWP (f
->tool_bar_window
)
11371 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11376 Lisp_Object window
;
11379 window
= FRAME_SELECTED_WINDOW (f
);
11380 w
= XWINDOW (window
);
11382 /* If the user has switched buffers or windows, we need to
11383 recompute to reflect the new bindings. But we'll
11384 recompute when update_mode_lines is set too; that means
11385 that people can use force-mode-line-update to request
11386 that the menu bar be recomputed. The adverse effect on
11387 the rest of the redisplay algorithm is about the same as
11388 windows_or_buffers_changed anyway. */
11389 if (windows_or_buffers_changed
11390 || w
->update_mode_line
11391 || update_mode_lines
11392 || window_buffer_changed (w
))
11394 struct buffer
*prev
= current_buffer
;
11395 ptrdiff_t count
= SPECPDL_INDEX ();
11396 Lisp_Object frame
, new_tool_bar
;
11397 int new_n_tool_bar
;
11398 struct gcpro gcpro1
;
11400 /* Set current_buffer to the buffer of the selected
11401 window of the frame, so that we get the right local
11403 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11405 /* Save match data, if we must. */
11406 if (save_match_data
)
11407 record_unwind_save_match_data ();
11409 /* Make sure that we don't accidentally use bogus keymaps. */
11410 if (NILP (Voverriding_local_map_menu_flag
))
11412 specbind (Qoverriding_terminal_local_map
, Qnil
);
11413 specbind (Qoverriding_local_map
, Qnil
);
11416 GCPRO1 (new_tool_bar
);
11418 /* We must temporarily set the selected frame to this frame
11419 before calling tool_bar_items, because the calculation of
11420 the tool-bar keymap uses the selected frame (see
11421 `tool-bar-make-keymap' in tool-bar.el). */
11422 eassert (EQ (selected_window
,
11423 /* Since we only explicitly preserve selected_frame,
11424 check that selected_window would be redundant. */
11425 XFRAME (selected_frame
)->selected_window
));
11426 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11427 XSETFRAME (frame
, f
);
11428 fast_set_selected_frame (frame
);
11430 /* Build desired tool-bar items from keymaps. */
11432 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11435 /* Redisplay the tool-bar if we changed it. */
11436 if (new_n_tool_bar
!= f
->n_tool_bar_items
11437 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11439 /* Redisplay that happens asynchronously due to an expose event
11440 may access f->tool_bar_items. Make sure we update both
11441 variables within BLOCK_INPUT so no such event interrupts. */
11443 fset_tool_bar_items (f
, new_tool_bar
);
11444 f
->n_tool_bar_items
= new_n_tool_bar
;
11445 w
->update_mode_line
= 1;
11451 unbind_to (count
, Qnil
);
11452 set_buffer_internal_1 (prev
);
11458 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11459 F's desired tool-bar contents. F->tool_bar_items must have
11460 been set up previously by calling prepare_menu_bars. */
11463 build_desired_tool_bar_string (struct frame
*f
)
11465 int i
, size
, size_needed
;
11466 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11467 Lisp_Object image
, plist
, props
;
11469 image
= plist
= props
= Qnil
;
11470 GCPRO3 (image
, plist
, props
);
11472 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11473 Otherwise, make a new string. */
11475 /* The size of the string we might be able to reuse. */
11476 size
= (STRINGP (f
->desired_tool_bar_string
)
11477 ? SCHARS (f
->desired_tool_bar_string
)
11480 /* We need one space in the string for each image. */
11481 size_needed
= f
->n_tool_bar_items
;
11483 /* Reuse f->desired_tool_bar_string, if possible. */
11484 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11485 fset_desired_tool_bar_string
11486 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11489 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11490 Fremove_text_properties (make_number (0), make_number (size
),
11491 props
, f
->desired_tool_bar_string
);
11494 /* Put a `display' property on the string for the images to display,
11495 put a `menu_item' property on tool-bar items with a value that
11496 is the index of the item in F's tool-bar item vector. */
11497 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11499 #define PROP(IDX) \
11500 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11502 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11503 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11504 int hmargin
, vmargin
, relief
, idx
, end
;
11506 /* If image is a vector, choose the image according to the
11508 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11509 if (VECTORP (image
))
11513 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11514 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11517 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11518 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11520 eassert (ASIZE (image
) >= idx
);
11521 image
= AREF (image
, idx
);
11526 /* Ignore invalid image specifications. */
11527 if (!valid_image_p (image
))
11530 /* Display the tool-bar button pressed, or depressed. */
11531 plist
= Fcopy_sequence (XCDR (image
));
11533 /* Compute margin and relief to draw. */
11534 relief
= (tool_bar_button_relief
>= 0
11535 ? tool_bar_button_relief
11536 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11537 hmargin
= vmargin
= relief
;
11539 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11540 INT_MAX
- max (hmargin
, vmargin
)))
11542 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11543 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11545 else if (CONSP (Vtool_bar_button_margin
))
11547 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11548 INT_MAX
- hmargin
))
11549 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11551 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11552 INT_MAX
- vmargin
))
11553 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11556 if (auto_raise_tool_bar_buttons_p
)
11558 /* Add a `:relief' property to the image spec if the item is
11562 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11569 /* If image is selected, display it pressed, i.e. with a
11570 negative relief. If it's not selected, display it with a
11572 plist
= Fplist_put (plist
, QCrelief
,
11574 ? make_number (-relief
)
11575 : make_number (relief
)));
11580 /* Put a margin around the image. */
11581 if (hmargin
|| vmargin
)
11583 if (hmargin
== vmargin
)
11584 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11586 plist
= Fplist_put (plist
, QCmargin
,
11587 Fcons (make_number (hmargin
),
11588 make_number (vmargin
)));
11591 /* If button is not enabled, and we don't have special images
11592 for the disabled state, make the image appear disabled by
11593 applying an appropriate algorithm to it. */
11594 if (!enabled_p
&& idx
< 0)
11595 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11597 /* Put a `display' text property on the string for the image to
11598 display. Put a `menu-item' property on the string that gives
11599 the start of this item's properties in the tool-bar items
11601 image
= Fcons (Qimage
, plist
);
11602 props
= list4 (Qdisplay
, image
,
11603 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11605 /* Let the last image hide all remaining spaces in the tool bar
11606 string. The string can be longer than needed when we reuse a
11607 previous string. */
11608 if (i
+ 1 == f
->n_tool_bar_items
)
11609 end
= SCHARS (f
->desired_tool_bar_string
);
11612 Fadd_text_properties (make_number (i
), make_number (end
),
11613 props
, f
->desired_tool_bar_string
);
11621 /* Display one line of the tool-bar of frame IT->f.
11623 HEIGHT specifies the desired height of the tool-bar line.
11624 If the actual height of the glyph row is less than HEIGHT, the
11625 row's height is increased to HEIGHT, and the icons are centered
11626 vertically in the new height.
11628 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11629 count a final empty row in case the tool-bar width exactly matches
11634 display_tool_bar_line (struct it
*it
, int height
)
11636 struct glyph_row
*row
= it
->glyph_row
;
11637 int max_x
= it
->last_visible_x
;
11638 struct glyph
*last
;
11640 prepare_desired_row (row
);
11641 row
->y
= it
->current_y
;
11643 /* Note that this isn't made use of if the face hasn't a box,
11644 so there's no need to check the face here. */
11645 it
->start_of_box_run_p
= 1;
11647 while (it
->current_x
< max_x
)
11649 int x
, n_glyphs_before
, i
, nglyphs
;
11650 struct it it_before
;
11652 /* Get the next display element. */
11653 if (!get_next_display_element (it
))
11655 /* Don't count empty row if we are counting needed tool-bar lines. */
11656 if (height
< 0 && !it
->hpos
)
11661 /* Produce glyphs. */
11662 n_glyphs_before
= row
->used
[TEXT_AREA
];
11665 PRODUCE_GLYPHS (it
);
11667 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11669 x
= it_before
.current_x
;
11670 while (i
< nglyphs
)
11672 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11674 if (x
+ glyph
->pixel_width
> max_x
)
11676 /* Glyph doesn't fit on line. Backtrack. */
11677 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11679 /* If this is the only glyph on this line, it will never fit on the
11680 tool-bar, so skip it. But ensure there is at least one glyph,
11681 so we don't accidentally disable the tool-bar. */
11682 if (n_glyphs_before
== 0
11683 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11689 x
+= glyph
->pixel_width
;
11693 /* Stop at line end. */
11694 if (ITERATOR_AT_END_OF_LINE_P (it
))
11697 set_iterator_to_next (it
, 1);
11702 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11704 /* Use default face for the border below the tool bar.
11706 FIXME: When auto-resize-tool-bars is grow-only, there is
11707 no additional border below the possibly empty tool-bar lines.
11708 So to make the extra empty lines look "normal", we have to
11709 use the tool-bar face for the border too. */
11710 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11711 it
->face_id
= DEFAULT_FACE_ID
;
11713 extend_face_to_end_of_line (it
);
11714 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11715 last
->right_box_line_p
= 1;
11716 if (last
== row
->glyphs
[TEXT_AREA
])
11717 last
->left_box_line_p
= 1;
11719 /* Make line the desired height and center it vertically. */
11720 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11722 /* Don't add more than one line height. */
11723 height
%= FRAME_LINE_HEIGHT (it
->f
);
11724 it
->max_ascent
+= height
/ 2;
11725 it
->max_descent
+= (height
+ 1) / 2;
11728 compute_line_metrics (it
);
11730 /* If line is empty, make it occupy the rest of the tool-bar. */
11731 if (!row
->displays_text_p
)
11733 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11734 row
->visible_height
= row
->height
;
11735 row
->ascent
= row
->phys_ascent
= 0;
11736 row
->extra_line_spacing
= 0;
11739 row
->full_width_p
= 1;
11740 row
->continued_p
= 0;
11741 row
->truncated_on_left_p
= 0;
11742 row
->truncated_on_right_p
= 0;
11744 it
->current_x
= it
->hpos
= 0;
11745 it
->current_y
+= row
->height
;
11751 /* Max tool-bar height. */
11753 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11754 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11756 /* Value is the number of screen lines needed to make all tool-bar
11757 items of frame F visible. The number of actual rows needed is
11758 returned in *N_ROWS if non-NULL. */
11761 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11763 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11765 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11766 the desired matrix, so use (unused) mode-line row as temporary row to
11767 avoid destroying the first tool-bar row. */
11768 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11770 /* Initialize an iterator for iteration over
11771 F->desired_tool_bar_string in the tool-bar window of frame F. */
11772 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11773 it
.first_visible_x
= 0;
11774 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11775 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11776 it
.paragraph_embedding
= L2R
;
11778 while (!ITERATOR_AT_END_P (&it
))
11780 clear_glyph_row (temp_row
);
11781 it
.glyph_row
= temp_row
;
11782 display_tool_bar_line (&it
, -1);
11784 clear_glyph_row (temp_row
);
11786 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11788 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11790 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11794 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11796 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
11797 If FRAME is nil or omitted, use the selected frame. */)
11798 (Lisp_Object frame
)
11800 struct frame
*f
= decode_any_frame (frame
);
11804 if (WINDOWP (f
->tool_bar_window
)
11805 && (w
= XWINDOW (f
->tool_bar_window
),
11806 WINDOW_TOTAL_LINES (w
) > 0))
11808 update_tool_bar (f
, 1);
11809 if (f
->n_tool_bar_items
)
11811 build_desired_tool_bar_string (f
);
11812 nlines
= tool_bar_lines_needed (f
, NULL
);
11816 return make_number (nlines
);
11820 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11821 height should be changed. */
11824 redisplay_tool_bar (struct frame
*f
)
11828 struct glyph_row
*row
;
11830 #if defined (USE_GTK) || defined (HAVE_NS)
11831 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11832 update_frame_tool_bar (f
);
11836 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11837 do anything. This means you must start with tool-bar-lines
11838 non-zero to get the auto-sizing effect. Or in other words, you
11839 can turn off tool-bars by specifying tool-bar-lines zero. */
11840 if (!WINDOWP (f
->tool_bar_window
)
11841 || (w
= XWINDOW (f
->tool_bar_window
),
11842 WINDOW_TOTAL_LINES (w
) == 0))
11845 /* Set up an iterator for the tool-bar window. */
11846 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11847 it
.first_visible_x
= 0;
11848 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11849 row
= it
.glyph_row
;
11851 /* Build a string that represents the contents of the tool-bar. */
11852 build_desired_tool_bar_string (f
);
11853 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11854 /* FIXME: This should be controlled by a user option. But it
11855 doesn't make sense to have an R2L tool bar if the menu bar cannot
11856 be drawn also R2L, and making the menu bar R2L is tricky due
11857 toolkit-specific code that implements it. If an R2L tool bar is
11858 ever supported, display_tool_bar_line should also be augmented to
11859 call unproduce_glyphs like display_line and display_string
11861 it
.paragraph_embedding
= L2R
;
11863 if (f
->n_tool_bar_rows
== 0)
11867 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11868 nlines
!= WINDOW_TOTAL_LINES (w
)))
11871 int old_height
= WINDOW_TOTAL_LINES (w
);
11873 XSETFRAME (frame
, f
);
11874 Fmodify_frame_parameters (frame
,
11875 Fcons (Fcons (Qtool_bar_lines
,
11876 make_number (nlines
)),
11878 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11880 clear_glyph_matrix (w
->desired_matrix
);
11881 fonts_changed_p
= 1;
11887 /* Display as many lines as needed to display all tool-bar items. */
11889 if (f
->n_tool_bar_rows
> 0)
11891 int border
, rows
, height
, extra
;
11893 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
11894 border
= XINT (Vtool_bar_border
);
11895 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11896 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11897 else if (EQ (Vtool_bar_border
, Qborder_width
))
11898 border
= f
->border_width
;
11904 rows
= f
->n_tool_bar_rows
;
11905 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11906 extra
= it
.last_visible_y
- border
- height
* rows
;
11908 while (it
.current_y
< it
.last_visible_y
)
11911 if (extra
> 0 && rows
-- > 0)
11913 h
= (extra
+ rows
- 1) / rows
;
11916 display_tool_bar_line (&it
, height
+ h
);
11921 while (it
.current_y
< it
.last_visible_y
)
11922 display_tool_bar_line (&it
, 0);
11925 /* It doesn't make much sense to try scrolling in the tool-bar
11926 window, so don't do it. */
11927 w
->desired_matrix
->no_scrolling_p
= 1;
11928 w
->must_be_updated_p
= 1;
11930 if (!NILP (Vauto_resize_tool_bars
))
11932 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11933 int change_height_p
= 0;
11935 /* If we couldn't display everything, change the tool-bar's
11936 height if there is room for more. */
11937 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11938 && it
.current_y
< max_tool_bar_height
)
11939 change_height_p
= 1;
11941 row
= it
.glyph_row
- 1;
11943 /* If there are blank lines at the end, except for a partially
11944 visible blank line at the end that is smaller than
11945 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11946 if (!row
->displays_text_p
11947 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11948 change_height_p
= 1;
11950 /* If row displays tool-bar items, but is partially visible,
11951 change the tool-bar's height. */
11952 if (row
->displays_text_p
11953 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11954 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11955 change_height_p
= 1;
11957 /* Resize windows as needed by changing the `tool-bar-lines'
11958 frame parameter. */
11959 if (change_height_p
)
11962 int old_height
= WINDOW_TOTAL_LINES (w
);
11964 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11966 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11967 && !f
->minimize_tool_bar_window_p
)
11968 ? (nlines
> old_height
)
11969 : (nlines
!= old_height
));
11970 f
->minimize_tool_bar_window_p
= 0;
11972 if (change_height_p
)
11974 XSETFRAME (frame
, f
);
11975 Fmodify_frame_parameters (frame
,
11976 Fcons (Fcons (Qtool_bar_lines
,
11977 make_number (nlines
)),
11979 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11981 clear_glyph_matrix (w
->desired_matrix
);
11982 f
->n_tool_bar_rows
= nrows
;
11983 fonts_changed_p
= 1;
11990 f
->minimize_tool_bar_window_p
= 0;
11995 /* Get information about the tool-bar item which is displayed in GLYPH
11996 on frame F. Return in *PROP_IDX the index where tool-bar item
11997 properties start in F->tool_bar_items. Value is zero if
11998 GLYPH doesn't display a tool-bar item. */
12001 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12007 /* This function can be called asynchronously, which means we must
12008 exclude any possibility that Fget_text_property signals an
12010 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12011 charpos
= max (0, charpos
);
12013 /* Get the text property `menu-item' at pos. The value of that
12014 property is the start index of this item's properties in
12015 F->tool_bar_items. */
12016 prop
= Fget_text_property (make_number (charpos
),
12017 Qmenu_item
, f
->current_tool_bar_string
);
12018 if (INTEGERP (prop
))
12020 *prop_idx
= XINT (prop
);
12030 /* Get information about the tool-bar item at position X/Y on frame F.
12031 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12032 the current matrix of the tool-bar window of F, or NULL if not
12033 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12034 item in F->tool_bar_items. Value is
12036 -1 if X/Y is not on a tool-bar item
12037 0 if X/Y is on the same item that was highlighted before.
12041 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12042 int *hpos
, int *vpos
, int *prop_idx
)
12044 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12045 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12048 /* Find the glyph under X/Y. */
12049 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12050 if (*glyph
== NULL
)
12053 /* Get the start of this tool-bar item's properties in
12054 f->tool_bar_items. */
12055 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12058 /* Is mouse on the highlighted item? */
12059 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12060 && *vpos
>= hlinfo
->mouse_face_beg_row
12061 && *vpos
<= hlinfo
->mouse_face_end_row
12062 && (*vpos
> hlinfo
->mouse_face_beg_row
12063 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12064 && (*vpos
< hlinfo
->mouse_face_end_row
12065 || *hpos
< hlinfo
->mouse_face_end_col
12066 || hlinfo
->mouse_face_past_end
))
12074 Handle mouse button event on the tool-bar of frame F, at
12075 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12076 0 for button release. MODIFIERS is event modifiers for button
12080 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12083 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12084 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12085 int hpos
, vpos
, prop_idx
;
12086 struct glyph
*glyph
;
12087 Lisp_Object enabled_p
;
12089 /* If not on the highlighted tool-bar item, return. */
12090 frame_to_window_pixel_xy (w
, &x
, &y
);
12091 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12094 /* If item is disabled, do nothing. */
12095 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12096 if (NILP (enabled_p
))
12101 /* Show item in pressed state. */
12102 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12103 last_tool_bar_item
= prop_idx
;
12107 Lisp_Object key
, frame
;
12108 struct input_event event
;
12109 EVENT_INIT (event
);
12111 /* Show item in released state. */
12112 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12114 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12116 XSETFRAME (frame
, f
);
12117 event
.kind
= TOOL_BAR_EVENT
;
12118 event
.frame_or_window
= frame
;
12120 kbd_buffer_store_event (&event
);
12122 event
.kind
= TOOL_BAR_EVENT
;
12123 event
.frame_or_window
= frame
;
12125 event
.modifiers
= modifiers
;
12126 kbd_buffer_store_event (&event
);
12127 last_tool_bar_item
= -1;
12132 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12133 tool-bar window-relative coordinates X/Y. Called from
12134 note_mouse_highlight. */
12137 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12139 Lisp_Object window
= f
->tool_bar_window
;
12140 struct window
*w
= XWINDOW (window
);
12141 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12142 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12144 struct glyph
*glyph
;
12145 struct glyph_row
*row
;
12147 Lisp_Object enabled_p
;
12149 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12150 int mouse_down_p
, rc
;
12152 /* Function note_mouse_highlight is called with negative X/Y
12153 values when mouse moves outside of the frame. */
12154 if (x
<= 0 || y
<= 0)
12156 clear_mouse_face (hlinfo
);
12160 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12163 /* Not on tool-bar item. */
12164 clear_mouse_face (hlinfo
);
12168 /* On same tool-bar item as before. */
12169 goto set_help_echo
;
12171 clear_mouse_face (hlinfo
);
12173 /* Mouse is down, but on different tool-bar item? */
12174 mouse_down_p
= (dpyinfo
->grabbed
12175 && f
== last_mouse_frame
12176 && FRAME_LIVE_P (f
));
12178 && last_tool_bar_item
!= prop_idx
)
12181 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12183 /* If tool-bar item is not enabled, don't highlight it. */
12184 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12185 if (!NILP (enabled_p
))
12187 /* Compute the x-position of the glyph. In front and past the
12188 image is a space. We include this in the highlighted area. */
12189 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12190 for (i
= x
= 0; i
< hpos
; ++i
)
12191 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12193 /* Record this as the current active region. */
12194 hlinfo
->mouse_face_beg_col
= hpos
;
12195 hlinfo
->mouse_face_beg_row
= vpos
;
12196 hlinfo
->mouse_face_beg_x
= x
;
12197 hlinfo
->mouse_face_beg_y
= row
->y
;
12198 hlinfo
->mouse_face_past_end
= 0;
12200 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12201 hlinfo
->mouse_face_end_row
= vpos
;
12202 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12203 hlinfo
->mouse_face_end_y
= row
->y
;
12204 hlinfo
->mouse_face_window
= window
;
12205 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12207 /* Display it as active. */
12208 show_mouse_face (hlinfo
, draw
);
12213 /* Set help_echo_string to a help string to display for this tool-bar item.
12214 XTread_socket does the rest. */
12215 help_echo_object
= help_echo_window
= Qnil
;
12216 help_echo_pos
= -1;
12217 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12218 if (NILP (help_echo_string
))
12219 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12222 #endif /* HAVE_WINDOW_SYSTEM */
12226 /************************************************************************
12227 Horizontal scrolling
12228 ************************************************************************/
12230 static int hscroll_window_tree (Lisp_Object
);
12231 static int hscroll_windows (Lisp_Object
);
12233 /* For all leaf windows in the window tree rooted at WINDOW, set their
12234 hscroll value so that PT is (i) visible in the window, and (ii) so
12235 that it is not within a certain margin at the window's left and
12236 right border. Value is non-zero if any window's hscroll has been
12240 hscroll_window_tree (Lisp_Object window
)
12242 int hscrolled_p
= 0;
12243 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12244 int hscroll_step_abs
= 0;
12245 double hscroll_step_rel
= 0;
12247 if (hscroll_relative_p
)
12249 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12250 if (hscroll_step_rel
< 0)
12252 hscroll_relative_p
= 0;
12253 hscroll_step_abs
= 0;
12256 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12258 hscroll_step_abs
= XINT (Vhscroll_step
);
12259 if (hscroll_step_abs
< 0)
12260 hscroll_step_abs
= 0;
12263 hscroll_step_abs
= 0;
12265 while (WINDOWP (window
))
12267 struct window
*w
= XWINDOW (window
);
12269 if (WINDOWP (w
->hchild
))
12270 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12271 else if (WINDOWP (w
->vchild
))
12272 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12273 else if (w
->cursor
.vpos
>= 0)
12276 int text_area_width
;
12277 struct glyph_row
*current_cursor_row
12278 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12279 struct glyph_row
*desired_cursor_row
12280 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12281 struct glyph_row
*cursor_row
12282 = (desired_cursor_row
->enabled_p
12283 ? desired_cursor_row
12284 : current_cursor_row
);
12285 int row_r2l_p
= cursor_row
->reversed_p
;
12287 text_area_width
= window_box_width (w
, TEXT_AREA
);
12289 /* Scroll when cursor is inside this scroll margin. */
12290 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12292 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12293 /* For left-to-right rows, hscroll when cursor is either
12294 (i) inside the right hscroll margin, or (ii) if it is
12295 inside the left margin and the window is already
12299 && w
->cursor
.x
<= h_margin
)
12300 || (cursor_row
->enabled_p
12301 && cursor_row
->truncated_on_right_p
12302 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12303 /* For right-to-left rows, the logic is similar,
12304 except that rules for scrolling to left and right
12305 are reversed. E.g., if cursor.x <= h_margin, we
12306 need to hscroll "to the right" unconditionally,
12307 and that will scroll the screen to the left so as
12308 to reveal the next portion of the row. */
12310 && ((cursor_row
->enabled_p
12311 /* FIXME: It is confusing to set the
12312 truncated_on_right_p flag when R2L rows
12313 are actually truncated on the left. */
12314 && cursor_row
->truncated_on_right_p
12315 && w
->cursor
.x
<= h_margin
)
12317 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12321 struct buffer
*saved_current_buffer
;
12325 /* Find point in a display of infinite width. */
12326 saved_current_buffer
= current_buffer
;
12327 current_buffer
= XBUFFER (w
->buffer
);
12329 if (w
== XWINDOW (selected_window
))
12332 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12334 /* Move iterator to pt starting at cursor_row->start in
12335 a line with infinite width. */
12336 init_to_row_start (&it
, w
, cursor_row
);
12337 it
.last_visible_x
= INFINITY
;
12338 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12339 current_buffer
= saved_current_buffer
;
12341 /* Position cursor in window. */
12342 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12343 hscroll
= max (0, (it
.current_x
12344 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12345 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12346 : (text_area_width
/ 2))))
12347 / FRAME_COLUMN_WIDTH (it
.f
);
12348 else if ((!row_r2l_p
12349 && w
->cursor
.x
>= text_area_width
- h_margin
)
12350 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12352 if (hscroll_relative_p
)
12353 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12356 wanted_x
= text_area_width
12357 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12360 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12364 if (hscroll_relative_p
)
12365 wanted_x
= text_area_width
* hscroll_step_rel
12368 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12371 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12373 hscroll
= max (hscroll
, w
->min_hscroll
);
12375 /* Don't prevent redisplay optimizations if hscroll
12376 hasn't changed, as it will unnecessarily slow down
12378 if (w
->hscroll
!= hscroll
)
12380 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12381 w
->hscroll
= hscroll
;
12390 /* Value is non-zero if hscroll of any leaf window has been changed. */
12391 return hscrolled_p
;
12395 /* Set hscroll so that cursor is visible and not inside horizontal
12396 scroll margins for all windows in the tree rooted at WINDOW. See
12397 also hscroll_window_tree above. Value is non-zero if any window's
12398 hscroll has been changed. If it has, desired matrices on the frame
12399 of WINDOW are cleared. */
12402 hscroll_windows (Lisp_Object window
)
12404 int hscrolled_p
= hscroll_window_tree (window
);
12406 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12407 return hscrolled_p
;
12412 /************************************************************************
12414 ************************************************************************/
12416 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12417 to a non-zero value. This is sometimes handy to have in a debugger
12422 /* First and last unchanged row for try_window_id. */
12424 static int debug_first_unchanged_at_end_vpos
;
12425 static int debug_last_unchanged_at_beg_vpos
;
12427 /* Delta vpos and y. */
12429 static int debug_dvpos
, debug_dy
;
12431 /* Delta in characters and bytes for try_window_id. */
12433 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12435 /* Values of window_end_pos and window_end_vpos at the end of
12438 static ptrdiff_t debug_end_vpos
;
12440 /* Append a string to W->desired_matrix->method. FMT is a printf
12441 format string. If trace_redisplay_p is non-zero also printf the
12442 resulting string to stderr. */
12444 static void debug_method_add (struct window
*, char const *, ...)
12445 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12448 debug_method_add (struct window
*w
, char const *fmt
, ...)
12450 char *method
= w
->desired_matrix
->method
;
12451 int len
= strlen (method
);
12452 int size
= sizeof w
->desired_matrix
->method
;
12453 int remaining
= size
- len
- 1;
12456 if (len
&& remaining
)
12459 --remaining
, ++len
;
12462 va_start (ap
, fmt
);
12463 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12466 if (trace_redisplay_p
)
12467 fprintf (stderr
, "%p (%s): %s\n",
12469 ((BUFFERP (w
->buffer
)
12470 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12471 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12476 #endif /* GLYPH_DEBUG */
12479 /* Value is non-zero if all changes in window W, which displays
12480 current_buffer, are in the text between START and END. START is a
12481 buffer position, END is given as a distance from Z. Used in
12482 redisplay_internal for display optimization. */
12485 text_outside_line_unchanged_p (struct window
*w
,
12486 ptrdiff_t start
, ptrdiff_t end
)
12488 int unchanged_p
= 1;
12490 /* If text or overlays have changed, see where. */
12491 if (window_outdated (w
))
12493 /* Gap in the line? */
12494 if (GPT
< start
|| Z
- GPT
< end
)
12497 /* Changes start in front of the line, or end after it? */
12499 && (BEG_UNCHANGED
< start
- 1
12500 || END_UNCHANGED
< end
))
12503 /* If selective display, can't optimize if changes start at the
12504 beginning of the line. */
12506 && INTEGERP (BVAR (current_buffer
, selective_display
))
12507 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12508 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12511 /* If there are overlays at the start or end of the line, these
12512 may have overlay strings with newlines in them. A change at
12513 START, for instance, may actually concern the display of such
12514 overlay strings as well, and they are displayed on different
12515 lines. So, quickly rule out this case. (For the future, it
12516 might be desirable to implement something more telling than
12517 just BEG/END_UNCHANGED.) */
12520 if (BEG
+ BEG_UNCHANGED
== start
12521 && overlay_touches_p (start
))
12523 if (END_UNCHANGED
== end
12524 && overlay_touches_p (Z
- end
))
12528 /* Under bidi reordering, adding or deleting a character in the
12529 beginning of a paragraph, before the first strong directional
12530 character, can change the base direction of the paragraph (unless
12531 the buffer specifies a fixed paragraph direction), which will
12532 require to redisplay the whole paragraph. It might be worthwhile
12533 to find the paragraph limits and widen the range of redisplayed
12534 lines to that, but for now just give up this optimization. */
12535 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12536 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12540 return unchanged_p
;
12544 /* Do a frame update, taking possible shortcuts into account. This is
12545 the main external entry point for redisplay.
12547 If the last redisplay displayed an echo area message and that message
12548 is no longer requested, we clear the echo area or bring back the
12549 mini-buffer if that is in use. */
12554 redisplay_internal ();
12559 overlay_arrow_string_or_property (Lisp_Object var
)
12563 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12566 return Voverlay_arrow_string
;
12569 /* Return 1 if there are any overlay-arrows in current_buffer. */
12571 overlay_arrow_in_current_buffer_p (void)
12575 for (vlist
= Voverlay_arrow_variable_list
;
12577 vlist
= XCDR (vlist
))
12579 Lisp_Object var
= XCAR (vlist
);
12582 if (!SYMBOLP (var
))
12584 val
= find_symbol_value (var
);
12586 && current_buffer
== XMARKER (val
)->buffer
)
12593 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12597 overlay_arrows_changed_p (void)
12601 for (vlist
= Voverlay_arrow_variable_list
;
12603 vlist
= XCDR (vlist
))
12605 Lisp_Object var
= XCAR (vlist
);
12606 Lisp_Object val
, pstr
;
12608 if (!SYMBOLP (var
))
12610 val
= find_symbol_value (var
);
12611 if (!MARKERP (val
))
12613 if (! EQ (COERCE_MARKER (val
),
12614 Fget (var
, Qlast_arrow_position
))
12615 || ! (pstr
= overlay_arrow_string_or_property (var
),
12616 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12622 /* Mark overlay arrows to be updated on next redisplay. */
12625 update_overlay_arrows (int up_to_date
)
12629 for (vlist
= Voverlay_arrow_variable_list
;
12631 vlist
= XCDR (vlist
))
12633 Lisp_Object var
= XCAR (vlist
);
12635 if (!SYMBOLP (var
))
12638 if (up_to_date
> 0)
12640 Lisp_Object val
= find_symbol_value (var
);
12641 Fput (var
, Qlast_arrow_position
,
12642 COERCE_MARKER (val
));
12643 Fput (var
, Qlast_arrow_string
,
12644 overlay_arrow_string_or_property (var
));
12646 else if (up_to_date
< 0
12647 || !NILP (Fget (var
, Qlast_arrow_position
)))
12649 Fput (var
, Qlast_arrow_position
, Qt
);
12650 Fput (var
, Qlast_arrow_string
, Qt
);
12656 /* Return overlay arrow string to display at row.
12657 Return integer (bitmap number) for arrow bitmap in left fringe.
12658 Return nil if no overlay arrow. */
12661 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12665 for (vlist
= Voverlay_arrow_variable_list
;
12667 vlist
= XCDR (vlist
))
12669 Lisp_Object var
= XCAR (vlist
);
12672 if (!SYMBOLP (var
))
12675 val
= find_symbol_value (var
);
12678 && current_buffer
== XMARKER (val
)->buffer
12679 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12681 if (FRAME_WINDOW_P (it
->f
)
12682 /* FIXME: if ROW->reversed_p is set, this should test
12683 the right fringe, not the left one. */
12684 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12686 #ifdef HAVE_WINDOW_SYSTEM
12687 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12690 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12691 return make_number (fringe_bitmap
);
12694 return make_number (-1); /* Use default arrow bitmap. */
12696 return overlay_arrow_string_or_property (var
);
12703 /* Return 1 if point moved out of or into a composition. Otherwise
12704 return 0. PREV_BUF and PREV_PT are the last point buffer and
12705 position. BUF and PT are the current point buffer and position. */
12708 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12709 struct buffer
*buf
, ptrdiff_t pt
)
12711 ptrdiff_t start
, end
;
12713 Lisp_Object buffer
;
12715 XSETBUFFER (buffer
, buf
);
12716 /* Check a composition at the last point if point moved within the
12718 if (prev_buf
== buf
)
12721 /* Point didn't move. */
12724 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12725 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12726 && COMPOSITION_VALID_P (start
, end
, prop
)
12727 && start
< prev_pt
&& end
> prev_pt
)
12728 /* The last point was within the composition. Return 1 iff
12729 point moved out of the composition. */
12730 return (pt
<= start
|| pt
>= end
);
12733 /* Check a composition at the current point. */
12734 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12735 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12736 && COMPOSITION_VALID_P (start
, end
, prop
)
12737 && start
< pt
&& end
> pt
);
12741 /* Reconsider the setting of B->clip_changed which is displayed
12745 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12747 if (b
->clip_changed
12748 && w
->window_end_valid
12749 && w
->current_matrix
->buffer
== b
12750 && w
->current_matrix
->zv
== BUF_ZV (b
)
12751 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12752 b
->clip_changed
= 0;
12754 /* If display wasn't paused, and W is not a tool bar window, see if
12755 point has been moved into or out of a composition. In that case,
12756 we set b->clip_changed to 1 to force updating the screen. If
12757 b->clip_changed has already been set to 1, we can skip this
12759 if (!b
->clip_changed
&& BUFFERP (w
->buffer
) && w
->window_end_valid
)
12763 if (w
== XWINDOW (selected_window
))
12766 pt
= marker_position (w
->pointm
);
12768 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12769 || pt
!= w
->last_point
)
12770 && check_point_in_composition (w
->current_matrix
->buffer
,
12772 XBUFFER (w
->buffer
), pt
))
12773 b
->clip_changed
= 1;
12778 #define STOP_POLLING \
12779 do { if (! polling_stopped_here) stop_polling (); \
12780 polling_stopped_here = 1; } while (0)
12782 #define RESUME_POLLING \
12783 do { if (polling_stopped_here) start_polling (); \
12784 polling_stopped_here = 0; } while (0)
12787 /* Perhaps in the future avoid recentering windows if it
12788 is not necessary; currently that causes some problems. */
12791 redisplay_internal (void)
12793 struct window
*w
= XWINDOW (selected_window
);
12797 int must_finish
= 0;
12798 struct text_pos tlbufpos
, tlendpos
;
12799 int number_of_visible_frames
;
12800 ptrdiff_t count
, count1
;
12802 int polling_stopped_here
= 0;
12803 Lisp_Object tail
, frame
;
12804 struct backtrace backtrace
;
12806 /* Non-zero means redisplay has to consider all windows on all
12807 frames. Zero means, only selected_window is considered. */
12808 int consider_all_windows_p
;
12810 /* Non-zero means redisplay has to redisplay the miniwindow. */
12811 int update_miniwindow_p
= 0;
12813 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12815 /* No redisplay if running in batch mode or frame is not yet fully
12816 initialized, or redisplay is explicitly turned off by setting
12817 Vinhibit_redisplay. */
12818 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12819 || !NILP (Vinhibit_redisplay
))
12822 /* Don't examine these until after testing Vinhibit_redisplay.
12823 When Emacs is shutting down, perhaps because its connection to
12824 X has dropped, we should not look at them at all. */
12825 fr
= XFRAME (w
->frame
);
12826 sf
= SELECTED_FRAME ();
12828 if (!fr
->glyphs_initialized_p
)
12831 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12832 if (popup_activated ())
12836 /* I don't think this happens but let's be paranoid. */
12837 if (redisplaying_p
)
12840 /* Record a function that clears redisplaying_p
12841 when we leave this function. */
12842 count
= SPECPDL_INDEX ();
12843 record_unwind_protect (unwind_redisplay
, selected_frame
);
12844 redisplaying_p
= 1;
12845 specbind (Qinhibit_free_realized_faces
, Qnil
);
12847 /* Record this function, so it appears on the profiler's backtraces. */
12848 backtrace
.next
= backtrace_list
;
12849 backtrace
.function
= Qredisplay_internal
;
12850 backtrace
.args
= &Qnil
;
12851 backtrace
.nargs
= 0;
12852 backtrace
.debug_on_exit
= 0;
12853 backtrace_list
= &backtrace
;
12855 FOR_EACH_FRAME (tail
, frame
)
12856 XFRAME (frame
)->already_hscrolled_p
= 0;
12859 /* Remember the currently selected window. */
12863 reconsider_clip_changes (w
, current_buffer
);
12864 last_escape_glyph_frame
= NULL
;
12865 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12866 last_glyphless_glyph_frame
= NULL
;
12867 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12869 /* If new fonts have been loaded that make a glyph matrix adjustment
12870 necessary, do it. */
12871 if (fonts_changed_p
)
12873 adjust_glyphs (NULL
);
12874 ++windows_or_buffers_changed
;
12875 fonts_changed_p
= 0;
12878 /* If face_change_count is non-zero, init_iterator will free all
12879 realized faces, which includes the faces referenced from current
12880 matrices. So, we can't reuse current matrices in this case. */
12881 if (face_change_count
)
12882 ++windows_or_buffers_changed
;
12884 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12885 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12887 /* Since frames on a single ASCII terminal share the same
12888 display area, displaying a different frame means redisplay
12889 the whole thing. */
12890 windows_or_buffers_changed
++;
12891 SET_FRAME_GARBAGED (sf
);
12893 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12895 FRAME_TTY (sf
)->previous_frame
= sf
;
12898 /* Set the visible flags for all frames. Do this before checking for
12899 resized or garbaged frames; they want to know if their frames are
12900 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
12901 number_of_visible_frames
= 0;
12903 FOR_EACH_FRAME (tail
, frame
)
12905 struct frame
*f
= XFRAME (frame
);
12907 if (FRAME_VISIBLE_P (f
))
12908 ++number_of_visible_frames
;
12909 clear_desired_matrices (f
);
12912 /* Notice any pending interrupt request to change frame size. */
12913 do_pending_window_change (1);
12915 /* do_pending_window_change could change the selected_window due to
12916 frame resizing which makes the selected window too small. */
12917 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12920 reconsider_clip_changes (w
, current_buffer
);
12923 /* Clear frames marked as garbaged. */
12924 clear_garbaged_frames ();
12926 /* Build menubar and tool-bar items. */
12927 if (NILP (Vmemory_full
))
12928 prepare_menu_bars ();
12930 if (windows_or_buffers_changed
)
12931 update_mode_lines
++;
12933 /* Detect case that we need to write or remove a star in the mode line. */
12934 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
12936 w
->update_mode_line
= 1;
12937 if (buffer_shared_and_changed ())
12938 update_mode_lines
++;
12941 /* Avoid invocation of point motion hooks by `current_column' below. */
12942 count1
= SPECPDL_INDEX ();
12943 specbind (Qinhibit_point_motion_hooks
, Qt
);
12945 if (mode_line_update_needed (w
))
12946 w
->update_mode_line
= 1;
12948 unbind_to (count1
, Qnil
);
12950 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12952 consider_all_windows_p
= (update_mode_lines
12953 || buffer_shared_and_changed ()
12954 || cursor_type_changed
);
12956 /* If specs for an arrow have changed, do thorough redisplay
12957 to ensure we remove any arrow that should no longer exist. */
12958 if (overlay_arrows_changed_p ())
12959 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12961 /* Normally the message* functions will have already displayed and
12962 updated the echo area, but the frame may have been trashed, or
12963 the update may have been preempted, so display the echo area
12964 again here. Checking message_cleared_p captures the case that
12965 the echo area should be cleared. */
12966 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12967 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12968 || (message_cleared_p
12969 && minibuf_level
== 0
12970 /* If the mini-window is currently selected, this means the
12971 echo-area doesn't show through. */
12972 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12974 int window_height_changed_p
= echo_area_display (0);
12976 if (message_cleared_p
)
12977 update_miniwindow_p
= 1;
12981 /* If we don't display the current message, don't clear the
12982 message_cleared_p flag, because, if we did, we wouldn't clear
12983 the echo area in the next redisplay which doesn't preserve
12985 if (!display_last_displayed_message_p
)
12986 message_cleared_p
= 0;
12988 if (fonts_changed_p
)
12990 else if (window_height_changed_p
)
12992 consider_all_windows_p
= 1;
12993 ++update_mode_lines
;
12994 ++windows_or_buffers_changed
;
12996 /* If window configuration was changed, frames may have been
12997 marked garbaged. Clear them or we will experience
12998 surprises wrt scrolling. */
12999 clear_garbaged_frames ();
13002 else if (EQ (selected_window
, minibuf_window
)
13003 && (current_buffer
->clip_changed
|| window_outdated (w
))
13004 && resize_mini_window (w
, 0))
13006 /* Resized active mini-window to fit the size of what it is
13007 showing if its contents might have changed. */
13009 /* FIXME: this causes all frames to be updated, which seems unnecessary
13010 since only the current frame needs to be considered. This function
13011 needs to be rewritten with two variables, consider_all_windows and
13012 consider_all_frames. */
13013 consider_all_windows_p
= 1;
13014 ++windows_or_buffers_changed
;
13015 ++update_mode_lines
;
13017 /* If window configuration was changed, frames may have been
13018 marked garbaged. Clear them or we will experience
13019 surprises wrt scrolling. */
13020 clear_garbaged_frames ();
13023 /* If showing the region, and mark has changed, we must redisplay
13024 the whole window. The assignment to this_line_start_pos prevents
13025 the optimization directly below this if-statement. */
13026 if (((!NILP (Vtransient_mark_mode
)
13027 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
13028 != (w
->region_showing
> 0))
13029 || (w
->region_showing
13030 && w
->region_showing
13031 != XINT (Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
13032 CHARPOS (this_line_start_pos
) = 0;
13034 /* Optimize the case that only the line containing the cursor in the
13035 selected window has changed. Variables starting with this_ are
13036 set in display_line and record information about the line
13037 containing the cursor. */
13038 tlbufpos
= this_line_start_pos
;
13039 tlendpos
= this_line_end_pos
;
13040 if (!consider_all_windows_p
13041 && CHARPOS (tlbufpos
) > 0
13042 && !w
->update_mode_line
13043 && !current_buffer
->clip_changed
13044 && !current_buffer
->prevent_redisplay_optimizations_p
13045 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13046 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13047 /* Make sure recorded data applies to current buffer, etc. */
13048 && this_line_buffer
== current_buffer
13049 && current_buffer
== XBUFFER (w
->buffer
)
13051 && !w
->optional_new_start
13052 /* Point must be on the line that we have info recorded about. */
13053 && PT
>= CHARPOS (tlbufpos
)
13054 && PT
<= Z
- CHARPOS (tlendpos
)
13055 /* All text outside that line, including its final newline,
13056 must be unchanged. */
13057 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13058 CHARPOS (tlendpos
)))
13060 if (CHARPOS (tlbufpos
) > BEGV
13061 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13062 && (CHARPOS (tlbufpos
) == ZV
13063 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13064 /* Former continuation line has disappeared by becoming empty. */
13066 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13068 /* We have to handle the case of continuation around a
13069 wide-column character (see the comment in indent.c around
13072 For instance, in the following case:
13074 -------- Insert --------
13075 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13076 J_I_ ==> J_I_ `^^' are cursors.
13080 As we have to redraw the line above, we cannot use this
13084 int line_height_before
= this_line_pixel_height
;
13086 /* Note that start_display will handle the case that the
13087 line starting at tlbufpos is a continuation line. */
13088 start_display (&it
, w
, tlbufpos
);
13090 /* Implementation note: It this still necessary? */
13091 if (it
.current_x
!= this_line_start_x
)
13094 TRACE ((stderr
, "trying display optimization 1\n"));
13095 w
->cursor
.vpos
= -1;
13096 overlay_arrow_seen
= 0;
13097 it
.vpos
= this_line_vpos
;
13098 it
.current_y
= this_line_y
;
13099 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13100 display_line (&it
);
13102 /* If line contains point, is not continued,
13103 and ends at same distance from eob as before, we win. */
13104 if (w
->cursor
.vpos
>= 0
13105 /* Line is not continued, otherwise this_line_start_pos
13106 would have been set to 0 in display_line. */
13107 && CHARPOS (this_line_start_pos
)
13108 /* Line ends as before. */
13109 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13110 /* Line has same height as before. Otherwise other lines
13111 would have to be shifted up or down. */
13112 && this_line_pixel_height
== line_height_before
)
13114 /* If this is not the window's last line, we must adjust
13115 the charstarts of the lines below. */
13116 if (it
.current_y
< it
.last_visible_y
)
13118 struct glyph_row
*row
13119 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13120 ptrdiff_t delta
, delta_bytes
;
13122 /* We used to distinguish between two cases here,
13123 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13124 when the line ends in a newline or the end of the
13125 buffer's accessible portion. But both cases did
13126 the same, so they were collapsed. */
13128 - CHARPOS (tlendpos
)
13129 - MATRIX_ROW_START_CHARPOS (row
));
13130 delta_bytes
= (Z_BYTE
13131 - BYTEPOS (tlendpos
)
13132 - MATRIX_ROW_START_BYTEPOS (row
));
13134 increment_matrix_positions (w
->current_matrix
,
13135 this_line_vpos
+ 1,
13136 w
->current_matrix
->nrows
,
13137 delta
, delta_bytes
);
13140 /* If this row displays text now but previously didn't,
13141 or vice versa, w->window_end_vpos may have to be
13143 if ((it
.glyph_row
- 1)->displays_text_p
)
13145 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13146 wset_window_end_vpos (w
, make_number (this_line_vpos
));
13148 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13149 && this_line_vpos
> 0)
13150 wset_window_end_vpos (w
, make_number (this_line_vpos
- 1));
13151 w
->window_end_valid
= 0;
13153 /* Update hint: No need to try to scroll in update_window. */
13154 w
->desired_matrix
->no_scrolling_p
= 1;
13157 *w
->desired_matrix
->method
= 0;
13158 debug_method_add (w
, "optimization 1");
13160 #ifdef HAVE_WINDOW_SYSTEM
13161 update_window_fringes (w
, 0);
13168 else if (/* Cursor position hasn't changed. */
13169 PT
== w
->last_point
13170 /* Make sure the cursor was last displayed
13171 in this window. Otherwise we have to reposition it. */
13172 && 0 <= w
->cursor
.vpos
13173 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13177 do_pending_window_change (1);
13178 /* If selected_window changed, redisplay again. */
13179 if (WINDOWP (selected_window
)
13180 && (w
= XWINDOW (selected_window
)) != sw
)
13183 /* We used to always goto end_of_redisplay here, but this
13184 isn't enough if we have a blinking cursor. */
13185 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13186 goto end_of_redisplay
;
13190 /* If highlighting the region, or if the cursor is in the echo area,
13191 then we can't just move the cursor. */
13192 else if (! (!NILP (Vtransient_mark_mode
)
13193 && !NILP (BVAR (current_buffer
, mark_active
)))
13194 && (EQ (selected_window
,
13195 BVAR (current_buffer
, last_selected_window
))
13196 || highlight_nonselected_windows
)
13197 && !w
->region_showing
13198 && NILP (Vshow_trailing_whitespace
)
13199 && !cursor_in_echo_area
)
13202 struct glyph_row
*row
;
13204 /* Skip from tlbufpos to PT and see where it is. Note that
13205 PT may be in invisible text. If so, we will end at the
13206 next visible position. */
13207 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13208 NULL
, DEFAULT_FACE_ID
);
13209 it
.current_x
= this_line_start_x
;
13210 it
.current_y
= this_line_y
;
13211 it
.vpos
= this_line_vpos
;
13213 /* The call to move_it_to stops in front of PT, but
13214 moves over before-strings. */
13215 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13217 if (it
.vpos
== this_line_vpos
13218 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13221 eassert (this_line_vpos
== it
.vpos
);
13222 eassert (this_line_y
== it
.current_y
);
13223 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13225 *w
->desired_matrix
->method
= 0;
13226 debug_method_add (w
, "optimization 3");
13235 /* Text changed drastically or point moved off of line. */
13236 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13239 CHARPOS (this_line_start_pos
) = 0;
13240 consider_all_windows_p
|= buffer_shared_and_changed ();
13241 ++clear_face_cache_count
;
13242 #ifdef HAVE_WINDOW_SYSTEM
13243 ++clear_image_cache_count
;
13246 /* Build desired matrices, and update the display. If
13247 consider_all_windows_p is non-zero, do it for all windows on all
13248 frames. Otherwise do it for selected_window, only. */
13250 if (consider_all_windows_p
)
13252 FOR_EACH_FRAME (tail
, frame
)
13253 XFRAME (frame
)->updated_p
= 0;
13255 FOR_EACH_FRAME (tail
, frame
)
13257 struct frame
*f
= XFRAME (frame
);
13259 /* We don't have to do anything for unselected terminal
13261 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13262 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13265 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13267 /* Mark all the scroll bars to be removed; we'll redeem
13268 the ones we want when we redisplay their windows. */
13269 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13270 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13272 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13273 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13275 /* The X error handler may have deleted that frame. */
13276 if (!FRAME_LIVE_P (f
))
13279 /* Any scroll bars which redisplay_windows should have
13280 nuked should now go away. */
13281 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13282 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13284 /* If fonts changed, display again. */
13285 /* ??? rms: I suspect it is a mistake to jump all the way
13286 back to retry here. It should just retry this frame. */
13287 if (fonts_changed_p
)
13290 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13292 /* See if we have to hscroll. */
13293 if (!f
->already_hscrolled_p
)
13295 f
->already_hscrolled_p
= 1;
13296 if (hscroll_windows (f
->root_window
))
13300 /* Prevent various kinds of signals during display
13301 update. stdio is not robust about handling
13302 signals, which can cause an apparent I/O
13304 if (interrupt_input
)
13305 unrequest_sigio ();
13308 /* Update the display. */
13309 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13310 pending
|= update_frame (f
, 0, 0);
13316 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13320 /* Do the mark_window_display_accurate after all windows have
13321 been redisplayed because this call resets flags in buffers
13322 which are needed for proper redisplay. */
13323 FOR_EACH_FRAME (tail
, frame
)
13325 struct frame
*f
= XFRAME (frame
);
13328 mark_window_display_accurate (f
->root_window
, 1);
13329 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13330 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13335 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13337 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13338 struct frame
*mini_frame
;
13340 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13341 /* Use list_of_error, not Qerror, so that
13342 we catch only errors and don't run the debugger. */
13343 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13345 redisplay_window_error
);
13346 if (update_miniwindow_p
)
13347 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13349 redisplay_window_error
);
13351 /* Compare desired and current matrices, perform output. */
13354 /* If fonts changed, display again. */
13355 if (fonts_changed_p
)
13358 /* Prevent various kinds of signals during display update.
13359 stdio is not robust about handling signals,
13360 which can cause an apparent I/O error. */
13361 if (interrupt_input
)
13362 unrequest_sigio ();
13365 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13367 if (hscroll_windows (selected_window
))
13370 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13371 pending
= update_frame (sf
, 0, 0);
13374 /* We may have called echo_area_display at the top of this
13375 function. If the echo area is on another frame, that may
13376 have put text on a frame other than the selected one, so the
13377 above call to update_frame would not have caught it. Catch
13379 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13380 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13382 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13384 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13385 pending
|= update_frame (mini_frame
, 0, 0);
13386 if (!pending
&& hscroll_windows (mini_window
))
13391 /* If display was paused because of pending input, make sure we do a
13392 thorough update the next time. */
13395 /* Prevent the optimization at the beginning of
13396 redisplay_internal that tries a single-line update of the
13397 line containing the cursor in the selected window. */
13398 CHARPOS (this_line_start_pos
) = 0;
13400 /* Let the overlay arrow be updated the next time. */
13401 update_overlay_arrows (0);
13403 /* If we pause after scrolling, some rows in the current
13404 matrices of some windows are not valid. */
13405 if (!WINDOW_FULL_WIDTH_P (w
)
13406 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13407 update_mode_lines
= 1;
13411 if (!consider_all_windows_p
)
13413 /* This has already been done above if
13414 consider_all_windows_p is set. */
13415 mark_window_display_accurate_1 (w
, 1);
13417 /* Say overlay arrows are up to date. */
13418 update_overlay_arrows (1);
13420 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13421 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13424 update_mode_lines
= 0;
13425 windows_or_buffers_changed
= 0;
13426 cursor_type_changed
= 0;
13429 /* Start SIGIO interrupts coming again. Having them off during the
13430 code above makes it less likely one will discard output, but not
13431 impossible, since there might be stuff in the system buffer here.
13432 But it is much hairier to try to do anything about that. */
13433 if (interrupt_input
)
13437 /* If a frame has become visible which was not before, redisplay
13438 again, so that we display it. Expose events for such a frame
13439 (which it gets when becoming visible) don't call the parts of
13440 redisplay constructing glyphs, so simply exposing a frame won't
13441 display anything in this case. So, we have to display these
13442 frames here explicitly. */
13447 FOR_EACH_FRAME (tail
, frame
)
13449 int this_is_visible
= 0;
13451 if (XFRAME (frame
)->visible
)
13452 this_is_visible
= 1;
13454 if (this_is_visible
)
13458 if (new_count
!= number_of_visible_frames
)
13459 windows_or_buffers_changed
++;
13462 /* Change frame size now if a change is pending. */
13463 do_pending_window_change (1);
13465 /* If we just did a pending size change, or have additional
13466 visible frames, or selected_window changed, redisplay again. */
13467 if ((windows_or_buffers_changed
&& !pending
)
13468 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13471 /* Clear the face and image caches.
13473 We used to do this only if consider_all_windows_p. But the cache
13474 needs to be cleared if a timer creates images in the current
13475 buffer (e.g. the test case in Bug#6230). */
13477 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13479 clear_face_cache (0);
13480 clear_face_cache_count
= 0;
13483 #ifdef HAVE_WINDOW_SYSTEM
13484 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13486 clear_image_caches (Qnil
);
13487 clear_image_cache_count
= 0;
13489 #endif /* HAVE_WINDOW_SYSTEM */
13492 backtrace_list
= backtrace
.next
;
13493 unbind_to (count
, Qnil
);
13498 /* Redisplay, but leave alone any recent echo area message unless
13499 another message has been requested in its place.
13501 This is useful in situations where you need to redisplay but no
13502 user action has occurred, making it inappropriate for the message
13503 area to be cleared. See tracking_off and
13504 wait_reading_process_output for examples of these situations.
13506 FROM_WHERE is an integer saying from where this function was
13507 called. This is useful for debugging. */
13510 redisplay_preserve_echo_area (int from_where
)
13512 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13514 if (!NILP (echo_area_buffer
[1]))
13516 /* We have a previously displayed message, but no current
13517 message. Redisplay the previous message. */
13518 display_last_displayed_message_p
= 1;
13519 redisplay_internal ();
13520 display_last_displayed_message_p
= 0;
13523 redisplay_internal ();
13525 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13526 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13527 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13531 /* Function registered with record_unwind_protect in redisplay_internal.
13532 Clear redisplaying_p. Also select the previously selected frame. */
13535 unwind_redisplay (Lisp_Object old_frame
)
13537 redisplaying_p
= 0;
13542 /* Mark the display of leaf window W as accurate or inaccurate.
13543 If ACCURATE_P is non-zero mark display of W as accurate. If
13544 ACCURATE_P is zero, arrange for W to be redisplayed the next
13545 time redisplay_internal is called. */
13548 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13550 struct buffer
*b
= XBUFFER (w
->buffer
);
13552 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
13553 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
13554 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13558 b
->clip_changed
= 0;
13559 b
->prevent_redisplay_optimizations_p
= 0;
13561 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13562 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13563 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13564 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13566 w
->current_matrix
->buffer
= b
;
13567 w
->current_matrix
->begv
= BUF_BEGV (b
);
13568 w
->current_matrix
->zv
= BUF_ZV (b
);
13570 w
->last_cursor
= w
->cursor
;
13571 w
->last_cursor_off_p
= w
->cursor_off_p
;
13573 if (w
== XWINDOW (selected_window
))
13574 w
->last_point
= BUF_PT (b
);
13576 w
->last_point
= marker_position (w
->pointm
);
13578 w
->window_end_valid
= 1;
13579 w
->update_mode_line
= 0;
13584 /* Mark the display of windows in the window tree rooted at WINDOW as
13585 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13586 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13587 be redisplayed the next time redisplay_internal is called. */
13590 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13594 for (; !NILP (window
); window
= w
->next
)
13596 w
= XWINDOW (window
);
13597 if (!NILP (w
->vchild
))
13598 mark_window_display_accurate (w
->vchild
, accurate_p
);
13599 else if (!NILP (w
->hchild
))
13600 mark_window_display_accurate (w
->hchild
, accurate_p
);
13601 else if (BUFFERP (w
->buffer
))
13602 mark_window_display_accurate_1 (w
, accurate_p
);
13606 update_overlay_arrows (1);
13608 /* Force a thorough redisplay the next time by setting
13609 last_arrow_position and last_arrow_string to t, which is
13610 unequal to any useful value of Voverlay_arrow_... */
13611 update_overlay_arrows (-1);
13615 /* Return value in display table DP (Lisp_Char_Table *) for character
13616 C. Since a display table doesn't have any parent, we don't have to
13617 follow parent. Do not call this function directly but use the
13618 macro DISP_CHAR_VECTOR. */
13621 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13625 if (ASCII_CHAR_P (c
))
13628 if (SUB_CHAR_TABLE_P (val
))
13629 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13635 XSETCHAR_TABLE (table
, dp
);
13636 val
= char_table_ref (table
, c
);
13645 /***********************************************************************
13647 ***********************************************************************/
13649 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13652 redisplay_windows (Lisp_Object window
)
13654 while (!NILP (window
))
13656 struct window
*w
= XWINDOW (window
);
13658 if (!NILP (w
->hchild
))
13659 redisplay_windows (w
->hchild
);
13660 else if (!NILP (w
->vchild
))
13661 redisplay_windows (w
->vchild
);
13662 else if (!NILP (w
->buffer
))
13664 displayed_buffer
= XBUFFER (w
->buffer
);
13665 /* Use list_of_error, not Qerror, so that
13666 we catch only errors and don't run the debugger. */
13667 internal_condition_case_1 (redisplay_window_0
, window
,
13669 redisplay_window_error
);
13677 redisplay_window_error (Lisp_Object ignore
)
13679 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13684 redisplay_window_0 (Lisp_Object window
)
13686 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13687 redisplay_window (window
, 0);
13692 redisplay_window_1 (Lisp_Object window
)
13694 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13695 redisplay_window (window
, 1);
13700 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13701 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13702 which positions recorded in ROW differ from current buffer
13705 Return 0 if cursor is not on this row, 1 otherwise. */
13708 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13709 struct glyph_matrix
*matrix
,
13710 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13713 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13714 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13715 struct glyph
*cursor
= NULL
;
13716 /* The last known character position in row. */
13717 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13719 ptrdiff_t pt_old
= PT
- delta
;
13720 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13721 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13722 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13723 /* A glyph beyond the edge of TEXT_AREA which we should never
13725 struct glyph
*glyphs_end
= end
;
13726 /* Non-zero means we've found a match for cursor position, but that
13727 glyph has the avoid_cursor_p flag set. */
13728 int match_with_avoid_cursor
= 0;
13729 /* Non-zero means we've seen at least one glyph that came from a
13731 int string_seen
= 0;
13732 /* Largest and smallest buffer positions seen so far during scan of
13734 ptrdiff_t bpos_max
= pos_before
;
13735 ptrdiff_t bpos_min
= pos_after
;
13736 /* Last buffer position covered by an overlay string with an integer
13737 `cursor' property. */
13738 ptrdiff_t bpos_covered
= 0;
13739 /* Non-zero means the display string on which to display the cursor
13740 comes from a text property, not from an overlay. */
13741 int string_from_text_prop
= 0;
13743 /* Don't even try doing anything if called for a mode-line or
13744 header-line row, since the rest of the code isn't prepared to
13745 deal with such calamities. */
13746 eassert (!row
->mode_line_p
);
13747 if (row
->mode_line_p
)
13750 /* Skip over glyphs not having an object at the start and the end of
13751 the row. These are special glyphs like truncation marks on
13752 terminal frames. */
13753 if (row
->displays_text_p
)
13755 if (!row
->reversed_p
)
13758 && INTEGERP (glyph
->object
)
13759 && glyph
->charpos
< 0)
13761 x
+= glyph
->pixel_width
;
13765 && INTEGERP ((end
- 1)->object
)
13766 /* CHARPOS is zero for blanks and stretch glyphs
13767 inserted by extend_face_to_end_of_line. */
13768 && (end
- 1)->charpos
<= 0)
13770 glyph_before
= glyph
- 1;
13777 /* If the glyph row is reversed, we need to process it from back
13778 to front, so swap the edge pointers. */
13779 glyphs_end
= end
= glyph
- 1;
13780 glyph
+= row
->used
[TEXT_AREA
] - 1;
13782 while (glyph
> end
+ 1
13783 && INTEGERP (glyph
->object
)
13784 && glyph
->charpos
< 0)
13787 x
-= glyph
->pixel_width
;
13789 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13791 /* By default, in reversed rows we put the cursor on the
13792 rightmost (first in the reading order) glyph. */
13793 for (g
= end
+ 1; g
< glyph
; g
++)
13794 x
+= g
->pixel_width
;
13796 && INTEGERP ((end
+ 1)->object
)
13797 && (end
+ 1)->charpos
<= 0)
13799 glyph_before
= glyph
+ 1;
13803 else if (row
->reversed_p
)
13805 /* In R2L rows that don't display text, put the cursor on the
13806 rightmost glyph. Case in point: an empty last line that is
13807 part of an R2L paragraph. */
13809 /* Avoid placing the cursor on the last glyph of the row, where
13810 on terminal frames we hold the vertical border between
13811 adjacent windows. */
13812 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13813 && !WINDOW_RIGHTMOST_P (w
)
13814 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13816 x
= -1; /* will be computed below, at label compute_x */
13819 /* Step 1: Try to find the glyph whose character position
13820 corresponds to point. If that's not possible, find 2 glyphs
13821 whose character positions are the closest to point, one before
13822 point, the other after it. */
13823 if (!row
->reversed_p
)
13824 while (/* not marched to end of glyph row */
13826 /* glyph was not inserted by redisplay for internal purposes */
13827 && !INTEGERP (glyph
->object
))
13829 if (BUFFERP (glyph
->object
))
13831 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
13833 if (glyph
->charpos
> bpos_max
)
13834 bpos_max
= glyph
->charpos
;
13835 if (glyph
->charpos
< bpos_min
)
13836 bpos_min
= glyph
->charpos
;
13837 if (!glyph
->avoid_cursor_p
)
13839 /* If we hit point, we've found the glyph on which to
13840 display the cursor. */
13843 match_with_avoid_cursor
= 0;
13846 /* See if we've found a better approximation to
13847 POS_BEFORE or to POS_AFTER. */
13848 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13850 pos_before
= glyph
->charpos
;
13851 glyph_before
= glyph
;
13853 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
13855 pos_after
= glyph
->charpos
;
13856 glyph_after
= glyph
;
13859 else if (dpos
== 0)
13860 match_with_avoid_cursor
= 1;
13862 else if (STRINGP (glyph
->object
))
13864 Lisp_Object chprop
;
13865 ptrdiff_t glyph_pos
= glyph
->charpos
;
13867 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13869 if (!NILP (chprop
))
13871 /* If the string came from a `display' text property,
13872 look up the buffer position of that property and
13873 use that position to update bpos_max, as if we
13874 actually saw such a position in one of the row's
13875 glyphs. This helps with supporting integer values
13876 of `cursor' property on the display string in
13877 situations where most or all of the row's buffer
13878 text is completely covered by display properties,
13879 so that no glyph with valid buffer positions is
13880 ever seen in the row. */
13881 ptrdiff_t prop_pos
=
13882 string_buffer_position_lim (glyph
->object
, pos_before
,
13885 if (prop_pos
>= pos_before
)
13886 bpos_max
= prop_pos
- 1;
13888 if (INTEGERP (chprop
))
13890 bpos_covered
= bpos_max
+ XINT (chprop
);
13891 /* If the `cursor' property covers buffer positions up
13892 to and including point, we should display cursor on
13893 this glyph. Note that, if a `cursor' property on one
13894 of the string's characters has an integer value, we
13895 will break out of the loop below _before_ we get to
13896 the position match above. IOW, integer values of
13897 the `cursor' property override the "exact match for
13898 point" strategy of positioning the cursor. */
13899 /* Implementation note: bpos_max == pt_old when, e.g.,
13900 we are in an empty line, where bpos_max is set to
13901 MATRIX_ROW_START_CHARPOS, see above. */
13902 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13911 x
+= glyph
->pixel_width
;
13914 else if (glyph
> end
) /* row is reversed */
13915 while (!INTEGERP (glyph
->object
))
13917 if (BUFFERP (glyph
->object
))
13919 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
13921 if (glyph
->charpos
> bpos_max
)
13922 bpos_max
= glyph
->charpos
;
13923 if (glyph
->charpos
< bpos_min
)
13924 bpos_min
= glyph
->charpos
;
13925 if (!glyph
->avoid_cursor_p
)
13929 match_with_avoid_cursor
= 0;
13932 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13934 pos_before
= glyph
->charpos
;
13935 glyph_before
= glyph
;
13937 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
13939 pos_after
= glyph
->charpos
;
13940 glyph_after
= glyph
;
13943 else if (dpos
== 0)
13944 match_with_avoid_cursor
= 1;
13946 else if (STRINGP (glyph
->object
))
13948 Lisp_Object chprop
;
13949 ptrdiff_t glyph_pos
= glyph
->charpos
;
13951 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13953 if (!NILP (chprop
))
13955 ptrdiff_t prop_pos
=
13956 string_buffer_position_lim (glyph
->object
, pos_before
,
13959 if (prop_pos
>= pos_before
)
13960 bpos_max
= prop_pos
- 1;
13962 if (INTEGERP (chprop
))
13964 bpos_covered
= bpos_max
+ XINT (chprop
);
13965 /* If the `cursor' property covers buffer positions up
13966 to and including point, we should display cursor on
13968 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13977 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13979 x
--; /* can't use any pixel_width */
13982 x
-= glyph
->pixel_width
;
13985 /* Step 2: If we didn't find an exact match for point, we need to
13986 look for a proper place to put the cursor among glyphs between
13987 GLYPH_BEFORE and GLYPH_AFTER. */
13988 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13989 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13990 && !(bpos_max
< pt_old
&& pt_old
<= bpos_covered
))
13992 /* An empty line has a single glyph whose OBJECT is zero and
13993 whose CHARPOS is the position of a newline on that line.
13994 Note that on a TTY, there are more glyphs after that, which
13995 were produced by extend_face_to_end_of_line, but their
13996 CHARPOS is zero or negative. */
13998 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13999 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14000 /* On a TTY, continued and truncated rows also have a glyph at
14001 their end whose OBJECT is zero and whose CHARPOS is
14002 positive (the continuation and truncation glyphs), but such
14003 rows are obviously not "empty". */
14004 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14006 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14008 ptrdiff_t ellipsis_pos
;
14010 /* Scan back over the ellipsis glyphs. */
14011 if (!row
->reversed_p
)
14013 ellipsis_pos
= (glyph
- 1)->charpos
;
14014 while (glyph
> row
->glyphs
[TEXT_AREA
]
14015 && (glyph
- 1)->charpos
== ellipsis_pos
)
14016 glyph
--, x
-= glyph
->pixel_width
;
14017 /* That loop always goes one position too far, including
14018 the glyph before the ellipsis. So scan forward over
14020 x
+= glyph
->pixel_width
;
14023 else /* row is reversed */
14025 ellipsis_pos
= (glyph
+ 1)->charpos
;
14026 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14027 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14028 glyph
++, x
+= glyph
->pixel_width
;
14029 x
-= glyph
->pixel_width
;
14033 else if (match_with_avoid_cursor
)
14035 cursor
= glyph_after
;
14038 else if (string_seen
)
14040 int incr
= row
->reversed_p
? -1 : +1;
14042 /* Need to find the glyph that came out of a string which is
14043 present at point. That glyph is somewhere between
14044 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14045 positioned between POS_BEFORE and POS_AFTER in the
14047 struct glyph
*start
, *stop
;
14048 ptrdiff_t pos
= pos_before
;
14052 /* If the row ends in a newline from a display string,
14053 reordering could have moved the glyphs belonging to the
14054 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14055 in this case we extend the search to the last glyph in
14056 the row that was not inserted by redisplay. */
14057 if (row
->ends_in_newline_from_string_p
)
14060 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14063 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14064 correspond to POS_BEFORE and POS_AFTER, respectively. We
14065 need START and STOP in the order that corresponds to the
14066 row's direction as given by its reversed_p flag. If the
14067 directionality of characters between POS_BEFORE and
14068 POS_AFTER is the opposite of the row's base direction,
14069 these characters will have been reordered for display,
14070 and we need to reverse START and STOP. */
14071 if (!row
->reversed_p
)
14073 start
= min (glyph_before
, glyph_after
);
14074 stop
= max (glyph_before
, glyph_after
);
14078 start
= max (glyph_before
, glyph_after
);
14079 stop
= min (glyph_before
, glyph_after
);
14081 for (glyph
= start
+ incr
;
14082 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14085 /* Any glyphs that come from the buffer are here because
14086 of bidi reordering. Skip them, and only pay
14087 attention to glyphs that came from some string. */
14088 if (STRINGP (glyph
->object
))
14092 /* If the display property covers the newline, we
14093 need to search for it one position farther. */
14094 ptrdiff_t lim
= pos_after
14095 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14097 string_from_text_prop
= 0;
14098 str
= glyph
->object
;
14099 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14100 if (tem
== 0 /* from overlay */
14103 /* If the string from which this glyph came is
14104 found in the buffer at point, or at position
14105 that is closer to point than pos_after, then
14106 we've found the glyph we've been looking for.
14107 If it comes from an overlay (tem == 0), and
14108 it has the `cursor' property on one of its
14109 glyphs, record that glyph as a candidate for
14110 displaying the cursor. (As in the
14111 unidirectional version, we will display the
14112 cursor on the last candidate we find.) */
14115 || (tem
- pt_old
> 0 && tem
< pos_after
))
14117 /* The glyphs from this string could have
14118 been reordered. Find the one with the
14119 smallest string position. Or there could
14120 be a character in the string with the
14121 `cursor' property, which means display
14122 cursor on that character's glyph. */
14123 ptrdiff_t strpos
= glyph
->charpos
;
14128 string_from_text_prop
= 1;
14131 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14132 && EQ (glyph
->object
, str
);
14136 ptrdiff_t gpos
= glyph
->charpos
;
14138 cprop
= Fget_char_property (make_number (gpos
),
14146 if (tem
&& glyph
->charpos
< strpos
)
14148 strpos
= glyph
->charpos
;
14154 || (tem
- pt_old
> 0 && tem
< pos_after
))
14158 pos
= tem
+ 1; /* don't find previous instances */
14160 /* This string is not what we want; skip all of the
14161 glyphs that came from it. */
14162 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14163 && EQ (glyph
->object
, str
))
14170 /* If we reached the end of the line, and END was from a string,
14171 the cursor is not on this line. */
14173 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14174 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14175 && STRINGP (end
->object
)
14176 && row
->continued_p
)
14179 /* A truncated row may not include PT among its character positions.
14180 Setting the cursor inside the scroll margin will trigger
14181 recalculation of hscroll in hscroll_window_tree. But if a
14182 display string covers point, defer to the string-handling
14183 code below to figure this out. */
14184 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14186 cursor
= glyph_before
;
14189 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14190 /* Zero-width characters produce no glyphs. */
14192 && (row
->reversed_p
14193 ? glyph_after
> glyphs_end
14194 : glyph_after
< glyphs_end
)))
14196 cursor
= glyph_after
;
14202 if (cursor
!= NULL
)
14204 else if (glyph
== glyphs_end
14205 && pos_before
== pos_after
14206 && STRINGP ((row
->reversed_p
14207 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14208 : row
->glyphs
[TEXT_AREA
])->object
))
14210 /* If all the glyphs of this row came from strings, put the
14211 cursor on the first glyph of the row. This avoids having the
14212 cursor outside of the text area in this very rare and hard
14216 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14217 : row
->glyphs
[TEXT_AREA
];
14223 /* Need to compute x that corresponds to GLYPH. */
14224 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14226 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14228 x
+= g
->pixel_width
;
14232 /* ROW could be part of a continued line, which, under bidi
14233 reordering, might have other rows whose start and end charpos
14234 occlude point. Only set w->cursor if we found a better
14235 approximation to the cursor position than we have from previously
14236 examined candidate rows belonging to the same continued line. */
14237 if (/* we already have a candidate row */
14238 w
->cursor
.vpos
>= 0
14239 /* that candidate is not the row we are processing */
14240 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14241 /* Make sure cursor.vpos specifies a row whose start and end
14242 charpos occlude point, and it is valid candidate for being a
14243 cursor-row. This is because some callers of this function
14244 leave cursor.vpos at the row where the cursor was displayed
14245 during the last redisplay cycle. */
14246 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14247 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14248 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14251 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14253 /* Don't consider glyphs that are outside TEXT_AREA. */
14254 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14256 /* Keep the candidate whose buffer position is the closest to
14257 point or has the `cursor' property. */
14258 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14259 w
->cursor
.hpos
>= 0
14260 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14261 && ((BUFFERP (g1
->object
)
14262 && (g1
->charpos
== pt_old
/* an exact match always wins */
14263 || (BUFFERP (glyph
->object
)
14264 && eabs (g1
->charpos
- pt_old
)
14265 < eabs (glyph
->charpos
- pt_old
))))
14266 /* previous candidate is a glyph from a string that has
14267 a non-nil `cursor' property */
14268 || (STRINGP (g1
->object
)
14269 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14270 Qcursor
, g1
->object
))
14271 /* previous candidate is from the same display
14272 string as this one, and the display string
14273 came from a text property */
14274 || (EQ (g1
->object
, glyph
->object
)
14275 && string_from_text_prop
)
14276 /* this candidate is from newline and its
14277 position is not an exact match */
14278 || (INTEGERP (glyph
->object
)
14279 && glyph
->charpos
!= pt_old
)))))
14281 /* If this candidate gives an exact match, use that. */
14282 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14283 /* If this candidate is a glyph created for the
14284 terminating newline of a line, and point is on that
14285 newline, it wins because it's an exact match. */
14286 || (!row
->continued_p
14287 && INTEGERP (glyph
->object
)
14288 && glyph
->charpos
== 0
14289 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14290 /* Otherwise, keep the candidate that comes from a row
14291 spanning less buffer positions. This may win when one or
14292 both candidate positions are on glyphs that came from
14293 display strings, for which we cannot compare buffer
14295 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14296 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14297 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14300 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14302 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14303 w
->cursor
.y
= row
->y
+ dy
;
14305 if (w
== XWINDOW (selected_window
))
14307 if (!row
->continued_p
14308 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14311 this_line_buffer
= XBUFFER (w
->buffer
);
14313 CHARPOS (this_line_start_pos
)
14314 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14315 BYTEPOS (this_line_start_pos
)
14316 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14318 CHARPOS (this_line_end_pos
)
14319 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14320 BYTEPOS (this_line_end_pos
)
14321 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14323 this_line_y
= w
->cursor
.y
;
14324 this_line_pixel_height
= row
->height
;
14325 this_line_vpos
= w
->cursor
.vpos
;
14326 this_line_start_x
= row
->x
;
14329 CHARPOS (this_line_start_pos
) = 0;
14336 /* Run window scroll functions, if any, for WINDOW with new window
14337 start STARTP. Sets the window start of WINDOW to that position.
14339 We assume that the window's buffer is really current. */
14341 static struct text_pos
14342 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14344 struct window
*w
= XWINDOW (window
);
14345 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14347 if (current_buffer
!= XBUFFER (w
->buffer
))
14350 if (!NILP (Vwindow_scroll_functions
))
14352 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14353 make_number (CHARPOS (startp
)));
14354 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14355 /* In case the hook functions switch buffers. */
14356 set_buffer_internal (XBUFFER (w
->buffer
));
14363 /* Make sure the line containing the cursor is fully visible.
14364 A value of 1 means there is nothing to be done.
14365 (Either the line is fully visible, or it cannot be made so,
14366 or we cannot tell.)
14368 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14369 is higher than window.
14371 A value of 0 means the caller should do scrolling
14372 as if point had gone off the screen. */
14375 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14377 struct glyph_matrix
*matrix
;
14378 struct glyph_row
*row
;
14381 if (!make_cursor_line_fully_visible_p
)
14384 /* It's not always possible to find the cursor, e.g, when a window
14385 is full of overlay strings. Don't do anything in that case. */
14386 if (w
->cursor
.vpos
< 0)
14389 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14390 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14392 /* If the cursor row is not partially visible, there's nothing to do. */
14393 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14396 /* If the row the cursor is in is taller than the window's height,
14397 it's not clear what to do, so do nothing. */
14398 window_height
= window_box_height (w
);
14399 if (row
->height
>= window_height
)
14401 if (!force_p
|| MINI_WINDOW_P (w
)
14402 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14409 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14410 non-zero means only WINDOW is redisplayed in redisplay_internal.
14411 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14412 in redisplay_window to bring a partially visible line into view in
14413 the case that only the cursor has moved.
14415 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14416 last screen line's vertical height extends past the end of the screen.
14420 1 if scrolling succeeded
14422 0 if scrolling didn't find point.
14424 -1 if new fonts have been loaded so that we must interrupt
14425 redisplay, adjust glyph matrices, and try again. */
14431 SCROLLING_NEED_LARGER_MATRICES
14434 /* If scroll-conservatively is more than this, never recenter.
14436 If you change this, don't forget to update the doc string of
14437 `scroll-conservatively' and the Emacs manual. */
14438 #define SCROLL_LIMIT 100
14441 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14442 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14443 int temp_scroll_step
, int last_line_misfit
)
14445 struct window
*w
= XWINDOW (window
);
14446 struct frame
*f
= XFRAME (w
->frame
);
14447 struct text_pos pos
, startp
;
14449 int this_scroll_margin
, scroll_max
, rc
, height
;
14450 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14451 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14452 Lisp_Object aggressive
;
14453 /* We will never try scrolling more than this number of lines. */
14454 int scroll_limit
= SCROLL_LIMIT
;
14457 debug_method_add (w
, "try_scrolling");
14460 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14462 /* Compute scroll margin height in pixels. We scroll when point is
14463 within this distance from the top or bottom of the window. */
14464 if (scroll_margin
> 0)
14465 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14466 * FRAME_LINE_HEIGHT (f
);
14468 this_scroll_margin
= 0;
14470 /* Force arg_scroll_conservatively to have a reasonable value, to
14471 avoid scrolling too far away with slow move_it_* functions. Note
14472 that the user can supply scroll-conservatively equal to
14473 `most-positive-fixnum', which can be larger than INT_MAX. */
14474 if (arg_scroll_conservatively
> scroll_limit
)
14476 arg_scroll_conservatively
= scroll_limit
+ 1;
14477 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14479 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14480 /* Compute how much we should try to scroll maximally to bring
14481 point into view. */
14482 scroll_max
= (max (scroll_step
,
14483 max (arg_scroll_conservatively
, temp_scroll_step
))
14484 * FRAME_LINE_HEIGHT (f
));
14485 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14486 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14487 /* We're trying to scroll because of aggressive scrolling but no
14488 scroll_step is set. Choose an arbitrary one. */
14489 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14495 /* Decide whether to scroll down. */
14496 if (PT
> CHARPOS (startp
))
14498 int scroll_margin_y
;
14500 /* Compute the pixel ypos of the scroll margin, then move IT to
14501 either that ypos or PT, whichever comes first. */
14502 start_display (&it
, w
, startp
);
14503 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14504 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14505 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14506 (MOVE_TO_POS
| MOVE_TO_Y
));
14508 if (PT
> CHARPOS (it
.current
.pos
))
14510 int y0
= line_bottom_y (&it
);
14511 /* Compute how many pixels below window bottom to stop searching
14512 for PT. This avoids costly search for PT that is far away if
14513 the user limited scrolling by a small number of lines, but
14514 always finds PT if scroll_conservatively is set to a large
14515 number, such as most-positive-fixnum. */
14516 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14517 int y_to_move
= it
.last_visible_y
+ slack
;
14519 /* Compute the distance from the scroll margin to PT or to
14520 the scroll limit, whichever comes first. This should
14521 include the height of the cursor line, to make that line
14523 move_it_to (&it
, PT
, -1, y_to_move
,
14524 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14525 dy
= line_bottom_y (&it
) - y0
;
14527 if (dy
> scroll_max
)
14528 return SCROLLING_FAILED
;
14537 /* Point is in or below the bottom scroll margin, so move the
14538 window start down. If scrolling conservatively, move it just
14539 enough down to make point visible. If scroll_step is set,
14540 move it down by scroll_step. */
14541 if (arg_scroll_conservatively
)
14543 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14544 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14545 else if (scroll_step
|| temp_scroll_step
)
14546 amount_to_scroll
= scroll_max
;
14549 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14550 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14551 if (NUMBERP (aggressive
))
14553 double float_amount
= XFLOATINT (aggressive
) * height
;
14554 int aggressive_scroll
= float_amount
;
14555 if (aggressive_scroll
== 0 && float_amount
> 0)
14556 aggressive_scroll
= 1;
14557 /* Don't let point enter the scroll margin near top of
14558 the window. This could happen if the value of
14559 scroll_up_aggressively is too large and there are
14560 non-zero margins, because scroll_up_aggressively
14561 means put point that fraction of window height
14562 _from_the_bottom_margin_. */
14563 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14564 aggressive_scroll
= height
- 2*this_scroll_margin
;
14565 amount_to_scroll
= dy
+ aggressive_scroll
;
14569 if (amount_to_scroll
<= 0)
14570 return SCROLLING_FAILED
;
14572 start_display (&it
, w
, startp
);
14573 if (arg_scroll_conservatively
<= scroll_limit
)
14574 move_it_vertically (&it
, amount_to_scroll
);
14577 /* Extra precision for users who set scroll-conservatively
14578 to a large number: make sure the amount we scroll
14579 the window start is never less than amount_to_scroll,
14580 which was computed as distance from window bottom to
14581 point. This matters when lines at window top and lines
14582 below window bottom have different height. */
14584 void *it1data
= NULL
;
14585 /* We use a temporary it1 because line_bottom_y can modify
14586 its argument, if it moves one line down; see there. */
14589 SAVE_IT (it1
, it
, it1data
);
14590 start_y
= line_bottom_y (&it1
);
14592 RESTORE_IT (&it
, &it
, it1data
);
14593 move_it_by_lines (&it
, 1);
14594 SAVE_IT (it1
, it
, it1data
);
14595 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14598 /* If STARTP is unchanged, move it down another screen line. */
14599 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14600 move_it_by_lines (&it
, 1);
14601 startp
= it
.current
.pos
;
14605 struct text_pos scroll_margin_pos
= startp
;
14608 /* See if point is inside the scroll margin at the top of the
14610 if (this_scroll_margin
)
14614 start_display (&it
, w
, startp
);
14615 y_start
= it
.current_y
;
14616 move_it_vertically (&it
, this_scroll_margin
);
14617 scroll_margin_pos
= it
.current
.pos
;
14618 /* If we didn't move enough before hitting ZV, request
14619 additional amount of scroll, to move point out of the
14621 if (IT_CHARPOS (it
) == ZV
14622 && it
.current_y
- y_start
< this_scroll_margin
)
14623 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
14626 if (PT
< CHARPOS (scroll_margin_pos
))
14628 /* Point is in the scroll margin at the top of the window or
14629 above what is displayed in the window. */
14632 /* Compute the vertical distance from PT to the scroll
14633 margin position. Move as far as scroll_max allows, or
14634 one screenful, or 10 screen lines, whichever is largest.
14635 Give up if distance is greater than scroll_max or if we
14636 didn't reach the scroll margin position. */
14637 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14638 start_display (&it
, w
, pos
);
14640 y_to_move
= max (it
.last_visible_y
,
14641 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14642 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14644 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14645 dy
= it
.current_y
- y0
;
14646 if (dy
> scroll_max
14647 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
14648 return SCROLLING_FAILED
;
14650 /* Additional scroll for when ZV was too close to point. */
14653 /* Compute new window start. */
14654 start_display (&it
, w
, startp
);
14656 if (arg_scroll_conservatively
)
14657 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14658 max (scroll_step
, temp_scroll_step
));
14659 else if (scroll_step
|| temp_scroll_step
)
14660 amount_to_scroll
= scroll_max
;
14663 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14664 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14665 if (NUMBERP (aggressive
))
14667 double float_amount
= XFLOATINT (aggressive
) * height
;
14668 int aggressive_scroll
= float_amount
;
14669 if (aggressive_scroll
== 0 && float_amount
> 0)
14670 aggressive_scroll
= 1;
14671 /* Don't let point enter the scroll margin near
14672 bottom of the window, if the value of
14673 scroll_down_aggressively happens to be too
14675 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14676 aggressive_scroll
= height
- 2*this_scroll_margin
;
14677 amount_to_scroll
= dy
+ aggressive_scroll
;
14681 if (amount_to_scroll
<= 0)
14682 return SCROLLING_FAILED
;
14684 move_it_vertically_backward (&it
, amount_to_scroll
);
14685 startp
= it
.current
.pos
;
14689 /* Run window scroll functions. */
14690 startp
= run_window_scroll_functions (window
, startp
);
14692 /* Display the window. Give up if new fonts are loaded, or if point
14694 if (!try_window (window
, startp
, 0))
14695 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14696 else if (w
->cursor
.vpos
< 0)
14698 clear_glyph_matrix (w
->desired_matrix
);
14699 rc
= SCROLLING_FAILED
;
14703 /* Maybe forget recorded base line for line number display. */
14704 if (!just_this_one_p
14705 || current_buffer
->clip_changed
14706 || BEG_UNCHANGED
< CHARPOS (startp
))
14707 w
->base_line_number
= 0;
14709 /* If cursor ends up on a partially visible line,
14710 treat that as being off the bottom of the screen. */
14711 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14712 /* It's possible that the cursor is on the first line of the
14713 buffer, which is partially obscured due to a vscroll
14714 (Bug#7537). In that case, avoid looping forever . */
14715 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14717 clear_glyph_matrix (w
->desired_matrix
);
14718 ++extra_scroll_margin_lines
;
14721 rc
= SCROLLING_SUCCESS
;
14728 /* Compute a suitable window start for window W if display of W starts
14729 on a continuation line. Value is non-zero if a new window start
14732 The new window start will be computed, based on W's width, starting
14733 from the start of the continued line. It is the start of the
14734 screen line with the minimum distance from the old start W->start. */
14737 compute_window_start_on_continuation_line (struct window
*w
)
14739 struct text_pos pos
, start_pos
;
14740 int window_start_changed_p
= 0;
14742 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14744 /* If window start is on a continuation line... Window start may be
14745 < BEGV in case there's invisible text at the start of the
14746 buffer (M-x rmail, for example). */
14747 if (CHARPOS (start_pos
) > BEGV
14748 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14751 struct glyph_row
*row
;
14753 /* Handle the case that the window start is out of range. */
14754 if (CHARPOS (start_pos
) < BEGV
)
14755 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14756 else if (CHARPOS (start_pos
) > ZV
)
14757 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14759 /* Find the start of the continued line. This should be fast
14760 because find_newline is fast (newline cache). */
14761 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14762 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14763 row
, DEFAULT_FACE_ID
);
14764 reseat_at_previous_visible_line_start (&it
);
14766 /* If the line start is "too far" away from the window start,
14767 say it takes too much time to compute a new window start. */
14768 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14769 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14771 int min_distance
, distance
;
14773 /* Move forward by display lines to find the new window
14774 start. If window width was enlarged, the new start can
14775 be expected to be > the old start. If window width was
14776 decreased, the new window start will be < the old start.
14777 So, we're looking for the display line start with the
14778 minimum distance from the old window start. */
14779 pos
= it
.current
.pos
;
14780 min_distance
= INFINITY
;
14781 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14782 distance
< min_distance
)
14784 min_distance
= distance
;
14785 pos
= it
.current
.pos
;
14786 move_it_by_lines (&it
, 1);
14789 /* Set the window start there. */
14790 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14791 window_start_changed_p
= 1;
14795 return window_start_changed_p
;
14799 /* Try cursor movement in case text has not changed in window WINDOW,
14800 with window start STARTP. Value is
14802 CURSOR_MOVEMENT_SUCCESS if successful
14804 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14806 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14807 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14808 we want to scroll as if scroll-step were set to 1. See the code.
14810 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14811 which case we have to abort this redisplay, and adjust matrices
14816 CURSOR_MOVEMENT_SUCCESS
,
14817 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14818 CURSOR_MOVEMENT_MUST_SCROLL
,
14819 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14823 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14825 struct window
*w
= XWINDOW (window
);
14826 struct frame
*f
= XFRAME (w
->frame
);
14827 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14830 if (inhibit_try_cursor_movement
)
14834 /* Previously, there was a check for Lisp integer in the
14835 if-statement below. Now, this field is converted to
14836 ptrdiff_t, thus zero means invalid position in a buffer. */
14837 eassert (w
->last_point
> 0);
14839 /* Handle case where text has not changed, only point, and it has
14840 not moved off the frame. */
14841 if (/* Point may be in this window. */
14842 PT
>= CHARPOS (startp
)
14843 /* Selective display hasn't changed. */
14844 && !current_buffer
->clip_changed
14845 /* Function force-mode-line-update is used to force a thorough
14846 redisplay. It sets either windows_or_buffers_changed or
14847 update_mode_lines. So don't take a shortcut here for these
14849 && !update_mode_lines
14850 && !windows_or_buffers_changed
14851 && !cursor_type_changed
14852 /* Can't use this case if highlighting a region. When a
14853 region exists, cursor movement has to do more than just
14855 && markpos_of_region () < 0
14856 && !w
->region_showing
14857 && NILP (Vshow_trailing_whitespace
)
14858 /* This code is not used for mini-buffer for the sake of the case
14859 of redisplaying to replace an echo area message; since in
14860 that case the mini-buffer contents per se are usually
14861 unchanged. This code is of no real use in the mini-buffer
14862 since the handling of this_line_start_pos, etc., in redisplay
14863 handles the same cases. */
14864 && !EQ (window
, minibuf_window
)
14865 /* When splitting windows or for new windows, it happens that
14866 redisplay is called with a nil window_end_vpos or one being
14867 larger than the window. This should really be fixed in
14868 window.c. I don't have this on my list, now, so we do
14869 approximately the same as the old redisplay code. --gerd. */
14870 && INTEGERP (w
->window_end_vpos
)
14871 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14872 && (FRAME_WINDOW_P (f
)
14873 || !overlay_arrow_in_current_buffer_p ()))
14875 int this_scroll_margin
, top_scroll_margin
;
14876 struct glyph_row
*row
= NULL
;
14879 debug_method_add (w
, "cursor movement");
14882 /* Scroll if point within this distance from the top or bottom
14883 of the window. This is a pixel value. */
14884 if (scroll_margin
> 0)
14886 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14887 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14890 this_scroll_margin
= 0;
14892 top_scroll_margin
= this_scroll_margin
;
14893 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14894 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14896 /* Start with the row the cursor was displayed during the last
14897 not paused redisplay. Give up if that row is not valid. */
14898 if (w
->last_cursor
.vpos
< 0
14899 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14900 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14903 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14904 if (row
->mode_line_p
)
14906 if (!row
->enabled_p
)
14907 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14910 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14912 int scroll_p
= 0, must_scroll
= 0;
14913 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14915 if (PT
> w
->last_point
)
14917 /* Point has moved forward. */
14918 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14919 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14921 eassert (row
->enabled_p
);
14925 /* If the end position of a row equals the start
14926 position of the next row, and PT is at that position,
14927 we would rather display cursor in the next line. */
14928 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14929 && MATRIX_ROW_END_CHARPOS (row
) == PT
14930 && row
< w
->current_matrix
->rows
14931 + w
->current_matrix
->nrows
- 1
14932 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14933 && !cursor_row_p (row
))
14936 /* If within the scroll margin, scroll. Note that
14937 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14938 the next line would be drawn, and that
14939 this_scroll_margin can be zero. */
14940 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14941 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14942 /* Line is completely visible last line in window
14943 and PT is to be set in the next line. */
14944 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14945 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14946 && !row
->ends_at_zv_p
14947 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14950 else if (PT
< w
->last_point
)
14952 /* Cursor has to be moved backward. Note that PT >=
14953 CHARPOS (startp) because of the outer if-statement. */
14954 while (!row
->mode_line_p
14955 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14956 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14957 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14958 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14959 row
> w
->current_matrix
->rows
14960 && (row
-1)->ends_in_newline_from_string_p
))))
14961 && (row
->y
> top_scroll_margin
14962 || CHARPOS (startp
) == BEGV
))
14964 eassert (row
->enabled_p
);
14968 /* Consider the following case: Window starts at BEGV,
14969 there is invisible, intangible text at BEGV, so that
14970 display starts at some point START > BEGV. It can
14971 happen that we are called with PT somewhere between
14972 BEGV and START. Try to handle that case. */
14973 if (row
< w
->current_matrix
->rows
14974 || row
->mode_line_p
)
14976 row
= w
->current_matrix
->rows
;
14977 if (row
->mode_line_p
)
14981 /* Due to newlines in overlay strings, we may have to
14982 skip forward over overlay strings. */
14983 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14984 && MATRIX_ROW_END_CHARPOS (row
) == PT
14985 && !cursor_row_p (row
))
14988 /* If within the scroll margin, scroll. */
14989 if (row
->y
< top_scroll_margin
14990 && CHARPOS (startp
) != BEGV
)
14995 /* Cursor did not move. So don't scroll even if cursor line
14996 is partially visible, as it was so before. */
14997 rc
= CURSOR_MOVEMENT_SUCCESS
;
15000 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15001 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15003 /* if PT is not in the glyph row, give up. */
15004 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15007 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15008 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15010 struct glyph_row
*row1
;
15012 /* If rows are bidi-reordered and point moved, back up
15013 until we find a row that does not belong to a
15014 continuation line. This is because we must consider
15015 all rows of a continued line as candidates for the
15016 new cursor positioning, since row start and end
15017 positions change non-linearly with vertical position
15019 /* FIXME: Revisit this when glyph ``spilling'' in
15020 continuation lines' rows is implemented for
15021 bidi-reordered rows. */
15022 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15023 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15026 /* If we hit the beginning of the displayed portion
15027 without finding the first row of a continued
15031 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15034 eassert (row
->enabled_p
);
15039 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15040 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15041 /* Make sure this isn't a header line by any chance, since
15042 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15043 && !row
->mode_line_p
15044 && make_cursor_line_fully_visible_p
)
15046 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15047 && !row
->ends_at_zv_p
15048 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15049 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15050 else if (row
->height
> window_box_height (w
))
15052 /* If we end up in a partially visible line, let's
15053 make it fully visible, except when it's taller
15054 than the window, in which case we can't do much
15057 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15061 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15062 if (!cursor_row_fully_visible_p (w
, 0, 1))
15063 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15065 rc
= CURSOR_MOVEMENT_SUCCESS
;
15069 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15070 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15071 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15073 /* With bidi-reordered rows, there could be more than
15074 one candidate row whose start and end positions
15075 occlude point. We need to let set_cursor_from_row
15076 find the best candidate. */
15077 /* FIXME: Revisit this when glyph ``spilling'' in
15078 continuation lines' rows is implemented for
15079 bidi-reordered rows. */
15084 int at_zv_p
= 0, exact_match_p
= 0;
15086 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15087 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15088 && cursor_row_p (row
))
15089 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15091 /* As soon as we've found the exact match for point,
15092 or the first suitable row whose ends_at_zv_p flag
15093 is set, we are done. */
15095 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15097 && w
->cursor
.hpos
>= 0
15098 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15101 struct glyph_row
*candidate
=
15102 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15104 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15105 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15108 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15109 || (INTEGERP (g
->object
)
15110 && (g
->charpos
== PT
15111 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15113 if (rv
&& (at_zv_p
|| exact_match_p
))
15115 rc
= CURSOR_MOVEMENT_SUCCESS
;
15118 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15122 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15123 || row
->continued_p
)
15124 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15125 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15126 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15127 /* If we didn't find any candidate rows, or exited the
15128 loop before all the candidates were examined, signal
15129 to the caller that this method failed. */
15130 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15132 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15133 && !row
->continued_p
))
15134 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15136 rc
= CURSOR_MOVEMENT_SUCCESS
;
15142 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15144 rc
= CURSOR_MOVEMENT_SUCCESS
;
15149 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15150 && MATRIX_ROW_START_CHARPOS (row
) == PT
15151 && cursor_row_p (row
));
15159 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15163 set_vertical_scroll_bar (struct window
*w
)
15165 ptrdiff_t start
, end
, whole
;
15167 /* Calculate the start and end positions for the current window.
15168 At some point, it would be nice to choose between scrollbars
15169 which reflect the whole buffer size, with special markers
15170 indicating narrowing, and scrollbars which reflect only the
15173 Note that mini-buffers sometimes aren't displaying any text. */
15174 if (!MINI_WINDOW_P (w
)
15175 || (w
== XWINDOW (minibuf_window
)
15176 && NILP (echo_area_buffer
[0])))
15178 struct buffer
*buf
= XBUFFER (w
->buffer
);
15179 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15180 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15181 /* I don't think this is guaranteed to be right. For the
15182 moment, we'll pretend it is. */
15183 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15187 if (whole
< (end
- start
))
15188 whole
= end
- start
;
15191 start
= end
= whole
= 0;
15193 /* Indicate what this scroll bar ought to be displaying now. */
15194 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15195 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15196 (w
, end
- start
, whole
, start
);
15200 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15201 selected_window is redisplayed.
15203 We can return without actually redisplaying the window if
15204 fonts_changed_p. In that case, redisplay_internal will
15208 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15210 struct window
*w
= XWINDOW (window
);
15211 struct frame
*f
= XFRAME (w
->frame
);
15212 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15213 struct buffer
*old
= current_buffer
;
15214 struct text_pos lpoint
, opoint
, startp
;
15215 int update_mode_line
;
15218 /* Record it now because it's overwritten. */
15219 int current_matrix_up_to_date_p
= 0;
15220 int used_current_matrix_p
= 0;
15221 /* This is less strict than current_matrix_up_to_date_p.
15222 It indicates that the buffer contents and narrowing are unchanged. */
15223 int buffer_unchanged_p
= 0;
15224 int temp_scroll_step
= 0;
15225 ptrdiff_t count
= SPECPDL_INDEX ();
15227 int centering_position
= -1;
15228 int last_line_misfit
= 0;
15229 ptrdiff_t beg_unchanged
, end_unchanged
;
15231 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15234 /* W must be a leaf window here. */
15235 eassert (!NILP (w
->buffer
));
15237 *w
->desired_matrix
->method
= 0;
15241 reconsider_clip_changes (w
, buffer
);
15243 /* Has the mode line to be updated? */
15244 update_mode_line
= (w
->update_mode_line
15245 || update_mode_lines
15246 || buffer
->clip_changed
15247 || buffer
->prevent_redisplay_optimizations_p
);
15249 if (MINI_WINDOW_P (w
))
15251 if (w
== XWINDOW (echo_area_window
)
15252 && !NILP (echo_area_buffer
[0]))
15254 if (update_mode_line
)
15255 /* We may have to update a tty frame's menu bar or a
15256 tool-bar. Example `M-x C-h C-h C-g'. */
15257 goto finish_menu_bars
;
15259 /* We've already displayed the echo area glyphs in this window. */
15260 goto finish_scroll_bars
;
15262 else if ((w
!= XWINDOW (minibuf_window
)
15263 || minibuf_level
== 0)
15264 /* When buffer is nonempty, redisplay window normally. */
15265 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15266 /* Quail displays non-mini buffers in minibuffer window.
15267 In that case, redisplay the window normally. */
15268 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15270 /* W is a mini-buffer window, but it's not active, so clear
15272 int yb
= window_text_bottom_y (w
);
15273 struct glyph_row
*row
;
15276 for (y
= 0, row
= w
->desired_matrix
->rows
;
15278 y
+= row
->height
, ++row
)
15279 blank_row (w
, row
, y
);
15280 goto finish_scroll_bars
;
15283 clear_glyph_matrix (w
->desired_matrix
);
15286 /* Otherwise set up data on this window; select its buffer and point
15288 /* Really select the buffer, for the sake of buffer-local
15290 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15292 current_matrix_up_to_date_p
15293 = (w
->window_end_valid
15294 && !current_buffer
->clip_changed
15295 && !current_buffer
->prevent_redisplay_optimizations_p
15296 && !window_outdated (w
));
15298 /* Run the window-bottom-change-functions
15299 if it is possible that the text on the screen has changed
15300 (either due to modification of the text, or any other reason). */
15301 if (!current_matrix_up_to_date_p
15302 && !NILP (Vwindow_text_change_functions
))
15304 safe_run_hooks (Qwindow_text_change_functions
);
15308 beg_unchanged
= BEG_UNCHANGED
;
15309 end_unchanged
= END_UNCHANGED
;
15311 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15313 specbind (Qinhibit_point_motion_hooks
, Qt
);
15316 = (w
->window_end_valid
15317 && !current_buffer
->clip_changed
15318 && !window_outdated (w
));
15320 /* When windows_or_buffers_changed is non-zero, we can't rely on
15321 the window end being valid, so set it to nil there. */
15322 if (windows_or_buffers_changed
)
15324 /* If window starts on a continuation line, maybe adjust the
15325 window start in case the window's width changed. */
15326 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15327 compute_window_start_on_continuation_line (w
);
15329 w
->window_end_valid
= 0;
15332 /* Some sanity checks. */
15333 CHECK_WINDOW_END (w
);
15334 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15336 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15339 if (mode_line_update_needed (w
))
15340 update_mode_line
= 1;
15342 /* Point refers normally to the selected window. For any other
15343 window, set up appropriate value. */
15344 if (!EQ (window
, selected_window
))
15346 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15347 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15351 new_pt_byte
= BEGV_BYTE
;
15352 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15354 else if (new_pt
> (ZV
- 1))
15357 new_pt_byte
= ZV_BYTE
;
15358 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15361 /* We don't use SET_PT so that the point-motion hooks don't run. */
15362 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15365 /* If any of the character widths specified in the display table
15366 have changed, invalidate the width run cache. It's true that
15367 this may be a bit late to catch such changes, but the rest of
15368 redisplay goes (non-fatally) haywire when the display table is
15369 changed, so why should we worry about doing any better? */
15370 if (current_buffer
->width_run_cache
)
15372 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15374 if (! disptab_matches_widthtab
15375 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15377 invalidate_region_cache (current_buffer
,
15378 current_buffer
->width_run_cache
,
15380 recompute_width_table (current_buffer
, disptab
);
15384 /* If window-start is screwed up, choose a new one. */
15385 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15388 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15390 /* If someone specified a new starting point but did not insist,
15391 check whether it can be used. */
15392 if (w
->optional_new_start
15393 && CHARPOS (startp
) >= BEGV
15394 && CHARPOS (startp
) <= ZV
)
15396 w
->optional_new_start
= 0;
15397 start_display (&it
, w
, startp
);
15398 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15399 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15400 if (IT_CHARPOS (it
) == PT
)
15401 w
->force_start
= 1;
15402 /* IT may overshoot PT if text at PT is invisible. */
15403 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15404 w
->force_start
= 1;
15409 /* Handle case where place to start displaying has been specified,
15410 unless the specified location is outside the accessible range. */
15411 if (w
->force_start
|| w
->frozen_window_start_p
)
15413 /* We set this later on if we have to adjust point. */
15416 w
->force_start
= 0;
15418 w
->window_end_valid
= 0;
15420 /* Forget any recorded base line for line number display. */
15421 if (!buffer_unchanged_p
)
15422 w
->base_line_number
= 0;
15424 /* Redisplay the mode line. Select the buffer properly for that.
15425 Also, run the hook window-scroll-functions
15426 because we have scrolled. */
15427 /* Note, we do this after clearing force_start because
15428 if there's an error, it is better to forget about force_start
15429 than to get into an infinite loop calling the hook functions
15430 and having them get more errors. */
15431 if (!update_mode_line
15432 || ! NILP (Vwindow_scroll_functions
))
15434 update_mode_line
= 1;
15435 w
->update_mode_line
= 1;
15436 startp
= run_window_scroll_functions (window
, startp
);
15439 w
->last_modified
= 0;
15440 w
->last_overlay_modified
= 0;
15441 if (CHARPOS (startp
) < BEGV
)
15442 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15443 else if (CHARPOS (startp
) > ZV
)
15444 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15446 /* Redisplay, then check if cursor has been set during the
15447 redisplay. Give up if new fonts were loaded. */
15448 /* We used to issue a CHECK_MARGINS argument to try_window here,
15449 but this causes scrolling to fail when point begins inside
15450 the scroll margin (bug#148) -- cyd */
15451 if (!try_window (window
, startp
, 0))
15453 w
->force_start
= 1;
15454 clear_glyph_matrix (w
->desired_matrix
);
15455 goto need_larger_matrices
;
15458 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15460 /* If point does not appear, try to move point so it does
15461 appear. The desired matrix has been built above, so we
15462 can use it here. */
15463 new_vpos
= window_box_height (w
) / 2;
15466 if (!cursor_row_fully_visible_p (w
, 0, 0))
15468 /* Point does appear, but on a line partly visible at end of window.
15469 Move it back to a fully-visible line. */
15470 new_vpos
= window_box_height (w
);
15472 else if (w
->cursor
.vpos
>=0)
15474 /* Some people insist on not letting point enter the scroll
15475 margin, even though this part handles windows that didn't
15477 int margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15478 int pixel_margin
= margin
* FRAME_LINE_HEIGHT (f
);
15479 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
15481 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
15482 below, which finds the row to move point to, advances by
15483 the Y coordinate of the _next_ row, see the definition of
15484 MATRIX_ROW_BOTTOM_Y. */
15485 if (w
->cursor
.vpos
< margin
+ header_line
)
15487 = pixel_margin
+ (header_line
15488 ? CURRENT_HEADER_LINE_HEIGHT (w
)
15489 : 0) + FRAME_LINE_HEIGHT (f
);
15492 int window_height
= window_box_height (w
);
15495 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15496 if (w
->cursor
.y
>= window_height
- pixel_margin
)
15497 new_vpos
= window_height
- pixel_margin
;
15501 /* If we need to move point for either of the above reasons,
15502 now actually do it. */
15505 struct glyph_row
*row
;
15507 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15508 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15511 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15512 MATRIX_ROW_START_BYTEPOS (row
));
15514 if (w
!= XWINDOW (selected_window
))
15515 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15516 else if (current_buffer
== old
)
15517 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15519 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15521 /* If we are highlighting the region, then we just changed
15522 the region, so redisplay to show it. */
15523 if (0 <= markpos_of_region ())
15525 clear_glyph_matrix (w
->desired_matrix
);
15526 if (!try_window (window
, startp
, 0))
15527 goto need_larger_matrices
;
15532 debug_method_add (w
, "forced window start");
15537 /* Handle case where text has not changed, only point, and it has
15538 not moved off the frame, and we are not retrying after hscroll.
15539 (current_matrix_up_to_date_p is nonzero when retrying.) */
15540 if (current_matrix_up_to_date_p
15541 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15542 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15546 case CURSOR_MOVEMENT_SUCCESS
:
15547 used_current_matrix_p
= 1;
15550 case CURSOR_MOVEMENT_MUST_SCROLL
:
15551 goto try_to_scroll
;
15557 /* If current starting point was originally the beginning of a line
15558 but no longer is, find a new starting point. */
15559 else if (w
->start_at_line_beg
15560 && !(CHARPOS (startp
) <= BEGV
15561 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15564 debug_method_add (w
, "recenter 1");
15569 /* Try scrolling with try_window_id. Value is > 0 if update has
15570 been done, it is -1 if we know that the same window start will
15571 not work. It is 0 if unsuccessful for some other reason. */
15572 else if ((tem
= try_window_id (w
)) != 0)
15575 debug_method_add (w
, "try_window_id %d", tem
);
15578 if (fonts_changed_p
)
15579 goto need_larger_matrices
;
15583 /* Otherwise try_window_id has returned -1 which means that we
15584 don't want the alternative below this comment to execute. */
15586 else if (CHARPOS (startp
) >= BEGV
15587 && CHARPOS (startp
) <= ZV
15588 && PT
>= CHARPOS (startp
)
15589 && (CHARPOS (startp
) < ZV
15590 /* Avoid starting at end of buffer. */
15591 || CHARPOS (startp
) == BEGV
15592 || !window_outdated (w
)))
15594 int d1
, d2
, d3
, d4
, d5
, d6
;
15596 /* If first window line is a continuation line, and window start
15597 is inside the modified region, but the first change is before
15598 current window start, we must select a new window start.
15600 However, if this is the result of a down-mouse event (e.g. by
15601 extending the mouse-drag-overlay), we don't want to select a
15602 new window start, since that would change the position under
15603 the mouse, resulting in an unwanted mouse-movement rather
15604 than a simple mouse-click. */
15605 if (!w
->start_at_line_beg
15606 && NILP (do_mouse_tracking
)
15607 && CHARPOS (startp
) > BEGV
15608 && CHARPOS (startp
) > BEG
+ beg_unchanged
15609 && CHARPOS (startp
) <= Z
- end_unchanged
15610 /* Even if w->start_at_line_beg is nil, a new window may
15611 start at a line_beg, since that's how set_buffer_window
15612 sets it. So, we need to check the return value of
15613 compute_window_start_on_continuation_line. (See also
15615 && XMARKER (w
->start
)->buffer
== current_buffer
15616 && compute_window_start_on_continuation_line (w
)
15617 /* It doesn't make sense to force the window start like we
15618 do at label force_start if it is already known that point
15619 will not be visible in the resulting window, because
15620 doing so will move point from its correct position
15621 instead of scrolling the window to bring point into view.
15623 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15625 w
->force_start
= 1;
15626 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15631 debug_method_add (w
, "same window start");
15634 /* Try to redisplay starting at same place as before.
15635 If point has not moved off frame, accept the results. */
15636 if (!current_matrix_up_to_date_p
15637 /* Don't use try_window_reusing_current_matrix in this case
15638 because a window scroll function can have changed the
15640 || !NILP (Vwindow_scroll_functions
)
15641 || MINI_WINDOW_P (w
)
15642 || !(used_current_matrix_p
15643 = try_window_reusing_current_matrix (w
)))
15645 IF_DEBUG (debug_method_add (w
, "1"));
15646 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15647 /* -1 means we need to scroll.
15648 0 means we need new matrices, but fonts_changed_p
15649 is set in that case, so we will detect it below. */
15650 goto try_to_scroll
;
15653 if (fonts_changed_p
)
15654 goto need_larger_matrices
;
15656 if (w
->cursor
.vpos
>= 0)
15658 if (!just_this_one_p
15659 || current_buffer
->clip_changed
15660 || BEG_UNCHANGED
< CHARPOS (startp
))
15661 /* Forget any recorded base line for line number display. */
15662 w
->base_line_number
= 0;
15664 if (!cursor_row_fully_visible_p (w
, 1, 0))
15666 clear_glyph_matrix (w
->desired_matrix
);
15667 last_line_misfit
= 1;
15669 /* Drop through and scroll. */
15674 clear_glyph_matrix (w
->desired_matrix
);
15679 w
->last_modified
= 0;
15680 w
->last_overlay_modified
= 0;
15682 /* Redisplay the mode line. Select the buffer properly for that. */
15683 if (!update_mode_line
)
15685 update_mode_line
= 1;
15686 w
->update_mode_line
= 1;
15689 /* Try to scroll by specified few lines. */
15690 if ((scroll_conservatively
15691 || emacs_scroll_step
15692 || temp_scroll_step
15693 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15694 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15695 && CHARPOS (startp
) >= BEGV
15696 && CHARPOS (startp
) <= ZV
)
15698 /* The function returns -1 if new fonts were loaded, 1 if
15699 successful, 0 if not successful. */
15700 int ss
= try_scrolling (window
, just_this_one_p
,
15701 scroll_conservatively
,
15703 temp_scroll_step
, last_line_misfit
);
15706 case SCROLLING_SUCCESS
:
15709 case SCROLLING_NEED_LARGER_MATRICES
:
15710 goto need_larger_matrices
;
15712 case SCROLLING_FAILED
:
15720 /* Finally, just choose a place to start which positions point
15721 according to user preferences. */
15726 debug_method_add (w
, "recenter");
15729 /* Forget any previously recorded base line for line number display. */
15730 if (!buffer_unchanged_p
)
15731 w
->base_line_number
= 0;
15733 /* Determine the window start relative to point. */
15734 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15735 it
.current_y
= it
.last_visible_y
;
15736 if (centering_position
< 0)
15740 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15742 ptrdiff_t margin_pos
= CHARPOS (startp
);
15743 Lisp_Object aggressive
;
15746 /* If there is a scroll margin at the top of the window, find
15747 its character position. */
15749 /* Cannot call start_display if startp is not in the
15750 accessible region of the buffer. This can happen when we
15751 have just switched to a different buffer and/or changed
15752 its restriction. In that case, startp is initialized to
15753 the character position 1 (BEGV) because we did not yet
15754 have chance to display the buffer even once. */
15755 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15758 void *it1data
= NULL
;
15760 SAVE_IT (it1
, it
, it1data
);
15761 start_display (&it1
, w
, startp
);
15762 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15763 margin_pos
= IT_CHARPOS (it1
);
15764 RESTORE_IT (&it
, &it
, it1data
);
15766 scrolling_up
= PT
> margin_pos
;
15769 ? BVAR (current_buffer
, scroll_up_aggressively
)
15770 : BVAR (current_buffer
, scroll_down_aggressively
);
15772 if (!MINI_WINDOW_P (w
)
15773 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15777 /* Setting scroll-conservatively overrides
15778 scroll-*-aggressively. */
15779 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15781 double float_amount
= XFLOATINT (aggressive
);
15783 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15784 if (pt_offset
== 0 && float_amount
> 0)
15786 if (pt_offset
&& margin
> 0)
15789 /* Compute how much to move the window start backward from
15790 point so that point will be displayed where the user
15794 centering_position
= it
.last_visible_y
;
15796 centering_position
-= pt_offset
;
15797 centering_position
-=
15798 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15799 + WINDOW_HEADER_LINE_HEIGHT (w
);
15800 /* Don't let point enter the scroll margin near top of
15802 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15803 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15806 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15809 /* Set the window start half the height of the window backward
15811 centering_position
= window_box_height (w
) / 2;
15813 move_it_vertically_backward (&it
, centering_position
);
15815 eassert (IT_CHARPOS (it
) >= BEGV
);
15817 /* The function move_it_vertically_backward may move over more
15818 than the specified y-distance. If it->w is small, e.g. a
15819 mini-buffer window, we may end up in front of the window's
15820 display area. Start displaying at the start of the line
15821 containing PT in this case. */
15822 if (it
.current_y
<= 0)
15824 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15825 move_it_vertically_backward (&it
, 0);
15829 it
.current_x
= it
.hpos
= 0;
15831 /* Set the window start position here explicitly, to avoid an
15832 infinite loop in case the functions in window-scroll-functions
15834 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15836 /* Run scroll hooks. */
15837 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15839 /* Redisplay the window. */
15840 if (!current_matrix_up_to_date_p
15841 || windows_or_buffers_changed
15842 || cursor_type_changed
15843 /* Don't use try_window_reusing_current_matrix in this case
15844 because it can have changed the buffer. */
15845 || !NILP (Vwindow_scroll_functions
)
15846 || !just_this_one_p
15847 || MINI_WINDOW_P (w
)
15848 || !(used_current_matrix_p
15849 = try_window_reusing_current_matrix (w
)))
15850 try_window (window
, startp
, 0);
15852 /* If new fonts have been loaded (due to fontsets), give up. We
15853 have to start a new redisplay since we need to re-adjust glyph
15855 if (fonts_changed_p
)
15856 goto need_larger_matrices
;
15858 /* If cursor did not appear assume that the middle of the window is
15859 in the first line of the window. Do it again with the next line.
15860 (Imagine a window of height 100, displaying two lines of height
15861 60. Moving back 50 from it->last_visible_y will end in the first
15863 if (w
->cursor
.vpos
< 0)
15865 if (w
->window_end_valid
&& PT
>= Z
- XFASTINT (w
->window_end_pos
))
15867 clear_glyph_matrix (w
->desired_matrix
);
15868 move_it_by_lines (&it
, 1);
15869 try_window (window
, it
.current
.pos
, 0);
15871 else if (PT
< IT_CHARPOS (it
))
15873 clear_glyph_matrix (w
->desired_matrix
);
15874 move_it_by_lines (&it
, -1);
15875 try_window (window
, it
.current
.pos
, 0);
15879 /* Not much we can do about it. */
15883 /* Consider the following case: Window starts at BEGV, there is
15884 invisible, intangible text at BEGV, so that display starts at
15885 some point START > BEGV. It can happen that we are called with
15886 PT somewhere between BEGV and START. Try to handle that case. */
15887 if (w
->cursor
.vpos
< 0)
15889 struct glyph_row
*row
= w
->current_matrix
->rows
;
15890 if (row
->mode_line_p
)
15892 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15895 if (!cursor_row_fully_visible_p (w
, 0, 0))
15897 /* If vscroll is enabled, disable it and try again. */
15901 clear_glyph_matrix (w
->desired_matrix
);
15905 /* Users who set scroll-conservatively to a large number want
15906 point just above/below the scroll margin. If we ended up
15907 with point's row partially visible, move the window start to
15908 make that row fully visible and out of the margin. */
15909 if (scroll_conservatively
> SCROLL_LIMIT
)
15913 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15915 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
15917 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
15918 clear_glyph_matrix (w
->desired_matrix
);
15919 if (1 == try_window (window
, it
.current
.pos
,
15920 TRY_WINDOW_CHECK_MARGINS
))
15924 /* If centering point failed to make the whole line visible,
15925 put point at the top instead. That has to make the whole line
15926 visible, if it can be done. */
15927 if (centering_position
== 0)
15930 clear_glyph_matrix (w
->desired_matrix
);
15931 centering_position
= 0;
15937 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15938 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
15939 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
15941 /* Display the mode line, if we must. */
15942 if ((update_mode_line
15943 /* If window not full width, must redo its mode line
15944 if (a) the window to its side is being redone and
15945 (b) we do a frame-based redisplay. This is a consequence
15946 of how inverted lines are drawn in frame-based redisplay. */
15947 || (!just_this_one_p
15948 && !FRAME_WINDOW_P (f
)
15949 && !WINDOW_FULL_WIDTH_P (w
))
15950 /* Line number to display. */
15951 || w
->base_line_pos
> 0
15952 /* Column number is displayed and different from the one displayed. */
15953 || (w
->column_number_displayed
!= -1
15954 && (w
->column_number_displayed
!= current_column ())))
15955 /* This means that the window has a mode line. */
15956 && (WINDOW_WANTS_MODELINE_P (w
)
15957 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15959 display_mode_lines (w
);
15961 /* If mode line height has changed, arrange for a thorough
15962 immediate redisplay using the correct mode line height. */
15963 if (WINDOW_WANTS_MODELINE_P (w
)
15964 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15966 fonts_changed_p
= 1;
15967 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15968 = DESIRED_MODE_LINE_HEIGHT (w
);
15971 /* If header line height has changed, arrange for a thorough
15972 immediate redisplay using the correct header line height. */
15973 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15974 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15976 fonts_changed_p
= 1;
15977 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15978 = DESIRED_HEADER_LINE_HEIGHT (w
);
15981 if (fonts_changed_p
)
15982 goto need_larger_matrices
;
15985 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
15987 w
->base_line_pos
= 0;
15988 w
->base_line_number
= 0;
15993 /* When we reach a frame's selected window, redo the frame's menu bar. */
15994 if (update_mode_line
15995 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15997 int redisplay_menu_p
= 0;
15999 if (FRAME_WINDOW_P (f
))
16001 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16002 || defined (HAVE_NS) || defined (USE_GTK)
16003 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16005 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16009 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16011 if (redisplay_menu_p
)
16012 display_menu_bar (w
);
16014 #ifdef HAVE_WINDOW_SYSTEM
16015 if (FRAME_WINDOW_P (f
))
16017 #if defined (USE_GTK) || defined (HAVE_NS)
16018 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16019 redisplay_tool_bar (f
);
16021 if (WINDOWP (f
->tool_bar_window
)
16022 && (FRAME_TOOL_BAR_LINES (f
) > 0
16023 || !NILP (Vauto_resize_tool_bars
))
16024 && redisplay_tool_bar (f
))
16025 ignore_mouse_drag_p
= 1;
16031 #ifdef HAVE_WINDOW_SYSTEM
16032 if (FRAME_WINDOW_P (f
)
16033 && update_window_fringes (w
, (just_this_one_p
16034 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16035 || w
->pseudo_window_p
)))
16039 if (draw_window_fringes (w
, 1))
16040 x_draw_vertical_border (w
);
16044 #endif /* HAVE_WINDOW_SYSTEM */
16046 /* We go to this label, with fonts_changed_p set,
16047 if it is necessary to try again using larger glyph matrices.
16048 We have to redeem the scroll bar even in this case,
16049 because the loop in redisplay_internal expects that. */
16050 need_larger_matrices
:
16052 finish_scroll_bars
:
16054 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16056 /* Set the thumb's position and size. */
16057 set_vertical_scroll_bar (w
);
16059 /* Note that we actually used the scroll bar attached to this
16060 window, so it shouldn't be deleted at the end of redisplay. */
16061 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16062 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16065 /* Restore current_buffer and value of point in it. The window
16066 update may have changed the buffer, so first make sure `opoint'
16067 is still valid (Bug#6177). */
16068 if (CHARPOS (opoint
) < BEGV
)
16069 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16070 else if (CHARPOS (opoint
) > ZV
)
16071 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16073 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16075 set_buffer_internal_1 (old
);
16076 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16077 shorter. This can be caused by log truncation in *Messages*. */
16078 if (CHARPOS (lpoint
) <= ZV
)
16079 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16081 unbind_to (count
, Qnil
);
16085 /* Build the complete desired matrix of WINDOW with a window start
16086 buffer position POS.
16088 Value is 1 if successful. It is zero if fonts were loaded during
16089 redisplay which makes re-adjusting glyph matrices necessary, and -1
16090 if point would appear in the scroll margins.
16091 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16092 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16096 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16098 struct window
*w
= XWINDOW (window
);
16100 struct glyph_row
*last_text_row
= NULL
;
16101 struct frame
*f
= XFRAME (w
->frame
);
16103 /* Make POS the new window start. */
16104 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16106 /* Mark cursor position as unknown. No overlay arrow seen. */
16107 w
->cursor
.vpos
= -1;
16108 overlay_arrow_seen
= 0;
16110 /* Initialize iterator and info to start at POS. */
16111 start_display (&it
, w
, pos
);
16113 /* Display all lines of W. */
16114 while (it
.current_y
< it
.last_visible_y
)
16116 if (display_line (&it
))
16117 last_text_row
= it
.glyph_row
- 1;
16118 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16122 /* Don't let the cursor end in the scroll margins. */
16123 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16124 && !MINI_WINDOW_P (w
))
16126 int this_scroll_margin
;
16128 if (scroll_margin
> 0)
16130 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16131 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16134 this_scroll_margin
= 0;
16136 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16137 && w
->cursor
.y
< this_scroll_margin
16138 && CHARPOS (pos
) > BEGV
16139 && IT_CHARPOS (it
) < ZV
)
16140 /* rms: considering make_cursor_line_fully_visible_p here
16141 seems to give wrong results. We don't want to recenter
16142 when the last line is partly visible, we want to allow
16143 that case to be handled in the usual way. */
16144 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16146 w
->cursor
.vpos
= -1;
16147 clear_glyph_matrix (w
->desired_matrix
);
16152 /* If bottom moved off end of frame, change mode line percentage. */
16153 if (XFASTINT (w
->window_end_pos
) <= 0
16154 && Z
!= IT_CHARPOS (it
))
16155 w
->update_mode_line
= 1;
16157 /* Set window_end_pos to the offset of the last character displayed
16158 on the window from the end of current_buffer. Set
16159 window_end_vpos to its row number. */
16162 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16163 w
->window_end_bytepos
16164 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16165 wset_window_end_pos
16166 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16167 wset_window_end_vpos
16168 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
)));
16170 (MATRIX_ROW (w
->desired_matrix
,
16171 XFASTINT (w
->window_end_vpos
))->displays_text_p
);
16175 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16176 wset_window_end_pos (w
, make_number (Z
- ZV
));
16177 wset_window_end_vpos (w
, make_number (0));
16180 /* But that is not valid info until redisplay finishes. */
16181 w
->window_end_valid
= 0;
16187 /************************************************************************
16188 Window redisplay reusing current matrix when buffer has not changed
16189 ************************************************************************/
16191 /* Try redisplay of window W showing an unchanged buffer with a
16192 different window start than the last time it was displayed by
16193 reusing its current matrix. Value is non-zero if successful.
16194 W->start is the new window start. */
16197 try_window_reusing_current_matrix (struct window
*w
)
16199 struct frame
*f
= XFRAME (w
->frame
);
16200 struct glyph_row
*bottom_row
;
16203 struct text_pos start
, new_start
;
16204 int nrows_scrolled
, i
;
16205 struct glyph_row
*last_text_row
;
16206 struct glyph_row
*last_reused_text_row
;
16207 struct glyph_row
*start_row
;
16208 int start_vpos
, min_y
, max_y
;
16211 if (inhibit_try_window_reusing
)
16215 if (/* This function doesn't handle terminal frames. */
16216 !FRAME_WINDOW_P (f
)
16217 /* Don't try to reuse the display if windows have been split
16219 || windows_or_buffers_changed
16220 || cursor_type_changed
)
16223 /* Can't do this if region may have changed. */
16224 if (0 <= markpos_of_region ()
16225 || w
->region_showing
16226 || !NILP (Vshow_trailing_whitespace
))
16229 /* If top-line visibility has changed, give up. */
16230 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16231 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16234 /* Give up if old or new display is scrolled vertically. We could
16235 make this function handle this, but right now it doesn't. */
16236 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16237 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16240 /* The variable new_start now holds the new window start. The old
16241 start `start' can be determined from the current matrix. */
16242 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16243 start
= start_row
->minpos
;
16244 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16246 /* Clear the desired matrix for the display below. */
16247 clear_glyph_matrix (w
->desired_matrix
);
16249 if (CHARPOS (new_start
) <= CHARPOS (start
))
16251 /* Don't use this method if the display starts with an ellipsis
16252 displayed for invisible text. It's not easy to handle that case
16253 below, and it's certainly not worth the effort since this is
16254 not a frequent case. */
16255 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16258 IF_DEBUG (debug_method_add (w
, "twu1"));
16260 /* Display up to a row that can be reused. The variable
16261 last_text_row is set to the last row displayed that displays
16262 text. Note that it.vpos == 0 if or if not there is a
16263 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16264 start_display (&it
, w
, new_start
);
16265 w
->cursor
.vpos
= -1;
16266 last_text_row
= last_reused_text_row
= NULL
;
16268 while (it
.current_y
< it
.last_visible_y
16269 && !fonts_changed_p
)
16271 /* If we have reached into the characters in the START row,
16272 that means the line boundaries have changed. So we
16273 can't start copying with the row START. Maybe it will
16274 work to start copying with the following row. */
16275 while (IT_CHARPOS (it
) > CHARPOS (start
))
16277 /* Advance to the next row as the "start". */
16279 start
= start_row
->minpos
;
16280 /* If there are no more rows to try, or just one, give up. */
16281 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16282 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16283 || CHARPOS (start
) == ZV
)
16285 clear_glyph_matrix (w
->desired_matrix
);
16289 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16291 /* If we have reached alignment, we can copy the rest of the
16293 if (IT_CHARPOS (it
) == CHARPOS (start
)
16294 /* Don't accept "alignment" inside a display vector,
16295 since start_row could have started in the middle of
16296 that same display vector (thus their character
16297 positions match), and we have no way of telling if
16298 that is the case. */
16299 && it
.current
.dpvec_index
< 0)
16302 if (display_line (&it
))
16303 last_text_row
= it
.glyph_row
- 1;
16307 /* A value of current_y < last_visible_y means that we stopped
16308 at the previous window start, which in turn means that we
16309 have at least one reusable row. */
16310 if (it
.current_y
< it
.last_visible_y
)
16312 struct glyph_row
*row
;
16314 /* IT.vpos always starts from 0; it counts text lines. */
16315 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16317 /* Find PT if not already found in the lines displayed. */
16318 if (w
->cursor
.vpos
< 0)
16320 int dy
= it
.current_y
- start_row
->y
;
16322 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16323 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16325 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16326 dy
, nrows_scrolled
);
16329 clear_glyph_matrix (w
->desired_matrix
);
16334 /* Scroll the display. Do it before the current matrix is
16335 changed. The problem here is that update has not yet
16336 run, i.e. part of the current matrix is not up to date.
16337 scroll_run_hook will clear the cursor, and use the
16338 current matrix to get the height of the row the cursor is
16340 run
.current_y
= start_row
->y
;
16341 run
.desired_y
= it
.current_y
;
16342 run
.height
= it
.last_visible_y
- it
.current_y
;
16344 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16347 FRAME_RIF (f
)->update_window_begin_hook (w
);
16348 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16349 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16350 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16354 /* Shift current matrix down by nrows_scrolled lines. */
16355 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16356 rotate_matrix (w
->current_matrix
,
16358 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16361 /* Disable lines that must be updated. */
16362 for (i
= 0; i
< nrows_scrolled
; ++i
)
16363 (start_row
+ i
)->enabled_p
= 0;
16365 /* Re-compute Y positions. */
16366 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16367 max_y
= it
.last_visible_y
;
16368 for (row
= start_row
+ nrows_scrolled
;
16372 row
->y
= it
.current_y
;
16373 row
->visible_height
= row
->height
;
16375 if (row
->y
< min_y
)
16376 row
->visible_height
-= min_y
- row
->y
;
16377 if (row
->y
+ row
->height
> max_y
)
16378 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16379 if (row
->fringe_bitmap_periodic_p
)
16380 row
->redraw_fringe_bitmaps_p
= 1;
16382 it
.current_y
+= row
->height
;
16384 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16385 last_reused_text_row
= row
;
16386 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16390 /* Disable lines in the current matrix which are now
16391 below the window. */
16392 for (++row
; row
< bottom_row
; ++row
)
16393 row
->enabled_p
= row
->mode_line_p
= 0;
16396 /* Update window_end_pos etc.; last_reused_text_row is the last
16397 reused row from the current matrix containing text, if any.
16398 The value of last_text_row is the last displayed line
16399 containing text. */
16400 if (last_reused_text_row
)
16402 w
->window_end_bytepos
16403 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16404 wset_window_end_pos
16406 - MATRIX_ROW_END_CHARPOS (last_reused_text_row
)));
16407 wset_window_end_vpos
16408 (w
, make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16409 w
->current_matrix
)));
16411 else if (last_text_row
)
16413 w
->window_end_bytepos
16414 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16415 wset_window_end_pos
16416 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16417 wset_window_end_vpos
16418 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16419 w
->desired_matrix
)));
16423 /* This window must be completely empty. */
16424 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16425 wset_window_end_pos (w
, make_number (Z
- ZV
));
16426 wset_window_end_vpos (w
, make_number (0));
16428 w
->window_end_valid
= 0;
16430 /* Update hint: don't try scrolling again in update_window. */
16431 w
->desired_matrix
->no_scrolling_p
= 1;
16434 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16438 else if (CHARPOS (new_start
) > CHARPOS (start
))
16440 struct glyph_row
*pt_row
, *row
;
16441 struct glyph_row
*first_reusable_row
;
16442 struct glyph_row
*first_row_to_display
;
16444 int yb
= window_text_bottom_y (w
);
16446 /* Find the row starting at new_start, if there is one. Don't
16447 reuse a partially visible line at the end. */
16448 first_reusable_row
= start_row
;
16449 while (first_reusable_row
->enabled_p
16450 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16451 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16452 < CHARPOS (new_start
)))
16453 ++first_reusable_row
;
16455 /* Give up if there is no row to reuse. */
16456 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16457 || !first_reusable_row
->enabled_p
16458 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16459 != CHARPOS (new_start
)))
16462 /* We can reuse fully visible rows beginning with
16463 first_reusable_row to the end of the window. Set
16464 first_row_to_display to the first row that cannot be reused.
16465 Set pt_row to the row containing point, if there is any. */
16467 for (first_row_to_display
= first_reusable_row
;
16468 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16469 ++first_row_to_display
)
16471 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16472 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16473 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16474 && first_row_to_display
->ends_at_zv_p
16475 && pt_row
== NULL
)))
16476 pt_row
= first_row_to_display
;
16479 /* Start displaying at the start of first_row_to_display. */
16480 eassert (first_row_to_display
->y
< yb
);
16481 init_to_row_start (&it
, w
, first_row_to_display
);
16483 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16485 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16487 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16488 + WINDOW_HEADER_LINE_HEIGHT (w
));
16490 /* Display lines beginning with first_row_to_display in the
16491 desired matrix. Set last_text_row to the last row displayed
16492 that displays text. */
16493 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16494 if (pt_row
== NULL
)
16495 w
->cursor
.vpos
= -1;
16496 last_text_row
= NULL
;
16497 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16498 if (display_line (&it
))
16499 last_text_row
= it
.glyph_row
- 1;
16501 /* If point is in a reused row, adjust y and vpos of the cursor
16505 w
->cursor
.vpos
-= nrows_scrolled
;
16506 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16509 /* Give up if point isn't in a row displayed or reused. (This
16510 also handles the case where w->cursor.vpos < nrows_scrolled
16511 after the calls to display_line, which can happen with scroll
16512 margins. See bug#1295.) */
16513 if (w
->cursor
.vpos
< 0)
16515 clear_glyph_matrix (w
->desired_matrix
);
16519 /* Scroll the display. */
16520 run
.current_y
= first_reusable_row
->y
;
16521 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16522 run
.height
= it
.last_visible_y
- run
.current_y
;
16523 dy
= run
.current_y
- run
.desired_y
;
16528 FRAME_RIF (f
)->update_window_begin_hook (w
);
16529 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16530 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16531 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16535 /* Adjust Y positions of reused rows. */
16536 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16537 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16538 max_y
= it
.last_visible_y
;
16539 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16542 row
->visible_height
= row
->height
;
16543 if (row
->y
< min_y
)
16544 row
->visible_height
-= min_y
- row
->y
;
16545 if (row
->y
+ row
->height
> max_y
)
16546 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16547 if (row
->fringe_bitmap_periodic_p
)
16548 row
->redraw_fringe_bitmaps_p
= 1;
16551 /* Scroll the current matrix. */
16552 eassert (nrows_scrolled
> 0);
16553 rotate_matrix (w
->current_matrix
,
16555 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16558 /* Disable rows not reused. */
16559 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16560 row
->enabled_p
= 0;
16562 /* Point may have moved to a different line, so we cannot assume that
16563 the previous cursor position is valid; locate the correct row. */
16566 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16568 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16569 && !row
->ends_at_zv_p
;
16573 w
->cursor
.y
= row
->y
;
16575 if (row
< bottom_row
)
16577 /* Can't simply scan the row for point with
16578 bidi-reordered glyph rows. Let set_cursor_from_row
16579 figure out where to put the cursor, and if it fails,
16581 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16583 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
16586 clear_glyph_matrix (w
->desired_matrix
);
16592 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16593 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16596 && (!BUFFERP (glyph
->object
)
16597 || glyph
->charpos
< PT
);
16601 w
->cursor
.x
+= glyph
->pixel_width
;
16607 /* Adjust window end. A null value of last_text_row means that
16608 the window end is in reused rows which in turn means that
16609 only its vpos can have changed. */
16612 w
->window_end_bytepos
16613 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16614 wset_window_end_pos
16615 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16616 wset_window_end_vpos
16617 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16618 w
->desired_matrix
)));
16622 wset_window_end_vpos
16623 (w
, make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
));
16626 w
->window_end_valid
= 0;
16627 w
->desired_matrix
->no_scrolling_p
= 1;
16630 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16640 /************************************************************************
16641 Window redisplay reusing current matrix when buffer has changed
16642 ************************************************************************/
16644 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16645 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16646 ptrdiff_t *, ptrdiff_t *);
16647 static struct glyph_row
*
16648 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16649 struct glyph_row
*);
16652 /* Return the last row in MATRIX displaying text. If row START is
16653 non-null, start searching with that row. IT gives the dimensions
16654 of the display. Value is null if matrix is empty; otherwise it is
16655 a pointer to the row found. */
16657 static struct glyph_row
*
16658 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16659 struct glyph_row
*start
)
16661 struct glyph_row
*row
, *row_found
;
16663 /* Set row_found to the last row in IT->w's current matrix
16664 displaying text. The loop looks funny but think of partially
16667 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16668 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16670 eassert (row
->enabled_p
);
16672 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16681 /* Return the last row in the current matrix of W that is not affected
16682 by changes at the start of current_buffer that occurred since W's
16683 current matrix was built. Value is null if no such row exists.
16685 BEG_UNCHANGED us the number of characters unchanged at the start of
16686 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16687 first changed character in current_buffer. Characters at positions <
16688 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16689 when the current matrix was built. */
16691 static struct glyph_row
*
16692 find_last_unchanged_at_beg_row (struct window
*w
)
16694 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16695 struct glyph_row
*row
;
16696 struct glyph_row
*row_found
= NULL
;
16697 int yb
= window_text_bottom_y (w
);
16699 /* Find the last row displaying unchanged text. */
16700 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16701 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16702 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16705 if (/* If row ends before first_changed_pos, it is unchanged,
16706 except in some case. */
16707 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16708 /* When row ends in ZV and we write at ZV it is not
16710 && !row
->ends_at_zv_p
16711 /* When first_changed_pos is the end of a continued line,
16712 row is not unchanged because it may be no longer
16714 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16715 && (row
->continued_p
16716 || row
->exact_window_width_line_p
))
16717 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16718 needs to be recomputed, so don't consider this row as
16719 unchanged. This happens when the last line was
16720 bidi-reordered and was killed immediately before this
16721 redisplay cycle. In that case, ROW->end stores the
16722 buffer position of the first visual-order character of
16723 the killed text, which is now beyond ZV. */
16724 && CHARPOS (row
->end
.pos
) <= ZV
)
16727 /* Stop if last visible row. */
16728 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16736 /* Find the first glyph row in the current matrix of W that is not
16737 affected by changes at the end of current_buffer since the
16738 time W's current matrix was built.
16740 Return in *DELTA the number of chars by which buffer positions in
16741 unchanged text at the end of current_buffer must be adjusted.
16743 Return in *DELTA_BYTES the corresponding number of bytes.
16745 Value is null if no such row exists, i.e. all rows are affected by
16748 static struct glyph_row
*
16749 find_first_unchanged_at_end_row (struct window
*w
,
16750 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16752 struct glyph_row
*row
;
16753 struct glyph_row
*row_found
= NULL
;
16755 *delta
= *delta_bytes
= 0;
16757 /* Display must not have been paused, otherwise the current matrix
16758 is not up to date. */
16759 eassert (w
->window_end_valid
);
16761 /* A value of window_end_pos >= END_UNCHANGED means that the window
16762 end is in the range of changed text. If so, there is no
16763 unchanged row at the end of W's current matrix. */
16764 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16767 /* Set row to the last row in W's current matrix displaying text. */
16768 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16770 /* If matrix is entirely empty, no unchanged row exists. */
16771 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16773 /* The value of row is the last glyph row in the matrix having a
16774 meaningful buffer position in it. The end position of row
16775 corresponds to window_end_pos. This allows us to translate
16776 buffer positions in the current matrix to current buffer
16777 positions for characters not in changed text. */
16779 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16780 ptrdiff_t Z_BYTE_old
=
16781 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16782 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
16783 struct glyph_row
*first_text_row
16784 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16786 *delta
= Z
- Z_old
;
16787 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16789 /* Set last_unchanged_pos to the buffer position of the last
16790 character in the buffer that has not been changed. Z is the
16791 index + 1 of the last character in current_buffer, i.e. by
16792 subtracting END_UNCHANGED we get the index of the last
16793 unchanged character, and we have to add BEG to get its buffer
16795 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16796 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16798 /* Search backward from ROW for a row displaying a line that
16799 starts at a minimum position >= last_unchanged_pos_old. */
16800 for (; row
> first_text_row
; --row
)
16802 /* This used to abort, but it can happen.
16803 It is ok to just stop the search instead here. KFS. */
16804 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16807 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16812 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16818 /* Make sure that glyph rows in the current matrix of window W
16819 reference the same glyph memory as corresponding rows in the
16820 frame's frame matrix. This function is called after scrolling W's
16821 current matrix on a terminal frame in try_window_id and
16822 try_window_reusing_current_matrix. */
16825 sync_frame_with_window_matrix_rows (struct window
*w
)
16827 struct frame
*f
= XFRAME (w
->frame
);
16828 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16830 /* Preconditions: W must be a leaf window and full-width. Its frame
16831 must have a frame matrix. */
16832 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16833 eassert (WINDOW_FULL_WIDTH_P (w
));
16834 eassert (!FRAME_WINDOW_P (f
));
16836 /* If W is a full-width window, glyph pointers in W's current matrix
16837 have, by definition, to be the same as glyph pointers in the
16838 corresponding frame matrix. Note that frame matrices have no
16839 marginal areas (see build_frame_matrix). */
16840 window_row
= w
->current_matrix
->rows
;
16841 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16842 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16843 while (window_row
< window_row_end
)
16845 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16846 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16848 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16849 frame_row
->glyphs
[TEXT_AREA
] = start
;
16850 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16851 frame_row
->glyphs
[LAST_AREA
] = end
;
16853 /* Disable frame rows whose corresponding window rows have
16854 been disabled in try_window_id. */
16855 if (!window_row
->enabled_p
)
16856 frame_row
->enabled_p
= 0;
16858 ++window_row
, ++frame_row
;
16863 /* Find the glyph row in window W containing CHARPOS. Consider all
16864 rows between START and END (not inclusive). END null means search
16865 all rows to the end of the display area of W. Value is the row
16866 containing CHARPOS or null. */
16869 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
16870 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16872 struct glyph_row
*row
= start
;
16873 struct glyph_row
*best_row
= NULL
;
16874 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16877 /* If we happen to start on a header-line, skip that. */
16878 if (row
->mode_line_p
)
16881 if ((end
&& row
>= end
) || !row
->enabled_p
)
16884 last_y
= window_text_bottom_y (w
) - dy
;
16888 /* Give up if we have gone too far. */
16889 if (end
&& row
>= end
)
16891 /* This formerly returned if they were equal.
16892 I think that both quantities are of a "last plus one" type;
16893 if so, when they are equal, the row is within the screen. -- rms. */
16894 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16897 /* If it is in this row, return this row. */
16898 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16899 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16900 /* The end position of a row equals the start
16901 position of the next row. If CHARPOS is there, we
16902 would rather display it in the next line, except
16903 when this line ends in ZV. */
16904 && !row
->ends_at_zv_p
16905 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16906 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16910 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16911 || (!best_row
&& !row
->continued_p
))
16913 /* In bidi-reordered rows, there could be several rows
16914 occluding point, all of them belonging to the same
16915 continued line. We need to find the row which fits
16916 CHARPOS the best. */
16917 for (g
= row
->glyphs
[TEXT_AREA
];
16918 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16921 if (!STRINGP (g
->object
))
16923 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16925 mindif
= eabs (g
->charpos
- charpos
);
16927 /* Exact match always wins. */
16934 else if (best_row
&& !row
->continued_p
)
16941 /* Try to redisplay window W by reusing its existing display. W's
16942 current matrix must be up to date when this function is called,
16943 i.e. window_end_valid must be nonzero.
16947 1 if display has been updated
16948 0 if otherwise unsuccessful
16949 -1 if redisplay with same window start is known not to succeed
16951 The following steps are performed:
16953 1. Find the last row in the current matrix of W that is not
16954 affected by changes at the start of current_buffer. If no such row
16957 2. Find the first row in W's current matrix that is not affected by
16958 changes at the end of current_buffer. Maybe there is no such row.
16960 3. Display lines beginning with the row + 1 found in step 1 to the
16961 row found in step 2 or, if step 2 didn't find a row, to the end of
16964 4. If cursor is not known to appear on the window, give up.
16966 5. If display stopped at the row found in step 2, scroll the
16967 display and current matrix as needed.
16969 6. Maybe display some lines at the end of W, if we must. This can
16970 happen under various circumstances, like a partially visible line
16971 becoming fully visible, or because newly displayed lines are displayed
16972 in smaller font sizes.
16974 7. Update W's window end information. */
16977 try_window_id (struct window
*w
)
16979 struct frame
*f
= XFRAME (w
->frame
);
16980 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16981 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16982 struct glyph_row
*last_unchanged_at_beg_row
;
16983 struct glyph_row
*first_unchanged_at_end_row
;
16984 struct glyph_row
*row
;
16985 struct glyph_row
*bottom_row
;
16988 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
16990 struct text_pos start_pos
;
16992 int first_unchanged_at_end_vpos
= 0;
16993 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16994 struct text_pos start
;
16995 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
16998 if (inhibit_try_window_id
)
17002 /* This is handy for debugging. */
17004 #define GIVE_UP(X) \
17006 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17010 #define GIVE_UP(X) return 0
17013 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17015 /* Don't use this for mini-windows because these can show
17016 messages and mini-buffers, and we don't handle that here. */
17017 if (MINI_WINDOW_P (w
))
17020 /* This flag is used to prevent redisplay optimizations. */
17021 if (windows_or_buffers_changed
|| cursor_type_changed
)
17024 /* Verify that narrowing has not changed.
17025 Also verify that we were not told to prevent redisplay optimizations.
17026 It would be nice to further
17027 reduce the number of cases where this prevents try_window_id. */
17028 if (current_buffer
->clip_changed
17029 || current_buffer
->prevent_redisplay_optimizations_p
)
17032 /* Window must either use window-based redisplay or be full width. */
17033 if (!FRAME_WINDOW_P (f
)
17034 && (!FRAME_LINE_INS_DEL_OK (f
)
17035 || !WINDOW_FULL_WIDTH_P (w
)))
17038 /* Give up if point is known NOT to appear in W. */
17039 if (PT
< CHARPOS (start
))
17042 /* Another way to prevent redisplay optimizations. */
17043 if (w
->last_modified
== 0)
17046 /* Verify that window is not hscrolled. */
17047 if (w
->hscroll
!= 0)
17050 /* Verify that display wasn't paused. */
17051 if (!w
->window_end_valid
)
17054 /* Can't use this if highlighting a region because a cursor movement
17055 will do more than just set the cursor. */
17056 if (0 <= markpos_of_region ())
17059 /* Likewise if highlighting trailing whitespace. */
17060 if (!NILP (Vshow_trailing_whitespace
))
17063 /* Likewise if showing a region. */
17064 if (w
->region_showing
)
17067 /* Can't use this if overlay arrow position and/or string have
17069 if (overlay_arrows_changed_p ())
17072 /* When word-wrap is on, adding a space to the first word of a
17073 wrapped line can change the wrap position, altering the line
17074 above it. It might be worthwhile to handle this more
17075 intelligently, but for now just redisplay from scratch. */
17076 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
17079 /* Under bidi reordering, adding or deleting a character in the
17080 beginning of a paragraph, before the first strong directional
17081 character, can change the base direction of the paragraph (unless
17082 the buffer specifies a fixed paragraph direction), which will
17083 require to redisplay the whole paragraph. It might be worthwhile
17084 to find the paragraph limits and widen the range of redisplayed
17085 lines to that, but for now just give up this optimization and
17086 redisplay from scratch. */
17087 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17088 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
17091 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17092 only if buffer has really changed. The reason is that the gap is
17093 initially at Z for freshly visited files. The code below would
17094 set end_unchanged to 0 in that case. */
17095 if (MODIFF
> SAVE_MODIFF
17096 /* This seems to happen sometimes after saving a buffer. */
17097 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17099 if (GPT
- BEG
< BEG_UNCHANGED
)
17100 BEG_UNCHANGED
= GPT
- BEG
;
17101 if (Z
- GPT
< END_UNCHANGED
)
17102 END_UNCHANGED
= Z
- GPT
;
17105 /* The position of the first and last character that has been changed. */
17106 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17107 last_changed_charpos
= Z
- END_UNCHANGED
;
17109 /* If window starts after a line end, and the last change is in
17110 front of that newline, then changes don't affect the display.
17111 This case happens with stealth-fontification. Note that although
17112 the display is unchanged, glyph positions in the matrix have to
17113 be adjusted, of course. */
17114 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17115 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17116 && ((last_changed_charpos
< CHARPOS (start
)
17117 && CHARPOS (start
) == BEGV
)
17118 || (last_changed_charpos
< CHARPOS (start
) - 1
17119 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17121 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17122 struct glyph_row
*r0
;
17124 /* Compute how many chars/bytes have been added to or removed
17125 from the buffer. */
17126 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17127 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17128 Z_delta
= Z
- Z_old
;
17129 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17131 /* Give up if PT is not in the window. Note that it already has
17132 been checked at the start of try_window_id that PT is not in
17133 front of the window start. */
17134 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17137 /* If window start is unchanged, we can reuse the whole matrix
17138 as is, after adjusting glyph positions. No need to compute
17139 the window end again, since its offset from Z hasn't changed. */
17140 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17141 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17142 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17143 /* PT must not be in a partially visible line. */
17144 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17145 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17147 /* Adjust positions in the glyph matrix. */
17148 if (Z_delta
|| Z_delta_bytes
)
17150 struct glyph_row
*r1
17151 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17152 increment_matrix_positions (w
->current_matrix
,
17153 MATRIX_ROW_VPOS (r0
, current_matrix
),
17154 MATRIX_ROW_VPOS (r1
, current_matrix
),
17155 Z_delta
, Z_delta_bytes
);
17158 /* Set the cursor. */
17159 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17161 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17168 /* Handle the case that changes are all below what is displayed in
17169 the window, and that PT is in the window. This shortcut cannot
17170 be taken if ZV is visible in the window, and text has been added
17171 there that is visible in the window. */
17172 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17173 /* ZV is not visible in the window, or there are no
17174 changes at ZV, actually. */
17175 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17176 || first_changed_charpos
== last_changed_charpos
))
17178 struct glyph_row
*r0
;
17180 /* Give up if PT is not in the window. Note that it already has
17181 been checked at the start of try_window_id that PT is not in
17182 front of the window start. */
17183 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17186 /* If window start is unchanged, we can reuse the whole matrix
17187 as is, without changing glyph positions since no text has
17188 been added/removed in front of the window end. */
17189 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17190 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17191 /* PT must not be in a partially visible line. */
17192 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17193 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17195 /* We have to compute the window end anew since text
17196 could have been added/removed after it. */
17197 wset_window_end_pos
17198 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17199 w
->window_end_bytepos
17200 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17202 /* Set the cursor. */
17203 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17205 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17212 /* Give up if window start is in the changed area.
17214 The condition used to read
17216 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17218 but why that was tested escapes me at the moment. */
17219 if (CHARPOS (start
) >= first_changed_charpos
17220 && CHARPOS (start
) <= last_changed_charpos
)
17223 /* Check that window start agrees with the start of the first glyph
17224 row in its current matrix. Check this after we know the window
17225 start is not in changed text, otherwise positions would not be
17227 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17228 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17231 /* Give up if the window ends in strings. Overlay strings
17232 at the end are difficult to handle, so don't try. */
17233 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17234 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17237 /* Compute the position at which we have to start displaying new
17238 lines. Some of the lines at the top of the window might be
17239 reusable because they are not displaying changed text. Find the
17240 last row in W's current matrix not affected by changes at the
17241 start of current_buffer. Value is null if changes start in the
17242 first line of window. */
17243 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17244 if (last_unchanged_at_beg_row
)
17246 /* Avoid starting to display in the middle of a character, a TAB
17247 for instance. This is easier than to set up the iterator
17248 exactly, and it's not a frequent case, so the additional
17249 effort wouldn't really pay off. */
17250 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17251 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17252 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17253 --last_unchanged_at_beg_row
;
17255 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17258 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17260 start_pos
= it
.current
.pos
;
17262 /* Start displaying new lines in the desired matrix at the same
17263 vpos we would use in the current matrix, i.e. below
17264 last_unchanged_at_beg_row. */
17265 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17267 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17268 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17270 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17274 /* There are no reusable lines at the start of the window.
17275 Start displaying in the first text line. */
17276 start_display (&it
, w
, start
);
17277 it
.vpos
= it
.first_vpos
;
17278 start_pos
= it
.current
.pos
;
17281 /* Find the first row that is not affected by changes at the end of
17282 the buffer. Value will be null if there is no unchanged row, in
17283 which case we must redisplay to the end of the window. delta
17284 will be set to the value by which buffer positions beginning with
17285 first_unchanged_at_end_row have to be adjusted due to text
17287 first_unchanged_at_end_row
17288 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17289 IF_DEBUG (debug_delta
= delta
);
17290 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17292 /* Set stop_pos to the buffer position up to which we will have to
17293 display new lines. If first_unchanged_at_end_row != NULL, this
17294 is the buffer position of the start of the line displayed in that
17295 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17296 that we don't stop at a buffer position. */
17298 if (first_unchanged_at_end_row
)
17300 eassert (last_unchanged_at_beg_row
== NULL
17301 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17303 /* If this is a continuation line, move forward to the next one
17304 that isn't. Changes in lines above affect this line.
17305 Caution: this may move first_unchanged_at_end_row to a row
17306 not displaying text. */
17307 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17308 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17309 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17310 < it
.last_visible_y
))
17311 ++first_unchanged_at_end_row
;
17313 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17314 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17315 >= it
.last_visible_y
))
17316 first_unchanged_at_end_row
= NULL
;
17319 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17321 first_unchanged_at_end_vpos
17322 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17323 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17326 else if (last_unchanged_at_beg_row
== NULL
)
17332 /* Either there is no unchanged row at the end, or the one we have
17333 now displays text. This is a necessary condition for the window
17334 end pos calculation at the end of this function. */
17335 eassert (first_unchanged_at_end_row
== NULL
17336 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17338 debug_last_unchanged_at_beg_vpos
17339 = (last_unchanged_at_beg_row
17340 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17342 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17344 #endif /* GLYPH_DEBUG */
17347 /* Display new lines. Set last_text_row to the last new line
17348 displayed which has text on it, i.e. might end up as being the
17349 line where the window_end_vpos is. */
17350 w
->cursor
.vpos
= -1;
17351 last_text_row
= NULL
;
17352 overlay_arrow_seen
= 0;
17353 while (it
.current_y
< it
.last_visible_y
17354 && !fonts_changed_p
17355 && (first_unchanged_at_end_row
== NULL
17356 || IT_CHARPOS (it
) < stop_pos
))
17358 if (display_line (&it
))
17359 last_text_row
= it
.glyph_row
- 1;
17362 if (fonts_changed_p
)
17366 /* Compute differences in buffer positions, y-positions etc. for
17367 lines reused at the bottom of the window. Compute what we can
17369 if (first_unchanged_at_end_row
17370 /* No lines reused because we displayed everything up to the
17371 bottom of the window. */
17372 && it
.current_y
< it
.last_visible_y
)
17375 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17377 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17378 run
.current_y
= first_unchanged_at_end_row
->y
;
17379 run
.desired_y
= run
.current_y
+ dy
;
17380 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17384 delta
= delta_bytes
= dvpos
= dy
17385 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17386 first_unchanged_at_end_row
= NULL
;
17388 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17391 /* Find the cursor if not already found. We have to decide whether
17392 PT will appear on this window (it sometimes doesn't, but this is
17393 not a very frequent case.) This decision has to be made before
17394 the current matrix is altered. A value of cursor.vpos < 0 means
17395 that PT is either in one of the lines beginning at
17396 first_unchanged_at_end_row or below the window. Don't care for
17397 lines that might be displayed later at the window end; as
17398 mentioned, this is not a frequent case. */
17399 if (w
->cursor
.vpos
< 0)
17401 /* Cursor in unchanged rows at the top? */
17402 if (PT
< CHARPOS (start_pos
)
17403 && last_unchanged_at_beg_row
)
17405 row
= row_containing_pos (w
, PT
,
17406 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17407 last_unchanged_at_beg_row
+ 1, 0);
17409 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17412 /* Start from first_unchanged_at_end_row looking for PT. */
17413 else if (first_unchanged_at_end_row
)
17415 row
= row_containing_pos (w
, PT
- delta
,
17416 first_unchanged_at_end_row
, NULL
, 0);
17418 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17419 delta_bytes
, dy
, dvpos
);
17422 /* Give up if cursor was not found. */
17423 if (w
->cursor
.vpos
< 0)
17425 clear_glyph_matrix (w
->desired_matrix
);
17430 /* Don't let the cursor end in the scroll margins. */
17432 int this_scroll_margin
, cursor_height
;
17434 this_scroll_margin
=
17435 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17436 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17437 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17439 if ((w
->cursor
.y
< this_scroll_margin
17440 && CHARPOS (start
) > BEGV
)
17441 /* Old redisplay didn't take scroll margin into account at the bottom,
17442 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17443 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17444 ? cursor_height
+ this_scroll_margin
17445 : 1)) > it
.last_visible_y
)
17447 w
->cursor
.vpos
= -1;
17448 clear_glyph_matrix (w
->desired_matrix
);
17453 /* Scroll the display. Do it before changing the current matrix so
17454 that xterm.c doesn't get confused about where the cursor glyph is
17456 if (dy
&& run
.height
)
17460 if (FRAME_WINDOW_P (f
))
17462 FRAME_RIF (f
)->update_window_begin_hook (w
);
17463 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17464 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17465 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17469 /* Terminal frame. In this case, dvpos gives the number of
17470 lines to scroll by; dvpos < 0 means scroll up. */
17472 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17473 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17474 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17475 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17476 + window_internal_height (w
));
17478 #if defined (HAVE_GPM) || defined (MSDOS)
17479 x_clear_window_mouse_face (w
);
17481 /* Perform the operation on the screen. */
17484 /* Scroll last_unchanged_at_beg_row to the end of the
17485 window down dvpos lines. */
17486 set_terminal_window (f
, end
);
17488 /* On dumb terminals delete dvpos lines at the end
17489 before inserting dvpos empty lines. */
17490 if (!FRAME_SCROLL_REGION_OK (f
))
17491 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17493 /* Insert dvpos empty lines in front of
17494 last_unchanged_at_beg_row. */
17495 ins_del_lines (f
, from
, dvpos
);
17497 else if (dvpos
< 0)
17499 /* Scroll up last_unchanged_at_beg_vpos to the end of
17500 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17501 set_terminal_window (f
, end
);
17503 /* Delete dvpos lines in front of
17504 last_unchanged_at_beg_vpos. ins_del_lines will set
17505 the cursor to the given vpos and emit |dvpos| delete
17507 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17509 /* On a dumb terminal insert dvpos empty lines at the
17511 if (!FRAME_SCROLL_REGION_OK (f
))
17512 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17515 set_terminal_window (f
, 0);
17521 /* Shift reused rows of the current matrix to the right position.
17522 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17524 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17525 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17528 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17529 bottom_vpos
, dvpos
);
17530 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17533 else if (dvpos
> 0)
17535 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17536 bottom_vpos
, dvpos
);
17537 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17538 first_unchanged_at_end_vpos
+ dvpos
);
17541 /* For frame-based redisplay, make sure that current frame and window
17542 matrix are in sync with respect to glyph memory. */
17543 if (!FRAME_WINDOW_P (f
))
17544 sync_frame_with_window_matrix_rows (w
);
17546 /* Adjust buffer positions in reused rows. */
17547 if (delta
|| delta_bytes
)
17548 increment_matrix_positions (current_matrix
,
17549 first_unchanged_at_end_vpos
+ dvpos
,
17550 bottom_vpos
, delta
, delta_bytes
);
17552 /* Adjust Y positions. */
17554 shift_glyph_matrix (w
, current_matrix
,
17555 first_unchanged_at_end_vpos
+ dvpos
,
17558 if (first_unchanged_at_end_row
)
17560 first_unchanged_at_end_row
+= dvpos
;
17561 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17562 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17563 first_unchanged_at_end_row
= NULL
;
17566 /* If scrolling up, there may be some lines to display at the end of
17568 last_text_row_at_end
= NULL
;
17571 /* Scrolling up can leave for example a partially visible line
17572 at the end of the window to be redisplayed. */
17573 /* Set last_row to the glyph row in the current matrix where the
17574 window end line is found. It has been moved up or down in
17575 the matrix by dvpos. */
17576 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17577 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17579 /* If last_row is the window end line, it should display text. */
17580 eassert (last_row
->displays_text_p
);
17582 /* If window end line was partially visible before, begin
17583 displaying at that line. Otherwise begin displaying with the
17584 line following it. */
17585 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17587 init_to_row_start (&it
, w
, last_row
);
17588 it
.vpos
= last_vpos
;
17589 it
.current_y
= last_row
->y
;
17593 init_to_row_end (&it
, w
, last_row
);
17594 it
.vpos
= 1 + last_vpos
;
17595 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17599 /* We may start in a continuation line. If so, we have to
17600 get the right continuation_lines_width and current_x. */
17601 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17602 it
.hpos
= it
.current_x
= 0;
17604 /* Display the rest of the lines at the window end. */
17605 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17606 while (it
.current_y
< it
.last_visible_y
17607 && !fonts_changed_p
)
17609 /* Is it always sure that the display agrees with lines in
17610 the current matrix? I don't think so, so we mark rows
17611 displayed invalid in the current matrix by setting their
17612 enabled_p flag to zero. */
17613 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17614 if (display_line (&it
))
17615 last_text_row_at_end
= it
.glyph_row
- 1;
17619 /* Update window_end_pos and window_end_vpos. */
17620 if (first_unchanged_at_end_row
17621 && !last_text_row_at_end
)
17623 /* Window end line if one of the preserved rows from the current
17624 matrix. Set row to the last row displaying text in current
17625 matrix starting at first_unchanged_at_end_row, after
17627 eassert (first_unchanged_at_end_row
->displays_text_p
);
17628 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17629 first_unchanged_at_end_row
);
17630 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17632 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17633 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17634 wset_window_end_vpos
17635 (w
, make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
)));
17636 eassert (w
->window_end_bytepos
>= 0);
17637 IF_DEBUG (debug_method_add (w
, "A"));
17639 else if (last_text_row_at_end
)
17641 wset_window_end_pos
17642 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
)));
17643 w
->window_end_bytepos
17644 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17645 wset_window_end_vpos
17646 (w
, make_number (MATRIX_ROW_VPOS (last_text_row_at_end
,
17648 eassert (w
->window_end_bytepos
>= 0);
17649 IF_DEBUG (debug_method_add (w
, "B"));
17651 else if (last_text_row
)
17653 /* We have displayed either to the end of the window or at the
17654 end of the window, i.e. the last row with text is to be found
17655 in the desired matrix. */
17656 wset_window_end_pos
17657 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
17658 w
->window_end_bytepos
17659 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17660 wset_window_end_vpos
17661 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
)));
17662 eassert (w
->window_end_bytepos
>= 0);
17664 else if (first_unchanged_at_end_row
== NULL
17665 && last_text_row
== NULL
17666 && last_text_row_at_end
== NULL
)
17668 /* Displayed to end of window, but no line containing text was
17669 displayed. Lines were deleted at the end of the window. */
17670 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17671 int vpos
= XFASTINT (w
->window_end_vpos
);
17672 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17673 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17676 row
== NULL
&& vpos
>= first_vpos
;
17677 --vpos
, --current_row
, --desired_row
)
17679 if (desired_row
->enabled_p
)
17681 if (desired_row
->displays_text_p
)
17684 else if (current_row
->displays_text_p
)
17688 eassert (row
!= NULL
);
17689 wset_window_end_vpos (w
, make_number (vpos
+ 1));
17690 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17691 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17692 eassert (w
->window_end_bytepos
>= 0);
17693 IF_DEBUG (debug_method_add (w
, "C"));
17698 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17699 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17701 /* Record that display has not been completed. */
17702 w
->window_end_valid
= 0;
17703 w
->desired_matrix
->no_scrolling_p
= 1;
17711 /***********************************************************************
17712 More debugging support
17713 ***********************************************************************/
17717 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17718 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17719 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17722 /* Dump the contents of glyph matrix MATRIX on stderr.
17724 GLYPHS 0 means don't show glyph contents.
17725 GLYPHS 1 means show glyphs in short form
17726 GLYPHS > 1 means show glyphs in long form. */
17729 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17732 for (i
= 0; i
< matrix
->nrows
; ++i
)
17733 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17737 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17738 the glyph row and area where the glyph comes from. */
17741 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17743 if (glyph
->type
== CHAR_GLYPH
17744 || glyph
->type
== GLYPHLESS_GLYPH
)
17747 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
17748 glyph
- row
->glyphs
[TEXT_AREA
],
17749 (glyph
->type
== CHAR_GLYPH
17753 (BUFFERP (glyph
->object
)
17755 : (STRINGP (glyph
->object
)
17757 : (INTEGERP (glyph
->object
)
17760 glyph
->pixel_width
,
17762 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17766 glyph
->left_box_line_p
,
17767 glyph
->right_box_line_p
);
17769 else if (glyph
->type
== STRETCH_GLYPH
)
17772 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
17773 glyph
- row
->glyphs
[TEXT_AREA
],
17776 (BUFFERP (glyph
->object
)
17778 : (STRINGP (glyph
->object
)
17780 : (INTEGERP (glyph
->object
)
17783 glyph
->pixel_width
,
17787 glyph
->left_box_line_p
,
17788 glyph
->right_box_line_p
);
17790 else if (glyph
->type
== IMAGE_GLYPH
)
17793 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
17794 glyph
- row
->glyphs
[TEXT_AREA
],
17797 (BUFFERP (glyph
->object
)
17799 : (STRINGP (glyph
->object
)
17801 : (INTEGERP (glyph
->object
)
17804 glyph
->pixel_width
,
17808 glyph
->left_box_line_p
,
17809 glyph
->right_box_line_p
);
17811 else if (glyph
->type
== COMPOSITE_GLYPH
)
17814 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
17815 glyph
- row
->glyphs
[TEXT_AREA
],
17818 (BUFFERP (glyph
->object
)
17820 : (STRINGP (glyph
->object
)
17822 : (INTEGERP (glyph
->object
)
17825 glyph
->pixel_width
,
17827 if (glyph
->u
.cmp
.automatic
)
17830 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17831 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17833 glyph
->left_box_line_p
,
17834 glyph
->right_box_line_p
);
17839 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17840 GLYPHS 0 means don't show glyph contents.
17841 GLYPHS 1 means show glyphs in short form
17842 GLYPHS > 1 means show glyphs in long form. */
17845 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17849 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17850 fprintf (stderr
, "==============================================================================\n");
17852 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17853 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17855 MATRIX_ROW_START_CHARPOS (row
),
17856 MATRIX_ROW_END_CHARPOS (row
),
17857 row
->used
[TEXT_AREA
],
17858 row
->contains_overlapping_glyphs_p
,
17860 row
->truncated_on_left_p
,
17861 row
->truncated_on_right_p
,
17863 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17864 row
->displays_text_p
,
17867 row
->ends_in_middle_of_char_p
,
17868 row
->starts_in_middle_of_char_p
,
17874 row
->visible_height
,
17877 /* The next 3 lines should align to "Start" in the header. */
17878 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
17879 row
->end
.overlay_string_index
,
17880 row
->continuation_lines_width
);
17881 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
17882 CHARPOS (row
->start
.string_pos
),
17883 CHARPOS (row
->end
.string_pos
));
17884 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
17885 row
->end
.dpvec_index
);
17892 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17894 struct glyph
*glyph
= row
->glyphs
[area
];
17895 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17897 /* Glyph for a line end in text. */
17898 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17901 if (glyph
< glyph_end
)
17902 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
17904 for (; glyph
< glyph_end
; ++glyph
)
17905 dump_glyph (row
, glyph
, area
);
17908 else if (glyphs
== 1)
17912 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17914 char *s
= alloca (row
->used
[area
] + 4);
17917 for (i
= 0; i
< row
->used
[area
]; ++i
)
17919 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17920 if (i
== row
->used
[area
] - 1
17921 && area
== TEXT_AREA
17922 && INTEGERP (glyph
->object
)
17923 && glyph
->type
== CHAR_GLYPH
17924 && glyph
->u
.ch
== ' ')
17926 strcpy (&s
[i
], "[\\n]");
17929 else if (glyph
->type
== CHAR_GLYPH
17930 && glyph
->u
.ch
< 0x80
17931 && glyph
->u
.ch
>= ' ')
17932 s
[i
] = glyph
->u
.ch
;
17938 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17944 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17945 Sdump_glyph_matrix
, 0, 1, "p",
17946 doc
: /* Dump the current matrix of the selected window to stderr.
17947 Shows contents of glyph row structures. With non-nil
17948 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17949 glyphs in short form, otherwise show glyphs in long form. */)
17950 (Lisp_Object glyphs
)
17952 struct window
*w
= XWINDOW (selected_window
);
17953 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17955 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17956 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17957 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17958 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17959 fprintf (stderr
, "=============================================\n");
17960 dump_glyph_matrix (w
->current_matrix
,
17961 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
17966 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17967 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17970 struct frame
*f
= XFRAME (selected_frame
);
17971 dump_glyph_matrix (f
->current_matrix
, 1);
17976 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17977 doc
: /* Dump glyph row ROW to stderr.
17978 GLYPH 0 means don't dump glyphs.
17979 GLYPH 1 means dump glyphs in short form.
17980 GLYPH > 1 or omitted means dump glyphs in long form. */)
17981 (Lisp_Object row
, Lisp_Object glyphs
)
17983 struct glyph_matrix
*matrix
;
17986 CHECK_NUMBER (row
);
17987 matrix
= XWINDOW (selected_window
)->current_matrix
;
17989 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17990 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17992 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
17997 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17998 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17999 GLYPH 0 means don't dump glyphs.
18000 GLYPH 1 means dump glyphs in short form.
18001 GLYPH > 1 or omitted means dump glyphs in long form. */)
18002 (Lisp_Object row
, Lisp_Object glyphs
)
18004 struct frame
*sf
= SELECTED_FRAME ();
18005 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18008 CHECK_NUMBER (row
);
18010 if (vpos
>= 0 && vpos
< m
->nrows
)
18011 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18012 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18017 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18018 doc
: /* Toggle tracing of redisplay.
18019 With ARG, turn tracing on if and only if ARG is positive. */)
18023 trace_redisplay_p
= !trace_redisplay_p
;
18026 arg
= Fprefix_numeric_value (arg
);
18027 trace_redisplay_p
= XINT (arg
) > 0;
18034 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18035 doc
: /* Like `format', but print result to stderr.
18036 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18037 (ptrdiff_t nargs
, Lisp_Object
*args
)
18039 Lisp_Object s
= Fformat (nargs
, args
);
18040 fprintf (stderr
, "%s", SDATA (s
));
18044 #endif /* GLYPH_DEBUG */
18048 /***********************************************************************
18049 Building Desired Matrix Rows
18050 ***********************************************************************/
18052 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18053 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18055 static struct glyph_row
*
18056 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18058 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18059 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18060 struct buffer
*old
= current_buffer
;
18061 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18062 int arrow_len
= SCHARS (overlay_arrow_string
);
18063 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18064 const unsigned char *p
;
18067 int n_glyphs_before
;
18069 set_buffer_temp (buffer
);
18070 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18071 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18072 SET_TEXT_POS (it
.position
, 0, 0);
18074 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18076 while (p
< arrow_end
)
18078 Lisp_Object face
, ilisp
;
18080 /* Get the next character. */
18082 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18085 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18086 if (! ASCII_CHAR_P (it
.c
))
18087 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18091 /* Get its face. */
18092 ilisp
= make_number (p
- arrow_string
);
18093 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18094 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18096 /* Compute its width, get its glyphs. */
18097 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18098 SET_TEXT_POS (it
.position
, -1, -1);
18099 PRODUCE_GLYPHS (&it
);
18101 /* If this character doesn't fit any more in the line, we have
18102 to remove some glyphs. */
18103 if (it
.current_x
> it
.last_visible_x
)
18105 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18110 set_buffer_temp (old
);
18111 return it
.glyph_row
;
18115 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18116 glyphs to insert is determined by produce_special_glyphs. */
18119 insert_left_trunc_glyphs (struct it
*it
)
18121 struct it truncate_it
;
18122 struct glyph
*from
, *end
, *to
, *toend
;
18124 eassert (!FRAME_WINDOW_P (it
->f
)
18125 || (!it
->glyph_row
->reversed_p
18126 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18127 || (it
->glyph_row
->reversed_p
18128 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18130 /* Get the truncation glyphs. */
18132 truncate_it
.current_x
= 0;
18133 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18134 truncate_it
.glyph_row
= &scratch_glyph_row
;
18135 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18136 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18137 truncate_it
.object
= make_number (0);
18138 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18140 /* Overwrite glyphs from IT with truncation glyphs. */
18141 if (!it
->glyph_row
->reversed_p
)
18143 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18145 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18146 end
= from
+ tused
;
18147 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18148 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18149 if (FRAME_WINDOW_P (it
->f
))
18151 /* On GUI frames, when variable-size fonts are displayed,
18152 the truncation glyphs may need more pixels than the row's
18153 glyphs they overwrite. We overwrite more glyphs to free
18154 enough screen real estate, and enlarge the stretch glyph
18155 on the right (see display_line), if there is one, to
18156 preserve the screen position of the truncation glyphs on
18159 struct glyph
*g
= to
;
18162 /* The first glyph could be partially visible, in which case
18163 it->glyph_row->x will be negative. But we want the left
18164 truncation glyphs to be aligned at the left margin of the
18165 window, so we override the x coordinate at which the row
18167 it
->glyph_row
->x
= 0;
18168 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18170 w
+= g
->pixel_width
;
18173 if (g
- to
- tused
> 0)
18175 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18176 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18178 used
= it
->glyph_row
->used
[TEXT_AREA
];
18179 if (it
->glyph_row
->truncated_on_right_p
18180 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18181 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18184 int extra
= w
- it
->truncation_pixel_width
;
18186 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18193 /* There may be padding glyphs left over. Overwrite them too. */
18194 if (!FRAME_WINDOW_P (it
->f
))
18196 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18198 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18205 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18209 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18211 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18212 that back to front. */
18213 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18214 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18215 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18216 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18217 if (FRAME_WINDOW_P (it
->f
))
18220 struct glyph
*g
= to
;
18222 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18224 w
+= g
->pixel_width
;
18227 if (to
- g
- tused
> 0)
18229 if (it
->glyph_row
->truncated_on_right_p
18230 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18231 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18233 int extra
= w
- it
->truncation_pixel_width
;
18235 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18239 while (from
>= end
&& to
>= toend
)
18241 if (!FRAME_WINDOW_P (it
->f
))
18243 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18246 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18247 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18248 while (from
>= end
&& to
>= toend
)
18254 /* Need to free some room before prepending additional
18256 int move_by
= from
- end
+ 1;
18257 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18258 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18260 for ( ; g
>= g0
; g
--)
18262 while (from
>= end
)
18264 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18269 /* Compute the hash code for ROW. */
18271 row_hash (struct glyph_row
*row
)
18274 unsigned hashval
= 0;
18276 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18277 for (k
= 0; k
< row
->used
[area
]; ++k
)
18278 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18279 + row
->glyphs
[area
][k
].u
.val
18280 + row
->glyphs
[area
][k
].face_id
18281 + row
->glyphs
[area
][k
].padding_p
18282 + (row
->glyphs
[area
][k
].type
<< 2));
18287 /* Compute the pixel height and width of IT->glyph_row.
18289 Most of the time, ascent and height of a display line will be equal
18290 to the max_ascent and max_height values of the display iterator
18291 structure. This is not the case if
18293 1. We hit ZV without displaying anything. In this case, max_ascent
18294 and max_height will be zero.
18296 2. We have some glyphs that don't contribute to the line height.
18297 (The glyph row flag contributes_to_line_height_p is for future
18298 pixmap extensions).
18300 The first case is easily covered by using default values because in
18301 these cases, the line height does not really matter, except that it
18302 must not be zero. */
18305 compute_line_metrics (struct it
*it
)
18307 struct glyph_row
*row
= it
->glyph_row
;
18309 if (FRAME_WINDOW_P (it
->f
))
18311 int i
, min_y
, max_y
;
18313 /* The line may consist of one space only, that was added to
18314 place the cursor on it. If so, the row's height hasn't been
18316 if (row
->height
== 0)
18318 if (it
->max_ascent
+ it
->max_descent
== 0)
18319 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18320 row
->ascent
= it
->max_ascent
;
18321 row
->height
= it
->max_ascent
+ it
->max_descent
;
18322 row
->phys_ascent
= it
->max_phys_ascent
;
18323 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18324 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18327 /* Compute the width of this line. */
18328 row
->pixel_width
= row
->x
;
18329 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18330 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18332 eassert (row
->pixel_width
>= 0);
18333 eassert (row
->ascent
>= 0 && row
->height
> 0);
18335 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18336 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18338 /* If first line's physical ascent is larger than its logical
18339 ascent, use the physical ascent, and make the row taller.
18340 This makes accented characters fully visible. */
18341 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18342 && row
->phys_ascent
> row
->ascent
)
18344 row
->height
+= row
->phys_ascent
- row
->ascent
;
18345 row
->ascent
= row
->phys_ascent
;
18348 /* Compute how much of the line is visible. */
18349 row
->visible_height
= row
->height
;
18351 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18352 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18354 if (row
->y
< min_y
)
18355 row
->visible_height
-= min_y
- row
->y
;
18356 if (row
->y
+ row
->height
> max_y
)
18357 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18361 row
->pixel_width
= row
->used
[TEXT_AREA
];
18362 if (row
->continued_p
)
18363 row
->pixel_width
-= it
->continuation_pixel_width
;
18364 else if (row
->truncated_on_right_p
)
18365 row
->pixel_width
-= it
->truncation_pixel_width
;
18366 row
->ascent
= row
->phys_ascent
= 0;
18367 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18368 row
->extra_line_spacing
= 0;
18371 /* Compute a hash code for this row. */
18372 row
->hash
= row_hash (row
);
18374 it
->max_ascent
= it
->max_descent
= 0;
18375 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18379 /* Append one space to the glyph row of iterator IT if doing a
18380 window-based redisplay. The space has the same face as
18381 IT->face_id. Value is non-zero if a space was added.
18383 This function is called to make sure that there is always one glyph
18384 at the end of a glyph row that the cursor can be set on under
18385 window-systems. (If there weren't such a glyph we would not know
18386 how wide and tall a box cursor should be displayed).
18388 At the same time this space let's a nicely handle clearing to the
18389 end of the line if the row ends in italic text. */
18392 append_space_for_newline (struct it
*it
, int default_face_p
)
18394 if (FRAME_WINDOW_P (it
->f
))
18396 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18398 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18399 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18401 /* Save some values that must not be changed.
18402 Must save IT->c and IT->len because otherwise
18403 ITERATOR_AT_END_P wouldn't work anymore after
18404 append_space_for_newline has been called. */
18405 enum display_element_type saved_what
= it
->what
;
18406 int saved_c
= it
->c
, saved_len
= it
->len
;
18407 int saved_char_to_display
= it
->char_to_display
;
18408 int saved_x
= it
->current_x
;
18409 int saved_face_id
= it
->face_id
;
18410 int saved_box_end
= it
->end_of_box_run_p
;
18411 struct text_pos saved_pos
;
18412 Lisp_Object saved_object
;
18415 saved_object
= it
->object
;
18416 saved_pos
= it
->position
;
18418 it
->what
= IT_CHARACTER
;
18419 memset (&it
->position
, 0, sizeof it
->position
);
18420 it
->object
= make_number (0);
18421 it
->c
= it
->char_to_display
= ' ';
18424 /* If the default face was remapped, be sure to use the
18425 remapped face for the appended newline. */
18426 if (default_face_p
)
18427 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18428 else if (it
->face_before_selective_p
)
18429 it
->face_id
= it
->saved_face_id
;
18430 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18431 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18432 /* In R2L rows, we will prepend a stretch glyph that will
18433 have the end_of_box_run_p flag set for it, so there's no
18434 need for the appended newline glyph to have that flag
18436 if (it
->glyph_row
->reversed_p
18437 /* But if the appended newline glyph goes all the way to
18438 the end of the row, there will be no stretch glyph,
18439 so leave the box flag set. */
18440 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
18441 it
->end_of_box_run_p
= 0;
18443 PRODUCE_GLYPHS (it
);
18445 it
->override_ascent
= -1;
18446 it
->constrain_row_ascent_descent_p
= 0;
18447 it
->current_x
= saved_x
;
18448 it
->object
= saved_object
;
18449 it
->position
= saved_pos
;
18450 it
->what
= saved_what
;
18451 it
->face_id
= saved_face_id
;
18452 it
->len
= saved_len
;
18454 it
->char_to_display
= saved_char_to_display
;
18455 it
->end_of_box_run_p
= saved_box_end
;
18464 /* Extend the face of the last glyph in the text area of IT->glyph_row
18465 to the end of the display line. Called from display_line. If the
18466 glyph row is empty, add a space glyph to it so that we know the
18467 face to draw. Set the glyph row flag fill_line_p. If the glyph
18468 row is R2L, prepend a stretch glyph to cover the empty space to the
18469 left of the leftmost glyph. */
18472 extend_face_to_end_of_line (struct it
*it
)
18474 struct face
*face
, *default_face
;
18475 struct frame
*f
= it
->f
;
18477 /* If line is already filled, do nothing. Non window-system frames
18478 get a grace of one more ``pixel'' because their characters are
18479 1-``pixel'' wide, so they hit the equality too early. This grace
18480 is needed only for R2L rows that are not continued, to produce
18481 one extra blank where we could display the cursor. */
18482 if (it
->current_x
>= it
->last_visible_x
18483 + (!FRAME_WINDOW_P (f
)
18484 && it
->glyph_row
->reversed_p
18485 && !it
->glyph_row
->continued_p
))
18488 /* The default face, possibly remapped. */
18489 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18491 /* Face extension extends the background and box of IT->face_id
18492 to the end of the line. If the background equals the background
18493 of the frame, we don't have to do anything. */
18494 if (it
->face_before_selective_p
)
18495 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18497 face
= FACE_FROM_ID (f
, it
->face_id
);
18499 if (FRAME_WINDOW_P (f
)
18500 && it
->glyph_row
->displays_text_p
18501 && face
->box
== FACE_NO_BOX
18502 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18504 && !it
->glyph_row
->reversed_p
)
18507 /* Set the glyph row flag indicating that the face of the last glyph
18508 in the text area has to be drawn to the end of the text area. */
18509 it
->glyph_row
->fill_line_p
= 1;
18511 /* If current character of IT is not ASCII, make sure we have the
18512 ASCII face. This will be automatically undone the next time
18513 get_next_display_element returns a multibyte character. Note
18514 that the character will always be single byte in unibyte
18516 if (!ASCII_CHAR_P (it
->c
))
18518 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18521 if (FRAME_WINDOW_P (f
))
18523 /* If the row is empty, add a space with the current face of IT,
18524 so that we know which face to draw. */
18525 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18527 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18528 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18529 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18531 #ifdef HAVE_WINDOW_SYSTEM
18532 if (it
->glyph_row
->reversed_p
)
18534 /* Prepend a stretch glyph to the row, such that the
18535 rightmost glyph will be drawn flushed all the way to the
18536 right margin of the window. The stretch glyph that will
18537 occupy the empty space, if any, to the left of the
18539 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18540 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18541 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18543 int row_width
, stretch_ascent
, stretch_width
;
18544 struct text_pos saved_pos
;
18545 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
18547 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18548 row_width
+= g
->pixel_width
;
18549 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18550 if (stretch_width
> 0)
18553 (((it
->ascent
+ it
->descent
)
18554 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18555 saved_pos
= it
->position
;
18556 memset (&it
->position
, 0, sizeof it
->position
);
18557 saved_avoid_cursor
= it
->avoid_cursor_p
;
18558 it
->avoid_cursor_p
= 1;
18559 saved_face_id
= it
->face_id
;
18560 saved_box_start
= it
->start_of_box_run_p
;
18561 /* The last row's stretch glyph should get the default
18562 face, to avoid painting the rest of the window with
18563 the region face, if the region ends at ZV. */
18564 if (it
->glyph_row
->ends_at_zv_p
)
18565 it
->face_id
= default_face
->id
;
18567 it
->face_id
= face
->id
;
18568 it
->start_of_box_run_p
= 0;
18569 append_stretch_glyph (it
, make_number (0), stretch_width
,
18570 it
->ascent
+ it
->descent
, stretch_ascent
);
18571 it
->position
= saved_pos
;
18572 it
->avoid_cursor_p
= saved_avoid_cursor
;
18573 it
->face_id
= saved_face_id
;
18574 it
->start_of_box_run_p
= saved_box_start
;
18577 #endif /* HAVE_WINDOW_SYSTEM */
18581 /* Save some values that must not be changed. */
18582 int saved_x
= it
->current_x
;
18583 struct text_pos saved_pos
;
18584 Lisp_Object saved_object
;
18585 enum display_element_type saved_what
= it
->what
;
18586 int saved_face_id
= it
->face_id
;
18588 saved_object
= it
->object
;
18589 saved_pos
= it
->position
;
18591 it
->what
= IT_CHARACTER
;
18592 memset (&it
->position
, 0, sizeof it
->position
);
18593 it
->object
= make_number (0);
18594 it
->c
= it
->char_to_display
= ' ';
18596 /* The last row's blank glyphs should get the default face, to
18597 avoid painting the rest of the window with the region face,
18598 if the region ends at ZV. */
18599 if (it
->glyph_row
->ends_at_zv_p
)
18600 it
->face_id
= default_face
->id
;
18602 it
->face_id
= face
->id
;
18604 PRODUCE_GLYPHS (it
);
18606 while (it
->current_x
<= it
->last_visible_x
)
18607 PRODUCE_GLYPHS (it
);
18609 /* Don't count these blanks really. It would let us insert a left
18610 truncation glyph below and make us set the cursor on them, maybe. */
18611 it
->current_x
= saved_x
;
18612 it
->object
= saved_object
;
18613 it
->position
= saved_pos
;
18614 it
->what
= saved_what
;
18615 it
->face_id
= saved_face_id
;
18620 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18621 trailing whitespace. */
18624 trailing_whitespace_p (ptrdiff_t charpos
)
18626 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18629 while (bytepos
< ZV_BYTE
18630 && (c
= FETCH_CHAR (bytepos
),
18631 c
== ' ' || c
== '\t'))
18634 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18636 if (bytepos
!= PT_BYTE
)
18643 /* Highlight trailing whitespace, if any, in ROW. */
18646 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18648 int used
= row
->used
[TEXT_AREA
];
18652 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18653 struct glyph
*glyph
= start
+ used
- 1;
18655 if (row
->reversed_p
)
18657 /* Right-to-left rows need to be processed in the opposite
18658 direction, so swap the edge pointers. */
18660 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18663 /* Skip over glyphs inserted to display the cursor at the
18664 end of a line, for extending the face of the last glyph
18665 to the end of the line on terminals, and for truncation
18666 and continuation glyphs. */
18667 if (!row
->reversed_p
)
18669 while (glyph
>= start
18670 && glyph
->type
== CHAR_GLYPH
18671 && INTEGERP (glyph
->object
))
18676 while (glyph
<= start
18677 && glyph
->type
== CHAR_GLYPH
18678 && INTEGERP (glyph
->object
))
18682 /* If last glyph is a space or stretch, and it's trailing
18683 whitespace, set the face of all trailing whitespace glyphs in
18684 IT->glyph_row to `trailing-whitespace'. */
18685 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18686 && BUFFERP (glyph
->object
)
18687 && (glyph
->type
== STRETCH_GLYPH
18688 || (glyph
->type
== CHAR_GLYPH
18689 && glyph
->u
.ch
== ' '))
18690 && trailing_whitespace_p (glyph
->charpos
))
18692 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18696 if (!row
->reversed_p
)
18698 while (glyph
>= start
18699 && BUFFERP (glyph
->object
)
18700 && (glyph
->type
== STRETCH_GLYPH
18701 || (glyph
->type
== CHAR_GLYPH
18702 && glyph
->u
.ch
== ' ')))
18703 (glyph
--)->face_id
= face_id
;
18707 while (glyph
<= start
18708 && BUFFERP (glyph
->object
)
18709 && (glyph
->type
== STRETCH_GLYPH
18710 || (glyph
->type
== CHAR_GLYPH
18711 && glyph
->u
.ch
== ' ')))
18712 (glyph
++)->face_id
= face_id
;
18719 /* Value is non-zero if glyph row ROW should be
18720 used to hold the cursor. */
18723 cursor_row_p (struct glyph_row
*row
)
18727 if (PT
== CHARPOS (row
->end
.pos
)
18728 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18730 /* Suppose the row ends on a string.
18731 Unless the row is continued, that means it ends on a newline
18732 in the string. If it's anything other than a display string
18733 (e.g., a before-string from an overlay), we don't want the
18734 cursor there. (This heuristic seems to give the optimal
18735 behavior for the various types of multi-line strings.)
18736 One exception: if the string has `cursor' property on one of
18737 its characters, we _do_ want the cursor there. */
18738 if (CHARPOS (row
->end
.string_pos
) >= 0)
18740 if (row
->continued_p
)
18744 /* Check for `display' property. */
18745 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18746 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18747 struct glyph
*glyph
;
18750 for (glyph
= end
; glyph
>= beg
; --glyph
)
18751 if (STRINGP (glyph
->object
))
18754 = Fget_char_property (make_number (PT
),
18758 && display_prop_string_p (prop
, glyph
->object
));
18759 /* If there's a `cursor' property on one of the
18760 string's characters, this row is a cursor row,
18761 even though this is not a display string. */
18764 Lisp_Object s
= glyph
->object
;
18766 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18768 ptrdiff_t gpos
= glyph
->charpos
;
18770 if (!NILP (Fget_char_property (make_number (gpos
),
18782 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18784 /* If the row ends in middle of a real character,
18785 and the line is continued, we want the cursor here.
18786 That's because CHARPOS (ROW->end.pos) would equal
18787 PT if PT is before the character. */
18788 if (!row
->ends_in_ellipsis_p
)
18789 result
= row
->continued_p
;
18791 /* If the row ends in an ellipsis, then
18792 CHARPOS (ROW->end.pos) will equal point after the
18793 invisible text. We want that position to be displayed
18794 after the ellipsis. */
18797 /* If the row ends at ZV, display the cursor at the end of that
18798 row instead of at the start of the row below. */
18799 else if (row
->ends_at_zv_p
)
18810 /* Push the property PROP so that it will be rendered at the current
18811 position in IT. Return 1 if PROP was successfully pushed, 0
18812 otherwise. Called from handle_line_prefix to handle the
18813 `line-prefix' and `wrap-prefix' properties. */
18816 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18818 struct text_pos pos
=
18819 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18821 eassert (it
->method
== GET_FROM_BUFFER
18822 || it
->method
== GET_FROM_DISPLAY_VECTOR
18823 || it
->method
== GET_FROM_STRING
);
18825 /* We need to save the current buffer/string position, so it will be
18826 restored by pop_it, because iterate_out_of_display_property
18827 depends on that being set correctly, but some situations leave
18828 it->position not yet set when this function is called. */
18829 push_it (it
, &pos
);
18831 if (STRINGP (prop
))
18833 if (SCHARS (prop
) == 0)
18840 it
->string_from_prefix_prop_p
= 1;
18841 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18842 it
->current
.overlay_string_index
= -1;
18843 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18844 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18845 it
->method
= GET_FROM_STRING
;
18846 it
->stop_charpos
= 0;
18848 it
->base_level_stop
= 0;
18850 /* Force paragraph direction to be that of the parent
18852 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18853 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18855 it
->paragraph_embedding
= L2R
;
18857 /* Set up the bidi iterator for this display string. */
18860 it
->bidi_it
.string
.lstring
= it
->string
;
18861 it
->bidi_it
.string
.s
= NULL
;
18862 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18863 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18864 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18865 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18866 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18869 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18871 it
->method
= GET_FROM_STRETCH
;
18874 #ifdef HAVE_WINDOW_SYSTEM
18875 else if (IMAGEP (prop
))
18877 it
->what
= IT_IMAGE
;
18878 it
->image_id
= lookup_image (it
->f
, prop
);
18879 it
->method
= GET_FROM_IMAGE
;
18881 #endif /* HAVE_WINDOW_SYSTEM */
18884 pop_it (it
); /* bogus display property, give up */
18891 /* Return the character-property PROP at the current position in IT. */
18894 get_it_property (struct it
*it
, Lisp_Object prop
)
18896 Lisp_Object position
;
18898 if (STRINGP (it
->object
))
18899 position
= make_number (IT_STRING_CHARPOS (*it
));
18900 else if (BUFFERP (it
->object
))
18901 position
= make_number (IT_CHARPOS (*it
));
18905 return Fget_char_property (position
, prop
, it
->object
);
18908 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18911 handle_line_prefix (struct it
*it
)
18913 Lisp_Object prefix
;
18915 if (it
->continuation_lines_width
> 0)
18917 prefix
= get_it_property (it
, Qwrap_prefix
);
18919 prefix
= Vwrap_prefix
;
18923 prefix
= get_it_property (it
, Qline_prefix
);
18925 prefix
= Vline_prefix
;
18927 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
18929 /* If the prefix is wider than the window, and we try to wrap
18930 it, it would acquire its own wrap prefix, and so on till the
18931 iterator stack overflows. So, don't wrap the prefix. */
18932 it
->line_wrap
= TRUNCATE
;
18933 it
->avoid_cursor_p
= 1;
18939 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18940 only for R2L lines from display_line and display_string, when they
18941 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18942 the line/string needs to be continued on the next glyph row. */
18944 unproduce_glyphs (struct it
*it
, int n
)
18946 struct glyph
*glyph
, *end
;
18948 eassert (it
->glyph_row
);
18949 eassert (it
->glyph_row
->reversed_p
);
18950 eassert (it
->area
== TEXT_AREA
);
18951 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18953 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18954 n
= it
->glyph_row
->used
[TEXT_AREA
];
18955 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18956 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18957 for ( ; glyph
< end
; glyph
++)
18958 glyph
[-n
] = *glyph
;
18961 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18962 and ROW->maxpos. */
18964 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18965 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
18966 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
18968 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18969 lines' rows is implemented for bidi-reordered rows. */
18971 /* ROW->minpos is the value of min_pos, the minimal buffer position
18972 we have in ROW, or ROW->start.pos if that is smaller. */
18973 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18974 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18976 /* We didn't find buffer positions smaller than ROW->start, or
18977 didn't find _any_ valid buffer positions in any of the glyphs,
18978 so we must trust the iterator's computed positions. */
18979 row
->minpos
= row
->start
.pos
;
18982 max_pos
= CHARPOS (it
->current
.pos
);
18983 max_bpos
= BYTEPOS (it
->current
.pos
);
18986 /* Here are the various use-cases for ending the row, and the
18987 corresponding values for ROW->maxpos:
18989 Line ends in a newline from buffer eol_pos + 1
18990 Line is continued from buffer max_pos + 1
18991 Line is truncated on right it->current.pos
18992 Line ends in a newline from string max_pos + 1(*)
18993 (*) + 1 only when line ends in a forward scan
18994 Line is continued from string max_pos
18995 Line is continued from display vector max_pos
18996 Line is entirely from a string min_pos == max_pos
18997 Line is entirely from a display vector min_pos == max_pos
18998 Line that ends at ZV ZV
19000 If you discover other use-cases, please add them here as
19002 if (row
->ends_at_zv_p
)
19003 row
->maxpos
= it
->current
.pos
;
19004 else if (row
->used
[TEXT_AREA
])
19006 int seen_this_string
= 0;
19007 struct glyph_row
*r1
= row
- 1;
19009 /* Did we see the same display string on the previous row? */
19010 if (STRINGP (it
->object
)
19011 /* this is not the first row */
19012 && row
> it
->w
->desired_matrix
->rows
19013 /* previous row is not the header line */
19014 && !r1
->mode_line_p
19015 /* previous row also ends in a newline from a string */
19016 && r1
->ends_in_newline_from_string_p
)
19018 struct glyph
*start
, *end
;
19020 /* Search for the last glyph of the previous row that came
19021 from buffer or string. Depending on whether the row is
19022 L2R or R2L, we need to process it front to back or the
19023 other way round. */
19024 if (!r1
->reversed_p
)
19026 start
= r1
->glyphs
[TEXT_AREA
];
19027 end
= start
+ r1
->used
[TEXT_AREA
];
19028 /* Glyphs inserted by redisplay have an integer (zero)
19029 as their object. */
19031 && INTEGERP ((end
- 1)->object
)
19032 && (end
- 1)->charpos
<= 0)
19036 if (EQ ((end
- 1)->object
, it
->object
))
19037 seen_this_string
= 1;
19040 /* If all the glyphs of the previous row were inserted
19041 by redisplay, it means the previous row was
19042 produced from a single newline, which is only
19043 possible if that newline came from the same string
19044 as the one which produced this ROW. */
19045 seen_this_string
= 1;
19049 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19050 start
= end
+ r1
->used
[TEXT_AREA
];
19052 && INTEGERP ((end
+ 1)->object
)
19053 && (end
+ 1)->charpos
<= 0)
19057 if (EQ ((end
+ 1)->object
, it
->object
))
19058 seen_this_string
= 1;
19061 seen_this_string
= 1;
19064 /* Take note of each display string that covers a newline only
19065 once, the first time we see it. This is for when a display
19066 string includes more than one newline in it. */
19067 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19069 /* If we were scanning the buffer forward when we displayed
19070 the string, we want to account for at least one buffer
19071 position that belongs to this row (position covered by
19072 the display string), so that cursor positioning will
19073 consider this row as a candidate when point is at the end
19074 of the visual line represented by this row. This is not
19075 required when scanning back, because max_pos will already
19076 have a much larger value. */
19077 if (CHARPOS (row
->end
.pos
) > max_pos
)
19078 INC_BOTH (max_pos
, max_bpos
);
19079 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19081 else if (CHARPOS (it
->eol_pos
) > 0)
19082 SET_TEXT_POS (row
->maxpos
,
19083 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19084 else if (row
->continued_p
)
19086 /* If max_pos is different from IT's current position, it
19087 means IT->method does not belong to the display element
19088 at max_pos. However, it also means that the display
19089 element at max_pos was displayed in its entirety on this
19090 line, which is equivalent to saying that the next line
19091 starts at the next buffer position. */
19092 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19093 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19096 INC_BOTH (max_pos
, max_bpos
);
19097 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19100 else if (row
->truncated_on_right_p
)
19101 /* display_line already called reseat_at_next_visible_line_start,
19102 which puts the iterator at the beginning of the next line, in
19103 the logical order. */
19104 row
->maxpos
= it
->current
.pos
;
19105 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19106 /* A line that is entirely from a string/image/stretch... */
19107 row
->maxpos
= row
->minpos
;
19112 row
->maxpos
= it
->current
.pos
;
19115 /* Construct the glyph row IT->glyph_row in the desired matrix of
19116 IT->w from text at the current position of IT. See dispextern.h
19117 for an overview of struct it. Value is non-zero if
19118 IT->glyph_row displays text, as opposed to a line displaying ZV
19122 display_line (struct it
*it
)
19124 struct glyph_row
*row
= it
->glyph_row
;
19125 Lisp_Object overlay_arrow_string
;
19127 void *wrap_data
= NULL
;
19128 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19129 int wrap_row_used
= -1;
19130 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19131 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19132 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19133 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19134 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19136 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19137 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19139 /* We always start displaying at hpos zero even if hscrolled. */
19140 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19142 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19143 >= it
->w
->desired_matrix
->nrows
)
19145 it
->w
->nrows_scale_factor
++;
19146 fonts_changed_p
= 1;
19150 /* Is IT->w showing the region? */
19151 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? it
->region_beg_charpos
: 0;
19153 /* Clear the result glyph row and enable it. */
19154 prepare_desired_row (row
);
19156 row
->y
= it
->current_y
;
19157 row
->start
= it
->start
;
19158 row
->continuation_lines_width
= it
->continuation_lines_width
;
19159 row
->displays_text_p
= 1;
19160 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19161 it
->starts_in_middle_of_char_p
= 0;
19163 /* Arrange the overlays nicely for our purposes. Usually, we call
19164 display_line on only one line at a time, in which case this
19165 can't really hurt too much, or we call it on lines which appear
19166 one after another in the buffer, in which case all calls to
19167 recenter_overlay_lists but the first will be pretty cheap. */
19168 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19170 /* Move over display elements that are not visible because we are
19171 hscrolled. This may stop at an x-position < IT->first_visible_x
19172 if the first glyph is partially visible or if we hit a line end. */
19173 if (it
->current_x
< it
->first_visible_x
)
19175 enum move_it_result move_result
;
19177 this_line_min_pos
= row
->start
.pos
;
19178 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19179 MOVE_TO_POS
| MOVE_TO_X
);
19180 /* If we are under a large hscroll, move_it_in_display_line_to
19181 could hit the end of the line without reaching
19182 it->first_visible_x. Pretend that we did reach it. This is
19183 especially important on a TTY, where we will call
19184 extend_face_to_end_of_line, which needs to know how many
19185 blank glyphs to produce. */
19186 if (it
->current_x
< it
->first_visible_x
19187 && (move_result
== MOVE_NEWLINE_OR_CR
19188 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19189 it
->current_x
= it
->first_visible_x
;
19191 /* Record the smallest positions seen while we moved over
19192 display elements that are not visible. This is needed by
19193 redisplay_internal for optimizing the case where the cursor
19194 stays inside the same line. The rest of this function only
19195 considers positions that are actually displayed, so
19196 RECORD_MAX_MIN_POS will not otherwise record positions that
19197 are hscrolled to the left of the left edge of the window. */
19198 min_pos
= CHARPOS (this_line_min_pos
);
19199 min_bpos
= BYTEPOS (this_line_min_pos
);
19203 /* We only do this when not calling `move_it_in_display_line_to'
19204 above, because move_it_in_display_line_to calls
19205 handle_line_prefix itself. */
19206 handle_line_prefix (it
);
19209 /* Get the initial row height. This is either the height of the
19210 text hscrolled, if there is any, or zero. */
19211 row
->ascent
= it
->max_ascent
;
19212 row
->height
= it
->max_ascent
+ it
->max_descent
;
19213 row
->phys_ascent
= it
->max_phys_ascent
;
19214 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19215 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19217 /* Utility macro to record max and min buffer positions seen until now. */
19218 #define RECORD_MAX_MIN_POS(IT) \
19221 int composition_p = !STRINGP ((IT)->string) \
19222 && ((IT)->what == IT_COMPOSITION); \
19223 ptrdiff_t current_pos = \
19224 composition_p ? (IT)->cmp_it.charpos \
19225 : IT_CHARPOS (*(IT)); \
19226 ptrdiff_t current_bpos = \
19227 composition_p ? CHAR_TO_BYTE (current_pos) \
19228 : IT_BYTEPOS (*(IT)); \
19229 if (current_pos < min_pos) \
19231 min_pos = current_pos; \
19232 min_bpos = current_bpos; \
19234 if (IT_CHARPOS (*it) > max_pos) \
19236 max_pos = IT_CHARPOS (*it); \
19237 max_bpos = IT_BYTEPOS (*it); \
19242 /* Loop generating characters. The loop is left with IT on the next
19243 character to display. */
19246 int n_glyphs_before
, hpos_before
, x_before
;
19248 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19250 /* Retrieve the next thing to display. Value is zero if end of
19252 if (!get_next_display_element (it
))
19254 /* Maybe add a space at the end of this line that is used to
19255 display the cursor there under X. Set the charpos of the
19256 first glyph of blank lines not corresponding to any text
19258 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19259 row
->exact_window_width_line_p
= 1;
19260 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19261 || row
->used
[TEXT_AREA
] == 0)
19263 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19264 row
->displays_text_p
= 0;
19266 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19267 && (!MINI_WINDOW_P (it
->w
)
19268 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19269 row
->indicate_empty_line_p
= 1;
19272 it
->continuation_lines_width
= 0;
19273 row
->ends_at_zv_p
= 1;
19274 /* A row that displays right-to-left text must always have
19275 its last face extended all the way to the end of line,
19276 even if this row ends in ZV, because we still write to
19277 the screen left to right. We also need to extend the
19278 last face if the default face is remapped to some
19279 different face, otherwise the functions that clear
19280 portions of the screen will clear with the default face's
19281 background color. */
19282 if (row
->reversed_p
19283 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19284 extend_face_to_end_of_line (it
);
19288 /* Now, get the metrics of what we want to display. This also
19289 generates glyphs in `row' (which is IT->glyph_row). */
19290 n_glyphs_before
= row
->used
[TEXT_AREA
];
19293 /* Remember the line height so far in case the next element doesn't
19294 fit on the line. */
19295 if (it
->line_wrap
!= TRUNCATE
)
19297 ascent
= it
->max_ascent
;
19298 descent
= it
->max_descent
;
19299 phys_ascent
= it
->max_phys_ascent
;
19300 phys_descent
= it
->max_phys_descent
;
19302 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19304 if (IT_DISPLAYING_WHITESPACE (it
))
19308 SAVE_IT (wrap_it
, *it
, wrap_data
);
19310 wrap_row_used
= row
->used
[TEXT_AREA
];
19311 wrap_row_ascent
= row
->ascent
;
19312 wrap_row_height
= row
->height
;
19313 wrap_row_phys_ascent
= row
->phys_ascent
;
19314 wrap_row_phys_height
= row
->phys_height
;
19315 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19316 wrap_row_min_pos
= min_pos
;
19317 wrap_row_min_bpos
= min_bpos
;
19318 wrap_row_max_pos
= max_pos
;
19319 wrap_row_max_bpos
= max_bpos
;
19325 PRODUCE_GLYPHS (it
);
19327 /* If this display element was in marginal areas, continue with
19329 if (it
->area
!= TEXT_AREA
)
19331 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19332 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19333 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19334 row
->phys_height
= max (row
->phys_height
,
19335 it
->max_phys_ascent
+ it
->max_phys_descent
);
19336 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19337 it
->max_extra_line_spacing
);
19338 set_iterator_to_next (it
, 1);
19342 /* Does the display element fit on the line? If we truncate
19343 lines, we should draw past the right edge of the window. If
19344 we don't truncate, we want to stop so that we can display the
19345 continuation glyph before the right margin. If lines are
19346 continued, there are two possible strategies for characters
19347 resulting in more than 1 glyph (e.g. tabs): Display as many
19348 glyphs as possible in this line and leave the rest for the
19349 continuation line, or display the whole element in the next
19350 line. Original redisplay did the former, so we do it also. */
19351 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19352 hpos_before
= it
->hpos
;
19355 if (/* Not a newline. */
19357 /* Glyphs produced fit entirely in the line. */
19358 && it
->current_x
< it
->last_visible_x
)
19360 it
->hpos
+= nglyphs
;
19361 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19362 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19363 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19364 row
->phys_height
= max (row
->phys_height
,
19365 it
->max_phys_ascent
+ it
->max_phys_descent
);
19366 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19367 it
->max_extra_line_spacing
);
19368 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19369 row
->x
= x
- it
->first_visible_x
;
19370 /* Record the maximum and minimum buffer positions seen so
19371 far in glyphs that will be displayed by this row. */
19373 RECORD_MAX_MIN_POS (it
);
19378 struct glyph
*glyph
;
19380 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19382 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19383 new_x
= x
+ glyph
->pixel_width
;
19385 if (/* Lines are continued. */
19386 it
->line_wrap
!= TRUNCATE
19387 && (/* Glyph doesn't fit on the line. */
19388 new_x
> it
->last_visible_x
19389 /* Or it fits exactly on a window system frame. */
19390 || (new_x
== it
->last_visible_x
19391 && FRAME_WINDOW_P (it
->f
)
19392 && (row
->reversed_p
19393 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19394 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19396 /* End of a continued line. */
19399 || (new_x
== it
->last_visible_x
19400 && FRAME_WINDOW_P (it
->f
)
19401 && (row
->reversed_p
19402 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19403 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19405 /* Current glyph is the only one on the line or
19406 fits exactly on the line. We must continue
19407 the line because we can't draw the cursor
19408 after the glyph. */
19409 row
->continued_p
= 1;
19410 it
->current_x
= new_x
;
19411 it
->continuation_lines_width
+= new_x
;
19413 if (i
== nglyphs
- 1)
19415 /* If line-wrap is on, check if a previous
19416 wrap point was found. */
19417 if (wrap_row_used
> 0
19418 /* Even if there is a previous wrap
19419 point, continue the line here as
19420 usual, if (i) the previous character
19421 was a space or tab AND (ii) the
19422 current character is not. */
19424 || IT_DISPLAYING_WHITESPACE (it
)))
19427 /* Record the maximum and minimum buffer
19428 positions seen so far in glyphs that will be
19429 displayed by this row. */
19431 RECORD_MAX_MIN_POS (it
);
19432 set_iterator_to_next (it
, 1);
19433 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19435 if (!get_next_display_element (it
))
19437 row
->exact_window_width_line_p
= 1;
19438 it
->continuation_lines_width
= 0;
19439 row
->continued_p
= 0;
19440 row
->ends_at_zv_p
= 1;
19442 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19444 row
->continued_p
= 0;
19445 row
->exact_window_width_line_p
= 1;
19449 else if (it
->bidi_p
)
19450 RECORD_MAX_MIN_POS (it
);
19452 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19453 && !FRAME_WINDOW_P (it
->f
))
19455 /* A padding glyph that doesn't fit on this line.
19456 This means the whole character doesn't fit
19458 if (row
->reversed_p
)
19459 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19460 - n_glyphs_before
);
19461 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19463 /* Fill the rest of the row with continuation
19464 glyphs like in 20.x. */
19465 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19466 < row
->glyphs
[1 + TEXT_AREA
])
19467 produce_special_glyphs (it
, IT_CONTINUATION
);
19469 row
->continued_p
= 1;
19470 it
->current_x
= x_before
;
19471 it
->continuation_lines_width
+= x_before
;
19473 /* Restore the height to what it was before the
19474 element not fitting on the line. */
19475 it
->max_ascent
= ascent
;
19476 it
->max_descent
= descent
;
19477 it
->max_phys_ascent
= phys_ascent
;
19478 it
->max_phys_descent
= phys_descent
;
19480 else if (wrap_row_used
> 0)
19483 if (row
->reversed_p
)
19484 unproduce_glyphs (it
,
19485 row
->used
[TEXT_AREA
] - wrap_row_used
);
19486 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19487 it
->continuation_lines_width
+= wrap_x
;
19488 row
->used
[TEXT_AREA
] = wrap_row_used
;
19489 row
->ascent
= wrap_row_ascent
;
19490 row
->height
= wrap_row_height
;
19491 row
->phys_ascent
= wrap_row_phys_ascent
;
19492 row
->phys_height
= wrap_row_phys_height
;
19493 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19494 min_pos
= wrap_row_min_pos
;
19495 min_bpos
= wrap_row_min_bpos
;
19496 max_pos
= wrap_row_max_pos
;
19497 max_bpos
= wrap_row_max_bpos
;
19498 row
->continued_p
= 1;
19499 row
->ends_at_zv_p
= 0;
19500 row
->exact_window_width_line_p
= 0;
19501 it
->continuation_lines_width
+= x
;
19503 /* Make sure that a non-default face is extended
19504 up to the right margin of the window. */
19505 extend_face_to_end_of_line (it
);
19507 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19509 /* A TAB that extends past the right edge of the
19510 window. This produces a single glyph on
19511 window system frames. We leave the glyph in
19512 this row and let it fill the row, but don't
19513 consume the TAB. */
19514 if ((row
->reversed_p
19515 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19516 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19517 produce_special_glyphs (it
, IT_CONTINUATION
);
19518 it
->continuation_lines_width
+= it
->last_visible_x
;
19519 row
->ends_in_middle_of_char_p
= 1;
19520 row
->continued_p
= 1;
19521 glyph
->pixel_width
= it
->last_visible_x
- x
;
19522 it
->starts_in_middle_of_char_p
= 1;
19526 /* Something other than a TAB that draws past
19527 the right edge of the window. Restore
19528 positions to values before the element. */
19529 if (row
->reversed_p
)
19530 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19531 - (n_glyphs_before
+ i
));
19532 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19534 /* Display continuation glyphs. */
19535 it
->current_x
= x_before
;
19536 it
->continuation_lines_width
+= x
;
19537 if (!FRAME_WINDOW_P (it
->f
)
19538 || (row
->reversed_p
19539 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19540 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19541 produce_special_glyphs (it
, IT_CONTINUATION
);
19542 row
->continued_p
= 1;
19544 extend_face_to_end_of_line (it
);
19546 if (nglyphs
> 1 && i
> 0)
19548 row
->ends_in_middle_of_char_p
= 1;
19549 it
->starts_in_middle_of_char_p
= 1;
19552 /* Restore the height to what it was before the
19553 element not fitting on the line. */
19554 it
->max_ascent
= ascent
;
19555 it
->max_descent
= descent
;
19556 it
->max_phys_ascent
= phys_ascent
;
19557 it
->max_phys_descent
= phys_descent
;
19562 else if (new_x
> it
->first_visible_x
)
19564 /* Increment number of glyphs actually displayed. */
19567 /* Record the maximum and minimum buffer positions
19568 seen so far in glyphs that will be displayed by
19571 RECORD_MAX_MIN_POS (it
);
19573 if (x
< it
->first_visible_x
)
19574 /* Glyph is partially visible, i.e. row starts at
19575 negative X position. */
19576 row
->x
= x
- it
->first_visible_x
;
19580 /* Glyph is completely off the left margin of the
19581 window. This should not happen because of the
19582 move_it_in_display_line at the start of this
19583 function, unless the text display area of the
19584 window is empty. */
19585 eassert (it
->first_visible_x
<= it
->last_visible_x
);
19588 /* Even if this display element produced no glyphs at all,
19589 we want to record its position. */
19590 if (it
->bidi_p
&& nglyphs
== 0)
19591 RECORD_MAX_MIN_POS (it
);
19593 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19594 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19595 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19596 row
->phys_height
= max (row
->phys_height
,
19597 it
->max_phys_ascent
+ it
->max_phys_descent
);
19598 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19599 it
->max_extra_line_spacing
);
19601 /* End of this display line if row is continued. */
19602 if (row
->continued_p
|| row
->ends_at_zv_p
)
19607 /* Is this a line end? If yes, we're also done, after making
19608 sure that a non-default face is extended up to the right
19609 margin of the window. */
19610 if (ITERATOR_AT_END_OF_LINE_P (it
))
19612 int used_before
= row
->used
[TEXT_AREA
];
19614 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19616 /* Add a space at the end of the line that is used to
19617 display the cursor there. */
19618 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19619 append_space_for_newline (it
, 0);
19621 /* Extend the face to the end of the line. */
19622 extend_face_to_end_of_line (it
);
19624 /* Make sure we have the position. */
19625 if (used_before
== 0)
19626 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19628 /* Record the position of the newline, for use in
19630 it
->eol_pos
= it
->current
.pos
;
19632 /* Consume the line end. This skips over invisible lines. */
19633 set_iterator_to_next (it
, 1);
19634 it
->continuation_lines_width
= 0;
19638 /* Proceed with next display element. Note that this skips
19639 over lines invisible because of selective display. */
19640 set_iterator_to_next (it
, 1);
19642 /* If we truncate lines, we are done when the last displayed
19643 glyphs reach past the right margin of the window. */
19644 if (it
->line_wrap
== TRUNCATE
19645 && (FRAME_WINDOW_P (it
->f
) && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19646 ? (it
->current_x
>= it
->last_visible_x
)
19647 : (it
->current_x
> it
->last_visible_x
)))
19649 /* Maybe add truncation glyphs. */
19650 if (!FRAME_WINDOW_P (it
->f
)
19651 || (row
->reversed_p
19652 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19653 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19657 if (!row
->reversed_p
)
19659 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19660 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19665 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19666 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19668 /* Remove any padding glyphs at the front of ROW, to
19669 make room for the truncation glyphs we will be
19670 adding below. The loop below always inserts at
19671 least one truncation glyph, so also remove the
19672 last glyph added to ROW. */
19673 unproduce_glyphs (it
, i
+ 1);
19674 /* Adjust i for the loop below. */
19675 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19678 it
->current_x
= x_before
;
19679 if (!FRAME_WINDOW_P (it
->f
))
19681 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19683 row
->used
[TEXT_AREA
] = i
;
19684 produce_special_glyphs (it
, IT_TRUNCATION
);
19689 row
->used
[TEXT_AREA
] = i
;
19690 produce_special_glyphs (it
, IT_TRUNCATION
);
19693 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19695 /* Don't truncate if we can overflow newline into fringe. */
19696 if (!get_next_display_element (it
))
19698 it
->continuation_lines_width
= 0;
19699 row
->ends_at_zv_p
= 1;
19700 row
->exact_window_width_line_p
= 1;
19703 if (ITERATOR_AT_END_OF_LINE_P (it
))
19705 row
->exact_window_width_line_p
= 1;
19706 goto at_end_of_line
;
19708 it
->current_x
= x_before
;
19711 row
->truncated_on_right_p
= 1;
19712 it
->continuation_lines_width
= 0;
19713 reseat_at_next_visible_line_start (it
, 0);
19714 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19715 it
->hpos
= hpos_before
;
19721 bidi_unshelve_cache (wrap_data
, 1);
19723 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19724 at the left window margin. */
19725 if (it
->first_visible_x
19726 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19728 if (!FRAME_WINDOW_P (it
->f
)
19729 || (row
->reversed_p
19730 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19731 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
19732 insert_left_trunc_glyphs (it
);
19733 row
->truncated_on_left_p
= 1;
19736 /* Remember the position at which this line ends.
19738 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19739 cannot be before the call to find_row_edges below, since that is
19740 where these positions are determined. */
19741 row
->end
= it
->current
;
19744 row
->minpos
= row
->start
.pos
;
19745 row
->maxpos
= row
->end
.pos
;
19749 /* ROW->minpos and ROW->maxpos must be the smallest and
19750 `1 + the largest' buffer positions in ROW. But if ROW was
19751 bidi-reordered, these two positions can be anywhere in the
19752 row, so we must determine them now. */
19753 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19756 /* If the start of this line is the overlay arrow-position, then
19757 mark this glyph row as the one containing the overlay arrow.
19758 This is clearly a mess with variable size fonts. It would be
19759 better to let it be displayed like cursors under X. */
19760 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19761 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19762 !NILP (overlay_arrow_string
)))
19764 /* Overlay arrow in window redisplay is a fringe bitmap. */
19765 if (STRINGP (overlay_arrow_string
))
19767 struct glyph_row
*arrow_row
19768 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19769 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19770 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19771 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19772 struct glyph
*p2
, *end
;
19774 /* Copy the arrow glyphs. */
19775 while (glyph
< arrow_end
)
19778 /* Throw away padding glyphs. */
19780 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19781 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19787 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19792 eassert (INTEGERP (overlay_arrow_string
));
19793 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19795 overlay_arrow_seen
= 1;
19798 /* Highlight trailing whitespace. */
19799 if (!NILP (Vshow_trailing_whitespace
))
19800 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19802 /* Compute pixel dimensions of this line. */
19803 compute_line_metrics (it
);
19805 /* Implementation note: No changes in the glyphs of ROW or in their
19806 faces can be done past this point, because compute_line_metrics
19807 computes ROW's hash value and stores it within the glyph_row
19810 /* Record whether this row ends inside an ellipsis. */
19811 row
->ends_in_ellipsis_p
19812 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19813 && it
->ellipsis_p
);
19815 /* Save fringe bitmaps in this row. */
19816 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19817 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19818 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19819 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19821 it
->left_user_fringe_bitmap
= 0;
19822 it
->left_user_fringe_face_id
= 0;
19823 it
->right_user_fringe_bitmap
= 0;
19824 it
->right_user_fringe_face_id
= 0;
19826 /* Maybe set the cursor. */
19827 cvpos
= it
->w
->cursor
.vpos
;
19829 /* In bidi-reordered rows, keep checking for proper cursor
19830 position even if one has been found already, because buffer
19831 positions in such rows change non-linearly with ROW->VPOS,
19832 when a line is continued. One exception: when we are at ZV,
19833 display cursor on the first suitable glyph row, since all
19834 the empty rows after that also have their position set to ZV. */
19835 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19836 lines' rows is implemented for bidi-reordered rows. */
19838 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19839 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19840 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19841 && cursor_row_p (row
))
19842 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19844 /* Prepare for the next line. This line starts horizontally at (X
19845 HPOS) = (0 0). Vertical positions are incremented. As a
19846 convenience for the caller, IT->glyph_row is set to the next
19848 it
->current_x
= it
->hpos
= 0;
19849 it
->current_y
+= row
->height
;
19850 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19853 /* The next row should by default use the same value of the
19854 reversed_p flag as this one. set_iterator_to_next decides when
19855 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19856 the flag accordingly. */
19857 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19858 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19859 it
->start
= row
->end
;
19860 return row
->displays_text_p
;
19862 #undef RECORD_MAX_MIN_POS
19865 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19866 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19867 doc
: /* Return paragraph direction at point in BUFFER.
19868 Value is either `left-to-right' or `right-to-left'.
19869 If BUFFER is omitted or nil, it defaults to the current buffer.
19871 Paragraph direction determines how the text in the paragraph is displayed.
19872 In left-to-right paragraphs, text begins at the left margin of the window
19873 and the reading direction is generally left to right. In right-to-left
19874 paragraphs, text begins at the right margin and is read from right to left.
19876 See also `bidi-paragraph-direction'. */)
19877 (Lisp_Object buffer
)
19879 struct buffer
*buf
= current_buffer
;
19880 struct buffer
*old
= buf
;
19882 if (! NILP (buffer
))
19884 CHECK_BUFFER (buffer
);
19885 buf
= XBUFFER (buffer
);
19888 if (NILP (BVAR (buf
, bidi_display_reordering
))
19889 || NILP (BVAR (buf
, enable_multibyte_characters
))
19890 /* When we are loading loadup.el, the character property tables
19891 needed for bidi iteration are not yet available. */
19892 || !NILP (Vpurify_flag
))
19893 return Qleft_to_right
;
19894 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19895 return BVAR (buf
, bidi_paragraph_direction
);
19898 /* Determine the direction from buffer text. We could try to
19899 use current_matrix if it is up to date, but this seems fast
19900 enough as it is. */
19901 struct bidi_it itb
;
19902 ptrdiff_t pos
= BUF_PT (buf
);
19903 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
19905 void *itb_data
= bidi_shelve_cache ();
19907 set_buffer_temp (buf
);
19908 /* bidi_paragraph_init finds the base direction of the paragraph
19909 by searching forward from paragraph start. We need the base
19910 direction of the current or _previous_ paragraph, so we need
19911 to make sure we are within that paragraph. To that end, find
19912 the previous non-empty line. */
19913 if (pos
>= ZV
&& pos
> BEGV
)
19916 bytepos
= CHAR_TO_BYTE (pos
);
19918 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19919 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19921 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19922 || c
== ' ' || c
== '\t' || c
== '\f')
19924 if (bytepos
<= BEGV_BYTE
)
19929 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19932 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19933 itb
.paragraph_dir
= NEUTRAL_DIR
;
19934 itb
.string
.s
= NULL
;
19935 itb
.string
.lstring
= Qnil
;
19936 itb
.string
.bufpos
= 0;
19937 itb
.string
.unibyte
= 0;
19938 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19939 bidi_unshelve_cache (itb_data
, 0);
19940 set_buffer_temp (old
);
19941 switch (itb
.paragraph_dir
)
19944 return Qleft_to_right
;
19947 return Qright_to_left
;
19957 /***********************************************************************
19959 ***********************************************************************/
19961 /* Redisplay the menu bar in the frame for window W.
19963 The menu bar of X frames that don't have X toolkit support is
19964 displayed in a special window W->frame->menu_bar_window.
19966 The menu bar of terminal frames is treated specially as far as
19967 glyph matrices are concerned. Menu bar lines are not part of
19968 windows, so the update is done directly on the frame matrix rows
19969 for the menu bar. */
19972 display_menu_bar (struct window
*w
)
19974 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19979 /* Don't do all this for graphical frames. */
19981 if (FRAME_W32_P (f
))
19984 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19990 if (FRAME_NS_P (f
))
19992 #endif /* HAVE_NS */
19994 #ifdef USE_X_TOOLKIT
19995 eassert (!FRAME_WINDOW_P (f
));
19996 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19997 it
.first_visible_x
= 0;
19998 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19999 #else /* not USE_X_TOOLKIT */
20000 if (FRAME_WINDOW_P (f
))
20002 /* Menu bar lines are displayed in the desired matrix of the
20003 dummy window menu_bar_window. */
20004 struct window
*menu_w
;
20005 eassert (WINDOWP (f
->menu_bar_window
));
20006 menu_w
= XWINDOW (f
->menu_bar_window
);
20007 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
20009 it
.first_visible_x
= 0;
20010 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20014 /* This is a TTY frame, i.e. character hpos/vpos are used as
20016 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
20018 it
.first_visible_x
= 0;
20019 it
.last_visible_x
= FRAME_COLS (f
);
20021 #endif /* not USE_X_TOOLKIT */
20023 /* FIXME: This should be controlled by a user option. See the
20024 comments in redisplay_tool_bar and display_mode_line about
20026 it
.paragraph_embedding
= L2R
;
20028 /* Clear all rows of the menu bar. */
20029 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
20031 struct glyph_row
*row
= it
.glyph_row
+ i
;
20032 clear_glyph_row (row
);
20033 row
->enabled_p
= 1;
20034 row
->full_width_p
= 1;
20037 /* Display all items of the menu bar. */
20038 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
20039 for (i
= 0; i
< ASIZE (items
); i
+= 4)
20041 Lisp_Object string
;
20043 /* Stop at nil string. */
20044 string
= AREF (items
, i
+ 1);
20048 /* Remember where item was displayed. */
20049 ASET (items
, i
+ 3, make_number (it
.hpos
));
20051 /* Display the item, pad with one space. */
20052 if (it
.current_x
< it
.last_visible_x
)
20053 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
20054 SCHARS (string
) + 1, 0, 0, -1);
20057 /* Fill out the line with spaces. */
20058 if (it
.current_x
< it
.last_visible_x
)
20059 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
20061 /* Compute the total height of the lines. */
20062 compute_line_metrics (&it
);
20067 /***********************************************************************
20069 ***********************************************************************/
20071 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20072 FORCE is non-zero, redisplay mode lines unconditionally.
20073 Otherwise, redisplay only mode lines that are garbaged. Value is
20074 the number of windows whose mode lines were redisplayed. */
20077 redisplay_mode_lines (Lisp_Object window
, int force
)
20081 while (!NILP (window
))
20083 struct window
*w
= XWINDOW (window
);
20085 if (WINDOWP (w
->hchild
))
20086 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
20087 else if (WINDOWP (w
->vchild
))
20088 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
20090 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20091 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20093 struct text_pos lpoint
;
20094 struct buffer
*old
= current_buffer
;
20096 /* Set the window's buffer for the mode line display. */
20097 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20098 set_buffer_internal_1 (XBUFFER (w
->buffer
));
20100 /* Point refers normally to the selected window. For any
20101 other window, set up appropriate value. */
20102 if (!EQ (window
, selected_window
))
20104 struct text_pos pt
;
20106 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20107 if (CHARPOS (pt
) < BEGV
)
20108 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
20109 else if (CHARPOS (pt
) > (ZV
- 1))
20110 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
20112 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20115 /* Display mode lines. */
20116 clear_glyph_matrix (w
->desired_matrix
);
20117 if (display_mode_lines (w
))
20120 w
->must_be_updated_p
= 1;
20123 /* Restore old settings. */
20124 set_buffer_internal_1 (old
);
20125 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20135 /* Display the mode and/or header line of window W. Value is the
20136 sum number of mode lines and header lines displayed. */
20139 display_mode_lines (struct window
*w
)
20141 Lisp_Object old_selected_window
= selected_window
;
20142 Lisp_Object old_selected_frame
= selected_frame
;
20143 Lisp_Object new_frame
= w
->frame
;
20144 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
20147 selected_frame
= new_frame
;
20148 /* FIXME: If we were to allow the mode-line's computation changing the buffer
20149 or window's point, then we'd need select_window_1 here as well. */
20150 XSETWINDOW (selected_window
, w
);
20151 XFRAME (new_frame
)->selected_window
= selected_window
;
20153 /* These will be set while the mode line specs are processed. */
20154 line_number_displayed
= 0;
20155 w
->column_number_displayed
= -1;
20157 if (WINDOW_WANTS_MODELINE_P (w
))
20159 struct window
*sel_w
= XWINDOW (old_selected_window
);
20161 /* Select mode line face based on the real selected window. */
20162 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20163 BVAR (current_buffer
, mode_line_format
));
20167 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20169 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20170 BVAR (current_buffer
, header_line_format
));
20174 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
20175 selected_frame
= old_selected_frame
;
20176 selected_window
= old_selected_window
;
20181 /* Display mode or header line of window W. FACE_ID specifies which
20182 line to display; it is either MODE_LINE_FACE_ID or
20183 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20184 display. Value is the pixel height of the mode/header line
20188 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20192 ptrdiff_t count
= SPECPDL_INDEX ();
20194 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20195 /* Don't extend on a previously drawn mode-line.
20196 This may happen if called from pos_visible_p. */
20197 it
.glyph_row
->enabled_p
= 0;
20198 prepare_desired_row (it
.glyph_row
);
20200 it
.glyph_row
->mode_line_p
= 1;
20202 /* FIXME: This should be controlled by a user option. But
20203 supporting such an option is not trivial, since the mode line is
20204 made up of many separate strings. */
20205 it
.paragraph_embedding
= L2R
;
20207 record_unwind_protect (unwind_format_mode_line
,
20208 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
20210 mode_line_target
= MODE_LINE_DISPLAY
;
20212 /* Temporarily make frame's keyboard the current kboard so that
20213 kboard-local variables in the mode_line_format will get the right
20215 push_kboard (FRAME_KBOARD (it
.f
));
20216 record_unwind_save_match_data ();
20217 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20220 unbind_to (count
, Qnil
);
20222 /* Fill up with spaces. */
20223 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20225 compute_line_metrics (&it
);
20226 it
.glyph_row
->full_width_p
= 1;
20227 it
.glyph_row
->continued_p
= 0;
20228 it
.glyph_row
->truncated_on_left_p
= 0;
20229 it
.glyph_row
->truncated_on_right_p
= 0;
20231 /* Make a 3D mode-line have a shadow at its right end. */
20232 face
= FACE_FROM_ID (it
.f
, face_id
);
20233 extend_face_to_end_of_line (&it
);
20234 if (face
->box
!= FACE_NO_BOX
)
20236 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20237 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20238 last
->right_box_line_p
= 1;
20241 return it
.glyph_row
->height
;
20244 /* Move element ELT in LIST to the front of LIST.
20245 Return the updated list. */
20248 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20250 register Lisp_Object tail
, prev
;
20251 register Lisp_Object tem
;
20255 while (CONSP (tail
))
20261 /* Splice out the link TAIL. */
20263 list
= XCDR (tail
);
20265 Fsetcdr (prev
, XCDR (tail
));
20267 /* Now make it the first. */
20268 Fsetcdr (tail
, list
);
20273 tail
= XCDR (tail
);
20277 /* Not found--return unchanged LIST. */
20281 /* Contribute ELT to the mode line for window IT->w. How it
20282 translates into text depends on its data type.
20284 IT describes the display environment in which we display, as usual.
20286 DEPTH is the depth in recursion. It is used to prevent
20287 infinite recursion here.
20289 FIELD_WIDTH is the number of characters the display of ELT should
20290 occupy in the mode line, and PRECISION is the maximum number of
20291 characters to display from ELT's representation. See
20292 display_string for details.
20294 Returns the hpos of the end of the text generated by ELT.
20296 PROPS is a property list to add to any string we encounter.
20298 If RISKY is nonzero, remove (disregard) any properties in any string
20299 we encounter, and ignore :eval and :propertize.
20301 The global variable `mode_line_target' determines whether the
20302 output is passed to `store_mode_line_noprop',
20303 `store_mode_line_string', or `display_string'. */
20306 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20307 Lisp_Object elt
, Lisp_Object props
, int risky
)
20309 int n
= 0, field
, prec
;
20314 elt
= build_string ("*too-deep*");
20318 switch (XTYPE (elt
))
20322 /* A string: output it and check for %-constructs within it. */
20324 ptrdiff_t offset
= 0;
20326 if (SCHARS (elt
) > 0
20327 && (!NILP (props
) || risky
))
20329 Lisp_Object oprops
, aelt
;
20330 oprops
= Ftext_properties_at (make_number (0), elt
);
20332 /* If the starting string's properties are not what
20333 we want, translate the string. Also, if the string
20334 is risky, do that anyway. */
20336 if (NILP (Fequal (props
, oprops
)) || risky
)
20338 /* If the starting string has properties,
20339 merge the specified ones onto the existing ones. */
20340 if (! NILP (oprops
) && !risky
)
20344 oprops
= Fcopy_sequence (oprops
);
20346 while (CONSP (tem
))
20348 oprops
= Fplist_put (oprops
, XCAR (tem
),
20349 XCAR (XCDR (tem
)));
20350 tem
= XCDR (XCDR (tem
));
20355 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20356 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20358 /* AELT is what we want. Move it to the front
20359 without consing. */
20361 mode_line_proptrans_alist
20362 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20368 /* If AELT has the wrong props, it is useless.
20369 so get rid of it. */
20371 mode_line_proptrans_alist
20372 = Fdelq (aelt
, mode_line_proptrans_alist
);
20374 elt
= Fcopy_sequence (elt
);
20375 Fset_text_properties (make_number (0), Flength (elt
),
20377 /* Add this item to mode_line_proptrans_alist. */
20378 mode_line_proptrans_alist
20379 = Fcons (Fcons (elt
, props
),
20380 mode_line_proptrans_alist
);
20381 /* Truncate mode_line_proptrans_alist
20382 to at most 50 elements. */
20383 tem
= Fnthcdr (make_number (50),
20384 mode_line_proptrans_alist
);
20386 XSETCDR (tem
, Qnil
);
20395 prec
= precision
- n
;
20396 switch (mode_line_target
)
20398 case MODE_LINE_NOPROP
:
20399 case MODE_LINE_TITLE
:
20400 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20402 case MODE_LINE_STRING
:
20403 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20405 case MODE_LINE_DISPLAY
:
20406 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20407 0, prec
, 0, STRING_MULTIBYTE (elt
));
20414 /* Handle the non-literal case. */
20416 while ((precision
<= 0 || n
< precision
)
20417 && SREF (elt
, offset
) != 0
20418 && (mode_line_target
!= MODE_LINE_DISPLAY
20419 || it
->current_x
< it
->last_visible_x
))
20421 ptrdiff_t last_offset
= offset
;
20423 /* Advance to end of string or next format specifier. */
20424 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20427 if (offset
- 1 != last_offset
)
20429 ptrdiff_t nchars
, nbytes
;
20431 /* Output to end of string or up to '%'. Field width
20432 is length of string. Don't output more than
20433 PRECISION allows us. */
20436 prec
= c_string_width (SDATA (elt
) + last_offset
,
20437 offset
- last_offset
, precision
- n
,
20440 switch (mode_line_target
)
20442 case MODE_LINE_NOPROP
:
20443 case MODE_LINE_TITLE
:
20444 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20446 case MODE_LINE_STRING
:
20448 ptrdiff_t bytepos
= last_offset
;
20449 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20450 ptrdiff_t endpos
= (precision
<= 0
20451 ? string_byte_to_char (elt
, offset
)
20452 : charpos
+ nchars
);
20454 n
+= store_mode_line_string (NULL
,
20455 Fsubstring (elt
, make_number (charpos
),
20456 make_number (endpos
)),
20460 case MODE_LINE_DISPLAY
:
20462 ptrdiff_t bytepos
= last_offset
;
20463 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20465 if (precision
<= 0)
20466 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20467 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20469 STRING_MULTIBYTE (elt
));
20474 else /* c == '%' */
20476 ptrdiff_t percent_position
= offset
;
20478 /* Get the specified minimum width. Zero means
20481 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20482 field
= field
* 10 + c
- '0';
20484 /* Don't pad beyond the total padding allowed. */
20485 if (field_width
- n
> 0 && field
> field_width
- n
)
20486 field
= field_width
- n
;
20488 /* Note that either PRECISION <= 0 or N < PRECISION. */
20489 prec
= precision
- n
;
20492 n
+= display_mode_element (it
, depth
, field
, prec
,
20493 Vglobal_mode_string
, props
,
20498 ptrdiff_t bytepos
, charpos
;
20500 Lisp_Object string
;
20502 bytepos
= percent_position
;
20503 charpos
= (STRING_MULTIBYTE (elt
)
20504 ? string_byte_to_char (elt
, bytepos
)
20506 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20507 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20509 switch (mode_line_target
)
20511 case MODE_LINE_NOPROP
:
20512 case MODE_LINE_TITLE
:
20513 n
+= store_mode_line_noprop (spec
, field
, prec
);
20515 case MODE_LINE_STRING
:
20517 Lisp_Object tem
= build_string (spec
);
20518 props
= Ftext_properties_at (make_number (charpos
), elt
);
20519 /* Should only keep face property in props */
20520 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20523 case MODE_LINE_DISPLAY
:
20525 int nglyphs_before
, nwritten
;
20527 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20528 nwritten
= display_string (spec
, string
, elt
,
20533 /* Assign to the glyphs written above the
20534 string where the `%x' came from, position
20538 struct glyph
*glyph
20539 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20543 for (i
= 0; i
< nwritten
; ++i
)
20545 glyph
[i
].object
= elt
;
20546 glyph
[i
].charpos
= charpos
;
20563 /* A symbol: process the value of the symbol recursively
20564 as if it appeared here directly. Avoid error if symbol void.
20565 Special case: if value of symbol is a string, output the string
20568 register Lisp_Object tem
;
20570 /* If the variable is not marked as risky to set
20571 then its contents are risky to use. */
20572 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20575 tem
= Fboundp (elt
);
20578 tem
= Fsymbol_value (elt
);
20579 /* If value is a string, output that string literally:
20580 don't check for % within it. */
20584 if (!EQ (tem
, elt
))
20586 /* Give up right away for nil or t. */
20596 register Lisp_Object car
, tem
;
20598 /* A cons cell: five distinct cases.
20599 If first element is :eval or :propertize, do something special.
20600 If first element is a string or a cons, process all the elements
20601 and effectively concatenate them.
20602 If first element is a negative number, truncate displaying cdr to
20603 at most that many characters. If positive, pad (with spaces)
20604 to at least that many characters.
20605 If first element is a symbol, process the cadr or caddr recursively
20606 according to whether the symbol's value is non-nil or nil. */
20608 if (EQ (car
, QCeval
))
20610 /* An element of the form (:eval FORM) means evaluate FORM
20611 and use the result as mode line elements. */
20616 if (CONSP (XCDR (elt
)))
20619 spec
= safe_eval (XCAR (XCDR (elt
)));
20620 n
+= display_mode_element (it
, depth
, field_width
- n
,
20621 precision
- n
, spec
, props
,
20625 else if (EQ (car
, QCpropertize
))
20627 /* An element of the form (:propertize ELT PROPS...)
20628 means display ELT but applying properties PROPS. */
20633 if (CONSP (XCDR (elt
)))
20634 n
+= display_mode_element (it
, depth
, field_width
- n
,
20635 precision
- n
, XCAR (XCDR (elt
)),
20636 XCDR (XCDR (elt
)), risky
);
20638 else if (SYMBOLP (car
))
20640 tem
= Fboundp (car
);
20644 /* elt is now the cdr, and we know it is a cons cell.
20645 Use its car if CAR has a non-nil value. */
20648 tem
= Fsymbol_value (car
);
20655 /* Symbol's value is nil (or symbol is unbound)
20656 Get the cddr of the original list
20657 and if possible find the caddr and use that. */
20661 else if (!CONSP (elt
))
20666 else if (INTEGERP (car
))
20668 register int lim
= XINT (car
);
20672 /* Negative int means reduce maximum width. */
20673 if (precision
<= 0)
20676 precision
= min (precision
, -lim
);
20680 /* Padding specified. Don't let it be more than
20681 current maximum. */
20683 lim
= min (precision
, lim
);
20685 /* If that's more padding than already wanted, queue it.
20686 But don't reduce padding already specified even if
20687 that is beyond the current truncation point. */
20688 field_width
= max (lim
, field_width
);
20692 else if (STRINGP (car
) || CONSP (car
))
20694 Lisp_Object halftail
= elt
;
20698 && (precision
<= 0 || n
< precision
))
20700 n
+= display_mode_element (it
, depth
,
20701 /* Do padding only after the last
20702 element in the list. */
20703 (! CONSP (XCDR (elt
))
20706 precision
- n
, XCAR (elt
),
20710 if ((len
& 1) == 0)
20711 halftail
= XCDR (halftail
);
20712 /* Check for cycle. */
20713 if (EQ (halftail
, elt
))
20722 elt
= build_string ("*invalid*");
20726 /* Pad to FIELD_WIDTH. */
20727 if (field_width
> 0 && n
< field_width
)
20729 switch (mode_line_target
)
20731 case MODE_LINE_NOPROP
:
20732 case MODE_LINE_TITLE
:
20733 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20735 case MODE_LINE_STRING
:
20736 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20738 case MODE_LINE_DISPLAY
:
20739 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20748 /* Store a mode-line string element in mode_line_string_list.
20750 If STRING is non-null, display that C string. Otherwise, the Lisp
20751 string LISP_STRING is displayed.
20753 FIELD_WIDTH is the minimum number of output glyphs to produce.
20754 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20755 with spaces. FIELD_WIDTH <= 0 means don't pad.
20757 PRECISION is the maximum number of characters to output from
20758 STRING. PRECISION <= 0 means don't truncate the string.
20760 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20761 properties to the string.
20763 PROPS are the properties to add to the string.
20764 The mode_line_string_face face property is always added to the string.
20768 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20769 int field_width
, int precision
, Lisp_Object props
)
20774 if (string
!= NULL
)
20776 len
= strlen (string
);
20777 if (precision
> 0 && len
> precision
)
20779 lisp_string
= make_string (string
, len
);
20781 props
= mode_line_string_face_prop
;
20782 else if (!NILP (mode_line_string_face
))
20784 Lisp_Object face
= Fplist_get (props
, Qface
);
20785 props
= Fcopy_sequence (props
);
20787 face
= mode_line_string_face
;
20789 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20790 props
= Fplist_put (props
, Qface
, face
);
20792 Fadd_text_properties (make_number (0), make_number (len
),
20793 props
, lisp_string
);
20797 len
= XFASTINT (Flength (lisp_string
));
20798 if (precision
> 0 && len
> precision
)
20801 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20804 if (!NILP (mode_line_string_face
))
20808 props
= Ftext_properties_at (make_number (0), lisp_string
);
20809 face
= Fplist_get (props
, Qface
);
20811 face
= mode_line_string_face
;
20813 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20814 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20816 lisp_string
= Fcopy_sequence (lisp_string
);
20819 Fadd_text_properties (make_number (0), make_number (len
),
20820 props
, lisp_string
);
20825 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20829 if (field_width
> len
)
20831 field_width
-= len
;
20832 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20834 Fadd_text_properties (make_number (0), make_number (field_width
),
20835 props
, lisp_string
);
20836 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20844 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20846 doc
: /* Format a string out of a mode line format specification.
20847 First arg FORMAT specifies the mode line format (see `mode-line-format'
20848 for details) to use.
20850 By default, the format is evaluated for the currently selected window.
20852 Optional second arg FACE specifies the face property to put on all
20853 characters for which no face is specified. The value nil means the
20854 default face. The value t means whatever face the window's mode line
20855 currently uses (either `mode-line' or `mode-line-inactive',
20856 depending on whether the window is the selected window or not).
20857 An integer value means the value string has no text
20860 Optional third and fourth args WINDOW and BUFFER specify the window
20861 and buffer to use as the context for the formatting (defaults
20862 are the selected window and the WINDOW's buffer). */)
20863 (Lisp_Object format
, Lisp_Object face
,
20864 Lisp_Object window
, Lisp_Object buffer
)
20869 struct buffer
*old_buffer
= NULL
;
20871 int no_props
= INTEGERP (face
);
20872 ptrdiff_t count
= SPECPDL_INDEX ();
20874 int string_start
= 0;
20876 w
= decode_any_window (window
);
20877 XSETWINDOW (window
, w
);
20880 buffer
= w
->buffer
;
20881 CHECK_BUFFER (buffer
);
20883 /* Make formatting the modeline a non-op when noninteractive, otherwise
20884 there will be problems later caused by a partially initialized frame. */
20885 if (NILP (format
) || noninteractive
)
20886 return empty_unibyte_string
;
20891 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20892 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20893 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20894 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20895 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20896 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20897 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20900 old_buffer
= current_buffer
;
20902 /* Save things including mode_line_proptrans_alist,
20903 and set that to nil so that we don't alter the outer value. */
20904 record_unwind_protect (unwind_format_mode_line
,
20905 format_mode_line_unwind_data
20906 (XFRAME (WINDOW_FRAME (w
)),
20907 old_buffer
, selected_window
, 1));
20908 mode_line_proptrans_alist
= Qnil
;
20910 Fselect_window (window
, Qt
);
20911 set_buffer_internal_1 (XBUFFER (buffer
));
20913 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20917 mode_line_target
= MODE_LINE_NOPROP
;
20918 mode_line_string_face_prop
= Qnil
;
20919 mode_line_string_list
= Qnil
;
20920 string_start
= MODE_LINE_NOPROP_LEN (0);
20924 mode_line_target
= MODE_LINE_STRING
;
20925 mode_line_string_list
= Qnil
;
20926 mode_line_string_face
= face
;
20927 mode_line_string_face_prop
20928 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20931 push_kboard (FRAME_KBOARD (it
.f
));
20932 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20937 len
= MODE_LINE_NOPROP_LEN (string_start
);
20938 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20942 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20943 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20944 empty_unibyte_string
);
20947 unbind_to (count
, Qnil
);
20951 /* Write a null-terminated, right justified decimal representation of
20952 the positive integer D to BUF using a minimal field width WIDTH. */
20955 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
20957 register char *p
= buf
;
20965 *p
++ = d
% 10 + '0';
20970 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20981 /* Write a null-terminated, right justified decimal and "human
20982 readable" representation of the nonnegative integer D to BUF using
20983 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20985 static const char power_letter
[] =
20999 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
21001 /* We aim to represent the nonnegative integer D as
21002 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
21003 ptrdiff_t quotient
= d
;
21005 /* -1 means: do not use TENTHS. */
21009 /* Length of QUOTIENT.TENTHS as a string. */
21015 if (1000 <= quotient
)
21017 /* Scale to the appropriate EXPONENT. */
21020 remainder
= quotient
% 1000;
21024 while (1000 <= quotient
);
21026 /* Round to nearest and decide whether to use TENTHS or not. */
21029 tenths
= remainder
/ 100;
21030 if (50 <= remainder
% 100)
21037 if (quotient
== 10)
21045 if (500 <= remainder
)
21047 if (quotient
< 999)
21058 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21059 if (tenths
== -1 && quotient
<= 99)
21066 p
= psuffix
= buf
+ max (width
, length
);
21068 /* Print EXPONENT. */
21069 *psuffix
++ = power_letter
[exponent
];
21072 /* Print TENTHS. */
21075 *--p
= '0' + tenths
;
21079 /* Print QUOTIENT. */
21082 int digit
= quotient
% 10;
21083 *--p
= '0' + digit
;
21085 while ((quotient
/= 10) != 0);
21087 /* Print leading spaces. */
21092 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21093 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21094 type of CODING_SYSTEM. Return updated pointer into BUF. */
21096 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21099 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21102 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21103 const unsigned char *eol_str
;
21105 /* The EOL conversion we are using. */
21106 Lisp_Object eoltype
;
21108 val
= CODING_SYSTEM_SPEC (coding_system
);
21111 if (!VECTORP (val
)) /* Not yet decided. */
21113 *buf
++ = multibyte
? '-' : ' ';
21115 eoltype
= eol_mnemonic_undecided
;
21116 /* Don't mention EOL conversion if it isn't decided. */
21121 Lisp_Object eolvalue
;
21123 attrs
= AREF (val
, 0);
21124 eolvalue
= AREF (val
, 2);
21127 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21132 /* The EOL conversion that is normal on this system. */
21134 if (NILP (eolvalue
)) /* Not yet decided. */
21135 eoltype
= eol_mnemonic_undecided
;
21136 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21137 eoltype
= eol_mnemonic_undecided
;
21138 else /* eolvalue is Qunix, Qdos, or Qmac. */
21139 eoltype
= (EQ (eolvalue
, Qunix
)
21140 ? eol_mnemonic_unix
21141 : (EQ (eolvalue
, Qdos
) == 1
21142 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21148 /* Mention the EOL conversion if it is not the usual one. */
21149 if (STRINGP (eoltype
))
21151 eol_str
= SDATA (eoltype
);
21152 eol_str_len
= SBYTES (eoltype
);
21154 else if (CHARACTERP (eoltype
))
21156 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
21157 int c
= XFASTINT (eoltype
);
21158 eol_str_len
= CHAR_STRING (c
, tmp
);
21163 eol_str
= invalid_eol_type
;
21164 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21166 memcpy (buf
, eol_str
, eol_str_len
);
21167 buf
+= eol_str_len
;
21173 /* Return a string for the output of a mode line %-spec for window W,
21174 generated by character C. FIELD_WIDTH > 0 means pad the string
21175 returned with spaces to that value. Return a Lisp string in
21176 *STRING if the resulting string is taken from that Lisp string.
21178 Note we operate on the current buffer for most purposes. */
21180 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21182 static const char *
21183 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21184 Lisp_Object
*string
)
21187 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21188 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21189 /* We are going to use f->decode_mode_spec_buffer as the buffer to
21190 produce strings from numerical values, so limit preposterously
21191 large values of FIELD_WIDTH to avoid overrunning the buffer's
21192 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
21193 bytes plus the terminating null. */
21194 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
21195 struct buffer
*b
= current_buffer
;
21203 if (!NILP (BVAR (b
, read_only
)))
21205 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21210 /* This differs from %* only for a modified read-only buffer. */
21211 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21213 if (!NILP (BVAR (b
, read_only
)))
21218 /* This differs from %* in ignoring read-only-ness. */
21219 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21231 if (command_loop_level
> 5)
21233 p
= decode_mode_spec_buf
;
21234 for (i
= 0; i
< command_loop_level
; i
++)
21237 return decode_mode_spec_buf
;
21245 if (command_loop_level
> 5)
21247 p
= decode_mode_spec_buf
;
21248 for (i
= 0; i
< command_loop_level
; i
++)
21251 return decode_mode_spec_buf
;
21258 /* Let lots_of_dashes be a string of infinite length. */
21259 if (mode_line_target
== MODE_LINE_NOPROP
21260 || mode_line_target
== MODE_LINE_STRING
)
21262 if (field_width
<= 0
21263 || field_width
> sizeof (lots_of_dashes
))
21265 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21266 decode_mode_spec_buf
[i
] = '-';
21267 decode_mode_spec_buf
[i
] = '\0';
21268 return decode_mode_spec_buf
;
21271 return lots_of_dashes
;
21275 obj
= BVAR (b
, name
);
21279 /* %c and %l are ignored in `frame-title-format'.
21280 (In redisplay_internal, the frame title is drawn _before_ the
21281 windows are updated, so the stuff which depends on actual
21282 window contents (such as %l) may fail to render properly, or
21283 even crash emacs.) */
21284 if (mode_line_target
== MODE_LINE_TITLE
)
21288 ptrdiff_t col
= current_column ();
21289 w
->column_number_displayed
= col
;
21290 pint2str (decode_mode_spec_buf
, width
, col
);
21291 return decode_mode_spec_buf
;
21295 #ifndef SYSTEM_MALLOC
21297 if (NILP (Vmemory_full
))
21300 return "!MEM FULL! ";
21307 /* %F displays the frame name. */
21308 if (!NILP (f
->title
))
21309 return SSDATA (f
->title
);
21310 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21311 return SSDATA (f
->name
);
21315 obj
= BVAR (b
, filename
);
21320 ptrdiff_t size
= ZV
- BEGV
;
21321 pint2str (decode_mode_spec_buf
, width
, size
);
21322 return decode_mode_spec_buf
;
21327 ptrdiff_t size
= ZV
- BEGV
;
21328 pint2hrstr (decode_mode_spec_buf
, width
, size
);
21329 return decode_mode_spec_buf
;
21334 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21335 ptrdiff_t topline
, nlines
, height
;
21338 /* %c and %l are ignored in `frame-title-format'. */
21339 if (mode_line_target
== MODE_LINE_TITLE
)
21342 startpos
= marker_position (w
->start
);
21343 startpos_byte
= marker_byte_position (w
->start
);
21344 height
= WINDOW_TOTAL_LINES (w
);
21346 /* If we decided that this buffer isn't suitable for line numbers,
21347 don't forget that too fast. */
21348 if (w
->base_line_pos
== -1)
21351 /* If the buffer is very big, don't waste time. */
21352 if (INTEGERP (Vline_number_display_limit
)
21353 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21355 w
->base_line_pos
= 0;
21356 w
->base_line_number
= 0;
21360 if (w
->base_line_number
> 0
21361 && w
->base_line_pos
> 0
21362 && w
->base_line_pos
<= startpos
)
21364 line
= w
->base_line_number
;
21365 linepos
= w
->base_line_pos
;
21366 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21371 linepos
= BUF_BEGV (b
);
21372 linepos_byte
= BUF_BEGV_BYTE (b
);
21375 /* Count lines from base line to window start position. */
21376 nlines
= display_count_lines (linepos_byte
,
21380 topline
= nlines
+ line
;
21382 /* Determine a new base line, if the old one is too close
21383 or too far away, or if we did not have one.
21384 "Too close" means it's plausible a scroll-down would
21385 go back past it. */
21386 if (startpos
== BUF_BEGV (b
))
21388 w
->base_line_number
= topline
;
21389 w
->base_line_pos
= BUF_BEGV (b
);
21391 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21392 || linepos
== BUF_BEGV (b
))
21394 ptrdiff_t limit
= BUF_BEGV (b
);
21395 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21396 ptrdiff_t position
;
21397 ptrdiff_t distance
=
21398 (height
* 2 + 30) * line_number_display_limit_width
;
21400 if (startpos
- distance
> limit
)
21402 limit
= startpos
- distance
;
21403 limit_byte
= CHAR_TO_BYTE (limit
);
21406 nlines
= display_count_lines (startpos_byte
,
21408 - (height
* 2 + 30),
21410 /* If we couldn't find the lines we wanted within
21411 line_number_display_limit_width chars per line,
21412 give up on line numbers for this window. */
21413 if (position
== limit_byte
&& limit
== startpos
- distance
)
21415 w
->base_line_pos
= -1;
21416 w
->base_line_number
= 0;
21420 w
->base_line_number
= topline
- nlines
;
21421 w
->base_line_pos
= BYTE_TO_CHAR (position
);
21424 /* Now count lines from the start pos to point. */
21425 nlines
= display_count_lines (startpos_byte
,
21426 PT_BYTE
, PT
, &junk
);
21428 /* Record that we did display the line number. */
21429 line_number_displayed
= 1;
21431 /* Make the string to show. */
21432 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
21433 return decode_mode_spec_buf
;
21436 char* p
= decode_mode_spec_buf
;
21437 int pad
= width
- 2;
21443 return decode_mode_spec_buf
;
21449 obj
= BVAR (b
, mode_name
);
21453 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21459 ptrdiff_t pos
= marker_position (w
->start
);
21460 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21462 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21464 if (pos
<= BUF_BEGV (b
))
21469 else if (pos
<= BUF_BEGV (b
))
21473 if (total
> 1000000)
21474 /* Do it differently for a large value, to avoid overflow. */
21475 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21477 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21478 /* We can't normally display a 3-digit number,
21479 so get us a 2-digit number that is close. */
21482 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21483 return decode_mode_spec_buf
;
21487 /* Display percentage of size above the bottom of the screen. */
21490 ptrdiff_t toppos
= marker_position (w
->start
);
21491 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21492 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21494 if (botpos
>= BUF_ZV (b
))
21496 if (toppos
<= BUF_BEGV (b
))
21503 if (total
> 1000000)
21504 /* Do it differently for a large value, to avoid overflow. */
21505 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21507 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21508 /* We can't normally display a 3-digit number,
21509 so get us a 2-digit number that is close. */
21512 if (toppos
<= BUF_BEGV (b
))
21513 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21515 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21516 return decode_mode_spec_buf
;
21521 /* status of process */
21522 obj
= Fget_buffer_process (Fcurrent_buffer ());
21524 return "no process";
21526 obj
= Fsymbol_name (Fprocess_status (obj
));
21532 ptrdiff_t count
= inhibit_garbage_collection ();
21533 Lisp_Object val
= call1 (intern ("file-remote-p"),
21534 BVAR (current_buffer
, directory
));
21535 unbind_to (count
, Qnil
);
21544 /* coding-system (not including end-of-line format) */
21546 /* coding-system (including end-of-line type) */
21548 int eol_flag
= (c
== 'Z');
21549 char *p
= decode_mode_spec_buf
;
21551 if (! FRAME_WINDOW_P (f
))
21553 /* No need to mention EOL here--the terminal never needs
21554 to do EOL conversion. */
21555 p
= decode_mode_spec_coding (CODING_ID_NAME
21556 (FRAME_KEYBOARD_CODING (f
)->id
),
21558 p
= decode_mode_spec_coding (CODING_ID_NAME
21559 (FRAME_TERMINAL_CODING (f
)->id
),
21562 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21565 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21566 #ifdef subprocesses
21567 obj
= Fget_buffer_process (Fcurrent_buffer ());
21568 if (PROCESSP (obj
))
21570 p
= decode_mode_spec_coding
21571 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
21572 p
= decode_mode_spec_coding
21573 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
21575 #endif /* subprocesses */
21578 return decode_mode_spec_buf
;
21585 return SSDATA (obj
);
21592 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
21593 means count lines back from START_BYTE. But don't go beyond
21594 LIMIT_BYTE. Return the number of lines thus found (always
21597 Set *BYTE_POS_PTR to the byte position where we stopped. This is
21598 either the position COUNT lines after/before START_BYTE, if we
21599 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
21603 display_count_lines (ptrdiff_t start_byte
,
21604 ptrdiff_t limit_byte
, ptrdiff_t count
,
21605 ptrdiff_t *byte_pos_ptr
)
21607 register unsigned char *cursor
;
21608 unsigned char *base
;
21610 register ptrdiff_t ceiling
;
21611 register unsigned char *ceiling_addr
;
21612 ptrdiff_t orig_count
= count
;
21614 /* If we are not in selective display mode,
21615 check only for newlines. */
21616 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21617 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21621 while (start_byte
< limit_byte
)
21623 ceiling
= BUFFER_CEILING_OF (start_byte
);
21624 ceiling
= min (limit_byte
- 1, ceiling
);
21625 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21626 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21630 if (selective_display
)
21632 while (*cursor
!= '\n' && *cursor
!= 015
21633 && ++cursor
!= ceiling_addr
)
21635 if (cursor
== ceiling_addr
)
21640 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
21649 start_byte
+= cursor
- base
;
21650 *byte_pos_ptr
= start_byte
;
21654 while (cursor
< ceiling_addr
);
21656 start_byte
+= ceiling_addr
- base
;
21661 while (start_byte
> limit_byte
)
21663 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21664 ceiling
= max (limit_byte
, ceiling
);
21665 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
21666 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21669 if (selective_display
)
21671 while (--cursor
>= ceiling_addr
21672 && *cursor
!= '\n' && *cursor
!= 015)
21674 if (cursor
< ceiling_addr
)
21679 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
21686 start_byte
+= cursor
- base
+ 1;
21687 *byte_pos_ptr
= start_byte
;
21688 /* When scanning backwards, we should
21689 not count the newline posterior to which we stop. */
21690 return - orig_count
- 1;
21693 start_byte
+= ceiling_addr
- base
;
21697 *byte_pos_ptr
= limit_byte
;
21700 return - orig_count
+ count
;
21701 return orig_count
- count
;
21707 /***********************************************************************
21709 ***********************************************************************/
21711 /* Display a NUL-terminated string, starting with index START.
21713 If STRING is non-null, display that C string. Otherwise, the Lisp
21714 string LISP_STRING is displayed. There's a case that STRING is
21715 non-null and LISP_STRING is not nil. It means STRING is a string
21716 data of LISP_STRING. In that case, we display LISP_STRING while
21717 ignoring its text properties.
21719 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21720 FACE_STRING. Display STRING or LISP_STRING with the face at
21721 FACE_STRING_POS in FACE_STRING:
21723 Display the string in the environment given by IT, but use the
21724 standard display table, temporarily.
21726 FIELD_WIDTH is the minimum number of output glyphs to produce.
21727 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21728 with spaces. If STRING has more characters, more than FIELD_WIDTH
21729 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21731 PRECISION is the maximum number of characters to output from
21732 STRING. PRECISION < 0 means don't truncate the string.
21734 This is roughly equivalent to printf format specifiers:
21736 FIELD_WIDTH PRECISION PRINTF
21737 ----------------------------------------
21743 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21744 display them, and < 0 means obey the current buffer's value of
21745 enable_multibyte_characters.
21747 Value is the number of columns displayed. */
21750 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21751 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
21752 int field_width
, int precision
, int max_x
, int multibyte
)
21754 int hpos_at_start
= it
->hpos
;
21755 int saved_face_id
= it
->face_id
;
21756 struct glyph_row
*row
= it
->glyph_row
;
21757 ptrdiff_t it_charpos
;
21759 /* Initialize the iterator IT for iteration over STRING beginning
21760 with index START. */
21761 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21762 precision
, field_width
, multibyte
);
21763 if (string
&& STRINGP (lisp_string
))
21764 /* LISP_STRING is the one returned by decode_mode_spec. We should
21765 ignore its text properties. */
21766 it
->stop_charpos
= it
->end_charpos
;
21768 /* If displaying STRING, set up the face of the iterator from
21769 FACE_STRING, if that's given. */
21770 if (STRINGP (face_string
))
21776 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21777 0, it
->region_beg_charpos
,
21778 it
->region_end_charpos
,
21779 &endptr
, it
->base_face_id
, 0);
21780 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21781 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21784 /* Set max_x to the maximum allowed X position. Don't let it go
21785 beyond the right edge of the window. */
21787 max_x
= it
->last_visible_x
;
21789 max_x
= min (max_x
, it
->last_visible_x
);
21791 /* Skip over display elements that are not visible. because IT->w is
21793 if (it
->current_x
< it
->first_visible_x
)
21794 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21795 MOVE_TO_POS
| MOVE_TO_X
);
21797 row
->ascent
= it
->max_ascent
;
21798 row
->height
= it
->max_ascent
+ it
->max_descent
;
21799 row
->phys_ascent
= it
->max_phys_ascent
;
21800 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21801 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21803 if (STRINGP (it
->string
))
21804 it_charpos
= IT_STRING_CHARPOS (*it
);
21806 it_charpos
= IT_CHARPOS (*it
);
21808 /* This condition is for the case that we are called with current_x
21809 past last_visible_x. */
21810 while (it
->current_x
< max_x
)
21812 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21814 /* Get the next display element. */
21815 if (!get_next_display_element (it
))
21818 /* Produce glyphs. */
21819 x_before
= it
->current_x
;
21820 n_glyphs_before
= row
->used
[TEXT_AREA
];
21821 PRODUCE_GLYPHS (it
);
21823 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21826 while (i
< nglyphs
)
21828 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21830 if (it
->line_wrap
!= TRUNCATE
21831 && x
+ glyph
->pixel_width
> max_x
)
21833 /* End of continued line or max_x reached. */
21834 if (CHAR_GLYPH_PADDING_P (*glyph
))
21836 /* A wide character is unbreakable. */
21837 if (row
->reversed_p
)
21838 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21839 - n_glyphs_before
);
21840 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21841 it
->current_x
= x_before
;
21845 if (row
->reversed_p
)
21846 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21847 - (n_glyphs_before
+ i
));
21848 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21853 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21855 /* Glyph is at least partially visible. */
21857 if (x
< it
->first_visible_x
)
21858 row
->x
= x
- it
->first_visible_x
;
21862 /* Glyph is off the left margin of the display area.
21863 Should not happen. */
21867 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21868 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21869 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21870 row
->phys_height
= max (row
->phys_height
,
21871 it
->max_phys_ascent
+ it
->max_phys_descent
);
21872 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21873 it
->max_extra_line_spacing
);
21874 x
+= glyph
->pixel_width
;
21878 /* Stop if max_x reached. */
21882 /* Stop at line ends. */
21883 if (ITERATOR_AT_END_OF_LINE_P (it
))
21885 it
->continuation_lines_width
= 0;
21889 set_iterator_to_next (it
, 1);
21890 if (STRINGP (it
->string
))
21891 it_charpos
= IT_STRING_CHARPOS (*it
);
21893 it_charpos
= IT_CHARPOS (*it
);
21895 /* Stop if truncating at the right edge. */
21896 if (it
->line_wrap
== TRUNCATE
21897 && it
->current_x
>= it
->last_visible_x
)
21899 /* Add truncation mark, but don't do it if the line is
21900 truncated at a padding space. */
21901 if (it_charpos
< it
->string_nchars
)
21903 if (!FRAME_WINDOW_P (it
->f
))
21907 if (it
->current_x
> it
->last_visible_x
)
21909 if (!row
->reversed_p
)
21911 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21912 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21917 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21918 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21920 unproduce_glyphs (it
, ii
+ 1);
21921 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21923 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21925 row
->used
[TEXT_AREA
] = ii
;
21926 produce_special_glyphs (it
, IT_TRUNCATION
);
21929 produce_special_glyphs (it
, IT_TRUNCATION
);
21931 row
->truncated_on_right_p
= 1;
21937 /* Maybe insert a truncation at the left. */
21938 if (it
->first_visible_x
21941 if (!FRAME_WINDOW_P (it
->f
)
21942 || (row
->reversed_p
21943 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21944 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
21945 insert_left_trunc_glyphs (it
);
21946 row
->truncated_on_left_p
= 1;
21949 it
->face_id
= saved_face_id
;
21951 /* Value is number of columns displayed. */
21952 return it
->hpos
- hpos_at_start
;
21957 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21958 appears as an element of LIST or as the car of an element of LIST.
21959 If PROPVAL is a list, compare each element against LIST in that
21960 way, and return 1/2 if any element of PROPVAL is found in LIST.
21961 Otherwise return 0. This function cannot quit.
21962 The return value is 2 if the text is invisible but with an ellipsis
21963 and 1 if it's invisible and without an ellipsis. */
21966 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21968 register Lisp_Object tail
, proptail
;
21970 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21972 register Lisp_Object tem
;
21974 if (EQ (propval
, tem
))
21976 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21977 return NILP (XCDR (tem
)) ? 1 : 2;
21980 if (CONSP (propval
))
21982 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21984 Lisp_Object propelt
;
21985 propelt
= XCAR (proptail
);
21986 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21988 register Lisp_Object tem
;
21990 if (EQ (propelt
, tem
))
21992 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21993 return NILP (XCDR (tem
)) ? 1 : 2;
22001 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
22002 doc
: /* Non-nil if the property makes the text invisible.
22003 POS-OR-PROP can be a marker or number, in which case it is taken to be
22004 a position in the current buffer and the value of the `invisible' property
22005 is checked; or it can be some other value, which is then presumed to be the
22006 value of the `invisible' property of the text of interest.
22007 The non-nil value returned can be t for truly invisible text or something
22008 else if the text is replaced by an ellipsis. */)
22009 (Lisp_Object pos_or_prop
)
22012 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
22013 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
22015 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
22016 return (invis
== 0 ? Qnil
22018 : make_number (invis
));
22021 /* Calculate a width or height in pixels from a specification using
22022 the following elements:
22025 NUM - a (fractional) multiple of the default font width/height
22026 (NUM) - specifies exactly NUM pixels
22027 UNIT - a fixed number of pixels, see below.
22028 ELEMENT - size of a display element in pixels, see below.
22029 (NUM . SPEC) - equals NUM * SPEC
22030 (+ SPEC SPEC ...) - add pixel values
22031 (- SPEC SPEC ...) - subtract pixel values
22032 (- SPEC) - negate pixel value
22035 INT or FLOAT - a number constant
22036 SYMBOL - use symbol's (buffer local) variable binding.
22039 in - pixels per inch *)
22040 mm - pixels per 1/1000 meter *)
22041 cm - pixels per 1/100 meter *)
22042 width - width of current font in pixels.
22043 height - height of current font in pixels.
22045 *) using the ratio(s) defined in display-pixels-per-inch.
22049 left-fringe - left fringe width in pixels
22050 right-fringe - right fringe width in pixels
22052 left-margin - left margin width in pixels
22053 right-margin - right margin width in pixels
22055 scroll-bar - scroll-bar area width in pixels
22059 Pixels corresponding to 5 inches:
22062 Total width of non-text areas on left side of window (if scroll-bar is on left):
22063 '(space :width (+ left-fringe left-margin scroll-bar))
22065 Align to first text column (in header line):
22066 '(space :align-to 0)
22068 Align to middle of text area minus half the width of variable `my-image'
22069 containing a loaded image:
22070 '(space :align-to (0.5 . (- text my-image)))
22072 Width of left margin minus width of 1 character in the default font:
22073 '(space :width (- left-margin 1))
22075 Width of left margin minus width of 2 characters in the current font:
22076 '(space :width (- left-margin (2 . width)))
22078 Center 1 character over left-margin (in header line):
22079 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22081 Different ways to express width of left fringe plus left margin minus one pixel:
22082 '(space :width (- (+ left-fringe left-margin) (1)))
22083 '(space :width (+ left-fringe left-margin (- (1))))
22084 '(space :width (+ left-fringe left-margin (-1)))
22088 #define NUMVAL(X) \
22089 ((INTEGERP (X) || FLOATP (X)) \
22094 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22095 struct font
*font
, int width_p
, int *align_to
)
22099 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22100 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22103 return OK_PIXELS (0);
22105 eassert (FRAME_LIVE_P (it
->f
));
22107 if (SYMBOLP (prop
))
22109 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22111 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22113 if (unit
[0] == 'i' && unit
[1] == 'n')
22115 else if (unit
[0] == 'm' && unit
[1] == 'm')
22117 else if (unit
[0] == 'c' && unit
[1] == 'm')
22124 #ifdef HAVE_WINDOW_SYSTEM
22125 if (FRAME_WINDOW_P (it
->f
)
22127 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
22128 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
22130 return OK_PIXELS (ppi
/ pixels
);
22133 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
22134 || (CONSP (Vdisplay_pixels_per_inch
)
22136 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
22137 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
22139 return OK_PIXELS (ppi
/ pixels
);
22145 #ifdef HAVE_WINDOW_SYSTEM
22146 if (EQ (prop
, Qheight
))
22147 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22148 if (EQ (prop
, Qwidth
))
22149 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22151 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22152 return OK_PIXELS (1);
22155 if (EQ (prop
, Qtext
))
22156 return OK_PIXELS (width_p
22157 ? window_box_width (it
->w
, TEXT_AREA
)
22158 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22160 if (align_to
&& *align_to
< 0)
22163 if (EQ (prop
, Qleft
))
22164 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22165 if (EQ (prop
, Qright
))
22166 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22167 if (EQ (prop
, Qcenter
))
22168 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22169 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22170 if (EQ (prop
, Qleft_fringe
))
22171 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22172 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22173 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22174 if (EQ (prop
, Qright_fringe
))
22175 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22176 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22177 : window_box_right_offset (it
->w
, TEXT_AREA
));
22178 if (EQ (prop
, Qleft_margin
))
22179 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22180 if (EQ (prop
, Qright_margin
))
22181 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22182 if (EQ (prop
, Qscroll_bar
))
22183 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22185 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22186 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22187 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22192 if (EQ (prop
, Qleft_fringe
))
22193 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22194 if (EQ (prop
, Qright_fringe
))
22195 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22196 if (EQ (prop
, Qleft_margin
))
22197 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22198 if (EQ (prop
, Qright_margin
))
22199 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22200 if (EQ (prop
, Qscroll_bar
))
22201 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22204 prop
= buffer_local_value_1 (prop
, it
->w
->buffer
);
22205 if (EQ (prop
, Qunbound
))
22209 if (INTEGERP (prop
) || FLOATP (prop
))
22211 int base_unit
= (width_p
22212 ? FRAME_COLUMN_WIDTH (it
->f
)
22213 : FRAME_LINE_HEIGHT (it
->f
));
22214 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22219 Lisp_Object car
= XCAR (prop
);
22220 Lisp_Object cdr
= XCDR (prop
);
22224 #ifdef HAVE_WINDOW_SYSTEM
22225 if (FRAME_WINDOW_P (it
->f
)
22226 && valid_image_p (prop
))
22228 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22229 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22231 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22234 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22240 while (CONSP (cdr
))
22242 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22243 font
, width_p
, align_to
))
22246 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22251 if (EQ (car
, Qminus
))
22253 return OK_PIXELS (pixels
);
22256 car
= buffer_local_value_1 (car
, it
->w
->buffer
);
22257 if (EQ (car
, Qunbound
))
22261 if (INTEGERP (car
) || FLOATP (car
))
22264 pixels
= XFLOATINT (car
);
22266 return OK_PIXELS (pixels
);
22267 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22268 font
, width_p
, align_to
))
22269 return OK_PIXELS (pixels
* fact
);
22280 /***********************************************************************
22282 ***********************************************************************/
22284 #ifdef HAVE_WINDOW_SYSTEM
22289 dump_glyph_string (struct glyph_string
*s
)
22291 fprintf (stderr
, "glyph string\n");
22292 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22293 s
->x
, s
->y
, s
->width
, s
->height
);
22294 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22295 fprintf (stderr
, " hl = %d\n", s
->hl
);
22296 fprintf (stderr
, " left overhang = %d, right = %d\n",
22297 s
->left_overhang
, s
->right_overhang
);
22298 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22299 fprintf (stderr
, " extends to end of line = %d\n",
22300 s
->extends_to_end_of_line_p
);
22301 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22302 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22305 #endif /* GLYPH_DEBUG */
22307 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22308 of XChar2b structures for S; it can't be allocated in
22309 init_glyph_string because it must be allocated via `alloca'. W
22310 is the window on which S is drawn. ROW and AREA are the glyph row
22311 and area within the row from which S is constructed. START is the
22312 index of the first glyph structure covered by S. HL is a
22313 face-override for drawing S. */
22316 #define OPTIONAL_HDC(hdc) HDC hdc,
22317 #define DECLARE_HDC(hdc) HDC hdc;
22318 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22319 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22322 #ifndef OPTIONAL_HDC
22323 #define OPTIONAL_HDC(hdc)
22324 #define DECLARE_HDC(hdc)
22325 #define ALLOCATE_HDC(hdc, f)
22326 #define RELEASE_HDC(hdc, f)
22330 init_glyph_string (struct glyph_string
*s
,
22332 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22333 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22335 memset (s
, 0, sizeof *s
);
22337 s
->f
= XFRAME (w
->frame
);
22341 s
->display
= FRAME_X_DISPLAY (s
->f
);
22342 s
->window
= FRAME_X_WINDOW (s
->f
);
22343 s
->char2b
= char2b
;
22347 s
->first_glyph
= row
->glyphs
[area
] + start
;
22348 s
->height
= row
->height
;
22349 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22350 s
->ybase
= s
->y
+ row
->ascent
;
22354 /* Append the list of glyph strings with head H and tail T to the list
22355 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22358 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22359 struct glyph_string
*h
, struct glyph_string
*t
)
22373 /* Prepend the list of glyph strings with head H and tail T to the
22374 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22378 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22379 struct glyph_string
*h
, struct glyph_string
*t
)
22393 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22394 Set *HEAD and *TAIL to the resulting list. */
22397 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22398 struct glyph_string
*s
)
22400 s
->next
= s
->prev
= NULL
;
22401 append_glyph_string_lists (head
, tail
, s
, s
);
22405 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22406 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22407 make sure that X resources for the face returned are allocated.
22408 Value is a pointer to a realized face that is ready for display if
22409 DISPLAY_P is non-zero. */
22411 static struct face
*
22412 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22413 XChar2b
*char2b
, int display_p
)
22415 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22419 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22421 if (code
!= FONT_INVALID_CODE
)
22422 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22424 STORE_XCHAR2B (char2b
, 0, 0);
22427 /* Make sure X resources of the face are allocated. */
22428 #ifdef HAVE_X_WINDOWS
22432 eassert (face
!= NULL
);
22433 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22440 /* Get face and two-byte form of character glyph GLYPH on frame F.
22441 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22442 a pointer to a realized face that is ready for display. */
22444 static struct face
*
22445 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22446 XChar2b
*char2b
, int *two_byte_p
)
22450 eassert (glyph
->type
== CHAR_GLYPH
);
22451 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22460 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22461 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22463 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22465 if (code
!= FONT_INVALID_CODE
)
22466 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22468 STORE_XCHAR2B (char2b
, 0, 0);
22471 /* Make sure X resources of the face are allocated. */
22472 eassert (face
!= NULL
);
22473 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22478 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22479 Return 1 if FONT has a glyph for C, otherwise return 0. */
22482 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22486 if (CHAR_BYTE8_P (c
))
22487 code
= CHAR_TO_BYTE8 (c
);
22489 code
= font
->driver
->encode_char (font
, c
);
22491 if (code
== FONT_INVALID_CODE
)
22493 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22498 /* Fill glyph string S with composition components specified by S->cmp.
22500 BASE_FACE is the base face of the composition.
22501 S->cmp_from is the index of the first component for S.
22503 OVERLAPS non-zero means S should draw the foreground only, and use
22504 its physical height for clipping. See also draw_glyphs.
22506 Value is the index of a component not in S. */
22509 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22513 /* For all glyphs of this composition, starting at the offset
22514 S->cmp_from, until we reach the end of the definition or encounter a
22515 glyph that requires the different face, add it to S. */
22520 s
->for_overlaps
= overlaps
;
22523 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22525 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22527 /* TAB in a composition means display glyphs with padding space
22528 on the left or right. */
22531 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22534 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22541 s
->font
= s
->face
->font
;
22543 else if (s
->face
!= face
)
22551 if (s
->face
== NULL
)
22553 s
->face
= base_face
->ascii_face
;
22554 s
->font
= s
->face
->font
;
22557 /* All glyph strings for the same composition has the same width,
22558 i.e. the width set for the first component of the composition. */
22559 s
->width
= s
->first_glyph
->pixel_width
;
22561 /* If the specified font could not be loaded, use the frame's
22562 default font, but record the fact that we couldn't load it in
22563 the glyph string so that we can draw rectangles for the
22564 characters of the glyph string. */
22565 if (s
->font
== NULL
)
22567 s
->font_not_found_p
= 1;
22568 s
->font
= FRAME_FONT (s
->f
);
22571 /* Adjust base line for subscript/superscript text. */
22572 s
->ybase
+= s
->first_glyph
->voffset
;
22574 /* This glyph string must always be drawn with 16-bit functions. */
22581 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22582 int start
, int end
, int overlaps
)
22584 struct glyph
*glyph
, *last
;
22585 Lisp_Object lgstring
;
22588 s
->for_overlaps
= overlaps
;
22589 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22590 last
= s
->row
->glyphs
[s
->area
] + end
;
22591 s
->cmp_id
= glyph
->u
.cmp
.id
;
22592 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22593 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22594 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22595 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22596 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22598 while (glyph
< last
22599 && glyph
->u
.cmp
.automatic
22600 && glyph
->u
.cmp
.id
== s
->cmp_id
22601 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22602 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22604 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22606 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22607 unsigned code
= LGLYPH_CODE (lglyph
);
22609 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22611 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22612 return glyph
- s
->row
->glyphs
[s
->area
];
22616 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22617 See the comment of fill_glyph_string for arguments.
22618 Value is the index of the first glyph not in S. */
22622 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22623 int start
, int end
, int overlaps
)
22625 struct glyph
*glyph
, *last
;
22628 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22629 s
->for_overlaps
= overlaps
;
22630 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22631 last
= s
->row
->glyphs
[s
->area
] + end
;
22632 voffset
= glyph
->voffset
;
22633 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22634 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
22636 s
->width
= glyph
->pixel_width
;
22638 while (glyph
< last
22639 && glyph
->type
== GLYPHLESS_GLYPH
22640 && glyph
->voffset
== voffset
22641 && glyph
->face_id
== face_id
)
22644 s
->width
+= glyph
->pixel_width
;
22647 s
->ybase
+= voffset
;
22648 return glyph
- s
->row
->glyphs
[s
->area
];
22652 /* Fill glyph string S from a sequence of character glyphs.
22654 FACE_ID is the face id of the string. START is the index of the
22655 first glyph to consider, END is the index of the last + 1.
22656 OVERLAPS non-zero means S should draw the foreground only, and use
22657 its physical height for clipping. See also draw_glyphs.
22659 Value is the index of the first glyph not in S. */
22662 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22663 int start
, int end
, int overlaps
)
22665 struct glyph
*glyph
, *last
;
22667 int glyph_not_available_p
;
22669 eassert (s
->f
== XFRAME (s
->w
->frame
));
22670 eassert (s
->nchars
== 0);
22671 eassert (start
>= 0 && end
> start
);
22673 s
->for_overlaps
= overlaps
;
22674 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22675 last
= s
->row
->glyphs
[s
->area
] + end
;
22676 voffset
= glyph
->voffset
;
22677 s
->padding_p
= glyph
->padding_p
;
22678 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22680 while (glyph
< last
22681 && glyph
->type
== CHAR_GLYPH
22682 && glyph
->voffset
== voffset
22683 /* Same face id implies same font, nowadays. */
22684 && glyph
->face_id
== face_id
22685 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22689 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22690 s
->char2b
+ s
->nchars
,
22692 s
->two_byte_p
= two_byte_p
;
22694 eassert (s
->nchars
<= end
- start
);
22695 s
->width
+= glyph
->pixel_width
;
22696 if (glyph
++->padding_p
!= s
->padding_p
)
22700 s
->font
= s
->face
->font
;
22702 /* If the specified font could not be loaded, use the frame's font,
22703 but record the fact that we couldn't load it in
22704 S->font_not_found_p so that we can draw rectangles for the
22705 characters of the glyph string. */
22706 if (s
->font
== NULL
|| glyph_not_available_p
)
22708 s
->font_not_found_p
= 1;
22709 s
->font
= FRAME_FONT (s
->f
);
22712 /* Adjust base line for subscript/superscript text. */
22713 s
->ybase
+= voffset
;
22715 eassert (s
->face
&& s
->face
->gc
);
22716 return glyph
- s
->row
->glyphs
[s
->area
];
22720 /* Fill glyph string S from image glyph S->first_glyph. */
22723 fill_image_glyph_string (struct glyph_string
*s
)
22725 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22726 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22728 s
->slice
= s
->first_glyph
->slice
.img
;
22729 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22730 s
->font
= s
->face
->font
;
22731 s
->width
= s
->first_glyph
->pixel_width
;
22733 /* Adjust base line for subscript/superscript text. */
22734 s
->ybase
+= s
->first_glyph
->voffset
;
22738 /* Fill glyph string S from a sequence of stretch glyphs.
22740 START is the index of the first glyph to consider,
22741 END is the index of the last + 1.
22743 Value is the index of the first glyph not in S. */
22746 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22748 struct glyph
*glyph
, *last
;
22749 int voffset
, face_id
;
22751 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22753 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22754 last
= s
->row
->glyphs
[s
->area
] + end
;
22755 face_id
= glyph
->face_id
;
22756 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22757 s
->font
= s
->face
->font
;
22758 s
->width
= glyph
->pixel_width
;
22760 voffset
= glyph
->voffset
;
22764 && glyph
->type
== STRETCH_GLYPH
22765 && glyph
->voffset
== voffset
22766 && glyph
->face_id
== face_id
);
22768 s
->width
+= glyph
->pixel_width
;
22770 /* Adjust base line for subscript/superscript text. */
22771 s
->ybase
+= voffset
;
22773 /* The case that face->gc == 0 is handled when drawing the glyph
22774 string by calling PREPARE_FACE_FOR_DISPLAY. */
22776 return glyph
- s
->row
->glyphs
[s
->area
];
22779 static struct font_metrics
*
22780 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22782 static struct font_metrics metrics
;
22783 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22785 if (! font
|| code
== FONT_INVALID_CODE
)
22787 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22792 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22793 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22794 assumed to be zero. */
22797 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22799 *left
= *right
= 0;
22801 if (glyph
->type
== CHAR_GLYPH
)
22805 struct font_metrics
*pcm
;
22807 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22808 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22810 if (pcm
->rbearing
> pcm
->width
)
22811 *right
= pcm
->rbearing
- pcm
->width
;
22812 if (pcm
->lbearing
< 0)
22813 *left
= -pcm
->lbearing
;
22816 else if (glyph
->type
== COMPOSITE_GLYPH
)
22818 if (! glyph
->u
.cmp
.automatic
)
22820 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22822 if (cmp
->rbearing
> cmp
->pixel_width
)
22823 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22824 if (cmp
->lbearing
< 0)
22825 *left
= - cmp
->lbearing
;
22829 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22830 struct font_metrics metrics
;
22832 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22833 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22834 if (metrics
.rbearing
> metrics
.width
)
22835 *right
= metrics
.rbearing
- metrics
.width
;
22836 if (metrics
.lbearing
< 0)
22837 *left
= - metrics
.lbearing
;
22843 /* Return the index of the first glyph preceding glyph string S that
22844 is overwritten by S because of S's left overhang. Value is -1
22845 if no glyphs are overwritten. */
22848 left_overwritten (struct glyph_string
*s
)
22852 if (s
->left_overhang
)
22855 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22856 int first
= s
->first_glyph
- glyphs
;
22858 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22859 x
-= glyphs
[i
].pixel_width
;
22870 /* Return the index of the first glyph preceding glyph string S that
22871 is overwriting S because of its right overhang. Value is -1 if no
22872 glyph in front of S overwrites S. */
22875 left_overwriting (struct glyph_string
*s
)
22878 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22879 int first
= s
->first_glyph
- glyphs
;
22883 for (i
= first
- 1; i
>= 0; --i
)
22886 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22889 x
-= glyphs
[i
].pixel_width
;
22896 /* Return the index of the last glyph following glyph string S that is
22897 overwritten by S because of S's right overhang. Value is -1 if
22898 no such glyph is found. */
22901 right_overwritten (struct glyph_string
*s
)
22905 if (s
->right_overhang
)
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
));
22911 int end
= s
->row
->used
[s
->area
];
22913 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22914 x
+= glyphs
[i
].pixel_width
;
22923 /* Return the index of the last glyph following glyph string S that
22924 overwrites S because of its left overhang. Value is negative
22925 if no such glyph is found. */
22928 right_overwriting (struct glyph_string
*s
)
22931 int end
= s
->row
->used
[s
->area
];
22932 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22933 int first
= (s
->first_glyph
- glyphs
22934 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
22938 for (i
= first
; i
< end
; ++i
)
22941 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22944 x
+= glyphs
[i
].pixel_width
;
22951 /* Set background width of glyph string S. START is the index of the
22952 first glyph following S. LAST_X is the right-most x-position + 1
22953 in the drawing area. */
22956 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22958 /* If the face of this glyph string has to be drawn to the end of
22959 the drawing area, set S->extends_to_end_of_line_p. */
22961 if (start
== s
->row
->used
[s
->area
]
22962 && s
->area
== TEXT_AREA
22963 && ((s
->row
->fill_line_p
22964 && (s
->hl
== DRAW_NORMAL_TEXT
22965 || s
->hl
== DRAW_IMAGE_RAISED
22966 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22967 || s
->hl
== DRAW_MOUSE_FACE
))
22968 s
->extends_to_end_of_line_p
= 1;
22970 /* If S extends its face to the end of the line, set its
22971 background_width to the distance to the right edge of the drawing
22973 if (s
->extends_to_end_of_line_p
)
22974 s
->background_width
= last_x
- s
->x
+ 1;
22976 s
->background_width
= s
->width
;
22980 /* Compute overhangs and x-positions for glyph string S and its
22981 predecessors, or successors. X is the starting x-position for S.
22982 BACKWARD_P non-zero means process predecessors. */
22985 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22991 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22992 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23002 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23003 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23013 /* The following macros are only called from draw_glyphs below.
23014 They reference the following parameters of that function directly:
23015 `w', `row', `area', and `overlap_p'
23016 as well as the following local variables:
23017 `s', `f', and `hdc' (in W32) */
23020 /* On W32, silently add local `hdc' variable to argument list of
23021 init_glyph_string. */
23022 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23023 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23025 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23026 init_glyph_string (s, char2b, w, row, area, start, hl)
23029 /* Add a glyph string for a stretch glyph to the list of strings
23030 between HEAD and TAIL. START is the index of the stretch glyph in
23031 row area AREA of glyph row ROW. END is the index of the last glyph
23032 in that glyph row area. X is the current output position assigned
23033 to the new glyph string constructed. HL overrides that face of the
23034 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23035 is the right-most x-position of the drawing area. */
23037 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23038 and below -- keep them on one line. */
23039 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23042 s = alloca (sizeof *s); \
23043 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23044 START = fill_stretch_glyph_string (s, START, END); \
23045 append_glyph_string (&HEAD, &TAIL, s); \
23051 /* Add a glyph string for an image glyph to the list of strings
23052 between HEAD and TAIL. START is the index of the image glyph in
23053 row area AREA of glyph row ROW. END is the index of the last glyph
23054 in that glyph row area. X is the current output position assigned
23055 to the new glyph string constructed. HL overrides that face of the
23056 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23057 is the right-most x-position of the drawing area. */
23059 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23062 s = alloca (sizeof *s); \
23063 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23064 fill_image_glyph_string (s); \
23065 append_glyph_string (&HEAD, &TAIL, s); \
23072 /* Add a glyph string for a sequence of character glyphs to the list
23073 of strings between HEAD and TAIL. START is the index of the first
23074 glyph in row area AREA of glyph row ROW that is part of the new
23075 glyph string. END is the index of the last glyph in that glyph row
23076 area. X is the current output position assigned to the new glyph
23077 string constructed. HL overrides that face of the glyph; e.g. it
23078 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23079 right-most x-position of the drawing area. */
23081 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23087 face_id = (row)->glyphs[area][START].face_id; \
23089 s = alloca (sizeof *s); \
23090 char2b = alloca ((END - START) * sizeof *char2b); \
23091 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23092 append_glyph_string (&HEAD, &TAIL, s); \
23094 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23099 /* Add a glyph string for a composite sequence to the list of strings
23100 between HEAD and TAIL. START is the index of the first glyph in
23101 row area AREA of glyph row ROW that is part of the new glyph
23102 string. END is the index of the last glyph in that glyph row area.
23103 X is the current output position assigned to the new glyph string
23104 constructed. HL overrides that face of the glyph; e.g. it is
23105 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23106 x-position of the drawing area. */
23108 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23110 int face_id = (row)->glyphs[area][START].face_id; \
23111 struct face *base_face = FACE_FROM_ID (f, face_id); \
23112 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23113 struct composition *cmp = composition_table[cmp_id]; \
23115 struct glyph_string *first_s = NULL; \
23118 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23120 /* Make glyph_strings for each glyph sequence that is drawable by \
23121 the same face, and append them to HEAD/TAIL. */ \
23122 for (n = 0; n < cmp->glyph_len;) \
23124 s = alloca (sizeof *s); \
23125 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23126 append_glyph_string (&(HEAD), &(TAIL), s); \
23132 n = fill_composite_glyph_string (s, base_face, overlaps); \
23140 /* Add a glyph string for a glyph-string sequence to the list of strings
23141 between HEAD and TAIL. */
23143 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23147 Lisp_Object gstring; \
23149 face_id = (row)->glyphs[area][START].face_id; \
23150 gstring = (composition_gstring_from_id \
23151 ((row)->glyphs[area][START].u.cmp.id)); \
23152 s = alloca (sizeof *s); \
23153 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23154 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23155 append_glyph_string (&(HEAD), &(TAIL), s); \
23157 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23161 /* Add a glyph string for a sequence of glyphless character's glyphs
23162 to the list of strings between HEAD and TAIL. The meanings of
23163 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23165 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23170 face_id = (row)->glyphs[area][START].face_id; \
23172 s = alloca (sizeof *s); \
23173 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23174 append_glyph_string (&HEAD, &TAIL, s); \
23176 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23182 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23183 of AREA of glyph row ROW on window W between indices START and END.
23184 HL overrides the face for drawing glyph strings, e.g. it is
23185 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23186 x-positions of the drawing area.
23188 This is an ugly monster macro construct because we must use alloca
23189 to allocate glyph strings (because draw_glyphs can be called
23190 asynchronously). */
23192 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23195 HEAD = TAIL = NULL; \
23196 while (START < END) \
23198 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23199 switch (first_glyph->type) \
23202 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23206 case COMPOSITE_GLYPH: \
23207 if (first_glyph->u.cmp.automatic) \
23208 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23211 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23215 case STRETCH_GLYPH: \
23216 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23220 case IMAGE_GLYPH: \
23221 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23225 case GLYPHLESS_GLYPH: \
23226 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23236 set_glyph_string_background_width (s, START, LAST_X); \
23243 /* Draw glyphs between START and END in AREA of ROW on window W,
23244 starting at x-position X. X is relative to AREA in W. HL is a
23245 face-override with the following meaning:
23247 DRAW_NORMAL_TEXT draw normally
23248 DRAW_CURSOR draw in cursor face
23249 DRAW_MOUSE_FACE draw in mouse face.
23250 DRAW_INVERSE_VIDEO draw in mode line face
23251 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23252 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23254 If OVERLAPS is non-zero, draw only the foreground of characters and
23255 clip to the physical height of ROW. Non-zero value also defines
23256 the overlapping part to be drawn:
23258 OVERLAPS_PRED overlap with preceding rows
23259 OVERLAPS_SUCC overlap with succeeding rows
23260 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23261 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23263 Value is the x-position reached, relative to AREA of W. */
23266 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23267 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23268 enum draw_glyphs_face hl
, int overlaps
)
23270 struct glyph_string
*head
, *tail
;
23271 struct glyph_string
*s
;
23272 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23273 int i
, j
, x_reached
, last_x
, area_left
= 0;
23274 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23277 ALLOCATE_HDC (hdc
, f
);
23279 /* Let's rather be paranoid than getting a SEGV. */
23280 end
= min (end
, row
->used
[area
]);
23281 start
= clip_to_bounds (0, start
, end
);
23283 /* Translate X to frame coordinates. Set last_x to the right
23284 end of the drawing area. */
23285 if (row
->full_width_p
)
23287 /* X is relative to the left edge of W, without scroll bars
23289 area_left
= WINDOW_LEFT_EDGE_X (w
);
23290 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23294 area_left
= window_box_left (w
, area
);
23295 last_x
= area_left
+ window_box_width (w
, area
);
23299 /* Build a doubly-linked list of glyph_string structures between
23300 head and tail from what we have to draw. Note that the macro
23301 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23302 the reason we use a separate variable `i'. */
23304 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23306 x_reached
= tail
->x
+ tail
->background_width
;
23310 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23311 the row, redraw some glyphs in front or following the glyph
23312 strings built above. */
23313 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23315 struct glyph_string
*h
, *t
;
23316 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23317 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23318 int check_mouse_face
= 0;
23321 /* If mouse highlighting is on, we may need to draw adjacent
23322 glyphs using mouse-face highlighting. */
23323 if (area
== TEXT_AREA
&& row
->mouse_face_p
23324 && hlinfo
->mouse_face_beg_row
>= 0
23325 && hlinfo
->mouse_face_end_row
>= 0)
23327 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23329 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23330 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23332 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23334 check_mouse_face
= 1;
23335 mouse_beg_col
= (row
== mouse_beg_row
)
23336 ? hlinfo
->mouse_face_beg_col
: 0;
23337 mouse_end_col
= (row
== mouse_end_row
)
23338 ? hlinfo
->mouse_face_end_col
23339 : row
->used
[TEXT_AREA
];
23343 /* Compute overhangs for all glyph strings. */
23344 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23345 for (s
= head
; s
; s
= s
->next
)
23346 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23348 /* Prepend glyph strings for glyphs in front of the first glyph
23349 string that are overwritten because of the first glyph
23350 string's left overhang. The background of all strings
23351 prepended must be drawn because the first glyph string
23353 i
= left_overwritten (head
);
23356 enum draw_glyphs_face overlap_hl
;
23358 /* If this row contains mouse highlighting, attempt to draw
23359 the overlapped glyphs with the correct highlight. This
23360 code fails if the overlap encompasses more than one glyph
23361 and mouse-highlight spans only some of these glyphs.
23362 However, making it work perfectly involves a lot more
23363 code, and I don't know if the pathological case occurs in
23364 practice, so we'll stick to this for now. --- cyd */
23365 if (check_mouse_face
23366 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23367 overlap_hl
= DRAW_MOUSE_FACE
;
23369 overlap_hl
= DRAW_NORMAL_TEXT
;
23372 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23373 overlap_hl
, dummy_x
, last_x
);
23375 compute_overhangs_and_x (t
, head
->x
, 1);
23376 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23380 /* Prepend glyph strings for glyphs in front of the first glyph
23381 string that overwrite that glyph string because of their
23382 right overhang. For these strings, only the foreground must
23383 be drawn, because it draws over the glyph string at `head'.
23384 The background must not be drawn because this would overwrite
23385 right overhangs of preceding glyphs for which no glyph
23387 i
= left_overwriting (head
);
23390 enum draw_glyphs_face overlap_hl
;
23392 if (check_mouse_face
23393 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23394 overlap_hl
= DRAW_MOUSE_FACE
;
23396 overlap_hl
= DRAW_NORMAL_TEXT
;
23399 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23400 overlap_hl
, dummy_x
, last_x
);
23401 for (s
= h
; s
; s
= s
->next
)
23402 s
->background_filled_p
= 1;
23403 compute_overhangs_and_x (t
, head
->x
, 1);
23404 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23407 /* Append glyphs strings for glyphs following the last glyph
23408 string tail that are overwritten by tail. The background of
23409 these strings has to be drawn because tail's foreground draws
23411 i
= right_overwritten (tail
);
23414 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
;
23422 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23423 overlap_hl
, x
, last_x
);
23424 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23425 we don't have `end = i;' here. */
23426 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23427 append_glyph_string_lists (&head
, &tail
, h
, t
);
23431 /* Append glyph strings for glyphs following the last glyph
23432 string tail that overwrite tail. The foreground of such
23433 glyphs has to be drawn because it writes into the background
23434 of tail. The background must not be drawn because it could
23435 paint over the foreground of following glyphs. */
23436 i
= right_overwriting (tail
);
23439 enum draw_glyphs_face overlap_hl
;
23440 if (check_mouse_face
23441 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23442 overlap_hl
= DRAW_MOUSE_FACE
;
23444 overlap_hl
= DRAW_NORMAL_TEXT
;
23447 i
++; /* We must include the Ith glyph. */
23448 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23449 overlap_hl
, x
, last_x
);
23450 for (s
= h
; s
; s
= s
->next
)
23451 s
->background_filled_p
= 1;
23452 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23453 append_glyph_string_lists (&head
, &tail
, h
, t
);
23455 if (clip_head
|| clip_tail
)
23456 for (s
= head
; s
; s
= s
->next
)
23458 s
->clip_head
= clip_head
;
23459 s
->clip_tail
= clip_tail
;
23463 /* Draw all strings. */
23464 for (s
= head
; s
; s
= s
->next
)
23465 FRAME_RIF (f
)->draw_glyph_string (s
);
23468 /* When focus a sole frame and move horizontally, this sets on_p to 0
23469 causing a failure to erase prev cursor position. */
23470 if (area
== TEXT_AREA
23471 && !row
->full_width_p
23472 /* When drawing overlapping rows, only the glyph strings'
23473 foreground is drawn, which doesn't erase a cursor
23477 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23478 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23479 : (tail
? tail
->x
+ tail
->background_width
: x
));
23483 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23484 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23488 /* Value is the x-position up to which drawn, relative to AREA of W.
23489 This doesn't include parts drawn because of overhangs. */
23490 if (row
->full_width_p
)
23491 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23493 x_reached
-= area_left
;
23495 RELEASE_HDC (hdc
, f
);
23500 /* Expand row matrix if too narrow. Don't expand if area
23503 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23505 if (!fonts_changed_p \
23506 && (it->glyph_row->glyphs[area] \
23507 < it->glyph_row->glyphs[area + 1])) \
23509 it->w->ncols_scale_factor++; \
23510 fonts_changed_p = 1; \
23514 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23515 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23518 append_glyph (struct it
*it
)
23520 struct glyph
*glyph
;
23521 enum glyph_row_area area
= it
->area
;
23523 eassert (it
->glyph_row
);
23524 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23526 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23527 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23529 /* If the glyph row is reversed, we need to prepend the glyph
23530 rather than append it. */
23531 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23535 /* Make room for the additional glyph. */
23536 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23538 glyph
= it
->glyph_row
->glyphs
[area
];
23540 glyph
->charpos
= CHARPOS (it
->position
);
23541 glyph
->object
= it
->object
;
23542 if (it
->pixel_width
> 0)
23544 glyph
->pixel_width
= it
->pixel_width
;
23545 glyph
->padding_p
= 0;
23549 /* Assure at least 1-pixel width. Otherwise, cursor can't
23550 be displayed correctly. */
23551 glyph
->pixel_width
= 1;
23552 glyph
->padding_p
= 1;
23554 glyph
->ascent
= it
->ascent
;
23555 glyph
->descent
= it
->descent
;
23556 glyph
->voffset
= it
->voffset
;
23557 glyph
->type
= CHAR_GLYPH
;
23558 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23559 glyph
->multibyte_p
= it
->multibyte_p
;
23560 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23562 /* In R2L rows, the left and the right box edges need to be
23563 drawn in reverse direction. */
23564 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23565 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23569 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23570 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23572 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23573 || it
->phys_descent
> it
->descent
);
23574 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23575 glyph
->face_id
= it
->face_id
;
23576 glyph
->u
.ch
= it
->char_to_display
;
23577 glyph
->slice
.img
= null_glyph_slice
;
23578 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23581 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23582 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23584 glyph
->bidi_type
= it
->bidi_it
.type
;
23588 glyph
->resolved_level
= 0;
23589 glyph
->bidi_type
= UNKNOWN_BT
;
23591 ++it
->glyph_row
->used
[area
];
23594 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23597 /* Store one glyph for the composition IT->cmp_it.id in
23598 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23602 append_composite_glyph (struct it
*it
)
23604 struct glyph
*glyph
;
23605 enum glyph_row_area area
= it
->area
;
23607 eassert (it
->glyph_row
);
23609 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23610 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23612 /* If the glyph row is reversed, we need to prepend the glyph
23613 rather than append it. */
23614 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23618 /* Make room for the new glyph. */
23619 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23621 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23623 glyph
->charpos
= it
->cmp_it
.charpos
;
23624 glyph
->object
= it
->object
;
23625 glyph
->pixel_width
= it
->pixel_width
;
23626 glyph
->ascent
= it
->ascent
;
23627 glyph
->descent
= it
->descent
;
23628 glyph
->voffset
= it
->voffset
;
23629 glyph
->type
= COMPOSITE_GLYPH
;
23630 if (it
->cmp_it
.ch
< 0)
23632 glyph
->u
.cmp
.automatic
= 0;
23633 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23634 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23638 glyph
->u
.cmp
.automatic
= 1;
23639 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23640 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23641 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23643 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23644 glyph
->multibyte_p
= it
->multibyte_p
;
23645 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23647 /* In R2L rows, the left and the right box edges need to be
23648 drawn in reverse direction. */
23649 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23650 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23654 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23655 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23657 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23658 || it
->phys_descent
> it
->descent
);
23659 glyph
->padding_p
= 0;
23660 glyph
->glyph_not_available_p
= 0;
23661 glyph
->face_id
= it
->face_id
;
23662 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23665 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23666 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23668 glyph
->bidi_type
= it
->bidi_it
.type
;
23670 ++it
->glyph_row
->used
[area
];
23673 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23677 /* Change IT->ascent and IT->height according to the setting of
23681 take_vertical_position_into_account (struct it
*it
)
23685 if (it
->voffset
< 0)
23686 /* Increase the ascent so that we can display the text higher
23688 it
->ascent
-= it
->voffset
;
23690 /* Increase the descent so that we can display the text lower
23692 it
->descent
+= it
->voffset
;
23697 /* Produce glyphs/get display metrics for the image IT is loaded with.
23698 See the description of struct display_iterator in dispextern.h for
23699 an overview of struct display_iterator. */
23702 produce_image_glyph (struct it
*it
)
23706 int glyph_ascent
, crop
;
23707 struct glyph_slice slice
;
23709 eassert (it
->what
== IT_IMAGE
);
23711 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23713 /* Make sure X resources of the face is loaded. */
23714 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23716 if (it
->image_id
< 0)
23718 /* Fringe bitmap. */
23719 it
->ascent
= it
->phys_ascent
= 0;
23720 it
->descent
= it
->phys_descent
= 0;
23721 it
->pixel_width
= 0;
23726 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23728 /* Make sure X resources of the image is loaded. */
23729 prepare_image_for_display (it
->f
, img
);
23731 slice
.x
= slice
.y
= 0;
23732 slice
.width
= img
->width
;
23733 slice
.height
= img
->height
;
23735 if (INTEGERP (it
->slice
.x
))
23736 slice
.x
= XINT (it
->slice
.x
);
23737 else if (FLOATP (it
->slice
.x
))
23738 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23740 if (INTEGERP (it
->slice
.y
))
23741 slice
.y
= XINT (it
->slice
.y
);
23742 else if (FLOATP (it
->slice
.y
))
23743 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23745 if (INTEGERP (it
->slice
.width
))
23746 slice
.width
= XINT (it
->slice
.width
);
23747 else if (FLOATP (it
->slice
.width
))
23748 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23750 if (INTEGERP (it
->slice
.height
))
23751 slice
.height
= XINT (it
->slice
.height
);
23752 else if (FLOATP (it
->slice
.height
))
23753 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23755 if (slice
.x
>= img
->width
)
23756 slice
.x
= img
->width
;
23757 if (slice
.y
>= img
->height
)
23758 slice
.y
= img
->height
;
23759 if (slice
.x
+ slice
.width
>= img
->width
)
23760 slice
.width
= img
->width
- slice
.x
;
23761 if (slice
.y
+ slice
.height
> img
->height
)
23762 slice
.height
= img
->height
- slice
.y
;
23764 if (slice
.width
== 0 || slice
.height
== 0)
23767 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23769 it
->descent
= slice
.height
- glyph_ascent
;
23771 it
->descent
+= img
->vmargin
;
23772 if (slice
.y
+ slice
.height
== img
->height
)
23773 it
->descent
+= img
->vmargin
;
23774 it
->phys_descent
= it
->descent
;
23776 it
->pixel_width
= slice
.width
;
23778 it
->pixel_width
+= img
->hmargin
;
23779 if (slice
.x
+ slice
.width
== img
->width
)
23780 it
->pixel_width
+= img
->hmargin
;
23782 /* It's quite possible for images to have an ascent greater than
23783 their height, so don't get confused in that case. */
23784 if (it
->descent
< 0)
23789 if (face
->box
!= FACE_NO_BOX
)
23791 if (face
->box_line_width
> 0)
23794 it
->ascent
+= face
->box_line_width
;
23795 if (slice
.y
+ slice
.height
== img
->height
)
23796 it
->descent
+= face
->box_line_width
;
23799 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23800 it
->pixel_width
+= eabs (face
->box_line_width
);
23801 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23802 it
->pixel_width
+= eabs (face
->box_line_width
);
23805 take_vertical_position_into_account (it
);
23807 /* Automatically crop wide image glyphs at right edge so we can
23808 draw the cursor on same display row. */
23809 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23810 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23812 it
->pixel_width
-= crop
;
23813 slice
.width
-= crop
;
23818 struct glyph
*glyph
;
23819 enum glyph_row_area area
= it
->area
;
23821 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23822 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23824 glyph
->charpos
= CHARPOS (it
->position
);
23825 glyph
->object
= it
->object
;
23826 glyph
->pixel_width
= it
->pixel_width
;
23827 glyph
->ascent
= glyph_ascent
;
23828 glyph
->descent
= it
->descent
;
23829 glyph
->voffset
= it
->voffset
;
23830 glyph
->type
= IMAGE_GLYPH
;
23831 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23832 glyph
->multibyte_p
= it
->multibyte_p
;
23833 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23835 /* In R2L rows, the left and the right box edges need to be
23836 drawn in reverse direction. */
23837 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23838 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23842 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23843 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23845 glyph
->overlaps_vertically_p
= 0;
23846 glyph
->padding_p
= 0;
23847 glyph
->glyph_not_available_p
= 0;
23848 glyph
->face_id
= it
->face_id
;
23849 glyph
->u
.img_id
= img
->id
;
23850 glyph
->slice
.img
= slice
;
23851 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23854 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23855 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23857 glyph
->bidi_type
= it
->bidi_it
.type
;
23859 ++it
->glyph_row
->used
[area
];
23862 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23867 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23868 of the glyph, WIDTH and HEIGHT are the width and height of the
23869 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23872 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23873 int width
, int height
, int ascent
)
23875 struct glyph
*glyph
;
23876 enum glyph_row_area area
= it
->area
;
23878 eassert (ascent
>= 0 && ascent
<= height
);
23880 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23881 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23883 /* If the glyph row is reversed, we need to prepend the glyph
23884 rather than append it. */
23885 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23889 /* Make room for the additional glyph. */
23890 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23892 glyph
= it
->glyph_row
->glyphs
[area
];
23894 glyph
->charpos
= CHARPOS (it
->position
);
23895 glyph
->object
= object
;
23896 glyph
->pixel_width
= width
;
23897 glyph
->ascent
= ascent
;
23898 glyph
->descent
= height
- ascent
;
23899 glyph
->voffset
= it
->voffset
;
23900 glyph
->type
= STRETCH_GLYPH
;
23901 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23902 glyph
->multibyte_p
= it
->multibyte_p
;
23903 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23905 /* In R2L rows, the left and the right box edges need to be
23906 drawn in reverse direction. */
23907 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23908 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23912 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23913 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23915 glyph
->overlaps_vertically_p
= 0;
23916 glyph
->padding_p
= 0;
23917 glyph
->glyph_not_available_p
= 0;
23918 glyph
->face_id
= it
->face_id
;
23919 glyph
->u
.stretch
.ascent
= ascent
;
23920 glyph
->u
.stretch
.height
= height
;
23921 glyph
->slice
.img
= null_glyph_slice
;
23922 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23925 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23926 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23928 glyph
->bidi_type
= it
->bidi_it
.type
;
23932 glyph
->resolved_level
= 0;
23933 glyph
->bidi_type
= UNKNOWN_BT
;
23935 ++it
->glyph_row
->used
[area
];
23938 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23941 #endif /* HAVE_WINDOW_SYSTEM */
23943 /* Produce a stretch glyph for iterator IT. IT->object is the value
23944 of the glyph property displayed. The value must be a list
23945 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23948 1. `:width WIDTH' specifies that the space should be WIDTH *
23949 canonical char width wide. WIDTH may be an integer or floating
23952 2. `:relative-width FACTOR' specifies that the width of the stretch
23953 should be computed from the width of the first character having the
23954 `glyph' property, and should be FACTOR times that width.
23956 3. `:align-to HPOS' specifies that the space should be wide enough
23957 to reach HPOS, a value in canonical character units.
23959 Exactly one of the above pairs must be present.
23961 4. `:height HEIGHT' specifies that the height of the stretch produced
23962 should be HEIGHT, measured in canonical character units.
23964 5. `:relative-height FACTOR' specifies that the height of the
23965 stretch should be FACTOR times the height of the characters having
23966 the glyph property.
23968 Either none or exactly one of 4 or 5 must be present.
23970 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23971 of the stretch should be used for the ascent of the stretch.
23972 ASCENT must be in the range 0 <= ASCENT <= 100. */
23975 produce_stretch_glyph (struct it
*it
)
23977 /* (space :width WIDTH :height HEIGHT ...) */
23978 Lisp_Object prop
, plist
;
23979 int width
= 0, height
= 0, align_to
= -1;
23980 int zero_width_ok_p
= 0;
23982 struct font
*font
= NULL
;
23984 #ifdef HAVE_WINDOW_SYSTEM
23986 int zero_height_ok_p
= 0;
23988 if (FRAME_WINDOW_P (it
->f
))
23990 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23991 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23992 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23996 /* List should start with `space'. */
23997 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23998 plist
= XCDR (it
->object
);
24000 /* Compute the width of the stretch. */
24001 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
24002 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
24004 /* Absolute width `:width WIDTH' specified and valid. */
24005 zero_width_ok_p
= 1;
24008 #ifdef HAVE_WINDOW_SYSTEM
24009 else if (FRAME_WINDOW_P (it
->f
)
24010 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
24012 /* Relative width `:relative-width FACTOR' specified and valid.
24013 Compute the width of the characters having the `glyph'
24016 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
24019 if (it
->multibyte_p
)
24020 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
24023 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
24024 if (! ASCII_CHAR_P (it2
.c
))
24025 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
24028 it2
.glyph_row
= NULL
;
24029 it2
.what
= IT_CHARACTER
;
24030 x_produce_glyphs (&it2
);
24031 width
= NUMVAL (prop
) * it2
.pixel_width
;
24033 #endif /* HAVE_WINDOW_SYSTEM */
24034 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
24035 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
24037 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
24038 align_to
= (align_to
< 0
24040 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
24041 else if (align_to
< 0)
24042 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
24043 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
24044 zero_width_ok_p
= 1;
24047 /* Nothing specified -> width defaults to canonical char width. */
24048 width
= FRAME_COLUMN_WIDTH (it
->f
);
24050 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
24053 #ifdef HAVE_WINDOW_SYSTEM
24054 /* Compute height. */
24055 if (FRAME_WINDOW_P (it
->f
))
24057 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
24058 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24061 zero_height_ok_p
= 1;
24063 else if (prop
= Fplist_get (plist
, QCrelative_height
),
24065 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
24067 height
= FONT_HEIGHT (font
);
24069 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
24072 /* Compute percentage of height used for ascent. If
24073 `:ascent ASCENT' is present and valid, use that. Otherwise,
24074 derive the ascent from the font in use. */
24075 if (prop
= Fplist_get (plist
, QCascent
),
24076 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
24077 ascent
= height
* NUMVAL (prop
) / 100.0;
24078 else if (!NILP (prop
)
24079 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24080 ascent
= min (max (0, (int)tem
), height
);
24082 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
24085 #endif /* HAVE_WINDOW_SYSTEM */
24088 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24089 && it
->current_x
+ width
> it
->last_visible_x
)
24091 width
= it
->last_visible_x
- it
->current_x
;
24092 #ifdef HAVE_WINDOW_SYSTEM
24093 /* Subtract one more pixel from the stretch width, but only on
24094 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24095 width
-= FRAME_WINDOW_P (it
->f
);
24099 if (width
> 0 && height
> 0 && it
->glyph_row
)
24101 Lisp_Object o_object
= it
->object
;
24102 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24105 if (!STRINGP (object
))
24106 object
= it
->w
->buffer
;
24107 #ifdef HAVE_WINDOW_SYSTEM
24108 if (FRAME_WINDOW_P (it
->f
))
24109 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24113 it
->object
= object
;
24114 it
->char_to_display
= ' ';
24115 it
->pixel_width
= it
->len
= 1;
24117 tty_append_glyph (it
);
24118 it
->object
= o_object
;
24122 it
->pixel_width
= width
;
24123 #ifdef HAVE_WINDOW_SYSTEM
24124 if (FRAME_WINDOW_P (it
->f
))
24126 it
->ascent
= it
->phys_ascent
= ascent
;
24127 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24128 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24129 take_vertical_position_into_account (it
);
24133 it
->nglyphs
= width
;
24136 /* Get information about special display element WHAT in an
24137 environment described by IT. WHAT is one of IT_TRUNCATION or
24138 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24139 non-null glyph_row member. This function ensures that fields like
24140 face_id, c, len of IT are left untouched. */
24143 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
24150 temp_it
.object
= make_number (0);
24151 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
24153 if (what
== IT_CONTINUATION
)
24155 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24156 if (it
->bidi_it
.paragraph_dir
== R2L
)
24157 SET_GLYPH_FROM_CHAR (glyph
, '/');
24159 SET_GLYPH_FROM_CHAR (glyph
, '\\');
24161 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24163 /* FIXME: Should we mirror GC for R2L lines? */
24164 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24165 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24168 else if (what
== IT_TRUNCATION
)
24170 /* Truncation glyph. */
24171 SET_GLYPH_FROM_CHAR (glyph
, '$');
24173 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24175 /* FIXME: Should we mirror GC for R2L lines? */
24176 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24177 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24183 #ifdef HAVE_WINDOW_SYSTEM
24184 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24185 is turned off, we precede the truncation/continuation glyphs by a
24186 stretch glyph whose width is computed such that these special
24187 glyphs are aligned at the window margin, even when very different
24188 fonts are used in different glyph rows. */
24189 if (FRAME_WINDOW_P (temp_it
.f
)
24190 /* init_iterator calls this with it->glyph_row == NULL, and it
24191 wants only the pixel width of the truncation/continuation
24193 && temp_it
.glyph_row
24194 /* insert_left_trunc_glyphs calls us at the beginning of the
24195 row, and it has its own calculation of the stretch glyph
24197 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
24198 && (temp_it
.glyph_row
->reversed_p
24199 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
24200 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
24202 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
24204 if (stretch_width
> 0)
24206 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
24207 struct font
*font
=
24208 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
24209 int stretch_ascent
=
24210 (((temp_it
.ascent
+ temp_it
.descent
)
24211 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
24213 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
24214 temp_it
.ascent
+ temp_it
.descent
,
24221 temp_it
.what
= IT_CHARACTER
;
24223 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
24224 temp_it
.face_id
= GLYPH_FACE (glyph
);
24225 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
24227 PRODUCE_GLYPHS (&temp_it
);
24228 it
->pixel_width
= temp_it
.pixel_width
;
24229 it
->nglyphs
= temp_it
.pixel_width
;
24232 #ifdef HAVE_WINDOW_SYSTEM
24234 /* Calculate line-height and line-spacing properties.
24235 An integer value specifies explicit pixel value.
24236 A float value specifies relative value to current face height.
24237 A cons (float . face-name) specifies relative value to
24238 height of specified face font.
24240 Returns height in pixels, or nil. */
24244 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24245 int boff
, int override
)
24247 Lisp_Object face_name
= Qnil
;
24248 int ascent
, descent
, height
;
24250 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24255 face_name
= XCAR (val
);
24257 if (!NUMBERP (val
))
24258 val
= make_number (1);
24259 if (NILP (face_name
))
24261 height
= it
->ascent
+ it
->descent
;
24266 if (NILP (face_name
))
24268 font
= FRAME_FONT (it
->f
);
24269 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24271 else if (EQ (face_name
, Qt
))
24280 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24282 return make_number (-1);
24284 face
= FACE_FROM_ID (it
->f
, face_id
);
24287 return make_number (-1);
24288 boff
= font
->baseline_offset
;
24289 if (font
->vertical_centering
)
24290 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24293 ascent
= FONT_BASE (font
) + boff
;
24294 descent
= FONT_DESCENT (font
) - boff
;
24298 it
->override_ascent
= ascent
;
24299 it
->override_descent
= descent
;
24300 it
->override_boff
= boff
;
24303 height
= ascent
+ descent
;
24307 height
= (int)(XFLOAT_DATA (val
) * height
);
24308 else if (INTEGERP (val
))
24309 height
*= XINT (val
);
24311 return make_number (height
);
24315 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24316 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24317 and only if this is for a character for which no font was found.
24319 If the display method (it->glyphless_method) is
24320 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24321 length of the acronym or the hexadecimal string, UPPER_XOFF and
24322 UPPER_YOFF are pixel offsets for the upper part of the string,
24323 LOWER_XOFF and LOWER_YOFF are for the lower part.
24325 For the other display methods, LEN through LOWER_YOFF are zero. */
24328 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24329 short upper_xoff
, short upper_yoff
,
24330 short lower_xoff
, short lower_yoff
)
24332 struct glyph
*glyph
;
24333 enum glyph_row_area area
= it
->area
;
24335 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24336 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24338 /* If the glyph row is reversed, we need to prepend the glyph
24339 rather than append it. */
24340 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24344 /* Make room for the additional glyph. */
24345 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24347 glyph
= it
->glyph_row
->glyphs
[area
];
24349 glyph
->charpos
= CHARPOS (it
->position
);
24350 glyph
->object
= it
->object
;
24351 glyph
->pixel_width
= it
->pixel_width
;
24352 glyph
->ascent
= it
->ascent
;
24353 glyph
->descent
= it
->descent
;
24354 glyph
->voffset
= it
->voffset
;
24355 glyph
->type
= GLYPHLESS_GLYPH
;
24356 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24357 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24358 glyph
->u
.glyphless
.len
= len
;
24359 glyph
->u
.glyphless
.ch
= it
->c
;
24360 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24361 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24362 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24363 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24364 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24365 glyph
->multibyte_p
= it
->multibyte_p
;
24366 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24368 /* In R2L rows, the left and the right box edges need to be
24369 drawn in reverse direction. */
24370 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24371 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24375 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24376 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24378 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24379 || it
->phys_descent
> it
->descent
);
24380 glyph
->padding_p
= 0;
24381 glyph
->glyph_not_available_p
= 0;
24382 glyph
->face_id
= face_id
;
24383 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24386 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24387 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24389 glyph
->bidi_type
= it
->bidi_it
.type
;
24391 ++it
->glyph_row
->used
[area
];
24394 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24398 /* Produce a glyph for a glyphless character for iterator IT.
24399 IT->glyphless_method specifies which method to use for displaying
24400 the character. See the description of enum
24401 glyphless_display_method in dispextern.h for the detail.
24403 FOR_NO_FONT is nonzero if and only if this is for a character for
24404 which no font was found. ACRONYM, if non-nil, is an acronym string
24405 for the character. */
24408 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24413 int base_width
, base_height
, width
, height
;
24414 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24417 /* Get the metrics of the base font. We always refer to the current
24419 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24420 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24421 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24422 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24423 base_height
= it
->ascent
+ it
->descent
;
24424 base_width
= font
->average_width
;
24426 /* Get a face ID for the glyph by utilizing a cache (the same way as
24427 done for `escape-glyph' in get_next_display_element). */
24428 if (it
->f
== last_glyphless_glyph_frame
24429 && it
->face_id
== last_glyphless_glyph_face_id
)
24431 face_id
= last_glyphless_glyph_merged_face_id
;
24435 /* Merge the `glyphless-char' face into the current face. */
24436 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24437 last_glyphless_glyph_frame
= it
->f
;
24438 last_glyphless_glyph_face_id
= it
->face_id
;
24439 last_glyphless_glyph_merged_face_id
= face_id
;
24442 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24444 it
->pixel_width
= THIN_SPACE_WIDTH
;
24446 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24448 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24450 width
= CHAR_WIDTH (it
->c
);
24453 else if (width
> 4)
24455 it
->pixel_width
= base_width
* width
;
24457 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24463 unsigned int code
[6];
24465 int ascent
, descent
;
24466 struct font_metrics metrics_upper
, metrics_lower
;
24468 face
= FACE_FROM_ID (it
->f
, face_id
);
24469 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24470 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24472 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24474 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24475 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24476 if (CONSP (acronym
))
24477 acronym
= XCAR (acronym
);
24478 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24482 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24483 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24486 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24487 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24488 upper_len
= (len
+ 1) / 2;
24489 font
->driver
->text_extents (font
, code
, upper_len
,
24491 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24496 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24497 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24498 upper_xoff
= upper_yoff
= 2; /* the typical case */
24499 if (base_width
>= width
)
24501 /* Align the upper to the left, the lower to the right. */
24502 it
->pixel_width
= base_width
;
24503 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24507 /* Center the shorter one. */
24508 it
->pixel_width
= width
;
24509 if (metrics_upper
.width
>= metrics_lower
.width
)
24510 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24513 /* FIXME: This code doesn't look right. It formerly was
24514 missing the "lower_xoff = 0;", which couldn't have
24515 been right since it left lower_xoff uninitialized. */
24517 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24521 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24522 top, bottom, and between upper and lower strings. */
24523 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24524 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24525 /* Center vertically.
24526 H:base_height, D:base_descent
24527 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24529 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24530 descent = D - H/2 + h/2;
24531 lower_yoff = descent - 2 - ld;
24532 upper_yoff = lower_yoff - la - 1 - ud; */
24533 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24534 descent
= it
->descent
- (base_height
- height
) / 2;
24535 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24536 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24537 - metrics_upper
.descent
);
24538 /* Don't make the height shorter than the base height. */
24539 if (height
> base_height
)
24541 it
->ascent
= ascent
;
24542 it
->descent
= descent
;
24546 it
->phys_ascent
= it
->ascent
;
24547 it
->phys_descent
= it
->descent
;
24549 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24550 upper_xoff
, upper_yoff
,
24551 lower_xoff
, lower_yoff
);
24553 take_vertical_position_into_account (it
);
24558 Produce glyphs/get display metrics for the display element IT is
24559 loaded with. See the description of struct it in dispextern.h
24560 for an overview of struct it. */
24563 x_produce_glyphs (struct it
*it
)
24565 int extra_line_spacing
= it
->extra_line_spacing
;
24567 it
->glyph_not_available_p
= 0;
24569 if (it
->what
== IT_CHARACTER
)
24572 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24573 struct font
*font
= face
->font
;
24574 struct font_metrics
*pcm
= NULL
;
24575 int boff
; /* baseline offset */
24579 /* When no suitable font is found, display this character by
24580 the method specified in the first extra slot of
24581 Vglyphless_char_display. */
24582 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24584 eassert (it
->what
== IT_GLYPHLESS
);
24585 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24589 boff
= font
->baseline_offset
;
24590 if (font
->vertical_centering
)
24591 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24593 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24599 if (it
->override_ascent
>= 0)
24601 it
->ascent
= it
->override_ascent
;
24602 it
->descent
= it
->override_descent
;
24603 boff
= it
->override_boff
;
24607 it
->ascent
= FONT_BASE (font
) + boff
;
24608 it
->descent
= FONT_DESCENT (font
) - boff
;
24611 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24613 pcm
= get_per_char_metric (font
, &char2b
);
24614 if (pcm
->width
== 0
24615 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24621 it
->phys_ascent
= pcm
->ascent
+ boff
;
24622 it
->phys_descent
= pcm
->descent
- boff
;
24623 it
->pixel_width
= pcm
->width
;
24627 it
->glyph_not_available_p
= 1;
24628 it
->phys_ascent
= it
->ascent
;
24629 it
->phys_descent
= it
->descent
;
24630 it
->pixel_width
= font
->space_width
;
24633 if (it
->constrain_row_ascent_descent_p
)
24635 if (it
->descent
> it
->max_descent
)
24637 it
->ascent
+= it
->descent
- it
->max_descent
;
24638 it
->descent
= it
->max_descent
;
24640 if (it
->ascent
> it
->max_ascent
)
24642 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24643 it
->ascent
= it
->max_ascent
;
24645 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24646 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24647 extra_line_spacing
= 0;
24650 /* If this is a space inside a region of text with
24651 `space-width' property, change its width. */
24652 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24654 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24656 /* If face has a box, add the box thickness to the character
24657 height. If character has a box line to the left and/or
24658 right, add the box line width to the character's width. */
24659 if (face
->box
!= FACE_NO_BOX
)
24661 int thick
= face
->box_line_width
;
24665 it
->ascent
+= thick
;
24666 it
->descent
+= thick
;
24671 if (it
->start_of_box_run_p
)
24672 it
->pixel_width
+= thick
;
24673 if (it
->end_of_box_run_p
)
24674 it
->pixel_width
+= thick
;
24677 /* If face has an overline, add the height of the overline
24678 (1 pixel) and a 1 pixel margin to the character height. */
24679 if (face
->overline_p
)
24680 it
->ascent
+= overline_margin
;
24682 if (it
->constrain_row_ascent_descent_p
)
24684 if (it
->ascent
> it
->max_ascent
)
24685 it
->ascent
= it
->max_ascent
;
24686 if (it
->descent
> it
->max_descent
)
24687 it
->descent
= it
->max_descent
;
24690 take_vertical_position_into_account (it
);
24692 /* If we have to actually produce glyphs, do it. */
24697 /* Translate a space with a `space-width' property
24698 into a stretch glyph. */
24699 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24700 / FONT_HEIGHT (font
));
24701 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24702 it
->ascent
+ it
->descent
, ascent
);
24707 /* If characters with lbearing or rbearing are displayed
24708 in this line, record that fact in a flag of the
24709 glyph row. This is used to optimize X output code. */
24710 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24711 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24713 if (! stretched_p
&& it
->pixel_width
== 0)
24714 /* We assure that all visible glyphs have at least 1-pixel
24716 it
->pixel_width
= 1;
24718 else if (it
->char_to_display
== '\n')
24720 /* A newline has no width, but we need the height of the
24721 line. But if previous part of the line sets a height,
24722 don't increase that height */
24724 Lisp_Object height
;
24725 Lisp_Object total_height
= Qnil
;
24727 it
->override_ascent
= -1;
24728 it
->pixel_width
= 0;
24731 height
= get_it_property (it
, Qline_height
);
24732 /* Split (line-height total-height) list */
24734 && CONSP (XCDR (height
))
24735 && NILP (XCDR (XCDR (height
))))
24737 total_height
= XCAR (XCDR (height
));
24738 height
= XCAR (height
);
24740 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24742 if (it
->override_ascent
>= 0)
24744 it
->ascent
= it
->override_ascent
;
24745 it
->descent
= it
->override_descent
;
24746 boff
= it
->override_boff
;
24750 it
->ascent
= FONT_BASE (font
) + boff
;
24751 it
->descent
= FONT_DESCENT (font
) - boff
;
24754 if (EQ (height
, Qt
))
24756 if (it
->descent
> it
->max_descent
)
24758 it
->ascent
+= it
->descent
- it
->max_descent
;
24759 it
->descent
= it
->max_descent
;
24761 if (it
->ascent
> it
->max_ascent
)
24763 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24764 it
->ascent
= it
->max_ascent
;
24766 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24767 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24768 it
->constrain_row_ascent_descent_p
= 1;
24769 extra_line_spacing
= 0;
24773 Lisp_Object spacing
;
24775 it
->phys_ascent
= it
->ascent
;
24776 it
->phys_descent
= it
->descent
;
24778 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24779 && face
->box
!= FACE_NO_BOX
24780 && face
->box_line_width
> 0)
24782 it
->ascent
+= face
->box_line_width
;
24783 it
->descent
+= face
->box_line_width
;
24786 && XINT (height
) > it
->ascent
+ it
->descent
)
24787 it
->ascent
= XINT (height
) - it
->descent
;
24789 if (!NILP (total_height
))
24790 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24793 spacing
= get_it_property (it
, Qline_spacing
);
24794 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24796 if (INTEGERP (spacing
))
24798 extra_line_spacing
= XINT (spacing
);
24799 if (!NILP (total_height
))
24800 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24804 else /* i.e. (it->char_to_display == '\t') */
24806 if (font
->space_width
> 0)
24808 int tab_width
= it
->tab_width
* font
->space_width
;
24809 int x
= it
->current_x
+ it
->continuation_lines_width
;
24810 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24812 /* If the distance from the current position to the next tab
24813 stop is less than a space character width, use the
24814 tab stop after that. */
24815 if (next_tab_x
- x
< font
->space_width
)
24816 next_tab_x
+= tab_width
;
24818 it
->pixel_width
= next_tab_x
- x
;
24820 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24821 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24825 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24826 it
->ascent
+ it
->descent
, it
->ascent
);
24831 it
->pixel_width
= 0;
24836 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24838 /* A static composition.
24840 Note: A composition is represented as one glyph in the
24841 glyph matrix. There are no padding glyphs.
24843 Important note: pixel_width, ascent, and descent are the
24844 values of what is drawn by draw_glyphs (i.e. the values of
24845 the overall glyphs composed). */
24846 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24847 int boff
; /* baseline offset */
24848 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24849 int glyph_len
= cmp
->glyph_len
;
24850 struct font
*font
= face
->font
;
24854 /* If we have not yet calculated pixel size data of glyphs of
24855 the composition for the current face font, calculate them
24856 now. Theoretically, we have to check all fonts for the
24857 glyphs, but that requires much time and memory space. So,
24858 here we check only the font of the first glyph. This may
24859 lead to incorrect display, but it's very rare, and C-l
24860 (recenter-top-bottom) can correct the display anyway. */
24861 if (! cmp
->font
|| cmp
->font
!= font
)
24863 /* Ascent and descent of the font of the first character
24864 of this composition (adjusted by baseline offset).
24865 Ascent and descent of overall glyphs should not be less
24866 than these, respectively. */
24867 int font_ascent
, font_descent
, font_height
;
24868 /* Bounding box of the overall glyphs. */
24869 int leftmost
, rightmost
, lowest
, highest
;
24870 int lbearing
, rbearing
;
24871 int i
, width
, ascent
, descent
;
24872 int left_padded
= 0, right_padded
= 0;
24873 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24875 struct font_metrics
*pcm
;
24876 int font_not_found_p
;
24879 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24880 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24882 if (glyph_len
< cmp
->glyph_len
)
24884 for (i
= 0; i
< glyph_len
; i
++)
24886 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24888 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24893 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24894 : IT_CHARPOS (*it
));
24895 /* If no suitable font is found, use the default font. */
24896 font_not_found_p
= font
== NULL
;
24897 if (font_not_found_p
)
24899 face
= face
->ascii_face
;
24902 boff
= font
->baseline_offset
;
24903 if (font
->vertical_centering
)
24904 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24905 font_ascent
= FONT_BASE (font
) + boff
;
24906 font_descent
= FONT_DESCENT (font
) - boff
;
24907 font_height
= FONT_HEIGHT (font
);
24912 if (! font_not_found_p
)
24914 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24916 pcm
= get_per_char_metric (font
, &char2b
);
24919 /* Initialize the bounding box. */
24922 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
24923 ascent
= pcm
->ascent
;
24924 descent
= pcm
->descent
;
24925 lbearing
= pcm
->lbearing
;
24926 rbearing
= pcm
->rbearing
;
24930 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
24931 ascent
= FONT_BASE (font
);
24932 descent
= FONT_DESCENT (font
);
24939 lowest
= - descent
+ boff
;
24940 highest
= ascent
+ boff
;
24942 if (! font_not_found_p
24943 && font
->default_ascent
24944 && CHAR_TABLE_P (Vuse_default_ascent
)
24945 && !NILP (Faref (Vuse_default_ascent
,
24946 make_number (it
->char_to_display
))))
24947 highest
= font
->default_ascent
+ boff
;
24949 /* Draw the first glyph at the normal position. It may be
24950 shifted to right later if some other glyphs are drawn
24952 cmp
->offsets
[i
* 2] = 0;
24953 cmp
->offsets
[i
* 2 + 1] = boff
;
24954 cmp
->lbearing
= lbearing
;
24955 cmp
->rbearing
= rbearing
;
24957 /* Set cmp->offsets for the remaining glyphs. */
24958 for (i
++; i
< glyph_len
; i
++)
24960 int left
, right
, btm
, top
;
24961 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24963 struct face
*this_face
;
24967 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24968 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24969 font
= this_face
->font
;
24975 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24977 pcm
= get_per_char_metric (font
, &char2b
);
24980 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24983 width
= pcm
->width
;
24984 ascent
= pcm
->ascent
;
24985 descent
= pcm
->descent
;
24986 lbearing
= pcm
->lbearing
;
24987 rbearing
= pcm
->rbearing
;
24988 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24990 /* Relative composition with or without
24991 alternate chars. */
24992 left
= (leftmost
+ rightmost
- width
) / 2;
24993 btm
= - descent
+ boff
;
24994 if (font
->relative_compose
24995 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24996 || NILP (Faref (Vignore_relative_composition
,
24997 make_number (ch
)))))
25000 if (- descent
>= font
->relative_compose
)
25001 /* One extra pixel between two glyphs. */
25003 else if (ascent
<= 0)
25004 /* One extra pixel between two glyphs. */
25005 btm
= lowest
- 1 - ascent
- descent
;
25010 /* A composition rule is specified by an integer
25011 value that encodes global and new reference
25012 points (GREF and NREF). GREF and NREF are
25013 specified by numbers as below:
25015 0---1---2 -- ascent
25019 9--10--11 -- center
25021 ---3---4---5--- baseline
25023 6---7---8 -- descent
25025 int rule
= COMPOSITION_RULE (cmp
, i
);
25026 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
25028 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
25029 grefx
= gref
% 3, nrefx
= nref
% 3;
25030 grefy
= gref
/ 3, nrefy
= nref
/ 3;
25032 xoff
= font_height
* (xoff
- 128) / 256;
25034 yoff
= font_height
* (yoff
- 128) / 256;
25037 + grefx
* (rightmost
- leftmost
) / 2
25038 - nrefx
* width
/ 2
25041 btm
= ((grefy
== 0 ? highest
25043 : grefy
== 2 ? lowest
25044 : (highest
+ lowest
) / 2)
25045 - (nrefy
== 0 ? ascent
+ descent
25046 : nrefy
== 1 ? descent
- boff
25048 : (ascent
+ descent
) / 2)
25052 cmp
->offsets
[i
* 2] = left
;
25053 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
25055 /* Update the bounding box of the overall glyphs. */
25058 right
= left
+ width
;
25059 if (left
< leftmost
)
25061 if (right
> rightmost
)
25064 top
= btm
+ descent
+ ascent
;
25070 if (cmp
->lbearing
> left
+ lbearing
)
25071 cmp
->lbearing
= left
+ lbearing
;
25072 if (cmp
->rbearing
< left
+ rbearing
)
25073 cmp
->rbearing
= left
+ rbearing
;
25077 /* If there are glyphs whose x-offsets are negative,
25078 shift all glyphs to the right and make all x-offsets
25082 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25083 cmp
->offsets
[i
* 2] -= leftmost
;
25084 rightmost
-= leftmost
;
25085 cmp
->lbearing
-= leftmost
;
25086 cmp
->rbearing
-= leftmost
;
25089 if (left_padded
&& cmp
->lbearing
< 0)
25091 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25092 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
25093 rightmost
-= cmp
->lbearing
;
25094 cmp
->rbearing
-= cmp
->lbearing
;
25097 if (right_padded
&& rightmost
< cmp
->rbearing
)
25099 rightmost
= cmp
->rbearing
;
25102 cmp
->pixel_width
= rightmost
;
25103 cmp
->ascent
= highest
;
25104 cmp
->descent
= - lowest
;
25105 if (cmp
->ascent
< font_ascent
)
25106 cmp
->ascent
= font_ascent
;
25107 if (cmp
->descent
< font_descent
)
25108 cmp
->descent
= font_descent
;
25112 && (cmp
->lbearing
< 0
25113 || cmp
->rbearing
> cmp
->pixel_width
))
25114 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25116 it
->pixel_width
= cmp
->pixel_width
;
25117 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
25118 it
->descent
= it
->phys_descent
= cmp
->descent
;
25119 if (face
->box
!= FACE_NO_BOX
)
25121 int thick
= face
->box_line_width
;
25125 it
->ascent
+= thick
;
25126 it
->descent
+= thick
;
25131 if (it
->start_of_box_run_p
)
25132 it
->pixel_width
+= thick
;
25133 if (it
->end_of_box_run_p
)
25134 it
->pixel_width
+= thick
;
25137 /* If face has an overline, add the height of the overline
25138 (1 pixel) and a 1 pixel margin to the character height. */
25139 if (face
->overline_p
)
25140 it
->ascent
+= overline_margin
;
25142 take_vertical_position_into_account (it
);
25143 if (it
->ascent
< 0)
25145 if (it
->descent
< 0)
25148 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
25149 append_composite_glyph (it
);
25151 else if (it
->what
== IT_COMPOSITION
)
25153 /* A dynamic (automatic) composition. */
25154 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25155 Lisp_Object gstring
;
25156 struct font_metrics metrics
;
25160 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
25162 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
25165 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
25166 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25167 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
25168 it
->descent
= it
->phys_descent
= metrics
.descent
;
25169 if (face
->box
!= FACE_NO_BOX
)
25171 int thick
= face
->box_line_width
;
25175 it
->ascent
+= thick
;
25176 it
->descent
+= thick
;
25181 if (it
->start_of_box_run_p
)
25182 it
->pixel_width
+= thick
;
25183 if (it
->end_of_box_run_p
)
25184 it
->pixel_width
+= thick
;
25186 /* If face has an overline, add the height of the overline
25187 (1 pixel) and a 1 pixel margin to the character height. */
25188 if (face
->overline_p
)
25189 it
->ascent
+= overline_margin
;
25190 take_vertical_position_into_account (it
);
25191 if (it
->ascent
< 0)
25193 if (it
->descent
< 0)
25197 append_composite_glyph (it
);
25199 else if (it
->what
== IT_GLYPHLESS
)
25200 produce_glyphless_glyph (it
, 0, Qnil
);
25201 else if (it
->what
== IT_IMAGE
)
25202 produce_image_glyph (it
);
25203 else if (it
->what
== IT_STRETCH
)
25204 produce_stretch_glyph (it
);
25207 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25208 because this isn't true for images with `:ascent 100'. */
25209 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
25210 if (it
->area
== TEXT_AREA
)
25211 it
->current_x
+= it
->pixel_width
;
25213 if (extra_line_spacing
> 0)
25215 it
->descent
+= extra_line_spacing
;
25216 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25217 it
->max_extra_line_spacing
= extra_line_spacing
;
25220 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25221 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25222 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25223 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25227 Output LEN glyphs starting at START at the nominal cursor position.
25228 Advance the nominal cursor over the text. The global variable
25229 updated_window contains the window being updated, updated_row is
25230 the glyph row being updated, and updated_area is the area of that
25231 row being updated. */
25234 x_write_glyphs (struct glyph
*start
, int len
)
25236 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25238 eassert (updated_window
&& updated_row
);
25239 /* When the window is hscrolled, cursor hpos can legitimately be out
25240 of bounds, but we draw the cursor at the corresponding window
25241 margin in that case. */
25242 if (!updated_row
->reversed_p
&& chpos
< 0)
25244 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25245 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25249 /* Write glyphs. */
25251 hpos
= start
- updated_row
->glyphs
[updated_area
];
25252 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25253 updated_row
, updated_area
,
25255 DRAW_NORMAL_TEXT
, 0);
25257 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25258 if (updated_area
== TEXT_AREA
25259 && updated_window
->phys_cursor_on_p
25260 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25262 && chpos
< hpos
+ len
)
25263 updated_window
->phys_cursor_on_p
= 0;
25267 /* Advance the output cursor. */
25268 output_cursor
.hpos
+= len
;
25269 output_cursor
.x
= x
;
25274 Insert LEN glyphs from START at the nominal cursor position. */
25277 x_insert_glyphs (struct glyph
*start
, int len
)
25281 int line_height
, shift_by_width
, shifted_region_width
;
25282 struct glyph_row
*row
;
25283 struct glyph
*glyph
;
25284 int frame_x
, frame_y
;
25287 eassert (updated_window
&& updated_row
);
25289 w
= updated_window
;
25290 f
= XFRAME (WINDOW_FRAME (w
));
25292 /* Get the height of the line we are in. */
25294 line_height
= row
->height
;
25296 /* Get the width of the glyphs to insert. */
25297 shift_by_width
= 0;
25298 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25299 shift_by_width
+= glyph
->pixel_width
;
25301 /* Get the width of the region to shift right. */
25302 shifted_region_width
= (window_box_width (w
, updated_area
)
25307 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25308 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25310 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25311 line_height
, shift_by_width
);
25313 /* Write the glyphs. */
25314 hpos
= start
- row
->glyphs
[updated_area
];
25315 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25317 DRAW_NORMAL_TEXT
, 0);
25319 /* Advance the output cursor. */
25320 output_cursor
.hpos
+= len
;
25321 output_cursor
.x
+= shift_by_width
;
25327 Erase the current text line from the nominal cursor position
25328 (inclusive) to pixel column TO_X (exclusive). The idea is that
25329 everything from TO_X onward is already erased.
25331 TO_X is a pixel position relative to updated_area of
25332 updated_window. TO_X == -1 means clear to the end of this area. */
25335 x_clear_end_of_line (int to_x
)
25338 struct window
*w
= updated_window
;
25339 int max_x
, min_y
, max_y
;
25340 int from_x
, from_y
, to_y
;
25342 eassert (updated_window
&& updated_row
);
25343 f
= XFRAME (w
->frame
);
25345 if (updated_row
->full_width_p
)
25346 max_x
= WINDOW_TOTAL_WIDTH (w
);
25348 max_x
= window_box_width (w
, updated_area
);
25349 max_y
= window_text_bottom_y (w
);
25351 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25352 of window. For TO_X > 0, truncate to end of drawing area. */
25358 to_x
= min (to_x
, max_x
);
25360 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25362 /* Notice if the cursor will be cleared by this operation. */
25363 if (!updated_row
->full_width_p
)
25364 notice_overwritten_cursor (w
, updated_area
,
25365 output_cursor
.x
, -1,
25367 MATRIX_ROW_BOTTOM_Y (updated_row
));
25369 from_x
= output_cursor
.x
;
25371 /* Translate to frame coordinates. */
25372 if (updated_row
->full_width_p
)
25374 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25375 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25379 int area_left
= window_box_left (w
, updated_area
);
25380 from_x
+= area_left
;
25384 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25385 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25386 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25388 /* Prevent inadvertently clearing to end of the X window. */
25389 if (to_x
> from_x
&& to_y
> from_y
)
25392 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25393 to_x
- from_x
, to_y
- from_y
);
25398 #endif /* HAVE_WINDOW_SYSTEM */
25402 /***********************************************************************
25404 ***********************************************************************/
25406 /* Value is the internal representation of the specified cursor type
25407 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25408 of the bar cursor. */
25410 static enum text_cursor_kinds
25411 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25413 enum text_cursor_kinds type
;
25418 if (EQ (arg
, Qbox
))
25419 return FILLED_BOX_CURSOR
;
25421 if (EQ (arg
, Qhollow
))
25422 return HOLLOW_BOX_CURSOR
;
25424 if (EQ (arg
, Qbar
))
25431 && EQ (XCAR (arg
), Qbar
)
25432 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25434 *width
= XINT (XCDR (arg
));
25438 if (EQ (arg
, Qhbar
))
25441 return HBAR_CURSOR
;
25445 && EQ (XCAR (arg
), Qhbar
)
25446 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25448 *width
= XINT (XCDR (arg
));
25449 return HBAR_CURSOR
;
25452 /* Treat anything unknown as "hollow box cursor".
25453 It was bad to signal an error; people have trouble fixing
25454 .Xdefaults with Emacs, when it has something bad in it. */
25455 type
= HOLLOW_BOX_CURSOR
;
25460 /* Set the default cursor types for specified frame. */
25462 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25467 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25468 FRAME_CURSOR_WIDTH (f
) = width
;
25470 /* By default, set up the blink-off state depending on the on-state. */
25472 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25475 FRAME_BLINK_OFF_CURSOR (f
)
25476 = get_specified_cursor_type (XCDR (tem
), &width
);
25477 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25480 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25484 #ifdef HAVE_WINDOW_SYSTEM
25486 /* Return the cursor we want to be displayed in window W. Return
25487 width of bar/hbar cursor through WIDTH arg. Return with
25488 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25489 (i.e. if the `system caret' should track this cursor).
25491 In a mini-buffer window, we want the cursor only to appear if we
25492 are reading input from this window. For the selected window, we
25493 want the cursor type given by the frame parameter or buffer local
25494 setting of cursor-type. If explicitly marked off, draw no cursor.
25495 In all other cases, we want a hollow box cursor. */
25497 static enum text_cursor_kinds
25498 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25499 int *active_cursor
)
25501 struct frame
*f
= XFRAME (w
->frame
);
25502 struct buffer
*b
= XBUFFER (w
->buffer
);
25503 int cursor_type
= DEFAULT_CURSOR
;
25504 Lisp_Object alt_cursor
;
25505 int non_selected
= 0;
25507 *active_cursor
= 1;
25510 if (cursor_in_echo_area
25511 && FRAME_HAS_MINIBUF_P (f
)
25512 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25514 if (w
== XWINDOW (echo_area_window
))
25516 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25518 *width
= FRAME_CURSOR_WIDTH (f
);
25519 return FRAME_DESIRED_CURSOR (f
);
25522 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25525 *active_cursor
= 0;
25529 /* Detect a nonselected window or nonselected frame. */
25530 else if (w
!= XWINDOW (f
->selected_window
)
25531 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25533 *active_cursor
= 0;
25535 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25541 /* Never display a cursor in a window in which cursor-type is nil. */
25542 if (NILP (BVAR (b
, cursor_type
)))
25545 /* Get the normal cursor type for this window. */
25546 if (EQ (BVAR (b
, cursor_type
), Qt
))
25548 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25549 *width
= FRAME_CURSOR_WIDTH (f
);
25552 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25554 /* Use cursor-in-non-selected-windows instead
25555 for non-selected window or frame. */
25558 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25559 if (!EQ (Qt
, alt_cursor
))
25560 return get_specified_cursor_type (alt_cursor
, width
);
25561 /* t means modify the normal cursor type. */
25562 if (cursor_type
== FILLED_BOX_CURSOR
)
25563 cursor_type
= HOLLOW_BOX_CURSOR
;
25564 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25566 return cursor_type
;
25569 /* Use normal cursor if not blinked off. */
25570 if (!w
->cursor_off_p
)
25572 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25574 if (cursor_type
== FILLED_BOX_CURSOR
)
25576 /* Using a block cursor on large images can be very annoying.
25577 So use a hollow cursor for "large" images.
25578 If image is not transparent (no mask), also use hollow cursor. */
25579 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25580 if (img
!= NULL
&& IMAGEP (img
->spec
))
25582 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25583 where N = size of default frame font size.
25584 This should cover most of the "tiny" icons people may use. */
25586 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25587 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25588 cursor_type
= HOLLOW_BOX_CURSOR
;
25591 else if (cursor_type
!= NO_CURSOR
)
25593 /* Display current only supports BOX and HOLLOW cursors for images.
25594 So for now, unconditionally use a HOLLOW cursor when cursor is
25595 not a solid box cursor. */
25596 cursor_type
= HOLLOW_BOX_CURSOR
;
25599 return cursor_type
;
25602 /* Cursor is blinked off, so determine how to "toggle" it. */
25604 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25605 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25606 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25608 /* Then see if frame has specified a specific blink off cursor type. */
25609 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25611 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25612 return FRAME_BLINK_OFF_CURSOR (f
);
25616 /* Some people liked having a permanently visible blinking cursor,
25617 while others had very strong opinions against it. So it was
25618 decided to remove it. KFS 2003-09-03 */
25620 /* Finally perform built-in cursor blinking:
25621 filled box <-> hollow box
25622 wide [h]bar <-> narrow [h]bar
25623 narrow [h]bar <-> no cursor
25624 other type <-> no cursor */
25626 if (cursor_type
== FILLED_BOX_CURSOR
)
25627 return HOLLOW_BOX_CURSOR
;
25629 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25632 return cursor_type
;
25640 /* Notice when the text cursor of window W has been completely
25641 overwritten by a drawing operation that outputs glyphs in AREA
25642 starting at X0 and ending at X1 in the line starting at Y0 and
25643 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25644 the rest of the line after X0 has been written. Y coordinates
25645 are window-relative. */
25648 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25649 int x0
, int x1
, int y0
, int y1
)
25651 int cx0
, cx1
, cy0
, cy1
;
25652 struct glyph_row
*row
;
25654 if (!w
->phys_cursor_on_p
)
25656 if (area
!= TEXT_AREA
)
25659 if (w
->phys_cursor
.vpos
< 0
25660 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25661 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25662 !(row
->enabled_p
&& row
->displays_text_p
)))
25665 if (row
->cursor_in_fringe_p
)
25667 row
->cursor_in_fringe_p
= 0;
25668 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25669 w
->phys_cursor_on_p
= 0;
25673 cx0
= w
->phys_cursor
.x
;
25674 cx1
= cx0
+ w
->phys_cursor_width
;
25675 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25678 /* The cursor image will be completely removed from the
25679 screen if the output area intersects the cursor area in
25680 y-direction. When we draw in [y0 y1[, and some part of
25681 the cursor is at y < y0, that part must have been drawn
25682 before. When scrolling, the cursor is erased before
25683 actually scrolling, so we don't come here. When not
25684 scrolling, the rows above the old cursor row must have
25685 changed, and in this case these rows must have written
25686 over the cursor image.
25688 Likewise if part of the cursor is below y1, with the
25689 exception of the cursor being in the first blank row at
25690 the buffer and window end because update_text_area
25691 doesn't draw that row. (Except when it does, but
25692 that's handled in update_text_area.) */
25694 cy0
= w
->phys_cursor
.y
;
25695 cy1
= cy0
+ w
->phys_cursor_height
;
25696 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25699 w
->phys_cursor_on_p
= 0;
25702 #endif /* HAVE_WINDOW_SYSTEM */
25705 /************************************************************************
25707 ************************************************************************/
25709 #ifdef HAVE_WINDOW_SYSTEM
25712 Fix the display of area AREA of overlapping row ROW in window W
25713 with respect to the overlapping part OVERLAPS. */
25716 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25717 enum glyph_row_area area
, int overlaps
)
25724 for (i
= 0; i
< row
->used
[area
];)
25726 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25728 int start
= i
, start_x
= x
;
25732 x
+= row
->glyphs
[area
][i
].pixel_width
;
25735 while (i
< row
->used
[area
]
25736 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25738 draw_glyphs (w
, start_x
, row
, area
,
25740 DRAW_NORMAL_TEXT
, overlaps
);
25744 x
+= row
->glyphs
[area
][i
].pixel_width
;
25754 Draw the cursor glyph of window W in glyph row ROW. See the
25755 comment of draw_glyphs for the meaning of HL. */
25758 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25759 enum draw_glyphs_face hl
)
25761 /* If cursor hpos is out of bounds, don't draw garbage. This can
25762 happen in mini-buffer windows when switching between echo area
25763 glyphs and mini-buffer. */
25764 if ((row
->reversed_p
25765 ? (w
->phys_cursor
.hpos
>= 0)
25766 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25768 int on_p
= w
->phys_cursor_on_p
;
25770 int hpos
= w
->phys_cursor
.hpos
;
25772 /* When the window is hscrolled, cursor hpos can legitimately be
25773 out of bounds, but we draw the cursor at the corresponding
25774 window margin in that case. */
25775 if (!row
->reversed_p
&& hpos
< 0)
25777 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25778 hpos
= row
->used
[TEXT_AREA
] - 1;
25780 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25782 w
->phys_cursor_on_p
= on_p
;
25784 if (hl
== DRAW_CURSOR
)
25785 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25786 /* When we erase the cursor, and ROW is overlapped by other
25787 rows, make sure that these overlapping parts of other rows
25789 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25791 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25793 if (row
> w
->current_matrix
->rows
25794 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25795 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25796 OVERLAPS_ERASED_CURSOR
);
25798 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25799 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25800 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25801 OVERLAPS_ERASED_CURSOR
);
25808 Erase the image of a cursor of window W from the screen. */
25811 erase_phys_cursor (struct window
*w
)
25813 struct frame
*f
= XFRAME (w
->frame
);
25814 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25815 int hpos
= w
->phys_cursor
.hpos
;
25816 int vpos
= w
->phys_cursor
.vpos
;
25817 int mouse_face_here_p
= 0;
25818 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25819 struct glyph_row
*cursor_row
;
25820 struct glyph
*cursor_glyph
;
25821 enum draw_glyphs_face hl
;
25823 /* No cursor displayed or row invalidated => nothing to do on the
25825 if (w
->phys_cursor_type
== NO_CURSOR
)
25826 goto mark_cursor_off
;
25828 /* VPOS >= active_glyphs->nrows means that window has been resized.
25829 Don't bother to erase the cursor. */
25830 if (vpos
>= active_glyphs
->nrows
)
25831 goto mark_cursor_off
;
25833 /* If row containing cursor is marked invalid, there is nothing we
25835 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25836 if (!cursor_row
->enabled_p
)
25837 goto mark_cursor_off
;
25839 /* If line spacing is > 0, old cursor may only be partially visible in
25840 window after split-window. So adjust visible height. */
25841 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25842 window_text_bottom_y (w
) - cursor_row
->y
);
25844 /* If row is completely invisible, don't attempt to delete a cursor which
25845 isn't there. This can happen if cursor is at top of a window, and
25846 we switch to a buffer with a header line in that window. */
25847 if (cursor_row
->visible_height
<= 0)
25848 goto mark_cursor_off
;
25850 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25851 if (cursor_row
->cursor_in_fringe_p
)
25853 cursor_row
->cursor_in_fringe_p
= 0;
25854 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25855 goto mark_cursor_off
;
25858 /* This can happen when the new row is shorter than the old one.
25859 In this case, either draw_glyphs or clear_end_of_line
25860 should have cleared the cursor. Note that we wouldn't be
25861 able to erase the cursor in this case because we don't have a
25862 cursor glyph at hand. */
25863 if ((cursor_row
->reversed_p
25864 ? (w
->phys_cursor
.hpos
< 0)
25865 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25866 goto mark_cursor_off
;
25868 /* When the window is hscrolled, cursor hpos can legitimately be out
25869 of bounds, but we draw the cursor at the corresponding window
25870 margin in that case. */
25871 if (!cursor_row
->reversed_p
&& hpos
< 0)
25873 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25874 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25876 /* If the cursor is in the mouse face area, redisplay that when
25877 we clear the cursor. */
25878 if (! NILP (hlinfo
->mouse_face_window
)
25879 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25880 /* Don't redraw the cursor's spot in mouse face if it is at the
25881 end of a line (on a newline). The cursor appears there, but
25882 mouse highlighting does not. */
25883 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25884 mouse_face_here_p
= 1;
25886 /* Maybe clear the display under the cursor. */
25887 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25890 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25893 cursor_glyph
= get_phys_cursor_glyph (w
);
25894 if (cursor_glyph
== NULL
)
25895 goto mark_cursor_off
;
25897 width
= cursor_glyph
->pixel_width
;
25898 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25899 x
= w
->phys_cursor
.x
;
25901 width
-= left_x
- x
;
25902 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25903 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25904 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25907 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25910 /* Erase the cursor by redrawing the character underneath it. */
25911 if (mouse_face_here_p
)
25912 hl
= DRAW_MOUSE_FACE
;
25914 hl
= DRAW_NORMAL_TEXT
;
25915 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25918 w
->phys_cursor_on_p
= 0;
25919 w
->phys_cursor_type
= NO_CURSOR
;
25924 Display or clear cursor of window W. If ON is zero, clear the
25925 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25926 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25929 display_and_set_cursor (struct window
*w
, int on
,
25930 int hpos
, int vpos
, int x
, int y
)
25932 struct frame
*f
= XFRAME (w
->frame
);
25933 int new_cursor_type
;
25934 int new_cursor_width
;
25936 struct glyph_row
*glyph_row
;
25937 struct glyph
*glyph
;
25939 /* This is pointless on invisible frames, and dangerous on garbaged
25940 windows and frames; in the latter case, the frame or window may
25941 be in the midst of changing its size, and x and y may be off the
25943 if (! FRAME_VISIBLE_P (f
)
25944 || FRAME_GARBAGED_P (f
)
25945 || vpos
>= w
->current_matrix
->nrows
25946 || hpos
>= w
->current_matrix
->matrix_w
)
25949 /* If cursor is off and we want it off, return quickly. */
25950 if (!on
&& !w
->phys_cursor_on_p
)
25953 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25954 /* If cursor row is not enabled, we don't really know where to
25955 display the cursor. */
25956 if (!glyph_row
->enabled_p
)
25958 w
->phys_cursor_on_p
= 0;
25963 if (!glyph_row
->exact_window_width_line_p
25964 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25965 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25967 eassert (input_blocked_p ());
25969 /* Set new_cursor_type to the cursor we want to be displayed. */
25970 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25971 &new_cursor_width
, &active_cursor
);
25973 /* If cursor is currently being shown and we don't want it to be or
25974 it is in the wrong place, or the cursor type is not what we want,
25976 if (w
->phys_cursor_on_p
25978 || w
->phys_cursor
.x
!= x
25979 || w
->phys_cursor
.y
!= y
25980 || new_cursor_type
!= w
->phys_cursor_type
25981 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25982 && new_cursor_width
!= w
->phys_cursor_width
)))
25983 erase_phys_cursor (w
);
25985 /* Don't check phys_cursor_on_p here because that flag is only set
25986 to zero in some cases where we know that the cursor has been
25987 completely erased, to avoid the extra work of erasing the cursor
25988 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25989 still not be visible, or it has only been partly erased. */
25992 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25993 w
->phys_cursor_height
= glyph_row
->height
;
25995 /* Set phys_cursor_.* before x_draw_.* is called because some
25996 of them may need the information. */
25997 w
->phys_cursor
.x
= x
;
25998 w
->phys_cursor
.y
= glyph_row
->y
;
25999 w
->phys_cursor
.hpos
= hpos
;
26000 w
->phys_cursor
.vpos
= vpos
;
26003 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
26004 new_cursor_type
, new_cursor_width
,
26005 on
, active_cursor
);
26009 /* Switch the display of W's cursor on or off, according to the value
26013 update_window_cursor (struct window
*w
, int on
)
26015 /* Don't update cursor in windows whose frame is in the process
26016 of being deleted. */
26017 if (w
->current_matrix
)
26019 int hpos
= w
->phys_cursor
.hpos
;
26020 int vpos
= w
->phys_cursor
.vpos
;
26021 struct glyph_row
*row
;
26023 if (vpos
>= w
->current_matrix
->nrows
26024 || hpos
>= w
->current_matrix
->matrix_w
)
26027 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26029 /* When the window is hscrolled, cursor hpos can legitimately be
26030 out of bounds, but we draw the cursor at the corresponding
26031 window margin in that case. */
26032 if (!row
->reversed_p
&& hpos
< 0)
26034 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26035 hpos
= row
->used
[TEXT_AREA
] - 1;
26038 display_and_set_cursor (w
, on
, hpos
, vpos
,
26039 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26045 /* Call update_window_cursor with parameter ON_P on all leaf windows
26046 in the window tree rooted at W. */
26049 update_cursor_in_window_tree (struct window
*w
, int on_p
)
26053 if (!NILP (w
->hchild
))
26054 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
26055 else if (!NILP (w
->vchild
))
26056 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
26058 update_window_cursor (w
, on_p
);
26060 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
26066 Display the cursor on window W, or clear it, according to ON_P.
26067 Don't change the cursor's position. */
26070 x_update_cursor (struct frame
*f
, int on_p
)
26072 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
26077 Clear the cursor of window W to background color, and mark the
26078 cursor as not shown. This is used when the text where the cursor
26079 is about to be rewritten. */
26082 x_clear_cursor (struct window
*w
)
26084 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
26085 update_window_cursor (w
, 0);
26088 #endif /* HAVE_WINDOW_SYSTEM */
26090 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26093 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
26094 int start_hpos
, int end_hpos
,
26095 enum draw_glyphs_face draw
)
26097 #ifdef HAVE_WINDOW_SYSTEM
26098 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
26100 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
26104 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26105 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
26109 /* Display the active region described by mouse_face_* according to DRAW. */
26112 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
26114 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
26115 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26117 if (/* If window is in the process of being destroyed, don't bother
26119 w
->current_matrix
!= NULL
26120 /* Don't update mouse highlight if hidden */
26121 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
26122 /* Recognize when we are called to operate on rows that don't exist
26123 anymore. This can happen when a window is split. */
26124 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
26126 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
26127 struct glyph_row
*row
, *first
, *last
;
26129 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
26130 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
26132 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
26134 int start_hpos
, end_hpos
, start_x
;
26136 /* For all but the first row, the highlight starts at column 0. */
26139 /* R2L rows have BEG and END in reversed order, but the
26140 screen drawing geometry is always left to right. So
26141 we need to mirror the beginning and end of the
26142 highlighted area in R2L rows. */
26143 if (!row
->reversed_p
)
26145 start_hpos
= hlinfo
->mouse_face_beg_col
;
26146 start_x
= hlinfo
->mouse_face_beg_x
;
26148 else if (row
== last
)
26150 start_hpos
= hlinfo
->mouse_face_end_col
;
26151 start_x
= hlinfo
->mouse_face_end_x
;
26159 else if (row
->reversed_p
&& row
== last
)
26161 start_hpos
= hlinfo
->mouse_face_end_col
;
26162 start_x
= hlinfo
->mouse_face_end_x
;
26172 if (!row
->reversed_p
)
26173 end_hpos
= hlinfo
->mouse_face_end_col
;
26174 else if (row
== first
)
26175 end_hpos
= hlinfo
->mouse_face_beg_col
;
26178 end_hpos
= row
->used
[TEXT_AREA
];
26179 if (draw
== DRAW_NORMAL_TEXT
)
26180 row
->fill_line_p
= 1; /* Clear to end of line */
26183 else if (row
->reversed_p
&& row
== first
)
26184 end_hpos
= hlinfo
->mouse_face_beg_col
;
26187 end_hpos
= row
->used
[TEXT_AREA
];
26188 if (draw
== DRAW_NORMAL_TEXT
)
26189 row
->fill_line_p
= 1; /* Clear to end of line */
26192 if (end_hpos
> start_hpos
)
26194 draw_row_with_mouse_face (w
, start_x
, row
,
26195 start_hpos
, end_hpos
, draw
);
26198 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26202 #ifdef HAVE_WINDOW_SYSTEM
26203 /* When we've written over the cursor, arrange for it to
26204 be displayed again. */
26205 if (FRAME_WINDOW_P (f
)
26206 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26208 int hpos
= w
->phys_cursor
.hpos
;
26210 /* When the window is hscrolled, cursor hpos can legitimately be
26211 out of bounds, but we draw the cursor at the corresponding
26212 window margin in that case. */
26213 if (!row
->reversed_p
&& hpos
< 0)
26215 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26216 hpos
= row
->used
[TEXT_AREA
] - 1;
26219 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26220 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26223 #endif /* HAVE_WINDOW_SYSTEM */
26226 #ifdef HAVE_WINDOW_SYSTEM
26227 /* Change the mouse cursor. */
26228 if (FRAME_WINDOW_P (f
))
26230 if (draw
== DRAW_NORMAL_TEXT
26231 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26232 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26233 else if (draw
== DRAW_MOUSE_FACE
)
26234 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26236 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26238 #endif /* HAVE_WINDOW_SYSTEM */
26242 Clear out the mouse-highlighted active region.
26243 Redraw it un-highlighted first. Value is non-zero if mouse
26244 face was actually drawn unhighlighted. */
26247 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26251 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26253 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26257 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26258 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26259 hlinfo
->mouse_face_window
= Qnil
;
26260 hlinfo
->mouse_face_overlay
= Qnil
;
26264 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26265 within the mouse face on that window. */
26267 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26269 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26271 /* Quickly resolve the easy cases. */
26272 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26273 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26275 if (vpos
< hlinfo
->mouse_face_beg_row
26276 || vpos
> hlinfo
->mouse_face_end_row
)
26278 if (vpos
> hlinfo
->mouse_face_beg_row
26279 && vpos
< hlinfo
->mouse_face_end_row
)
26282 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26284 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26286 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26289 else if ((vpos
== hlinfo
->mouse_face_beg_row
26290 && hpos
>= hlinfo
->mouse_face_beg_col
)
26291 || (vpos
== hlinfo
->mouse_face_end_row
26292 && hpos
< hlinfo
->mouse_face_end_col
))
26297 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26299 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26302 else if ((vpos
== hlinfo
->mouse_face_beg_row
26303 && hpos
<= hlinfo
->mouse_face_beg_col
)
26304 || (vpos
== hlinfo
->mouse_face_end_row
26305 && hpos
> hlinfo
->mouse_face_end_col
))
26313 Non-zero if physical cursor of window W is within mouse face. */
26316 cursor_in_mouse_face_p (struct window
*w
)
26318 int hpos
= w
->phys_cursor
.hpos
;
26319 int vpos
= w
->phys_cursor
.vpos
;
26320 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26322 /* When the window is hscrolled, cursor hpos can legitimately be out
26323 of bounds, but we draw the cursor at the corresponding window
26324 margin in that case. */
26325 if (!row
->reversed_p
&& hpos
< 0)
26327 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26328 hpos
= row
->used
[TEXT_AREA
] - 1;
26330 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26335 /* Find the glyph rows START_ROW and END_ROW of window W that display
26336 characters between buffer positions START_CHARPOS and END_CHARPOS
26337 (excluding END_CHARPOS). DISP_STRING is a display string that
26338 covers these buffer positions. This is similar to
26339 row_containing_pos, but is more accurate when bidi reordering makes
26340 buffer positions change non-linearly with glyph rows. */
26342 rows_from_pos_range (struct window
*w
,
26343 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26344 Lisp_Object disp_string
,
26345 struct glyph_row
**start
, struct glyph_row
**end
)
26347 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26348 int last_y
= window_text_bottom_y (w
);
26349 struct glyph_row
*row
;
26354 while (!first
->enabled_p
26355 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26358 /* Find the START row. */
26360 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26363 /* A row can potentially be the START row if the range of the
26364 characters it displays intersects the range
26365 [START_CHARPOS..END_CHARPOS). */
26366 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26367 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26368 /* See the commentary in row_containing_pos, for the
26369 explanation of the complicated way to check whether
26370 some position is beyond the end of the characters
26371 displayed by a row. */
26372 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26373 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26374 && !row
->ends_at_zv_p
26375 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26376 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26377 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26378 && !row
->ends_at_zv_p
26379 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26381 /* Found a candidate row. Now make sure at least one of the
26382 glyphs it displays has a charpos from the range
26383 [START_CHARPOS..END_CHARPOS).
26385 This is not obvious because bidi reordering could make
26386 buffer positions of a row be 1,2,3,102,101,100, and if we
26387 want to highlight characters in [50..60), we don't want
26388 this row, even though [50..60) does intersect [1..103),
26389 the range of character positions given by the row's start
26390 and end positions. */
26391 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26392 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26396 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26397 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26398 /* A glyph that comes from DISP_STRING is by
26399 definition to be highlighted. */
26400 || EQ (g
->object
, disp_string
))
26409 /* Find the END row. */
26411 /* If the last row is partially visible, start looking for END
26412 from that row, instead of starting from FIRST. */
26413 && !(row
->enabled_p
26414 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26416 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26418 struct glyph_row
*next
= row
+ 1;
26419 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26421 if (!next
->enabled_p
26422 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26423 /* The first row >= START whose range of displayed characters
26424 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26425 is the row END + 1. */
26426 || (start_charpos
< next_start
26427 && end_charpos
< next_start
)
26428 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26429 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26430 && !next
->ends_at_zv_p
26431 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26432 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26433 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26434 && !next
->ends_at_zv_p
26435 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26442 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26443 but none of the characters it displays are in the range, it is
26445 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26446 struct glyph
*s
= g
;
26447 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26451 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26452 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26453 /* If the buffer position of the first glyph in
26454 the row is equal to END_CHARPOS, it means
26455 the last character to be highlighted is the
26456 newline of ROW, and we must consider NEXT as
26458 || (((!next
->reversed_p
&& g
== s
)
26459 || (next
->reversed_p
&& g
== e
- 1))
26460 && (g
->charpos
== end_charpos
26461 /* Special case for when NEXT is an
26462 empty line at ZV. */
26463 || (g
->charpos
== -1
26464 && !row
->ends_at_zv_p
26465 && next_start
== end_charpos
)))))
26466 /* A glyph that comes from DISP_STRING is by
26467 definition to be highlighted. */
26468 || EQ (g
->object
, disp_string
))
26477 /* The first row that ends at ZV must be the last to be
26479 else if (next
->ends_at_zv_p
)
26488 /* This function sets the mouse_face_* elements of HLINFO, assuming
26489 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26490 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26491 for the overlay or run of text properties specifying the mouse
26492 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26493 before-string and after-string that must also be highlighted.
26494 DISP_STRING, if non-nil, is a display string that may cover some
26495 or all of the highlighted text. */
26498 mouse_face_from_buffer_pos (Lisp_Object window
,
26499 Mouse_HLInfo
*hlinfo
,
26500 ptrdiff_t mouse_charpos
,
26501 ptrdiff_t start_charpos
,
26502 ptrdiff_t end_charpos
,
26503 Lisp_Object before_string
,
26504 Lisp_Object after_string
,
26505 Lisp_Object disp_string
)
26507 struct window
*w
= XWINDOW (window
);
26508 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26509 struct glyph_row
*r1
, *r2
;
26510 struct glyph
*glyph
, *end
;
26511 ptrdiff_t ignore
, pos
;
26514 eassert (NILP (disp_string
) || STRINGP (disp_string
));
26515 eassert (NILP (before_string
) || STRINGP (before_string
));
26516 eassert (NILP (after_string
) || STRINGP (after_string
));
26518 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26519 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26521 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26522 /* If the before-string or display-string contains newlines,
26523 rows_from_pos_range skips to its last row. Move back. */
26524 if (!NILP (before_string
) || !NILP (disp_string
))
26526 struct glyph_row
*prev
;
26527 while ((prev
= r1
- 1, prev
>= first
)
26528 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26529 && prev
->used
[TEXT_AREA
] > 0)
26531 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26532 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26533 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26535 || !(EQ (glyph
->object
, before_string
)
26536 || EQ (glyph
->object
, disp_string
)))
26543 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26544 hlinfo
->mouse_face_past_end
= 1;
26546 else if (!NILP (after_string
))
26548 /* If the after-string has newlines, advance to its last row. */
26549 struct glyph_row
*next
;
26550 struct glyph_row
*last
26551 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26553 for (next
= r2
+ 1;
26555 && next
->used
[TEXT_AREA
] > 0
26556 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26560 /* The rest of the display engine assumes that mouse_face_beg_row is
26561 either above mouse_face_end_row or identical to it. But with
26562 bidi-reordered continued lines, the row for START_CHARPOS could
26563 be below the row for END_CHARPOS. If so, swap the rows and store
26564 them in correct order. */
26567 struct glyph_row
*tem
= r2
;
26573 hlinfo
->mouse_face_beg_y
= r1
->y
;
26574 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26575 hlinfo
->mouse_face_end_y
= r2
->y
;
26576 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26578 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26579 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26580 could be anywhere in the row and in any order. The strategy
26581 below is to find the leftmost and the rightmost glyph that
26582 belongs to either of these 3 strings, or whose position is
26583 between START_CHARPOS and END_CHARPOS, and highlight all the
26584 glyphs between those two. This may cover more than just the text
26585 between START_CHARPOS and END_CHARPOS if the range of characters
26586 strides the bidi level boundary, e.g. if the beginning is in R2L
26587 text while the end is in L2R text or vice versa. */
26588 if (!r1
->reversed_p
)
26590 /* This row is in a left to right paragraph. Scan it left to
26592 glyph
= r1
->glyphs
[TEXT_AREA
];
26593 end
= glyph
+ r1
->used
[TEXT_AREA
];
26596 /* Skip truncation glyphs at the start of the glyph row. */
26597 if (r1
->displays_text_p
)
26599 && INTEGERP (glyph
->object
)
26600 && glyph
->charpos
< 0;
26602 x
+= glyph
->pixel_width
;
26604 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26605 or DISP_STRING, and the first glyph from buffer whose
26606 position is between START_CHARPOS and END_CHARPOS. */
26608 && !INTEGERP (glyph
->object
)
26609 && !EQ (glyph
->object
, disp_string
)
26610 && !(BUFFERP (glyph
->object
)
26611 && (glyph
->charpos
>= start_charpos
26612 && glyph
->charpos
< end_charpos
));
26615 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26616 are present at buffer positions between START_CHARPOS and
26617 END_CHARPOS, or if they come from an overlay. */
26618 if (EQ (glyph
->object
, before_string
))
26620 pos
= string_buffer_position (before_string
,
26622 /* If pos == 0, it means before_string came from an
26623 overlay, not from a buffer position. */
26624 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26627 else if (EQ (glyph
->object
, after_string
))
26629 pos
= string_buffer_position (after_string
, end_charpos
);
26630 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26633 x
+= glyph
->pixel_width
;
26635 hlinfo
->mouse_face_beg_x
= x
;
26636 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26640 /* This row is in a right to left paragraph. Scan it right to
26644 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26645 glyph
= end
+ r1
->used
[TEXT_AREA
];
26647 /* Skip truncation glyphs at the start of the glyph row. */
26648 if (r1
->displays_text_p
)
26650 && INTEGERP (glyph
->object
)
26651 && glyph
->charpos
< 0;
26655 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26656 or DISP_STRING, and the first glyph from buffer whose
26657 position is between START_CHARPOS and END_CHARPOS. */
26659 && !INTEGERP (glyph
->object
)
26660 && !EQ (glyph
->object
, disp_string
)
26661 && !(BUFFERP (glyph
->object
)
26662 && (glyph
->charpos
>= start_charpos
26663 && glyph
->charpos
< end_charpos
));
26666 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26667 are present at buffer positions between START_CHARPOS and
26668 END_CHARPOS, or if they come from an overlay. */
26669 if (EQ (glyph
->object
, before_string
))
26671 pos
= string_buffer_position (before_string
, start_charpos
);
26672 /* If pos == 0, it means before_string came from an
26673 overlay, not from a buffer position. */
26674 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26677 else if (EQ (glyph
->object
, after_string
))
26679 pos
= string_buffer_position (after_string
, end_charpos
);
26680 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26685 glyph
++; /* first glyph to the right of the highlighted area */
26686 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26687 x
+= g
->pixel_width
;
26688 hlinfo
->mouse_face_beg_x
= x
;
26689 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26692 /* If the highlight ends in a different row, compute GLYPH and END
26693 for the end row. Otherwise, reuse the values computed above for
26694 the row where the highlight begins. */
26697 if (!r2
->reversed_p
)
26699 glyph
= r2
->glyphs
[TEXT_AREA
];
26700 end
= glyph
+ r2
->used
[TEXT_AREA
];
26705 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26706 glyph
= end
+ r2
->used
[TEXT_AREA
];
26710 if (!r2
->reversed_p
)
26712 /* Skip truncation and continuation glyphs near the end of the
26713 row, and also blanks and stretch glyphs inserted by
26714 extend_face_to_end_of_line. */
26716 && INTEGERP ((end
- 1)->object
))
26718 /* Scan the rest of the glyph row from the end, looking for the
26719 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26720 DISP_STRING, or whose position is between START_CHARPOS
26724 && !INTEGERP (end
->object
)
26725 && !EQ (end
->object
, disp_string
)
26726 && !(BUFFERP (end
->object
)
26727 && (end
->charpos
>= start_charpos
26728 && end
->charpos
< end_charpos
));
26731 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26732 are present at buffer positions between START_CHARPOS and
26733 END_CHARPOS, or if they come from an overlay. */
26734 if (EQ (end
->object
, before_string
))
26736 pos
= string_buffer_position (before_string
, start_charpos
);
26737 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26740 else if (EQ (end
->object
, after_string
))
26742 pos
= string_buffer_position (after_string
, end_charpos
);
26743 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26747 /* Find the X coordinate of the last glyph to be highlighted. */
26748 for (; glyph
<= end
; ++glyph
)
26749 x
+= glyph
->pixel_width
;
26751 hlinfo
->mouse_face_end_x
= x
;
26752 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26756 /* Skip truncation and continuation glyphs near the end of the
26757 row, and also blanks and stretch glyphs inserted by
26758 extend_face_to_end_of_line. */
26762 && INTEGERP (end
->object
))
26764 x
+= end
->pixel_width
;
26767 /* Scan the rest of the glyph row from the end, looking for the
26768 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26769 DISP_STRING, or whose position is between START_CHARPOS
26773 && !INTEGERP (end
->object
)
26774 && !EQ (end
->object
, disp_string
)
26775 && !(BUFFERP (end
->object
)
26776 && (end
->charpos
>= start_charpos
26777 && end
->charpos
< end_charpos
));
26780 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26781 are present at buffer positions between START_CHARPOS and
26782 END_CHARPOS, or if they come from an overlay. */
26783 if (EQ (end
->object
, before_string
))
26785 pos
= string_buffer_position (before_string
, start_charpos
);
26786 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26789 else if (EQ (end
->object
, after_string
))
26791 pos
= string_buffer_position (after_string
, end_charpos
);
26792 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26795 x
+= end
->pixel_width
;
26797 /* If we exited the above loop because we arrived at the last
26798 glyph of the row, and its buffer position is still not in
26799 range, it means the last character in range is the preceding
26800 newline. Bump the end column and x values to get past the
26803 && BUFFERP (end
->object
)
26804 && (end
->charpos
< start_charpos
26805 || end
->charpos
>= end_charpos
))
26807 x
+= end
->pixel_width
;
26810 hlinfo
->mouse_face_end_x
= x
;
26811 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26814 hlinfo
->mouse_face_window
= window
;
26815 hlinfo
->mouse_face_face_id
26816 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26818 !hlinfo
->mouse_face_hidden
, -1);
26819 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26822 /* The following function is not used anymore (replaced with
26823 mouse_face_from_string_pos), but I leave it here for the time
26824 being, in case someone would. */
26826 #if 0 /* not used */
26828 /* Find the position of the glyph for position POS in OBJECT in
26829 window W's current matrix, and return in *X, *Y the pixel
26830 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26832 RIGHT_P non-zero means return the position of the right edge of the
26833 glyph, RIGHT_P zero means return the left edge position.
26835 If no glyph for POS exists in the matrix, return the position of
26836 the glyph with the next smaller position that is in the matrix, if
26837 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26838 exists in the matrix, return the position of the glyph with the
26839 next larger position in OBJECT.
26841 Value is non-zero if a glyph was found. */
26844 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
26845 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26847 int yb
= window_text_bottom_y (w
);
26848 struct glyph_row
*r
;
26849 struct glyph
*best_glyph
= NULL
;
26850 struct glyph_row
*best_row
= NULL
;
26853 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26854 r
->enabled_p
&& r
->y
< yb
;
26857 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26858 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26861 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26862 if (EQ (g
->object
, object
))
26864 if (g
->charpos
== pos
)
26871 else if (best_glyph
== NULL
26872 || ((eabs (g
->charpos
- pos
)
26873 < eabs (best_glyph
->charpos
- pos
))
26876 : g
->charpos
> pos
)))
26890 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26894 *x
+= best_glyph
->pixel_width
;
26899 *vpos
= best_row
- w
->current_matrix
->rows
;
26902 return best_glyph
!= NULL
;
26904 #endif /* not used */
26906 /* Find the positions of the first and the last glyphs in window W's
26907 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26908 (assumed to be a string), and return in HLINFO's mouse_face_*
26909 members the pixel and column/row coordinates of those glyphs. */
26912 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26913 Lisp_Object object
,
26914 ptrdiff_t startpos
, ptrdiff_t endpos
)
26916 int yb
= window_text_bottom_y (w
);
26917 struct glyph_row
*r
;
26918 struct glyph
*g
, *e
;
26922 /* Find the glyph row with at least one position in the range
26923 [STARTPOS..ENDPOS], and the first glyph in that row whose
26924 position belongs to that range. */
26925 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26926 r
->enabled_p
&& r
->y
< yb
;
26929 if (!r
->reversed_p
)
26931 g
= r
->glyphs
[TEXT_AREA
];
26932 e
= g
+ r
->used
[TEXT_AREA
];
26933 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26934 if (EQ (g
->object
, object
)
26935 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26937 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26938 hlinfo
->mouse_face_beg_y
= r
->y
;
26939 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26940 hlinfo
->mouse_face_beg_x
= gx
;
26949 e
= r
->glyphs
[TEXT_AREA
];
26950 g
= e
+ r
->used
[TEXT_AREA
];
26951 for ( ; g
> e
; --g
)
26952 if (EQ ((g
-1)->object
, object
)
26953 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26955 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26956 hlinfo
->mouse_face_beg_y
= r
->y
;
26957 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26958 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26959 gx
+= g1
->pixel_width
;
26960 hlinfo
->mouse_face_beg_x
= gx
;
26972 /* Starting with the next row, look for the first row which does NOT
26973 include any glyphs whose positions are in the range. */
26974 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26976 g
= r
->glyphs
[TEXT_AREA
];
26977 e
= g
+ r
->used
[TEXT_AREA
];
26979 for ( ; g
< e
; ++g
)
26980 if (EQ (g
->object
, object
)
26981 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26990 /* The highlighted region ends on the previous row. */
26993 /* Set the end row and its vertical pixel coordinate. */
26994 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26995 hlinfo
->mouse_face_end_y
= r
->y
;
26997 /* Compute and set the end column and the end column's horizontal
26998 pixel coordinate. */
26999 if (!r
->reversed_p
)
27001 g
= r
->glyphs
[TEXT_AREA
];
27002 e
= g
+ r
->used
[TEXT_AREA
];
27003 for ( ; e
> g
; --e
)
27004 if (EQ ((e
-1)->object
, object
)
27005 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
27007 hlinfo
->mouse_face_end_col
= e
- g
;
27009 for (gx
= r
->x
; g
< e
; ++g
)
27010 gx
+= g
->pixel_width
;
27011 hlinfo
->mouse_face_end_x
= gx
;
27015 e
= r
->glyphs
[TEXT_AREA
];
27016 g
= e
+ r
->used
[TEXT_AREA
];
27017 for (gx
= r
->x
; e
< g
; ++e
)
27019 if (EQ (e
->object
, object
)
27020 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
27022 gx
+= e
->pixel_width
;
27024 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
27025 hlinfo
->mouse_face_end_x
= gx
;
27029 #ifdef HAVE_WINDOW_SYSTEM
27031 /* See if position X, Y is within a hot-spot of an image. */
27034 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
27036 if (!CONSP (hot_spot
))
27039 if (EQ (XCAR (hot_spot
), Qrect
))
27041 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27042 Lisp_Object rect
= XCDR (hot_spot
);
27046 if (!CONSP (XCAR (rect
)))
27048 if (!CONSP (XCDR (rect
)))
27050 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
27052 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
27054 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
27056 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
27060 else if (EQ (XCAR (hot_spot
), Qcircle
))
27062 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27063 Lisp_Object circ
= XCDR (hot_spot
);
27064 Lisp_Object lr
, lx0
, ly0
;
27066 && CONSP (XCAR (circ
))
27067 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
27068 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
27069 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
27071 double r
= XFLOATINT (lr
);
27072 double dx
= XINT (lx0
) - x
;
27073 double dy
= XINT (ly0
) - y
;
27074 return (dx
* dx
+ dy
* dy
<= r
* r
);
27077 else if (EQ (XCAR (hot_spot
), Qpoly
))
27079 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27080 if (VECTORP (XCDR (hot_spot
)))
27082 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
27083 Lisp_Object
*poly
= v
->contents
;
27084 ptrdiff_t n
= v
->header
.size
;
27087 Lisp_Object lx
, ly
;
27090 /* Need an even number of coordinates, and at least 3 edges. */
27091 if (n
< 6 || n
& 1)
27094 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27095 If count is odd, we are inside polygon. Pixels on edges
27096 may or may not be included depending on actual geometry of the
27098 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
27099 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
27101 x0
= XINT (lx
), y0
= XINT (ly
);
27102 for (i
= 0; i
< n
; i
+= 2)
27104 int x1
= x0
, y1
= y0
;
27105 if ((lx
= poly
[i
], !INTEGERP (lx
))
27106 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
27108 x0
= XINT (lx
), y0
= XINT (ly
);
27110 /* Does this segment cross the X line? */
27118 if (y
> y0
&& y
> y1
)
27120 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
27130 find_hot_spot (Lisp_Object map
, int x
, int y
)
27132 while (CONSP (map
))
27134 if (CONSP (XCAR (map
))
27135 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
27143 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
27145 doc
: /* Lookup in image map MAP coordinates X and Y.
27146 An image map is an alist where each element has the format (AREA ID PLIST).
27147 An AREA is specified as either a rectangle, a circle, or a polygon:
27148 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27149 pixel coordinates of the upper left and bottom right corners.
27150 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27151 and the radius of the circle; r may be a float or integer.
27152 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27153 vector describes one corner in the polygon.
27154 Returns the alist element for the first matching AREA in MAP. */)
27155 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
27163 return find_hot_spot (map
,
27164 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
27165 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
27169 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27171 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
27173 /* Do not change cursor shape while dragging mouse. */
27174 if (!NILP (do_mouse_tracking
))
27177 if (!NILP (pointer
))
27179 if (EQ (pointer
, Qarrow
))
27180 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27181 else if (EQ (pointer
, Qhand
))
27182 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27183 else if (EQ (pointer
, Qtext
))
27184 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27185 else if (EQ (pointer
, intern ("hdrag")))
27186 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27187 #ifdef HAVE_X_WINDOWS
27188 else if (EQ (pointer
, intern ("vdrag")))
27189 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27191 else if (EQ (pointer
, intern ("hourglass")))
27192 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27193 else if (EQ (pointer
, Qmodeline
))
27194 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27196 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27199 if (cursor
!= No_Cursor
)
27200 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27203 #endif /* HAVE_WINDOW_SYSTEM */
27205 /* Take proper action when mouse has moved to the mode or header line
27206 or marginal area AREA of window W, x-position X and y-position Y.
27207 X is relative to the start of the text display area of W, so the
27208 width of bitmap areas and scroll bars must be subtracted to get a
27209 position relative to the start of the mode line. */
27212 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27213 enum window_part area
)
27215 struct window
*w
= XWINDOW (window
);
27216 struct frame
*f
= XFRAME (w
->frame
);
27217 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27218 #ifdef HAVE_WINDOW_SYSTEM
27219 Display_Info
*dpyinfo
;
27221 Cursor cursor
= No_Cursor
;
27222 Lisp_Object pointer
= Qnil
;
27223 int dx
, dy
, width
, height
;
27225 Lisp_Object string
, object
= Qnil
;
27226 Lisp_Object pos
IF_LINT (= Qnil
), help
;
27228 Lisp_Object mouse_face
;
27229 int original_x_pixel
= x
;
27230 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27231 struct glyph_row
*row
IF_LINT (= 0);
27233 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27238 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27239 returns them in row/column units! */
27240 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27241 &object
, &dx
, &dy
, &width
, &height
);
27243 row
= (area
== ON_MODE_LINE
27244 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27245 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27247 /* Find the glyph under the mouse pointer. */
27248 if (row
->mode_line_p
&& row
->enabled_p
)
27250 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27251 end
= glyph
+ row
->used
[TEXT_AREA
];
27253 for (x0
= original_x_pixel
;
27254 glyph
< end
&& x0
>= glyph
->pixel_width
;
27256 x0
-= glyph
->pixel_width
;
27264 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27265 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27266 returns them in row/column units! */
27267 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27268 &object
, &dx
, &dy
, &width
, &height
);
27273 #ifdef HAVE_WINDOW_SYSTEM
27274 if (IMAGEP (object
))
27276 Lisp_Object image_map
, hotspot
;
27277 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27279 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27281 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27285 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27286 If so, we could look for mouse-enter, mouse-leave
27287 properties in PLIST (and do something...). */
27288 hotspot
= XCDR (hotspot
);
27289 if (CONSP (hotspot
)
27290 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27292 pointer
= Fplist_get (plist
, Qpointer
);
27293 if (NILP (pointer
))
27295 help
= Fplist_get (plist
, Qhelp_echo
);
27298 help_echo_string
= help
;
27299 XSETWINDOW (help_echo_window
, w
);
27300 help_echo_object
= w
->buffer
;
27301 help_echo_pos
= charpos
;
27305 if (NILP (pointer
))
27306 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27308 #endif /* HAVE_WINDOW_SYSTEM */
27310 if (STRINGP (string
))
27311 pos
= make_number (charpos
);
27313 /* Set the help text and mouse pointer. If the mouse is on a part
27314 of the mode line without any text (e.g. past the right edge of
27315 the mode line text), use the default help text and pointer. */
27316 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27318 /* Arrange to display the help by setting the global variables
27319 help_echo_string, help_echo_object, and help_echo_pos. */
27322 if (STRINGP (string
))
27323 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27327 help_echo_string
= help
;
27328 XSETWINDOW (help_echo_window
, w
);
27329 help_echo_object
= string
;
27330 help_echo_pos
= charpos
;
27332 else if (area
== ON_MODE_LINE
)
27334 Lisp_Object default_help
27335 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27338 if (STRINGP (default_help
))
27340 help_echo_string
= default_help
;
27341 XSETWINDOW (help_echo_window
, w
);
27342 help_echo_object
= Qnil
;
27343 help_echo_pos
= -1;
27348 #ifdef HAVE_WINDOW_SYSTEM
27349 /* Change the mouse pointer according to what is under it. */
27350 if (FRAME_WINDOW_P (f
))
27352 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27353 if (STRINGP (string
))
27355 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27357 if (NILP (pointer
))
27358 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27360 /* Change the mouse pointer according to what is under X/Y. */
27362 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27365 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27366 if (!KEYMAPP (map
))
27367 map
= Fget_text_property (pos
, Qkeymap
, string
);
27368 if (!KEYMAPP (map
))
27369 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27373 /* Default mode-line pointer. */
27374 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27379 /* Change the mouse face according to what is under X/Y. */
27380 if (STRINGP (string
))
27382 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27383 if (!NILP (mouse_face
)
27384 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27389 struct glyph
* tmp_glyph
;
27393 int total_pixel_width
;
27394 ptrdiff_t begpos
, endpos
, ignore
;
27398 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27399 Qmouse_face
, string
, Qnil
);
27405 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27407 endpos
= SCHARS (string
);
27411 /* Calculate the glyph position GPOS of GLYPH in the
27412 displayed string, relative to the beginning of the
27413 highlighted part of the string.
27415 Note: GPOS is different from CHARPOS. CHARPOS is the
27416 position of GLYPH in the internal string object. A mode
27417 line string format has structures which are converted to
27418 a flattened string by the Emacs Lisp interpreter. The
27419 internal string is an element of those structures. The
27420 displayed string is the flattened string. */
27421 tmp_glyph
= row_start_glyph
;
27422 while (tmp_glyph
< glyph
27423 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27424 && begpos
<= tmp_glyph
->charpos
27425 && tmp_glyph
->charpos
< endpos
)))
27427 gpos
= glyph
- tmp_glyph
;
27429 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27430 the highlighted part of the displayed string to which
27431 GLYPH belongs. Note: GSEQ_LENGTH is different from
27432 SCHARS (STRING), because the latter returns the length of
27433 the internal string. */
27434 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27436 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27437 && begpos
<= tmp_glyph
->charpos
27438 && tmp_glyph
->charpos
< endpos
));
27441 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27443 /* Calculate the total pixel width of all the glyphs between
27444 the beginning of the highlighted area and GLYPH. */
27445 total_pixel_width
= 0;
27446 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27447 total_pixel_width
+= tmp_glyph
->pixel_width
;
27449 /* Pre calculation of re-rendering position. Note: X is in
27450 column units here, after the call to mode_line_string or
27451 marginal_area_string. */
27453 vpos
= (area
== ON_MODE_LINE
27454 ? (w
->current_matrix
)->nrows
- 1
27457 /* If GLYPH's position is included in the region that is
27458 already drawn in mouse face, we have nothing to do. */
27459 if ( EQ (window
, hlinfo
->mouse_face_window
)
27460 && (!row
->reversed_p
27461 ? (hlinfo
->mouse_face_beg_col
<= hpos
27462 && hpos
< hlinfo
->mouse_face_end_col
)
27463 /* In R2L rows we swap BEG and END, see below. */
27464 : (hlinfo
->mouse_face_end_col
<= hpos
27465 && hpos
< hlinfo
->mouse_face_beg_col
))
27466 && hlinfo
->mouse_face_beg_row
== vpos
)
27469 if (clear_mouse_face (hlinfo
))
27470 cursor
= No_Cursor
;
27472 if (!row
->reversed_p
)
27474 hlinfo
->mouse_face_beg_col
= hpos
;
27475 hlinfo
->mouse_face_beg_x
= original_x_pixel
27476 - (total_pixel_width
+ dx
);
27477 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27478 hlinfo
->mouse_face_end_x
= 0;
27482 /* In R2L rows, show_mouse_face expects BEG and END
27483 coordinates to be swapped. */
27484 hlinfo
->mouse_face_end_col
= hpos
;
27485 hlinfo
->mouse_face_end_x
= original_x_pixel
27486 - (total_pixel_width
+ dx
);
27487 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27488 hlinfo
->mouse_face_beg_x
= 0;
27491 hlinfo
->mouse_face_beg_row
= vpos
;
27492 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27493 hlinfo
->mouse_face_beg_y
= 0;
27494 hlinfo
->mouse_face_end_y
= 0;
27495 hlinfo
->mouse_face_past_end
= 0;
27496 hlinfo
->mouse_face_window
= window
;
27498 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27504 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27506 if (NILP (pointer
))
27509 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27510 clear_mouse_face (hlinfo
);
27512 #ifdef HAVE_WINDOW_SYSTEM
27513 if (FRAME_WINDOW_P (f
))
27514 define_frame_cursor1 (f
, cursor
, pointer
);
27520 Take proper action when the mouse has moved to position X, Y on
27521 frame F as regards highlighting characters that have mouse-face
27522 properties. Also de-highlighting chars where the mouse was before.
27523 X and Y can be negative or out of range. */
27526 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27528 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27529 enum window_part part
= ON_NOTHING
;
27530 Lisp_Object window
;
27532 Cursor cursor
= No_Cursor
;
27533 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27536 /* When a menu is active, don't highlight because this looks odd. */
27537 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27538 if (popup_activated ())
27542 if (NILP (Vmouse_highlight
)
27543 || !f
->glyphs_initialized_p
27544 || f
->pointer_invisible
)
27547 hlinfo
->mouse_face_mouse_x
= x
;
27548 hlinfo
->mouse_face_mouse_y
= y
;
27549 hlinfo
->mouse_face_mouse_frame
= f
;
27551 if (hlinfo
->mouse_face_defer
)
27554 /* Which window is that in? */
27555 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27557 /* If displaying active text in another window, clear that. */
27558 if (! EQ (window
, hlinfo
->mouse_face_window
)
27559 /* Also clear if we move out of text area in same window. */
27560 || (!NILP (hlinfo
->mouse_face_window
)
27563 && part
!= ON_MODE_LINE
27564 && part
!= ON_HEADER_LINE
))
27565 clear_mouse_face (hlinfo
);
27567 /* Not on a window -> return. */
27568 if (!WINDOWP (window
))
27571 /* Reset help_echo_string. It will get recomputed below. */
27572 help_echo_string
= Qnil
;
27574 /* Convert to window-relative pixel coordinates. */
27575 w
= XWINDOW (window
);
27576 frame_to_window_pixel_xy (w
, &x
, &y
);
27578 #ifdef HAVE_WINDOW_SYSTEM
27579 /* Handle tool-bar window differently since it doesn't display a
27581 if (EQ (window
, f
->tool_bar_window
))
27583 note_tool_bar_highlight (f
, x
, y
);
27588 /* Mouse is on the mode, header line or margin? */
27589 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27590 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27592 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27596 #ifdef HAVE_WINDOW_SYSTEM
27597 if (part
== ON_VERTICAL_BORDER
)
27599 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27600 help_echo_string
= build_string ("drag-mouse-1: resize");
27602 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27603 || part
== ON_SCROLL_BAR
)
27604 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27606 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27609 /* Are we in a window whose display is up to date?
27610 And verify the buffer's text has not changed. */
27611 b
= XBUFFER (w
->buffer
);
27612 if (part
== ON_TEXT
27613 && w
->window_end_valid
27614 && w
->last_modified
== BUF_MODIFF (b
)
27615 && w
->last_overlay_modified
== BUF_OVERLAY_MODIFF (b
))
27617 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27619 struct glyph
*glyph
;
27620 Lisp_Object object
;
27621 Lisp_Object mouse_face
= Qnil
, position
;
27622 Lisp_Object
*overlay_vec
= NULL
;
27623 ptrdiff_t i
, noverlays
;
27624 struct buffer
*obuf
;
27625 ptrdiff_t obegv
, ozv
;
27628 /* Find the glyph under X/Y. */
27629 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27631 #ifdef HAVE_WINDOW_SYSTEM
27632 /* Look for :pointer property on image. */
27633 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27635 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27636 if (img
!= NULL
&& IMAGEP (img
->spec
))
27638 Lisp_Object image_map
, hotspot
;
27639 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27641 && (hotspot
= find_hot_spot (image_map
,
27642 glyph
->slice
.img
.x
+ dx
,
27643 glyph
->slice
.img
.y
+ dy
),
27645 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27649 /* Could check XCAR (hotspot) to see if we enter/leave
27651 If so, we could look for mouse-enter, mouse-leave
27652 properties in PLIST (and do something...). */
27653 hotspot
= XCDR (hotspot
);
27654 if (CONSP (hotspot
)
27655 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27657 pointer
= Fplist_get (plist
, Qpointer
);
27658 if (NILP (pointer
))
27660 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27661 if (!NILP (help_echo_string
))
27663 help_echo_window
= window
;
27664 help_echo_object
= glyph
->object
;
27665 help_echo_pos
= glyph
->charpos
;
27669 if (NILP (pointer
))
27670 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27673 #endif /* HAVE_WINDOW_SYSTEM */
27675 /* Clear mouse face if X/Y not over text. */
27677 || area
!= TEXT_AREA
27678 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27679 /* Glyph's OBJECT is an integer for glyphs inserted by the
27680 display engine for its internal purposes, like truncation
27681 and continuation glyphs and blanks beyond the end of
27682 line's text on text terminals. If we are over such a
27683 glyph, we are not over any text. */
27684 || INTEGERP (glyph
->object
)
27685 /* R2L rows have a stretch glyph at their front, which
27686 stands for no text, whereas L2R rows have no glyphs at
27687 all beyond the end of text. Treat such stretch glyphs
27688 like we do with NULL glyphs in L2R rows. */
27689 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27690 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27691 && glyph
->type
== STRETCH_GLYPH
27692 && glyph
->avoid_cursor_p
))
27694 if (clear_mouse_face (hlinfo
))
27695 cursor
= No_Cursor
;
27696 #ifdef HAVE_WINDOW_SYSTEM
27697 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27699 if (area
!= TEXT_AREA
)
27700 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27702 pointer
= Vvoid_text_area_pointer
;
27708 pos
= glyph
->charpos
;
27709 object
= glyph
->object
;
27710 if (!STRINGP (object
) && !BUFFERP (object
))
27713 /* If we get an out-of-range value, return now; avoid an error. */
27714 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27717 /* Make the window's buffer temporarily current for
27718 overlays_at and compute_char_face. */
27719 obuf
= current_buffer
;
27720 current_buffer
= b
;
27726 /* Is this char mouse-active or does it have help-echo? */
27727 position
= make_number (pos
);
27729 if (BUFFERP (object
))
27731 /* Put all the overlays we want in a vector in overlay_vec. */
27732 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27733 /* Sort overlays into increasing priority order. */
27734 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27739 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27742 cursor
= No_Cursor
;
27744 /* Check mouse-face highlighting. */
27746 /* If there exists an overlay with mouse-face overlapping
27747 the one we are currently highlighting, we have to
27748 check if we enter the overlapping overlay, and then
27749 highlight only that. */
27750 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27751 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27753 /* Find the highest priority overlay with a mouse-face. */
27754 Lisp_Object overlay
= Qnil
;
27755 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27757 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27758 if (!NILP (mouse_face
))
27759 overlay
= overlay_vec
[i
];
27762 /* If we're highlighting the same overlay as before, there's
27763 no need to do that again. */
27764 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27765 goto check_help_echo
;
27766 hlinfo
->mouse_face_overlay
= overlay
;
27768 /* Clear the display of the old active region, if any. */
27769 if (clear_mouse_face (hlinfo
))
27770 cursor
= No_Cursor
;
27772 /* If no overlay applies, get a text property. */
27773 if (NILP (overlay
))
27774 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27776 /* Next, compute the bounds of the mouse highlighting and
27778 if (!NILP (mouse_face
) && STRINGP (object
))
27780 /* The mouse-highlighting comes from a display string
27781 with a mouse-face. */
27785 s
= Fprevious_single_property_change
27786 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27787 e
= Fnext_single_property_change
27788 (position
, Qmouse_face
, object
, Qnil
);
27790 s
= make_number (0);
27792 e
= make_number (SCHARS (object
) - 1);
27793 mouse_face_from_string_pos (w
, hlinfo
, object
,
27794 XINT (s
), XINT (e
));
27795 hlinfo
->mouse_face_past_end
= 0;
27796 hlinfo
->mouse_face_window
= window
;
27797 hlinfo
->mouse_face_face_id
27798 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27799 glyph
->face_id
, 1);
27800 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27801 cursor
= No_Cursor
;
27805 /* The mouse-highlighting, if any, comes from an overlay
27806 or text property in the buffer. */
27807 Lisp_Object buffer
IF_LINT (= Qnil
);
27808 Lisp_Object disp_string
IF_LINT (= Qnil
);
27810 if (STRINGP (object
))
27812 /* If we are on a display string with no mouse-face,
27813 check if the text under it has one. */
27814 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27815 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27816 pos
= string_buffer_position (object
, start
);
27819 mouse_face
= get_char_property_and_overlay
27820 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27821 buffer
= w
->buffer
;
27822 disp_string
= object
;
27828 disp_string
= Qnil
;
27831 if (!NILP (mouse_face
))
27833 Lisp_Object before
, after
;
27834 Lisp_Object before_string
, after_string
;
27835 /* To correctly find the limits of mouse highlight
27836 in a bidi-reordered buffer, we must not use the
27837 optimization of limiting the search in
27838 previous-single-property-change and
27839 next-single-property-change, because
27840 rows_from_pos_range needs the real start and end
27841 positions to DTRT in this case. That's because
27842 the first row visible in a window does not
27843 necessarily display the character whose position
27844 is the smallest. */
27846 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27847 ? Fmarker_position (w
->start
)
27850 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27851 ? make_number (BUF_Z (XBUFFER (buffer
))
27852 - XFASTINT (w
->window_end_pos
))
27855 if (NILP (overlay
))
27857 /* Handle the text property case. */
27858 before
= Fprevious_single_property_change
27859 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27860 after
= Fnext_single_property_change
27861 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27862 before_string
= after_string
= Qnil
;
27866 /* Handle the overlay case. */
27867 before
= Foverlay_start (overlay
);
27868 after
= Foverlay_end (overlay
);
27869 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27870 after_string
= Foverlay_get (overlay
, Qafter_string
);
27872 if (!STRINGP (before_string
)) before_string
= Qnil
;
27873 if (!STRINGP (after_string
)) after_string
= Qnil
;
27876 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27879 : XFASTINT (before
),
27881 ? BUF_Z (XBUFFER (buffer
))
27882 : XFASTINT (after
),
27883 before_string
, after_string
,
27885 cursor
= No_Cursor
;
27892 /* Look for a `help-echo' property. */
27893 if (NILP (help_echo_string
)) {
27894 Lisp_Object help
, overlay
;
27896 /* Check overlays first. */
27897 help
= overlay
= Qnil
;
27898 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27900 overlay
= overlay_vec
[i
];
27901 help
= Foverlay_get (overlay
, Qhelp_echo
);
27906 help_echo_string
= help
;
27907 help_echo_window
= window
;
27908 help_echo_object
= overlay
;
27909 help_echo_pos
= pos
;
27913 Lisp_Object obj
= glyph
->object
;
27914 ptrdiff_t charpos
= glyph
->charpos
;
27916 /* Try text properties. */
27919 && charpos
< SCHARS (obj
))
27921 help
= Fget_text_property (make_number (charpos
),
27925 /* If the string itself doesn't specify a help-echo,
27926 see if the buffer text ``under'' it does. */
27927 struct glyph_row
*r
27928 = MATRIX_ROW (w
->current_matrix
, vpos
);
27929 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27930 ptrdiff_t p
= string_buffer_position (obj
, start
);
27933 help
= Fget_char_property (make_number (p
),
27934 Qhelp_echo
, w
->buffer
);
27943 else if (BUFFERP (obj
)
27946 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27951 help_echo_string
= help
;
27952 help_echo_window
= window
;
27953 help_echo_object
= obj
;
27954 help_echo_pos
= charpos
;
27959 #ifdef HAVE_WINDOW_SYSTEM
27960 /* Look for a `pointer' property. */
27961 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27963 /* Check overlays first. */
27964 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27965 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27967 if (NILP (pointer
))
27969 Lisp_Object obj
= glyph
->object
;
27970 ptrdiff_t charpos
= glyph
->charpos
;
27972 /* Try text properties. */
27975 && charpos
< SCHARS (obj
))
27977 pointer
= Fget_text_property (make_number (charpos
),
27979 if (NILP (pointer
))
27981 /* If the string itself doesn't specify a pointer,
27982 see if the buffer text ``under'' it does. */
27983 struct glyph_row
*r
27984 = MATRIX_ROW (w
->current_matrix
, vpos
);
27985 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27986 ptrdiff_t p
= string_buffer_position (obj
, start
);
27988 pointer
= Fget_char_property (make_number (p
),
27989 Qpointer
, w
->buffer
);
27992 else if (BUFFERP (obj
)
27995 pointer
= Fget_text_property (make_number (charpos
),
27999 #endif /* HAVE_WINDOW_SYSTEM */
28003 current_buffer
= obuf
;
28008 #ifdef HAVE_WINDOW_SYSTEM
28009 if (FRAME_WINDOW_P (f
))
28010 define_frame_cursor1 (f
, cursor
, pointer
);
28012 /* This is here to prevent a compiler error, about "label at end of
28013 compound statement". */
28020 Clear any mouse-face on window W. This function is part of the
28021 redisplay interface, and is called from try_window_id and similar
28022 functions to ensure the mouse-highlight is off. */
28025 x_clear_window_mouse_face (struct window
*w
)
28027 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28028 Lisp_Object window
;
28031 XSETWINDOW (window
, w
);
28032 if (EQ (window
, hlinfo
->mouse_face_window
))
28033 clear_mouse_face (hlinfo
);
28039 Just discard the mouse face information for frame F, if any.
28040 This is used when the size of F is changed. */
28043 cancel_mouse_face (struct frame
*f
)
28045 Lisp_Object window
;
28046 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28048 window
= hlinfo
->mouse_face_window
;
28049 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
28051 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28052 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28053 hlinfo
->mouse_face_window
= Qnil
;
28059 /***********************************************************************
28061 ***********************************************************************/
28063 #ifdef HAVE_WINDOW_SYSTEM
28065 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28066 which intersects rectangle R. R is in window-relative coordinates. */
28069 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
28070 enum glyph_row_area area
)
28072 struct glyph
*first
= row
->glyphs
[area
];
28073 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
28074 struct glyph
*last
;
28075 int first_x
, start_x
, x
;
28077 if (area
== TEXT_AREA
&& row
->fill_line_p
)
28078 /* If row extends face to end of line write the whole line. */
28079 draw_glyphs (w
, 0, row
, area
,
28080 0, row
->used
[area
],
28081 DRAW_NORMAL_TEXT
, 0);
28084 /* Set START_X to the window-relative start position for drawing glyphs of
28085 AREA. The first glyph of the text area can be partially visible.
28086 The first glyphs of other areas cannot. */
28087 start_x
= window_box_left_offset (w
, area
);
28089 if (area
== TEXT_AREA
)
28092 /* Find the first glyph that must be redrawn. */
28094 && x
+ first
->pixel_width
< r
->x
)
28096 x
+= first
->pixel_width
;
28100 /* Find the last one. */
28104 && x
< r
->x
+ r
->width
)
28106 x
+= last
->pixel_width
;
28112 draw_glyphs (w
, first_x
- start_x
, row
, area
,
28113 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
28114 DRAW_NORMAL_TEXT
, 0);
28119 /* Redraw the parts of the glyph row ROW on window W intersecting
28120 rectangle R. R is in window-relative coordinates. Value is
28121 non-zero if mouse-face was overwritten. */
28124 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
28126 eassert (row
->enabled_p
);
28128 if (row
->mode_line_p
|| w
->pseudo_window_p
)
28129 draw_glyphs (w
, 0, row
, TEXT_AREA
,
28130 0, row
->used
[TEXT_AREA
],
28131 DRAW_NORMAL_TEXT
, 0);
28134 if (row
->used
[LEFT_MARGIN_AREA
])
28135 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
28136 if (row
->used
[TEXT_AREA
])
28137 expose_area (w
, row
, r
, TEXT_AREA
);
28138 if (row
->used
[RIGHT_MARGIN_AREA
])
28139 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
28140 draw_row_fringe_bitmaps (w
, row
);
28143 return row
->mouse_face_p
;
28147 /* Redraw those parts of glyphs rows during expose event handling that
28148 overlap other rows. Redrawing of an exposed line writes over parts
28149 of lines overlapping that exposed line; this function fixes that.
28151 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28152 row in W's current matrix that is exposed and overlaps other rows.
28153 LAST_OVERLAPPING_ROW is the last such row. */
28156 expose_overlaps (struct window
*w
,
28157 struct glyph_row
*first_overlapping_row
,
28158 struct glyph_row
*last_overlapping_row
,
28161 struct glyph_row
*row
;
28163 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
28164 if (row
->overlapping_p
)
28166 eassert (row
->enabled_p
&& !row
->mode_line_p
);
28169 if (row
->used
[LEFT_MARGIN_AREA
])
28170 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
28172 if (row
->used
[TEXT_AREA
])
28173 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
28175 if (row
->used
[RIGHT_MARGIN_AREA
])
28176 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
28182 /* Return non-zero if W's cursor intersects rectangle R. */
28185 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
28187 XRectangle cr
, result
;
28188 struct glyph
*cursor_glyph
;
28189 struct glyph_row
*row
;
28191 if (w
->phys_cursor
.vpos
>= 0
28192 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
28193 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
28195 && row
->cursor_in_fringe_p
)
28197 /* Cursor is in the fringe. */
28198 cr
.x
= window_box_right_offset (w
,
28199 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
28200 ? RIGHT_MARGIN_AREA
28203 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
28204 cr
.height
= row
->height
;
28205 return x_intersect_rectangles (&cr
, r
, &result
);
28208 cursor_glyph
= get_phys_cursor_glyph (w
);
28211 /* r is relative to W's box, but w->phys_cursor.x is relative
28212 to left edge of W's TEXT area. Adjust it. */
28213 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28214 cr
.y
= w
->phys_cursor
.y
;
28215 cr
.width
= cursor_glyph
->pixel_width
;
28216 cr
.height
= w
->phys_cursor_height
;
28217 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28218 I assume the effect is the same -- and this is portable. */
28219 return x_intersect_rectangles (&cr
, r
, &result
);
28221 /* If we don't understand the format, pretend we're not in the hot-spot. */
28227 Draw a vertical window border to the right of window W if W doesn't
28228 have vertical scroll bars. */
28231 x_draw_vertical_border (struct window
*w
)
28233 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28235 /* We could do better, if we knew what type of scroll-bar the adjacent
28236 windows (on either side) have... But we don't :-(
28237 However, I think this works ok. ++KFS 2003-04-25 */
28239 /* Redraw borders between horizontally adjacent windows. Don't
28240 do it for frames with vertical scroll bars because either the
28241 right scroll bar of a window, or the left scroll bar of its
28242 neighbor will suffice as a border. */
28243 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28246 /* Note: It is necessary to redraw both the left and the right
28247 borders, for when only this single window W is being
28249 if (!WINDOW_RIGHTMOST_P (w
)
28250 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28252 int x0
, x1
, y0
, y1
;
28254 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28257 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28260 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28262 if (!WINDOW_LEFTMOST_P (w
)
28263 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28265 int x0
, x1
, y0
, y1
;
28267 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28270 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28273 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28278 /* Redraw the part of window W intersection rectangle FR. Pixel
28279 coordinates in FR are frame-relative. Call this function with
28280 input blocked. Value is non-zero if the exposure overwrites
28284 expose_window (struct window
*w
, XRectangle
*fr
)
28286 struct frame
*f
= XFRAME (w
->frame
);
28288 int mouse_face_overwritten_p
= 0;
28290 /* If window is not yet fully initialized, do nothing. This can
28291 happen when toolkit scroll bars are used and a window is split.
28292 Reconfiguring the scroll bar will generate an expose for a newly
28294 if (w
->current_matrix
== NULL
)
28297 /* When we're currently updating the window, display and current
28298 matrix usually don't agree. Arrange for a thorough display
28300 if (w
== updated_window
)
28302 SET_FRAME_GARBAGED (f
);
28306 /* Frame-relative pixel rectangle of W. */
28307 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28308 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28309 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28310 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28312 if (x_intersect_rectangles (fr
, &wr
, &r
))
28314 int yb
= window_text_bottom_y (w
);
28315 struct glyph_row
*row
;
28316 int cursor_cleared_p
, phys_cursor_on_p
;
28317 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28319 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28320 r
.x
, r
.y
, r
.width
, r
.height
));
28322 /* Convert to window coordinates. */
28323 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28324 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28326 /* Turn off the cursor. */
28327 if (!w
->pseudo_window_p
28328 && phys_cursor_in_rect_p (w
, &r
))
28330 x_clear_cursor (w
);
28331 cursor_cleared_p
= 1;
28334 cursor_cleared_p
= 0;
28336 /* If the row containing the cursor extends face to end of line,
28337 then expose_area might overwrite the cursor outside the
28338 rectangle and thus notice_overwritten_cursor might clear
28339 w->phys_cursor_on_p. We remember the original value and
28340 check later if it is changed. */
28341 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28343 /* Update lines intersecting rectangle R. */
28344 first_overlapping_row
= last_overlapping_row
= NULL
;
28345 for (row
= w
->current_matrix
->rows
;
28350 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28352 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28353 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28354 || (r
.y
>= y0
&& r
.y
< y1
)
28355 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28357 /* A header line may be overlapping, but there is no need
28358 to fix overlapping areas for them. KFS 2005-02-12 */
28359 if (row
->overlapping_p
&& !row
->mode_line_p
)
28361 if (first_overlapping_row
== NULL
)
28362 first_overlapping_row
= row
;
28363 last_overlapping_row
= row
;
28367 if (expose_line (w
, row
, &r
))
28368 mouse_face_overwritten_p
= 1;
28371 else if (row
->overlapping_p
)
28373 /* We must redraw a row overlapping the exposed area. */
28375 ? y0
+ row
->phys_height
> r
.y
28376 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28378 if (first_overlapping_row
== NULL
)
28379 first_overlapping_row
= row
;
28380 last_overlapping_row
= row
;
28388 /* Display the mode line if there is one. */
28389 if (WINDOW_WANTS_MODELINE_P (w
)
28390 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28392 && row
->y
< r
.y
+ r
.height
)
28394 if (expose_line (w
, row
, &r
))
28395 mouse_face_overwritten_p
= 1;
28398 if (!w
->pseudo_window_p
)
28400 /* Fix the display of overlapping rows. */
28401 if (first_overlapping_row
)
28402 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28405 /* Draw border between windows. */
28406 x_draw_vertical_border (w
);
28408 /* Turn the cursor on again. */
28409 if (cursor_cleared_p
28410 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28411 update_window_cursor (w
, 1);
28415 return mouse_face_overwritten_p
;
28420 /* Redraw (parts) of all windows in the window tree rooted at W that
28421 intersect R. R contains frame pixel coordinates. Value is
28422 non-zero if the exposure overwrites mouse-face. */
28425 expose_window_tree (struct window
*w
, XRectangle
*r
)
28427 struct frame
*f
= XFRAME (w
->frame
);
28428 int mouse_face_overwritten_p
= 0;
28430 while (w
&& !FRAME_GARBAGED_P (f
))
28432 if (!NILP (w
->hchild
))
28433 mouse_face_overwritten_p
28434 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28435 else if (!NILP (w
->vchild
))
28436 mouse_face_overwritten_p
28437 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28439 mouse_face_overwritten_p
|= expose_window (w
, r
);
28441 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28444 return mouse_face_overwritten_p
;
28449 Redisplay an exposed area of frame F. X and Y are the upper-left
28450 corner of the exposed rectangle. W and H are width and height of
28451 the exposed area. All are pixel values. W or H zero means redraw
28452 the entire frame. */
28455 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28458 int mouse_face_overwritten_p
= 0;
28460 TRACE ((stderr
, "expose_frame "));
28462 /* No need to redraw if frame will be redrawn soon. */
28463 if (FRAME_GARBAGED_P (f
))
28465 TRACE ((stderr
, " garbaged\n"));
28469 /* If basic faces haven't been realized yet, there is no point in
28470 trying to redraw anything. This can happen when we get an expose
28471 event while Emacs is starting, e.g. by moving another window. */
28472 if (FRAME_FACE_CACHE (f
) == NULL
28473 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28475 TRACE ((stderr
, " no faces\n"));
28479 if (w
== 0 || h
== 0)
28482 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28483 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28493 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28494 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28496 if (WINDOWP (f
->tool_bar_window
))
28497 mouse_face_overwritten_p
28498 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28500 #ifdef HAVE_X_WINDOWS
28502 #ifndef USE_X_TOOLKIT
28503 if (WINDOWP (f
->menu_bar_window
))
28504 mouse_face_overwritten_p
28505 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28506 #endif /* not USE_X_TOOLKIT */
28510 /* Some window managers support a focus-follows-mouse style with
28511 delayed raising of frames. Imagine a partially obscured frame,
28512 and moving the mouse into partially obscured mouse-face on that
28513 frame. The visible part of the mouse-face will be highlighted,
28514 then the WM raises the obscured frame. With at least one WM, KDE
28515 2.1, Emacs is not getting any event for the raising of the frame
28516 (even tried with SubstructureRedirectMask), only Expose events.
28517 These expose events will draw text normally, i.e. not
28518 highlighted. Which means we must redo the highlight here.
28519 Subsume it under ``we love X''. --gerd 2001-08-15 */
28520 /* Included in Windows version because Windows most likely does not
28521 do the right thing if any third party tool offers
28522 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28523 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28525 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28526 if (f
== hlinfo
->mouse_face_mouse_frame
)
28528 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28529 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28530 clear_mouse_face (hlinfo
);
28531 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28538 Determine the intersection of two rectangles R1 and R2. Return
28539 the intersection in *RESULT. Value is non-zero if RESULT is not
28543 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28545 XRectangle
*left
, *right
;
28546 XRectangle
*upper
, *lower
;
28547 int intersection_p
= 0;
28549 /* Rearrange so that R1 is the left-most rectangle. */
28551 left
= r1
, right
= r2
;
28553 left
= r2
, right
= r1
;
28555 /* X0 of the intersection is right.x0, if this is inside R1,
28556 otherwise there is no intersection. */
28557 if (right
->x
<= left
->x
+ left
->width
)
28559 result
->x
= right
->x
;
28561 /* The right end of the intersection is the minimum of
28562 the right ends of left and right. */
28563 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28566 /* Same game for Y. */
28568 upper
= r1
, lower
= r2
;
28570 upper
= r2
, lower
= r1
;
28572 /* The upper end of the intersection is lower.y0, if this is inside
28573 of upper. Otherwise, there is no intersection. */
28574 if (lower
->y
<= upper
->y
+ upper
->height
)
28576 result
->y
= lower
->y
;
28578 /* The lower end of the intersection is the minimum of the lower
28579 ends of upper and lower. */
28580 result
->height
= (min (lower
->y
+ lower
->height
,
28581 upper
->y
+ upper
->height
)
28583 intersection_p
= 1;
28587 return intersection_p
;
28590 #endif /* HAVE_WINDOW_SYSTEM */
28593 /***********************************************************************
28595 ***********************************************************************/
28598 syms_of_xdisp (void)
28600 Vwith_echo_area_save_vector
= Qnil
;
28601 staticpro (&Vwith_echo_area_save_vector
);
28603 Vmessage_stack
= Qnil
;
28604 staticpro (&Vmessage_stack
);
28606 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28607 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
28609 message_dolog_marker1
= Fmake_marker ();
28610 staticpro (&message_dolog_marker1
);
28611 message_dolog_marker2
= Fmake_marker ();
28612 staticpro (&message_dolog_marker2
);
28613 message_dolog_marker3
= Fmake_marker ();
28614 staticpro (&message_dolog_marker3
);
28617 defsubr (&Sdump_frame_glyph_matrix
);
28618 defsubr (&Sdump_glyph_matrix
);
28619 defsubr (&Sdump_glyph_row
);
28620 defsubr (&Sdump_tool_bar_row
);
28621 defsubr (&Strace_redisplay
);
28622 defsubr (&Strace_to_stderr
);
28624 #ifdef HAVE_WINDOW_SYSTEM
28625 defsubr (&Stool_bar_lines_needed
);
28626 defsubr (&Slookup_image_map
);
28628 defsubr (&Sformat_mode_line
);
28629 defsubr (&Sinvisible_p
);
28630 defsubr (&Scurrent_bidi_paragraph_direction
);
28632 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28633 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28634 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28635 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28636 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28637 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28638 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28639 DEFSYM (Qeval
, "eval");
28640 DEFSYM (QCdata
, ":data");
28641 DEFSYM (Qdisplay
, "display");
28642 DEFSYM (Qspace_width
, "space-width");
28643 DEFSYM (Qraise
, "raise");
28644 DEFSYM (Qslice
, "slice");
28645 DEFSYM (Qspace
, "space");
28646 DEFSYM (Qmargin
, "margin");
28647 DEFSYM (Qpointer
, "pointer");
28648 DEFSYM (Qleft_margin
, "left-margin");
28649 DEFSYM (Qright_margin
, "right-margin");
28650 DEFSYM (Qcenter
, "center");
28651 DEFSYM (Qline_height
, "line-height");
28652 DEFSYM (QCalign_to
, ":align-to");
28653 DEFSYM (QCrelative_width
, ":relative-width");
28654 DEFSYM (QCrelative_height
, ":relative-height");
28655 DEFSYM (QCeval
, ":eval");
28656 DEFSYM (QCpropertize
, ":propertize");
28657 DEFSYM (QCfile
, ":file");
28658 DEFSYM (Qfontified
, "fontified");
28659 DEFSYM (Qfontification_functions
, "fontification-functions");
28660 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28661 DEFSYM (Qescape_glyph
, "escape-glyph");
28662 DEFSYM (Qnobreak_space
, "nobreak-space");
28663 DEFSYM (Qimage
, "image");
28664 DEFSYM (Qtext
, "text");
28665 DEFSYM (Qboth
, "both");
28666 DEFSYM (Qboth_horiz
, "both-horiz");
28667 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28668 DEFSYM (QCmap
, ":map");
28669 DEFSYM (QCpointer
, ":pointer");
28670 DEFSYM (Qrect
, "rect");
28671 DEFSYM (Qcircle
, "circle");
28672 DEFSYM (Qpoly
, "poly");
28673 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28674 DEFSYM (Qgrow_only
, "grow-only");
28675 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28676 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28677 DEFSYM (Qposition
, "position");
28678 DEFSYM (Qbuffer_position
, "buffer-position");
28679 DEFSYM (Qobject
, "object");
28680 DEFSYM (Qbar
, "bar");
28681 DEFSYM (Qhbar
, "hbar");
28682 DEFSYM (Qbox
, "box");
28683 DEFSYM (Qhollow
, "hollow");
28684 DEFSYM (Qhand
, "hand");
28685 DEFSYM (Qarrow
, "arrow");
28686 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28688 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28689 Fcons (intern_c_string ("void-variable"), Qnil
)),
28691 staticpro (&list_of_error
);
28693 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28694 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28695 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28696 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28698 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28699 staticpro (&echo_buffer
[0]);
28700 staticpro (&echo_buffer
[1]);
28702 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28703 staticpro (&echo_area_buffer
[0]);
28704 staticpro (&echo_area_buffer
[1]);
28706 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
28707 staticpro (&Vmessages_buffer_name
);
28709 mode_line_proptrans_alist
= Qnil
;
28710 staticpro (&mode_line_proptrans_alist
);
28711 mode_line_string_list
= Qnil
;
28712 staticpro (&mode_line_string_list
);
28713 mode_line_string_face
= Qnil
;
28714 staticpro (&mode_line_string_face
);
28715 mode_line_string_face_prop
= Qnil
;
28716 staticpro (&mode_line_string_face_prop
);
28717 Vmode_line_unwind_vector
= Qnil
;
28718 staticpro (&Vmode_line_unwind_vector
);
28720 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
28722 help_echo_string
= Qnil
;
28723 staticpro (&help_echo_string
);
28724 help_echo_object
= Qnil
;
28725 staticpro (&help_echo_object
);
28726 help_echo_window
= Qnil
;
28727 staticpro (&help_echo_window
);
28728 previous_help_echo_string
= Qnil
;
28729 staticpro (&previous_help_echo_string
);
28730 help_echo_pos
= -1;
28732 DEFSYM (Qright_to_left
, "right-to-left");
28733 DEFSYM (Qleft_to_right
, "left-to-right");
28735 #ifdef HAVE_WINDOW_SYSTEM
28736 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28737 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
28738 For example, if a block cursor is over a tab, it will be drawn as
28739 wide as that tab on the display. */);
28740 x_stretch_cursor_p
= 0;
28743 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28744 doc
: /* Non-nil means highlight trailing whitespace.
28745 The face used for trailing whitespace is `trailing-whitespace'. */);
28746 Vshow_trailing_whitespace
= Qnil
;
28748 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28749 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28750 If the value is t, Emacs highlights non-ASCII chars which have the
28751 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28752 or `escape-glyph' face respectively.
28754 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28755 U+2011 (non-breaking hyphen) are affected.
28757 Any other non-nil value means to display these characters as a escape
28758 glyph followed by an ordinary space or hyphen.
28760 A value of nil means no special handling of these characters. */);
28761 Vnobreak_char_display
= Qt
;
28763 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28764 doc
: /* The pointer shape to show in void text areas.
28765 A value of nil means to show the text pointer. Other options are `arrow',
28766 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28767 Vvoid_text_area_pointer
= Qarrow
;
28769 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28770 doc
: /* Non-nil means don't actually do any redisplay.
28771 This is used for internal purposes. */);
28772 Vinhibit_redisplay
= Qnil
;
28774 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28775 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28776 Vglobal_mode_string
= Qnil
;
28778 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28779 doc
: /* Marker for where to display an arrow on top of the buffer text.
28780 This must be the beginning of a line in order to work.
28781 See also `overlay-arrow-string'. */);
28782 Voverlay_arrow_position
= Qnil
;
28784 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28785 doc
: /* String to display as an arrow in non-window frames.
28786 See also `overlay-arrow-position'. */);
28787 Voverlay_arrow_string
= build_pure_c_string ("=>");
28789 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28790 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28791 The symbols on this list are examined during redisplay to determine
28792 where to display overlay arrows. */);
28793 Voverlay_arrow_variable_list
28794 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28796 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28797 doc
: /* The number of lines to try scrolling a window by when point moves out.
28798 If that fails to bring point back on frame, point is centered instead.
28799 If this is zero, point is always centered after it moves off frame.
28800 If you want scrolling to always be a line at a time, you should set
28801 `scroll-conservatively' to a large value rather than set this to 1. */);
28803 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28804 doc
: /* Scroll up to this many lines, to bring point back on screen.
28805 If point moves off-screen, redisplay will scroll by up to
28806 `scroll-conservatively' lines in order to bring point just barely
28807 onto the screen again. If that cannot be done, then redisplay
28808 recenters point as usual.
28810 If the value is greater than 100, redisplay will never recenter point,
28811 but will always scroll just enough text to bring point into view, even
28812 if you move far away.
28814 A value of zero means always recenter point if it moves off screen. */);
28815 scroll_conservatively
= 0;
28817 DEFVAR_INT ("scroll-margin", scroll_margin
,
28818 doc
: /* Number of lines of margin at the top and bottom of a window.
28819 Recenter the window whenever point gets within this many lines
28820 of the top or bottom of the window. */);
28823 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28824 doc
: /* Pixels per inch value for non-window system displays.
28825 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28826 Vdisplay_pixels_per_inch
= make_float (72.0);
28829 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28832 DEFVAR_LISP ("truncate-partial-width-windows",
28833 Vtruncate_partial_width_windows
,
28834 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28835 For an integer value, truncate lines in each window narrower than the
28836 full frame width, provided the window width is less than that integer;
28837 otherwise, respect the value of `truncate-lines'.
28839 For any other non-nil value, truncate lines in all windows that do
28840 not span the full frame width.
28842 A value of nil means to respect the value of `truncate-lines'.
28844 If `word-wrap' is enabled, you might want to reduce this. */);
28845 Vtruncate_partial_width_windows
= make_number (50);
28847 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28848 doc
: /* Maximum buffer size for which line number should be displayed.
28849 If the buffer is bigger than this, the line number does not appear
28850 in the mode line. A value of nil means no limit. */);
28851 Vline_number_display_limit
= Qnil
;
28853 DEFVAR_INT ("line-number-display-limit-width",
28854 line_number_display_limit_width
,
28855 doc
: /* Maximum line width (in characters) for line number display.
28856 If the average length of the lines near point is bigger than this, then the
28857 line number may be omitted from the mode line. */);
28858 line_number_display_limit_width
= 200;
28860 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28861 doc
: /* Non-nil means highlight region even in nonselected windows. */);
28862 highlight_nonselected_windows
= 0;
28864 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28865 doc
: /* Non-nil if more than one frame is visible on this display.
28866 Minibuffer-only frames don't count, but iconified frames do.
28867 This variable is not guaranteed to be accurate except while processing
28868 `frame-title-format' and `icon-title-format'. */);
28870 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28871 doc
: /* Template for displaying the title bar of visible frames.
28872 \(Assuming the window manager supports this feature.)
28874 This variable has the same structure as `mode-line-format', except that
28875 the %c and %l constructs are ignored. It is used only on frames for
28876 which no explicit name has been set \(see `modify-frame-parameters'). */);
28878 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28879 doc
: /* Template for displaying the title bar of an iconified frame.
28880 \(Assuming the window manager supports this feature.)
28881 This variable has the same structure as `mode-line-format' (which see),
28882 and is used only on frames for which no explicit name has been set
28883 \(see `modify-frame-parameters'). */);
28885 = Vframe_title_format
28886 = listn (CONSTYPE_PURE
, 3,
28887 intern_c_string ("multiple-frames"),
28888 build_pure_c_string ("%b"),
28889 listn (CONSTYPE_PURE
, 4,
28890 empty_unibyte_string
,
28891 intern_c_string ("invocation-name"),
28892 build_pure_c_string ("@"),
28893 intern_c_string ("system-name")));
28895 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28896 doc
: /* Maximum number of lines to keep in the message log buffer.
28897 If nil, disable message logging. If t, log messages but don't truncate
28898 the buffer when it becomes large. */);
28899 Vmessage_log_max
= make_number (1000);
28901 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28902 doc
: /* Functions called before redisplay, if window sizes have changed.
28903 The value should be a list of functions that take one argument.
28904 Just before redisplay, for each frame, if any of its windows have changed
28905 size since the last redisplay, or have been split or deleted,
28906 all the functions in the list are called, with the frame as argument. */);
28907 Vwindow_size_change_functions
= Qnil
;
28909 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28910 doc
: /* List of functions to call before redisplaying a window with scrolling.
28911 Each function is called with two arguments, the window and its new
28912 display-start position. Note that these functions are also called by
28913 `set-window-buffer'. Also note that the value of `window-end' is not
28914 valid when these functions are called.
28916 Warning: Do not use this feature to alter the way the window
28917 is scrolled. It is not designed for that, and such use probably won't
28919 Vwindow_scroll_functions
= Qnil
;
28921 DEFVAR_LISP ("window-text-change-functions",
28922 Vwindow_text_change_functions
,
28923 doc
: /* Functions to call in redisplay when text in the window might change. */);
28924 Vwindow_text_change_functions
= Qnil
;
28926 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28927 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28928 Each function is called with two arguments, the window and the end trigger value.
28929 See `set-window-redisplay-end-trigger'. */);
28930 Vredisplay_end_trigger_functions
= Qnil
;
28932 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28933 doc
: /* Non-nil means autoselect window with mouse pointer.
28934 If nil, do not autoselect windows.
28935 A positive number means delay autoselection by that many seconds: a
28936 window is autoselected only after the mouse has remained in that
28937 window for the duration of the delay.
28938 A negative number has a similar effect, but causes windows to be
28939 autoselected only after the mouse has stopped moving. \(Because of
28940 the way Emacs compares mouse events, you will occasionally wait twice
28941 that time before the window gets selected.\)
28942 Any other value means to autoselect window instantaneously when the
28943 mouse pointer enters it.
28945 Autoselection selects the minibuffer only if it is active, and never
28946 unselects the minibuffer if it is active.
28948 When customizing this variable make sure that the actual value of
28949 `focus-follows-mouse' matches the behavior of your window manager. */);
28950 Vmouse_autoselect_window
= Qnil
;
28952 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28953 doc
: /* Non-nil means automatically resize tool-bars.
28954 This dynamically changes the tool-bar's height to the minimum height
28955 that is needed to make all tool-bar items visible.
28956 If value is `grow-only', the tool-bar's height is only increased
28957 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28958 Vauto_resize_tool_bars
= Qt
;
28960 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28961 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28962 auto_raise_tool_bar_buttons_p
= 1;
28964 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28965 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28966 make_cursor_line_fully_visible_p
= 1;
28968 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28969 doc
: /* Border below tool-bar in pixels.
28970 If an integer, use it as the height of the border.
28971 If it is one of `internal-border-width' or `border-width', use the
28972 value of the corresponding frame parameter.
28973 Otherwise, no border is added below the tool-bar. */);
28974 Vtool_bar_border
= Qinternal_border_width
;
28976 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28977 doc
: /* Margin around tool-bar buttons in pixels.
28978 If an integer, use that for both horizontal and vertical margins.
28979 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28980 HORZ specifying the horizontal margin, and VERT specifying the
28981 vertical margin. */);
28982 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28984 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28985 doc
: /* Relief thickness of tool-bar buttons. */);
28986 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28988 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28989 doc
: /* Tool bar style to use.
28991 image - show images only
28992 text - show text only
28993 both - show both, text below image
28994 both-horiz - show text to the right of the image
28995 text-image-horiz - show text to the left of the image
28996 any other - use system default or image if no system default.
28998 This variable only affects the GTK+ toolkit version of Emacs. */);
28999 Vtool_bar_style
= Qnil
;
29001 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
29002 doc
: /* Maximum number of characters a label can have to be shown.
29003 The tool bar style must also show labels for this to have any effect, see
29004 `tool-bar-style'. */);
29005 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
29007 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
29008 doc
: /* List of functions to call to fontify regions of text.
29009 Each function is called with one argument POS. Functions must
29010 fontify a region starting at POS in the current buffer, and give
29011 fontified regions the property `fontified'. */);
29012 Vfontification_functions
= Qnil
;
29013 Fmake_variable_buffer_local (Qfontification_functions
);
29015 DEFVAR_BOOL ("unibyte-display-via-language-environment",
29016 unibyte_display_via_language_environment
,
29017 doc
: /* Non-nil means display unibyte text according to language environment.
29018 Specifically, this means that raw bytes in the range 160-255 decimal
29019 are displayed by converting them to the equivalent multibyte characters
29020 according to the current language environment. As a result, they are
29021 displayed according to the current fontset.
29023 Note that this variable affects only how these bytes are displayed,
29024 but does not change the fact they are interpreted as raw bytes. */);
29025 unibyte_display_via_language_environment
= 0;
29027 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
29028 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29029 If a float, it specifies a fraction of the mini-window frame's height.
29030 If an integer, it specifies a number of lines. */);
29031 Vmax_mini_window_height
= make_float (0.25);
29033 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
29034 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
29035 A value of nil means don't automatically resize mini-windows.
29036 A value of t means resize them to fit the text displayed in them.
29037 A value of `grow-only', the default, means let mini-windows grow only;
29038 they return to their normal size when the minibuffer is closed, or the
29039 echo area becomes empty. */);
29040 Vresize_mini_windows
= Qgrow_only
;
29042 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
29043 doc
: /* Alist specifying how to blink the cursor off.
29044 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29045 `cursor-type' frame-parameter or variable equals ON-STATE,
29046 comparing using `equal', Emacs uses OFF-STATE to specify
29047 how to blink it off. ON-STATE and OFF-STATE are values for
29048 the `cursor-type' frame parameter.
29050 If a frame's ON-STATE has no entry in this list,
29051 the frame's other specifications determine how to blink the cursor off. */);
29052 Vblink_cursor_alist
= Qnil
;
29054 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
29055 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
29056 If non-nil, windows are automatically scrolled horizontally to make
29057 point visible. */);
29058 automatic_hscrolling_p
= 1;
29059 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
29061 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
29062 doc
: /* How many columns away from the window edge point is allowed to get
29063 before automatic hscrolling will horizontally scroll the window. */);
29064 hscroll_margin
= 5;
29066 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
29067 doc
: /* How many columns to scroll the window when point gets too close to the edge.
29068 When point is less than `hscroll-margin' columns from the window
29069 edge, automatic hscrolling will scroll the window by the amount of columns
29070 determined by this variable. If its value is a positive integer, scroll that
29071 many columns. If it's a positive floating-point number, it specifies the
29072 fraction of the window's width to scroll. If it's nil or zero, point will be
29073 centered horizontally after the scroll. Any other value, including negative
29074 numbers, are treated as if the value were zero.
29076 Automatic hscrolling always moves point outside the scroll margin, so if
29077 point was more than scroll step columns inside the margin, the window will
29078 scroll more than the value given by the scroll step.
29080 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29081 and `scroll-right' overrides this variable's effect. */);
29082 Vhscroll_step
= make_number (0);
29084 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
29085 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
29086 Bind this around calls to `message' to let it take effect. */);
29087 message_truncate_lines
= 0;
29089 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
29090 doc
: /* Normal hook run to update the menu bar definitions.
29091 Redisplay runs this hook before it redisplays the menu bar.
29092 This is used to update submenus such as Buffers,
29093 whose contents depend on various data. */);
29094 Vmenu_bar_update_hook
= Qnil
;
29096 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
29097 doc
: /* Frame for which we are updating a menu.
29098 The enable predicate for a menu binding should check this variable. */);
29099 Vmenu_updating_frame
= Qnil
;
29101 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
29102 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
29103 inhibit_menubar_update
= 0;
29105 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
29106 doc
: /* Prefix prepended to all continuation lines at display time.
29107 The value may be a string, an image, or a stretch-glyph; it is
29108 interpreted in the same way as the value of a `display' text property.
29110 This variable is overridden by any `wrap-prefix' text or overlay
29113 To add a prefix to non-continuation lines, use `line-prefix'. */);
29114 Vwrap_prefix
= Qnil
;
29115 DEFSYM (Qwrap_prefix
, "wrap-prefix");
29116 Fmake_variable_buffer_local (Qwrap_prefix
);
29118 DEFVAR_LISP ("line-prefix", Vline_prefix
,
29119 doc
: /* Prefix prepended to all non-continuation lines at display time.
29120 The value may be a string, an image, or a stretch-glyph; it is
29121 interpreted in the same way as the value of a `display' text property.
29123 This variable is overridden by any `line-prefix' text or overlay
29126 To add a prefix to continuation lines, use `wrap-prefix'. */);
29127 Vline_prefix
= Qnil
;
29128 DEFSYM (Qline_prefix
, "line-prefix");
29129 Fmake_variable_buffer_local (Qline_prefix
);
29131 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
29132 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
29133 inhibit_eval_during_redisplay
= 0;
29135 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
29136 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
29137 inhibit_free_realized_faces
= 0;
29140 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
29141 doc
: /* Inhibit try_window_id display optimization. */);
29142 inhibit_try_window_id
= 0;
29144 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
29145 doc
: /* Inhibit try_window_reusing display optimization. */);
29146 inhibit_try_window_reusing
= 0;
29148 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
29149 doc
: /* Inhibit try_cursor_movement display optimization. */);
29150 inhibit_try_cursor_movement
= 0;
29151 #endif /* GLYPH_DEBUG */
29153 DEFVAR_INT ("overline-margin", overline_margin
,
29154 doc
: /* Space between overline and text, in pixels.
29155 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29156 margin to the character height. */);
29157 overline_margin
= 2;
29159 DEFVAR_INT ("underline-minimum-offset",
29160 underline_minimum_offset
,
29161 doc
: /* Minimum distance between baseline and underline.
29162 This can improve legibility of underlined text at small font sizes,
29163 particularly when using variable `x-use-underline-position-properties'
29164 with fonts that specify an UNDERLINE_POSITION relatively close to the
29165 baseline. The default value is 1. */);
29166 underline_minimum_offset
= 1;
29168 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
29169 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29170 This feature only works when on a window system that can change
29171 cursor shapes. */);
29172 display_hourglass_p
= 1;
29174 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
29175 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29176 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
29178 hourglass_atimer
= NULL
;
29179 hourglass_shown_p
= 0;
29181 DEFSYM (Qglyphless_char
, "glyphless-char");
29182 DEFSYM (Qhex_code
, "hex-code");
29183 DEFSYM (Qempty_box
, "empty-box");
29184 DEFSYM (Qthin_space
, "thin-space");
29185 DEFSYM (Qzero_width
, "zero-width");
29187 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
29188 /* Intern this now in case it isn't already done.
29189 Setting this variable twice is harmless.
29190 But don't staticpro it here--that is done in alloc.c. */
29191 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
29192 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
29194 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
29195 doc
: /* Char-table defining glyphless characters.
29196 Each element, if non-nil, should be one of the following:
29197 an ASCII acronym string: display this string in a box
29198 `hex-code': display the hexadecimal code of a character in a box
29199 `empty-box': display as an empty box
29200 `thin-space': display as 1-pixel width space
29201 `zero-width': don't display
29202 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29203 display method for graphical terminals and text terminals respectively.
29204 GRAPHICAL and TEXT should each have one of the values listed above.
29206 The char-table has one extra slot to control the display of a character for
29207 which no font is found. This slot only takes effect on graphical terminals.
29208 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29209 `thin-space'. The default is `empty-box'. */);
29210 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29211 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29214 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
29215 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
29216 Vdebug_on_message
= Qnil
;
29220 /* Initialize this module when Emacs starts. */
29225 current_header_line_height
= current_mode_line_height
= -1;
29227 CHARPOS (this_line_start_pos
) = 0;
29229 if (!noninteractive
)
29231 struct window
*m
= XWINDOW (minibuf_window
);
29232 Lisp_Object frame
= m
->frame
;
29233 struct frame
*f
= XFRAME (frame
);
29234 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29235 struct window
*r
= XWINDOW (root
);
29238 echo_area_window
= minibuf_window
;
29240 wset_top_line (r
, make_number (FRAME_TOP_MARGIN (f
)));
29242 (r
, make_number (FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
)));
29243 wset_total_cols (r
, make_number (FRAME_COLS (f
)));
29244 wset_top_line (m
, make_number (FRAME_LINES (f
) - 1));
29245 wset_total_lines (m
, make_number (1));
29246 wset_total_cols (m
, make_number (FRAME_COLS (f
)));
29248 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29249 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29250 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29252 /* The default ellipsis glyphs `...'. */
29253 for (i
= 0; i
< 3; ++i
)
29254 default_invis_vector
[i
] = make_number ('.');
29258 /* Allocate the buffer for frame titles.
29259 Also used for `format-mode-line'. */
29261 mode_line_noprop_buf
= xmalloc (size
);
29262 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29263 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29264 mode_line_target
= MODE_LINE_DISPLAY
;
29267 help_echo_showing_p
= 0;
29270 /* Platform-independent portion of hourglass implementation. */
29272 /* Cancel a currently active hourglass timer, and start a new one. */
29274 start_hourglass (void)
29276 #if defined (HAVE_WINDOW_SYSTEM)
29279 cancel_hourglass ();
29281 if (INTEGERP (Vhourglass_delay
)
29282 && XINT (Vhourglass_delay
) > 0)
29283 delay
= make_emacs_time (min (XINT (Vhourglass_delay
),
29284 TYPE_MAXIMUM (time_t)),
29286 else if (FLOATP (Vhourglass_delay
)
29287 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29288 delay
= EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (Vhourglass_delay
));
29290 delay
= make_emacs_time (DEFAULT_HOURGLASS_DELAY
, 0);
29294 extern void w32_note_current_window (void);
29295 w32_note_current_window ();
29297 #endif /* HAVE_NTGUI */
29299 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29300 show_hourglass
, NULL
);
29305 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29308 cancel_hourglass (void)
29310 #if defined (HAVE_WINDOW_SYSTEM)
29311 if (hourglass_atimer
)
29313 cancel_atimer (hourglass_atimer
);
29314 hourglass_atimer
= NULL
;
29317 if (hourglass_shown_p
)