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 (IT_CHARPOS (*it
) - 1, -1, &IT_BYTEPOS (*it
));
5913 /* Move IT to the next line start.
5915 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5916 we skipped over part of the text (as opposed to moving the iterator
5917 continuously over the text). Otherwise, don't change the value
5920 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5921 iterator on the newline, if it was found.
5923 Newlines may come from buffer text, overlay strings, or strings
5924 displayed via the `display' property. That's the reason we can't
5925 simply use find_next_newline_no_quit.
5927 Note that this function may not skip over invisible text that is so
5928 because of text properties and immediately follows a newline. If
5929 it would, function reseat_at_next_visible_line_start, when called
5930 from set_iterator_to_next, would effectively make invisible
5931 characters following a newline part of the wrong glyph row, which
5932 leads to wrong cursor motion. */
5935 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5936 struct bidi_it
*bidi_it_prev
)
5938 ptrdiff_t old_selective
;
5939 int newline_found_p
, n
;
5940 const int MAX_NEWLINE_DISTANCE
= 500;
5942 /* If already on a newline, just consume it to avoid unintended
5943 skipping over invisible text below. */
5944 if (it
->what
== IT_CHARACTER
5946 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5948 if (it
->bidi_p
&& bidi_it_prev
)
5949 *bidi_it_prev
= it
->bidi_it
;
5950 set_iterator_to_next (it
, 0);
5955 /* Don't handle selective display in the following. It's (a)
5956 unnecessary because it's done by the caller, and (b) leads to an
5957 infinite recursion because next_element_from_ellipsis indirectly
5958 calls this function. */
5959 old_selective
= it
->selective
;
5962 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5963 from buffer text. */
5964 for (n
= newline_found_p
= 0;
5965 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5966 n
+= STRINGP (it
->string
) ? 0 : 1)
5968 if (!get_next_display_element (it
))
5970 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5971 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5972 *bidi_it_prev
= it
->bidi_it
;
5973 set_iterator_to_next (it
, 0);
5976 /* If we didn't find a newline near enough, see if we can use a
5978 if (!newline_found_p
)
5980 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
5981 ptrdiff_t limit
= find_next_newline (start
, 1, &bytepos
);
5984 eassert (!STRINGP (it
->string
));
5986 /* If there isn't any `display' property in sight, and no
5987 overlays, we can just use the position of the newline in
5989 if (it
->stop_charpos
>= limit
5990 || ((pos
= Fnext_single_property_change (make_number (start
),
5992 make_number (limit
)),
5994 && next_overlay_change (start
) == ZV
))
5998 IT_CHARPOS (*it
) = limit
;
5999 IT_BYTEPOS (*it
) = bytepos
;
6003 struct bidi_it bprev
;
6005 /* Help bidi.c avoid expensive searches for display
6006 properties and overlays, by telling it that there are
6007 none up to `limit'. */
6008 if (it
->bidi_it
.disp_pos
< limit
)
6010 it
->bidi_it
.disp_pos
= limit
;
6011 it
->bidi_it
.disp_prop
= 0;
6014 bprev
= it
->bidi_it
;
6015 bidi_move_to_visually_next (&it
->bidi_it
);
6016 } while (it
->bidi_it
.charpos
!= limit
);
6017 IT_CHARPOS (*it
) = limit
;
6018 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6020 *bidi_it_prev
= bprev
;
6022 *skipped_p
= newline_found_p
= 1;
6026 while (get_next_display_element (it
)
6027 && !newline_found_p
)
6029 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6030 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6031 *bidi_it_prev
= it
->bidi_it
;
6032 set_iterator_to_next (it
, 0);
6037 it
->selective
= old_selective
;
6038 return newline_found_p
;
6042 /* Set IT's current position to the previous visible line start. Skip
6043 invisible text that is so either due to text properties or due to
6044 selective display. Caution: this does not change IT->current_x and
6048 back_to_previous_visible_line_start (struct it
*it
)
6050 while (IT_CHARPOS (*it
) > BEGV
)
6052 back_to_previous_line_start (it
);
6054 if (IT_CHARPOS (*it
) <= BEGV
)
6057 /* If selective > 0, then lines indented more than its value are
6059 if (it
->selective
> 0
6060 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6064 /* Check the newline before point for invisibility. */
6067 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6068 Qinvisible
, it
->window
);
6069 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6073 if (IT_CHARPOS (*it
) <= BEGV
)
6078 void *it2data
= NULL
;
6081 Lisp_Object val
, overlay
;
6083 SAVE_IT (it2
, *it
, it2data
);
6085 /* If newline is part of a composition, continue from start of composition */
6086 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6087 && beg
< IT_CHARPOS (*it
))
6090 /* If newline is replaced by a display property, find start of overlay
6091 or interval and continue search from that point. */
6092 pos
= --IT_CHARPOS (it2
);
6095 bidi_unshelve_cache (NULL
, 0);
6096 it2
.string_from_display_prop_p
= 0;
6097 it2
.from_disp_prop_p
= 0;
6098 if (handle_display_prop (&it2
) == HANDLED_RETURN
6099 && !NILP (val
= get_char_property_and_overlay
6100 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6101 && (OVERLAYP (overlay
)
6102 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6103 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6105 RESTORE_IT (it
, it
, it2data
);
6109 /* Newline is not replaced by anything -- so we are done. */
6110 RESTORE_IT (it
, it
, it2data
);
6116 IT_CHARPOS (*it
) = beg
;
6117 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6121 it
->continuation_lines_width
= 0;
6123 eassert (IT_CHARPOS (*it
) >= BEGV
);
6124 eassert (IT_CHARPOS (*it
) == BEGV
6125 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6130 /* Reseat iterator IT at the previous visible line start. Skip
6131 invisible text that is so either due to text properties or due to
6132 selective display. At the end, update IT's overlay information,
6133 face information etc. */
6136 reseat_at_previous_visible_line_start (struct it
*it
)
6138 back_to_previous_visible_line_start (it
);
6139 reseat (it
, it
->current
.pos
, 1);
6144 /* Reseat iterator IT on the next visible line start in the current
6145 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6146 preceding the line start. Skip over invisible text that is so
6147 because of selective display. Compute faces, overlays etc at the
6148 new position. Note that this function does not skip over text that
6149 is invisible because of text properties. */
6152 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6154 int newline_found_p
, skipped_p
= 0;
6155 struct bidi_it bidi_it_prev
;
6157 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6159 /* Skip over lines that are invisible because they are indented
6160 more than the value of IT->selective. */
6161 if (it
->selective
> 0)
6162 while (IT_CHARPOS (*it
) < ZV
6163 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6166 eassert (IT_BYTEPOS (*it
) == BEGV
6167 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6169 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6172 /* Position on the newline if that's what's requested. */
6173 if (on_newline_p
&& newline_found_p
)
6175 if (STRINGP (it
->string
))
6177 if (IT_STRING_CHARPOS (*it
) > 0)
6181 --IT_STRING_CHARPOS (*it
);
6182 --IT_STRING_BYTEPOS (*it
);
6186 /* We need to restore the bidi iterator to the state
6187 it had on the newline, and resync the IT's
6188 position with that. */
6189 it
->bidi_it
= bidi_it_prev
;
6190 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6191 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6195 else if (IT_CHARPOS (*it
) > BEGV
)
6204 /* We need to restore the bidi iterator to the state it
6205 had on the newline and resync IT with that. */
6206 it
->bidi_it
= bidi_it_prev
;
6207 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6208 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6210 reseat (it
, it
->current
.pos
, 0);
6214 reseat (it
, it
->current
.pos
, 0);
6221 /***********************************************************************
6222 Changing an iterator's position
6223 ***********************************************************************/
6225 /* Change IT's current position to POS in current_buffer. If FORCE_P
6226 is non-zero, always check for text properties at the new position.
6227 Otherwise, text properties are only looked up if POS >=
6228 IT->check_charpos of a property. */
6231 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6233 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6235 reseat_1 (it
, pos
, 0);
6237 /* Determine where to check text properties. Avoid doing it
6238 where possible because text property lookup is very expensive. */
6240 || CHARPOS (pos
) > it
->stop_charpos
6241 || CHARPOS (pos
) < original_pos
)
6245 /* For bidi iteration, we need to prime prev_stop and
6246 base_level_stop with our best estimations. */
6247 /* Implementation note: Of course, POS is not necessarily a
6248 stop position, so assigning prev_pos to it is a lie; we
6249 should have called compute_stop_backwards. However, if
6250 the current buffer does not include any R2L characters,
6251 that call would be a waste of cycles, because the
6252 iterator will never move back, and thus never cross this
6253 "fake" stop position. So we delay that backward search
6254 until the time we really need it, in next_element_from_buffer. */
6255 if (CHARPOS (pos
) != it
->prev_stop
)
6256 it
->prev_stop
= CHARPOS (pos
);
6257 if (CHARPOS (pos
) < it
->base_level_stop
)
6258 it
->base_level_stop
= 0; /* meaning it's unknown */
6264 it
->prev_stop
= it
->base_level_stop
= 0;
6273 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6274 IT->stop_pos to POS, also. */
6277 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6279 /* Don't call this function when scanning a C string. */
6280 eassert (it
->s
== NULL
);
6282 /* POS must be a reasonable value. */
6283 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6285 it
->current
.pos
= it
->position
= pos
;
6286 it
->end_charpos
= ZV
;
6288 it
->current
.dpvec_index
= -1;
6289 it
->current
.overlay_string_index
= -1;
6290 IT_STRING_CHARPOS (*it
) = -1;
6291 IT_STRING_BYTEPOS (*it
) = -1;
6293 it
->method
= GET_FROM_BUFFER
;
6294 it
->object
= it
->w
->buffer
;
6295 it
->area
= TEXT_AREA
;
6296 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6298 it
->string_from_display_prop_p
= 0;
6299 it
->string_from_prefix_prop_p
= 0;
6301 it
->from_disp_prop_p
= 0;
6302 it
->face_before_selective_p
= 0;
6305 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6307 bidi_unshelve_cache (NULL
, 0);
6308 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6309 it
->bidi_it
.string
.s
= NULL
;
6310 it
->bidi_it
.string
.lstring
= Qnil
;
6311 it
->bidi_it
.string
.bufpos
= 0;
6312 it
->bidi_it
.string
.unibyte
= 0;
6317 it
->stop_charpos
= CHARPOS (pos
);
6318 it
->base_level_stop
= CHARPOS (pos
);
6320 /* This make the information stored in it->cmp_it invalidate. */
6325 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6326 If S is non-null, it is a C string to iterate over. Otherwise,
6327 STRING gives a Lisp string to iterate over.
6329 If PRECISION > 0, don't return more then PRECISION number of
6330 characters from the string.
6332 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6333 characters have been returned. FIELD_WIDTH < 0 means an infinite
6336 MULTIBYTE = 0 means disable processing of multibyte characters,
6337 MULTIBYTE > 0 means enable it,
6338 MULTIBYTE < 0 means use IT->multibyte_p.
6340 IT must be initialized via a prior call to init_iterator before
6341 calling this function. */
6344 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6345 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6348 /* No region in strings. */
6349 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6351 /* No text property checks performed by default, but see below. */
6352 it
->stop_charpos
= -1;
6354 /* Set iterator position and end position. */
6355 memset (&it
->current
, 0, sizeof it
->current
);
6356 it
->current
.overlay_string_index
= -1;
6357 it
->current
.dpvec_index
= -1;
6358 eassert (charpos
>= 0);
6360 /* If STRING is specified, use its multibyteness, otherwise use the
6361 setting of MULTIBYTE, if specified. */
6363 it
->multibyte_p
= multibyte
> 0;
6365 /* Bidirectional reordering of strings is controlled by the default
6366 value of bidi-display-reordering. Don't try to reorder while
6367 loading loadup.el, as the necessary character property tables are
6368 not yet available. */
6371 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6375 eassert (STRINGP (string
));
6376 it
->string
= string
;
6378 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6379 it
->method
= GET_FROM_STRING
;
6380 it
->current
.string_pos
= string_pos (charpos
, string
);
6384 it
->bidi_it
.string
.lstring
= string
;
6385 it
->bidi_it
.string
.s
= NULL
;
6386 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6387 it
->bidi_it
.string
.bufpos
= 0;
6388 it
->bidi_it
.string
.from_disp_str
= 0;
6389 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6390 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6391 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6396 it
->s
= (const unsigned char *) s
;
6399 /* Note that we use IT->current.pos, not it->current.string_pos,
6400 for displaying C strings. */
6401 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6402 if (it
->multibyte_p
)
6404 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6405 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6409 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6410 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6415 it
->bidi_it
.string
.lstring
= Qnil
;
6416 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6417 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6418 it
->bidi_it
.string
.bufpos
= 0;
6419 it
->bidi_it
.string
.from_disp_str
= 0;
6420 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6421 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6424 it
->method
= GET_FROM_C_STRING
;
6427 /* PRECISION > 0 means don't return more than PRECISION characters
6429 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6431 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6433 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6436 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6437 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6438 FIELD_WIDTH < 0 means infinite field width. This is useful for
6439 padding with `-' at the end of a mode line. */
6440 if (field_width
< 0)
6441 field_width
= INFINITY
;
6442 /* Implementation note: We deliberately don't enlarge
6443 it->bidi_it.string.schars here to fit it->end_charpos, because
6444 the bidi iterator cannot produce characters out of thin air. */
6445 if (field_width
> it
->end_charpos
- charpos
)
6446 it
->end_charpos
= charpos
+ field_width
;
6448 /* Use the standard display table for displaying strings. */
6449 if (DISP_TABLE_P (Vstandard_display_table
))
6450 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6452 it
->stop_charpos
= charpos
;
6453 it
->prev_stop
= charpos
;
6454 it
->base_level_stop
= 0;
6457 it
->bidi_it
.first_elt
= 1;
6458 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6459 it
->bidi_it
.disp_pos
= -1;
6461 if (s
== NULL
&& it
->multibyte_p
)
6463 ptrdiff_t endpos
= SCHARS (it
->string
);
6464 if (endpos
> it
->end_charpos
)
6465 endpos
= it
->end_charpos
;
6466 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6474 /***********************************************************************
6476 ***********************************************************************/
6478 /* Map enum it_method value to corresponding next_element_from_* function. */
6480 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6482 next_element_from_buffer
,
6483 next_element_from_display_vector
,
6484 next_element_from_string
,
6485 next_element_from_c_string
,
6486 next_element_from_image
,
6487 next_element_from_stretch
6490 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6493 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6494 (possibly with the following characters). */
6496 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6497 ((IT)->cmp_it.id >= 0 \
6498 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6499 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6500 END_CHARPOS, (IT)->w, \
6501 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6505 /* Lookup the char-table Vglyphless_char_display for character C (-1
6506 if we want information for no-font case), and return the display
6507 method symbol. By side-effect, update it->what and
6508 it->glyphless_method. This function is called from
6509 get_next_display_element for each character element, and from
6510 x_produce_glyphs when no suitable font was found. */
6513 lookup_glyphless_char_display (int c
, struct it
*it
)
6515 Lisp_Object glyphless_method
= Qnil
;
6517 if (CHAR_TABLE_P (Vglyphless_char_display
)
6518 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6522 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6523 if (CONSP (glyphless_method
))
6524 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6525 ? XCAR (glyphless_method
)
6526 : XCDR (glyphless_method
);
6529 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6533 if (NILP (glyphless_method
))
6536 /* The default is to display the character by a proper font. */
6538 /* The default for the no-font case is to display an empty box. */
6539 glyphless_method
= Qempty_box
;
6541 if (EQ (glyphless_method
, Qzero_width
))
6544 return glyphless_method
;
6545 /* This method can't be used for the no-font case. */
6546 glyphless_method
= Qempty_box
;
6548 if (EQ (glyphless_method
, Qthin_space
))
6549 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6550 else if (EQ (glyphless_method
, Qempty_box
))
6551 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6552 else if (EQ (glyphless_method
, Qhex_code
))
6553 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6554 else if (STRINGP (glyphless_method
))
6555 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6558 /* Invalid value. We use the default method. */
6559 glyphless_method
= Qnil
;
6562 it
->what
= IT_GLYPHLESS
;
6563 return glyphless_method
;
6566 /* Load IT's display element fields with information about the next
6567 display element from the current position of IT. Value is zero if
6568 end of buffer (or C string) is reached. */
6570 static struct frame
*last_escape_glyph_frame
= NULL
;
6571 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6572 static int last_escape_glyph_merged_face_id
= 0;
6574 struct frame
*last_glyphless_glyph_frame
= NULL
;
6575 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6576 int last_glyphless_glyph_merged_face_id
= 0;
6579 get_next_display_element (struct it
*it
)
6581 /* Non-zero means that we found a display element. Zero means that
6582 we hit the end of what we iterate over. Performance note: the
6583 function pointer `method' used here turns out to be faster than
6584 using a sequence of if-statements. */
6588 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6590 if (it
->what
== IT_CHARACTER
)
6592 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6593 and only if (a) the resolved directionality of that character
6595 /* FIXME: Do we need an exception for characters from display
6597 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6598 it
->c
= bidi_mirror_char (it
->c
);
6599 /* Map via display table or translate control characters.
6600 IT->c, IT->len etc. have been set to the next character by
6601 the function call above. If we have a display table, and it
6602 contains an entry for IT->c, translate it. Don't do this if
6603 IT->c itself comes from a display table, otherwise we could
6604 end up in an infinite recursion. (An alternative could be to
6605 count the recursion depth of this function and signal an
6606 error when a certain maximum depth is reached.) Is it worth
6608 if (success_p
&& it
->dpvec
== NULL
)
6611 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6612 int nonascii_space_p
= 0;
6613 int nonascii_hyphen_p
= 0;
6614 int c
= it
->c
; /* This is the character to display. */
6616 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6618 eassert (SINGLE_BYTE_CHAR_P (c
));
6619 if (unibyte_display_via_language_environment
)
6621 c
= DECODE_CHAR (unibyte
, c
);
6623 c
= BYTE8_TO_CHAR (it
->c
);
6626 c
= BYTE8_TO_CHAR (it
->c
);
6630 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6633 struct Lisp_Vector
*v
= XVECTOR (dv
);
6635 /* Return the first character from the display table
6636 entry, if not empty. If empty, don't display the
6637 current character. */
6640 it
->dpvec_char_len
= it
->len
;
6641 it
->dpvec
= v
->contents
;
6642 it
->dpend
= v
->contents
+ v
->header
.size
;
6643 it
->current
.dpvec_index
= 0;
6644 it
->dpvec_face_id
= -1;
6645 it
->saved_face_id
= it
->face_id
;
6646 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6651 set_iterator_to_next (it
, 0);
6656 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6658 if (it
->what
== IT_GLYPHLESS
)
6660 /* Don't display this character. */
6661 set_iterator_to_next (it
, 0);
6665 /* If `nobreak-char-display' is non-nil, we display
6666 non-ASCII spaces and hyphens specially. */
6667 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6670 nonascii_space_p
= 1;
6671 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6672 nonascii_hyphen_p
= 1;
6675 /* Translate control characters into `\003' or `^C' form.
6676 Control characters coming from a display table entry are
6677 currently not translated because we use IT->dpvec to hold
6678 the translation. This could easily be changed but I
6679 don't believe that it is worth doing.
6681 The characters handled by `nobreak-char-display' must be
6684 Non-printable characters and raw-byte characters are also
6685 translated to octal form. */
6686 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6687 ? (it
->area
!= TEXT_AREA
6688 /* In mode line, treat \n, \t like other crl chars. */
6691 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6692 || (c
!= '\n' && c
!= '\t'))
6694 || nonascii_hyphen_p
6696 || ! CHAR_PRINTABLE_P (c
))))
6698 /* C is a control character, non-ASCII space/hyphen,
6699 raw-byte, or a non-printable character which must be
6700 displayed either as '\003' or as `^C' where the '\\'
6701 and '^' can be defined in the display table. Fill
6702 IT->ctl_chars with glyphs for what we have to
6703 display. Then, set IT->dpvec to these glyphs. */
6710 /* Handle control characters with ^. */
6712 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6716 g
= '^'; /* default glyph for Control */
6717 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6719 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6721 g
= GLYPH_CODE_CHAR (gc
);
6722 lface_id
= GLYPH_CODE_FACE (gc
);
6726 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6728 else if (it
->f
== last_escape_glyph_frame
6729 && it
->face_id
== last_escape_glyph_face_id
)
6731 face_id
= last_escape_glyph_merged_face_id
;
6735 /* Merge the escape-glyph face into the current face. */
6736 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6738 last_escape_glyph_frame
= it
->f
;
6739 last_escape_glyph_face_id
= it
->face_id
;
6740 last_escape_glyph_merged_face_id
= face_id
;
6743 XSETINT (it
->ctl_chars
[0], g
);
6744 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6746 goto display_control
;
6749 /* Handle non-ascii space in the mode where it only gets
6752 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6754 /* Merge `nobreak-space' into the current face. */
6755 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6757 XSETINT (it
->ctl_chars
[0], ' ');
6759 goto display_control
;
6762 /* Handle sequences that start with the "escape glyph". */
6764 /* the default escape glyph is \. */
6765 escape_glyph
= '\\';
6768 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6770 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6771 lface_id
= GLYPH_CODE_FACE (gc
);
6775 /* The display table specified a face.
6776 Merge it into face_id and also into escape_glyph. */
6777 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6780 else if (it
->f
== last_escape_glyph_frame
6781 && it
->face_id
== last_escape_glyph_face_id
)
6783 face_id
= last_escape_glyph_merged_face_id
;
6787 /* Merge the escape-glyph face into the current face. */
6788 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6790 last_escape_glyph_frame
= it
->f
;
6791 last_escape_glyph_face_id
= it
->face_id
;
6792 last_escape_glyph_merged_face_id
= face_id
;
6795 /* Draw non-ASCII hyphen with just highlighting: */
6797 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6799 XSETINT (it
->ctl_chars
[0], '-');
6801 goto display_control
;
6804 /* Draw non-ASCII space/hyphen with escape glyph: */
6806 if (nonascii_space_p
|| nonascii_hyphen_p
)
6808 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6809 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6811 goto display_control
;
6818 if (CHAR_BYTE8_P (c
))
6819 /* Display \200 instead of \17777600. */
6820 c
= CHAR_TO_BYTE8 (c
);
6821 len
= sprintf (str
, "%03o", c
);
6823 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6824 for (i
= 0; i
< len
; i
++)
6825 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6830 /* Set up IT->dpvec and return first character from it. */
6831 it
->dpvec_char_len
= it
->len
;
6832 it
->dpvec
= it
->ctl_chars
;
6833 it
->dpend
= it
->dpvec
+ ctl_len
;
6834 it
->current
.dpvec_index
= 0;
6835 it
->dpvec_face_id
= face_id
;
6836 it
->saved_face_id
= it
->face_id
;
6837 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6841 it
->char_to_display
= c
;
6845 it
->char_to_display
= it
->c
;
6849 /* Adjust face id for a multibyte character. There are no multibyte
6850 character in unibyte text. */
6851 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6854 && FRAME_WINDOW_P (it
->f
))
6856 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6858 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6860 /* Automatic composition with glyph-string. */
6861 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6863 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6867 ptrdiff_t pos
= (it
->s
? -1
6868 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6869 : IT_CHARPOS (*it
));
6872 if (it
->what
== IT_CHARACTER
)
6873 c
= it
->char_to_display
;
6876 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6880 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6881 /* TAB in a composition means display glyphs with
6882 padding space on the left or right. */
6883 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6886 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6891 /* Is this character the last one of a run of characters with
6892 box? If yes, set IT->end_of_box_run_p to 1. */
6896 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6898 int face_id
= underlying_face_id (it
);
6899 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6903 if (face
->box
== FACE_NO_BOX
)
6905 /* If the box comes from face properties in a
6906 display string, check faces in that string. */
6907 int string_face_id
= face_after_it_pos (it
);
6908 it
->end_of_box_run_p
6909 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6912 /* Otherwise, the box comes from the underlying face.
6913 If this is the last string character displayed, check
6914 the next buffer location. */
6915 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6916 && (it
->current
.overlay_string_index
6917 == it
->n_overlay_strings
- 1))
6921 struct text_pos pos
= it
->current
.pos
;
6922 INC_TEXT_POS (pos
, it
->multibyte_p
);
6924 next_face_id
= face_at_buffer_position
6925 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6926 it
->region_end_charpos
, &ignore
,
6927 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6929 it
->end_of_box_run_p
6930 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6937 int face_id
= face_after_it_pos (it
);
6938 it
->end_of_box_run_p
6939 = (face_id
!= it
->face_id
6940 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6943 /* If we reached the end of the object we've been iterating (e.g., a
6944 display string or an overlay string), and there's something on
6945 IT->stack, proceed with what's on the stack. It doesn't make
6946 sense to return zero if there's unprocessed stuff on the stack,
6947 because otherwise that stuff will never be displayed. */
6948 if (!success_p
&& it
->sp
> 0)
6950 set_iterator_to_next (it
, 0);
6951 success_p
= get_next_display_element (it
);
6954 /* Value is 0 if end of buffer or string reached. */
6959 /* Move IT to the next display element.
6961 RESEAT_P non-zero means if called on a newline in buffer text,
6962 skip to the next visible line start.
6964 Functions get_next_display_element and set_iterator_to_next are
6965 separate because I find this arrangement easier to handle than a
6966 get_next_display_element function that also increments IT's
6967 position. The way it is we can first look at an iterator's current
6968 display element, decide whether it fits on a line, and if it does,
6969 increment the iterator position. The other way around we probably
6970 would either need a flag indicating whether the iterator has to be
6971 incremented the next time, or we would have to implement a
6972 decrement position function which would not be easy to write. */
6975 set_iterator_to_next (struct it
*it
, int reseat_p
)
6977 /* Reset flags indicating start and end of a sequence of characters
6978 with box. Reset them at the start of this function because
6979 moving the iterator to a new position might set them. */
6980 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6984 case GET_FROM_BUFFER
:
6985 /* The current display element of IT is a character from
6986 current_buffer. Advance in the buffer, and maybe skip over
6987 invisible lines that are so because of selective display. */
6988 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6989 reseat_at_next_visible_line_start (it
, 0);
6990 else if (it
->cmp_it
.id
>= 0)
6992 /* We are currently getting glyphs from a composition. */
6997 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6998 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6999 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7001 it
->cmp_it
.from
= it
->cmp_it
.to
;
7006 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7008 it
->end_charpos
, Qnil
);
7011 else if (! it
->cmp_it
.reversed_p
)
7013 /* Composition created while scanning forward. */
7014 /* Update IT's char/byte positions to point to the first
7015 character of the next grapheme cluster, or to the
7016 character visually after the current composition. */
7017 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7018 bidi_move_to_visually_next (&it
->bidi_it
);
7019 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7020 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7022 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7024 /* Proceed to the next grapheme cluster. */
7025 it
->cmp_it
.from
= it
->cmp_it
.to
;
7029 /* No more grapheme clusters in this composition.
7030 Find the next stop position. */
7031 ptrdiff_t stop
= it
->end_charpos
;
7032 if (it
->bidi_it
.scan_dir
< 0)
7033 /* Now we are scanning backward and don't know
7036 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7037 IT_BYTEPOS (*it
), stop
, Qnil
);
7042 /* Composition created while scanning backward. */
7043 /* Update IT's char/byte positions to point to the last
7044 character of the previous grapheme cluster, or the
7045 character visually after the current composition. */
7046 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7047 bidi_move_to_visually_next (&it
->bidi_it
);
7048 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7049 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7050 if (it
->cmp_it
.from
> 0)
7052 /* Proceed to the previous grapheme cluster. */
7053 it
->cmp_it
.to
= it
->cmp_it
.from
;
7057 /* No more grapheme clusters in this composition.
7058 Find the next stop position. */
7059 ptrdiff_t stop
= it
->end_charpos
;
7060 if (it
->bidi_it
.scan_dir
< 0)
7061 /* Now we are scanning backward and don't know
7064 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7065 IT_BYTEPOS (*it
), stop
, Qnil
);
7071 eassert (it
->len
!= 0);
7075 IT_BYTEPOS (*it
) += it
->len
;
7076 IT_CHARPOS (*it
) += 1;
7080 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7081 /* If this is a new paragraph, determine its base
7082 direction (a.k.a. its base embedding level). */
7083 if (it
->bidi_it
.new_paragraph
)
7084 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7085 bidi_move_to_visually_next (&it
->bidi_it
);
7086 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7087 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7088 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7090 /* As the scan direction was changed, we must
7091 re-compute the stop position for composition. */
7092 ptrdiff_t stop
= it
->end_charpos
;
7093 if (it
->bidi_it
.scan_dir
< 0)
7095 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7096 IT_BYTEPOS (*it
), stop
, Qnil
);
7099 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7103 case GET_FROM_C_STRING
:
7104 /* Current display element of IT is from a C string. */
7106 /* If the string position is beyond string's end, it means
7107 next_element_from_c_string is padding the string with
7108 blanks, in which case we bypass the bidi iterator,
7109 because it cannot deal with such virtual characters. */
7110 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7112 IT_BYTEPOS (*it
) += it
->len
;
7113 IT_CHARPOS (*it
) += 1;
7117 bidi_move_to_visually_next (&it
->bidi_it
);
7118 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7119 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7123 case GET_FROM_DISPLAY_VECTOR
:
7124 /* Current display element of IT is from a display table entry.
7125 Advance in the display table definition. Reset it to null if
7126 end reached, and continue with characters from buffers/
7128 ++it
->current
.dpvec_index
;
7130 /* Restore face of the iterator to what they were before the
7131 display vector entry (these entries may contain faces). */
7132 it
->face_id
= it
->saved_face_id
;
7134 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7136 int recheck_faces
= it
->ellipsis_p
;
7139 it
->method
= GET_FROM_C_STRING
;
7140 else if (STRINGP (it
->string
))
7141 it
->method
= GET_FROM_STRING
;
7144 it
->method
= GET_FROM_BUFFER
;
7145 it
->object
= it
->w
->buffer
;
7149 it
->current
.dpvec_index
= -1;
7151 /* Skip over characters which were displayed via IT->dpvec. */
7152 if (it
->dpvec_char_len
< 0)
7153 reseat_at_next_visible_line_start (it
, 1);
7154 else if (it
->dpvec_char_len
> 0)
7156 if (it
->method
== GET_FROM_STRING
7157 && it
->n_overlay_strings
> 0)
7158 it
->ignore_overlay_strings_at_pos_p
= 1;
7159 it
->len
= it
->dpvec_char_len
;
7160 set_iterator_to_next (it
, reseat_p
);
7163 /* Maybe recheck faces after display vector */
7165 it
->stop_charpos
= IT_CHARPOS (*it
);
7169 case GET_FROM_STRING
:
7170 /* Current display element is a character from a Lisp string. */
7171 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7172 /* Don't advance past string end. These conditions are true
7173 when set_iterator_to_next is called at the end of
7174 get_next_display_element, in which case the Lisp string is
7175 already exhausted, and all we want is pop the iterator
7177 if (it
->current
.overlay_string_index
>= 0)
7179 /* This is an overlay string, so there's no padding with
7180 spaces, and the number of characters in the string is
7181 where the string ends. */
7182 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7183 goto consider_string_end
;
7187 /* Not an overlay string. There could be padding, so test
7188 against it->end_charpos . */
7189 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7190 goto consider_string_end
;
7192 if (it
->cmp_it
.id
>= 0)
7198 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7199 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7200 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7201 it
->cmp_it
.from
= it
->cmp_it
.to
;
7205 composition_compute_stop_pos (&it
->cmp_it
,
7206 IT_STRING_CHARPOS (*it
),
7207 IT_STRING_BYTEPOS (*it
),
7208 it
->end_charpos
, it
->string
);
7211 else if (! it
->cmp_it
.reversed_p
)
7213 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7214 bidi_move_to_visually_next (&it
->bidi_it
);
7215 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7216 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7218 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7219 it
->cmp_it
.from
= it
->cmp_it
.to
;
7222 ptrdiff_t stop
= it
->end_charpos
;
7223 if (it
->bidi_it
.scan_dir
< 0)
7225 composition_compute_stop_pos (&it
->cmp_it
,
7226 IT_STRING_CHARPOS (*it
),
7227 IT_STRING_BYTEPOS (*it
), stop
,
7233 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7234 bidi_move_to_visually_next (&it
->bidi_it
);
7235 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7236 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7237 if (it
->cmp_it
.from
> 0)
7238 it
->cmp_it
.to
= it
->cmp_it
.from
;
7241 ptrdiff_t stop
= it
->end_charpos
;
7242 if (it
->bidi_it
.scan_dir
< 0)
7244 composition_compute_stop_pos (&it
->cmp_it
,
7245 IT_STRING_CHARPOS (*it
),
7246 IT_STRING_BYTEPOS (*it
), stop
,
7254 /* If the string position is beyond string's end, it
7255 means next_element_from_string is padding the string
7256 with blanks, in which case we bypass the bidi
7257 iterator, because it cannot deal with such virtual
7259 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7261 IT_STRING_BYTEPOS (*it
) += it
->len
;
7262 IT_STRING_CHARPOS (*it
) += 1;
7266 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7268 bidi_move_to_visually_next (&it
->bidi_it
);
7269 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7270 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7271 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7273 ptrdiff_t stop
= it
->end_charpos
;
7275 if (it
->bidi_it
.scan_dir
< 0)
7277 composition_compute_stop_pos (&it
->cmp_it
,
7278 IT_STRING_CHARPOS (*it
),
7279 IT_STRING_BYTEPOS (*it
), stop
,
7285 consider_string_end
:
7287 if (it
->current
.overlay_string_index
>= 0)
7289 /* IT->string is an overlay string. Advance to the
7290 next, if there is one. */
7291 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7294 next_overlay_string (it
);
7296 setup_for_ellipsis (it
, 0);
7301 /* IT->string is not an overlay string. If we reached
7302 its end, and there is something on IT->stack, proceed
7303 with what is on the stack. This can be either another
7304 string, this time an overlay string, or a buffer. */
7305 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7309 if (it
->method
== GET_FROM_STRING
)
7310 goto consider_string_end
;
7315 case GET_FROM_IMAGE
:
7316 case GET_FROM_STRETCH
:
7317 /* The position etc with which we have to proceed are on
7318 the stack. The position may be at the end of a string,
7319 if the `display' property takes up the whole string. */
7320 eassert (it
->sp
> 0);
7322 if (it
->method
== GET_FROM_STRING
)
7323 goto consider_string_end
;
7327 /* There are no other methods defined, so this should be a bug. */
7331 eassert (it
->method
!= GET_FROM_STRING
7332 || (STRINGP (it
->string
)
7333 && IT_STRING_CHARPOS (*it
) >= 0));
7336 /* Load IT's display element fields with information about the next
7337 display element which comes from a display table entry or from the
7338 result of translating a control character to one of the forms `^C'
7341 IT->dpvec holds the glyphs to return as characters.
7342 IT->saved_face_id holds the face id before the display vector--it
7343 is restored into IT->face_id in set_iterator_to_next. */
7346 next_element_from_display_vector (struct it
*it
)
7351 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7353 it
->face_id
= it
->saved_face_id
;
7355 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7356 That seemed totally bogus - so I changed it... */
7357 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7359 if (GLYPH_CODE_P (gc
))
7361 it
->c
= GLYPH_CODE_CHAR (gc
);
7362 it
->len
= CHAR_BYTES (it
->c
);
7364 /* The entry may contain a face id to use. Such a face id is
7365 the id of a Lisp face, not a realized face. A face id of
7366 zero means no face is specified. */
7367 if (it
->dpvec_face_id
>= 0)
7368 it
->face_id
= it
->dpvec_face_id
;
7371 int lface_id
= GLYPH_CODE_FACE (gc
);
7373 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7378 /* Display table entry is invalid. Return a space. */
7379 it
->c
= ' ', it
->len
= 1;
7381 /* Don't change position and object of the iterator here. They are
7382 still the values of the character that had this display table
7383 entry or was translated, and that's what we want. */
7384 it
->what
= IT_CHARACTER
;
7388 /* Get the first element of string/buffer in the visual order, after
7389 being reseated to a new position in a string or a buffer. */
7391 get_visually_first_element (struct it
*it
)
7393 int string_p
= STRINGP (it
->string
) || it
->s
;
7394 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7395 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7397 if (STRINGP (it
->string
))
7399 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7400 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7404 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7405 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7408 if (it
->bidi_it
.charpos
== eob
)
7410 /* Nothing to do, but reset the FIRST_ELT flag, like
7411 bidi_paragraph_init does, because we are not going to
7413 it
->bidi_it
.first_elt
= 0;
7415 else if (it
->bidi_it
.charpos
== bob
7417 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7418 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7420 /* If we are at the beginning of a line/string, we can produce
7421 the next element right away. */
7422 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7423 bidi_move_to_visually_next (&it
->bidi_it
);
7427 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7429 /* We need to prime the bidi iterator starting at the line's or
7430 string's beginning, before we will be able to produce the
7433 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7436 = find_next_newline (IT_CHARPOS (*it
), -1, &it
->bidi_it
.bytepos
);
7437 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7440 /* Now return to buffer/string position where we were asked
7441 to get the next display element, and produce that. */
7442 bidi_move_to_visually_next (&it
->bidi_it
);
7444 while (it
->bidi_it
.bytepos
!= orig_bytepos
7445 && it
->bidi_it
.charpos
< eob
);
7448 /* Adjust IT's position information to where we ended up. */
7449 if (STRINGP (it
->string
))
7451 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7452 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7456 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7457 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7460 if (STRINGP (it
->string
) || !it
->s
)
7462 ptrdiff_t stop
, charpos
, bytepos
;
7464 if (STRINGP (it
->string
))
7467 stop
= SCHARS (it
->string
);
7468 if (stop
> it
->end_charpos
)
7469 stop
= it
->end_charpos
;
7470 charpos
= IT_STRING_CHARPOS (*it
);
7471 bytepos
= IT_STRING_BYTEPOS (*it
);
7475 stop
= it
->end_charpos
;
7476 charpos
= IT_CHARPOS (*it
);
7477 bytepos
= IT_BYTEPOS (*it
);
7479 if (it
->bidi_it
.scan_dir
< 0)
7481 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7486 /* Load IT with the next display element from Lisp string IT->string.
7487 IT->current.string_pos is the current position within the string.
7488 If IT->current.overlay_string_index >= 0, the Lisp string is an
7492 next_element_from_string (struct it
*it
)
7494 struct text_pos position
;
7496 eassert (STRINGP (it
->string
));
7497 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7498 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7499 position
= it
->current
.string_pos
;
7501 /* With bidi reordering, the character to display might not be the
7502 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7503 that we were reseat()ed to a new string, whose paragraph
7504 direction is not known. */
7505 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7507 get_visually_first_element (it
);
7508 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7511 /* Time to check for invisible text? */
7512 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7514 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7517 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7518 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7520 /* With bidi non-linear iteration, we could find
7521 ourselves far beyond the last computed stop_charpos,
7522 with several other stop positions in between that we
7523 missed. Scan them all now, in buffer's logical
7524 order, until we find and handle the last stop_charpos
7525 that precedes our current position. */
7526 handle_stop_backwards (it
, it
->stop_charpos
);
7527 return GET_NEXT_DISPLAY_ELEMENT (it
);
7533 /* Take note of the stop position we just moved
7534 across, for when we will move back across it. */
7535 it
->prev_stop
= it
->stop_charpos
;
7536 /* If we are at base paragraph embedding level, take
7537 note of the last stop position seen at this
7539 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7540 it
->base_level_stop
= it
->stop_charpos
;
7544 /* Since a handler may have changed IT->method, we must
7546 return GET_NEXT_DISPLAY_ELEMENT (it
);
7550 /* If we are before prev_stop, we may have overstepped
7551 on our way backwards a stop_pos, and if so, we need
7552 to handle that stop_pos. */
7553 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7554 /* We can sometimes back up for reasons that have nothing
7555 to do with bidi reordering. E.g., compositions. The
7556 code below is only needed when we are above the base
7557 embedding level, so test for that explicitly. */
7558 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7560 /* If we lost track of base_level_stop, we have no better
7561 place for handle_stop_backwards to start from than string
7562 beginning. This happens, e.g., when we were reseated to
7563 the previous screenful of text by vertical-motion. */
7564 if (it
->base_level_stop
<= 0
7565 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7566 it
->base_level_stop
= 0;
7567 handle_stop_backwards (it
, it
->base_level_stop
);
7568 return GET_NEXT_DISPLAY_ELEMENT (it
);
7572 if (it
->current
.overlay_string_index
>= 0)
7574 /* Get the next character from an overlay string. In overlay
7575 strings, there is no field width or padding with spaces to
7577 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7582 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7583 IT_STRING_BYTEPOS (*it
),
7584 it
->bidi_it
.scan_dir
< 0
7586 : SCHARS (it
->string
))
7587 && next_element_from_composition (it
))
7591 else if (STRING_MULTIBYTE (it
->string
))
7593 const unsigned char *s
= (SDATA (it
->string
)
7594 + IT_STRING_BYTEPOS (*it
));
7595 it
->c
= string_char_and_length (s
, &it
->len
);
7599 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7605 /* Get the next character from a Lisp string that is not an
7606 overlay string. Such strings come from the mode line, for
7607 example. We may have to pad with spaces, or truncate the
7608 string. See also next_element_from_c_string. */
7609 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7614 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7616 /* Pad with spaces. */
7617 it
->c
= ' ', it
->len
= 1;
7618 CHARPOS (position
) = BYTEPOS (position
) = -1;
7620 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7621 IT_STRING_BYTEPOS (*it
),
7622 it
->bidi_it
.scan_dir
< 0
7624 : it
->string_nchars
)
7625 && next_element_from_composition (it
))
7629 else if (STRING_MULTIBYTE (it
->string
))
7631 const unsigned char *s
= (SDATA (it
->string
)
7632 + IT_STRING_BYTEPOS (*it
));
7633 it
->c
= string_char_and_length (s
, &it
->len
);
7637 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7642 /* Record what we have and where it came from. */
7643 it
->what
= IT_CHARACTER
;
7644 it
->object
= it
->string
;
7645 it
->position
= position
;
7650 /* Load IT with next display element from C string IT->s.
7651 IT->string_nchars is the maximum number of characters to return
7652 from the string. IT->end_charpos may be greater than
7653 IT->string_nchars when this function is called, in which case we
7654 may have to return padding spaces. Value is zero if end of string
7655 reached, including padding spaces. */
7658 next_element_from_c_string (struct it
*it
)
7663 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7664 it
->what
= IT_CHARACTER
;
7665 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7668 /* With bidi reordering, the character to display might not be the
7669 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7670 we were reseated to a new string, whose paragraph direction is
7672 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7673 get_visually_first_element (it
);
7675 /* IT's position can be greater than IT->string_nchars in case a
7676 field width or precision has been specified when the iterator was
7678 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7680 /* End of the game. */
7684 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7686 /* Pad with spaces. */
7687 it
->c
= ' ', it
->len
= 1;
7688 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7690 else if (it
->multibyte_p
)
7691 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7693 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7699 /* Set up IT to return characters from an ellipsis, if appropriate.
7700 The definition of the ellipsis glyphs may come from a display table
7701 entry. This function fills IT with the first glyph from the
7702 ellipsis if an ellipsis is to be displayed. */
7705 next_element_from_ellipsis (struct it
*it
)
7707 if (it
->selective_display_ellipsis_p
)
7708 setup_for_ellipsis (it
, it
->len
);
7711 /* The face at the current position may be different from the
7712 face we find after the invisible text. Remember what it
7713 was in IT->saved_face_id, and signal that it's there by
7714 setting face_before_selective_p. */
7715 it
->saved_face_id
= it
->face_id
;
7716 it
->method
= GET_FROM_BUFFER
;
7717 it
->object
= it
->w
->buffer
;
7718 reseat_at_next_visible_line_start (it
, 1);
7719 it
->face_before_selective_p
= 1;
7722 return GET_NEXT_DISPLAY_ELEMENT (it
);
7726 /* Deliver an image display element. The iterator IT is already
7727 filled with image information (done in handle_display_prop). Value
7732 next_element_from_image (struct it
*it
)
7734 it
->what
= IT_IMAGE
;
7735 it
->ignore_overlay_strings_at_pos_p
= 0;
7740 /* Fill iterator IT with next display element from a stretch glyph
7741 property. IT->object is the value of the text property. Value is
7745 next_element_from_stretch (struct it
*it
)
7747 it
->what
= IT_STRETCH
;
7751 /* Scan backwards from IT's current position until we find a stop
7752 position, or until BEGV. This is called when we find ourself
7753 before both the last known prev_stop and base_level_stop while
7754 reordering bidirectional text. */
7757 compute_stop_pos_backwards (struct it
*it
)
7759 const int SCAN_BACK_LIMIT
= 1000;
7760 struct text_pos pos
;
7761 struct display_pos save_current
= it
->current
;
7762 struct text_pos save_position
= it
->position
;
7763 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7764 ptrdiff_t where_we_are
= charpos
;
7765 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7766 ptrdiff_t save_end_pos
= it
->end_charpos
;
7768 eassert (NILP (it
->string
) && !it
->s
);
7769 eassert (it
->bidi_p
);
7773 it
->end_charpos
= min (charpos
+ 1, ZV
);
7774 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7775 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
7776 reseat_1 (it
, pos
, 0);
7777 compute_stop_pos (it
);
7778 /* We must advance forward, right? */
7779 if (it
->stop_charpos
<= charpos
)
7782 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7784 if (it
->stop_charpos
<= where_we_are
)
7785 it
->prev_stop
= it
->stop_charpos
;
7787 it
->prev_stop
= BEGV
;
7789 it
->current
= save_current
;
7790 it
->position
= save_position
;
7791 it
->stop_charpos
= save_stop_pos
;
7792 it
->end_charpos
= save_end_pos
;
7795 /* Scan forward from CHARPOS in the current buffer/string, until we
7796 find a stop position > current IT's position. Then handle the stop
7797 position before that. This is called when we bump into a stop
7798 position while reordering bidirectional text. CHARPOS should be
7799 the last previously processed stop_pos (or BEGV/0, if none were
7800 processed yet) whose position is less that IT's current
7804 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7806 int bufp
= !STRINGP (it
->string
);
7807 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7808 struct display_pos save_current
= it
->current
;
7809 struct text_pos save_position
= it
->position
;
7810 struct text_pos pos1
;
7811 ptrdiff_t next_stop
;
7813 /* Scan in strict logical order. */
7814 eassert (it
->bidi_p
);
7818 it
->prev_stop
= charpos
;
7821 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7822 reseat_1 (it
, pos1
, 0);
7825 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7826 compute_stop_pos (it
);
7827 /* We must advance forward, right? */
7828 if (it
->stop_charpos
<= it
->prev_stop
)
7830 charpos
= it
->stop_charpos
;
7832 while (charpos
<= where_we_are
);
7835 it
->current
= save_current
;
7836 it
->position
= save_position
;
7837 next_stop
= it
->stop_charpos
;
7838 it
->stop_charpos
= it
->prev_stop
;
7840 it
->stop_charpos
= next_stop
;
7843 /* Load IT with the next display element from current_buffer. Value
7844 is zero if end of buffer reached. IT->stop_charpos is the next
7845 position at which to stop and check for text properties or buffer
7849 next_element_from_buffer (struct it
*it
)
7853 eassert (IT_CHARPOS (*it
) >= BEGV
);
7854 eassert (NILP (it
->string
) && !it
->s
);
7855 eassert (!it
->bidi_p
7856 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7857 && it
->bidi_it
.string
.s
== NULL
));
7859 /* With bidi reordering, the character to display might not be the
7860 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7861 we were reseat()ed to a new buffer position, which is potentially
7862 a different paragraph. */
7863 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7865 get_visually_first_element (it
);
7866 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7869 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7871 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7873 int overlay_strings_follow_p
;
7875 /* End of the game, except when overlay strings follow that
7876 haven't been returned yet. */
7877 if (it
->overlay_strings_at_end_processed_p
)
7878 overlay_strings_follow_p
= 0;
7881 it
->overlay_strings_at_end_processed_p
= 1;
7882 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7885 if (overlay_strings_follow_p
)
7886 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7890 it
->position
= it
->current
.pos
;
7894 else if (!(!it
->bidi_p
7895 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7896 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7898 /* With bidi non-linear iteration, we could find ourselves
7899 far beyond the last computed stop_charpos, with several
7900 other stop positions in between that we missed. Scan
7901 them all now, in buffer's logical order, until we find
7902 and handle the last stop_charpos that precedes our
7903 current position. */
7904 handle_stop_backwards (it
, it
->stop_charpos
);
7905 return GET_NEXT_DISPLAY_ELEMENT (it
);
7911 /* Take note of the stop position we just moved across,
7912 for when we will move back across it. */
7913 it
->prev_stop
= it
->stop_charpos
;
7914 /* If we are at base paragraph embedding level, take
7915 note of the last stop position seen at this
7917 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7918 it
->base_level_stop
= it
->stop_charpos
;
7921 return GET_NEXT_DISPLAY_ELEMENT (it
);
7925 /* If we are before prev_stop, we may have overstepped on
7926 our way backwards a stop_pos, and if so, we need to
7927 handle that stop_pos. */
7928 && IT_CHARPOS (*it
) < it
->prev_stop
7929 /* We can sometimes back up for reasons that have nothing
7930 to do with bidi reordering. E.g., compositions. The
7931 code below is only needed when we are above the base
7932 embedding level, so test for that explicitly. */
7933 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7935 if (it
->base_level_stop
<= 0
7936 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7938 /* If we lost track of base_level_stop, we need to find
7939 prev_stop by looking backwards. This happens, e.g., when
7940 we were reseated to the previous screenful of text by
7942 it
->base_level_stop
= BEGV
;
7943 compute_stop_pos_backwards (it
);
7944 handle_stop_backwards (it
, it
->prev_stop
);
7947 handle_stop_backwards (it
, it
->base_level_stop
);
7948 return GET_NEXT_DISPLAY_ELEMENT (it
);
7952 /* No face changes, overlays etc. in sight, so just return a
7953 character from current_buffer. */
7957 /* Maybe run the redisplay end trigger hook. Performance note:
7958 This doesn't seem to cost measurable time. */
7959 if (it
->redisplay_end_trigger_charpos
7961 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7962 run_redisplay_end_trigger_hook (it
);
7964 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7965 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7967 && next_element_from_composition (it
))
7972 /* Get the next character, maybe multibyte. */
7973 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7974 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7975 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7977 it
->c
= *p
, it
->len
= 1;
7979 /* Record what we have and where it came from. */
7980 it
->what
= IT_CHARACTER
;
7981 it
->object
= it
->w
->buffer
;
7982 it
->position
= it
->current
.pos
;
7984 /* Normally we return the character found above, except when we
7985 really want to return an ellipsis for selective display. */
7990 /* A value of selective > 0 means hide lines indented more
7991 than that number of columns. */
7992 if (it
->selective
> 0
7993 && IT_CHARPOS (*it
) + 1 < ZV
7994 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7995 IT_BYTEPOS (*it
) + 1,
7998 success_p
= next_element_from_ellipsis (it
);
7999 it
->dpvec_char_len
= -1;
8002 else if (it
->c
== '\r' && it
->selective
== -1)
8004 /* A value of selective == -1 means that everything from the
8005 CR to the end of the line is invisible, with maybe an
8006 ellipsis displayed for it. */
8007 success_p
= next_element_from_ellipsis (it
);
8008 it
->dpvec_char_len
= -1;
8013 /* Value is zero if end of buffer reached. */
8014 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8019 /* Run the redisplay end trigger hook for IT. */
8022 run_redisplay_end_trigger_hook (struct it
*it
)
8024 Lisp_Object args
[3];
8026 /* IT->glyph_row should be non-null, i.e. we should be actually
8027 displaying something, or otherwise we should not run the hook. */
8028 eassert (it
->glyph_row
);
8030 /* Set up hook arguments. */
8031 args
[0] = Qredisplay_end_trigger_functions
;
8032 args
[1] = it
->window
;
8033 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8034 it
->redisplay_end_trigger_charpos
= 0;
8036 /* Since we are *trying* to run these functions, don't try to run
8037 them again, even if they get an error. */
8038 wset_redisplay_end_trigger (it
->w
, Qnil
);
8039 Frun_hook_with_args (3, args
);
8041 /* Notice if it changed the face of the character we are on. */
8042 handle_face_prop (it
);
8046 /* Deliver a composition display element. Unlike the other
8047 next_element_from_XXX, this function is not registered in the array
8048 get_next_element[]. It is called from next_element_from_buffer and
8049 next_element_from_string when necessary. */
8052 next_element_from_composition (struct it
*it
)
8054 it
->what
= IT_COMPOSITION
;
8055 it
->len
= it
->cmp_it
.nbytes
;
8056 if (STRINGP (it
->string
))
8060 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8061 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8064 it
->position
= it
->current
.string_pos
;
8065 it
->object
= it
->string
;
8066 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8067 IT_STRING_BYTEPOS (*it
), it
->string
);
8073 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8074 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8077 if (it
->bidi_it
.new_paragraph
)
8078 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8079 /* Resync the bidi iterator with IT's new position.
8080 FIXME: this doesn't support bidirectional text. */
8081 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8082 bidi_move_to_visually_next (&it
->bidi_it
);
8086 it
->position
= it
->current
.pos
;
8087 it
->object
= it
->w
->buffer
;
8088 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8089 IT_BYTEPOS (*it
), Qnil
);
8096 /***********************************************************************
8097 Moving an iterator without producing glyphs
8098 ***********************************************************************/
8100 /* Check if iterator is at a position corresponding to a valid buffer
8101 position after some move_it_ call. */
8103 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8104 ((it)->method == GET_FROM_STRING \
8105 ? IT_STRING_CHARPOS (*it) == 0 \
8109 /* Move iterator IT to a specified buffer or X position within one
8110 line on the display without producing glyphs.
8112 OP should be a bit mask including some or all of these bits:
8113 MOVE_TO_X: Stop upon reaching x-position TO_X.
8114 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8115 Regardless of OP's value, stop upon reaching the end of the display line.
8117 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8118 This means, in particular, that TO_X includes window's horizontal
8121 The return value has several possible values that
8122 say what condition caused the scan to stop:
8124 MOVE_POS_MATCH_OR_ZV
8125 - when TO_POS or ZV was reached.
8128 -when TO_X was reached before TO_POS or ZV were reached.
8131 - when we reached the end of the display area and the line must
8135 - when we reached the end of the display area and the line is
8139 - when we stopped at a line end, i.e. a newline or a CR and selective
8142 static enum move_it_result
8143 move_it_in_display_line_to (struct it
*it
,
8144 ptrdiff_t to_charpos
, int to_x
,
8145 enum move_operation_enum op
)
8147 enum move_it_result result
= MOVE_UNDEFINED
;
8148 struct glyph_row
*saved_glyph_row
;
8149 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8150 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8151 void *ppos_data
= NULL
;
8153 enum it_method prev_method
= it
->method
;
8154 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8155 int saw_smaller_pos
= prev_pos
< to_charpos
;
8157 /* Don't produce glyphs in produce_glyphs. */
8158 saved_glyph_row
= it
->glyph_row
;
8159 it
->glyph_row
= NULL
;
8161 /* Use wrap_it to save a copy of IT wherever a word wrap could
8162 occur. Use atpos_it to save a copy of IT at the desired buffer
8163 position, if found, so that we can scan ahead and check if the
8164 word later overshoots the window edge. Use atx_it similarly, for
8170 /* Use ppos_it under bidi reordering to save a copy of IT for the
8171 position > CHARPOS that is the closest to CHARPOS. We restore
8172 that position in IT when we have scanned the entire display line
8173 without finding a match for CHARPOS and all the character
8174 positions are greater than CHARPOS. */
8177 SAVE_IT (ppos_it
, *it
, ppos_data
);
8178 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8179 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8180 SAVE_IT (ppos_it
, *it
, ppos_data
);
8183 #define BUFFER_POS_REACHED_P() \
8184 ((op & MOVE_TO_POS) != 0 \
8185 && BUFFERP (it->object) \
8186 && (IT_CHARPOS (*it) == to_charpos \
8188 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8189 && IT_CHARPOS (*it) > to_charpos) \
8190 || (it->what == IT_COMPOSITION \
8191 && ((IT_CHARPOS (*it) > to_charpos \
8192 && to_charpos >= it->cmp_it.charpos) \
8193 || (IT_CHARPOS (*it) < to_charpos \
8194 && to_charpos <= it->cmp_it.charpos)))) \
8195 && (it->method == GET_FROM_BUFFER \
8196 || (it->method == GET_FROM_DISPLAY_VECTOR \
8197 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8199 /* If there's a line-/wrap-prefix, handle it. */
8200 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8201 && it
->current_y
< it
->last_visible_y
)
8202 handle_line_prefix (it
);
8204 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8205 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8209 int x
, i
, ascent
= 0, descent
= 0;
8211 /* Utility macro to reset an iterator with x, ascent, and descent. */
8212 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8213 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8214 (IT)->max_descent = descent)
8216 /* Stop if we move beyond TO_CHARPOS (after an image or a
8217 display string or stretch glyph). */
8218 if ((op
& MOVE_TO_POS
) != 0
8219 && BUFFERP (it
->object
)
8220 && it
->method
== GET_FROM_BUFFER
8222 /* When the iterator is at base embedding level, we
8223 are guaranteed that characters are delivered for
8224 display in strictly increasing order of their
8225 buffer positions. */
8226 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8227 && IT_CHARPOS (*it
) > to_charpos
)
8229 && (prev_method
== GET_FROM_IMAGE
8230 || prev_method
== GET_FROM_STRETCH
8231 || prev_method
== GET_FROM_STRING
)
8232 /* Passed TO_CHARPOS from left to right. */
8233 && ((prev_pos
< to_charpos
8234 && IT_CHARPOS (*it
) > to_charpos
)
8235 /* Passed TO_CHARPOS from right to left. */
8236 || (prev_pos
> to_charpos
8237 && IT_CHARPOS (*it
) < to_charpos
)))))
8239 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8241 result
= MOVE_POS_MATCH_OR_ZV
;
8244 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8245 /* If wrap_it is valid, the current position might be in a
8246 word that is wrapped. So, save the iterator in
8247 atpos_it and continue to see if wrapping happens. */
8248 SAVE_IT (atpos_it
, *it
, atpos_data
);
8251 /* Stop when ZV reached.
8252 We used to stop here when TO_CHARPOS reached as well, but that is
8253 too soon if this glyph does not fit on this line. So we handle it
8254 explicitly below. */
8255 if (!get_next_display_element (it
))
8257 result
= MOVE_POS_MATCH_OR_ZV
;
8261 if (it
->line_wrap
== TRUNCATE
)
8263 if (BUFFER_POS_REACHED_P ())
8265 result
= MOVE_POS_MATCH_OR_ZV
;
8271 if (it
->line_wrap
== WORD_WRAP
)
8273 if (IT_DISPLAYING_WHITESPACE (it
))
8277 /* We have reached a glyph that follows one or more
8278 whitespace characters. If the position is
8279 already found, we are done. */
8280 if (atpos_it
.sp
>= 0)
8282 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8283 result
= MOVE_POS_MATCH_OR_ZV
;
8288 RESTORE_IT (it
, &atx_it
, atx_data
);
8289 result
= MOVE_X_REACHED
;
8292 /* Otherwise, we can wrap here. */
8293 SAVE_IT (wrap_it
, *it
, wrap_data
);
8299 /* Remember the line height for the current line, in case
8300 the next element doesn't fit on the line. */
8301 ascent
= it
->max_ascent
;
8302 descent
= it
->max_descent
;
8304 /* The call to produce_glyphs will get the metrics of the
8305 display element IT is loaded with. Record the x-position
8306 before this display element, in case it doesn't fit on the
8310 PRODUCE_GLYPHS (it
);
8312 if (it
->area
!= TEXT_AREA
)
8314 prev_method
= it
->method
;
8315 if (it
->method
== GET_FROM_BUFFER
)
8316 prev_pos
= IT_CHARPOS (*it
);
8317 set_iterator_to_next (it
, 1);
8318 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8319 SET_TEXT_POS (this_line_min_pos
,
8320 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8322 && (op
& MOVE_TO_POS
)
8323 && IT_CHARPOS (*it
) > to_charpos
8324 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8325 SAVE_IT (ppos_it
, *it
, ppos_data
);
8329 /* The number of glyphs we get back in IT->nglyphs will normally
8330 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8331 character on a terminal frame, or (iii) a line end. For the
8332 second case, IT->nglyphs - 1 padding glyphs will be present.
8333 (On X frames, there is only one glyph produced for a
8334 composite character.)
8336 The behavior implemented below means, for continuation lines,
8337 that as many spaces of a TAB as fit on the current line are
8338 displayed there. For terminal frames, as many glyphs of a
8339 multi-glyph character are displayed in the current line, too.
8340 This is what the old redisplay code did, and we keep it that
8341 way. Under X, the whole shape of a complex character must
8342 fit on the line or it will be completely displayed in the
8345 Note that both for tabs and padding glyphs, all glyphs have
8349 /* More than one glyph or glyph doesn't fit on line. All
8350 glyphs have the same width. */
8351 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8353 int x_before_this_char
= x
;
8354 int hpos_before_this_char
= it
->hpos
;
8356 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8358 new_x
= x
+ single_glyph_width
;
8360 /* We want to leave anything reaching TO_X to the caller. */
8361 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8363 if (BUFFER_POS_REACHED_P ())
8365 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8366 goto buffer_pos_reached
;
8367 if (atpos_it
.sp
< 0)
8369 SAVE_IT (atpos_it
, *it
, atpos_data
);
8370 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8375 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8378 result
= MOVE_X_REACHED
;
8383 SAVE_IT (atx_it
, *it
, atx_data
);
8384 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8389 if (/* Lines are continued. */
8390 it
->line_wrap
!= TRUNCATE
8391 && (/* And glyph doesn't fit on the line. */
8392 new_x
> it
->last_visible_x
8393 /* Or it fits exactly and we're on a window
8395 || (new_x
== it
->last_visible_x
8396 && FRAME_WINDOW_P (it
->f
)
8397 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8398 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8399 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8401 if (/* IT->hpos == 0 means the very first glyph
8402 doesn't fit on the line, e.g. a wide image. */
8404 || (new_x
== it
->last_visible_x
8405 && FRAME_WINDOW_P (it
->f
)))
8408 it
->current_x
= new_x
;
8410 /* The character's last glyph just barely fits
8412 if (i
== it
->nglyphs
- 1)
8414 /* If this is the destination position,
8415 return a position *before* it in this row,
8416 now that we know it fits in this row. */
8417 if (BUFFER_POS_REACHED_P ())
8419 if (it
->line_wrap
!= WORD_WRAP
8422 it
->hpos
= hpos_before_this_char
;
8423 it
->current_x
= x_before_this_char
;
8424 result
= MOVE_POS_MATCH_OR_ZV
;
8427 if (it
->line_wrap
== WORD_WRAP
8430 SAVE_IT (atpos_it
, *it
, atpos_data
);
8431 atpos_it
.current_x
= x_before_this_char
;
8432 atpos_it
.hpos
= hpos_before_this_char
;
8436 prev_method
= it
->method
;
8437 if (it
->method
== GET_FROM_BUFFER
)
8438 prev_pos
= IT_CHARPOS (*it
);
8439 set_iterator_to_next (it
, 1);
8440 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8441 SET_TEXT_POS (this_line_min_pos
,
8442 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8443 /* On graphical terminals, newlines may
8444 "overflow" into the fringe if
8445 overflow-newline-into-fringe is non-nil.
8446 On text terminals, and on graphical
8447 terminals with no right margin, newlines
8448 may overflow into the last glyph on the
8450 if (!FRAME_WINDOW_P (it
->f
)
8452 && it
->bidi_it
.paragraph_dir
== R2L
)
8453 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8454 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8455 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8457 if (!get_next_display_element (it
))
8459 result
= MOVE_POS_MATCH_OR_ZV
;
8462 if (BUFFER_POS_REACHED_P ())
8464 if (ITERATOR_AT_END_OF_LINE_P (it
))
8465 result
= MOVE_POS_MATCH_OR_ZV
;
8467 result
= MOVE_LINE_CONTINUED
;
8470 if (ITERATOR_AT_END_OF_LINE_P (it
))
8472 result
= MOVE_NEWLINE_OR_CR
;
8479 IT_RESET_X_ASCENT_DESCENT (it
);
8481 if (wrap_it
.sp
>= 0)
8483 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8488 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8490 result
= MOVE_LINE_CONTINUED
;
8494 if (BUFFER_POS_REACHED_P ())
8496 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8497 goto buffer_pos_reached
;
8498 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8500 SAVE_IT (atpos_it
, *it
, atpos_data
);
8501 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8505 if (new_x
> it
->first_visible_x
)
8507 /* Glyph is visible. Increment number of glyphs that
8508 would be displayed. */
8513 if (result
!= MOVE_UNDEFINED
)
8516 else if (BUFFER_POS_REACHED_P ())
8519 IT_RESET_X_ASCENT_DESCENT (it
);
8520 result
= MOVE_POS_MATCH_OR_ZV
;
8523 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8525 /* Stop when TO_X specified and reached. This check is
8526 necessary here because of lines consisting of a line end,
8527 only. The line end will not produce any glyphs and we
8528 would never get MOVE_X_REACHED. */
8529 eassert (it
->nglyphs
== 0);
8530 result
= MOVE_X_REACHED
;
8534 /* Is this a line end? If yes, we're done. */
8535 if (ITERATOR_AT_END_OF_LINE_P (it
))
8537 /* If we are past TO_CHARPOS, but never saw any character
8538 positions smaller than TO_CHARPOS, return
8539 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8541 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8543 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8545 if (IT_CHARPOS (ppos_it
) < ZV
)
8547 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8548 result
= MOVE_POS_MATCH_OR_ZV
;
8551 goto buffer_pos_reached
;
8553 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8554 && IT_CHARPOS (*it
) > to_charpos
)
8555 goto buffer_pos_reached
;
8557 result
= MOVE_NEWLINE_OR_CR
;
8560 result
= MOVE_NEWLINE_OR_CR
;
8564 prev_method
= it
->method
;
8565 if (it
->method
== GET_FROM_BUFFER
)
8566 prev_pos
= IT_CHARPOS (*it
);
8567 /* The current display element has been consumed. Advance
8569 set_iterator_to_next (it
, 1);
8570 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8571 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8572 if (IT_CHARPOS (*it
) < to_charpos
)
8573 saw_smaller_pos
= 1;
8575 && (op
& MOVE_TO_POS
)
8576 && IT_CHARPOS (*it
) >= to_charpos
8577 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8578 SAVE_IT (ppos_it
, *it
, ppos_data
);
8580 /* Stop if lines are truncated and IT's current x-position is
8581 past the right edge of the window now. */
8582 if (it
->line_wrap
== TRUNCATE
8583 && it
->current_x
>= it
->last_visible_x
)
8585 if (!FRAME_WINDOW_P (it
->f
)
8586 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8587 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8588 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8589 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8593 if ((at_eob_p
= !get_next_display_element (it
))
8594 || BUFFER_POS_REACHED_P ()
8595 /* If we are past TO_CHARPOS, but never saw any
8596 character positions smaller than TO_CHARPOS,
8597 return MOVE_POS_MATCH_OR_ZV, like the
8598 unidirectional display did. */
8599 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8601 && IT_CHARPOS (*it
) > to_charpos
))
8604 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8605 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8606 result
= MOVE_POS_MATCH_OR_ZV
;
8609 if (ITERATOR_AT_END_OF_LINE_P (it
))
8611 result
= MOVE_NEWLINE_OR_CR
;
8615 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8617 && IT_CHARPOS (*it
) > to_charpos
)
8619 if (IT_CHARPOS (ppos_it
) < ZV
)
8620 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8621 result
= MOVE_POS_MATCH_OR_ZV
;
8624 result
= MOVE_LINE_TRUNCATED
;
8627 #undef IT_RESET_X_ASCENT_DESCENT
8630 #undef BUFFER_POS_REACHED_P
8632 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8633 restore the saved iterator. */
8634 if (atpos_it
.sp
>= 0)
8635 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8636 else if (atx_it
.sp
>= 0)
8637 RESTORE_IT (it
, &atx_it
, atx_data
);
8642 bidi_unshelve_cache (atpos_data
, 1);
8644 bidi_unshelve_cache (atx_data
, 1);
8646 bidi_unshelve_cache (wrap_data
, 1);
8648 bidi_unshelve_cache (ppos_data
, 1);
8650 /* Restore the iterator settings altered at the beginning of this
8652 it
->glyph_row
= saved_glyph_row
;
8656 /* For external use. */
8658 move_it_in_display_line (struct it
*it
,
8659 ptrdiff_t to_charpos
, int to_x
,
8660 enum move_operation_enum op
)
8662 if (it
->line_wrap
== WORD_WRAP
8663 && (op
& MOVE_TO_X
))
8666 void *save_data
= NULL
;
8669 SAVE_IT (save_it
, *it
, save_data
);
8670 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8671 /* When word-wrap is on, TO_X may lie past the end
8672 of a wrapped line. Then it->current is the
8673 character on the next line, so backtrack to the
8674 space before the wrap point. */
8675 if (skip
== MOVE_LINE_CONTINUED
)
8677 int prev_x
= max (it
->current_x
- 1, 0);
8678 RESTORE_IT (it
, &save_it
, save_data
);
8679 move_it_in_display_line_to
8680 (it
, -1, prev_x
, MOVE_TO_X
);
8683 bidi_unshelve_cache (save_data
, 1);
8686 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8690 /* Move IT forward until it satisfies one or more of the criteria in
8691 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8693 OP is a bit-mask that specifies where to stop, and in particular,
8694 which of those four position arguments makes a difference. See the
8695 description of enum move_operation_enum.
8697 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8698 screen line, this function will set IT to the next position that is
8699 displayed to the right of TO_CHARPOS on the screen. */
8702 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8704 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8705 int line_height
, line_start_x
= 0, reached
= 0;
8706 void *backup_data
= NULL
;
8710 if (op
& MOVE_TO_VPOS
)
8712 /* If no TO_CHARPOS and no TO_X specified, stop at the
8713 start of the line TO_VPOS. */
8714 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8716 if (it
->vpos
== to_vpos
)
8722 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8726 /* TO_VPOS >= 0 means stop at TO_X in the line at
8727 TO_VPOS, or at TO_POS, whichever comes first. */
8728 if (it
->vpos
== to_vpos
)
8734 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8736 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8741 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8743 /* We have reached TO_X but not in the line we want. */
8744 skip
= move_it_in_display_line_to (it
, to_charpos
,
8746 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8754 else if (op
& MOVE_TO_Y
)
8756 struct it it_backup
;
8758 if (it
->line_wrap
== WORD_WRAP
)
8759 SAVE_IT (it_backup
, *it
, backup_data
);
8761 /* TO_Y specified means stop at TO_X in the line containing
8762 TO_Y---or at TO_CHARPOS if this is reached first. The
8763 problem is that we can't really tell whether the line
8764 contains TO_Y before we have completely scanned it, and
8765 this may skip past TO_X. What we do is to first scan to
8768 If TO_X is not specified, use a TO_X of zero. The reason
8769 is to make the outcome of this function more predictable.
8770 If we didn't use TO_X == 0, we would stop at the end of
8771 the line which is probably not what a caller would expect
8773 skip
= move_it_in_display_line_to
8774 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8775 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8777 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8778 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8780 else if (skip
== MOVE_X_REACHED
)
8782 /* If TO_X was reached, we want to know whether TO_Y is
8783 in the line. We know this is the case if the already
8784 scanned glyphs make the line tall enough. Otherwise,
8785 we must check by scanning the rest of the line. */
8786 line_height
= it
->max_ascent
+ it
->max_descent
;
8787 if (to_y
>= it
->current_y
8788 && to_y
< it
->current_y
+ line_height
)
8793 SAVE_IT (it_backup
, *it
, backup_data
);
8794 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8795 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8797 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8798 line_height
= it
->max_ascent
+ it
->max_descent
;
8799 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8801 if (to_y
>= it
->current_y
8802 && to_y
< it
->current_y
+ line_height
)
8804 /* If TO_Y is in this line and TO_X was reached
8805 above, we scanned too far. We have to restore
8806 IT's settings to the ones before skipping. But
8807 keep the more accurate values of max_ascent and
8808 max_descent we've found while skipping the rest
8809 of the line, for the sake of callers, such as
8810 pos_visible_p, that need to know the line
8812 int max_ascent
= it
->max_ascent
;
8813 int max_descent
= it
->max_descent
;
8815 RESTORE_IT (it
, &it_backup
, backup_data
);
8816 it
->max_ascent
= max_ascent
;
8817 it
->max_descent
= max_descent
;
8823 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8829 /* Check whether TO_Y is in this line. */
8830 line_height
= it
->max_ascent
+ it
->max_descent
;
8831 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8833 if (to_y
>= it
->current_y
8834 && to_y
< it
->current_y
+ line_height
)
8836 /* When word-wrap is on, TO_X may lie past the end
8837 of a wrapped line. Then it->current is the
8838 character on the next line, so backtrack to the
8839 space before the wrap point. */
8840 if (skip
== MOVE_LINE_CONTINUED
8841 && it
->line_wrap
== WORD_WRAP
)
8843 int prev_x
= max (it
->current_x
- 1, 0);
8844 RESTORE_IT (it
, &it_backup
, backup_data
);
8845 skip
= move_it_in_display_line_to
8846 (it
, -1, prev_x
, MOVE_TO_X
);
8855 else if (BUFFERP (it
->object
)
8856 && (it
->method
== GET_FROM_BUFFER
8857 || it
->method
== GET_FROM_STRETCH
)
8858 && IT_CHARPOS (*it
) >= to_charpos
8859 /* Under bidi iteration, a call to set_iterator_to_next
8860 can scan far beyond to_charpos if the initial
8861 portion of the next line needs to be reordered. In
8862 that case, give move_it_in_display_line_to another
8865 && it
->bidi_it
.scan_dir
== -1))
8866 skip
= MOVE_POS_MATCH_OR_ZV
;
8868 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8872 case MOVE_POS_MATCH_OR_ZV
:
8876 case MOVE_NEWLINE_OR_CR
:
8877 set_iterator_to_next (it
, 1);
8878 it
->continuation_lines_width
= 0;
8881 case MOVE_LINE_TRUNCATED
:
8882 it
->continuation_lines_width
= 0;
8883 reseat_at_next_visible_line_start (it
, 0);
8884 if ((op
& MOVE_TO_POS
) != 0
8885 && IT_CHARPOS (*it
) > to_charpos
)
8892 case MOVE_LINE_CONTINUED
:
8893 /* For continued lines ending in a tab, some of the glyphs
8894 associated with the tab are displayed on the current
8895 line. Since it->current_x does not include these glyphs,
8896 we use it->last_visible_x instead. */
8899 it
->continuation_lines_width
+= it
->last_visible_x
;
8900 /* When moving by vpos, ensure that the iterator really
8901 advances to the next line (bug#847, bug#969). Fixme:
8902 do we need to do this in other circumstances? */
8903 if (it
->current_x
!= it
->last_visible_x
8904 && (op
& MOVE_TO_VPOS
)
8905 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8907 line_start_x
= it
->current_x
+ it
->pixel_width
8908 - it
->last_visible_x
;
8909 set_iterator_to_next (it
, 0);
8913 it
->continuation_lines_width
+= it
->current_x
;
8920 /* Reset/increment for the next run. */
8921 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8922 it
->current_x
= line_start_x
;
8925 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8927 last_height
= it
->max_ascent
+ it
->max_descent
;
8928 last_max_ascent
= it
->max_ascent
;
8929 it
->max_ascent
= it
->max_descent
= 0;
8934 /* On text terminals, we may stop at the end of a line in the middle
8935 of a multi-character glyph. If the glyph itself is continued,
8936 i.e. it is actually displayed on the next line, don't treat this
8937 stopping point as valid; move to the next line instead (unless
8938 that brings us offscreen). */
8939 if (!FRAME_WINDOW_P (it
->f
)
8941 && IT_CHARPOS (*it
) == to_charpos
8942 && it
->what
== IT_CHARACTER
8944 && it
->line_wrap
== WINDOW_WRAP
8945 && it
->current_x
== it
->last_visible_x
- 1
8948 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8950 it
->continuation_lines_width
+= it
->current_x
;
8951 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8952 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8954 last_height
= it
->max_ascent
+ it
->max_descent
;
8955 last_max_ascent
= it
->max_ascent
;
8959 bidi_unshelve_cache (backup_data
, 1);
8961 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8965 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8967 If DY > 0, move IT backward at least that many pixels. DY = 0
8968 means move IT backward to the preceding line start or BEGV. This
8969 function may move over more than DY pixels if IT->current_y - DY
8970 ends up in the middle of a line; in this case IT->current_y will be
8971 set to the top of the line moved to. */
8974 move_it_vertically_backward (struct it
*it
, int dy
)
8978 void *it2data
= NULL
, *it3data
= NULL
;
8979 ptrdiff_t start_pos
;
8981 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
8982 ptrdiff_t pos_limit
;
8987 start_pos
= IT_CHARPOS (*it
);
8989 /* Estimate how many newlines we must move back. */
8990 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8991 if (it
->line_wrap
== TRUNCATE
)
8994 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
8996 /* Set the iterator's position that many lines back. But don't go
8997 back more than NLINES full screen lines -- this wins a day with
8998 buffers which have very long lines. */
8999 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9000 back_to_previous_visible_line_start (it
);
9002 /* Reseat the iterator here. When moving backward, we don't want
9003 reseat to skip forward over invisible text, set up the iterator
9004 to deliver from overlay strings at the new position etc. So,
9005 use reseat_1 here. */
9006 reseat_1 (it
, it
->current
.pos
, 1);
9008 /* We are now surely at a line start. */
9009 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9010 reordering is in effect. */
9011 it
->continuation_lines_width
= 0;
9013 /* Move forward and see what y-distance we moved. First move to the
9014 start of the next line so that we get its height. We need this
9015 height to be able to tell whether we reached the specified
9017 SAVE_IT (it2
, *it
, it2data
);
9018 it2
.max_ascent
= it2
.max_descent
= 0;
9021 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9022 MOVE_TO_POS
| MOVE_TO_VPOS
);
9024 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9025 /* If we are in a display string which starts at START_POS,
9026 and that display string includes a newline, and we are
9027 right after that newline (i.e. at the beginning of a
9028 display line), exit the loop, because otherwise we will
9029 infloop, since move_it_to will see that it is already at
9030 START_POS and will not move. */
9031 || (it2
.method
== GET_FROM_STRING
9032 && IT_CHARPOS (it2
) == start_pos
9033 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9034 eassert (IT_CHARPOS (*it
) >= BEGV
);
9035 SAVE_IT (it3
, it2
, it3data
);
9037 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9038 eassert (IT_CHARPOS (*it
) >= BEGV
);
9039 /* H is the actual vertical distance from the position in *IT
9040 and the starting position. */
9041 h
= it2
.current_y
- it
->current_y
;
9042 /* NLINES is the distance in number of lines. */
9043 nlines
= it2
.vpos
- it
->vpos
;
9045 /* Correct IT's y and vpos position
9046 so that they are relative to the starting point. */
9052 /* DY == 0 means move to the start of the screen line. The
9053 value of nlines is > 0 if continuation lines were involved,
9054 or if the original IT position was at start of a line. */
9055 RESTORE_IT (it
, it
, it2data
);
9057 move_it_by_lines (it
, nlines
);
9058 /* The above code moves us to some position NLINES down,
9059 usually to its first glyph (leftmost in an L2R line), but
9060 that's not necessarily the start of the line, under bidi
9061 reordering. We want to get to the character position
9062 that is immediately after the newline of the previous
9065 && !it
->continuation_lines_width
9066 && !STRINGP (it
->string
)
9067 && IT_CHARPOS (*it
) > BEGV
9068 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9071 find_next_newline (IT_CHARPOS (*it
) - 1, -1, NULL
);
9073 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
9075 bidi_unshelve_cache (it3data
, 1);
9079 /* The y-position we try to reach, relative to *IT.
9080 Note that H has been subtracted in front of the if-statement. */
9081 int target_y
= it
->current_y
+ h
- dy
;
9082 int y0
= it3
.current_y
;
9086 RESTORE_IT (&it3
, &it3
, it3data
);
9087 y1
= line_bottom_y (&it3
);
9088 line_height
= y1
- y0
;
9089 RESTORE_IT (it
, it
, it2data
);
9090 /* If we did not reach target_y, try to move further backward if
9091 we can. If we moved too far backward, try to move forward. */
9092 if (target_y
< it
->current_y
9093 /* This is heuristic. In a window that's 3 lines high, with
9094 a line height of 13 pixels each, recentering with point
9095 on the bottom line will try to move -39/2 = 19 pixels
9096 backward. Try to avoid moving into the first line. */
9097 && (it
->current_y
- target_y
9098 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9099 && IT_CHARPOS (*it
) > BEGV
)
9101 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9102 target_y
- it
->current_y
));
9103 dy
= it
->current_y
- target_y
;
9104 goto move_further_back
;
9106 else if (target_y
>= it
->current_y
+ line_height
9107 && IT_CHARPOS (*it
) < ZV
)
9109 /* Should move forward by at least one line, maybe more.
9111 Note: Calling move_it_by_lines can be expensive on
9112 terminal frames, where compute_motion is used (via
9113 vmotion) to do the job, when there are very long lines
9114 and truncate-lines is nil. That's the reason for
9115 treating terminal frames specially here. */
9117 if (!FRAME_WINDOW_P (it
->f
))
9118 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9123 move_it_by_lines (it
, 1);
9125 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9132 /* Move IT by a specified amount of pixel lines DY. DY negative means
9133 move backwards. DY = 0 means move to start of screen line. At the
9134 end, IT will be on the start of a screen line. */
9137 move_it_vertically (struct it
*it
, int dy
)
9140 move_it_vertically_backward (it
, -dy
);
9143 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9144 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9145 MOVE_TO_POS
| MOVE_TO_Y
);
9146 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9148 /* If buffer ends in ZV without a newline, move to the start of
9149 the line to satisfy the post-condition. */
9150 if (IT_CHARPOS (*it
) == ZV
9152 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9153 move_it_by_lines (it
, 0);
9158 /* Move iterator IT past the end of the text line it is in. */
9161 move_it_past_eol (struct it
*it
)
9163 enum move_it_result rc
;
9165 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9166 if (rc
== MOVE_NEWLINE_OR_CR
)
9167 set_iterator_to_next (it
, 0);
9171 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9172 negative means move up. DVPOS == 0 means move to the start of the
9175 Optimization idea: If we would know that IT->f doesn't use
9176 a face with proportional font, we could be faster for
9177 truncate-lines nil. */
9180 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9183 /* The commented-out optimization uses vmotion on terminals. This
9184 gives bad results, because elements like it->what, on which
9185 callers such as pos_visible_p rely, aren't updated. */
9186 /* struct position pos;
9187 if (!FRAME_WINDOW_P (it->f))
9189 struct text_pos textpos;
9191 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9192 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9193 reseat (it, textpos, 1);
9194 it->vpos += pos.vpos;
9195 it->current_y += pos.vpos;
9201 /* DVPOS == 0 means move to the start of the screen line. */
9202 move_it_vertically_backward (it
, 0);
9203 /* Let next call to line_bottom_y calculate real line height */
9208 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9209 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9211 /* Only move to the next buffer position if we ended up in a
9212 string from display property, not in an overlay string
9213 (before-string or after-string). That is because the
9214 latter don't conceal the underlying buffer position, so
9215 we can ask to move the iterator to the exact position we
9216 are interested in. Note that, even if we are already at
9217 IT_CHARPOS (*it), the call below is not a no-op, as it
9218 will detect that we are at the end of the string, pop the
9219 iterator, and compute it->current_x and it->hpos
9221 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9222 -1, -1, -1, MOVE_TO_POS
);
9228 void *it2data
= NULL
;
9229 ptrdiff_t start_charpos
, i
;
9231 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9232 ptrdiff_t pos_limit
;
9234 /* Start at the beginning of the screen line containing IT's
9235 position. This may actually move vertically backwards,
9236 in case of overlays, so adjust dvpos accordingly. */
9238 move_it_vertically_backward (it
, 0);
9241 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9242 screen lines, and reseat the iterator there. */
9243 start_charpos
= IT_CHARPOS (*it
);
9244 if (it
->line_wrap
== TRUNCATE
)
9247 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9248 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9249 back_to_previous_visible_line_start (it
);
9250 reseat (it
, it
->current
.pos
, 1);
9252 /* Move further back if we end up in a string or an image. */
9253 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9255 /* First try to move to start of display line. */
9257 move_it_vertically_backward (it
, 0);
9259 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9261 /* If start of line is still in string or image,
9262 move further back. */
9263 back_to_previous_visible_line_start (it
);
9264 reseat (it
, it
->current
.pos
, 1);
9268 it
->current_x
= it
->hpos
= 0;
9270 /* Above call may have moved too far if continuation lines
9271 are involved. Scan forward and see if it did. */
9272 SAVE_IT (it2
, *it
, it2data
);
9273 it2
.vpos
= it2
.current_y
= 0;
9274 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9275 it
->vpos
-= it2
.vpos
;
9276 it
->current_y
-= it2
.current_y
;
9277 it
->current_x
= it
->hpos
= 0;
9279 /* If we moved too far back, move IT some lines forward. */
9280 if (it2
.vpos
> -dvpos
)
9282 int delta
= it2
.vpos
+ dvpos
;
9284 RESTORE_IT (&it2
, &it2
, it2data
);
9285 SAVE_IT (it2
, *it
, it2data
);
9286 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9287 /* Move back again if we got too far ahead. */
9288 if (IT_CHARPOS (*it
) >= start_charpos
)
9289 RESTORE_IT (it
, &it2
, it2data
);
9291 bidi_unshelve_cache (it2data
, 1);
9294 RESTORE_IT (it
, it
, it2data
);
9298 /* Return 1 if IT points into the middle of a display vector. */
9301 in_display_vector_p (struct it
*it
)
9303 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9304 && it
->current
.dpvec_index
> 0
9305 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9309 /***********************************************************************
9311 ***********************************************************************/
9314 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9318 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9320 Lisp_Object args
[3];
9321 Lisp_Object msg
, fmt
;
9324 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9328 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9330 args
[0] = fmt
= build_string (format
);
9333 msg
= Fformat (3, args
);
9335 len
= SBYTES (msg
) + 1;
9336 buffer
= SAFE_ALLOCA (len
);
9337 memcpy (buffer
, SDATA (msg
), len
);
9339 message_dolog (buffer
, len
- 1, 1, 0);
9346 /* Output a newline in the *Messages* buffer if "needs" one. */
9349 message_log_maybe_newline (void)
9351 if (message_log_need_newline
)
9352 message_dolog ("", 0, 1, 0);
9356 /* Add a string M of length NBYTES to the message log, optionally
9357 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9358 true, means interpret the contents of M as multibyte. This
9359 function calls low-level routines in order to bypass text property
9360 hooks, etc. which might not be safe to run.
9362 This may GC (insert may run before/after change hooks),
9363 so the buffer M must NOT point to a Lisp string. */
9366 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9368 const unsigned char *msg
= (const unsigned char *) m
;
9370 if (!NILP (Vmemory_full
))
9373 if (!NILP (Vmessage_log_max
))
9375 struct buffer
*oldbuf
;
9376 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9377 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9378 ptrdiff_t point_at_end
= 0;
9379 ptrdiff_t zv_at_end
= 0;
9380 Lisp_Object old_deactivate_mark
;
9382 struct gcpro gcpro1
;
9384 old_deactivate_mark
= Vdeactivate_mark
;
9385 oldbuf
= current_buffer
;
9386 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9387 bset_undo_list (current_buffer
, Qt
);
9389 oldpoint
= message_dolog_marker1
;
9390 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9391 oldbegv
= message_dolog_marker2
;
9392 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9393 oldzv
= message_dolog_marker3
;
9394 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9395 GCPRO1 (old_deactivate_mark
);
9403 BEGV_BYTE
= BEG_BYTE
;
9406 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9408 /* Insert the string--maybe converting multibyte to single byte
9409 or vice versa, so that all the text fits the buffer. */
9411 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9417 /* Convert a multibyte string to single-byte
9418 for the *Message* buffer. */
9419 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9421 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9422 work
[0] = (ASCII_CHAR_P (c
)
9424 : multibyte_char_to_unibyte (c
));
9425 insert_1_both (work
, 1, 1, 1, 0, 0);
9428 else if (! multibyte
9429 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9433 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9434 /* Convert a single-byte string to multibyte
9435 for the *Message* buffer. */
9436 for (i
= 0; i
< nbytes
; i
++)
9439 MAKE_CHAR_MULTIBYTE (c
);
9440 char_bytes
= CHAR_STRING (c
, str
);
9441 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9445 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
9449 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9452 insert_1_both ("\n", 1, 1, 1, 0, 0);
9454 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9456 this_bol_byte
= PT_BYTE
;
9458 /* See if this line duplicates the previous one.
9459 If so, combine duplicates. */
9462 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9464 prev_bol_byte
= PT_BYTE
;
9466 dups
= message_log_check_duplicate (prev_bol_byte
,
9470 del_range_both (prev_bol
, prev_bol_byte
,
9471 this_bol
, this_bol_byte
, 0);
9474 char dupstr
[sizeof " [ times]"
9475 + INT_STRLEN_BOUND (printmax_t
)];
9477 /* If you change this format, don't forget to also
9478 change message_log_check_duplicate. */
9479 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9480 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9481 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
9486 /* If we have more than the desired maximum number of lines
9487 in the *Messages* buffer now, delete the oldest ones.
9488 This is safe because we don't have undo in this buffer. */
9490 if (NATNUMP (Vmessage_log_max
))
9492 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9493 -XFASTINT (Vmessage_log_max
) - 1, 0);
9494 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9497 BEGV
= marker_position (oldbegv
);
9498 BEGV_BYTE
= marker_byte_position (oldbegv
);
9507 ZV
= marker_position (oldzv
);
9508 ZV_BYTE
= marker_byte_position (oldzv
);
9512 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9514 /* We can't do Fgoto_char (oldpoint) because it will run some
9516 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
9517 marker_byte_position (oldpoint
));
9520 unchain_marker (XMARKER (oldpoint
));
9521 unchain_marker (XMARKER (oldbegv
));
9522 unchain_marker (XMARKER (oldzv
));
9524 shown
= buffer_window_count (current_buffer
) > 0;
9525 set_buffer_internal (oldbuf
);
9527 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9528 message_log_need_newline
= !nlflag
;
9529 Vdeactivate_mark
= old_deactivate_mark
;
9534 /* We are at the end of the buffer after just having inserted a newline.
9535 (Note: We depend on the fact we won't be crossing the gap.)
9536 Check to see if the most recent message looks a lot like the previous one.
9537 Return 0 if different, 1 if the new one should just replace it, or a
9538 value N > 1 if we should also append " [N times]". */
9541 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9544 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9546 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9547 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9549 for (i
= 0; i
< len
; i
++)
9551 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
9559 if (*p1
++ == ' ' && *p1
++ == '[')
9562 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9563 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9570 /* Display an echo area message M with a specified length of NBYTES
9571 bytes. The string may include null characters. If M is not a
9572 string, clear out any existing message, and let the mini-buffer
9575 This function cancels echoing. */
9578 message3 (Lisp_Object m
)
9580 struct gcpro gcpro1
;
9583 clear_message (1,1);
9586 /* First flush out any partial line written with print. */
9587 message_log_maybe_newline ();
9590 ptrdiff_t nbytes
= SBYTES (m
);
9591 bool multibyte
= STRING_MULTIBYTE (m
);
9593 char *buffer
= SAFE_ALLOCA (nbytes
);
9594 memcpy (buffer
, SDATA (m
), nbytes
);
9595 message_dolog (buffer
, nbytes
, 1, multibyte
);
9604 /* The non-logging version of message3.
9605 This does not cancel echoing, because it is used for echoing.
9606 Perhaps we need to make a separate function for echoing
9607 and make this cancel echoing. */
9610 message3_nolog (Lisp_Object m
)
9612 struct frame
*sf
= SELECTED_FRAME ();
9614 if (FRAME_INITIAL_P (sf
))
9616 if (noninteractive_need_newline
)
9617 putc ('\n', stderr
);
9618 noninteractive_need_newline
= 0;
9620 fwrite (SDATA (m
), SBYTES (m
), 1, stderr
);
9621 if (cursor_in_echo_area
== 0)
9622 fprintf (stderr
, "\n");
9625 /* Error messages get reported properly by cmd_error, so this must be just an
9626 informative message; if the frame hasn't really been initialized yet, just
9628 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
9630 /* Get the frame containing the mini-buffer
9631 that the selected frame is using. */
9632 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9633 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
9634 struct frame
*f
= XFRAME (frame
);
9636 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
9637 Fmake_frame_visible (frame
);
9639 if (STRINGP (m
) && SCHARS (m
) > 0)
9642 if (minibuffer_auto_raise
)
9643 Fraise_frame (frame
);
9644 /* Assume we are not echoing.
9645 (If we are, echo_now will override this.) */
9646 echo_message_buffer
= Qnil
;
9649 clear_message (1, 1);
9651 do_pending_window_change (0);
9652 echo_area_display (1);
9653 do_pending_window_change (0);
9654 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
9655 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9660 /* Display a null-terminated echo area message M. If M is 0, clear
9661 out any existing message, and let the mini-buffer text show through.
9663 The buffer M must continue to exist until after the echo area gets
9664 cleared or some other message gets displayed there. Do not pass
9665 text that is stored in a Lisp string. Do not pass text in a buffer
9666 that was alloca'd. */
9669 message1 (const char *m
)
9671 message3 (m
? make_unibyte_string (m
, strlen (m
)) : Qnil
);
9675 /* The non-logging counterpart of message1. */
9678 message1_nolog (const char *m
)
9680 message3_nolog (m
? make_unibyte_string (m
, strlen (m
)) : Qnil
);
9683 /* Display a message M which contains a single %s
9684 which gets replaced with STRING. */
9687 message_with_string (const char *m
, Lisp_Object string
, int log
)
9689 CHECK_STRING (string
);
9695 if (noninteractive_need_newline
)
9696 putc ('\n', stderr
);
9697 noninteractive_need_newline
= 0;
9698 fprintf (stderr
, m
, SDATA (string
));
9699 if (!cursor_in_echo_area
)
9700 fprintf (stderr
, "\n");
9704 else if (INTERACTIVE
)
9706 /* The frame whose minibuffer we're going to display the message on.
9707 It may be larger than the selected frame, so we need
9708 to use its buffer, not the selected frame's buffer. */
9709 Lisp_Object mini_window
;
9710 struct frame
*f
, *sf
= SELECTED_FRAME ();
9712 /* Get the frame containing the minibuffer
9713 that the selected frame is using. */
9714 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9715 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9717 /* Error messages get reported properly by cmd_error, so this must be
9718 just an informative message; if the frame hasn't really been
9719 initialized yet, just toss it. */
9720 if (f
->glyphs_initialized_p
)
9722 Lisp_Object args
[2], msg
;
9723 struct gcpro gcpro1
, gcpro2
;
9725 args
[0] = build_string (m
);
9726 args
[1] = msg
= string
;
9727 GCPRO2 (args
[0], msg
);
9730 msg
= Fformat (2, args
);
9735 message3_nolog (msg
);
9739 /* Print should start at the beginning of the message
9740 buffer next time. */
9741 message_buf_print
= 0;
9747 /* Dump an informative message to the minibuf. If M is 0, clear out
9748 any existing message, and let the mini-buffer text show through. */
9751 vmessage (const char *m
, va_list ap
)
9757 if (noninteractive_need_newline
)
9758 putc ('\n', stderr
);
9759 noninteractive_need_newline
= 0;
9760 vfprintf (stderr
, m
, ap
);
9761 if (cursor_in_echo_area
== 0)
9762 fprintf (stderr
, "\n");
9766 else if (INTERACTIVE
)
9768 /* The frame whose mini-buffer we're going to display the message
9769 on. It may be larger than the selected frame, so we need to
9770 use its buffer, not the selected frame's buffer. */
9771 Lisp_Object mini_window
;
9772 struct frame
*f
, *sf
= SELECTED_FRAME ();
9774 /* Get the frame containing the mini-buffer
9775 that the selected frame is using. */
9776 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9777 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9779 /* Error messages get reported properly by cmd_error, so this must be
9780 just an informative message; if the frame hasn't really been
9781 initialized yet, just toss it. */
9782 if (f
->glyphs_initialized_p
)
9787 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
9788 char *message_buf
= alloca (maxsize
+ 1);
9790 len
= doprnt (message_buf
, maxsize
, m
, (char *)0, ap
);
9792 message3 (make_string (message_buf
, len
));
9797 /* Print should start at the beginning of the message
9798 buffer next time. */
9799 message_buf_print
= 0;
9805 message (const char *m
, ...)
9815 /* The non-logging version of message. */
9818 message_nolog (const char *m
, ...)
9820 Lisp_Object old_log_max
;
9823 old_log_max
= Vmessage_log_max
;
9824 Vmessage_log_max
= Qnil
;
9826 Vmessage_log_max
= old_log_max
;
9832 /* Display the current message in the current mini-buffer. This is
9833 only called from error handlers in process.c, and is not time
9837 update_echo_area (void)
9839 if (!NILP (echo_area_buffer
[0]))
9842 string
= Fcurrent_message ();
9848 /* Make sure echo area buffers in `echo_buffers' are live.
9849 If they aren't, make new ones. */
9852 ensure_echo_area_buffers (void)
9856 for (i
= 0; i
< 2; ++i
)
9857 if (!BUFFERP (echo_buffer
[i
])
9858 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
9861 Lisp_Object old_buffer
;
9864 old_buffer
= echo_buffer
[i
];
9865 echo_buffer
[i
] = Fget_buffer_create
9866 (make_formatted_string (name
, " *Echo Area %d*", i
));
9867 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
9868 /* to force word wrap in echo area -
9869 it was decided to postpone this*/
9870 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9872 for (j
= 0; j
< 2; ++j
)
9873 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9874 echo_area_buffer
[j
] = echo_buffer
[i
];
9879 /* Call FN with args A1..A2 with either the current or last displayed
9880 echo_area_buffer as current buffer.
9882 WHICH zero means use the current message buffer
9883 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9884 from echo_buffer[] and clear it.
9886 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9887 suitable buffer from echo_buffer[] and clear it.
9889 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9890 that the current message becomes the last displayed one, make
9891 choose a suitable buffer for echo_area_buffer[0], and clear it.
9893 Value is what FN returns. */
9896 with_echo_area_buffer (struct window
*w
, int which
,
9897 int (*fn
) (ptrdiff_t, Lisp_Object
),
9898 ptrdiff_t a1
, Lisp_Object a2
)
9901 int this_one
, the_other
, clear_buffer_p
, rc
;
9902 ptrdiff_t count
= SPECPDL_INDEX ();
9904 /* If buffers aren't live, make new ones. */
9905 ensure_echo_area_buffers ();
9910 this_one
= 0, the_other
= 1;
9912 this_one
= 1, the_other
= 0;
9915 this_one
= 0, the_other
= 1;
9918 /* We need a fresh one in case the current echo buffer equals
9919 the one containing the last displayed echo area message. */
9920 if (!NILP (echo_area_buffer
[this_one
])
9921 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9922 echo_area_buffer
[this_one
] = Qnil
;
9925 /* Choose a suitable buffer from echo_buffer[] is we don't
9927 if (NILP (echo_area_buffer
[this_one
]))
9929 echo_area_buffer
[this_one
]
9930 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9931 ? echo_buffer
[the_other
]
9932 : echo_buffer
[this_one
]);
9936 buffer
= echo_area_buffer
[this_one
];
9938 /* Don't get confused by reusing the buffer used for echoing
9939 for a different purpose. */
9940 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9943 record_unwind_protect (unwind_with_echo_area_buffer
,
9944 with_echo_area_buffer_unwind_data (w
));
9946 /* Make the echo area buffer current. Note that for display
9947 purposes, it is not necessary that the displayed window's buffer
9948 == current_buffer, except for text property lookup. So, let's
9949 only set that buffer temporarily here without doing a full
9950 Fset_window_buffer. We must also change w->pointm, though,
9951 because otherwise an assertions in unshow_buffer fails, and Emacs
9953 set_buffer_internal_1 (XBUFFER (buffer
));
9956 wset_buffer (w
, buffer
);
9957 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9960 bset_undo_list (current_buffer
, Qt
);
9961 bset_read_only (current_buffer
, Qnil
);
9962 specbind (Qinhibit_read_only
, Qt
);
9963 specbind (Qinhibit_modification_hooks
, Qt
);
9965 if (clear_buffer_p
&& Z
> BEG
)
9968 eassert (BEGV
>= BEG
);
9969 eassert (ZV
<= Z
&& ZV
>= BEGV
);
9973 eassert (BEGV
>= BEG
);
9974 eassert (ZV
<= Z
&& ZV
>= BEGV
);
9976 unbind_to (count
, Qnil
);
9981 /* Save state that should be preserved around the call to the function
9982 FN called in with_echo_area_buffer. */
9985 with_echo_area_buffer_unwind_data (struct window
*w
)
9988 Lisp_Object vector
, tmp
;
9990 /* Reduce consing by keeping one vector in
9991 Vwith_echo_area_save_vector. */
9992 vector
= Vwith_echo_area_save_vector
;
9993 Vwith_echo_area_save_vector
= Qnil
;
9996 vector
= Fmake_vector (make_number (7), Qnil
);
9998 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9999 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10000 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10004 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10005 ASET (vector
, i
, w
->buffer
); ++i
;
10006 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10007 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10012 for (; i
< end
; ++i
)
10013 ASET (vector
, i
, Qnil
);
10016 eassert (i
== ASIZE (vector
));
10021 /* Restore global state from VECTOR which was created by
10022 with_echo_area_buffer_unwind_data. */
10025 unwind_with_echo_area_buffer (Lisp_Object vector
)
10027 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10028 Vdeactivate_mark
= AREF (vector
, 1);
10029 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10031 if (WINDOWP (AREF (vector
, 3)))
10034 Lisp_Object buffer
, charpos
, bytepos
;
10036 w
= XWINDOW (AREF (vector
, 3));
10037 buffer
= AREF (vector
, 4);
10038 charpos
= AREF (vector
, 5);
10039 bytepos
= AREF (vector
, 6);
10041 wset_buffer (w
, buffer
);
10042 set_marker_both (w
->pointm
, buffer
,
10043 XFASTINT (charpos
), XFASTINT (bytepos
));
10046 Vwith_echo_area_save_vector
= vector
;
10051 /* Set up the echo area for use by print functions. MULTIBYTE_P
10052 non-zero means we will print multibyte. */
10055 setup_echo_area_for_printing (int multibyte_p
)
10057 /* If we can't find an echo area any more, exit. */
10058 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10059 Fkill_emacs (Qnil
);
10061 ensure_echo_area_buffers ();
10063 if (!message_buf_print
)
10065 /* A message has been output since the last time we printed.
10066 Choose a fresh echo area buffer. */
10067 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10068 echo_area_buffer
[0] = echo_buffer
[1];
10070 echo_area_buffer
[0] = echo_buffer
[0];
10072 /* Switch to that buffer and clear it. */
10073 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10074 bset_truncate_lines (current_buffer
, Qnil
);
10078 ptrdiff_t count
= SPECPDL_INDEX ();
10079 specbind (Qinhibit_read_only
, Qt
);
10080 /* Note that undo recording is always disabled. */
10081 del_range (BEG
, Z
);
10082 unbind_to (count
, Qnil
);
10084 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10086 /* Set up the buffer for the multibyteness we need. */
10088 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10089 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10091 /* Raise the frame containing the echo area. */
10092 if (minibuffer_auto_raise
)
10094 struct frame
*sf
= SELECTED_FRAME ();
10095 Lisp_Object mini_window
;
10096 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10097 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10100 message_log_maybe_newline ();
10101 message_buf_print
= 1;
10105 if (NILP (echo_area_buffer
[0]))
10107 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10108 echo_area_buffer
[0] = echo_buffer
[1];
10110 echo_area_buffer
[0] = echo_buffer
[0];
10113 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10115 /* Someone switched buffers between print requests. */
10116 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10117 bset_truncate_lines (current_buffer
, Qnil
);
10123 /* Display an echo area message in window W. Value is non-zero if W's
10124 height is changed. If display_last_displayed_message_p is
10125 non-zero, display the message that was last displayed, otherwise
10126 display the current message. */
10129 display_echo_area (struct window
*w
)
10131 int i
, no_message_p
, window_height_changed_p
;
10133 /* Temporarily disable garbage collections while displaying the echo
10134 area. This is done because a GC can print a message itself.
10135 That message would modify the echo area buffer's contents while a
10136 redisplay of the buffer is going on, and seriously confuse
10138 ptrdiff_t count
= inhibit_garbage_collection ();
10140 /* If there is no message, we must call display_echo_area_1
10141 nevertheless because it resizes the window. But we will have to
10142 reset the echo_area_buffer in question to nil at the end because
10143 with_echo_area_buffer will sets it to an empty buffer. */
10144 i
= display_last_displayed_message_p
? 1 : 0;
10145 no_message_p
= NILP (echo_area_buffer
[i
]);
10147 window_height_changed_p
10148 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10149 display_echo_area_1
,
10150 (intptr_t) w
, Qnil
);
10153 echo_area_buffer
[i
] = Qnil
;
10155 unbind_to (count
, Qnil
);
10156 return window_height_changed_p
;
10160 /* Helper for display_echo_area. Display the current buffer which
10161 contains the current echo area message in window W, a mini-window,
10162 a pointer to which is passed in A1. A2..A4 are currently not used.
10163 Change the height of W so that all of the message is displayed.
10164 Value is non-zero if height of W was changed. */
10167 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10170 struct window
*w
= (struct window
*) i1
;
10171 Lisp_Object window
;
10172 struct text_pos start
;
10173 int window_height_changed_p
= 0;
10175 /* Do this before displaying, so that we have a large enough glyph
10176 matrix for the display. If we can't get enough space for the
10177 whole text, display the last N lines. That works by setting w->start. */
10178 window_height_changed_p
= resize_mini_window (w
, 0);
10180 /* Use the starting position chosen by resize_mini_window. */
10181 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10184 clear_glyph_matrix (w
->desired_matrix
);
10185 XSETWINDOW (window
, w
);
10186 try_window (window
, start
, 0);
10188 return window_height_changed_p
;
10192 /* Resize the echo area window to exactly the size needed for the
10193 currently displayed message, if there is one. If a mini-buffer
10194 is active, don't shrink it. */
10197 resize_echo_area_exactly (void)
10199 if (BUFFERP (echo_area_buffer
[0])
10200 && WINDOWP (echo_area_window
))
10202 struct window
*w
= XWINDOW (echo_area_window
);
10204 Lisp_Object resize_exactly
;
10206 if (minibuf_level
== 0)
10207 resize_exactly
= Qt
;
10209 resize_exactly
= Qnil
;
10211 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10212 (intptr_t) w
, resize_exactly
);
10215 ++windows_or_buffers_changed
;
10216 ++update_mode_lines
;
10217 redisplay_internal ();
10223 /* Callback function for with_echo_area_buffer, when used from
10224 resize_echo_area_exactly. A1 contains a pointer to the window to
10225 resize, EXACTLY non-nil means resize the mini-window exactly to the
10226 size of the text displayed. A3 and A4 are not used. Value is what
10227 resize_mini_window returns. */
10230 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10233 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10237 /* Resize mini-window W to fit the size of its contents. EXACT_P
10238 means size the window exactly to the size needed. Otherwise, it's
10239 only enlarged until W's buffer is empty.
10241 Set W->start to the right place to begin display. If the whole
10242 contents fit, start at the beginning. Otherwise, start so as
10243 to make the end of the contents appear. This is particularly
10244 important for y-or-n-p, but seems desirable generally.
10246 Value is non-zero if the window height has been changed. */
10249 resize_mini_window (struct window
*w
, int exact_p
)
10251 struct frame
*f
= XFRAME (w
->frame
);
10252 int window_height_changed_p
= 0;
10254 eassert (MINI_WINDOW_P (w
));
10256 /* By default, start display at the beginning. */
10257 set_marker_both (w
->start
, w
->buffer
,
10258 BUF_BEGV (XBUFFER (w
->buffer
)),
10259 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10261 /* Don't resize windows while redisplaying a window; it would
10262 confuse redisplay functions when the size of the window they are
10263 displaying changes from under them. Such a resizing can happen,
10264 for instance, when which-func prints a long message while
10265 we are running fontification-functions. We're running these
10266 functions with safe_call which binds inhibit-redisplay to t. */
10267 if (!NILP (Vinhibit_redisplay
))
10270 /* Nil means don't try to resize. */
10271 if (NILP (Vresize_mini_windows
)
10272 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10275 if (!FRAME_MINIBUF_ONLY_P (f
))
10278 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10279 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10281 EMACS_INT max_height
;
10282 int unit
= FRAME_LINE_HEIGHT (f
);
10283 struct text_pos start
;
10284 struct buffer
*old_current_buffer
= NULL
;
10286 if (current_buffer
!= XBUFFER (w
->buffer
))
10288 old_current_buffer
= current_buffer
;
10289 set_buffer_internal (XBUFFER (w
->buffer
));
10292 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10294 /* Compute the max. number of lines specified by the user. */
10295 if (FLOATP (Vmax_mini_window_height
))
10296 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10297 else if (INTEGERP (Vmax_mini_window_height
))
10298 max_height
= XINT (Vmax_mini_window_height
);
10300 max_height
= total_height
/ 4;
10302 /* Correct that max. height if it's bogus. */
10303 max_height
= clip_to_bounds (1, max_height
, total_height
);
10305 /* Find out the height of the text in the window. */
10306 if (it
.line_wrap
== TRUNCATE
)
10311 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10312 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10313 height
= it
.current_y
+ last_height
;
10315 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10316 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10317 height
= (height
+ unit
- 1) / unit
;
10320 /* Compute a suitable window start. */
10321 if (height
> max_height
)
10323 height
= max_height
;
10324 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10325 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10326 start
= it
.current
.pos
;
10329 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10330 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10332 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10334 /* Let it grow only, until we display an empty message, in which
10335 case the window shrinks again. */
10336 if (height
> WINDOW_TOTAL_LINES (w
))
10338 int old_height
= WINDOW_TOTAL_LINES (w
);
10339 freeze_window_starts (f
, 1);
10340 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10341 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10343 else if (height
< WINDOW_TOTAL_LINES (w
)
10344 && (exact_p
|| BEGV
== ZV
))
10346 int old_height
= WINDOW_TOTAL_LINES (w
);
10347 freeze_window_starts (f
, 0);
10348 shrink_mini_window (w
);
10349 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10354 /* Always resize to exact size needed. */
10355 if (height
> WINDOW_TOTAL_LINES (w
))
10357 int old_height
= WINDOW_TOTAL_LINES (w
);
10358 freeze_window_starts (f
, 1);
10359 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10360 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10362 else if (height
< WINDOW_TOTAL_LINES (w
))
10364 int old_height
= WINDOW_TOTAL_LINES (w
);
10365 freeze_window_starts (f
, 0);
10366 shrink_mini_window (w
);
10370 freeze_window_starts (f
, 1);
10371 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10374 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10378 if (old_current_buffer
)
10379 set_buffer_internal (old_current_buffer
);
10382 return window_height_changed_p
;
10386 /* Value is the current message, a string, or nil if there is no
10387 current message. */
10390 current_message (void)
10394 if (!BUFFERP (echo_area_buffer
[0]))
10398 with_echo_area_buffer (0, 0, current_message_1
,
10399 (intptr_t) &msg
, Qnil
);
10401 echo_area_buffer
[0] = Qnil
;
10409 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10412 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10415 *msg
= make_buffer_string (BEG
, Z
, 1);
10422 /* Push the current message on Vmessage_stack for later restoration
10423 by restore_message. Value is non-zero if the current message isn't
10424 empty. This is a relatively infrequent operation, so it's not
10425 worth optimizing. */
10428 push_message (void)
10430 Lisp_Object msg
= current_message ();
10431 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10432 return STRINGP (msg
);
10436 /* Restore message display from the top of Vmessage_stack. */
10439 restore_message (void)
10441 eassert (CONSP (Vmessage_stack
));
10442 message3_nolog (XCAR (Vmessage_stack
));
10446 /* Handler for record_unwind_protect calling pop_message. */
10449 pop_message_unwind (Lisp_Object dummy
)
10455 /* Pop the top-most entry off Vmessage_stack. */
10460 eassert (CONSP (Vmessage_stack
));
10461 Vmessage_stack
= XCDR (Vmessage_stack
);
10465 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10466 exits. If the stack is not empty, we have a missing pop_message
10470 check_message_stack (void)
10472 if (!NILP (Vmessage_stack
))
10477 /* Truncate to NCHARS what will be displayed in the echo area the next
10478 time we display it---but don't redisplay it now. */
10481 truncate_echo_area (ptrdiff_t nchars
)
10484 echo_area_buffer
[0] = Qnil
;
10485 else if (!noninteractive
10487 && !NILP (echo_area_buffer
[0]))
10489 struct frame
*sf
= SELECTED_FRAME ();
10490 /* Error messages get reported properly by cmd_error, so this must be
10491 just an informative message; if the frame hasn't really been
10492 initialized yet, just toss it. */
10493 if (sf
->glyphs_initialized_p
)
10494 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
10499 /* Helper function for truncate_echo_area. Truncate the current
10500 message to at most NCHARS characters. */
10503 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
10505 if (BEG
+ nchars
< Z
)
10506 del_range (BEG
+ nchars
, Z
);
10508 echo_area_buffer
[0] = Qnil
;
10512 /* Set the current message to STRING. */
10515 set_message (Lisp_Object string
)
10517 eassert (STRINGP (string
));
10519 message_enable_multibyte
= STRING_MULTIBYTE (string
);
10521 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
10522 message_buf_print
= 0;
10523 help_echo_showing_p
= 0;
10525 if (STRINGP (Vdebug_on_message
)
10526 && STRINGP (string
)
10527 && fast_string_match (Vdebug_on_message
, string
) >= 0)
10528 call_debugger (list2 (Qerror
, string
));
10532 /* Helper function for set_message. First argument is ignored and second
10533 argument has the same meaning as for set_message.
10534 This function is called with the echo area buffer being current. */
10537 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
10539 eassert (STRINGP (string
));
10541 /* Change multibyteness of the echo buffer appropriately. */
10542 if (message_enable_multibyte
10543 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10544 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10546 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
10547 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10548 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
10550 /* Insert new message at BEG. */
10551 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10553 /* This function takes care of single/multibyte conversion.
10554 We just have to ensure that the echo area buffer has the right
10555 setting of enable_multibyte_characters. */
10556 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
10562 /* Clear messages. CURRENT_P non-zero means clear the current
10563 message. LAST_DISPLAYED_P non-zero means clear the message
10567 clear_message (int current_p
, int last_displayed_p
)
10571 echo_area_buffer
[0] = Qnil
;
10572 message_cleared_p
= 1;
10575 if (last_displayed_p
)
10576 echo_area_buffer
[1] = Qnil
;
10578 message_buf_print
= 0;
10581 /* Clear garbaged frames.
10583 This function is used where the old redisplay called
10584 redraw_garbaged_frames which in turn called redraw_frame which in
10585 turn called clear_frame. The call to clear_frame was a source of
10586 flickering. I believe a clear_frame is not necessary. It should
10587 suffice in the new redisplay to invalidate all current matrices,
10588 and ensure a complete redisplay of all windows. */
10591 clear_garbaged_frames (void)
10593 if (frame_garbaged
)
10595 Lisp_Object tail
, frame
;
10596 int changed_count
= 0;
10598 FOR_EACH_FRAME (tail
, frame
)
10600 struct frame
*f
= XFRAME (frame
);
10602 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10607 f
->force_flush_display_p
= 1;
10609 clear_current_matrices (f
);
10616 frame_garbaged
= 0;
10618 ++windows_or_buffers_changed
;
10623 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10624 is non-zero update selected_frame. Value is non-zero if the
10625 mini-windows height has been changed. */
10628 echo_area_display (int update_frame_p
)
10630 Lisp_Object mini_window
;
10633 int window_height_changed_p
= 0;
10634 struct frame
*sf
= SELECTED_FRAME ();
10636 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10637 w
= XWINDOW (mini_window
);
10638 f
= XFRAME (WINDOW_FRAME (w
));
10640 /* Don't display if frame is invisible or not yet initialized. */
10641 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10644 #ifdef HAVE_WINDOW_SYSTEM
10645 /* When Emacs starts, selected_frame may be the initial terminal
10646 frame. If we let this through, a message would be displayed on
10648 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10650 #endif /* HAVE_WINDOW_SYSTEM */
10652 /* Redraw garbaged frames. */
10653 clear_garbaged_frames ();
10655 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10657 echo_area_window
= mini_window
;
10658 window_height_changed_p
= display_echo_area (w
);
10659 w
->must_be_updated_p
= 1;
10661 /* Update the display, unless called from redisplay_internal.
10662 Also don't update the screen during redisplay itself. The
10663 update will happen at the end of redisplay, and an update
10664 here could cause confusion. */
10665 if (update_frame_p
&& !redisplaying_p
)
10669 /* If the display update has been interrupted by pending
10670 input, update mode lines in the frame. Due to the
10671 pending input, it might have been that redisplay hasn't
10672 been called, so that mode lines above the echo area are
10673 garbaged. This looks odd, so we prevent it here. */
10674 if (!display_completed
)
10675 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10677 if (window_height_changed_p
10678 /* Don't do this if Emacs is shutting down. Redisplay
10679 needs to run hooks. */
10680 && !NILP (Vrun_hooks
))
10682 /* Must update other windows. Likewise as in other
10683 cases, don't let this update be interrupted by
10685 ptrdiff_t count
= SPECPDL_INDEX ();
10686 specbind (Qredisplay_dont_pause
, Qt
);
10687 windows_or_buffers_changed
= 1;
10688 redisplay_internal ();
10689 unbind_to (count
, Qnil
);
10691 else if (FRAME_WINDOW_P (f
) && n
== 0)
10693 /* Window configuration is the same as before.
10694 Can do with a display update of the echo area,
10695 unless we displayed some mode lines. */
10696 update_single_window (w
, 1);
10697 FRAME_RIF (f
)->flush_display (f
);
10700 update_frame (f
, 1, 1);
10702 /* If cursor is in the echo area, make sure that the next
10703 redisplay displays the minibuffer, so that the cursor will
10704 be replaced with what the minibuffer wants. */
10705 if (cursor_in_echo_area
)
10706 ++windows_or_buffers_changed
;
10709 else if (!EQ (mini_window
, selected_window
))
10710 windows_or_buffers_changed
++;
10712 /* Last displayed message is now the current message. */
10713 echo_area_buffer
[1] = echo_area_buffer
[0];
10714 /* Inform read_char that we're not echoing. */
10715 echo_message_buffer
= Qnil
;
10717 /* Prevent redisplay optimization in redisplay_internal by resetting
10718 this_line_start_pos. This is done because the mini-buffer now
10719 displays the message instead of its buffer text. */
10720 if (EQ (mini_window
, selected_window
))
10721 CHARPOS (this_line_start_pos
) = 0;
10723 return window_height_changed_p
;
10726 /* Nonzero if the current window's buffer is shown in more than one
10727 window and was modified since last redisplay. */
10730 buffer_shared_and_changed (void)
10732 return (buffer_window_count (current_buffer
) > 1
10733 && UNCHANGED_MODIFIED
< MODIFF
);
10736 /* Nonzero if W doesn't reflect the actual state of current buffer due
10737 to its text or overlays change. FIXME: this may be called when
10738 XBUFFER (w->buffer) != current_buffer, which looks suspicious. */
10741 window_outdated (struct window
*w
)
10743 return (w
->last_modified
< MODIFF
10744 || w
->last_overlay_modified
< OVERLAY_MODIFF
);
10747 /* Nonzero if W's buffer was changed but not saved or Transient Mark mode
10748 is enabled and mark of W's buffer was changed since last W's update. */
10751 window_buffer_changed (struct window
*w
)
10753 struct buffer
*b
= XBUFFER (w
->buffer
);
10755 eassert (BUFFER_LIVE_P (b
));
10757 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
)
10758 || ((!NILP (Vtransient_mark_mode
) && !NILP (BVAR (b
, mark_active
)))
10759 != (w
->region_showing
!= 0)));
10762 /* Nonzero if W has %c in its mode line and mode line should be updated. */
10765 mode_line_update_needed (struct window
*w
)
10767 return (w
->column_number_displayed
!= -1
10768 && !(PT
== w
->last_point
&& !window_outdated (w
))
10769 && (w
->column_number_displayed
!= current_column ()));
10772 /***********************************************************************
10773 Mode Lines and Frame Titles
10774 ***********************************************************************/
10776 /* A buffer for constructing non-propertized mode-line strings and
10777 frame titles in it; allocated from the heap in init_xdisp and
10778 resized as needed in store_mode_line_noprop_char. */
10780 static char *mode_line_noprop_buf
;
10782 /* The buffer's end, and a current output position in it. */
10784 static char *mode_line_noprop_buf_end
;
10785 static char *mode_line_noprop_ptr
;
10787 #define MODE_LINE_NOPROP_LEN(start) \
10788 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10791 MODE_LINE_DISPLAY
= 0,
10795 } mode_line_target
;
10797 /* Alist that caches the results of :propertize.
10798 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10799 static Lisp_Object mode_line_proptrans_alist
;
10801 /* List of strings making up the mode-line. */
10802 static Lisp_Object mode_line_string_list
;
10804 /* Base face property when building propertized mode line string. */
10805 static Lisp_Object mode_line_string_face
;
10806 static Lisp_Object mode_line_string_face_prop
;
10809 /* Unwind data for mode line strings */
10811 static Lisp_Object Vmode_line_unwind_vector
;
10814 format_mode_line_unwind_data (struct frame
*target_frame
,
10815 struct buffer
*obuf
,
10817 int save_proptrans
)
10819 Lisp_Object vector
, tmp
;
10821 /* Reduce consing by keeping one vector in
10822 Vwith_echo_area_save_vector. */
10823 vector
= Vmode_line_unwind_vector
;
10824 Vmode_line_unwind_vector
= Qnil
;
10827 vector
= Fmake_vector (make_number (10), Qnil
);
10829 ASET (vector
, 0, make_number (mode_line_target
));
10830 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10831 ASET (vector
, 2, mode_line_string_list
);
10832 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10833 ASET (vector
, 4, mode_line_string_face
);
10834 ASET (vector
, 5, mode_line_string_face_prop
);
10837 XSETBUFFER (tmp
, obuf
);
10840 ASET (vector
, 6, tmp
);
10841 ASET (vector
, 7, owin
);
10844 /* Similarly to `with-selected-window', if the operation selects
10845 a window on another frame, we must restore that frame's
10846 selected window, and (for a tty) the top-frame. */
10847 ASET (vector
, 8, target_frame
->selected_window
);
10848 if (FRAME_TERMCAP_P (target_frame
))
10849 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
10856 unwind_format_mode_line (Lisp_Object vector
)
10858 Lisp_Object old_window
= AREF (vector
, 7);
10859 Lisp_Object target_frame_window
= AREF (vector
, 8);
10860 Lisp_Object old_top_frame
= AREF (vector
, 9);
10862 mode_line_target
= XINT (AREF (vector
, 0));
10863 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10864 mode_line_string_list
= AREF (vector
, 2);
10865 if (! EQ (AREF (vector
, 3), Qt
))
10866 mode_line_proptrans_alist
= AREF (vector
, 3);
10867 mode_line_string_face
= AREF (vector
, 4);
10868 mode_line_string_face_prop
= AREF (vector
, 5);
10870 /* Select window before buffer, since it may change the buffer. */
10871 if (!NILP (old_window
))
10873 /* If the operation that we are unwinding had selected a window
10874 on a different frame, reset its frame-selected-window. For a
10875 text terminal, reset its top-frame if necessary. */
10876 if (!NILP (target_frame_window
))
10879 = WINDOW_FRAME (XWINDOW (target_frame_window
));
10881 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
10882 Fselect_window (target_frame_window
, Qt
);
10884 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
10885 Fselect_frame (old_top_frame
, Qt
);
10888 Fselect_window (old_window
, Qt
);
10891 if (!NILP (AREF (vector
, 6)))
10893 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10894 ASET (vector
, 6, Qnil
);
10897 Vmode_line_unwind_vector
= vector
;
10902 /* Store a single character C for the frame title in mode_line_noprop_buf.
10903 Re-allocate mode_line_noprop_buf if necessary. */
10906 store_mode_line_noprop_char (char c
)
10908 /* If output position has reached the end of the allocated buffer,
10909 increase the buffer's size. */
10910 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10912 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10913 ptrdiff_t size
= len
;
10914 mode_line_noprop_buf
=
10915 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10916 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10917 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10920 *mode_line_noprop_ptr
++ = c
;
10924 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10925 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10926 characters that yield more columns than PRECISION; PRECISION <= 0
10927 means copy the whole string. Pad with spaces until FIELD_WIDTH
10928 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10929 pad. Called from display_mode_element when it is used to build a
10933 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10935 const unsigned char *str
= (const unsigned char *) string
;
10937 ptrdiff_t dummy
, nbytes
;
10939 /* Copy at most PRECISION chars from STR. */
10940 nbytes
= strlen (string
);
10941 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10943 store_mode_line_noprop_char (*str
++);
10945 /* Fill up with spaces until FIELD_WIDTH reached. */
10946 while (field_width
> 0
10947 && n
< field_width
)
10949 store_mode_line_noprop_char (' ');
10956 /***********************************************************************
10958 ***********************************************************************/
10960 #ifdef HAVE_WINDOW_SYSTEM
10962 /* Set the title of FRAME, if it has changed. The title format is
10963 Vicon_title_format if FRAME is iconified, otherwise it is
10964 frame_title_format. */
10967 x_consider_frame_title (Lisp_Object frame
)
10969 struct frame
*f
= XFRAME (frame
);
10971 if (FRAME_WINDOW_P (f
)
10972 || FRAME_MINIBUF_ONLY_P (f
)
10973 || f
->explicit_name
)
10975 /* Do we have more than one visible frame on this X display? */
10976 Lisp_Object tail
, other_frame
, fmt
;
10977 ptrdiff_t title_start
;
10981 ptrdiff_t count
= SPECPDL_INDEX ();
10983 FOR_EACH_FRAME (tail
, other_frame
)
10985 struct frame
*tf
= XFRAME (other_frame
);
10988 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10989 && !FRAME_MINIBUF_ONLY_P (tf
)
10990 && !EQ (other_frame
, tip_frame
)
10991 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10995 /* Set global variable indicating that multiple frames exist. */
10996 multiple_frames
= CONSP (tail
);
10998 /* Switch to the buffer of selected window of the frame. Set up
10999 mode_line_target so that display_mode_element will output into
11000 mode_line_noprop_buf; then display the title. */
11001 record_unwind_protect (unwind_format_mode_line
,
11002 format_mode_line_unwind_data
11003 (f
, current_buffer
, selected_window
, 0));
11005 Fselect_window (f
->selected_window
, Qt
);
11006 set_buffer_internal_1
11007 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
11008 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11010 mode_line_target
= MODE_LINE_TITLE
;
11011 title_start
= MODE_LINE_NOPROP_LEN (0);
11012 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11013 NULL
, DEFAULT_FACE_ID
);
11014 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11015 len
= MODE_LINE_NOPROP_LEN (title_start
);
11016 title
= mode_line_noprop_buf
+ title_start
;
11017 unbind_to (count
, Qnil
);
11019 /* Set the title only if it's changed. This avoids consing in
11020 the common case where it hasn't. (If it turns out that we've
11021 already wasted too much time by walking through the list with
11022 display_mode_element, then we might need to optimize at a
11023 higher level than this.) */
11024 if (! STRINGP (f
->name
)
11025 || SBYTES (f
->name
) != len
11026 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11027 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11031 #endif /* not HAVE_WINDOW_SYSTEM */
11034 /***********************************************************************
11036 ***********************************************************************/
11039 /* Prepare for redisplay by updating menu-bar item lists when
11040 appropriate. This can call eval. */
11043 prepare_menu_bars (void)
11046 struct gcpro gcpro1
, gcpro2
;
11048 Lisp_Object tooltip_frame
;
11050 #ifdef HAVE_WINDOW_SYSTEM
11051 tooltip_frame
= tip_frame
;
11053 tooltip_frame
= Qnil
;
11056 /* Update all frame titles based on their buffer names, etc. We do
11057 this before the menu bars so that the buffer-menu will show the
11058 up-to-date frame titles. */
11059 #ifdef HAVE_WINDOW_SYSTEM
11060 if (windows_or_buffers_changed
|| update_mode_lines
)
11062 Lisp_Object tail
, frame
;
11064 FOR_EACH_FRAME (tail
, frame
)
11066 f
= XFRAME (frame
);
11067 if (!EQ (frame
, tooltip_frame
)
11068 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
11069 x_consider_frame_title (frame
);
11072 #endif /* HAVE_WINDOW_SYSTEM */
11074 /* Update the menu bar item lists, if appropriate. This has to be
11075 done before any actual redisplay or generation of display lines. */
11076 all_windows
= (update_mode_lines
11077 || buffer_shared_and_changed ()
11078 || windows_or_buffers_changed
);
11081 Lisp_Object tail
, frame
;
11082 ptrdiff_t count
= SPECPDL_INDEX ();
11083 /* 1 means that update_menu_bar has run its hooks
11084 so any further calls to update_menu_bar shouldn't do so again. */
11085 int menu_bar_hooks_run
= 0;
11087 record_unwind_save_match_data ();
11089 FOR_EACH_FRAME (tail
, frame
)
11091 f
= XFRAME (frame
);
11093 /* Ignore tooltip frame. */
11094 if (EQ (frame
, tooltip_frame
))
11097 /* If a window on this frame changed size, report that to
11098 the user and clear the size-change flag. */
11099 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11101 Lisp_Object functions
;
11103 /* Clear flag first in case we get an error below. */
11104 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11105 functions
= Vwindow_size_change_functions
;
11106 GCPRO2 (tail
, functions
);
11108 while (CONSP (functions
))
11110 if (!EQ (XCAR (functions
), Qt
))
11111 call1 (XCAR (functions
), frame
);
11112 functions
= XCDR (functions
);
11118 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11119 #ifdef HAVE_WINDOW_SYSTEM
11120 update_tool_bar (f
, 0);
11123 if (windows_or_buffers_changed
11126 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->buffer
));
11131 unbind_to (count
, Qnil
);
11135 struct frame
*sf
= SELECTED_FRAME ();
11136 update_menu_bar (sf
, 1, 0);
11137 #ifdef HAVE_WINDOW_SYSTEM
11138 update_tool_bar (sf
, 1);
11144 /* Update the menu bar item list for frame F. This has to be done
11145 before we start to fill in any display lines, because it can call
11148 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11150 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11151 already ran the menu bar hooks for this redisplay, so there
11152 is no need to run them again. The return value is the
11153 updated value of this flag, to pass to the next call. */
11156 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11158 Lisp_Object window
;
11159 register struct window
*w
;
11161 /* If called recursively during a menu update, do nothing. This can
11162 happen when, for instance, an activate-menubar-hook causes a
11164 if (inhibit_menubar_update
)
11167 window
= FRAME_SELECTED_WINDOW (f
);
11168 w
= XWINDOW (window
);
11170 if (FRAME_WINDOW_P (f
)
11172 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11173 || defined (HAVE_NS) || defined (USE_GTK)
11174 FRAME_EXTERNAL_MENU_BAR (f
)
11176 FRAME_MENU_BAR_LINES (f
) > 0
11178 : FRAME_MENU_BAR_LINES (f
) > 0)
11180 /* If the user has switched buffers or windows, we need to
11181 recompute to reflect the new bindings. But we'll
11182 recompute when update_mode_lines is set too; that means
11183 that people can use force-mode-line-update to request
11184 that the menu bar be recomputed. The adverse effect on
11185 the rest of the redisplay algorithm is about the same as
11186 windows_or_buffers_changed anyway. */
11187 if (windows_or_buffers_changed
11188 /* This used to test w->update_mode_line, but we believe
11189 there is no need to recompute the menu in that case. */
11190 || update_mode_lines
11191 || window_buffer_changed (w
))
11193 struct buffer
*prev
= current_buffer
;
11194 ptrdiff_t count
= SPECPDL_INDEX ();
11196 specbind (Qinhibit_menubar_update
, Qt
);
11198 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11199 if (save_match_data
)
11200 record_unwind_save_match_data ();
11201 if (NILP (Voverriding_local_map_menu_flag
))
11203 specbind (Qoverriding_terminal_local_map
, Qnil
);
11204 specbind (Qoverriding_local_map
, Qnil
);
11209 /* Run the Lucid hook. */
11210 safe_run_hooks (Qactivate_menubar_hook
);
11212 /* If it has changed current-menubar from previous value,
11213 really recompute the menu-bar from the value. */
11214 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11215 call0 (Qrecompute_lucid_menubar
);
11217 safe_run_hooks (Qmenu_bar_update_hook
);
11222 XSETFRAME (Vmenu_updating_frame
, f
);
11223 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11225 /* Redisplay the menu bar in case we changed it. */
11226 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11227 || defined (HAVE_NS) || defined (USE_GTK)
11228 if (FRAME_WINDOW_P (f
))
11230 #if defined (HAVE_NS)
11231 /* All frames on Mac OS share the same menubar. So only
11232 the selected frame should be allowed to set it. */
11233 if (f
== SELECTED_FRAME ())
11235 set_frame_menubar (f
, 0, 0);
11238 /* On a terminal screen, the menu bar is an ordinary screen
11239 line, and this makes it get updated. */
11240 w
->update_mode_line
= 1;
11241 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11242 /* In the non-toolkit version, the menu bar is an ordinary screen
11243 line, and this makes it get updated. */
11244 w
->update_mode_line
= 1;
11245 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11247 unbind_to (count
, Qnil
);
11248 set_buffer_internal_1 (prev
);
11257 /***********************************************************************
11259 ***********************************************************************/
11261 #ifdef HAVE_WINDOW_SYSTEM
11264 Nominal cursor position -- where to draw output.
11265 HPOS and VPOS are window relative glyph matrix coordinates.
11266 X and Y are window relative pixel coordinates. */
11268 struct cursor_pos output_cursor
;
11272 Set the global variable output_cursor to CURSOR. All cursor
11273 positions are relative to updated_window. */
11276 set_output_cursor (struct cursor_pos
*cursor
)
11278 output_cursor
.hpos
= cursor
->hpos
;
11279 output_cursor
.vpos
= cursor
->vpos
;
11280 output_cursor
.x
= cursor
->x
;
11281 output_cursor
.y
= cursor
->y
;
11286 Set a nominal cursor position.
11288 HPOS and VPOS are column/row positions in a window glyph matrix. X
11289 and Y are window text area relative pixel positions.
11291 If this is done during an update, updated_window will contain the
11292 window that is being updated and the position is the future output
11293 cursor position for that window. If updated_window is null, use
11294 selected_window and display the cursor at the given position. */
11297 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11301 /* If updated_window is not set, work on selected_window. */
11302 if (updated_window
)
11303 w
= updated_window
;
11305 w
= XWINDOW (selected_window
);
11307 /* Set the output cursor. */
11308 output_cursor
.hpos
= hpos
;
11309 output_cursor
.vpos
= vpos
;
11310 output_cursor
.x
= x
;
11311 output_cursor
.y
= y
;
11313 /* If not called as part of an update, really display the cursor.
11314 This will also set the cursor position of W. */
11315 if (updated_window
== NULL
)
11318 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11319 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11320 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11325 #endif /* HAVE_WINDOW_SYSTEM */
11328 /***********************************************************************
11330 ***********************************************************************/
11332 #ifdef HAVE_WINDOW_SYSTEM
11334 /* Where the mouse was last time we reported a mouse event. */
11336 FRAME_PTR last_mouse_frame
;
11338 /* Tool-bar item index of the item on which a mouse button was pressed
11341 int last_tool_bar_item
;
11343 /* Select `frame' temporarily without running all the code in
11345 FIXME: Maybe do_switch_frame should be trimmed down similarly
11346 when `norecord' is set. */
11348 fast_set_selected_frame (Lisp_Object frame
)
11350 if (!EQ (selected_frame
, frame
))
11352 selected_frame
= frame
;
11353 selected_window
= XFRAME (frame
)->selected_window
;
11358 /* Update the tool-bar item list for frame F. This has to be done
11359 before we start to fill in any display lines. Called from
11360 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11361 and restore it here. */
11364 update_tool_bar (struct frame
*f
, int save_match_data
)
11366 #if defined (USE_GTK) || defined (HAVE_NS)
11367 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11369 int do_update
= WINDOWP (f
->tool_bar_window
)
11370 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11375 Lisp_Object window
;
11378 window
= FRAME_SELECTED_WINDOW (f
);
11379 w
= XWINDOW (window
);
11381 /* If the user has switched buffers or windows, we need to
11382 recompute to reflect the new bindings. But we'll
11383 recompute when update_mode_lines is set too; that means
11384 that people can use force-mode-line-update to request
11385 that the menu bar be recomputed. The adverse effect on
11386 the rest of the redisplay algorithm is about the same as
11387 windows_or_buffers_changed anyway. */
11388 if (windows_or_buffers_changed
11389 || w
->update_mode_line
11390 || update_mode_lines
11391 || window_buffer_changed (w
))
11393 struct buffer
*prev
= current_buffer
;
11394 ptrdiff_t count
= SPECPDL_INDEX ();
11395 Lisp_Object frame
, new_tool_bar
;
11396 int new_n_tool_bar
;
11397 struct gcpro gcpro1
;
11399 /* Set current_buffer to the buffer of the selected
11400 window of the frame, so that we get the right local
11402 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11404 /* Save match data, if we must. */
11405 if (save_match_data
)
11406 record_unwind_save_match_data ();
11408 /* Make sure that we don't accidentally use bogus keymaps. */
11409 if (NILP (Voverriding_local_map_menu_flag
))
11411 specbind (Qoverriding_terminal_local_map
, Qnil
);
11412 specbind (Qoverriding_local_map
, Qnil
);
11415 GCPRO1 (new_tool_bar
);
11417 /* We must temporarily set the selected frame to this frame
11418 before calling tool_bar_items, because the calculation of
11419 the tool-bar keymap uses the selected frame (see
11420 `tool-bar-make-keymap' in tool-bar.el). */
11421 eassert (EQ (selected_window
,
11422 /* Since we only explicitly preserve selected_frame,
11423 check that selected_window would be redundant. */
11424 XFRAME (selected_frame
)->selected_window
));
11425 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11426 XSETFRAME (frame
, f
);
11427 fast_set_selected_frame (frame
);
11429 /* Build desired tool-bar items from keymaps. */
11431 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11434 /* Redisplay the tool-bar if we changed it. */
11435 if (new_n_tool_bar
!= f
->n_tool_bar_items
11436 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11438 /* Redisplay that happens asynchronously due to an expose event
11439 may access f->tool_bar_items. Make sure we update both
11440 variables within BLOCK_INPUT so no such event interrupts. */
11442 fset_tool_bar_items (f
, new_tool_bar
);
11443 f
->n_tool_bar_items
= new_n_tool_bar
;
11444 w
->update_mode_line
= 1;
11450 unbind_to (count
, Qnil
);
11451 set_buffer_internal_1 (prev
);
11457 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11458 F's desired tool-bar contents. F->tool_bar_items must have
11459 been set up previously by calling prepare_menu_bars. */
11462 build_desired_tool_bar_string (struct frame
*f
)
11464 int i
, size
, size_needed
;
11465 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11466 Lisp_Object image
, plist
, props
;
11468 image
= plist
= props
= Qnil
;
11469 GCPRO3 (image
, plist
, props
);
11471 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11472 Otherwise, make a new string. */
11474 /* The size of the string we might be able to reuse. */
11475 size
= (STRINGP (f
->desired_tool_bar_string
)
11476 ? SCHARS (f
->desired_tool_bar_string
)
11479 /* We need one space in the string for each image. */
11480 size_needed
= f
->n_tool_bar_items
;
11482 /* Reuse f->desired_tool_bar_string, if possible. */
11483 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11484 fset_desired_tool_bar_string
11485 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11488 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11489 Fremove_text_properties (make_number (0), make_number (size
),
11490 props
, f
->desired_tool_bar_string
);
11493 /* Put a `display' property on the string for the images to display,
11494 put a `menu_item' property on tool-bar items with a value that
11495 is the index of the item in F's tool-bar item vector. */
11496 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11498 #define PROP(IDX) \
11499 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11501 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11502 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11503 int hmargin
, vmargin
, relief
, idx
, end
;
11505 /* If image is a vector, choose the image according to the
11507 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11508 if (VECTORP (image
))
11512 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11513 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11516 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11517 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11519 eassert (ASIZE (image
) >= idx
);
11520 image
= AREF (image
, idx
);
11525 /* Ignore invalid image specifications. */
11526 if (!valid_image_p (image
))
11529 /* Display the tool-bar button pressed, or depressed. */
11530 plist
= Fcopy_sequence (XCDR (image
));
11532 /* Compute margin and relief to draw. */
11533 relief
= (tool_bar_button_relief
>= 0
11534 ? tool_bar_button_relief
11535 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11536 hmargin
= vmargin
= relief
;
11538 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11539 INT_MAX
- max (hmargin
, vmargin
)))
11541 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11542 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11544 else if (CONSP (Vtool_bar_button_margin
))
11546 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11547 INT_MAX
- hmargin
))
11548 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11550 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11551 INT_MAX
- vmargin
))
11552 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11555 if (auto_raise_tool_bar_buttons_p
)
11557 /* Add a `:relief' property to the image spec if the item is
11561 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11568 /* If image is selected, display it pressed, i.e. with a
11569 negative relief. If it's not selected, display it with a
11571 plist
= Fplist_put (plist
, QCrelief
,
11573 ? make_number (-relief
)
11574 : make_number (relief
)));
11579 /* Put a margin around the image. */
11580 if (hmargin
|| vmargin
)
11582 if (hmargin
== vmargin
)
11583 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11585 plist
= Fplist_put (plist
, QCmargin
,
11586 Fcons (make_number (hmargin
),
11587 make_number (vmargin
)));
11590 /* If button is not enabled, and we don't have special images
11591 for the disabled state, make the image appear disabled by
11592 applying an appropriate algorithm to it. */
11593 if (!enabled_p
&& idx
< 0)
11594 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11596 /* Put a `display' text property on the string for the image to
11597 display. Put a `menu-item' property on the string that gives
11598 the start of this item's properties in the tool-bar items
11600 image
= Fcons (Qimage
, plist
);
11601 props
= list4 (Qdisplay
, image
,
11602 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11604 /* Let the last image hide all remaining spaces in the tool bar
11605 string. The string can be longer than needed when we reuse a
11606 previous string. */
11607 if (i
+ 1 == f
->n_tool_bar_items
)
11608 end
= SCHARS (f
->desired_tool_bar_string
);
11611 Fadd_text_properties (make_number (i
), make_number (end
),
11612 props
, f
->desired_tool_bar_string
);
11620 /* Display one line of the tool-bar of frame IT->f.
11622 HEIGHT specifies the desired height of the tool-bar line.
11623 If the actual height of the glyph row is less than HEIGHT, the
11624 row's height is increased to HEIGHT, and the icons are centered
11625 vertically in the new height.
11627 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11628 count a final empty row in case the tool-bar width exactly matches
11633 display_tool_bar_line (struct it
*it
, int height
)
11635 struct glyph_row
*row
= it
->glyph_row
;
11636 int max_x
= it
->last_visible_x
;
11637 struct glyph
*last
;
11639 prepare_desired_row (row
);
11640 row
->y
= it
->current_y
;
11642 /* Note that this isn't made use of if the face hasn't a box,
11643 so there's no need to check the face here. */
11644 it
->start_of_box_run_p
= 1;
11646 while (it
->current_x
< max_x
)
11648 int x
, n_glyphs_before
, i
, nglyphs
;
11649 struct it it_before
;
11651 /* Get the next display element. */
11652 if (!get_next_display_element (it
))
11654 /* Don't count empty row if we are counting needed tool-bar lines. */
11655 if (height
< 0 && !it
->hpos
)
11660 /* Produce glyphs. */
11661 n_glyphs_before
= row
->used
[TEXT_AREA
];
11664 PRODUCE_GLYPHS (it
);
11666 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11668 x
= it_before
.current_x
;
11669 while (i
< nglyphs
)
11671 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11673 if (x
+ glyph
->pixel_width
> max_x
)
11675 /* Glyph doesn't fit on line. Backtrack. */
11676 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11678 /* If this is the only glyph on this line, it will never fit on the
11679 tool-bar, so skip it. But ensure there is at least one glyph,
11680 so we don't accidentally disable the tool-bar. */
11681 if (n_glyphs_before
== 0
11682 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11688 x
+= glyph
->pixel_width
;
11692 /* Stop at line end. */
11693 if (ITERATOR_AT_END_OF_LINE_P (it
))
11696 set_iterator_to_next (it
, 1);
11701 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11703 /* Use default face for the border below the tool bar.
11705 FIXME: When auto-resize-tool-bars is grow-only, there is
11706 no additional border below the possibly empty tool-bar lines.
11707 So to make the extra empty lines look "normal", we have to
11708 use the tool-bar face for the border too. */
11709 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11710 it
->face_id
= DEFAULT_FACE_ID
;
11712 extend_face_to_end_of_line (it
);
11713 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11714 last
->right_box_line_p
= 1;
11715 if (last
== row
->glyphs
[TEXT_AREA
])
11716 last
->left_box_line_p
= 1;
11718 /* Make line the desired height and center it vertically. */
11719 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11721 /* Don't add more than one line height. */
11722 height
%= FRAME_LINE_HEIGHT (it
->f
);
11723 it
->max_ascent
+= height
/ 2;
11724 it
->max_descent
+= (height
+ 1) / 2;
11727 compute_line_metrics (it
);
11729 /* If line is empty, make it occupy the rest of the tool-bar. */
11730 if (!row
->displays_text_p
)
11732 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11733 row
->visible_height
= row
->height
;
11734 row
->ascent
= row
->phys_ascent
= 0;
11735 row
->extra_line_spacing
= 0;
11738 row
->full_width_p
= 1;
11739 row
->continued_p
= 0;
11740 row
->truncated_on_left_p
= 0;
11741 row
->truncated_on_right_p
= 0;
11743 it
->current_x
= it
->hpos
= 0;
11744 it
->current_y
+= row
->height
;
11750 /* Max tool-bar height. */
11752 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11753 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11755 /* Value is the number of screen lines needed to make all tool-bar
11756 items of frame F visible. The number of actual rows needed is
11757 returned in *N_ROWS if non-NULL. */
11760 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11762 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11764 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11765 the desired matrix, so use (unused) mode-line row as temporary row to
11766 avoid destroying the first tool-bar row. */
11767 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11769 /* Initialize an iterator for iteration over
11770 F->desired_tool_bar_string in the tool-bar window of frame F. */
11771 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11772 it
.first_visible_x
= 0;
11773 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11774 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11775 it
.paragraph_embedding
= L2R
;
11777 while (!ITERATOR_AT_END_P (&it
))
11779 clear_glyph_row (temp_row
);
11780 it
.glyph_row
= temp_row
;
11781 display_tool_bar_line (&it
, -1);
11783 clear_glyph_row (temp_row
);
11785 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11787 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11789 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11793 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11795 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
11796 If FRAME is nil or omitted, use the selected frame. */)
11797 (Lisp_Object frame
)
11799 struct frame
*f
= decode_any_frame (frame
);
11803 if (WINDOWP (f
->tool_bar_window
)
11804 && (w
= XWINDOW (f
->tool_bar_window
),
11805 WINDOW_TOTAL_LINES (w
) > 0))
11807 update_tool_bar (f
, 1);
11808 if (f
->n_tool_bar_items
)
11810 build_desired_tool_bar_string (f
);
11811 nlines
= tool_bar_lines_needed (f
, NULL
);
11815 return make_number (nlines
);
11819 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11820 height should be changed. */
11823 redisplay_tool_bar (struct frame
*f
)
11827 struct glyph_row
*row
;
11829 #if defined (USE_GTK) || defined (HAVE_NS)
11830 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11831 update_frame_tool_bar (f
);
11835 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11836 do anything. This means you must start with tool-bar-lines
11837 non-zero to get the auto-sizing effect. Or in other words, you
11838 can turn off tool-bars by specifying tool-bar-lines zero. */
11839 if (!WINDOWP (f
->tool_bar_window
)
11840 || (w
= XWINDOW (f
->tool_bar_window
),
11841 WINDOW_TOTAL_LINES (w
) == 0))
11844 /* Set up an iterator for the tool-bar window. */
11845 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11846 it
.first_visible_x
= 0;
11847 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11848 row
= it
.glyph_row
;
11850 /* Build a string that represents the contents of the tool-bar. */
11851 build_desired_tool_bar_string (f
);
11852 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11853 /* FIXME: This should be controlled by a user option. But it
11854 doesn't make sense to have an R2L tool bar if the menu bar cannot
11855 be drawn also R2L, and making the menu bar R2L is tricky due
11856 toolkit-specific code that implements it. If an R2L tool bar is
11857 ever supported, display_tool_bar_line should also be augmented to
11858 call unproduce_glyphs like display_line and display_string
11860 it
.paragraph_embedding
= L2R
;
11862 if (f
->n_tool_bar_rows
== 0)
11866 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11867 nlines
!= WINDOW_TOTAL_LINES (w
)))
11870 int old_height
= WINDOW_TOTAL_LINES (w
);
11872 XSETFRAME (frame
, f
);
11873 Fmodify_frame_parameters (frame
,
11874 Fcons (Fcons (Qtool_bar_lines
,
11875 make_number (nlines
)),
11877 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11879 clear_glyph_matrix (w
->desired_matrix
);
11880 fonts_changed_p
= 1;
11886 /* Display as many lines as needed to display all tool-bar items. */
11888 if (f
->n_tool_bar_rows
> 0)
11890 int border
, rows
, height
, extra
;
11892 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
11893 border
= XINT (Vtool_bar_border
);
11894 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11895 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11896 else if (EQ (Vtool_bar_border
, Qborder_width
))
11897 border
= f
->border_width
;
11903 rows
= f
->n_tool_bar_rows
;
11904 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11905 extra
= it
.last_visible_y
- border
- height
* rows
;
11907 while (it
.current_y
< it
.last_visible_y
)
11910 if (extra
> 0 && rows
-- > 0)
11912 h
= (extra
+ rows
- 1) / rows
;
11915 display_tool_bar_line (&it
, height
+ h
);
11920 while (it
.current_y
< it
.last_visible_y
)
11921 display_tool_bar_line (&it
, 0);
11924 /* It doesn't make much sense to try scrolling in the tool-bar
11925 window, so don't do it. */
11926 w
->desired_matrix
->no_scrolling_p
= 1;
11927 w
->must_be_updated_p
= 1;
11929 if (!NILP (Vauto_resize_tool_bars
))
11931 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11932 int change_height_p
= 0;
11934 /* If we couldn't display everything, change the tool-bar's
11935 height if there is room for more. */
11936 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11937 && it
.current_y
< max_tool_bar_height
)
11938 change_height_p
= 1;
11940 row
= it
.glyph_row
- 1;
11942 /* If there are blank lines at the end, except for a partially
11943 visible blank line at the end that is smaller than
11944 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11945 if (!row
->displays_text_p
11946 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11947 change_height_p
= 1;
11949 /* If row displays tool-bar items, but is partially visible,
11950 change the tool-bar's height. */
11951 if (row
->displays_text_p
11952 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11953 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11954 change_height_p
= 1;
11956 /* Resize windows as needed by changing the `tool-bar-lines'
11957 frame parameter. */
11958 if (change_height_p
)
11961 int old_height
= WINDOW_TOTAL_LINES (w
);
11963 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11965 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11966 && !f
->minimize_tool_bar_window_p
)
11967 ? (nlines
> old_height
)
11968 : (nlines
!= old_height
));
11969 f
->minimize_tool_bar_window_p
= 0;
11971 if (change_height_p
)
11973 XSETFRAME (frame
, f
);
11974 Fmodify_frame_parameters (frame
,
11975 Fcons (Fcons (Qtool_bar_lines
,
11976 make_number (nlines
)),
11978 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11980 clear_glyph_matrix (w
->desired_matrix
);
11981 f
->n_tool_bar_rows
= nrows
;
11982 fonts_changed_p
= 1;
11989 f
->minimize_tool_bar_window_p
= 0;
11994 /* Get information about the tool-bar item which is displayed in GLYPH
11995 on frame F. Return in *PROP_IDX the index where tool-bar item
11996 properties start in F->tool_bar_items. Value is zero if
11997 GLYPH doesn't display a tool-bar item. */
12000 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12006 /* This function can be called asynchronously, which means we must
12007 exclude any possibility that Fget_text_property signals an
12009 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12010 charpos
= max (0, charpos
);
12012 /* Get the text property `menu-item' at pos. The value of that
12013 property is the start index of this item's properties in
12014 F->tool_bar_items. */
12015 prop
= Fget_text_property (make_number (charpos
),
12016 Qmenu_item
, f
->current_tool_bar_string
);
12017 if (INTEGERP (prop
))
12019 *prop_idx
= XINT (prop
);
12029 /* Get information about the tool-bar item at position X/Y on frame F.
12030 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12031 the current matrix of the tool-bar window of F, or NULL if not
12032 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12033 item in F->tool_bar_items. Value is
12035 -1 if X/Y is not on a tool-bar item
12036 0 if X/Y is on the same item that was highlighted before.
12040 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12041 int *hpos
, int *vpos
, int *prop_idx
)
12043 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12044 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12047 /* Find the glyph under X/Y. */
12048 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12049 if (*glyph
== NULL
)
12052 /* Get the start of this tool-bar item's properties in
12053 f->tool_bar_items. */
12054 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12057 /* Is mouse on the highlighted item? */
12058 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12059 && *vpos
>= hlinfo
->mouse_face_beg_row
12060 && *vpos
<= hlinfo
->mouse_face_end_row
12061 && (*vpos
> hlinfo
->mouse_face_beg_row
12062 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12063 && (*vpos
< hlinfo
->mouse_face_end_row
12064 || *hpos
< hlinfo
->mouse_face_end_col
12065 || hlinfo
->mouse_face_past_end
))
12073 Handle mouse button event on the tool-bar of frame F, at
12074 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12075 0 for button release. MODIFIERS is event modifiers for button
12079 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12082 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12083 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12084 int hpos
, vpos
, prop_idx
;
12085 struct glyph
*glyph
;
12086 Lisp_Object enabled_p
;
12088 /* If not on the highlighted tool-bar item, return. */
12089 frame_to_window_pixel_xy (w
, &x
, &y
);
12090 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12093 /* If item is disabled, do nothing. */
12094 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12095 if (NILP (enabled_p
))
12100 /* Show item in pressed state. */
12101 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12102 last_tool_bar_item
= prop_idx
;
12106 Lisp_Object key
, frame
;
12107 struct input_event event
;
12108 EVENT_INIT (event
);
12110 /* Show item in released state. */
12111 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12113 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12115 XSETFRAME (frame
, f
);
12116 event
.kind
= TOOL_BAR_EVENT
;
12117 event
.frame_or_window
= frame
;
12119 kbd_buffer_store_event (&event
);
12121 event
.kind
= TOOL_BAR_EVENT
;
12122 event
.frame_or_window
= frame
;
12124 event
.modifiers
= modifiers
;
12125 kbd_buffer_store_event (&event
);
12126 last_tool_bar_item
= -1;
12131 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12132 tool-bar window-relative coordinates X/Y. Called from
12133 note_mouse_highlight. */
12136 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12138 Lisp_Object window
= f
->tool_bar_window
;
12139 struct window
*w
= XWINDOW (window
);
12140 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12141 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12143 struct glyph
*glyph
;
12144 struct glyph_row
*row
;
12146 Lisp_Object enabled_p
;
12148 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12149 int mouse_down_p
, rc
;
12151 /* Function note_mouse_highlight is called with negative X/Y
12152 values when mouse moves outside of the frame. */
12153 if (x
<= 0 || y
<= 0)
12155 clear_mouse_face (hlinfo
);
12159 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12162 /* Not on tool-bar item. */
12163 clear_mouse_face (hlinfo
);
12167 /* On same tool-bar item as before. */
12168 goto set_help_echo
;
12170 clear_mouse_face (hlinfo
);
12172 /* Mouse is down, but on different tool-bar item? */
12173 mouse_down_p
= (dpyinfo
->grabbed
12174 && f
== last_mouse_frame
12175 && FRAME_LIVE_P (f
));
12177 && last_tool_bar_item
!= prop_idx
)
12180 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12182 /* If tool-bar item is not enabled, don't highlight it. */
12183 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12184 if (!NILP (enabled_p
))
12186 /* Compute the x-position of the glyph. In front and past the
12187 image is a space. We include this in the highlighted area. */
12188 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12189 for (i
= x
= 0; i
< hpos
; ++i
)
12190 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12192 /* Record this as the current active region. */
12193 hlinfo
->mouse_face_beg_col
= hpos
;
12194 hlinfo
->mouse_face_beg_row
= vpos
;
12195 hlinfo
->mouse_face_beg_x
= x
;
12196 hlinfo
->mouse_face_beg_y
= row
->y
;
12197 hlinfo
->mouse_face_past_end
= 0;
12199 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12200 hlinfo
->mouse_face_end_row
= vpos
;
12201 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12202 hlinfo
->mouse_face_end_y
= row
->y
;
12203 hlinfo
->mouse_face_window
= window
;
12204 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12206 /* Display it as active. */
12207 show_mouse_face (hlinfo
, draw
);
12212 /* Set help_echo_string to a help string to display for this tool-bar item.
12213 XTread_socket does the rest. */
12214 help_echo_object
= help_echo_window
= Qnil
;
12215 help_echo_pos
= -1;
12216 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12217 if (NILP (help_echo_string
))
12218 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12221 #endif /* HAVE_WINDOW_SYSTEM */
12225 /************************************************************************
12226 Horizontal scrolling
12227 ************************************************************************/
12229 static int hscroll_window_tree (Lisp_Object
);
12230 static int hscroll_windows (Lisp_Object
);
12232 /* For all leaf windows in the window tree rooted at WINDOW, set their
12233 hscroll value so that PT is (i) visible in the window, and (ii) so
12234 that it is not within a certain margin at the window's left and
12235 right border. Value is non-zero if any window's hscroll has been
12239 hscroll_window_tree (Lisp_Object window
)
12241 int hscrolled_p
= 0;
12242 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12243 int hscroll_step_abs
= 0;
12244 double hscroll_step_rel
= 0;
12246 if (hscroll_relative_p
)
12248 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12249 if (hscroll_step_rel
< 0)
12251 hscroll_relative_p
= 0;
12252 hscroll_step_abs
= 0;
12255 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12257 hscroll_step_abs
= XINT (Vhscroll_step
);
12258 if (hscroll_step_abs
< 0)
12259 hscroll_step_abs
= 0;
12262 hscroll_step_abs
= 0;
12264 while (WINDOWP (window
))
12266 struct window
*w
= XWINDOW (window
);
12268 if (WINDOWP (w
->hchild
))
12269 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12270 else if (WINDOWP (w
->vchild
))
12271 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12272 else if (w
->cursor
.vpos
>= 0)
12275 int text_area_width
;
12276 struct glyph_row
*current_cursor_row
12277 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12278 struct glyph_row
*desired_cursor_row
12279 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12280 struct glyph_row
*cursor_row
12281 = (desired_cursor_row
->enabled_p
12282 ? desired_cursor_row
12283 : current_cursor_row
);
12284 int row_r2l_p
= cursor_row
->reversed_p
;
12286 text_area_width
= window_box_width (w
, TEXT_AREA
);
12288 /* Scroll when cursor is inside this scroll margin. */
12289 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12291 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12292 /* For left-to-right rows, hscroll when cursor is either
12293 (i) inside the right hscroll margin, or (ii) if it is
12294 inside the left margin and the window is already
12298 && w
->cursor
.x
<= h_margin
)
12299 || (cursor_row
->enabled_p
12300 && cursor_row
->truncated_on_right_p
12301 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12302 /* For right-to-left rows, the logic is similar,
12303 except that rules for scrolling to left and right
12304 are reversed. E.g., if cursor.x <= h_margin, we
12305 need to hscroll "to the right" unconditionally,
12306 and that will scroll the screen to the left so as
12307 to reveal the next portion of the row. */
12309 && ((cursor_row
->enabled_p
12310 /* FIXME: It is confusing to set the
12311 truncated_on_right_p flag when R2L rows
12312 are actually truncated on the left. */
12313 && cursor_row
->truncated_on_right_p
12314 && w
->cursor
.x
<= h_margin
)
12316 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12320 struct buffer
*saved_current_buffer
;
12324 /* Find point in a display of infinite width. */
12325 saved_current_buffer
= current_buffer
;
12326 current_buffer
= XBUFFER (w
->buffer
);
12328 if (w
== XWINDOW (selected_window
))
12331 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12333 /* Move iterator to pt starting at cursor_row->start in
12334 a line with infinite width. */
12335 init_to_row_start (&it
, w
, cursor_row
);
12336 it
.last_visible_x
= INFINITY
;
12337 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12338 current_buffer
= saved_current_buffer
;
12340 /* Position cursor in window. */
12341 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12342 hscroll
= max (0, (it
.current_x
12343 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12344 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12345 : (text_area_width
/ 2))))
12346 / FRAME_COLUMN_WIDTH (it
.f
);
12347 else if ((!row_r2l_p
12348 && w
->cursor
.x
>= text_area_width
- h_margin
)
12349 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12351 if (hscroll_relative_p
)
12352 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12355 wanted_x
= text_area_width
12356 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12359 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12363 if (hscroll_relative_p
)
12364 wanted_x
= text_area_width
* hscroll_step_rel
12367 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12370 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12372 hscroll
= max (hscroll
, w
->min_hscroll
);
12374 /* Don't prevent redisplay optimizations if hscroll
12375 hasn't changed, as it will unnecessarily slow down
12377 if (w
->hscroll
!= hscroll
)
12379 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12380 w
->hscroll
= hscroll
;
12389 /* Value is non-zero if hscroll of any leaf window has been changed. */
12390 return hscrolled_p
;
12394 /* Set hscroll so that cursor is visible and not inside horizontal
12395 scroll margins for all windows in the tree rooted at WINDOW. See
12396 also hscroll_window_tree above. Value is non-zero if any window's
12397 hscroll has been changed. If it has, desired matrices on the frame
12398 of WINDOW are cleared. */
12401 hscroll_windows (Lisp_Object window
)
12403 int hscrolled_p
= hscroll_window_tree (window
);
12405 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12406 return hscrolled_p
;
12411 /************************************************************************
12413 ************************************************************************/
12415 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12416 to a non-zero value. This is sometimes handy to have in a debugger
12421 /* First and last unchanged row for try_window_id. */
12423 static int debug_first_unchanged_at_end_vpos
;
12424 static int debug_last_unchanged_at_beg_vpos
;
12426 /* Delta vpos and y. */
12428 static int debug_dvpos
, debug_dy
;
12430 /* Delta in characters and bytes for try_window_id. */
12432 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12434 /* Values of window_end_pos and window_end_vpos at the end of
12437 static ptrdiff_t debug_end_vpos
;
12439 /* Append a string to W->desired_matrix->method. FMT is a printf
12440 format string. If trace_redisplay_p is non-zero also printf the
12441 resulting string to stderr. */
12443 static void debug_method_add (struct window
*, char const *, ...)
12444 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12447 debug_method_add (struct window
*w
, char const *fmt
, ...)
12449 char *method
= w
->desired_matrix
->method
;
12450 int len
= strlen (method
);
12451 int size
= sizeof w
->desired_matrix
->method
;
12452 int remaining
= size
- len
- 1;
12455 if (len
&& remaining
)
12458 --remaining
, ++len
;
12461 va_start (ap
, fmt
);
12462 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12465 if (trace_redisplay_p
)
12466 fprintf (stderr
, "%p (%s): %s\n",
12468 ((BUFFERP (w
->buffer
)
12469 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12470 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12475 #endif /* GLYPH_DEBUG */
12478 /* Value is non-zero if all changes in window W, which displays
12479 current_buffer, are in the text between START and END. START is a
12480 buffer position, END is given as a distance from Z. Used in
12481 redisplay_internal for display optimization. */
12484 text_outside_line_unchanged_p (struct window
*w
,
12485 ptrdiff_t start
, ptrdiff_t end
)
12487 int unchanged_p
= 1;
12489 /* If text or overlays have changed, see where. */
12490 if (window_outdated (w
))
12492 /* Gap in the line? */
12493 if (GPT
< start
|| Z
- GPT
< end
)
12496 /* Changes start in front of the line, or end after it? */
12498 && (BEG_UNCHANGED
< start
- 1
12499 || END_UNCHANGED
< end
))
12502 /* If selective display, can't optimize if changes start at the
12503 beginning of the line. */
12505 && INTEGERP (BVAR (current_buffer
, selective_display
))
12506 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12507 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12510 /* If there are overlays at the start or end of the line, these
12511 may have overlay strings with newlines in them. A change at
12512 START, for instance, may actually concern the display of such
12513 overlay strings as well, and they are displayed on different
12514 lines. So, quickly rule out this case. (For the future, it
12515 might be desirable to implement something more telling than
12516 just BEG/END_UNCHANGED.) */
12519 if (BEG
+ BEG_UNCHANGED
== start
12520 && overlay_touches_p (start
))
12522 if (END_UNCHANGED
== end
12523 && overlay_touches_p (Z
- end
))
12527 /* Under bidi reordering, adding or deleting a character in the
12528 beginning of a paragraph, before the first strong directional
12529 character, can change the base direction of the paragraph (unless
12530 the buffer specifies a fixed paragraph direction), which will
12531 require to redisplay the whole paragraph. It might be worthwhile
12532 to find the paragraph limits and widen the range of redisplayed
12533 lines to that, but for now just give up this optimization. */
12534 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12535 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12539 return unchanged_p
;
12543 /* Do a frame update, taking possible shortcuts into account. This is
12544 the main external entry point for redisplay.
12546 If the last redisplay displayed an echo area message and that message
12547 is no longer requested, we clear the echo area or bring back the
12548 mini-buffer if that is in use. */
12553 redisplay_internal ();
12558 overlay_arrow_string_or_property (Lisp_Object var
)
12562 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12565 return Voverlay_arrow_string
;
12568 /* Return 1 if there are any overlay-arrows in current_buffer. */
12570 overlay_arrow_in_current_buffer_p (void)
12574 for (vlist
= Voverlay_arrow_variable_list
;
12576 vlist
= XCDR (vlist
))
12578 Lisp_Object var
= XCAR (vlist
);
12581 if (!SYMBOLP (var
))
12583 val
= find_symbol_value (var
);
12585 && current_buffer
== XMARKER (val
)->buffer
)
12592 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12596 overlay_arrows_changed_p (void)
12600 for (vlist
= Voverlay_arrow_variable_list
;
12602 vlist
= XCDR (vlist
))
12604 Lisp_Object var
= XCAR (vlist
);
12605 Lisp_Object val
, pstr
;
12607 if (!SYMBOLP (var
))
12609 val
= find_symbol_value (var
);
12610 if (!MARKERP (val
))
12612 if (! EQ (COERCE_MARKER (val
),
12613 Fget (var
, Qlast_arrow_position
))
12614 || ! (pstr
= overlay_arrow_string_or_property (var
),
12615 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12621 /* Mark overlay arrows to be updated on next redisplay. */
12624 update_overlay_arrows (int up_to_date
)
12628 for (vlist
= Voverlay_arrow_variable_list
;
12630 vlist
= XCDR (vlist
))
12632 Lisp_Object var
= XCAR (vlist
);
12634 if (!SYMBOLP (var
))
12637 if (up_to_date
> 0)
12639 Lisp_Object val
= find_symbol_value (var
);
12640 Fput (var
, Qlast_arrow_position
,
12641 COERCE_MARKER (val
));
12642 Fput (var
, Qlast_arrow_string
,
12643 overlay_arrow_string_or_property (var
));
12645 else if (up_to_date
< 0
12646 || !NILP (Fget (var
, Qlast_arrow_position
)))
12648 Fput (var
, Qlast_arrow_position
, Qt
);
12649 Fput (var
, Qlast_arrow_string
, Qt
);
12655 /* Return overlay arrow string to display at row.
12656 Return integer (bitmap number) for arrow bitmap in left fringe.
12657 Return nil if no overlay arrow. */
12660 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12664 for (vlist
= Voverlay_arrow_variable_list
;
12666 vlist
= XCDR (vlist
))
12668 Lisp_Object var
= XCAR (vlist
);
12671 if (!SYMBOLP (var
))
12674 val
= find_symbol_value (var
);
12677 && current_buffer
== XMARKER (val
)->buffer
12678 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12680 if (FRAME_WINDOW_P (it
->f
)
12681 /* FIXME: if ROW->reversed_p is set, this should test
12682 the right fringe, not the left one. */
12683 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12685 #ifdef HAVE_WINDOW_SYSTEM
12686 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12689 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12690 return make_number (fringe_bitmap
);
12693 return make_number (-1); /* Use default arrow bitmap. */
12695 return overlay_arrow_string_or_property (var
);
12702 /* Return 1 if point moved out of or into a composition. Otherwise
12703 return 0. PREV_BUF and PREV_PT are the last point buffer and
12704 position. BUF and PT are the current point buffer and position. */
12707 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12708 struct buffer
*buf
, ptrdiff_t pt
)
12710 ptrdiff_t start
, end
;
12712 Lisp_Object buffer
;
12714 XSETBUFFER (buffer
, buf
);
12715 /* Check a composition at the last point if point moved within the
12717 if (prev_buf
== buf
)
12720 /* Point didn't move. */
12723 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12724 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12725 && COMPOSITION_VALID_P (start
, end
, prop
)
12726 && start
< prev_pt
&& end
> prev_pt
)
12727 /* The last point was within the composition. Return 1 iff
12728 point moved out of the composition. */
12729 return (pt
<= start
|| pt
>= end
);
12732 /* Check a composition at the current point. */
12733 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12734 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12735 && COMPOSITION_VALID_P (start
, end
, prop
)
12736 && start
< pt
&& end
> pt
);
12740 /* Reconsider the setting of B->clip_changed which is displayed
12744 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12746 if (b
->clip_changed
12747 && w
->window_end_valid
12748 && w
->current_matrix
->buffer
== b
12749 && w
->current_matrix
->zv
== BUF_ZV (b
)
12750 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12751 b
->clip_changed
= 0;
12753 /* If display wasn't paused, and W is not a tool bar window, see if
12754 point has been moved into or out of a composition. In that case,
12755 we set b->clip_changed to 1 to force updating the screen. If
12756 b->clip_changed has already been set to 1, we can skip this
12758 if (!b
->clip_changed
&& BUFFERP (w
->buffer
) && w
->window_end_valid
)
12762 if (w
== XWINDOW (selected_window
))
12765 pt
= marker_position (w
->pointm
);
12767 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12768 || pt
!= w
->last_point
)
12769 && check_point_in_composition (w
->current_matrix
->buffer
,
12771 XBUFFER (w
->buffer
), pt
))
12772 b
->clip_changed
= 1;
12777 #define STOP_POLLING \
12778 do { if (! polling_stopped_here) stop_polling (); \
12779 polling_stopped_here = 1; } while (0)
12781 #define RESUME_POLLING \
12782 do { if (polling_stopped_here) start_polling (); \
12783 polling_stopped_here = 0; } while (0)
12786 /* Perhaps in the future avoid recentering windows if it
12787 is not necessary; currently that causes some problems. */
12790 redisplay_internal (void)
12792 struct window
*w
= XWINDOW (selected_window
);
12796 int must_finish
= 0;
12797 struct text_pos tlbufpos
, tlendpos
;
12798 int number_of_visible_frames
;
12799 ptrdiff_t count
, count1
;
12801 int polling_stopped_here
= 0;
12802 Lisp_Object tail
, frame
;
12803 struct backtrace backtrace
;
12805 /* Non-zero means redisplay has to consider all windows on all
12806 frames. Zero means, only selected_window is considered. */
12807 int consider_all_windows_p
;
12809 /* Non-zero means redisplay has to redisplay the miniwindow. */
12810 int update_miniwindow_p
= 0;
12812 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12814 /* No redisplay if running in batch mode or frame is not yet fully
12815 initialized, or redisplay is explicitly turned off by setting
12816 Vinhibit_redisplay. */
12817 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12818 || !NILP (Vinhibit_redisplay
))
12821 /* Don't examine these until after testing Vinhibit_redisplay.
12822 When Emacs is shutting down, perhaps because its connection to
12823 X has dropped, we should not look at them at all. */
12824 fr
= XFRAME (w
->frame
);
12825 sf
= SELECTED_FRAME ();
12827 if (!fr
->glyphs_initialized_p
)
12830 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12831 if (popup_activated ())
12835 /* I don't think this happens but let's be paranoid. */
12836 if (redisplaying_p
)
12839 /* Record a function that clears redisplaying_p
12840 when we leave this function. */
12841 count
= SPECPDL_INDEX ();
12842 record_unwind_protect (unwind_redisplay
, selected_frame
);
12843 redisplaying_p
= 1;
12844 specbind (Qinhibit_free_realized_faces
, Qnil
);
12846 /* Record this function, so it appears on the profiler's backtraces. */
12847 backtrace
.next
= backtrace_list
;
12848 backtrace
.function
= Qredisplay_internal
;
12849 backtrace
.args
= &Qnil
;
12850 backtrace
.nargs
= 0;
12851 backtrace
.debug_on_exit
= 0;
12852 backtrace_list
= &backtrace
;
12854 FOR_EACH_FRAME (tail
, frame
)
12855 XFRAME (frame
)->already_hscrolled_p
= 0;
12858 /* Remember the currently selected window. */
12862 reconsider_clip_changes (w
, current_buffer
);
12863 last_escape_glyph_frame
= NULL
;
12864 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12865 last_glyphless_glyph_frame
= NULL
;
12866 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12868 /* If new fonts have been loaded that make a glyph matrix adjustment
12869 necessary, do it. */
12870 if (fonts_changed_p
)
12872 adjust_glyphs (NULL
);
12873 ++windows_or_buffers_changed
;
12874 fonts_changed_p
= 0;
12877 /* If face_change_count is non-zero, init_iterator will free all
12878 realized faces, which includes the faces referenced from current
12879 matrices. So, we can't reuse current matrices in this case. */
12880 if (face_change_count
)
12881 ++windows_or_buffers_changed
;
12883 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12884 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12886 /* Since frames on a single ASCII terminal share the same
12887 display area, displaying a different frame means redisplay
12888 the whole thing. */
12889 windows_or_buffers_changed
++;
12890 SET_FRAME_GARBAGED (sf
);
12892 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12894 FRAME_TTY (sf
)->previous_frame
= sf
;
12897 /* Set the visible flags for all frames. Do this before checking for
12898 resized or garbaged frames; they want to know if their frames are
12899 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
12900 number_of_visible_frames
= 0;
12902 FOR_EACH_FRAME (tail
, frame
)
12904 struct frame
*f
= XFRAME (frame
);
12906 if (FRAME_VISIBLE_P (f
))
12907 ++number_of_visible_frames
;
12908 clear_desired_matrices (f
);
12911 /* Notice any pending interrupt request to change frame size. */
12912 do_pending_window_change (1);
12914 /* do_pending_window_change could change the selected_window due to
12915 frame resizing which makes the selected window too small. */
12916 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12919 reconsider_clip_changes (w
, current_buffer
);
12922 /* Clear frames marked as garbaged. */
12923 clear_garbaged_frames ();
12925 /* Build menubar and tool-bar items. */
12926 if (NILP (Vmemory_full
))
12927 prepare_menu_bars ();
12929 if (windows_or_buffers_changed
)
12930 update_mode_lines
++;
12932 /* Detect case that we need to write or remove a star in the mode line. */
12933 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
12935 w
->update_mode_line
= 1;
12936 if (buffer_shared_and_changed ())
12937 update_mode_lines
++;
12940 /* Avoid invocation of point motion hooks by `current_column' below. */
12941 count1
= SPECPDL_INDEX ();
12942 specbind (Qinhibit_point_motion_hooks
, Qt
);
12944 if (mode_line_update_needed (w
))
12945 w
->update_mode_line
= 1;
12947 unbind_to (count1
, Qnil
);
12949 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12951 consider_all_windows_p
= (update_mode_lines
12952 || buffer_shared_and_changed ()
12953 || cursor_type_changed
);
12955 /* If specs for an arrow have changed, do thorough redisplay
12956 to ensure we remove any arrow that should no longer exist. */
12957 if (overlay_arrows_changed_p ())
12958 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12960 /* Normally the message* functions will have already displayed and
12961 updated the echo area, but the frame may have been trashed, or
12962 the update may have been preempted, so display the echo area
12963 again here. Checking message_cleared_p captures the case that
12964 the echo area should be cleared. */
12965 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12966 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12967 || (message_cleared_p
12968 && minibuf_level
== 0
12969 /* If the mini-window is currently selected, this means the
12970 echo-area doesn't show through. */
12971 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12973 int window_height_changed_p
= echo_area_display (0);
12975 if (message_cleared_p
)
12976 update_miniwindow_p
= 1;
12980 /* If we don't display the current message, don't clear the
12981 message_cleared_p flag, because, if we did, we wouldn't clear
12982 the echo area in the next redisplay which doesn't preserve
12984 if (!display_last_displayed_message_p
)
12985 message_cleared_p
= 0;
12987 if (fonts_changed_p
)
12989 else if (window_height_changed_p
)
12991 consider_all_windows_p
= 1;
12992 ++update_mode_lines
;
12993 ++windows_or_buffers_changed
;
12995 /* If window configuration was changed, frames may have been
12996 marked garbaged. Clear them or we will experience
12997 surprises wrt scrolling. */
12998 clear_garbaged_frames ();
13001 else if (EQ (selected_window
, minibuf_window
)
13002 && (current_buffer
->clip_changed
|| window_outdated (w
))
13003 && resize_mini_window (w
, 0))
13005 /* Resized active mini-window to fit the size of what it is
13006 showing if its contents might have changed. */
13008 /* FIXME: this causes all frames to be updated, which seems unnecessary
13009 since only the current frame needs to be considered. This function
13010 needs to be rewritten with two variables, consider_all_windows and
13011 consider_all_frames. */
13012 consider_all_windows_p
= 1;
13013 ++windows_or_buffers_changed
;
13014 ++update_mode_lines
;
13016 /* If window configuration was changed, frames may have been
13017 marked garbaged. Clear them or we will experience
13018 surprises wrt scrolling. */
13019 clear_garbaged_frames ();
13022 /* If showing the region, and mark has changed, we must redisplay
13023 the whole window. The assignment to this_line_start_pos prevents
13024 the optimization directly below this if-statement. */
13025 if (((!NILP (Vtransient_mark_mode
)
13026 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
13027 != (w
->region_showing
> 0))
13028 || (w
->region_showing
13029 && w
->region_showing
13030 != XINT (Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
13031 CHARPOS (this_line_start_pos
) = 0;
13033 /* Optimize the case that only the line containing the cursor in the
13034 selected window has changed. Variables starting with this_ are
13035 set in display_line and record information about the line
13036 containing the cursor. */
13037 tlbufpos
= this_line_start_pos
;
13038 tlendpos
= this_line_end_pos
;
13039 if (!consider_all_windows_p
13040 && CHARPOS (tlbufpos
) > 0
13041 && !w
->update_mode_line
13042 && !current_buffer
->clip_changed
13043 && !current_buffer
->prevent_redisplay_optimizations_p
13044 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13045 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13046 /* Make sure recorded data applies to current buffer, etc. */
13047 && this_line_buffer
== current_buffer
13048 && current_buffer
== XBUFFER (w
->buffer
)
13050 && !w
->optional_new_start
13051 /* Point must be on the line that we have info recorded about. */
13052 && PT
>= CHARPOS (tlbufpos
)
13053 && PT
<= Z
- CHARPOS (tlendpos
)
13054 /* All text outside that line, including its final newline,
13055 must be unchanged. */
13056 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13057 CHARPOS (tlendpos
)))
13059 if (CHARPOS (tlbufpos
) > BEGV
13060 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13061 && (CHARPOS (tlbufpos
) == ZV
13062 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13063 /* Former continuation line has disappeared by becoming empty. */
13065 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13067 /* We have to handle the case of continuation around a
13068 wide-column character (see the comment in indent.c around
13071 For instance, in the following case:
13073 -------- Insert --------
13074 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13075 J_I_ ==> J_I_ `^^' are cursors.
13079 As we have to redraw the line above, we cannot use this
13083 int line_height_before
= this_line_pixel_height
;
13085 /* Note that start_display will handle the case that the
13086 line starting at tlbufpos is a continuation line. */
13087 start_display (&it
, w
, tlbufpos
);
13089 /* Implementation note: It this still necessary? */
13090 if (it
.current_x
!= this_line_start_x
)
13093 TRACE ((stderr
, "trying display optimization 1\n"));
13094 w
->cursor
.vpos
= -1;
13095 overlay_arrow_seen
= 0;
13096 it
.vpos
= this_line_vpos
;
13097 it
.current_y
= this_line_y
;
13098 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13099 display_line (&it
);
13101 /* If line contains point, is not continued,
13102 and ends at same distance from eob as before, we win. */
13103 if (w
->cursor
.vpos
>= 0
13104 /* Line is not continued, otherwise this_line_start_pos
13105 would have been set to 0 in display_line. */
13106 && CHARPOS (this_line_start_pos
)
13107 /* Line ends as before. */
13108 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13109 /* Line has same height as before. Otherwise other lines
13110 would have to be shifted up or down. */
13111 && this_line_pixel_height
== line_height_before
)
13113 /* If this is not the window's last line, we must adjust
13114 the charstarts of the lines below. */
13115 if (it
.current_y
< it
.last_visible_y
)
13117 struct glyph_row
*row
13118 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13119 ptrdiff_t delta
, delta_bytes
;
13121 /* We used to distinguish between two cases here,
13122 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13123 when the line ends in a newline or the end of the
13124 buffer's accessible portion. But both cases did
13125 the same, so they were collapsed. */
13127 - CHARPOS (tlendpos
)
13128 - MATRIX_ROW_START_CHARPOS (row
));
13129 delta_bytes
= (Z_BYTE
13130 - BYTEPOS (tlendpos
)
13131 - MATRIX_ROW_START_BYTEPOS (row
));
13133 increment_matrix_positions (w
->current_matrix
,
13134 this_line_vpos
+ 1,
13135 w
->current_matrix
->nrows
,
13136 delta
, delta_bytes
);
13139 /* If this row displays text now but previously didn't,
13140 or vice versa, w->window_end_vpos may have to be
13142 if ((it
.glyph_row
- 1)->displays_text_p
)
13144 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13145 wset_window_end_vpos (w
, make_number (this_line_vpos
));
13147 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13148 && this_line_vpos
> 0)
13149 wset_window_end_vpos (w
, make_number (this_line_vpos
- 1));
13150 w
->window_end_valid
= 0;
13152 /* Update hint: No need to try to scroll in update_window. */
13153 w
->desired_matrix
->no_scrolling_p
= 1;
13156 *w
->desired_matrix
->method
= 0;
13157 debug_method_add (w
, "optimization 1");
13159 #ifdef HAVE_WINDOW_SYSTEM
13160 update_window_fringes (w
, 0);
13167 else if (/* Cursor position hasn't changed. */
13168 PT
== w
->last_point
13169 /* Make sure the cursor was last displayed
13170 in this window. Otherwise we have to reposition it. */
13171 && 0 <= w
->cursor
.vpos
13172 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13176 do_pending_window_change (1);
13177 /* If selected_window changed, redisplay again. */
13178 if (WINDOWP (selected_window
)
13179 && (w
= XWINDOW (selected_window
)) != sw
)
13182 /* We used to always goto end_of_redisplay here, but this
13183 isn't enough if we have a blinking cursor. */
13184 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13185 goto end_of_redisplay
;
13189 /* If highlighting the region, or if the cursor is in the echo area,
13190 then we can't just move the cursor. */
13191 else if (! (!NILP (Vtransient_mark_mode
)
13192 && !NILP (BVAR (current_buffer
, mark_active
)))
13193 && (EQ (selected_window
,
13194 BVAR (current_buffer
, last_selected_window
))
13195 || highlight_nonselected_windows
)
13196 && !w
->region_showing
13197 && NILP (Vshow_trailing_whitespace
)
13198 && !cursor_in_echo_area
)
13201 struct glyph_row
*row
;
13203 /* Skip from tlbufpos to PT and see where it is. Note that
13204 PT may be in invisible text. If so, we will end at the
13205 next visible position. */
13206 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13207 NULL
, DEFAULT_FACE_ID
);
13208 it
.current_x
= this_line_start_x
;
13209 it
.current_y
= this_line_y
;
13210 it
.vpos
= this_line_vpos
;
13212 /* The call to move_it_to stops in front of PT, but
13213 moves over before-strings. */
13214 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13216 if (it
.vpos
== this_line_vpos
13217 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13220 eassert (this_line_vpos
== it
.vpos
);
13221 eassert (this_line_y
== it
.current_y
);
13222 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13224 *w
->desired_matrix
->method
= 0;
13225 debug_method_add (w
, "optimization 3");
13234 /* Text changed drastically or point moved off of line. */
13235 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13238 CHARPOS (this_line_start_pos
) = 0;
13239 consider_all_windows_p
|= buffer_shared_and_changed ();
13240 ++clear_face_cache_count
;
13241 #ifdef HAVE_WINDOW_SYSTEM
13242 ++clear_image_cache_count
;
13245 /* Build desired matrices, and update the display. If
13246 consider_all_windows_p is non-zero, do it for all windows on all
13247 frames. Otherwise do it for selected_window, only. */
13249 if (consider_all_windows_p
)
13251 FOR_EACH_FRAME (tail
, frame
)
13252 XFRAME (frame
)->updated_p
= 0;
13254 FOR_EACH_FRAME (tail
, frame
)
13256 struct frame
*f
= XFRAME (frame
);
13258 /* We don't have to do anything for unselected terminal
13260 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13261 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13264 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13266 /* Mark all the scroll bars to be removed; we'll redeem
13267 the ones we want when we redisplay their windows. */
13268 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13269 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13271 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13272 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13274 /* The X error handler may have deleted that frame. */
13275 if (!FRAME_LIVE_P (f
))
13278 /* Any scroll bars which redisplay_windows should have
13279 nuked should now go away. */
13280 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13281 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13283 /* If fonts changed, display again. */
13284 /* ??? rms: I suspect it is a mistake to jump all the way
13285 back to retry here. It should just retry this frame. */
13286 if (fonts_changed_p
)
13289 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13291 /* See if we have to hscroll. */
13292 if (!f
->already_hscrolled_p
)
13294 f
->already_hscrolled_p
= 1;
13295 if (hscroll_windows (f
->root_window
))
13299 /* Prevent various kinds of signals during display
13300 update. stdio is not robust about handling
13301 signals, which can cause an apparent I/O
13303 if (interrupt_input
)
13304 unrequest_sigio ();
13307 /* Update the display. */
13308 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13309 pending
|= update_frame (f
, 0, 0);
13315 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13319 /* Do the mark_window_display_accurate after all windows have
13320 been redisplayed because this call resets flags in buffers
13321 which are needed for proper redisplay. */
13322 FOR_EACH_FRAME (tail
, frame
)
13324 struct frame
*f
= XFRAME (frame
);
13327 mark_window_display_accurate (f
->root_window
, 1);
13328 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13329 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13334 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13336 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13337 struct frame
*mini_frame
;
13339 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13340 /* Use list_of_error, not Qerror, so that
13341 we catch only errors and don't run the debugger. */
13342 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13344 redisplay_window_error
);
13345 if (update_miniwindow_p
)
13346 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13348 redisplay_window_error
);
13350 /* Compare desired and current matrices, perform output. */
13353 /* If fonts changed, display again. */
13354 if (fonts_changed_p
)
13357 /* Prevent various kinds of signals during display update.
13358 stdio is not robust about handling signals,
13359 which can cause an apparent I/O error. */
13360 if (interrupt_input
)
13361 unrequest_sigio ();
13364 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13366 if (hscroll_windows (selected_window
))
13369 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13370 pending
= update_frame (sf
, 0, 0);
13373 /* We may have called echo_area_display at the top of this
13374 function. If the echo area is on another frame, that may
13375 have put text on a frame other than the selected one, so the
13376 above call to update_frame would not have caught it. Catch
13378 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13379 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13381 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13383 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13384 pending
|= update_frame (mini_frame
, 0, 0);
13385 if (!pending
&& hscroll_windows (mini_window
))
13390 /* If display was paused because of pending input, make sure we do a
13391 thorough update the next time. */
13394 /* Prevent the optimization at the beginning of
13395 redisplay_internal that tries a single-line update of the
13396 line containing the cursor in the selected window. */
13397 CHARPOS (this_line_start_pos
) = 0;
13399 /* Let the overlay arrow be updated the next time. */
13400 update_overlay_arrows (0);
13402 /* If we pause after scrolling, some rows in the current
13403 matrices of some windows are not valid. */
13404 if (!WINDOW_FULL_WIDTH_P (w
)
13405 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13406 update_mode_lines
= 1;
13410 if (!consider_all_windows_p
)
13412 /* This has already been done above if
13413 consider_all_windows_p is set. */
13414 mark_window_display_accurate_1 (w
, 1);
13416 /* Say overlay arrows are up to date. */
13417 update_overlay_arrows (1);
13419 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13420 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13423 update_mode_lines
= 0;
13424 windows_or_buffers_changed
= 0;
13425 cursor_type_changed
= 0;
13428 /* Start SIGIO interrupts coming again. Having them off during the
13429 code above makes it less likely one will discard output, but not
13430 impossible, since there might be stuff in the system buffer here.
13431 But it is much hairier to try to do anything about that. */
13432 if (interrupt_input
)
13436 /* If a frame has become visible which was not before, redisplay
13437 again, so that we display it. Expose events for such a frame
13438 (which it gets when becoming visible) don't call the parts of
13439 redisplay constructing glyphs, so simply exposing a frame won't
13440 display anything in this case. So, we have to display these
13441 frames here explicitly. */
13446 FOR_EACH_FRAME (tail
, frame
)
13448 int this_is_visible
= 0;
13450 if (XFRAME (frame
)->visible
)
13451 this_is_visible
= 1;
13453 if (this_is_visible
)
13457 if (new_count
!= number_of_visible_frames
)
13458 windows_or_buffers_changed
++;
13461 /* Change frame size now if a change is pending. */
13462 do_pending_window_change (1);
13464 /* If we just did a pending size change, or have additional
13465 visible frames, or selected_window changed, redisplay again. */
13466 if ((windows_or_buffers_changed
&& !pending
)
13467 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13470 /* Clear the face and image caches.
13472 We used to do this only if consider_all_windows_p. But the cache
13473 needs to be cleared if a timer creates images in the current
13474 buffer (e.g. the test case in Bug#6230). */
13476 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13478 clear_face_cache (0);
13479 clear_face_cache_count
= 0;
13482 #ifdef HAVE_WINDOW_SYSTEM
13483 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13485 clear_image_caches (Qnil
);
13486 clear_image_cache_count
= 0;
13488 #endif /* HAVE_WINDOW_SYSTEM */
13491 backtrace_list
= backtrace
.next
;
13492 unbind_to (count
, Qnil
);
13497 /* Redisplay, but leave alone any recent echo area message unless
13498 another message has been requested in its place.
13500 This is useful in situations where you need to redisplay but no
13501 user action has occurred, making it inappropriate for the message
13502 area to be cleared. See tracking_off and
13503 wait_reading_process_output for examples of these situations.
13505 FROM_WHERE is an integer saying from where this function was
13506 called. This is useful for debugging. */
13509 redisplay_preserve_echo_area (int from_where
)
13511 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13513 if (!NILP (echo_area_buffer
[1]))
13515 /* We have a previously displayed message, but no current
13516 message. Redisplay the previous message. */
13517 display_last_displayed_message_p
= 1;
13518 redisplay_internal ();
13519 display_last_displayed_message_p
= 0;
13522 redisplay_internal ();
13524 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13525 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13526 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13530 /* Function registered with record_unwind_protect in redisplay_internal.
13531 Clear redisplaying_p. Also select the previously selected frame. */
13534 unwind_redisplay (Lisp_Object old_frame
)
13536 redisplaying_p
= 0;
13541 /* Mark the display of leaf window W as accurate or inaccurate.
13542 If ACCURATE_P is non-zero mark display of W as accurate. If
13543 ACCURATE_P is zero, arrange for W to be redisplayed the next
13544 time redisplay_internal is called. */
13547 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13549 struct buffer
*b
= XBUFFER (w
->buffer
);
13551 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
13552 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
13553 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13557 b
->clip_changed
= 0;
13558 b
->prevent_redisplay_optimizations_p
= 0;
13560 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13561 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13562 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13563 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13565 w
->current_matrix
->buffer
= b
;
13566 w
->current_matrix
->begv
= BUF_BEGV (b
);
13567 w
->current_matrix
->zv
= BUF_ZV (b
);
13569 w
->last_cursor
= w
->cursor
;
13570 w
->last_cursor_off_p
= w
->cursor_off_p
;
13572 if (w
== XWINDOW (selected_window
))
13573 w
->last_point
= BUF_PT (b
);
13575 w
->last_point
= marker_position (w
->pointm
);
13577 w
->window_end_valid
= 1;
13578 w
->update_mode_line
= 0;
13583 /* Mark the display of windows in the window tree rooted at WINDOW as
13584 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13585 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13586 be redisplayed the next time redisplay_internal is called. */
13589 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13593 for (; !NILP (window
); window
= w
->next
)
13595 w
= XWINDOW (window
);
13596 if (!NILP (w
->vchild
))
13597 mark_window_display_accurate (w
->vchild
, accurate_p
);
13598 else if (!NILP (w
->hchild
))
13599 mark_window_display_accurate (w
->hchild
, accurate_p
);
13600 else if (BUFFERP (w
->buffer
))
13601 mark_window_display_accurate_1 (w
, accurate_p
);
13605 update_overlay_arrows (1);
13607 /* Force a thorough redisplay the next time by setting
13608 last_arrow_position and last_arrow_string to t, which is
13609 unequal to any useful value of Voverlay_arrow_... */
13610 update_overlay_arrows (-1);
13614 /* Return value in display table DP (Lisp_Char_Table *) for character
13615 C. Since a display table doesn't have any parent, we don't have to
13616 follow parent. Do not call this function directly but use the
13617 macro DISP_CHAR_VECTOR. */
13620 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13624 if (ASCII_CHAR_P (c
))
13627 if (SUB_CHAR_TABLE_P (val
))
13628 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13634 XSETCHAR_TABLE (table
, dp
);
13635 val
= char_table_ref (table
, c
);
13644 /***********************************************************************
13646 ***********************************************************************/
13648 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13651 redisplay_windows (Lisp_Object window
)
13653 while (!NILP (window
))
13655 struct window
*w
= XWINDOW (window
);
13657 if (!NILP (w
->hchild
))
13658 redisplay_windows (w
->hchild
);
13659 else if (!NILP (w
->vchild
))
13660 redisplay_windows (w
->vchild
);
13661 else if (!NILP (w
->buffer
))
13663 displayed_buffer
= XBUFFER (w
->buffer
);
13664 /* Use list_of_error, not Qerror, so that
13665 we catch only errors and don't run the debugger. */
13666 internal_condition_case_1 (redisplay_window_0
, window
,
13668 redisplay_window_error
);
13676 redisplay_window_error (Lisp_Object ignore
)
13678 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13683 redisplay_window_0 (Lisp_Object window
)
13685 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13686 redisplay_window (window
, 0);
13691 redisplay_window_1 (Lisp_Object window
)
13693 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13694 redisplay_window (window
, 1);
13699 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13700 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13701 which positions recorded in ROW differ from current buffer
13704 Return 0 if cursor is not on this row, 1 otherwise. */
13707 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13708 struct glyph_matrix
*matrix
,
13709 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13712 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13713 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13714 struct glyph
*cursor
= NULL
;
13715 /* The last known character position in row. */
13716 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13718 ptrdiff_t pt_old
= PT
- delta
;
13719 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13720 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13721 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13722 /* A glyph beyond the edge of TEXT_AREA which we should never
13724 struct glyph
*glyphs_end
= end
;
13725 /* Non-zero means we've found a match for cursor position, but that
13726 glyph has the avoid_cursor_p flag set. */
13727 int match_with_avoid_cursor
= 0;
13728 /* Non-zero means we've seen at least one glyph that came from a
13730 int string_seen
= 0;
13731 /* Largest and smallest buffer positions seen so far during scan of
13733 ptrdiff_t bpos_max
= pos_before
;
13734 ptrdiff_t bpos_min
= pos_after
;
13735 /* Last buffer position covered by an overlay string with an integer
13736 `cursor' property. */
13737 ptrdiff_t bpos_covered
= 0;
13738 /* Non-zero means the display string on which to display the cursor
13739 comes from a text property, not from an overlay. */
13740 int string_from_text_prop
= 0;
13742 /* Don't even try doing anything if called for a mode-line or
13743 header-line row, since the rest of the code isn't prepared to
13744 deal with such calamities. */
13745 eassert (!row
->mode_line_p
);
13746 if (row
->mode_line_p
)
13749 /* Skip over glyphs not having an object at the start and the end of
13750 the row. These are special glyphs like truncation marks on
13751 terminal frames. */
13752 if (row
->displays_text_p
)
13754 if (!row
->reversed_p
)
13757 && INTEGERP (glyph
->object
)
13758 && glyph
->charpos
< 0)
13760 x
+= glyph
->pixel_width
;
13764 && INTEGERP ((end
- 1)->object
)
13765 /* CHARPOS is zero for blanks and stretch glyphs
13766 inserted by extend_face_to_end_of_line. */
13767 && (end
- 1)->charpos
<= 0)
13769 glyph_before
= glyph
- 1;
13776 /* If the glyph row is reversed, we need to process it from back
13777 to front, so swap the edge pointers. */
13778 glyphs_end
= end
= glyph
- 1;
13779 glyph
+= row
->used
[TEXT_AREA
] - 1;
13781 while (glyph
> end
+ 1
13782 && INTEGERP (glyph
->object
)
13783 && glyph
->charpos
< 0)
13786 x
-= glyph
->pixel_width
;
13788 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13790 /* By default, in reversed rows we put the cursor on the
13791 rightmost (first in the reading order) glyph. */
13792 for (g
= end
+ 1; g
< glyph
; g
++)
13793 x
+= g
->pixel_width
;
13795 && INTEGERP ((end
+ 1)->object
)
13796 && (end
+ 1)->charpos
<= 0)
13798 glyph_before
= glyph
+ 1;
13802 else if (row
->reversed_p
)
13804 /* In R2L rows that don't display text, put the cursor on the
13805 rightmost glyph. Case in point: an empty last line that is
13806 part of an R2L paragraph. */
13808 /* Avoid placing the cursor on the last glyph of the row, where
13809 on terminal frames we hold the vertical border between
13810 adjacent windows. */
13811 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13812 && !WINDOW_RIGHTMOST_P (w
)
13813 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13815 x
= -1; /* will be computed below, at label compute_x */
13818 /* Step 1: Try to find the glyph whose character position
13819 corresponds to point. If that's not possible, find 2 glyphs
13820 whose character positions are the closest to point, one before
13821 point, the other after it. */
13822 if (!row
->reversed_p
)
13823 while (/* not marched to end of glyph row */
13825 /* glyph was not inserted by redisplay for internal purposes */
13826 && !INTEGERP (glyph
->object
))
13828 if (BUFFERP (glyph
->object
))
13830 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
13832 if (glyph
->charpos
> bpos_max
)
13833 bpos_max
= glyph
->charpos
;
13834 if (glyph
->charpos
< bpos_min
)
13835 bpos_min
= glyph
->charpos
;
13836 if (!glyph
->avoid_cursor_p
)
13838 /* If we hit point, we've found the glyph on which to
13839 display the cursor. */
13842 match_with_avoid_cursor
= 0;
13845 /* See if we've found a better approximation to
13846 POS_BEFORE or to POS_AFTER. */
13847 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13849 pos_before
= glyph
->charpos
;
13850 glyph_before
= glyph
;
13852 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
13854 pos_after
= glyph
->charpos
;
13855 glyph_after
= glyph
;
13858 else if (dpos
== 0)
13859 match_with_avoid_cursor
= 1;
13861 else if (STRINGP (glyph
->object
))
13863 Lisp_Object chprop
;
13864 ptrdiff_t glyph_pos
= glyph
->charpos
;
13866 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13868 if (!NILP (chprop
))
13870 /* If the string came from a `display' text property,
13871 look up the buffer position of that property and
13872 use that position to update bpos_max, as if we
13873 actually saw such a position in one of the row's
13874 glyphs. This helps with supporting integer values
13875 of `cursor' property on the display string in
13876 situations where most or all of the row's buffer
13877 text is completely covered by display properties,
13878 so that no glyph with valid buffer positions is
13879 ever seen in the row. */
13880 ptrdiff_t prop_pos
=
13881 string_buffer_position_lim (glyph
->object
, pos_before
,
13884 if (prop_pos
>= pos_before
)
13885 bpos_max
= prop_pos
- 1;
13887 if (INTEGERP (chprop
))
13889 bpos_covered
= bpos_max
+ XINT (chprop
);
13890 /* If the `cursor' property covers buffer positions up
13891 to and including point, we should display cursor on
13892 this glyph. Note that, if a `cursor' property on one
13893 of the string's characters has an integer value, we
13894 will break out of the loop below _before_ we get to
13895 the position match above. IOW, integer values of
13896 the `cursor' property override the "exact match for
13897 point" strategy of positioning the cursor. */
13898 /* Implementation note: bpos_max == pt_old when, e.g.,
13899 we are in an empty line, where bpos_max is set to
13900 MATRIX_ROW_START_CHARPOS, see above. */
13901 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13910 x
+= glyph
->pixel_width
;
13913 else if (glyph
> end
) /* row is reversed */
13914 while (!INTEGERP (glyph
->object
))
13916 if (BUFFERP (glyph
->object
))
13918 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
13920 if (glyph
->charpos
> bpos_max
)
13921 bpos_max
= glyph
->charpos
;
13922 if (glyph
->charpos
< bpos_min
)
13923 bpos_min
= glyph
->charpos
;
13924 if (!glyph
->avoid_cursor_p
)
13928 match_with_avoid_cursor
= 0;
13931 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13933 pos_before
= glyph
->charpos
;
13934 glyph_before
= glyph
;
13936 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
13938 pos_after
= glyph
->charpos
;
13939 glyph_after
= glyph
;
13942 else if (dpos
== 0)
13943 match_with_avoid_cursor
= 1;
13945 else if (STRINGP (glyph
->object
))
13947 Lisp_Object chprop
;
13948 ptrdiff_t glyph_pos
= glyph
->charpos
;
13950 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13952 if (!NILP (chprop
))
13954 ptrdiff_t prop_pos
=
13955 string_buffer_position_lim (glyph
->object
, pos_before
,
13958 if (prop_pos
>= pos_before
)
13959 bpos_max
= prop_pos
- 1;
13961 if (INTEGERP (chprop
))
13963 bpos_covered
= bpos_max
+ XINT (chprop
);
13964 /* If the `cursor' property covers buffer positions up
13965 to and including point, we should display cursor on
13967 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13976 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13978 x
--; /* can't use any pixel_width */
13981 x
-= glyph
->pixel_width
;
13984 /* Step 2: If we didn't find an exact match for point, we need to
13985 look for a proper place to put the cursor among glyphs between
13986 GLYPH_BEFORE and GLYPH_AFTER. */
13987 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13988 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13989 && !(bpos_max
< pt_old
&& pt_old
<= bpos_covered
))
13991 /* An empty line has a single glyph whose OBJECT is zero and
13992 whose CHARPOS is the position of a newline on that line.
13993 Note that on a TTY, there are more glyphs after that, which
13994 were produced by extend_face_to_end_of_line, but their
13995 CHARPOS is zero or negative. */
13997 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13998 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
13999 /* On a TTY, continued and truncated rows also have a glyph at
14000 their end whose OBJECT is zero and whose CHARPOS is
14001 positive (the continuation and truncation glyphs), but such
14002 rows are obviously not "empty". */
14003 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14005 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14007 ptrdiff_t ellipsis_pos
;
14009 /* Scan back over the ellipsis glyphs. */
14010 if (!row
->reversed_p
)
14012 ellipsis_pos
= (glyph
- 1)->charpos
;
14013 while (glyph
> row
->glyphs
[TEXT_AREA
]
14014 && (glyph
- 1)->charpos
== ellipsis_pos
)
14015 glyph
--, x
-= glyph
->pixel_width
;
14016 /* That loop always goes one position too far, including
14017 the glyph before the ellipsis. So scan forward over
14019 x
+= glyph
->pixel_width
;
14022 else /* row is reversed */
14024 ellipsis_pos
= (glyph
+ 1)->charpos
;
14025 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14026 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14027 glyph
++, x
+= glyph
->pixel_width
;
14028 x
-= glyph
->pixel_width
;
14032 else if (match_with_avoid_cursor
)
14034 cursor
= glyph_after
;
14037 else if (string_seen
)
14039 int incr
= row
->reversed_p
? -1 : +1;
14041 /* Need to find the glyph that came out of a string which is
14042 present at point. That glyph is somewhere between
14043 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14044 positioned between POS_BEFORE and POS_AFTER in the
14046 struct glyph
*start
, *stop
;
14047 ptrdiff_t pos
= pos_before
;
14051 /* If the row ends in a newline from a display string,
14052 reordering could have moved the glyphs belonging to the
14053 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14054 in this case we extend the search to the last glyph in
14055 the row that was not inserted by redisplay. */
14056 if (row
->ends_in_newline_from_string_p
)
14059 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14062 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14063 correspond to POS_BEFORE and POS_AFTER, respectively. We
14064 need START and STOP in the order that corresponds to the
14065 row's direction as given by its reversed_p flag. If the
14066 directionality of characters between POS_BEFORE and
14067 POS_AFTER is the opposite of the row's base direction,
14068 these characters will have been reordered for display,
14069 and we need to reverse START and STOP. */
14070 if (!row
->reversed_p
)
14072 start
= min (glyph_before
, glyph_after
);
14073 stop
= max (glyph_before
, glyph_after
);
14077 start
= max (glyph_before
, glyph_after
);
14078 stop
= min (glyph_before
, glyph_after
);
14080 for (glyph
= start
+ incr
;
14081 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14084 /* Any glyphs that come from the buffer are here because
14085 of bidi reordering. Skip them, and only pay
14086 attention to glyphs that came from some string. */
14087 if (STRINGP (glyph
->object
))
14091 /* If the display property covers the newline, we
14092 need to search for it one position farther. */
14093 ptrdiff_t lim
= pos_after
14094 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14096 string_from_text_prop
= 0;
14097 str
= glyph
->object
;
14098 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14099 if (tem
== 0 /* from overlay */
14102 /* If the string from which this glyph came is
14103 found in the buffer at point, or at position
14104 that is closer to point than pos_after, then
14105 we've found the glyph we've been looking for.
14106 If it comes from an overlay (tem == 0), and
14107 it has the `cursor' property on one of its
14108 glyphs, record that glyph as a candidate for
14109 displaying the cursor. (As in the
14110 unidirectional version, we will display the
14111 cursor on the last candidate we find.) */
14114 || (tem
- pt_old
> 0 && tem
< pos_after
))
14116 /* The glyphs from this string could have
14117 been reordered. Find the one with the
14118 smallest string position. Or there could
14119 be a character in the string with the
14120 `cursor' property, which means display
14121 cursor on that character's glyph. */
14122 ptrdiff_t strpos
= glyph
->charpos
;
14127 string_from_text_prop
= 1;
14130 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14131 && EQ (glyph
->object
, str
);
14135 ptrdiff_t gpos
= glyph
->charpos
;
14137 cprop
= Fget_char_property (make_number (gpos
),
14145 if (tem
&& glyph
->charpos
< strpos
)
14147 strpos
= glyph
->charpos
;
14153 || (tem
- pt_old
> 0 && tem
< pos_after
))
14157 pos
= tem
+ 1; /* don't find previous instances */
14159 /* This string is not what we want; skip all of the
14160 glyphs that came from it. */
14161 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14162 && EQ (glyph
->object
, str
))
14169 /* If we reached the end of the line, and END was from a string,
14170 the cursor is not on this line. */
14172 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14173 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14174 && STRINGP (end
->object
)
14175 && row
->continued_p
)
14178 /* A truncated row may not include PT among its character positions.
14179 Setting the cursor inside the scroll margin will trigger
14180 recalculation of hscroll in hscroll_window_tree. But if a
14181 display string covers point, defer to the string-handling
14182 code below to figure this out. */
14183 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14185 cursor
= glyph_before
;
14188 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14189 /* Zero-width characters produce no glyphs. */
14191 && (row
->reversed_p
14192 ? glyph_after
> glyphs_end
14193 : glyph_after
< glyphs_end
)))
14195 cursor
= glyph_after
;
14201 if (cursor
!= NULL
)
14203 else if (glyph
== glyphs_end
14204 && pos_before
== pos_after
14205 && STRINGP ((row
->reversed_p
14206 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14207 : row
->glyphs
[TEXT_AREA
])->object
))
14209 /* If all the glyphs of this row came from strings, put the
14210 cursor on the first glyph of the row. This avoids having the
14211 cursor outside of the text area in this very rare and hard
14215 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14216 : row
->glyphs
[TEXT_AREA
];
14222 /* Need to compute x that corresponds to GLYPH. */
14223 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14225 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14227 x
+= g
->pixel_width
;
14231 /* ROW could be part of a continued line, which, under bidi
14232 reordering, might have other rows whose start and end charpos
14233 occlude point. Only set w->cursor if we found a better
14234 approximation to the cursor position than we have from previously
14235 examined candidate rows belonging to the same continued line. */
14236 if (/* we already have a candidate row */
14237 w
->cursor
.vpos
>= 0
14238 /* that candidate is not the row we are processing */
14239 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14240 /* Make sure cursor.vpos specifies a row whose start and end
14241 charpos occlude point, and it is valid candidate for being a
14242 cursor-row. This is because some callers of this function
14243 leave cursor.vpos at the row where the cursor was displayed
14244 during the last redisplay cycle. */
14245 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14246 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14247 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14250 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14252 /* Don't consider glyphs that are outside TEXT_AREA. */
14253 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14255 /* Keep the candidate whose buffer position is the closest to
14256 point or has the `cursor' property. */
14257 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14258 w
->cursor
.hpos
>= 0
14259 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14260 && ((BUFFERP (g1
->object
)
14261 && (g1
->charpos
== pt_old
/* an exact match always wins */
14262 || (BUFFERP (glyph
->object
)
14263 && eabs (g1
->charpos
- pt_old
)
14264 < eabs (glyph
->charpos
- pt_old
))))
14265 /* previous candidate is a glyph from a string that has
14266 a non-nil `cursor' property */
14267 || (STRINGP (g1
->object
)
14268 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14269 Qcursor
, g1
->object
))
14270 /* previous candidate is from the same display
14271 string as this one, and the display string
14272 came from a text property */
14273 || (EQ (g1
->object
, glyph
->object
)
14274 && string_from_text_prop
)
14275 /* this candidate is from newline and its
14276 position is not an exact match */
14277 || (INTEGERP (glyph
->object
)
14278 && glyph
->charpos
!= pt_old
)))))
14280 /* If this candidate gives an exact match, use that. */
14281 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14282 /* If this candidate is a glyph created for the
14283 terminating newline of a line, and point is on that
14284 newline, it wins because it's an exact match. */
14285 || (!row
->continued_p
14286 && INTEGERP (glyph
->object
)
14287 && glyph
->charpos
== 0
14288 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14289 /* Otherwise, keep the candidate that comes from a row
14290 spanning less buffer positions. This may win when one or
14291 both candidate positions are on glyphs that came from
14292 display strings, for which we cannot compare buffer
14294 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14295 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14296 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14299 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14301 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14302 w
->cursor
.y
= row
->y
+ dy
;
14304 if (w
== XWINDOW (selected_window
))
14306 if (!row
->continued_p
14307 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14310 this_line_buffer
= XBUFFER (w
->buffer
);
14312 CHARPOS (this_line_start_pos
)
14313 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14314 BYTEPOS (this_line_start_pos
)
14315 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14317 CHARPOS (this_line_end_pos
)
14318 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14319 BYTEPOS (this_line_end_pos
)
14320 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14322 this_line_y
= w
->cursor
.y
;
14323 this_line_pixel_height
= row
->height
;
14324 this_line_vpos
= w
->cursor
.vpos
;
14325 this_line_start_x
= row
->x
;
14328 CHARPOS (this_line_start_pos
) = 0;
14335 /* Run window scroll functions, if any, for WINDOW with new window
14336 start STARTP. Sets the window start of WINDOW to that position.
14338 We assume that the window's buffer is really current. */
14340 static struct text_pos
14341 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14343 struct window
*w
= XWINDOW (window
);
14344 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14346 if (current_buffer
!= XBUFFER (w
->buffer
))
14349 if (!NILP (Vwindow_scroll_functions
))
14351 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14352 make_number (CHARPOS (startp
)));
14353 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14354 /* In case the hook functions switch buffers. */
14355 set_buffer_internal (XBUFFER (w
->buffer
));
14362 /* Make sure the line containing the cursor is fully visible.
14363 A value of 1 means there is nothing to be done.
14364 (Either the line is fully visible, or it cannot be made so,
14365 or we cannot tell.)
14367 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14368 is higher than window.
14370 A value of 0 means the caller should do scrolling
14371 as if point had gone off the screen. */
14374 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14376 struct glyph_matrix
*matrix
;
14377 struct glyph_row
*row
;
14380 if (!make_cursor_line_fully_visible_p
)
14383 /* It's not always possible to find the cursor, e.g, when a window
14384 is full of overlay strings. Don't do anything in that case. */
14385 if (w
->cursor
.vpos
< 0)
14388 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14389 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14391 /* If the cursor row is not partially visible, there's nothing to do. */
14392 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14395 /* If the row the cursor is in is taller than the window's height,
14396 it's not clear what to do, so do nothing. */
14397 window_height
= window_box_height (w
);
14398 if (row
->height
>= window_height
)
14400 if (!force_p
|| MINI_WINDOW_P (w
)
14401 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14408 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14409 non-zero means only WINDOW is redisplayed in redisplay_internal.
14410 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14411 in redisplay_window to bring a partially visible line into view in
14412 the case that only the cursor has moved.
14414 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14415 last screen line's vertical height extends past the end of the screen.
14419 1 if scrolling succeeded
14421 0 if scrolling didn't find point.
14423 -1 if new fonts have been loaded so that we must interrupt
14424 redisplay, adjust glyph matrices, and try again. */
14430 SCROLLING_NEED_LARGER_MATRICES
14433 /* If scroll-conservatively is more than this, never recenter.
14435 If you change this, don't forget to update the doc string of
14436 `scroll-conservatively' and the Emacs manual. */
14437 #define SCROLL_LIMIT 100
14440 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14441 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14442 int temp_scroll_step
, int last_line_misfit
)
14444 struct window
*w
= XWINDOW (window
);
14445 struct frame
*f
= XFRAME (w
->frame
);
14446 struct text_pos pos
, startp
;
14448 int this_scroll_margin
, scroll_max
, rc
, height
;
14449 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14450 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14451 Lisp_Object aggressive
;
14452 /* We will never try scrolling more than this number of lines. */
14453 int scroll_limit
= SCROLL_LIMIT
;
14456 debug_method_add (w
, "try_scrolling");
14459 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14461 /* Compute scroll margin height in pixels. We scroll when point is
14462 within this distance from the top or bottom of the window. */
14463 if (scroll_margin
> 0)
14464 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14465 * FRAME_LINE_HEIGHT (f
);
14467 this_scroll_margin
= 0;
14469 /* Force arg_scroll_conservatively to have a reasonable value, to
14470 avoid scrolling too far away with slow move_it_* functions. Note
14471 that the user can supply scroll-conservatively equal to
14472 `most-positive-fixnum', which can be larger than INT_MAX. */
14473 if (arg_scroll_conservatively
> scroll_limit
)
14475 arg_scroll_conservatively
= scroll_limit
+ 1;
14476 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14478 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14479 /* Compute how much we should try to scroll maximally to bring
14480 point into view. */
14481 scroll_max
= (max (scroll_step
,
14482 max (arg_scroll_conservatively
, temp_scroll_step
))
14483 * FRAME_LINE_HEIGHT (f
));
14484 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14485 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14486 /* We're trying to scroll because of aggressive scrolling but no
14487 scroll_step is set. Choose an arbitrary one. */
14488 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14494 /* Decide whether to scroll down. */
14495 if (PT
> CHARPOS (startp
))
14497 int scroll_margin_y
;
14499 /* Compute the pixel ypos of the scroll margin, then move IT to
14500 either that ypos or PT, whichever comes first. */
14501 start_display (&it
, w
, startp
);
14502 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14503 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14504 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14505 (MOVE_TO_POS
| MOVE_TO_Y
));
14507 if (PT
> CHARPOS (it
.current
.pos
))
14509 int y0
= line_bottom_y (&it
);
14510 /* Compute how many pixels below window bottom to stop searching
14511 for PT. This avoids costly search for PT that is far away if
14512 the user limited scrolling by a small number of lines, but
14513 always finds PT if scroll_conservatively is set to a large
14514 number, such as most-positive-fixnum. */
14515 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14516 int y_to_move
= it
.last_visible_y
+ slack
;
14518 /* Compute the distance from the scroll margin to PT or to
14519 the scroll limit, whichever comes first. This should
14520 include the height of the cursor line, to make that line
14522 move_it_to (&it
, PT
, -1, y_to_move
,
14523 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14524 dy
= line_bottom_y (&it
) - y0
;
14526 if (dy
> scroll_max
)
14527 return SCROLLING_FAILED
;
14536 /* Point is in or below the bottom scroll margin, so move the
14537 window start down. If scrolling conservatively, move it just
14538 enough down to make point visible. If scroll_step is set,
14539 move it down by scroll_step. */
14540 if (arg_scroll_conservatively
)
14542 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14543 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14544 else if (scroll_step
|| temp_scroll_step
)
14545 amount_to_scroll
= scroll_max
;
14548 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14549 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14550 if (NUMBERP (aggressive
))
14552 double float_amount
= XFLOATINT (aggressive
) * height
;
14553 int aggressive_scroll
= float_amount
;
14554 if (aggressive_scroll
== 0 && float_amount
> 0)
14555 aggressive_scroll
= 1;
14556 /* Don't let point enter the scroll margin near top of
14557 the window. This could happen if the value of
14558 scroll_up_aggressively is too large and there are
14559 non-zero margins, because scroll_up_aggressively
14560 means put point that fraction of window height
14561 _from_the_bottom_margin_. */
14562 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14563 aggressive_scroll
= height
- 2*this_scroll_margin
;
14564 amount_to_scroll
= dy
+ aggressive_scroll
;
14568 if (amount_to_scroll
<= 0)
14569 return SCROLLING_FAILED
;
14571 start_display (&it
, w
, startp
);
14572 if (arg_scroll_conservatively
<= scroll_limit
)
14573 move_it_vertically (&it
, amount_to_scroll
);
14576 /* Extra precision for users who set scroll-conservatively
14577 to a large number: make sure the amount we scroll
14578 the window start is never less than amount_to_scroll,
14579 which was computed as distance from window bottom to
14580 point. This matters when lines at window top and lines
14581 below window bottom have different height. */
14583 void *it1data
= NULL
;
14584 /* We use a temporary it1 because line_bottom_y can modify
14585 its argument, if it moves one line down; see there. */
14588 SAVE_IT (it1
, it
, it1data
);
14589 start_y
= line_bottom_y (&it1
);
14591 RESTORE_IT (&it
, &it
, it1data
);
14592 move_it_by_lines (&it
, 1);
14593 SAVE_IT (it1
, it
, it1data
);
14594 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14597 /* If STARTP is unchanged, move it down another screen line. */
14598 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14599 move_it_by_lines (&it
, 1);
14600 startp
= it
.current
.pos
;
14604 struct text_pos scroll_margin_pos
= startp
;
14607 /* See if point is inside the scroll margin at the top of the
14609 if (this_scroll_margin
)
14613 start_display (&it
, w
, startp
);
14614 y_start
= it
.current_y
;
14615 move_it_vertically (&it
, this_scroll_margin
);
14616 scroll_margin_pos
= it
.current
.pos
;
14617 /* If we didn't move enough before hitting ZV, request
14618 additional amount of scroll, to move point out of the
14620 if (IT_CHARPOS (it
) == ZV
14621 && it
.current_y
- y_start
< this_scroll_margin
)
14622 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
14625 if (PT
< CHARPOS (scroll_margin_pos
))
14627 /* Point is in the scroll margin at the top of the window or
14628 above what is displayed in the window. */
14631 /* Compute the vertical distance from PT to the scroll
14632 margin position. Move as far as scroll_max allows, or
14633 one screenful, or 10 screen lines, whichever is largest.
14634 Give up if distance is greater than scroll_max or if we
14635 didn't reach the scroll margin position. */
14636 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14637 start_display (&it
, w
, pos
);
14639 y_to_move
= max (it
.last_visible_y
,
14640 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14641 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14643 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14644 dy
= it
.current_y
- y0
;
14645 if (dy
> scroll_max
14646 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
14647 return SCROLLING_FAILED
;
14649 /* Additional scroll for when ZV was too close to point. */
14652 /* Compute new window start. */
14653 start_display (&it
, w
, startp
);
14655 if (arg_scroll_conservatively
)
14656 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14657 max (scroll_step
, temp_scroll_step
));
14658 else if (scroll_step
|| temp_scroll_step
)
14659 amount_to_scroll
= scroll_max
;
14662 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14663 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14664 if (NUMBERP (aggressive
))
14666 double float_amount
= XFLOATINT (aggressive
) * height
;
14667 int aggressive_scroll
= float_amount
;
14668 if (aggressive_scroll
== 0 && float_amount
> 0)
14669 aggressive_scroll
= 1;
14670 /* Don't let point enter the scroll margin near
14671 bottom of the window, if the value of
14672 scroll_down_aggressively happens to be too
14674 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14675 aggressive_scroll
= height
- 2*this_scroll_margin
;
14676 amount_to_scroll
= dy
+ aggressive_scroll
;
14680 if (amount_to_scroll
<= 0)
14681 return SCROLLING_FAILED
;
14683 move_it_vertically_backward (&it
, amount_to_scroll
);
14684 startp
= it
.current
.pos
;
14688 /* Run window scroll functions. */
14689 startp
= run_window_scroll_functions (window
, startp
);
14691 /* Display the window. Give up if new fonts are loaded, or if point
14693 if (!try_window (window
, startp
, 0))
14694 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14695 else if (w
->cursor
.vpos
< 0)
14697 clear_glyph_matrix (w
->desired_matrix
);
14698 rc
= SCROLLING_FAILED
;
14702 /* Maybe forget recorded base line for line number display. */
14703 if (!just_this_one_p
14704 || current_buffer
->clip_changed
14705 || BEG_UNCHANGED
< CHARPOS (startp
))
14706 w
->base_line_number
= 0;
14708 /* If cursor ends up on a partially visible line,
14709 treat that as being off the bottom of the screen. */
14710 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14711 /* It's possible that the cursor is on the first line of the
14712 buffer, which is partially obscured due to a vscroll
14713 (Bug#7537). In that case, avoid looping forever . */
14714 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14716 clear_glyph_matrix (w
->desired_matrix
);
14717 ++extra_scroll_margin_lines
;
14720 rc
= SCROLLING_SUCCESS
;
14727 /* Compute a suitable window start for window W if display of W starts
14728 on a continuation line. Value is non-zero if a new window start
14731 The new window start will be computed, based on W's width, starting
14732 from the start of the continued line. It is the start of the
14733 screen line with the minimum distance from the old start W->start. */
14736 compute_window_start_on_continuation_line (struct window
*w
)
14738 struct text_pos pos
, start_pos
;
14739 int window_start_changed_p
= 0;
14741 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14743 /* If window start is on a continuation line... Window start may be
14744 < BEGV in case there's invisible text at the start of the
14745 buffer (M-x rmail, for example). */
14746 if (CHARPOS (start_pos
) > BEGV
14747 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14750 struct glyph_row
*row
;
14752 /* Handle the case that the window start is out of range. */
14753 if (CHARPOS (start_pos
) < BEGV
)
14754 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14755 else if (CHARPOS (start_pos
) > ZV
)
14756 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14758 /* Find the start of the continued line. This should be fast
14759 because find_newline is fast (newline cache). */
14760 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14761 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14762 row
, DEFAULT_FACE_ID
);
14763 reseat_at_previous_visible_line_start (&it
);
14765 /* If the line start is "too far" away from the window start,
14766 say it takes too much time to compute a new window start. */
14767 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14768 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14770 int min_distance
, distance
;
14772 /* Move forward by display lines to find the new window
14773 start. If window width was enlarged, the new start can
14774 be expected to be > the old start. If window width was
14775 decreased, the new window start will be < the old start.
14776 So, we're looking for the display line start with the
14777 minimum distance from the old window start. */
14778 pos
= it
.current
.pos
;
14779 min_distance
= INFINITY
;
14780 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14781 distance
< min_distance
)
14783 min_distance
= distance
;
14784 pos
= it
.current
.pos
;
14785 move_it_by_lines (&it
, 1);
14788 /* Set the window start there. */
14789 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14790 window_start_changed_p
= 1;
14794 return window_start_changed_p
;
14798 /* Try cursor movement in case text has not changed in window WINDOW,
14799 with window start STARTP. Value is
14801 CURSOR_MOVEMENT_SUCCESS if successful
14803 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14805 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14806 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14807 we want to scroll as if scroll-step were set to 1. See the code.
14809 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14810 which case we have to abort this redisplay, and adjust matrices
14815 CURSOR_MOVEMENT_SUCCESS
,
14816 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14817 CURSOR_MOVEMENT_MUST_SCROLL
,
14818 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14822 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14824 struct window
*w
= XWINDOW (window
);
14825 struct frame
*f
= XFRAME (w
->frame
);
14826 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14829 if (inhibit_try_cursor_movement
)
14833 /* Previously, there was a check for Lisp integer in the
14834 if-statement below. Now, this field is converted to
14835 ptrdiff_t, thus zero means invalid position in a buffer. */
14836 eassert (w
->last_point
> 0);
14838 /* Handle case where text has not changed, only point, and it has
14839 not moved off the frame. */
14840 if (/* Point may be in this window. */
14841 PT
>= CHARPOS (startp
)
14842 /* Selective display hasn't changed. */
14843 && !current_buffer
->clip_changed
14844 /* Function force-mode-line-update is used to force a thorough
14845 redisplay. It sets either windows_or_buffers_changed or
14846 update_mode_lines. So don't take a shortcut here for these
14848 && !update_mode_lines
14849 && !windows_or_buffers_changed
14850 && !cursor_type_changed
14851 /* Can't use this case if highlighting a region. When a
14852 region exists, cursor movement has to do more than just
14854 && markpos_of_region () < 0
14855 && !w
->region_showing
14856 && NILP (Vshow_trailing_whitespace
)
14857 /* This code is not used for mini-buffer for the sake of the case
14858 of redisplaying to replace an echo area message; since in
14859 that case the mini-buffer contents per se are usually
14860 unchanged. This code is of no real use in the mini-buffer
14861 since the handling of this_line_start_pos, etc., in redisplay
14862 handles the same cases. */
14863 && !EQ (window
, minibuf_window
)
14864 /* When splitting windows or for new windows, it happens that
14865 redisplay is called with a nil window_end_vpos or one being
14866 larger than the window. This should really be fixed in
14867 window.c. I don't have this on my list, now, so we do
14868 approximately the same as the old redisplay code. --gerd. */
14869 && INTEGERP (w
->window_end_vpos
)
14870 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14871 && (FRAME_WINDOW_P (f
)
14872 || !overlay_arrow_in_current_buffer_p ()))
14874 int this_scroll_margin
, top_scroll_margin
;
14875 struct glyph_row
*row
= NULL
;
14878 debug_method_add (w
, "cursor movement");
14881 /* Scroll if point within this distance from the top or bottom
14882 of the window. This is a pixel value. */
14883 if (scroll_margin
> 0)
14885 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14886 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14889 this_scroll_margin
= 0;
14891 top_scroll_margin
= this_scroll_margin
;
14892 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14893 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14895 /* Start with the row the cursor was displayed during the last
14896 not paused redisplay. Give up if that row is not valid. */
14897 if (w
->last_cursor
.vpos
< 0
14898 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14899 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14902 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14903 if (row
->mode_line_p
)
14905 if (!row
->enabled_p
)
14906 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14909 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14911 int scroll_p
= 0, must_scroll
= 0;
14912 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14914 if (PT
> w
->last_point
)
14916 /* Point has moved forward. */
14917 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14918 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14920 eassert (row
->enabled_p
);
14924 /* If the end position of a row equals the start
14925 position of the next row, and PT is at that position,
14926 we would rather display cursor in the next line. */
14927 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14928 && MATRIX_ROW_END_CHARPOS (row
) == PT
14929 && row
< w
->current_matrix
->rows
14930 + w
->current_matrix
->nrows
- 1
14931 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14932 && !cursor_row_p (row
))
14935 /* If within the scroll margin, scroll. Note that
14936 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14937 the next line would be drawn, and that
14938 this_scroll_margin can be zero. */
14939 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14940 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14941 /* Line is completely visible last line in window
14942 and PT is to be set in the next line. */
14943 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14944 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14945 && !row
->ends_at_zv_p
14946 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14949 else if (PT
< w
->last_point
)
14951 /* Cursor has to be moved backward. Note that PT >=
14952 CHARPOS (startp) because of the outer if-statement. */
14953 while (!row
->mode_line_p
14954 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14955 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14956 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14957 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14958 row
> w
->current_matrix
->rows
14959 && (row
-1)->ends_in_newline_from_string_p
))))
14960 && (row
->y
> top_scroll_margin
14961 || CHARPOS (startp
) == BEGV
))
14963 eassert (row
->enabled_p
);
14967 /* Consider the following case: Window starts at BEGV,
14968 there is invisible, intangible text at BEGV, so that
14969 display starts at some point START > BEGV. It can
14970 happen that we are called with PT somewhere between
14971 BEGV and START. Try to handle that case. */
14972 if (row
< w
->current_matrix
->rows
14973 || row
->mode_line_p
)
14975 row
= w
->current_matrix
->rows
;
14976 if (row
->mode_line_p
)
14980 /* Due to newlines in overlay strings, we may have to
14981 skip forward over overlay strings. */
14982 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14983 && MATRIX_ROW_END_CHARPOS (row
) == PT
14984 && !cursor_row_p (row
))
14987 /* If within the scroll margin, scroll. */
14988 if (row
->y
< top_scroll_margin
14989 && CHARPOS (startp
) != BEGV
)
14994 /* Cursor did not move. So don't scroll even if cursor line
14995 is partially visible, as it was so before. */
14996 rc
= CURSOR_MOVEMENT_SUCCESS
;
14999 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15000 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15002 /* if PT is not in the glyph row, give up. */
15003 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15006 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15007 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15009 struct glyph_row
*row1
;
15011 /* If rows are bidi-reordered and point moved, back up
15012 until we find a row that does not belong to a
15013 continuation line. This is because we must consider
15014 all rows of a continued line as candidates for the
15015 new cursor positioning, since row start and end
15016 positions change non-linearly with vertical position
15018 /* FIXME: Revisit this when glyph ``spilling'' in
15019 continuation lines' rows is implemented for
15020 bidi-reordered rows. */
15021 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15022 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15025 /* If we hit the beginning of the displayed portion
15026 without finding the first row of a continued
15030 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15033 eassert (row
->enabled_p
);
15038 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15039 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15040 /* Make sure this isn't a header line by any chance, since
15041 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15042 && !row
->mode_line_p
15043 && make_cursor_line_fully_visible_p
)
15045 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15046 && !row
->ends_at_zv_p
15047 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15048 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15049 else if (row
->height
> window_box_height (w
))
15051 /* If we end up in a partially visible line, let's
15052 make it fully visible, except when it's taller
15053 than the window, in which case we can't do much
15056 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15060 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15061 if (!cursor_row_fully_visible_p (w
, 0, 1))
15062 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15064 rc
= CURSOR_MOVEMENT_SUCCESS
;
15068 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15069 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15070 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15072 /* With bidi-reordered rows, there could be more than
15073 one candidate row whose start and end positions
15074 occlude point. We need to let set_cursor_from_row
15075 find the best candidate. */
15076 /* FIXME: Revisit this when glyph ``spilling'' in
15077 continuation lines' rows is implemented for
15078 bidi-reordered rows. */
15083 int at_zv_p
= 0, exact_match_p
= 0;
15085 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15086 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15087 && cursor_row_p (row
))
15088 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15090 /* As soon as we've found the exact match for point,
15091 or the first suitable row whose ends_at_zv_p flag
15092 is set, we are done. */
15094 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15096 && w
->cursor
.hpos
>= 0
15097 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15100 struct glyph_row
*candidate
=
15101 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15103 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15104 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15107 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15108 || (INTEGERP (g
->object
)
15109 && (g
->charpos
== PT
15110 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15112 if (rv
&& (at_zv_p
|| exact_match_p
))
15114 rc
= CURSOR_MOVEMENT_SUCCESS
;
15117 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15121 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15122 || row
->continued_p
)
15123 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15124 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15125 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15126 /* If we didn't find any candidate rows, or exited the
15127 loop before all the candidates were examined, signal
15128 to the caller that this method failed. */
15129 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15131 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15132 && !row
->continued_p
))
15133 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15135 rc
= CURSOR_MOVEMENT_SUCCESS
;
15141 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15143 rc
= CURSOR_MOVEMENT_SUCCESS
;
15148 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15149 && MATRIX_ROW_START_CHARPOS (row
) == PT
15150 && cursor_row_p (row
));
15158 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15162 set_vertical_scroll_bar (struct window
*w
)
15164 ptrdiff_t start
, end
, whole
;
15166 /* Calculate the start and end positions for the current window.
15167 At some point, it would be nice to choose between scrollbars
15168 which reflect the whole buffer size, with special markers
15169 indicating narrowing, and scrollbars which reflect only the
15172 Note that mini-buffers sometimes aren't displaying any text. */
15173 if (!MINI_WINDOW_P (w
)
15174 || (w
== XWINDOW (minibuf_window
)
15175 && NILP (echo_area_buffer
[0])))
15177 struct buffer
*buf
= XBUFFER (w
->buffer
);
15178 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15179 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15180 /* I don't think this is guaranteed to be right. For the
15181 moment, we'll pretend it is. */
15182 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15186 if (whole
< (end
- start
))
15187 whole
= end
- start
;
15190 start
= end
= whole
= 0;
15192 /* Indicate what this scroll bar ought to be displaying now. */
15193 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15194 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15195 (w
, end
- start
, whole
, start
);
15199 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15200 selected_window is redisplayed.
15202 We can return without actually redisplaying the window if
15203 fonts_changed_p. In that case, redisplay_internal will
15207 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15209 struct window
*w
= XWINDOW (window
);
15210 struct frame
*f
= XFRAME (w
->frame
);
15211 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15212 struct buffer
*old
= current_buffer
;
15213 struct text_pos lpoint
, opoint
, startp
;
15214 int update_mode_line
;
15217 /* Record it now because it's overwritten. */
15218 int current_matrix_up_to_date_p
= 0;
15219 int used_current_matrix_p
= 0;
15220 /* This is less strict than current_matrix_up_to_date_p.
15221 It indicates that the buffer contents and narrowing are unchanged. */
15222 int buffer_unchanged_p
= 0;
15223 int temp_scroll_step
= 0;
15224 ptrdiff_t count
= SPECPDL_INDEX ();
15226 int centering_position
= -1;
15227 int last_line_misfit
= 0;
15228 ptrdiff_t beg_unchanged
, end_unchanged
;
15230 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15233 /* W must be a leaf window here. */
15234 eassert (!NILP (w
->buffer
));
15236 *w
->desired_matrix
->method
= 0;
15240 reconsider_clip_changes (w
, buffer
);
15242 /* Has the mode line to be updated? */
15243 update_mode_line
= (w
->update_mode_line
15244 || update_mode_lines
15245 || buffer
->clip_changed
15246 || buffer
->prevent_redisplay_optimizations_p
);
15248 if (MINI_WINDOW_P (w
))
15250 if (w
== XWINDOW (echo_area_window
)
15251 && !NILP (echo_area_buffer
[0]))
15253 if (update_mode_line
)
15254 /* We may have to update a tty frame's menu bar or a
15255 tool-bar. Example `M-x C-h C-h C-g'. */
15256 goto finish_menu_bars
;
15258 /* We've already displayed the echo area glyphs in this window. */
15259 goto finish_scroll_bars
;
15261 else if ((w
!= XWINDOW (minibuf_window
)
15262 || minibuf_level
== 0)
15263 /* When buffer is nonempty, redisplay window normally. */
15264 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15265 /* Quail displays non-mini buffers in minibuffer window.
15266 In that case, redisplay the window normally. */
15267 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15269 /* W is a mini-buffer window, but it's not active, so clear
15271 int yb
= window_text_bottom_y (w
);
15272 struct glyph_row
*row
;
15275 for (y
= 0, row
= w
->desired_matrix
->rows
;
15277 y
+= row
->height
, ++row
)
15278 blank_row (w
, row
, y
);
15279 goto finish_scroll_bars
;
15282 clear_glyph_matrix (w
->desired_matrix
);
15285 /* Otherwise set up data on this window; select its buffer and point
15287 /* Really select the buffer, for the sake of buffer-local
15289 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15291 current_matrix_up_to_date_p
15292 = (w
->window_end_valid
15293 && !current_buffer
->clip_changed
15294 && !current_buffer
->prevent_redisplay_optimizations_p
15295 && !window_outdated (w
));
15297 /* Run the window-bottom-change-functions
15298 if it is possible that the text on the screen has changed
15299 (either due to modification of the text, or any other reason). */
15300 if (!current_matrix_up_to_date_p
15301 && !NILP (Vwindow_text_change_functions
))
15303 safe_run_hooks (Qwindow_text_change_functions
);
15307 beg_unchanged
= BEG_UNCHANGED
;
15308 end_unchanged
= END_UNCHANGED
;
15310 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15312 specbind (Qinhibit_point_motion_hooks
, Qt
);
15315 = (w
->window_end_valid
15316 && !current_buffer
->clip_changed
15317 && !window_outdated (w
));
15319 /* When windows_or_buffers_changed is non-zero, we can't rely on
15320 the window end being valid, so set it to nil there. */
15321 if (windows_or_buffers_changed
)
15323 /* If window starts on a continuation line, maybe adjust the
15324 window start in case the window's width changed. */
15325 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15326 compute_window_start_on_continuation_line (w
);
15328 w
->window_end_valid
= 0;
15331 /* Some sanity checks. */
15332 CHECK_WINDOW_END (w
);
15333 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15335 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15338 if (mode_line_update_needed (w
))
15339 update_mode_line
= 1;
15341 /* Point refers normally to the selected window. For any other
15342 window, set up appropriate value. */
15343 if (!EQ (window
, selected_window
))
15345 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15346 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15350 new_pt_byte
= BEGV_BYTE
;
15351 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15353 else if (new_pt
> (ZV
- 1))
15356 new_pt_byte
= ZV_BYTE
;
15357 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15360 /* We don't use SET_PT so that the point-motion hooks don't run. */
15361 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15364 /* If any of the character widths specified in the display table
15365 have changed, invalidate the width run cache. It's true that
15366 this may be a bit late to catch such changes, but the rest of
15367 redisplay goes (non-fatally) haywire when the display table is
15368 changed, so why should we worry about doing any better? */
15369 if (current_buffer
->width_run_cache
)
15371 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15373 if (! disptab_matches_widthtab
15374 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15376 invalidate_region_cache (current_buffer
,
15377 current_buffer
->width_run_cache
,
15379 recompute_width_table (current_buffer
, disptab
);
15383 /* If window-start is screwed up, choose a new one. */
15384 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15387 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15389 /* If someone specified a new starting point but did not insist,
15390 check whether it can be used. */
15391 if (w
->optional_new_start
15392 && CHARPOS (startp
) >= BEGV
15393 && CHARPOS (startp
) <= ZV
)
15395 w
->optional_new_start
= 0;
15396 start_display (&it
, w
, startp
);
15397 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15398 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15399 if (IT_CHARPOS (it
) == PT
)
15400 w
->force_start
= 1;
15401 /* IT may overshoot PT if text at PT is invisible. */
15402 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15403 w
->force_start
= 1;
15408 /* Handle case where place to start displaying has been specified,
15409 unless the specified location is outside the accessible range. */
15410 if (w
->force_start
|| w
->frozen_window_start_p
)
15412 /* We set this later on if we have to adjust point. */
15415 w
->force_start
= 0;
15417 w
->window_end_valid
= 0;
15419 /* Forget any recorded base line for line number display. */
15420 if (!buffer_unchanged_p
)
15421 w
->base_line_number
= 0;
15423 /* Redisplay the mode line. Select the buffer properly for that.
15424 Also, run the hook window-scroll-functions
15425 because we have scrolled. */
15426 /* Note, we do this after clearing force_start because
15427 if there's an error, it is better to forget about force_start
15428 than to get into an infinite loop calling the hook functions
15429 and having them get more errors. */
15430 if (!update_mode_line
15431 || ! NILP (Vwindow_scroll_functions
))
15433 update_mode_line
= 1;
15434 w
->update_mode_line
= 1;
15435 startp
= run_window_scroll_functions (window
, startp
);
15438 w
->last_modified
= 0;
15439 w
->last_overlay_modified
= 0;
15440 if (CHARPOS (startp
) < BEGV
)
15441 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15442 else if (CHARPOS (startp
) > ZV
)
15443 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15445 /* Redisplay, then check if cursor has been set during the
15446 redisplay. Give up if new fonts were loaded. */
15447 /* We used to issue a CHECK_MARGINS argument to try_window here,
15448 but this causes scrolling to fail when point begins inside
15449 the scroll margin (bug#148) -- cyd */
15450 if (!try_window (window
, startp
, 0))
15452 w
->force_start
= 1;
15453 clear_glyph_matrix (w
->desired_matrix
);
15454 goto need_larger_matrices
;
15457 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15459 /* If point does not appear, try to move point so it does
15460 appear. The desired matrix has been built above, so we
15461 can use it here. */
15462 new_vpos
= window_box_height (w
) / 2;
15465 if (!cursor_row_fully_visible_p (w
, 0, 0))
15467 /* Point does appear, but on a line partly visible at end of window.
15468 Move it back to a fully-visible line. */
15469 new_vpos
= window_box_height (w
);
15471 else if (w
->cursor
.vpos
>=0)
15473 /* Some people insist on not letting point enter the scroll
15474 margin, even though this part handles windows that didn't
15476 int margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15477 int pixel_margin
= margin
* FRAME_LINE_HEIGHT (f
);
15478 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
15480 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
15481 below, which finds the row to move point to, advances by
15482 the Y coordinate of the _next_ row, see the definition of
15483 MATRIX_ROW_BOTTOM_Y. */
15484 if (w
->cursor
.vpos
< margin
+ header_line
)
15486 = pixel_margin
+ (header_line
15487 ? CURRENT_HEADER_LINE_HEIGHT (w
)
15488 : 0) + FRAME_LINE_HEIGHT (f
);
15491 int window_height
= window_box_height (w
);
15494 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15495 if (w
->cursor
.y
>= window_height
- pixel_margin
)
15496 new_vpos
= window_height
- pixel_margin
;
15500 /* If we need to move point for either of the above reasons,
15501 now actually do it. */
15504 struct glyph_row
*row
;
15506 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15507 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15510 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15511 MATRIX_ROW_START_BYTEPOS (row
));
15513 if (w
!= XWINDOW (selected_window
))
15514 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15515 else if (current_buffer
== old
)
15516 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15518 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15520 /* If we are highlighting the region, then we just changed
15521 the region, so redisplay to show it. */
15522 if (0 <= markpos_of_region ())
15524 clear_glyph_matrix (w
->desired_matrix
);
15525 if (!try_window (window
, startp
, 0))
15526 goto need_larger_matrices
;
15531 debug_method_add (w
, "forced window start");
15536 /* Handle case where text has not changed, only point, and it has
15537 not moved off the frame, and we are not retrying after hscroll.
15538 (current_matrix_up_to_date_p is nonzero when retrying.) */
15539 if (current_matrix_up_to_date_p
15540 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15541 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15545 case CURSOR_MOVEMENT_SUCCESS
:
15546 used_current_matrix_p
= 1;
15549 case CURSOR_MOVEMENT_MUST_SCROLL
:
15550 goto try_to_scroll
;
15556 /* If current starting point was originally the beginning of a line
15557 but no longer is, find a new starting point. */
15558 else if (w
->start_at_line_beg
15559 && !(CHARPOS (startp
) <= BEGV
15560 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15563 debug_method_add (w
, "recenter 1");
15568 /* Try scrolling with try_window_id. Value is > 0 if update has
15569 been done, it is -1 if we know that the same window start will
15570 not work. It is 0 if unsuccessful for some other reason. */
15571 else if ((tem
= try_window_id (w
)) != 0)
15574 debug_method_add (w
, "try_window_id %d", tem
);
15577 if (fonts_changed_p
)
15578 goto need_larger_matrices
;
15582 /* Otherwise try_window_id has returned -1 which means that we
15583 don't want the alternative below this comment to execute. */
15585 else if (CHARPOS (startp
) >= BEGV
15586 && CHARPOS (startp
) <= ZV
15587 && PT
>= CHARPOS (startp
)
15588 && (CHARPOS (startp
) < ZV
15589 /* Avoid starting at end of buffer. */
15590 || CHARPOS (startp
) == BEGV
15591 || !window_outdated (w
)))
15593 int d1
, d2
, d3
, d4
, d5
, d6
;
15595 /* If first window line is a continuation line, and window start
15596 is inside the modified region, but the first change is before
15597 current window start, we must select a new window start.
15599 However, if this is the result of a down-mouse event (e.g. by
15600 extending the mouse-drag-overlay), we don't want to select a
15601 new window start, since that would change the position under
15602 the mouse, resulting in an unwanted mouse-movement rather
15603 than a simple mouse-click. */
15604 if (!w
->start_at_line_beg
15605 && NILP (do_mouse_tracking
)
15606 && CHARPOS (startp
) > BEGV
15607 && CHARPOS (startp
) > BEG
+ beg_unchanged
15608 && CHARPOS (startp
) <= Z
- end_unchanged
15609 /* Even if w->start_at_line_beg is nil, a new window may
15610 start at a line_beg, since that's how set_buffer_window
15611 sets it. So, we need to check the return value of
15612 compute_window_start_on_continuation_line. (See also
15614 && XMARKER (w
->start
)->buffer
== current_buffer
15615 && compute_window_start_on_continuation_line (w
)
15616 /* It doesn't make sense to force the window start like we
15617 do at label force_start if it is already known that point
15618 will not be visible in the resulting window, because
15619 doing so will move point from its correct position
15620 instead of scrolling the window to bring point into view.
15622 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15624 w
->force_start
= 1;
15625 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15630 debug_method_add (w
, "same window start");
15633 /* Try to redisplay starting at same place as before.
15634 If point has not moved off frame, accept the results. */
15635 if (!current_matrix_up_to_date_p
15636 /* Don't use try_window_reusing_current_matrix in this case
15637 because a window scroll function can have changed the
15639 || !NILP (Vwindow_scroll_functions
)
15640 || MINI_WINDOW_P (w
)
15641 || !(used_current_matrix_p
15642 = try_window_reusing_current_matrix (w
)))
15644 IF_DEBUG (debug_method_add (w
, "1"));
15645 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15646 /* -1 means we need to scroll.
15647 0 means we need new matrices, but fonts_changed_p
15648 is set in that case, so we will detect it below. */
15649 goto try_to_scroll
;
15652 if (fonts_changed_p
)
15653 goto need_larger_matrices
;
15655 if (w
->cursor
.vpos
>= 0)
15657 if (!just_this_one_p
15658 || current_buffer
->clip_changed
15659 || BEG_UNCHANGED
< CHARPOS (startp
))
15660 /* Forget any recorded base line for line number display. */
15661 w
->base_line_number
= 0;
15663 if (!cursor_row_fully_visible_p (w
, 1, 0))
15665 clear_glyph_matrix (w
->desired_matrix
);
15666 last_line_misfit
= 1;
15668 /* Drop through and scroll. */
15673 clear_glyph_matrix (w
->desired_matrix
);
15678 w
->last_modified
= 0;
15679 w
->last_overlay_modified
= 0;
15681 /* Redisplay the mode line. Select the buffer properly for that. */
15682 if (!update_mode_line
)
15684 update_mode_line
= 1;
15685 w
->update_mode_line
= 1;
15688 /* Try to scroll by specified few lines. */
15689 if ((scroll_conservatively
15690 || emacs_scroll_step
15691 || temp_scroll_step
15692 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15693 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15694 && CHARPOS (startp
) >= BEGV
15695 && CHARPOS (startp
) <= ZV
)
15697 /* The function returns -1 if new fonts were loaded, 1 if
15698 successful, 0 if not successful. */
15699 int ss
= try_scrolling (window
, just_this_one_p
,
15700 scroll_conservatively
,
15702 temp_scroll_step
, last_line_misfit
);
15705 case SCROLLING_SUCCESS
:
15708 case SCROLLING_NEED_LARGER_MATRICES
:
15709 goto need_larger_matrices
;
15711 case SCROLLING_FAILED
:
15719 /* Finally, just choose a place to start which positions point
15720 according to user preferences. */
15725 debug_method_add (w
, "recenter");
15728 /* Forget any previously recorded base line for line number display. */
15729 if (!buffer_unchanged_p
)
15730 w
->base_line_number
= 0;
15732 /* Determine the window start relative to point. */
15733 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15734 it
.current_y
= it
.last_visible_y
;
15735 if (centering_position
< 0)
15739 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15741 ptrdiff_t margin_pos
= CHARPOS (startp
);
15742 Lisp_Object aggressive
;
15745 /* If there is a scroll margin at the top of the window, find
15746 its character position. */
15748 /* Cannot call start_display if startp is not in the
15749 accessible region of the buffer. This can happen when we
15750 have just switched to a different buffer and/or changed
15751 its restriction. In that case, startp is initialized to
15752 the character position 1 (BEGV) because we did not yet
15753 have chance to display the buffer even once. */
15754 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15757 void *it1data
= NULL
;
15759 SAVE_IT (it1
, it
, it1data
);
15760 start_display (&it1
, w
, startp
);
15761 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15762 margin_pos
= IT_CHARPOS (it1
);
15763 RESTORE_IT (&it
, &it
, it1data
);
15765 scrolling_up
= PT
> margin_pos
;
15768 ? BVAR (current_buffer
, scroll_up_aggressively
)
15769 : BVAR (current_buffer
, scroll_down_aggressively
);
15771 if (!MINI_WINDOW_P (w
)
15772 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15776 /* Setting scroll-conservatively overrides
15777 scroll-*-aggressively. */
15778 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15780 double float_amount
= XFLOATINT (aggressive
);
15782 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15783 if (pt_offset
== 0 && float_amount
> 0)
15785 if (pt_offset
&& margin
> 0)
15788 /* Compute how much to move the window start backward from
15789 point so that point will be displayed where the user
15793 centering_position
= it
.last_visible_y
;
15795 centering_position
-= pt_offset
;
15796 centering_position
-=
15797 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15798 + WINDOW_HEADER_LINE_HEIGHT (w
);
15799 /* Don't let point enter the scroll margin near top of
15801 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15802 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15805 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15808 /* Set the window start half the height of the window backward
15810 centering_position
= window_box_height (w
) / 2;
15812 move_it_vertically_backward (&it
, centering_position
);
15814 eassert (IT_CHARPOS (it
) >= BEGV
);
15816 /* The function move_it_vertically_backward may move over more
15817 than the specified y-distance. If it->w is small, e.g. a
15818 mini-buffer window, we may end up in front of the window's
15819 display area. Start displaying at the start of the line
15820 containing PT in this case. */
15821 if (it
.current_y
<= 0)
15823 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15824 move_it_vertically_backward (&it
, 0);
15828 it
.current_x
= it
.hpos
= 0;
15830 /* Set the window start position here explicitly, to avoid an
15831 infinite loop in case the functions in window-scroll-functions
15833 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15835 /* Run scroll hooks. */
15836 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15838 /* Redisplay the window. */
15839 if (!current_matrix_up_to_date_p
15840 || windows_or_buffers_changed
15841 || cursor_type_changed
15842 /* Don't use try_window_reusing_current_matrix in this case
15843 because it can have changed the buffer. */
15844 || !NILP (Vwindow_scroll_functions
)
15845 || !just_this_one_p
15846 || MINI_WINDOW_P (w
)
15847 || !(used_current_matrix_p
15848 = try_window_reusing_current_matrix (w
)))
15849 try_window (window
, startp
, 0);
15851 /* If new fonts have been loaded (due to fontsets), give up. We
15852 have to start a new redisplay since we need to re-adjust glyph
15854 if (fonts_changed_p
)
15855 goto need_larger_matrices
;
15857 /* If cursor did not appear assume that the middle of the window is
15858 in the first line of the window. Do it again with the next line.
15859 (Imagine a window of height 100, displaying two lines of height
15860 60. Moving back 50 from it->last_visible_y will end in the first
15862 if (w
->cursor
.vpos
< 0)
15864 if (w
->window_end_valid
&& PT
>= Z
- XFASTINT (w
->window_end_pos
))
15866 clear_glyph_matrix (w
->desired_matrix
);
15867 move_it_by_lines (&it
, 1);
15868 try_window (window
, it
.current
.pos
, 0);
15870 else if (PT
< IT_CHARPOS (it
))
15872 clear_glyph_matrix (w
->desired_matrix
);
15873 move_it_by_lines (&it
, -1);
15874 try_window (window
, it
.current
.pos
, 0);
15878 /* Not much we can do about it. */
15882 /* Consider the following case: Window starts at BEGV, there is
15883 invisible, intangible text at BEGV, so that display starts at
15884 some point START > BEGV. It can happen that we are called with
15885 PT somewhere between BEGV and START. Try to handle that case. */
15886 if (w
->cursor
.vpos
< 0)
15888 struct glyph_row
*row
= w
->current_matrix
->rows
;
15889 if (row
->mode_line_p
)
15891 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15894 if (!cursor_row_fully_visible_p (w
, 0, 0))
15896 /* If vscroll is enabled, disable it and try again. */
15900 clear_glyph_matrix (w
->desired_matrix
);
15904 /* Users who set scroll-conservatively to a large number want
15905 point just above/below the scroll margin. If we ended up
15906 with point's row partially visible, move the window start to
15907 make that row fully visible and out of the margin. */
15908 if (scroll_conservatively
> SCROLL_LIMIT
)
15912 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15914 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
15916 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
15917 clear_glyph_matrix (w
->desired_matrix
);
15918 if (1 == try_window (window
, it
.current
.pos
,
15919 TRY_WINDOW_CHECK_MARGINS
))
15923 /* If centering point failed to make the whole line visible,
15924 put point at the top instead. That has to make the whole line
15925 visible, if it can be done. */
15926 if (centering_position
== 0)
15929 clear_glyph_matrix (w
->desired_matrix
);
15930 centering_position
= 0;
15936 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15937 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
15938 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
15940 /* Display the mode line, if we must. */
15941 if ((update_mode_line
15942 /* If window not full width, must redo its mode line
15943 if (a) the window to its side is being redone and
15944 (b) we do a frame-based redisplay. This is a consequence
15945 of how inverted lines are drawn in frame-based redisplay. */
15946 || (!just_this_one_p
15947 && !FRAME_WINDOW_P (f
)
15948 && !WINDOW_FULL_WIDTH_P (w
))
15949 /* Line number to display. */
15950 || w
->base_line_pos
> 0
15951 /* Column number is displayed and different from the one displayed. */
15952 || (w
->column_number_displayed
!= -1
15953 && (w
->column_number_displayed
!= current_column ())))
15954 /* This means that the window has a mode line. */
15955 && (WINDOW_WANTS_MODELINE_P (w
)
15956 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15958 display_mode_lines (w
);
15960 /* If mode line height has changed, arrange for a thorough
15961 immediate redisplay using the correct mode line height. */
15962 if (WINDOW_WANTS_MODELINE_P (w
)
15963 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15965 fonts_changed_p
= 1;
15966 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15967 = DESIRED_MODE_LINE_HEIGHT (w
);
15970 /* If header line height has changed, arrange for a thorough
15971 immediate redisplay using the correct header line height. */
15972 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15973 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15975 fonts_changed_p
= 1;
15976 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15977 = DESIRED_HEADER_LINE_HEIGHT (w
);
15980 if (fonts_changed_p
)
15981 goto need_larger_matrices
;
15984 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
15986 w
->base_line_pos
= 0;
15987 w
->base_line_number
= 0;
15992 /* When we reach a frame's selected window, redo the frame's menu bar. */
15993 if (update_mode_line
15994 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15996 int redisplay_menu_p
= 0;
15998 if (FRAME_WINDOW_P (f
))
16000 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16001 || defined (HAVE_NS) || defined (USE_GTK)
16002 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16004 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16008 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16010 if (redisplay_menu_p
)
16011 display_menu_bar (w
);
16013 #ifdef HAVE_WINDOW_SYSTEM
16014 if (FRAME_WINDOW_P (f
))
16016 #if defined (USE_GTK) || defined (HAVE_NS)
16017 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16018 redisplay_tool_bar (f
);
16020 if (WINDOWP (f
->tool_bar_window
)
16021 && (FRAME_TOOL_BAR_LINES (f
) > 0
16022 || !NILP (Vauto_resize_tool_bars
))
16023 && redisplay_tool_bar (f
))
16024 ignore_mouse_drag_p
= 1;
16030 #ifdef HAVE_WINDOW_SYSTEM
16031 if (FRAME_WINDOW_P (f
)
16032 && update_window_fringes (w
, (just_this_one_p
16033 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16034 || w
->pseudo_window_p
)))
16038 if (draw_window_fringes (w
, 1))
16039 x_draw_vertical_border (w
);
16043 #endif /* HAVE_WINDOW_SYSTEM */
16045 /* We go to this label, with fonts_changed_p set,
16046 if it is necessary to try again using larger glyph matrices.
16047 We have to redeem the scroll bar even in this case,
16048 because the loop in redisplay_internal expects that. */
16049 need_larger_matrices
:
16051 finish_scroll_bars
:
16053 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16055 /* Set the thumb's position and size. */
16056 set_vertical_scroll_bar (w
);
16058 /* Note that we actually used the scroll bar attached to this
16059 window, so it shouldn't be deleted at the end of redisplay. */
16060 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16061 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16064 /* Restore current_buffer and value of point in it. The window
16065 update may have changed the buffer, so first make sure `opoint'
16066 is still valid (Bug#6177). */
16067 if (CHARPOS (opoint
) < BEGV
)
16068 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16069 else if (CHARPOS (opoint
) > ZV
)
16070 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16072 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16074 set_buffer_internal_1 (old
);
16075 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16076 shorter. This can be caused by log truncation in *Messages*. */
16077 if (CHARPOS (lpoint
) <= ZV
)
16078 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16080 unbind_to (count
, Qnil
);
16084 /* Build the complete desired matrix of WINDOW with a window start
16085 buffer position POS.
16087 Value is 1 if successful. It is zero if fonts were loaded during
16088 redisplay which makes re-adjusting glyph matrices necessary, and -1
16089 if point would appear in the scroll margins.
16090 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16091 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16095 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16097 struct window
*w
= XWINDOW (window
);
16099 struct glyph_row
*last_text_row
= NULL
;
16100 struct frame
*f
= XFRAME (w
->frame
);
16102 /* Make POS the new window start. */
16103 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16105 /* Mark cursor position as unknown. No overlay arrow seen. */
16106 w
->cursor
.vpos
= -1;
16107 overlay_arrow_seen
= 0;
16109 /* Initialize iterator and info to start at POS. */
16110 start_display (&it
, w
, pos
);
16112 /* Display all lines of W. */
16113 while (it
.current_y
< it
.last_visible_y
)
16115 if (display_line (&it
))
16116 last_text_row
= it
.glyph_row
- 1;
16117 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16121 /* Don't let the cursor end in the scroll margins. */
16122 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16123 && !MINI_WINDOW_P (w
))
16125 int this_scroll_margin
;
16127 if (scroll_margin
> 0)
16129 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16130 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16133 this_scroll_margin
= 0;
16135 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16136 && w
->cursor
.y
< this_scroll_margin
16137 && CHARPOS (pos
) > BEGV
16138 && IT_CHARPOS (it
) < ZV
)
16139 /* rms: considering make_cursor_line_fully_visible_p here
16140 seems to give wrong results. We don't want to recenter
16141 when the last line is partly visible, we want to allow
16142 that case to be handled in the usual way. */
16143 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16145 w
->cursor
.vpos
= -1;
16146 clear_glyph_matrix (w
->desired_matrix
);
16151 /* If bottom moved off end of frame, change mode line percentage. */
16152 if (XFASTINT (w
->window_end_pos
) <= 0
16153 && Z
!= IT_CHARPOS (it
))
16154 w
->update_mode_line
= 1;
16156 /* Set window_end_pos to the offset of the last character displayed
16157 on the window from the end of current_buffer. Set
16158 window_end_vpos to its row number. */
16161 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16162 w
->window_end_bytepos
16163 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16164 wset_window_end_pos
16165 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16166 wset_window_end_vpos
16167 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
)));
16169 (MATRIX_ROW (w
->desired_matrix
,
16170 XFASTINT (w
->window_end_vpos
))->displays_text_p
);
16174 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16175 wset_window_end_pos (w
, make_number (Z
- ZV
));
16176 wset_window_end_vpos (w
, make_number (0));
16179 /* But that is not valid info until redisplay finishes. */
16180 w
->window_end_valid
= 0;
16186 /************************************************************************
16187 Window redisplay reusing current matrix when buffer has not changed
16188 ************************************************************************/
16190 /* Try redisplay of window W showing an unchanged buffer with a
16191 different window start than the last time it was displayed by
16192 reusing its current matrix. Value is non-zero if successful.
16193 W->start is the new window start. */
16196 try_window_reusing_current_matrix (struct window
*w
)
16198 struct frame
*f
= XFRAME (w
->frame
);
16199 struct glyph_row
*bottom_row
;
16202 struct text_pos start
, new_start
;
16203 int nrows_scrolled
, i
;
16204 struct glyph_row
*last_text_row
;
16205 struct glyph_row
*last_reused_text_row
;
16206 struct glyph_row
*start_row
;
16207 int start_vpos
, min_y
, max_y
;
16210 if (inhibit_try_window_reusing
)
16214 if (/* This function doesn't handle terminal frames. */
16215 !FRAME_WINDOW_P (f
)
16216 /* Don't try to reuse the display if windows have been split
16218 || windows_or_buffers_changed
16219 || cursor_type_changed
)
16222 /* Can't do this if region may have changed. */
16223 if (0 <= markpos_of_region ()
16224 || w
->region_showing
16225 || !NILP (Vshow_trailing_whitespace
))
16228 /* If top-line visibility has changed, give up. */
16229 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16230 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16233 /* Give up if old or new display is scrolled vertically. We could
16234 make this function handle this, but right now it doesn't. */
16235 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16236 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16239 /* The variable new_start now holds the new window start. The old
16240 start `start' can be determined from the current matrix. */
16241 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16242 start
= start_row
->minpos
;
16243 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16245 /* Clear the desired matrix for the display below. */
16246 clear_glyph_matrix (w
->desired_matrix
);
16248 if (CHARPOS (new_start
) <= CHARPOS (start
))
16250 /* Don't use this method if the display starts with an ellipsis
16251 displayed for invisible text. It's not easy to handle that case
16252 below, and it's certainly not worth the effort since this is
16253 not a frequent case. */
16254 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16257 IF_DEBUG (debug_method_add (w
, "twu1"));
16259 /* Display up to a row that can be reused. The variable
16260 last_text_row is set to the last row displayed that displays
16261 text. Note that it.vpos == 0 if or if not there is a
16262 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16263 start_display (&it
, w
, new_start
);
16264 w
->cursor
.vpos
= -1;
16265 last_text_row
= last_reused_text_row
= NULL
;
16267 while (it
.current_y
< it
.last_visible_y
16268 && !fonts_changed_p
)
16270 /* If we have reached into the characters in the START row,
16271 that means the line boundaries have changed. So we
16272 can't start copying with the row START. Maybe it will
16273 work to start copying with the following row. */
16274 while (IT_CHARPOS (it
) > CHARPOS (start
))
16276 /* Advance to the next row as the "start". */
16278 start
= start_row
->minpos
;
16279 /* If there are no more rows to try, or just one, give up. */
16280 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16281 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16282 || CHARPOS (start
) == ZV
)
16284 clear_glyph_matrix (w
->desired_matrix
);
16288 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16290 /* If we have reached alignment, we can copy the rest of the
16292 if (IT_CHARPOS (it
) == CHARPOS (start
)
16293 /* Don't accept "alignment" inside a display vector,
16294 since start_row could have started in the middle of
16295 that same display vector (thus their character
16296 positions match), and we have no way of telling if
16297 that is the case. */
16298 && it
.current
.dpvec_index
< 0)
16301 if (display_line (&it
))
16302 last_text_row
= it
.glyph_row
- 1;
16306 /* A value of current_y < last_visible_y means that we stopped
16307 at the previous window start, which in turn means that we
16308 have at least one reusable row. */
16309 if (it
.current_y
< it
.last_visible_y
)
16311 struct glyph_row
*row
;
16313 /* IT.vpos always starts from 0; it counts text lines. */
16314 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16316 /* Find PT if not already found in the lines displayed. */
16317 if (w
->cursor
.vpos
< 0)
16319 int dy
= it
.current_y
- start_row
->y
;
16321 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16322 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16324 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16325 dy
, nrows_scrolled
);
16328 clear_glyph_matrix (w
->desired_matrix
);
16333 /* Scroll the display. Do it before the current matrix is
16334 changed. The problem here is that update has not yet
16335 run, i.e. part of the current matrix is not up to date.
16336 scroll_run_hook will clear the cursor, and use the
16337 current matrix to get the height of the row the cursor is
16339 run
.current_y
= start_row
->y
;
16340 run
.desired_y
= it
.current_y
;
16341 run
.height
= it
.last_visible_y
- it
.current_y
;
16343 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16346 FRAME_RIF (f
)->update_window_begin_hook (w
);
16347 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16348 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16349 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16353 /* Shift current matrix down by nrows_scrolled lines. */
16354 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16355 rotate_matrix (w
->current_matrix
,
16357 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16360 /* Disable lines that must be updated. */
16361 for (i
= 0; i
< nrows_scrolled
; ++i
)
16362 (start_row
+ i
)->enabled_p
= 0;
16364 /* Re-compute Y positions. */
16365 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16366 max_y
= it
.last_visible_y
;
16367 for (row
= start_row
+ nrows_scrolled
;
16371 row
->y
= it
.current_y
;
16372 row
->visible_height
= row
->height
;
16374 if (row
->y
< min_y
)
16375 row
->visible_height
-= min_y
- row
->y
;
16376 if (row
->y
+ row
->height
> max_y
)
16377 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16378 if (row
->fringe_bitmap_periodic_p
)
16379 row
->redraw_fringe_bitmaps_p
= 1;
16381 it
.current_y
+= row
->height
;
16383 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16384 last_reused_text_row
= row
;
16385 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16389 /* Disable lines in the current matrix which are now
16390 below the window. */
16391 for (++row
; row
< bottom_row
; ++row
)
16392 row
->enabled_p
= row
->mode_line_p
= 0;
16395 /* Update window_end_pos etc.; last_reused_text_row is the last
16396 reused row from the current matrix containing text, if any.
16397 The value of last_text_row is the last displayed line
16398 containing text. */
16399 if (last_reused_text_row
)
16401 w
->window_end_bytepos
16402 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16403 wset_window_end_pos
16405 - MATRIX_ROW_END_CHARPOS (last_reused_text_row
)));
16406 wset_window_end_vpos
16407 (w
, make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16408 w
->current_matrix
)));
16410 else if (last_text_row
)
16412 w
->window_end_bytepos
16413 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16414 wset_window_end_pos
16415 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16416 wset_window_end_vpos
16417 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16418 w
->desired_matrix
)));
16422 /* This window must be completely empty. */
16423 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16424 wset_window_end_pos (w
, make_number (Z
- ZV
));
16425 wset_window_end_vpos (w
, make_number (0));
16427 w
->window_end_valid
= 0;
16429 /* Update hint: don't try scrolling again in update_window. */
16430 w
->desired_matrix
->no_scrolling_p
= 1;
16433 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16437 else if (CHARPOS (new_start
) > CHARPOS (start
))
16439 struct glyph_row
*pt_row
, *row
;
16440 struct glyph_row
*first_reusable_row
;
16441 struct glyph_row
*first_row_to_display
;
16443 int yb
= window_text_bottom_y (w
);
16445 /* Find the row starting at new_start, if there is one. Don't
16446 reuse a partially visible line at the end. */
16447 first_reusable_row
= start_row
;
16448 while (first_reusable_row
->enabled_p
16449 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16450 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16451 < CHARPOS (new_start
)))
16452 ++first_reusable_row
;
16454 /* Give up if there is no row to reuse. */
16455 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16456 || !first_reusable_row
->enabled_p
16457 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16458 != CHARPOS (new_start
)))
16461 /* We can reuse fully visible rows beginning with
16462 first_reusable_row to the end of the window. Set
16463 first_row_to_display to the first row that cannot be reused.
16464 Set pt_row to the row containing point, if there is any. */
16466 for (first_row_to_display
= first_reusable_row
;
16467 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16468 ++first_row_to_display
)
16470 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16471 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16472 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16473 && first_row_to_display
->ends_at_zv_p
16474 && pt_row
== NULL
)))
16475 pt_row
= first_row_to_display
;
16478 /* Start displaying at the start of first_row_to_display. */
16479 eassert (first_row_to_display
->y
< yb
);
16480 init_to_row_start (&it
, w
, first_row_to_display
);
16482 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16484 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16486 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16487 + WINDOW_HEADER_LINE_HEIGHT (w
));
16489 /* Display lines beginning with first_row_to_display in the
16490 desired matrix. Set last_text_row to the last row displayed
16491 that displays text. */
16492 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16493 if (pt_row
== NULL
)
16494 w
->cursor
.vpos
= -1;
16495 last_text_row
= NULL
;
16496 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16497 if (display_line (&it
))
16498 last_text_row
= it
.glyph_row
- 1;
16500 /* If point is in a reused row, adjust y and vpos of the cursor
16504 w
->cursor
.vpos
-= nrows_scrolled
;
16505 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16508 /* Give up if point isn't in a row displayed or reused. (This
16509 also handles the case where w->cursor.vpos < nrows_scrolled
16510 after the calls to display_line, which can happen with scroll
16511 margins. See bug#1295.) */
16512 if (w
->cursor
.vpos
< 0)
16514 clear_glyph_matrix (w
->desired_matrix
);
16518 /* Scroll the display. */
16519 run
.current_y
= first_reusable_row
->y
;
16520 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16521 run
.height
= it
.last_visible_y
- run
.current_y
;
16522 dy
= run
.current_y
- run
.desired_y
;
16527 FRAME_RIF (f
)->update_window_begin_hook (w
);
16528 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16529 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16530 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16534 /* Adjust Y positions of reused rows. */
16535 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16536 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16537 max_y
= it
.last_visible_y
;
16538 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16541 row
->visible_height
= row
->height
;
16542 if (row
->y
< min_y
)
16543 row
->visible_height
-= min_y
- row
->y
;
16544 if (row
->y
+ row
->height
> max_y
)
16545 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16546 if (row
->fringe_bitmap_periodic_p
)
16547 row
->redraw_fringe_bitmaps_p
= 1;
16550 /* Scroll the current matrix. */
16551 eassert (nrows_scrolled
> 0);
16552 rotate_matrix (w
->current_matrix
,
16554 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16557 /* Disable rows not reused. */
16558 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16559 row
->enabled_p
= 0;
16561 /* Point may have moved to a different line, so we cannot assume that
16562 the previous cursor position is valid; locate the correct row. */
16565 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16567 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16568 && !row
->ends_at_zv_p
;
16572 w
->cursor
.y
= row
->y
;
16574 if (row
< bottom_row
)
16576 /* Can't simply scan the row for point with
16577 bidi-reordered glyph rows. Let set_cursor_from_row
16578 figure out where to put the cursor, and if it fails,
16580 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16582 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
16585 clear_glyph_matrix (w
->desired_matrix
);
16591 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16592 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16595 && (!BUFFERP (glyph
->object
)
16596 || glyph
->charpos
< PT
);
16600 w
->cursor
.x
+= glyph
->pixel_width
;
16606 /* Adjust window end. A null value of last_text_row means that
16607 the window end is in reused rows which in turn means that
16608 only its vpos can have changed. */
16611 w
->window_end_bytepos
16612 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16613 wset_window_end_pos
16614 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16615 wset_window_end_vpos
16616 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16617 w
->desired_matrix
)));
16621 wset_window_end_vpos
16622 (w
, make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
));
16625 w
->window_end_valid
= 0;
16626 w
->desired_matrix
->no_scrolling_p
= 1;
16629 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16639 /************************************************************************
16640 Window redisplay reusing current matrix when buffer has changed
16641 ************************************************************************/
16643 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16644 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16645 ptrdiff_t *, ptrdiff_t *);
16646 static struct glyph_row
*
16647 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16648 struct glyph_row
*);
16651 /* Return the last row in MATRIX displaying text. If row START is
16652 non-null, start searching with that row. IT gives the dimensions
16653 of the display. Value is null if matrix is empty; otherwise it is
16654 a pointer to the row found. */
16656 static struct glyph_row
*
16657 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16658 struct glyph_row
*start
)
16660 struct glyph_row
*row
, *row_found
;
16662 /* Set row_found to the last row in IT->w's current matrix
16663 displaying text. The loop looks funny but think of partially
16666 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16667 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16669 eassert (row
->enabled_p
);
16671 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16680 /* Return the last row in the current matrix of W that is not affected
16681 by changes at the start of current_buffer that occurred since W's
16682 current matrix was built. Value is null if no such row exists.
16684 BEG_UNCHANGED us the number of characters unchanged at the start of
16685 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16686 first changed character in current_buffer. Characters at positions <
16687 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16688 when the current matrix was built. */
16690 static struct glyph_row
*
16691 find_last_unchanged_at_beg_row (struct window
*w
)
16693 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16694 struct glyph_row
*row
;
16695 struct glyph_row
*row_found
= NULL
;
16696 int yb
= window_text_bottom_y (w
);
16698 /* Find the last row displaying unchanged text. */
16699 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16700 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16701 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16704 if (/* If row ends before first_changed_pos, it is unchanged,
16705 except in some case. */
16706 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16707 /* When row ends in ZV and we write at ZV it is not
16709 && !row
->ends_at_zv_p
16710 /* When first_changed_pos is the end of a continued line,
16711 row is not unchanged because it may be no longer
16713 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16714 && (row
->continued_p
16715 || row
->exact_window_width_line_p
))
16716 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16717 needs to be recomputed, so don't consider this row as
16718 unchanged. This happens when the last line was
16719 bidi-reordered and was killed immediately before this
16720 redisplay cycle. In that case, ROW->end stores the
16721 buffer position of the first visual-order character of
16722 the killed text, which is now beyond ZV. */
16723 && CHARPOS (row
->end
.pos
) <= ZV
)
16726 /* Stop if last visible row. */
16727 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16735 /* Find the first glyph row in the current matrix of W that is not
16736 affected by changes at the end of current_buffer since the
16737 time W's current matrix was built.
16739 Return in *DELTA the number of chars by which buffer positions in
16740 unchanged text at the end of current_buffer must be adjusted.
16742 Return in *DELTA_BYTES the corresponding number of bytes.
16744 Value is null if no such row exists, i.e. all rows are affected by
16747 static struct glyph_row
*
16748 find_first_unchanged_at_end_row (struct window
*w
,
16749 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16751 struct glyph_row
*row
;
16752 struct glyph_row
*row_found
= NULL
;
16754 *delta
= *delta_bytes
= 0;
16756 /* Display must not have been paused, otherwise the current matrix
16757 is not up to date. */
16758 eassert (w
->window_end_valid
);
16760 /* A value of window_end_pos >= END_UNCHANGED means that the window
16761 end is in the range of changed text. If so, there is no
16762 unchanged row at the end of W's current matrix. */
16763 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16766 /* Set row to the last row in W's current matrix displaying text. */
16767 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16769 /* If matrix is entirely empty, no unchanged row exists. */
16770 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16772 /* The value of row is the last glyph row in the matrix having a
16773 meaningful buffer position in it. The end position of row
16774 corresponds to window_end_pos. This allows us to translate
16775 buffer positions in the current matrix to current buffer
16776 positions for characters not in changed text. */
16778 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16779 ptrdiff_t Z_BYTE_old
=
16780 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16781 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
16782 struct glyph_row
*first_text_row
16783 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16785 *delta
= Z
- Z_old
;
16786 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16788 /* Set last_unchanged_pos to the buffer position of the last
16789 character in the buffer that has not been changed. Z is the
16790 index + 1 of the last character in current_buffer, i.e. by
16791 subtracting END_UNCHANGED we get the index of the last
16792 unchanged character, and we have to add BEG to get its buffer
16794 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16795 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16797 /* Search backward from ROW for a row displaying a line that
16798 starts at a minimum position >= last_unchanged_pos_old. */
16799 for (; row
> first_text_row
; --row
)
16801 /* This used to abort, but it can happen.
16802 It is ok to just stop the search instead here. KFS. */
16803 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16806 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16811 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16817 /* Make sure that glyph rows in the current matrix of window W
16818 reference the same glyph memory as corresponding rows in the
16819 frame's frame matrix. This function is called after scrolling W's
16820 current matrix on a terminal frame in try_window_id and
16821 try_window_reusing_current_matrix. */
16824 sync_frame_with_window_matrix_rows (struct window
*w
)
16826 struct frame
*f
= XFRAME (w
->frame
);
16827 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16829 /* Preconditions: W must be a leaf window and full-width. Its frame
16830 must have a frame matrix. */
16831 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16832 eassert (WINDOW_FULL_WIDTH_P (w
));
16833 eassert (!FRAME_WINDOW_P (f
));
16835 /* If W is a full-width window, glyph pointers in W's current matrix
16836 have, by definition, to be the same as glyph pointers in the
16837 corresponding frame matrix. Note that frame matrices have no
16838 marginal areas (see build_frame_matrix). */
16839 window_row
= w
->current_matrix
->rows
;
16840 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16841 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16842 while (window_row
< window_row_end
)
16844 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16845 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16847 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16848 frame_row
->glyphs
[TEXT_AREA
] = start
;
16849 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16850 frame_row
->glyphs
[LAST_AREA
] = end
;
16852 /* Disable frame rows whose corresponding window rows have
16853 been disabled in try_window_id. */
16854 if (!window_row
->enabled_p
)
16855 frame_row
->enabled_p
= 0;
16857 ++window_row
, ++frame_row
;
16862 /* Find the glyph row in window W containing CHARPOS. Consider all
16863 rows between START and END (not inclusive). END null means search
16864 all rows to the end of the display area of W. Value is the row
16865 containing CHARPOS or null. */
16868 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
16869 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16871 struct glyph_row
*row
= start
;
16872 struct glyph_row
*best_row
= NULL
;
16873 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16876 /* If we happen to start on a header-line, skip that. */
16877 if (row
->mode_line_p
)
16880 if ((end
&& row
>= end
) || !row
->enabled_p
)
16883 last_y
= window_text_bottom_y (w
) - dy
;
16887 /* Give up if we have gone too far. */
16888 if (end
&& row
>= end
)
16890 /* This formerly returned if they were equal.
16891 I think that both quantities are of a "last plus one" type;
16892 if so, when they are equal, the row is within the screen. -- rms. */
16893 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16896 /* If it is in this row, return this row. */
16897 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16898 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16899 /* The end position of a row equals the start
16900 position of the next row. If CHARPOS is there, we
16901 would rather display it in the next line, except
16902 when this line ends in ZV. */
16903 && !row
->ends_at_zv_p
16904 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16905 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16909 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16910 || (!best_row
&& !row
->continued_p
))
16912 /* In bidi-reordered rows, there could be several rows
16913 occluding point, all of them belonging to the same
16914 continued line. We need to find the row which fits
16915 CHARPOS the best. */
16916 for (g
= row
->glyphs
[TEXT_AREA
];
16917 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16920 if (!STRINGP (g
->object
))
16922 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16924 mindif
= eabs (g
->charpos
- charpos
);
16926 /* Exact match always wins. */
16933 else if (best_row
&& !row
->continued_p
)
16940 /* Try to redisplay window W by reusing its existing display. W's
16941 current matrix must be up to date when this function is called,
16942 i.e. window_end_valid must be nonzero.
16946 1 if display has been updated
16947 0 if otherwise unsuccessful
16948 -1 if redisplay with same window start is known not to succeed
16950 The following steps are performed:
16952 1. Find the last row in the current matrix of W that is not
16953 affected by changes at the start of current_buffer. If no such row
16956 2. Find the first row in W's current matrix that is not affected by
16957 changes at the end of current_buffer. Maybe there is no such row.
16959 3. Display lines beginning with the row + 1 found in step 1 to the
16960 row found in step 2 or, if step 2 didn't find a row, to the end of
16963 4. If cursor is not known to appear on the window, give up.
16965 5. If display stopped at the row found in step 2, scroll the
16966 display and current matrix as needed.
16968 6. Maybe display some lines at the end of W, if we must. This can
16969 happen under various circumstances, like a partially visible line
16970 becoming fully visible, or because newly displayed lines are displayed
16971 in smaller font sizes.
16973 7. Update W's window end information. */
16976 try_window_id (struct window
*w
)
16978 struct frame
*f
= XFRAME (w
->frame
);
16979 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16980 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16981 struct glyph_row
*last_unchanged_at_beg_row
;
16982 struct glyph_row
*first_unchanged_at_end_row
;
16983 struct glyph_row
*row
;
16984 struct glyph_row
*bottom_row
;
16987 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
16989 struct text_pos start_pos
;
16991 int first_unchanged_at_end_vpos
= 0;
16992 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16993 struct text_pos start
;
16994 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
16997 if (inhibit_try_window_id
)
17001 /* This is handy for debugging. */
17003 #define GIVE_UP(X) \
17005 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17009 #define GIVE_UP(X) return 0
17012 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17014 /* Don't use this for mini-windows because these can show
17015 messages and mini-buffers, and we don't handle that here. */
17016 if (MINI_WINDOW_P (w
))
17019 /* This flag is used to prevent redisplay optimizations. */
17020 if (windows_or_buffers_changed
|| cursor_type_changed
)
17023 /* Verify that narrowing has not changed.
17024 Also verify that we were not told to prevent redisplay optimizations.
17025 It would be nice to further
17026 reduce the number of cases where this prevents try_window_id. */
17027 if (current_buffer
->clip_changed
17028 || current_buffer
->prevent_redisplay_optimizations_p
)
17031 /* Window must either use window-based redisplay or be full width. */
17032 if (!FRAME_WINDOW_P (f
)
17033 && (!FRAME_LINE_INS_DEL_OK (f
)
17034 || !WINDOW_FULL_WIDTH_P (w
)))
17037 /* Give up if point is known NOT to appear in W. */
17038 if (PT
< CHARPOS (start
))
17041 /* Another way to prevent redisplay optimizations. */
17042 if (w
->last_modified
== 0)
17045 /* Verify that window is not hscrolled. */
17046 if (w
->hscroll
!= 0)
17049 /* Verify that display wasn't paused. */
17050 if (!w
->window_end_valid
)
17053 /* Can't use this if highlighting a region because a cursor movement
17054 will do more than just set the cursor. */
17055 if (0 <= markpos_of_region ())
17058 /* Likewise if highlighting trailing whitespace. */
17059 if (!NILP (Vshow_trailing_whitespace
))
17062 /* Likewise if showing a region. */
17063 if (w
->region_showing
)
17066 /* Can't use this if overlay arrow position and/or string have
17068 if (overlay_arrows_changed_p ())
17071 /* When word-wrap is on, adding a space to the first word of a
17072 wrapped line can change the wrap position, altering the line
17073 above it. It might be worthwhile to handle this more
17074 intelligently, but for now just redisplay from scratch. */
17075 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
17078 /* Under bidi reordering, adding or deleting a character in the
17079 beginning of a paragraph, before the first strong directional
17080 character, can change the base direction of the paragraph (unless
17081 the buffer specifies a fixed paragraph direction), which will
17082 require to redisplay the whole paragraph. It might be worthwhile
17083 to find the paragraph limits and widen the range of redisplayed
17084 lines to that, but for now just give up this optimization and
17085 redisplay from scratch. */
17086 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17087 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
17090 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17091 only if buffer has really changed. The reason is that the gap is
17092 initially at Z for freshly visited files. The code below would
17093 set end_unchanged to 0 in that case. */
17094 if (MODIFF
> SAVE_MODIFF
17095 /* This seems to happen sometimes after saving a buffer. */
17096 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17098 if (GPT
- BEG
< BEG_UNCHANGED
)
17099 BEG_UNCHANGED
= GPT
- BEG
;
17100 if (Z
- GPT
< END_UNCHANGED
)
17101 END_UNCHANGED
= Z
- GPT
;
17104 /* The position of the first and last character that has been changed. */
17105 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17106 last_changed_charpos
= Z
- END_UNCHANGED
;
17108 /* If window starts after a line end, and the last change is in
17109 front of that newline, then changes don't affect the display.
17110 This case happens with stealth-fontification. Note that although
17111 the display is unchanged, glyph positions in the matrix have to
17112 be adjusted, of course. */
17113 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17114 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17115 && ((last_changed_charpos
< CHARPOS (start
)
17116 && CHARPOS (start
) == BEGV
)
17117 || (last_changed_charpos
< CHARPOS (start
) - 1
17118 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17120 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17121 struct glyph_row
*r0
;
17123 /* Compute how many chars/bytes have been added to or removed
17124 from the buffer. */
17125 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17126 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17127 Z_delta
= Z
- Z_old
;
17128 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17130 /* Give up if PT is not in the window. Note that it already has
17131 been checked at the start of try_window_id that PT is not in
17132 front of the window start. */
17133 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17136 /* If window start is unchanged, we can reuse the whole matrix
17137 as is, after adjusting glyph positions. No need to compute
17138 the window end again, since its offset from Z hasn't changed. */
17139 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17140 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17141 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17142 /* PT must not be in a partially visible line. */
17143 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17144 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17146 /* Adjust positions in the glyph matrix. */
17147 if (Z_delta
|| Z_delta_bytes
)
17149 struct glyph_row
*r1
17150 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17151 increment_matrix_positions (w
->current_matrix
,
17152 MATRIX_ROW_VPOS (r0
, current_matrix
),
17153 MATRIX_ROW_VPOS (r1
, current_matrix
),
17154 Z_delta
, Z_delta_bytes
);
17157 /* Set the cursor. */
17158 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17160 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17167 /* Handle the case that changes are all below what is displayed in
17168 the window, and that PT is in the window. This shortcut cannot
17169 be taken if ZV is visible in the window, and text has been added
17170 there that is visible in the window. */
17171 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17172 /* ZV is not visible in the window, or there are no
17173 changes at ZV, actually. */
17174 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17175 || first_changed_charpos
== last_changed_charpos
))
17177 struct glyph_row
*r0
;
17179 /* Give up if PT is not in the window. Note that it already has
17180 been checked at the start of try_window_id that PT is not in
17181 front of the window start. */
17182 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17185 /* If window start is unchanged, we can reuse the whole matrix
17186 as is, without changing glyph positions since no text has
17187 been added/removed in front of the window end. */
17188 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17189 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17190 /* PT must not be in a partially visible line. */
17191 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17192 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17194 /* We have to compute the window end anew since text
17195 could have been added/removed after it. */
17196 wset_window_end_pos
17197 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17198 w
->window_end_bytepos
17199 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17201 /* Set the cursor. */
17202 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17204 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17211 /* Give up if window start is in the changed area.
17213 The condition used to read
17215 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17217 but why that was tested escapes me at the moment. */
17218 if (CHARPOS (start
) >= first_changed_charpos
17219 && CHARPOS (start
) <= last_changed_charpos
)
17222 /* Check that window start agrees with the start of the first glyph
17223 row in its current matrix. Check this after we know the window
17224 start is not in changed text, otherwise positions would not be
17226 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17227 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17230 /* Give up if the window ends in strings. Overlay strings
17231 at the end are difficult to handle, so don't try. */
17232 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17233 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17236 /* Compute the position at which we have to start displaying new
17237 lines. Some of the lines at the top of the window might be
17238 reusable because they are not displaying changed text. Find the
17239 last row in W's current matrix not affected by changes at the
17240 start of current_buffer. Value is null if changes start in the
17241 first line of window. */
17242 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17243 if (last_unchanged_at_beg_row
)
17245 /* Avoid starting to display in the middle of a character, a TAB
17246 for instance. This is easier than to set up the iterator
17247 exactly, and it's not a frequent case, so the additional
17248 effort wouldn't really pay off. */
17249 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17250 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17251 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17252 --last_unchanged_at_beg_row
;
17254 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17257 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17259 start_pos
= it
.current
.pos
;
17261 /* Start displaying new lines in the desired matrix at the same
17262 vpos we would use in the current matrix, i.e. below
17263 last_unchanged_at_beg_row. */
17264 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17266 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17267 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17269 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17273 /* There are no reusable lines at the start of the window.
17274 Start displaying in the first text line. */
17275 start_display (&it
, w
, start
);
17276 it
.vpos
= it
.first_vpos
;
17277 start_pos
= it
.current
.pos
;
17280 /* Find the first row that is not affected by changes at the end of
17281 the buffer. Value will be null if there is no unchanged row, in
17282 which case we must redisplay to the end of the window. delta
17283 will be set to the value by which buffer positions beginning with
17284 first_unchanged_at_end_row have to be adjusted due to text
17286 first_unchanged_at_end_row
17287 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17288 IF_DEBUG (debug_delta
= delta
);
17289 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17291 /* Set stop_pos to the buffer position up to which we will have to
17292 display new lines. If first_unchanged_at_end_row != NULL, this
17293 is the buffer position of the start of the line displayed in that
17294 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17295 that we don't stop at a buffer position. */
17297 if (first_unchanged_at_end_row
)
17299 eassert (last_unchanged_at_beg_row
== NULL
17300 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17302 /* If this is a continuation line, move forward to the next one
17303 that isn't. Changes in lines above affect this line.
17304 Caution: this may move first_unchanged_at_end_row to a row
17305 not displaying text. */
17306 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17307 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17308 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17309 < it
.last_visible_y
))
17310 ++first_unchanged_at_end_row
;
17312 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17313 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17314 >= it
.last_visible_y
))
17315 first_unchanged_at_end_row
= NULL
;
17318 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17320 first_unchanged_at_end_vpos
17321 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17322 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17325 else if (last_unchanged_at_beg_row
== NULL
)
17331 /* Either there is no unchanged row at the end, or the one we have
17332 now displays text. This is a necessary condition for the window
17333 end pos calculation at the end of this function. */
17334 eassert (first_unchanged_at_end_row
== NULL
17335 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17337 debug_last_unchanged_at_beg_vpos
17338 = (last_unchanged_at_beg_row
17339 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17341 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17343 #endif /* GLYPH_DEBUG */
17346 /* Display new lines. Set last_text_row to the last new line
17347 displayed which has text on it, i.e. might end up as being the
17348 line where the window_end_vpos is. */
17349 w
->cursor
.vpos
= -1;
17350 last_text_row
= NULL
;
17351 overlay_arrow_seen
= 0;
17352 while (it
.current_y
< it
.last_visible_y
17353 && !fonts_changed_p
17354 && (first_unchanged_at_end_row
== NULL
17355 || IT_CHARPOS (it
) < stop_pos
))
17357 if (display_line (&it
))
17358 last_text_row
= it
.glyph_row
- 1;
17361 if (fonts_changed_p
)
17365 /* Compute differences in buffer positions, y-positions etc. for
17366 lines reused at the bottom of the window. Compute what we can
17368 if (first_unchanged_at_end_row
17369 /* No lines reused because we displayed everything up to the
17370 bottom of the window. */
17371 && it
.current_y
< it
.last_visible_y
)
17374 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17376 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17377 run
.current_y
= first_unchanged_at_end_row
->y
;
17378 run
.desired_y
= run
.current_y
+ dy
;
17379 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17383 delta
= delta_bytes
= dvpos
= dy
17384 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17385 first_unchanged_at_end_row
= NULL
;
17387 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17390 /* Find the cursor if not already found. We have to decide whether
17391 PT will appear on this window (it sometimes doesn't, but this is
17392 not a very frequent case.) This decision has to be made before
17393 the current matrix is altered. A value of cursor.vpos < 0 means
17394 that PT is either in one of the lines beginning at
17395 first_unchanged_at_end_row or below the window. Don't care for
17396 lines that might be displayed later at the window end; as
17397 mentioned, this is not a frequent case. */
17398 if (w
->cursor
.vpos
< 0)
17400 /* Cursor in unchanged rows at the top? */
17401 if (PT
< CHARPOS (start_pos
)
17402 && last_unchanged_at_beg_row
)
17404 row
= row_containing_pos (w
, PT
,
17405 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17406 last_unchanged_at_beg_row
+ 1, 0);
17408 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17411 /* Start from first_unchanged_at_end_row looking for PT. */
17412 else if (first_unchanged_at_end_row
)
17414 row
= row_containing_pos (w
, PT
- delta
,
17415 first_unchanged_at_end_row
, NULL
, 0);
17417 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17418 delta_bytes
, dy
, dvpos
);
17421 /* Give up if cursor was not found. */
17422 if (w
->cursor
.vpos
< 0)
17424 clear_glyph_matrix (w
->desired_matrix
);
17429 /* Don't let the cursor end in the scroll margins. */
17431 int this_scroll_margin
, cursor_height
;
17433 this_scroll_margin
=
17434 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17435 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17436 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17438 if ((w
->cursor
.y
< this_scroll_margin
17439 && CHARPOS (start
) > BEGV
)
17440 /* Old redisplay didn't take scroll margin into account at the bottom,
17441 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17442 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17443 ? cursor_height
+ this_scroll_margin
17444 : 1)) > it
.last_visible_y
)
17446 w
->cursor
.vpos
= -1;
17447 clear_glyph_matrix (w
->desired_matrix
);
17452 /* Scroll the display. Do it before changing the current matrix so
17453 that xterm.c doesn't get confused about where the cursor glyph is
17455 if (dy
&& run
.height
)
17459 if (FRAME_WINDOW_P (f
))
17461 FRAME_RIF (f
)->update_window_begin_hook (w
);
17462 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17463 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17464 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17468 /* Terminal frame. In this case, dvpos gives the number of
17469 lines to scroll by; dvpos < 0 means scroll up. */
17471 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17472 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17473 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17474 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17475 + window_internal_height (w
));
17477 #if defined (HAVE_GPM) || defined (MSDOS)
17478 x_clear_window_mouse_face (w
);
17480 /* Perform the operation on the screen. */
17483 /* Scroll last_unchanged_at_beg_row to the end of the
17484 window down dvpos lines. */
17485 set_terminal_window (f
, end
);
17487 /* On dumb terminals delete dvpos lines at the end
17488 before inserting dvpos empty lines. */
17489 if (!FRAME_SCROLL_REGION_OK (f
))
17490 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17492 /* Insert dvpos empty lines in front of
17493 last_unchanged_at_beg_row. */
17494 ins_del_lines (f
, from
, dvpos
);
17496 else if (dvpos
< 0)
17498 /* Scroll up last_unchanged_at_beg_vpos to the end of
17499 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17500 set_terminal_window (f
, end
);
17502 /* Delete dvpos lines in front of
17503 last_unchanged_at_beg_vpos. ins_del_lines will set
17504 the cursor to the given vpos and emit |dvpos| delete
17506 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17508 /* On a dumb terminal insert dvpos empty lines at the
17510 if (!FRAME_SCROLL_REGION_OK (f
))
17511 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17514 set_terminal_window (f
, 0);
17520 /* Shift reused rows of the current matrix to the right position.
17521 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17523 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17524 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17527 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17528 bottom_vpos
, dvpos
);
17529 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17532 else if (dvpos
> 0)
17534 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17535 bottom_vpos
, dvpos
);
17536 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17537 first_unchanged_at_end_vpos
+ dvpos
);
17540 /* For frame-based redisplay, make sure that current frame and window
17541 matrix are in sync with respect to glyph memory. */
17542 if (!FRAME_WINDOW_P (f
))
17543 sync_frame_with_window_matrix_rows (w
);
17545 /* Adjust buffer positions in reused rows. */
17546 if (delta
|| delta_bytes
)
17547 increment_matrix_positions (current_matrix
,
17548 first_unchanged_at_end_vpos
+ dvpos
,
17549 bottom_vpos
, delta
, delta_bytes
);
17551 /* Adjust Y positions. */
17553 shift_glyph_matrix (w
, current_matrix
,
17554 first_unchanged_at_end_vpos
+ dvpos
,
17557 if (first_unchanged_at_end_row
)
17559 first_unchanged_at_end_row
+= dvpos
;
17560 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17561 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17562 first_unchanged_at_end_row
= NULL
;
17565 /* If scrolling up, there may be some lines to display at the end of
17567 last_text_row_at_end
= NULL
;
17570 /* Scrolling up can leave for example a partially visible line
17571 at the end of the window to be redisplayed. */
17572 /* Set last_row to the glyph row in the current matrix where the
17573 window end line is found. It has been moved up or down in
17574 the matrix by dvpos. */
17575 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17576 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17578 /* If last_row is the window end line, it should display text. */
17579 eassert (last_row
->displays_text_p
);
17581 /* If window end line was partially visible before, begin
17582 displaying at that line. Otherwise begin displaying with the
17583 line following it. */
17584 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17586 init_to_row_start (&it
, w
, last_row
);
17587 it
.vpos
= last_vpos
;
17588 it
.current_y
= last_row
->y
;
17592 init_to_row_end (&it
, w
, last_row
);
17593 it
.vpos
= 1 + last_vpos
;
17594 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17598 /* We may start in a continuation line. If so, we have to
17599 get the right continuation_lines_width and current_x. */
17600 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17601 it
.hpos
= it
.current_x
= 0;
17603 /* Display the rest of the lines at the window end. */
17604 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17605 while (it
.current_y
< it
.last_visible_y
17606 && !fonts_changed_p
)
17608 /* Is it always sure that the display agrees with lines in
17609 the current matrix? I don't think so, so we mark rows
17610 displayed invalid in the current matrix by setting their
17611 enabled_p flag to zero. */
17612 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17613 if (display_line (&it
))
17614 last_text_row_at_end
= it
.glyph_row
- 1;
17618 /* Update window_end_pos and window_end_vpos. */
17619 if (first_unchanged_at_end_row
17620 && !last_text_row_at_end
)
17622 /* Window end line if one of the preserved rows from the current
17623 matrix. Set row to the last row displaying text in current
17624 matrix starting at first_unchanged_at_end_row, after
17626 eassert (first_unchanged_at_end_row
->displays_text_p
);
17627 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17628 first_unchanged_at_end_row
);
17629 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17631 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17632 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17633 wset_window_end_vpos
17634 (w
, make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
)));
17635 eassert (w
->window_end_bytepos
>= 0);
17636 IF_DEBUG (debug_method_add (w
, "A"));
17638 else if (last_text_row_at_end
)
17640 wset_window_end_pos
17641 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
)));
17642 w
->window_end_bytepos
17643 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17644 wset_window_end_vpos
17645 (w
, make_number (MATRIX_ROW_VPOS (last_text_row_at_end
,
17647 eassert (w
->window_end_bytepos
>= 0);
17648 IF_DEBUG (debug_method_add (w
, "B"));
17650 else if (last_text_row
)
17652 /* We have displayed either to the end of the window or at the
17653 end of the window, i.e. the last row with text is to be found
17654 in the desired matrix. */
17655 wset_window_end_pos
17656 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
17657 w
->window_end_bytepos
17658 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17659 wset_window_end_vpos
17660 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
)));
17661 eassert (w
->window_end_bytepos
>= 0);
17663 else if (first_unchanged_at_end_row
== NULL
17664 && last_text_row
== NULL
17665 && last_text_row_at_end
== NULL
)
17667 /* Displayed to end of window, but no line containing text was
17668 displayed. Lines were deleted at the end of the window. */
17669 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17670 int vpos
= XFASTINT (w
->window_end_vpos
);
17671 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17672 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17675 row
== NULL
&& vpos
>= first_vpos
;
17676 --vpos
, --current_row
, --desired_row
)
17678 if (desired_row
->enabled_p
)
17680 if (desired_row
->displays_text_p
)
17683 else if (current_row
->displays_text_p
)
17687 eassert (row
!= NULL
);
17688 wset_window_end_vpos (w
, make_number (vpos
+ 1));
17689 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17690 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17691 eassert (w
->window_end_bytepos
>= 0);
17692 IF_DEBUG (debug_method_add (w
, "C"));
17697 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17698 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17700 /* Record that display has not been completed. */
17701 w
->window_end_valid
= 0;
17702 w
->desired_matrix
->no_scrolling_p
= 1;
17710 /***********************************************************************
17711 More debugging support
17712 ***********************************************************************/
17716 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17717 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17718 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17721 /* Dump the contents of glyph matrix MATRIX on stderr.
17723 GLYPHS 0 means don't show glyph contents.
17724 GLYPHS 1 means show glyphs in short form
17725 GLYPHS > 1 means show glyphs in long form. */
17728 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17731 for (i
= 0; i
< matrix
->nrows
; ++i
)
17732 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17736 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17737 the glyph row and area where the glyph comes from. */
17740 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17742 if (glyph
->type
== CHAR_GLYPH
17743 || glyph
->type
== GLYPHLESS_GLYPH
)
17746 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
17747 glyph
- row
->glyphs
[TEXT_AREA
],
17748 (glyph
->type
== CHAR_GLYPH
17752 (BUFFERP (glyph
->object
)
17754 : (STRINGP (glyph
->object
)
17756 : (INTEGERP (glyph
->object
)
17759 glyph
->pixel_width
,
17761 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17765 glyph
->left_box_line_p
,
17766 glyph
->right_box_line_p
);
17768 else if (glyph
->type
== STRETCH_GLYPH
)
17771 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
17772 glyph
- row
->glyphs
[TEXT_AREA
],
17775 (BUFFERP (glyph
->object
)
17777 : (STRINGP (glyph
->object
)
17779 : (INTEGERP (glyph
->object
)
17782 glyph
->pixel_width
,
17786 glyph
->left_box_line_p
,
17787 glyph
->right_box_line_p
);
17789 else if (glyph
->type
== IMAGE_GLYPH
)
17792 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
17793 glyph
- row
->glyphs
[TEXT_AREA
],
17796 (BUFFERP (glyph
->object
)
17798 : (STRINGP (glyph
->object
)
17800 : (INTEGERP (glyph
->object
)
17803 glyph
->pixel_width
,
17807 glyph
->left_box_line_p
,
17808 glyph
->right_box_line_p
);
17810 else if (glyph
->type
== COMPOSITE_GLYPH
)
17813 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
17814 glyph
- row
->glyphs
[TEXT_AREA
],
17817 (BUFFERP (glyph
->object
)
17819 : (STRINGP (glyph
->object
)
17821 : (INTEGERP (glyph
->object
)
17824 glyph
->pixel_width
,
17826 if (glyph
->u
.cmp
.automatic
)
17829 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17830 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17832 glyph
->left_box_line_p
,
17833 glyph
->right_box_line_p
);
17838 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17839 GLYPHS 0 means don't show glyph contents.
17840 GLYPHS 1 means show glyphs in short form
17841 GLYPHS > 1 means show glyphs in long form. */
17844 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17848 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17849 fprintf (stderr
, "==============================================================================\n");
17851 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17852 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17854 MATRIX_ROW_START_CHARPOS (row
),
17855 MATRIX_ROW_END_CHARPOS (row
),
17856 row
->used
[TEXT_AREA
],
17857 row
->contains_overlapping_glyphs_p
,
17859 row
->truncated_on_left_p
,
17860 row
->truncated_on_right_p
,
17862 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17863 row
->displays_text_p
,
17866 row
->ends_in_middle_of_char_p
,
17867 row
->starts_in_middle_of_char_p
,
17873 row
->visible_height
,
17876 /* The next 3 lines should align to "Start" in the header. */
17877 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
17878 row
->end
.overlay_string_index
,
17879 row
->continuation_lines_width
);
17880 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
17881 CHARPOS (row
->start
.string_pos
),
17882 CHARPOS (row
->end
.string_pos
));
17883 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
17884 row
->end
.dpvec_index
);
17891 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17893 struct glyph
*glyph
= row
->glyphs
[area
];
17894 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17896 /* Glyph for a line end in text. */
17897 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17900 if (glyph
< glyph_end
)
17901 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
17903 for (; glyph
< glyph_end
; ++glyph
)
17904 dump_glyph (row
, glyph
, area
);
17907 else if (glyphs
== 1)
17911 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17913 char *s
= alloca (row
->used
[area
] + 4);
17916 for (i
= 0; i
< row
->used
[area
]; ++i
)
17918 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17919 if (i
== row
->used
[area
] - 1
17920 && area
== TEXT_AREA
17921 && INTEGERP (glyph
->object
)
17922 && glyph
->type
== CHAR_GLYPH
17923 && glyph
->u
.ch
== ' ')
17925 strcpy (&s
[i
], "[\\n]");
17928 else if (glyph
->type
== CHAR_GLYPH
17929 && glyph
->u
.ch
< 0x80
17930 && glyph
->u
.ch
>= ' ')
17931 s
[i
] = glyph
->u
.ch
;
17937 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17943 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17944 Sdump_glyph_matrix
, 0, 1, "p",
17945 doc
: /* Dump the current matrix of the selected window to stderr.
17946 Shows contents of glyph row structures. With non-nil
17947 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17948 glyphs in short form, otherwise show glyphs in long form. */)
17949 (Lisp_Object glyphs
)
17951 struct window
*w
= XWINDOW (selected_window
);
17952 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17954 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17955 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17956 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17957 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17958 fprintf (stderr
, "=============================================\n");
17959 dump_glyph_matrix (w
->current_matrix
,
17960 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
17965 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17966 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17969 struct frame
*f
= XFRAME (selected_frame
);
17970 dump_glyph_matrix (f
->current_matrix
, 1);
17975 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17976 doc
: /* Dump glyph row ROW to stderr.
17977 GLYPH 0 means don't dump glyphs.
17978 GLYPH 1 means dump glyphs in short form.
17979 GLYPH > 1 or omitted means dump glyphs in long form. */)
17980 (Lisp_Object row
, Lisp_Object glyphs
)
17982 struct glyph_matrix
*matrix
;
17985 CHECK_NUMBER (row
);
17986 matrix
= XWINDOW (selected_window
)->current_matrix
;
17988 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17989 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17991 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
17996 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17997 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17998 GLYPH 0 means don't dump glyphs.
17999 GLYPH 1 means dump glyphs in short form.
18000 GLYPH > 1 or omitted means dump glyphs in long form. */)
18001 (Lisp_Object row
, Lisp_Object glyphs
)
18003 struct frame
*sf
= SELECTED_FRAME ();
18004 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18007 CHECK_NUMBER (row
);
18009 if (vpos
>= 0 && vpos
< m
->nrows
)
18010 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18011 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18016 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18017 doc
: /* Toggle tracing of redisplay.
18018 With ARG, turn tracing on if and only if ARG is positive. */)
18022 trace_redisplay_p
= !trace_redisplay_p
;
18025 arg
= Fprefix_numeric_value (arg
);
18026 trace_redisplay_p
= XINT (arg
) > 0;
18033 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18034 doc
: /* Like `format', but print result to stderr.
18035 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18036 (ptrdiff_t nargs
, Lisp_Object
*args
)
18038 Lisp_Object s
= Fformat (nargs
, args
);
18039 fprintf (stderr
, "%s", SDATA (s
));
18043 #endif /* GLYPH_DEBUG */
18047 /***********************************************************************
18048 Building Desired Matrix Rows
18049 ***********************************************************************/
18051 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18052 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18054 static struct glyph_row
*
18055 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18057 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18058 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18059 struct buffer
*old
= current_buffer
;
18060 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18061 int arrow_len
= SCHARS (overlay_arrow_string
);
18062 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18063 const unsigned char *p
;
18066 int n_glyphs_before
;
18068 set_buffer_temp (buffer
);
18069 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18070 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18071 SET_TEXT_POS (it
.position
, 0, 0);
18073 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18075 while (p
< arrow_end
)
18077 Lisp_Object face
, ilisp
;
18079 /* Get the next character. */
18081 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18084 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18085 if (! ASCII_CHAR_P (it
.c
))
18086 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18090 /* Get its face. */
18091 ilisp
= make_number (p
- arrow_string
);
18092 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18093 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18095 /* Compute its width, get its glyphs. */
18096 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18097 SET_TEXT_POS (it
.position
, -1, -1);
18098 PRODUCE_GLYPHS (&it
);
18100 /* If this character doesn't fit any more in the line, we have
18101 to remove some glyphs. */
18102 if (it
.current_x
> it
.last_visible_x
)
18104 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18109 set_buffer_temp (old
);
18110 return it
.glyph_row
;
18114 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18115 glyphs to insert is determined by produce_special_glyphs. */
18118 insert_left_trunc_glyphs (struct it
*it
)
18120 struct it truncate_it
;
18121 struct glyph
*from
, *end
, *to
, *toend
;
18123 eassert (!FRAME_WINDOW_P (it
->f
)
18124 || (!it
->glyph_row
->reversed_p
18125 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18126 || (it
->glyph_row
->reversed_p
18127 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18129 /* Get the truncation glyphs. */
18131 truncate_it
.current_x
= 0;
18132 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18133 truncate_it
.glyph_row
= &scratch_glyph_row
;
18134 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18135 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18136 truncate_it
.object
= make_number (0);
18137 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18139 /* Overwrite glyphs from IT with truncation glyphs. */
18140 if (!it
->glyph_row
->reversed_p
)
18142 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18144 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18145 end
= from
+ tused
;
18146 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18147 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18148 if (FRAME_WINDOW_P (it
->f
))
18150 /* On GUI frames, when variable-size fonts are displayed,
18151 the truncation glyphs may need more pixels than the row's
18152 glyphs they overwrite. We overwrite more glyphs to free
18153 enough screen real estate, and enlarge the stretch glyph
18154 on the right (see display_line), if there is one, to
18155 preserve the screen position of the truncation glyphs on
18158 struct glyph
*g
= to
;
18161 /* The first glyph could be partially visible, in which case
18162 it->glyph_row->x will be negative. But we want the left
18163 truncation glyphs to be aligned at the left margin of the
18164 window, so we override the x coordinate at which the row
18166 it
->glyph_row
->x
= 0;
18167 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18169 w
+= g
->pixel_width
;
18172 if (g
- to
- tused
> 0)
18174 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18175 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18177 used
= it
->glyph_row
->used
[TEXT_AREA
];
18178 if (it
->glyph_row
->truncated_on_right_p
18179 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18180 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18183 int extra
= w
- it
->truncation_pixel_width
;
18185 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18192 /* There may be padding glyphs left over. Overwrite them too. */
18193 if (!FRAME_WINDOW_P (it
->f
))
18195 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18197 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18204 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18208 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18210 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18211 that back to front. */
18212 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18213 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18214 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18215 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18216 if (FRAME_WINDOW_P (it
->f
))
18219 struct glyph
*g
= to
;
18221 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18223 w
+= g
->pixel_width
;
18226 if (to
- g
- tused
> 0)
18228 if (it
->glyph_row
->truncated_on_right_p
18229 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18230 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18232 int extra
= w
- it
->truncation_pixel_width
;
18234 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18238 while (from
>= end
&& to
>= toend
)
18240 if (!FRAME_WINDOW_P (it
->f
))
18242 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18245 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18246 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18247 while (from
>= end
&& to
>= toend
)
18253 /* Need to free some room before prepending additional
18255 int move_by
= from
- end
+ 1;
18256 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18257 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18259 for ( ; g
>= g0
; g
--)
18261 while (from
>= end
)
18263 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18268 /* Compute the hash code for ROW. */
18270 row_hash (struct glyph_row
*row
)
18273 unsigned hashval
= 0;
18275 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18276 for (k
= 0; k
< row
->used
[area
]; ++k
)
18277 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18278 + row
->glyphs
[area
][k
].u
.val
18279 + row
->glyphs
[area
][k
].face_id
18280 + row
->glyphs
[area
][k
].padding_p
18281 + (row
->glyphs
[area
][k
].type
<< 2));
18286 /* Compute the pixel height and width of IT->glyph_row.
18288 Most of the time, ascent and height of a display line will be equal
18289 to the max_ascent and max_height values of the display iterator
18290 structure. This is not the case if
18292 1. We hit ZV without displaying anything. In this case, max_ascent
18293 and max_height will be zero.
18295 2. We have some glyphs that don't contribute to the line height.
18296 (The glyph row flag contributes_to_line_height_p is for future
18297 pixmap extensions).
18299 The first case is easily covered by using default values because in
18300 these cases, the line height does not really matter, except that it
18301 must not be zero. */
18304 compute_line_metrics (struct it
*it
)
18306 struct glyph_row
*row
= it
->glyph_row
;
18308 if (FRAME_WINDOW_P (it
->f
))
18310 int i
, min_y
, max_y
;
18312 /* The line may consist of one space only, that was added to
18313 place the cursor on it. If so, the row's height hasn't been
18315 if (row
->height
== 0)
18317 if (it
->max_ascent
+ it
->max_descent
== 0)
18318 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18319 row
->ascent
= it
->max_ascent
;
18320 row
->height
= it
->max_ascent
+ it
->max_descent
;
18321 row
->phys_ascent
= it
->max_phys_ascent
;
18322 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18323 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18326 /* Compute the width of this line. */
18327 row
->pixel_width
= row
->x
;
18328 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18329 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18331 eassert (row
->pixel_width
>= 0);
18332 eassert (row
->ascent
>= 0 && row
->height
> 0);
18334 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18335 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18337 /* If first line's physical ascent is larger than its logical
18338 ascent, use the physical ascent, and make the row taller.
18339 This makes accented characters fully visible. */
18340 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18341 && row
->phys_ascent
> row
->ascent
)
18343 row
->height
+= row
->phys_ascent
- row
->ascent
;
18344 row
->ascent
= row
->phys_ascent
;
18347 /* Compute how much of the line is visible. */
18348 row
->visible_height
= row
->height
;
18350 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18351 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18353 if (row
->y
< min_y
)
18354 row
->visible_height
-= min_y
- row
->y
;
18355 if (row
->y
+ row
->height
> max_y
)
18356 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18360 row
->pixel_width
= row
->used
[TEXT_AREA
];
18361 if (row
->continued_p
)
18362 row
->pixel_width
-= it
->continuation_pixel_width
;
18363 else if (row
->truncated_on_right_p
)
18364 row
->pixel_width
-= it
->truncation_pixel_width
;
18365 row
->ascent
= row
->phys_ascent
= 0;
18366 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18367 row
->extra_line_spacing
= 0;
18370 /* Compute a hash code for this row. */
18371 row
->hash
= row_hash (row
);
18373 it
->max_ascent
= it
->max_descent
= 0;
18374 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18378 /* Append one space to the glyph row of iterator IT if doing a
18379 window-based redisplay. The space has the same face as
18380 IT->face_id. Value is non-zero if a space was added.
18382 This function is called to make sure that there is always one glyph
18383 at the end of a glyph row that the cursor can be set on under
18384 window-systems. (If there weren't such a glyph we would not know
18385 how wide and tall a box cursor should be displayed).
18387 At the same time this space let's a nicely handle clearing to the
18388 end of the line if the row ends in italic text. */
18391 append_space_for_newline (struct it
*it
, int default_face_p
)
18393 if (FRAME_WINDOW_P (it
->f
))
18395 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18397 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18398 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18400 /* Save some values that must not be changed.
18401 Must save IT->c and IT->len because otherwise
18402 ITERATOR_AT_END_P wouldn't work anymore after
18403 append_space_for_newline has been called. */
18404 enum display_element_type saved_what
= it
->what
;
18405 int saved_c
= it
->c
, saved_len
= it
->len
;
18406 int saved_char_to_display
= it
->char_to_display
;
18407 int saved_x
= it
->current_x
;
18408 int saved_face_id
= it
->face_id
;
18409 int saved_box_end
= it
->end_of_box_run_p
;
18410 struct text_pos saved_pos
;
18411 Lisp_Object saved_object
;
18414 saved_object
= it
->object
;
18415 saved_pos
= it
->position
;
18417 it
->what
= IT_CHARACTER
;
18418 memset (&it
->position
, 0, sizeof it
->position
);
18419 it
->object
= make_number (0);
18420 it
->c
= it
->char_to_display
= ' ';
18423 /* If the default face was remapped, be sure to use the
18424 remapped face for the appended newline. */
18425 if (default_face_p
)
18426 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18427 else if (it
->face_before_selective_p
)
18428 it
->face_id
= it
->saved_face_id
;
18429 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18430 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18431 /* In R2L rows, we will prepend a stretch glyph that will
18432 have the end_of_box_run_p flag set for it, so there's no
18433 need for the appended newline glyph to have that flag
18435 if (it
->glyph_row
->reversed_p
18436 /* But if the appended newline glyph goes all the way to
18437 the end of the row, there will be no stretch glyph,
18438 so leave the box flag set. */
18439 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
18440 it
->end_of_box_run_p
= 0;
18442 PRODUCE_GLYPHS (it
);
18444 it
->override_ascent
= -1;
18445 it
->constrain_row_ascent_descent_p
= 0;
18446 it
->current_x
= saved_x
;
18447 it
->object
= saved_object
;
18448 it
->position
= saved_pos
;
18449 it
->what
= saved_what
;
18450 it
->face_id
= saved_face_id
;
18451 it
->len
= saved_len
;
18453 it
->char_to_display
= saved_char_to_display
;
18454 it
->end_of_box_run_p
= saved_box_end
;
18463 /* Extend the face of the last glyph in the text area of IT->glyph_row
18464 to the end of the display line. Called from display_line. If the
18465 glyph row is empty, add a space glyph to it so that we know the
18466 face to draw. Set the glyph row flag fill_line_p. If the glyph
18467 row is R2L, prepend a stretch glyph to cover the empty space to the
18468 left of the leftmost glyph. */
18471 extend_face_to_end_of_line (struct it
*it
)
18473 struct face
*face
, *default_face
;
18474 struct frame
*f
= it
->f
;
18476 /* If line is already filled, do nothing. Non window-system frames
18477 get a grace of one more ``pixel'' because their characters are
18478 1-``pixel'' wide, so they hit the equality too early. This grace
18479 is needed only for R2L rows that are not continued, to produce
18480 one extra blank where we could display the cursor. */
18481 if (it
->current_x
>= it
->last_visible_x
18482 + (!FRAME_WINDOW_P (f
)
18483 && it
->glyph_row
->reversed_p
18484 && !it
->glyph_row
->continued_p
))
18487 /* The default face, possibly remapped. */
18488 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18490 /* Face extension extends the background and box of IT->face_id
18491 to the end of the line. If the background equals the background
18492 of the frame, we don't have to do anything. */
18493 if (it
->face_before_selective_p
)
18494 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18496 face
= FACE_FROM_ID (f
, it
->face_id
);
18498 if (FRAME_WINDOW_P (f
)
18499 && it
->glyph_row
->displays_text_p
18500 && face
->box
== FACE_NO_BOX
18501 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18503 && !it
->glyph_row
->reversed_p
)
18506 /* Set the glyph row flag indicating that the face of the last glyph
18507 in the text area has to be drawn to the end of the text area. */
18508 it
->glyph_row
->fill_line_p
= 1;
18510 /* If current character of IT is not ASCII, make sure we have the
18511 ASCII face. This will be automatically undone the next time
18512 get_next_display_element returns a multibyte character. Note
18513 that the character will always be single byte in unibyte
18515 if (!ASCII_CHAR_P (it
->c
))
18517 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18520 if (FRAME_WINDOW_P (f
))
18522 /* If the row is empty, add a space with the current face of IT,
18523 so that we know which face to draw. */
18524 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18526 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18527 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18528 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18530 #ifdef HAVE_WINDOW_SYSTEM
18531 if (it
->glyph_row
->reversed_p
)
18533 /* Prepend a stretch glyph to the row, such that the
18534 rightmost glyph will be drawn flushed all the way to the
18535 right margin of the window. The stretch glyph that will
18536 occupy the empty space, if any, to the left of the
18538 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18539 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18540 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18542 int row_width
, stretch_ascent
, stretch_width
;
18543 struct text_pos saved_pos
;
18544 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
18546 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18547 row_width
+= g
->pixel_width
;
18548 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18549 if (stretch_width
> 0)
18552 (((it
->ascent
+ it
->descent
)
18553 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18554 saved_pos
= it
->position
;
18555 memset (&it
->position
, 0, sizeof it
->position
);
18556 saved_avoid_cursor
= it
->avoid_cursor_p
;
18557 it
->avoid_cursor_p
= 1;
18558 saved_face_id
= it
->face_id
;
18559 saved_box_start
= it
->start_of_box_run_p
;
18560 /* The last row's stretch glyph should get the default
18561 face, to avoid painting the rest of the window with
18562 the region face, if the region ends at ZV. */
18563 if (it
->glyph_row
->ends_at_zv_p
)
18564 it
->face_id
= default_face
->id
;
18566 it
->face_id
= face
->id
;
18567 it
->start_of_box_run_p
= 0;
18568 append_stretch_glyph (it
, make_number (0), stretch_width
,
18569 it
->ascent
+ it
->descent
, stretch_ascent
);
18570 it
->position
= saved_pos
;
18571 it
->avoid_cursor_p
= saved_avoid_cursor
;
18572 it
->face_id
= saved_face_id
;
18573 it
->start_of_box_run_p
= saved_box_start
;
18576 #endif /* HAVE_WINDOW_SYSTEM */
18580 /* Save some values that must not be changed. */
18581 int saved_x
= it
->current_x
;
18582 struct text_pos saved_pos
;
18583 Lisp_Object saved_object
;
18584 enum display_element_type saved_what
= it
->what
;
18585 int saved_face_id
= it
->face_id
;
18587 saved_object
= it
->object
;
18588 saved_pos
= it
->position
;
18590 it
->what
= IT_CHARACTER
;
18591 memset (&it
->position
, 0, sizeof it
->position
);
18592 it
->object
= make_number (0);
18593 it
->c
= it
->char_to_display
= ' ';
18595 /* The last row's blank glyphs should get the default face, to
18596 avoid painting the rest of the window with the region face,
18597 if the region ends at ZV. */
18598 if (it
->glyph_row
->ends_at_zv_p
)
18599 it
->face_id
= default_face
->id
;
18601 it
->face_id
= face
->id
;
18603 PRODUCE_GLYPHS (it
);
18605 while (it
->current_x
<= it
->last_visible_x
)
18606 PRODUCE_GLYPHS (it
);
18608 /* Don't count these blanks really. It would let us insert a left
18609 truncation glyph below and make us set the cursor on them, maybe. */
18610 it
->current_x
= saved_x
;
18611 it
->object
= saved_object
;
18612 it
->position
= saved_pos
;
18613 it
->what
= saved_what
;
18614 it
->face_id
= saved_face_id
;
18619 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18620 trailing whitespace. */
18623 trailing_whitespace_p (ptrdiff_t charpos
)
18625 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18628 while (bytepos
< ZV_BYTE
18629 && (c
= FETCH_CHAR (bytepos
),
18630 c
== ' ' || c
== '\t'))
18633 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18635 if (bytepos
!= PT_BYTE
)
18642 /* Highlight trailing whitespace, if any, in ROW. */
18645 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18647 int used
= row
->used
[TEXT_AREA
];
18651 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18652 struct glyph
*glyph
= start
+ used
- 1;
18654 if (row
->reversed_p
)
18656 /* Right-to-left rows need to be processed in the opposite
18657 direction, so swap the edge pointers. */
18659 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18662 /* Skip over glyphs inserted to display the cursor at the
18663 end of a line, for extending the face of the last glyph
18664 to the end of the line on terminals, and for truncation
18665 and continuation glyphs. */
18666 if (!row
->reversed_p
)
18668 while (glyph
>= start
18669 && glyph
->type
== CHAR_GLYPH
18670 && INTEGERP (glyph
->object
))
18675 while (glyph
<= start
18676 && glyph
->type
== CHAR_GLYPH
18677 && INTEGERP (glyph
->object
))
18681 /* If last glyph is a space or stretch, and it's trailing
18682 whitespace, set the face of all trailing whitespace glyphs in
18683 IT->glyph_row to `trailing-whitespace'. */
18684 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18685 && BUFFERP (glyph
->object
)
18686 && (glyph
->type
== STRETCH_GLYPH
18687 || (glyph
->type
== CHAR_GLYPH
18688 && glyph
->u
.ch
== ' '))
18689 && trailing_whitespace_p (glyph
->charpos
))
18691 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18695 if (!row
->reversed_p
)
18697 while (glyph
>= start
18698 && BUFFERP (glyph
->object
)
18699 && (glyph
->type
== STRETCH_GLYPH
18700 || (glyph
->type
== CHAR_GLYPH
18701 && glyph
->u
.ch
== ' ')))
18702 (glyph
--)->face_id
= face_id
;
18706 while (glyph
<= start
18707 && BUFFERP (glyph
->object
)
18708 && (glyph
->type
== STRETCH_GLYPH
18709 || (glyph
->type
== CHAR_GLYPH
18710 && glyph
->u
.ch
== ' ')))
18711 (glyph
++)->face_id
= face_id
;
18718 /* Value is non-zero if glyph row ROW should be
18719 used to hold the cursor. */
18722 cursor_row_p (struct glyph_row
*row
)
18726 if (PT
== CHARPOS (row
->end
.pos
)
18727 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18729 /* Suppose the row ends on a string.
18730 Unless the row is continued, that means it ends on a newline
18731 in the string. If it's anything other than a display string
18732 (e.g., a before-string from an overlay), we don't want the
18733 cursor there. (This heuristic seems to give the optimal
18734 behavior for the various types of multi-line strings.)
18735 One exception: if the string has `cursor' property on one of
18736 its characters, we _do_ want the cursor there. */
18737 if (CHARPOS (row
->end
.string_pos
) >= 0)
18739 if (row
->continued_p
)
18743 /* Check for `display' property. */
18744 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18745 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18746 struct glyph
*glyph
;
18749 for (glyph
= end
; glyph
>= beg
; --glyph
)
18750 if (STRINGP (glyph
->object
))
18753 = Fget_char_property (make_number (PT
),
18757 && display_prop_string_p (prop
, glyph
->object
));
18758 /* If there's a `cursor' property on one of the
18759 string's characters, this row is a cursor row,
18760 even though this is not a display string. */
18763 Lisp_Object s
= glyph
->object
;
18765 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18767 ptrdiff_t gpos
= glyph
->charpos
;
18769 if (!NILP (Fget_char_property (make_number (gpos
),
18781 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18783 /* If the row ends in middle of a real character,
18784 and the line is continued, we want the cursor here.
18785 That's because CHARPOS (ROW->end.pos) would equal
18786 PT if PT is before the character. */
18787 if (!row
->ends_in_ellipsis_p
)
18788 result
= row
->continued_p
;
18790 /* If the row ends in an ellipsis, then
18791 CHARPOS (ROW->end.pos) will equal point after the
18792 invisible text. We want that position to be displayed
18793 after the ellipsis. */
18796 /* If the row ends at ZV, display the cursor at the end of that
18797 row instead of at the start of the row below. */
18798 else if (row
->ends_at_zv_p
)
18809 /* Push the property PROP so that it will be rendered at the current
18810 position in IT. Return 1 if PROP was successfully pushed, 0
18811 otherwise. Called from handle_line_prefix to handle the
18812 `line-prefix' and `wrap-prefix' properties. */
18815 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18817 struct text_pos pos
=
18818 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18820 eassert (it
->method
== GET_FROM_BUFFER
18821 || it
->method
== GET_FROM_DISPLAY_VECTOR
18822 || it
->method
== GET_FROM_STRING
);
18824 /* We need to save the current buffer/string position, so it will be
18825 restored by pop_it, because iterate_out_of_display_property
18826 depends on that being set correctly, but some situations leave
18827 it->position not yet set when this function is called. */
18828 push_it (it
, &pos
);
18830 if (STRINGP (prop
))
18832 if (SCHARS (prop
) == 0)
18839 it
->string_from_prefix_prop_p
= 1;
18840 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18841 it
->current
.overlay_string_index
= -1;
18842 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18843 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18844 it
->method
= GET_FROM_STRING
;
18845 it
->stop_charpos
= 0;
18847 it
->base_level_stop
= 0;
18849 /* Force paragraph direction to be that of the parent
18851 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18852 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18854 it
->paragraph_embedding
= L2R
;
18856 /* Set up the bidi iterator for this display string. */
18859 it
->bidi_it
.string
.lstring
= it
->string
;
18860 it
->bidi_it
.string
.s
= NULL
;
18861 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18862 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18863 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18864 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18865 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18868 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18870 it
->method
= GET_FROM_STRETCH
;
18873 #ifdef HAVE_WINDOW_SYSTEM
18874 else if (IMAGEP (prop
))
18876 it
->what
= IT_IMAGE
;
18877 it
->image_id
= lookup_image (it
->f
, prop
);
18878 it
->method
= GET_FROM_IMAGE
;
18880 #endif /* HAVE_WINDOW_SYSTEM */
18883 pop_it (it
); /* bogus display property, give up */
18890 /* Return the character-property PROP at the current position in IT. */
18893 get_it_property (struct it
*it
, Lisp_Object prop
)
18895 Lisp_Object position
;
18897 if (STRINGP (it
->object
))
18898 position
= make_number (IT_STRING_CHARPOS (*it
));
18899 else if (BUFFERP (it
->object
))
18900 position
= make_number (IT_CHARPOS (*it
));
18904 return Fget_char_property (position
, prop
, it
->object
);
18907 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18910 handle_line_prefix (struct it
*it
)
18912 Lisp_Object prefix
;
18914 if (it
->continuation_lines_width
> 0)
18916 prefix
= get_it_property (it
, Qwrap_prefix
);
18918 prefix
= Vwrap_prefix
;
18922 prefix
= get_it_property (it
, Qline_prefix
);
18924 prefix
= Vline_prefix
;
18926 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
18928 /* If the prefix is wider than the window, and we try to wrap
18929 it, it would acquire its own wrap prefix, and so on till the
18930 iterator stack overflows. So, don't wrap the prefix. */
18931 it
->line_wrap
= TRUNCATE
;
18932 it
->avoid_cursor_p
= 1;
18938 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18939 only for R2L lines from display_line and display_string, when they
18940 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18941 the line/string needs to be continued on the next glyph row. */
18943 unproduce_glyphs (struct it
*it
, int n
)
18945 struct glyph
*glyph
, *end
;
18947 eassert (it
->glyph_row
);
18948 eassert (it
->glyph_row
->reversed_p
);
18949 eassert (it
->area
== TEXT_AREA
);
18950 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18952 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18953 n
= it
->glyph_row
->used
[TEXT_AREA
];
18954 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18955 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18956 for ( ; glyph
< end
; glyph
++)
18957 glyph
[-n
] = *glyph
;
18960 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18961 and ROW->maxpos. */
18963 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18964 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
18965 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
18967 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18968 lines' rows is implemented for bidi-reordered rows. */
18970 /* ROW->minpos is the value of min_pos, the minimal buffer position
18971 we have in ROW, or ROW->start.pos if that is smaller. */
18972 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18973 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18975 /* We didn't find buffer positions smaller than ROW->start, or
18976 didn't find _any_ valid buffer positions in any of the glyphs,
18977 so we must trust the iterator's computed positions. */
18978 row
->minpos
= row
->start
.pos
;
18981 max_pos
= CHARPOS (it
->current
.pos
);
18982 max_bpos
= BYTEPOS (it
->current
.pos
);
18985 /* Here are the various use-cases for ending the row, and the
18986 corresponding values for ROW->maxpos:
18988 Line ends in a newline from buffer eol_pos + 1
18989 Line is continued from buffer max_pos + 1
18990 Line is truncated on right it->current.pos
18991 Line ends in a newline from string max_pos + 1(*)
18992 (*) + 1 only when line ends in a forward scan
18993 Line is continued from string max_pos
18994 Line is continued from display vector max_pos
18995 Line is entirely from a string min_pos == max_pos
18996 Line is entirely from a display vector min_pos == max_pos
18997 Line that ends at ZV ZV
18999 If you discover other use-cases, please add them here as
19001 if (row
->ends_at_zv_p
)
19002 row
->maxpos
= it
->current
.pos
;
19003 else if (row
->used
[TEXT_AREA
])
19005 int seen_this_string
= 0;
19006 struct glyph_row
*r1
= row
- 1;
19008 /* Did we see the same display string on the previous row? */
19009 if (STRINGP (it
->object
)
19010 /* this is not the first row */
19011 && row
> it
->w
->desired_matrix
->rows
19012 /* previous row is not the header line */
19013 && !r1
->mode_line_p
19014 /* previous row also ends in a newline from a string */
19015 && r1
->ends_in_newline_from_string_p
)
19017 struct glyph
*start
, *end
;
19019 /* Search for the last glyph of the previous row that came
19020 from buffer or string. Depending on whether the row is
19021 L2R or R2L, we need to process it front to back or the
19022 other way round. */
19023 if (!r1
->reversed_p
)
19025 start
= r1
->glyphs
[TEXT_AREA
];
19026 end
= start
+ r1
->used
[TEXT_AREA
];
19027 /* Glyphs inserted by redisplay have an integer (zero)
19028 as their object. */
19030 && INTEGERP ((end
- 1)->object
)
19031 && (end
- 1)->charpos
<= 0)
19035 if (EQ ((end
- 1)->object
, it
->object
))
19036 seen_this_string
= 1;
19039 /* If all the glyphs of the previous row were inserted
19040 by redisplay, it means the previous row was
19041 produced from a single newline, which is only
19042 possible if that newline came from the same string
19043 as the one which produced this ROW. */
19044 seen_this_string
= 1;
19048 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19049 start
= end
+ r1
->used
[TEXT_AREA
];
19051 && INTEGERP ((end
+ 1)->object
)
19052 && (end
+ 1)->charpos
<= 0)
19056 if (EQ ((end
+ 1)->object
, it
->object
))
19057 seen_this_string
= 1;
19060 seen_this_string
= 1;
19063 /* Take note of each display string that covers a newline only
19064 once, the first time we see it. This is for when a display
19065 string includes more than one newline in it. */
19066 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19068 /* If we were scanning the buffer forward when we displayed
19069 the string, we want to account for at least one buffer
19070 position that belongs to this row (position covered by
19071 the display string), so that cursor positioning will
19072 consider this row as a candidate when point is at the end
19073 of the visual line represented by this row. This is not
19074 required when scanning back, because max_pos will already
19075 have a much larger value. */
19076 if (CHARPOS (row
->end
.pos
) > max_pos
)
19077 INC_BOTH (max_pos
, max_bpos
);
19078 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19080 else if (CHARPOS (it
->eol_pos
) > 0)
19081 SET_TEXT_POS (row
->maxpos
,
19082 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19083 else if (row
->continued_p
)
19085 /* If max_pos is different from IT's current position, it
19086 means IT->method does not belong to the display element
19087 at max_pos. However, it also means that the display
19088 element at max_pos was displayed in its entirety on this
19089 line, which is equivalent to saying that the next line
19090 starts at the next buffer position. */
19091 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19092 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19095 INC_BOTH (max_pos
, max_bpos
);
19096 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19099 else if (row
->truncated_on_right_p
)
19100 /* display_line already called reseat_at_next_visible_line_start,
19101 which puts the iterator at the beginning of the next line, in
19102 the logical order. */
19103 row
->maxpos
= it
->current
.pos
;
19104 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19105 /* A line that is entirely from a string/image/stretch... */
19106 row
->maxpos
= row
->minpos
;
19111 row
->maxpos
= it
->current
.pos
;
19114 /* Construct the glyph row IT->glyph_row in the desired matrix of
19115 IT->w from text at the current position of IT. See dispextern.h
19116 for an overview of struct it. Value is non-zero if
19117 IT->glyph_row displays text, as opposed to a line displaying ZV
19121 display_line (struct it
*it
)
19123 struct glyph_row
*row
= it
->glyph_row
;
19124 Lisp_Object overlay_arrow_string
;
19126 void *wrap_data
= NULL
;
19127 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19128 int wrap_row_used
= -1;
19129 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19130 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19131 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19132 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19133 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19135 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19136 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19138 /* We always start displaying at hpos zero even if hscrolled. */
19139 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19141 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19142 >= it
->w
->desired_matrix
->nrows
)
19144 it
->w
->nrows_scale_factor
++;
19145 fonts_changed_p
= 1;
19149 /* Is IT->w showing the region? */
19150 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? it
->region_beg_charpos
: 0;
19152 /* Clear the result glyph row and enable it. */
19153 prepare_desired_row (row
);
19155 row
->y
= it
->current_y
;
19156 row
->start
= it
->start
;
19157 row
->continuation_lines_width
= it
->continuation_lines_width
;
19158 row
->displays_text_p
= 1;
19159 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19160 it
->starts_in_middle_of_char_p
= 0;
19162 /* Arrange the overlays nicely for our purposes. Usually, we call
19163 display_line on only one line at a time, in which case this
19164 can't really hurt too much, or we call it on lines which appear
19165 one after another in the buffer, in which case all calls to
19166 recenter_overlay_lists but the first will be pretty cheap. */
19167 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19169 /* Move over display elements that are not visible because we are
19170 hscrolled. This may stop at an x-position < IT->first_visible_x
19171 if the first glyph is partially visible or if we hit a line end. */
19172 if (it
->current_x
< it
->first_visible_x
)
19174 enum move_it_result move_result
;
19176 this_line_min_pos
= row
->start
.pos
;
19177 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19178 MOVE_TO_POS
| MOVE_TO_X
);
19179 /* If we are under a large hscroll, move_it_in_display_line_to
19180 could hit the end of the line without reaching
19181 it->first_visible_x. Pretend that we did reach it. This is
19182 especially important on a TTY, where we will call
19183 extend_face_to_end_of_line, which needs to know how many
19184 blank glyphs to produce. */
19185 if (it
->current_x
< it
->first_visible_x
19186 && (move_result
== MOVE_NEWLINE_OR_CR
19187 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19188 it
->current_x
= it
->first_visible_x
;
19190 /* Record the smallest positions seen while we moved over
19191 display elements that are not visible. This is needed by
19192 redisplay_internal for optimizing the case where the cursor
19193 stays inside the same line. The rest of this function only
19194 considers positions that are actually displayed, so
19195 RECORD_MAX_MIN_POS will not otherwise record positions that
19196 are hscrolled to the left of the left edge of the window. */
19197 min_pos
= CHARPOS (this_line_min_pos
);
19198 min_bpos
= BYTEPOS (this_line_min_pos
);
19202 /* We only do this when not calling `move_it_in_display_line_to'
19203 above, because move_it_in_display_line_to calls
19204 handle_line_prefix itself. */
19205 handle_line_prefix (it
);
19208 /* Get the initial row height. This is either the height of the
19209 text hscrolled, if there is any, or zero. */
19210 row
->ascent
= it
->max_ascent
;
19211 row
->height
= it
->max_ascent
+ it
->max_descent
;
19212 row
->phys_ascent
= it
->max_phys_ascent
;
19213 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19214 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19216 /* Utility macro to record max and min buffer positions seen until now. */
19217 #define RECORD_MAX_MIN_POS(IT) \
19220 int composition_p = !STRINGP ((IT)->string) \
19221 && ((IT)->what == IT_COMPOSITION); \
19222 ptrdiff_t current_pos = \
19223 composition_p ? (IT)->cmp_it.charpos \
19224 : IT_CHARPOS (*(IT)); \
19225 ptrdiff_t current_bpos = \
19226 composition_p ? CHAR_TO_BYTE (current_pos) \
19227 : IT_BYTEPOS (*(IT)); \
19228 if (current_pos < min_pos) \
19230 min_pos = current_pos; \
19231 min_bpos = current_bpos; \
19233 if (IT_CHARPOS (*it) > max_pos) \
19235 max_pos = IT_CHARPOS (*it); \
19236 max_bpos = IT_BYTEPOS (*it); \
19241 /* Loop generating characters. The loop is left with IT on the next
19242 character to display. */
19245 int n_glyphs_before
, hpos_before
, x_before
;
19247 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19249 /* Retrieve the next thing to display. Value is zero if end of
19251 if (!get_next_display_element (it
))
19253 /* Maybe add a space at the end of this line that is used to
19254 display the cursor there under X. Set the charpos of the
19255 first glyph of blank lines not corresponding to any text
19257 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19258 row
->exact_window_width_line_p
= 1;
19259 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19260 || row
->used
[TEXT_AREA
] == 0)
19262 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19263 row
->displays_text_p
= 0;
19265 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19266 && (!MINI_WINDOW_P (it
->w
)
19267 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19268 row
->indicate_empty_line_p
= 1;
19271 it
->continuation_lines_width
= 0;
19272 row
->ends_at_zv_p
= 1;
19273 /* A row that displays right-to-left text must always have
19274 its last face extended all the way to the end of line,
19275 even if this row ends in ZV, because we still write to
19276 the screen left to right. We also need to extend the
19277 last face if the default face is remapped to some
19278 different face, otherwise the functions that clear
19279 portions of the screen will clear with the default face's
19280 background color. */
19281 if (row
->reversed_p
19282 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19283 extend_face_to_end_of_line (it
);
19287 /* Now, get the metrics of what we want to display. This also
19288 generates glyphs in `row' (which is IT->glyph_row). */
19289 n_glyphs_before
= row
->used
[TEXT_AREA
];
19292 /* Remember the line height so far in case the next element doesn't
19293 fit on the line. */
19294 if (it
->line_wrap
!= TRUNCATE
)
19296 ascent
= it
->max_ascent
;
19297 descent
= it
->max_descent
;
19298 phys_ascent
= it
->max_phys_ascent
;
19299 phys_descent
= it
->max_phys_descent
;
19301 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19303 if (IT_DISPLAYING_WHITESPACE (it
))
19307 SAVE_IT (wrap_it
, *it
, wrap_data
);
19309 wrap_row_used
= row
->used
[TEXT_AREA
];
19310 wrap_row_ascent
= row
->ascent
;
19311 wrap_row_height
= row
->height
;
19312 wrap_row_phys_ascent
= row
->phys_ascent
;
19313 wrap_row_phys_height
= row
->phys_height
;
19314 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19315 wrap_row_min_pos
= min_pos
;
19316 wrap_row_min_bpos
= min_bpos
;
19317 wrap_row_max_pos
= max_pos
;
19318 wrap_row_max_bpos
= max_bpos
;
19324 PRODUCE_GLYPHS (it
);
19326 /* If this display element was in marginal areas, continue with
19328 if (it
->area
!= TEXT_AREA
)
19330 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19331 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19332 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19333 row
->phys_height
= max (row
->phys_height
,
19334 it
->max_phys_ascent
+ it
->max_phys_descent
);
19335 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19336 it
->max_extra_line_spacing
);
19337 set_iterator_to_next (it
, 1);
19341 /* Does the display element fit on the line? If we truncate
19342 lines, we should draw past the right edge of the window. If
19343 we don't truncate, we want to stop so that we can display the
19344 continuation glyph before the right margin. If lines are
19345 continued, there are two possible strategies for characters
19346 resulting in more than 1 glyph (e.g. tabs): Display as many
19347 glyphs as possible in this line and leave the rest for the
19348 continuation line, or display the whole element in the next
19349 line. Original redisplay did the former, so we do it also. */
19350 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19351 hpos_before
= it
->hpos
;
19354 if (/* Not a newline. */
19356 /* Glyphs produced fit entirely in the line. */
19357 && it
->current_x
< it
->last_visible_x
)
19359 it
->hpos
+= nglyphs
;
19360 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19361 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19362 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19363 row
->phys_height
= max (row
->phys_height
,
19364 it
->max_phys_ascent
+ it
->max_phys_descent
);
19365 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19366 it
->max_extra_line_spacing
);
19367 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19368 row
->x
= x
- it
->first_visible_x
;
19369 /* Record the maximum and minimum buffer positions seen so
19370 far in glyphs that will be displayed by this row. */
19372 RECORD_MAX_MIN_POS (it
);
19377 struct glyph
*glyph
;
19379 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19381 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19382 new_x
= x
+ glyph
->pixel_width
;
19384 if (/* Lines are continued. */
19385 it
->line_wrap
!= TRUNCATE
19386 && (/* Glyph doesn't fit on the line. */
19387 new_x
> it
->last_visible_x
19388 /* Or it fits exactly on a window system frame. */
19389 || (new_x
== it
->last_visible_x
19390 && FRAME_WINDOW_P (it
->f
)
19391 && (row
->reversed_p
19392 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19393 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19395 /* End of a continued line. */
19398 || (new_x
== it
->last_visible_x
19399 && FRAME_WINDOW_P (it
->f
)
19400 && (row
->reversed_p
19401 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19402 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19404 /* Current glyph is the only one on the line or
19405 fits exactly on the line. We must continue
19406 the line because we can't draw the cursor
19407 after the glyph. */
19408 row
->continued_p
= 1;
19409 it
->current_x
= new_x
;
19410 it
->continuation_lines_width
+= new_x
;
19412 if (i
== nglyphs
- 1)
19414 /* If line-wrap is on, check if a previous
19415 wrap point was found. */
19416 if (wrap_row_used
> 0
19417 /* Even if there is a previous wrap
19418 point, continue the line here as
19419 usual, if (i) the previous character
19420 was a space or tab AND (ii) the
19421 current character is not. */
19423 || IT_DISPLAYING_WHITESPACE (it
)))
19426 /* Record the maximum and minimum buffer
19427 positions seen so far in glyphs that will be
19428 displayed by this row. */
19430 RECORD_MAX_MIN_POS (it
);
19431 set_iterator_to_next (it
, 1);
19432 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19434 if (!get_next_display_element (it
))
19436 row
->exact_window_width_line_p
= 1;
19437 it
->continuation_lines_width
= 0;
19438 row
->continued_p
= 0;
19439 row
->ends_at_zv_p
= 1;
19441 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19443 row
->continued_p
= 0;
19444 row
->exact_window_width_line_p
= 1;
19448 else if (it
->bidi_p
)
19449 RECORD_MAX_MIN_POS (it
);
19451 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19452 && !FRAME_WINDOW_P (it
->f
))
19454 /* A padding glyph that doesn't fit on this line.
19455 This means the whole character doesn't fit
19457 if (row
->reversed_p
)
19458 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19459 - n_glyphs_before
);
19460 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19462 /* Fill the rest of the row with continuation
19463 glyphs like in 20.x. */
19464 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19465 < row
->glyphs
[1 + TEXT_AREA
])
19466 produce_special_glyphs (it
, IT_CONTINUATION
);
19468 row
->continued_p
= 1;
19469 it
->current_x
= x_before
;
19470 it
->continuation_lines_width
+= x_before
;
19472 /* Restore the height to what it was before the
19473 element not fitting on the line. */
19474 it
->max_ascent
= ascent
;
19475 it
->max_descent
= descent
;
19476 it
->max_phys_ascent
= phys_ascent
;
19477 it
->max_phys_descent
= phys_descent
;
19479 else if (wrap_row_used
> 0)
19482 if (row
->reversed_p
)
19483 unproduce_glyphs (it
,
19484 row
->used
[TEXT_AREA
] - wrap_row_used
);
19485 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19486 it
->continuation_lines_width
+= wrap_x
;
19487 row
->used
[TEXT_AREA
] = wrap_row_used
;
19488 row
->ascent
= wrap_row_ascent
;
19489 row
->height
= wrap_row_height
;
19490 row
->phys_ascent
= wrap_row_phys_ascent
;
19491 row
->phys_height
= wrap_row_phys_height
;
19492 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19493 min_pos
= wrap_row_min_pos
;
19494 min_bpos
= wrap_row_min_bpos
;
19495 max_pos
= wrap_row_max_pos
;
19496 max_bpos
= wrap_row_max_bpos
;
19497 row
->continued_p
= 1;
19498 row
->ends_at_zv_p
= 0;
19499 row
->exact_window_width_line_p
= 0;
19500 it
->continuation_lines_width
+= x
;
19502 /* Make sure that a non-default face is extended
19503 up to the right margin of the window. */
19504 extend_face_to_end_of_line (it
);
19506 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19508 /* A TAB that extends past the right edge of the
19509 window. This produces a single glyph on
19510 window system frames. We leave the glyph in
19511 this row and let it fill the row, but don't
19512 consume the TAB. */
19513 if ((row
->reversed_p
19514 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19515 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19516 produce_special_glyphs (it
, IT_CONTINUATION
);
19517 it
->continuation_lines_width
+= it
->last_visible_x
;
19518 row
->ends_in_middle_of_char_p
= 1;
19519 row
->continued_p
= 1;
19520 glyph
->pixel_width
= it
->last_visible_x
- x
;
19521 it
->starts_in_middle_of_char_p
= 1;
19525 /* Something other than a TAB that draws past
19526 the right edge of the window. Restore
19527 positions to values before the element. */
19528 if (row
->reversed_p
)
19529 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19530 - (n_glyphs_before
+ i
));
19531 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19533 /* Display continuation glyphs. */
19534 it
->current_x
= x_before
;
19535 it
->continuation_lines_width
+= x
;
19536 if (!FRAME_WINDOW_P (it
->f
)
19537 || (row
->reversed_p
19538 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19539 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19540 produce_special_glyphs (it
, IT_CONTINUATION
);
19541 row
->continued_p
= 1;
19543 extend_face_to_end_of_line (it
);
19545 if (nglyphs
> 1 && i
> 0)
19547 row
->ends_in_middle_of_char_p
= 1;
19548 it
->starts_in_middle_of_char_p
= 1;
19551 /* Restore the height to what it was before the
19552 element not fitting on the line. */
19553 it
->max_ascent
= ascent
;
19554 it
->max_descent
= descent
;
19555 it
->max_phys_ascent
= phys_ascent
;
19556 it
->max_phys_descent
= phys_descent
;
19561 else if (new_x
> it
->first_visible_x
)
19563 /* Increment number of glyphs actually displayed. */
19566 /* Record the maximum and minimum buffer positions
19567 seen so far in glyphs that will be displayed by
19570 RECORD_MAX_MIN_POS (it
);
19572 if (x
< it
->first_visible_x
)
19573 /* Glyph is partially visible, i.e. row starts at
19574 negative X position. */
19575 row
->x
= x
- it
->first_visible_x
;
19579 /* Glyph is completely off the left margin of the
19580 window. This should not happen because of the
19581 move_it_in_display_line at the start of this
19582 function, unless the text display area of the
19583 window is empty. */
19584 eassert (it
->first_visible_x
<= it
->last_visible_x
);
19587 /* Even if this display element produced no glyphs at all,
19588 we want to record its position. */
19589 if (it
->bidi_p
&& nglyphs
== 0)
19590 RECORD_MAX_MIN_POS (it
);
19592 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19593 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19594 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19595 row
->phys_height
= max (row
->phys_height
,
19596 it
->max_phys_ascent
+ it
->max_phys_descent
);
19597 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19598 it
->max_extra_line_spacing
);
19600 /* End of this display line if row is continued. */
19601 if (row
->continued_p
|| row
->ends_at_zv_p
)
19606 /* Is this a line end? If yes, we're also done, after making
19607 sure that a non-default face is extended up to the right
19608 margin of the window. */
19609 if (ITERATOR_AT_END_OF_LINE_P (it
))
19611 int used_before
= row
->used
[TEXT_AREA
];
19613 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19615 /* Add a space at the end of the line that is used to
19616 display the cursor there. */
19617 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19618 append_space_for_newline (it
, 0);
19620 /* Extend the face to the end of the line. */
19621 extend_face_to_end_of_line (it
);
19623 /* Make sure we have the position. */
19624 if (used_before
== 0)
19625 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19627 /* Record the position of the newline, for use in
19629 it
->eol_pos
= it
->current
.pos
;
19631 /* Consume the line end. This skips over invisible lines. */
19632 set_iterator_to_next (it
, 1);
19633 it
->continuation_lines_width
= 0;
19637 /* Proceed with next display element. Note that this skips
19638 over lines invisible because of selective display. */
19639 set_iterator_to_next (it
, 1);
19641 /* If we truncate lines, we are done when the last displayed
19642 glyphs reach past the right margin of the window. */
19643 if (it
->line_wrap
== TRUNCATE
19644 && (FRAME_WINDOW_P (it
->f
) && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19645 ? (it
->current_x
>= it
->last_visible_x
)
19646 : (it
->current_x
> it
->last_visible_x
)))
19648 /* Maybe add truncation glyphs. */
19649 if (!FRAME_WINDOW_P (it
->f
)
19650 || (row
->reversed_p
19651 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19652 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19656 if (!row
->reversed_p
)
19658 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19659 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19664 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19665 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19667 /* Remove any padding glyphs at the front of ROW, to
19668 make room for the truncation glyphs we will be
19669 adding below. The loop below always inserts at
19670 least one truncation glyph, so also remove the
19671 last glyph added to ROW. */
19672 unproduce_glyphs (it
, i
+ 1);
19673 /* Adjust i for the loop below. */
19674 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19677 it
->current_x
= x_before
;
19678 if (!FRAME_WINDOW_P (it
->f
))
19680 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19682 row
->used
[TEXT_AREA
] = i
;
19683 produce_special_glyphs (it
, IT_TRUNCATION
);
19688 row
->used
[TEXT_AREA
] = i
;
19689 produce_special_glyphs (it
, IT_TRUNCATION
);
19692 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19694 /* Don't truncate if we can overflow newline into fringe. */
19695 if (!get_next_display_element (it
))
19697 it
->continuation_lines_width
= 0;
19698 row
->ends_at_zv_p
= 1;
19699 row
->exact_window_width_line_p
= 1;
19702 if (ITERATOR_AT_END_OF_LINE_P (it
))
19704 row
->exact_window_width_line_p
= 1;
19705 goto at_end_of_line
;
19707 it
->current_x
= x_before
;
19710 row
->truncated_on_right_p
= 1;
19711 it
->continuation_lines_width
= 0;
19712 reseat_at_next_visible_line_start (it
, 0);
19713 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19714 it
->hpos
= hpos_before
;
19720 bidi_unshelve_cache (wrap_data
, 1);
19722 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19723 at the left window margin. */
19724 if (it
->first_visible_x
19725 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19727 if (!FRAME_WINDOW_P (it
->f
)
19728 || (row
->reversed_p
19729 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19730 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
19731 insert_left_trunc_glyphs (it
);
19732 row
->truncated_on_left_p
= 1;
19735 /* Remember the position at which this line ends.
19737 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19738 cannot be before the call to find_row_edges below, since that is
19739 where these positions are determined. */
19740 row
->end
= it
->current
;
19743 row
->minpos
= row
->start
.pos
;
19744 row
->maxpos
= row
->end
.pos
;
19748 /* ROW->minpos and ROW->maxpos must be the smallest and
19749 `1 + the largest' buffer positions in ROW. But if ROW was
19750 bidi-reordered, these two positions can be anywhere in the
19751 row, so we must determine them now. */
19752 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19755 /* If the start of this line is the overlay arrow-position, then
19756 mark this glyph row as the one containing the overlay arrow.
19757 This is clearly a mess with variable size fonts. It would be
19758 better to let it be displayed like cursors under X. */
19759 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19760 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19761 !NILP (overlay_arrow_string
)))
19763 /* Overlay arrow in window redisplay is a fringe bitmap. */
19764 if (STRINGP (overlay_arrow_string
))
19766 struct glyph_row
*arrow_row
19767 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19768 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19769 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19770 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19771 struct glyph
*p2
, *end
;
19773 /* Copy the arrow glyphs. */
19774 while (glyph
< arrow_end
)
19777 /* Throw away padding glyphs. */
19779 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19780 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19786 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19791 eassert (INTEGERP (overlay_arrow_string
));
19792 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19794 overlay_arrow_seen
= 1;
19797 /* Highlight trailing whitespace. */
19798 if (!NILP (Vshow_trailing_whitespace
))
19799 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19801 /* Compute pixel dimensions of this line. */
19802 compute_line_metrics (it
);
19804 /* Implementation note: No changes in the glyphs of ROW or in their
19805 faces can be done past this point, because compute_line_metrics
19806 computes ROW's hash value and stores it within the glyph_row
19809 /* Record whether this row ends inside an ellipsis. */
19810 row
->ends_in_ellipsis_p
19811 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19812 && it
->ellipsis_p
);
19814 /* Save fringe bitmaps in this row. */
19815 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19816 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19817 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19818 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19820 it
->left_user_fringe_bitmap
= 0;
19821 it
->left_user_fringe_face_id
= 0;
19822 it
->right_user_fringe_bitmap
= 0;
19823 it
->right_user_fringe_face_id
= 0;
19825 /* Maybe set the cursor. */
19826 cvpos
= it
->w
->cursor
.vpos
;
19828 /* In bidi-reordered rows, keep checking for proper cursor
19829 position even if one has been found already, because buffer
19830 positions in such rows change non-linearly with ROW->VPOS,
19831 when a line is continued. One exception: when we are at ZV,
19832 display cursor on the first suitable glyph row, since all
19833 the empty rows after that also have their position set to ZV. */
19834 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19835 lines' rows is implemented for bidi-reordered rows. */
19837 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19838 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19839 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19840 && cursor_row_p (row
))
19841 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19843 /* Prepare for the next line. This line starts horizontally at (X
19844 HPOS) = (0 0). Vertical positions are incremented. As a
19845 convenience for the caller, IT->glyph_row is set to the next
19847 it
->current_x
= it
->hpos
= 0;
19848 it
->current_y
+= row
->height
;
19849 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19852 /* The next row should by default use the same value of the
19853 reversed_p flag as this one. set_iterator_to_next decides when
19854 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19855 the flag accordingly. */
19856 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19857 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19858 it
->start
= row
->end
;
19859 return row
->displays_text_p
;
19861 #undef RECORD_MAX_MIN_POS
19864 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19865 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19866 doc
: /* Return paragraph direction at point in BUFFER.
19867 Value is either `left-to-right' or `right-to-left'.
19868 If BUFFER is omitted or nil, it defaults to the current buffer.
19870 Paragraph direction determines how the text in the paragraph is displayed.
19871 In left-to-right paragraphs, text begins at the left margin of the window
19872 and the reading direction is generally left to right. In right-to-left
19873 paragraphs, text begins at the right margin and is read from right to left.
19875 See also `bidi-paragraph-direction'. */)
19876 (Lisp_Object buffer
)
19878 struct buffer
*buf
= current_buffer
;
19879 struct buffer
*old
= buf
;
19881 if (! NILP (buffer
))
19883 CHECK_BUFFER (buffer
);
19884 buf
= XBUFFER (buffer
);
19887 if (NILP (BVAR (buf
, bidi_display_reordering
))
19888 || NILP (BVAR (buf
, enable_multibyte_characters
))
19889 /* When we are loading loadup.el, the character property tables
19890 needed for bidi iteration are not yet available. */
19891 || !NILP (Vpurify_flag
))
19892 return Qleft_to_right
;
19893 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19894 return BVAR (buf
, bidi_paragraph_direction
);
19897 /* Determine the direction from buffer text. We could try to
19898 use current_matrix if it is up to date, but this seems fast
19899 enough as it is. */
19900 struct bidi_it itb
;
19901 ptrdiff_t pos
= BUF_PT (buf
);
19902 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
19904 void *itb_data
= bidi_shelve_cache ();
19906 set_buffer_temp (buf
);
19907 /* bidi_paragraph_init finds the base direction of the paragraph
19908 by searching forward from paragraph start. We need the base
19909 direction of the current or _previous_ paragraph, so we need
19910 to make sure we are within that paragraph. To that end, find
19911 the previous non-empty line. */
19912 if (pos
>= ZV
&& pos
> BEGV
)
19915 bytepos
= CHAR_TO_BYTE (pos
);
19917 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19918 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19920 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19921 || c
== ' ' || c
== '\t' || c
== '\f')
19923 if (bytepos
<= BEGV_BYTE
)
19928 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19931 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19932 itb
.paragraph_dir
= NEUTRAL_DIR
;
19933 itb
.string
.s
= NULL
;
19934 itb
.string
.lstring
= Qnil
;
19935 itb
.string
.bufpos
= 0;
19936 itb
.string
.unibyte
= 0;
19937 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19938 bidi_unshelve_cache (itb_data
, 0);
19939 set_buffer_temp (old
);
19940 switch (itb
.paragraph_dir
)
19943 return Qleft_to_right
;
19946 return Qright_to_left
;
19956 /***********************************************************************
19958 ***********************************************************************/
19960 /* Redisplay the menu bar in the frame for window W.
19962 The menu bar of X frames that don't have X toolkit support is
19963 displayed in a special window W->frame->menu_bar_window.
19965 The menu bar of terminal frames is treated specially as far as
19966 glyph matrices are concerned. Menu bar lines are not part of
19967 windows, so the update is done directly on the frame matrix rows
19968 for the menu bar. */
19971 display_menu_bar (struct window
*w
)
19973 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19978 /* Don't do all this for graphical frames. */
19980 if (FRAME_W32_P (f
))
19983 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19989 if (FRAME_NS_P (f
))
19991 #endif /* HAVE_NS */
19993 #ifdef USE_X_TOOLKIT
19994 eassert (!FRAME_WINDOW_P (f
));
19995 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19996 it
.first_visible_x
= 0;
19997 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19998 #else /* not USE_X_TOOLKIT */
19999 if (FRAME_WINDOW_P (f
))
20001 /* Menu bar lines are displayed in the desired matrix of the
20002 dummy window menu_bar_window. */
20003 struct window
*menu_w
;
20004 eassert (WINDOWP (f
->menu_bar_window
));
20005 menu_w
= XWINDOW (f
->menu_bar_window
);
20006 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
20008 it
.first_visible_x
= 0;
20009 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20013 /* This is a TTY frame, i.e. character hpos/vpos are used as
20015 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
20017 it
.first_visible_x
= 0;
20018 it
.last_visible_x
= FRAME_COLS (f
);
20020 #endif /* not USE_X_TOOLKIT */
20022 /* FIXME: This should be controlled by a user option. See the
20023 comments in redisplay_tool_bar and display_mode_line about
20025 it
.paragraph_embedding
= L2R
;
20027 /* Clear all rows of the menu bar. */
20028 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
20030 struct glyph_row
*row
= it
.glyph_row
+ i
;
20031 clear_glyph_row (row
);
20032 row
->enabled_p
= 1;
20033 row
->full_width_p
= 1;
20036 /* Display all items of the menu bar. */
20037 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
20038 for (i
= 0; i
< ASIZE (items
); i
+= 4)
20040 Lisp_Object string
;
20042 /* Stop at nil string. */
20043 string
= AREF (items
, i
+ 1);
20047 /* Remember where item was displayed. */
20048 ASET (items
, i
+ 3, make_number (it
.hpos
));
20050 /* Display the item, pad with one space. */
20051 if (it
.current_x
< it
.last_visible_x
)
20052 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
20053 SCHARS (string
) + 1, 0, 0, -1);
20056 /* Fill out the line with spaces. */
20057 if (it
.current_x
< it
.last_visible_x
)
20058 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
20060 /* Compute the total height of the lines. */
20061 compute_line_metrics (&it
);
20066 /***********************************************************************
20068 ***********************************************************************/
20070 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20071 FORCE is non-zero, redisplay mode lines unconditionally.
20072 Otherwise, redisplay only mode lines that are garbaged. Value is
20073 the number of windows whose mode lines were redisplayed. */
20076 redisplay_mode_lines (Lisp_Object window
, int force
)
20080 while (!NILP (window
))
20082 struct window
*w
= XWINDOW (window
);
20084 if (WINDOWP (w
->hchild
))
20085 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
20086 else if (WINDOWP (w
->vchild
))
20087 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
20089 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20090 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20092 struct text_pos lpoint
;
20093 struct buffer
*old
= current_buffer
;
20095 /* Set the window's buffer for the mode line display. */
20096 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20097 set_buffer_internal_1 (XBUFFER (w
->buffer
));
20099 /* Point refers normally to the selected window. For any
20100 other window, set up appropriate value. */
20101 if (!EQ (window
, selected_window
))
20103 struct text_pos pt
;
20105 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20106 if (CHARPOS (pt
) < BEGV
)
20107 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
20108 else if (CHARPOS (pt
) > (ZV
- 1))
20109 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
20111 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20114 /* Display mode lines. */
20115 clear_glyph_matrix (w
->desired_matrix
);
20116 if (display_mode_lines (w
))
20119 w
->must_be_updated_p
= 1;
20122 /* Restore old settings. */
20123 set_buffer_internal_1 (old
);
20124 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20134 /* Display the mode and/or header line of window W. Value is the
20135 sum number of mode lines and header lines displayed. */
20138 display_mode_lines (struct window
*w
)
20140 Lisp_Object old_selected_window
= selected_window
;
20141 Lisp_Object old_selected_frame
= selected_frame
;
20142 Lisp_Object new_frame
= w
->frame
;
20143 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
20146 selected_frame
= new_frame
;
20147 /* FIXME: If we were to allow the mode-line's computation changing the buffer
20148 or window's point, then we'd need select_window_1 here as well. */
20149 XSETWINDOW (selected_window
, w
);
20150 XFRAME (new_frame
)->selected_window
= selected_window
;
20152 /* These will be set while the mode line specs are processed. */
20153 line_number_displayed
= 0;
20154 w
->column_number_displayed
= -1;
20156 if (WINDOW_WANTS_MODELINE_P (w
))
20158 struct window
*sel_w
= XWINDOW (old_selected_window
);
20160 /* Select mode line face based on the real selected window. */
20161 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20162 BVAR (current_buffer
, mode_line_format
));
20166 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20168 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20169 BVAR (current_buffer
, header_line_format
));
20173 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
20174 selected_frame
= old_selected_frame
;
20175 selected_window
= old_selected_window
;
20180 /* Display mode or header line of window W. FACE_ID specifies which
20181 line to display; it is either MODE_LINE_FACE_ID or
20182 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20183 display. Value is the pixel height of the mode/header line
20187 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20191 ptrdiff_t count
= SPECPDL_INDEX ();
20193 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20194 /* Don't extend on a previously drawn mode-line.
20195 This may happen if called from pos_visible_p. */
20196 it
.glyph_row
->enabled_p
= 0;
20197 prepare_desired_row (it
.glyph_row
);
20199 it
.glyph_row
->mode_line_p
= 1;
20201 /* FIXME: This should be controlled by a user option. But
20202 supporting such an option is not trivial, since the mode line is
20203 made up of many separate strings. */
20204 it
.paragraph_embedding
= L2R
;
20206 record_unwind_protect (unwind_format_mode_line
,
20207 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
20209 mode_line_target
= MODE_LINE_DISPLAY
;
20211 /* Temporarily make frame's keyboard the current kboard so that
20212 kboard-local variables in the mode_line_format will get the right
20214 push_kboard (FRAME_KBOARD (it
.f
));
20215 record_unwind_save_match_data ();
20216 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20219 unbind_to (count
, Qnil
);
20221 /* Fill up with spaces. */
20222 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20224 compute_line_metrics (&it
);
20225 it
.glyph_row
->full_width_p
= 1;
20226 it
.glyph_row
->continued_p
= 0;
20227 it
.glyph_row
->truncated_on_left_p
= 0;
20228 it
.glyph_row
->truncated_on_right_p
= 0;
20230 /* Make a 3D mode-line have a shadow at its right end. */
20231 face
= FACE_FROM_ID (it
.f
, face_id
);
20232 extend_face_to_end_of_line (&it
);
20233 if (face
->box
!= FACE_NO_BOX
)
20235 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20236 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20237 last
->right_box_line_p
= 1;
20240 return it
.glyph_row
->height
;
20243 /* Move element ELT in LIST to the front of LIST.
20244 Return the updated list. */
20247 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20249 register Lisp_Object tail
, prev
;
20250 register Lisp_Object tem
;
20254 while (CONSP (tail
))
20260 /* Splice out the link TAIL. */
20262 list
= XCDR (tail
);
20264 Fsetcdr (prev
, XCDR (tail
));
20266 /* Now make it the first. */
20267 Fsetcdr (tail
, list
);
20272 tail
= XCDR (tail
);
20276 /* Not found--return unchanged LIST. */
20280 /* Contribute ELT to the mode line for window IT->w. How it
20281 translates into text depends on its data type.
20283 IT describes the display environment in which we display, as usual.
20285 DEPTH is the depth in recursion. It is used to prevent
20286 infinite recursion here.
20288 FIELD_WIDTH is the number of characters the display of ELT should
20289 occupy in the mode line, and PRECISION is the maximum number of
20290 characters to display from ELT's representation. See
20291 display_string for details.
20293 Returns the hpos of the end of the text generated by ELT.
20295 PROPS is a property list to add to any string we encounter.
20297 If RISKY is nonzero, remove (disregard) any properties in any string
20298 we encounter, and ignore :eval and :propertize.
20300 The global variable `mode_line_target' determines whether the
20301 output is passed to `store_mode_line_noprop',
20302 `store_mode_line_string', or `display_string'. */
20305 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20306 Lisp_Object elt
, Lisp_Object props
, int risky
)
20308 int n
= 0, field
, prec
;
20313 elt
= build_string ("*too-deep*");
20317 switch (XTYPE (elt
))
20321 /* A string: output it and check for %-constructs within it. */
20323 ptrdiff_t offset
= 0;
20325 if (SCHARS (elt
) > 0
20326 && (!NILP (props
) || risky
))
20328 Lisp_Object oprops
, aelt
;
20329 oprops
= Ftext_properties_at (make_number (0), elt
);
20331 /* If the starting string's properties are not what
20332 we want, translate the string. Also, if the string
20333 is risky, do that anyway. */
20335 if (NILP (Fequal (props
, oprops
)) || risky
)
20337 /* If the starting string has properties,
20338 merge the specified ones onto the existing ones. */
20339 if (! NILP (oprops
) && !risky
)
20343 oprops
= Fcopy_sequence (oprops
);
20345 while (CONSP (tem
))
20347 oprops
= Fplist_put (oprops
, XCAR (tem
),
20348 XCAR (XCDR (tem
)));
20349 tem
= XCDR (XCDR (tem
));
20354 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20355 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20357 /* AELT is what we want. Move it to the front
20358 without consing. */
20360 mode_line_proptrans_alist
20361 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20367 /* If AELT has the wrong props, it is useless.
20368 so get rid of it. */
20370 mode_line_proptrans_alist
20371 = Fdelq (aelt
, mode_line_proptrans_alist
);
20373 elt
= Fcopy_sequence (elt
);
20374 Fset_text_properties (make_number (0), Flength (elt
),
20376 /* Add this item to mode_line_proptrans_alist. */
20377 mode_line_proptrans_alist
20378 = Fcons (Fcons (elt
, props
),
20379 mode_line_proptrans_alist
);
20380 /* Truncate mode_line_proptrans_alist
20381 to at most 50 elements. */
20382 tem
= Fnthcdr (make_number (50),
20383 mode_line_proptrans_alist
);
20385 XSETCDR (tem
, Qnil
);
20394 prec
= precision
- n
;
20395 switch (mode_line_target
)
20397 case MODE_LINE_NOPROP
:
20398 case MODE_LINE_TITLE
:
20399 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20401 case MODE_LINE_STRING
:
20402 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20404 case MODE_LINE_DISPLAY
:
20405 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20406 0, prec
, 0, STRING_MULTIBYTE (elt
));
20413 /* Handle the non-literal case. */
20415 while ((precision
<= 0 || n
< precision
)
20416 && SREF (elt
, offset
) != 0
20417 && (mode_line_target
!= MODE_LINE_DISPLAY
20418 || it
->current_x
< it
->last_visible_x
))
20420 ptrdiff_t last_offset
= offset
;
20422 /* Advance to end of string or next format specifier. */
20423 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20426 if (offset
- 1 != last_offset
)
20428 ptrdiff_t nchars
, nbytes
;
20430 /* Output to end of string or up to '%'. Field width
20431 is length of string. Don't output more than
20432 PRECISION allows us. */
20435 prec
= c_string_width (SDATA (elt
) + last_offset
,
20436 offset
- last_offset
, precision
- n
,
20439 switch (mode_line_target
)
20441 case MODE_LINE_NOPROP
:
20442 case MODE_LINE_TITLE
:
20443 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20445 case MODE_LINE_STRING
:
20447 ptrdiff_t bytepos
= last_offset
;
20448 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20449 ptrdiff_t endpos
= (precision
<= 0
20450 ? string_byte_to_char (elt
, offset
)
20451 : charpos
+ nchars
);
20453 n
+= store_mode_line_string (NULL
,
20454 Fsubstring (elt
, make_number (charpos
),
20455 make_number (endpos
)),
20459 case MODE_LINE_DISPLAY
:
20461 ptrdiff_t bytepos
= last_offset
;
20462 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20464 if (precision
<= 0)
20465 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20466 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20468 STRING_MULTIBYTE (elt
));
20473 else /* c == '%' */
20475 ptrdiff_t percent_position
= offset
;
20477 /* Get the specified minimum width. Zero means
20480 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20481 field
= field
* 10 + c
- '0';
20483 /* Don't pad beyond the total padding allowed. */
20484 if (field_width
- n
> 0 && field
> field_width
- n
)
20485 field
= field_width
- n
;
20487 /* Note that either PRECISION <= 0 or N < PRECISION. */
20488 prec
= precision
- n
;
20491 n
+= display_mode_element (it
, depth
, field
, prec
,
20492 Vglobal_mode_string
, props
,
20497 ptrdiff_t bytepos
, charpos
;
20499 Lisp_Object string
;
20501 bytepos
= percent_position
;
20502 charpos
= (STRING_MULTIBYTE (elt
)
20503 ? string_byte_to_char (elt
, bytepos
)
20505 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20506 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20508 switch (mode_line_target
)
20510 case MODE_LINE_NOPROP
:
20511 case MODE_LINE_TITLE
:
20512 n
+= store_mode_line_noprop (spec
, field
, prec
);
20514 case MODE_LINE_STRING
:
20516 Lisp_Object tem
= build_string (spec
);
20517 props
= Ftext_properties_at (make_number (charpos
), elt
);
20518 /* Should only keep face property in props */
20519 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20522 case MODE_LINE_DISPLAY
:
20524 int nglyphs_before
, nwritten
;
20526 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20527 nwritten
= display_string (spec
, string
, elt
,
20532 /* Assign to the glyphs written above the
20533 string where the `%x' came from, position
20537 struct glyph
*glyph
20538 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20542 for (i
= 0; i
< nwritten
; ++i
)
20544 glyph
[i
].object
= elt
;
20545 glyph
[i
].charpos
= charpos
;
20562 /* A symbol: process the value of the symbol recursively
20563 as if it appeared here directly. Avoid error if symbol void.
20564 Special case: if value of symbol is a string, output the string
20567 register Lisp_Object tem
;
20569 /* If the variable is not marked as risky to set
20570 then its contents are risky to use. */
20571 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20574 tem
= Fboundp (elt
);
20577 tem
= Fsymbol_value (elt
);
20578 /* If value is a string, output that string literally:
20579 don't check for % within it. */
20583 if (!EQ (tem
, elt
))
20585 /* Give up right away for nil or t. */
20595 register Lisp_Object car
, tem
;
20597 /* A cons cell: five distinct cases.
20598 If first element is :eval or :propertize, do something special.
20599 If first element is a string or a cons, process all the elements
20600 and effectively concatenate them.
20601 If first element is a negative number, truncate displaying cdr to
20602 at most that many characters. If positive, pad (with spaces)
20603 to at least that many characters.
20604 If first element is a symbol, process the cadr or caddr recursively
20605 according to whether the symbol's value is non-nil or nil. */
20607 if (EQ (car
, QCeval
))
20609 /* An element of the form (:eval FORM) means evaluate FORM
20610 and use the result as mode line elements. */
20615 if (CONSP (XCDR (elt
)))
20618 spec
= safe_eval (XCAR (XCDR (elt
)));
20619 n
+= display_mode_element (it
, depth
, field_width
- n
,
20620 precision
- n
, spec
, props
,
20624 else if (EQ (car
, QCpropertize
))
20626 /* An element of the form (:propertize ELT PROPS...)
20627 means display ELT but applying properties PROPS. */
20632 if (CONSP (XCDR (elt
)))
20633 n
+= display_mode_element (it
, depth
, field_width
- n
,
20634 precision
- n
, XCAR (XCDR (elt
)),
20635 XCDR (XCDR (elt
)), risky
);
20637 else if (SYMBOLP (car
))
20639 tem
= Fboundp (car
);
20643 /* elt is now the cdr, and we know it is a cons cell.
20644 Use its car if CAR has a non-nil value. */
20647 tem
= Fsymbol_value (car
);
20654 /* Symbol's value is nil (or symbol is unbound)
20655 Get the cddr of the original list
20656 and if possible find the caddr and use that. */
20660 else if (!CONSP (elt
))
20665 else if (INTEGERP (car
))
20667 register int lim
= XINT (car
);
20671 /* Negative int means reduce maximum width. */
20672 if (precision
<= 0)
20675 precision
= min (precision
, -lim
);
20679 /* Padding specified. Don't let it be more than
20680 current maximum. */
20682 lim
= min (precision
, lim
);
20684 /* If that's more padding than already wanted, queue it.
20685 But don't reduce padding already specified even if
20686 that is beyond the current truncation point. */
20687 field_width
= max (lim
, field_width
);
20691 else if (STRINGP (car
) || CONSP (car
))
20693 Lisp_Object halftail
= elt
;
20697 && (precision
<= 0 || n
< precision
))
20699 n
+= display_mode_element (it
, depth
,
20700 /* Do padding only after the last
20701 element in the list. */
20702 (! CONSP (XCDR (elt
))
20705 precision
- n
, XCAR (elt
),
20709 if ((len
& 1) == 0)
20710 halftail
= XCDR (halftail
);
20711 /* Check for cycle. */
20712 if (EQ (halftail
, elt
))
20721 elt
= build_string ("*invalid*");
20725 /* Pad to FIELD_WIDTH. */
20726 if (field_width
> 0 && n
< field_width
)
20728 switch (mode_line_target
)
20730 case MODE_LINE_NOPROP
:
20731 case MODE_LINE_TITLE
:
20732 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20734 case MODE_LINE_STRING
:
20735 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20737 case MODE_LINE_DISPLAY
:
20738 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20747 /* Store a mode-line string element in mode_line_string_list.
20749 If STRING is non-null, display that C string. Otherwise, the Lisp
20750 string LISP_STRING is displayed.
20752 FIELD_WIDTH is the minimum number of output glyphs to produce.
20753 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20754 with spaces. FIELD_WIDTH <= 0 means don't pad.
20756 PRECISION is the maximum number of characters to output from
20757 STRING. PRECISION <= 0 means don't truncate the string.
20759 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20760 properties to the string.
20762 PROPS are the properties to add to the string.
20763 The mode_line_string_face face property is always added to the string.
20767 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20768 int field_width
, int precision
, Lisp_Object props
)
20773 if (string
!= NULL
)
20775 len
= strlen (string
);
20776 if (precision
> 0 && len
> precision
)
20778 lisp_string
= make_string (string
, len
);
20780 props
= mode_line_string_face_prop
;
20781 else if (!NILP (mode_line_string_face
))
20783 Lisp_Object face
= Fplist_get (props
, Qface
);
20784 props
= Fcopy_sequence (props
);
20786 face
= mode_line_string_face
;
20788 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20789 props
= Fplist_put (props
, Qface
, face
);
20791 Fadd_text_properties (make_number (0), make_number (len
),
20792 props
, lisp_string
);
20796 len
= XFASTINT (Flength (lisp_string
));
20797 if (precision
> 0 && len
> precision
)
20800 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20803 if (!NILP (mode_line_string_face
))
20807 props
= Ftext_properties_at (make_number (0), lisp_string
);
20808 face
= Fplist_get (props
, Qface
);
20810 face
= mode_line_string_face
;
20812 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20813 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20815 lisp_string
= Fcopy_sequence (lisp_string
);
20818 Fadd_text_properties (make_number (0), make_number (len
),
20819 props
, lisp_string
);
20824 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20828 if (field_width
> len
)
20830 field_width
-= len
;
20831 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20833 Fadd_text_properties (make_number (0), make_number (field_width
),
20834 props
, lisp_string
);
20835 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20843 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20845 doc
: /* Format a string out of a mode line format specification.
20846 First arg FORMAT specifies the mode line format (see `mode-line-format'
20847 for details) to use.
20849 By default, the format is evaluated for the currently selected window.
20851 Optional second arg FACE specifies the face property to put on all
20852 characters for which no face is specified. The value nil means the
20853 default face. The value t means whatever face the window's mode line
20854 currently uses (either `mode-line' or `mode-line-inactive',
20855 depending on whether the window is the selected window or not).
20856 An integer value means the value string has no text
20859 Optional third and fourth args WINDOW and BUFFER specify the window
20860 and buffer to use as the context for the formatting (defaults
20861 are the selected window and the WINDOW's buffer). */)
20862 (Lisp_Object format
, Lisp_Object face
,
20863 Lisp_Object window
, Lisp_Object buffer
)
20868 struct buffer
*old_buffer
= NULL
;
20870 int no_props
= INTEGERP (face
);
20871 ptrdiff_t count
= SPECPDL_INDEX ();
20873 int string_start
= 0;
20875 w
= decode_any_window (window
);
20876 XSETWINDOW (window
, w
);
20879 buffer
= w
->buffer
;
20880 CHECK_BUFFER (buffer
);
20882 /* Make formatting the modeline a non-op when noninteractive, otherwise
20883 there will be problems later caused by a partially initialized frame. */
20884 if (NILP (format
) || noninteractive
)
20885 return empty_unibyte_string
;
20890 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20891 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20892 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20893 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20894 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20895 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20896 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20899 old_buffer
= current_buffer
;
20901 /* Save things including mode_line_proptrans_alist,
20902 and set that to nil so that we don't alter the outer value. */
20903 record_unwind_protect (unwind_format_mode_line
,
20904 format_mode_line_unwind_data
20905 (XFRAME (WINDOW_FRAME (w
)),
20906 old_buffer
, selected_window
, 1));
20907 mode_line_proptrans_alist
= Qnil
;
20909 Fselect_window (window
, Qt
);
20910 set_buffer_internal_1 (XBUFFER (buffer
));
20912 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20916 mode_line_target
= MODE_LINE_NOPROP
;
20917 mode_line_string_face_prop
= Qnil
;
20918 mode_line_string_list
= Qnil
;
20919 string_start
= MODE_LINE_NOPROP_LEN (0);
20923 mode_line_target
= MODE_LINE_STRING
;
20924 mode_line_string_list
= Qnil
;
20925 mode_line_string_face
= face
;
20926 mode_line_string_face_prop
20927 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20930 push_kboard (FRAME_KBOARD (it
.f
));
20931 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20936 len
= MODE_LINE_NOPROP_LEN (string_start
);
20937 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20941 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20942 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20943 empty_unibyte_string
);
20946 unbind_to (count
, Qnil
);
20950 /* Write a null-terminated, right justified decimal representation of
20951 the positive integer D to BUF using a minimal field width WIDTH. */
20954 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
20956 register char *p
= buf
;
20964 *p
++ = d
% 10 + '0';
20969 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20980 /* Write a null-terminated, right justified decimal and "human
20981 readable" representation of the nonnegative integer D to BUF using
20982 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20984 static const char power_letter
[] =
20998 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
21000 /* We aim to represent the nonnegative integer D as
21001 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
21002 ptrdiff_t quotient
= d
;
21004 /* -1 means: do not use TENTHS. */
21008 /* Length of QUOTIENT.TENTHS as a string. */
21014 if (1000 <= quotient
)
21016 /* Scale to the appropriate EXPONENT. */
21019 remainder
= quotient
% 1000;
21023 while (1000 <= quotient
);
21025 /* Round to nearest and decide whether to use TENTHS or not. */
21028 tenths
= remainder
/ 100;
21029 if (50 <= remainder
% 100)
21036 if (quotient
== 10)
21044 if (500 <= remainder
)
21046 if (quotient
< 999)
21057 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21058 if (tenths
== -1 && quotient
<= 99)
21065 p
= psuffix
= buf
+ max (width
, length
);
21067 /* Print EXPONENT. */
21068 *psuffix
++ = power_letter
[exponent
];
21071 /* Print TENTHS. */
21074 *--p
= '0' + tenths
;
21078 /* Print QUOTIENT. */
21081 int digit
= quotient
% 10;
21082 *--p
= '0' + digit
;
21084 while ((quotient
/= 10) != 0);
21086 /* Print leading spaces. */
21091 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21092 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21093 type of CODING_SYSTEM. Return updated pointer into BUF. */
21095 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21098 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21101 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21102 const unsigned char *eol_str
;
21104 /* The EOL conversion we are using. */
21105 Lisp_Object eoltype
;
21107 val
= CODING_SYSTEM_SPEC (coding_system
);
21110 if (!VECTORP (val
)) /* Not yet decided. */
21112 *buf
++ = multibyte
? '-' : ' ';
21114 eoltype
= eol_mnemonic_undecided
;
21115 /* Don't mention EOL conversion if it isn't decided. */
21120 Lisp_Object eolvalue
;
21122 attrs
= AREF (val
, 0);
21123 eolvalue
= AREF (val
, 2);
21126 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21131 /* The EOL conversion that is normal on this system. */
21133 if (NILP (eolvalue
)) /* Not yet decided. */
21134 eoltype
= eol_mnemonic_undecided
;
21135 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21136 eoltype
= eol_mnemonic_undecided
;
21137 else /* eolvalue is Qunix, Qdos, or Qmac. */
21138 eoltype
= (EQ (eolvalue
, Qunix
)
21139 ? eol_mnemonic_unix
21140 : (EQ (eolvalue
, Qdos
) == 1
21141 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21147 /* Mention the EOL conversion if it is not the usual one. */
21148 if (STRINGP (eoltype
))
21150 eol_str
= SDATA (eoltype
);
21151 eol_str_len
= SBYTES (eoltype
);
21153 else if (CHARACTERP (eoltype
))
21155 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
21156 int c
= XFASTINT (eoltype
);
21157 eol_str_len
= CHAR_STRING (c
, tmp
);
21162 eol_str
= invalid_eol_type
;
21163 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21165 memcpy (buf
, eol_str
, eol_str_len
);
21166 buf
+= eol_str_len
;
21172 /* Return a string for the output of a mode line %-spec for window W,
21173 generated by character C. FIELD_WIDTH > 0 means pad the string
21174 returned with spaces to that value. Return a Lisp string in
21175 *STRING if the resulting string is taken from that Lisp string.
21177 Note we operate on the current buffer for most purposes. */
21179 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21181 static const char *
21182 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21183 Lisp_Object
*string
)
21186 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21187 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21188 /* We are going to use f->decode_mode_spec_buffer as the buffer to
21189 produce strings from numerical values, so limit preposterously
21190 large values of FIELD_WIDTH to avoid overrunning the buffer's
21191 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
21192 bytes plus the terminating null. */
21193 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
21194 struct buffer
*b
= current_buffer
;
21202 if (!NILP (BVAR (b
, read_only
)))
21204 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21209 /* This differs from %* only for a modified read-only buffer. */
21210 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21212 if (!NILP (BVAR (b
, read_only
)))
21217 /* This differs from %* in ignoring read-only-ness. */
21218 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21230 if (command_loop_level
> 5)
21232 p
= decode_mode_spec_buf
;
21233 for (i
= 0; i
< command_loop_level
; i
++)
21236 return decode_mode_spec_buf
;
21244 if (command_loop_level
> 5)
21246 p
= decode_mode_spec_buf
;
21247 for (i
= 0; i
< command_loop_level
; i
++)
21250 return decode_mode_spec_buf
;
21257 /* Let lots_of_dashes be a string of infinite length. */
21258 if (mode_line_target
== MODE_LINE_NOPROP
21259 || mode_line_target
== MODE_LINE_STRING
)
21261 if (field_width
<= 0
21262 || field_width
> sizeof (lots_of_dashes
))
21264 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21265 decode_mode_spec_buf
[i
] = '-';
21266 decode_mode_spec_buf
[i
] = '\0';
21267 return decode_mode_spec_buf
;
21270 return lots_of_dashes
;
21274 obj
= BVAR (b
, name
);
21278 /* %c and %l are ignored in `frame-title-format'.
21279 (In redisplay_internal, the frame title is drawn _before_ the
21280 windows are updated, so the stuff which depends on actual
21281 window contents (such as %l) may fail to render properly, or
21282 even crash emacs.) */
21283 if (mode_line_target
== MODE_LINE_TITLE
)
21287 ptrdiff_t col
= current_column ();
21288 w
->column_number_displayed
= col
;
21289 pint2str (decode_mode_spec_buf
, width
, col
);
21290 return decode_mode_spec_buf
;
21294 #ifndef SYSTEM_MALLOC
21296 if (NILP (Vmemory_full
))
21299 return "!MEM FULL! ";
21306 /* %F displays the frame name. */
21307 if (!NILP (f
->title
))
21308 return SSDATA (f
->title
);
21309 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21310 return SSDATA (f
->name
);
21314 obj
= BVAR (b
, filename
);
21319 ptrdiff_t size
= ZV
- BEGV
;
21320 pint2str (decode_mode_spec_buf
, width
, size
);
21321 return decode_mode_spec_buf
;
21326 ptrdiff_t size
= ZV
- BEGV
;
21327 pint2hrstr (decode_mode_spec_buf
, width
, size
);
21328 return decode_mode_spec_buf
;
21333 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21334 ptrdiff_t topline
, nlines
, height
;
21337 /* %c and %l are ignored in `frame-title-format'. */
21338 if (mode_line_target
== MODE_LINE_TITLE
)
21341 startpos
= marker_position (w
->start
);
21342 startpos_byte
= marker_byte_position (w
->start
);
21343 height
= WINDOW_TOTAL_LINES (w
);
21345 /* If we decided that this buffer isn't suitable for line numbers,
21346 don't forget that too fast. */
21347 if (w
->base_line_pos
== -1)
21350 /* If the buffer is very big, don't waste time. */
21351 if (INTEGERP (Vline_number_display_limit
)
21352 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21354 w
->base_line_pos
= 0;
21355 w
->base_line_number
= 0;
21359 if (w
->base_line_number
> 0
21360 && w
->base_line_pos
> 0
21361 && w
->base_line_pos
<= startpos
)
21363 line
= w
->base_line_number
;
21364 linepos
= w
->base_line_pos
;
21365 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21370 linepos
= BUF_BEGV (b
);
21371 linepos_byte
= BUF_BEGV_BYTE (b
);
21374 /* Count lines from base line to window start position. */
21375 nlines
= display_count_lines (linepos_byte
,
21379 topline
= nlines
+ line
;
21381 /* Determine a new base line, if the old one is too close
21382 or too far away, or if we did not have one.
21383 "Too close" means it's plausible a scroll-down would
21384 go back past it. */
21385 if (startpos
== BUF_BEGV (b
))
21387 w
->base_line_number
= topline
;
21388 w
->base_line_pos
= BUF_BEGV (b
);
21390 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21391 || linepos
== BUF_BEGV (b
))
21393 ptrdiff_t limit
= BUF_BEGV (b
);
21394 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21395 ptrdiff_t position
;
21396 ptrdiff_t distance
=
21397 (height
* 2 + 30) * line_number_display_limit_width
;
21399 if (startpos
- distance
> limit
)
21401 limit
= startpos
- distance
;
21402 limit_byte
= CHAR_TO_BYTE (limit
);
21405 nlines
= display_count_lines (startpos_byte
,
21407 - (height
* 2 + 30),
21409 /* If we couldn't find the lines we wanted within
21410 line_number_display_limit_width chars per line,
21411 give up on line numbers for this window. */
21412 if (position
== limit_byte
&& limit
== startpos
- distance
)
21414 w
->base_line_pos
= -1;
21415 w
->base_line_number
= 0;
21419 w
->base_line_number
= topline
- nlines
;
21420 w
->base_line_pos
= BYTE_TO_CHAR (position
);
21423 /* Now count lines from the start pos to point. */
21424 nlines
= display_count_lines (startpos_byte
,
21425 PT_BYTE
, PT
, &junk
);
21427 /* Record that we did display the line number. */
21428 line_number_displayed
= 1;
21430 /* Make the string to show. */
21431 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
21432 return decode_mode_spec_buf
;
21435 char* p
= decode_mode_spec_buf
;
21436 int pad
= width
- 2;
21442 return decode_mode_spec_buf
;
21448 obj
= BVAR (b
, mode_name
);
21452 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21458 ptrdiff_t pos
= marker_position (w
->start
);
21459 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21461 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21463 if (pos
<= BUF_BEGV (b
))
21468 else if (pos
<= BUF_BEGV (b
))
21472 if (total
> 1000000)
21473 /* Do it differently for a large value, to avoid overflow. */
21474 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21476 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21477 /* We can't normally display a 3-digit number,
21478 so get us a 2-digit number that is close. */
21481 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21482 return decode_mode_spec_buf
;
21486 /* Display percentage of size above the bottom of the screen. */
21489 ptrdiff_t toppos
= marker_position (w
->start
);
21490 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21491 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21493 if (botpos
>= BUF_ZV (b
))
21495 if (toppos
<= BUF_BEGV (b
))
21502 if (total
> 1000000)
21503 /* Do it differently for a large value, to avoid overflow. */
21504 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21506 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21507 /* We can't normally display a 3-digit number,
21508 so get us a 2-digit number that is close. */
21511 if (toppos
<= BUF_BEGV (b
))
21512 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21514 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21515 return decode_mode_spec_buf
;
21520 /* status of process */
21521 obj
= Fget_buffer_process (Fcurrent_buffer ());
21523 return "no process";
21525 obj
= Fsymbol_name (Fprocess_status (obj
));
21531 ptrdiff_t count
= inhibit_garbage_collection ();
21532 Lisp_Object val
= call1 (intern ("file-remote-p"),
21533 BVAR (current_buffer
, directory
));
21534 unbind_to (count
, Qnil
);
21543 /* coding-system (not including end-of-line format) */
21545 /* coding-system (including end-of-line type) */
21547 int eol_flag
= (c
== 'Z');
21548 char *p
= decode_mode_spec_buf
;
21550 if (! FRAME_WINDOW_P (f
))
21552 /* No need to mention EOL here--the terminal never needs
21553 to do EOL conversion. */
21554 p
= decode_mode_spec_coding (CODING_ID_NAME
21555 (FRAME_KEYBOARD_CODING (f
)->id
),
21557 p
= decode_mode_spec_coding (CODING_ID_NAME
21558 (FRAME_TERMINAL_CODING (f
)->id
),
21561 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21564 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21565 #ifdef subprocesses
21566 obj
= Fget_buffer_process (Fcurrent_buffer ());
21567 if (PROCESSP (obj
))
21569 p
= decode_mode_spec_coding
21570 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
21571 p
= decode_mode_spec_coding
21572 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
21574 #endif /* subprocesses */
21577 return decode_mode_spec_buf
;
21584 return SSDATA (obj
);
21591 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
21592 means count lines back from START_BYTE. But don't go beyond
21593 LIMIT_BYTE. Return the number of lines thus found (always
21596 Set *BYTE_POS_PTR to the byte position where we stopped. This is
21597 either the position COUNT lines after/before START_BYTE, if we
21598 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
21602 display_count_lines (ptrdiff_t start_byte
,
21603 ptrdiff_t limit_byte
, ptrdiff_t count
,
21604 ptrdiff_t *byte_pos_ptr
)
21606 register unsigned char *cursor
;
21607 unsigned char *base
;
21609 register ptrdiff_t ceiling
;
21610 register unsigned char *ceiling_addr
;
21611 ptrdiff_t orig_count
= count
;
21613 /* If we are not in selective display mode,
21614 check only for newlines. */
21615 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21616 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21620 while (start_byte
< limit_byte
)
21622 ceiling
= BUFFER_CEILING_OF (start_byte
);
21623 ceiling
= min (limit_byte
- 1, ceiling
);
21624 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21625 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21629 if (selective_display
)
21631 while (*cursor
!= '\n' && *cursor
!= 015
21632 && ++cursor
!= ceiling_addr
)
21634 if (cursor
== ceiling_addr
)
21639 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
21648 start_byte
+= cursor
- base
;
21649 *byte_pos_ptr
= start_byte
;
21653 while (cursor
< ceiling_addr
);
21655 start_byte
+= ceiling_addr
- base
;
21660 while (start_byte
> limit_byte
)
21662 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21663 ceiling
= max (limit_byte
, ceiling
);
21664 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
21665 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21668 if (selective_display
)
21670 while (--cursor
>= ceiling_addr
21671 && *cursor
!= '\n' && *cursor
!= 015)
21673 if (cursor
< ceiling_addr
)
21678 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
21685 start_byte
+= cursor
- base
+ 1;
21686 *byte_pos_ptr
= start_byte
;
21687 /* When scanning backwards, we should
21688 not count the newline posterior to which we stop. */
21689 return - orig_count
- 1;
21692 start_byte
+= ceiling_addr
- base
;
21696 *byte_pos_ptr
= limit_byte
;
21699 return - orig_count
+ count
;
21700 return orig_count
- count
;
21706 /***********************************************************************
21708 ***********************************************************************/
21710 /* Display a NUL-terminated string, starting with index START.
21712 If STRING is non-null, display that C string. Otherwise, the Lisp
21713 string LISP_STRING is displayed. There's a case that STRING is
21714 non-null and LISP_STRING is not nil. It means STRING is a string
21715 data of LISP_STRING. In that case, we display LISP_STRING while
21716 ignoring its text properties.
21718 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21719 FACE_STRING. Display STRING or LISP_STRING with the face at
21720 FACE_STRING_POS in FACE_STRING:
21722 Display the string in the environment given by IT, but use the
21723 standard display table, temporarily.
21725 FIELD_WIDTH is the minimum number of output glyphs to produce.
21726 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21727 with spaces. If STRING has more characters, more than FIELD_WIDTH
21728 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21730 PRECISION is the maximum number of characters to output from
21731 STRING. PRECISION < 0 means don't truncate the string.
21733 This is roughly equivalent to printf format specifiers:
21735 FIELD_WIDTH PRECISION PRINTF
21736 ----------------------------------------
21742 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21743 display them, and < 0 means obey the current buffer's value of
21744 enable_multibyte_characters.
21746 Value is the number of columns displayed. */
21749 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21750 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
21751 int field_width
, int precision
, int max_x
, int multibyte
)
21753 int hpos_at_start
= it
->hpos
;
21754 int saved_face_id
= it
->face_id
;
21755 struct glyph_row
*row
= it
->glyph_row
;
21756 ptrdiff_t it_charpos
;
21758 /* Initialize the iterator IT for iteration over STRING beginning
21759 with index START. */
21760 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21761 precision
, field_width
, multibyte
);
21762 if (string
&& STRINGP (lisp_string
))
21763 /* LISP_STRING is the one returned by decode_mode_spec. We should
21764 ignore its text properties. */
21765 it
->stop_charpos
= it
->end_charpos
;
21767 /* If displaying STRING, set up the face of the iterator from
21768 FACE_STRING, if that's given. */
21769 if (STRINGP (face_string
))
21775 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21776 0, it
->region_beg_charpos
,
21777 it
->region_end_charpos
,
21778 &endptr
, it
->base_face_id
, 0);
21779 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21780 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21783 /* Set max_x to the maximum allowed X position. Don't let it go
21784 beyond the right edge of the window. */
21786 max_x
= it
->last_visible_x
;
21788 max_x
= min (max_x
, it
->last_visible_x
);
21790 /* Skip over display elements that are not visible. because IT->w is
21792 if (it
->current_x
< it
->first_visible_x
)
21793 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21794 MOVE_TO_POS
| MOVE_TO_X
);
21796 row
->ascent
= it
->max_ascent
;
21797 row
->height
= it
->max_ascent
+ it
->max_descent
;
21798 row
->phys_ascent
= it
->max_phys_ascent
;
21799 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21800 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21802 if (STRINGP (it
->string
))
21803 it_charpos
= IT_STRING_CHARPOS (*it
);
21805 it_charpos
= IT_CHARPOS (*it
);
21807 /* This condition is for the case that we are called with current_x
21808 past last_visible_x. */
21809 while (it
->current_x
< max_x
)
21811 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21813 /* Get the next display element. */
21814 if (!get_next_display_element (it
))
21817 /* Produce glyphs. */
21818 x_before
= it
->current_x
;
21819 n_glyphs_before
= row
->used
[TEXT_AREA
];
21820 PRODUCE_GLYPHS (it
);
21822 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21825 while (i
< nglyphs
)
21827 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21829 if (it
->line_wrap
!= TRUNCATE
21830 && x
+ glyph
->pixel_width
> max_x
)
21832 /* End of continued line or max_x reached. */
21833 if (CHAR_GLYPH_PADDING_P (*glyph
))
21835 /* A wide character is unbreakable. */
21836 if (row
->reversed_p
)
21837 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21838 - n_glyphs_before
);
21839 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21840 it
->current_x
= x_before
;
21844 if (row
->reversed_p
)
21845 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21846 - (n_glyphs_before
+ i
));
21847 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21852 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21854 /* Glyph is at least partially visible. */
21856 if (x
< it
->first_visible_x
)
21857 row
->x
= x
- it
->first_visible_x
;
21861 /* Glyph is off the left margin of the display area.
21862 Should not happen. */
21866 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21867 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21868 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21869 row
->phys_height
= max (row
->phys_height
,
21870 it
->max_phys_ascent
+ it
->max_phys_descent
);
21871 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21872 it
->max_extra_line_spacing
);
21873 x
+= glyph
->pixel_width
;
21877 /* Stop if max_x reached. */
21881 /* Stop at line ends. */
21882 if (ITERATOR_AT_END_OF_LINE_P (it
))
21884 it
->continuation_lines_width
= 0;
21888 set_iterator_to_next (it
, 1);
21889 if (STRINGP (it
->string
))
21890 it_charpos
= IT_STRING_CHARPOS (*it
);
21892 it_charpos
= IT_CHARPOS (*it
);
21894 /* Stop if truncating at the right edge. */
21895 if (it
->line_wrap
== TRUNCATE
21896 && it
->current_x
>= it
->last_visible_x
)
21898 /* Add truncation mark, but don't do it if the line is
21899 truncated at a padding space. */
21900 if (it_charpos
< it
->string_nchars
)
21902 if (!FRAME_WINDOW_P (it
->f
))
21906 if (it
->current_x
> it
->last_visible_x
)
21908 if (!row
->reversed_p
)
21910 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21911 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21916 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21917 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21919 unproduce_glyphs (it
, ii
+ 1);
21920 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21922 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21924 row
->used
[TEXT_AREA
] = ii
;
21925 produce_special_glyphs (it
, IT_TRUNCATION
);
21928 produce_special_glyphs (it
, IT_TRUNCATION
);
21930 row
->truncated_on_right_p
= 1;
21936 /* Maybe insert a truncation at the left. */
21937 if (it
->first_visible_x
21940 if (!FRAME_WINDOW_P (it
->f
)
21941 || (row
->reversed_p
21942 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21943 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
21944 insert_left_trunc_glyphs (it
);
21945 row
->truncated_on_left_p
= 1;
21948 it
->face_id
= saved_face_id
;
21950 /* Value is number of columns displayed. */
21951 return it
->hpos
- hpos_at_start
;
21956 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21957 appears as an element of LIST or as the car of an element of LIST.
21958 If PROPVAL is a list, compare each element against LIST in that
21959 way, and return 1/2 if any element of PROPVAL is found in LIST.
21960 Otherwise return 0. This function cannot quit.
21961 The return value is 2 if the text is invisible but with an ellipsis
21962 and 1 if it's invisible and without an ellipsis. */
21965 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21967 register Lisp_Object tail
, proptail
;
21969 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21971 register Lisp_Object tem
;
21973 if (EQ (propval
, tem
))
21975 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21976 return NILP (XCDR (tem
)) ? 1 : 2;
21979 if (CONSP (propval
))
21981 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21983 Lisp_Object propelt
;
21984 propelt
= XCAR (proptail
);
21985 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21987 register Lisp_Object tem
;
21989 if (EQ (propelt
, tem
))
21991 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21992 return NILP (XCDR (tem
)) ? 1 : 2;
22000 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
22001 doc
: /* Non-nil if the property makes the text invisible.
22002 POS-OR-PROP can be a marker or number, in which case it is taken to be
22003 a position in the current buffer and the value of the `invisible' property
22004 is checked; or it can be some other value, which is then presumed to be the
22005 value of the `invisible' property of the text of interest.
22006 The non-nil value returned can be t for truly invisible text or something
22007 else if the text is replaced by an ellipsis. */)
22008 (Lisp_Object pos_or_prop
)
22011 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
22012 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
22014 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
22015 return (invis
== 0 ? Qnil
22017 : make_number (invis
));
22020 /* Calculate a width or height in pixels from a specification using
22021 the following elements:
22024 NUM - a (fractional) multiple of the default font width/height
22025 (NUM) - specifies exactly NUM pixels
22026 UNIT - a fixed number of pixels, see below.
22027 ELEMENT - size of a display element in pixels, see below.
22028 (NUM . SPEC) - equals NUM * SPEC
22029 (+ SPEC SPEC ...) - add pixel values
22030 (- SPEC SPEC ...) - subtract pixel values
22031 (- SPEC) - negate pixel value
22034 INT or FLOAT - a number constant
22035 SYMBOL - use symbol's (buffer local) variable binding.
22038 in - pixels per inch *)
22039 mm - pixels per 1/1000 meter *)
22040 cm - pixels per 1/100 meter *)
22041 width - width of current font in pixels.
22042 height - height of current font in pixels.
22044 *) using the ratio(s) defined in display-pixels-per-inch.
22048 left-fringe - left fringe width in pixels
22049 right-fringe - right fringe width in pixels
22051 left-margin - left margin width in pixels
22052 right-margin - right margin width in pixels
22054 scroll-bar - scroll-bar area width in pixels
22058 Pixels corresponding to 5 inches:
22061 Total width of non-text areas on left side of window (if scroll-bar is on left):
22062 '(space :width (+ left-fringe left-margin scroll-bar))
22064 Align to first text column (in header line):
22065 '(space :align-to 0)
22067 Align to middle of text area minus half the width of variable `my-image'
22068 containing a loaded image:
22069 '(space :align-to (0.5 . (- text my-image)))
22071 Width of left margin minus width of 1 character in the default font:
22072 '(space :width (- left-margin 1))
22074 Width of left margin minus width of 2 characters in the current font:
22075 '(space :width (- left-margin (2 . width)))
22077 Center 1 character over left-margin (in header line):
22078 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22080 Different ways to express width of left fringe plus left margin minus one pixel:
22081 '(space :width (- (+ left-fringe left-margin) (1)))
22082 '(space :width (+ left-fringe left-margin (- (1))))
22083 '(space :width (+ left-fringe left-margin (-1)))
22087 #define NUMVAL(X) \
22088 ((INTEGERP (X) || FLOATP (X)) \
22093 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22094 struct font
*font
, int width_p
, int *align_to
)
22098 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22099 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22102 return OK_PIXELS (0);
22104 eassert (FRAME_LIVE_P (it
->f
));
22106 if (SYMBOLP (prop
))
22108 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22110 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22112 if (unit
[0] == 'i' && unit
[1] == 'n')
22114 else if (unit
[0] == 'm' && unit
[1] == 'm')
22116 else if (unit
[0] == 'c' && unit
[1] == 'm')
22123 #ifdef HAVE_WINDOW_SYSTEM
22124 if (FRAME_WINDOW_P (it
->f
)
22126 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
22127 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
22129 return OK_PIXELS (ppi
/ pixels
);
22132 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
22133 || (CONSP (Vdisplay_pixels_per_inch
)
22135 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
22136 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
22138 return OK_PIXELS (ppi
/ pixels
);
22144 #ifdef HAVE_WINDOW_SYSTEM
22145 if (EQ (prop
, Qheight
))
22146 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22147 if (EQ (prop
, Qwidth
))
22148 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22150 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22151 return OK_PIXELS (1);
22154 if (EQ (prop
, Qtext
))
22155 return OK_PIXELS (width_p
22156 ? window_box_width (it
->w
, TEXT_AREA
)
22157 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22159 if (align_to
&& *align_to
< 0)
22162 if (EQ (prop
, Qleft
))
22163 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22164 if (EQ (prop
, Qright
))
22165 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22166 if (EQ (prop
, Qcenter
))
22167 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22168 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22169 if (EQ (prop
, Qleft_fringe
))
22170 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22171 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22172 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22173 if (EQ (prop
, Qright_fringe
))
22174 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22175 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22176 : window_box_right_offset (it
->w
, TEXT_AREA
));
22177 if (EQ (prop
, Qleft_margin
))
22178 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22179 if (EQ (prop
, Qright_margin
))
22180 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22181 if (EQ (prop
, Qscroll_bar
))
22182 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22184 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22185 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22186 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22191 if (EQ (prop
, Qleft_fringe
))
22192 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22193 if (EQ (prop
, Qright_fringe
))
22194 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22195 if (EQ (prop
, Qleft_margin
))
22196 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22197 if (EQ (prop
, Qright_margin
))
22198 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22199 if (EQ (prop
, Qscroll_bar
))
22200 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22203 prop
= buffer_local_value_1 (prop
, it
->w
->buffer
);
22204 if (EQ (prop
, Qunbound
))
22208 if (INTEGERP (prop
) || FLOATP (prop
))
22210 int base_unit
= (width_p
22211 ? FRAME_COLUMN_WIDTH (it
->f
)
22212 : FRAME_LINE_HEIGHT (it
->f
));
22213 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22218 Lisp_Object car
= XCAR (prop
);
22219 Lisp_Object cdr
= XCDR (prop
);
22223 #ifdef HAVE_WINDOW_SYSTEM
22224 if (FRAME_WINDOW_P (it
->f
)
22225 && valid_image_p (prop
))
22227 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22228 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22230 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22233 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22239 while (CONSP (cdr
))
22241 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22242 font
, width_p
, align_to
))
22245 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22250 if (EQ (car
, Qminus
))
22252 return OK_PIXELS (pixels
);
22255 car
= buffer_local_value_1 (car
, it
->w
->buffer
);
22256 if (EQ (car
, Qunbound
))
22260 if (INTEGERP (car
) || FLOATP (car
))
22263 pixels
= XFLOATINT (car
);
22265 return OK_PIXELS (pixels
);
22266 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22267 font
, width_p
, align_to
))
22268 return OK_PIXELS (pixels
* fact
);
22279 /***********************************************************************
22281 ***********************************************************************/
22283 #ifdef HAVE_WINDOW_SYSTEM
22288 dump_glyph_string (struct glyph_string
*s
)
22290 fprintf (stderr
, "glyph string\n");
22291 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22292 s
->x
, s
->y
, s
->width
, s
->height
);
22293 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22294 fprintf (stderr
, " hl = %d\n", s
->hl
);
22295 fprintf (stderr
, " left overhang = %d, right = %d\n",
22296 s
->left_overhang
, s
->right_overhang
);
22297 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22298 fprintf (stderr
, " extends to end of line = %d\n",
22299 s
->extends_to_end_of_line_p
);
22300 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22301 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22304 #endif /* GLYPH_DEBUG */
22306 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22307 of XChar2b structures for S; it can't be allocated in
22308 init_glyph_string because it must be allocated via `alloca'. W
22309 is the window on which S is drawn. ROW and AREA are the glyph row
22310 and area within the row from which S is constructed. START is the
22311 index of the first glyph structure covered by S. HL is a
22312 face-override for drawing S. */
22315 #define OPTIONAL_HDC(hdc) HDC hdc,
22316 #define DECLARE_HDC(hdc) HDC hdc;
22317 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22318 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22321 #ifndef OPTIONAL_HDC
22322 #define OPTIONAL_HDC(hdc)
22323 #define DECLARE_HDC(hdc)
22324 #define ALLOCATE_HDC(hdc, f)
22325 #define RELEASE_HDC(hdc, f)
22329 init_glyph_string (struct glyph_string
*s
,
22331 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22332 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22334 memset (s
, 0, sizeof *s
);
22336 s
->f
= XFRAME (w
->frame
);
22340 s
->display
= FRAME_X_DISPLAY (s
->f
);
22341 s
->window
= FRAME_X_WINDOW (s
->f
);
22342 s
->char2b
= char2b
;
22346 s
->first_glyph
= row
->glyphs
[area
] + start
;
22347 s
->height
= row
->height
;
22348 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22349 s
->ybase
= s
->y
+ row
->ascent
;
22353 /* Append the list of glyph strings with head H and tail T to the list
22354 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22357 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22358 struct glyph_string
*h
, struct glyph_string
*t
)
22372 /* Prepend the list of glyph strings with head H and tail T to the
22373 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22377 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22378 struct glyph_string
*h
, struct glyph_string
*t
)
22392 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22393 Set *HEAD and *TAIL to the resulting list. */
22396 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22397 struct glyph_string
*s
)
22399 s
->next
= s
->prev
= NULL
;
22400 append_glyph_string_lists (head
, tail
, s
, s
);
22404 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22405 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22406 make sure that X resources for the face returned are allocated.
22407 Value is a pointer to a realized face that is ready for display if
22408 DISPLAY_P is non-zero. */
22410 static struct face
*
22411 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22412 XChar2b
*char2b
, int display_p
)
22414 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22418 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22420 if (code
!= FONT_INVALID_CODE
)
22421 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22423 STORE_XCHAR2B (char2b
, 0, 0);
22426 /* Make sure X resources of the face are allocated. */
22427 #ifdef HAVE_X_WINDOWS
22431 eassert (face
!= NULL
);
22432 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22439 /* Get face and two-byte form of character glyph GLYPH on frame F.
22440 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22441 a pointer to a realized face that is ready for display. */
22443 static struct face
*
22444 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22445 XChar2b
*char2b
, int *two_byte_p
)
22449 eassert (glyph
->type
== CHAR_GLYPH
);
22450 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22459 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22460 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22462 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22464 if (code
!= FONT_INVALID_CODE
)
22465 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22467 STORE_XCHAR2B (char2b
, 0, 0);
22470 /* Make sure X resources of the face are allocated. */
22471 eassert (face
!= NULL
);
22472 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22477 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22478 Return 1 if FONT has a glyph for C, otherwise return 0. */
22481 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22485 if (CHAR_BYTE8_P (c
))
22486 code
= CHAR_TO_BYTE8 (c
);
22488 code
= font
->driver
->encode_char (font
, c
);
22490 if (code
== FONT_INVALID_CODE
)
22492 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22497 /* Fill glyph string S with composition components specified by S->cmp.
22499 BASE_FACE is the base face of the composition.
22500 S->cmp_from is the index of the first component for S.
22502 OVERLAPS non-zero means S should draw the foreground only, and use
22503 its physical height for clipping. See also draw_glyphs.
22505 Value is the index of a component not in S. */
22508 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22512 /* For all glyphs of this composition, starting at the offset
22513 S->cmp_from, until we reach the end of the definition or encounter a
22514 glyph that requires the different face, add it to S. */
22519 s
->for_overlaps
= overlaps
;
22522 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22524 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22526 /* TAB in a composition means display glyphs with padding space
22527 on the left or right. */
22530 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22533 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22540 s
->font
= s
->face
->font
;
22542 else if (s
->face
!= face
)
22550 if (s
->face
== NULL
)
22552 s
->face
= base_face
->ascii_face
;
22553 s
->font
= s
->face
->font
;
22556 /* All glyph strings for the same composition has the same width,
22557 i.e. the width set for the first component of the composition. */
22558 s
->width
= s
->first_glyph
->pixel_width
;
22560 /* If the specified font could not be loaded, use the frame's
22561 default font, but record the fact that we couldn't load it in
22562 the glyph string so that we can draw rectangles for the
22563 characters of the glyph string. */
22564 if (s
->font
== NULL
)
22566 s
->font_not_found_p
= 1;
22567 s
->font
= FRAME_FONT (s
->f
);
22570 /* Adjust base line for subscript/superscript text. */
22571 s
->ybase
+= s
->first_glyph
->voffset
;
22573 /* This glyph string must always be drawn with 16-bit functions. */
22580 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22581 int start
, int end
, int overlaps
)
22583 struct glyph
*glyph
, *last
;
22584 Lisp_Object lgstring
;
22587 s
->for_overlaps
= overlaps
;
22588 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22589 last
= s
->row
->glyphs
[s
->area
] + end
;
22590 s
->cmp_id
= glyph
->u
.cmp
.id
;
22591 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22592 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22593 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22594 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22595 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22597 while (glyph
< last
22598 && glyph
->u
.cmp
.automatic
22599 && glyph
->u
.cmp
.id
== s
->cmp_id
22600 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22601 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22603 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22605 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22606 unsigned code
= LGLYPH_CODE (lglyph
);
22608 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22610 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22611 return glyph
- s
->row
->glyphs
[s
->area
];
22615 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22616 See the comment of fill_glyph_string for arguments.
22617 Value is the index of the first glyph not in S. */
22621 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22622 int start
, int end
, int overlaps
)
22624 struct glyph
*glyph
, *last
;
22627 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22628 s
->for_overlaps
= overlaps
;
22629 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22630 last
= s
->row
->glyphs
[s
->area
] + end
;
22631 voffset
= glyph
->voffset
;
22632 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22633 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
22635 s
->width
= glyph
->pixel_width
;
22637 while (glyph
< last
22638 && glyph
->type
== GLYPHLESS_GLYPH
22639 && glyph
->voffset
== voffset
22640 && glyph
->face_id
== face_id
)
22643 s
->width
+= glyph
->pixel_width
;
22646 s
->ybase
+= voffset
;
22647 return glyph
- s
->row
->glyphs
[s
->area
];
22651 /* Fill glyph string S from a sequence of character glyphs.
22653 FACE_ID is the face id of the string. START is the index of the
22654 first glyph to consider, END is the index of the last + 1.
22655 OVERLAPS non-zero means S should draw the foreground only, and use
22656 its physical height for clipping. See also draw_glyphs.
22658 Value is the index of the first glyph not in S. */
22661 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22662 int start
, int end
, int overlaps
)
22664 struct glyph
*glyph
, *last
;
22666 int glyph_not_available_p
;
22668 eassert (s
->f
== XFRAME (s
->w
->frame
));
22669 eassert (s
->nchars
== 0);
22670 eassert (start
>= 0 && end
> start
);
22672 s
->for_overlaps
= overlaps
;
22673 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22674 last
= s
->row
->glyphs
[s
->area
] + end
;
22675 voffset
= glyph
->voffset
;
22676 s
->padding_p
= glyph
->padding_p
;
22677 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22679 while (glyph
< last
22680 && glyph
->type
== CHAR_GLYPH
22681 && glyph
->voffset
== voffset
22682 /* Same face id implies same font, nowadays. */
22683 && glyph
->face_id
== face_id
22684 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22688 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22689 s
->char2b
+ s
->nchars
,
22691 s
->two_byte_p
= two_byte_p
;
22693 eassert (s
->nchars
<= end
- start
);
22694 s
->width
+= glyph
->pixel_width
;
22695 if (glyph
++->padding_p
!= s
->padding_p
)
22699 s
->font
= s
->face
->font
;
22701 /* If the specified font could not be loaded, use the frame's font,
22702 but record the fact that we couldn't load it in
22703 S->font_not_found_p so that we can draw rectangles for the
22704 characters of the glyph string. */
22705 if (s
->font
== NULL
|| glyph_not_available_p
)
22707 s
->font_not_found_p
= 1;
22708 s
->font
= FRAME_FONT (s
->f
);
22711 /* Adjust base line for subscript/superscript text. */
22712 s
->ybase
+= voffset
;
22714 eassert (s
->face
&& s
->face
->gc
);
22715 return glyph
- s
->row
->glyphs
[s
->area
];
22719 /* Fill glyph string S from image glyph S->first_glyph. */
22722 fill_image_glyph_string (struct glyph_string
*s
)
22724 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22725 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22727 s
->slice
= s
->first_glyph
->slice
.img
;
22728 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22729 s
->font
= s
->face
->font
;
22730 s
->width
= s
->first_glyph
->pixel_width
;
22732 /* Adjust base line for subscript/superscript text. */
22733 s
->ybase
+= s
->first_glyph
->voffset
;
22737 /* Fill glyph string S from a sequence of stretch glyphs.
22739 START is the index of the first glyph to consider,
22740 END is the index of the last + 1.
22742 Value is the index of the first glyph not in S. */
22745 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22747 struct glyph
*glyph
, *last
;
22748 int voffset
, face_id
;
22750 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22752 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22753 last
= s
->row
->glyphs
[s
->area
] + end
;
22754 face_id
= glyph
->face_id
;
22755 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22756 s
->font
= s
->face
->font
;
22757 s
->width
= glyph
->pixel_width
;
22759 voffset
= glyph
->voffset
;
22763 && glyph
->type
== STRETCH_GLYPH
22764 && glyph
->voffset
== voffset
22765 && glyph
->face_id
== face_id
);
22767 s
->width
+= glyph
->pixel_width
;
22769 /* Adjust base line for subscript/superscript text. */
22770 s
->ybase
+= voffset
;
22772 /* The case that face->gc == 0 is handled when drawing the glyph
22773 string by calling PREPARE_FACE_FOR_DISPLAY. */
22775 return glyph
- s
->row
->glyphs
[s
->area
];
22778 static struct font_metrics
*
22779 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22781 static struct font_metrics metrics
;
22782 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22784 if (! font
|| code
== FONT_INVALID_CODE
)
22786 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22791 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22792 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22793 assumed to be zero. */
22796 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22798 *left
= *right
= 0;
22800 if (glyph
->type
== CHAR_GLYPH
)
22804 struct font_metrics
*pcm
;
22806 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22807 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22809 if (pcm
->rbearing
> pcm
->width
)
22810 *right
= pcm
->rbearing
- pcm
->width
;
22811 if (pcm
->lbearing
< 0)
22812 *left
= -pcm
->lbearing
;
22815 else if (glyph
->type
== COMPOSITE_GLYPH
)
22817 if (! glyph
->u
.cmp
.automatic
)
22819 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22821 if (cmp
->rbearing
> cmp
->pixel_width
)
22822 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22823 if (cmp
->lbearing
< 0)
22824 *left
= - cmp
->lbearing
;
22828 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22829 struct font_metrics metrics
;
22831 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22832 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22833 if (metrics
.rbearing
> metrics
.width
)
22834 *right
= metrics
.rbearing
- metrics
.width
;
22835 if (metrics
.lbearing
< 0)
22836 *left
= - metrics
.lbearing
;
22842 /* Return the index of the first glyph preceding glyph string S that
22843 is overwritten by S because of S's left overhang. Value is -1
22844 if no glyphs are overwritten. */
22847 left_overwritten (struct glyph_string
*s
)
22851 if (s
->left_overhang
)
22854 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22855 int first
= s
->first_glyph
- glyphs
;
22857 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22858 x
-= glyphs
[i
].pixel_width
;
22869 /* Return the index of the first glyph preceding glyph string S that
22870 is overwriting S because of its right overhang. Value is -1 if no
22871 glyph in front of S overwrites S. */
22874 left_overwriting (struct glyph_string
*s
)
22877 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22878 int first
= s
->first_glyph
- glyphs
;
22882 for (i
= first
- 1; i
>= 0; --i
)
22885 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22888 x
-= glyphs
[i
].pixel_width
;
22895 /* Return the index of the last glyph following glyph string S that is
22896 overwritten by S because of S's right overhang. Value is -1 if
22897 no such glyph is found. */
22900 right_overwritten (struct glyph_string
*s
)
22904 if (s
->right_overhang
)
22907 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22908 int first
= (s
->first_glyph
- glyphs
22909 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
22910 int end
= s
->row
->used
[s
->area
];
22912 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22913 x
+= glyphs
[i
].pixel_width
;
22922 /* Return the index of the last glyph following glyph string S that
22923 overwrites S because of its left overhang. Value is negative
22924 if no such glyph is found. */
22927 right_overwriting (struct glyph_string
*s
)
22930 int end
= s
->row
->used
[s
->area
];
22931 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22932 int first
= (s
->first_glyph
- glyphs
22933 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
22937 for (i
= first
; i
< end
; ++i
)
22940 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22943 x
+= glyphs
[i
].pixel_width
;
22950 /* Set background width of glyph string S. START is the index of the
22951 first glyph following S. LAST_X is the right-most x-position + 1
22952 in the drawing area. */
22955 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22957 /* If the face of this glyph string has to be drawn to the end of
22958 the drawing area, set S->extends_to_end_of_line_p. */
22960 if (start
== s
->row
->used
[s
->area
]
22961 && s
->area
== TEXT_AREA
22962 && ((s
->row
->fill_line_p
22963 && (s
->hl
== DRAW_NORMAL_TEXT
22964 || s
->hl
== DRAW_IMAGE_RAISED
22965 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22966 || s
->hl
== DRAW_MOUSE_FACE
))
22967 s
->extends_to_end_of_line_p
= 1;
22969 /* If S extends its face to the end of the line, set its
22970 background_width to the distance to the right edge of the drawing
22972 if (s
->extends_to_end_of_line_p
)
22973 s
->background_width
= last_x
- s
->x
+ 1;
22975 s
->background_width
= s
->width
;
22979 /* Compute overhangs and x-positions for glyph string S and its
22980 predecessors, or successors. X is the starting x-position for S.
22981 BACKWARD_P non-zero means process predecessors. */
22984 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22990 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22991 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23001 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23002 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23012 /* The following macros are only called from draw_glyphs below.
23013 They reference the following parameters of that function directly:
23014 `w', `row', `area', and `overlap_p'
23015 as well as the following local variables:
23016 `s', `f', and `hdc' (in W32) */
23019 /* On W32, silently add local `hdc' variable to argument list of
23020 init_glyph_string. */
23021 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23022 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23024 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23025 init_glyph_string (s, char2b, w, row, area, start, hl)
23028 /* Add a glyph string for a stretch glyph to the list of strings
23029 between HEAD and TAIL. START is the index of the stretch glyph in
23030 row area AREA of glyph row ROW. END is the index of the last glyph
23031 in that glyph row area. X is the current output position assigned
23032 to the new glyph string constructed. HL overrides that face of the
23033 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23034 is the right-most x-position of the drawing area. */
23036 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23037 and below -- keep them on one line. */
23038 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23041 s = alloca (sizeof *s); \
23042 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23043 START = fill_stretch_glyph_string (s, START, END); \
23044 append_glyph_string (&HEAD, &TAIL, s); \
23050 /* Add a glyph string for an image glyph to the list of strings
23051 between HEAD and TAIL. START is the index of the image glyph in
23052 row area AREA of glyph row ROW. END is the index of the last glyph
23053 in that glyph row area. X is the current output position assigned
23054 to the new glyph string constructed. HL overrides that face of the
23055 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23056 is the right-most x-position of the drawing area. */
23058 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23061 s = alloca (sizeof *s); \
23062 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23063 fill_image_glyph_string (s); \
23064 append_glyph_string (&HEAD, &TAIL, s); \
23071 /* Add a glyph string for a sequence of character glyphs to the list
23072 of strings between HEAD and TAIL. START is the index of the first
23073 glyph in row area AREA of glyph row ROW that is part of the new
23074 glyph string. END is the index of the last glyph in that glyph row
23075 area. X is the current output position assigned to the new glyph
23076 string constructed. HL overrides that face of the glyph; e.g. it
23077 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23078 right-most x-position of the drawing area. */
23080 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23086 face_id = (row)->glyphs[area][START].face_id; \
23088 s = alloca (sizeof *s); \
23089 char2b = alloca ((END - START) * sizeof *char2b); \
23090 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23091 append_glyph_string (&HEAD, &TAIL, s); \
23093 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23098 /* Add a glyph string for a composite sequence to the list of strings
23099 between HEAD and TAIL. START is the index of the first glyph in
23100 row area AREA of glyph row ROW that is part of the new glyph
23101 string. END is the index of the last glyph in that glyph row area.
23102 X is the current output position assigned to the new glyph string
23103 constructed. HL overrides that face of the glyph; e.g. it is
23104 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23105 x-position of the drawing area. */
23107 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23109 int face_id = (row)->glyphs[area][START].face_id; \
23110 struct face *base_face = FACE_FROM_ID (f, face_id); \
23111 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23112 struct composition *cmp = composition_table[cmp_id]; \
23114 struct glyph_string *first_s = NULL; \
23117 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23119 /* Make glyph_strings for each glyph sequence that is drawable by \
23120 the same face, and append them to HEAD/TAIL. */ \
23121 for (n = 0; n < cmp->glyph_len;) \
23123 s = alloca (sizeof *s); \
23124 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23125 append_glyph_string (&(HEAD), &(TAIL), s); \
23131 n = fill_composite_glyph_string (s, base_face, overlaps); \
23139 /* Add a glyph string for a glyph-string sequence to the list of strings
23140 between HEAD and TAIL. */
23142 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23146 Lisp_Object gstring; \
23148 face_id = (row)->glyphs[area][START].face_id; \
23149 gstring = (composition_gstring_from_id \
23150 ((row)->glyphs[area][START].u.cmp.id)); \
23151 s = alloca (sizeof *s); \
23152 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23153 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23154 append_glyph_string (&(HEAD), &(TAIL), s); \
23156 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23160 /* Add a glyph string for a sequence of glyphless character's glyphs
23161 to the list of strings between HEAD and TAIL. The meanings of
23162 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23164 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23169 face_id = (row)->glyphs[area][START].face_id; \
23171 s = alloca (sizeof *s); \
23172 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23173 append_glyph_string (&HEAD, &TAIL, s); \
23175 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23181 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23182 of AREA of glyph row ROW on window W between indices START and END.
23183 HL overrides the face for drawing glyph strings, e.g. it is
23184 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23185 x-positions of the drawing area.
23187 This is an ugly monster macro construct because we must use alloca
23188 to allocate glyph strings (because draw_glyphs can be called
23189 asynchronously). */
23191 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23194 HEAD = TAIL = NULL; \
23195 while (START < END) \
23197 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23198 switch (first_glyph->type) \
23201 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23205 case COMPOSITE_GLYPH: \
23206 if (first_glyph->u.cmp.automatic) \
23207 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23210 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23214 case STRETCH_GLYPH: \
23215 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23219 case IMAGE_GLYPH: \
23220 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23224 case GLYPHLESS_GLYPH: \
23225 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23235 set_glyph_string_background_width (s, START, LAST_X); \
23242 /* Draw glyphs between START and END in AREA of ROW on window W,
23243 starting at x-position X. X is relative to AREA in W. HL is a
23244 face-override with the following meaning:
23246 DRAW_NORMAL_TEXT draw normally
23247 DRAW_CURSOR draw in cursor face
23248 DRAW_MOUSE_FACE draw in mouse face.
23249 DRAW_INVERSE_VIDEO draw in mode line face
23250 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23251 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23253 If OVERLAPS is non-zero, draw only the foreground of characters and
23254 clip to the physical height of ROW. Non-zero value also defines
23255 the overlapping part to be drawn:
23257 OVERLAPS_PRED overlap with preceding rows
23258 OVERLAPS_SUCC overlap with succeeding rows
23259 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23260 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23262 Value is the x-position reached, relative to AREA of W. */
23265 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23266 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23267 enum draw_glyphs_face hl
, int overlaps
)
23269 struct glyph_string
*head
, *tail
;
23270 struct glyph_string
*s
;
23271 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23272 int i
, j
, x_reached
, last_x
, area_left
= 0;
23273 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23276 ALLOCATE_HDC (hdc
, f
);
23278 /* Let's rather be paranoid than getting a SEGV. */
23279 end
= min (end
, row
->used
[area
]);
23280 start
= clip_to_bounds (0, start
, end
);
23282 /* Translate X to frame coordinates. Set last_x to the right
23283 end of the drawing area. */
23284 if (row
->full_width_p
)
23286 /* X is relative to the left edge of W, without scroll bars
23288 area_left
= WINDOW_LEFT_EDGE_X (w
);
23289 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23293 area_left
= window_box_left (w
, area
);
23294 last_x
= area_left
+ window_box_width (w
, area
);
23298 /* Build a doubly-linked list of glyph_string structures between
23299 head and tail from what we have to draw. Note that the macro
23300 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23301 the reason we use a separate variable `i'. */
23303 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23305 x_reached
= tail
->x
+ tail
->background_width
;
23309 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23310 the row, redraw some glyphs in front or following the glyph
23311 strings built above. */
23312 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23314 struct glyph_string
*h
, *t
;
23315 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23316 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23317 int check_mouse_face
= 0;
23320 /* If mouse highlighting is on, we may need to draw adjacent
23321 glyphs using mouse-face highlighting. */
23322 if (area
== TEXT_AREA
&& row
->mouse_face_p
23323 && hlinfo
->mouse_face_beg_row
>= 0
23324 && hlinfo
->mouse_face_end_row
>= 0)
23326 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23328 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23329 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23331 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23333 check_mouse_face
= 1;
23334 mouse_beg_col
= (row
== mouse_beg_row
)
23335 ? hlinfo
->mouse_face_beg_col
: 0;
23336 mouse_end_col
= (row
== mouse_end_row
)
23337 ? hlinfo
->mouse_face_end_col
23338 : row
->used
[TEXT_AREA
];
23342 /* Compute overhangs for all glyph strings. */
23343 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23344 for (s
= head
; s
; s
= s
->next
)
23345 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23347 /* Prepend glyph strings for glyphs in front of the first glyph
23348 string that are overwritten because of the first glyph
23349 string's left overhang. The background of all strings
23350 prepended must be drawn because the first glyph string
23352 i
= left_overwritten (head
);
23355 enum draw_glyphs_face overlap_hl
;
23357 /* If this row contains mouse highlighting, attempt to draw
23358 the overlapped glyphs with the correct highlight. This
23359 code fails if the overlap encompasses more than one glyph
23360 and mouse-highlight spans only some of these glyphs.
23361 However, making it work perfectly involves a lot more
23362 code, and I don't know if the pathological case occurs in
23363 practice, so we'll stick to this for now. --- cyd */
23364 if (check_mouse_face
23365 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23366 overlap_hl
= DRAW_MOUSE_FACE
;
23368 overlap_hl
= DRAW_NORMAL_TEXT
;
23371 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23372 overlap_hl
, dummy_x
, last_x
);
23374 compute_overhangs_and_x (t
, head
->x
, 1);
23375 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23379 /* Prepend glyph strings for glyphs in front of the first glyph
23380 string that overwrite that glyph string because of their
23381 right overhang. For these strings, only the foreground must
23382 be drawn, because it draws over the glyph string at `head'.
23383 The background must not be drawn because this would overwrite
23384 right overhangs of preceding glyphs for which no glyph
23386 i
= left_overwriting (head
);
23389 enum draw_glyphs_face overlap_hl
;
23391 if (check_mouse_face
23392 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23393 overlap_hl
= DRAW_MOUSE_FACE
;
23395 overlap_hl
= DRAW_NORMAL_TEXT
;
23398 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23399 overlap_hl
, dummy_x
, last_x
);
23400 for (s
= h
; s
; s
= s
->next
)
23401 s
->background_filled_p
= 1;
23402 compute_overhangs_and_x (t
, head
->x
, 1);
23403 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23406 /* Append glyphs strings for glyphs following the last glyph
23407 string tail that are overwritten by tail. The background of
23408 these strings has to be drawn because tail's foreground draws
23410 i
= right_overwritten (tail
);
23413 enum draw_glyphs_face overlap_hl
;
23415 if (check_mouse_face
23416 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23417 overlap_hl
= DRAW_MOUSE_FACE
;
23419 overlap_hl
= DRAW_NORMAL_TEXT
;
23421 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23422 overlap_hl
, x
, last_x
);
23423 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23424 we don't have `end = i;' here. */
23425 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23426 append_glyph_string_lists (&head
, &tail
, h
, t
);
23430 /* Append glyph strings for glyphs following the last glyph
23431 string tail that overwrite tail. The foreground of such
23432 glyphs has to be drawn because it writes into the background
23433 of tail. The background must not be drawn because it could
23434 paint over the foreground of following glyphs. */
23435 i
= right_overwriting (tail
);
23438 enum draw_glyphs_face overlap_hl
;
23439 if (check_mouse_face
23440 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23441 overlap_hl
= DRAW_MOUSE_FACE
;
23443 overlap_hl
= DRAW_NORMAL_TEXT
;
23446 i
++; /* We must include the Ith glyph. */
23447 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23448 overlap_hl
, x
, last_x
);
23449 for (s
= h
; s
; s
= s
->next
)
23450 s
->background_filled_p
= 1;
23451 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23452 append_glyph_string_lists (&head
, &tail
, h
, t
);
23454 if (clip_head
|| clip_tail
)
23455 for (s
= head
; s
; s
= s
->next
)
23457 s
->clip_head
= clip_head
;
23458 s
->clip_tail
= clip_tail
;
23462 /* Draw all strings. */
23463 for (s
= head
; s
; s
= s
->next
)
23464 FRAME_RIF (f
)->draw_glyph_string (s
);
23467 /* When focus a sole frame and move horizontally, this sets on_p to 0
23468 causing a failure to erase prev cursor position. */
23469 if (area
== TEXT_AREA
23470 && !row
->full_width_p
23471 /* When drawing overlapping rows, only the glyph strings'
23472 foreground is drawn, which doesn't erase a cursor
23476 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23477 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23478 : (tail
? tail
->x
+ tail
->background_width
: x
));
23482 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23483 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23487 /* Value is the x-position up to which drawn, relative to AREA of W.
23488 This doesn't include parts drawn because of overhangs. */
23489 if (row
->full_width_p
)
23490 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23492 x_reached
-= area_left
;
23494 RELEASE_HDC (hdc
, f
);
23499 /* Expand row matrix if too narrow. Don't expand if area
23502 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23504 if (!fonts_changed_p \
23505 && (it->glyph_row->glyphs[area] \
23506 < it->glyph_row->glyphs[area + 1])) \
23508 it->w->ncols_scale_factor++; \
23509 fonts_changed_p = 1; \
23513 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23514 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23517 append_glyph (struct it
*it
)
23519 struct glyph
*glyph
;
23520 enum glyph_row_area area
= it
->area
;
23522 eassert (it
->glyph_row
);
23523 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23525 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23526 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23528 /* If the glyph row is reversed, we need to prepend the glyph
23529 rather than append it. */
23530 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23534 /* Make room for the additional glyph. */
23535 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23537 glyph
= it
->glyph_row
->glyphs
[area
];
23539 glyph
->charpos
= CHARPOS (it
->position
);
23540 glyph
->object
= it
->object
;
23541 if (it
->pixel_width
> 0)
23543 glyph
->pixel_width
= it
->pixel_width
;
23544 glyph
->padding_p
= 0;
23548 /* Assure at least 1-pixel width. Otherwise, cursor can't
23549 be displayed correctly. */
23550 glyph
->pixel_width
= 1;
23551 glyph
->padding_p
= 1;
23553 glyph
->ascent
= it
->ascent
;
23554 glyph
->descent
= it
->descent
;
23555 glyph
->voffset
= it
->voffset
;
23556 glyph
->type
= CHAR_GLYPH
;
23557 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23558 glyph
->multibyte_p
= it
->multibyte_p
;
23559 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23561 /* In R2L rows, the left and the right box edges need to be
23562 drawn in reverse direction. */
23563 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23564 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23568 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23569 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23571 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23572 || it
->phys_descent
> it
->descent
);
23573 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23574 glyph
->face_id
= it
->face_id
;
23575 glyph
->u
.ch
= it
->char_to_display
;
23576 glyph
->slice
.img
= null_glyph_slice
;
23577 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23580 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23581 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23583 glyph
->bidi_type
= it
->bidi_it
.type
;
23587 glyph
->resolved_level
= 0;
23588 glyph
->bidi_type
= UNKNOWN_BT
;
23590 ++it
->glyph_row
->used
[area
];
23593 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23596 /* Store one glyph for the composition IT->cmp_it.id in
23597 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23601 append_composite_glyph (struct it
*it
)
23603 struct glyph
*glyph
;
23604 enum glyph_row_area area
= it
->area
;
23606 eassert (it
->glyph_row
);
23608 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23609 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23611 /* If the glyph row is reversed, we need to prepend the glyph
23612 rather than append it. */
23613 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23617 /* Make room for the new glyph. */
23618 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23620 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23622 glyph
->charpos
= it
->cmp_it
.charpos
;
23623 glyph
->object
= it
->object
;
23624 glyph
->pixel_width
= it
->pixel_width
;
23625 glyph
->ascent
= it
->ascent
;
23626 glyph
->descent
= it
->descent
;
23627 glyph
->voffset
= it
->voffset
;
23628 glyph
->type
= COMPOSITE_GLYPH
;
23629 if (it
->cmp_it
.ch
< 0)
23631 glyph
->u
.cmp
.automatic
= 0;
23632 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23633 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23637 glyph
->u
.cmp
.automatic
= 1;
23638 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23639 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23640 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23642 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23643 glyph
->multibyte_p
= it
->multibyte_p
;
23644 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23646 /* In R2L rows, the left and the right box edges need to be
23647 drawn in reverse direction. */
23648 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23649 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23653 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23654 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23656 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23657 || it
->phys_descent
> it
->descent
);
23658 glyph
->padding_p
= 0;
23659 glyph
->glyph_not_available_p
= 0;
23660 glyph
->face_id
= it
->face_id
;
23661 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23664 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23665 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23667 glyph
->bidi_type
= it
->bidi_it
.type
;
23669 ++it
->glyph_row
->used
[area
];
23672 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23676 /* Change IT->ascent and IT->height according to the setting of
23680 take_vertical_position_into_account (struct it
*it
)
23684 if (it
->voffset
< 0)
23685 /* Increase the ascent so that we can display the text higher
23687 it
->ascent
-= it
->voffset
;
23689 /* Increase the descent so that we can display the text lower
23691 it
->descent
+= it
->voffset
;
23696 /* Produce glyphs/get display metrics for the image IT is loaded with.
23697 See the description of struct display_iterator in dispextern.h for
23698 an overview of struct display_iterator. */
23701 produce_image_glyph (struct it
*it
)
23705 int glyph_ascent
, crop
;
23706 struct glyph_slice slice
;
23708 eassert (it
->what
== IT_IMAGE
);
23710 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23712 /* Make sure X resources of the face is loaded. */
23713 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23715 if (it
->image_id
< 0)
23717 /* Fringe bitmap. */
23718 it
->ascent
= it
->phys_ascent
= 0;
23719 it
->descent
= it
->phys_descent
= 0;
23720 it
->pixel_width
= 0;
23725 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23727 /* Make sure X resources of the image is loaded. */
23728 prepare_image_for_display (it
->f
, img
);
23730 slice
.x
= slice
.y
= 0;
23731 slice
.width
= img
->width
;
23732 slice
.height
= img
->height
;
23734 if (INTEGERP (it
->slice
.x
))
23735 slice
.x
= XINT (it
->slice
.x
);
23736 else if (FLOATP (it
->slice
.x
))
23737 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23739 if (INTEGERP (it
->slice
.y
))
23740 slice
.y
= XINT (it
->slice
.y
);
23741 else if (FLOATP (it
->slice
.y
))
23742 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23744 if (INTEGERP (it
->slice
.width
))
23745 slice
.width
= XINT (it
->slice
.width
);
23746 else if (FLOATP (it
->slice
.width
))
23747 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23749 if (INTEGERP (it
->slice
.height
))
23750 slice
.height
= XINT (it
->slice
.height
);
23751 else if (FLOATP (it
->slice
.height
))
23752 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23754 if (slice
.x
>= img
->width
)
23755 slice
.x
= img
->width
;
23756 if (slice
.y
>= img
->height
)
23757 slice
.y
= img
->height
;
23758 if (slice
.x
+ slice
.width
>= img
->width
)
23759 slice
.width
= img
->width
- slice
.x
;
23760 if (slice
.y
+ slice
.height
> img
->height
)
23761 slice
.height
= img
->height
- slice
.y
;
23763 if (slice
.width
== 0 || slice
.height
== 0)
23766 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23768 it
->descent
= slice
.height
- glyph_ascent
;
23770 it
->descent
+= img
->vmargin
;
23771 if (slice
.y
+ slice
.height
== img
->height
)
23772 it
->descent
+= img
->vmargin
;
23773 it
->phys_descent
= it
->descent
;
23775 it
->pixel_width
= slice
.width
;
23777 it
->pixel_width
+= img
->hmargin
;
23778 if (slice
.x
+ slice
.width
== img
->width
)
23779 it
->pixel_width
+= img
->hmargin
;
23781 /* It's quite possible for images to have an ascent greater than
23782 their height, so don't get confused in that case. */
23783 if (it
->descent
< 0)
23788 if (face
->box
!= FACE_NO_BOX
)
23790 if (face
->box_line_width
> 0)
23793 it
->ascent
+= face
->box_line_width
;
23794 if (slice
.y
+ slice
.height
== img
->height
)
23795 it
->descent
+= face
->box_line_width
;
23798 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23799 it
->pixel_width
+= eabs (face
->box_line_width
);
23800 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23801 it
->pixel_width
+= eabs (face
->box_line_width
);
23804 take_vertical_position_into_account (it
);
23806 /* Automatically crop wide image glyphs at right edge so we can
23807 draw the cursor on same display row. */
23808 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23809 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23811 it
->pixel_width
-= crop
;
23812 slice
.width
-= crop
;
23817 struct glyph
*glyph
;
23818 enum glyph_row_area area
= it
->area
;
23820 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23821 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23823 glyph
->charpos
= CHARPOS (it
->position
);
23824 glyph
->object
= it
->object
;
23825 glyph
->pixel_width
= it
->pixel_width
;
23826 glyph
->ascent
= glyph_ascent
;
23827 glyph
->descent
= it
->descent
;
23828 glyph
->voffset
= it
->voffset
;
23829 glyph
->type
= IMAGE_GLYPH
;
23830 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23831 glyph
->multibyte_p
= it
->multibyte_p
;
23832 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23834 /* In R2L rows, the left and the right box edges need to be
23835 drawn in reverse direction. */
23836 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23837 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23841 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23842 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23844 glyph
->overlaps_vertically_p
= 0;
23845 glyph
->padding_p
= 0;
23846 glyph
->glyph_not_available_p
= 0;
23847 glyph
->face_id
= it
->face_id
;
23848 glyph
->u
.img_id
= img
->id
;
23849 glyph
->slice
.img
= slice
;
23850 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23853 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23854 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23856 glyph
->bidi_type
= it
->bidi_it
.type
;
23858 ++it
->glyph_row
->used
[area
];
23861 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23866 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23867 of the glyph, WIDTH and HEIGHT are the width and height of the
23868 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23871 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23872 int width
, int height
, int ascent
)
23874 struct glyph
*glyph
;
23875 enum glyph_row_area area
= it
->area
;
23877 eassert (ascent
>= 0 && ascent
<= height
);
23879 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23880 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23882 /* If the glyph row is reversed, we need to prepend the glyph
23883 rather than append it. */
23884 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23888 /* Make room for the additional glyph. */
23889 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23891 glyph
= it
->glyph_row
->glyphs
[area
];
23893 glyph
->charpos
= CHARPOS (it
->position
);
23894 glyph
->object
= object
;
23895 glyph
->pixel_width
= width
;
23896 glyph
->ascent
= ascent
;
23897 glyph
->descent
= height
- ascent
;
23898 glyph
->voffset
= it
->voffset
;
23899 glyph
->type
= STRETCH_GLYPH
;
23900 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23901 glyph
->multibyte_p
= it
->multibyte_p
;
23902 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23904 /* In R2L rows, the left and the right box edges need to be
23905 drawn in reverse direction. */
23906 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23907 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23911 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23912 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23914 glyph
->overlaps_vertically_p
= 0;
23915 glyph
->padding_p
= 0;
23916 glyph
->glyph_not_available_p
= 0;
23917 glyph
->face_id
= it
->face_id
;
23918 glyph
->u
.stretch
.ascent
= ascent
;
23919 glyph
->u
.stretch
.height
= height
;
23920 glyph
->slice
.img
= null_glyph_slice
;
23921 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23924 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23925 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23927 glyph
->bidi_type
= it
->bidi_it
.type
;
23931 glyph
->resolved_level
= 0;
23932 glyph
->bidi_type
= UNKNOWN_BT
;
23934 ++it
->glyph_row
->used
[area
];
23937 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23940 #endif /* HAVE_WINDOW_SYSTEM */
23942 /* Produce a stretch glyph for iterator IT. IT->object is the value
23943 of the glyph property displayed. The value must be a list
23944 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23947 1. `:width WIDTH' specifies that the space should be WIDTH *
23948 canonical char width wide. WIDTH may be an integer or floating
23951 2. `:relative-width FACTOR' specifies that the width of the stretch
23952 should be computed from the width of the first character having the
23953 `glyph' property, and should be FACTOR times that width.
23955 3. `:align-to HPOS' specifies that the space should be wide enough
23956 to reach HPOS, a value in canonical character units.
23958 Exactly one of the above pairs must be present.
23960 4. `:height HEIGHT' specifies that the height of the stretch produced
23961 should be HEIGHT, measured in canonical character units.
23963 5. `:relative-height FACTOR' specifies that the height of the
23964 stretch should be FACTOR times the height of the characters having
23965 the glyph property.
23967 Either none or exactly one of 4 or 5 must be present.
23969 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23970 of the stretch should be used for the ascent of the stretch.
23971 ASCENT must be in the range 0 <= ASCENT <= 100. */
23974 produce_stretch_glyph (struct it
*it
)
23976 /* (space :width WIDTH :height HEIGHT ...) */
23977 Lisp_Object prop
, plist
;
23978 int width
= 0, height
= 0, align_to
= -1;
23979 int zero_width_ok_p
= 0;
23981 struct font
*font
= NULL
;
23983 #ifdef HAVE_WINDOW_SYSTEM
23985 int zero_height_ok_p
= 0;
23987 if (FRAME_WINDOW_P (it
->f
))
23989 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23990 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23991 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23995 /* List should start with `space'. */
23996 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23997 plist
= XCDR (it
->object
);
23999 /* Compute the width of the stretch. */
24000 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
24001 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
24003 /* Absolute width `:width WIDTH' specified and valid. */
24004 zero_width_ok_p
= 1;
24007 #ifdef HAVE_WINDOW_SYSTEM
24008 else if (FRAME_WINDOW_P (it
->f
)
24009 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
24011 /* Relative width `:relative-width FACTOR' specified and valid.
24012 Compute the width of the characters having the `glyph'
24015 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
24018 if (it
->multibyte_p
)
24019 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
24022 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
24023 if (! ASCII_CHAR_P (it2
.c
))
24024 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
24027 it2
.glyph_row
= NULL
;
24028 it2
.what
= IT_CHARACTER
;
24029 x_produce_glyphs (&it2
);
24030 width
= NUMVAL (prop
) * it2
.pixel_width
;
24032 #endif /* HAVE_WINDOW_SYSTEM */
24033 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
24034 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
24036 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
24037 align_to
= (align_to
< 0
24039 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
24040 else if (align_to
< 0)
24041 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
24042 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
24043 zero_width_ok_p
= 1;
24046 /* Nothing specified -> width defaults to canonical char width. */
24047 width
= FRAME_COLUMN_WIDTH (it
->f
);
24049 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
24052 #ifdef HAVE_WINDOW_SYSTEM
24053 /* Compute height. */
24054 if (FRAME_WINDOW_P (it
->f
))
24056 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
24057 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24060 zero_height_ok_p
= 1;
24062 else if (prop
= Fplist_get (plist
, QCrelative_height
),
24064 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
24066 height
= FONT_HEIGHT (font
);
24068 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
24071 /* Compute percentage of height used for ascent. If
24072 `:ascent ASCENT' is present and valid, use that. Otherwise,
24073 derive the ascent from the font in use. */
24074 if (prop
= Fplist_get (plist
, QCascent
),
24075 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
24076 ascent
= height
* NUMVAL (prop
) / 100.0;
24077 else if (!NILP (prop
)
24078 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24079 ascent
= min (max (0, (int)tem
), height
);
24081 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
24084 #endif /* HAVE_WINDOW_SYSTEM */
24087 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24088 && it
->current_x
+ width
> it
->last_visible_x
)
24090 width
= it
->last_visible_x
- it
->current_x
;
24091 #ifdef HAVE_WINDOW_SYSTEM
24092 /* Subtract one more pixel from the stretch width, but only on
24093 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24094 width
-= FRAME_WINDOW_P (it
->f
);
24098 if (width
> 0 && height
> 0 && it
->glyph_row
)
24100 Lisp_Object o_object
= it
->object
;
24101 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24104 if (!STRINGP (object
))
24105 object
= it
->w
->buffer
;
24106 #ifdef HAVE_WINDOW_SYSTEM
24107 if (FRAME_WINDOW_P (it
->f
))
24108 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24112 it
->object
= object
;
24113 it
->char_to_display
= ' ';
24114 it
->pixel_width
= it
->len
= 1;
24116 tty_append_glyph (it
);
24117 it
->object
= o_object
;
24121 it
->pixel_width
= width
;
24122 #ifdef HAVE_WINDOW_SYSTEM
24123 if (FRAME_WINDOW_P (it
->f
))
24125 it
->ascent
= it
->phys_ascent
= ascent
;
24126 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24127 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24128 take_vertical_position_into_account (it
);
24132 it
->nglyphs
= width
;
24135 /* Get information about special display element WHAT in an
24136 environment described by IT. WHAT is one of IT_TRUNCATION or
24137 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24138 non-null glyph_row member. This function ensures that fields like
24139 face_id, c, len of IT are left untouched. */
24142 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
24149 temp_it
.object
= make_number (0);
24150 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
24152 if (what
== IT_CONTINUATION
)
24154 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24155 if (it
->bidi_it
.paragraph_dir
== R2L
)
24156 SET_GLYPH_FROM_CHAR (glyph
, '/');
24158 SET_GLYPH_FROM_CHAR (glyph
, '\\');
24160 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24162 /* FIXME: Should we mirror GC for R2L lines? */
24163 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24164 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24167 else if (what
== IT_TRUNCATION
)
24169 /* Truncation glyph. */
24170 SET_GLYPH_FROM_CHAR (glyph
, '$');
24172 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24174 /* FIXME: Should we mirror GC for R2L lines? */
24175 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24176 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24182 #ifdef HAVE_WINDOW_SYSTEM
24183 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24184 is turned off, we precede the truncation/continuation glyphs by a
24185 stretch glyph whose width is computed such that these special
24186 glyphs are aligned at the window margin, even when very different
24187 fonts are used in different glyph rows. */
24188 if (FRAME_WINDOW_P (temp_it
.f
)
24189 /* init_iterator calls this with it->glyph_row == NULL, and it
24190 wants only the pixel width of the truncation/continuation
24192 && temp_it
.glyph_row
24193 /* insert_left_trunc_glyphs calls us at the beginning of the
24194 row, and it has its own calculation of the stretch glyph
24196 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
24197 && (temp_it
.glyph_row
->reversed_p
24198 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
24199 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
24201 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
24203 if (stretch_width
> 0)
24205 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
24206 struct font
*font
=
24207 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
24208 int stretch_ascent
=
24209 (((temp_it
.ascent
+ temp_it
.descent
)
24210 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
24212 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
24213 temp_it
.ascent
+ temp_it
.descent
,
24220 temp_it
.what
= IT_CHARACTER
;
24222 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
24223 temp_it
.face_id
= GLYPH_FACE (glyph
);
24224 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
24226 PRODUCE_GLYPHS (&temp_it
);
24227 it
->pixel_width
= temp_it
.pixel_width
;
24228 it
->nglyphs
= temp_it
.pixel_width
;
24231 #ifdef HAVE_WINDOW_SYSTEM
24233 /* Calculate line-height and line-spacing properties.
24234 An integer value specifies explicit pixel value.
24235 A float value specifies relative value to current face height.
24236 A cons (float . face-name) specifies relative value to
24237 height of specified face font.
24239 Returns height in pixels, or nil. */
24243 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24244 int boff
, int override
)
24246 Lisp_Object face_name
= Qnil
;
24247 int ascent
, descent
, height
;
24249 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24254 face_name
= XCAR (val
);
24256 if (!NUMBERP (val
))
24257 val
= make_number (1);
24258 if (NILP (face_name
))
24260 height
= it
->ascent
+ it
->descent
;
24265 if (NILP (face_name
))
24267 font
= FRAME_FONT (it
->f
);
24268 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24270 else if (EQ (face_name
, Qt
))
24279 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24281 return make_number (-1);
24283 face
= FACE_FROM_ID (it
->f
, face_id
);
24286 return make_number (-1);
24287 boff
= font
->baseline_offset
;
24288 if (font
->vertical_centering
)
24289 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24292 ascent
= FONT_BASE (font
) + boff
;
24293 descent
= FONT_DESCENT (font
) - boff
;
24297 it
->override_ascent
= ascent
;
24298 it
->override_descent
= descent
;
24299 it
->override_boff
= boff
;
24302 height
= ascent
+ descent
;
24306 height
= (int)(XFLOAT_DATA (val
) * height
);
24307 else if (INTEGERP (val
))
24308 height
*= XINT (val
);
24310 return make_number (height
);
24314 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24315 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24316 and only if this is for a character for which no font was found.
24318 If the display method (it->glyphless_method) is
24319 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24320 length of the acronym or the hexadecimal string, UPPER_XOFF and
24321 UPPER_YOFF are pixel offsets for the upper part of the string,
24322 LOWER_XOFF and LOWER_YOFF are for the lower part.
24324 For the other display methods, LEN through LOWER_YOFF are zero. */
24327 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24328 short upper_xoff
, short upper_yoff
,
24329 short lower_xoff
, short lower_yoff
)
24331 struct glyph
*glyph
;
24332 enum glyph_row_area area
= it
->area
;
24334 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24335 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24337 /* If the glyph row is reversed, we need to prepend the glyph
24338 rather than append it. */
24339 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24343 /* Make room for the additional glyph. */
24344 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24346 glyph
= it
->glyph_row
->glyphs
[area
];
24348 glyph
->charpos
= CHARPOS (it
->position
);
24349 glyph
->object
= it
->object
;
24350 glyph
->pixel_width
= it
->pixel_width
;
24351 glyph
->ascent
= it
->ascent
;
24352 glyph
->descent
= it
->descent
;
24353 glyph
->voffset
= it
->voffset
;
24354 glyph
->type
= GLYPHLESS_GLYPH
;
24355 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24356 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24357 glyph
->u
.glyphless
.len
= len
;
24358 glyph
->u
.glyphless
.ch
= it
->c
;
24359 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24360 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24361 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24362 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24363 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24364 glyph
->multibyte_p
= it
->multibyte_p
;
24365 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24367 /* In R2L rows, the left and the right box edges need to be
24368 drawn in reverse direction. */
24369 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24370 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24374 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24375 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24377 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24378 || it
->phys_descent
> it
->descent
);
24379 glyph
->padding_p
= 0;
24380 glyph
->glyph_not_available_p
= 0;
24381 glyph
->face_id
= face_id
;
24382 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24385 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24386 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24388 glyph
->bidi_type
= it
->bidi_it
.type
;
24390 ++it
->glyph_row
->used
[area
];
24393 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24397 /* Produce a glyph for a glyphless character for iterator IT.
24398 IT->glyphless_method specifies which method to use for displaying
24399 the character. See the description of enum
24400 glyphless_display_method in dispextern.h for the detail.
24402 FOR_NO_FONT is nonzero if and only if this is for a character for
24403 which no font was found. ACRONYM, if non-nil, is an acronym string
24404 for the character. */
24407 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24412 int base_width
, base_height
, width
, height
;
24413 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24416 /* Get the metrics of the base font. We always refer to the current
24418 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24419 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24420 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24421 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24422 base_height
= it
->ascent
+ it
->descent
;
24423 base_width
= font
->average_width
;
24425 /* Get a face ID for the glyph by utilizing a cache (the same way as
24426 done for `escape-glyph' in get_next_display_element). */
24427 if (it
->f
== last_glyphless_glyph_frame
24428 && it
->face_id
== last_glyphless_glyph_face_id
)
24430 face_id
= last_glyphless_glyph_merged_face_id
;
24434 /* Merge the `glyphless-char' face into the current face. */
24435 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24436 last_glyphless_glyph_frame
= it
->f
;
24437 last_glyphless_glyph_face_id
= it
->face_id
;
24438 last_glyphless_glyph_merged_face_id
= face_id
;
24441 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24443 it
->pixel_width
= THIN_SPACE_WIDTH
;
24445 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24447 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24449 width
= CHAR_WIDTH (it
->c
);
24452 else if (width
> 4)
24454 it
->pixel_width
= base_width
* width
;
24456 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24462 unsigned int code
[6];
24464 int ascent
, descent
;
24465 struct font_metrics metrics_upper
, metrics_lower
;
24467 face
= FACE_FROM_ID (it
->f
, face_id
);
24468 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24469 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24471 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24473 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24474 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24475 if (CONSP (acronym
))
24476 acronym
= XCAR (acronym
);
24477 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24481 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24482 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24485 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24486 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24487 upper_len
= (len
+ 1) / 2;
24488 font
->driver
->text_extents (font
, code
, upper_len
,
24490 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24495 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24496 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24497 upper_xoff
= upper_yoff
= 2; /* the typical case */
24498 if (base_width
>= width
)
24500 /* Align the upper to the left, the lower to the right. */
24501 it
->pixel_width
= base_width
;
24502 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24506 /* Center the shorter one. */
24507 it
->pixel_width
= width
;
24508 if (metrics_upper
.width
>= metrics_lower
.width
)
24509 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24512 /* FIXME: This code doesn't look right. It formerly was
24513 missing the "lower_xoff = 0;", which couldn't have
24514 been right since it left lower_xoff uninitialized. */
24516 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24520 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24521 top, bottom, and between upper and lower strings. */
24522 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24523 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24524 /* Center vertically.
24525 H:base_height, D:base_descent
24526 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24528 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24529 descent = D - H/2 + h/2;
24530 lower_yoff = descent - 2 - ld;
24531 upper_yoff = lower_yoff - la - 1 - ud; */
24532 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24533 descent
= it
->descent
- (base_height
- height
) / 2;
24534 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24535 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24536 - metrics_upper
.descent
);
24537 /* Don't make the height shorter than the base height. */
24538 if (height
> base_height
)
24540 it
->ascent
= ascent
;
24541 it
->descent
= descent
;
24545 it
->phys_ascent
= it
->ascent
;
24546 it
->phys_descent
= it
->descent
;
24548 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24549 upper_xoff
, upper_yoff
,
24550 lower_xoff
, lower_yoff
);
24552 take_vertical_position_into_account (it
);
24557 Produce glyphs/get display metrics for the display element IT is
24558 loaded with. See the description of struct it in dispextern.h
24559 for an overview of struct it. */
24562 x_produce_glyphs (struct it
*it
)
24564 int extra_line_spacing
= it
->extra_line_spacing
;
24566 it
->glyph_not_available_p
= 0;
24568 if (it
->what
== IT_CHARACTER
)
24571 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24572 struct font
*font
= face
->font
;
24573 struct font_metrics
*pcm
= NULL
;
24574 int boff
; /* baseline offset */
24578 /* When no suitable font is found, display this character by
24579 the method specified in the first extra slot of
24580 Vglyphless_char_display. */
24581 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24583 eassert (it
->what
== IT_GLYPHLESS
);
24584 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24588 boff
= font
->baseline_offset
;
24589 if (font
->vertical_centering
)
24590 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24592 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24598 if (it
->override_ascent
>= 0)
24600 it
->ascent
= it
->override_ascent
;
24601 it
->descent
= it
->override_descent
;
24602 boff
= it
->override_boff
;
24606 it
->ascent
= FONT_BASE (font
) + boff
;
24607 it
->descent
= FONT_DESCENT (font
) - boff
;
24610 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24612 pcm
= get_per_char_metric (font
, &char2b
);
24613 if (pcm
->width
== 0
24614 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24620 it
->phys_ascent
= pcm
->ascent
+ boff
;
24621 it
->phys_descent
= pcm
->descent
- boff
;
24622 it
->pixel_width
= pcm
->width
;
24626 it
->glyph_not_available_p
= 1;
24627 it
->phys_ascent
= it
->ascent
;
24628 it
->phys_descent
= it
->descent
;
24629 it
->pixel_width
= font
->space_width
;
24632 if (it
->constrain_row_ascent_descent_p
)
24634 if (it
->descent
> it
->max_descent
)
24636 it
->ascent
+= it
->descent
- it
->max_descent
;
24637 it
->descent
= it
->max_descent
;
24639 if (it
->ascent
> it
->max_ascent
)
24641 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24642 it
->ascent
= it
->max_ascent
;
24644 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24645 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24646 extra_line_spacing
= 0;
24649 /* If this is a space inside a region of text with
24650 `space-width' property, change its width. */
24651 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24653 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24655 /* If face has a box, add the box thickness to the character
24656 height. If character has a box line to the left and/or
24657 right, add the box line width to the character's width. */
24658 if (face
->box
!= FACE_NO_BOX
)
24660 int thick
= face
->box_line_width
;
24664 it
->ascent
+= thick
;
24665 it
->descent
+= thick
;
24670 if (it
->start_of_box_run_p
)
24671 it
->pixel_width
+= thick
;
24672 if (it
->end_of_box_run_p
)
24673 it
->pixel_width
+= thick
;
24676 /* If face has an overline, add the height of the overline
24677 (1 pixel) and a 1 pixel margin to the character height. */
24678 if (face
->overline_p
)
24679 it
->ascent
+= overline_margin
;
24681 if (it
->constrain_row_ascent_descent_p
)
24683 if (it
->ascent
> it
->max_ascent
)
24684 it
->ascent
= it
->max_ascent
;
24685 if (it
->descent
> it
->max_descent
)
24686 it
->descent
= it
->max_descent
;
24689 take_vertical_position_into_account (it
);
24691 /* If we have to actually produce glyphs, do it. */
24696 /* Translate a space with a `space-width' property
24697 into a stretch glyph. */
24698 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24699 / FONT_HEIGHT (font
));
24700 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24701 it
->ascent
+ it
->descent
, ascent
);
24706 /* If characters with lbearing or rbearing are displayed
24707 in this line, record that fact in a flag of the
24708 glyph row. This is used to optimize X output code. */
24709 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24710 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24712 if (! stretched_p
&& it
->pixel_width
== 0)
24713 /* We assure that all visible glyphs have at least 1-pixel
24715 it
->pixel_width
= 1;
24717 else if (it
->char_to_display
== '\n')
24719 /* A newline has no width, but we need the height of the
24720 line. But if previous part of the line sets a height,
24721 don't increase that height */
24723 Lisp_Object height
;
24724 Lisp_Object total_height
= Qnil
;
24726 it
->override_ascent
= -1;
24727 it
->pixel_width
= 0;
24730 height
= get_it_property (it
, Qline_height
);
24731 /* Split (line-height total-height) list */
24733 && CONSP (XCDR (height
))
24734 && NILP (XCDR (XCDR (height
))))
24736 total_height
= XCAR (XCDR (height
));
24737 height
= XCAR (height
);
24739 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24741 if (it
->override_ascent
>= 0)
24743 it
->ascent
= it
->override_ascent
;
24744 it
->descent
= it
->override_descent
;
24745 boff
= it
->override_boff
;
24749 it
->ascent
= FONT_BASE (font
) + boff
;
24750 it
->descent
= FONT_DESCENT (font
) - boff
;
24753 if (EQ (height
, Qt
))
24755 if (it
->descent
> it
->max_descent
)
24757 it
->ascent
+= it
->descent
- it
->max_descent
;
24758 it
->descent
= it
->max_descent
;
24760 if (it
->ascent
> it
->max_ascent
)
24762 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24763 it
->ascent
= it
->max_ascent
;
24765 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24766 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24767 it
->constrain_row_ascent_descent_p
= 1;
24768 extra_line_spacing
= 0;
24772 Lisp_Object spacing
;
24774 it
->phys_ascent
= it
->ascent
;
24775 it
->phys_descent
= it
->descent
;
24777 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24778 && face
->box
!= FACE_NO_BOX
24779 && face
->box_line_width
> 0)
24781 it
->ascent
+= face
->box_line_width
;
24782 it
->descent
+= face
->box_line_width
;
24785 && XINT (height
) > it
->ascent
+ it
->descent
)
24786 it
->ascent
= XINT (height
) - it
->descent
;
24788 if (!NILP (total_height
))
24789 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24792 spacing
= get_it_property (it
, Qline_spacing
);
24793 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24795 if (INTEGERP (spacing
))
24797 extra_line_spacing
= XINT (spacing
);
24798 if (!NILP (total_height
))
24799 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24803 else /* i.e. (it->char_to_display == '\t') */
24805 if (font
->space_width
> 0)
24807 int tab_width
= it
->tab_width
* font
->space_width
;
24808 int x
= it
->current_x
+ it
->continuation_lines_width
;
24809 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24811 /* If the distance from the current position to the next tab
24812 stop is less than a space character width, use the
24813 tab stop after that. */
24814 if (next_tab_x
- x
< font
->space_width
)
24815 next_tab_x
+= tab_width
;
24817 it
->pixel_width
= next_tab_x
- x
;
24819 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24820 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24824 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24825 it
->ascent
+ it
->descent
, it
->ascent
);
24830 it
->pixel_width
= 0;
24835 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24837 /* A static composition.
24839 Note: A composition is represented as one glyph in the
24840 glyph matrix. There are no padding glyphs.
24842 Important note: pixel_width, ascent, and descent are the
24843 values of what is drawn by draw_glyphs (i.e. the values of
24844 the overall glyphs composed). */
24845 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24846 int boff
; /* baseline offset */
24847 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24848 int glyph_len
= cmp
->glyph_len
;
24849 struct font
*font
= face
->font
;
24853 /* If we have not yet calculated pixel size data of glyphs of
24854 the composition for the current face font, calculate them
24855 now. Theoretically, we have to check all fonts for the
24856 glyphs, but that requires much time and memory space. So,
24857 here we check only the font of the first glyph. This may
24858 lead to incorrect display, but it's very rare, and C-l
24859 (recenter-top-bottom) can correct the display anyway. */
24860 if (! cmp
->font
|| cmp
->font
!= font
)
24862 /* Ascent and descent of the font of the first character
24863 of this composition (adjusted by baseline offset).
24864 Ascent and descent of overall glyphs should not be less
24865 than these, respectively. */
24866 int font_ascent
, font_descent
, font_height
;
24867 /* Bounding box of the overall glyphs. */
24868 int leftmost
, rightmost
, lowest
, highest
;
24869 int lbearing
, rbearing
;
24870 int i
, width
, ascent
, descent
;
24871 int left_padded
= 0, right_padded
= 0;
24872 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24874 struct font_metrics
*pcm
;
24875 int font_not_found_p
;
24878 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24879 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24881 if (glyph_len
< cmp
->glyph_len
)
24883 for (i
= 0; i
< glyph_len
; i
++)
24885 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24887 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24892 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24893 : IT_CHARPOS (*it
));
24894 /* If no suitable font is found, use the default font. */
24895 font_not_found_p
= font
== NULL
;
24896 if (font_not_found_p
)
24898 face
= face
->ascii_face
;
24901 boff
= font
->baseline_offset
;
24902 if (font
->vertical_centering
)
24903 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24904 font_ascent
= FONT_BASE (font
) + boff
;
24905 font_descent
= FONT_DESCENT (font
) - boff
;
24906 font_height
= FONT_HEIGHT (font
);
24911 if (! font_not_found_p
)
24913 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24915 pcm
= get_per_char_metric (font
, &char2b
);
24918 /* Initialize the bounding box. */
24921 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
24922 ascent
= pcm
->ascent
;
24923 descent
= pcm
->descent
;
24924 lbearing
= pcm
->lbearing
;
24925 rbearing
= pcm
->rbearing
;
24929 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
24930 ascent
= FONT_BASE (font
);
24931 descent
= FONT_DESCENT (font
);
24938 lowest
= - descent
+ boff
;
24939 highest
= ascent
+ boff
;
24941 if (! font_not_found_p
24942 && font
->default_ascent
24943 && CHAR_TABLE_P (Vuse_default_ascent
)
24944 && !NILP (Faref (Vuse_default_ascent
,
24945 make_number (it
->char_to_display
))))
24946 highest
= font
->default_ascent
+ boff
;
24948 /* Draw the first glyph at the normal position. It may be
24949 shifted to right later if some other glyphs are drawn
24951 cmp
->offsets
[i
* 2] = 0;
24952 cmp
->offsets
[i
* 2 + 1] = boff
;
24953 cmp
->lbearing
= lbearing
;
24954 cmp
->rbearing
= rbearing
;
24956 /* Set cmp->offsets for the remaining glyphs. */
24957 for (i
++; i
< glyph_len
; i
++)
24959 int left
, right
, btm
, top
;
24960 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24962 struct face
*this_face
;
24966 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24967 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24968 font
= this_face
->font
;
24974 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24976 pcm
= get_per_char_metric (font
, &char2b
);
24979 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24982 width
= pcm
->width
;
24983 ascent
= pcm
->ascent
;
24984 descent
= pcm
->descent
;
24985 lbearing
= pcm
->lbearing
;
24986 rbearing
= pcm
->rbearing
;
24987 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24989 /* Relative composition with or without
24990 alternate chars. */
24991 left
= (leftmost
+ rightmost
- width
) / 2;
24992 btm
= - descent
+ boff
;
24993 if (font
->relative_compose
24994 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24995 || NILP (Faref (Vignore_relative_composition
,
24996 make_number (ch
)))))
24999 if (- descent
>= font
->relative_compose
)
25000 /* One extra pixel between two glyphs. */
25002 else if (ascent
<= 0)
25003 /* One extra pixel between two glyphs. */
25004 btm
= lowest
- 1 - ascent
- descent
;
25009 /* A composition rule is specified by an integer
25010 value that encodes global and new reference
25011 points (GREF and NREF). GREF and NREF are
25012 specified by numbers as below:
25014 0---1---2 -- ascent
25018 9--10--11 -- center
25020 ---3---4---5--- baseline
25022 6---7---8 -- descent
25024 int rule
= COMPOSITION_RULE (cmp
, i
);
25025 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
25027 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
25028 grefx
= gref
% 3, nrefx
= nref
% 3;
25029 grefy
= gref
/ 3, nrefy
= nref
/ 3;
25031 xoff
= font_height
* (xoff
- 128) / 256;
25033 yoff
= font_height
* (yoff
- 128) / 256;
25036 + grefx
* (rightmost
- leftmost
) / 2
25037 - nrefx
* width
/ 2
25040 btm
= ((grefy
== 0 ? highest
25042 : grefy
== 2 ? lowest
25043 : (highest
+ lowest
) / 2)
25044 - (nrefy
== 0 ? ascent
+ descent
25045 : nrefy
== 1 ? descent
- boff
25047 : (ascent
+ descent
) / 2)
25051 cmp
->offsets
[i
* 2] = left
;
25052 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
25054 /* Update the bounding box of the overall glyphs. */
25057 right
= left
+ width
;
25058 if (left
< leftmost
)
25060 if (right
> rightmost
)
25063 top
= btm
+ descent
+ ascent
;
25069 if (cmp
->lbearing
> left
+ lbearing
)
25070 cmp
->lbearing
= left
+ lbearing
;
25071 if (cmp
->rbearing
< left
+ rbearing
)
25072 cmp
->rbearing
= left
+ rbearing
;
25076 /* If there are glyphs whose x-offsets are negative,
25077 shift all glyphs to the right and make all x-offsets
25081 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25082 cmp
->offsets
[i
* 2] -= leftmost
;
25083 rightmost
-= leftmost
;
25084 cmp
->lbearing
-= leftmost
;
25085 cmp
->rbearing
-= leftmost
;
25088 if (left_padded
&& cmp
->lbearing
< 0)
25090 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25091 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
25092 rightmost
-= cmp
->lbearing
;
25093 cmp
->rbearing
-= cmp
->lbearing
;
25096 if (right_padded
&& rightmost
< cmp
->rbearing
)
25098 rightmost
= cmp
->rbearing
;
25101 cmp
->pixel_width
= rightmost
;
25102 cmp
->ascent
= highest
;
25103 cmp
->descent
= - lowest
;
25104 if (cmp
->ascent
< font_ascent
)
25105 cmp
->ascent
= font_ascent
;
25106 if (cmp
->descent
< font_descent
)
25107 cmp
->descent
= font_descent
;
25111 && (cmp
->lbearing
< 0
25112 || cmp
->rbearing
> cmp
->pixel_width
))
25113 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25115 it
->pixel_width
= cmp
->pixel_width
;
25116 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
25117 it
->descent
= it
->phys_descent
= cmp
->descent
;
25118 if (face
->box
!= FACE_NO_BOX
)
25120 int thick
= face
->box_line_width
;
25124 it
->ascent
+= thick
;
25125 it
->descent
+= thick
;
25130 if (it
->start_of_box_run_p
)
25131 it
->pixel_width
+= thick
;
25132 if (it
->end_of_box_run_p
)
25133 it
->pixel_width
+= thick
;
25136 /* If face has an overline, add the height of the overline
25137 (1 pixel) and a 1 pixel margin to the character height. */
25138 if (face
->overline_p
)
25139 it
->ascent
+= overline_margin
;
25141 take_vertical_position_into_account (it
);
25142 if (it
->ascent
< 0)
25144 if (it
->descent
< 0)
25147 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
25148 append_composite_glyph (it
);
25150 else if (it
->what
== IT_COMPOSITION
)
25152 /* A dynamic (automatic) composition. */
25153 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25154 Lisp_Object gstring
;
25155 struct font_metrics metrics
;
25159 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
25161 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
25164 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
25165 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25166 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
25167 it
->descent
= it
->phys_descent
= metrics
.descent
;
25168 if (face
->box
!= FACE_NO_BOX
)
25170 int thick
= face
->box_line_width
;
25174 it
->ascent
+= thick
;
25175 it
->descent
+= thick
;
25180 if (it
->start_of_box_run_p
)
25181 it
->pixel_width
+= thick
;
25182 if (it
->end_of_box_run_p
)
25183 it
->pixel_width
+= thick
;
25185 /* If face has an overline, add the height of the overline
25186 (1 pixel) and a 1 pixel margin to the character height. */
25187 if (face
->overline_p
)
25188 it
->ascent
+= overline_margin
;
25189 take_vertical_position_into_account (it
);
25190 if (it
->ascent
< 0)
25192 if (it
->descent
< 0)
25196 append_composite_glyph (it
);
25198 else if (it
->what
== IT_GLYPHLESS
)
25199 produce_glyphless_glyph (it
, 0, Qnil
);
25200 else if (it
->what
== IT_IMAGE
)
25201 produce_image_glyph (it
);
25202 else if (it
->what
== IT_STRETCH
)
25203 produce_stretch_glyph (it
);
25206 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25207 because this isn't true for images with `:ascent 100'. */
25208 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
25209 if (it
->area
== TEXT_AREA
)
25210 it
->current_x
+= it
->pixel_width
;
25212 if (extra_line_spacing
> 0)
25214 it
->descent
+= extra_line_spacing
;
25215 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25216 it
->max_extra_line_spacing
= extra_line_spacing
;
25219 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25220 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25221 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25222 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25226 Output LEN glyphs starting at START at the nominal cursor position.
25227 Advance the nominal cursor over the text. The global variable
25228 updated_window contains the window being updated, updated_row is
25229 the glyph row being updated, and updated_area is the area of that
25230 row being updated. */
25233 x_write_glyphs (struct glyph
*start
, int len
)
25235 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25237 eassert (updated_window
&& updated_row
);
25238 /* When the window is hscrolled, cursor hpos can legitimately be out
25239 of bounds, but we draw the cursor at the corresponding window
25240 margin in that case. */
25241 if (!updated_row
->reversed_p
&& chpos
< 0)
25243 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25244 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25248 /* Write glyphs. */
25250 hpos
= start
- updated_row
->glyphs
[updated_area
];
25251 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25252 updated_row
, updated_area
,
25254 DRAW_NORMAL_TEXT
, 0);
25256 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25257 if (updated_area
== TEXT_AREA
25258 && updated_window
->phys_cursor_on_p
25259 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25261 && chpos
< hpos
+ len
)
25262 updated_window
->phys_cursor_on_p
= 0;
25266 /* Advance the output cursor. */
25267 output_cursor
.hpos
+= len
;
25268 output_cursor
.x
= x
;
25273 Insert LEN glyphs from START at the nominal cursor position. */
25276 x_insert_glyphs (struct glyph
*start
, int len
)
25280 int line_height
, shift_by_width
, shifted_region_width
;
25281 struct glyph_row
*row
;
25282 struct glyph
*glyph
;
25283 int frame_x
, frame_y
;
25286 eassert (updated_window
&& updated_row
);
25288 w
= updated_window
;
25289 f
= XFRAME (WINDOW_FRAME (w
));
25291 /* Get the height of the line we are in. */
25293 line_height
= row
->height
;
25295 /* Get the width of the glyphs to insert. */
25296 shift_by_width
= 0;
25297 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25298 shift_by_width
+= glyph
->pixel_width
;
25300 /* Get the width of the region to shift right. */
25301 shifted_region_width
= (window_box_width (w
, updated_area
)
25306 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25307 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25309 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25310 line_height
, shift_by_width
);
25312 /* Write the glyphs. */
25313 hpos
= start
- row
->glyphs
[updated_area
];
25314 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25316 DRAW_NORMAL_TEXT
, 0);
25318 /* Advance the output cursor. */
25319 output_cursor
.hpos
+= len
;
25320 output_cursor
.x
+= shift_by_width
;
25326 Erase the current text line from the nominal cursor position
25327 (inclusive) to pixel column TO_X (exclusive). The idea is that
25328 everything from TO_X onward is already erased.
25330 TO_X is a pixel position relative to updated_area of
25331 updated_window. TO_X == -1 means clear to the end of this area. */
25334 x_clear_end_of_line (int to_x
)
25337 struct window
*w
= updated_window
;
25338 int max_x
, min_y
, max_y
;
25339 int from_x
, from_y
, to_y
;
25341 eassert (updated_window
&& updated_row
);
25342 f
= XFRAME (w
->frame
);
25344 if (updated_row
->full_width_p
)
25345 max_x
= WINDOW_TOTAL_WIDTH (w
);
25347 max_x
= window_box_width (w
, updated_area
);
25348 max_y
= window_text_bottom_y (w
);
25350 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25351 of window. For TO_X > 0, truncate to end of drawing area. */
25357 to_x
= min (to_x
, max_x
);
25359 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25361 /* Notice if the cursor will be cleared by this operation. */
25362 if (!updated_row
->full_width_p
)
25363 notice_overwritten_cursor (w
, updated_area
,
25364 output_cursor
.x
, -1,
25366 MATRIX_ROW_BOTTOM_Y (updated_row
));
25368 from_x
= output_cursor
.x
;
25370 /* Translate to frame coordinates. */
25371 if (updated_row
->full_width_p
)
25373 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25374 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25378 int area_left
= window_box_left (w
, updated_area
);
25379 from_x
+= area_left
;
25383 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25384 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25385 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25387 /* Prevent inadvertently clearing to end of the X window. */
25388 if (to_x
> from_x
&& to_y
> from_y
)
25391 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25392 to_x
- from_x
, to_y
- from_y
);
25397 #endif /* HAVE_WINDOW_SYSTEM */
25401 /***********************************************************************
25403 ***********************************************************************/
25405 /* Value is the internal representation of the specified cursor type
25406 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25407 of the bar cursor. */
25409 static enum text_cursor_kinds
25410 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25412 enum text_cursor_kinds type
;
25417 if (EQ (arg
, Qbox
))
25418 return FILLED_BOX_CURSOR
;
25420 if (EQ (arg
, Qhollow
))
25421 return HOLLOW_BOX_CURSOR
;
25423 if (EQ (arg
, Qbar
))
25430 && EQ (XCAR (arg
), Qbar
)
25431 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25433 *width
= XINT (XCDR (arg
));
25437 if (EQ (arg
, Qhbar
))
25440 return HBAR_CURSOR
;
25444 && EQ (XCAR (arg
), Qhbar
)
25445 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25447 *width
= XINT (XCDR (arg
));
25448 return HBAR_CURSOR
;
25451 /* Treat anything unknown as "hollow box cursor".
25452 It was bad to signal an error; people have trouble fixing
25453 .Xdefaults with Emacs, when it has something bad in it. */
25454 type
= HOLLOW_BOX_CURSOR
;
25459 /* Set the default cursor types for specified frame. */
25461 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25466 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25467 FRAME_CURSOR_WIDTH (f
) = width
;
25469 /* By default, set up the blink-off state depending on the on-state. */
25471 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25474 FRAME_BLINK_OFF_CURSOR (f
)
25475 = get_specified_cursor_type (XCDR (tem
), &width
);
25476 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25479 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25483 #ifdef HAVE_WINDOW_SYSTEM
25485 /* Return the cursor we want to be displayed in window W. Return
25486 width of bar/hbar cursor through WIDTH arg. Return with
25487 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25488 (i.e. if the `system caret' should track this cursor).
25490 In a mini-buffer window, we want the cursor only to appear if we
25491 are reading input from this window. For the selected window, we
25492 want the cursor type given by the frame parameter or buffer local
25493 setting of cursor-type. If explicitly marked off, draw no cursor.
25494 In all other cases, we want a hollow box cursor. */
25496 static enum text_cursor_kinds
25497 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25498 int *active_cursor
)
25500 struct frame
*f
= XFRAME (w
->frame
);
25501 struct buffer
*b
= XBUFFER (w
->buffer
);
25502 int cursor_type
= DEFAULT_CURSOR
;
25503 Lisp_Object alt_cursor
;
25504 int non_selected
= 0;
25506 *active_cursor
= 1;
25509 if (cursor_in_echo_area
25510 && FRAME_HAS_MINIBUF_P (f
)
25511 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25513 if (w
== XWINDOW (echo_area_window
))
25515 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25517 *width
= FRAME_CURSOR_WIDTH (f
);
25518 return FRAME_DESIRED_CURSOR (f
);
25521 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25524 *active_cursor
= 0;
25528 /* Detect a nonselected window or nonselected frame. */
25529 else if (w
!= XWINDOW (f
->selected_window
)
25530 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25532 *active_cursor
= 0;
25534 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25540 /* Never display a cursor in a window in which cursor-type is nil. */
25541 if (NILP (BVAR (b
, cursor_type
)))
25544 /* Get the normal cursor type for this window. */
25545 if (EQ (BVAR (b
, cursor_type
), Qt
))
25547 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25548 *width
= FRAME_CURSOR_WIDTH (f
);
25551 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25553 /* Use cursor-in-non-selected-windows instead
25554 for non-selected window or frame. */
25557 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25558 if (!EQ (Qt
, alt_cursor
))
25559 return get_specified_cursor_type (alt_cursor
, width
);
25560 /* t means modify the normal cursor type. */
25561 if (cursor_type
== FILLED_BOX_CURSOR
)
25562 cursor_type
= HOLLOW_BOX_CURSOR
;
25563 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25565 return cursor_type
;
25568 /* Use normal cursor if not blinked off. */
25569 if (!w
->cursor_off_p
)
25571 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25573 if (cursor_type
== FILLED_BOX_CURSOR
)
25575 /* Using a block cursor on large images can be very annoying.
25576 So use a hollow cursor for "large" images.
25577 If image is not transparent (no mask), also use hollow cursor. */
25578 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25579 if (img
!= NULL
&& IMAGEP (img
->spec
))
25581 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25582 where N = size of default frame font size.
25583 This should cover most of the "tiny" icons people may use. */
25585 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25586 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25587 cursor_type
= HOLLOW_BOX_CURSOR
;
25590 else if (cursor_type
!= NO_CURSOR
)
25592 /* Display current only supports BOX and HOLLOW cursors for images.
25593 So for now, unconditionally use a HOLLOW cursor when cursor is
25594 not a solid box cursor. */
25595 cursor_type
= HOLLOW_BOX_CURSOR
;
25598 return cursor_type
;
25601 /* Cursor is blinked off, so determine how to "toggle" it. */
25603 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25604 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25605 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25607 /* Then see if frame has specified a specific blink off cursor type. */
25608 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25610 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25611 return FRAME_BLINK_OFF_CURSOR (f
);
25615 /* Some people liked having a permanently visible blinking cursor,
25616 while others had very strong opinions against it. So it was
25617 decided to remove it. KFS 2003-09-03 */
25619 /* Finally perform built-in cursor blinking:
25620 filled box <-> hollow box
25621 wide [h]bar <-> narrow [h]bar
25622 narrow [h]bar <-> no cursor
25623 other type <-> no cursor */
25625 if (cursor_type
== FILLED_BOX_CURSOR
)
25626 return HOLLOW_BOX_CURSOR
;
25628 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25631 return cursor_type
;
25639 /* Notice when the text cursor of window W has been completely
25640 overwritten by a drawing operation that outputs glyphs in AREA
25641 starting at X0 and ending at X1 in the line starting at Y0 and
25642 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25643 the rest of the line after X0 has been written. Y coordinates
25644 are window-relative. */
25647 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25648 int x0
, int x1
, int y0
, int y1
)
25650 int cx0
, cx1
, cy0
, cy1
;
25651 struct glyph_row
*row
;
25653 if (!w
->phys_cursor_on_p
)
25655 if (area
!= TEXT_AREA
)
25658 if (w
->phys_cursor
.vpos
< 0
25659 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25660 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25661 !(row
->enabled_p
&& row
->displays_text_p
)))
25664 if (row
->cursor_in_fringe_p
)
25666 row
->cursor_in_fringe_p
= 0;
25667 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25668 w
->phys_cursor_on_p
= 0;
25672 cx0
= w
->phys_cursor
.x
;
25673 cx1
= cx0
+ w
->phys_cursor_width
;
25674 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25677 /* The cursor image will be completely removed from the
25678 screen if the output area intersects the cursor area in
25679 y-direction. When we draw in [y0 y1[, and some part of
25680 the cursor is at y < y0, that part must have been drawn
25681 before. When scrolling, the cursor is erased before
25682 actually scrolling, so we don't come here. When not
25683 scrolling, the rows above the old cursor row must have
25684 changed, and in this case these rows must have written
25685 over the cursor image.
25687 Likewise if part of the cursor is below y1, with the
25688 exception of the cursor being in the first blank row at
25689 the buffer and window end because update_text_area
25690 doesn't draw that row. (Except when it does, but
25691 that's handled in update_text_area.) */
25693 cy0
= w
->phys_cursor
.y
;
25694 cy1
= cy0
+ w
->phys_cursor_height
;
25695 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25698 w
->phys_cursor_on_p
= 0;
25701 #endif /* HAVE_WINDOW_SYSTEM */
25704 /************************************************************************
25706 ************************************************************************/
25708 #ifdef HAVE_WINDOW_SYSTEM
25711 Fix the display of area AREA of overlapping row ROW in window W
25712 with respect to the overlapping part OVERLAPS. */
25715 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25716 enum glyph_row_area area
, int overlaps
)
25723 for (i
= 0; i
< row
->used
[area
];)
25725 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25727 int start
= i
, start_x
= x
;
25731 x
+= row
->glyphs
[area
][i
].pixel_width
;
25734 while (i
< row
->used
[area
]
25735 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25737 draw_glyphs (w
, start_x
, row
, area
,
25739 DRAW_NORMAL_TEXT
, overlaps
);
25743 x
+= row
->glyphs
[area
][i
].pixel_width
;
25753 Draw the cursor glyph of window W in glyph row ROW. See the
25754 comment of draw_glyphs for the meaning of HL. */
25757 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25758 enum draw_glyphs_face hl
)
25760 /* If cursor hpos is out of bounds, don't draw garbage. This can
25761 happen in mini-buffer windows when switching between echo area
25762 glyphs and mini-buffer. */
25763 if ((row
->reversed_p
25764 ? (w
->phys_cursor
.hpos
>= 0)
25765 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25767 int on_p
= w
->phys_cursor_on_p
;
25769 int hpos
= w
->phys_cursor
.hpos
;
25771 /* When the window is hscrolled, cursor hpos can legitimately be
25772 out of bounds, but we draw the cursor at the corresponding
25773 window margin in that case. */
25774 if (!row
->reversed_p
&& hpos
< 0)
25776 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25777 hpos
= row
->used
[TEXT_AREA
] - 1;
25779 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25781 w
->phys_cursor_on_p
= on_p
;
25783 if (hl
== DRAW_CURSOR
)
25784 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25785 /* When we erase the cursor, and ROW is overlapped by other
25786 rows, make sure that these overlapping parts of other rows
25788 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25790 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25792 if (row
> w
->current_matrix
->rows
25793 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25794 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25795 OVERLAPS_ERASED_CURSOR
);
25797 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25798 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25799 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25800 OVERLAPS_ERASED_CURSOR
);
25807 Erase the image of a cursor of window W from the screen. */
25810 erase_phys_cursor (struct window
*w
)
25812 struct frame
*f
= XFRAME (w
->frame
);
25813 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25814 int hpos
= w
->phys_cursor
.hpos
;
25815 int vpos
= w
->phys_cursor
.vpos
;
25816 int mouse_face_here_p
= 0;
25817 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25818 struct glyph_row
*cursor_row
;
25819 struct glyph
*cursor_glyph
;
25820 enum draw_glyphs_face hl
;
25822 /* No cursor displayed or row invalidated => nothing to do on the
25824 if (w
->phys_cursor_type
== NO_CURSOR
)
25825 goto mark_cursor_off
;
25827 /* VPOS >= active_glyphs->nrows means that window has been resized.
25828 Don't bother to erase the cursor. */
25829 if (vpos
>= active_glyphs
->nrows
)
25830 goto mark_cursor_off
;
25832 /* If row containing cursor is marked invalid, there is nothing we
25834 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25835 if (!cursor_row
->enabled_p
)
25836 goto mark_cursor_off
;
25838 /* If line spacing is > 0, old cursor may only be partially visible in
25839 window after split-window. So adjust visible height. */
25840 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25841 window_text_bottom_y (w
) - cursor_row
->y
);
25843 /* If row is completely invisible, don't attempt to delete a cursor which
25844 isn't there. This can happen if cursor is at top of a window, and
25845 we switch to a buffer with a header line in that window. */
25846 if (cursor_row
->visible_height
<= 0)
25847 goto mark_cursor_off
;
25849 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25850 if (cursor_row
->cursor_in_fringe_p
)
25852 cursor_row
->cursor_in_fringe_p
= 0;
25853 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25854 goto mark_cursor_off
;
25857 /* This can happen when the new row is shorter than the old one.
25858 In this case, either draw_glyphs or clear_end_of_line
25859 should have cleared the cursor. Note that we wouldn't be
25860 able to erase the cursor in this case because we don't have a
25861 cursor glyph at hand. */
25862 if ((cursor_row
->reversed_p
25863 ? (w
->phys_cursor
.hpos
< 0)
25864 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25865 goto mark_cursor_off
;
25867 /* When the window is hscrolled, cursor hpos can legitimately be out
25868 of bounds, but we draw the cursor at the corresponding window
25869 margin in that case. */
25870 if (!cursor_row
->reversed_p
&& hpos
< 0)
25872 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25873 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25875 /* If the cursor is in the mouse face area, redisplay that when
25876 we clear the cursor. */
25877 if (! NILP (hlinfo
->mouse_face_window
)
25878 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25879 /* Don't redraw the cursor's spot in mouse face if it is at the
25880 end of a line (on a newline). The cursor appears there, but
25881 mouse highlighting does not. */
25882 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25883 mouse_face_here_p
= 1;
25885 /* Maybe clear the display under the cursor. */
25886 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25889 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25892 cursor_glyph
= get_phys_cursor_glyph (w
);
25893 if (cursor_glyph
== NULL
)
25894 goto mark_cursor_off
;
25896 width
= cursor_glyph
->pixel_width
;
25897 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25898 x
= w
->phys_cursor
.x
;
25900 width
-= left_x
- x
;
25901 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25902 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25903 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25906 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25909 /* Erase the cursor by redrawing the character underneath it. */
25910 if (mouse_face_here_p
)
25911 hl
= DRAW_MOUSE_FACE
;
25913 hl
= DRAW_NORMAL_TEXT
;
25914 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25917 w
->phys_cursor_on_p
= 0;
25918 w
->phys_cursor_type
= NO_CURSOR
;
25923 Display or clear cursor of window W. If ON is zero, clear the
25924 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25925 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25928 display_and_set_cursor (struct window
*w
, int on
,
25929 int hpos
, int vpos
, int x
, int y
)
25931 struct frame
*f
= XFRAME (w
->frame
);
25932 int new_cursor_type
;
25933 int new_cursor_width
;
25935 struct glyph_row
*glyph_row
;
25936 struct glyph
*glyph
;
25938 /* This is pointless on invisible frames, and dangerous on garbaged
25939 windows and frames; in the latter case, the frame or window may
25940 be in the midst of changing its size, and x and y may be off the
25942 if (! FRAME_VISIBLE_P (f
)
25943 || FRAME_GARBAGED_P (f
)
25944 || vpos
>= w
->current_matrix
->nrows
25945 || hpos
>= w
->current_matrix
->matrix_w
)
25948 /* If cursor is off and we want it off, return quickly. */
25949 if (!on
&& !w
->phys_cursor_on_p
)
25952 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25953 /* If cursor row is not enabled, we don't really know where to
25954 display the cursor. */
25955 if (!glyph_row
->enabled_p
)
25957 w
->phys_cursor_on_p
= 0;
25962 if (!glyph_row
->exact_window_width_line_p
25963 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25964 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25966 eassert (input_blocked_p ());
25968 /* Set new_cursor_type to the cursor we want to be displayed. */
25969 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25970 &new_cursor_width
, &active_cursor
);
25972 /* If cursor is currently being shown and we don't want it to be or
25973 it is in the wrong place, or the cursor type is not what we want,
25975 if (w
->phys_cursor_on_p
25977 || w
->phys_cursor
.x
!= x
25978 || w
->phys_cursor
.y
!= y
25979 || new_cursor_type
!= w
->phys_cursor_type
25980 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25981 && new_cursor_width
!= w
->phys_cursor_width
)))
25982 erase_phys_cursor (w
);
25984 /* Don't check phys_cursor_on_p here because that flag is only set
25985 to zero in some cases where we know that the cursor has been
25986 completely erased, to avoid the extra work of erasing the cursor
25987 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25988 still not be visible, or it has only been partly erased. */
25991 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25992 w
->phys_cursor_height
= glyph_row
->height
;
25994 /* Set phys_cursor_.* before x_draw_.* is called because some
25995 of them may need the information. */
25996 w
->phys_cursor
.x
= x
;
25997 w
->phys_cursor
.y
= glyph_row
->y
;
25998 w
->phys_cursor
.hpos
= hpos
;
25999 w
->phys_cursor
.vpos
= vpos
;
26002 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
26003 new_cursor_type
, new_cursor_width
,
26004 on
, active_cursor
);
26008 /* Switch the display of W's cursor on or off, according to the value
26012 update_window_cursor (struct window
*w
, int on
)
26014 /* Don't update cursor in windows whose frame is in the process
26015 of being deleted. */
26016 if (w
->current_matrix
)
26018 int hpos
= w
->phys_cursor
.hpos
;
26019 int vpos
= w
->phys_cursor
.vpos
;
26020 struct glyph_row
*row
;
26022 if (vpos
>= w
->current_matrix
->nrows
26023 || hpos
>= w
->current_matrix
->matrix_w
)
26026 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26028 /* When the window is hscrolled, cursor hpos can legitimately be
26029 out of bounds, but we draw the cursor at the corresponding
26030 window margin in that case. */
26031 if (!row
->reversed_p
&& hpos
< 0)
26033 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26034 hpos
= row
->used
[TEXT_AREA
] - 1;
26037 display_and_set_cursor (w
, on
, hpos
, vpos
,
26038 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26044 /* Call update_window_cursor with parameter ON_P on all leaf windows
26045 in the window tree rooted at W. */
26048 update_cursor_in_window_tree (struct window
*w
, int on_p
)
26052 if (!NILP (w
->hchild
))
26053 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
26054 else if (!NILP (w
->vchild
))
26055 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
26057 update_window_cursor (w
, on_p
);
26059 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
26065 Display the cursor on window W, or clear it, according to ON_P.
26066 Don't change the cursor's position. */
26069 x_update_cursor (struct frame
*f
, int on_p
)
26071 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
26076 Clear the cursor of window W to background color, and mark the
26077 cursor as not shown. This is used when the text where the cursor
26078 is about to be rewritten. */
26081 x_clear_cursor (struct window
*w
)
26083 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
26084 update_window_cursor (w
, 0);
26087 #endif /* HAVE_WINDOW_SYSTEM */
26089 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26092 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
26093 int start_hpos
, int end_hpos
,
26094 enum draw_glyphs_face draw
)
26096 #ifdef HAVE_WINDOW_SYSTEM
26097 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
26099 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
26103 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26104 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
26108 /* Display the active region described by mouse_face_* according to DRAW. */
26111 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
26113 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
26114 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26116 if (/* If window is in the process of being destroyed, don't bother
26118 w
->current_matrix
!= NULL
26119 /* Don't update mouse highlight if hidden */
26120 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
26121 /* Recognize when we are called to operate on rows that don't exist
26122 anymore. This can happen when a window is split. */
26123 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
26125 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
26126 struct glyph_row
*row
, *first
, *last
;
26128 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
26129 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
26131 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
26133 int start_hpos
, end_hpos
, start_x
;
26135 /* For all but the first row, the highlight starts at column 0. */
26138 /* R2L rows have BEG and END in reversed order, but the
26139 screen drawing geometry is always left to right. So
26140 we need to mirror the beginning and end of the
26141 highlighted area in R2L rows. */
26142 if (!row
->reversed_p
)
26144 start_hpos
= hlinfo
->mouse_face_beg_col
;
26145 start_x
= hlinfo
->mouse_face_beg_x
;
26147 else if (row
== last
)
26149 start_hpos
= hlinfo
->mouse_face_end_col
;
26150 start_x
= hlinfo
->mouse_face_end_x
;
26158 else if (row
->reversed_p
&& row
== last
)
26160 start_hpos
= hlinfo
->mouse_face_end_col
;
26161 start_x
= hlinfo
->mouse_face_end_x
;
26171 if (!row
->reversed_p
)
26172 end_hpos
= hlinfo
->mouse_face_end_col
;
26173 else if (row
== first
)
26174 end_hpos
= hlinfo
->mouse_face_beg_col
;
26177 end_hpos
= row
->used
[TEXT_AREA
];
26178 if (draw
== DRAW_NORMAL_TEXT
)
26179 row
->fill_line_p
= 1; /* Clear to end of line */
26182 else if (row
->reversed_p
&& row
== first
)
26183 end_hpos
= hlinfo
->mouse_face_beg_col
;
26186 end_hpos
= row
->used
[TEXT_AREA
];
26187 if (draw
== DRAW_NORMAL_TEXT
)
26188 row
->fill_line_p
= 1; /* Clear to end of line */
26191 if (end_hpos
> start_hpos
)
26193 draw_row_with_mouse_face (w
, start_x
, row
,
26194 start_hpos
, end_hpos
, draw
);
26197 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26201 #ifdef HAVE_WINDOW_SYSTEM
26202 /* When we've written over the cursor, arrange for it to
26203 be displayed again. */
26204 if (FRAME_WINDOW_P (f
)
26205 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26207 int hpos
= w
->phys_cursor
.hpos
;
26209 /* When the window is hscrolled, cursor hpos can legitimately be
26210 out of bounds, but we draw the cursor at the corresponding
26211 window margin in that case. */
26212 if (!row
->reversed_p
&& hpos
< 0)
26214 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26215 hpos
= row
->used
[TEXT_AREA
] - 1;
26218 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26219 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26222 #endif /* HAVE_WINDOW_SYSTEM */
26225 #ifdef HAVE_WINDOW_SYSTEM
26226 /* Change the mouse cursor. */
26227 if (FRAME_WINDOW_P (f
))
26229 if (draw
== DRAW_NORMAL_TEXT
26230 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26231 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26232 else if (draw
== DRAW_MOUSE_FACE
)
26233 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26235 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26237 #endif /* HAVE_WINDOW_SYSTEM */
26241 Clear out the mouse-highlighted active region.
26242 Redraw it un-highlighted first. Value is non-zero if mouse
26243 face was actually drawn unhighlighted. */
26246 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26250 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26252 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26256 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26257 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26258 hlinfo
->mouse_face_window
= Qnil
;
26259 hlinfo
->mouse_face_overlay
= Qnil
;
26263 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26264 within the mouse face on that window. */
26266 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26268 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26270 /* Quickly resolve the easy cases. */
26271 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26272 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26274 if (vpos
< hlinfo
->mouse_face_beg_row
26275 || vpos
> hlinfo
->mouse_face_end_row
)
26277 if (vpos
> hlinfo
->mouse_face_beg_row
26278 && vpos
< hlinfo
->mouse_face_end_row
)
26281 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26283 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26285 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26288 else if ((vpos
== hlinfo
->mouse_face_beg_row
26289 && hpos
>= hlinfo
->mouse_face_beg_col
)
26290 || (vpos
== hlinfo
->mouse_face_end_row
26291 && hpos
< hlinfo
->mouse_face_end_col
))
26296 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26298 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26301 else if ((vpos
== hlinfo
->mouse_face_beg_row
26302 && hpos
<= hlinfo
->mouse_face_beg_col
)
26303 || (vpos
== hlinfo
->mouse_face_end_row
26304 && hpos
> hlinfo
->mouse_face_end_col
))
26312 Non-zero if physical cursor of window W is within mouse face. */
26315 cursor_in_mouse_face_p (struct window
*w
)
26317 int hpos
= w
->phys_cursor
.hpos
;
26318 int vpos
= w
->phys_cursor
.vpos
;
26319 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26321 /* When the window is hscrolled, cursor hpos can legitimately be out
26322 of bounds, but we draw the cursor at the corresponding window
26323 margin in that case. */
26324 if (!row
->reversed_p
&& hpos
< 0)
26326 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26327 hpos
= row
->used
[TEXT_AREA
] - 1;
26329 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26334 /* Find the glyph rows START_ROW and END_ROW of window W that display
26335 characters between buffer positions START_CHARPOS and END_CHARPOS
26336 (excluding END_CHARPOS). DISP_STRING is a display string that
26337 covers these buffer positions. This is similar to
26338 row_containing_pos, but is more accurate when bidi reordering makes
26339 buffer positions change non-linearly with glyph rows. */
26341 rows_from_pos_range (struct window
*w
,
26342 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26343 Lisp_Object disp_string
,
26344 struct glyph_row
**start
, struct glyph_row
**end
)
26346 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26347 int last_y
= window_text_bottom_y (w
);
26348 struct glyph_row
*row
;
26353 while (!first
->enabled_p
26354 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26357 /* Find the START row. */
26359 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26362 /* A row can potentially be the START row if the range of the
26363 characters it displays intersects the range
26364 [START_CHARPOS..END_CHARPOS). */
26365 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26366 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26367 /* See the commentary in row_containing_pos, for the
26368 explanation of the complicated way to check whether
26369 some position is beyond the end of the characters
26370 displayed by a row. */
26371 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26372 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26373 && !row
->ends_at_zv_p
26374 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26375 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26376 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26377 && !row
->ends_at_zv_p
26378 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26380 /* Found a candidate row. Now make sure at least one of the
26381 glyphs it displays has a charpos from the range
26382 [START_CHARPOS..END_CHARPOS).
26384 This is not obvious because bidi reordering could make
26385 buffer positions of a row be 1,2,3,102,101,100, and if we
26386 want to highlight characters in [50..60), we don't want
26387 this row, even though [50..60) does intersect [1..103),
26388 the range of character positions given by the row's start
26389 and end positions. */
26390 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26391 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26395 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26396 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26397 /* A glyph that comes from DISP_STRING is by
26398 definition to be highlighted. */
26399 || EQ (g
->object
, disp_string
))
26408 /* Find the END row. */
26410 /* If the last row is partially visible, start looking for END
26411 from that row, instead of starting from FIRST. */
26412 && !(row
->enabled_p
26413 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26415 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26417 struct glyph_row
*next
= row
+ 1;
26418 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26420 if (!next
->enabled_p
26421 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26422 /* The first row >= START whose range of displayed characters
26423 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26424 is the row END + 1. */
26425 || (start_charpos
< next_start
26426 && end_charpos
< next_start
)
26427 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26428 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26429 && !next
->ends_at_zv_p
26430 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26431 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26432 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26433 && !next
->ends_at_zv_p
26434 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26441 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26442 but none of the characters it displays are in the range, it is
26444 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26445 struct glyph
*s
= g
;
26446 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26450 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26451 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26452 /* If the buffer position of the first glyph in
26453 the row is equal to END_CHARPOS, it means
26454 the last character to be highlighted is the
26455 newline of ROW, and we must consider NEXT as
26457 || (((!next
->reversed_p
&& g
== s
)
26458 || (next
->reversed_p
&& g
== e
- 1))
26459 && (g
->charpos
== end_charpos
26460 /* Special case for when NEXT is an
26461 empty line at ZV. */
26462 || (g
->charpos
== -1
26463 && !row
->ends_at_zv_p
26464 && next_start
== end_charpos
)))))
26465 /* A glyph that comes from DISP_STRING is by
26466 definition to be highlighted. */
26467 || EQ (g
->object
, disp_string
))
26476 /* The first row that ends at ZV must be the last to be
26478 else if (next
->ends_at_zv_p
)
26487 /* This function sets the mouse_face_* elements of HLINFO, assuming
26488 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26489 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26490 for the overlay or run of text properties specifying the mouse
26491 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26492 before-string and after-string that must also be highlighted.
26493 DISP_STRING, if non-nil, is a display string that may cover some
26494 or all of the highlighted text. */
26497 mouse_face_from_buffer_pos (Lisp_Object window
,
26498 Mouse_HLInfo
*hlinfo
,
26499 ptrdiff_t mouse_charpos
,
26500 ptrdiff_t start_charpos
,
26501 ptrdiff_t end_charpos
,
26502 Lisp_Object before_string
,
26503 Lisp_Object after_string
,
26504 Lisp_Object disp_string
)
26506 struct window
*w
= XWINDOW (window
);
26507 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26508 struct glyph_row
*r1
, *r2
;
26509 struct glyph
*glyph
, *end
;
26510 ptrdiff_t ignore
, pos
;
26513 eassert (NILP (disp_string
) || STRINGP (disp_string
));
26514 eassert (NILP (before_string
) || STRINGP (before_string
));
26515 eassert (NILP (after_string
) || STRINGP (after_string
));
26517 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26518 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26520 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26521 /* If the before-string or display-string contains newlines,
26522 rows_from_pos_range skips to its last row. Move back. */
26523 if (!NILP (before_string
) || !NILP (disp_string
))
26525 struct glyph_row
*prev
;
26526 while ((prev
= r1
- 1, prev
>= first
)
26527 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26528 && prev
->used
[TEXT_AREA
] > 0)
26530 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26531 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26532 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26534 || !(EQ (glyph
->object
, before_string
)
26535 || EQ (glyph
->object
, disp_string
)))
26542 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26543 hlinfo
->mouse_face_past_end
= 1;
26545 else if (!NILP (after_string
))
26547 /* If the after-string has newlines, advance to its last row. */
26548 struct glyph_row
*next
;
26549 struct glyph_row
*last
26550 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26552 for (next
= r2
+ 1;
26554 && next
->used
[TEXT_AREA
] > 0
26555 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26559 /* The rest of the display engine assumes that mouse_face_beg_row is
26560 either above mouse_face_end_row or identical to it. But with
26561 bidi-reordered continued lines, the row for START_CHARPOS could
26562 be below the row for END_CHARPOS. If so, swap the rows and store
26563 them in correct order. */
26566 struct glyph_row
*tem
= r2
;
26572 hlinfo
->mouse_face_beg_y
= r1
->y
;
26573 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26574 hlinfo
->mouse_face_end_y
= r2
->y
;
26575 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26577 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26578 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26579 could be anywhere in the row and in any order. The strategy
26580 below is to find the leftmost and the rightmost glyph that
26581 belongs to either of these 3 strings, or whose position is
26582 between START_CHARPOS and END_CHARPOS, and highlight all the
26583 glyphs between those two. This may cover more than just the text
26584 between START_CHARPOS and END_CHARPOS if the range of characters
26585 strides the bidi level boundary, e.g. if the beginning is in R2L
26586 text while the end is in L2R text or vice versa. */
26587 if (!r1
->reversed_p
)
26589 /* This row is in a left to right paragraph. Scan it left to
26591 glyph
= r1
->glyphs
[TEXT_AREA
];
26592 end
= glyph
+ r1
->used
[TEXT_AREA
];
26595 /* Skip truncation glyphs at the start of the glyph row. */
26596 if (r1
->displays_text_p
)
26598 && INTEGERP (glyph
->object
)
26599 && glyph
->charpos
< 0;
26601 x
+= glyph
->pixel_width
;
26603 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26604 or DISP_STRING, and the first glyph from buffer whose
26605 position is between START_CHARPOS and END_CHARPOS. */
26607 && !INTEGERP (glyph
->object
)
26608 && !EQ (glyph
->object
, disp_string
)
26609 && !(BUFFERP (glyph
->object
)
26610 && (glyph
->charpos
>= start_charpos
26611 && glyph
->charpos
< end_charpos
));
26614 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26615 are present at buffer positions between START_CHARPOS and
26616 END_CHARPOS, or if they come from an overlay. */
26617 if (EQ (glyph
->object
, before_string
))
26619 pos
= string_buffer_position (before_string
,
26621 /* If pos == 0, it means before_string came from an
26622 overlay, not from a buffer position. */
26623 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26626 else if (EQ (glyph
->object
, after_string
))
26628 pos
= string_buffer_position (after_string
, end_charpos
);
26629 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26632 x
+= glyph
->pixel_width
;
26634 hlinfo
->mouse_face_beg_x
= x
;
26635 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26639 /* This row is in a right to left paragraph. Scan it right to
26643 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26644 glyph
= end
+ r1
->used
[TEXT_AREA
];
26646 /* Skip truncation glyphs at the start of the glyph row. */
26647 if (r1
->displays_text_p
)
26649 && INTEGERP (glyph
->object
)
26650 && glyph
->charpos
< 0;
26654 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26655 or DISP_STRING, and the first glyph from buffer whose
26656 position is between START_CHARPOS and END_CHARPOS. */
26658 && !INTEGERP (glyph
->object
)
26659 && !EQ (glyph
->object
, disp_string
)
26660 && !(BUFFERP (glyph
->object
)
26661 && (glyph
->charpos
>= start_charpos
26662 && glyph
->charpos
< end_charpos
));
26665 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26666 are present at buffer positions between START_CHARPOS and
26667 END_CHARPOS, or if they come from an overlay. */
26668 if (EQ (glyph
->object
, before_string
))
26670 pos
= string_buffer_position (before_string
, start_charpos
);
26671 /* If pos == 0, it means before_string came from an
26672 overlay, not from a buffer position. */
26673 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26676 else if (EQ (glyph
->object
, after_string
))
26678 pos
= string_buffer_position (after_string
, end_charpos
);
26679 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26684 glyph
++; /* first glyph to the right of the highlighted area */
26685 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26686 x
+= g
->pixel_width
;
26687 hlinfo
->mouse_face_beg_x
= x
;
26688 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26691 /* If the highlight ends in a different row, compute GLYPH and END
26692 for the end row. Otherwise, reuse the values computed above for
26693 the row where the highlight begins. */
26696 if (!r2
->reversed_p
)
26698 glyph
= r2
->glyphs
[TEXT_AREA
];
26699 end
= glyph
+ r2
->used
[TEXT_AREA
];
26704 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26705 glyph
= end
+ r2
->used
[TEXT_AREA
];
26709 if (!r2
->reversed_p
)
26711 /* Skip truncation and continuation glyphs near the end of the
26712 row, and also blanks and stretch glyphs inserted by
26713 extend_face_to_end_of_line. */
26715 && INTEGERP ((end
- 1)->object
))
26717 /* Scan the rest of the glyph row from the end, looking for the
26718 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26719 DISP_STRING, or whose position is between START_CHARPOS
26723 && !INTEGERP (end
->object
)
26724 && !EQ (end
->object
, disp_string
)
26725 && !(BUFFERP (end
->object
)
26726 && (end
->charpos
>= start_charpos
26727 && end
->charpos
< end_charpos
));
26730 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26731 are present at buffer positions between START_CHARPOS and
26732 END_CHARPOS, or if they come from an overlay. */
26733 if (EQ (end
->object
, before_string
))
26735 pos
= string_buffer_position (before_string
, start_charpos
);
26736 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26739 else if (EQ (end
->object
, after_string
))
26741 pos
= string_buffer_position (after_string
, end_charpos
);
26742 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26746 /* Find the X coordinate of the last glyph to be highlighted. */
26747 for (; glyph
<= end
; ++glyph
)
26748 x
+= glyph
->pixel_width
;
26750 hlinfo
->mouse_face_end_x
= x
;
26751 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26755 /* Skip truncation and continuation glyphs near the end of the
26756 row, and also blanks and stretch glyphs inserted by
26757 extend_face_to_end_of_line. */
26761 && INTEGERP (end
->object
))
26763 x
+= end
->pixel_width
;
26766 /* Scan the rest of the glyph row from the end, looking for the
26767 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26768 DISP_STRING, or whose position is between START_CHARPOS
26772 && !INTEGERP (end
->object
)
26773 && !EQ (end
->object
, disp_string
)
26774 && !(BUFFERP (end
->object
)
26775 && (end
->charpos
>= start_charpos
26776 && end
->charpos
< end_charpos
));
26779 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26780 are present at buffer positions between START_CHARPOS and
26781 END_CHARPOS, or if they come from an overlay. */
26782 if (EQ (end
->object
, before_string
))
26784 pos
= string_buffer_position (before_string
, start_charpos
);
26785 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26788 else if (EQ (end
->object
, after_string
))
26790 pos
= string_buffer_position (after_string
, end_charpos
);
26791 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26794 x
+= end
->pixel_width
;
26796 /* If we exited the above loop because we arrived at the last
26797 glyph of the row, and its buffer position is still not in
26798 range, it means the last character in range is the preceding
26799 newline. Bump the end column and x values to get past the
26802 && BUFFERP (end
->object
)
26803 && (end
->charpos
< start_charpos
26804 || end
->charpos
>= end_charpos
))
26806 x
+= end
->pixel_width
;
26809 hlinfo
->mouse_face_end_x
= x
;
26810 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26813 hlinfo
->mouse_face_window
= window
;
26814 hlinfo
->mouse_face_face_id
26815 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26817 !hlinfo
->mouse_face_hidden
, -1);
26818 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26821 /* The following function is not used anymore (replaced with
26822 mouse_face_from_string_pos), but I leave it here for the time
26823 being, in case someone would. */
26825 #if 0 /* not used */
26827 /* Find the position of the glyph for position POS in OBJECT in
26828 window W's current matrix, and return in *X, *Y the pixel
26829 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26831 RIGHT_P non-zero means return the position of the right edge of the
26832 glyph, RIGHT_P zero means return the left edge position.
26834 If no glyph for POS exists in the matrix, return the position of
26835 the glyph with the next smaller position that is in the matrix, if
26836 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26837 exists in the matrix, return the position of the glyph with the
26838 next larger position in OBJECT.
26840 Value is non-zero if a glyph was found. */
26843 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
26844 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26846 int yb
= window_text_bottom_y (w
);
26847 struct glyph_row
*r
;
26848 struct glyph
*best_glyph
= NULL
;
26849 struct glyph_row
*best_row
= NULL
;
26852 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26853 r
->enabled_p
&& r
->y
< yb
;
26856 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26857 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26860 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26861 if (EQ (g
->object
, object
))
26863 if (g
->charpos
== pos
)
26870 else if (best_glyph
== NULL
26871 || ((eabs (g
->charpos
- pos
)
26872 < eabs (best_glyph
->charpos
- pos
))
26875 : g
->charpos
> pos
)))
26889 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26893 *x
+= best_glyph
->pixel_width
;
26898 *vpos
= best_row
- w
->current_matrix
->rows
;
26901 return best_glyph
!= NULL
;
26903 #endif /* not used */
26905 /* Find the positions of the first and the last glyphs in window W's
26906 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26907 (assumed to be a string), and return in HLINFO's mouse_face_*
26908 members the pixel and column/row coordinates of those glyphs. */
26911 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26912 Lisp_Object object
,
26913 ptrdiff_t startpos
, ptrdiff_t endpos
)
26915 int yb
= window_text_bottom_y (w
);
26916 struct glyph_row
*r
;
26917 struct glyph
*g
, *e
;
26921 /* Find the glyph row with at least one position in the range
26922 [STARTPOS..ENDPOS], and the first glyph in that row whose
26923 position belongs to that range. */
26924 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26925 r
->enabled_p
&& r
->y
< yb
;
26928 if (!r
->reversed_p
)
26930 g
= r
->glyphs
[TEXT_AREA
];
26931 e
= g
+ r
->used
[TEXT_AREA
];
26932 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26933 if (EQ (g
->object
, object
)
26934 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26936 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26937 hlinfo
->mouse_face_beg_y
= r
->y
;
26938 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26939 hlinfo
->mouse_face_beg_x
= gx
;
26948 e
= r
->glyphs
[TEXT_AREA
];
26949 g
= e
+ r
->used
[TEXT_AREA
];
26950 for ( ; g
> e
; --g
)
26951 if (EQ ((g
-1)->object
, object
)
26952 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26954 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26955 hlinfo
->mouse_face_beg_y
= r
->y
;
26956 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26957 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26958 gx
+= g1
->pixel_width
;
26959 hlinfo
->mouse_face_beg_x
= gx
;
26971 /* Starting with the next row, look for the first row which does NOT
26972 include any glyphs whose positions are in the range. */
26973 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26975 g
= r
->glyphs
[TEXT_AREA
];
26976 e
= g
+ r
->used
[TEXT_AREA
];
26978 for ( ; g
< e
; ++g
)
26979 if (EQ (g
->object
, object
)
26980 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26989 /* The highlighted region ends on the previous row. */
26992 /* Set the end row and its vertical pixel coordinate. */
26993 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26994 hlinfo
->mouse_face_end_y
= r
->y
;
26996 /* Compute and set the end column and the end column's horizontal
26997 pixel coordinate. */
26998 if (!r
->reversed_p
)
27000 g
= r
->glyphs
[TEXT_AREA
];
27001 e
= g
+ r
->used
[TEXT_AREA
];
27002 for ( ; e
> g
; --e
)
27003 if (EQ ((e
-1)->object
, object
)
27004 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
27006 hlinfo
->mouse_face_end_col
= e
- g
;
27008 for (gx
= r
->x
; g
< e
; ++g
)
27009 gx
+= g
->pixel_width
;
27010 hlinfo
->mouse_face_end_x
= gx
;
27014 e
= r
->glyphs
[TEXT_AREA
];
27015 g
= e
+ r
->used
[TEXT_AREA
];
27016 for (gx
= r
->x
; e
< g
; ++e
)
27018 if (EQ (e
->object
, object
)
27019 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
27021 gx
+= e
->pixel_width
;
27023 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
27024 hlinfo
->mouse_face_end_x
= gx
;
27028 #ifdef HAVE_WINDOW_SYSTEM
27030 /* See if position X, Y is within a hot-spot of an image. */
27033 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
27035 if (!CONSP (hot_spot
))
27038 if (EQ (XCAR (hot_spot
), Qrect
))
27040 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27041 Lisp_Object rect
= XCDR (hot_spot
);
27045 if (!CONSP (XCAR (rect
)))
27047 if (!CONSP (XCDR (rect
)))
27049 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
27051 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
27053 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
27055 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
27059 else if (EQ (XCAR (hot_spot
), Qcircle
))
27061 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27062 Lisp_Object circ
= XCDR (hot_spot
);
27063 Lisp_Object lr
, lx0
, ly0
;
27065 && CONSP (XCAR (circ
))
27066 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
27067 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
27068 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
27070 double r
= XFLOATINT (lr
);
27071 double dx
= XINT (lx0
) - x
;
27072 double dy
= XINT (ly0
) - y
;
27073 return (dx
* dx
+ dy
* dy
<= r
* r
);
27076 else if (EQ (XCAR (hot_spot
), Qpoly
))
27078 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27079 if (VECTORP (XCDR (hot_spot
)))
27081 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
27082 Lisp_Object
*poly
= v
->contents
;
27083 ptrdiff_t n
= v
->header
.size
;
27086 Lisp_Object lx
, ly
;
27089 /* Need an even number of coordinates, and at least 3 edges. */
27090 if (n
< 6 || n
& 1)
27093 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27094 If count is odd, we are inside polygon. Pixels on edges
27095 may or may not be included depending on actual geometry of the
27097 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
27098 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
27100 x0
= XINT (lx
), y0
= XINT (ly
);
27101 for (i
= 0; i
< n
; i
+= 2)
27103 int x1
= x0
, y1
= y0
;
27104 if ((lx
= poly
[i
], !INTEGERP (lx
))
27105 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
27107 x0
= XINT (lx
), y0
= XINT (ly
);
27109 /* Does this segment cross the X line? */
27117 if (y
> y0
&& y
> y1
)
27119 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
27129 find_hot_spot (Lisp_Object map
, int x
, int y
)
27131 while (CONSP (map
))
27133 if (CONSP (XCAR (map
))
27134 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
27142 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
27144 doc
: /* Lookup in image map MAP coordinates X and Y.
27145 An image map is an alist where each element has the format (AREA ID PLIST).
27146 An AREA is specified as either a rectangle, a circle, or a polygon:
27147 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27148 pixel coordinates of the upper left and bottom right corners.
27149 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27150 and the radius of the circle; r may be a float or integer.
27151 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27152 vector describes one corner in the polygon.
27153 Returns the alist element for the first matching AREA in MAP. */)
27154 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
27162 return find_hot_spot (map
,
27163 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
27164 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
27168 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27170 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
27172 /* Do not change cursor shape while dragging mouse. */
27173 if (!NILP (do_mouse_tracking
))
27176 if (!NILP (pointer
))
27178 if (EQ (pointer
, Qarrow
))
27179 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27180 else if (EQ (pointer
, Qhand
))
27181 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27182 else if (EQ (pointer
, Qtext
))
27183 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27184 else if (EQ (pointer
, intern ("hdrag")))
27185 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27186 #ifdef HAVE_X_WINDOWS
27187 else if (EQ (pointer
, intern ("vdrag")))
27188 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27190 else if (EQ (pointer
, intern ("hourglass")))
27191 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27192 else if (EQ (pointer
, Qmodeline
))
27193 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27195 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27198 if (cursor
!= No_Cursor
)
27199 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27202 #endif /* HAVE_WINDOW_SYSTEM */
27204 /* Take proper action when mouse has moved to the mode or header line
27205 or marginal area AREA of window W, x-position X and y-position Y.
27206 X is relative to the start of the text display area of W, so the
27207 width of bitmap areas and scroll bars must be subtracted to get a
27208 position relative to the start of the mode line. */
27211 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27212 enum window_part area
)
27214 struct window
*w
= XWINDOW (window
);
27215 struct frame
*f
= XFRAME (w
->frame
);
27216 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27217 #ifdef HAVE_WINDOW_SYSTEM
27218 Display_Info
*dpyinfo
;
27220 Cursor cursor
= No_Cursor
;
27221 Lisp_Object pointer
= Qnil
;
27222 int dx
, dy
, width
, height
;
27224 Lisp_Object string
, object
= Qnil
;
27225 Lisp_Object pos
IF_LINT (= Qnil
), help
;
27227 Lisp_Object mouse_face
;
27228 int original_x_pixel
= x
;
27229 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27230 struct glyph_row
*row
IF_LINT (= 0);
27232 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27237 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27238 returns them in row/column units! */
27239 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27240 &object
, &dx
, &dy
, &width
, &height
);
27242 row
= (area
== ON_MODE_LINE
27243 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27244 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27246 /* Find the glyph under the mouse pointer. */
27247 if (row
->mode_line_p
&& row
->enabled_p
)
27249 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27250 end
= glyph
+ row
->used
[TEXT_AREA
];
27252 for (x0
= original_x_pixel
;
27253 glyph
< end
&& x0
>= glyph
->pixel_width
;
27255 x0
-= glyph
->pixel_width
;
27263 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27264 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27265 returns them in row/column units! */
27266 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27267 &object
, &dx
, &dy
, &width
, &height
);
27272 #ifdef HAVE_WINDOW_SYSTEM
27273 if (IMAGEP (object
))
27275 Lisp_Object image_map
, hotspot
;
27276 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27278 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27280 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27284 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27285 If so, we could look for mouse-enter, mouse-leave
27286 properties in PLIST (and do something...). */
27287 hotspot
= XCDR (hotspot
);
27288 if (CONSP (hotspot
)
27289 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27291 pointer
= Fplist_get (plist
, Qpointer
);
27292 if (NILP (pointer
))
27294 help
= Fplist_get (plist
, Qhelp_echo
);
27297 help_echo_string
= help
;
27298 XSETWINDOW (help_echo_window
, w
);
27299 help_echo_object
= w
->buffer
;
27300 help_echo_pos
= charpos
;
27304 if (NILP (pointer
))
27305 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27307 #endif /* HAVE_WINDOW_SYSTEM */
27309 if (STRINGP (string
))
27310 pos
= make_number (charpos
);
27312 /* Set the help text and mouse pointer. If the mouse is on a part
27313 of the mode line without any text (e.g. past the right edge of
27314 the mode line text), use the default help text and pointer. */
27315 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27317 /* Arrange to display the help by setting the global variables
27318 help_echo_string, help_echo_object, and help_echo_pos. */
27321 if (STRINGP (string
))
27322 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27326 help_echo_string
= help
;
27327 XSETWINDOW (help_echo_window
, w
);
27328 help_echo_object
= string
;
27329 help_echo_pos
= charpos
;
27331 else if (area
== ON_MODE_LINE
)
27333 Lisp_Object default_help
27334 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27337 if (STRINGP (default_help
))
27339 help_echo_string
= default_help
;
27340 XSETWINDOW (help_echo_window
, w
);
27341 help_echo_object
= Qnil
;
27342 help_echo_pos
= -1;
27347 #ifdef HAVE_WINDOW_SYSTEM
27348 /* Change the mouse pointer according to what is under it. */
27349 if (FRAME_WINDOW_P (f
))
27351 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27352 if (STRINGP (string
))
27354 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27356 if (NILP (pointer
))
27357 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27359 /* Change the mouse pointer according to what is under X/Y. */
27361 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27364 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27365 if (!KEYMAPP (map
))
27366 map
= Fget_text_property (pos
, Qkeymap
, string
);
27367 if (!KEYMAPP (map
))
27368 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27372 /* Default mode-line pointer. */
27373 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27378 /* Change the mouse face according to what is under X/Y. */
27379 if (STRINGP (string
))
27381 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27382 if (!NILP (mouse_face
)
27383 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27388 struct glyph
* tmp_glyph
;
27392 int total_pixel_width
;
27393 ptrdiff_t begpos
, endpos
, ignore
;
27397 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27398 Qmouse_face
, string
, Qnil
);
27404 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27406 endpos
= SCHARS (string
);
27410 /* Calculate the glyph position GPOS of GLYPH in the
27411 displayed string, relative to the beginning of the
27412 highlighted part of the string.
27414 Note: GPOS is different from CHARPOS. CHARPOS is the
27415 position of GLYPH in the internal string object. A mode
27416 line string format has structures which are converted to
27417 a flattened string by the Emacs Lisp interpreter. The
27418 internal string is an element of those structures. The
27419 displayed string is the flattened string. */
27420 tmp_glyph
= row_start_glyph
;
27421 while (tmp_glyph
< glyph
27422 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27423 && begpos
<= tmp_glyph
->charpos
27424 && tmp_glyph
->charpos
< endpos
)))
27426 gpos
= glyph
- tmp_glyph
;
27428 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27429 the highlighted part of the displayed string to which
27430 GLYPH belongs. Note: GSEQ_LENGTH is different from
27431 SCHARS (STRING), because the latter returns the length of
27432 the internal string. */
27433 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27435 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27436 && begpos
<= tmp_glyph
->charpos
27437 && tmp_glyph
->charpos
< endpos
));
27440 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27442 /* Calculate the total pixel width of all the glyphs between
27443 the beginning of the highlighted area and GLYPH. */
27444 total_pixel_width
= 0;
27445 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27446 total_pixel_width
+= tmp_glyph
->pixel_width
;
27448 /* Pre calculation of re-rendering position. Note: X is in
27449 column units here, after the call to mode_line_string or
27450 marginal_area_string. */
27452 vpos
= (area
== ON_MODE_LINE
27453 ? (w
->current_matrix
)->nrows
- 1
27456 /* If GLYPH's position is included in the region that is
27457 already drawn in mouse face, we have nothing to do. */
27458 if ( EQ (window
, hlinfo
->mouse_face_window
)
27459 && (!row
->reversed_p
27460 ? (hlinfo
->mouse_face_beg_col
<= hpos
27461 && hpos
< hlinfo
->mouse_face_end_col
)
27462 /* In R2L rows we swap BEG and END, see below. */
27463 : (hlinfo
->mouse_face_end_col
<= hpos
27464 && hpos
< hlinfo
->mouse_face_beg_col
))
27465 && hlinfo
->mouse_face_beg_row
== vpos
)
27468 if (clear_mouse_face (hlinfo
))
27469 cursor
= No_Cursor
;
27471 if (!row
->reversed_p
)
27473 hlinfo
->mouse_face_beg_col
= hpos
;
27474 hlinfo
->mouse_face_beg_x
= original_x_pixel
27475 - (total_pixel_width
+ dx
);
27476 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27477 hlinfo
->mouse_face_end_x
= 0;
27481 /* In R2L rows, show_mouse_face expects BEG and END
27482 coordinates to be swapped. */
27483 hlinfo
->mouse_face_end_col
= hpos
;
27484 hlinfo
->mouse_face_end_x
= original_x_pixel
27485 - (total_pixel_width
+ dx
);
27486 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27487 hlinfo
->mouse_face_beg_x
= 0;
27490 hlinfo
->mouse_face_beg_row
= vpos
;
27491 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27492 hlinfo
->mouse_face_beg_y
= 0;
27493 hlinfo
->mouse_face_end_y
= 0;
27494 hlinfo
->mouse_face_past_end
= 0;
27495 hlinfo
->mouse_face_window
= window
;
27497 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27503 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27505 if (NILP (pointer
))
27508 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27509 clear_mouse_face (hlinfo
);
27511 #ifdef HAVE_WINDOW_SYSTEM
27512 if (FRAME_WINDOW_P (f
))
27513 define_frame_cursor1 (f
, cursor
, pointer
);
27519 Take proper action when the mouse has moved to position X, Y on
27520 frame F as regards highlighting characters that have mouse-face
27521 properties. Also de-highlighting chars where the mouse was before.
27522 X and Y can be negative or out of range. */
27525 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27527 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27528 enum window_part part
= ON_NOTHING
;
27529 Lisp_Object window
;
27531 Cursor cursor
= No_Cursor
;
27532 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27535 /* When a menu is active, don't highlight because this looks odd. */
27536 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27537 if (popup_activated ())
27541 if (NILP (Vmouse_highlight
)
27542 || !f
->glyphs_initialized_p
27543 || f
->pointer_invisible
)
27546 hlinfo
->mouse_face_mouse_x
= x
;
27547 hlinfo
->mouse_face_mouse_y
= y
;
27548 hlinfo
->mouse_face_mouse_frame
= f
;
27550 if (hlinfo
->mouse_face_defer
)
27553 /* Which window is that in? */
27554 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27556 /* If displaying active text in another window, clear that. */
27557 if (! EQ (window
, hlinfo
->mouse_face_window
)
27558 /* Also clear if we move out of text area in same window. */
27559 || (!NILP (hlinfo
->mouse_face_window
)
27562 && part
!= ON_MODE_LINE
27563 && part
!= ON_HEADER_LINE
))
27564 clear_mouse_face (hlinfo
);
27566 /* Not on a window -> return. */
27567 if (!WINDOWP (window
))
27570 /* Reset help_echo_string. It will get recomputed below. */
27571 help_echo_string
= Qnil
;
27573 /* Convert to window-relative pixel coordinates. */
27574 w
= XWINDOW (window
);
27575 frame_to_window_pixel_xy (w
, &x
, &y
);
27577 #ifdef HAVE_WINDOW_SYSTEM
27578 /* Handle tool-bar window differently since it doesn't display a
27580 if (EQ (window
, f
->tool_bar_window
))
27582 note_tool_bar_highlight (f
, x
, y
);
27587 /* Mouse is on the mode, header line or margin? */
27588 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27589 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27591 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27595 #ifdef HAVE_WINDOW_SYSTEM
27596 if (part
== ON_VERTICAL_BORDER
)
27598 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27599 help_echo_string
= build_string ("drag-mouse-1: resize");
27601 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27602 || part
== ON_SCROLL_BAR
)
27603 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27605 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27608 /* Are we in a window whose display is up to date?
27609 And verify the buffer's text has not changed. */
27610 b
= XBUFFER (w
->buffer
);
27611 if (part
== ON_TEXT
27612 && w
->window_end_valid
27613 && w
->last_modified
== BUF_MODIFF (b
)
27614 && w
->last_overlay_modified
== BUF_OVERLAY_MODIFF (b
))
27616 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27618 struct glyph
*glyph
;
27619 Lisp_Object object
;
27620 Lisp_Object mouse_face
= Qnil
, position
;
27621 Lisp_Object
*overlay_vec
= NULL
;
27622 ptrdiff_t i
, noverlays
;
27623 struct buffer
*obuf
;
27624 ptrdiff_t obegv
, ozv
;
27627 /* Find the glyph under X/Y. */
27628 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27630 #ifdef HAVE_WINDOW_SYSTEM
27631 /* Look for :pointer property on image. */
27632 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27634 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27635 if (img
!= NULL
&& IMAGEP (img
->spec
))
27637 Lisp_Object image_map
, hotspot
;
27638 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27640 && (hotspot
= find_hot_spot (image_map
,
27641 glyph
->slice
.img
.x
+ dx
,
27642 glyph
->slice
.img
.y
+ dy
),
27644 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27648 /* Could check XCAR (hotspot) to see if we enter/leave
27650 If so, we could look for mouse-enter, mouse-leave
27651 properties in PLIST (and do something...). */
27652 hotspot
= XCDR (hotspot
);
27653 if (CONSP (hotspot
)
27654 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27656 pointer
= Fplist_get (plist
, Qpointer
);
27657 if (NILP (pointer
))
27659 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27660 if (!NILP (help_echo_string
))
27662 help_echo_window
= window
;
27663 help_echo_object
= glyph
->object
;
27664 help_echo_pos
= glyph
->charpos
;
27668 if (NILP (pointer
))
27669 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27672 #endif /* HAVE_WINDOW_SYSTEM */
27674 /* Clear mouse face if X/Y not over text. */
27676 || area
!= TEXT_AREA
27677 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27678 /* Glyph's OBJECT is an integer for glyphs inserted by the
27679 display engine for its internal purposes, like truncation
27680 and continuation glyphs and blanks beyond the end of
27681 line's text on text terminals. If we are over such a
27682 glyph, we are not over any text. */
27683 || INTEGERP (glyph
->object
)
27684 /* R2L rows have a stretch glyph at their front, which
27685 stands for no text, whereas L2R rows have no glyphs at
27686 all beyond the end of text. Treat such stretch glyphs
27687 like we do with NULL glyphs in L2R rows. */
27688 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27689 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27690 && glyph
->type
== STRETCH_GLYPH
27691 && glyph
->avoid_cursor_p
))
27693 if (clear_mouse_face (hlinfo
))
27694 cursor
= No_Cursor
;
27695 #ifdef HAVE_WINDOW_SYSTEM
27696 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27698 if (area
!= TEXT_AREA
)
27699 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27701 pointer
= Vvoid_text_area_pointer
;
27707 pos
= glyph
->charpos
;
27708 object
= glyph
->object
;
27709 if (!STRINGP (object
) && !BUFFERP (object
))
27712 /* If we get an out-of-range value, return now; avoid an error. */
27713 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27716 /* Make the window's buffer temporarily current for
27717 overlays_at and compute_char_face. */
27718 obuf
= current_buffer
;
27719 current_buffer
= b
;
27725 /* Is this char mouse-active or does it have help-echo? */
27726 position
= make_number (pos
);
27728 if (BUFFERP (object
))
27730 /* Put all the overlays we want in a vector in overlay_vec. */
27731 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27732 /* Sort overlays into increasing priority order. */
27733 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27738 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27741 cursor
= No_Cursor
;
27743 /* Check mouse-face highlighting. */
27745 /* If there exists an overlay with mouse-face overlapping
27746 the one we are currently highlighting, we have to
27747 check if we enter the overlapping overlay, and then
27748 highlight only that. */
27749 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27750 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27752 /* Find the highest priority overlay with a mouse-face. */
27753 Lisp_Object overlay
= Qnil
;
27754 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27756 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27757 if (!NILP (mouse_face
))
27758 overlay
= overlay_vec
[i
];
27761 /* If we're highlighting the same overlay as before, there's
27762 no need to do that again. */
27763 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27764 goto check_help_echo
;
27765 hlinfo
->mouse_face_overlay
= overlay
;
27767 /* Clear the display of the old active region, if any. */
27768 if (clear_mouse_face (hlinfo
))
27769 cursor
= No_Cursor
;
27771 /* If no overlay applies, get a text property. */
27772 if (NILP (overlay
))
27773 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27775 /* Next, compute the bounds of the mouse highlighting and
27777 if (!NILP (mouse_face
) && STRINGP (object
))
27779 /* The mouse-highlighting comes from a display string
27780 with a mouse-face. */
27784 s
= Fprevious_single_property_change
27785 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27786 e
= Fnext_single_property_change
27787 (position
, Qmouse_face
, object
, Qnil
);
27789 s
= make_number (0);
27791 e
= make_number (SCHARS (object
) - 1);
27792 mouse_face_from_string_pos (w
, hlinfo
, object
,
27793 XINT (s
), XINT (e
));
27794 hlinfo
->mouse_face_past_end
= 0;
27795 hlinfo
->mouse_face_window
= window
;
27796 hlinfo
->mouse_face_face_id
27797 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27798 glyph
->face_id
, 1);
27799 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27800 cursor
= No_Cursor
;
27804 /* The mouse-highlighting, if any, comes from an overlay
27805 or text property in the buffer. */
27806 Lisp_Object buffer
IF_LINT (= Qnil
);
27807 Lisp_Object disp_string
IF_LINT (= Qnil
);
27809 if (STRINGP (object
))
27811 /* If we are on a display string with no mouse-face,
27812 check if the text under it has one. */
27813 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27814 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27815 pos
= string_buffer_position (object
, start
);
27818 mouse_face
= get_char_property_and_overlay
27819 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27820 buffer
= w
->buffer
;
27821 disp_string
= object
;
27827 disp_string
= Qnil
;
27830 if (!NILP (mouse_face
))
27832 Lisp_Object before
, after
;
27833 Lisp_Object before_string
, after_string
;
27834 /* To correctly find the limits of mouse highlight
27835 in a bidi-reordered buffer, we must not use the
27836 optimization of limiting the search in
27837 previous-single-property-change and
27838 next-single-property-change, because
27839 rows_from_pos_range needs the real start and end
27840 positions to DTRT in this case. That's because
27841 the first row visible in a window does not
27842 necessarily display the character whose position
27843 is the smallest. */
27845 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27846 ? Fmarker_position (w
->start
)
27849 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27850 ? make_number (BUF_Z (XBUFFER (buffer
))
27851 - XFASTINT (w
->window_end_pos
))
27854 if (NILP (overlay
))
27856 /* Handle the text property case. */
27857 before
= Fprevious_single_property_change
27858 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27859 after
= Fnext_single_property_change
27860 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27861 before_string
= after_string
= Qnil
;
27865 /* Handle the overlay case. */
27866 before
= Foverlay_start (overlay
);
27867 after
= Foverlay_end (overlay
);
27868 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27869 after_string
= Foverlay_get (overlay
, Qafter_string
);
27871 if (!STRINGP (before_string
)) before_string
= Qnil
;
27872 if (!STRINGP (after_string
)) after_string
= Qnil
;
27875 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27878 : XFASTINT (before
),
27880 ? BUF_Z (XBUFFER (buffer
))
27881 : XFASTINT (after
),
27882 before_string
, after_string
,
27884 cursor
= No_Cursor
;
27891 /* Look for a `help-echo' property. */
27892 if (NILP (help_echo_string
)) {
27893 Lisp_Object help
, overlay
;
27895 /* Check overlays first. */
27896 help
= overlay
= Qnil
;
27897 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27899 overlay
= overlay_vec
[i
];
27900 help
= Foverlay_get (overlay
, Qhelp_echo
);
27905 help_echo_string
= help
;
27906 help_echo_window
= window
;
27907 help_echo_object
= overlay
;
27908 help_echo_pos
= pos
;
27912 Lisp_Object obj
= glyph
->object
;
27913 ptrdiff_t charpos
= glyph
->charpos
;
27915 /* Try text properties. */
27918 && charpos
< SCHARS (obj
))
27920 help
= Fget_text_property (make_number (charpos
),
27924 /* If the string itself doesn't specify a help-echo,
27925 see if the buffer text ``under'' it does. */
27926 struct glyph_row
*r
27927 = MATRIX_ROW (w
->current_matrix
, vpos
);
27928 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27929 ptrdiff_t p
= string_buffer_position (obj
, start
);
27932 help
= Fget_char_property (make_number (p
),
27933 Qhelp_echo
, w
->buffer
);
27942 else if (BUFFERP (obj
)
27945 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27950 help_echo_string
= help
;
27951 help_echo_window
= window
;
27952 help_echo_object
= obj
;
27953 help_echo_pos
= charpos
;
27958 #ifdef HAVE_WINDOW_SYSTEM
27959 /* Look for a `pointer' property. */
27960 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27962 /* Check overlays first. */
27963 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27964 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27966 if (NILP (pointer
))
27968 Lisp_Object obj
= glyph
->object
;
27969 ptrdiff_t charpos
= glyph
->charpos
;
27971 /* Try text properties. */
27974 && charpos
< SCHARS (obj
))
27976 pointer
= Fget_text_property (make_number (charpos
),
27978 if (NILP (pointer
))
27980 /* If the string itself doesn't specify a pointer,
27981 see if the buffer text ``under'' it does. */
27982 struct glyph_row
*r
27983 = MATRIX_ROW (w
->current_matrix
, vpos
);
27984 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27985 ptrdiff_t p
= string_buffer_position (obj
, start
);
27987 pointer
= Fget_char_property (make_number (p
),
27988 Qpointer
, w
->buffer
);
27991 else if (BUFFERP (obj
)
27994 pointer
= Fget_text_property (make_number (charpos
),
27998 #endif /* HAVE_WINDOW_SYSTEM */
28002 current_buffer
= obuf
;
28007 #ifdef HAVE_WINDOW_SYSTEM
28008 if (FRAME_WINDOW_P (f
))
28009 define_frame_cursor1 (f
, cursor
, pointer
);
28011 /* This is here to prevent a compiler error, about "label at end of
28012 compound statement". */
28019 Clear any mouse-face on window W. This function is part of the
28020 redisplay interface, and is called from try_window_id and similar
28021 functions to ensure the mouse-highlight is off. */
28024 x_clear_window_mouse_face (struct window
*w
)
28026 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28027 Lisp_Object window
;
28030 XSETWINDOW (window
, w
);
28031 if (EQ (window
, hlinfo
->mouse_face_window
))
28032 clear_mouse_face (hlinfo
);
28038 Just discard the mouse face information for frame F, if any.
28039 This is used when the size of F is changed. */
28042 cancel_mouse_face (struct frame
*f
)
28044 Lisp_Object window
;
28045 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28047 window
= hlinfo
->mouse_face_window
;
28048 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
28050 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28051 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28052 hlinfo
->mouse_face_window
= Qnil
;
28058 /***********************************************************************
28060 ***********************************************************************/
28062 #ifdef HAVE_WINDOW_SYSTEM
28064 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28065 which intersects rectangle R. R is in window-relative coordinates. */
28068 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
28069 enum glyph_row_area area
)
28071 struct glyph
*first
= row
->glyphs
[area
];
28072 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
28073 struct glyph
*last
;
28074 int first_x
, start_x
, x
;
28076 if (area
== TEXT_AREA
&& row
->fill_line_p
)
28077 /* If row extends face to end of line write the whole line. */
28078 draw_glyphs (w
, 0, row
, area
,
28079 0, row
->used
[area
],
28080 DRAW_NORMAL_TEXT
, 0);
28083 /* Set START_X to the window-relative start position for drawing glyphs of
28084 AREA. The first glyph of the text area can be partially visible.
28085 The first glyphs of other areas cannot. */
28086 start_x
= window_box_left_offset (w
, area
);
28088 if (area
== TEXT_AREA
)
28091 /* Find the first glyph that must be redrawn. */
28093 && x
+ first
->pixel_width
< r
->x
)
28095 x
+= first
->pixel_width
;
28099 /* Find the last one. */
28103 && x
< r
->x
+ r
->width
)
28105 x
+= last
->pixel_width
;
28111 draw_glyphs (w
, first_x
- start_x
, row
, area
,
28112 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
28113 DRAW_NORMAL_TEXT
, 0);
28118 /* Redraw the parts of the glyph row ROW on window W intersecting
28119 rectangle R. R is in window-relative coordinates. Value is
28120 non-zero if mouse-face was overwritten. */
28123 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
28125 eassert (row
->enabled_p
);
28127 if (row
->mode_line_p
|| w
->pseudo_window_p
)
28128 draw_glyphs (w
, 0, row
, TEXT_AREA
,
28129 0, row
->used
[TEXT_AREA
],
28130 DRAW_NORMAL_TEXT
, 0);
28133 if (row
->used
[LEFT_MARGIN_AREA
])
28134 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
28135 if (row
->used
[TEXT_AREA
])
28136 expose_area (w
, row
, r
, TEXT_AREA
);
28137 if (row
->used
[RIGHT_MARGIN_AREA
])
28138 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
28139 draw_row_fringe_bitmaps (w
, row
);
28142 return row
->mouse_face_p
;
28146 /* Redraw those parts of glyphs rows during expose event handling that
28147 overlap other rows. Redrawing of an exposed line writes over parts
28148 of lines overlapping that exposed line; this function fixes that.
28150 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28151 row in W's current matrix that is exposed and overlaps other rows.
28152 LAST_OVERLAPPING_ROW is the last such row. */
28155 expose_overlaps (struct window
*w
,
28156 struct glyph_row
*first_overlapping_row
,
28157 struct glyph_row
*last_overlapping_row
,
28160 struct glyph_row
*row
;
28162 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
28163 if (row
->overlapping_p
)
28165 eassert (row
->enabled_p
&& !row
->mode_line_p
);
28168 if (row
->used
[LEFT_MARGIN_AREA
])
28169 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
28171 if (row
->used
[TEXT_AREA
])
28172 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
28174 if (row
->used
[RIGHT_MARGIN_AREA
])
28175 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
28181 /* Return non-zero if W's cursor intersects rectangle R. */
28184 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
28186 XRectangle cr
, result
;
28187 struct glyph
*cursor_glyph
;
28188 struct glyph_row
*row
;
28190 if (w
->phys_cursor
.vpos
>= 0
28191 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
28192 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
28194 && row
->cursor_in_fringe_p
)
28196 /* Cursor is in the fringe. */
28197 cr
.x
= window_box_right_offset (w
,
28198 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
28199 ? RIGHT_MARGIN_AREA
28202 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
28203 cr
.height
= row
->height
;
28204 return x_intersect_rectangles (&cr
, r
, &result
);
28207 cursor_glyph
= get_phys_cursor_glyph (w
);
28210 /* r is relative to W's box, but w->phys_cursor.x is relative
28211 to left edge of W's TEXT area. Adjust it. */
28212 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28213 cr
.y
= w
->phys_cursor
.y
;
28214 cr
.width
= cursor_glyph
->pixel_width
;
28215 cr
.height
= w
->phys_cursor_height
;
28216 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28217 I assume the effect is the same -- and this is portable. */
28218 return x_intersect_rectangles (&cr
, r
, &result
);
28220 /* If we don't understand the format, pretend we're not in the hot-spot. */
28226 Draw a vertical window border to the right of window W if W doesn't
28227 have vertical scroll bars. */
28230 x_draw_vertical_border (struct window
*w
)
28232 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28234 /* We could do better, if we knew what type of scroll-bar the adjacent
28235 windows (on either side) have... But we don't :-(
28236 However, I think this works ok. ++KFS 2003-04-25 */
28238 /* Redraw borders between horizontally adjacent windows. Don't
28239 do it for frames with vertical scroll bars because either the
28240 right scroll bar of a window, or the left scroll bar of its
28241 neighbor will suffice as a border. */
28242 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28245 /* Note: It is necessary to redraw both the left and the right
28246 borders, for when only this single window W is being
28248 if (!WINDOW_RIGHTMOST_P (w
)
28249 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28251 int x0
, x1
, y0
, y1
;
28253 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28256 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28259 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28261 if (!WINDOW_LEFTMOST_P (w
)
28262 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28264 int x0
, x1
, y0
, y1
;
28266 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28269 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28272 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28277 /* Redraw the part of window W intersection rectangle FR. Pixel
28278 coordinates in FR are frame-relative. Call this function with
28279 input blocked. Value is non-zero if the exposure overwrites
28283 expose_window (struct window
*w
, XRectangle
*fr
)
28285 struct frame
*f
= XFRAME (w
->frame
);
28287 int mouse_face_overwritten_p
= 0;
28289 /* If window is not yet fully initialized, do nothing. This can
28290 happen when toolkit scroll bars are used and a window is split.
28291 Reconfiguring the scroll bar will generate an expose for a newly
28293 if (w
->current_matrix
== NULL
)
28296 /* When we're currently updating the window, display and current
28297 matrix usually don't agree. Arrange for a thorough display
28299 if (w
== updated_window
)
28301 SET_FRAME_GARBAGED (f
);
28305 /* Frame-relative pixel rectangle of W. */
28306 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28307 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28308 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28309 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28311 if (x_intersect_rectangles (fr
, &wr
, &r
))
28313 int yb
= window_text_bottom_y (w
);
28314 struct glyph_row
*row
;
28315 int cursor_cleared_p
, phys_cursor_on_p
;
28316 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28318 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28319 r
.x
, r
.y
, r
.width
, r
.height
));
28321 /* Convert to window coordinates. */
28322 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28323 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28325 /* Turn off the cursor. */
28326 if (!w
->pseudo_window_p
28327 && phys_cursor_in_rect_p (w
, &r
))
28329 x_clear_cursor (w
);
28330 cursor_cleared_p
= 1;
28333 cursor_cleared_p
= 0;
28335 /* If the row containing the cursor extends face to end of line,
28336 then expose_area might overwrite the cursor outside the
28337 rectangle and thus notice_overwritten_cursor might clear
28338 w->phys_cursor_on_p. We remember the original value and
28339 check later if it is changed. */
28340 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28342 /* Update lines intersecting rectangle R. */
28343 first_overlapping_row
= last_overlapping_row
= NULL
;
28344 for (row
= w
->current_matrix
->rows
;
28349 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28351 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28352 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28353 || (r
.y
>= y0
&& r
.y
< y1
)
28354 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28356 /* A header line may be overlapping, but there is no need
28357 to fix overlapping areas for them. KFS 2005-02-12 */
28358 if (row
->overlapping_p
&& !row
->mode_line_p
)
28360 if (first_overlapping_row
== NULL
)
28361 first_overlapping_row
= row
;
28362 last_overlapping_row
= row
;
28366 if (expose_line (w
, row
, &r
))
28367 mouse_face_overwritten_p
= 1;
28370 else if (row
->overlapping_p
)
28372 /* We must redraw a row overlapping the exposed area. */
28374 ? y0
+ row
->phys_height
> r
.y
28375 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28377 if (first_overlapping_row
== NULL
)
28378 first_overlapping_row
= row
;
28379 last_overlapping_row
= row
;
28387 /* Display the mode line if there is one. */
28388 if (WINDOW_WANTS_MODELINE_P (w
)
28389 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28391 && row
->y
< r
.y
+ r
.height
)
28393 if (expose_line (w
, row
, &r
))
28394 mouse_face_overwritten_p
= 1;
28397 if (!w
->pseudo_window_p
)
28399 /* Fix the display of overlapping rows. */
28400 if (first_overlapping_row
)
28401 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28404 /* Draw border between windows. */
28405 x_draw_vertical_border (w
);
28407 /* Turn the cursor on again. */
28408 if (cursor_cleared_p
28409 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28410 update_window_cursor (w
, 1);
28414 return mouse_face_overwritten_p
;
28419 /* Redraw (parts) of all windows in the window tree rooted at W that
28420 intersect R. R contains frame pixel coordinates. Value is
28421 non-zero if the exposure overwrites mouse-face. */
28424 expose_window_tree (struct window
*w
, XRectangle
*r
)
28426 struct frame
*f
= XFRAME (w
->frame
);
28427 int mouse_face_overwritten_p
= 0;
28429 while (w
&& !FRAME_GARBAGED_P (f
))
28431 if (!NILP (w
->hchild
))
28432 mouse_face_overwritten_p
28433 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28434 else if (!NILP (w
->vchild
))
28435 mouse_face_overwritten_p
28436 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28438 mouse_face_overwritten_p
|= expose_window (w
, r
);
28440 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28443 return mouse_face_overwritten_p
;
28448 Redisplay an exposed area of frame F. X and Y are the upper-left
28449 corner of the exposed rectangle. W and H are width and height of
28450 the exposed area. All are pixel values. W or H zero means redraw
28451 the entire frame. */
28454 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28457 int mouse_face_overwritten_p
= 0;
28459 TRACE ((stderr
, "expose_frame "));
28461 /* No need to redraw if frame will be redrawn soon. */
28462 if (FRAME_GARBAGED_P (f
))
28464 TRACE ((stderr
, " garbaged\n"));
28468 /* If basic faces haven't been realized yet, there is no point in
28469 trying to redraw anything. This can happen when we get an expose
28470 event while Emacs is starting, e.g. by moving another window. */
28471 if (FRAME_FACE_CACHE (f
) == NULL
28472 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28474 TRACE ((stderr
, " no faces\n"));
28478 if (w
== 0 || h
== 0)
28481 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28482 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28492 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28493 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28495 if (WINDOWP (f
->tool_bar_window
))
28496 mouse_face_overwritten_p
28497 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28499 #ifdef HAVE_X_WINDOWS
28501 #ifndef USE_X_TOOLKIT
28502 if (WINDOWP (f
->menu_bar_window
))
28503 mouse_face_overwritten_p
28504 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28505 #endif /* not USE_X_TOOLKIT */
28509 /* Some window managers support a focus-follows-mouse style with
28510 delayed raising of frames. Imagine a partially obscured frame,
28511 and moving the mouse into partially obscured mouse-face on that
28512 frame. The visible part of the mouse-face will be highlighted,
28513 then the WM raises the obscured frame. With at least one WM, KDE
28514 2.1, Emacs is not getting any event for the raising of the frame
28515 (even tried with SubstructureRedirectMask), only Expose events.
28516 These expose events will draw text normally, i.e. not
28517 highlighted. Which means we must redo the highlight here.
28518 Subsume it under ``we love X''. --gerd 2001-08-15 */
28519 /* Included in Windows version because Windows most likely does not
28520 do the right thing if any third party tool offers
28521 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28522 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28524 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28525 if (f
== hlinfo
->mouse_face_mouse_frame
)
28527 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28528 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28529 clear_mouse_face (hlinfo
);
28530 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28537 Determine the intersection of two rectangles R1 and R2. Return
28538 the intersection in *RESULT. Value is non-zero if RESULT is not
28542 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28544 XRectangle
*left
, *right
;
28545 XRectangle
*upper
, *lower
;
28546 int intersection_p
= 0;
28548 /* Rearrange so that R1 is the left-most rectangle. */
28550 left
= r1
, right
= r2
;
28552 left
= r2
, right
= r1
;
28554 /* X0 of the intersection is right.x0, if this is inside R1,
28555 otherwise there is no intersection. */
28556 if (right
->x
<= left
->x
+ left
->width
)
28558 result
->x
= right
->x
;
28560 /* The right end of the intersection is the minimum of
28561 the right ends of left and right. */
28562 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28565 /* Same game for Y. */
28567 upper
= r1
, lower
= r2
;
28569 upper
= r2
, lower
= r1
;
28571 /* The upper end of the intersection is lower.y0, if this is inside
28572 of upper. Otherwise, there is no intersection. */
28573 if (lower
->y
<= upper
->y
+ upper
->height
)
28575 result
->y
= lower
->y
;
28577 /* The lower end of the intersection is the minimum of the lower
28578 ends of upper and lower. */
28579 result
->height
= (min (lower
->y
+ lower
->height
,
28580 upper
->y
+ upper
->height
)
28582 intersection_p
= 1;
28586 return intersection_p
;
28589 #endif /* HAVE_WINDOW_SYSTEM */
28592 /***********************************************************************
28594 ***********************************************************************/
28597 syms_of_xdisp (void)
28599 Vwith_echo_area_save_vector
= Qnil
;
28600 staticpro (&Vwith_echo_area_save_vector
);
28602 Vmessage_stack
= Qnil
;
28603 staticpro (&Vmessage_stack
);
28605 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28606 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
28608 message_dolog_marker1
= Fmake_marker ();
28609 staticpro (&message_dolog_marker1
);
28610 message_dolog_marker2
= Fmake_marker ();
28611 staticpro (&message_dolog_marker2
);
28612 message_dolog_marker3
= Fmake_marker ();
28613 staticpro (&message_dolog_marker3
);
28616 defsubr (&Sdump_frame_glyph_matrix
);
28617 defsubr (&Sdump_glyph_matrix
);
28618 defsubr (&Sdump_glyph_row
);
28619 defsubr (&Sdump_tool_bar_row
);
28620 defsubr (&Strace_redisplay
);
28621 defsubr (&Strace_to_stderr
);
28623 #ifdef HAVE_WINDOW_SYSTEM
28624 defsubr (&Stool_bar_lines_needed
);
28625 defsubr (&Slookup_image_map
);
28627 defsubr (&Sformat_mode_line
);
28628 defsubr (&Sinvisible_p
);
28629 defsubr (&Scurrent_bidi_paragraph_direction
);
28631 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28632 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28633 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28634 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28635 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28636 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28637 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28638 DEFSYM (Qeval
, "eval");
28639 DEFSYM (QCdata
, ":data");
28640 DEFSYM (Qdisplay
, "display");
28641 DEFSYM (Qspace_width
, "space-width");
28642 DEFSYM (Qraise
, "raise");
28643 DEFSYM (Qslice
, "slice");
28644 DEFSYM (Qspace
, "space");
28645 DEFSYM (Qmargin
, "margin");
28646 DEFSYM (Qpointer
, "pointer");
28647 DEFSYM (Qleft_margin
, "left-margin");
28648 DEFSYM (Qright_margin
, "right-margin");
28649 DEFSYM (Qcenter
, "center");
28650 DEFSYM (Qline_height
, "line-height");
28651 DEFSYM (QCalign_to
, ":align-to");
28652 DEFSYM (QCrelative_width
, ":relative-width");
28653 DEFSYM (QCrelative_height
, ":relative-height");
28654 DEFSYM (QCeval
, ":eval");
28655 DEFSYM (QCpropertize
, ":propertize");
28656 DEFSYM (QCfile
, ":file");
28657 DEFSYM (Qfontified
, "fontified");
28658 DEFSYM (Qfontification_functions
, "fontification-functions");
28659 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28660 DEFSYM (Qescape_glyph
, "escape-glyph");
28661 DEFSYM (Qnobreak_space
, "nobreak-space");
28662 DEFSYM (Qimage
, "image");
28663 DEFSYM (Qtext
, "text");
28664 DEFSYM (Qboth
, "both");
28665 DEFSYM (Qboth_horiz
, "both-horiz");
28666 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28667 DEFSYM (QCmap
, ":map");
28668 DEFSYM (QCpointer
, ":pointer");
28669 DEFSYM (Qrect
, "rect");
28670 DEFSYM (Qcircle
, "circle");
28671 DEFSYM (Qpoly
, "poly");
28672 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28673 DEFSYM (Qgrow_only
, "grow-only");
28674 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28675 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28676 DEFSYM (Qposition
, "position");
28677 DEFSYM (Qbuffer_position
, "buffer-position");
28678 DEFSYM (Qobject
, "object");
28679 DEFSYM (Qbar
, "bar");
28680 DEFSYM (Qhbar
, "hbar");
28681 DEFSYM (Qbox
, "box");
28682 DEFSYM (Qhollow
, "hollow");
28683 DEFSYM (Qhand
, "hand");
28684 DEFSYM (Qarrow
, "arrow");
28685 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28687 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28688 Fcons (intern_c_string ("void-variable"), Qnil
)),
28690 staticpro (&list_of_error
);
28692 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28693 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28694 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28695 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28697 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28698 staticpro (&echo_buffer
[0]);
28699 staticpro (&echo_buffer
[1]);
28701 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28702 staticpro (&echo_area_buffer
[0]);
28703 staticpro (&echo_area_buffer
[1]);
28705 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
28706 staticpro (&Vmessages_buffer_name
);
28708 mode_line_proptrans_alist
= Qnil
;
28709 staticpro (&mode_line_proptrans_alist
);
28710 mode_line_string_list
= Qnil
;
28711 staticpro (&mode_line_string_list
);
28712 mode_line_string_face
= Qnil
;
28713 staticpro (&mode_line_string_face
);
28714 mode_line_string_face_prop
= Qnil
;
28715 staticpro (&mode_line_string_face_prop
);
28716 Vmode_line_unwind_vector
= Qnil
;
28717 staticpro (&Vmode_line_unwind_vector
);
28719 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
28721 help_echo_string
= Qnil
;
28722 staticpro (&help_echo_string
);
28723 help_echo_object
= Qnil
;
28724 staticpro (&help_echo_object
);
28725 help_echo_window
= Qnil
;
28726 staticpro (&help_echo_window
);
28727 previous_help_echo_string
= Qnil
;
28728 staticpro (&previous_help_echo_string
);
28729 help_echo_pos
= -1;
28731 DEFSYM (Qright_to_left
, "right-to-left");
28732 DEFSYM (Qleft_to_right
, "left-to-right");
28734 #ifdef HAVE_WINDOW_SYSTEM
28735 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28736 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
28737 For example, if a block cursor is over a tab, it will be drawn as
28738 wide as that tab on the display. */);
28739 x_stretch_cursor_p
= 0;
28742 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28743 doc
: /* Non-nil means highlight trailing whitespace.
28744 The face used for trailing whitespace is `trailing-whitespace'. */);
28745 Vshow_trailing_whitespace
= Qnil
;
28747 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28748 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28749 If the value is t, Emacs highlights non-ASCII chars which have the
28750 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28751 or `escape-glyph' face respectively.
28753 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28754 U+2011 (non-breaking hyphen) are affected.
28756 Any other non-nil value means to display these characters as a escape
28757 glyph followed by an ordinary space or hyphen.
28759 A value of nil means no special handling of these characters. */);
28760 Vnobreak_char_display
= Qt
;
28762 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28763 doc
: /* The pointer shape to show in void text areas.
28764 A value of nil means to show the text pointer. Other options are `arrow',
28765 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28766 Vvoid_text_area_pointer
= Qarrow
;
28768 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28769 doc
: /* Non-nil means don't actually do any redisplay.
28770 This is used for internal purposes. */);
28771 Vinhibit_redisplay
= Qnil
;
28773 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28774 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28775 Vglobal_mode_string
= Qnil
;
28777 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28778 doc
: /* Marker for where to display an arrow on top of the buffer text.
28779 This must be the beginning of a line in order to work.
28780 See also `overlay-arrow-string'. */);
28781 Voverlay_arrow_position
= Qnil
;
28783 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28784 doc
: /* String to display as an arrow in non-window frames.
28785 See also `overlay-arrow-position'. */);
28786 Voverlay_arrow_string
= build_pure_c_string ("=>");
28788 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28789 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28790 The symbols on this list are examined during redisplay to determine
28791 where to display overlay arrows. */);
28792 Voverlay_arrow_variable_list
28793 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28795 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28796 doc
: /* The number of lines to try scrolling a window by when point moves out.
28797 If that fails to bring point back on frame, point is centered instead.
28798 If this is zero, point is always centered after it moves off frame.
28799 If you want scrolling to always be a line at a time, you should set
28800 `scroll-conservatively' to a large value rather than set this to 1. */);
28802 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28803 doc
: /* Scroll up to this many lines, to bring point back on screen.
28804 If point moves off-screen, redisplay will scroll by up to
28805 `scroll-conservatively' lines in order to bring point just barely
28806 onto the screen again. If that cannot be done, then redisplay
28807 recenters point as usual.
28809 If the value is greater than 100, redisplay will never recenter point,
28810 but will always scroll just enough text to bring point into view, even
28811 if you move far away.
28813 A value of zero means always recenter point if it moves off screen. */);
28814 scroll_conservatively
= 0;
28816 DEFVAR_INT ("scroll-margin", scroll_margin
,
28817 doc
: /* Number of lines of margin at the top and bottom of a window.
28818 Recenter the window whenever point gets within this many lines
28819 of the top or bottom of the window. */);
28822 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28823 doc
: /* Pixels per inch value for non-window system displays.
28824 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28825 Vdisplay_pixels_per_inch
= make_float (72.0);
28828 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28831 DEFVAR_LISP ("truncate-partial-width-windows",
28832 Vtruncate_partial_width_windows
,
28833 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28834 For an integer value, truncate lines in each window narrower than the
28835 full frame width, provided the window width is less than that integer;
28836 otherwise, respect the value of `truncate-lines'.
28838 For any other non-nil value, truncate lines in all windows that do
28839 not span the full frame width.
28841 A value of nil means to respect the value of `truncate-lines'.
28843 If `word-wrap' is enabled, you might want to reduce this. */);
28844 Vtruncate_partial_width_windows
= make_number (50);
28846 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28847 doc
: /* Maximum buffer size for which line number should be displayed.
28848 If the buffer is bigger than this, the line number does not appear
28849 in the mode line. A value of nil means no limit. */);
28850 Vline_number_display_limit
= Qnil
;
28852 DEFVAR_INT ("line-number-display-limit-width",
28853 line_number_display_limit_width
,
28854 doc
: /* Maximum line width (in characters) for line number display.
28855 If the average length of the lines near point is bigger than this, then the
28856 line number may be omitted from the mode line. */);
28857 line_number_display_limit_width
= 200;
28859 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28860 doc
: /* Non-nil means highlight region even in nonselected windows. */);
28861 highlight_nonselected_windows
= 0;
28863 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28864 doc
: /* Non-nil if more than one frame is visible on this display.
28865 Minibuffer-only frames don't count, but iconified frames do.
28866 This variable is not guaranteed to be accurate except while processing
28867 `frame-title-format' and `icon-title-format'. */);
28869 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28870 doc
: /* Template for displaying the title bar of visible frames.
28871 \(Assuming the window manager supports this feature.)
28873 This variable has the same structure as `mode-line-format', except that
28874 the %c and %l constructs are ignored. It is used only on frames for
28875 which no explicit name has been set \(see `modify-frame-parameters'). */);
28877 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28878 doc
: /* Template for displaying the title bar of an iconified frame.
28879 \(Assuming the window manager supports this feature.)
28880 This variable has the same structure as `mode-line-format' (which see),
28881 and is used only on frames for which no explicit name has been set
28882 \(see `modify-frame-parameters'). */);
28884 = Vframe_title_format
28885 = listn (CONSTYPE_PURE
, 3,
28886 intern_c_string ("multiple-frames"),
28887 build_pure_c_string ("%b"),
28888 listn (CONSTYPE_PURE
, 4,
28889 empty_unibyte_string
,
28890 intern_c_string ("invocation-name"),
28891 build_pure_c_string ("@"),
28892 intern_c_string ("system-name")));
28894 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28895 doc
: /* Maximum number of lines to keep in the message log buffer.
28896 If nil, disable message logging. If t, log messages but don't truncate
28897 the buffer when it becomes large. */);
28898 Vmessage_log_max
= make_number (1000);
28900 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28901 doc
: /* Functions called before redisplay, if window sizes have changed.
28902 The value should be a list of functions that take one argument.
28903 Just before redisplay, for each frame, if any of its windows have changed
28904 size since the last redisplay, or have been split or deleted,
28905 all the functions in the list are called, with the frame as argument. */);
28906 Vwindow_size_change_functions
= Qnil
;
28908 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28909 doc
: /* List of functions to call before redisplaying a window with scrolling.
28910 Each function is called with two arguments, the window and its new
28911 display-start position. Note that these functions are also called by
28912 `set-window-buffer'. Also note that the value of `window-end' is not
28913 valid when these functions are called.
28915 Warning: Do not use this feature to alter the way the window
28916 is scrolled. It is not designed for that, and such use probably won't
28918 Vwindow_scroll_functions
= Qnil
;
28920 DEFVAR_LISP ("window-text-change-functions",
28921 Vwindow_text_change_functions
,
28922 doc
: /* Functions to call in redisplay when text in the window might change. */);
28923 Vwindow_text_change_functions
= Qnil
;
28925 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28926 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28927 Each function is called with two arguments, the window and the end trigger value.
28928 See `set-window-redisplay-end-trigger'. */);
28929 Vredisplay_end_trigger_functions
= Qnil
;
28931 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28932 doc
: /* Non-nil means autoselect window with mouse pointer.
28933 If nil, do not autoselect windows.
28934 A positive number means delay autoselection by that many seconds: a
28935 window is autoselected only after the mouse has remained in that
28936 window for the duration of the delay.
28937 A negative number has a similar effect, but causes windows to be
28938 autoselected only after the mouse has stopped moving. \(Because of
28939 the way Emacs compares mouse events, you will occasionally wait twice
28940 that time before the window gets selected.\)
28941 Any other value means to autoselect window instantaneously when the
28942 mouse pointer enters it.
28944 Autoselection selects the minibuffer only if it is active, and never
28945 unselects the minibuffer if it is active.
28947 When customizing this variable make sure that the actual value of
28948 `focus-follows-mouse' matches the behavior of your window manager. */);
28949 Vmouse_autoselect_window
= Qnil
;
28951 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28952 doc
: /* Non-nil means automatically resize tool-bars.
28953 This dynamically changes the tool-bar's height to the minimum height
28954 that is needed to make all tool-bar items visible.
28955 If value is `grow-only', the tool-bar's height is only increased
28956 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28957 Vauto_resize_tool_bars
= Qt
;
28959 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28960 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28961 auto_raise_tool_bar_buttons_p
= 1;
28963 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28964 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28965 make_cursor_line_fully_visible_p
= 1;
28967 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28968 doc
: /* Border below tool-bar in pixels.
28969 If an integer, use it as the height of the border.
28970 If it is one of `internal-border-width' or `border-width', use the
28971 value of the corresponding frame parameter.
28972 Otherwise, no border is added below the tool-bar. */);
28973 Vtool_bar_border
= Qinternal_border_width
;
28975 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28976 doc
: /* Margin around tool-bar buttons in pixels.
28977 If an integer, use that for both horizontal and vertical margins.
28978 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28979 HORZ specifying the horizontal margin, and VERT specifying the
28980 vertical margin. */);
28981 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28983 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28984 doc
: /* Relief thickness of tool-bar buttons. */);
28985 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28987 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28988 doc
: /* Tool bar style to use.
28990 image - show images only
28991 text - show text only
28992 both - show both, text below image
28993 both-horiz - show text to the right of the image
28994 text-image-horiz - show text to the left of the image
28995 any other - use system default or image if no system default.
28997 This variable only affects the GTK+ toolkit version of Emacs. */);
28998 Vtool_bar_style
= Qnil
;
29000 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
29001 doc
: /* Maximum number of characters a label can have to be shown.
29002 The tool bar style must also show labels for this to have any effect, see
29003 `tool-bar-style'. */);
29004 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
29006 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
29007 doc
: /* List of functions to call to fontify regions of text.
29008 Each function is called with one argument POS. Functions must
29009 fontify a region starting at POS in the current buffer, and give
29010 fontified regions the property `fontified'. */);
29011 Vfontification_functions
= Qnil
;
29012 Fmake_variable_buffer_local (Qfontification_functions
);
29014 DEFVAR_BOOL ("unibyte-display-via-language-environment",
29015 unibyte_display_via_language_environment
,
29016 doc
: /* Non-nil means display unibyte text according to language environment.
29017 Specifically, this means that raw bytes in the range 160-255 decimal
29018 are displayed by converting them to the equivalent multibyte characters
29019 according to the current language environment. As a result, they are
29020 displayed according to the current fontset.
29022 Note that this variable affects only how these bytes are displayed,
29023 but does not change the fact they are interpreted as raw bytes. */);
29024 unibyte_display_via_language_environment
= 0;
29026 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
29027 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29028 If a float, it specifies a fraction of the mini-window frame's height.
29029 If an integer, it specifies a number of lines. */);
29030 Vmax_mini_window_height
= make_float (0.25);
29032 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
29033 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
29034 A value of nil means don't automatically resize mini-windows.
29035 A value of t means resize them to fit the text displayed in them.
29036 A value of `grow-only', the default, means let mini-windows grow only;
29037 they return to their normal size when the minibuffer is closed, or the
29038 echo area becomes empty. */);
29039 Vresize_mini_windows
= Qgrow_only
;
29041 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
29042 doc
: /* Alist specifying how to blink the cursor off.
29043 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29044 `cursor-type' frame-parameter or variable equals ON-STATE,
29045 comparing using `equal', Emacs uses OFF-STATE to specify
29046 how to blink it off. ON-STATE and OFF-STATE are values for
29047 the `cursor-type' frame parameter.
29049 If a frame's ON-STATE has no entry in this list,
29050 the frame's other specifications determine how to blink the cursor off. */);
29051 Vblink_cursor_alist
= Qnil
;
29053 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
29054 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
29055 If non-nil, windows are automatically scrolled horizontally to make
29056 point visible. */);
29057 automatic_hscrolling_p
= 1;
29058 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
29060 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
29061 doc
: /* How many columns away from the window edge point is allowed to get
29062 before automatic hscrolling will horizontally scroll the window. */);
29063 hscroll_margin
= 5;
29065 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
29066 doc
: /* How many columns to scroll the window when point gets too close to the edge.
29067 When point is less than `hscroll-margin' columns from the window
29068 edge, automatic hscrolling will scroll the window by the amount of columns
29069 determined by this variable. If its value is a positive integer, scroll that
29070 many columns. If it's a positive floating-point number, it specifies the
29071 fraction of the window's width to scroll. If it's nil or zero, point will be
29072 centered horizontally after the scroll. Any other value, including negative
29073 numbers, are treated as if the value were zero.
29075 Automatic hscrolling always moves point outside the scroll margin, so if
29076 point was more than scroll step columns inside the margin, the window will
29077 scroll more than the value given by the scroll step.
29079 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29080 and `scroll-right' overrides this variable's effect. */);
29081 Vhscroll_step
= make_number (0);
29083 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
29084 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
29085 Bind this around calls to `message' to let it take effect. */);
29086 message_truncate_lines
= 0;
29088 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
29089 doc
: /* Normal hook run to update the menu bar definitions.
29090 Redisplay runs this hook before it redisplays the menu bar.
29091 This is used to update submenus such as Buffers,
29092 whose contents depend on various data. */);
29093 Vmenu_bar_update_hook
= Qnil
;
29095 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
29096 doc
: /* Frame for which we are updating a menu.
29097 The enable predicate for a menu binding should check this variable. */);
29098 Vmenu_updating_frame
= Qnil
;
29100 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
29101 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
29102 inhibit_menubar_update
= 0;
29104 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
29105 doc
: /* Prefix prepended to all continuation lines at display time.
29106 The value may be a string, an image, or a stretch-glyph; it is
29107 interpreted in the same way as the value of a `display' text property.
29109 This variable is overridden by any `wrap-prefix' text or overlay
29112 To add a prefix to non-continuation lines, use `line-prefix'. */);
29113 Vwrap_prefix
= Qnil
;
29114 DEFSYM (Qwrap_prefix
, "wrap-prefix");
29115 Fmake_variable_buffer_local (Qwrap_prefix
);
29117 DEFVAR_LISP ("line-prefix", Vline_prefix
,
29118 doc
: /* Prefix prepended to all non-continuation lines at display time.
29119 The value may be a string, an image, or a stretch-glyph; it is
29120 interpreted in the same way as the value of a `display' text property.
29122 This variable is overridden by any `line-prefix' text or overlay
29125 To add a prefix to continuation lines, use `wrap-prefix'. */);
29126 Vline_prefix
= Qnil
;
29127 DEFSYM (Qline_prefix
, "line-prefix");
29128 Fmake_variable_buffer_local (Qline_prefix
);
29130 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
29131 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
29132 inhibit_eval_during_redisplay
= 0;
29134 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
29135 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
29136 inhibit_free_realized_faces
= 0;
29139 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
29140 doc
: /* Inhibit try_window_id display optimization. */);
29141 inhibit_try_window_id
= 0;
29143 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
29144 doc
: /* Inhibit try_window_reusing display optimization. */);
29145 inhibit_try_window_reusing
= 0;
29147 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
29148 doc
: /* Inhibit try_cursor_movement display optimization. */);
29149 inhibit_try_cursor_movement
= 0;
29150 #endif /* GLYPH_DEBUG */
29152 DEFVAR_INT ("overline-margin", overline_margin
,
29153 doc
: /* Space between overline and text, in pixels.
29154 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29155 margin to the character height. */);
29156 overline_margin
= 2;
29158 DEFVAR_INT ("underline-minimum-offset",
29159 underline_minimum_offset
,
29160 doc
: /* Minimum distance between baseline and underline.
29161 This can improve legibility of underlined text at small font sizes,
29162 particularly when using variable `x-use-underline-position-properties'
29163 with fonts that specify an UNDERLINE_POSITION relatively close to the
29164 baseline. The default value is 1. */);
29165 underline_minimum_offset
= 1;
29167 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
29168 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29169 This feature only works when on a window system that can change
29170 cursor shapes. */);
29171 display_hourglass_p
= 1;
29173 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
29174 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29175 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
29177 hourglass_atimer
= NULL
;
29178 hourglass_shown_p
= 0;
29180 DEFSYM (Qglyphless_char
, "glyphless-char");
29181 DEFSYM (Qhex_code
, "hex-code");
29182 DEFSYM (Qempty_box
, "empty-box");
29183 DEFSYM (Qthin_space
, "thin-space");
29184 DEFSYM (Qzero_width
, "zero-width");
29186 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
29187 /* Intern this now in case it isn't already done.
29188 Setting this variable twice is harmless.
29189 But don't staticpro it here--that is done in alloc.c. */
29190 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
29191 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
29193 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
29194 doc
: /* Char-table defining glyphless characters.
29195 Each element, if non-nil, should be one of the following:
29196 an ASCII acronym string: display this string in a box
29197 `hex-code': display the hexadecimal code of a character in a box
29198 `empty-box': display as an empty box
29199 `thin-space': display as 1-pixel width space
29200 `zero-width': don't display
29201 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29202 display method for graphical terminals and text terminals respectively.
29203 GRAPHICAL and TEXT should each have one of the values listed above.
29205 The char-table has one extra slot to control the display of a character for
29206 which no font is found. This slot only takes effect on graphical terminals.
29207 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29208 `thin-space'. The default is `empty-box'. */);
29209 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29210 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29213 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
29214 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
29215 Vdebug_on_message
= Qnil
;
29219 /* Initialize this module when Emacs starts. */
29224 current_header_line_height
= current_mode_line_height
= -1;
29226 CHARPOS (this_line_start_pos
) = 0;
29228 if (!noninteractive
)
29230 struct window
*m
= XWINDOW (minibuf_window
);
29231 Lisp_Object frame
= m
->frame
;
29232 struct frame
*f
= XFRAME (frame
);
29233 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29234 struct window
*r
= XWINDOW (root
);
29237 echo_area_window
= minibuf_window
;
29239 wset_top_line (r
, make_number (FRAME_TOP_MARGIN (f
)));
29241 (r
, make_number (FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
)));
29242 wset_total_cols (r
, make_number (FRAME_COLS (f
)));
29243 wset_top_line (m
, make_number (FRAME_LINES (f
) - 1));
29244 wset_total_lines (m
, make_number (1));
29245 wset_total_cols (m
, make_number (FRAME_COLS (f
)));
29247 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29248 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29249 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29251 /* The default ellipsis glyphs `...'. */
29252 for (i
= 0; i
< 3; ++i
)
29253 default_invis_vector
[i
] = make_number ('.');
29257 /* Allocate the buffer for frame titles.
29258 Also used for `format-mode-line'. */
29260 mode_line_noprop_buf
= xmalloc (size
);
29261 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29262 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29263 mode_line_target
= MODE_LINE_DISPLAY
;
29266 help_echo_showing_p
= 0;
29269 /* Platform-independent portion of hourglass implementation. */
29271 /* Cancel a currently active hourglass timer, and start a new one. */
29273 start_hourglass (void)
29275 #if defined (HAVE_WINDOW_SYSTEM)
29278 cancel_hourglass ();
29280 if (INTEGERP (Vhourglass_delay
)
29281 && XINT (Vhourglass_delay
) > 0)
29282 delay
= make_emacs_time (min (XINT (Vhourglass_delay
),
29283 TYPE_MAXIMUM (time_t)),
29285 else if (FLOATP (Vhourglass_delay
)
29286 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29287 delay
= EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (Vhourglass_delay
));
29289 delay
= make_emacs_time (DEFAULT_HOURGLASS_DELAY
, 0);
29293 extern void w32_note_current_window (void);
29294 w32_note_current_window ();
29296 #endif /* HAVE_NTGUI */
29298 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29299 show_hourglass
, NULL
);
29304 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29307 cancel_hourglass (void)
29309 #if defined (HAVE_WINDOW_SYSTEM)
29310 if (hourglass_atimer
)
29312 cancel_atimer (hourglass_atimer
);
29313 hourglass_atimer
= NULL
;
29316 if (hourglass_shown_p
)