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
316 #ifndef FRAME_X_OUTPUT
317 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
320 #define INFINITY 10000000
322 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
323 Lisp_Object Qwindow_scroll_functions
;
324 static Lisp_Object Qwindow_text_change_functions
;
325 static Lisp_Object Qredisplay_end_trigger_functions
;
326 Lisp_Object Qinhibit_point_motion_hooks
;
327 static Lisp_Object QCeval
, QCpropertize
;
328 Lisp_Object QCfile
, QCdata
;
329 static Lisp_Object Qfontified
;
330 static Lisp_Object Qgrow_only
;
331 static Lisp_Object Qinhibit_eval_during_redisplay
;
332 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
333 static Lisp_Object Qright_to_left
, Qleft_to_right
;
336 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
338 /* Pointer shapes. */
339 static Lisp_Object Qarrow
, Qhand
;
342 /* Holds the list (error). */
343 static Lisp_Object list_of_error
;
345 static Lisp_Object Qfontification_functions
;
347 static Lisp_Object Qwrap_prefix
;
348 static Lisp_Object Qline_prefix
;
349 static Lisp_Object Qredisplay_internal
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x)
381 #else /* !HAVE_WINDOW_SYSTEM */
382 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
383 #endif /* HAVE_WINDOW_SYSTEM */
385 /* Test if the display element loaded in IT, or the underlying buffer
386 or string character, is a space or a TAB character. This is used
387 to determine where word wrapping can occur. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
391 || ((STRINGP (it->string) \
392 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
393 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
395 && (it->s[IT_BYTEPOS (*it)] == ' ' \
396 || it->s[IT_BYTEPOS (*it)] == '\t')) \
397 || (IT_BYTEPOS (*it) < ZV_BYTE \
398 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
399 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
401 /* Name of the face used to highlight trailing whitespace. */
403 static Lisp_Object Qtrailing_whitespace
;
405 /* Name and number of the face used to highlight escape glyphs. */
407 static Lisp_Object Qescape_glyph
;
409 /* Name and number of the face used to highlight non-breaking spaces. */
411 static Lisp_Object Qnobreak_space
;
413 /* The symbol `image' which is the car of the lists used to represent
414 images in Lisp. Also a tool bar style. */
418 /* The image map types. */
420 static Lisp_Object QCpointer
;
421 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
423 /* Tool bar styles */
424 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
426 /* Non-zero means print newline to stdout before next mini-buffer
429 int noninteractive_need_newline
;
431 /* Non-zero means print newline to message log before next message. */
433 static int message_log_need_newline
;
435 /* Three markers that message_dolog uses.
436 It could allocate them itself, but that causes trouble
437 in handling memory-full errors. */
438 static Lisp_Object message_dolog_marker1
;
439 static Lisp_Object message_dolog_marker2
;
440 static Lisp_Object message_dolog_marker3
;
442 /* The buffer position of the first character appearing entirely or
443 partially on the line of the selected window which contains the
444 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
445 redisplay optimization in redisplay_internal. */
447 static struct text_pos this_line_start_pos
;
449 /* Number of characters past the end of the line above, including the
450 terminating newline. */
452 static struct text_pos this_line_end_pos
;
454 /* The vertical positions and the height of this line. */
456 static int this_line_vpos
;
457 static int this_line_y
;
458 static int this_line_pixel_height
;
460 /* X position at which this display line starts. Usually zero;
461 negative if first character is partially visible. */
463 static int this_line_start_x
;
465 /* The smallest character position seen by move_it_* functions as they
466 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
467 hscrolled lines, see display_line. */
469 static struct text_pos this_line_min_pos
;
471 /* Buffer that this_line_.* variables are referring to. */
473 static struct buffer
*this_line_buffer
;
476 /* Values of those variables at last redisplay are stored as
477 properties on `overlay-arrow-position' symbol. However, if
478 Voverlay_arrow_position is a marker, last-arrow-position is its
479 numerical position. */
481 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
483 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
484 properties on a symbol in overlay-arrow-variable-list. */
486 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
488 Lisp_Object Qmenu_bar_update_hook
;
490 /* Nonzero if an overlay arrow has been displayed in this window. */
492 static int overlay_arrow_seen
;
494 /* Vector containing glyphs for an ellipsis `...'. */
496 static Lisp_Object default_invis_vector
[3];
498 /* This is the window where the echo area message was displayed. It
499 is always a mini-buffer window, but it may not be the same window
500 currently active as a mini-buffer. */
502 Lisp_Object echo_area_window
;
504 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
505 pushes the current message and the value of
506 message_enable_multibyte on the stack, the function restore_message
507 pops the stack and displays MESSAGE again. */
509 static Lisp_Object Vmessage_stack
;
511 /* Nonzero means multibyte characters were enabled when the echo area
512 message was specified. */
514 static int message_enable_multibyte
;
516 /* Nonzero if we should redraw the mode lines on the next redisplay. */
518 int update_mode_lines
;
520 /* Nonzero if window sizes or contents have changed since last
521 redisplay that finished. */
523 int windows_or_buffers_changed
;
525 /* Nonzero means a frame's cursor type has been changed. */
527 static int cursor_type_changed
;
529 /* Nonzero after display_mode_line if %l was used and it displayed a
532 static int line_number_displayed
;
534 /* The name of the *Messages* buffer, a string. */
536 static Lisp_Object Vmessages_buffer_name
;
538 /* Current, index 0, and last displayed echo area message. Either
539 buffers from echo_buffers, or nil to indicate no message. */
541 Lisp_Object echo_area_buffer
[2];
543 /* The buffers referenced from echo_area_buffer. */
545 static Lisp_Object echo_buffer
[2];
547 /* A vector saved used in with_area_buffer to reduce consing. */
549 static Lisp_Object Vwith_echo_area_save_vector
;
551 /* Non-zero means display_echo_area should display the last echo area
552 message again. Set by redisplay_preserve_echo_area. */
554 static int display_last_displayed_message_p
;
556 /* Nonzero if echo area is being used by print; zero if being used by
559 static int message_buf_print
;
561 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
563 static Lisp_Object Qinhibit_menubar_update
;
564 static Lisp_Object Qmessage_truncate_lines
;
566 /* Set to 1 in clear_message to make redisplay_internal aware
567 of an emptied echo area. */
569 static int message_cleared_p
;
571 /* A scratch glyph row with contents used for generating truncation
572 glyphs. Also used in direct_output_for_insert. */
574 #define MAX_SCRATCH_GLYPHS 100
575 static struct glyph_row scratch_glyph_row
;
576 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
578 /* Ascent and height of the last line processed by move_it_to. */
580 static int last_height
;
582 /* Non-zero if there's a help-echo in the echo area. */
584 int help_echo_showing_p
;
586 /* If >= 0, computed, exact values of mode-line and header-line height
587 to use in the macros CURRENT_MODE_LINE_HEIGHT and
588 CURRENT_HEADER_LINE_HEIGHT. */
590 int current_mode_line_height
, current_header_line_height
;
592 /* The maximum distance to look ahead for text properties. Values
593 that are too small let us call compute_char_face and similar
594 functions too often which is expensive. Values that are too large
595 let us call compute_char_face and alike too often because we
596 might not be interested in text properties that far away. */
598 #define TEXT_PROP_DISTANCE_LIMIT 100
600 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
601 iterator state and later restore it. This is needed because the
602 bidi iterator on bidi.c keeps a stacked cache of its states, which
603 is really a singleton. When we use scratch iterator objects to
604 move around the buffer, we can cause the bidi cache to be pushed or
605 popped, and therefore we need to restore the cache state when we
606 return to the original iterator. */
607 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
610 bidi_unshelve_cache (CACHE, 1); \
612 CACHE = bidi_shelve_cache (); \
615 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
617 if (pITORIG != pITCOPY) \
618 *(pITORIG) = *(pITCOPY); \
619 bidi_unshelve_cache (CACHE, 0); \
625 /* Non-zero means print traces of redisplay if compiled with
626 GLYPH_DEBUG defined. */
628 int trace_redisplay_p
;
630 #endif /* GLYPH_DEBUG */
632 #ifdef DEBUG_TRACE_MOVE
633 /* Non-zero means trace with TRACE_MOVE to stderr. */
636 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
638 #define TRACE_MOVE(x) (void) 0
641 static Lisp_Object Qauto_hscroll_mode
;
643 /* Buffer being redisplayed -- for redisplay_window_error. */
645 static struct buffer
*displayed_buffer
;
647 /* Value returned from text property handlers (see below). */
652 HANDLED_RECOMPUTE_PROPS
,
653 HANDLED_OVERLAY_STRING_CONSUMED
,
657 /* A description of text properties that redisplay is interested
662 /* The name of the property. */
665 /* A unique index for the property. */
668 /* A handler function called to set up iterator IT from the property
669 at IT's current position. Value is used to steer handle_stop. */
670 enum prop_handled (*handler
) (struct it
*it
);
673 static enum prop_handled
handle_face_prop (struct it
*);
674 static enum prop_handled
handle_invisible_prop (struct it
*);
675 static enum prop_handled
handle_display_prop (struct it
*);
676 static enum prop_handled
handle_composition_prop (struct it
*);
677 static enum prop_handled
handle_overlay_change (struct it
*);
678 static enum prop_handled
handle_fontified_prop (struct it
*);
680 /* Properties handled by iterators. */
682 static struct props it_props
[] =
684 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
685 /* Handle `face' before `display' because some sub-properties of
686 `display' need to know the face. */
687 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
688 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
689 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
690 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
694 /* Value is the position described by X. If X is a marker, value is
695 the marker_position of X. Otherwise, value is X. */
697 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
699 /* Enumeration returned by some move_it_.* functions internally. */
703 /* Not used. Undefined value. */
706 /* Move ended at the requested buffer position or ZV. */
707 MOVE_POS_MATCH_OR_ZV
,
709 /* Move ended at the requested X pixel position. */
712 /* Move within a line ended at the end of a line that must be
716 /* Move within a line ended at the end of a line that would
717 be displayed truncated. */
720 /* Move within a line ended at a line end. */
724 /* This counter is used to clear the face cache every once in a while
725 in redisplay_internal. It is incremented for each redisplay.
726 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
729 #define CLEAR_FACE_CACHE_COUNT 500
730 static int clear_face_cache_count
;
732 /* Similarly for the image cache. */
734 #ifdef HAVE_WINDOW_SYSTEM
735 #define CLEAR_IMAGE_CACHE_COUNT 101
736 static int clear_image_cache_count
;
738 /* Null glyph slice */
739 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
742 /* True while redisplay_internal is in progress. */
746 static Lisp_Object Qinhibit_free_realized_faces
;
747 static Lisp_Object Qmode_line_default_help_echo
;
749 /* If a string, XTread_socket generates an event to display that string.
750 (The display is done in read_char.) */
752 Lisp_Object help_echo_string
;
753 Lisp_Object help_echo_window
;
754 Lisp_Object help_echo_object
;
755 ptrdiff_t help_echo_pos
;
757 /* Temporary variable for XTread_socket. */
759 Lisp_Object previous_help_echo_string
;
761 /* Platform-independent portion of hourglass implementation. */
763 /* Non-zero means an hourglass cursor is currently shown. */
764 int hourglass_shown_p
;
766 /* If non-null, an asynchronous timer that, when it expires, displays
767 an hourglass cursor on all frames. */
768 struct atimer
*hourglass_atimer
;
770 /* Name of the face used to display glyphless characters. */
771 Lisp_Object Qglyphless_char
;
773 /* Symbol for the purpose of Vglyphless_char_display. */
774 static Lisp_Object Qglyphless_char_display
;
776 /* Method symbols for Vglyphless_char_display. */
777 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
779 /* Default pixel width of `thin-space' display method. */
780 #define THIN_SPACE_WIDTH 1
782 /* Default number of seconds to wait before displaying an hourglass
784 #define DEFAULT_HOURGLASS_DELAY 1
787 /* Function prototypes. */
789 static void setup_for_ellipsis (struct it
*, int);
790 static void set_iterator_to_next (struct it
*, int);
791 static void mark_window_display_accurate_1 (struct window
*, int);
792 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
793 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
794 static int row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
795 static int cursor_row_p (struct glyph_row
*);
796 static int redisplay_mode_lines (Lisp_Object
, int);
797 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
799 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
801 static void handle_line_prefix (struct it
*);
803 static void pint2str (char *, int, ptrdiff_t);
804 static void pint2hrstr (char *, int, ptrdiff_t);
805 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
807 static int text_outside_line_unchanged_p (struct window
*,
808 ptrdiff_t, ptrdiff_t);
809 static void store_mode_line_noprop_char (char);
810 static int store_mode_line_noprop (const char *, int, int);
811 static void handle_stop (struct it
*);
812 static void handle_stop_backwards (struct it
*, ptrdiff_t);
813 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
814 static void ensure_echo_area_buffers (void);
815 static void unwind_with_echo_area_buffer (Lisp_Object
);
816 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
817 static int with_echo_area_buffer (struct window
*, int,
818 int (*) (ptrdiff_t, Lisp_Object
),
819 ptrdiff_t, Lisp_Object
);
820 static void clear_garbaged_frames (void);
821 static int current_message_1 (ptrdiff_t, Lisp_Object
);
822 static int truncate_message_1 (ptrdiff_t, Lisp_Object
);
823 static void set_message (Lisp_Object
);
824 static int set_message_1 (ptrdiff_t, Lisp_Object
);
825 static int display_echo_area (struct window
*);
826 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
);
827 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
828 static void unwind_redisplay (void);
829 static int string_char_and_length (const unsigned char *, int *);
830 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
832 static int compute_window_start_on_continuation_line (struct window
*);
833 static void insert_left_trunc_glyphs (struct it
*);
834 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
836 static void extend_face_to_end_of_line (struct it
*);
837 static int append_space_for_newline (struct it
*, int);
838 static int cursor_row_fully_visible_p (struct window
*, int, int);
839 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
840 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
841 static int trailing_whitespace_p (ptrdiff_t);
842 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
843 static void push_it (struct it
*, struct text_pos
*);
844 static void iterate_out_of_display_property (struct it
*);
845 static void pop_it (struct it
*);
846 static void sync_frame_with_window_matrix_rows (struct window
*);
847 static void redisplay_internal (void);
848 static int echo_area_display (int);
849 static void redisplay_windows (Lisp_Object
);
850 static void redisplay_window (Lisp_Object
, int);
851 static Lisp_Object
redisplay_window_error (Lisp_Object
);
852 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
853 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
854 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
855 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
857 static int update_menu_bar (struct frame
*, int, int);
858 static int try_window_reusing_current_matrix (struct window
*);
859 static int try_window_id (struct window
*);
860 static int display_line (struct it
*);
861 static int display_mode_lines (struct window
*);
862 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
863 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
864 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
865 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
866 static void display_menu_bar (struct window
*);
867 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
869 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
870 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
871 static void compute_line_metrics (struct it
*);
872 static void run_redisplay_end_trigger_hook (struct it
*);
873 static int get_overlay_strings (struct it
*, ptrdiff_t);
874 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
875 static void next_overlay_string (struct it
*);
876 static void reseat (struct it
*, struct text_pos
, int);
877 static void reseat_1 (struct it
*, struct text_pos
, int);
878 static void back_to_previous_visible_line_start (struct it
*);
879 static void reseat_at_next_visible_line_start (struct it
*, int);
880 static int next_element_from_ellipsis (struct it
*);
881 static int next_element_from_display_vector (struct it
*);
882 static int next_element_from_string (struct it
*);
883 static int next_element_from_c_string (struct it
*);
884 static int next_element_from_buffer (struct it
*);
885 static int next_element_from_composition (struct it
*);
886 static int next_element_from_image (struct it
*);
887 static int next_element_from_stretch (struct it
*);
888 static void load_overlay_strings (struct it
*, ptrdiff_t);
889 static int init_from_display_pos (struct it
*, struct window
*,
890 struct display_pos
*);
891 static void reseat_to_string (struct it
*, const char *,
892 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
893 static int get_next_display_element (struct it
*);
894 static enum move_it_result
895 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
896 enum move_operation_enum
);
897 static void get_visually_first_element (struct it
*);
898 static void init_to_row_start (struct it
*, struct window
*,
900 static int init_to_row_end (struct it
*, struct window
*,
902 static void back_to_previous_line_start (struct it
*);
903 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
904 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
905 Lisp_Object
, ptrdiff_t);
906 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
907 static struct text_pos
c_string_pos (ptrdiff_t, const char *, bool);
908 static ptrdiff_t number_of_chars (const char *, bool);
909 static void compute_stop_pos (struct it
*);
910 static void compute_string_pos (struct text_pos
*, struct text_pos
,
912 static int face_before_or_after_it_pos (struct it
*, int);
913 static ptrdiff_t next_overlay_change (ptrdiff_t);
914 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
915 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
916 static int handle_single_display_spec (struct it
*, Lisp_Object
,
917 Lisp_Object
, Lisp_Object
,
918 struct text_pos
*, ptrdiff_t, int, int);
919 static int underlying_face_id (struct it
*);
920 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
923 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
924 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
926 #ifdef HAVE_WINDOW_SYSTEM
928 static void x_consider_frame_title (Lisp_Object
);
929 static int tool_bar_lines_needed (struct frame
*, int *);
930 static void update_tool_bar (struct frame
*, int);
931 static void build_desired_tool_bar_string (struct frame
*f
);
932 static int redisplay_tool_bar (struct frame
*);
933 static void display_tool_bar_line (struct it
*, int);
934 static void notice_overwritten_cursor (struct window
*,
937 static void append_stretch_glyph (struct it
*, Lisp_Object
,
941 #endif /* HAVE_WINDOW_SYSTEM */
943 static void produce_special_glyphs (struct it
*, enum display_element_type
);
944 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
945 static int coords_in_mouse_face_p (struct window
*, int, int);
949 /***********************************************************************
950 Window display dimensions
951 ***********************************************************************/
953 /* Return the bottom boundary y-position for text lines in window W.
954 This is the first y position at which a line cannot start.
955 It is relative to the top of the window.
957 This is the height of W minus the height of a mode line, if any. */
960 window_text_bottom_y (struct window
*w
)
962 int height
= WINDOW_TOTAL_HEIGHT (w
);
964 if (WINDOW_WANTS_MODELINE_P (w
))
965 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
969 /* Return the pixel width of display area AREA of window W.
970 ANY_AREA means return the total width of W, not including
971 fringes to the left and right of the window. */
974 window_box_width (struct window
*w
, enum glyph_row_area area
)
976 int cols
= w
->total_cols
;
979 if (!w
->pseudo_window_p
)
981 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
983 if (area
== TEXT_AREA
)
985 cols
-= max (0, w
->left_margin_cols
);
986 cols
-= max (0, w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= max (0, w
->left_margin_cols
);
994 else if (area
== RIGHT_MARGIN_AREA
)
996 cols
= max (0, w
->right_margin_cols
);
1001 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1005 /* Return the pixel height of the display area of window W, not
1006 including mode lines of W, if any. */
1009 window_box_height (struct window
*w
)
1011 struct frame
*f
= XFRAME (w
->frame
);
1012 int height
= WINDOW_TOTAL_HEIGHT (w
);
1014 eassert (height
>= 0);
1016 /* Note: the code below that determines the mode-line/header-line
1017 height is essentially the same as that contained in the macro
1018 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1019 the appropriate glyph row has its `mode_line_p' flag set,
1020 and if it doesn't, uses estimate_mode_line_height instead. */
1022 if (WINDOW_WANTS_MODELINE_P (w
))
1024 struct glyph_row
*ml_row
1025 = (w
->current_matrix
&& w
->current_matrix
->rows
1026 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1028 if (ml_row
&& ml_row
->mode_line_p
)
1029 height
-= ml_row
->height
;
1031 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1034 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1036 struct glyph_row
*hl_row
1037 = (w
->current_matrix
&& w
->current_matrix
->rows
1038 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1040 if (hl_row
&& hl_row
->mode_line_p
)
1041 height
-= hl_row
->height
;
1043 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1046 /* With a very small font and a mode-line that's taller than
1047 default, we might end up with a negative height. */
1048 return max (0, height
);
1051 /* Return the window-relative coordinate of the left edge of display
1052 area AREA of window W. ANY_AREA means return the left edge of the
1053 whole window, to the right of the left fringe of W. */
1056 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1060 if (w
->pseudo_window_p
)
1063 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1065 if (area
== TEXT_AREA
)
1066 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1067 + window_box_width (w
, LEFT_MARGIN_AREA
));
1068 else if (area
== RIGHT_MARGIN_AREA
)
1069 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1070 + window_box_width (w
, LEFT_MARGIN_AREA
)
1071 + window_box_width (w
, TEXT_AREA
)
1072 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1074 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1075 else if (area
== LEFT_MARGIN_AREA
1076 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1077 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1083 /* Return the window-relative coordinate of the right edge of display
1084 area AREA of window W. ANY_AREA means return the right edge of the
1085 whole window, to the left of the right fringe of W. */
1088 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1090 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1093 /* Return the frame-relative coordinate of the left edge of display
1094 area AREA of window W. ANY_AREA means return the left edge of the
1095 whole window, to the right of the left fringe of W. */
1098 window_box_left (struct window
*w
, enum glyph_row_area area
)
1100 struct frame
*f
= XFRAME (w
->frame
);
1103 if (w
->pseudo_window_p
)
1104 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1106 x
= (WINDOW_LEFT_EDGE_X (w
)
1107 + window_box_left_offset (w
, area
));
1113 /* Return the frame-relative coordinate of the right edge of display
1114 area AREA of window W. ANY_AREA means return the right edge of the
1115 whole window, to the left of the right fringe of W. */
1118 window_box_right (struct window
*w
, enum glyph_row_area area
)
1120 return window_box_left (w
, area
) + window_box_width (w
, area
);
1123 /* Get the bounding box of the display area AREA of window W, without
1124 mode lines, in frame-relative coordinates. ANY_AREA means the
1125 whole window, not including the left and right fringes of
1126 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1127 coordinates of the upper-left corner of the box. Return in
1128 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1131 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1132 int *box_y
, int *box_width
, int *box_height
)
1135 *box_width
= window_box_width (w
, area
);
1137 *box_height
= window_box_height (w
);
1139 *box_x
= window_box_left (w
, area
);
1142 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1143 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1144 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1149 /* Get the bounding box of the display area AREA of window W, without
1150 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1151 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1152 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1153 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1157 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1158 int *bottom_right_x
, int *bottom_right_y
)
1160 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1161 bottom_right_x
, bottom_right_y
);
1162 *bottom_right_x
+= *top_left_x
;
1163 *bottom_right_y
+= *top_left_y
;
1168 /***********************************************************************
1170 ***********************************************************************/
1172 /* Return the bottom y-position of the line the iterator IT is in.
1173 This can modify IT's settings. */
1176 line_bottom_y (struct it
*it
)
1178 int line_height
= it
->max_ascent
+ it
->max_descent
;
1179 int line_top_y
= it
->current_y
;
1181 if (line_height
== 0)
1184 line_height
= last_height
;
1185 else if (IT_CHARPOS (*it
) < ZV
)
1187 move_it_by_lines (it
, 1);
1188 line_height
= (it
->max_ascent
|| it
->max_descent
1189 ? it
->max_ascent
+ it
->max_descent
1194 struct glyph_row
*row
= it
->glyph_row
;
1196 /* Use the default character height. */
1197 it
->glyph_row
= NULL
;
1198 it
->what
= IT_CHARACTER
;
1201 PRODUCE_GLYPHS (it
);
1202 line_height
= it
->ascent
+ it
->descent
;
1203 it
->glyph_row
= row
;
1207 return line_top_y
+ line_height
;
1210 DEFUN ("line-pixel-height", Fline_pixel_height
,
1211 Sline_pixel_height
, 0, 0, 0,
1212 doc
: /* Return height in pixels of text line in the selected window.
1214 Value is the height in pixels of the line at point. */)
1219 struct window
*w
= XWINDOW (selected_window
);
1221 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1222 start_display (&it
, w
, pt
);
1223 it
.vpos
= it
.current_y
= 0;
1225 return make_number (line_bottom_y (&it
));
1228 /* Return the default pixel height of text lines in window W. The
1229 value is the canonical height of the W frame's default font, plus
1230 any extra space required by the line-spacing variable or frame
1233 Implementation note: this ignores any line-spacing text properties
1234 put on the newline characters. This is because those properties
1235 only affect the _screen_ line ending in the newline (i.e., in a
1236 continued line, only the last screen line will be affected), which
1237 means only a small number of lines in a buffer can ever use this
1238 feature. Since this function is used to compute the default pixel
1239 equivalent of text lines in a window, we can safely ignore those
1240 few lines. For the same reasons, we ignore the line-height
1243 default_line_pixel_height (struct window
*w
)
1245 struct frame
*f
= WINDOW_XFRAME (w
);
1246 int height
= FRAME_LINE_HEIGHT (f
);
1248 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1250 struct buffer
*b
= XBUFFER (w
->contents
);
1251 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1254 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1257 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1258 height
+= XFASTINT (val
);
1259 else if (FLOATP (val
))
1261 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1268 height
+= f
->extra_line_spacing
;
1274 /* Subroutine of pos_visible_p below. Extracts a display string, if
1275 any, from the display spec given as its argument. */
1277 string_from_display_spec (Lisp_Object spec
)
1281 while (CONSP (spec
))
1283 if (STRINGP (XCAR (spec
)))
1288 else if (VECTORP (spec
))
1292 for (i
= 0; i
< ASIZE (spec
); i
++)
1294 if (STRINGP (AREF (spec
, i
)))
1295 return AREF (spec
, i
);
1304 /* Limit insanely large values of W->hscroll on frame F to the largest
1305 value that will still prevent first_visible_x and last_visible_x of
1306 'struct it' from overflowing an int. */
1308 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1310 ptrdiff_t window_hscroll
= w
->hscroll
;
1311 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1312 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1314 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1315 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1317 return window_hscroll
;
1320 /* Return 1 if position CHARPOS is visible in window W.
1321 CHARPOS < 0 means return info about WINDOW_END position.
1322 If visible, set *X and *Y to pixel coordinates of top left corner.
1323 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1324 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1327 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1328 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1331 void *itdata
= bidi_shelve_cache ();
1332 struct text_pos top
;
1334 struct buffer
*old_buffer
= NULL
;
1336 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1339 if (XBUFFER (w
->contents
) != current_buffer
)
1341 old_buffer
= current_buffer
;
1342 set_buffer_internal_1 (XBUFFER (w
->contents
));
1345 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1346 /* Scrolling a minibuffer window via scroll bar when the echo area
1347 shows long text sometimes resets the minibuffer contents behind
1349 if (CHARPOS (top
) > ZV
)
1350 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1352 /* Compute exact mode line heights. */
1353 if (WINDOW_WANTS_MODELINE_P (w
))
1354 current_mode_line_height
1355 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1356 BVAR (current_buffer
, mode_line_format
));
1358 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1359 current_header_line_height
1360 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1361 BVAR (current_buffer
, header_line_format
));
1363 start_display (&it
, w
, top
);
1364 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1365 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1368 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1369 && IT_CHARPOS (it
) >= charpos
)
1370 /* When scanning backwards under bidi iteration, move_it_to
1371 stops at or _before_ CHARPOS, because it stops at or to
1372 the _right_ of the character at CHARPOS. */
1373 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1374 && IT_CHARPOS (it
) <= charpos
)))
1376 /* We have reached CHARPOS, or passed it. How the call to
1377 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1378 or covered by a display property, move_it_to stops at the end
1379 of the invisible text, to the right of CHARPOS. (ii) If
1380 CHARPOS is in a display vector, move_it_to stops on its last
1382 int top_x
= it
.current_x
;
1383 int top_y
= it
.current_y
;
1384 /* Calling line_bottom_y may change it.method, it.position, etc. */
1385 enum it_method it_method
= it
.method
;
1386 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1387 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1389 if (top_y
< window_top_y
)
1390 visible_p
= bottom_y
> window_top_y
;
1391 else if (top_y
< it
.last_visible_y
)
1393 if (bottom_y
>= it
.last_visible_y
1394 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1395 && IT_CHARPOS (it
) < charpos
)
1397 /* When the last line of the window is scanned backwards
1398 under bidi iteration, we could be duped into thinking
1399 that we have passed CHARPOS, when in fact move_it_to
1400 simply stopped short of CHARPOS because it reached
1401 last_visible_y. To see if that's what happened, we call
1402 move_it_to again with a slightly larger vertical limit,
1403 and see if it actually moved vertically; if it did, we
1404 didn't really reach CHARPOS, which is beyond window end. */
1405 struct it save_it
= it
;
1406 /* Why 10? because we don't know how many canonical lines
1407 will the height of the next line(s) be. So we guess. */
1408 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1410 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1411 MOVE_TO_POS
| MOVE_TO_Y
);
1412 if (it
.current_y
> top_y
)
1419 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1421 /* We stopped on the last glyph of a display vector.
1422 Try and recompute. Hack alert! */
1423 if (charpos
< 2 || top
.charpos
>= charpos
)
1424 top_x
= it
.glyph_row
->x
;
1427 struct it it2
, it2_prev
;
1428 /* The idea is to get to the previous buffer
1429 position, consume the character there, and use
1430 the pixel coordinates we get after that. But if
1431 the previous buffer position is also displayed
1432 from a display vector, we need to consume all of
1433 the glyphs from that display vector. */
1434 start_display (&it2
, w
, top
);
1435 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1436 /* If we didn't get to CHARPOS - 1, there's some
1437 replacing display property at that position, and
1438 we stopped after it. That is exactly the place
1439 whose coordinates we want. */
1440 if (IT_CHARPOS (it2
) != charpos
- 1)
1444 /* Iterate until we get out of the display
1445 vector that displays the character at
1448 get_next_display_element (&it2
);
1449 PRODUCE_GLYPHS (&it2
);
1451 set_iterator_to_next (&it2
, 1);
1452 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1453 && IT_CHARPOS (it2
) < charpos
);
1455 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1456 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1457 top_x
= it
.glyph_row
->x
;
1460 top_x
= it2_prev
.current_x
;
1461 top_y
= it2_prev
.current_y
;
1465 else if (IT_CHARPOS (it
) != charpos
)
1467 Lisp_Object cpos
= make_number (charpos
);
1468 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1469 Lisp_Object string
= string_from_display_spec (spec
);
1470 struct text_pos tpos
;
1471 int replacing_spec_p
;
1472 bool newline_in_string
1474 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1476 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1479 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1480 charpos
, FRAME_WINDOW_P (it
.f
)));
1481 /* The tricky code below is needed because there's a
1482 discrepancy between move_it_to and how we set cursor
1483 when PT is at the beginning of a portion of text
1484 covered by a display property or an overlay with a
1485 display property, or the display line ends in a
1486 newline from a display string. move_it_to will stop
1487 _after_ such display strings, whereas
1488 set_cursor_from_row conspires with cursor_row_p to
1489 place the cursor on the first glyph produced from the
1492 /* We have overshoot PT because it is covered by a
1493 display property that replaces the text it covers.
1494 If the string includes embedded newlines, we are also
1495 in the wrong display line. Backtrack to the correct
1496 line, where the display property begins. */
1497 if (replacing_spec_p
)
1499 Lisp_Object startpos
, endpos
;
1500 EMACS_INT start
, end
;
1504 /* Find the first and the last buffer positions
1505 covered by the display string. */
1507 Fnext_single_char_property_change (cpos
, Qdisplay
,
1510 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1512 start
= XFASTINT (startpos
);
1513 end
= XFASTINT (endpos
);
1514 /* Move to the last buffer position before the
1515 display property. */
1516 start_display (&it3
, w
, top
);
1517 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1518 /* Move forward one more line if the position before
1519 the display string is a newline or if it is the
1520 rightmost character on a line that is
1521 continued or word-wrapped. */
1522 if (it3
.method
== GET_FROM_BUFFER
1524 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1525 move_it_by_lines (&it3
, 1);
1526 else if (move_it_in_display_line_to (&it3
, -1,
1530 == MOVE_LINE_CONTINUED
)
1532 move_it_by_lines (&it3
, 1);
1533 /* When we are under word-wrap, the #$@%!
1534 move_it_by_lines moves 2 lines, so we need to
1536 if (it3
.line_wrap
== WORD_WRAP
)
1537 move_it_by_lines (&it3
, -1);
1540 /* Record the vertical coordinate of the display
1541 line where we wound up. */
1542 top_y
= it3
.current_y
;
1545 /* When characters are reordered for display,
1546 the character displayed to the left of the
1547 display string could be _after_ the display
1548 property in the logical order. Use the
1549 smallest vertical position of these two. */
1550 start_display (&it3
, w
, top
);
1551 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1552 if (it3
.current_y
< top_y
)
1553 top_y
= it3
.current_y
;
1555 /* Move from the top of the window to the beginning
1556 of the display line where the display string
1558 start_display (&it3
, w
, top
);
1559 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1560 /* If it3_moved stays zero after the 'while' loop
1561 below, that means we already were at a newline
1562 before the loop (e.g., the display string begins
1563 with a newline), so we don't need to (and cannot)
1564 inspect the glyphs of it3.glyph_row, because
1565 PRODUCE_GLYPHS will not produce anything for a
1566 newline, and thus it3.glyph_row stays at its
1567 stale content it got at top of the window. */
1569 /* Finally, advance the iterator until we hit the
1570 first display element whose character position is
1571 CHARPOS, or until the first newline from the
1572 display string, which signals the end of the
1574 while (get_next_display_element (&it3
))
1576 PRODUCE_GLYPHS (&it3
);
1577 if (IT_CHARPOS (it3
) == charpos
1578 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1581 set_iterator_to_next (&it3
, 0);
1583 top_x
= it3
.current_x
- it3
.pixel_width
;
1584 /* Normally, we would exit the above loop because we
1585 found the display element whose character
1586 position is CHARPOS. For the contingency that we
1587 didn't, and stopped at the first newline from the
1588 display string, move back over the glyphs
1589 produced from the string, until we find the
1590 rightmost glyph not from the string. */
1592 && newline_in_string
1593 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1595 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1596 + it3
.glyph_row
->used
[TEXT_AREA
];
1598 while (EQ ((g
- 1)->object
, string
))
1601 top_x
-= g
->pixel_width
;
1603 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1604 + it3
.glyph_row
->used
[TEXT_AREA
]);
1610 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1611 *rtop
= max (0, window_top_y
- top_y
);
1612 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1613 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1614 - max (top_y
, window_top_y
)));
1620 /* We were asked to provide info about WINDOW_END. */
1622 void *it2data
= NULL
;
1624 SAVE_IT (it2
, it
, it2data
);
1625 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1626 move_it_by_lines (&it
, 1);
1627 if (charpos
< IT_CHARPOS (it
)
1628 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1631 RESTORE_IT (&it2
, &it2
, it2data
);
1632 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1634 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1635 *rtop
= max (0, -it2
.current_y
);
1636 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1637 - it
.last_visible_y
));
1638 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1640 - max (it2
.current_y
,
1641 WINDOW_HEADER_LINE_HEIGHT (w
))));
1645 bidi_unshelve_cache (it2data
, 1);
1647 bidi_unshelve_cache (itdata
, 0);
1650 set_buffer_internal_1 (old_buffer
);
1652 current_header_line_height
= current_mode_line_height
= -1;
1654 if (visible_p
&& w
->hscroll
> 0)
1656 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1657 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1660 /* Debugging code. */
1662 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1663 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1665 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1672 /* Return the next character from STR. Return in *LEN the length of
1673 the character. This is like STRING_CHAR_AND_LENGTH but never
1674 returns an invalid character. If we find one, we return a `?', but
1675 with the length of the invalid character. */
1678 string_char_and_length (const unsigned char *str
, int *len
)
1682 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1683 if (!CHAR_VALID_P (c
))
1684 /* We may not change the length here because other places in Emacs
1685 don't use this function, i.e. they silently accept invalid
1694 /* Given a position POS containing a valid character and byte position
1695 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1697 static struct text_pos
1698 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1700 eassert (STRINGP (string
) && nchars
>= 0);
1702 if (STRING_MULTIBYTE (string
))
1704 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1709 string_char_and_length (p
, &len
);
1712 BYTEPOS (pos
) += len
;
1716 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1722 /* Value is the text position, i.e. character and byte position,
1723 for character position CHARPOS in STRING. */
1725 static struct text_pos
1726 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1728 struct text_pos pos
;
1729 eassert (STRINGP (string
));
1730 eassert (charpos
>= 0);
1731 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1736 /* Value is a text position, i.e. character and byte position, for
1737 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1738 means recognize multibyte characters. */
1740 static struct text_pos
1741 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1743 struct text_pos pos
;
1745 eassert (s
!= NULL
);
1746 eassert (charpos
>= 0);
1752 SET_TEXT_POS (pos
, 0, 0);
1755 string_char_and_length ((const unsigned char *) s
, &len
);
1758 BYTEPOS (pos
) += len
;
1762 SET_TEXT_POS (pos
, charpos
, charpos
);
1768 /* Value is the number of characters in C string S. MULTIBYTE_P
1769 non-zero means recognize multibyte characters. */
1772 number_of_chars (const char *s
, bool multibyte_p
)
1778 ptrdiff_t rest
= strlen (s
);
1780 const unsigned char *p
= (const unsigned char *) s
;
1782 for (nchars
= 0; rest
> 0; ++nchars
)
1784 string_char_and_length (p
, &len
);
1785 rest
-= len
, p
+= len
;
1789 nchars
= strlen (s
);
1795 /* Compute byte position NEWPOS->bytepos corresponding to
1796 NEWPOS->charpos. POS is a known position in string STRING.
1797 NEWPOS->charpos must be >= POS.charpos. */
1800 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1802 eassert (STRINGP (string
));
1803 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1805 if (STRING_MULTIBYTE (string
))
1806 *newpos
= string_pos_nchars_ahead (pos
, string
,
1807 CHARPOS (*newpos
) - CHARPOS (pos
));
1809 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1813 Return an estimation of the pixel height of mode or header lines on
1814 frame F. FACE_ID specifies what line's height to estimate. */
1817 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1819 #ifdef HAVE_WINDOW_SYSTEM
1820 if (FRAME_WINDOW_P (f
))
1822 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1824 /* This function is called so early when Emacs starts that the face
1825 cache and mode line face are not yet initialized. */
1826 if (FRAME_FACE_CACHE (f
))
1828 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1832 height
= FONT_HEIGHT (face
->font
);
1833 if (face
->box_line_width
> 0)
1834 height
+= 2 * face
->box_line_width
;
1845 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1846 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1847 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1848 not force the value into range. */
1851 pixel_to_glyph_coords (struct frame
*f
, register int pix_x
, register int pix_y
,
1852 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1855 #ifdef HAVE_WINDOW_SYSTEM
1856 if (FRAME_WINDOW_P (f
))
1858 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1859 even for negative values. */
1861 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1863 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1865 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1866 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1869 STORE_NATIVE_RECT (*bounds
,
1870 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1871 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1872 FRAME_COLUMN_WIDTH (f
) - 1,
1873 FRAME_LINE_HEIGHT (f
) - 1);
1879 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1880 pix_x
= FRAME_TOTAL_COLS (f
);
1884 else if (pix_y
> FRAME_LINES (f
))
1885 pix_y
= FRAME_LINES (f
);
1895 /* Find the glyph under window-relative coordinates X/Y in window W.
1896 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1897 strings. Return in *HPOS and *VPOS the row and column number of
1898 the glyph found. Return in *AREA the glyph area containing X.
1899 Value is a pointer to the glyph found or null if X/Y is not on
1900 text, or we can't tell because W's current matrix is not up to
1905 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1906 int *dx
, int *dy
, int *area
)
1908 struct glyph
*glyph
, *end
;
1909 struct glyph_row
*row
= NULL
;
1912 /* Find row containing Y. Give up if some row is not enabled. */
1913 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1915 row
= MATRIX_ROW (w
->current_matrix
, i
);
1916 if (!row
->enabled_p
)
1918 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1925 /* Give up if Y is not in the window. */
1926 if (i
== w
->current_matrix
->nrows
)
1929 /* Get the glyph area containing X. */
1930 if (w
->pseudo_window_p
)
1937 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1939 *area
= LEFT_MARGIN_AREA
;
1940 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1942 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1945 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1949 *area
= RIGHT_MARGIN_AREA
;
1950 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1954 /* Find glyph containing X. */
1955 glyph
= row
->glyphs
[*area
];
1956 end
= glyph
+ row
->used
[*area
];
1958 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1960 x
-= glyph
->pixel_width
;
1970 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1973 *hpos
= glyph
- row
->glyphs
[*area
];
1977 /* Convert frame-relative x/y to coordinates relative to window W.
1978 Takes pseudo-windows into account. */
1981 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1983 if (w
->pseudo_window_p
)
1985 /* A pseudo-window is always full-width, and starts at the
1986 left edge of the frame, plus a frame border. */
1987 struct frame
*f
= XFRAME (w
->frame
);
1988 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1989 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1993 *x
-= WINDOW_LEFT_EDGE_X (w
);
1994 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1998 #ifdef HAVE_WINDOW_SYSTEM
2001 Return in RECTS[] at most N clipping rectangles for glyph string S.
2002 Return the number of stored rectangles. */
2005 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2012 if (s
->row
->full_width_p
)
2014 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2015 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2016 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
2018 /* Unless displaying a mode or menu bar line, which are always
2019 fully visible, clip to the visible part of the row. */
2020 if (s
->w
->pseudo_window_p
)
2021 r
.height
= s
->row
->visible_height
;
2023 r
.height
= s
->height
;
2027 /* This is a text line that may be partially visible. */
2028 r
.x
= window_box_left (s
->w
, s
->area
);
2029 r
.width
= window_box_width (s
->w
, s
->area
);
2030 r
.height
= s
->row
->visible_height
;
2034 if (r
.x
< s
->clip_head
->x
)
2036 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2037 r
.width
-= s
->clip_head
->x
- r
.x
;
2040 r
.x
= s
->clip_head
->x
;
2043 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2045 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2046 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2051 /* If S draws overlapping rows, it's sufficient to use the top and
2052 bottom of the window for clipping because this glyph string
2053 intentionally draws over other lines. */
2054 if (s
->for_overlaps
)
2056 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2057 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2059 /* Alas, the above simple strategy does not work for the
2060 environments with anti-aliased text: if the same text is
2061 drawn onto the same place multiple times, it gets thicker.
2062 If the overlap we are processing is for the erased cursor, we
2063 take the intersection with the rectangle of the cursor. */
2064 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2066 XRectangle rc
, r_save
= r
;
2068 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2069 rc
.y
= s
->w
->phys_cursor
.y
;
2070 rc
.width
= s
->w
->phys_cursor_width
;
2071 rc
.height
= s
->w
->phys_cursor_height
;
2073 x_intersect_rectangles (&r_save
, &rc
, &r
);
2078 /* Don't use S->y for clipping because it doesn't take partially
2079 visible lines into account. For example, it can be negative for
2080 partially visible lines at the top of a window. */
2081 if (!s
->row
->full_width_p
2082 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2083 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2085 r
.y
= max (0, s
->row
->y
);
2088 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2090 /* If drawing the cursor, don't let glyph draw outside its
2091 advertised boundaries. Cleartype does this under some circumstances. */
2092 if (s
->hl
== DRAW_CURSOR
)
2094 struct glyph
*glyph
= s
->first_glyph
;
2099 r
.width
-= s
->x
- r
.x
;
2102 r
.width
= min (r
.width
, glyph
->pixel_width
);
2104 /* If r.y is below window bottom, ensure that we still see a cursor. */
2105 height
= min (glyph
->ascent
+ glyph
->descent
,
2106 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2107 max_y
= window_text_bottom_y (s
->w
) - height
;
2108 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2109 if (s
->ybase
- glyph
->ascent
> max_y
)
2116 /* Don't draw cursor glyph taller than our actual glyph. */
2117 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2118 if (height
< r
.height
)
2120 max_y
= r
.y
+ r
.height
;
2121 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2122 r
.height
= min (max_y
- r
.y
, height
);
2129 XRectangle r_save
= r
;
2131 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2135 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2136 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2138 #ifdef CONVERT_FROM_XRECT
2139 CONVERT_FROM_XRECT (r
, *rects
);
2147 /* If we are processing overlapping and allowed to return
2148 multiple clipping rectangles, we exclude the row of the glyph
2149 string from the clipping rectangle. This is to avoid drawing
2150 the same text on the environment with anti-aliasing. */
2151 #ifdef CONVERT_FROM_XRECT
2154 XRectangle
*rs
= rects
;
2156 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2158 if (s
->for_overlaps
& OVERLAPS_PRED
)
2161 if (r
.y
+ r
.height
> row_y
)
2164 rs
[i
].height
= row_y
- r
.y
;
2170 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2173 if (r
.y
< row_y
+ s
->row
->visible_height
)
2175 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2177 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2178 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2187 #ifdef CONVERT_FROM_XRECT
2188 for (i
= 0; i
< n
; i
++)
2189 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2196 Return in *NR the clipping rectangle for glyph string S. */
2199 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2201 get_glyph_string_clip_rects (s
, nr
, 1);
2206 Return the position and height of the phys cursor in window W.
2207 Set w->phys_cursor_width to width of phys cursor.
2211 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2212 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2214 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2215 int x
, y
, wd
, h
, h0
, y0
;
2217 /* Compute the width of the rectangle to draw. If on a stretch
2218 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2219 rectangle as wide as the glyph, but use a canonical character
2221 wd
= glyph
->pixel_width
- 1;
2222 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2226 x
= w
->phys_cursor
.x
;
2233 if (glyph
->type
== STRETCH_GLYPH
2234 && !x_stretch_cursor_p
)
2235 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2236 w
->phys_cursor_width
= wd
;
2238 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2240 /* If y is below window bottom, ensure that we still see a cursor. */
2241 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2243 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2244 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2246 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2249 h
= max (h
- (y0
- y
) + 1, h0
);
2254 y0
= window_text_bottom_y (w
) - h0
;
2262 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2263 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2268 * Remember which glyph the mouse is over.
2272 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2276 struct glyph_row
*r
, *gr
, *end_row
;
2277 enum window_part part
;
2278 enum glyph_row_area area
;
2279 int x
, y
, width
, height
;
2281 /* Try to determine frame pixel position and size of the glyph under
2282 frame pixel coordinates X/Y on frame F. */
2284 if (!f
->glyphs_initialized_p
2285 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2288 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2289 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2293 w
= XWINDOW (window
);
2294 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2295 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2297 x
= window_relative_x_coord (w
, part
, gx
);
2298 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2300 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2301 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2303 if (w
->pseudo_window_p
)
2306 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2312 case ON_LEFT_MARGIN
:
2313 area
= LEFT_MARGIN_AREA
;
2316 case ON_RIGHT_MARGIN
:
2317 area
= RIGHT_MARGIN_AREA
;
2320 case ON_HEADER_LINE
:
2322 gr
= (part
== ON_HEADER_LINE
2323 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2324 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2327 goto text_glyph_row_found
;
2334 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2335 if (r
->y
+ r
->height
> y
)
2341 text_glyph_row_found
:
2344 struct glyph
*g
= gr
->glyphs
[area
];
2345 struct glyph
*end
= g
+ gr
->used
[area
];
2347 height
= gr
->height
;
2348 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2349 if (gx
+ g
->pixel_width
> x
)
2354 if (g
->type
== IMAGE_GLYPH
)
2356 /* Don't remember when mouse is over image, as
2357 image may have hot-spots. */
2358 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2361 width
= g
->pixel_width
;
2365 /* Use nominal char spacing at end of line. */
2367 gx
+= (x
/ width
) * width
;
2370 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2371 gx
+= window_box_left_offset (w
, area
);
2375 /* Use nominal line height at end of window. */
2376 gx
= (x
/ width
) * width
;
2378 gy
+= (y
/ height
) * height
;
2382 case ON_LEFT_FRINGE
:
2383 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2384 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2385 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2386 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2389 case ON_RIGHT_FRINGE
:
2390 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2391 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2392 : window_box_right_offset (w
, TEXT_AREA
));
2393 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2397 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2399 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2400 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2401 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2403 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2407 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2408 if (r
->y
+ r
->height
> y
)
2415 height
= gr
->height
;
2418 /* Use nominal line height at end of window. */
2420 gy
+= (y
/ height
) * height
;
2427 /* If there is no glyph under the mouse, then we divide the screen
2428 into a grid of the smallest glyph in the frame, and use that
2431 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2432 round down even for negative values. */
2438 gx
= (gx
/ width
) * width
;
2439 gy
= (gy
/ height
) * height
;
2444 gx
+= WINDOW_LEFT_EDGE_X (w
);
2445 gy
+= WINDOW_TOP_EDGE_Y (w
);
2448 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2450 /* Visible feedback for debugging. */
2453 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2454 f
->output_data
.x
->normal_gc
,
2455 gx
, gy
, width
, height
);
2461 #endif /* HAVE_WINDOW_SYSTEM */
2464 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2467 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2468 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2470 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2473 /***********************************************************************
2474 Lisp form evaluation
2475 ***********************************************************************/
2477 /* Error handler for safe_eval and safe_call. */
2480 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2482 add_to_log ("Error during redisplay: %S signaled %S",
2483 Flist (nargs
, args
), arg
);
2487 /* Call function FUNC with the rest of NARGS - 1 arguments
2488 following. Return the result, or nil if something went
2489 wrong. Prevent redisplay during the evaluation. */
2492 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2496 if (inhibit_eval_during_redisplay
)
2502 ptrdiff_t count
= SPECPDL_INDEX ();
2503 struct gcpro gcpro1
;
2504 Lisp_Object
*args
= alloca (nargs
* word_size
);
2507 va_start (ap
, func
);
2508 for (i
= 1; i
< nargs
; i
++)
2509 args
[i
] = va_arg (ap
, Lisp_Object
);
2513 gcpro1
.nvars
= nargs
;
2514 specbind (Qinhibit_redisplay
, Qt
);
2515 /* Use Qt to ensure debugger does not run,
2516 so there is no possibility of wanting to redisplay. */
2517 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2520 val
= unbind_to (count
, val
);
2527 /* Call function FN with one argument ARG.
2528 Return the result, or nil if something went wrong. */
2531 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2533 return safe_call (2, fn
, arg
);
2536 static Lisp_Object Qeval
;
2539 safe_eval (Lisp_Object sexpr
)
2541 return safe_call1 (Qeval
, sexpr
);
2544 /* Call function FN with two arguments ARG1 and ARG2.
2545 Return the result, or nil if something went wrong. */
2548 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2550 return safe_call (3, fn
, arg1
, arg2
);
2555 /***********************************************************************
2557 ***********************************************************************/
2561 /* Define CHECK_IT to perform sanity checks on iterators.
2562 This is for debugging. It is too slow to do unconditionally. */
2565 check_it (struct it
*it
)
2567 if (it
->method
== GET_FROM_STRING
)
2569 eassert (STRINGP (it
->string
));
2570 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2574 eassert (IT_STRING_CHARPOS (*it
) < 0);
2575 if (it
->method
== GET_FROM_BUFFER
)
2577 /* Check that character and byte positions agree. */
2578 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2583 eassert (it
->current
.dpvec_index
>= 0);
2585 eassert (it
->current
.dpvec_index
< 0);
2588 #define CHECK_IT(IT) check_it ((IT))
2592 #define CHECK_IT(IT) (void) 0
2597 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2599 /* Check that the window end of window W is what we expect it
2600 to be---the last row in the current matrix displaying text. */
2603 check_window_end (struct window
*w
)
2605 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2607 struct glyph_row
*row
;
2608 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2610 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2611 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2615 #define CHECK_WINDOW_END(W) check_window_end ((W))
2619 #define CHECK_WINDOW_END(W) (void) 0
2621 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2623 /* Return mark position if current buffer has the region of non-zero length,
2627 markpos_of_region (void)
2629 if (!NILP (Vtransient_mark_mode
)
2630 && !NILP (BVAR (current_buffer
, mark_active
))
2631 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= NULL
)
2633 ptrdiff_t markpos
= XMARKER (BVAR (current_buffer
, mark
))->charpos
;
2641 /***********************************************************************
2642 Iterator initialization
2643 ***********************************************************************/
2645 /* Initialize IT for displaying current_buffer in window W, starting
2646 at character position CHARPOS. CHARPOS < 0 means that no buffer
2647 position is specified which is useful when the iterator is assigned
2648 a position later. BYTEPOS is the byte position corresponding to
2651 If ROW is not null, calls to produce_glyphs with IT as parameter
2652 will produce glyphs in that row.
2654 BASE_FACE_ID is the id of a base face to use. It must be one of
2655 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2656 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2657 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2659 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2660 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2661 will be initialized to use the corresponding mode line glyph row of
2662 the desired matrix of W. */
2665 init_iterator (struct it
*it
, struct window
*w
,
2666 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2667 struct glyph_row
*row
, enum face_id base_face_id
)
2670 enum face_id remapped_base_face_id
= base_face_id
;
2672 /* Some precondition checks. */
2673 eassert (w
!= NULL
&& it
!= NULL
);
2674 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2677 /* If face attributes have been changed since the last redisplay,
2678 free realized faces now because they depend on face definitions
2679 that might have changed. Don't free faces while there might be
2680 desired matrices pending which reference these faces. */
2681 if (face_change_count
&& !inhibit_free_realized_faces
)
2683 face_change_count
= 0;
2684 free_all_realized_faces (Qnil
);
2687 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2688 if (! NILP (Vface_remapping_alist
))
2689 remapped_base_face_id
2690 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2692 /* Use one of the mode line rows of W's desired matrix if
2696 if (base_face_id
== MODE_LINE_FACE_ID
2697 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2698 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2699 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2700 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2704 memset (it
, 0, sizeof *it
);
2705 it
->current
.overlay_string_index
= -1;
2706 it
->current
.dpvec_index
= -1;
2707 it
->base_face_id
= remapped_base_face_id
;
2709 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2710 it
->paragraph_embedding
= L2R
;
2711 it
->bidi_it
.string
.lstring
= Qnil
;
2712 it
->bidi_it
.string
.s
= NULL
;
2713 it
->bidi_it
.string
.bufpos
= 0;
2716 /* The window in which we iterate over current_buffer: */
2717 XSETWINDOW (it
->window
, w
);
2719 it
->f
= XFRAME (w
->frame
);
2723 /* Extra space between lines (on window systems only). */
2724 if (base_face_id
== DEFAULT_FACE_ID
2725 && FRAME_WINDOW_P (it
->f
))
2727 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2728 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2729 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2730 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2731 * FRAME_LINE_HEIGHT (it
->f
));
2732 else if (it
->f
->extra_line_spacing
> 0)
2733 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2734 it
->max_extra_line_spacing
= 0;
2737 /* If realized faces have been removed, e.g. because of face
2738 attribute changes of named faces, recompute them. When running
2739 in batch mode, the face cache of the initial frame is null. If
2740 we happen to get called, make a dummy face cache. */
2741 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2742 init_frame_faces (it
->f
);
2743 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2744 recompute_basic_faces (it
->f
);
2746 /* Current value of the `slice', `space-width', and 'height' properties. */
2747 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2748 it
->space_width
= Qnil
;
2749 it
->font_height
= Qnil
;
2750 it
->override_ascent
= -1;
2752 /* Are control characters displayed as `^C'? */
2753 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2755 /* -1 means everything between a CR and the following line end
2756 is invisible. >0 means lines indented more than this value are
2758 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2760 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2762 : (!NILP (BVAR (current_buffer
, selective_display
))
2764 it
->selective_display_ellipsis_p
2765 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2767 /* Display table to use. */
2768 it
->dp
= window_display_table (w
);
2770 /* Are multibyte characters enabled in current_buffer? */
2771 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2773 /* If visible region is of non-zero length, set IT->region_beg_charpos
2774 and IT->region_end_charpos to the start and end of a visible region
2775 in window IT->w. Set both to -1 to indicate no region. */
2776 markpos
= markpos_of_region ();
2778 /* Maybe highlight only in selected window. */
2779 && (/* Either show region everywhere. */
2780 highlight_nonselected_windows
2781 /* Or show region in the selected window. */
2782 || w
== XWINDOW (selected_window
)
2783 /* Or show the region if we are in the mini-buffer and W is
2784 the window the mini-buffer refers to. */
2785 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2786 && WINDOWP (minibuf_selected_window
)
2787 && w
== XWINDOW (minibuf_selected_window
))))
2789 it
->region_beg_charpos
= min (PT
, markpos
);
2790 it
->region_end_charpos
= max (PT
, markpos
);
2793 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2795 /* Get the position at which the redisplay_end_trigger hook should
2796 be run, if it is to be run at all. */
2797 if (MARKERP (w
->redisplay_end_trigger
)
2798 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2799 it
->redisplay_end_trigger_charpos
2800 = marker_position (w
->redisplay_end_trigger
);
2801 else if (INTEGERP (w
->redisplay_end_trigger
))
2802 it
->redisplay_end_trigger_charpos
=
2803 clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
), PTRDIFF_MAX
);
2805 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2807 /* Are lines in the display truncated? */
2808 if (base_face_id
!= DEFAULT_FACE_ID
2810 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2811 && ((!NILP (Vtruncate_partial_width_windows
)
2812 && !INTEGERP (Vtruncate_partial_width_windows
))
2813 || (INTEGERP (Vtruncate_partial_width_windows
)
2814 && (WINDOW_TOTAL_COLS (it
->w
)
2815 < XINT (Vtruncate_partial_width_windows
))))))
2816 it
->line_wrap
= TRUNCATE
;
2817 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2818 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2819 ? WINDOW_WRAP
: WORD_WRAP
;
2821 it
->line_wrap
= TRUNCATE
;
2823 /* Get dimensions of truncation and continuation glyphs. These are
2824 displayed as fringe bitmaps under X, but we need them for such
2825 frames when the fringes are turned off. But leave the dimensions
2826 zero for tooltip frames, as these glyphs look ugly there and also
2827 sabotage calculations of tooltip dimensions in x-show-tip. */
2828 #ifdef HAVE_WINDOW_SYSTEM
2829 if (!(FRAME_WINDOW_P (it
->f
)
2830 && FRAMEP (tip_frame
)
2831 && it
->f
== XFRAME (tip_frame
)))
2834 if (it
->line_wrap
== TRUNCATE
)
2836 /* We will need the truncation glyph. */
2837 eassert (it
->glyph_row
== NULL
);
2838 produce_special_glyphs (it
, IT_TRUNCATION
);
2839 it
->truncation_pixel_width
= it
->pixel_width
;
2843 /* We will need the continuation glyph. */
2844 eassert (it
->glyph_row
== NULL
);
2845 produce_special_glyphs (it
, IT_CONTINUATION
);
2846 it
->continuation_pixel_width
= it
->pixel_width
;
2850 /* Reset these values to zero because the produce_special_glyphs
2851 above has changed them. */
2852 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2853 it
->phys_ascent
= it
->phys_descent
= 0;
2855 /* Set this after getting the dimensions of truncation and
2856 continuation glyphs, so that we don't produce glyphs when calling
2857 produce_special_glyphs, above. */
2858 it
->glyph_row
= row
;
2859 it
->area
= TEXT_AREA
;
2861 /* Forget any previous info about this row being reversed. */
2863 it
->glyph_row
->reversed_p
= 0;
2865 /* Get the dimensions of the display area. The display area
2866 consists of the visible window area plus a horizontally scrolled
2867 part to the left of the window. All x-values are relative to the
2868 start of this total display area. */
2869 if (base_face_id
!= DEFAULT_FACE_ID
)
2871 /* Mode lines, menu bar in terminal frames. */
2872 it
->first_visible_x
= 0;
2873 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2877 it
->first_visible_x
=
2878 window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2879 it
->last_visible_x
= (it
->first_visible_x
2880 + window_box_width (w
, TEXT_AREA
));
2882 /* If we truncate lines, leave room for the truncation glyph(s) at
2883 the right margin. Otherwise, leave room for the continuation
2884 glyph(s). Done only if the window has no fringes. Since we
2885 don't know at this point whether there will be any R2L lines in
2886 the window, we reserve space for truncation/continuation glyphs
2887 even if only one of the fringes is absent. */
2888 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
2889 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
2891 if (it
->line_wrap
== TRUNCATE
)
2892 it
->last_visible_x
-= it
->truncation_pixel_width
;
2894 it
->last_visible_x
-= it
->continuation_pixel_width
;
2897 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2898 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2901 /* Leave room for a border glyph. */
2902 if (!FRAME_WINDOW_P (it
->f
)
2903 && !WINDOW_RIGHTMOST_P (it
->w
))
2904 it
->last_visible_x
-= 1;
2906 it
->last_visible_y
= window_text_bottom_y (w
);
2908 /* For mode lines and alike, arrange for the first glyph having a
2909 left box line if the face specifies a box. */
2910 if (base_face_id
!= DEFAULT_FACE_ID
)
2914 it
->face_id
= remapped_base_face_id
;
2916 /* If we have a boxed mode line, make the first character appear
2917 with a left box line. */
2918 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2919 if (face
->box
!= FACE_NO_BOX
)
2920 it
->start_of_box_run_p
= 1;
2923 /* If a buffer position was specified, set the iterator there,
2924 getting overlays and face properties from that position. */
2925 if (charpos
>= BUF_BEG (current_buffer
))
2927 it
->end_charpos
= ZV
;
2928 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2929 IT_CHARPOS (*it
) = charpos
;
2930 IT_BYTEPOS (*it
) = bytepos
;
2932 /* We will rely on `reseat' to set this up properly, via
2933 handle_face_prop. */
2934 it
->face_id
= it
->base_face_id
;
2936 it
->start
= it
->current
;
2937 /* Do we need to reorder bidirectional text? Not if this is a
2938 unibyte buffer: by definition, none of the single-byte
2939 characters are strong R2L, so no reordering is needed. And
2940 bidi.c doesn't support unibyte buffers anyway. Also, don't
2941 reorder while we are loading loadup.el, since the tables of
2942 character properties needed for reordering are not yet
2946 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2949 /* If we are to reorder bidirectional text, init the bidi
2953 /* Note the paragraph direction that this buffer wants to
2955 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2957 it
->paragraph_embedding
= L2R
;
2958 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2960 it
->paragraph_embedding
= R2L
;
2962 it
->paragraph_embedding
= NEUTRAL_DIR
;
2963 bidi_unshelve_cache (NULL
, 0);
2964 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2968 /* Compute faces etc. */
2969 reseat (it
, it
->current
.pos
, 1);
2976 /* Initialize IT for the display of window W with window start POS. */
2979 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2981 struct glyph_row
*row
;
2982 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2984 row
= w
->desired_matrix
->rows
+ first_vpos
;
2985 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2986 it
->first_vpos
= first_vpos
;
2988 /* Don't reseat to previous visible line start if current start
2989 position is in a string or image. */
2990 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2992 int start_at_line_beg_p
;
2993 int first_y
= it
->current_y
;
2995 /* If window start is not at a line start, skip forward to POS to
2996 get the correct continuation lines width. */
2997 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2998 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2999 if (!start_at_line_beg_p
)
3003 reseat_at_previous_visible_line_start (it
);
3004 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3006 new_x
= it
->current_x
+ it
->pixel_width
;
3008 /* If lines are continued, this line may end in the middle
3009 of a multi-glyph character (e.g. a control character
3010 displayed as \003, or in the middle of an overlay
3011 string). In this case move_it_to above will not have
3012 taken us to the start of the continuation line but to the
3013 end of the continued line. */
3014 if (it
->current_x
> 0
3015 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3016 && (/* And glyph doesn't fit on the line. */
3017 new_x
> it
->last_visible_x
3018 /* Or it fits exactly and we're on a window
3020 || (new_x
== it
->last_visible_x
3021 && FRAME_WINDOW_P (it
->f
)
3022 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3023 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3024 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3026 if ((it
->current
.dpvec_index
>= 0
3027 || it
->current
.overlay_string_index
>= 0)
3028 /* If we are on a newline from a display vector or
3029 overlay string, then we are already at the end of
3030 a screen line; no need to go to the next line in
3031 that case, as this line is not really continued.
3032 (If we do go to the next line, C-e will not DTRT.) */
3035 set_iterator_to_next (it
, 1);
3036 move_it_in_display_line_to (it
, -1, -1, 0);
3039 it
->continuation_lines_width
+= it
->current_x
;
3041 /* If the character at POS is displayed via a display
3042 vector, move_it_to above stops at the final glyph of
3043 IT->dpvec. To make the caller redisplay that character
3044 again (a.k.a. start at POS), we need to reset the
3045 dpvec_index to the beginning of IT->dpvec. */
3046 else if (it
->current
.dpvec_index
>= 0)
3047 it
->current
.dpvec_index
= 0;
3049 /* We're starting a new display line, not affected by the
3050 height of the continued line, so clear the appropriate
3051 fields in the iterator structure. */
3052 it
->max_ascent
= it
->max_descent
= 0;
3053 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3055 it
->current_y
= first_y
;
3057 it
->current_x
= it
->hpos
= 0;
3063 /* Return 1 if POS is a position in ellipses displayed for invisible
3064 text. W is the window we display, for text property lookup. */
3067 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3069 Lisp_Object prop
, window
;
3071 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3073 /* If POS specifies a position in a display vector, this might
3074 be for an ellipsis displayed for invisible text. We won't
3075 get the iterator set up for delivering that ellipsis unless
3076 we make sure that it gets aware of the invisible text. */
3077 if (pos
->dpvec_index
>= 0
3078 && pos
->overlay_string_index
< 0
3079 && CHARPOS (pos
->string_pos
) < 0
3081 && (XSETWINDOW (window
, w
),
3082 prop
= Fget_char_property (make_number (charpos
),
3083 Qinvisible
, window
),
3084 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3086 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3088 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3095 /* Initialize IT for stepping through current_buffer in window W,
3096 starting at position POS that includes overlay string and display
3097 vector/ control character translation position information. Value
3098 is zero if there are overlay strings with newlines at POS. */
3101 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3103 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3104 int i
, overlay_strings_with_newlines
= 0;
3106 /* If POS specifies a position in a display vector, this might
3107 be for an ellipsis displayed for invisible text. We won't
3108 get the iterator set up for delivering that ellipsis unless
3109 we make sure that it gets aware of the invisible text. */
3110 if (in_ellipses_for_invisible_text_p (pos
, w
))
3116 /* Keep in mind: the call to reseat in init_iterator skips invisible
3117 text, so we might end up at a position different from POS. This
3118 is only a problem when POS is a row start after a newline and an
3119 overlay starts there with an after-string, and the overlay has an
3120 invisible property. Since we don't skip invisible text in
3121 display_line and elsewhere immediately after consuming the
3122 newline before the row start, such a POS will not be in a string,
3123 but the call to init_iterator below will move us to the
3125 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3127 /* This only scans the current chunk -- it should scan all chunks.
3128 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3129 to 16 in 22.1 to make this a lesser problem. */
3130 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3132 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3133 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3135 while (s
< e
&& *s
!= '\n')
3140 overlay_strings_with_newlines
= 1;
3145 /* If position is within an overlay string, set up IT to the right
3147 if (pos
->overlay_string_index
>= 0)
3151 /* If the first overlay string happens to have a `display'
3152 property for an image, the iterator will be set up for that
3153 image, and we have to undo that setup first before we can
3154 correct the overlay string index. */
3155 if (it
->method
== GET_FROM_IMAGE
)
3158 /* We already have the first chunk of overlay strings in
3159 IT->overlay_strings. Load more until the one for
3160 pos->overlay_string_index is in IT->overlay_strings. */
3161 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3163 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3164 it
->current
.overlay_string_index
= 0;
3167 load_overlay_strings (it
, 0);
3168 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3172 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3173 relative_index
= (it
->current
.overlay_string_index
3174 % OVERLAY_STRING_CHUNK_SIZE
);
3175 it
->string
= it
->overlay_strings
[relative_index
];
3176 eassert (STRINGP (it
->string
));
3177 it
->current
.string_pos
= pos
->string_pos
;
3178 it
->method
= GET_FROM_STRING
;
3179 it
->end_charpos
= SCHARS (it
->string
);
3180 /* Set up the bidi iterator for this overlay string. */
3183 it
->bidi_it
.string
.lstring
= it
->string
;
3184 it
->bidi_it
.string
.s
= NULL
;
3185 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3186 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3187 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3188 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3189 it
->bidi_it
.w
= it
->w
;
3190 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3191 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3193 /* Synchronize the state of the bidi iterator with
3194 pos->string_pos. For any string position other than
3195 zero, this will be done automagically when we resume
3196 iteration over the string and get_visually_first_element
3197 is called. But if string_pos is zero, and the string is
3198 to be reordered for display, we need to resync manually,
3199 since it could be that the iteration state recorded in
3200 pos ended at string_pos of 0 moving backwards in string. */
3201 if (CHARPOS (pos
->string_pos
) == 0)
3203 get_visually_first_element (it
);
3204 if (IT_STRING_CHARPOS (*it
) != 0)
3207 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3208 bidi_move_to_visually_next (&it
->bidi_it
);
3209 } while (it
->bidi_it
.charpos
!= 0);
3211 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3212 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3216 if (CHARPOS (pos
->string_pos
) >= 0)
3218 /* Recorded position is not in an overlay string, but in another
3219 string. This can only be a string from a `display' property.
3220 IT should already be filled with that string. */
3221 it
->current
.string_pos
= pos
->string_pos
;
3222 eassert (STRINGP (it
->string
));
3224 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3225 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3228 /* Restore position in display vector translations, control
3229 character translations or ellipses. */
3230 if (pos
->dpvec_index
>= 0)
3232 if (it
->dpvec
== NULL
)
3233 get_next_display_element (it
);
3234 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3235 it
->current
.dpvec_index
= pos
->dpvec_index
;
3239 return !overlay_strings_with_newlines
;
3243 /* Initialize IT for stepping through current_buffer in window W
3244 starting at ROW->start. */
3247 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3249 init_from_display_pos (it
, w
, &row
->start
);
3250 it
->start
= row
->start
;
3251 it
->continuation_lines_width
= row
->continuation_lines_width
;
3256 /* Initialize IT for stepping through current_buffer in window W
3257 starting in the line following ROW, i.e. starting at ROW->end.
3258 Value is zero if there are overlay strings with newlines at ROW's
3262 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3266 if (init_from_display_pos (it
, w
, &row
->end
))
3268 if (row
->continued_p
)
3269 it
->continuation_lines_width
3270 = row
->continuation_lines_width
+ row
->pixel_width
;
3281 /***********************************************************************
3283 ***********************************************************************/
3285 /* Called when IT reaches IT->stop_charpos. Handle text property and
3286 overlay changes. Set IT->stop_charpos to the next position where
3290 handle_stop (struct it
*it
)
3292 enum prop_handled handled
;
3293 int handle_overlay_change_p
;
3297 it
->current
.dpvec_index
= -1;
3298 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3299 it
->ignore_overlay_strings_at_pos_p
= 0;
3302 /* Use face of preceding text for ellipsis (if invisible) */
3303 if (it
->selective_display_ellipsis_p
)
3304 it
->saved_face_id
= it
->face_id
;
3308 handled
= HANDLED_NORMALLY
;
3310 /* Call text property handlers. */
3311 for (p
= it_props
; p
->handler
; ++p
)
3313 handled
= p
->handler (it
);
3315 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3317 else if (handled
== HANDLED_RETURN
)
3319 /* We still want to show before and after strings from
3320 overlays even if the actual buffer text is replaced. */
3321 if (!handle_overlay_change_p
3323 /* Don't call get_overlay_strings_1 if we already
3324 have overlay strings loaded, because doing so
3325 will load them again and push the iterator state
3326 onto the stack one more time, which is not
3327 expected by the rest of the code that processes
3329 || (it
->current
.overlay_string_index
< 0
3330 ? !get_overlay_strings_1 (it
, 0, 0)
3334 setup_for_ellipsis (it
, 0);
3335 /* When handling a display spec, we might load an
3336 empty string. In that case, discard it here. We
3337 used to discard it in handle_single_display_spec,
3338 but that causes get_overlay_strings_1, above, to
3339 ignore overlay strings that we must check. */
3340 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3344 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3348 it
->ignore_overlay_strings_at_pos_p
= 1;
3349 it
->string_from_display_prop_p
= 0;
3350 it
->from_disp_prop_p
= 0;
3351 handle_overlay_change_p
= 0;
3353 handled
= HANDLED_RECOMPUTE_PROPS
;
3356 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3357 handle_overlay_change_p
= 0;
3360 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3362 /* Don't check for overlay strings below when set to deliver
3363 characters from a display vector. */
3364 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3365 handle_overlay_change_p
= 0;
3367 /* Handle overlay changes.
3368 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3369 if it finds overlays. */
3370 if (handle_overlay_change_p
)
3371 handled
= handle_overlay_change (it
);
3376 setup_for_ellipsis (it
, 0);
3380 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3382 /* Determine where to stop next. */
3383 if (handled
== HANDLED_NORMALLY
)
3384 compute_stop_pos (it
);
3388 /* Compute IT->stop_charpos from text property and overlay change
3389 information for IT's current position. */
3392 compute_stop_pos (struct it
*it
)
3394 register INTERVAL iv
, next_iv
;
3395 Lisp_Object object
, limit
, position
;
3396 ptrdiff_t charpos
, bytepos
;
3398 if (STRINGP (it
->string
))
3400 /* Strings are usually short, so don't limit the search for
3402 it
->stop_charpos
= it
->end_charpos
;
3403 object
= it
->string
;
3405 charpos
= IT_STRING_CHARPOS (*it
);
3406 bytepos
= IT_STRING_BYTEPOS (*it
);
3412 /* If end_charpos is out of range for some reason, such as a
3413 misbehaving display function, rationalize it (Bug#5984). */
3414 if (it
->end_charpos
> ZV
)
3415 it
->end_charpos
= ZV
;
3416 it
->stop_charpos
= it
->end_charpos
;
3418 /* If next overlay change is in front of the current stop pos
3419 (which is IT->end_charpos), stop there. Note: value of
3420 next_overlay_change is point-max if no overlay change
3422 charpos
= IT_CHARPOS (*it
);
3423 bytepos
= IT_BYTEPOS (*it
);
3424 pos
= next_overlay_change (charpos
);
3425 if (pos
< it
->stop_charpos
)
3426 it
->stop_charpos
= pos
;
3428 /* If showing the region, we have to stop at the region
3429 start or end because the face might change there. */
3430 if (it
->region_beg_charpos
> 0)
3432 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3433 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3434 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3435 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3438 /* Set up variables for computing the stop position from text
3439 property changes. */
3440 XSETBUFFER (object
, current_buffer
);
3441 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3444 /* Get the interval containing IT's position. Value is a null
3445 interval if there isn't such an interval. */
3446 position
= make_number (charpos
);
3447 iv
= validate_interval_range (object
, &position
, &position
, 0);
3450 Lisp_Object values_here
[LAST_PROP_IDX
];
3453 /* Get properties here. */
3454 for (p
= it_props
; p
->handler
; ++p
)
3455 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3457 /* Look for an interval following iv that has different
3459 for (next_iv
= next_interval (iv
);
3462 || XFASTINT (limit
) > next_iv
->position
));
3463 next_iv
= next_interval (next_iv
))
3465 for (p
= it_props
; p
->handler
; ++p
)
3467 Lisp_Object new_value
;
3469 new_value
= textget (next_iv
->plist
, *p
->name
);
3470 if (!EQ (values_here
[p
->idx
], new_value
))
3480 if (INTEGERP (limit
)
3481 && next_iv
->position
>= XFASTINT (limit
))
3482 /* No text property change up to limit. */
3483 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3485 /* Text properties change in next_iv. */
3486 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3490 if (it
->cmp_it
.id
< 0)
3492 ptrdiff_t stoppos
= it
->end_charpos
;
3494 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3496 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3497 stoppos
, it
->string
);
3500 eassert (STRINGP (it
->string
)
3501 || (it
->stop_charpos
>= BEGV
3502 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3506 /* Return the position of the next overlay change after POS in
3507 current_buffer. Value is point-max if no overlay change
3508 follows. This is like `next-overlay-change' but doesn't use
3512 next_overlay_change (ptrdiff_t pos
)
3514 ptrdiff_t i
, noverlays
;
3516 Lisp_Object
*overlays
;
3518 /* Get all overlays at the given position. */
3519 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3521 /* If any of these overlays ends before endpos,
3522 use its ending point instead. */
3523 for (i
= 0; i
< noverlays
; ++i
)
3528 oend
= OVERLAY_END (overlays
[i
]);
3529 oendpos
= OVERLAY_POSITION (oend
);
3530 endpos
= min (endpos
, oendpos
);
3536 /* How many characters forward to search for a display property or
3537 display string. Searching too far forward makes the bidi display
3538 sluggish, especially in small windows. */
3539 #define MAX_DISP_SCAN 250
3541 /* Return the character position of a display string at or after
3542 position specified by POSITION. If no display string exists at or
3543 after POSITION, return ZV. A display string is either an overlay
3544 with `display' property whose value is a string, or a `display'
3545 text property whose value is a string. STRING is data about the
3546 string to iterate; if STRING->lstring is nil, we are iterating a
3547 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3548 on a GUI frame. DISP_PROP is set to zero if we searched
3549 MAX_DISP_SCAN characters forward without finding any display
3550 strings, non-zero otherwise. It is set to 2 if the display string
3551 uses any kind of `(space ...)' spec that will produce a stretch of
3552 white space in the text area. */
3554 compute_display_string_pos (struct text_pos
*position
,
3555 struct bidi_string_data
*string
,
3557 int frame_window_p
, int *disp_prop
)
3559 /* OBJECT = nil means current buffer. */
3560 Lisp_Object object
, object1
;
3561 Lisp_Object pos
, spec
, limpos
;
3562 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3563 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3564 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3565 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3567 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3568 struct text_pos tpos
;
3571 if (string
&& STRINGP (string
->lstring
))
3572 object1
= object
= string
->lstring
;
3573 else if (w
&& !string_p
)
3575 XSETWINDOW (object
, w
);
3579 object1
= object
= Qnil
;
3584 /* We don't support display properties whose values are strings
3585 that have display string properties. */
3586 || string
->from_disp_str
3587 /* C strings cannot have display properties. */
3588 || (string
->s
&& !STRINGP (object
)))
3594 /* If the character at CHARPOS is where the display string begins,
3596 pos
= make_number (charpos
);
3597 if (STRINGP (object
))
3598 bufpos
= string
->bufpos
;
3602 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3604 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3607 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3615 /* Look forward for the first character with a `display' property
3616 that will replace the underlying text when displayed. */
3617 limpos
= make_number (lim
);
3619 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3620 CHARPOS (tpos
) = XFASTINT (pos
);
3621 if (CHARPOS (tpos
) >= lim
)
3626 if (STRINGP (object
))
3627 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3629 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3630 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3631 if (!STRINGP (object
))
3632 bufpos
= CHARPOS (tpos
);
3633 } while (NILP (spec
)
3634 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3635 bufpos
, frame_window_p
)));
3639 return CHARPOS (tpos
);
3642 /* Return the character position of the end of the display string that
3643 started at CHARPOS. If there's no display string at CHARPOS,
3644 return -1. A display string is either an overlay with `display'
3645 property whose value is a string or a `display' text property whose
3646 value is a string. */
3648 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3650 /* OBJECT = nil means current buffer. */
3651 Lisp_Object object
=
3652 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3653 Lisp_Object pos
= make_number (charpos
);
3655 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3657 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3660 /* It could happen that the display property or overlay was removed
3661 since we found it in compute_display_string_pos above. One way
3662 this can happen is if JIT font-lock was called (through
3663 handle_fontified_prop), and jit-lock-functions remove text
3664 properties or overlays from the portion of buffer that includes
3665 CHARPOS. Muse mode is known to do that, for example. In this
3666 case, we return -1 to the caller, to signal that no display
3667 string is actually present at CHARPOS. See bidi_fetch_char for
3668 how this is handled.
3670 An alternative would be to never look for display properties past
3671 it->stop_charpos. But neither compute_display_string_pos nor
3672 bidi_fetch_char that calls it know or care where the next
3674 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3677 /* Look forward for the first character where the `display' property
3679 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3681 return XFASTINT (pos
);
3686 /***********************************************************************
3688 ***********************************************************************/
3690 /* Handle changes in the `fontified' property of the current buffer by
3691 calling hook functions from Qfontification_functions to fontify
3694 static enum prop_handled
3695 handle_fontified_prop (struct it
*it
)
3697 Lisp_Object prop
, pos
;
3698 enum prop_handled handled
= HANDLED_NORMALLY
;
3700 if (!NILP (Vmemory_full
))
3703 /* Get the value of the `fontified' property at IT's current buffer
3704 position. (The `fontified' property doesn't have a special
3705 meaning in strings.) If the value is nil, call functions from
3706 Qfontification_functions. */
3707 if (!STRINGP (it
->string
)
3709 && !NILP (Vfontification_functions
)
3710 && !NILP (Vrun_hooks
)
3711 && (pos
= make_number (IT_CHARPOS (*it
)),
3712 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3713 /* Ignore the special cased nil value always present at EOB since
3714 no amount of fontifying will be able to change it. */
3715 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3717 ptrdiff_t count
= SPECPDL_INDEX ();
3719 struct buffer
*obuf
= current_buffer
;
3720 int begv
= BEGV
, zv
= ZV
;
3721 int old_clip_changed
= current_buffer
->clip_changed
;
3723 val
= Vfontification_functions
;
3724 specbind (Qfontification_functions
, Qnil
);
3726 eassert (it
->end_charpos
== ZV
);
3728 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3729 safe_call1 (val
, pos
);
3732 Lisp_Object fns
, fn
;
3733 struct gcpro gcpro1
, gcpro2
;
3738 for (; CONSP (val
); val
= XCDR (val
))
3744 /* A value of t indicates this hook has a local
3745 binding; it means to run the global binding too.
3746 In a global value, t should not occur. If it
3747 does, we must ignore it to avoid an endless
3749 for (fns
= Fdefault_value (Qfontification_functions
);
3755 safe_call1 (fn
, pos
);
3759 safe_call1 (fn
, pos
);
3765 unbind_to (count
, Qnil
);
3767 /* Fontification functions routinely call `save-restriction'.
3768 Normally, this tags clip_changed, which can confuse redisplay
3769 (see discussion in Bug#6671). Since we don't perform any
3770 special handling of fontification changes in the case where
3771 `save-restriction' isn't called, there's no point doing so in
3772 this case either. So, if the buffer's restrictions are
3773 actually left unchanged, reset clip_changed. */
3774 if (obuf
== current_buffer
)
3776 if (begv
== BEGV
&& zv
== ZV
)
3777 current_buffer
->clip_changed
= old_clip_changed
;
3779 /* There isn't much we can reasonably do to protect against
3780 misbehaving fontification, but here's a fig leaf. */
3781 else if (BUFFER_LIVE_P (obuf
))
3782 set_buffer_internal_1 (obuf
);
3784 /* The fontification code may have added/removed text.
3785 It could do even a lot worse, but let's at least protect against
3786 the most obvious case where only the text past `pos' gets changed',
3787 as is/was done in grep.el where some escapes sequences are turned
3788 into face properties (bug#7876). */
3789 it
->end_charpos
= ZV
;
3791 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3792 something. This avoids an endless loop if they failed to
3793 fontify the text for which reason ever. */
3794 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3795 handled
= HANDLED_RECOMPUTE_PROPS
;
3803 /***********************************************************************
3805 ***********************************************************************/
3807 /* Set up iterator IT from face properties at its current position.
3808 Called from handle_stop. */
3810 static enum prop_handled
3811 handle_face_prop (struct it
*it
)
3814 ptrdiff_t next_stop
;
3816 if (!STRINGP (it
->string
))
3819 = face_at_buffer_position (it
->w
,
3821 it
->region_beg_charpos
,
3822 it
->region_end_charpos
,
3825 + TEXT_PROP_DISTANCE_LIMIT
),
3826 0, it
->base_face_id
);
3828 /* Is this a start of a run of characters with box face?
3829 Caveat: this can be called for a freshly initialized
3830 iterator; face_id is -1 in this case. We know that the new
3831 face will not change until limit, i.e. if the new face has a
3832 box, all characters up to limit will have one. But, as
3833 usual, we don't know whether limit is really the end. */
3834 if (new_face_id
!= it
->face_id
)
3836 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3837 /* If it->face_id is -1, old_face below will be NULL, see
3838 the definition of FACE_FROM_ID. This will happen if this
3839 is the initial call that gets the face. */
3840 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3842 /* If the value of face_id of the iterator is -1, we have to
3843 look in front of IT's position and see whether there is a
3844 face there that's different from new_face_id. */
3845 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3847 int prev_face_id
= face_before_it_pos (it
);
3849 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3852 /* If the new face has a box, but the old face does not,
3853 this is the start of a run of characters with box face,
3854 i.e. this character has a shadow on the left side. */
3855 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3856 && (old_face
== NULL
|| !old_face
->box
));
3857 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3865 Lisp_Object from_overlay
3866 = (it
->current
.overlay_string_index
>= 0
3867 ? it
->string_overlays
[it
->current
.overlay_string_index
3868 % OVERLAY_STRING_CHUNK_SIZE
]
3871 /* See if we got to this string directly or indirectly from
3872 an overlay property. That includes the before-string or
3873 after-string of an overlay, strings in display properties
3874 provided by an overlay, their text properties, etc.
3876 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3877 if (! NILP (from_overlay
))
3878 for (i
= it
->sp
- 1; i
>= 0; i
--)
3880 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3882 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3883 % OVERLAY_STRING_CHUNK_SIZE
];
3884 else if (! NILP (it
->stack
[i
].from_overlay
))
3885 from_overlay
= it
->stack
[i
].from_overlay
;
3887 if (!NILP (from_overlay
))
3891 if (! NILP (from_overlay
))
3893 bufpos
= IT_CHARPOS (*it
);
3894 /* For a string from an overlay, the base face depends
3895 only on text properties and ignores overlays. */
3897 = face_for_overlay_string (it
->w
,
3899 it
->region_beg_charpos
,
3900 it
->region_end_charpos
,
3903 + TEXT_PROP_DISTANCE_LIMIT
),
3911 /* For strings from a `display' property, use the face at
3912 IT's current buffer position as the base face to merge
3913 with, so that overlay strings appear in the same face as
3914 surrounding text, unless they specify their own faces.
3915 For strings from wrap-prefix and line-prefix properties,
3916 use the default face, possibly remapped via
3917 Vface_remapping_alist. */
3918 base_face_id
= it
->string_from_prefix_prop_p
3919 ? (!NILP (Vface_remapping_alist
)
3920 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3922 : underlying_face_id (it
);
3925 new_face_id
= face_at_string_position (it
->w
,
3927 IT_STRING_CHARPOS (*it
),
3929 it
->region_beg_charpos
,
3930 it
->region_end_charpos
,
3934 /* Is this a start of a run of characters with box? Caveat:
3935 this can be called for a freshly allocated iterator; face_id
3936 is -1 is this case. We know that the new face will not
3937 change until the next check pos, i.e. if the new face has a
3938 box, all characters up to that position will have a
3939 box. But, as usual, we don't know whether that position
3940 is really the end. */
3941 if (new_face_id
!= it
->face_id
)
3943 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3944 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3946 /* If new face has a box but old face hasn't, this is the
3947 start of a run of characters with box, i.e. it has a
3948 shadow on the left side. */
3949 it
->start_of_box_run_p
3950 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3951 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3955 it
->face_id
= new_face_id
;
3956 return HANDLED_NORMALLY
;
3960 /* Return the ID of the face ``underlying'' IT's current position,
3961 which is in a string. If the iterator is associated with a
3962 buffer, return the face at IT's current buffer position.
3963 Otherwise, use the iterator's base_face_id. */
3966 underlying_face_id (struct it
*it
)
3968 int face_id
= it
->base_face_id
, i
;
3970 eassert (STRINGP (it
->string
));
3972 for (i
= it
->sp
- 1; i
>= 0; --i
)
3973 if (NILP (it
->stack
[i
].string
))
3974 face_id
= it
->stack
[i
].face_id
;
3980 /* Compute the face one character before or after the current position
3981 of IT, in the visual order. BEFORE_P non-zero means get the face
3982 in front (to the left in L2R paragraphs, to the right in R2L
3983 paragraphs) of IT's screen position. Value is the ID of the face. */
3986 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3989 ptrdiff_t next_check_charpos
;
3991 void *it_copy_data
= NULL
;
3993 eassert (it
->s
== NULL
);
3995 if (STRINGP (it
->string
))
3997 ptrdiff_t bufpos
, charpos
;
4000 /* No face change past the end of the string (for the case
4001 we are padding with spaces). No face change before the
4003 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4004 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4009 /* Set charpos to the position before or after IT's current
4010 position, in the logical order, which in the non-bidi
4011 case is the same as the visual order. */
4013 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4014 else if (it
->what
== IT_COMPOSITION
)
4015 /* For composition, we must check the character after the
4017 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4019 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4025 /* With bidi iteration, the character before the current
4026 in the visual order cannot be found by simple
4027 iteration, because "reverse" reordering is not
4028 supported. Instead, we need to use the move_it_*
4029 family of functions. */
4030 /* Ignore face changes before the first visible
4031 character on this display line. */
4032 if (it
->current_x
<= it
->first_visible_x
)
4034 SAVE_IT (it_copy
, *it
, it_copy_data
);
4035 /* Implementation note: Since move_it_in_display_line
4036 works in the iterator geometry, and thinks the first
4037 character is always the leftmost, even in R2L lines,
4038 we don't need to distinguish between the R2L and L2R
4040 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4041 it_copy
.current_x
- 1, MOVE_TO_X
);
4042 charpos
= IT_STRING_CHARPOS (it_copy
);
4043 RESTORE_IT (it
, it
, it_copy_data
);
4047 /* Set charpos to the string position of the character
4048 that comes after IT's current position in the visual
4050 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4054 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4056 charpos
= it_copy
.bidi_it
.charpos
;
4059 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4061 if (it
->current
.overlay_string_index
>= 0)
4062 bufpos
= IT_CHARPOS (*it
);
4066 base_face_id
= underlying_face_id (it
);
4068 /* Get the face for ASCII, or unibyte. */
4069 face_id
= face_at_string_position (it
->w
,
4073 it
->region_beg_charpos
,
4074 it
->region_end_charpos
,
4075 &next_check_charpos
,
4078 /* Correct the face for charsets different from ASCII. Do it
4079 for the multibyte case only. The face returned above is
4080 suitable for unibyte text if IT->string is unibyte. */
4081 if (STRING_MULTIBYTE (it
->string
))
4083 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4084 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4086 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4088 c
= string_char_and_length (p
, &len
);
4089 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4094 struct text_pos pos
;
4096 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4097 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4100 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4101 pos
= it
->current
.pos
;
4106 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4109 if (it
->what
== IT_COMPOSITION
)
4111 /* For composition, we must check the position after
4113 pos
.charpos
+= it
->cmp_it
.nchars
;
4114 pos
.bytepos
+= it
->len
;
4117 INC_TEXT_POS (pos
, it
->multibyte_p
);
4124 /* With bidi iteration, the character before the current
4125 in the visual order cannot be found by simple
4126 iteration, because "reverse" reordering is not
4127 supported. Instead, we need to use the move_it_*
4128 family of functions. */
4129 /* Ignore face changes before the first visible
4130 character on this display line. */
4131 if (it
->current_x
<= it
->first_visible_x
)
4133 SAVE_IT (it_copy
, *it
, it_copy_data
);
4134 /* Implementation note: Since move_it_in_display_line
4135 works in the iterator geometry, and thinks the first
4136 character is always the leftmost, even in R2L lines,
4137 we don't need to distinguish between the R2L and L2R
4139 move_it_in_display_line (&it_copy
, ZV
,
4140 it_copy
.current_x
- 1, MOVE_TO_X
);
4141 pos
= it_copy
.current
.pos
;
4142 RESTORE_IT (it
, it
, it_copy_data
);
4146 /* Set charpos to the buffer position of the character
4147 that comes after IT's current position in the visual
4149 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4153 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4156 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4159 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4161 /* Determine face for CHARSET_ASCII, or unibyte. */
4162 face_id
= face_at_buffer_position (it
->w
,
4164 it
->region_beg_charpos
,
4165 it
->region_end_charpos
,
4166 &next_check_charpos
,
4169 /* Correct the face for charsets different from ASCII. Do it
4170 for the multibyte case only. The face returned above is
4171 suitable for unibyte text if current_buffer is unibyte. */
4172 if (it
->multibyte_p
)
4174 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4175 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4176 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4185 /***********************************************************************
4187 ***********************************************************************/
4189 /* Set up iterator IT from invisible properties at its current
4190 position. Called from handle_stop. */
4192 static enum prop_handled
4193 handle_invisible_prop (struct it
*it
)
4195 enum prop_handled handled
= HANDLED_NORMALLY
;
4199 if (STRINGP (it
->string
))
4201 Lisp_Object end_charpos
, limit
, charpos
;
4203 /* Get the value of the invisible text property at the
4204 current position. Value will be nil if there is no such
4206 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4207 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4208 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4210 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4212 /* Record whether we have to display an ellipsis for the
4214 int display_ellipsis_p
= (invis_p
== 2);
4215 ptrdiff_t len
, endpos
;
4217 handled
= HANDLED_RECOMPUTE_PROPS
;
4219 /* Get the position at which the next visible text can be
4220 found in IT->string, if any. */
4221 endpos
= len
= SCHARS (it
->string
);
4222 XSETINT (limit
, len
);
4225 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4227 if (INTEGERP (end_charpos
))
4229 endpos
= XFASTINT (end_charpos
);
4230 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4231 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4233 display_ellipsis_p
= 1;
4236 while (invis_p
&& endpos
< len
);
4238 if (display_ellipsis_p
)
4243 /* Text at END_CHARPOS is visible. Move IT there. */
4244 struct text_pos old
;
4247 old
= it
->current
.string_pos
;
4248 oldpos
= CHARPOS (old
);
4251 if (it
->bidi_it
.first_elt
4252 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4253 bidi_paragraph_init (it
->paragraph_embedding
,
4255 /* Bidi-iterate out of the invisible text. */
4258 bidi_move_to_visually_next (&it
->bidi_it
);
4260 while (oldpos
<= it
->bidi_it
.charpos
4261 && it
->bidi_it
.charpos
< endpos
);
4263 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4264 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4265 if (IT_CHARPOS (*it
) >= endpos
)
4266 it
->prev_stop
= endpos
;
4270 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4271 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4276 /* The rest of the string is invisible. If this is an
4277 overlay string, proceed with the next overlay string
4278 or whatever comes and return a character from there. */
4279 if (it
->current
.overlay_string_index
>= 0
4280 && !display_ellipsis_p
)
4282 next_overlay_string (it
);
4283 /* Don't check for overlay strings when we just
4284 finished processing them. */
4285 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4289 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4290 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4297 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4298 Lisp_Object pos
, overlay
;
4300 /* First of all, is there invisible text at this position? */
4301 tem
= start_charpos
= IT_CHARPOS (*it
);
4302 pos
= make_number (tem
);
4303 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4305 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4307 /* If we are on invisible text, skip over it. */
4308 if (invis_p
&& start_charpos
< it
->end_charpos
)
4310 /* Record whether we have to display an ellipsis for the
4312 int display_ellipsis_p
= invis_p
== 2;
4314 handled
= HANDLED_RECOMPUTE_PROPS
;
4316 /* Loop skipping over invisible text. The loop is left at
4317 ZV or with IT on the first char being visible again. */
4320 /* Try to skip some invisible text. Return value is the
4321 position reached which can be equal to where we start
4322 if there is nothing invisible there. This skips both
4323 over invisible text properties and overlays with
4324 invisible property. */
4325 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4327 /* If we skipped nothing at all we weren't at invisible
4328 text in the first place. If everything to the end of
4329 the buffer was skipped, end the loop. */
4330 if (newpos
== tem
|| newpos
>= ZV
)
4334 /* We skipped some characters but not necessarily
4335 all there are. Check if we ended up on visible
4336 text. Fget_char_property returns the property of
4337 the char before the given position, i.e. if we
4338 get invis_p = 0, this means that the char at
4339 newpos is visible. */
4340 pos
= make_number (newpos
);
4341 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4342 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4345 /* If we ended up on invisible text, proceed to
4346 skip starting with next_stop. */
4350 /* If there are adjacent invisible texts, don't lose the
4351 second one's ellipsis. */
4353 display_ellipsis_p
= 1;
4357 /* The position newpos is now either ZV or on visible text. */
4360 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4362 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4364 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4366 /* If the invisible text ends on a newline or on a
4367 character after a newline, we can avoid the costly,
4368 character by character, bidi iteration to NEWPOS, and
4369 instead simply reseat the iterator there. That's
4370 because all bidi reordering information is tossed at
4371 the newline. This is a big win for modes that hide
4372 complete lines, like Outline, Org, etc. */
4373 if (on_newline
|| after_newline
)
4375 struct text_pos tpos
;
4376 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4378 SET_TEXT_POS (tpos
, newpos
, bpos
);
4379 reseat_1 (it
, tpos
, 0);
4380 /* If we reseat on a newline/ZV, we need to prep the
4381 bidi iterator for advancing to the next character
4382 after the newline/EOB, keeping the current paragraph
4383 direction (so that PRODUCE_GLYPHS does TRT wrt
4384 prepending/appending glyphs to a glyph row). */
4387 it
->bidi_it
.first_elt
= 0;
4388 it
->bidi_it
.paragraph_dir
= pdir
;
4389 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4390 it
->bidi_it
.nchars
= 1;
4391 it
->bidi_it
.ch_len
= 1;
4394 else /* Must use the slow method. */
4396 /* With bidi iteration, the region of invisible text
4397 could start and/or end in the middle of a
4398 non-base embedding level. Therefore, we need to
4399 skip invisible text using the bidi iterator,
4400 starting at IT's current position, until we find
4401 ourselves outside of the invisible text.
4402 Skipping invisible text _after_ bidi iteration
4403 avoids affecting the visual order of the
4404 displayed text when invisible properties are
4405 added or removed. */
4406 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4408 /* If we were `reseat'ed to a new paragraph,
4409 determine the paragraph base direction. We
4410 need to do it now because
4411 next_element_from_buffer may not have a
4412 chance to do it, if we are going to skip any
4413 text at the beginning, which resets the
4415 bidi_paragraph_init (it
->paragraph_embedding
,
4420 bidi_move_to_visually_next (&it
->bidi_it
);
4422 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4423 && it
->bidi_it
.charpos
< newpos
);
4424 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4425 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4426 /* If we overstepped NEWPOS, record its position in
4427 the iterator, so that we skip invisible text if
4428 later the bidi iteration lands us in the
4429 invisible region again. */
4430 if (IT_CHARPOS (*it
) >= newpos
)
4431 it
->prev_stop
= newpos
;
4436 IT_CHARPOS (*it
) = newpos
;
4437 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4440 /* If there are before-strings at the start of invisible
4441 text, and the text is invisible because of a text
4442 property, arrange to show before-strings because 20.x did
4443 it that way. (If the text is invisible because of an
4444 overlay property instead of a text property, this is
4445 already handled in the overlay code.) */
4447 && get_overlay_strings (it
, it
->stop_charpos
))
4449 handled
= HANDLED_RECOMPUTE_PROPS
;
4450 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4452 else if (display_ellipsis_p
)
4454 /* Make sure that the glyphs of the ellipsis will get
4455 correct `charpos' values. If we would not update
4456 it->position here, the glyphs would belong to the
4457 last visible character _before_ the invisible
4458 text, which confuses `set_cursor_from_row'.
4460 We use the last invisible position instead of the
4461 first because this way the cursor is always drawn on
4462 the first "." of the ellipsis, whenever PT is inside
4463 the invisible text. Otherwise the cursor would be
4464 placed _after_ the ellipsis when the point is after the
4465 first invisible character. */
4466 if (!STRINGP (it
->object
))
4468 it
->position
.charpos
= newpos
- 1;
4469 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4472 /* Let the ellipsis display before
4473 considering any properties of the following char.
4474 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4475 handled
= HANDLED_RETURN
;
4484 /* Make iterator IT return `...' next.
4485 Replaces LEN characters from buffer. */
4488 setup_for_ellipsis (struct it
*it
, int len
)
4490 /* Use the display table definition for `...'. Invalid glyphs
4491 will be handled by the method returning elements from dpvec. */
4492 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4494 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4495 it
->dpvec
= v
->contents
;
4496 it
->dpend
= v
->contents
+ v
->header
.size
;
4500 /* Default `...'. */
4501 it
->dpvec
= default_invis_vector
;
4502 it
->dpend
= default_invis_vector
+ 3;
4505 it
->dpvec_char_len
= len
;
4506 it
->current
.dpvec_index
= 0;
4507 it
->dpvec_face_id
= -1;
4509 /* Remember the current face id in case glyphs specify faces.
4510 IT's face is restored in set_iterator_to_next.
4511 saved_face_id was set to preceding char's face in handle_stop. */
4512 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4513 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4515 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4521 /***********************************************************************
4523 ***********************************************************************/
4525 /* Set up iterator IT from `display' property at its current position.
4526 Called from handle_stop.
4527 We return HANDLED_RETURN if some part of the display property
4528 overrides the display of the buffer text itself.
4529 Otherwise we return HANDLED_NORMALLY. */
4531 static enum prop_handled
4532 handle_display_prop (struct it
*it
)
4534 Lisp_Object propval
, object
, overlay
;
4535 struct text_pos
*position
;
4537 /* Nonzero if some property replaces the display of the text itself. */
4538 int display_replaced_p
= 0;
4540 if (STRINGP (it
->string
))
4542 object
= it
->string
;
4543 position
= &it
->current
.string_pos
;
4544 bufpos
= CHARPOS (it
->current
.pos
);
4548 XSETWINDOW (object
, it
->w
);
4549 position
= &it
->current
.pos
;
4550 bufpos
= CHARPOS (*position
);
4553 /* Reset those iterator values set from display property values. */
4554 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4555 it
->space_width
= Qnil
;
4556 it
->font_height
= Qnil
;
4559 /* We don't support recursive `display' properties, i.e. string
4560 values that have a string `display' property, that have a string
4561 `display' property etc. */
4562 if (!it
->string_from_display_prop_p
)
4563 it
->area
= TEXT_AREA
;
4565 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4566 Qdisplay
, object
, &overlay
);
4568 return HANDLED_NORMALLY
;
4569 /* Now OVERLAY is the overlay that gave us this property, or nil
4570 if it was a text property. */
4572 if (!STRINGP (it
->string
))
4573 object
= it
->w
->contents
;
4575 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4577 FRAME_WINDOW_P (it
->f
));
4579 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4582 /* Subroutine of handle_display_prop. Returns non-zero if the display
4583 specification in SPEC is a replacing specification, i.e. it would
4584 replace the text covered by `display' property with something else,
4585 such as an image or a display string. If SPEC includes any kind or
4586 `(space ...) specification, the value is 2; this is used by
4587 compute_display_string_pos, which see.
4589 See handle_single_display_spec for documentation of arguments.
4590 frame_window_p is non-zero if the window being redisplayed is on a
4591 GUI frame; this argument is used only if IT is NULL, see below.
4593 IT can be NULL, if this is called by the bidi reordering code
4594 through compute_display_string_pos, which see. In that case, this
4595 function only examines SPEC, but does not otherwise "handle" it, in
4596 the sense that it doesn't set up members of IT from the display
4599 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4600 Lisp_Object overlay
, struct text_pos
*position
,
4601 ptrdiff_t bufpos
, int frame_window_p
)
4603 int replacing_p
= 0;
4607 /* Simple specifications. */
4608 && !EQ (XCAR (spec
), Qimage
)
4609 && !EQ (XCAR (spec
), Qspace
)
4610 && !EQ (XCAR (spec
), Qwhen
)
4611 && !EQ (XCAR (spec
), Qslice
)
4612 && !EQ (XCAR (spec
), Qspace_width
)
4613 && !EQ (XCAR (spec
), Qheight
)
4614 && !EQ (XCAR (spec
), Qraise
)
4615 /* Marginal area specifications. */
4616 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4617 && !EQ (XCAR (spec
), Qleft_fringe
)
4618 && !EQ (XCAR (spec
), Qright_fringe
)
4619 && !NILP (XCAR (spec
)))
4621 for (; CONSP (spec
); spec
= XCDR (spec
))
4623 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4624 overlay
, position
, bufpos
,
4625 replacing_p
, frame_window_p
)))
4628 /* If some text in a string is replaced, `position' no
4629 longer points to the position of `object'. */
4630 if (!it
|| STRINGP (object
))
4635 else if (VECTORP (spec
))
4638 for (i
= 0; i
< ASIZE (spec
); ++i
)
4639 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4640 overlay
, position
, bufpos
,
4641 replacing_p
, frame_window_p
)))
4644 /* If some text in a string is replaced, `position' no
4645 longer points to the position of `object'. */
4646 if (!it
|| STRINGP (object
))
4652 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4653 position
, bufpos
, 0,
4661 /* Value is the position of the end of the `display' property starting
4662 at START_POS in OBJECT. */
4664 static struct text_pos
4665 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4668 struct text_pos end_pos
;
4670 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4671 Qdisplay
, object
, Qnil
);
4672 CHARPOS (end_pos
) = XFASTINT (end
);
4673 if (STRINGP (object
))
4674 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4676 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4682 /* Set up IT from a single `display' property specification SPEC. OBJECT
4683 is the object in which the `display' property was found. *POSITION
4684 is the position in OBJECT at which the `display' property was found.
4685 BUFPOS is the buffer position of OBJECT (different from POSITION if
4686 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4687 previously saw a display specification which already replaced text
4688 display with something else, for example an image; we ignore such
4689 properties after the first one has been processed.
4691 OVERLAY is the overlay this `display' property came from,
4692 or nil if it was a text property.
4694 If SPEC is a `space' or `image' specification, and in some other
4695 cases too, set *POSITION to the position where the `display'
4698 If IT is NULL, only examine the property specification in SPEC, but
4699 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4700 is intended to be displayed in a window on a GUI frame.
4702 Value is non-zero if something was found which replaces the display
4703 of buffer or string text. */
4706 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4707 Lisp_Object overlay
, struct text_pos
*position
,
4708 ptrdiff_t bufpos
, int display_replaced_p
,
4712 Lisp_Object location
, value
;
4713 struct text_pos start_pos
= *position
;
4716 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4717 If the result is non-nil, use VALUE instead of SPEC. */
4719 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4728 if (!NILP (form
) && !EQ (form
, Qt
))
4730 ptrdiff_t count
= SPECPDL_INDEX ();
4731 struct gcpro gcpro1
;
4733 /* Bind `object' to the object having the `display' property, a
4734 buffer or string. Bind `position' to the position in the
4735 object where the property was found, and `buffer-position'
4736 to the current position in the buffer. */
4739 XSETBUFFER (object
, current_buffer
);
4740 specbind (Qobject
, object
);
4741 specbind (Qposition
, make_number (CHARPOS (*position
)));
4742 specbind (Qbuffer_position
, make_number (bufpos
));
4744 form
= safe_eval (form
);
4746 unbind_to (count
, Qnil
);
4752 /* Handle `(height HEIGHT)' specifications. */
4754 && EQ (XCAR (spec
), Qheight
)
4755 && CONSP (XCDR (spec
)))
4759 if (!FRAME_WINDOW_P (it
->f
))
4762 it
->font_height
= XCAR (XCDR (spec
));
4763 if (!NILP (it
->font_height
))
4765 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4766 int new_height
= -1;
4768 if (CONSP (it
->font_height
)
4769 && (EQ (XCAR (it
->font_height
), Qplus
)
4770 || EQ (XCAR (it
->font_height
), Qminus
))
4771 && CONSP (XCDR (it
->font_height
))
4772 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4774 /* `(+ N)' or `(- N)' where N is an integer. */
4775 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4776 if (EQ (XCAR (it
->font_height
), Qplus
))
4778 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4780 else if (FUNCTIONP (it
->font_height
))
4782 /* Call function with current height as argument.
4783 Value is the new height. */
4785 height
= safe_call1 (it
->font_height
,
4786 face
->lface
[LFACE_HEIGHT_INDEX
]);
4787 if (NUMBERP (height
))
4788 new_height
= XFLOATINT (height
);
4790 else if (NUMBERP (it
->font_height
))
4792 /* Value is a multiple of the canonical char height. */
4795 f
= FACE_FROM_ID (it
->f
,
4796 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4797 new_height
= (XFLOATINT (it
->font_height
)
4798 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4802 /* Evaluate IT->font_height with `height' bound to the
4803 current specified height to get the new height. */
4804 ptrdiff_t count
= SPECPDL_INDEX ();
4806 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4807 value
= safe_eval (it
->font_height
);
4808 unbind_to (count
, Qnil
);
4810 if (NUMBERP (value
))
4811 new_height
= XFLOATINT (value
);
4815 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4822 /* Handle `(space-width WIDTH)'. */
4824 && EQ (XCAR (spec
), Qspace_width
)
4825 && CONSP (XCDR (spec
)))
4829 if (!FRAME_WINDOW_P (it
->f
))
4832 value
= XCAR (XCDR (spec
));
4833 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4834 it
->space_width
= value
;
4840 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4842 && EQ (XCAR (spec
), Qslice
))
4848 if (!FRAME_WINDOW_P (it
->f
))
4851 if (tem
= XCDR (spec
), CONSP (tem
))
4853 it
->slice
.x
= XCAR (tem
);
4854 if (tem
= XCDR (tem
), CONSP (tem
))
4856 it
->slice
.y
= XCAR (tem
);
4857 if (tem
= XCDR (tem
), CONSP (tem
))
4859 it
->slice
.width
= XCAR (tem
);
4860 if (tem
= XCDR (tem
), CONSP (tem
))
4861 it
->slice
.height
= XCAR (tem
);
4870 /* Handle `(raise FACTOR)'. */
4872 && EQ (XCAR (spec
), Qraise
)
4873 && CONSP (XCDR (spec
)))
4877 if (!FRAME_WINDOW_P (it
->f
))
4880 #ifdef HAVE_WINDOW_SYSTEM
4881 value
= XCAR (XCDR (spec
));
4882 if (NUMBERP (value
))
4884 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4885 it
->voffset
= - (XFLOATINT (value
)
4886 * (FONT_HEIGHT (face
->font
)));
4888 #endif /* HAVE_WINDOW_SYSTEM */
4894 /* Don't handle the other kinds of display specifications
4895 inside a string that we got from a `display' property. */
4896 if (it
&& it
->string_from_display_prop_p
)
4899 /* Characters having this form of property are not displayed, so
4900 we have to find the end of the property. */
4903 start_pos
= *position
;
4904 *position
= display_prop_end (it
, object
, start_pos
);
4908 /* Stop the scan at that end position--we assume that all
4909 text properties change there. */
4911 it
->stop_charpos
= position
->charpos
;
4913 /* Handle `(left-fringe BITMAP [FACE])'
4914 and `(right-fringe BITMAP [FACE])'. */
4916 && (EQ (XCAR (spec
), Qleft_fringe
)
4917 || EQ (XCAR (spec
), Qright_fringe
))
4918 && CONSP (XCDR (spec
)))
4924 if (!FRAME_WINDOW_P (it
->f
))
4925 /* If we return here, POSITION has been advanced
4926 across the text with this property. */
4928 /* Synchronize the bidi iterator with POSITION. This is
4929 needed because we are not going to push the iterator
4930 on behalf of this display property, so there will be
4931 no pop_it call to do this synchronization for us. */
4934 it
->position
= *position
;
4935 iterate_out_of_display_property (it
);
4936 *position
= it
->position
;
4941 else if (!frame_window_p
)
4944 #ifdef HAVE_WINDOW_SYSTEM
4945 value
= XCAR (XCDR (spec
));
4946 if (!SYMBOLP (value
)
4947 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4948 /* If we return here, POSITION has been advanced
4949 across the text with this property. */
4951 if (it
&& it
->bidi_p
)
4953 it
->position
= *position
;
4954 iterate_out_of_display_property (it
);
4955 *position
= it
->position
;
4962 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4964 if (CONSP (XCDR (XCDR (spec
))))
4966 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4967 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4973 /* Save current settings of IT so that we can restore them
4974 when we are finished with the glyph property value. */
4975 push_it (it
, position
);
4977 it
->area
= TEXT_AREA
;
4978 it
->what
= IT_IMAGE
;
4979 it
->image_id
= -1; /* no image */
4980 it
->position
= start_pos
;
4981 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
4982 it
->method
= GET_FROM_IMAGE
;
4983 it
->from_overlay
= Qnil
;
4984 it
->face_id
= face_id
;
4985 it
->from_disp_prop_p
= 1;
4987 /* Say that we haven't consumed the characters with
4988 `display' property yet. The call to pop_it in
4989 set_iterator_to_next will clean this up. */
4990 *position
= start_pos
;
4992 if (EQ (XCAR (spec
), Qleft_fringe
))
4994 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4995 it
->left_user_fringe_face_id
= face_id
;
4999 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5000 it
->right_user_fringe_face_id
= face_id
;
5003 #endif /* HAVE_WINDOW_SYSTEM */
5007 /* Prepare to handle `((margin left-margin) ...)',
5008 `((margin right-margin) ...)' and `((margin nil) ...)'
5009 prefixes for display specifications. */
5010 location
= Qunbound
;
5011 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5015 value
= XCDR (spec
);
5017 value
= XCAR (value
);
5020 if (EQ (XCAR (tem
), Qmargin
)
5021 && (tem
= XCDR (tem
),
5022 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5024 || EQ (tem
, Qleft_margin
)
5025 || EQ (tem
, Qright_margin
))))
5029 if (EQ (location
, Qunbound
))
5035 /* After this point, VALUE is the property after any
5036 margin prefix has been stripped. It must be a string,
5037 an image specification, or `(space ...)'.
5039 LOCATION specifies where to display: `left-margin',
5040 `right-margin' or nil. */
5042 valid_p
= (STRINGP (value
)
5043 #ifdef HAVE_WINDOW_SYSTEM
5044 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5045 && valid_image_p (value
))
5046 #endif /* not HAVE_WINDOW_SYSTEM */
5047 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5049 if (valid_p
&& !display_replaced_p
)
5055 /* Callers need to know whether the display spec is any kind
5056 of `(space ...)' spec that is about to affect text-area
5058 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5063 /* Save current settings of IT so that we can restore them
5064 when we are finished with the glyph property value. */
5065 push_it (it
, position
);
5066 it
->from_overlay
= overlay
;
5067 it
->from_disp_prop_p
= 1;
5069 if (NILP (location
))
5070 it
->area
= TEXT_AREA
;
5071 else if (EQ (location
, Qleft_margin
))
5072 it
->area
= LEFT_MARGIN_AREA
;
5074 it
->area
= RIGHT_MARGIN_AREA
;
5076 if (STRINGP (value
))
5079 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5080 it
->current
.overlay_string_index
= -1;
5081 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5082 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5083 it
->method
= GET_FROM_STRING
;
5084 it
->stop_charpos
= 0;
5086 it
->base_level_stop
= 0;
5087 it
->string_from_display_prop_p
= 1;
5088 /* Say that we haven't consumed the characters with
5089 `display' property yet. The call to pop_it in
5090 set_iterator_to_next will clean this up. */
5091 if (BUFFERP (object
))
5092 *position
= start_pos
;
5094 /* Force paragraph direction to be that of the parent
5095 object. If the parent object's paragraph direction is
5096 not yet determined, default to L2R. */
5097 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5098 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5100 it
->paragraph_embedding
= L2R
;
5102 /* Set up the bidi iterator for this display string. */
5105 it
->bidi_it
.string
.lstring
= it
->string
;
5106 it
->bidi_it
.string
.s
= NULL
;
5107 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5108 it
->bidi_it
.string
.bufpos
= bufpos
;
5109 it
->bidi_it
.string
.from_disp_str
= 1;
5110 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5111 it
->bidi_it
.w
= it
->w
;
5112 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5115 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5117 it
->method
= GET_FROM_STRETCH
;
5119 *position
= it
->position
= start_pos
;
5120 retval
= 1 + (it
->area
== TEXT_AREA
);
5122 #ifdef HAVE_WINDOW_SYSTEM
5125 it
->what
= IT_IMAGE
;
5126 it
->image_id
= lookup_image (it
->f
, value
);
5127 it
->position
= start_pos
;
5128 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5129 it
->method
= GET_FROM_IMAGE
;
5131 /* Say that we haven't consumed the characters with
5132 `display' property yet. The call to pop_it in
5133 set_iterator_to_next will clean this up. */
5134 *position
= start_pos
;
5136 #endif /* HAVE_WINDOW_SYSTEM */
5141 /* Invalid property or property not supported. Restore
5142 POSITION to what it was before. */
5143 *position
= start_pos
;
5147 /* Check if PROP is a display property value whose text should be
5148 treated as intangible. OVERLAY is the overlay from which PROP
5149 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5150 specify the buffer position covered by PROP. */
5153 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5154 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5156 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5157 struct text_pos position
;
5159 SET_TEXT_POS (position
, charpos
, bytepos
);
5160 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5161 &position
, charpos
, frame_window_p
);
5165 /* Return 1 if PROP is a display sub-property value containing STRING.
5167 Implementation note: this and the following function are really
5168 special cases of handle_display_spec and
5169 handle_single_display_spec, and should ideally use the same code.
5170 Until they do, these two pairs must be consistent and must be
5171 modified in sync. */
5174 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5176 if (EQ (string
, prop
))
5179 /* Skip over `when FORM'. */
5180 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5185 /* Actually, the condition following `when' should be eval'ed,
5186 like handle_single_display_spec does, and we should return
5187 zero if it evaluates to nil. However, this function is
5188 called only when the buffer was already displayed and some
5189 glyph in the glyph matrix was found to come from a display
5190 string. Therefore, the condition was already evaluated, and
5191 the result was non-nil, otherwise the display string wouldn't
5192 have been displayed and we would have never been called for
5193 this property. Thus, we can skip the evaluation and assume
5194 its result is non-nil. */
5199 /* Skip over `margin LOCATION'. */
5200 if (EQ (XCAR (prop
), Qmargin
))
5211 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5215 /* Return 1 if STRING appears in the `display' property PROP. */
5218 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5221 && !EQ (XCAR (prop
), Qwhen
)
5222 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5224 /* A list of sub-properties. */
5225 while (CONSP (prop
))
5227 if (single_display_spec_string_p (XCAR (prop
), string
))
5232 else if (VECTORP (prop
))
5234 /* A vector of sub-properties. */
5236 for (i
= 0; i
< ASIZE (prop
); ++i
)
5237 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5241 return single_display_spec_string_p (prop
, string
);
5246 /* Look for STRING in overlays and text properties in the current
5247 buffer, between character positions FROM and TO (excluding TO).
5248 BACK_P non-zero means look back (in this case, TO is supposed to be
5250 Value is the first character position where STRING was found, or
5251 zero if it wasn't found before hitting TO.
5253 This function may only use code that doesn't eval because it is
5254 called asynchronously from note_mouse_highlight. */
5257 string_buffer_position_lim (Lisp_Object string
,
5258 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5260 Lisp_Object limit
, prop
, pos
;
5263 pos
= make_number (max (from
, BEGV
));
5265 if (!back_p
) /* looking forward */
5267 limit
= make_number (min (to
, ZV
));
5268 while (!found
&& !EQ (pos
, limit
))
5270 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5271 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5274 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5278 else /* looking back */
5280 limit
= make_number (max (to
, BEGV
));
5281 while (!found
&& !EQ (pos
, limit
))
5283 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5284 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5287 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5292 return found
? XINT (pos
) : 0;
5295 /* Determine which buffer position in current buffer STRING comes from.
5296 AROUND_CHARPOS is an approximate position where it could come from.
5297 Value is the buffer position or 0 if it couldn't be determined.
5299 This function is necessary because we don't record buffer positions
5300 in glyphs generated from strings (to keep struct glyph small).
5301 This function may only use code that doesn't eval because it is
5302 called asynchronously from note_mouse_highlight. */
5305 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5307 const int MAX_DISTANCE
= 1000;
5308 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5309 around_charpos
+ MAX_DISTANCE
,
5313 found
= string_buffer_position_lim (string
, around_charpos
,
5314 around_charpos
- MAX_DISTANCE
, 1);
5320 /***********************************************************************
5321 `composition' property
5322 ***********************************************************************/
5324 /* Set up iterator IT from `composition' property at its current
5325 position. Called from handle_stop. */
5327 static enum prop_handled
5328 handle_composition_prop (struct it
*it
)
5330 Lisp_Object prop
, string
;
5331 ptrdiff_t pos
, pos_byte
, start
, end
;
5333 if (STRINGP (it
->string
))
5337 pos
= IT_STRING_CHARPOS (*it
);
5338 pos_byte
= IT_STRING_BYTEPOS (*it
);
5339 string
= it
->string
;
5340 s
= SDATA (string
) + pos_byte
;
5341 it
->c
= STRING_CHAR (s
);
5345 pos
= IT_CHARPOS (*it
);
5346 pos_byte
= IT_BYTEPOS (*it
);
5348 it
->c
= FETCH_CHAR (pos_byte
);
5351 /* If there's a valid composition and point is not inside of the
5352 composition (in the case that the composition is from the current
5353 buffer), draw a glyph composed from the composition components. */
5354 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5355 && composition_valid_p (start
, end
, prop
)
5356 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5359 /* As we can't handle this situation (perhaps font-lock added
5360 a new composition), we just return here hoping that next
5361 redisplay will detect this composition much earlier. */
5362 return HANDLED_NORMALLY
;
5365 if (STRINGP (it
->string
))
5366 pos_byte
= string_char_to_byte (it
->string
, start
);
5368 pos_byte
= CHAR_TO_BYTE (start
);
5370 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5373 if (it
->cmp_it
.id
>= 0)
5376 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5377 it
->cmp_it
.nglyphs
= -1;
5381 return HANDLED_NORMALLY
;
5386 /***********************************************************************
5388 ***********************************************************************/
5390 /* The following structure is used to record overlay strings for
5391 later sorting in load_overlay_strings. */
5393 struct overlay_entry
5395 Lisp_Object overlay
;
5402 /* Set up iterator IT from overlay strings at its current position.
5403 Called from handle_stop. */
5405 static enum prop_handled
5406 handle_overlay_change (struct it
*it
)
5408 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5409 return HANDLED_RECOMPUTE_PROPS
;
5411 return HANDLED_NORMALLY
;
5415 /* Set up the next overlay string for delivery by IT, if there is an
5416 overlay string to deliver. Called by set_iterator_to_next when the
5417 end of the current overlay string is reached. If there are more
5418 overlay strings to display, IT->string and
5419 IT->current.overlay_string_index are set appropriately here.
5420 Otherwise IT->string is set to nil. */
5423 next_overlay_string (struct it
*it
)
5425 ++it
->current
.overlay_string_index
;
5426 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5428 /* No more overlay strings. Restore IT's settings to what
5429 they were before overlay strings were processed, and
5430 continue to deliver from current_buffer. */
5432 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5435 || (NILP (it
->string
)
5436 && it
->method
== GET_FROM_BUFFER
5437 && it
->stop_charpos
>= BEGV
5438 && it
->stop_charpos
<= it
->end_charpos
));
5439 it
->current
.overlay_string_index
= -1;
5440 it
->n_overlay_strings
= 0;
5441 it
->overlay_strings_charpos
= -1;
5442 /* If there's an empty display string on the stack, pop the
5443 stack, to resync the bidi iterator with IT's position. Such
5444 empty strings are pushed onto the stack in
5445 get_overlay_strings_1. */
5446 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5449 /* If we're at the end of the buffer, record that we have
5450 processed the overlay strings there already, so that
5451 next_element_from_buffer doesn't try it again. */
5452 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5453 it
->overlay_strings_at_end_processed_p
= 1;
5457 /* There are more overlay strings to process. If
5458 IT->current.overlay_string_index has advanced to a position
5459 where we must load IT->overlay_strings with more strings, do
5460 it. We must load at the IT->overlay_strings_charpos where
5461 IT->n_overlay_strings was originally computed; when invisible
5462 text is present, this might not be IT_CHARPOS (Bug#7016). */
5463 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5465 if (it
->current
.overlay_string_index
&& i
== 0)
5466 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5468 /* Initialize IT to deliver display elements from the overlay
5470 it
->string
= it
->overlay_strings
[i
];
5471 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5472 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5473 it
->method
= GET_FROM_STRING
;
5474 it
->stop_charpos
= 0;
5475 it
->end_charpos
= SCHARS (it
->string
);
5476 if (it
->cmp_it
.stop_pos
>= 0)
5477 it
->cmp_it
.stop_pos
= 0;
5479 it
->base_level_stop
= 0;
5481 /* Set up the bidi iterator for this overlay string. */
5484 it
->bidi_it
.string
.lstring
= it
->string
;
5485 it
->bidi_it
.string
.s
= NULL
;
5486 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5487 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5488 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5489 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5490 it
->bidi_it
.w
= it
->w
;
5491 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5499 /* Compare two overlay_entry structures E1 and E2. Used as a
5500 comparison function for qsort in load_overlay_strings. Overlay
5501 strings for the same position are sorted so that
5503 1. All after-strings come in front of before-strings, except
5504 when they come from the same overlay.
5506 2. Within after-strings, strings are sorted so that overlay strings
5507 from overlays with higher priorities come first.
5509 2. Within before-strings, strings are sorted so that overlay
5510 strings from overlays with higher priorities come last.
5512 Value is analogous to strcmp. */
5516 compare_overlay_entries (const void *e1
, const void *e2
)
5518 struct overlay_entry
const *entry1
= e1
;
5519 struct overlay_entry
const *entry2
= e2
;
5522 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5524 /* Let after-strings appear in front of before-strings if
5525 they come from different overlays. */
5526 if (EQ (entry1
->overlay
, entry2
->overlay
))
5527 result
= entry1
->after_string_p
? 1 : -1;
5529 result
= entry1
->after_string_p
? -1 : 1;
5531 else if (entry1
->priority
!= entry2
->priority
)
5533 if (entry1
->after_string_p
)
5534 /* After-strings sorted in order of decreasing priority. */
5535 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5537 /* Before-strings sorted in order of increasing priority. */
5538 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5547 /* Load the vector IT->overlay_strings with overlay strings from IT's
5548 current buffer position, or from CHARPOS if that is > 0. Set
5549 IT->n_overlays to the total number of overlay strings found.
5551 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5552 a time. On entry into load_overlay_strings,
5553 IT->current.overlay_string_index gives the number of overlay
5554 strings that have already been loaded by previous calls to this
5557 IT->add_overlay_start contains an additional overlay start
5558 position to consider for taking overlay strings from, if non-zero.
5559 This position comes into play when the overlay has an `invisible'
5560 property, and both before and after-strings. When we've skipped to
5561 the end of the overlay, because of its `invisible' property, we
5562 nevertheless want its before-string to appear.
5563 IT->add_overlay_start will contain the overlay start position
5566 Overlay strings are sorted so that after-string strings come in
5567 front of before-string strings. Within before and after-strings,
5568 strings are sorted by overlay priority. See also function
5569 compare_overlay_entries. */
5572 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5574 Lisp_Object overlay
, window
, str
, invisible
;
5575 struct Lisp_Overlay
*ov
;
5576 ptrdiff_t start
, end
;
5577 ptrdiff_t size
= 20;
5578 ptrdiff_t n
= 0, i
, j
;
5580 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5584 charpos
= IT_CHARPOS (*it
);
5586 /* Append the overlay string STRING of overlay OVERLAY to vector
5587 `entries' which has size `size' and currently contains `n'
5588 elements. AFTER_P non-zero means STRING is an after-string of
5590 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5593 Lisp_Object priority; \
5597 struct overlay_entry *old = entries; \
5598 SAFE_NALLOCA (entries, 2, size); \
5599 memcpy (entries, old, size * sizeof *entries); \
5603 entries[n].string = (STRING); \
5604 entries[n].overlay = (OVERLAY); \
5605 priority = Foverlay_get ((OVERLAY), Qpriority); \
5606 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5607 entries[n].after_string_p = (AFTER_P); \
5612 /* Process overlay before the overlay center. */
5613 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5615 XSETMISC (overlay
, ov
);
5616 eassert (OVERLAYP (overlay
));
5617 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5618 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5623 /* Skip this overlay if it doesn't start or end at IT's current
5625 if (end
!= charpos
&& start
!= charpos
)
5628 /* Skip this overlay if it doesn't apply to IT->w. */
5629 window
= Foverlay_get (overlay
, Qwindow
);
5630 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5633 /* If the text ``under'' the overlay is invisible, both before-
5634 and after-strings from this overlay are visible; start and
5635 end position are indistinguishable. */
5636 invisible
= Foverlay_get (overlay
, Qinvisible
);
5637 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5639 /* If overlay has a non-empty before-string, record it. */
5640 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5641 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5643 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5645 /* If overlay has a non-empty after-string, record it. */
5646 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5647 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5649 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5652 /* Process overlays after the overlay center. */
5653 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5655 XSETMISC (overlay
, ov
);
5656 eassert (OVERLAYP (overlay
));
5657 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5658 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5660 if (start
> charpos
)
5663 /* Skip this overlay if it doesn't start or end at IT's current
5665 if (end
!= charpos
&& start
!= charpos
)
5668 /* Skip this overlay if it doesn't apply to IT->w. */
5669 window
= Foverlay_get (overlay
, Qwindow
);
5670 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5673 /* If the text ``under'' the overlay is invisible, it has a zero
5674 dimension, and both before- and after-strings apply. */
5675 invisible
= Foverlay_get (overlay
, Qinvisible
);
5676 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5678 /* If overlay has a non-empty before-string, record it. */
5679 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5680 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5682 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5684 /* If overlay has a non-empty after-string, record it. */
5685 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5686 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5688 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5691 #undef RECORD_OVERLAY_STRING
5695 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5697 /* Record number of overlay strings, and where we computed it. */
5698 it
->n_overlay_strings
= n
;
5699 it
->overlay_strings_charpos
= charpos
;
5701 /* IT->current.overlay_string_index is the number of overlay strings
5702 that have already been consumed by IT. Copy some of the
5703 remaining overlay strings to IT->overlay_strings. */
5705 j
= it
->current
.overlay_string_index
;
5706 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5708 it
->overlay_strings
[i
] = entries
[j
].string
;
5709 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5717 /* Get the first chunk of overlay strings at IT's current buffer
5718 position, or at CHARPOS if that is > 0. Value is non-zero if at
5719 least one overlay string was found. */
5722 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5724 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5725 process. This fills IT->overlay_strings with strings, and sets
5726 IT->n_overlay_strings to the total number of strings to process.
5727 IT->pos.overlay_string_index has to be set temporarily to zero
5728 because load_overlay_strings needs this; it must be set to -1
5729 when no overlay strings are found because a zero value would
5730 indicate a position in the first overlay string. */
5731 it
->current
.overlay_string_index
= 0;
5732 load_overlay_strings (it
, charpos
);
5734 /* If we found overlay strings, set up IT to deliver display
5735 elements from the first one. Otherwise set up IT to deliver
5736 from current_buffer. */
5737 if (it
->n_overlay_strings
)
5739 /* Make sure we know settings in current_buffer, so that we can
5740 restore meaningful values when we're done with the overlay
5743 compute_stop_pos (it
);
5744 eassert (it
->face_id
>= 0);
5746 /* Save IT's settings. They are restored after all overlay
5747 strings have been processed. */
5748 eassert (!compute_stop_p
|| it
->sp
== 0);
5750 /* When called from handle_stop, there might be an empty display
5751 string loaded. In that case, don't bother saving it. But
5752 don't use this optimization with the bidi iterator, since we
5753 need the corresponding pop_it call to resync the bidi
5754 iterator's position with IT's position, after we are done
5755 with the overlay strings. (The corresponding call to pop_it
5756 in case of an empty display string is in
5757 next_overlay_string.) */
5759 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5762 /* Set up IT to deliver display elements from the first overlay
5764 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5765 it
->string
= it
->overlay_strings
[0];
5766 it
->from_overlay
= Qnil
;
5767 it
->stop_charpos
= 0;
5768 eassert (STRINGP (it
->string
));
5769 it
->end_charpos
= SCHARS (it
->string
);
5771 it
->base_level_stop
= 0;
5772 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5773 it
->method
= GET_FROM_STRING
;
5774 it
->from_disp_prop_p
= 0;
5776 /* Force paragraph direction to be that of the parent
5778 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5779 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5781 it
->paragraph_embedding
= L2R
;
5783 /* Set up the bidi iterator for this overlay string. */
5786 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5788 it
->bidi_it
.string
.lstring
= it
->string
;
5789 it
->bidi_it
.string
.s
= NULL
;
5790 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5791 it
->bidi_it
.string
.bufpos
= pos
;
5792 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5793 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5794 it
->bidi_it
.w
= it
->w
;
5795 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5800 it
->current
.overlay_string_index
= -1;
5805 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5808 it
->method
= GET_FROM_BUFFER
;
5810 (void) get_overlay_strings_1 (it
, charpos
, 1);
5814 /* Value is non-zero if we found at least one overlay string. */
5815 return STRINGP (it
->string
);
5820 /***********************************************************************
5821 Saving and restoring state
5822 ***********************************************************************/
5824 /* Save current settings of IT on IT->stack. Called, for example,
5825 before setting up IT for an overlay string, to be able to restore
5826 IT's settings to what they were after the overlay string has been
5827 processed. If POSITION is non-NULL, it is the position to save on
5828 the stack instead of IT->position. */
5831 push_it (struct it
*it
, struct text_pos
*position
)
5833 struct iterator_stack_entry
*p
;
5835 eassert (it
->sp
< IT_STACK_SIZE
);
5836 p
= it
->stack
+ it
->sp
;
5838 p
->stop_charpos
= it
->stop_charpos
;
5839 p
->prev_stop
= it
->prev_stop
;
5840 p
->base_level_stop
= it
->base_level_stop
;
5841 p
->cmp_it
= it
->cmp_it
;
5842 eassert (it
->face_id
>= 0);
5843 p
->face_id
= it
->face_id
;
5844 p
->string
= it
->string
;
5845 p
->method
= it
->method
;
5846 p
->from_overlay
= it
->from_overlay
;
5849 case GET_FROM_IMAGE
:
5850 p
->u
.image
.object
= it
->object
;
5851 p
->u
.image
.image_id
= it
->image_id
;
5852 p
->u
.image
.slice
= it
->slice
;
5854 case GET_FROM_STRETCH
:
5855 p
->u
.stretch
.object
= it
->object
;
5858 p
->position
= position
? *position
: it
->position
;
5859 p
->current
= it
->current
;
5860 p
->end_charpos
= it
->end_charpos
;
5861 p
->string_nchars
= it
->string_nchars
;
5863 p
->multibyte_p
= it
->multibyte_p
;
5864 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5865 p
->space_width
= it
->space_width
;
5866 p
->font_height
= it
->font_height
;
5867 p
->voffset
= it
->voffset
;
5868 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5869 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5870 p
->display_ellipsis_p
= 0;
5871 p
->line_wrap
= it
->line_wrap
;
5872 p
->bidi_p
= it
->bidi_p
;
5873 p
->paragraph_embedding
= it
->paragraph_embedding
;
5874 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5877 /* Save the state of the bidi iterator as well. */
5879 bidi_push_it (&it
->bidi_it
);
5883 iterate_out_of_display_property (struct it
*it
)
5885 int buffer_p
= !STRINGP (it
->string
);
5886 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5887 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5889 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5891 /* Maybe initialize paragraph direction. If we are at the beginning
5892 of a new paragraph, next_element_from_buffer may not have a
5893 chance to do that. */
5894 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5895 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5896 /* prev_stop can be zero, so check against BEGV as well. */
5897 while (it
->bidi_it
.charpos
>= bob
5898 && it
->prev_stop
<= it
->bidi_it
.charpos
5899 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5900 && it
->bidi_it
.charpos
< eob
)
5901 bidi_move_to_visually_next (&it
->bidi_it
);
5902 /* Record the stop_pos we just crossed, for when we cross it
5904 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5905 it
->prev_stop
= CHARPOS (it
->position
);
5906 /* If we ended up not where pop_it put us, resync IT's
5907 positional members with the bidi iterator. */
5908 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5909 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5911 it
->current
.pos
= it
->position
;
5913 it
->current
.string_pos
= it
->position
;
5916 /* Restore IT's settings from IT->stack. Called, for example, when no
5917 more overlay strings must be processed, and we return to delivering
5918 display elements from a buffer, or when the end of a string from a
5919 `display' property is reached and we return to delivering display
5920 elements from an overlay string, or from a buffer. */
5923 pop_it (struct it
*it
)
5925 struct iterator_stack_entry
*p
;
5926 int from_display_prop
= it
->from_disp_prop_p
;
5928 eassert (it
->sp
> 0);
5930 p
= it
->stack
+ it
->sp
;
5931 it
->stop_charpos
= p
->stop_charpos
;
5932 it
->prev_stop
= p
->prev_stop
;
5933 it
->base_level_stop
= p
->base_level_stop
;
5934 it
->cmp_it
= p
->cmp_it
;
5935 it
->face_id
= p
->face_id
;
5936 it
->current
= p
->current
;
5937 it
->position
= p
->position
;
5938 it
->string
= p
->string
;
5939 it
->from_overlay
= p
->from_overlay
;
5940 if (NILP (it
->string
))
5941 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5942 it
->method
= p
->method
;
5945 case GET_FROM_IMAGE
:
5946 it
->image_id
= p
->u
.image
.image_id
;
5947 it
->object
= p
->u
.image
.object
;
5948 it
->slice
= p
->u
.image
.slice
;
5950 case GET_FROM_STRETCH
:
5951 it
->object
= p
->u
.stretch
.object
;
5953 case GET_FROM_BUFFER
:
5954 it
->object
= it
->w
->contents
;
5956 case GET_FROM_STRING
:
5957 it
->object
= it
->string
;
5959 case GET_FROM_DISPLAY_VECTOR
:
5961 it
->method
= GET_FROM_C_STRING
;
5962 else if (STRINGP (it
->string
))
5963 it
->method
= GET_FROM_STRING
;
5966 it
->method
= GET_FROM_BUFFER
;
5967 it
->object
= it
->w
->contents
;
5970 it
->end_charpos
= p
->end_charpos
;
5971 it
->string_nchars
= p
->string_nchars
;
5973 it
->multibyte_p
= p
->multibyte_p
;
5974 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5975 it
->space_width
= p
->space_width
;
5976 it
->font_height
= p
->font_height
;
5977 it
->voffset
= p
->voffset
;
5978 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5979 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5980 it
->line_wrap
= p
->line_wrap
;
5981 it
->bidi_p
= p
->bidi_p
;
5982 it
->paragraph_embedding
= p
->paragraph_embedding
;
5983 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5986 bidi_pop_it (&it
->bidi_it
);
5987 /* Bidi-iterate until we get out of the portion of text, if any,
5988 covered by a `display' text property or by an overlay with
5989 `display' property. (We cannot just jump there, because the
5990 internal coherency of the bidi iterator state can not be
5991 preserved across such jumps.) We also must determine the
5992 paragraph base direction if the overlay we just processed is
5993 at the beginning of a new paragraph. */
5994 if (from_display_prop
5995 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5996 iterate_out_of_display_property (it
);
5998 eassert ((BUFFERP (it
->object
)
5999 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6000 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6001 || (STRINGP (it
->object
)
6002 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6003 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6004 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6010 /***********************************************************************
6012 ***********************************************************************/
6014 /* Set IT's current position to the previous line start. */
6017 back_to_previous_line_start (struct it
*it
)
6019 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6022 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6026 /* Move IT to the next line start.
6028 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6029 we skipped over part of the text (as opposed to moving the iterator
6030 continuously over the text). Otherwise, don't change the value
6033 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6034 iterator on the newline, if it was found.
6036 Newlines may come from buffer text, overlay strings, or strings
6037 displayed via the `display' property. That's the reason we can't
6038 simply use find_newline_no_quit.
6040 Note that this function may not skip over invisible text that is so
6041 because of text properties and immediately follows a newline. If
6042 it would, function reseat_at_next_visible_line_start, when called
6043 from set_iterator_to_next, would effectively make invisible
6044 characters following a newline part of the wrong glyph row, which
6045 leads to wrong cursor motion. */
6048 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6049 struct bidi_it
*bidi_it_prev
)
6051 ptrdiff_t old_selective
;
6052 int newline_found_p
, n
;
6053 const int MAX_NEWLINE_DISTANCE
= 500;
6055 /* If already on a newline, just consume it to avoid unintended
6056 skipping over invisible text below. */
6057 if (it
->what
== IT_CHARACTER
6059 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6061 if (it
->bidi_p
&& bidi_it_prev
)
6062 *bidi_it_prev
= it
->bidi_it
;
6063 set_iterator_to_next (it
, 0);
6068 /* Don't handle selective display in the following. It's (a)
6069 unnecessary because it's done by the caller, and (b) leads to an
6070 infinite recursion because next_element_from_ellipsis indirectly
6071 calls this function. */
6072 old_selective
= it
->selective
;
6075 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6076 from buffer text. */
6077 for (n
= newline_found_p
= 0;
6078 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6079 n
+= STRINGP (it
->string
) ? 0 : 1)
6081 if (!get_next_display_element (it
))
6083 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6084 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6085 *bidi_it_prev
= it
->bidi_it
;
6086 set_iterator_to_next (it
, 0);
6089 /* If we didn't find a newline near enough, see if we can use a
6091 if (!newline_found_p
)
6093 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6094 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6098 eassert (!STRINGP (it
->string
));
6100 /* If there isn't any `display' property in sight, and no
6101 overlays, we can just use the position of the newline in
6103 if (it
->stop_charpos
>= limit
6104 || ((pos
= Fnext_single_property_change (make_number (start
),
6106 make_number (limit
)),
6108 && next_overlay_change (start
) == ZV
))
6112 IT_CHARPOS (*it
) = limit
;
6113 IT_BYTEPOS (*it
) = bytepos
;
6117 struct bidi_it bprev
;
6119 /* Help bidi.c avoid expensive searches for display
6120 properties and overlays, by telling it that there are
6121 none up to `limit'. */
6122 if (it
->bidi_it
.disp_pos
< limit
)
6124 it
->bidi_it
.disp_pos
= limit
;
6125 it
->bidi_it
.disp_prop
= 0;
6128 bprev
= it
->bidi_it
;
6129 bidi_move_to_visually_next (&it
->bidi_it
);
6130 } while (it
->bidi_it
.charpos
!= limit
);
6131 IT_CHARPOS (*it
) = limit
;
6132 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6134 *bidi_it_prev
= bprev
;
6136 *skipped_p
= newline_found_p
= 1;
6140 while (get_next_display_element (it
)
6141 && !newline_found_p
)
6143 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6144 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6145 *bidi_it_prev
= it
->bidi_it
;
6146 set_iterator_to_next (it
, 0);
6151 it
->selective
= old_selective
;
6152 return newline_found_p
;
6156 /* Set IT's current position to the previous visible line start. Skip
6157 invisible text that is so either due to text properties or due to
6158 selective display. Caution: this does not change IT->current_x and
6162 back_to_previous_visible_line_start (struct it
*it
)
6164 while (IT_CHARPOS (*it
) > BEGV
)
6166 back_to_previous_line_start (it
);
6168 if (IT_CHARPOS (*it
) <= BEGV
)
6171 /* If selective > 0, then lines indented more than its value are
6173 if (it
->selective
> 0
6174 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6178 /* Check the newline before point for invisibility. */
6181 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6182 Qinvisible
, it
->window
);
6183 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6187 if (IT_CHARPOS (*it
) <= BEGV
)
6192 void *it2data
= NULL
;
6195 Lisp_Object val
, overlay
;
6197 SAVE_IT (it2
, *it
, it2data
);
6199 /* If newline is part of a composition, continue from start of composition */
6200 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6201 && beg
< IT_CHARPOS (*it
))
6204 /* If newline is replaced by a display property, find start of overlay
6205 or interval and continue search from that point. */
6206 pos
= --IT_CHARPOS (it2
);
6209 bidi_unshelve_cache (NULL
, 0);
6210 it2
.string_from_display_prop_p
= 0;
6211 it2
.from_disp_prop_p
= 0;
6212 if (handle_display_prop (&it2
) == HANDLED_RETURN
6213 && !NILP (val
= get_char_property_and_overlay
6214 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6215 && (OVERLAYP (overlay
)
6216 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6217 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6219 RESTORE_IT (it
, it
, it2data
);
6223 /* Newline is not replaced by anything -- so we are done. */
6224 RESTORE_IT (it
, it
, it2data
);
6230 IT_CHARPOS (*it
) = beg
;
6231 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6235 it
->continuation_lines_width
= 0;
6237 eassert (IT_CHARPOS (*it
) >= BEGV
);
6238 eassert (IT_CHARPOS (*it
) == BEGV
6239 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6244 /* Reseat iterator IT at the previous visible line start. Skip
6245 invisible text that is so either due to text properties or due to
6246 selective display. At the end, update IT's overlay information,
6247 face information etc. */
6250 reseat_at_previous_visible_line_start (struct it
*it
)
6252 back_to_previous_visible_line_start (it
);
6253 reseat (it
, it
->current
.pos
, 1);
6258 /* Reseat iterator IT on the next visible line start in the current
6259 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6260 preceding the line start. Skip over invisible text that is so
6261 because of selective display. Compute faces, overlays etc at the
6262 new position. Note that this function does not skip over text that
6263 is invisible because of text properties. */
6266 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6268 int newline_found_p
, skipped_p
= 0;
6269 struct bidi_it bidi_it_prev
;
6271 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6273 /* Skip over lines that are invisible because they are indented
6274 more than the value of IT->selective. */
6275 if (it
->selective
> 0)
6276 while (IT_CHARPOS (*it
) < ZV
6277 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6280 eassert (IT_BYTEPOS (*it
) == BEGV
6281 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6283 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6286 /* Position on the newline if that's what's requested. */
6287 if (on_newline_p
&& newline_found_p
)
6289 if (STRINGP (it
->string
))
6291 if (IT_STRING_CHARPOS (*it
) > 0)
6295 --IT_STRING_CHARPOS (*it
);
6296 --IT_STRING_BYTEPOS (*it
);
6300 /* We need to restore the bidi iterator to the state
6301 it had on the newline, and resync the IT's
6302 position with that. */
6303 it
->bidi_it
= bidi_it_prev
;
6304 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6305 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6309 else if (IT_CHARPOS (*it
) > BEGV
)
6318 /* We need to restore the bidi iterator to the state it
6319 had on the newline and resync IT with that. */
6320 it
->bidi_it
= bidi_it_prev
;
6321 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6322 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6324 reseat (it
, it
->current
.pos
, 0);
6328 reseat (it
, it
->current
.pos
, 0);
6335 /***********************************************************************
6336 Changing an iterator's position
6337 ***********************************************************************/
6339 /* Change IT's current position to POS in current_buffer. If FORCE_P
6340 is non-zero, always check for text properties at the new position.
6341 Otherwise, text properties are only looked up if POS >=
6342 IT->check_charpos of a property. */
6345 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6347 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6349 reseat_1 (it
, pos
, 0);
6351 /* Determine where to check text properties. Avoid doing it
6352 where possible because text property lookup is very expensive. */
6354 || CHARPOS (pos
) > it
->stop_charpos
6355 || CHARPOS (pos
) < original_pos
)
6359 /* For bidi iteration, we need to prime prev_stop and
6360 base_level_stop with our best estimations. */
6361 /* Implementation note: Of course, POS is not necessarily a
6362 stop position, so assigning prev_pos to it is a lie; we
6363 should have called compute_stop_backwards. However, if
6364 the current buffer does not include any R2L characters,
6365 that call would be a waste of cycles, because the
6366 iterator will never move back, and thus never cross this
6367 "fake" stop position. So we delay that backward search
6368 until the time we really need it, in next_element_from_buffer. */
6369 if (CHARPOS (pos
) != it
->prev_stop
)
6370 it
->prev_stop
= CHARPOS (pos
);
6371 if (CHARPOS (pos
) < it
->base_level_stop
)
6372 it
->base_level_stop
= 0; /* meaning it's unknown */
6378 it
->prev_stop
= it
->base_level_stop
= 0;
6387 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6388 IT->stop_pos to POS, also. */
6391 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6393 /* Don't call this function when scanning a C string. */
6394 eassert (it
->s
== NULL
);
6396 /* POS must be a reasonable value. */
6397 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6399 it
->current
.pos
= it
->position
= pos
;
6400 it
->end_charpos
= ZV
;
6402 it
->current
.dpvec_index
= -1;
6403 it
->current
.overlay_string_index
= -1;
6404 IT_STRING_CHARPOS (*it
) = -1;
6405 IT_STRING_BYTEPOS (*it
) = -1;
6407 it
->method
= GET_FROM_BUFFER
;
6408 it
->object
= it
->w
->contents
;
6409 it
->area
= TEXT_AREA
;
6410 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6412 it
->string_from_display_prop_p
= 0;
6413 it
->string_from_prefix_prop_p
= 0;
6415 it
->from_disp_prop_p
= 0;
6416 it
->face_before_selective_p
= 0;
6419 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6421 bidi_unshelve_cache (NULL
, 0);
6422 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6423 it
->bidi_it
.string
.s
= NULL
;
6424 it
->bidi_it
.string
.lstring
= Qnil
;
6425 it
->bidi_it
.string
.bufpos
= 0;
6426 it
->bidi_it
.string
.unibyte
= 0;
6427 it
->bidi_it
.w
= it
->w
;
6432 it
->stop_charpos
= CHARPOS (pos
);
6433 it
->base_level_stop
= CHARPOS (pos
);
6435 /* This make the information stored in it->cmp_it invalidate. */
6440 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6441 If S is non-null, it is a C string to iterate over. Otherwise,
6442 STRING gives a Lisp string to iterate over.
6444 If PRECISION > 0, don't return more then PRECISION number of
6445 characters from the string.
6447 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6448 characters have been returned. FIELD_WIDTH < 0 means an infinite
6451 MULTIBYTE = 0 means disable processing of multibyte characters,
6452 MULTIBYTE > 0 means enable it,
6453 MULTIBYTE < 0 means use IT->multibyte_p.
6455 IT must be initialized via a prior call to init_iterator before
6456 calling this function. */
6459 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6460 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6463 /* No region in strings. */
6464 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6466 /* No text property checks performed by default, but see below. */
6467 it
->stop_charpos
= -1;
6469 /* Set iterator position and end position. */
6470 memset (&it
->current
, 0, sizeof it
->current
);
6471 it
->current
.overlay_string_index
= -1;
6472 it
->current
.dpvec_index
= -1;
6473 eassert (charpos
>= 0);
6475 /* If STRING is specified, use its multibyteness, otherwise use the
6476 setting of MULTIBYTE, if specified. */
6478 it
->multibyte_p
= multibyte
> 0;
6480 /* Bidirectional reordering of strings is controlled by the default
6481 value of bidi-display-reordering. Don't try to reorder while
6482 loading loadup.el, as the necessary character property tables are
6483 not yet available. */
6486 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6490 eassert (STRINGP (string
));
6491 it
->string
= string
;
6493 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6494 it
->method
= GET_FROM_STRING
;
6495 it
->current
.string_pos
= string_pos (charpos
, string
);
6499 it
->bidi_it
.string
.lstring
= string
;
6500 it
->bidi_it
.string
.s
= NULL
;
6501 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6502 it
->bidi_it
.string
.bufpos
= 0;
6503 it
->bidi_it
.string
.from_disp_str
= 0;
6504 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6505 it
->bidi_it
.w
= it
->w
;
6506 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6507 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6512 it
->s
= (const unsigned char *) s
;
6515 /* Note that we use IT->current.pos, not it->current.string_pos,
6516 for displaying C strings. */
6517 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6518 if (it
->multibyte_p
)
6520 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6521 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6525 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6526 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6531 it
->bidi_it
.string
.lstring
= Qnil
;
6532 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6533 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6534 it
->bidi_it
.string
.bufpos
= 0;
6535 it
->bidi_it
.string
.from_disp_str
= 0;
6536 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6537 it
->bidi_it
.w
= it
->w
;
6538 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6541 it
->method
= GET_FROM_C_STRING
;
6544 /* PRECISION > 0 means don't return more than PRECISION characters
6546 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6548 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6550 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6553 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6554 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6555 FIELD_WIDTH < 0 means infinite field width. This is useful for
6556 padding with `-' at the end of a mode line. */
6557 if (field_width
< 0)
6558 field_width
= INFINITY
;
6559 /* Implementation note: We deliberately don't enlarge
6560 it->bidi_it.string.schars here to fit it->end_charpos, because
6561 the bidi iterator cannot produce characters out of thin air. */
6562 if (field_width
> it
->end_charpos
- charpos
)
6563 it
->end_charpos
= charpos
+ field_width
;
6565 /* Use the standard display table for displaying strings. */
6566 if (DISP_TABLE_P (Vstandard_display_table
))
6567 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6569 it
->stop_charpos
= charpos
;
6570 it
->prev_stop
= charpos
;
6571 it
->base_level_stop
= 0;
6574 it
->bidi_it
.first_elt
= 1;
6575 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6576 it
->bidi_it
.disp_pos
= -1;
6578 if (s
== NULL
&& it
->multibyte_p
)
6580 ptrdiff_t endpos
= SCHARS (it
->string
);
6581 if (endpos
> it
->end_charpos
)
6582 endpos
= it
->end_charpos
;
6583 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6591 /***********************************************************************
6593 ***********************************************************************/
6595 /* Map enum it_method value to corresponding next_element_from_* function. */
6597 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6599 next_element_from_buffer
,
6600 next_element_from_display_vector
,
6601 next_element_from_string
,
6602 next_element_from_c_string
,
6603 next_element_from_image
,
6604 next_element_from_stretch
6607 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6610 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6611 (possibly with the following characters). */
6613 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6614 ((IT)->cmp_it.id >= 0 \
6615 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6616 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6617 END_CHARPOS, (IT)->w, \
6618 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6622 /* Lookup the char-table Vglyphless_char_display for character C (-1
6623 if we want information for no-font case), and return the display
6624 method symbol. By side-effect, update it->what and
6625 it->glyphless_method. This function is called from
6626 get_next_display_element for each character element, and from
6627 x_produce_glyphs when no suitable font was found. */
6630 lookup_glyphless_char_display (int c
, struct it
*it
)
6632 Lisp_Object glyphless_method
= Qnil
;
6634 if (CHAR_TABLE_P (Vglyphless_char_display
)
6635 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6639 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6640 if (CONSP (glyphless_method
))
6641 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6642 ? XCAR (glyphless_method
)
6643 : XCDR (glyphless_method
);
6646 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6650 if (NILP (glyphless_method
))
6653 /* The default is to display the character by a proper font. */
6655 /* The default for the no-font case is to display an empty box. */
6656 glyphless_method
= Qempty_box
;
6658 if (EQ (glyphless_method
, Qzero_width
))
6661 return glyphless_method
;
6662 /* This method can't be used for the no-font case. */
6663 glyphless_method
= Qempty_box
;
6665 if (EQ (glyphless_method
, Qthin_space
))
6666 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6667 else if (EQ (glyphless_method
, Qempty_box
))
6668 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6669 else if (EQ (glyphless_method
, Qhex_code
))
6670 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6671 else if (STRINGP (glyphless_method
))
6672 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6675 /* Invalid value. We use the default method. */
6676 glyphless_method
= Qnil
;
6679 it
->what
= IT_GLYPHLESS
;
6680 return glyphless_method
;
6683 /* Load IT's display element fields with information about the next
6684 display element from the current position of IT. Value is zero if
6685 end of buffer (or C string) is reached. */
6687 static struct frame
*last_escape_glyph_frame
= NULL
;
6688 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6689 static int last_escape_glyph_merged_face_id
= 0;
6691 struct frame
*last_glyphless_glyph_frame
= NULL
;
6692 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6693 int last_glyphless_glyph_merged_face_id
= 0;
6696 get_next_display_element (struct it
*it
)
6698 /* Non-zero means that we found a display element. Zero means that
6699 we hit the end of what we iterate over. Performance note: the
6700 function pointer `method' used here turns out to be faster than
6701 using a sequence of if-statements. */
6705 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6707 if (it
->what
== IT_CHARACTER
)
6709 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6710 and only if (a) the resolved directionality of that character
6712 /* FIXME: Do we need an exception for characters from display
6714 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6715 it
->c
= bidi_mirror_char (it
->c
);
6716 /* Map via display table or translate control characters.
6717 IT->c, IT->len etc. have been set to the next character by
6718 the function call above. If we have a display table, and it
6719 contains an entry for IT->c, translate it. Don't do this if
6720 IT->c itself comes from a display table, otherwise we could
6721 end up in an infinite recursion. (An alternative could be to
6722 count the recursion depth of this function and signal an
6723 error when a certain maximum depth is reached.) Is it worth
6725 if (success_p
&& it
->dpvec
== NULL
)
6728 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6729 int nonascii_space_p
= 0;
6730 int nonascii_hyphen_p
= 0;
6731 int c
= it
->c
; /* This is the character to display. */
6733 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6735 eassert (SINGLE_BYTE_CHAR_P (c
));
6736 if (unibyte_display_via_language_environment
)
6738 c
= DECODE_CHAR (unibyte
, c
);
6740 c
= BYTE8_TO_CHAR (it
->c
);
6743 c
= BYTE8_TO_CHAR (it
->c
);
6747 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6750 struct Lisp_Vector
*v
= XVECTOR (dv
);
6752 /* Return the first character from the display table
6753 entry, if not empty. If empty, don't display the
6754 current character. */
6757 it
->dpvec_char_len
= it
->len
;
6758 it
->dpvec
= v
->contents
;
6759 it
->dpend
= v
->contents
+ v
->header
.size
;
6760 it
->current
.dpvec_index
= 0;
6761 it
->dpvec_face_id
= -1;
6762 it
->saved_face_id
= it
->face_id
;
6763 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6768 set_iterator_to_next (it
, 0);
6773 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6775 if (it
->what
== IT_GLYPHLESS
)
6777 /* Don't display this character. */
6778 set_iterator_to_next (it
, 0);
6782 /* If `nobreak-char-display' is non-nil, we display
6783 non-ASCII spaces and hyphens specially. */
6784 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6787 nonascii_space_p
= 1;
6788 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6789 nonascii_hyphen_p
= 1;
6792 /* Translate control characters into `\003' or `^C' form.
6793 Control characters coming from a display table entry are
6794 currently not translated because we use IT->dpvec to hold
6795 the translation. This could easily be changed but I
6796 don't believe that it is worth doing.
6798 The characters handled by `nobreak-char-display' must be
6801 Non-printable characters and raw-byte characters are also
6802 translated to octal form. */
6803 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6804 ? (it
->area
!= TEXT_AREA
6805 /* In mode line, treat \n, \t like other crl chars. */
6808 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6809 || (c
!= '\n' && c
!= '\t'))
6811 || nonascii_hyphen_p
6813 || ! CHAR_PRINTABLE_P (c
))))
6815 /* C is a control character, non-ASCII space/hyphen,
6816 raw-byte, or a non-printable character which must be
6817 displayed either as '\003' or as `^C' where the '\\'
6818 and '^' can be defined in the display table. Fill
6819 IT->ctl_chars with glyphs for what we have to
6820 display. Then, set IT->dpvec to these glyphs. */
6827 /* Handle control characters with ^. */
6829 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6833 g
= '^'; /* default glyph for Control */
6834 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6836 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6838 g
= GLYPH_CODE_CHAR (gc
);
6839 lface_id
= GLYPH_CODE_FACE (gc
);
6843 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6845 else if (it
->f
== last_escape_glyph_frame
6846 && it
->face_id
== last_escape_glyph_face_id
)
6848 face_id
= last_escape_glyph_merged_face_id
;
6852 /* Merge the escape-glyph face into the current face. */
6853 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6855 last_escape_glyph_frame
= it
->f
;
6856 last_escape_glyph_face_id
= it
->face_id
;
6857 last_escape_glyph_merged_face_id
= face_id
;
6860 XSETINT (it
->ctl_chars
[0], g
);
6861 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6863 goto display_control
;
6866 /* Handle non-ascii space in the mode where it only gets
6869 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6871 /* Merge `nobreak-space' into the current face. */
6872 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6874 XSETINT (it
->ctl_chars
[0], ' ');
6876 goto display_control
;
6879 /* Handle sequences that start with the "escape glyph". */
6881 /* the default escape glyph is \. */
6882 escape_glyph
= '\\';
6885 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6887 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6888 lface_id
= GLYPH_CODE_FACE (gc
);
6892 /* The display table specified a face.
6893 Merge it into face_id and also into escape_glyph. */
6894 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6897 else if (it
->f
== last_escape_glyph_frame
6898 && it
->face_id
== last_escape_glyph_face_id
)
6900 face_id
= last_escape_glyph_merged_face_id
;
6904 /* Merge the escape-glyph face into the current face. */
6905 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6907 last_escape_glyph_frame
= it
->f
;
6908 last_escape_glyph_face_id
= it
->face_id
;
6909 last_escape_glyph_merged_face_id
= face_id
;
6912 /* Draw non-ASCII hyphen with just highlighting: */
6914 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6916 XSETINT (it
->ctl_chars
[0], '-');
6918 goto display_control
;
6921 /* Draw non-ASCII space/hyphen with escape glyph: */
6923 if (nonascii_space_p
|| nonascii_hyphen_p
)
6925 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6926 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6928 goto display_control
;
6935 if (CHAR_BYTE8_P (c
))
6936 /* Display \200 instead of \17777600. */
6937 c
= CHAR_TO_BYTE8 (c
);
6938 len
= sprintf (str
, "%03o", c
);
6940 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6941 for (i
= 0; i
< len
; i
++)
6942 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6947 /* Set up IT->dpvec and return first character from it. */
6948 it
->dpvec_char_len
= it
->len
;
6949 it
->dpvec
= it
->ctl_chars
;
6950 it
->dpend
= it
->dpvec
+ ctl_len
;
6951 it
->current
.dpvec_index
= 0;
6952 it
->dpvec_face_id
= face_id
;
6953 it
->saved_face_id
= it
->face_id
;
6954 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6958 it
->char_to_display
= c
;
6962 it
->char_to_display
= it
->c
;
6966 /* Adjust face id for a multibyte character. There are no multibyte
6967 character in unibyte text. */
6968 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6971 && FRAME_WINDOW_P (it
->f
))
6973 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6975 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6977 /* Automatic composition with glyph-string. */
6978 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6980 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6984 ptrdiff_t pos
= (it
->s
? -1
6985 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6986 : IT_CHARPOS (*it
));
6989 if (it
->what
== IT_CHARACTER
)
6990 c
= it
->char_to_display
;
6993 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6997 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6998 /* TAB in a composition means display glyphs with
6999 padding space on the left or right. */
7000 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7003 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7008 /* Is this character the last one of a run of characters with
7009 box? If yes, set IT->end_of_box_run_p to 1. */
7013 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7015 int face_id
= underlying_face_id (it
);
7016 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7020 if (face
->box
== FACE_NO_BOX
)
7022 /* If the box comes from face properties in a
7023 display string, check faces in that string. */
7024 int string_face_id
= face_after_it_pos (it
);
7025 it
->end_of_box_run_p
7026 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7029 /* Otherwise, the box comes from the underlying face.
7030 If this is the last string character displayed, check
7031 the next buffer location. */
7032 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7033 && (it
->current
.overlay_string_index
7034 == it
->n_overlay_strings
- 1))
7038 struct text_pos pos
= it
->current
.pos
;
7039 INC_TEXT_POS (pos
, it
->multibyte_p
);
7041 next_face_id
= face_at_buffer_position
7042 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
7043 it
->region_end_charpos
, &ignore
,
7044 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
7046 it
->end_of_box_run_p
7047 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7052 /* next_element_from_display_vector sets this flag according to
7053 faces of the display vector glyphs, see there. */
7054 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7056 int face_id
= face_after_it_pos (it
);
7057 it
->end_of_box_run_p
7058 = (face_id
!= it
->face_id
7059 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7062 /* If we reached the end of the object we've been iterating (e.g., a
7063 display string or an overlay string), and there's something on
7064 IT->stack, proceed with what's on the stack. It doesn't make
7065 sense to return zero if there's unprocessed stuff on the stack,
7066 because otherwise that stuff will never be displayed. */
7067 if (!success_p
&& it
->sp
> 0)
7069 set_iterator_to_next (it
, 0);
7070 success_p
= get_next_display_element (it
);
7073 /* Value is 0 if end of buffer or string reached. */
7078 /* Move IT to the next display element.
7080 RESEAT_P non-zero means if called on a newline in buffer text,
7081 skip to the next visible line start.
7083 Functions get_next_display_element and set_iterator_to_next are
7084 separate because I find this arrangement easier to handle than a
7085 get_next_display_element function that also increments IT's
7086 position. The way it is we can first look at an iterator's current
7087 display element, decide whether it fits on a line, and if it does,
7088 increment the iterator position. The other way around we probably
7089 would either need a flag indicating whether the iterator has to be
7090 incremented the next time, or we would have to implement a
7091 decrement position function which would not be easy to write. */
7094 set_iterator_to_next (struct it
*it
, int reseat_p
)
7096 /* Reset flags indicating start and end of a sequence of characters
7097 with box. Reset them at the start of this function because
7098 moving the iterator to a new position might set them. */
7099 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7103 case GET_FROM_BUFFER
:
7104 /* The current display element of IT is a character from
7105 current_buffer. Advance in the buffer, and maybe skip over
7106 invisible lines that are so because of selective display. */
7107 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7108 reseat_at_next_visible_line_start (it
, 0);
7109 else if (it
->cmp_it
.id
>= 0)
7111 /* We are currently getting glyphs from a composition. */
7116 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7117 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7118 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7120 it
->cmp_it
.from
= it
->cmp_it
.to
;
7125 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7127 it
->end_charpos
, Qnil
);
7130 else if (! it
->cmp_it
.reversed_p
)
7132 /* Composition created while scanning forward. */
7133 /* Update IT's char/byte positions to point to the first
7134 character of the next grapheme cluster, or to the
7135 character visually after the current composition. */
7136 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7137 bidi_move_to_visually_next (&it
->bidi_it
);
7138 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7139 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7141 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7143 /* Proceed to the next grapheme cluster. */
7144 it
->cmp_it
.from
= it
->cmp_it
.to
;
7148 /* No more grapheme clusters in this composition.
7149 Find the next stop position. */
7150 ptrdiff_t stop
= it
->end_charpos
;
7151 if (it
->bidi_it
.scan_dir
< 0)
7152 /* Now we are scanning backward and don't know
7155 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7156 IT_BYTEPOS (*it
), stop
, Qnil
);
7161 /* Composition created while scanning backward. */
7162 /* Update IT's char/byte positions to point to the last
7163 character of the previous grapheme cluster, or the
7164 character visually after the current composition. */
7165 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7166 bidi_move_to_visually_next (&it
->bidi_it
);
7167 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7168 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7169 if (it
->cmp_it
.from
> 0)
7171 /* Proceed to the previous grapheme cluster. */
7172 it
->cmp_it
.to
= it
->cmp_it
.from
;
7176 /* No more grapheme clusters in this composition.
7177 Find the next stop position. */
7178 ptrdiff_t stop
= it
->end_charpos
;
7179 if (it
->bidi_it
.scan_dir
< 0)
7180 /* Now we are scanning backward and don't know
7183 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7184 IT_BYTEPOS (*it
), stop
, Qnil
);
7190 eassert (it
->len
!= 0);
7194 IT_BYTEPOS (*it
) += it
->len
;
7195 IT_CHARPOS (*it
) += 1;
7199 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7200 /* If this is a new paragraph, determine its base
7201 direction (a.k.a. its base embedding level). */
7202 if (it
->bidi_it
.new_paragraph
)
7203 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7204 bidi_move_to_visually_next (&it
->bidi_it
);
7205 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7206 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7207 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7209 /* As the scan direction was changed, we must
7210 re-compute the stop position for composition. */
7211 ptrdiff_t stop
= it
->end_charpos
;
7212 if (it
->bidi_it
.scan_dir
< 0)
7214 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7215 IT_BYTEPOS (*it
), stop
, Qnil
);
7218 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7222 case GET_FROM_C_STRING
:
7223 /* Current display element of IT is from a C string. */
7225 /* If the string position is beyond string's end, it means
7226 next_element_from_c_string is padding the string with
7227 blanks, in which case we bypass the bidi iterator,
7228 because it cannot deal with such virtual characters. */
7229 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7231 IT_BYTEPOS (*it
) += it
->len
;
7232 IT_CHARPOS (*it
) += 1;
7236 bidi_move_to_visually_next (&it
->bidi_it
);
7237 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7238 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7242 case GET_FROM_DISPLAY_VECTOR
:
7243 /* Current display element of IT is from a display table entry.
7244 Advance in the display table definition. Reset it to null if
7245 end reached, and continue with characters from buffers/
7247 ++it
->current
.dpvec_index
;
7249 /* Restore face of the iterator to what they were before the
7250 display vector entry (these entries may contain faces). */
7251 it
->face_id
= it
->saved_face_id
;
7253 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7255 int recheck_faces
= it
->ellipsis_p
;
7258 it
->method
= GET_FROM_C_STRING
;
7259 else if (STRINGP (it
->string
))
7260 it
->method
= GET_FROM_STRING
;
7263 it
->method
= GET_FROM_BUFFER
;
7264 it
->object
= it
->w
->contents
;
7268 it
->current
.dpvec_index
= -1;
7270 /* Skip over characters which were displayed via IT->dpvec. */
7271 if (it
->dpvec_char_len
< 0)
7272 reseat_at_next_visible_line_start (it
, 1);
7273 else if (it
->dpvec_char_len
> 0)
7275 if (it
->method
== GET_FROM_STRING
7276 && it
->current
.overlay_string_index
>= 0
7277 && it
->n_overlay_strings
> 0)
7278 it
->ignore_overlay_strings_at_pos_p
= 1;
7279 it
->len
= it
->dpvec_char_len
;
7280 set_iterator_to_next (it
, reseat_p
);
7283 /* Maybe recheck faces after display vector */
7285 it
->stop_charpos
= IT_CHARPOS (*it
);
7289 case GET_FROM_STRING
:
7290 /* Current display element is a character from a Lisp string. */
7291 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7292 /* Don't advance past string end. These conditions are true
7293 when set_iterator_to_next is called at the end of
7294 get_next_display_element, in which case the Lisp string is
7295 already exhausted, and all we want is pop the iterator
7297 if (it
->current
.overlay_string_index
>= 0)
7299 /* This is an overlay string, so there's no padding with
7300 spaces, and the number of characters in the string is
7301 where the string ends. */
7302 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7303 goto consider_string_end
;
7307 /* Not an overlay string. There could be padding, so test
7308 against it->end_charpos . */
7309 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7310 goto consider_string_end
;
7312 if (it
->cmp_it
.id
>= 0)
7318 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7319 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7320 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7321 it
->cmp_it
.from
= it
->cmp_it
.to
;
7325 composition_compute_stop_pos (&it
->cmp_it
,
7326 IT_STRING_CHARPOS (*it
),
7327 IT_STRING_BYTEPOS (*it
),
7328 it
->end_charpos
, it
->string
);
7331 else if (! it
->cmp_it
.reversed_p
)
7333 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7334 bidi_move_to_visually_next (&it
->bidi_it
);
7335 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7336 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7338 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7339 it
->cmp_it
.from
= it
->cmp_it
.to
;
7342 ptrdiff_t stop
= it
->end_charpos
;
7343 if (it
->bidi_it
.scan_dir
< 0)
7345 composition_compute_stop_pos (&it
->cmp_it
,
7346 IT_STRING_CHARPOS (*it
),
7347 IT_STRING_BYTEPOS (*it
), stop
,
7353 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7354 bidi_move_to_visually_next (&it
->bidi_it
);
7355 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7356 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7357 if (it
->cmp_it
.from
> 0)
7358 it
->cmp_it
.to
= it
->cmp_it
.from
;
7361 ptrdiff_t stop
= it
->end_charpos
;
7362 if (it
->bidi_it
.scan_dir
< 0)
7364 composition_compute_stop_pos (&it
->cmp_it
,
7365 IT_STRING_CHARPOS (*it
),
7366 IT_STRING_BYTEPOS (*it
), stop
,
7374 /* If the string position is beyond string's end, it
7375 means next_element_from_string is padding the string
7376 with blanks, in which case we bypass the bidi
7377 iterator, because it cannot deal with such virtual
7379 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7381 IT_STRING_BYTEPOS (*it
) += it
->len
;
7382 IT_STRING_CHARPOS (*it
) += 1;
7386 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7388 bidi_move_to_visually_next (&it
->bidi_it
);
7389 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7390 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7391 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7393 ptrdiff_t stop
= it
->end_charpos
;
7395 if (it
->bidi_it
.scan_dir
< 0)
7397 composition_compute_stop_pos (&it
->cmp_it
,
7398 IT_STRING_CHARPOS (*it
),
7399 IT_STRING_BYTEPOS (*it
), stop
,
7405 consider_string_end
:
7407 if (it
->current
.overlay_string_index
>= 0)
7409 /* IT->string is an overlay string. Advance to the
7410 next, if there is one. */
7411 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7414 next_overlay_string (it
);
7416 setup_for_ellipsis (it
, 0);
7421 /* IT->string is not an overlay string. If we reached
7422 its end, and there is something on IT->stack, proceed
7423 with what is on the stack. This can be either another
7424 string, this time an overlay string, or a buffer. */
7425 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7429 if (it
->method
== GET_FROM_STRING
)
7430 goto consider_string_end
;
7435 case GET_FROM_IMAGE
:
7436 case GET_FROM_STRETCH
:
7437 /* The position etc with which we have to proceed are on
7438 the stack. The position may be at the end of a string,
7439 if the `display' property takes up the whole string. */
7440 eassert (it
->sp
> 0);
7442 if (it
->method
== GET_FROM_STRING
)
7443 goto consider_string_end
;
7447 /* There are no other methods defined, so this should be a bug. */
7451 eassert (it
->method
!= GET_FROM_STRING
7452 || (STRINGP (it
->string
)
7453 && IT_STRING_CHARPOS (*it
) >= 0));
7456 /* Load IT's display element fields with information about the next
7457 display element which comes from a display table entry or from the
7458 result of translating a control character to one of the forms `^C'
7461 IT->dpvec holds the glyphs to return as characters.
7462 IT->saved_face_id holds the face id before the display vector--it
7463 is restored into IT->face_id in set_iterator_to_next. */
7466 next_element_from_display_vector (struct it
*it
)
7469 int prev_face_id
= it
->face_id
;
7473 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7475 it
->face_id
= it
->saved_face_id
;
7477 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7478 That seemed totally bogus - so I changed it... */
7479 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7481 if (GLYPH_CODE_P (gc
))
7483 struct face
*this_face
, *prev_face
, *next_face
;
7485 it
->c
= GLYPH_CODE_CHAR (gc
);
7486 it
->len
= CHAR_BYTES (it
->c
);
7488 /* The entry may contain a face id to use. Such a face id is
7489 the id of a Lisp face, not a realized face. A face id of
7490 zero means no face is specified. */
7491 if (it
->dpvec_face_id
>= 0)
7492 it
->face_id
= it
->dpvec_face_id
;
7495 int lface_id
= GLYPH_CODE_FACE (gc
);
7497 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7501 /* Glyphs in the display vector could have the box face, so we
7502 need to set the related flags in the iterator, as
7504 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7505 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7507 /* Is this character the first character of a box-face run? */
7508 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7510 || prev_face
->box
== FACE_NO_BOX
));
7512 /* For the last character of the box-face run, we need to look
7513 either at the next glyph from the display vector, or at the
7514 face we saw before the display vector. */
7515 next_face_id
= it
->saved_face_id
;
7516 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7518 if (it
->dpvec_face_id
>= 0)
7519 next_face_id
= it
->dpvec_face_id
;
7523 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7526 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7530 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7531 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7533 || next_face
->box
== FACE_NO_BOX
));
7534 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7537 /* Display table entry is invalid. Return a space. */
7538 it
->c
= ' ', it
->len
= 1;
7540 /* Don't change position and object of the iterator here. They are
7541 still the values of the character that had this display table
7542 entry or was translated, and that's what we want. */
7543 it
->what
= IT_CHARACTER
;
7547 /* Get the first element of string/buffer in the visual order, after
7548 being reseated to a new position in a string or a buffer. */
7550 get_visually_first_element (struct it
*it
)
7552 int string_p
= STRINGP (it
->string
) || it
->s
;
7553 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7554 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7556 if (STRINGP (it
->string
))
7558 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7559 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7563 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7564 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7567 if (it
->bidi_it
.charpos
== eob
)
7569 /* Nothing to do, but reset the FIRST_ELT flag, like
7570 bidi_paragraph_init does, because we are not going to
7572 it
->bidi_it
.first_elt
= 0;
7574 else if (it
->bidi_it
.charpos
== bob
7576 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7577 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7579 /* If we are at the beginning of a line/string, we can produce
7580 the next element right away. */
7581 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7582 bidi_move_to_visually_next (&it
->bidi_it
);
7586 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7588 /* We need to prime the bidi iterator starting at the line's or
7589 string's beginning, before we will be able to produce the
7592 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7594 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7595 IT_BYTEPOS (*it
), -1,
7596 &it
->bidi_it
.bytepos
);
7597 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7600 /* Now return to buffer/string position where we were asked
7601 to get the next display element, and produce that. */
7602 bidi_move_to_visually_next (&it
->bidi_it
);
7604 while (it
->bidi_it
.bytepos
!= orig_bytepos
7605 && it
->bidi_it
.charpos
< eob
);
7608 /* Adjust IT's position information to where we ended up. */
7609 if (STRINGP (it
->string
))
7611 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7612 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7616 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7617 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7620 if (STRINGP (it
->string
) || !it
->s
)
7622 ptrdiff_t stop
, charpos
, bytepos
;
7624 if (STRINGP (it
->string
))
7627 stop
= SCHARS (it
->string
);
7628 if (stop
> it
->end_charpos
)
7629 stop
= it
->end_charpos
;
7630 charpos
= IT_STRING_CHARPOS (*it
);
7631 bytepos
= IT_STRING_BYTEPOS (*it
);
7635 stop
= it
->end_charpos
;
7636 charpos
= IT_CHARPOS (*it
);
7637 bytepos
= IT_BYTEPOS (*it
);
7639 if (it
->bidi_it
.scan_dir
< 0)
7641 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7646 /* Load IT with the next display element from Lisp string IT->string.
7647 IT->current.string_pos is the current position within the string.
7648 If IT->current.overlay_string_index >= 0, the Lisp string is an
7652 next_element_from_string (struct it
*it
)
7654 struct text_pos position
;
7656 eassert (STRINGP (it
->string
));
7657 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7658 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7659 position
= it
->current
.string_pos
;
7661 /* With bidi reordering, the character to display might not be the
7662 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7663 that we were reseat()ed to a new string, whose paragraph
7664 direction is not known. */
7665 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7667 get_visually_first_element (it
);
7668 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7671 /* Time to check for invisible text? */
7672 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7674 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7677 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7678 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7680 /* With bidi non-linear iteration, we could find
7681 ourselves far beyond the last computed stop_charpos,
7682 with several other stop positions in between that we
7683 missed. Scan them all now, in buffer's logical
7684 order, until we find and handle the last stop_charpos
7685 that precedes our current position. */
7686 handle_stop_backwards (it
, it
->stop_charpos
);
7687 return GET_NEXT_DISPLAY_ELEMENT (it
);
7693 /* Take note of the stop position we just moved
7694 across, for when we will move back across it. */
7695 it
->prev_stop
= it
->stop_charpos
;
7696 /* If we are at base paragraph embedding level, take
7697 note of the last stop position seen at this
7699 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7700 it
->base_level_stop
= it
->stop_charpos
;
7704 /* Since a handler may have changed IT->method, we must
7706 return GET_NEXT_DISPLAY_ELEMENT (it
);
7710 /* If we are before prev_stop, we may have overstepped
7711 on our way backwards a stop_pos, and if so, we need
7712 to handle that stop_pos. */
7713 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7714 /* We can sometimes back up for reasons that have nothing
7715 to do with bidi reordering. E.g., compositions. The
7716 code below is only needed when we are above the base
7717 embedding level, so test for that explicitly. */
7718 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7720 /* If we lost track of base_level_stop, we have no better
7721 place for handle_stop_backwards to start from than string
7722 beginning. This happens, e.g., when we were reseated to
7723 the previous screenful of text by vertical-motion. */
7724 if (it
->base_level_stop
<= 0
7725 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7726 it
->base_level_stop
= 0;
7727 handle_stop_backwards (it
, it
->base_level_stop
);
7728 return GET_NEXT_DISPLAY_ELEMENT (it
);
7732 if (it
->current
.overlay_string_index
>= 0)
7734 /* Get the next character from an overlay string. In overlay
7735 strings, there is no field width or padding with spaces to
7737 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7742 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7743 IT_STRING_BYTEPOS (*it
),
7744 it
->bidi_it
.scan_dir
< 0
7746 : SCHARS (it
->string
))
7747 && next_element_from_composition (it
))
7751 else if (STRING_MULTIBYTE (it
->string
))
7753 const unsigned char *s
= (SDATA (it
->string
)
7754 + IT_STRING_BYTEPOS (*it
));
7755 it
->c
= string_char_and_length (s
, &it
->len
);
7759 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7765 /* Get the next character from a Lisp string that is not an
7766 overlay string. Such strings come from the mode line, for
7767 example. We may have to pad with spaces, or truncate the
7768 string. See also next_element_from_c_string. */
7769 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7774 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7776 /* Pad with spaces. */
7777 it
->c
= ' ', it
->len
= 1;
7778 CHARPOS (position
) = BYTEPOS (position
) = -1;
7780 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7781 IT_STRING_BYTEPOS (*it
),
7782 it
->bidi_it
.scan_dir
< 0
7784 : it
->string_nchars
)
7785 && next_element_from_composition (it
))
7789 else if (STRING_MULTIBYTE (it
->string
))
7791 const unsigned char *s
= (SDATA (it
->string
)
7792 + IT_STRING_BYTEPOS (*it
));
7793 it
->c
= string_char_and_length (s
, &it
->len
);
7797 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7802 /* Record what we have and where it came from. */
7803 it
->what
= IT_CHARACTER
;
7804 it
->object
= it
->string
;
7805 it
->position
= position
;
7810 /* Load IT with next display element from C string IT->s.
7811 IT->string_nchars is the maximum number of characters to return
7812 from the string. IT->end_charpos may be greater than
7813 IT->string_nchars when this function is called, in which case we
7814 may have to return padding spaces. Value is zero if end of string
7815 reached, including padding spaces. */
7818 next_element_from_c_string (struct it
*it
)
7823 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7824 it
->what
= IT_CHARACTER
;
7825 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7828 /* With bidi reordering, the character to display might not be the
7829 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7830 we were reseated to a new string, whose paragraph direction is
7832 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7833 get_visually_first_element (it
);
7835 /* IT's position can be greater than IT->string_nchars in case a
7836 field width or precision has been specified when the iterator was
7838 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7840 /* End of the game. */
7844 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7846 /* Pad with spaces. */
7847 it
->c
= ' ', it
->len
= 1;
7848 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7850 else if (it
->multibyte_p
)
7851 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7853 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7859 /* Set up IT to return characters from an ellipsis, if appropriate.
7860 The definition of the ellipsis glyphs may come from a display table
7861 entry. This function fills IT with the first glyph from the
7862 ellipsis if an ellipsis is to be displayed. */
7865 next_element_from_ellipsis (struct it
*it
)
7867 if (it
->selective_display_ellipsis_p
)
7868 setup_for_ellipsis (it
, it
->len
);
7871 /* The face at the current position may be different from the
7872 face we find after the invisible text. Remember what it
7873 was in IT->saved_face_id, and signal that it's there by
7874 setting face_before_selective_p. */
7875 it
->saved_face_id
= it
->face_id
;
7876 it
->method
= GET_FROM_BUFFER
;
7877 it
->object
= it
->w
->contents
;
7878 reseat_at_next_visible_line_start (it
, 1);
7879 it
->face_before_selective_p
= 1;
7882 return GET_NEXT_DISPLAY_ELEMENT (it
);
7886 /* Deliver an image display element. The iterator IT is already
7887 filled with image information (done in handle_display_prop). Value
7892 next_element_from_image (struct it
*it
)
7894 it
->what
= IT_IMAGE
;
7895 it
->ignore_overlay_strings_at_pos_p
= 0;
7900 /* Fill iterator IT with next display element from a stretch glyph
7901 property. IT->object is the value of the text property. Value is
7905 next_element_from_stretch (struct it
*it
)
7907 it
->what
= IT_STRETCH
;
7911 /* Scan backwards from IT's current position until we find a stop
7912 position, or until BEGV. This is called when we find ourself
7913 before both the last known prev_stop and base_level_stop while
7914 reordering bidirectional text. */
7917 compute_stop_pos_backwards (struct it
*it
)
7919 const int SCAN_BACK_LIMIT
= 1000;
7920 struct text_pos pos
;
7921 struct display_pos save_current
= it
->current
;
7922 struct text_pos save_position
= it
->position
;
7923 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7924 ptrdiff_t where_we_are
= charpos
;
7925 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7926 ptrdiff_t save_end_pos
= it
->end_charpos
;
7928 eassert (NILP (it
->string
) && !it
->s
);
7929 eassert (it
->bidi_p
);
7933 it
->end_charpos
= min (charpos
+ 1, ZV
);
7934 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7935 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
7936 reseat_1 (it
, pos
, 0);
7937 compute_stop_pos (it
);
7938 /* We must advance forward, right? */
7939 if (it
->stop_charpos
<= charpos
)
7942 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7944 if (it
->stop_charpos
<= where_we_are
)
7945 it
->prev_stop
= it
->stop_charpos
;
7947 it
->prev_stop
= BEGV
;
7949 it
->current
= save_current
;
7950 it
->position
= save_position
;
7951 it
->stop_charpos
= save_stop_pos
;
7952 it
->end_charpos
= save_end_pos
;
7955 /* Scan forward from CHARPOS in the current buffer/string, until we
7956 find a stop position > current IT's position. Then handle the stop
7957 position before that. This is called when we bump into a stop
7958 position while reordering bidirectional text. CHARPOS should be
7959 the last previously processed stop_pos (or BEGV/0, if none were
7960 processed yet) whose position is less that IT's current
7964 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7966 int bufp
= !STRINGP (it
->string
);
7967 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7968 struct display_pos save_current
= it
->current
;
7969 struct text_pos save_position
= it
->position
;
7970 struct text_pos pos1
;
7971 ptrdiff_t next_stop
;
7973 /* Scan in strict logical order. */
7974 eassert (it
->bidi_p
);
7978 it
->prev_stop
= charpos
;
7981 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7982 reseat_1 (it
, pos1
, 0);
7985 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7986 compute_stop_pos (it
);
7987 /* We must advance forward, right? */
7988 if (it
->stop_charpos
<= it
->prev_stop
)
7990 charpos
= it
->stop_charpos
;
7992 while (charpos
<= where_we_are
);
7995 it
->current
= save_current
;
7996 it
->position
= save_position
;
7997 next_stop
= it
->stop_charpos
;
7998 it
->stop_charpos
= it
->prev_stop
;
8000 it
->stop_charpos
= next_stop
;
8003 /* Load IT with the next display element from current_buffer. Value
8004 is zero if end of buffer reached. IT->stop_charpos is the next
8005 position at which to stop and check for text properties or buffer
8009 next_element_from_buffer (struct it
*it
)
8013 eassert (IT_CHARPOS (*it
) >= BEGV
);
8014 eassert (NILP (it
->string
) && !it
->s
);
8015 eassert (!it
->bidi_p
8016 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8017 && it
->bidi_it
.string
.s
== NULL
));
8019 /* With bidi reordering, the character to display might not be the
8020 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8021 we were reseat()ed to a new buffer position, which is potentially
8022 a different paragraph. */
8023 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8025 get_visually_first_element (it
);
8026 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8029 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8031 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8033 int overlay_strings_follow_p
;
8035 /* End of the game, except when overlay strings follow that
8036 haven't been returned yet. */
8037 if (it
->overlay_strings_at_end_processed_p
)
8038 overlay_strings_follow_p
= 0;
8041 it
->overlay_strings_at_end_processed_p
= 1;
8042 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8045 if (overlay_strings_follow_p
)
8046 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8050 it
->position
= it
->current
.pos
;
8054 else if (!(!it
->bidi_p
8055 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8056 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8058 /* With bidi non-linear iteration, we could find ourselves
8059 far beyond the last computed stop_charpos, with several
8060 other stop positions in between that we missed. Scan
8061 them all now, in buffer's logical order, until we find
8062 and handle the last stop_charpos that precedes our
8063 current position. */
8064 handle_stop_backwards (it
, it
->stop_charpos
);
8065 return GET_NEXT_DISPLAY_ELEMENT (it
);
8071 /* Take note of the stop position we just moved across,
8072 for when we will move back across it. */
8073 it
->prev_stop
= it
->stop_charpos
;
8074 /* If we are at base paragraph embedding level, take
8075 note of the last stop position seen at this
8077 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8078 it
->base_level_stop
= it
->stop_charpos
;
8081 return GET_NEXT_DISPLAY_ELEMENT (it
);
8085 /* If we are before prev_stop, we may have overstepped on
8086 our way backwards a stop_pos, and if so, we need to
8087 handle that stop_pos. */
8088 && IT_CHARPOS (*it
) < it
->prev_stop
8089 /* We can sometimes back up for reasons that have nothing
8090 to do with bidi reordering. E.g., compositions. The
8091 code below is only needed when we are above the base
8092 embedding level, so test for that explicitly. */
8093 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8095 if (it
->base_level_stop
<= 0
8096 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8098 /* If we lost track of base_level_stop, we need to find
8099 prev_stop by looking backwards. This happens, e.g., when
8100 we were reseated to the previous screenful of text by
8102 it
->base_level_stop
= BEGV
;
8103 compute_stop_pos_backwards (it
);
8104 handle_stop_backwards (it
, it
->prev_stop
);
8107 handle_stop_backwards (it
, it
->base_level_stop
);
8108 return GET_NEXT_DISPLAY_ELEMENT (it
);
8112 /* No face changes, overlays etc. in sight, so just return a
8113 character from current_buffer. */
8117 /* Maybe run the redisplay end trigger hook. Performance note:
8118 This doesn't seem to cost measurable time. */
8119 if (it
->redisplay_end_trigger_charpos
8121 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8122 run_redisplay_end_trigger_hook (it
);
8124 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8125 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8127 && next_element_from_composition (it
))
8132 /* Get the next character, maybe multibyte. */
8133 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8134 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
8135 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8137 it
->c
= *p
, it
->len
= 1;
8139 /* Record what we have and where it came from. */
8140 it
->what
= IT_CHARACTER
;
8141 it
->object
= it
->w
->contents
;
8142 it
->position
= it
->current
.pos
;
8144 /* Normally we return the character found above, except when we
8145 really want to return an ellipsis for selective display. */
8150 /* A value of selective > 0 means hide lines indented more
8151 than that number of columns. */
8152 if (it
->selective
> 0
8153 && IT_CHARPOS (*it
) + 1 < ZV
8154 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8155 IT_BYTEPOS (*it
) + 1,
8158 success_p
= next_element_from_ellipsis (it
);
8159 it
->dpvec_char_len
= -1;
8162 else if (it
->c
== '\r' && it
->selective
== -1)
8164 /* A value of selective == -1 means that everything from the
8165 CR to the end of the line is invisible, with maybe an
8166 ellipsis displayed for it. */
8167 success_p
= next_element_from_ellipsis (it
);
8168 it
->dpvec_char_len
= -1;
8173 /* Value is zero if end of buffer reached. */
8174 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8179 /* Run the redisplay end trigger hook for IT. */
8182 run_redisplay_end_trigger_hook (struct it
*it
)
8184 Lisp_Object args
[3];
8186 /* IT->glyph_row should be non-null, i.e. we should be actually
8187 displaying something, or otherwise we should not run the hook. */
8188 eassert (it
->glyph_row
);
8190 /* Set up hook arguments. */
8191 args
[0] = Qredisplay_end_trigger_functions
;
8192 args
[1] = it
->window
;
8193 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8194 it
->redisplay_end_trigger_charpos
= 0;
8196 /* Since we are *trying* to run these functions, don't try to run
8197 them again, even if they get an error. */
8198 wset_redisplay_end_trigger (it
->w
, Qnil
);
8199 Frun_hook_with_args (3, args
);
8201 /* Notice if it changed the face of the character we are on. */
8202 handle_face_prop (it
);
8206 /* Deliver a composition display element. Unlike the other
8207 next_element_from_XXX, this function is not registered in the array
8208 get_next_element[]. It is called from next_element_from_buffer and
8209 next_element_from_string when necessary. */
8212 next_element_from_composition (struct it
*it
)
8214 it
->what
= IT_COMPOSITION
;
8215 it
->len
= it
->cmp_it
.nbytes
;
8216 if (STRINGP (it
->string
))
8220 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8221 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8224 it
->position
= it
->current
.string_pos
;
8225 it
->object
= it
->string
;
8226 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8227 IT_STRING_BYTEPOS (*it
), it
->string
);
8233 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8234 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8237 if (it
->bidi_it
.new_paragraph
)
8238 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8239 /* Resync the bidi iterator with IT's new position.
8240 FIXME: this doesn't support bidirectional text. */
8241 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8242 bidi_move_to_visually_next (&it
->bidi_it
);
8246 it
->position
= it
->current
.pos
;
8247 it
->object
= it
->w
->contents
;
8248 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8249 IT_BYTEPOS (*it
), Qnil
);
8256 /***********************************************************************
8257 Moving an iterator without producing glyphs
8258 ***********************************************************************/
8260 /* Check if iterator is at a position corresponding to a valid buffer
8261 position after some move_it_ call. */
8263 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8264 ((it)->method == GET_FROM_STRING \
8265 ? IT_STRING_CHARPOS (*it) == 0 \
8269 /* Move iterator IT to a specified buffer or X position within one
8270 line on the display without producing glyphs.
8272 OP should be a bit mask including some or all of these bits:
8273 MOVE_TO_X: Stop upon reaching x-position TO_X.
8274 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8275 Regardless of OP's value, stop upon reaching the end of the display line.
8277 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8278 This means, in particular, that TO_X includes window's horizontal
8281 The return value has several possible values that
8282 say what condition caused the scan to stop:
8284 MOVE_POS_MATCH_OR_ZV
8285 - when TO_POS or ZV was reached.
8288 -when TO_X was reached before TO_POS or ZV were reached.
8291 - when we reached the end of the display area and the line must
8295 - when we reached the end of the display area and the line is
8299 - when we stopped at a line end, i.e. a newline or a CR and selective
8302 static enum move_it_result
8303 move_it_in_display_line_to (struct it
*it
,
8304 ptrdiff_t to_charpos
, int to_x
,
8305 enum move_operation_enum op
)
8307 enum move_it_result result
= MOVE_UNDEFINED
;
8308 struct glyph_row
*saved_glyph_row
;
8309 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8310 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8311 void *ppos_data
= NULL
;
8313 enum it_method prev_method
= it
->method
;
8314 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8315 int saw_smaller_pos
= prev_pos
< to_charpos
;
8317 /* Don't produce glyphs in produce_glyphs. */
8318 saved_glyph_row
= it
->glyph_row
;
8319 it
->glyph_row
= NULL
;
8321 /* Use wrap_it to save a copy of IT wherever a word wrap could
8322 occur. Use atpos_it to save a copy of IT at the desired buffer
8323 position, if found, so that we can scan ahead and check if the
8324 word later overshoots the window edge. Use atx_it similarly, for
8330 /* Use ppos_it under bidi reordering to save a copy of IT for the
8331 position > CHARPOS that is the closest to CHARPOS. We restore
8332 that position in IT when we have scanned the entire display line
8333 without finding a match for CHARPOS and all the character
8334 positions are greater than CHARPOS. */
8337 SAVE_IT (ppos_it
, *it
, ppos_data
);
8338 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8339 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8340 SAVE_IT (ppos_it
, *it
, ppos_data
);
8343 #define BUFFER_POS_REACHED_P() \
8344 ((op & MOVE_TO_POS) != 0 \
8345 && BUFFERP (it->object) \
8346 && (IT_CHARPOS (*it) == to_charpos \
8348 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8349 && IT_CHARPOS (*it) > to_charpos) \
8350 || (it->what == IT_COMPOSITION \
8351 && ((IT_CHARPOS (*it) > to_charpos \
8352 && to_charpos >= it->cmp_it.charpos) \
8353 || (IT_CHARPOS (*it) < to_charpos \
8354 && to_charpos <= it->cmp_it.charpos)))) \
8355 && (it->method == GET_FROM_BUFFER \
8356 || (it->method == GET_FROM_DISPLAY_VECTOR \
8357 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8359 /* If there's a line-/wrap-prefix, handle it. */
8360 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8361 && it
->current_y
< it
->last_visible_y
)
8362 handle_line_prefix (it
);
8364 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8365 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8369 int x
, i
, ascent
= 0, descent
= 0;
8371 /* Utility macro to reset an iterator with x, ascent, and descent. */
8372 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8373 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8374 (IT)->max_descent = descent)
8376 /* Stop if we move beyond TO_CHARPOS (after an image or a
8377 display string or stretch glyph). */
8378 if ((op
& MOVE_TO_POS
) != 0
8379 && BUFFERP (it
->object
)
8380 && it
->method
== GET_FROM_BUFFER
8382 /* When the iterator is at base embedding level, we
8383 are guaranteed that characters are delivered for
8384 display in strictly increasing order of their
8385 buffer positions. */
8386 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8387 && IT_CHARPOS (*it
) > to_charpos
)
8389 && (prev_method
== GET_FROM_IMAGE
8390 || prev_method
== GET_FROM_STRETCH
8391 || prev_method
== GET_FROM_STRING
)
8392 /* Passed TO_CHARPOS from left to right. */
8393 && ((prev_pos
< to_charpos
8394 && IT_CHARPOS (*it
) > to_charpos
)
8395 /* Passed TO_CHARPOS from right to left. */
8396 || (prev_pos
> to_charpos
8397 && IT_CHARPOS (*it
) < to_charpos
)))))
8399 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8401 result
= MOVE_POS_MATCH_OR_ZV
;
8404 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8405 /* If wrap_it is valid, the current position might be in a
8406 word that is wrapped. So, save the iterator in
8407 atpos_it and continue to see if wrapping happens. */
8408 SAVE_IT (atpos_it
, *it
, atpos_data
);
8411 /* Stop when ZV reached.
8412 We used to stop here when TO_CHARPOS reached as well, but that is
8413 too soon if this glyph does not fit on this line. So we handle it
8414 explicitly below. */
8415 if (!get_next_display_element (it
))
8417 result
= MOVE_POS_MATCH_OR_ZV
;
8421 if (it
->line_wrap
== TRUNCATE
)
8423 if (BUFFER_POS_REACHED_P ())
8425 result
= MOVE_POS_MATCH_OR_ZV
;
8431 if (it
->line_wrap
== WORD_WRAP
)
8433 if (IT_DISPLAYING_WHITESPACE (it
))
8437 /* We have reached a glyph that follows one or more
8438 whitespace characters. If the position is
8439 already found, we are done. */
8440 if (atpos_it
.sp
>= 0)
8442 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8443 result
= MOVE_POS_MATCH_OR_ZV
;
8448 RESTORE_IT (it
, &atx_it
, atx_data
);
8449 result
= MOVE_X_REACHED
;
8452 /* Otherwise, we can wrap here. */
8453 SAVE_IT (wrap_it
, *it
, wrap_data
);
8459 /* Remember the line height for the current line, in case
8460 the next element doesn't fit on the line. */
8461 ascent
= it
->max_ascent
;
8462 descent
= it
->max_descent
;
8464 /* The call to produce_glyphs will get the metrics of the
8465 display element IT is loaded with. Record the x-position
8466 before this display element, in case it doesn't fit on the
8470 PRODUCE_GLYPHS (it
);
8472 if (it
->area
!= TEXT_AREA
)
8474 prev_method
= it
->method
;
8475 if (it
->method
== GET_FROM_BUFFER
)
8476 prev_pos
= IT_CHARPOS (*it
);
8477 set_iterator_to_next (it
, 1);
8478 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8479 SET_TEXT_POS (this_line_min_pos
,
8480 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8482 && (op
& MOVE_TO_POS
)
8483 && IT_CHARPOS (*it
) > to_charpos
8484 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8485 SAVE_IT (ppos_it
, *it
, ppos_data
);
8489 /* The number of glyphs we get back in IT->nglyphs will normally
8490 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8491 character on a terminal frame, or (iii) a line end. For the
8492 second case, IT->nglyphs - 1 padding glyphs will be present.
8493 (On X frames, there is only one glyph produced for a
8494 composite character.)
8496 The behavior implemented below means, for continuation lines,
8497 that as many spaces of a TAB as fit on the current line are
8498 displayed there. For terminal frames, as many glyphs of a
8499 multi-glyph character are displayed in the current line, too.
8500 This is what the old redisplay code did, and we keep it that
8501 way. Under X, the whole shape of a complex character must
8502 fit on the line or it will be completely displayed in the
8505 Note that both for tabs and padding glyphs, all glyphs have
8509 /* More than one glyph or glyph doesn't fit on line. All
8510 glyphs have the same width. */
8511 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8513 int x_before_this_char
= x
;
8514 int hpos_before_this_char
= it
->hpos
;
8516 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8518 new_x
= x
+ single_glyph_width
;
8520 /* We want to leave anything reaching TO_X to the caller. */
8521 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8523 if (BUFFER_POS_REACHED_P ())
8525 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8526 goto buffer_pos_reached
;
8527 if (atpos_it
.sp
< 0)
8529 SAVE_IT (atpos_it
, *it
, atpos_data
);
8530 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8535 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8538 result
= MOVE_X_REACHED
;
8543 SAVE_IT (atx_it
, *it
, atx_data
);
8544 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8549 if (/* Lines are continued. */
8550 it
->line_wrap
!= TRUNCATE
8551 && (/* And glyph doesn't fit on the line. */
8552 new_x
> it
->last_visible_x
8553 /* Or it fits exactly and we're on a window
8555 || (new_x
== it
->last_visible_x
8556 && FRAME_WINDOW_P (it
->f
)
8557 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8558 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8559 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8561 if (/* IT->hpos == 0 means the very first glyph
8562 doesn't fit on the line, e.g. a wide image. */
8564 || (new_x
== it
->last_visible_x
8565 && FRAME_WINDOW_P (it
->f
)))
8568 it
->current_x
= new_x
;
8570 /* The character's last glyph just barely fits
8572 if (i
== it
->nglyphs
- 1)
8574 /* If this is the destination position,
8575 return a position *before* it in this row,
8576 now that we know it fits in this row. */
8577 if (BUFFER_POS_REACHED_P ())
8579 if (it
->line_wrap
!= WORD_WRAP
8582 it
->hpos
= hpos_before_this_char
;
8583 it
->current_x
= x_before_this_char
;
8584 result
= MOVE_POS_MATCH_OR_ZV
;
8587 if (it
->line_wrap
== WORD_WRAP
8590 SAVE_IT (atpos_it
, *it
, atpos_data
);
8591 atpos_it
.current_x
= x_before_this_char
;
8592 atpos_it
.hpos
= hpos_before_this_char
;
8596 prev_method
= it
->method
;
8597 if (it
->method
== GET_FROM_BUFFER
)
8598 prev_pos
= IT_CHARPOS (*it
);
8599 set_iterator_to_next (it
, 1);
8600 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8601 SET_TEXT_POS (this_line_min_pos
,
8602 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8603 /* On graphical terminals, newlines may
8604 "overflow" into the fringe if
8605 overflow-newline-into-fringe is non-nil.
8606 On text terminals, and on graphical
8607 terminals with no right margin, newlines
8608 may overflow into the last glyph on the
8610 if (!FRAME_WINDOW_P (it
->f
)
8612 && it
->bidi_it
.paragraph_dir
== R2L
)
8613 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8614 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8615 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8617 if (!get_next_display_element (it
))
8619 result
= MOVE_POS_MATCH_OR_ZV
;
8622 if (BUFFER_POS_REACHED_P ())
8624 if (ITERATOR_AT_END_OF_LINE_P (it
))
8625 result
= MOVE_POS_MATCH_OR_ZV
;
8627 result
= MOVE_LINE_CONTINUED
;
8630 if (ITERATOR_AT_END_OF_LINE_P (it
)
8631 && (it
->line_wrap
!= WORD_WRAP
8634 result
= MOVE_NEWLINE_OR_CR
;
8641 IT_RESET_X_ASCENT_DESCENT (it
);
8643 if (wrap_it
.sp
>= 0)
8645 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8650 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8652 result
= MOVE_LINE_CONTINUED
;
8656 if (BUFFER_POS_REACHED_P ())
8658 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8659 goto buffer_pos_reached
;
8660 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8662 SAVE_IT (atpos_it
, *it
, atpos_data
);
8663 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8667 if (new_x
> it
->first_visible_x
)
8669 /* Glyph is visible. Increment number of glyphs that
8670 would be displayed. */
8675 if (result
!= MOVE_UNDEFINED
)
8678 else if (BUFFER_POS_REACHED_P ())
8681 IT_RESET_X_ASCENT_DESCENT (it
);
8682 result
= MOVE_POS_MATCH_OR_ZV
;
8685 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8687 /* Stop when TO_X specified and reached. This check is
8688 necessary here because of lines consisting of a line end,
8689 only. The line end will not produce any glyphs and we
8690 would never get MOVE_X_REACHED. */
8691 eassert (it
->nglyphs
== 0);
8692 result
= MOVE_X_REACHED
;
8696 /* Is this a line end? If yes, we're done. */
8697 if (ITERATOR_AT_END_OF_LINE_P (it
))
8699 /* If we are past TO_CHARPOS, but never saw any character
8700 positions smaller than TO_CHARPOS, return
8701 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8703 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8705 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8707 if (IT_CHARPOS (ppos_it
) < ZV
)
8709 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8710 result
= MOVE_POS_MATCH_OR_ZV
;
8713 goto buffer_pos_reached
;
8715 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8716 && IT_CHARPOS (*it
) > to_charpos
)
8717 goto buffer_pos_reached
;
8719 result
= MOVE_NEWLINE_OR_CR
;
8722 result
= MOVE_NEWLINE_OR_CR
;
8726 prev_method
= it
->method
;
8727 if (it
->method
== GET_FROM_BUFFER
)
8728 prev_pos
= IT_CHARPOS (*it
);
8729 /* The current display element has been consumed. Advance
8731 set_iterator_to_next (it
, 1);
8732 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8733 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8734 if (IT_CHARPOS (*it
) < to_charpos
)
8735 saw_smaller_pos
= 1;
8737 && (op
& MOVE_TO_POS
)
8738 && IT_CHARPOS (*it
) >= to_charpos
8739 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8740 SAVE_IT (ppos_it
, *it
, ppos_data
);
8742 /* Stop if lines are truncated and IT's current x-position is
8743 past the right edge of the window now. */
8744 if (it
->line_wrap
== TRUNCATE
8745 && it
->current_x
>= it
->last_visible_x
)
8747 if (!FRAME_WINDOW_P (it
->f
)
8748 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8749 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8750 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8751 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8755 if ((at_eob_p
= !get_next_display_element (it
))
8756 || BUFFER_POS_REACHED_P ()
8757 /* If we are past TO_CHARPOS, but never saw any
8758 character positions smaller than TO_CHARPOS,
8759 return MOVE_POS_MATCH_OR_ZV, like the
8760 unidirectional display did. */
8761 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8763 && IT_CHARPOS (*it
) > to_charpos
))
8766 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8767 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8768 result
= MOVE_POS_MATCH_OR_ZV
;
8771 if (ITERATOR_AT_END_OF_LINE_P (it
))
8773 result
= MOVE_NEWLINE_OR_CR
;
8777 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8779 && IT_CHARPOS (*it
) > to_charpos
)
8781 if (IT_CHARPOS (ppos_it
) < ZV
)
8782 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8783 result
= MOVE_POS_MATCH_OR_ZV
;
8786 result
= MOVE_LINE_TRUNCATED
;
8789 #undef IT_RESET_X_ASCENT_DESCENT
8792 #undef BUFFER_POS_REACHED_P
8794 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8795 restore the saved iterator. */
8796 if (atpos_it
.sp
>= 0)
8797 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8798 else if (atx_it
.sp
>= 0)
8799 RESTORE_IT (it
, &atx_it
, atx_data
);
8804 bidi_unshelve_cache (atpos_data
, 1);
8806 bidi_unshelve_cache (atx_data
, 1);
8808 bidi_unshelve_cache (wrap_data
, 1);
8810 bidi_unshelve_cache (ppos_data
, 1);
8812 /* Restore the iterator settings altered at the beginning of this
8814 it
->glyph_row
= saved_glyph_row
;
8818 /* For external use. */
8820 move_it_in_display_line (struct it
*it
,
8821 ptrdiff_t to_charpos
, int to_x
,
8822 enum move_operation_enum op
)
8824 if (it
->line_wrap
== WORD_WRAP
8825 && (op
& MOVE_TO_X
))
8828 void *save_data
= NULL
;
8831 SAVE_IT (save_it
, *it
, save_data
);
8832 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8833 /* When word-wrap is on, TO_X may lie past the end
8834 of a wrapped line. Then it->current is the
8835 character on the next line, so backtrack to the
8836 space before the wrap point. */
8837 if (skip
== MOVE_LINE_CONTINUED
)
8839 int prev_x
= max (it
->current_x
- 1, 0);
8840 RESTORE_IT (it
, &save_it
, save_data
);
8841 move_it_in_display_line_to
8842 (it
, -1, prev_x
, MOVE_TO_X
);
8845 bidi_unshelve_cache (save_data
, 1);
8848 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8852 /* Move IT forward until it satisfies one or more of the criteria in
8853 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8855 OP is a bit-mask that specifies where to stop, and in particular,
8856 which of those four position arguments makes a difference. See the
8857 description of enum move_operation_enum.
8859 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8860 screen line, this function will set IT to the next position that is
8861 displayed to the right of TO_CHARPOS on the screen. */
8864 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8866 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8867 int line_height
, line_start_x
= 0, reached
= 0;
8868 void *backup_data
= NULL
;
8872 if (op
& MOVE_TO_VPOS
)
8874 /* If no TO_CHARPOS and no TO_X specified, stop at the
8875 start of the line TO_VPOS. */
8876 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8878 if (it
->vpos
== to_vpos
)
8884 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8888 /* TO_VPOS >= 0 means stop at TO_X in the line at
8889 TO_VPOS, or at TO_POS, whichever comes first. */
8890 if (it
->vpos
== to_vpos
)
8896 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8898 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8903 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8905 /* We have reached TO_X but not in the line we want. */
8906 skip
= move_it_in_display_line_to (it
, to_charpos
,
8908 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8916 else if (op
& MOVE_TO_Y
)
8918 struct it it_backup
;
8920 if (it
->line_wrap
== WORD_WRAP
)
8921 SAVE_IT (it_backup
, *it
, backup_data
);
8923 /* TO_Y specified means stop at TO_X in the line containing
8924 TO_Y---or at TO_CHARPOS if this is reached first. The
8925 problem is that we can't really tell whether the line
8926 contains TO_Y before we have completely scanned it, and
8927 this may skip past TO_X. What we do is to first scan to
8930 If TO_X is not specified, use a TO_X of zero. The reason
8931 is to make the outcome of this function more predictable.
8932 If we didn't use TO_X == 0, we would stop at the end of
8933 the line which is probably not what a caller would expect
8935 skip
= move_it_in_display_line_to
8936 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8937 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8939 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8940 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8942 else if (skip
== MOVE_X_REACHED
)
8944 /* If TO_X was reached, we want to know whether TO_Y is
8945 in the line. We know this is the case if the already
8946 scanned glyphs make the line tall enough. Otherwise,
8947 we must check by scanning the rest of the line. */
8948 line_height
= it
->max_ascent
+ it
->max_descent
;
8949 if (to_y
>= it
->current_y
8950 && to_y
< it
->current_y
+ line_height
)
8955 SAVE_IT (it_backup
, *it
, backup_data
);
8956 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8957 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8959 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8960 line_height
= it
->max_ascent
+ it
->max_descent
;
8961 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8963 if (to_y
>= it
->current_y
8964 && to_y
< it
->current_y
+ line_height
)
8966 /* If TO_Y is in this line and TO_X was reached
8967 above, we scanned too far. We have to restore
8968 IT's settings to the ones before skipping. But
8969 keep the more accurate values of max_ascent and
8970 max_descent we've found while skipping the rest
8971 of the line, for the sake of callers, such as
8972 pos_visible_p, that need to know the line
8974 int max_ascent
= it
->max_ascent
;
8975 int max_descent
= it
->max_descent
;
8977 RESTORE_IT (it
, &it_backup
, backup_data
);
8978 it
->max_ascent
= max_ascent
;
8979 it
->max_descent
= max_descent
;
8985 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8991 /* Check whether TO_Y is in this line. */
8992 line_height
= it
->max_ascent
+ it
->max_descent
;
8993 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8995 if (to_y
>= it
->current_y
8996 && to_y
< it
->current_y
+ line_height
)
8998 /* When word-wrap is on, TO_X may lie past the end
8999 of a wrapped line. Then it->current is the
9000 character on the next line, so backtrack to the
9001 space before the wrap point. */
9002 if (skip
== MOVE_LINE_CONTINUED
9003 && it
->line_wrap
== WORD_WRAP
)
9005 int prev_x
= max (it
->current_x
- 1, 0);
9006 RESTORE_IT (it
, &it_backup
, backup_data
);
9007 skip
= move_it_in_display_line_to
9008 (it
, -1, prev_x
, MOVE_TO_X
);
9017 else if (BUFFERP (it
->object
)
9018 && (it
->method
== GET_FROM_BUFFER
9019 || it
->method
== GET_FROM_STRETCH
)
9020 && IT_CHARPOS (*it
) >= to_charpos
9021 /* Under bidi iteration, a call to set_iterator_to_next
9022 can scan far beyond to_charpos if the initial
9023 portion of the next line needs to be reordered. In
9024 that case, give move_it_in_display_line_to another
9027 && it
->bidi_it
.scan_dir
== -1))
9028 skip
= MOVE_POS_MATCH_OR_ZV
;
9030 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9034 case MOVE_POS_MATCH_OR_ZV
:
9038 case MOVE_NEWLINE_OR_CR
:
9039 set_iterator_to_next (it
, 1);
9040 it
->continuation_lines_width
= 0;
9043 case MOVE_LINE_TRUNCATED
:
9044 it
->continuation_lines_width
= 0;
9045 reseat_at_next_visible_line_start (it
, 0);
9046 if ((op
& MOVE_TO_POS
) != 0
9047 && IT_CHARPOS (*it
) > to_charpos
)
9054 case MOVE_LINE_CONTINUED
:
9055 /* For continued lines ending in a tab, some of the glyphs
9056 associated with the tab are displayed on the current
9057 line. Since it->current_x does not include these glyphs,
9058 we use it->last_visible_x instead. */
9061 it
->continuation_lines_width
+= it
->last_visible_x
;
9062 /* When moving by vpos, ensure that the iterator really
9063 advances to the next line (bug#847, bug#969). Fixme:
9064 do we need to do this in other circumstances? */
9065 if (it
->current_x
!= it
->last_visible_x
9066 && (op
& MOVE_TO_VPOS
)
9067 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9069 line_start_x
= it
->current_x
+ it
->pixel_width
9070 - it
->last_visible_x
;
9071 set_iterator_to_next (it
, 0);
9075 it
->continuation_lines_width
+= it
->current_x
;
9082 /* Reset/increment for the next run. */
9083 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9084 it
->current_x
= line_start_x
;
9087 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9089 last_height
= it
->max_ascent
+ it
->max_descent
;
9090 it
->max_ascent
= it
->max_descent
= 0;
9095 /* On text terminals, we may stop at the end of a line in the middle
9096 of a multi-character glyph. If the glyph itself is continued,
9097 i.e. it is actually displayed on the next line, don't treat this
9098 stopping point as valid; move to the next line instead (unless
9099 that brings us offscreen). */
9100 if (!FRAME_WINDOW_P (it
->f
)
9102 && IT_CHARPOS (*it
) == to_charpos
9103 && it
->what
== IT_CHARACTER
9105 && it
->line_wrap
== WINDOW_WRAP
9106 && it
->current_x
== it
->last_visible_x
- 1
9109 && it
->vpos
< it
->w
->window_end_vpos
)
9111 it
->continuation_lines_width
+= it
->current_x
;
9112 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9113 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9115 last_height
= it
->max_ascent
+ it
->max_descent
;
9119 bidi_unshelve_cache (backup_data
, 1);
9121 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9125 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9127 If DY > 0, move IT backward at least that many pixels. DY = 0
9128 means move IT backward to the preceding line start or BEGV. This
9129 function may move over more than DY pixels if IT->current_y - DY
9130 ends up in the middle of a line; in this case IT->current_y will be
9131 set to the top of the line moved to. */
9134 move_it_vertically_backward (struct it
*it
, int dy
)
9138 void *it2data
= NULL
, *it3data
= NULL
;
9139 ptrdiff_t start_pos
;
9141 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9142 ptrdiff_t pos_limit
;
9147 start_pos
= IT_CHARPOS (*it
);
9149 /* Estimate how many newlines we must move back. */
9150 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9151 if (it
->line_wrap
== TRUNCATE
)
9154 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9156 /* Set the iterator's position that many lines back. But don't go
9157 back more than NLINES full screen lines -- this wins a day with
9158 buffers which have very long lines. */
9159 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9160 back_to_previous_visible_line_start (it
);
9162 /* Reseat the iterator here. When moving backward, we don't want
9163 reseat to skip forward over invisible text, set up the iterator
9164 to deliver from overlay strings at the new position etc. So,
9165 use reseat_1 here. */
9166 reseat_1 (it
, it
->current
.pos
, 1);
9168 /* We are now surely at a line start. */
9169 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9170 reordering is in effect. */
9171 it
->continuation_lines_width
= 0;
9173 /* Move forward and see what y-distance we moved. First move to the
9174 start of the next line so that we get its height. We need this
9175 height to be able to tell whether we reached the specified
9177 SAVE_IT (it2
, *it
, it2data
);
9178 it2
.max_ascent
= it2
.max_descent
= 0;
9181 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9182 MOVE_TO_POS
| MOVE_TO_VPOS
);
9184 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9185 /* If we are in a display string which starts at START_POS,
9186 and that display string includes a newline, and we are
9187 right after that newline (i.e. at the beginning of a
9188 display line), exit the loop, because otherwise we will
9189 infloop, since move_it_to will see that it is already at
9190 START_POS and will not move. */
9191 || (it2
.method
== GET_FROM_STRING
9192 && IT_CHARPOS (it2
) == start_pos
9193 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9194 eassert (IT_CHARPOS (*it
) >= BEGV
);
9195 SAVE_IT (it3
, it2
, it3data
);
9197 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9198 eassert (IT_CHARPOS (*it
) >= BEGV
);
9199 /* H is the actual vertical distance from the position in *IT
9200 and the starting position. */
9201 h
= it2
.current_y
- it
->current_y
;
9202 /* NLINES is the distance in number of lines. */
9203 nlines
= it2
.vpos
- it
->vpos
;
9205 /* Correct IT's y and vpos position
9206 so that they are relative to the starting point. */
9212 /* DY == 0 means move to the start of the screen line. The
9213 value of nlines is > 0 if continuation lines were involved,
9214 or if the original IT position was at start of a line. */
9215 RESTORE_IT (it
, it
, it2data
);
9217 move_it_by_lines (it
, nlines
);
9218 /* The above code moves us to some position NLINES down,
9219 usually to its first glyph (leftmost in an L2R line), but
9220 that's not necessarily the start of the line, under bidi
9221 reordering. We want to get to the character position
9222 that is immediately after the newline of the previous
9225 && !it
->continuation_lines_width
9226 && !STRINGP (it
->string
)
9227 && IT_CHARPOS (*it
) > BEGV
9228 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9230 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9233 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9234 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9236 bidi_unshelve_cache (it3data
, 1);
9240 /* The y-position we try to reach, relative to *IT.
9241 Note that H has been subtracted in front of the if-statement. */
9242 int target_y
= it
->current_y
+ h
- dy
;
9243 int y0
= it3
.current_y
;
9247 RESTORE_IT (&it3
, &it3
, it3data
);
9248 y1
= line_bottom_y (&it3
);
9249 line_height
= y1
- y0
;
9250 RESTORE_IT (it
, it
, it2data
);
9251 /* If we did not reach target_y, try to move further backward if
9252 we can. If we moved too far backward, try to move forward. */
9253 if (target_y
< it
->current_y
9254 /* This is heuristic. In a window that's 3 lines high, with
9255 a line height of 13 pixels each, recentering with point
9256 on the bottom line will try to move -39/2 = 19 pixels
9257 backward. Try to avoid moving into the first line. */
9258 && (it
->current_y
- target_y
9259 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9260 && IT_CHARPOS (*it
) > BEGV
)
9262 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9263 target_y
- it
->current_y
));
9264 dy
= it
->current_y
- target_y
;
9265 goto move_further_back
;
9267 else if (target_y
>= it
->current_y
+ line_height
9268 && IT_CHARPOS (*it
) < ZV
)
9270 /* Should move forward by at least one line, maybe more.
9272 Note: Calling move_it_by_lines can be expensive on
9273 terminal frames, where compute_motion is used (via
9274 vmotion) to do the job, when there are very long lines
9275 and truncate-lines is nil. That's the reason for
9276 treating terminal frames specially here. */
9278 if (!FRAME_WINDOW_P (it
->f
))
9279 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9284 move_it_by_lines (it
, 1);
9286 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9293 /* Move IT by a specified amount of pixel lines DY. DY negative means
9294 move backwards. DY = 0 means move to start of screen line. At the
9295 end, IT will be on the start of a screen line. */
9298 move_it_vertically (struct it
*it
, int dy
)
9301 move_it_vertically_backward (it
, -dy
);
9304 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9305 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9306 MOVE_TO_POS
| MOVE_TO_Y
);
9307 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9309 /* If buffer ends in ZV without a newline, move to the start of
9310 the line to satisfy the post-condition. */
9311 if (IT_CHARPOS (*it
) == ZV
9313 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9314 move_it_by_lines (it
, 0);
9319 /* Move iterator IT past the end of the text line it is in. */
9322 move_it_past_eol (struct it
*it
)
9324 enum move_it_result rc
;
9326 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9327 if (rc
== MOVE_NEWLINE_OR_CR
)
9328 set_iterator_to_next (it
, 0);
9332 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9333 negative means move up. DVPOS == 0 means move to the start of the
9336 Optimization idea: If we would know that IT->f doesn't use
9337 a face with proportional font, we could be faster for
9338 truncate-lines nil. */
9341 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9344 /* The commented-out optimization uses vmotion on terminals. This
9345 gives bad results, because elements like it->what, on which
9346 callers such as pos_visible_p rely, aren't updated. */
9347 /* struct position pos;
9348 if (!FRAME_WINDOW_P (it->f))
9350 struct text_pos textpos;
9352 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9353 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9354 reseat (it, textpos, 1);
9355 it->vpos += pos.vpos;
9356 it->current_y += pos.vpos;
9362 /* DVPOS == 0 means move to the start of the screen line. */
9363 move_it_vertically_backward (it
, 0);
9364 /* Let next call to line_bottom_y calculate real line height */
9369 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9370 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9372 /* Only move to the next buffer position if we ended up in a
9373 string from display property, not in an overlay string
9374 (before-string or after-string). That is because the
9375 latter don't conceal the underlying buffer position, so
9376 we can ask to move the iterator to the exact position we
9377 are interested in. Note that, even if we are already at
9378 IT_CHARPOS (*it), the call below is not a no-op, as it
9379 will detect that we are at the end of the string, pop the
9380 iterator, and compute it->current_x and it->hpos
9382 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9383 -1, -1, -1, MOVE_TO_POS
);
9389 void *it2data
= NULL
;
9390 ptrdiff_t start_charpos
, i
;
9392 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9393 ptrdiff_t pos_limit
;
9395 /* Start at the beginning of the screen line containing IT's
9396 position. This may actually move vertically backwards,
9397 in case of overlays, so adjust dvpos accordingly. */
9399 move_it_vertically_backward (it
, 0);
9402 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9403 screen lines, and reseat the iterator there. */
9404 start_charpos
= IT_CHARPOS (*it
);
9405 if (it
->line_wrap
== TRUNCATE
)
9408 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9409 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9410 back_to_previous_visible_line_start (it
);
9411 reseat (it
, it
->current
.pos
, 1);
9413 /* Move further back if we end up in a string or an image. */
9414 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9416 /* First try to move to start of display line. */
9418 move_it_vertically_backward (it
, 0);
9420 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9422 /* If start of line is still in string or image,
9423 move further back. */
9424 back_to_previous_visible_line_start (it
);
9425 reseat (it
, it
->current
.pos
, 1);
9429 it
->current_x
= it
->hpos
= 0;
9431 /* Above call may have moved too far if continuation lines
9432 are involved. Scan forward and see if it did. */
9433 SAVE_IT (it2
, *it
, it2data
);
9434 it2
.vpos
= it2
.current_y
= 0;
9435 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9436 it
->vpos
-= it2
.vpos
;
9437 it
->current_y
-= it2
.current_y
;
9438 it
->current_x
= it
->hpos
= 0;
9440 /* If we moved too far back, move IT some lines forward. */
9441 if (it2
.vpos
> -dvpos
)
9443 int delta
= it2
.vpos
+ dvpos
;
9445 RESTORE_IT (&it2
, &it2
, it2data
);
9446 SAVE_IT (it2
, *it
, it2data
);
9447 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9448 /* Move back again if we got too far ahead. */
9449 if (IT_CHARPOS (*it
) >= start_charpos
)
9450 RESTORE_IT (it
, &it2
, it2data
);
9452 bidi_unshelve_cache (it2data
, 1);
9455 RESTORE_IT (it
, it
, it2data
);
9459 /* Return 1 if IT points into the middle of a display vector. */
9462 in_display_vector_p (struct it
*it
)
9464 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9465 && it
->current
.dpvec_index
> 0
9466 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9470 /***********************************************************************
9472 ***********************************************************************/
9475 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9479 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9481 Lisp_Object args
[3];
9482 Lisp_Object msg
, fmt
;
9485 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9489 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9491 args
[0] = fmt
= build_string (format
);
9494 msg
= Fformat (3, args
);
9496 len
= SBYTES (msg
) + 1;
9497 buffer
= SAFE_ALLOCA (len
);
9498 memcpy (buffer
, SDATA (msg
), len
);
9500 message_dolog (buffer
, len
- 1, 1, 0);
9507 /* Output a newline in the *Messages* buffer if "needs" one. */
9510 message_log_maybe_newline (void)
9512 if (message_log_need_newline
)
9513 message_dolog ("", 0, 1, 0);
9517 /* Add a string M of length NBYTES to the message log, optionally
9518 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9519 true, means interpret the contents of M as multibyte. This
9520 function calls low-level routines in order to bypass text property
9521 hooks, etc. which might not be safe to run.
9523 This may GC (insert may run before/after change hooks),
9524 so the buffer M must NOT point to a Lisp string. */
9527 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9529 const unsigned char *msg
= (const unsigned char *) m
;
9531 if (!NILP (Vmemory_full
))
9534 if (!NILP (Vmessage_log_max
))
9536 struct buffer
*oldbuf
;
9537 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9538 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9539 ptrdiff_t point_at_end
= 0;
9540 ptrdiff_t zv_at_end
= 0;
9541 Lisp_Object old_deactivate_mark
;
9543 struct gcpro gcpro1
;
9545 old_deactivate_mark
= Vdeactivate_mark
;
9546 oldbuf
= current_buffer
;
9547 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9548 bset_undo_list (current_buffer
, Qt
);
9550 oldpoint
= message_dolog_marker1
;
9551 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9552 oldbegv
= message_dolog_marker2
;
9553 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9554 oldzv
= message_dolog_marker3
;
9555 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9556 GCPRO1 (old_deactivate_mark
);
9564 BEGV_BYTE
= BEG_BYTE
;
9567 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9569 /* Insert the string--maybe converting multibyte to single byte
9570 or vice versa, so that all the text fits the buffer. */
9572 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9578 /* Convert a multibyte string to single-byte
9579 for the *Message* buffer. */
9580 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9582 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9583 work
[0] = (ASCII_CHAR_P (c
)
9585 : multibyte_char_to_unibyte (c
));
9586 insert_1_both (work
, 1, 1, 1, 0, 0);
9589 else if (! multibyte
9590 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9594 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9595 /* Convert a single-byte string to multibyte
9596 for the *Message* buffer. */
9597 for (i
= 0; i
< nbytes
; i
++)
9600 MAKE_CHAR_MULTIBYTE (c
);
9601 char_bytes
= CHAR_STRING (c
, str
);
9602 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9606 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
9610 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9613 insert_1_both ("\n", 1, 1, 1, 0, 0);
9615 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9617 this_bol_byte
= PT_BYTE
;
9619 /* See if this line duplicates the previous one.
9620 If so, combine duplicates. */
9623 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9625 prev_bol_byte
= PT_BYTE
;
9627 dups
= message_log_check_duplicate (prev_bol_byte
,
9631 del_range_both (prev_bol
, prev_bol_byte
,
9632 this_bol
, this_bol_byte
, 0);
9635 char dupstr
[sizeof " [ times]"
9636 + INT_STRLEN_BOUND (printmax_t
)];
9638 /* If you change this format, don't forget to also
9639 change message_log_check_duplicate. */
9640 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9641 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9642 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
9647 /* If we have more than the desired maximum number of lines
9648 in the *Messages* buffer now, delete the oldest ones.
9649 This is safe because we don't have undo in this buffer. */
9651 if (NATNUMP (Vmessage_log_max
))
9653 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9654 -XFASTINT (Vmessage_log_max
) - 1, 0);
9655 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9658 BEGV
= marker_position (oldbegv
);
9659 BEGV_BYTE
= marker_byte_position (oldbegv
);
9668 ZV
= marker_position (oldzv
);
9669 ZV_BYTE
= marker_byte_position (oldzv
);
9673 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9675 /* We can't do Fgoto_char (oldpoint) because it will run some
9677 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
9678 marker_byte_position (oldpoint
));
9681 unchain_marker (XMARKER (oldpoint
));
9682 unchain_marker (XMARKER (oldbegv
));
9683 unchain_marker (XMARKER (oldzv
));
9685 shown
= buffer_window_count (current_buffer
) > 0;
9686 set_buffer_internal (oldbuf
);
9687 /* We called insert_1_both above with its 5th argument (PREPARE)
9688 zero, which prevents insert_1_both from calling
9689 prepare_to_modify_buffer, which in turns prevents us from
9690 incrementing windows_or_buffers_changed even if *Messages* is
9691 shown in some window. So we must manually incrementing
9692 windows_or_buffers_changed here to make up for that. */
9694 windows_or_buffers_changed
++;
9696 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9697 message_log_need_newline
= !nlflag
;
9698 Vdeactivate_mark
= old_deactivate_mark
;
9703 /* We are at the end of the buffer after just having inserted a newline.
9704 (Note: We depend on the fact we won't be crossing the gap.)
9705 Check to see if the most recent message looks a lot like the previous one.
9706 Return 0 if different, 1 if the new one should just replace it, or a
9707 value N > 1 if we should also append " [N times]". */
9710 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9713 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9715 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9716 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9718 for (i
= 0; i
< len
; i
++)
9720 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
9728 if (*p1
++ == ' ' && *p1
++ == '[')
9731 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9732 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9739 /* Display an echo area message M with a specified length of NBYTES
9740 bytes. The string may include null characters. If M is not a
9741 string, clear out any existing message, and let the mini-buffer
9744 This function cancels echoing. */
9747 message3 (Lisp_Object m
)
9749 struct gcpro gcpro1
;
9752 clear_message (1,1);
9755 /* First flush out any partial line written with print. */
9756 message_log_maybe_newline ();
9759 ptrdiff_t nbytes
= SBYTES (m
);
9760 bool multibyte
= STRING_MULTIBYTE (m
);
9762 char *buffer
= SAFE_ALLOCA (nbytes
);
9763 memcpy (buffer
, SDATA (m
), nbytes
);
9764 message_dolog (buffer
, nbytes
, 1, multibyte
);
9773 /* The non-logging version of message3.
9774 This does not cancel echoing, because it is used for echoing.
9775 Perhaps we need to make a separate function for echoing
9776 and make this cancel echoing. */
9779 message3_nolog (Lisp_Object m
)
9781 struct frame
*sf
= SELECTED_FRAME ();
9783 if (FRAME_INITIAL_P (sf
))
9785 if (noninteractive_need_newline
)
9786 putc ('\n', stderr
);
9787 noninteractive_need_newline
= 0;
9789 fwrite (SDATA (m
), SBYTES (m
), 1, stderr
);
9790 if (cursor_in_echo_area
== 0)
9791 fprintf (stderr
, "\n");
9794 /* Error messages get reported properly by cmd_error, so this must be just an
9795 informative message; if the frame hasn't really been initialized yet, just
9797 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
9799 /* Get the frame containing the mini-buffer
9800 that the selected frame is using. */
9801 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9802 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
9803 struct frame
*f
= XFRAME (frame
);
9805 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
9806 Fmake_frame_visible (frame
);
9808 if (STRINGP (m
) && SCHARS (m
) > 0)
9811 if (minibuffer_auto_raise
)
9812 Fraise_frame (frame
);
9813 /* Assume we are not echoing.
9814 (If we are, echo_now will override this.) */
9815 echo_message_buffer
= Qnil
;
9818 clear_message (1, 1);
9820 do_pending_window_change (0);
9821 echo_area_display (1);
9822 do_pending_window_change (0);
9823 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
9824 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9829 /* Display a null-terminated echo area message M. If M is 0, clear
9830 out any existing message, and let the mini-buffer text show through.
9832 The buffer M must continue to exist until after the echo area gets
9833 cleared or some other message gets displayed there. Do not pass
9834 text that is stored in a Lisp string. Do not pass text in a buffer
9835 that was alloca'd. */
9838 message1 (const char *m
)
9840 message3 (m
? build_unibyte_string (m
) : Qnil
);
9844 /* The non-logging counterpart of message1. */
9847 message1_nolog (const char *m
)
9849 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
9852 /* Display a message M which contains a single %s
9853 which gets replaced with STRING. */
9856 message_with_string (const char *m
, Lisp_Object string
, int log
)
9858 CHECK_STRING (string
);
9864 if (noninteractive_need_newline
)
9865 putc ('\n', stderr
);
9866 noninteractive_need_newline
= 0;
9867 fprintf (stderr
, m
, SDATA (string
));
9868 if (!cursor_in_echo_area
)
9869 fprintf (stderr
, "\n");
9873 else if (INTERACTIVE
)
9875 /* The frame whose minibuffer we're going to display the message on.
9876 It may be larger than the selected frame, so we need
9877 to use its buffer, not the selected frame's buffer. */
9878 Lisp_Object mini_window
;
9879 struct frame
*f
, *sf
= SELECTED_FRAME ();
9881 /* Get the frame containing the minibuffer
9882 that the selected frame is using. */
9883 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9884 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9886 /* Error messages get reported properly by cmd_error, so this must be
9887 just an informative message; if the frame hasn't really been
9888 initialized yet, just toss it. */
9889 if (f
->glyphs_initialized_p
)
9891 Lisp_Object args
[2], msg
;
9892 struct gcpro gcpro1
, gcpro2
;
9894 args
[0] = build_string (m
);
9895 args
[1] = msg
= string
;
9896 GCPRO2 (args
[0], msg
);
9899 msg
= Fformat (2, args
);
9904 message3_nolog (msg
);
9908 /* Print should start at the beginning of the message
9909 buffer next time. */
9910 message_buf_print
= 0;
9916 /* Dump an informative message to the minibuf. If M is 0, clear out
9917 any existing message, and let the mini-buffer text show through. */
9920 vmessage (const char *m
, va_list ap
)
9926 if (noninteractive_need_newline
)
9927 putc ('\n', stderr
);
9928 noninteractive_need_newline
= 0;
9929 vfprintf (stderr
, m
, ap
);
9930 if (cursor_in_echo_area
== 0)
9931 fprintf (stderr
, "\n");
9935 else if (INTERACTIVE
)
9937 /* The frame whose mini-buffer we're going to display the message
9938 on. It may be larger than the selected frame, so we need to
9939 use its buffer, not the selected frame's buffer. */
9940 Lisp_Object mini_window
;
9941 struct frame
*f
, *sf
= SELECTED_FRAME ();
9943 /* Get the frame containing the mini-buffer
9944 that the selected frame is using. */
9945 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9946 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9948 /* Error messages get reported properly by cmd_error, so this must be
9949 just an informative message; if the frame hasn't really been
9950 initialized yet, just toss it. */
9951 if (f
->glyphs_initialized_p
)
9956 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
9957 char *message_buf
= alloca (maxsize
+ 1);
9959 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
9961 message3 (make_string (message_buf
, len
));
9966 /* Print should start at the beginning of the message
9967 buffer next time. */
9968 message_buf_print
= 0;
9974 message (const char *m
, ...)
9984 /* The non-logging version of message. */
9987 message_nolog (const char *m
, ...)
9989 Lisp_Object old_log_max
;
9992 old_log_max
= Vmessage_log_max
;
9993 Vmessage_log_max
= Qnil
;
9995 Vmessage_log_max
= old_log_max
;
10001 /* Display the current message in the current mini-buffer. This is
10002 only called from error handlers in process.c, and is not time
10006 update_echo_area (void)
10008 if (!NILP (echo_area_buffer
[0]))
10010 Lisp_Object string
;
10011 string
= Fcurrent_message ();
10017 /* Make sure echo area buffers in `echo_buffers' are live.
10018 If they aren't, make new ones. */
10021 ensure_echo_area_buffers (void)
10025 for (i
= 0; i
< 2; ++i
)
10026 if (!BUFFERP (echo_buffer
[i
])
10027 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10030 Lisp_Object old_buffer
;
10033 old_buffer
= echo_buffer
[i
];
10034 echo_buffer
[i
] = Fget_buffer_create
10035 (make_formatted_string (name
, " *Echo Area %d*", i
));
10036 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10037 /* to force word wrap in echo area -
10038 it was decided to postpone this*/
10039 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10041 for (j
= 0; j
< 2; ++j
)
10042 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10043 echo_area_buffer
[j
] = echo_buffer
[i
];
10048 /* Call FN with args A1..A2 with either the current or last displayed
10049 echo_area_buffer as current buffer.
10051 WHICH zero means use the current message buffer
10052 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10053 from echo_buffer[] and clear it.
10055 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10056 suitable buffer from echo_buffer[] and clear it.
10058 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10059 that the current message becomes the last displayed one, make
10060 choose a suitable buffer for echo_area_buffer[0], and clear it.
10062 Value is what FN returns. */
10065 with_echo_area_buffer (struct window
*w
, int which
,
10066 int (*fn
) (ptrdiff_t, Lisp_Object
),
10067 ptrdiff_t a1
, Lisp_Object a2
)
10069 Lisp_Object buffer
;
10070 int this_one
, the_other
, clear_buffer_p
, rc
;
10071 ptrdiff_t count
= SPECPDL_INDEX ();
10073 /* If buffers aren't live, make new ones. */
10074 ensure_echo_area_buffers ();
10076 clear_buffer_p
= 0;
10079 this_one
= 0, the_other
= 1;
10080 else if (which
> 0)
10081 this_one
= 1, the_other
= 0;
10084 this_one
= 0, the_other
= 1;
10085 clear_buffer_p
= 1;
10087 /* We need a fresh one in case the current echo buffer equals
10088 the one containing the last displayed echo area message. */
10089 if (!NILP (echo_area_buffer
[this_one
])
10090 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10091 echo_area_buffer
[this_one
] = Qnil
;
10094 /* Choose a suitable buffer from echo_buffer[] is we don't
10096 if (NILP (echo_area_buffer
[this_one
]))
10098 echo_area_buffer
[this_one
]
10099 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10100 ? echo_buffer
[the_other
]
10101 : echo_buffer
[this_one
]);
10102 clear_buffer_p
= 1;
10105 buffer
= echo_area_buffer
[this_one
];
10107 /* Don't get confused by reusing the buffer used for echoing
10108 for a different purpose. */
10109 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10112 record_unwind_protect (unwind_with_echo_area_buffer
,
10113 with_echo_area_buffer_unwind_data (w
));
10115 /* Make the echo area buffer current. Note that for display
10116 purposes, it is not necessary that the displayed window's buffer
10117 == current_buffer, except for text property lookup. So, let's
10118 only set that buffer temporarily here without doing a full
10119 Fset_window_buffer. We must also change w->pointm, though,
10120 because otherwise an assertions in unshow_buffer fails, and Emacs
10122 set_buffer_internal_1 (XBUFFER (buffer
));
10125 wset_buffer (w
, buffer
);
10126 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10129 bset_undo_list (current_buffer
, Qt
);
10130 bset_read_only (current_buffer
, Qnil
);
10131 specbind (Qinhibit_read_only
, Qt
);
10132 specbind (Qinhibit_modification_hooks
, Qt
);
10134 if (clear_buffer_p
&& Z
> BEG
)
10135 del_range (BEG
, Z
);
10137 eassert (BEGV
>= BEG
);
10138 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10142 eassert (BEGV
>= BEG
);
10143 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10145 unbind_to (count
, Qnil
);
10150 /* Save state that should be preserved around the call to the function
10151 FN called in with_echo_area_buffer. */
10154 with_echo_area_buffer_unwind_data (struct window
*w
)
10157 Lisp_Object vector
, tmp
;
10159 /* Reduce consing by keeping one vector in
10160 Vwith_echo_area_save_vector. */
10161 vector
= Vwith_echo_area_save_vector
;
10162 Vwith_echo_area_save_vector
= Qnil
;
10165 vector
= Fmake_vector (make_number (9), Qnil
);
10167 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10168 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10169 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10173 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10174 ASET (vector
, i
, w
->contents
); ++i
;
10175 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10176 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10177 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10178 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10183 for (; i
< end
; ++i
)
10184 ASET (vector
, i
, Qnil
);
10187 eassert (i
== ASIZE (vector
));
10192 /* Restore global state from VECTOR which was created by
10193 with_echo_area_buffer_unwind_data. */
10196 unwind_with_echo_area_buffer (Lisp_Object vector
)
10198 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10199 Vdeactivate_mark
= AREF (vector
, 1);
10200 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10202 if (WINDOWP (AREF (vector
, 3)))
10205 Lisp_Object buffer
;
10207 w
= XWINDOW (AREF (vector
, 3));
10208 buffer
= AREF (vector
, 4);
10210 wset_buffer (w
, buffer
);
10211 set_marker_both (w
->pointm
, buffer
,
10212 XFASTINT (AREF (vector
, 5)),
10213 XFASTINT (AREF (vector
, 6)));
10214 set_marker_both (w
->start
, buffer
,
10215 XFASTINT (AREF (vector
, 7)),
10216 XFASTINT (AREF (vector
, 8)));
10219 Vwith_echo_area_save_vector
= vector
;
10223 /* Set up the echo area for use by print functions. MULTIBYTE_P
10224 non-zero means we will print multibyte. */
10227 setup_echo_area_for_printing (int multibyte_p
)
10229 /* If we can't find an echo area any more, exit. */
10230 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10231 Fkill_emacs (Qnil
);
10233 ensure_echo_area_buffers ();
10235 if (!message_buf_print
)
10237 /* A message has been output since the last time we printed.
10238 Choose a fresh echo area buffer. */
10239 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10240 echo_area_buffer
[0] = echo_buffer
[1];
10242 echo_area_buffer
[0] = echo_buffer
[0];
10244 /* Switch to that buffer and clear it. */
10245 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10246 bset_truncate_lines (current_buffer
, Qnil
);
10250 ptrdiff_t count
= SPECPDL_INDEX ();
10251 specbind (Qinhibit_read_only
, Qt
);
10252 /* Note that undo recording is always disabled. */
10253 del_range (BEG
, Z
);
10254 unbind_to (count
, Qnil
);
10256 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10258 /* Set up the buffer for the multibyteness we need. */
10260 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10261 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10263 /* Raise the frame containing the echo area. */
10264 if (minibuffer_auto_raise
)
10266 struct frame
*sf
= SELECTED_FRAME ();
10267 Lisp_Object mini_window
;
10268 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10269 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10272 message_log_maybe_newline ();
10273 message_buf_print
= 1;
10277 if (NILP (echo_area_buffer
[0]))
10279 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10280 echo_area_buffer
[0] = echo_buffer
[1];
10282 echo_area_buffer
[0] = echo_buffer
[0];
10285 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10287 /* Someone switched buffers between print requests. */
10288 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10289 bset_truncate_lines (current_buffer
, Qnil
);
10295 /* Display an echo area message in window W. Value is non-zero if W's
10296 height is changed. If display_last_displayed_message_p is
10297 non-zero, display the message that was last displayed, otherwise
10298 display the current message. */
10301 display_echo_area (struct window
*w
)
10303 int i
, no_message_p
, window_height_changed_p
;
10305 /* Temporarily disable garbage collections while displaying the echo
10306 area. This is done because a GC can print a message itself.
10307 That message would modify the echo area buffer's contents while a
10308 redisplay of the buffer is going on, and seriously confuse
10310 ptrdiff_t count
= inhibit_garbage_collection ();
10312 /* If there is no message, we must call display_echo_area_1
10313 nevertheless because it resizes the window. But we will have to
10314 reset the echo_area_buffer in question to nil at the end because
10315 with_echo_area_buffer will sets it to an empty buffer. */
10316 i
= display_last_displayed_message_p
? 1 : 0;
10317 no_message_p
= NILP (echo_area_buffer
[i
]);
10319 window_height_changed_p
10320 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10321 display_echo_area_1
,
10322 (intptr_t) w
, Qnil
);
10325 echo_area_buffer
[i
] = Qnil
;
10327 unbind_to (count
, Qnil
);
10328 return window_height_changed_p
;
10332 /* Helper for display_echo_area. Display the current buffer which
10333 contains the current echo area message in window W, a mini-window,
10334 a pointer to which is passed in A1. A2..A4 are currently not used.
10335 Change the height of W so that all of the message is displayed.
10336 Value is non-zero if height of W was changed. */
10339 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10342 struct window
*w
= (struct window
*) i1
;
10343 Lisp_Object window
;
10344 struct text_pos start
;
10345 int window_height_changed_p
= 0;
10347 /* Do this before displaying, so that we have a large enough glyph
10348 matrix for the display. If we can't get enough space for the
10349 whole text, display the last N lines. That works by setting w->start. */
10350 window_height_changed_p
= resize_mini_window (w
, 0);
10352 /* Use the starting position chosen by resize_mini_window. */
10353 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10356 clear_glyph_matrix (w
->desired_matrix
);
10357 XSETWINDOW (window
, w
);
10358 try_window (window
, start
, 0);
10360 return window_height_changed_p
;
10364 /* Resize the echo area window to exactly the size needed for the
10365 currently displayed message, if there is one. If a mini-buffer
10366 is active, don't shrink it. */
10369 resize_echo_area_exactly (void)
10371 if (BUFFERP (echo_area_buffer
[0])
10372 && WINDOWP (echo_area_window
))
10374 struct window
*w
= XWINDOW (echo_area_window
);
10376 Lisp_Object resize_exactly
;
10378 if (minibuf_level
== 0)
10379 resize_exactly
= Qt
;
10381 resize_exactly
= Qnil
;
10383 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10384 (intptr_t) w
, resize_exactly
);
10387 ++windows_or_buffers_changed
;
10388 ++update_mode_lines
;
10389 redisplay_internal ();
10395 /* Callback function for with_echo_area_buffer, when used from
10396 resize_echo_area_exactly. A1 contains a pointer to the window to
10397 resize, EXACTLY non-nil means resize the mini-window exactly to the
10398 size of the text displayed. A3 and A4 are not used. Value is what
10399 resize_mini_window returns. */
10402 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10405 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10409 /* Resize mini-window W to fit the size of its contents. EXACT_P
10410 means size the window exactly to the size needed. Otherwise, it's
10411 only enlarged until W's buffer is empty.
10413 Set W->start to the right place to begin display. If the whole
10414 contents fit, start at the beginning. Otherwise, start so as
10415 to make the end of the contents appear. This is particularly
10416 important for y-or-n-p, but seems desirable generally.
10418 Value is non-zero if the window height has been changed. */
10421 resize_mini_window (struct window
*w
, int exact_p
)
10423 struct frame
*f
= XFRAME (w
->frame
);
10424 int window_height_changed_p
= 0;
10426 eassert (MINI_WINDOW_P (w
));
10428 /* By default, start display at the beginning. */
10429 set_marker_both (w
->start
, w
->contents
,
10430 BUF_BEGV (XBUFFER (w
->contents
)),
10431 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10433 /* Don't resize windows while redisplaying a window; it would
10434 confuse redisplay functions when the size of the window they are
10435 displaying changes from under them. Such a resizing can happen,
10436 for instance, when which-func prints a long message while
10437 we are running fontification-functions. We're running these
10438 functions with safe_call which binds inhibit-redisplay to t. */
10439 if (!NILP (Vinhibit_redisplay
))
10442 /* Nil means don't try to resize. */
10443 if (NILP (Vresize_mini_windows
)
10444 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10447 if (!FRAME_MINIBUF_ONLY_P (f
))
10450 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10451 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10453 EMACS_INT max_height
;
10454 int unit
= FRAME_LINE_HEIGHT (f
);
10455 struct text_pos start
;
10456 struct buffer
*old_current_buffer
= NULL
;
10458 if (current_buffer
!= XBUFFER (w
->contents
))
10460 old_current_buffer
= current_buffer
;
10461 set_buffer_internal (XBUFFER (w
->contents
));
10464 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10466 /* Compute the max. number of lines specified by the user. */
10467 if (FLOATP (Vmax_mini_window_height
))
10468 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10469 else if (INTEGERP (Vmax_mini_window_height
))
10470 max_height
= XINT (Vmax_mini_window_height
);
10472 max_height
= total_height
/ 4;
10474 /* Correct that max. height if it's bogus. */
10475 max_height
= clip_to_bounds (1, max_height
, total_height
);
10477 /* Find out the height of the text in the window. */
10478 if (it
.line_wrap
== TRUNCATE
)
10483 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10484 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10485 height
= it
.current_y
+ last_height
;
10487 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10488 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10489 height
= (height
+ unit
- 1) / unit
;
10492 /* Compute a suitable window start. */
10493 if (height
> max_height
)
10495 height
= max_height
;
10496 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10497 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10498 start
= it
.current
.pos
;
10501 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10502 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10504 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10506 /* Let it grow only, until we display an empty message, in which
10507 case the window shrinks again. */
10508 if (height
> WINDOW_TOTAL_LINES (w
))
10510 int old_height
= WINDOW_TOTAL_LINES (w
);
10512 FRAME_WINDOWS_FROZEN (f
) = 1;
10513 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10514 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10516 else if (height
< WINDOW_TOTAL_LINES (w
)
10517 && (exact_p
|| BEGV
== ZV
))
10519 int old_height
= WINDOW_TOTAL_LINES (w
);
10521 FRAME_WINDOWS_FROZEN (f
) = 0;
10522 shrink_mini_window (w
);
10523 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10528 /* Always resize to exact size needed. */
10529 if (height
> WINDOW_TOTAL_LINES (w
))
10531 int old_height
= WINDOW_TOTAL_LINES (w
);
10533 FRAME_WINDOWS_FROZEN (f
) = 1;
10534 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10535 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10537 else if (height
< WINDOW_TOTAL_LINES (w
))
10539 int old_height
= WINDOW_TOTAL_LINES (w
);
10541 FRAME_WINDOWS_FROZEN (f
) = 0;
10542 shrink_mini_window (w
);
10546 FRAME_WINDOWS_FROZEN (f
) = 1;
10547 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10550 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10554 if (old_current_buffer
)
10555 set_buffer_internal (old_current_buffer
);
10558 return window_height_changed_p
;
10562 /* Value is the current message, a string, or nil if there is no
10563 current message. */
10566 current_message (void)
10570 if (!BUFFERP (echo_area_buffer
[0]))
10574 with_echo_area_buffer (0, 0, current_message_1
,
10575 (intptr_t) &msg
, Qnil
);
10577 echo_area_buffer
[0] = Qnil
;
10585 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10588 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10591 *msg
= make_buffer_string (BEG
, Z
, 1);
10598 /* Push the current message on Vmessage_stack for later restoration
10599 by restore_message. Value is non-zero if the current message isn't
10600 empty. This is a relatively infrequent operation, so it's not
10601 worth optimizing. */
10604 push_message (void)
10606 Lisp_Object msg
= current_message ();
10607 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10608 return STRINGP (msg
);
10612 /* Restore message display from the top of Vmessage_stack. */
10615 restore_message (void)
10617 eassert (CONSP (Vmessage_stack
));
10618 message3_nolog (XCAR (Vmessage_stack
));
10622 /* Handler for unwind-protect calling pop_message. */
10625 pop_message_unwind (void)
10627 /* Pop the top-most entry off Vmessage_stack. */
10628 eassert (CONSP (Vmessage_stack
));
10629 Vmessage_stack
= XCDR (Vmessage_stack
);
10633 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10634 exits. If the stack is not empty, we have a missing pop_message
10638 check_message_stack (void)
10640 if (!NILP (Vmessage_stack
))
10645 /* Truncate to NCHARS what will be displayed in the echo area the next
10646 time we display it---but don't redisplay it now. */
10649 truncate_echo_area (ptrdiff_t nchars
)
10652 echo_area_buffer
[0] = Qnil
;
10653 else if (!noninteractive
10655 && !NILP (echo_area_buffer
[0]))
10657 struct frame
*sf
= SELECTED_FRAME ();
10658 /* Error messages get reported properly by cmd_error, so this must be
10659 just an informative message; if the frame hasn't really been
10660 initialized yet, just toss it. */
10661 if (sf
->glyphs_initialized_p
)
10662 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
10667 /* Helper function for truncate_echo_area. Truncate the current
10668 message to at most NCHARS characters. */
10671 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
10673 if (BEG
+ nchars
< Z
)
10674 del_range (BEG
+ nchars
, Z
);
10676 echo_area_buffer
[0] = Qnil
;
10680 /* Set the current message to STRING. */
10683 set_message (Lisp_Object string
)
10685 eassert (STRINGP (string
));
10687 message_enable_multibyte
= STRING_MULTIBYTE (string
);
10689 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
10690 message_buf_print
= 0;
10691 help_echo_showing_p
= 0;
10693 if (STRINGP (Vdebug_on_message
)
10694 && STRINGP (string
)
10695 && fast_string_match (Vdebug_on_message
, string
) >= 0)
10696 call_debugger (list2 (Qerror
, string
));
10700 /* Helper function for set_message. First argument is ignored and second
10701 argument has the same meaning as for set_message.
10702 This function is called with the echo area buffer being current. */
10705 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
10707 eassert (STRINGP (string
));
10709 /* Change multibyteness of the echo buffer appropriately. */
10710 if (message_enable_multibyte
10711 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10712 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10714 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
10715 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10716 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
10718 /* Insert new message at BEG. */
10719 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10721 /* This function takes care of single/multibyte conversion.
10722 We just have to ensure that the echo area buffer has the right
10723 setting of enable_multibyte_characters. */
10724 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
10730 /* Clear messages. CURRENT_P non-zero means clear the current
10731 message. LAST_DISPLAYED_P non-zero means clear the message
10735 clear_message (int current_p
, int last_displayed_p
)
10739 echo_area_buffer
[0] = Qnil
;
10740 message_cleared_p
= 1;
10743 if (last_displayed_p
)
10744 echo_area_buffer
[1] = Qnil
;
10746 message_buf_print
= 0;
10749 /* Clear garbaged frames.
10751 This function is used where the old redisplay called
10752 redraw_garbaged_frames which in turn called redraw_frame which in
10753 turn called clear_frame. The call to clear_frame was a source of
10754 flickering. I believe a clear_frame is not necessary. It should
10755 suffice in the new redisplay to invalidate all current matrices,
10756 and ensure a complete redisplay of all windows. */
10759 clear_garbaged_frames (void)
10761 if (frame_garbaged
)
10763 Lisp_Object tail
, frame
;
10764 int changed_count
= 0;
10766 FOR_EACH_FRAME (tail
, frame
)
10768 struct frame
*f
= XFRAME (frame
);
10770 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10775 f
->force_flush_display_p
= 1;
10777 clear_current_matrices (f
);
10784 frame_garbaged
= 0;
10786 ++windows_or_buffers_changed
;
10791 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10792 is non-zero update selected_frame. Value is non-zero if the
10793 mini-windows height has been changed. */
10796 echo_area_display (int update_frame_p
)
10798 Lisp_Object mini_window
;
10801 int window_height_changed_p
= 0;
10802 struct frame
*sf
= SELECTED_FRAME ();
10804 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10805 w
= XWINDOW (mini_window
);
10806 f
= XFRAME (WINDOW_FRAME (w
));
10808 /* Don't display if frame is invisible or not yet initialized. */
10809 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10812 #ifdef HAVE_WINDOW_SYSTEM
10813 /* When Emacs starts, selected_frame may be the initial terminal
10814 frame. If we let this through, a message would be displayed on
10816 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10818 #endif /* HAVE_WINDOW_SYSTEM */
10820 /* Redraw garbaged frames. */
10821 clear_garbaged_frames ();
10823 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10825 echo_area_window
= mini_window
;
10826 window_height_changed_p
= display_echo_area (w
);
10827 w
->must_be_updated_p
= 1;
10829 /* Update the display, unless called from redisplay_internal.
10830 Also don't update the screen during redisplay itself. The
10831 update will happen at the end of redisplay, and an update
10832 here could cause confusion. */
10833 if (update_frame_p
&& !redisplaying_p
)
10837 /* If the display update has been interrupted by pending
10838 input, update mode lines in the frame. Due to the
10839 pending input, it might have been that redisplay hasn't
10840 been called, so that mode lines above the echo area are
10841 garbaged. This looks odd, so we prevent it here. */
10842 if (!display_completed
)
10843 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10845 if (window_height_changed_p
10846 /* Don't do this if Emacs is shutting down. Redisplay
10847 needs to run hooks. */
10848 && !NILP (Vrun_hooks
))
10850 /* Must update other windows. Likewise as in other
10851 cases, don't let this update be interrupted by
10853 ptrdiff_t count
= SPECPDL_INDEX ();
10854 specbind (Qredisplay_dont_pause
, Qt
);
10855 windows_or_buffers_changed
= 1;
10856 redisplay_internal ();
10857 unbind_to (count
, Qnil
);
10859 else if (FRAME_WINDOW_P (f
) && n
== 0)
10861 /* Window configuration is the same as before.
10862 Can do with a display update of the echo area,
10863 unless we displayed some mode lines. */
10864 update_single_window (w
, 1);
10865 FRAME_RIF (f
)->flush_display (f
);
10868 update_frame (f
, 1, 1);
10870 /* If cursor is in the echo area, make sure that the next
10871 redisplay displays the minibuffer, so that the cursor will
10872 be replaced with what the minibuffer wants. */
10873 if (cursor_in_echo_area
)
10874 ++windows_or_buffers_changed
;
10877 else if (!EQ (mini_window
, selected_window
))
10878 windows_or_buffers_changed
++;
10880 /* Last displayed message is now the current message. */
10881 echo_area_buffer
[1] = echo_area_buffer
[0];
10882 /* Inform read_char that we're not echoing. */
10883 echo_message_buffer
= Qnil
;
10885 /* Prevent redisplay optimization in redisplay_internal by resetting
10886 this_line_start_pos. This is done because the mini-buffer now
10887 displays the message instead of its buffer text. */
10888 if (EQ (mini_window
, selected_window
))
10889 CHARPOS (this_line_start_pos
) = 0;
10891 return window_height_changed_p
;
10894 /* Nonzero if the current window's buffer is shown in more than one
10895 window and was modified since last redisplay. */
10898 buffer_shared_and_changed (void)
10900 return (buffer_window_count (current_buffer
) > 1
10901 && UNCHANGED_MODIFIED
< MODIFF
);
10904 /* Nonzero if W's buffer was changed but not saved or Transient Mark mode
10905 is enabled and mark of W's buffer was changed since last W's update. */
10908 window_buffer_changed (struct window
*w
)
10910 struct buffer
*b
= XBUFFER (w
->contents
);
10912 eassert (BUFFER_LIVE_P (b
));
10914 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
)
10915 || ((!NILP (Vtransient_mark_mode
) && !NILP (BVAR (b
, mark_active
)))
10916 != (w
->region_showing
!= 0)));
10919 /* Nonzero if W has %c in its mode line and mode line should be updated. */
10922 mode_line_update_needed (struct window
*w
)
10924 return (w
->column_number_displayed
!= -1
10925 && !(PT
== w
->last_point
&& !window_outdated (w
))
10926 && (w
->column_number_displayed
!= current_column ()));
10929 /* Nonzero if window start of W is frozen and may not be changed during
10933 window_frozen_p (struct window
*w
)
10935 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
10937 Lisp_Object window
;
10939 XSETWINDOW (window
, w
);
10940 if (MINI_WINDOW_P (w
))
10942 else if (EQ (window
, selected_window
))
10944 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
10945 && EQ (window
, Vminibuf_scroll_window
))
10946 /* This special window can't be frozen too. */
10954 /***********************************************************************
10955 Mode Lines and Frame Titles
10956 ***********************************************************************/
10958 /* A buffer for constructing non-propertized mode-line strings and
10959 frame titles in it; allocated from the heap in init_xdisp and
10960 resized as needed in store_mode_line_noprop_char. */
10962 static char *mode_line_noprop_buf
;
10964 /* The buffer's end, and a current output position in it. */
10966 static char *mode_line_noprop_buf_end
;
10967 static char *mode_line_noprop_ptr
;
10969 #define MODE_LINE_NOPROP_LEN(start) \
10970 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10973 MODE_LINE_DISPLAY
= 0,
10977 } mode_line_target
;
10979 /* Alist that caches the results of :propertize.
10980 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10981 static Lisp_Object mode_line_proptrans_alist
;
10983 /* List of strings making up the mode-line. */
10984 static Lisp_Object mode_line_string_list
;
10986 /* Base face property when building propertized mode line string. */
10987 static Lisp_Object mode_line_string_face
;
10988 static Lisp_Object mode_line_string_face_prop
;
10991 /* Unwind data for mode line strings */
10993 static Lisp_Object Vmode_line_unwind_vector
;
10996 format_mode_line_unwind_data (struct frame
*target_frame
,
10997 struct buffer
*obuf
,
10999 int save_proptrans
)
11001 Lisp_Object vector
, tmp
;
11003 /* Reduce consing by keeping one vector in
11004 Vwith_echo_area_save_vector. */
11005 vector
= Vmode_line_unwind_vector
;
11006 Vmode_line_unwind_vector
= Qnil
;
11009 vector
= Fmake_vector (make_number (10), Qnil
);
11011 ASET (vector
, 0, make_number (mode_line_target
));
11012 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11013 ASET (vector
, 2, mode_line_string_list
);
11014 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11015 ASET (vector
, 4, mode_line_string_face
);
11016 ASET (vector
, 5, mode_line_string_face_prop
);
11019 XSETBUFFER (tmp
, obuf
);
11022 ASET (vector
, 6, tmp
);
11023 ASET (vector
, 7, owin
);
11026 /* Similarly to `with-selected-window', if the operation selects
11027 a window on another frame, we must restore that frame's
11028 selected window, and (for a tty) the top-frame. */
11029 ASET (vector
, 8, target_frame
->selected_window
);
11030 if (FRAME_TERMCAP_P (target_frame
))
11031 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11038 unwind_format_mode_line (Lisp_Object vector
)
11040 Lisp_Object old_window
= AREF (vector
, 7);
11041 Lisp_Object target_frame_window
= AREF (vector
, 8);
11042 Lisp_Object old_top_frame
= AREF (vector
, 9);
11044 mode_line_target
= XINT (AREF (vector
, 0));
11045 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11046 mode_line_string_list
= AREF (vector
, 2);
11047 if (! EQ (AREF (vector
, 3), Qt
))
11048 mode_line_proptrans_alist
= AREF (vector
, 3);
11049 mode_line_string_face
= AREF (vector
, 4);
11050 mode_line_string_face_prop
= AREF (vector
, 5);
11052 /* Select window before buffer, since it may change the buffer. */
11053 if (!NILP (old_window
))
11055 /* If the operation that we are unwinding had selected a window
11056 on a different frame, reset its frame-selected-window. For a
11057 text terminal, reset its top-frame if necessary. */
11058 if (!NILP (target_frame_window
))
11061 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11063 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11064 Fselect_window (target_frame_window
, Qt
);
11066 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11067 Fselect_frame (old_top_frame
, Qt
);
11070 Fselect_window (old_window
, Qt
);
11073 if (!NILP (AREF (vector
, 6)))
11075 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11076 ASET (vector
, 6, Qnil
);
11079 Vmode_line_unwind_vector
= vector
;
11083 /* Store a single character C for the frame title in mode_line_noprop_buf.
11084 Re-allocate mode_line_noprop_buf if necessary. */
11087 store_mode_line_noprop_char (char c
)
11089 /* If output position has reached the end of the allocated buffer,
11090 increase the buffer's size. */
11091 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11093 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11094 ptrdiff_t size
= len
;
11095 mode_line_noprop_buf
=
11096 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11097 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11098 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11101 *mode_line_noprop_ptr
++ = c
;
11105 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11106 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11107 characters that yield more columns than PRECISION; PRECISION <= 0
11108 means copy the whole string. Pad with spaces until FIELD_WIDTH
11109 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11110 pad. Called from display_mode_element when it is used to build a
11114 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11116 const unsigned char *str
= (const unsigned char *) string
;
11118 ptrdiff_t dummy
, nbytes
;
11120 /* Copy at most PRECISION chars from STR. */
11121 nbytes
= strlen (string
);
11122 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11124 store_mode_line_noprop_char (*str
++);
11126 /* Fill up with spaces until FIELD_WIDTH reached. */
11127 while (field_width
> 0
11128 && n
< field_width
)
11130 store_mode_line_noprop_char (' ');
11137 /***********************************************************************
11139 ***********************************************************************/
11141 #ifdef HAVE_WINDOW_SYSTEM
11143 /* Set the title of FRAME, if it has changed. The title format is
11144 Vicon_title_format if FRAME is iconified, otherwise it is
11145 frame_title_format. */
11148 x_consider_frame_title (Lisp_Object frame
)
11150 struct frame
*f
= XFRAME (frame
);
11152 if (FRAME_WINDOW_P (f
)
11153 || FRAME_MINIBUF_ONLY_P (f
)
11154 || f
->explicit_name
)
11156 /* Do we have more than one visible frame on this X display? */
11157 Lisp_Object tail
, other_frame
, fmt
;
11158 ptrdiff_t title_start
;
11162 ptrdiff_t count
= SPECPDL_INDEX ();
11164 FOR_EACH_FRAME (tail
, other_frame
)
11166 struct frame
*tf
= XFRAME (other_frame
);
11169 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11170 && !FRAME_MINIBUF_ONLY_P (tf
)
11171 && !EQ (other_frame
, tip_frame
)
11172 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11176 /* Set global variable indicating that multiple frames exist. */
11177 multiple_frames
= CONSP (tail
);
11179 /* Switch to the buffer of selected window of the frame. Set up
11180 mode_line_target so that display_mode_element will output into
11181 mode_line_noprop_buf; then display the title. */
11182 record_unwind_protect (unwind_format_mode_line
,
11183 format_mode_line_unwind_data
11184 (f
, current_buffer
, selected_window
, 0));
11186 Fselect_window (f
->selected_window
, Qt
);
11187 set_buffer_internal_1
11188 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11189 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11191 mode_line_target
= MODE_LINE_TITLE
;
11192 title_start
= MODE_LINE_NOPROP_LEN (0);
11193 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11194 NULL
, DEFAULT_FACE_ID
);
11195 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11196 len
= MODE_LINE_NOPROP_LEN (title_start
);
11197 title
= mode_line_noprop_buf
+ title_start
;
11198 unbind_to (count
, Qnil
);
11200 /* Set the title only if it's changed. This avoids consing in
11201 the common case where it hasn't. (If it turns out that we've
11202 already wasted too much time by walking through the list with
11203 display_mode_element, then we might need to optimize at a
11204 higher level than this.) */
11205 if (! STRINGP (f
->name
)
11206 || SBYTES (f
->name
) != len
11207 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11208 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11212 #endif /* not HAVE_WINDOW_SYSTEM */
11215 /***********************************************************************
11217 ***********************************************************************/
11220 /* Prepare for redisplay by updating menu-bar item lists when
11221 appropriate. This can call eval. */
11224 prepare_menu_bars (void)
11227 struct gcpro gcpro1
, gcpro2
;
11229 Lisp_Object tooltip_frame
;
11231 #ifdef HAVE_WINDOW_SYSTEM
11232 tooltip_frame
= tip_frame
;
11234 tooltip_frame
= Qnil
;
11237 /* Update all frame titles based on their buffer names, etc. We do
11238 this before the menu bars so that the buffer-menu will show the
11239 up-to-date frame titles. */
11240 #ifdef HAVE_WINDOW_SYSTEM
11241 if (windows_or_buffers_changed
|| update_mode_lines
)
11243 Lisp_Object tail
, frame
;
11245 FOR_EACH_FRAME (tail
, frame
)
11247 f
= XFRAME (frame
);
11248 if (!EQ (frame
, tooltip_frame
)
11249 && (FRAME_ICONIFIED_P (f
)
11250 || FRAME_VISIBLE_P (f
) == 1
11251 /* Exclude TTY frames that are obscured because they
11252 are not the top frame on their console. This is
11253 because x_consider_frame_title actually switches
11254 to the frame, which for TTY frames means it is
11255 marked as garbaged, and will be completely
11256 redrawn on the next redisplay cycle. This causes
11257 TTY frames to be completely redrawn, when there
11258 are more than one of them, even though nothing
11259 should be changed on display. */
11260 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11261 x_consider_frame_title (frame
);
11264 #endif /* HAVE_WINDOW_SYSTEM */
11266 /* Update the menu bar item lists, if appropriate. This has to be
11267 done before any actual redisplay or generation of display lines. */
11268 all_windows
= (update_mode_lines
11269 || buffer_shared_and_changed ()
11270 || windows_or_buffers_changed
);
11273 Lisp_Object tail
, frame
;
11274 ptrdiff_t count
= SPECPDL_INDEX ();
11275 /* 1 means that update_menu_bar has run its hooks
11276 so any further calls to update_menu_bar shouldn't do so again. */
11277 int menu_bar_hooks_run
= 0;
11279 record_unwind_save_match_data ();
11281 FOR_EACH_FRAME (tail
, frame
)
11283 f
= XFRAME (frame
);
11285 /* Ignore tooltip frame. */
11286 if (EQ (frame
, tooltip_frame
))
11289 /* If a window on this frame changed size, report that to
11290 the user and clear the size-change flag. */
11291 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11293 Lisp_Object functions
;
11295 /* Clear flag first in case we get an error below. */
11296 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11297 functions
= Vwindow_size_change_functions
;
11298 GCPRO2 (tail
, functions
);
11300 while (CONSP (functions
))
11302 if (!EQ (XCAR (functions
), Qt
))
11303 call1 (XCAR (functions
), frame
);
11304 functions
= XCDR (functions
);
11310 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11311 #ifdef HAVE_WINDOW_SYSTEM
11312 update_tool_bar (f
, 0);
11315 if (windows_or_buffers_changed
11318 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11323 unbind_to (count
, Qnil
);
11327 struct frame
*sf
= SELECTED_FRAME ();
11328 update_menu_bar (sf
, 1, 0);
11329 #ifdef HAVE_WINDOW_SYSTEM
11330 update_tool_bar (sf
, 1);
11336 /* Update the menu bar item list for frame F. This has to be done
11337 before we start to fill in any display lines, because it can call
11340 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11342 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11343 already ran the menu bar hooks for this redisplay, so there
11344 is no need to run them again. The return value is the
11345 updated value of this flag, to pass to the next call. */
11348 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11350 Lisp_Object window
;
11351 register struct window
*w
;
11353 /* If called recursively during a menu update, do nothing. This can
11354 happen when, for instance, an activate-menubar-hook causes a
11356 if (inhibit_menubar_update
)
11359 window
= FRAME_SELECTED_WINDOW (f
);
11360 w
= XWINDOW (window
);
11362 if (FRAME_WINDOW_P (f
)
11364 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11365 || defined (HAVE_NS) || defined (USE_GTK)
11366 FRAME_EXTERNAL_MENU_BAR (f
)
11368 FRAME_MENU_BAR_LINES (f
) > 0
11370 : FRAME_MENU_BAR_LINES (f
) > 0)
11372 /* If the user has switched buffers or windows, we need to
11373 recompute to reflect the new bindings. But we'll
11374 recompute when update_mode_lines is set too; that means
11375 that people can use force-mode-line-update to request
11376 that the menu bar be recomputed. The adverse effect on
11377 the rest of the redisplay algorithm is about the same as
11378 windows_or_buffers_changed anyway. */
11379 if (windows_or_buffers_changed
11380 /* This used to test w->update_mode_line, but we believe
11381 there is no need to recompute the menu in that case. */
11382 || update_mode_lines
11383 || window_buffer_changed (w
))
11385 struct buffer
*prev
= current_buffer
;
11386 ptrdiff_t count
= SPECPDL_INDEX ();
11388 specbind (Qinhibit_menubar_update
, Qt
);
11390 set_buffer_internal_1 (XBUFFER (w
->contents
));
11391 if (save_match_data
)
11392 record_unwind_save_match_data ();
11393 if (NILP (Voverriding_local_map_menu_flag
))
11395 specbind (Qoverriding_terminal_local_map
, Qnil
);
11396 specbind (Qoverriding_local_map
, Qnil
);
11401 /* Run the Lucid hook. */
11402 safe_run_hooks (Qactivate_menubar_hook
);
11404 /* If it has changed current-menubar from previous value,
11405 really recompute the menu-bar from the value. */
11406 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11407 call0 (Qrecompute_lucid_menubar
);
11409 safe_run_hooks (Qmenu_bar_update_hook
);
11414 XSETFRAME (Vmenu_updating_frame
, f
);
11415 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11417 /* Redisplay the menu bar in case we changed it. */
11418 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11419 || defined (HAVE_NS) || defined (USE_GTK)
11420 if (FRAME_WINDOW_P (f
))
11422 #if defined (HAVE_NS)
11423 /* All frames on Mac OS share the same menubar. So only
11424 the selected frame should be allowed to set it. */
11425 if (f
== SELECTED_FRAME ())
11427 set_frame_menubar (f
, 0, 0);
11430 /* On a terminal screen, the menu bar is an ordinary screen
11431 line, and this makes it get updated. */
11432 w
->update_mode_line
= 1;
11433 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11434 /* In the non-toolkit version, the menu bar is an ordinary screen
11435 line, and this makes it get updated. */
11436 w
->update_mode_line
= 1;
11437 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11439 unbind_to (count
, Qnil
);
11440 set_buffer_internal_1 (prev
);
11447 /***********************************************************************
11449 ***********************************************************************/
11451 #ifdef HAVE_WINDOW_SYSTEM
11453 /* Where the mouse was last time we reported a mouse event. */
11455 struct frame
*last_mouse_frame
;
11457 /* Tool-bar item index of the item on which a mouse button was pressed
11460 int last_tool_bar_item
;
11462 /* Select `frame' temporarily without running all the code in
11464 FIXME: Maybe do_switch_frame should be trimmed down similarly
11465 when `norecord' is set. */
11467 fast_set_selected_frame (Lisp_Object frame
)
11469 if (!EQ (selected_frame
, frame
))
11471 selected_frame
= frame
;
11472 selected_window
= XFRAME (frame
)->selected_window
;
11476 /* Update the tool-bar item list for frame F. This has to be done
11477 before we start to fill in any display lines. Called from
11478 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11479 and restore it here. */
11482 update_tool_bar (struct frame
*f
, int save_match_data
)
11484 #if defined (USE_GTK) || defined (HAVE_NS)
11485 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11487 int do_update
= WINDOWP (f
->tool_bar_window
)
11488 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11493 Lisp_Object window
;
11496 window
= FRAME_SELECTED_WINDOW (f
);
11497 w
= XWINDOW (window
);
11499 /* If the user has switched buffers or windows, we need to
11500 recompute to reflect the new bindings. But we'll
11501 recompute when update_mode_lines is set too; that means
11502 that people can use force-mode-line-update to request
11503 that the menu bar be recomputed. The adverse effect on
11504 the rest of the redisplay algorithm is about the same as
11505 windows_or_buffers_changed anyway. */
11506 if (windows_or_buffers_changed
11507 || w
->update_mode_line
11508 || update_mode_lines
11509 || window_buffer_changed (w
))
11511 struct buffer
*prev
= current_buffer
;
11512 ptrdiff_t count
= SPECPDL_INDEX ();
11513 Lisp_Object frame
, new_tool_bar
;
11514 int new_n_tool_bar
;
11515 struct gcpro gcpro1
;
11517 /* Set current_buffer to the buffer of the selected
11518 window of the frame, so that we get the right local
11520 set_buffer_internal_1 (XBUFFER (w
->contents
));
11522 /* Save match data, if we must. */
11523 if (save_match_data
)
11524 record_unwind_save_match_data ();
11526 /* Make sure that we don't accidentally use bogus keymaps. */
11527 if (NILP (Voverriding_local_map_menu_flag
))
11529 specbind (Qoverriding_terminal_local_map
, Qnil
);
11530 specbind (Qoverriding_local_map
, Qnil
);
11533 GCPRO1 (new_tool_bar
);
11535 /* We must temporarily set the selected frame to this frame
11536 before calling tool_bar_items, because the calculation of
11537 the tool-bar keymap uses the selected frame (see
11538 `tool-bar-make-keymap' in tool-bar.el). */
11539 eassert (EQ (selected_window
,
11540 /* Since we only explicitly preserve selected_frame,
11541 check that selected_window would be redundant. */
11542 XFRAME (selected_frame
)->selected_window
));
11543 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11544 XSETFRAME (frame
, f
);
11545 fast_set_selected_frame (frame
);
11547 /* Build desired tool-bar items from keymaps. */
11549 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11552 /* Redisplay the tool-bar if we changed it. */
11553 if (new_n_tool_bar
!= f
->n_tool_bar_items
11554 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11556 /* Redisplay that happens asynchronously due to an expose event
11557 may access f->tool_bar_items. Make sure we update both
11558 variables within BLOCK_INPUT so no such event interrupts. */
11560 fset_tool_bar_items (f
, new_tool_bar
);
11561 f
->n_tool_bar_items
= new_n_tool_bar
;
11562 w
->update_mode_line
= 1;
11568 unbind_to (count
, Qnil
);
11569 set_buffer_internal_1 (prev
);
11575 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11576 F's desired tool-bar contents. F->tool_bar_items must have
11577 been set up previously by calling prepare_menu_bars. */
11580 build_desired_tool_bar_string (struct frame
*f
)
11582 int i
, size
, size_needed
;
11583 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11584 Lisp_Object image
, plist
, props
;
11586 image
= plist
= props
= Qnil
;
11587 GCPRO3 (image
, plist
, props
);
11589 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11590 Otherwise, make a new string. */
11592 /* The size of the string we might be able to reuse. */
11593 size
= (STRINGP (f
->desired_tool_bar_string
)
11594 ? SCHARS (f
->desired_tool_bar_string
)
11597 /* We need one space in the string for each image. */
11598 size_needed
= f
->n_tool_bar_items
;
11600 /* Reuse f->desired_tool_bar_string, if possible. */
11601 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11602 fset_desired_tool_bar_string
11603 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11606 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11607 Fremove_text_properties (make_number (0), make_number (size
),
11608 props
, f
->desired_tool_bar_string
);
11611 /* Put a `display' property on the string for the images to display,
11612 put a `menu_item' property on tool-bar items with a value that
11613 is the index of the item in F's tool-bar item vector. */
11614 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11616 #define PROP(IDX) \
11617 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11619 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11620 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11621 int hmargin
, vmargin
, relief
, idx
, end
;
11623 /* If image is a vector, choose the image according to the
11625 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11626 if (VECTORP (image
))
11630 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11631 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11634 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11635 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11637 eassert (ASIZE (image
) >= idx
);
11638 image
= AREF (image
, idx
);
11643 /* Ignore invalid image specifications. */
11644 if (!valid_image_p (image
))
11647 /* Display the tool-bar button pressed, or depressed. */
11648 plist
= Fcopy_sequence (XCDR (image
));
11650 /* Compute margin and relief to draw. */
11651 relief
= (tool_bar_button_relief
>= 0
11652 ? tool_bar_button_relief
11653 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11654 hmargin
= vmargin
= relief
;
11656 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11657 INT_MAX
- max (hmargin
, vmargin
)))
11659 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11660 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11662 else if (CONSP (Vtool_bar_button_margin
))
11664 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11665 INT_MAX
- hmargin
))
11666 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11668 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11669 INT_MAX
- vmargin
))
11670 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11673 if (auto_raise_tool_bar_buttons_p
)
11675 /* Add a `:relief' property to the image spec if the item is
11679 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11686 /* If image is selected, display it pressed, i.e. with a
11687 negative relief. If it's not selected, display it with a
11689 plist
= Fplist_put (plist
, QCrelief
,
11691 ? make_number (-relief
)
11692 : make_number (relief
)));
11697 /* Put a margin around the image. */
11698 if (hmargin
|| vmargin
)
11700 if (hmargin
== vmargin
)
11701 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11703 plist
= Fplist_put (plist
, QCmargin
,
11704 Fcons (make_number (hmargin
),
11705 make_number (vmargin
)));
11708 /* If button is not enabled, and we don't have special images
11709 for the disabled state, make the image appear disabled by
11710 applying an appropriate algorithm to it. */
11711 if (!enabled_p
&& idx
< 0)
11712 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11714 /* Put a `display' text property on the string for the image to
11715 display. Put a `menu-item' property on the string that gives
11716 the start of this item's properties in the tool-bar items
11718 image
= Fcons (Qimage
, plist
);
11719 props
= list4 (Qdisplay
, image
,
11720 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11722 /* Let the last image hide all remaining spaces in the tool bar
11723 string. The string can be longer than needed when we reuse a
11724 previous string. */
11725 if (i
+ 1 == f
->n_tool_bar_items
)
11726 end
= SCHARS (f
->desired_tool_bar_string
);
11729 Fadd_text_properties (make_number (i
), make_number (end
),
11730 props
, f
->desired_tool_bar_string
);
11738 /* Display one line of the tool-bar of frame IT->f.
11740 HEIGHT specifies the desired height of the tool-bar line.
11741 If the actual height of the glyph row is less than HEIGHT, the
11742 row's height is increased to HEIGHT, and the icons are centered
11743 vertically in the new height.
11745 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11746 count a final empty row in case the tool-bar width exactly matches
11751 display_tool_bar_line (struct it
*it
, int height
)
11753 struct glyph_row
*row
= it
->glyph_row
;
11754 int max_x
= it
->last_visible_x
;
11755 struct glyph
*last
;
11757 prepare_desired_row (row
);
11758 row
->y
= it
->current_y
;
11760 /* Note that this isn't made use of if the face hasn't a box,
11761 so there's no need to check the face here. */
11762 it
->start_of_box_run_p
= 1;
11764 while (it
->current_x
< max_x
)
11766 int x
, n_glyphs_before
, i
, nglyphs
;
11767 struct it it_before
;
11769 /* Get the next display element. */
11770 if (!get_next_display_element (it
))
11772 /* Don't count empty row if we are counting needed tool-bar lines. */
11773 if (height
< 0 && !it
->hpos
)
11778 /* Produce glyphs. */
11779 n_glyphs_before
= row
->used
[TEXT_AREA
];
11782 PRODUCE_GLYPHS (it
);
11784 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11786 x
= it_before
.current_x
;
11787 while (i
< nglyphs
)
11789 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11791 if (x
+ glyph
->pixel_width
> max_x
)
11793 /* Glyph doesn't fit on line. Backtrack. */
11794 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11796 /* If this is the only glyph on this line, it will never fit on the
11797 tool-bar, so skip it. But ensure there is at least one glyph,
11798 so we don't accidentally disable the tool-bar. */
11799 if (n_glyphs_before
== 0
11800 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11806 x
+= glyph
->pixel_width
;
11810 /* Stop at line end. */
11811 if (ITERATOR_AT_END_OF_LINE_P (it
))
11814 set_iterator_to_next (it
, 1);
11819 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11821 /* Use default face for the border below the tool bar.
11823 FIXME: When auto-resize-tool-bars is grow-only, there is
11824 no additional border below the possibly empty tool-bar lines.
11825 So to make the extra empty lines look "normal", we have to
11826 use the tool-bar face for the border too. */
11827 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
11828 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11829 it
->face_id
= DEFAULT_FACE_ID
;
11831 extend_face_to_end_of_line (it
);
11832 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11833 last
->right_box_line_p
= 1;
11834 if (last
== row
->glyphs
[TEXT_AREA
])
11835 last
->left_box_line_p
= 1;
11837 /* Make line the desired height and center it vertically. */
11838 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11840 /* Don't add more than one line height. */
11841 height
%= FRAME_LINE_HEIGHT (it
->f
);
11842 it
->max_ascent
+= height
/ 2;
11843 it
->max_descent
+= (height
+ 1) / 2;
11846 compute_line_metrics (it
);
11848 /* If line is empty, make it occupy the rest of the tool-bar. */
11849 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
11851 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11852 row
->visible_height
= row
->height
;
11853 row
->ascent
= row
->phys_ascent
= 0;
11854 row
->extra_line_spacing
= 0;
11857 row
->full_width_p
= 1;
11858 row
->continued_p
= 0;
11859 row
->truncated_on_left_p
= 0;
11860 row
->truncated_on_right_p
= 0;
11862 it
->current_x
= it
->hpos
= 0;
11863 it
->current_y
+= row
->height
;
11869 /* Max tool-bar height. */
11871 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11872 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11874 /* Value is the number of screen lines needed to make all tool-bar
11875 items of frame F visible. The number of actual rows needed is
11876 returned in *N_ROWS if non-NULL. */
11879 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11881 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11883 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11884 the desired matrix, so use (unused) mode-line row as temporary row to
11885 avoid destroying the first tool-bar row. */
11886 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11888 /* Initialize an iterator for iteration over
11889 F->desired_tool_bar_string in the tool-bar window of frame F. */
11890 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11891 it
.first_visible_x
= 0;
11892 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11893 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11894 it
.paragraph_embedding
= L2R
;
11896 while (!ITERATOR_AT_END_P (&it
))
11898 clear_glyph_row (temp_row
);
11899 it
.glyph_row
= temp_row
;
11900 display_tool_bar_line (&it
, -1);
11902 clear_glyph_row (temp_row
);
11904 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11906 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11908 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11912 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11914 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
11915 If FRAME is nil or omitted, use the selected frame. */)
11916 (Lisp_Object frame
)
11918 struct frame
*f
= decode_any_frame (frame
);
11922 if (WINDOWP (f
->tool_bar_window
)
11923 && (w
= XWINDOW (f
->tool_bar_window
),
11924 WINDOW_TOTAL_LINES (w
) > 0))
11926 update_tool_bar (f
, 1);
11927 if (f
->n_tool_bar_items
)
11929 build_desired_tool_bar_string (f
);
11930 nlines
= tool_bar_lines_needed (f
, NULL
);
11934 return make_number (nlines
);
11938 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11939 height should be changed. */
11942 redisplay_tool_bar (struct frame
*f
)
11946 struct glyph_row
*row
;
11948 #if defined (USE_GTK) || defined (HAVE_NS)
11949 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11950 update_frame_tool_bar (f
);
11954 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11955 do anything. This means you must start with tool-bar-lines
11956 non-zero to get the auto-sizing effect. Or in other words, you
11957 can turn off tool-bars by specifying tool-bar-lines zero. */
11958 if (!WINDOWP (f
->tool_bar_window
)
11959 || (w
= XWINDOW (f
->tool_bar_window
),
11960 WINDOW_TOTAL_LINES (w
) == 0))
11963 /* Set up an iterator for the tool-bar window. */
11964 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11965 it
.first_visible_x
= 0;
11966 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11967 row
= it
.glyph_row
;
11969 /* Build a string that represents the contents of the tool-bar. */
11970 build_desired_tool_bar_string (f
);
11971 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11972 /* FIXME: This should be controlled by a user option. But it
11973 doesn't make sense to have an R2L tool bar if the menu bar cannot
11974 be drawn also R2L, and making the menu bar R2L is tricky due
11975 toolkit-specific code that implements it. If an R2L tool bar is
11976 ever supported, display_tool_bar_line should also be augmented to
11977 call unproduce_glyphs like display_line and display_string
11979 it
.paragraph_embedding
= L2R
;
11981 if (f
->n_tool_bar_rows
== 0)
11985 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11986 nlines
!= WINDOW_TOTAL_LINES (w
)))
11989 int old_height
= WINDOW_TOTAL_LINES (w
);
11991 XSETFRAME (frame
, f
);
11992 Fmodify_frame_parameters (frame
,
11993 list1 (Fcons (Qtool_bar_lines
,
11994 make_number (nlines
))));
11995 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11997 clear_glyph_matrix (w
->desired_matrix
);
11998 fonts_changed_p
= 1;
12004 /* Display as many lines as needed to display all tool-bar items. */
12006 if (f
->n_tool_bar_rows
> 0)
12008 int border
, rows
, height
, extra
;
12010 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12011 border
= XINT (Vtool_bar_border
);
12012 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12013 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12014 else if (EQ (Vtool_bar_border
, Qborder_width
))
12015 border
= f
->border_width
;
12021 rows
= f
->n_tool_bar_rows
;
12022 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12023 extra
= it
.last_visible_y
- border
- height
* rows
;
12025 while (it
.current_y
< it
.last_visible_y
)
12028 if (extra
> 0 && rows
-- > 0)
12030 h
= (extra
+ rows
- 1) / rows
;
12033 display_tool_bar_line (&it
, height
+ h
);
12038 while (it
.current_y
< it
.last_visible_y
)
12039 display_tool_bar_line (&it
, 0);
12042 /* It doesn't make much sense to try scrolling in the tool-bar
12043 window, so don't do it. */
12044 w
->desired_matrix
->no_scrolling_p
= 1;
12045 w
->must_be_updated_p
= 1;
12047 if (!NILP (Vauto_resize_tool_bars
))
12049 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12050 int change_height_p
= 0;
12052 /* If we couldn't display everything, change the tool-bar's
12053 height if there is room for more. */
12054 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12055 && it
.current_y
< max_tool_bar_height
)
12056 change_height_p
= 1;
12058 row
= it
.glyph_row
- 1;
12060 /* If there are blank lines at the end, except for a partially
12061 visible blank line at the end that is smaller than
12062 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12063 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12064 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12065 change_height_p
= 1;
12067 /* If row displays tool-bar items, but is partially visible,
12068 change the tool-bar's height. */
12069 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12070 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12071 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12072 change_height_p
= 1;
12074 /* Resize windows as needed by changing the `tool-bar-lines'
12075 frame parameter. */
12076 if (change_height_p
)
12079 int old_height
= WINDOW_TOTAL_LINES (w
);
12081 int nlines
= tool_bar_lines_needed (f
, &nrows
);
12083 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12084 && !f
->minimize_tool_bar_window_p
)
12085 ? (nlines
> old_height
)
12086 : (nlines
!= old_height
));
12087 f
->minimize_tool_bar_window_p
= 0;
12089 if (change_height_p
)
12091 XSETFRAME (frame
, f
);
12092 Fmodify_frame_parameters (frame
,
12093 list1 (Fcons (Qtool_bar_lines
,
12094 make_number (nlines
))));
12095 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12097 clear_glyph_matrix (w
->desired_matrix
);
12098 f
->n_tool_bar_rows
= nrows
;
12099 fonts_changed_p
= 1;
12106 f
->minimize_tool_bar_window_p
= 0;
12111 /* Get information about the tool-bar item which is displayed in GLYPH
12112 on frame F. Return in *PROP_IDX the index where tool-bar item
12113 properties start in F->tool_bar_items. Value is zero if
12114 GLYPH doesn't display a tool-bar item. */
12117 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12123 /* This function can be called asynchronously, which means we must
12124 exclude any possibility that Fget_text_property signals an
12126 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12127 charpos
= max (0, charpos
);
12129 /* Get the text property `menu-item' at pos. The value of that
12130 property is the start index of this item's properties in
12131 F->tool_bar_items. */
12132 prop
= Fget_text_property (make_number (charpos
),
12133 Qmenu_item
, f
->current_tool_bar_string
);
12134 if (INTEGERP (prop
))
12136 *prop_idx
= XINT (prop
);
12146 /* Get information about the tool-bar item at position X/Y on frame F.
12147 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12148 the current matrix of the tool-bar window of F, or NULL if not
12149 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12150 item in F->tool_bar_items. Value is
12152 -1 if X/Y is not on a tool-bar item
12153 0 if X/Y is on the same item that was highlighted before.
12157 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12158 int *hpos
, int *vpos
, int *prop_idx
)
12160 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12161 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12164 /* Find the glyph under X/Y. */
12165 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12166 if (*glyph
== NULL
)
12169 /* Get the start of this tool-bar item's properties in
12170 f->tool_bar_items. */
12171 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12174 /* Is mouse on the highlighted item? */
12175 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12176 && *vpos
>= hlinfo
->mouse_face_beg_row
12177 && *vpos
<= hlinfo
->mouse_face_end_row
12178 && (*vpos
> hlinfo
->mouse_face_beg_row
12179 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12180 && (*vpos
< hlinfo
->mouse_face_end_row
12181 || *hpos
< hlinfo
->mouse_face_end_col
12182 || hlinfo
->mouse_face_past_end
))
12190 Handle mouse button event on the tool-bar of frame F, at
12191 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12192 0 for button release. MODIFIERS is event modifiers for button
12196 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12199 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12200 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12201 int hpos
, vpos
, prop_idx
;
12202 struct glyph
*glyph
;
12203 Lisp_Object enabled_p
;
12206 /* If not on the highlighted tool-bar item, and mouse-highlight is
12207 non-nil, return. This is so we generate the tool-bar button
12208 click only when the mouse button is released on the same item as
12209 where it was pressed. However, when mouse-highlight is disabled,
12210 generate the click when the button is released regardless of the
12211 highlight, since tool-bar items are not highlighted in that
12213 frame_to_window_pixel_xy (w
, &x
, &y
);
12214 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12216 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12219 /* When mouse-highlight is off, generate the click for the item
12220 where the button was pressed, disregarding where it was
12222 if (NILP (Vmouse_highlight
) && !down_p
)
12223 prop_idx
= last_tool_bar_item
;
12225 /* If item is disabled, do nothing. */
12226 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12227 if (NILP (enabled_p
))
12232 /* Show item in pressed state. */
12233 if (!NILP (Vmouse_highlight
))
12234 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12235 last_tool_bar_item
= prop_idx
;
12239 Lisp_Object key
, frame
;
12240 struct input_event event
;
12241 EVENT_INIT (event
);
12243 /* Show item in released state. */
12244 if (!NILP (Vmouse_highlight
))
12245 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12247 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12249 XSETFRAME (frame
, f
);
12250 event
.kind
= TOOL_BAR_EVENT
;
12251 event
.frame_or_window
= frame
;
12253 kbd_buffer_store_event (&event
);
12255 event
.kind
= TOOL_BAR_EVENT
;
12256 event
.frame_or_window
= frame
;
12258 event
.modifiers
= modifiers
;
12259 kbd_buffer_store_event (&event
);
12260 last_tool_bar_item
= -1;
12265 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12266 tool-bar window-relative coordinates X/Y. Called from
12267 note_mouse_highlight. */
12270 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12272 Lisp_Object window
= f
->tool_bar_window
;
12273 struct window
*w
= XWINDOW (window
);
12274 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12275 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12277 struct glyph
*glyph
;
12278 struct glyph_row
*row
;
12280 Lisp_Object enabled_p
;
12282 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12283 int mouse_down_p
, rc
;
12285 /* Function note_mouse_highlight is called with negative X/Y
12286 values when mouse moves outside of the frame. */
12287 if (x
<= 0 || y
<= 0)
12289 clear_mouse_face (hlinfo
);
12293 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12296 /* Not on tool-bar item. */
12297 clear_mouse_face (hlinfo
);
12301 /* On same tool-bar item as before. */
12302 goto set_help_echo
;
12304 clear_mouse_face (hlinfo
);
12306 /* Mouse is down, but on different tool-bar item? */
12307 mouse_down_p
= (dpyinfo
->grabbed
12308 && f
== last_mouse_frame
12309 && FRAME_LIVE_P (f
));
12311 && last_tool_bar_item
!= prop_idx
)
12314 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12316 /* If tool-bar item is not enabled, don't highlight it. */
12317 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12318 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12320 /* Compute the x-position of the glyph. In front and past the
12321 image is a space. We include this in the highlighted area. */
12322 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12323 for (i
= x
= 0; i
< hpos
; ++i
)
12324 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12326 /* Record this as the current active region. */
12327 hlinfo
->mouse_face_beg_col
= hpos
;
12328 hlinfo
->mouse_face_beg_row
= vpos
;
12329 hlinfo
->mouse_face_beg_x
= x
;
12330 hlinfo
->mouse_face_past_end
= 0;
12332 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12333 hlinfo
->mouse_face_end_row
= vpos
;
12334 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12335 hlinfo
->mouse_face_window
= window
;
12336 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12338 /* Display it as active. */
12339 show_mouse_face (hlinfo
, draw
);
12344 /* Set help_echo_string to a help string to display for this tool-bar item.
12345 XTread_socket does the rest. */
12346 help_echo_object
= help_echo_window
= Qnil
;
12347 help_echo_pos
= -1;
12348 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12349 if (NILP (help_echo_string
))
12350 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12353 #endif /* HAVE_WINDOW_SYSTEM */
12357 /************************************************************************
12358 Horizontal scrolling
12359 ************************************************************************/
12361 static int hscroll_window_tree (Lisp_Object
);
12362 static int hscroll_windows (Lisp_Object
);
12364 /* For all leaf windows in the window tree rooted at WINDOW, set their
12365 hscroll value so that PT is (i) visible in the window, and (ii) so
12366 that it is not within a certain margin at the window's left and
12367 right border. Value is non-zero if any window's hscroll has been
12371 hscroll_window_tree (Lisp_Object window
)
12373 int hscrolled_p
= 0;
12374 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12375 int hscroll_step_abs
= 0;
12376 double hscroll_step_rel
= 0;
12378 if (hscroll_relative_p
)
12380 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12381 if (hscroll_step_rel
< 0)
12383 hscroll_relative_p
= 0;
12384 hscroll_step_abs
= 0;
12387 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12389 hscroll_step_abs
= XINT (Vhscroll_step
);
12390 if (hscroll_step_abs
< 0)
12391 hscroll_step_abs
= 0;
12394 hscroll_step_abs
= 0;
12396 while (WINDOWP (window
))
12398 struct window
*w
= XWINDOW (window
);
12400 if (WINDOWP (w
->contents
))
12401 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12402 else if (w
->cursor
.vpos
>= 0)
12405 int text_area_width
;
12406 struct glyph_row
*current_cursor_row
12407 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12408 struct glyph_row
*desired_cursor_row
12409 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12410 struct glyph_row
*cursor_row
12411 = (desired_cursor_row
->enabled_p
12412 ? desired_cursor_row
12413 : current_cursor_row
);
12414 int row_r2l_p
= cursor_row
->reversed_p
;
12416 text_area_width
= window_box_width (w
, TEXT_AREA
);
12418 /* Scroll when cursor is inside this scroll margin. */
12419 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12421 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12422 /* For left-to-right rows, hscroll when cursor is either
12423 (i) inside the right hscroll margin, or (ii) if it is
12424 inside the left margin and the window is already
12428 && w
->cursor
.x
<= h_margin
)
12429 || (cursor_row
->enabled_p
12430 && cursor_row
->truncated_on_right_p
12431 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12432 /* For right-to-left rows, the logic is similar,
12433 except that rules for scrolling to left and right
12434 are reversed. E.g., if cursor.x <= h_margin, we
12435 need to hscroll "to the right" unconditionally,
12436 and that will scroll the screen to the left so as
12437 to reveal the next portion of the row. */
12439 && ((cursor_row
->enabled_p
12440 /* FIXME: It is confusing to set the
12441 truncated_on_right_p flag when R2L rows
12442 are actually truncated on the left. */
12443 && cursor_row
->truncated_on_right_p
12444 && w
->cursor
.x
<= h_margin
)
12446 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12450 struct buffer
*saved_current_buffer
;
12454 /* Find point in a display of infinite width. */
12455 saved_current_buffer
= current_buffer
;
12456 current_buffer
= XBUFFER (w
->contents
);
12458 if (w
== XWINDOW (selected_window
))
12461 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12463 /* Move iterator to pt starting at cursor_row->start in
12464 a line with infinite width. */
12465 init_to_row_start (&it
, w
, cursor_row
);
12466 it
.last_visible_x
= INFINITY
;
12467 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12468 current_buffer
= saved_current_buffer
;
12470 /* Position cursor in window. */
12471 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12472 hscroll
= max (0, (it
.current_x
12473 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12474 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12475 : (text_area_width
/ 2))))
12476 / FRAME_COLUMN_WIDTH (it
.f
);
12477 else if ((!row_r2l_p
12478 && w
->cursor
.x
>= text_area_width
- h_margin
)
12479 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12481 if (hscroll_relative_p
)
12482 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12485 wanted_x
= text_area_width
12486 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12489 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12493 if (hscroll_relative_p
)
12494 wanted_x
= text_area_width
* hscroll_step_rel
12497 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12500 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12502 hscroll
= max (hscroll
, w
->min_hscroll
);
12504 /* Don't prevent redisplay optimizations if hscroll
12505 hasn't changed, as it will unnecessarily slow down
12507 if (w
->hscroll
!= hscroll
)
12509 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12510 w
->hscroll
= hscroll
;
12519 /* Value is non-zero if hscroll of any leaf window has been changed. */
12520 return hscrolled_p
;
12524 /* Set hscroll so that cursor is visible and not inside horizontal
12525 scroll margins for all windows in the tree rooted at WINDOW. See
12526 also hscroll_window_tree above. Value is non-zero if any window's
12527 hscroll has been changed. If it has, desired matrices on the frame
12528 of WINDOW are cleared. */
12531 hscroll_windows (Lisp_Object window
)
12533 int hscrolled_p
= hscroll_window_tree (window
);
12535 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12536 return hscrolled_p
;
12541 /************************************************************************
12543 ************************************************************************/
12545 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12546 to a non-zero value. This is sometimes handy to have in a debugger
12551 /* First and last unchanged row for try_window_id. */
12553 static int debug_first_unchanged_at_end_vpos
;
12554 static int debug_last_unchanged_at_beg_vpos
;
12556 /* Delta vpos and y. */
12558 static int debug_dvpos
, debug_dy
;
12560 /* Delta in characters and bytes for try_window_id. */
12562 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12564 /* Values of window_end_pos and window_end_vpos at the end of
12567 static ptrdiff_t debug_end_vpos
;
12569 /* Append a string to W->desired_matrix->method. FMT is a printf
12570 format string. If trace_redisplay_p is non-zero also printf the
12571 resulting string to stderr. */
12573 static void debug_method_add (struct window
*, char const *, ...)
12574 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12577 debug_method_add (struct window
*w
, char const *fmt
, ...)
12580 char *method
= w
->desired_matrix
->method
;
12581 int len
= strlen (method
);
12582 int size
= sizeof w
->desired_matrix
->method
;
12583 int remaining
= size
- len
- 1;
12586 if (len
&& remaining
)
12589 --remaining
, ++len
;
12592 va_start (ap
, fmt
);
12593 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12596 if (trace_redisplay_p
)
12597 fprintf (stderr
, "%p (%s): %s\n",
12599 ((BUFFERP (w
->contents
)
12600 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
12601 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
12606 #endif /* GLYPH_DEBUG */
12609 /* Value is non-zero if all changes in window W, which displays
12610 current_buffer, are in the text between START and END. START is a
12611 buffer position, END is given as a distance from Z. Used in
12612 redisplay_internal for display optimization. */
12615 text_outside_line_unchanged_p (struct window
*w
,
12616 ptrdiff_t start
, ptrdiff_t end
)
12618 int unchanged_p
= 1;
12620 /* If text or overlays have changed, see where. */
12621 if (window_outdated (w
))
12623 /* Gap in the line? */
12624 if (GPT
< start
|| Z
- GPT
< end
)
12627 /* Changes start in front of the line, or end after it? */
12629 && (BEG_UNCHANGED
< start
- 1
12630 || END_UNCHANGED
< end
))
12633 /* If selective display, can't optimize if changes start at the
12634 beginning of the line. */
12636 && INTEGERP (BVAR (current_buffer
, selective_display
))
12637 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12638 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12641 /* If there are overlays at the start or end of the line, these
12642 may have overlay strings with newlines in them. A change at
12643 START, for instance, may actually concern the display of such
12644 overlay strings as well, and they are displayed on different
12645 lines. So, quickly rule out this case. (For the future, it
12646 might be desirable to implement something more telling than
12647 just BEG/END_UNCHANGED.) */
12650 if (BEG
+ BEG_UNCHANGED
== start
12651 && overlay_touches_p (start
))
12653 if (END_UNCHANGED
== end
12654 && overlay_touches_p (Z
- end
))
12658 /* Under bidi reordering, adding or deleting a character in the
12659 beginning of a paragraph, before the first strong directional
12660 character, can change the base direction of the paragraph (unless
12661 the buffer specifies a fixed paragraph direction), which will
12662 require to redisplay the whole paragraph. It might be worthwhile
12663 to find the paragraph limits and widen the range of redisplayed
12664 lines to that, but for now just give up this optimization. */
12665 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
12666 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
12670 return unchanged_p
;
12674 /* Do a frame update, taking possible shortcuts into account. This is
12675 the main external entry point for redisplay.
12677 If the last redisplay displayed an echo area message and that message
12678 is no longer requested, we clear the echo area or bring back the
12679 mini-buffer if that is in use. */
12684 redisplay_internal ();
12689 overlay_arrow_string_or_property (Lisp_Object var
)
12693 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12696 return Voverlay_arrow_string
;
12699 /* Return 1 if there are any overlay-arrows in current_buffer. */
12701 overlay_arrow_in_current_buffer_p (void)
12705 for (vlist
= Voverlay_arrow_variable_list
;
12707 vlist
= XCDR (vlist
))
12709 Lisp_Object var
= XCAR (vlist
);
12712 if (!SYMBOLP (var
))
12714 val
= find_symbol_value (var
);
12716 && current_buffer
== XMARKER (val
)->buffer
)
12723 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12727 overlay_arrows_changed_p (void)
12731 for (vlist
= Voverlay_arrow_variable_list
;
12733 vlist
= XCDR (vlist
))
12735 Lisp_Object var
= XCAR (vlist
);
12736 Lisp_Object val
, pstr
;
12738 if (!SYMBOLP (var
))
12740 val
= find_symbol_value (var
);
12741 if (!MARKERP (val
))
12743 if (! EQ (COERCE_MARKER (val
),
12744 Fget (var
, Qlast_arrow_position
))
12745 || ! (pstr
= overlay_arrow_string_or_property (var
),
12746 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12752 /* Mark overlay arrows to be updated on next redisplay. */
12755 update_overlay_arrows (int up_to_date
)
12759 for (vlist
= Voverlay_arrow_variable_list
;
12761 vlist
= XCDR (vlist
))
12763 Lisp_Object var
= XCAR (vlist
);
12765 if (!SYMBOLP (var
))
12768 if (up_to_date
> 0)
12770 Lisp_Object val
= find_symbol_value (var
);
12771 Fput (var
, Qlast_arrow_position
,
12772 COERCE_MARKER (val
));
12773 Fput (var
, Qlast_arrow_string
,
12774 overlay_arrow_string_or_property (var
));
12776 else if (up_to_date
< 0
12777 || !NILP (Fget (var
, Qlast_arrow_position
)))
12779 Fput (var
, Qlast_arrow_position
, Qt
);
12780 Fput (var
, Qlast_arrow_string
, Qt
);
12786 /* Return overlay arrow string to display at row.
12787 Return integer (bitmap number) for arrow bitmap in left fringe.
12788 Return nil if no overlay arrow. */
12791 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12795 for (vlist
= Voverlay_arrow_variable_list
;
12797 vlist
= XCDR (vlist
))
12799 Lisp_Object var
= XCAR (vlist
);
12802 if (!SYMBOLP (var
))
12805 val
= find_symbol_value (var
);
12808 && current_buffer
== XMARKER (val
)->buffer
12809 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12811 if (FRAME_WINDOW_P (it
->f
)
12812 /* FIXME: if ROW->reversed_p is set, this should test
12813 the right fringe, not the left one. */
12814 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12816 #ifdef HAVE_WINDOW_SYSTEM
12817 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12820 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12821 return make_number (fringe_bitmap
);
12824 return make_number (-1); /* Use default arrow bitmap. */
12826 return overlay_arrow_string_or_property (var
);
12833 /* Return 1 if point moved out of or into a composition. Otherwise
12834 return 0. PREV_BUF and PREV_PT are the last point buffer and
12835 position. BUF and PT are the current point buffer and position. */
12838 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12839 struct buffer
*buf
, ptrdiff_t pt
)
12841 ptrdiff_t start
, end
;
12843 Lisp_Object buffer
;
12845 XSETBUFFER (buffer
, buf
);
12846 /* Check a composition at the last point if point moved within the
12848 if (prev_buf
== buf
)
12851 /* Point didn't move. */
12854 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12855 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12856 && composition_valid_p (start
, end
, prop
)
12857 && start
< prev_pt
&& end
> prev_pt
)
12858 /* The last point was within the composition. Return 1 iff
12859 point moved out of the composition. */
12860 return (pt
<= start
|| pt
>= end
);
12863 /* Check a composition at the current point. */
12864 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12865 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12866 && composition_valid_p (start
, end
, prop
)
12867 && start
< pt
&& end
> pt
);
12870 /* Reconsider the clip changes of buffer which is displayed in W. */
12873 reconsider_clip_changes (struct window
*w
)
12875 struct buffer
*b
= XBUFFER (w
->contents
);
12877 if (b
->clip_changed
12878 && w
->window_end_valid
12879 && w
->current_matrix
->buffer
== b
12880 && w
->current_matrix
->zv
== BUF_ZV (b
)
12881 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12882 b
->clip_changed
= 0;
12884 /* If display wasn't paused, and W is not a tool bar window, see if
12885 point has been moved into or out of a composition. In that case,
12886 we set b->clip_changed to 1 to force updating the screen. If
12887 b->clip_changed has already been set to 1, we can skip this
12889 if (!b
->clip_changed
&& w
->window_end_valid
)
12891 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
12892 ? PT
: marker_position (w
->pointm
));
12894 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
12895 && check_point_in_composition (w
->current_matrix
->buffer
,
12896 w
->last_point
, b
, pt
))
12897 b
->clip_changed
= 1;
12901 #define STOP_POLLING \
12902 do { if (! polling_stopped_here) stop_polling (); \
12903 polling_stopped_here = 1; } while (0)
12905 #define RESUME_POLLING \
12906 do { if (polling_stopped_here) start_polling (); \
12907 polling_stopped_here = 0; } while (0)
12910 /* Perhaps in the future avoid recentering windows if it
12911 is not necessary; currently that causes some problems. */
12914 redisplay_internal (void)
12916 struct window
*w
= XWINDOW (selected_window
);
12920 bool must_finish
= 0, match_p
;
12921 struct text_pos tlbufpos
, tlendpos
;
12922 int number_of_visible_frames
;
12925 int polling_stopped_here
= 0;
12926 Lisp_Object tail
, frame
;
12928 /* Non-zero means redisplay has to consider all windows on all
12929 frames. Zero means, only selected_window is considered. */
12930 int consider_all_windows_p
;
12932 /* Non-zero means redisplay has to redisplay the miniwindow. */
12933 int update_miniwindow_p
= 0;
12935 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12937 /* No redisplay if running in batch mode or frame is not yet fully
12938 initialized, or redisplay is explicitly turned off by setting
12939 Vinhibit_redisplay. */
12940 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12941 || !NILP (Vinhibit_redisplay
))
12944 /* Don't examine these until after testing Vinhibit_redisplay.
12945 When Emacs is shutting down, perhaps because its connection to
12946 X has dropped, we should not look at them at all. */
12947 fr
= XFRAME (w
->frame
);
12948 sf
= SELECTED_FRAME ();
12950 if (!fr
->glyphs_initialized_p
)
12953 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12954 if (popup_activated ())
12958 /* I don't think this happens but let's be paranoid. */
12959 if (redisplaying_p
)
12962 /* Record a function that clears redisplaying_p
12963 when we leave this function. */
12964 count
= SPECPDL_INDEX ();
12965 record_unwind_protect_void (unwind_redisplay
);
12966 redisplaying_p
= 1;
12967 specbind (Qinhibit_free_realized_faces
, Qnil
);
12969 /* Record this function, so it appears on the profiler's backtraces. */
12970 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
12972 FOR_EACH_FRAME (tail
, frame
)
12973 XFRAME (frame
)->already_hscrolled_p
= 0;
12976 /* Remember the currently selected window. */
12980 last_escape_glyph_frame
= NULL
;
12981 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12982 last_glyphless_glyph_frame
= NULL
;
12983 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12985 /* If new fonts have been loaded that make a glyph matrix adjustment
12986 necessary, do it. */
12987 if (fonts_changed_p
)
12989 adjust_glyphs (NULL
);
12990 ++windows_or_buffers_changed
;
12991 fonts_changed_p
= 0;
12994 /* If face_change_count is non-zero, init_iterator will free all
12995 realized faces, which includes the faces referenced from current
12996 matrices. So, we can't reuse current matrices in this case. */
12997 if (face_change_count
)
12998 ++windows_or_buffers_changed
;
13000 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13001 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13003 /* Since frames on a single ASCII terminal share the same
13004 display area, displaying a different frame means redisplay
13005 the whole thing. */
13006 windows_or_buffers_changed
++;
13007 SET_FRAME_GARBAGED (sf
);
13009 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13011 FRAME_TTY (sf
)->previous_frame
= sf
;
13014 /* Set the visible flags for all frames. Do this before checking for
13015 resized or garbaged frames; they want to know if their frames are
13016 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13017 number_of_visible_frames
= 0;
13019 FOR_EACH_FRAME (tail
, frame
)
13021 struct frame
*f
= XFRAME (frame
);
13023 if (FRAME_VISIBLE_P (f
))
13024 ++number_of_visible_frames
;
13025 clear_desired_matrices (f
);
13028 /* Notice any pending interrupt request to change frame size. */
13029 do_pending_window_change (1);
13031 /* do_pending_window_change could change the selected_window due to
13032 frame resizing which makes the selected window too small. */
13033 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13036 /* Clear frames marked as garbaged. */
13037 clear_garbaged_frames ();
13039 /* Build menubar and tool-bar items. */
13040 if (NILP (Vmemory_full
))
13041 prepare_menu_bars ();
13043 if (windows_or_buffers_changed
)
13044 update_mode_lines
++;
13046 reconsider_clip_changes (w
);
13048 /* In most cases selected window displays current buffer. */
13049 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13054 /* Detect case that we need to write or remove a star in the mode line. */
13055 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13057 w
->update_mode_line
= 1;
13058 if (buffer_shared_and_changed ())
13059 update_mode_lines
++;
13062 /* Avoid invocation of point motion hooks by `current_column' below. */
13063 count1
= SPECPDL_INDEX ();
13064 specbind (Qinhibit_point_motion_hooks
, Qt
);
13066 if (mode_line_update_needed (w
))
13067 w
->update_mode_line
= 1;
13069 unbind_to (count1
, Qnil
);
13072 consider_all_windows_p
= (update_mode_lines
13073 || buffer_shared_and_changed ()
13074 || cursor_type_changed
);
13076 /* If specs for an arrow have changed, do thorough redisplay
13077 to ensure we remove any arrow that should no longer exist. */
13078 if (overlay_arrows_changed_p ())
13079 consider_all_windows_p
= windows_or_buffers_changed
= 1;
13081 /* Normally the message* functions will have already displayed and
13082 updated the echo area, but the frame may have been trashed, or
13083 the update may have been preempted, so display the echo area
13084 again here. Checking message_cleared_p captures the case that
13085 the echo area should be cleared. */
13086 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13087 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13088 || (message_cleared_p
13089 && minibuf_level
== 0
13090 /* If the mini-window is currently selected, this means the
13091 echo-area doesn't show through. */
13092 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13094 int window_height_changed_p
= echo_area_display (0);
13096 if (message_cleared_p
)
13097 update_miniwindow_p
= 1;
13101 /* If we don't display the current message, don't clear the
13102 message_cleared_p flag, because, if we did, we wouldn't clear
13103 the echo area in the next redisplay which doesn't preserve
13105 if (!display_last_displayed_message_p
)
13106 message_cleared_p
= 0;
13108 if (fonts_changed_p
)
13110 else if (window_height_changed_p
)
13112 consider_all_windows_p
= 1;
13113 ++update_mode_lines
;
13114 ++windows_or_buffers_changed
;
13116 /* If window configuration was changed, frames may have been
13117 marked garbaged. Clear them or we will experience
13118 surprises wrt scrolling. */
13119 clear_garbaged_frames ();
13122 else if (EQ (selected_window
, minibuf_window
)
13123 && (current_buffer
->clip_changed
|| window_outdated (w
))
13124 && resize_mini_window (w
, 0))
13126 /* Resized active mini-window to fit the size of what it is
13127 showing if its contents might have changed. */
13129 /* FIXME: this causes all frames to be updated, which seems unnecessary
13130 since only the current frame needs to be considered. This function
13131 needs to be rewritten with two variables, consider_all_windows and
13132 consider_all_frames. */
13133 consider_all_windows_p
= 1;
13134 ++windows_or_buffers_changed
;
13135 ++update_mode_lines
;
13137 /* If window configuration was changed, frames may have been
13138 marked garbaged. Clear them or we will experience
13139 surprises wrt scrolling. */
13140 clear_garbaged_frames ();
13143 /* If showing the region, and mark has changed, we must redisplay
13144 the whole window. The assignment to this_line_start_pos prevents
13145 the optimization directly below this if-statement. */
13146 if (((!NILP (Vtransient_mark_mode
)
13147 && !NILP (BVAR (XBUFFER (w
->contents
), mark_active
)))
13148 != (w
->region_showing
> 0))
13149 || (w
->region_showing
13150 && w
->region_showing
13151 != XINT (Fmarker_position (BVAR (XBUFFER (w
->contents
), mark
)))))
13152 CHARPOS (this_line_start_pos
) = 0;
13154 /* Optimize the case that only the line containing the cursor in the
13155 selected window has changed. Variables starting with this_ are
13156 set in display_line and record information about the line
13157 containing the cursor. */
13158 tlbufpos
= this_line_start_pos
;
13159 tlendpos
= this_line_end_pos
;
13160 if (!consider_all_windows_p
13161 && CHARPOS (tlbufpos
) > 0
13162 && !w
->update_mode_line
13163 && !current_buffer
->clip_changed
13164 && !current_buffer
->prevent_redisplay_optimizations_p
13165 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13166 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13167 /* Make sure recorded data applies to current buffer, etc. */
13168 && this_line_buffer
== current_buffer
13171 && !w
->optional_new_start
13172 /* Point must be on the line that we have info recorded about. */
13173 && PT
>= CHARPOS (tlbufpos
)
13174 && PT
<= Z
- CHARPOS (tlendpos
)
13175 /* All text outside that line, including its final newline,
13176 must be unchanged. */
13177 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13178 CHARPOS (tlendpos
)))
13180 if (CHARPOS (tlbufpos
) > BEGV
13181 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13182 && (CHARPOS (tlbufpos
) == ZV
13183 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13184 /* Former continuation line has disappeared by becoming empty. */
13186 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13188 /* We have to handle the case of continuation around a
13189 wide-column character (see the comment in indent.c around
13192 For instance, in the following case:
13194 -------- Insert --------
13195 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13196 J_I_ ==> J_I_ `^^' are cursors.
13200 As we have to redraw the line above, we cannot use this
13204 int line_height_before
= this_line_pixel_height
;
13206 /* Note that start_display will handle the case that the
13207 line starting at tlbufpos is a continuation line. */
13208 start_display (&it
, w
, tlbufpos
);
13210 /* Implementation note: It this still necessary? */
13211 if (it
.current_x
!= this_line_start_x
)
13214 TRACE ((stderr
, "trying display optimization 1\n"));
13215 w
->cursor
.vpos
= -1;
13216 overlay_arrow_seen
= 0;
13217 it
.vpos
= this_line_vpos
;
13218 it
.current_y
= this_line_y
;
13219 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13220 display_line (&it
);
13222 /* If line contains point, is not continued,
13223 and ends at same distance from eob as before, we win. */
13224 if (w
->cursor
.vpos
>= 0
13225 /* Line is not continued, otherwise this_line_start_pos
13226 would have been set to 0 in display_line. */
13227 && CHARPOS (this_line_start_pos
)
13228 /* Line ends as before. */
13229 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13230 /* Line has same height as before. Otherwise other lines
13231 would have to be shifted up or down. */
13232 && this_line_pixel_height
== line_height_before
)
13234 /* If this is not the window's last line, we must adjust
13235 the charstarts of the lines below. */
13236 if (it
.current_y
< it
.last_visible_y
)
13238 struct glyph_row
*row
13239 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13240 ptrdiff_t delta
, delta_bytes
;
13242 /* We used to distinguish between two cases here,
13243 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13244 when the line ends in a newline or the end of the
13245 buffer's accessible portion. But both cases did
13246 the same, so they were collapsed. */
13248 - CHARPOS (tlendpos
)
13249 - MATRIX_ROW_START_CHARPOS (row
));
13250 delta_bytes
= (Z_BYTE
13251 - BYTEPOS (tlendpos
)
13252 - MATRIX_ROW_START_BYTEPOS (row
));
13254 increment_matrix_positions (w
->current_matrix
,
13255 this_line_vpos
+ 1,
13256 w
->current_matrix
->nrows
,
13257 delta
, delta_bytes
);
13260 /* If this row displays text now but previously didn't,
13261 or vice versa, w->window_end_vpos may have to be
13263 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13265 if (w
->window_end_vpos
< this_line_vpos
)
13266 w
->window_end_vpos
= this_line_vpos
;
13268 else if (w
->window_end_vpos
== this_line_vpos
13269 && this_line_vpos
> 0)
13270 w
->window_end_vpos
= this_line_vpos
- 1;
13271 w
->window_end_valid
= 0;
13273 /* Update hint: No need to try to scroll in update_window. */
13274 w
->desired_matrix
->no_scrolling_p
= 1;
13277 *w
->desired_matrix
->method
= 0;
13278 debug_method_add (w
, "optimization 1");
13280 #ifdef HAVE_WINDOW_SYSTEM
13281 update_window_fringes (w
, 0);
13288 else if (/* Cursor position hasn't changed. */
13289 PT
== w
->last_point
13290 /* Make sure the cursor was last displayed
13291 in this window. Otherwise we have to reposition it. */
13292 && 0 <= w
->cursor
.vpos
13293 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13297 do_pending_window_change (1);
13298 /* If selected_window changed, redisplay again. */
13299 if (WINDOWP (selected_window
)
13300 && (w
= XWINDOW (selected_window
)) != sw
)
13303 /* We used to always goto end_of_redisplay here, but this
13304 isn't enough if we have a blinking cursor. */
13305 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13306 goto end_of_redisplay
;
13310 /* If highlighting the region, or if the cursor is in the echo area,
13311 then we can't just move the cursor. */
13312 else if (! (!NILP (Vtransient_mark_mode
)
13313 && !NILP (BVAR (current_buffer
, mark_active
)))
13314 && (EQ (selected_window
,
13315 BVAR (current_buffer
, last_selected_window
))
13316 || highlight_nonselected_windows
)
13317 && !w
->region_showing
13318 && NILP (Vshow_trailing_whitespace
)
13319 && !cursor_in_echo_area
)
13322 struct glyph_row
*row
;
13324 /* Skip from tlbufpos to PT and see where it is. Note that
13325 PT may be in invisible text. If so, we will end at the
13326 next visible position. */
13327 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13328 NULL
, DEFAULT_FACE_ID
);
13329 it
.current_x
= this_line_start_x
;
13330 it
.current_y
= this_line_y
;
13331 it
.vpos
= this_line_vpos
;
13333 /* The call to move_it_to stops in front of PT, but
13334 moves over before-strings. */
13335 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13337 if (it
.vpos
== this_line_vpos
13338 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13341 eassert (this_line_vpos
== it
.vpos
);
13342 eassert (this_line_y
== it
.current_y
);
13343 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13345 *w
->desired_matrix
->method
= 0;
13346 debug_method_add (w
, "optimization 3");
13355 /* Text changed drastically or point moved off of line. */
13356 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13359 CHARPOS (this_line_start_pos
) = 0;
13360 consider_all_windows_p
|= buffer_shared_and_changed ();
13361 ++clear_face_cache_count
;
13362 #ifdef HAVE_WINDOW_SYSTEM
13363 ++clear_image_cache_count
;
13366 /* Build desired matrices, and update the display. If
13367 consider_all_windows_p is non-zero, do it for all windows on all
13368 frames. Otherwise do it for selected_window, only. */
13370 if (consider_all_windows_p
)
13372 FOR_EACH_FRAME (tail
, frame
)
13373 XFRAME (frame
)->updated_p
= 0;
13375 FOR_EACH_FRAME (tail
, frame
)
13377 struct frame
*f
= XFRAME (frame
);
13379 /* We don't have to do anything for unselected terminal
13381 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13382 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13385 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13387 /* Mark all the scroll bars to be removed; we'll redeem
13388 the ones we want when we redisplay their windows. */
13389 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13390 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13392 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13393 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13395 /* The X error handler may have deleted that frame. */
13396 if (!FRAME_LIVE_P (f
))
13399 /* Any scroll bars which redisplay_windows should have
13400 nuked should now go away. */
13401 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13402 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13404 /* If fonts changed, display again. */
13405 /* ??? rms: I suspect it is a mistake to jump all the way
13406 back to retry here. It should just retry this frame. */
13407 if (fonts_changed_p
)
13410 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13412 /* See if we have to hscroll. */
13413 if (!f
->already_hscrolled_p
)
13415 f
->already_hscrolled_p
= 1;
13416 if (hscroll_windows (f
->root_window
))
13420 /* Prevent various kinds of signals during display
13421 update. stdio is not robust about handling
13422 signals, which can cause an apparent I/O
13424 if (interrupt_input
)
13425 unrequest_sigio ();
13428 /* Update the display. */
13429 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13430 pending
|= update_frame (f
, 0, 0);
13436 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13440 /* Do the mark_window_display_accurate after all windows have
13441 been redisplayed because this call resets flags in buffers
13442 which are needed for proper redisplay. */
13443 FOR_EACH_FRAME (tail
, frame
)
13445 struct frame
*f
= XFRAME (frame
);
13448 mark_window_display_accurate (f
->root_window
, 1);
13449 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13450 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13455 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13457 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13458 struct frame
*mini_frame
;
13460 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13461 /* Use list_of_error, not Qerror, so that
13462 we catch only errors and don't run the debugger. */
13463 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13465 redisplay_window_error
);
13466 if (update_miniwindow_p
)
13467 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13469 redisplay_window_error
);
13471 /* Compare desired and current matrices, perform output. */
13474 /* If fonts changed, display again. */
13475 if (fonts_changed_p
)
13478 /* Prevent various kinds of signals during display update.
13479 stdio is not robust about handling signals,
13480 which can cause an apparent I/O error. */
13481 if (interrupt_input
)
13482 unrequest_sigio ();
13485 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13487 if (hscroll_windows (selected_window
))
13490 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13491 pending
= update_frame (sf
, 0, 0);
13494 /* We may have called echo_area_display at the top of this
13495 function. If the echo area is on another frame, that may
13496 have put text on a frame other than the selected one, so the
13497 above call to update_frame would not have caught it. Catch
13499 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13500 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13502 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13504 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13505 pending
|= update_frame (mini_frame
, 0, 0);
13506 if (!pending
&& hscroll_windows (mini_window
))
13511 /* If display was paused because of pending input, make sure we do a
13512 thorough update the next time. */
13515 /* Prevent the optimization at the beginning of
13516 redisplay_internal that tries a single-line update of the
13517 line containing the cursor in the selected window. */
13518 CHARPOS (this_line_start_pos
) = 0;
13520 /* Let the overlay arrow be updated the next time. */
13521 update_overlay_arrows (0);
13523 /* If we pause after scrolling, some rows in the current
13524 matrices of some windows are not valid. */
13525 if (!WINDOW_FULL_WIDTH_P (w
)
13526 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13527 update_mode_lines
= 1;
13531 if (!consider_all_windows_p
)
13533 /* This has already been done above if
13534 consider_all_windows_p is set. */
13535 mark_window_display_accurate_1 (w
, 1);
13537 /* Say overlay arrows are up to date. */
13538 update_overlay_arrows (1);
13540 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13541 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13544 update_mode_lines
= 0;
13545 windows_or_buffers_changed
= 0;
13546 cursor_type_changed
= 0;
13549 /* Start SIGIO interrupts coming again. Having them off during the
13550 code above makes it less likely one will discard output, but not
13551 impossible, since there might be stuff in the system buffer here.
13552 But it is much hairier to try to do anything about that. */
13553 if (interrupt_input
)
13557 /* If a frame has become visible which was not before, redisplay
13558 again, so that we display it. Expose events for such a frame
13559 (which it gets when becoming visible) don't call the parts of
13560 redisplay constructing glyphs, so simply exposing a frame won't
13561 display anything in this case. So, we have to display these
13562 frames here explicitly. */
13567 FOR_EACH_FRAME (tail
, frame
)
13569 int this_is_visible
= 0;
13571 if (XFRAME (frame
)->visible
)
13572 this_is_visible
= 1;
13574 if (this_is_visible
)
13578 if (new_count
!= number_of_visible_frames
)
13579 windows_or_buffers_changed
++;
13582 /* Change frame size now if a change is pending. */
13583 do_pending_window_change (1);
13585 /* If we just did a pending size change, or have additional
13586 visible frames, or selected_window changed, redisplay again. */
13587 if ((windows_or_buffers_changed
&& !pending
)
13588 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13591 /* Clear the face and image caches.
13593 We used to do this only if consider_all_windows_p. But the cache
13594 needs to be cleared if a timer creates images in the current
13595 buffer (e.g. the test case in Bug#6230). */
13597 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13599 clear_face_cache (0);
13600 clear_face_cache_count
= 0;
13603 #ifdef HAVE_WINDOW_SYSTEM
13604 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13606 clear_image_caches (Qnil
);
13607 clear_image_cache_count
= 0;
13609 #endif /* HAVE_WINDOW_SYSTEM */
13612 unbind_to (count
, Qnil
);
13617 /* Redisplay, but leave alone any recent echo area message unless
13618 another message has been requested in its place.
13620 This is useful in situations where you need to redisplay but no
13621 user action has occurred, making it inappropriate for the message
13622 area to be cleared. See tracking_off and
13623 wait_reading_process_output for examples of these situations.
13625 FROM_WHERE is an integer saying from where this function was
13626 called. This is useful for debugging. */
13629 redisplay_preserve_echo_area (int from_where
)
13631 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13633 if (!NILP (echo_area_buffer
[1]))
13635 /* We have a previously displayed message, but no current
13636 message. Redisplay the previous message. */
13637 display_last_displayed_message_p
= 1;
13638 redisplay_internal ();
13639 display_last_displayed_message_p
= 0;
13642 redisplay_internal ();
13644 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13645 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13646 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13650 /* Function registered with record_unwind_protect in redisplay_internal. */
13653 unwind_redisplay (void)
13655 redisplaying_p
= 0;
13659 /* Mark the display of leaf window W as accurate or inaccurate.
13660 If ACCURATE_P is non-zero mark display of W as accurate. If
13661 ACCURATE_P is zero, arrange for W to be redisplayed the next
13662 time redisplay_internal is called. */
13665 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13667 struct buffer
*b
= XBUFFER (w
->contents
);
13669 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
13670 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
13671 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13675 b
->clip_changed
= 0;
13676 b
->prevent_redisplay_optimizations_p
= 0;
13678 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13679 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13680 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13681 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13683 w
->current_matrix
->buffer
= b
;
13684 w
->current_matrix
->begv
= BUF_BEGV (b
);
13685 w
->current_matrix
->zv
= BUF_ZV (b
);
13687 w
->last_cursor_vpos
= w
->cursor
.vpos
;
13688 w
->last_cursor_off_p
= w
->cursor_off_p
;
13690 if (w
== XWINDOW (selected_window
))
13691 w
->last_point
= BUF_PT (b
);
13693 w
->last_point
= marker_position (w
->pointm
);
13695 w
->window_end_valid
= 1;
13696 w
->update_mode_line
= 0;
13701 /* Mark the display of windows in the window tree rooted at WINDOW as
13702 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13703 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13704 be redisplayed the next time redisplay_internal is called. */
13707 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13711 for (; !NILP (window
); window
= w
->next
)
13713 w
= XWINDOW (window
);
13714 if (WINDOWP (w
->contents
))
13715 mark_window_display_accurate (w
->contents
, accurate_p
);
13717 mark_window_display_accurate_1 (w
, accurate_p
);
13721 update_overlay_arrows (1);
13723 /* Force a thorough redisplay the next time by setting
13724 last_arrow_position and last_arrow_string to t, which is
13725 unequal to any useful value of Voverlay_arrow_... */
13726 update_overlay_arrows (-1);
13730 /* Return value in display table DP (Lisp_Char_Table *) for character
13731 C. Since a display table doesn't have any parent, we don't have to
13732 follow parent. Do not call this function directly but use the
13733 macro DISP_CHAR_VECTOR. */
13736 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13740 if (ASCII_CHAR_P (c
))
13743 if (SUB_CHAR_TABLE_P (val
))
13744 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13750 XSETCHAR_TABLE (table
, dp
);
13751 val
= char_table_ref (table
, c
);
13760 /***********************************************************************
13762 ***********************************************************************/
13764 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13767 redisplay_windows (Lisp_Object window
)
13769 while (!NILP (window
))
13771 struct window
*w
= XWINDOW (window
);
13773 if (WINDOWP (w
->contents
))
13774 redisplay_windows (w
->contents
);
13775 else if (BUFFERP (w
->contents
))
13777 displayed_buffer
= XBUFFER (w
->contents
);
13778 /* Use list_of_error, not Qerror, so that
13779 we catch only errors and don't run the debugger. */
13780 internal_condition_case_1 (redisplay_window_0
, window
,
13782 redisplay_window_error
);
13790 redisplay_window_error (Lisp_Object ignore
)
13792 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13797 redisplay_window_0 (Lisp_Object window
)
13799 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13800 redisplay_window (window
, 0);
13805 redisplay_window_1 (Lisp_Object window
)
13807 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13808 redisplay_window (window
, 1);
13813 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13814 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13815 which positions recorded in ROW differ from current buffer
13818 Return 0 if cursor is not on this row, 1 otherwise. */
13821 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13822 struct glyph_matrix
*matrix
,
13823 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13826 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13827 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13828 struct glyph
*cursor
= NULL
;
13829 /* The last known character position in row. */
13830 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13832 ptrdiff_t pt_old
= PT
- delta
;
13833 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13834 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13835 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13836 /* A glyph beyond the edge of TEXT_AREA which we should never
13838 struct glyph
*glyphs_end
= end
;
13839 /* Non-zero means we've found a match for cursor position, but that
13840 glyph has the avoid_cursor_p flag set. */
13841 int match_with_avoid_cursor
= 0;
13842 /* Non-zero means we've seen at least one glyph that came from a
13844 int string_seen
= 0;
13845 /* Largest and smallest buffer positions seen so far during scan of
13847 ptrdiff_t bpos_max
= pos_before
;
13848 ptrdiff_t bpos_min
= pos_after
;
13849 /* Last buffer position covered by an overlay string with an integer
13850 `cursor' property. */
13851 ptrdiff_t bpos_covered
= 0;
13852 /* Non-zero means the display string on which to display the cursor
13853 comes from a text property, not from an overlay. */
13854 int string_from_text_prop
= 0;
13856 /* Don't even try doing anything if called for a mode-line or
13857 header-line row, since the rest of the code isn't prepared to
13858 deal with such calamities. */
13859 eassert (!row
->mode_line_p
);
13860 if (row
->mode_line_p
)
13863 /* Skip over glyphs not having an object at the start and the end of
13864 the row. These are special glyphs like truncation marks on
13865 terminal frames. */
13866 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
13868 if (!row
->reversed_p
)
13871 && INTEGERP (glyph
->object
)
13872 && glyph
->charpos
< 0)
13874 x
+= glyph
->pixel_width
;
13878 && INTEGERP ((end
- 1)->object
)
13879 /* CHARPOS is zero for blanks and stretch glyphs
13880 inserted by extend_face_to_end_of_line. */
13881 && (end
- 1)->charpos
<= 0)
13883 glyph_before
= glyph
- 1;
13890 /* If the glyph row is reversed, we need to process it from back
13891 to front, so swap the edge pointers. */
13892 glyphs_end
= end
= glyph
- 1;
13893 glyph
+= row
->used
[TEXT_AREA
] - 1;
13895 while (glyph
> end
+ 1
13896 && INTEGERP (glyph
->object
)
13897 && glyph
->charpos
< 0)
13900 x
-= glyph
->pixel_width
;
13902 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13904 /* By default, in reversed rows we put the cursor on the
13905 rightmost (first in the reading order) glyph. */
13906 for (g
= end
+ 1; g
< glyph
; g
++)
13907 x
+= g
->pixel_width
;
13909 && INTEGERP ((end
+ 1)->object
)
13910 && (end
+ 1)->charpos
<= 0)
13912 glyph_before
= glyph
+ 1;
13916 else if (row
->reversed_p
)
13918 /* In R2L rows that don't display text, put the cursor on the
13919 rightmost glyph. Case in point: an empty last line that is
13920 part of an R2L paragraph. */
13922 /* Avoid placing the cursor on the last glyph of the row, where
13923 on terminal frames we hold the vertical border between
13924 adjacent windows. */
13925 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13926 && !WINDOW_RIGHTMOST_P (w
)
13927 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13929 x
= -1; /* will be computed below, at label compute_x */
13932 /* Step 1: Try to find the glyph whose character position
13933 corresponds to point. If that's not possible, find 2 glyphs
13934 whose character positions are the closest to point, one before
13935 point, the other after it. */
13936 if (!row
->reversed_p
)
13937 while (/* not marched to end of glyph row */
13939 /* glyph was not inserted by redisplay for internal purposes */
13940 && !INTEGERP (glyph
->object
))
13942 if (BUFFERP (glyph
->object
))
13944 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
13946 if (glyph
->charpos
> bpos_max
)
13947 bpos_max
= glyph
->charpos
;
13948 if (glyph
->charpos
< bpos_min
)
13949 bpos_min
= glyph
->charpos
;
13950 if (!glyph
->avoid_cursor_p
)
13952 /* If we hit point, we've found the glyph on which to
13953 display the cursor. */
13956 match_with_avoid_cursor
= 0;
13959 /* See if we've found a better approximation to
13960 POS_BEFORE or to POS_AFTER. */
13961 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13963 pos_before
= glyph
->charpos
;
13964 glyph_before
= glyph
;
13966 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
13968 pos_after
= glyph
->charpos
;
13969 glyph_after
= glyph
;
13972 else if (dpos
== 0)
13973 match_with_avoid_cursor
= 1;
13975 else if (STRINGP (glyph
->object
))
13977 Lisp_Object chprop
;
13978 ptrdiff_t glyph_pos
= glyph
->charpos
;
13980 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13982 if (!NILP (chprop
))
13984 /* If the string came from a `display' text property,
13985 look up the buffer position of that property and
13986 use that position to update bpos_max, as if we
13987 actually saw such a position in one of the row's
13988 glyphs. This helps with supporting integer values
13989 of `cursor' property on the display string in
13990 situations where most or all of the row's buffer
13991 text is completely covered by display properties,
13992 so that no glyph with valid buffer positions is
13993 ever seen in the row. */
13994 ptrdiff_t prop_pos
=
13995 string_buffer_position_lim (glyph
->object
, pos_before
,
13998 if (prop_pos
>= pos_before
)
13999 bpos_max
= prop_pos
- 1;
14001 if (INTEGERP (chprop
))
14003 bpos_covered
= bpos_max
+ XINT (chprop
);
14004 /* If the `cursor' property covers buffer positions up
14005 to and including point, we should display cursor on
14006 this glyph. Note that, if a `cursor' property on one
14007 of the string's characters has an integer value, we
14008 will break out of the loop below _before_ we get to
14009 the position match above. IOW, integer values of
14010 the `cursor' property override the "exact match for
14011 point" strategy of positioning the cursor. */
14012 /* Implementation note: bpos_max == pt_old when, e.g.,
14013 we are in an empty line, where bpos_max is set to
14014 MATRIX_ROW_START_CHARPOS, see above. */
14015 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14024 x
+= glyph
->pixel_width
;
14027 else if (glyph
> end
) /* row is reversed */
14028 while (!INTEGERP (glyph
->object
))
14030 if (BUFFERP (glyph
->object
))
14032 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14034 if (glyph
->charpos
> bpos_max
)
14035 bpos_max
= glyph
->charpos
;
14036 if (glyph
->charpos
< bpos_min
)
14037 bpos_min
= glyph
->charpos
;
14038 if (!glyph
->avoid_cursor_p
)
14042 match_with_avoid_cursor
= 0;
14045 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14047 pos_before
= glyph
->charpos
;
14048 glyph_before
= glyph
;
14050 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14052 pos_after
= glyph
->charpos
;
14053 glyph_after
= glyph
;
14056 else if (dpos
== 0)
14057 match_with_avoid_cursor
= 1;
14059 else if (STRINGP (glyph
->object
))
14061 Lisp_Object chprop
;
14062 ptrdiff_t glyph_pos
= glyph
->charpos
;
14064 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14066 if (!NILP (chprop
))
14068 ptrdiff_t prop_pos
=
14069 string_buffer_position_lim (glyph
->object
, pos_before
,
14072 if (prop_pos
>= pos_before
)
14073 bpos_max
= prop_pos
- 1;
14075 if (INTEGERP (chprop
))
14077 bpos_covered
= bpos_max
+ XINT (chprop
);
14078 /* If the `cursor' property covers buffer positions up
14079 to and including point, we should display cursor on
14081 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14090 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14092 x
--; /* can't use any pixel_width */
14095 x
-= glyph
->pixel_width
;
14098 /* Step 2: If we didn't find an exact match for point, we need to
14099 look for a proper place to put the cursor among glyphs between
14100 GLYPH_BEFORE and GLYPH_AFTER. */
14101 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14102 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14103 && !(bpos_max
< pt_old
&& pt_old
<= bpos_covered
))
14105 /* An empty line has a single glyph whose OBJECT is zero and
14106 whose CHARPOS is the position of a newline on that line.
14107 Note that on a TTY, there are more glyphs after that, which
14108 were produced by extend_face_to_end_of_line, but their
14109 CHARPOS is zero or negative. */
14111 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14112 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14113 /* On a TTY, continued and truncated rows also have a glyph at
14114 their end whose OBJECT is zero and whose CHARPOS is
14115 positive (the continuation and truncation glyphs), but such
14116 rows are obviously not "empty". */
14117 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14119 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14121 ptrdiff_t ellipsis_pos
;
14123 /* Scan back over the ellipsis glyphs. */
14124 if (!row
->reversed_p
)
14126 ellipsis_pos
= (glyph
- 1)->charpos
;
14127 while (glyph
> row
->glyphs
[TEXT_AREA
]
14128 && (glyph
- 1)->charpos
== ellipsis_pos
)
14129 glyph
--, x
-= glyph
->pixel_width
;
14130 /* That loop always goes one position too far, including
14131 the glyph before the ellipsis. So scan forward over
14133 x
+= glyph
->pixel_width
;
14136 else /* row is reversed */
14138 ellipsis_pos
= (glyph
+ 1)->charpos
;
14139 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14140 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14141 glyph
++, x
+= glyph
->pixel_width
;
14142 x
-= glyph
->pixel_width
;
14146 else if (match_with_avoid_cursor
)
14148 cursor
= glyph_after
;
14151 else if (string_seen
)
14153 int incr
= row
->reversed_p
? -1 : +1;
14155 /* Need to find the glyph that came out of a string which is
14156 present at point. That glyph is somewhere between
14157 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14158 positioned between POS_BEFORE and POS_AFTER in the
14160 struct glyph
*start
, *stop
;
14161 ptrdiff_t pos
= pos_before
;
14165 /* If the row ends in a newline from a display string,
14166 reordering could have moved the glyphs belonging to the
14167 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14168 in this case we extend the search to the last glyph in
14169 the row that was not inserted by redisplay. */
14170 if (row
->ends_in_newline_from_string_p
)
14173 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14176 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14177 correspond to POS_BEFORE and POS_AFTER, respectively. We
14178 need START and STOP in the order that corresponds to the
14179 row's direction as given by its reversed_p flag. If the
14180 directionality of characters between POS_BEFORE and
14181 POS_AFTER is the opposite of the row's base direction,
14182 these characters will have been reordered for display,
14183 and we need to reverse START and STOP. */
14184 if (!row
->reversed_p
)
14186 start
= min (glyph_before
, glyph_after
);
14187 stop
= max (glyph_before
, glyph_after
);
14191 start
= max (glyph_before
, glyph_after
);
14192 stop
= min (glyph_before
, glyph_after
);
14194 for (glyph
= start
+ incr
;
14195 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14198 /* Any glyphs that come from the buffer are here because
14199 of bidi reordering. Skip them, and only pay
14200 attention to glyphs that came from some string. */
14201 if (STRINGP (glyph
->object
))
14205 /* If the display property covers the newline, we
14206 need to search for it one position farther. */
14207 ptrdiff_t lim
= pos_after
14208 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14210 string_from_text_prop
= 0;
14211 str
= glyph
->object
;
14212 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14213 if (tem
== 0 /* from overlay */
14216 /* If the string from which this glyph came is
14217 found in the buffer at point, or at position
14218 that is closer to point than pos_after, then
14219 we've found the glyph we've been looking for.
14220 If it comes from an overlay (tem == 0), and
14221 it has the `cursor' property on one of its
14222 glyphs, record that glyph as a candidate for
14223 displaying the cursor. (As in the
14224 unidirectional version, we will display the
14225 cursor on the last candidate we find.) */
14228 || (tem
- pt_old
> 0 && tem
< pos_after
))
14230 /* The glyphs from this string could have
14231 been reordered. Find the one with the
14232 smallest string position. Or there could
14233 be a character in the string with the
14234 `cursor' property, which means display
14235 cursor on that character's glyph. */
14236 ptrdiff_t strpos
= glyph
->charpos
;
14241 string_from_text_prop
= 1;
14244 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14245 && EQ (glyph
->object
, str
);
14249 ptrdiff_t gpos
= glyph
->charpos
;
14251 cprop
= Fget_char_property (make_number (gpos
),
14259 if (tem
&& glyph
->charpos
< strpos
)
14261 strpos
= glyph
->charpos
;
14267 || (tem
- pt_old
> 0 && tem
< pos_after
))
14271 pos
= tem
+ 1; /* don't find previous instances */
14273 /* This string is not what we want; skip all of the
14274 glyphs that came from it. */
14275 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14276 && EQ (glyph
->object
, str
))
14283 /* If we reached the end of the line, and END was from a string,
14284 the cursor is not on this line. */
14286 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14287 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14288 && STRINGP (end
->object
)
14289 && row
->continued_p
)
14292 /* A truncated row may not include PT among its character positions.
14293 Setting the cursor inside the scroll margin will trigger
14294 recalculation of hscroll in hscroll_window_tree. But if a
14295 display string covers point, defer to the string-handling
14296 code below to figure this out. */
14297 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14299 cursor
= glyph_before
;
14302 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14303 /* Zero-width characters produce no glyphs. */
14305 && (row
->reversed_p
14306 ? glyph_after
> glyphs_end
14307 : glyph_after
< glyphs_end
)))
14309 cursor
= glyph_after
;
14315 if (cursor
!= NULL
)
14317 else if (glyph
== glyphs_end
14318 && pos_before
== pos_after
14319 && STRINGP ((row
->reversed_p
14320 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14321 : row
->glyphs
[TEXT_AREA
])->object
))
14323 /* If all the glyphs of this row came from strings, put the
14324 cursor on the first glyph of the row. This avoids having the
14325 cursor outside of the text area in this very rare and hard
14329 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14330 : row
->glyphs
[TEXT_AREA
];
14336 /* Need to compute x that corresponds to GLYPH. */
14337 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14339 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14341 x
+= g
->pixel_width
;
14345 /* ROW could be part of a continued line, which, under bidi
14346 reordering, might have other rows whose start and end charpos
14347 occlude point. Only set w->cursor if we found a better
14348 approximation to the cursor position than we have from previously
14349 examined candidate rows belonging to the same continued line. */
14350 if (/* we already have a candidate row */
14351 w
->cursor
.vpos
>= 0
14352 /* that candidate is not the row we are processing */
14353 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14354 /* Make sure cursor.vpos specifies a row whose start and end
14355 charpos occlude point, and it is valid candidate for being a
14356 cursor-row. This is because some callers of this function
14357 leave cursor.vpos at the row where the cursor was displayed
14358 during the last redisplay cycle. */
14359 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14360 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14361 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14364 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14366 /* Don't consider glyphs that are outside TEXT_AREA. */
14367 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14369 /* Keep the candidate whose buffer position is the closest to
14370 point or has the `cursor' property. */
14371 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14372 w
->cursor
.hpos
>= 0
14373 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14374 && ((BUFFERP (g1
->object
)
14375 && (g1
->charpos
== pt_old
/* an exact match always wins */
14376 || (BUFFERP (glyph
->object
)
14377 && eabs (g1
->charpos
- pt_old
)
14378 < eabs (glyph
->charpos
- pt_old
))))
14379 /* previous candidate is a glyph from a string that has
14380 a non-nil `cursor' property */
14381 || (STRINGP (g1
->object
)
14382 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14383 Qcursor
, g1
->object
))
14384 /* previous candidate is from the same display
14385 string as this one, and the display string
14386 came from a text property */
14387 || (EQ (g1
->object
, glyph
->object
)
14388 && string_from_text_prop
)
14389 /* this candidate is from newline and its
14390 position is not an exact match */
14391 || (INTEGERP (glyph
->object
)
14392 && glyph
->charpos
!= pt_old
)))))
14394 /* If this candidate gives an exact match, use that. */
14395 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14396 /* If this candidate is a glyph created for the
14397 terminating newline of a line, and point is on that
14398 newline, it wins because it's an exact match. */
14399 || (!row
->continued_p
14400 && INTEGERP (glyph
->object
)
14401 && glyph
->charpos
== 0
14402 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14403 /* Otherwise, keep the candidate that comes from a row
14404 spanning less buffer positions. This may win when one or
14405 both candidate positions are on glyphs that came from
14406 display strings, for which we cannot compare buffer
14408 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14409 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14410 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14413 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14415 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14416 w
->cursor
.y
= row
->y
+ dy
;
14418 if (w
== XWINDOW (selected_window
))
14420 if (!row
->continued_p
14421 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14424 this_line_buffer
= XBUFFER (w
->contents
);
14426 CHARPOS (this_line_start_pos
)
14427 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14428 BYTEPOS (this_line_start_pos
)
14429 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14431 CHARPOS (this_line_end_pos
)
14432 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14433 BYTEPOS (this_line_end_pos
)
14434 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14436 this_line_y
= w
->cursor
.y
;
14437 this_line_pixel_height
= row
->height
;
14438 this_line_vpos
= w
->cursor
.vpos
;
14439 this_line_start_x
= row
->x
;
14442 CHARPOS (this_line_start_pos
) = 0;
14449 /* Run window scroll functions, if any, for WINDOW with new window
14450 start STARTP. Sets the window start of WINDOW to that position.
14452 We assume that the window's buffer is really current. */
14454 static struct text_pos
14455 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14457 struct window
*w
= XWINDOW (window
);
14458 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14460 eassert (current_buffer
== XBUFFER (w
->contents
));
14462 if (!NILP (Vwindow_scroll_functions
))
14464 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14465 make_number (CHARPOS (startp
)));
14466 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14467 /* In case the hook functions switch buffers. */
14468 set_buffer_internal (XBUFFER (w
->contents
));
14475 /* Make sure the line containing the cursor is fully visible.
14476 A value of 1 means there is nothing to be done.
14477 (Either the line is fully visible, or it cannot be made so,
14478 or we cannot tell.)
14480 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14481 is higher than window.
14483 A value of 0 means the caller should do scrolling
14484 as if point had gone off the screen. */
14487 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14489 struct glyph_matrix
*matrix
;
14490 struct glyph_row
*row
;
14493 if (!make_cursor_line_fully_visible_p
)
14496 /* It's not always possible to find the cursor, e.g, when a window
14497 is full of overlay strings. Don't do anything in that case. */
14498 if (w
->cursor
.vpos
< 0)
14501 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14502 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14504 /* If the cursor row is not partially visible, there's nothing to do. */
14505 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14508 /* If the row the cursor is in is taller than the window's height,
14509 it's not clear what to do, so do nothing. */
14510 window_height
= window_box_height (w
);
14511 if (row
->height
>= window_height
)
14513 if (!force_p
|| MINI_WINDOW_P (w
)
14514 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14521 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14522 non-zero means only WINDOW is redisplayed in redisplay_internal.
14523 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14524 in redisplay_window to bring a partially visible line into view in
14525 the case that only the cursor has moved.
14527 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14528 last screen line's vertical height extends past the end of the screen.
14532 1 if scrolling succeeded
14534 0 if scrolling didn't find point.
14536 -1 if new fonts have been loaded so that we must interrupt
14537 redisplay, adjust glyph matrices, and try again. */
14543 SCROLLING_NEED_LARGER_MATRICES
14546 /* If scroll-conservatively is more than this, never recenter.
14548 If you change this, don't forget to update the doc string of
14549 `scroll-conservatively' and the Emacs manual. */
14550 #define SCROLL_LIMIT 100
14553 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14554 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14555 int temp_scroll_step
, int last_line_misfit
)
14557 struct window
*w
= XWINDOW (window
);
14558 struct frame
*f
= XFRAME (w
->frame
);
14559 struct text_pos pos
, startp
;
14561 int this_scroll_margin
, scroll_max
, rc
, height
;
14562 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14563 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14564 Lisp_Object aggressive
;
14565 /* We will never try scrolling more than this number of lines. */
14566 int scroll_limit
= SCROLL_LIMIT
;
14567 int frame_line_height
= default_line_pixel_height (w
);
14568 int window_total_lines
14569 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
14572 debug_method_add (w
, "try_scrolling");
14575 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14577 /* Compute scroll margin height in pixels. We scroll when point is
14578 within this distance from the top or bottom of the window. */
14579 if (scroll_margin
> 0)
14580 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
14581 * frame_line_height
;
14583 this_scroll_margin
= 0;
14585 /* Force arg_scroll_conservatively to have a reasonable value, to
14586 avoid scrolling too far away with slow move_it_* functions. Note
14587 that the user can supply scroll-conservatively equal to
14588 `most-positive-fixnum', which can be larger than INT_MAX. */
14589 if (arg_scroll_conservatively
> scroll_limit
)
14591 arg_scroll_conservatively
= scroll_limit
+ 1;
14592 scroll_max
= scroll_limit
* frame_line_height
;
14594 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14595 /* Compute how much we should try to scroll maximally to bring
14596 point into view. */
14597 scroll_max
= (max (scroll_step
,
14598 max (arg_scroll_conservatively
, temp_scroll_step
))
14599 * frame_line_height
);
14600 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14601 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14602 /* We're trying to scroll because of aggressive scrolling but no
14603 scroll_step is set. Choose an arbitrary one. */
14604 scroll_max
= 10 * frame_line_height
;
14610 /* Decide whether to scroll down. */
14611 if (PT
> CHARPOS (startp
))
14613 int scroll_margin_y
;
14615 /* Compute the pixel ypos of the scroll margin, then move IT to
14616 either that ypos or PT, whichever comes first. */
14617 start_display (&it
, w
, startp
);
14618 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14619 - frame_line_height
* extra_scroll_margin_lines
;
14620 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14621 (MOVE_TO_POS
| MOVE_TO_Y
));
14623 if (PT
> CHARPOS (it
.current
.pos
))
14625 int y0
= line_bottom_y (&it
);
14626 /* Compute how many pixels below window bottom to stop searching
14627 for PT. This avoids costly search for PT that is far away if
14628 the user limited scrolling by a small number of lines, but
14629 always finds PT if scroll_conservatively is set to a large
14630 number, such as most-positive-fixnum. */
14631 int slack
= max (scroll_max
, 10 * frame_line_height
);
14632 int y_to_move
= it
.last_visible_y
+ slack
;
14634 /* Compute the distance from the scroll margin to PT or to
14635 the scroll limit, whichever comes first. This should
14636 include the height of the cursor line, to make that line
14638 move_it_to (&it
, PT
, -1, y_to_move
,
14639 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14640 dy
= line_bottom_y (&it
) - y0
;
14642 if (dy
> scroll_max
)
14643 return SCROLLING_FAILED
;
14652 /* Point is in or below the bottom scroll margin, so move the
14653 window start down. If scrolling conservatively, move it just
14654 enough down to make point visible. If scroll_step is set,
14655 move it down by scroll_step. */
14656 if (arg_scroll_conservatively
)
14658 = min (max (dy
, frame_line_height
),
14659 frame_line_height
* arg_scroll_conservatively
);
14660 else if (scroll_step
|| temp_scroll_step
)
14661 amount_to_scroll
= scroll_max
;
14664 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14665 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14666 if (NUMBERP (aggressive
))
14668 double float_amount
= XFLOATINT (aggressive
) * height
;
14669 int aggressive_scroll
= float_amount
;
14670 if (aggressive_scroll
== 0 && float_amount
> 0)
14671 aggressive_scroll
= 1;
14672 /* Don't let point enter the scroll margin near top of
14673 the window. This could happen if the value of
14674 scroll_up_aggressively is too large and there are
14675 non-zero margins, because scroll_up_aggressively
14676 means put point that fraction of window height
14677 _from_the_bottom_margin_. */
14678 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14679 aggressive_scroll
= height
- 2*this_scroll_margin
;
14680 amount_to_scroll
= dy
+ aggressive_scroll
;
14684 if (amount_to_scroll
<= 0)
14685 return SCROLLING_FAILED
;
14687 start_display (&it
, w
, startp
);
14688 if (arg_scroll_conservatively
<= scroll_limit
)
14689 move_it_vertically (&it
, amount_to_scroll
);
14692 /* Extra precision for users who set scroll-conservatively
14693 to a large number: make sure the amount we scroll
14694 the window start is never less than amount_to_scroll,
14695 which was computed as distance from window bottom to
14696 point. This matters when lines at window top and lines
14697 below window bottom have different height. */
14699 void *it1data
= NULL
;
14700 /* We use a temporary it1 because line_bottom_y can modify
14701 its argument, if it moves one line down; see there. */
14704 SAVE_IT (it1
, it
, it1data
);
14705 start_y
= line_bottom_y (&it1
);
14707 RESTORE_IT (&it
, &it
, it1data
);
14708 move_it_by_lines (&it
, 1);
14709 SAVE_IT (it1
, it
, it1data
);
14710 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14713 /* If STARTP is unchanged, move it down another screen line. */
14714 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14715 move_it_by_lines (&it
, 1);
14716 startp
= it
.current
.pos
;
14720 struct text_pos scroll_margin_pos
= startp
;
14723 /* See if point is inside the scroll margin at the top of the
14725 if (this_scroll_margin
)
14729 start_display (&it
, w
, startp
);
14730 y_start
= it
.current_y
;
14731 move_it_vertically (&it
, this_scroll_margin
);
14732 scroll_margin_pos
= it
.current
.pos
;
14733 /* If we didn't move enough before hitting ZV, request
14734 additional amount of scroll, to move point out of the
14736 if (IT_CHARPOS (it
) == ZV
14737 && it
.current_y
- y_start
< this_scroll_margin
)
14738 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
14741 if (PT
< CHARPOS (scroll_margin_pos
))
14743 /* Point is in the scroll margin at the top of the window or
14744 above what is displayed in the window. */
14747 /* Compute the vertical distance from PT to the scroll
14748 margin position. Move as far as scroll_max allows, or
14749 one screenful, or 10 screen lines, whichever is largest.
14750 Give up if distance is greater than scroll_max or if we
14751 didn't reach the scroll margin position. */
14752 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14753 start_display (&it
, w
, pos
);
14755 y_to_move
= max (it
.last_visible_y
,
14756 max (scroll_max
, 10 * frame_line_height
));
14757 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14759 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14760 dy
= it
.current_y
- y0
;
14761 if (dy
> scroll_max
14762 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
14763 return SCROLLING_FAILED
;
14765 /* Additional scroll for when ZV was too close to point. */
14768 /* Compute new window start. */
14769 start_display (&it
, w
, startp
);
14771 if (arg_scroll_conservatively
)
14772 amount_to_scroll
= max (dy
, frame_line_height
*
14773 max (scroll_step
, temp_scroll_step
));
14774 else if (scroll_step
|| temp_scroll_step
)
14775 amount_to_scroll
= scroll_max
;
14778 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14779 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14780 if (NUMBERP (aggressive
))
14782 double float_amount
= XFLOATINT (aggressive
) * height
;
14783 int aggressive_scroll
= float_amount
;
14784 if (aggressive_scroll
== 0 && float_amount
> 0)
14785 aggressive_scroll
= 1;
14786 /* Don't let point enter the scroll margin near
14787 bottom of the window, if the value of
14788 scroll_down_aggressively happens to be too
14790 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14791 aggressive_scroll
= height
- 2*this_scroll_margin
;
14792 amount_to_scroll
= dy
+ aggressive_scroll
;
14796 if (amount_to_scroll
<= 0)
14797 return SCROLLING_FAILED
;
14799 move_it_vertically_backward (&it
, amount_to_scroll
);
14800 startp
= it
.current
.pos
;
14804 /* Run window scroll functions. */
14805 startp
= run_window_scroll_functions (window
, startp
);
14807 /* Display the window. Give up if new fonts are loaded, or if point
14809 if (!try_window (window
, startp
, 0))
14810 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14811 else if (w
->cursor
.vpos
< 0)
14813 clear_glyph_matrix (w
->desired_matrix
);
14814 rc
= SCROLLING_FAILED
;
14818 /* Maybe forget recorded base line for line number display. */
14819 if (!just_this_one_p
14820 || current_buffer
->clip_changed
14821 || BEG_UNCHANGED
< CHARPOS (startp
))
14822 w
->base_line_number
= 0;
14824 /* If cursor ends up on a partially visible line,
14825 treat that as being off the bottom of the screen. */
14826 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14827 /* It's possible that the cursor is on the first line of the
14828 buffer, which is partially obscured due to a vscroll
14829 (Bug#7537). In that case, avoid looping forever . */
14830 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14832 clear_glyph_matrix (w
->desired_matrix
);
14833 ++extra_scroll_margin_lines
;
14836 rc
= SCROLLING_SUCCESS
;
14843 /* Compute a suitable window start for window W if display of W starts
14844 on a continuation line. Value is non-zero if a new window start
14847 The new window start will be computed, based on W's width, starting
14848 from the start of the continued line. It is the start of the
14849 screen line with the minimum distance from the old start W->start. */
14852 compute_window_start_on_continuation_line (struct window
*w
)
14854 struct text_pos pos
, start_pos
;
14855 int window_start_changed_p
= 0;
14857 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14859 /* If window start is on a continuation line... Window start may be
14860 < BEGV in case there's invisible text at the start of the
14861 buffer (M-x rmail, for example). */
14862 if (CHARPOS (start_pos
) > BEGV
14863 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14866 struct glyph_row
*row
;
14868 /* Handle the case that the window start is out of range. */
14869 if (CHARPOS (start_pos
) < BEGV
)
14870 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14871 else if (CHARPOS (start_pos
) > ZV
)
14872 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14874 /* Find the start of the continued line. This should be fast
14875 because find_newline is fast (newline cache). */
14876 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14877 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14878 row
, DEFAULT_FACE_ID
);
14879 reseat_at_previous_visible_line_start (&it
);
14881 /* If the line start is "too far" away from the window start,
14882 say it takes too much time to compute a new window start. */
14883 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14884 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14886 int min_distance
, distance
;
14888 /* Move forward by display lines to find the new window
14889 start. If window width was enlarged, the new start can
14890 be expected to be > the old start. If window width was
14891 decreased, the new window start will be < the old start.
14892 So, we're looking for the display line start with the
14893 minimum distance from the old window start. */
14894 pos
= it
.current
.pos
;
14895 min_distance
= INFINITY
;
14896 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14897 distance
< min_distance
)
14899 min_distance
= distance
;
14900 pos
= it
.current
.pos
;
14901 if (it
.line_wrap
== WORD_WRAP
)
14903 /* Under WORD_WRAP, move_it_by_lines is likely to
14904 overshoot and stop not at the first, but the
14905 second character from the left margin. So in
14906 that case, we need a more tight control on the X
14907 coordinate of the iterator than move_it_by_lines
14908 promises in its contract. The method is to first
14909 go to the last (rightmost) visible character of a
14910 line, then move to the leftmost character on the
14911 next line in a separate call. */
14912 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
14913 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14914 move_it_to (&it
, ZV
, 0,
14915 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
14916 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14919 move_it_by_lines (&it
, 1);
14922 /* Set the window start there. */
14923 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14924 window_start_changed_p
= 1;
14928 return window_start_changed_p
;
14932 /* Try cursor movement in case text has not changed in window WINDOW,
14933 with window start STARTP. Value is
14935 CURSOR_MOVEMENT_SUCCESS if successful
14937 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14939 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14940 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14941 we want to scroll as if scroll-step were set to 1. See the code.
14943 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14944 which case we have to abort this redisplay, and adjust matrices
14949 CURSOR_MOVEMENT_SUCCESS
,
14950 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14951 CURSOR_MOVEMENT_MUST_SCROLL
,
14952 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14956 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14958 struct window
*w
= XWINDOW (window
);
14959 struct frame
*f
= XFRAME (w
->frame
);
14960 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14963 if (inhibit_try_cursor_movement
)
14967 /* Previously, there was a check for Lisp integer in the
14968 if-statement below. Now, this field is converted to
14969 ptrdiff_t, thus zero means invalid position in a buffer. */
14970 eassert (w
->last_point
> 0);
14971 /* Likewise there was a check whether window_end_vpos is nil or larger
14972 than the window. Now window_end_vpos is int and so never nil, but
14973 let's leave eassert to check whether it fits in the window. */
14974 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
14976 /* Handle case where text has not changed, only point, and it has
14977 not moved off the frame. */
14978 if (/* Point may be in this window. */
14979 PT
>= CHARPOS (startp
)
14980 /* Selective display hasn't changed. */
14981 && !current_buffer
->clip_changed
14982 /* Function force-mode-line-update is used to force a thorough
14983 redisplay. It sets either windows_or_buffers_changed or
14984 update_mode_lines. So don't take a shortcut here for these
14986 && !update_mode_lines
14987 && !windows_or_buffers_changed
14988 && !cursor_type_changed
14989 /* Can't use this case if highlighting a region. When a
14990 region exists, cursor movement has to do more than just
14992 && markpos_of_region () < 0
14993 && !w
->region_showing
14994 && NILP (Vshow_trailing_whitespace
)
14995 /* This code is not used for mini-buffer for the sake of the case
14996 of redisplaying to replace an echo area message; since in
14997 that case the mini-buffer contents per se are usually
14998 unchanged. This code is of no real use in the mini-buffer
14999 since the handling of this_line_start_pos, etc., in redisplay
15000 handles the same cases. */
15001 && !EQ (window
, minibuf_window
)
15002 && (FRAME_WINDOW_P (f
)
15003 || !overlay_arrow_in_current_buffer_p ()))
15005 int this_scroll_margin
, top_scroll_margin
;
15006 struct glyph_row
*row
= NULL
;
15007 int frame_line_height
= default_line_pixel_height (w
);
15008 int window_total_lines
15009 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15012 debug_method_add (w
, "cursor movement");
15015 /* Scroll if point within this distance from the top or bottom
15016 of the window. This is a pixel value. */
15017 if (scroll_margin
> 0)
15019 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15020 this_scroll_margin
*= frame_line_height
;
15023 this_scroll_margin
= 0;
15025 top_scroll_margin
= this_scroll_margin
;
15026 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15027 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15029 /* Start with the row the cursor was displayed during the last
15030 not paused redisplay. Give up if that row is not valid. */
15031 if (w
->last_cursor_vpos
< 0
15032 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15033 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15036 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15037 if (row
->mode_line_p
)
15039 if (!row
->enabled_p
)
15040 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15043 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15045 int scroll_p
= 0, must_scroll
= 0;
15046 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15048 if (PT
> w
->last_point
)
15050 /* Point has moved forward. */
15051 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15052 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15054 eassert (row
->enabled_p
);
15058 /* If the end position of a row equals the start
15059 position of the next row, and PT is at that position,
15060 we would rather display cursor in the next line. */
15061 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15062 && MATRIX_ROW_END_CHARPOS (row
) == PT
15063 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15064 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15065 && !cursor_row_p (row
))
15068 /* If within the scroll margin, scroll. Note that
15069 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15070 the next line would be drawn, and that
15071 this_scroll_margin can be zero. */
15072 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15073 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15074 /* Line is completely visible last line in window
15075 and PT is to be set in the next line. */
15076 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15077 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15078 && !row
->ends_at_zv_p
15079 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15082 else if (PT
< w
->last_point
)
15084 /* Cursor has to be moved backward. Note that PT >=
15085 CHARPOS (startp) because of the outer if-statement. */
15086 while (!row
->mode_line_p
15087 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15088 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15089 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15090 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15091 row
> w
->current_matrix
->rows
15092 && (row
-1)->ends_in_newline_from_string_p
))))
15093 && (row
->y
> top_scroll_margin
15094 || CHARPOS (startp
) == BEGV
))
15096 eassert (row
->enabled_p
);
15100 /* Consider the following case: Window starts at BEGV,
15101 there is invisible, intangible text at BEGV, so that
15102 display starts at some point START > BEGV. It can
15103 happen that we are called with PT somewhere between
15104 BEGV and START. Try to handle that case. */
15105 if (row
< w
->current_matrix
->rows
15106 || row
->mode_line_p
)
15108 row
= w
->current_matrix
->rows
;
15109 if (row
->mode_line_p
)
15113 /* Due to newlines in overlay strings, we may have to
15114 skip forward over overlay strings. */
15115 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15116 && MATRIX_ROW_END_CHARPOS (row
) == PT
15117 && !cursor_row_p (row
))
15120 /* If within the scroll margin, scroll. */
15121 if (row
->y
< top_scroll_margin
15122 && CHARPOS (startp
) != BEGV
)
15127 /* Cursor did not move. So don't scroll even if cursor line
15128 is partially visible, as it was so before. */
15129 rc
= CURSOR_MOVEMENT_SUCCESS
;
15132 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15133 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15135 /* if PT is not in the glyph row, give up. */
15136 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15139 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15140 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15142 struct glyph_row
*row1
;
15144 /* If rows are bidi-reordered and point moved, back up
15145 until we find a row that does not belong to a
15146 continuation line. This is because we must consider
15147 all rows of a continued line as candidates for the
15148 new cursor positioning, since row start and end
15149 positions change non-linearly with vertical position
15151 /* FIXME: Revisit this when glyph ``spilling'' in
15152 continuation lines' rows is implemented for
15153 bidi-reordered rows. */
15154 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15155 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15158 /* If we hit the beginning of the displayed portion
15159 without finding the first row of a continued
15163 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15166 eassert (row
->enabled_p
);
15171 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15172 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15173 /* Make sure this isn't a header line by any chance, since
15174 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15175 && !row
->mode_line_p
15176 && make_cursor_line_fully_visible_p
)
15178 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15179 && !row
->ends_at_zv_p
15180 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15181 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15182 else if (row
->height
> window_box_height (w
))
15184 /* If we end up in a partially visible line, let's
15185 make it fully visible, except when it's taller
15186 than the window, in which case we can't do much
15189 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15193 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15194 if (!cursor_row_fully_visible_p (w
, 0, 1))
15195 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15197 rc
= CURSOR_MOVEMENT_SUCCESS
;
15201 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15202 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15203 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15205 /* With bidi-reordered rows, there could be more than
15206 one candidate row whose start and end positions
15207 occlude point. We need to let set_cursor_from_row
15208 find the best candidate. */
15209 /* FIXME: Revisit this when glyph ``spilling'' in
15210 continuation lines' rows is implemented for
15211 bidi-reordered rows. */
15216 int at_zv_p
= 0, exact_match_p
= 0;
15218 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15219 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15220 && cursor_row_p (row
))
15221 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15223 /* As soon as we've found the exact match for point,
15224 or the first suitable row whose ends_at_zv_p flag
15225 is set, we are done. */
15227 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15229 && w
->cursor
.hpos
>= 0
15230 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15233 struct glyph_row
*candidate
=
15234 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15236 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15237 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15240 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15241 || (INTEGERP (g
->object
)
15242 && (g
->charpos
== PT
15243 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15245 if (rv
&& (at_zv_p
|| exact_match_p
))
15247 rc
= CURSOR_MOVEMENT_SUCCESS
;
15250 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15254 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15255 || row
->continued_p
)
15256 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15257 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15258 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15259 /* If we didn't find any candidate rows, or exited the
15260 loop before all the candidates were examined, signal
15261 to the caller that this method failed. */
15262 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15264 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15265 && !row
->continued_p
))
15266 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15268 rc
= CURSOR_MOVEMENT_SUCCESS
;
15274 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15276 rc
= CURSOR_MOVEMENT_SUCCESS
;
15281 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15282 && MATRIX_ROW_START_CHARPOS (row
) == PT
15283 && cursor_row_p (row
));
15291 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15295 set_vertical_scroll_bar (struct window
*w
)
15297 ptrdiff_t start
, end
, whole
;
15299 /* Calculate the start and end positions for the current window.
15300 At some point, it would be nice to choose between scrollbars
15301 which reflect the whole buffer size, with special markers
15302 indicating narrowing, and scrollbars which reflect only the
15305 Note that mini-buffers sometimes aren't displaying any text. */
15306 if (!MINI_WINDOW_P (w
)
15307 || (w
== XWINDOW (minibuf_window
)
15308 && NILP (echo_area_buffer
[0])))
15310 struct buffer
*buf
= XBUFFER (w
->contents
);
15311 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15312 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15313 /* I don't think this is guaranteed to be right. For the
15314 moment, we'll pretend it is. */
15315 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15319 if (whole
< (end
- start
))
15320 whole
= end
- start
;
15323 start
= end
= whole
= 0;
15325 /* Indicate what this scroll bar ought to be displaying now. */
15326 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15327 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15328 (w
, end
- start
, whole
, start
);
15332 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15333 selected_window is redisplayed.
15335 We can return without actually redisplaying the window if
15336 fonts_changed_p. In that case, redisplay_internal will
15340 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15342 struct window
*w
= XWINDOW (window
);
15343 struct frame
*f
= XFRAME (w
->frame
);
15344 struct buffer
*buffer
= XBUFFER (w
->contents
);
15345 struct buffer
*old
= current_buffer
;
15346 struct text_pos lpoint
, opoint
, startp
;
15347 int update_mode_line
;
15350 /* Record it now because it's overwritten. */
15351 int current_matrix_up_to_date_p
= 0;
15352 int used_current_matrix_p
= 0;
15353 /* This is less strict than current_matrix_up_to_date_p.
15354 It indicates that the buffer contents and narrowing are unchanged. */
15355 int buffer_unchanged_p
= 0;
15356 int temp_scroll_step
= 0;
15357 ptrdiff_t count
= SPECPDL_INDEX ();
15359 int centering_position
= -1;
15360 int last_line_misfit
= 0;
15361 ptrdiff_t beg_unchanged
, end_unchanged
;
15362 int frame_line_height
;
15364 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15368 *w
->desired_matrix
->method
= 0;
15371 /* Make sure that both W's markers are valid. */
15372 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15373 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15376 reconsider_clip_changes (w
);
15377 frame_line_height
= default_line_pixel_height (w
);
15379 /* Has the mode line to be updated? */
15380 update_mode_line
= (w
->update_mode_line
15381 || update_mode_lines
15382 || buffer
->clip_changed
15383 || buffer
->prevent_redisplay_optimizations_p
);
15385 if (MINI_WINDOW_P (w
))
15387 if (w
== XWINDOW (echo_area_window
)
15388 && !NILP (echo_area_buffer
[0]))
15390 if (update_mode_line
)
15391 /* We may have to update a tty frame's menu bar or a
15392 tool-bar. Example `M-x C-h C-h C-g'. */
15393 goto finish_menu_bars
;
15395 /* We've already displayed the echo area glyphs in this window. */
15396 goto finish_scroll_bars
;
15398 else if ((w
!= XWINDOW (minibuf_window
)
15399 || minibuf_level
== 0)
15400 /* When buffer is nonempty, redisplay window normally. */
15401 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15402 /* Quail displays non-mini buffers in minibuffer window.
15403 In that case, redisplay the window normally. */
15404 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15406 /* W is a mini-buffer window, but it's not active, so clear
15408 int yb
= window_text_bottom_y (w
);
15409 struct glyph_row
*row
;
15412 for (y
= 0, row
= w
->desired_matrix
->rows
;
15414 y
+= row
->height
, ++row
)
15415 blank_row (w
, row
, y
);
15416 goto finish_scroll_bars
;
15419 clear_glyph_matrix (w
->desired_matrix
);
15422 /* Otherwise set up data on this window; select its buffer and point
15424 /* Really select the buffer, for the sake of buffer-local
15426 set_buffer_internal_1 (XBUFFER (w
->contents
));
15428 current_matrix_up_to_date_p
15429 = (w
->window_end_valid
15430 && !current_buffer
->clip_changed
15431 && !current_buffer
->prevent_redisplay_optimizations_p
15432 && !window_outdated (w
));
15434 /* Run the window-bottom-change-functions
15435 if it is possible that the text on the screen has changed
15436 (either due to modification of the text, or any other reason). */
15437 if (!current_matrix_up_to_date_p
15438 && !NILP (Vwindow_text_change_functions
))
15440 safe_run_hooks (Qwindow_text_change_functions
);
15444 beg_unchanged
= BEG_UNCHANGED
;
15445 end_unchanged
= END_UNCHANGED
;
15447 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15449 specbind (Qinhibit_point_motion_hooks
, Qt
);
15452 = (w
->window_end_valid
15453 && !current_buffer
->clip_changed
15454 && !window_outdated (w
));
15456 /* When windows_or_buffers_changed is non-zero, we can't rely
15457 on the window end being valid, so set it to zero there. */
15458 if (windows_or_buffers_changed
)
15460 /* If window starts on a continuation line, maybe adjust the
15461 window start in case the window's width changed. */
15462 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15463 compute_window_start_on_continuation_line (w
);
15465 w
->window_end_valid
= 0;
15466 /* If so, we also can't rely on current matrix
15467 and should not fool try_cursor_movement below. */
15468 current_matrix_up_to_date_p
= 0;
15471 /* Some sanity checks. */
15472 CHECK_WINDOW_END (w
);
15473 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15475 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15478 if (mode_line_update_needed (w
))
15479 update_mode_line
= 1;
15481 /* Point refers normally to the selected window. For any other
15482 window, set up appropriate value. */
15483 if (!EQ (window
, selected_window
))
15485 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15486 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15490 new_pt_byte
= BEGV_BYTE
;
15491 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15493 else if (new_pt
> (ZV
- 1))
15496 new_pt_byte
= ZV_BYTE
;
15497 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15500 /* We don't use SET_PT so that the point-motion hooks don't run. */
15501 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15504 /* If any of the character widths specified in the display table
15505 have changed, invalidate the width run cache. It's true that
15506 this may be a bit late to catch such changes, but the rest of
15507 redisplay goes (non-fatally) haywire when the display table is
15508 changed, so why should we worry about doing any better? */
15509 if (current_buffer
->width_run_cache
)
15511 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15513 if (! disptab_matches_widthtab
15514 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15516 invalidate_region_cache (current_buffer
,
15517 current_buffer
->width_run_cache
,
15519 recompute_width_table (current_buffer
, disptab
);
15523 /* If window-start is screwed up, choose a new one. */
15524 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15527 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15529 /* If someone specified a new starting point but did not insist,
15530 check whether it can be used. */
15531 if (w
->optional_new_start
15532 && CHARPOS (startp
) >= BEGV
15533 && CHARPOS (startp
) <= ZV
)
15535 w
->optional_new_start
= 0;
15536 start_display (&it
, w
, startp
);
15537 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15538 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15539 if (IT_CHARPOS (it
) == PT
)
15540 w
->force_start
= 1;
15541 /* IT may overshoot PT if text at PT is invisible. */
15542 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15543 w
->force_start
= 1;
15548 /* Handle case where place to start displaying has been specified,
15549 unless the specified location is outside the accessible range. */
15550 if (w
->force_start
|| window_frozen_p (w
))
15552 /* We set this later on if we have to adjust point. */
15555 w
->force_start
= 0;
15557 w
->window_end_valid
= 0;
15559 /* Forget any recorded base line for line number display. */
15560 if (!buffer_unchanged_p
)
15561 w
->base_line_number
= 0;
15563 /* Redisplay the mode line. Select the buffer properly for that.
15564 Also, run the hook window-scroll-functions
15565 because we have scrolled. */
15566 /* Note, we do this after clearing force_start because
15567 if there's an error, it is better to forget about force_start
15568 than to get into an infinite loop calling the hook functions
15569 and having them get more errors. */
15570 if (!update_mode_line
15571 || ! NILP (Vwindow_scroll_functions
))
15573 update_mode_line
= 1;
15574 w
->update_mode_line
= 1;
15575 startp
= run_window_scroll_functions (window
, startp
);
15578 if (CHARPOS (startp
) < BEGV
)
15579 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15580 else if (CHARPOS (startp
) > ZV
)
15581 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15583 /* Redisplay, then check if cursor has been set during the
15584 redisplay. Give up if new fonts were loaded. */
15585 /* We used to issue a CHECK_MARGINS argument to try_window here,
15586 but this causes scrolling to fail when point begins inside
15587 the scroll margin (bug#148) -- cyd */
15588 if (!try_window (window
, startp
, 0))
15590 w
->force_start
= 1;
15591 clear_glyph_matrix (w
->desired_matrix
);
15592 goto need_larger_matrices
;
15595 if (w
->cursor
.vpos
< 0 && !window_frozen_p (w
))
15597 /* If point does not appear, try to move point so it does
15598 appear. The desired matrix has been built above, so we
15599 can use it here. */
15600 new_vpos
= window_box_height (w
) / 2;
15603 if (!cursor_row_fully_visible_p (w
, 0, 0))
15605 /* Point does appear, but on a line partly visible at end of window.
15606 Move it back to a fully-visible line. */
15607 new_vpos
= window_box_height (w
);
15609 else if (w
->cursor
.vpos
>=0)
15611 /* Some people insist on not letting point enter the scroll
15612 margin, even though this part handles windows that didn't
15614 int window_total_lines
15615 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15616 int margin
= min (scroll_margin
, window_total_lines
/ 4);
15617 int pixel_margin
= margin
* frame_line_height
;
15618 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
15620 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
15621 below, which finds the row to move point to, advances by
15622 the Y coordinate of the _next_ row, see the definition of
15623 MATRIX_ROW_BOTTOM_Y. */
15624 if (w
->cursor
.vpos
< margin
+ header_line
)
15626 w
->cursor
.vpos
= -1;
15627 clear_glyph_matrix (w
->desired_matrix
);
15628 goto try_to_scroll
;
15632 int window_height
= window_box_height (w
);
15635 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15636 if (w
->cursor
.y
>= window_height
- pixel_margin
)
15638 w
->cursor
.vpos
= -1;
15639 clear_glyph_matrix (w
->desired_matrix
);
15640 goto try_to_scroll
;
15645 /* If we need to move point for either of the above reasons,
15646 now actually do it. */
15649 struct glyph_row
*row
;
15651 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15652 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15655 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15656 MATRIX_ROW_START_BYTEPOS (row
));
15658 if (w
!= XWINDOW (selected_window
))
15659 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15660 else if (current_buffer
== old
)
15661 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15663 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15665 /* If we are highlighting the region, then we just changed
15666 the region, so redisplay to show it. */
15667 if (markpos_of_region () >= 0)
15669 clear_glyph_matrix (w
->desired_matrix
);
15670 if (!try_window (window
, startp
, 0))
15671 goto need_larger_matrices
;
15676 debug_method_add (w
, "forced window start");
15681 /* Handle case where text has not changed, only point, and it has
15682 not moved off the frame, and we are not retrying after hscroll.
15683 (current_matrix_up_to_date_p is nonzero when retrying.) */
15684 if (current_matrix_up_to_date_p
15685 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15686 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15690 case CURSOR_MOVEMENT_SUCCESS
:
15691 used_current_matrix_p
= 1;
15694 case CURSOR_MOVEMENT_MUST_SCROLL
:
15695 goto try_to_scroll
;
15701 /* If current starting point was originally the beginning of a line
15702 but no longer is, find a new starting point. */
15703 else if (w
->start_at_line_beg
15704 && !(CHARPOS (startp
) <= BEGV
15705 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15708 debug_method_add (w
, "recenter 1");
15713 /* Try scrolling with try_window_id. Value is > 0 if update has
15714 been done, it is -1 if we know that the same window start will
15715 not work. It is 0 if unsuccessful for some other reason. */
15716 else if ((tem
= try_window_id (w
)) != 0)
15719 debug_method_add (w
, "try_window_id %d", tem
);
15722 if (fonts_changed_p
)
15723 goto need_larger_matrices
;
15727 /* Otherwise try_window_id has returned -1 which means that we
15728 don't want the alternative below this comment to execute. */
15730 else if (CHARPOS (startp
) >= BEGV
15731 && CHARPOS (startp
) <= ZV
15732 && PT
>= CHARPOS (startp
)
15733 && (CHARPOS (startp
) < ZV
15734 /* Avoid starting at end of buffer. */
15735 || CHARPOS (startp
) == BEGV
15736 || !window_outdated (w
)))
15738 int d1
, d2
, d3
, d4
, d5
, d6
;
15740 /* If first window line is a continuation line, and window start
15741 is inside the modified region, but the first change is before
15742 current window start, we must select a new window start.
15744 However, if this is the result of a down-mouse event (e.g. by
15745 extending the mouse-drag-overlay), we don't want to select a
15746 new window start, since that would change the position under
15747 the mouse, resulting in an unwanted mouse-movement rather
15748 than a simple mouse-click. */
15749 if (!w
->start_at_line_beg
15750 && NILP (do_mouse_tracking
)
15751 && CHARPOS (startp
) > BEGV
15752 && CHARPOS (startp
) > BEG
+ beg_unchanged
15753 && CHARPOS (startp
) <= Z
- end_unchanged
15754 /* Even if w->start_at_line_beg is nil, a new window may
15755 start at a line_beg, since that's how set_buffer_window
15756 sets it. So, we need to check the return value of
15757 compute_window_start_on_continuation_line. (See also
15759 && XMARKER (w
->start
)->buffer
== current_buffer
15760 && compute_window_start_on_continuation_line (w
)
15761 /* It doesn't make sense to force the window start like we
15762 do at label force_start if it is already known that point
15763 will not be visible in the resulting window, because
15764 doing so will move point from its correct position
15765 instead of scrolling the window to bring point into view.
15767 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15769 w
->force_start
= 1;
15770 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15775 debug_method_add (w
, "same window start");
15778 /* Try to redisplay starting at same place as before.
15779 If point has not moved off frame, accept the results. */
15780 if (!current_matrix_up_to_date_p
15781 /* Don't use try_window_reusing_current_matrix in this case
15782 because a window scroll function can have changed the
15784 || !NILP (Vwindow_scroll_functions
)
15785 || MINI_WINDOW_P (w
)
15786 || !(used_current_matrix_p
15787 = try_window_reusing_current_matrix (w
)))
15789 IF_DEBUG (debug_method_add (w
, "1"));
15790 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15791 /* -1 means we need to scroll.
15792 0 means we need new matrices, but fonts_changed_p
15793 is set in that case, so we will detect it below. */
15794 goto try_to_scroll
;
15797 if (fonts_changed_p
)
15798 goto need_larger_matrices
;
15800 if (w
->cursor
.vpos
>= 0)
15802 if (!just_this_one_p
15803 || current_buffer
->clip_changed
15804 || BEG_UNCHANGED
< CHARPOS (startp
))
15805 /* Forget any recorded base line for line number display. */
15806 w
->base_line_number
= 0;
15808 if (!cursor_row_fully_visible_p (w
, 1, 0))
15810 clear_glyph_matrix (w
->desired_matrix
);
15811 last_line_misfit
= 1;
15813 /* Drop through and scroll. */
15818 clear_glyph_matrix (w
->desired_matrix
);
15823 /* Redisplay the mode line. Select the buffer properly for that. */
15824 if (!update_mode_line
)
15826 update_mode_line
= 1;
15827 w
->update_mode_line
= 1;
15830 /* Try to scroll by specified few lines. */
15831 if ((scroll_conservatively
15832 || emacs_scroll_step
15833 || temp_scroll_step
15834 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15835 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15836 && CHARPOS (startp
) >= BEGV
15837 && CHARPOS (startp
) <= ZV
)
15839 /* The function returns -1 if new fonts were loaded, 1 if
15840 successful, 0 if not successful. */
15841 int ss
= try_scrolling (window
, just_this_one_p
,
15842 scroll_conservatively
,
15844 temp_scroll_step
, last_line_misfit
);
15847 case SCROLLING_SUCCESS
:
15850 case SCROLLING_NEED_LARGER_MATRICES
:
15851 goto need_larger_matrices
;
15853 case SCROLLING_FAILED
:
15861 /* Finally, just choose a place to start which positions point
15862 according to user preferences. */
15867 debug_method_add (w
, "recenter");
15870 /* Forget any previously recorded base line for line number display. */
15871 if (!buffer_unchanged_p
)
15872 w
->base_line_number
= 0;
15874 /* Determine the window start relative to point. */
15875 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15876 it
.current_y
= it
.last_visible_y
;
15877 if (centering_position
< 0)
15879 int window_total_lines
15880 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15883 ? min (scroll_margin
, window_total_lines
/ 4)
15885 ptrdiff_t margin_pos
= CHARPOS (startp
);
15886 Lisp_Object aggressive
;
15889 /* If there is a scroll margin at the top of the window, find
15890 its character position. */
15892 /* Cannot call start_display if startp is not in the
15893 accessible region of the buffer. This can happen when we
15894 have just switched to a different buffer and/or changed
15895 its restriction. In that case, startp is initialized to
15896 the character position 1 (BEGV) because we did not yet
15897 have chance to display the buffer even once. */
15898 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15901 void *it1data
= NULL
;
15903 SAVE_IT (it1
, it
, it1data
);
15904 start_display (&it1
, w
, startp
);
15905 move_it_vertically (&it1
, margin
* frame_line_height
);
15906 margin_pos
= IT_CHARPOS (it1
);
15907 RESTORE_IT (&it
, &it
, it1data
);
15909 scrolling_up
= PT
> margin_pos
;
15912 ? BVAR (current_buffer
, scroll_up_aggressively
)
15913 : BVAR (current_buffer
, scroll_down_aggressively
);
15915 if (!MINI_WINDOW_P (w
)
15916 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15920 /* Setting scroll-conservatively overrides
15921 scroll-*-aggressively. */
15922 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15924 double float_amount
= XFLOATINT (aggressive
);
15926 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15927 if (pt_offset
== 0 && float_amount
> 0)
15929 if (pt_offset
&& margin
> 0)
15932 /* Compute how much to move the window start backward from
15933 point so that point will be displayed where the user
15937 centering_position
= it
.last_visible_y
;
15939 centering_position
-= pt_offset
;
15940 centering_position
-=
15941 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
15942 + WINDOW_HEADER_LINE_HEIGHT (w
);
15943 /* Don't let point enter the scroll margin near top of
15945 if (centering_position
< margin
* frame_line_height
)
15946 centering_position
= margin
* frame_line_height
;
15949 centering_position
= margin
* frame_line_height
+ pt_offset
;
15952 /* Set the window start half the height of the window backward
15954 centering_position
= window_box_height (w
) / 2;
15956 move_it_vertically_backward (&it
, centering_position
);
15958 eassert (IT_CHARPOS (it
) >= BEGV
);
15960 /* The function move_it_vertically_backward may move over more
15961 than the specified y-distance. If it->w is small, e.g. a
15962 mini-buffer window, we may end up in front of the window's
15963 display area. Start displaying at the start of the line
15964 containing PT in this case. */
15965 if (it
.current_y
<= 0)
15967 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15968 move_it_vertically_backward (&it
, 0);
15972 it
.current_x
= it
.hpos
= 0;
15974 /* Set the window start position here explicitly, to avoid an
15975 infinite loop in case the functions in window-scroll-functions
15977 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15979 /* Run scroll hooks. */
15980 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15982 /* Redisplay the window. */
15983 if (!current_matrix_up_to_date_p
15984 || windows_or_buffers_changed
15985 || cursor_type_changed
15986 /* Don't use try_window_reusing_current_matrix in this case
15987 because it can have changed the buffer. */
15988 || !NILP (Vwindow_scroll_functions
)
15989 || !just_this_one_p
15990 || MINI_WINDOW_P (w
)
15991 || !(used_current_matrix_p
15992 = try_window_reusing_current_matrix (w
)))
15993 try_window (window
, startp
, 0);
15995 /* If new fonts have been loaded (due to fontsets), give up. We
15996 have to start a new redisplay since we need to re-adjust glyph
15998 if (fonts_changed_p
)
15999 goto need_larger_matrices
;
16001 /* If cursor did not appear assume that the middle of the window is
16002 in the first line of the window. Do it again with the next line.
16003 (Imagine a window of height 100, displaying two lines of height
16004 60. Moving back 50 from it->last_visible_y will end in the first
16006 if (w
->cursor
.vpos
< 0)
16008 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16010 clear_glyph_matrix (w
->desired_matrix
);
16011 move_it_by_lines (&it
, 1);
16012 try_window (window
, it
.current
.pos
, 0);
16014 else if (PT
< IT_CHARPOS (it
))
16016 clear_glyph_matrix (w
->desired_matrix
);
16017 move_it_by_lines (&it
, -1);
16018 try_window (window
, it
.current
.pos
, 0);
16022 /* Not much we can do about it. */
16026 /* Consider the following case: Window starts at BEGV, there is
16027 invisible, intangible text at BEGV, so that display starts at
16028 some point START > BEGV. It can happen that we are called with
16029 PT somewhere between BEGV and START. Try to handle that case. */
16030 if (w
->cursor
.vpos
< 0)
16032 struct glyph_row
*row
= w
->current_matrix
->rows
;
16033 if (row
->mode_line_p
)
16035 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16038 if (!cursor_row_fully_visible_p (w
, 0, 0))
16040 /* If vscroll is enabled, disable it and try again. */
16044 clear_glyph_matrix (w
->desired_matrix
);
16048 /* Users who set scroll-conservatively to a large number want
16049 point just above/below the scroll margin. If we ended up
16050 with point's row partially visible, move the window start to
16051 make that row fully visible and out of the margin. */
16052 if (scroll_conservatively
> SCROLL_LIMIT
)
16054 int window_total_lines
16055 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16058 ? min (scroll_margin
, window_total_lines
/ 4)
16060 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16062 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16063 clear_glyph_matrix (w
->desired_matrix
);
16064 if (1 == try_window (window
, it
.current
.pos
,
16065 TRY_WINDOW_CHECK_MARGINS
))
16069 /* If centering point failed to make the whole line visible,
16070 put point at the top instead. That has to make the whole line
16071 visible, if it can be done. */
16072 if (centering_position
== 0)
16075 clear_glyph_matrix (w
->desired_matrix
);
16076 centering_position
= 0;
16082 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16083 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16084 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16086 /* Display the mode line, if we must. */
16087 if ((update_mode_line
16088 /* If window not full width, must redo its mode line
16089 if (a) the window to its side is being redone and
16090 (b) we do a frame-based redisplay. This is a consequence
16091 of how inverted lines are drawn in frame-based redisplay. */
16092 || (!just_this_one_p
16093 && !FRAME_WINDOW_P (f
)
16094 && !WINDOW_FULL_WIDTH_P (w
))
16095 /* Line number to display. */
16096 || w
->base_line_pos
> 0
16097 /* Column number is displayed and different from the one displayed. */
16098 || (w
->column_number_displayed
!= -1
16099 && (w
->column_number_displayed
!= current_column ())))
16100 /* This means that the window has a mode line. */
16101 && (WINDOW_WANTS_MODELINE_P (w
)
16102 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16104 display_mode_lines (w
);
16106 /* If mode line height has changed, arrange for a thorough
16107 immediate redisplay using the correct mode line height. */
16108 if (WINDOW_WANTS_MODELINE_P (w
)
16109 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16111 fonts_changed_p
= 1;
16112 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16113 = DESIRED_MODE_LINE_HEIGHT (w
);
16116 /* If header line height has changed, arrange for a thorough
16117 immediate redisplay using the correct header line height. */
16118 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16119 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16121 fonts_changed_p
= 1;
16122 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16123 = DESIRED_HEADER_LINE_HEIGHT (w
);
16126 if (fonts_changed_p
)
16127 goto need_larger_matrices
;
16130 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16132 w
->base_line_pos
= 0;
16133 w
->base_line_number
= 0;
16138 /* When we reach a frame's selected window, redo the frame's menu bar. */
16139 if (update_mode_line
16140 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16142 int redisplay_menu_p
= 0;
16144 if (FRAME_WINDOW_P (f
))
16146 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16147 || defined (HAVE_NS) || defined (USE_GTK)
16148 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16150 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16154 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16156 if (redisplay_menu_p
)
16157 display_menu_bar (w
);
16159 #ifdef HAVE_WINDOW_SYSTEM
16160 if (FRAME_WINDOW_P (f
))
16162 #if defined (USE_GTK) || defined (HAVE_NS)
16163 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16164 redisplay_tool_bar (f
);
16166 if (WINDOWP (f
->tool_bar_window
)
16167 && (FRAME_TOOL_BAR_LINES (f
) > 0
16168 || !NILP (Vauto_resize_tool_bars
))
16169 && redisplay_tool_bar (f
))
16170 ignore_mouse_drag_p
= 1;
16176 #ifdef HAVE_WINDOW_SYSTEM
16177 if (FRAME_WINDOW_P (f
)
16178 && update_window_fringes (w
, (just_this_one_p
16179 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16180 || w
->pseudo_window_p
)))
16184 if (draw_window_fringes (w
, 1))
16185 x_draw_vertical_border (w
);
16189 #endif /* HAVE_WINDOW_SYSTEM */
16191 /* We go to this label, with fonts_changed_p set,
16192 if it is necessary to try again using larger glyph matrices.
16193 We have to redeem the scroll bar even in this case,
16194 because the loop in redisplay_internal expects that. */
16195 need_larger_matrices
:
16197 finish_scroll_bars
:
16199 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16201 /* Set the thumb's position and size. */
16202 set_vertical_scroll_bar (w
);
16204 /* Note that we actually used the scroll bar attached to this
16205 window, so it shouldn't be deleted at the end of redisplay. */
16206 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16207 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16210 /* Restore current_buffer and value of point in it. The window
16211 update may have changed the buffer, so first make sure `opoint'
16212 is still valid (Bug#6177). */
16213 if (CHARPOS (opoint
) < BEGV
)
16214 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16215 else if (CHARPOS (opoint
) > ZV
)
16216 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16218 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16220 set_buffer_internal_1 (old
);
16221 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16222 shorter. This can be caused by log truncation in *Messages*. */
16223 if (CHARPOS (lpoint
) <= ZV
)
16224 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16226 unbind_to (count
, Qnil
);
16230 /* Build the complete desired matrix of WINDOW with a window start
16231 buffer position POS.
16233 Value is 1 if successful. It is zero if fonts were loaded during
16234 redisplay which makes re-adjusting glyph matrices necessary, and -1
16235 if point would appear in the scroll margins.
16236 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16237 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16241 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16243 struct window
*w
= XWINDOW (window
);
16245 struct glyph_row
*last_text_row
= NULL
;
16246 struct frame
*f
= XFRAME (w
->frame
);
16247 int frame_line_height
= default_line_pixel_height (w
);
16249 /* Make POS the new window start. */
16250 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16252 /* Mark cursor position as unknown. No overlay arrow seen. */
16253 w
->cursor
.vpos
= -1;
16254 overlay_arrow_seen
= 0;
16256 /* Initialize iterator and info to start at POS. */
16257 start_display (&it
, w
, pos
);
16259 /* Display all lines of W. */
16260 while (it
.current_y
< it
.last_visible_y
)
16262 if (display_line (&it
))
16263 last_text_row
= it
.glyph_row
- 1;
16264 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16268 /* Don't let the cursor end in the scroll margins. */
16269 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16270 && !MINI_WINDOW_P (w
))
16272 int this_scroll_margin
;
16273 int window_total_lines
16274 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16276 if (scroll_margin
> 0)
16278 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16279 this_scroll_margin
*= frame_line_height
;
16282 this_scroll_margin
= 0;
16284 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16285 && w
->cursor
.y
< this_scroll_margin
16286 && CHARPOS (pos
) > BEGV
16287 && IT_CHARPOS (it
) < ZV
)
16288 /* rms: considering make_cursor_line_fully_visible_p here
16289 seems to give wrong results. We don't want to recenter
16290 when the last line is partly visible, we want to allow
16291 that case to be handled in the usual way. */
16292 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16294 w
->cursor
.vpos
= -1;
16295 clear_glyph_matrix (w
->desired_matrix
);
16300 /* If bottom moved off end of frame, change mode line percentage. */
16301 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16302 w
->update_mode_line
= 1;
16304 /* Set window_end_pos to the offset of the last character displayed
16305 on the window from the end of current_buffer. Set
16306 window_end_vpos to its row number. */
16309 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16310 adjust_window_ends (w
, last_text_row
, 0);
16312 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16313 w
->window_end_vpos
)));
16317 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16318 w
->window_end_pos
= Z
- ZV
;
16319 w
->window_end_vpos
= 0;
16322 /* But that is not valid info until redisplay finishes. */
16323 w
->window_end_valid
= 0;
16329 /************************************************************************
16330 Window redisplay reusing current matrix when buffer has not changed
16331 ************************************************************************/
16333 /* Try redisplay of window W showing an unchanged buffer with a
16334 different window start than the last time it was displayed by
16335 reusing its current matrix. Value is non-zero if successful.
16336 W->start is the new window start. */
16339 try_window_reusing_current_matrix (struct window
*w
)
16341 struct frame
*f
= XFRAME (w
->frame
);
16342 struct glyph_row
*bottom_row
;
16345 struct text_pos start
, new_start
;
16346 int nrows_scrolled
, i
;
16347 struct glyph_row
*last_text_row
;
16348 struct glyph_row
*last_reused_text_row
;
16349 struct glyph_row
*start_row
;
16350 int start_vpos
, min_y
, max_y
;
16353 if (inhibit_try_window_reusing
)
16357 if (/* This function doesn't handle terminal frames. */
16358 !FRAME_WINDOW_P (f
)
16359 /* Don't try to reuse the display if windows have been split
16361 || windows_or_buffers_changed
16362 || cursor_type_changed
)
16365 /* Can't do this if region may have changed. */
16366 if (markpos_of_region () >= 0
16367 || w
->region_showing
16368 || !NILP (Vshow_trailing_whitespace
))
16371 /* If top-line visibility has changed, give up. */
16372 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16373 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16376 /* Give up if old or new display is scrolled vertically. We could
16377 make this function handle this, but right now it doesn't. */
16378 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16379 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16382 /* The variable new_start now holds the new window start. The old
16383 start `start' can be determined from the current matrix. */
16384 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16385 start
= start_row
->minpos
;
16386 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16388 /* Clear the desired matrix for the display below. */
16389 clear_glyph_matrix (w
->desired_matrix
);
16391 if (CHARPOS (new_start
) <= CHARPOS (start
))
16393 /* Don't use this method if the display starts with an ellipsis
16394 displayed for invisible text. It's not easy to handle that case
16395 below, and it's certainly not worth the effort since this is
16396 not a frequent case. */
16397 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16400 IF_DEBUG (debug_method_add (w
, "twu1"));
16402 /* Display up to a row that can be reused. The variable
16403 last_text_row is set to the last row displayed that displays
16404 text. Note that it.vpos == 0 if or if not there is a
16405 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16406 start_display (&it
, w
, new_start
);
16407 w
->cursor
.vpos
= -1;
16408 last_text_row
= last_reused_text_row
= NULL
;
16410 while (it
.current_y
< it
.last_visible_y
16411 && !fonts_changed_p
)
16413 /* If we have reached into the characters in the START row,
16414 that means the line boundaries have changed. So we
16415 can't start copying with the row START. Maybe it will
16416 work to start copying with the following row. */
16417 while (IT_CHARPOS (it
) > CHARPOS (start
))
16419 /* Advance to the next row as the "start". */
16421 start
= start_row
->minpos
;
16422 /* If there are no more rows to try, or just one, give up. */
16423 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16424 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16425 || CHARPOS (start
) == ZV
)
16427 clear_glyph_matrix (w
->desired_matrix
);
16431 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16433 /* If we have reached alignment, we can copy the rest of the
16435 if (IT_CHARPOS (it
) == CHARPOS (start
)
16436 /* Don't accept "alignment" inside a display vector,
16437 since start_row could have started in the middle of
16438 that same display vector (thus their character
16439 positions match), and we have no way of telling if
16440 that is the case. */
16441 && it
.current
.dpvec_index
< 0)
16444 if (display_line (&it
))
16445 last_text_row
= it
.glyph_row
- 1;
16449 /* A value of current_y < last_visible_y means that we stopped
16450 at the previous window start, which in turn means that we
16451 have at least one reusable row. */
16452 if (it
.current_y
< it
.last_visible_y
)
16454 struct glyph_row
*row
;
16456 /* IT.vpos always starts from 0; it counts text lines. */
16457 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16459 /* Find PT if not already found in the lines displayed. */
16460 if (w
->cursor
.vpos
< 0)
16462 int dy
= it
.current_y
- start_row
->y
;
16464 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16465 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16467 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16468 dy
, nrows_scrolled
);
16471 clear_glyph_matrix (w
->desired_matrix
);
16476 /* Scroll the display. Do it before the current matrix is
16477 changed. The problem here is that update has not yet
16478 run, i.e. part of the current matrix is not up to date.
16479 scroll_run_hook will clear the cursor, and use the
16480 current matrix to get the height of the row the cursor is
16482 run
.current_y
= start_row
->y
;
16483 run
.desired_y
= it
.current_y
;
16484 run
.height
= it
.last_visible_y
- it
.current_y
;
16486 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16489 FRAME_RIF (f
)->update_window_begin_hook (w
);
16490 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16491 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16492 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16496 /* Shift current matrix down by nrows_scrolled lines. */
16497 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16498 rotate_matrix (w
->current_matrix
,
16500 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16503 /* Disable lines that must be updated. */
16504 for (i
= 0; i
< nrows_scrolled
; ++i
)
16505 (start_row
+ i
)->enabled_p
= 0;
16507 /* Re-compute Y positions. */
16508 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16509 max_y
= it
.last_visible_y
;
16510 for (row
= start_row
+ nrows_scrolled
;
16514 row
->y
= it
.current_y
;
16515 row
->visible_height
= row
->height
;
16517 if (row
->y
< min_y
)
16518 row
->visible_height
-= min_y
- row
->y
;
16519 if (row
->y
+ row
->height
> max_y
)
16520 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16521 if (row
->fringe_bitmap_periodic_p
)
16522 row
->redraw_fringe_bitmaps_p
= 1;
16524 it
.current_y
+= row
->height
;
16526 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16527 last_reused_text_row
= row
;
16528 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16532 /* Disable lines in the current matrix which are now
16533 below the window. */
16534 for (++row
; row
< bottom_row
; ++row
)
16535 row
->enabled_p
= row
->mode_line_p
= 0;
16538 /* Update window_end_pos etc.; last_reused_text_row is the last
16539 reused row from the current matrix containing text, if any.
16540 The value of last_text_row is the last displayed line
16541 containing text. */
16542 if (last_reused_text_row
)
16543 adjust_window_ends (w
, last_reused_text_row
, 1);
16544 else if (last_text_row
)
16545 adjust_window_ends (w
, last_text_row
, 0);
16548 /* This window must be completely empty. */
16549 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16550 w
->window_end_pos
= Z
- ZV
;
16551 w
->window_end_vpos
= 0;
16553 w
->window_end_valid
= 0;
16555 /* Update hint: don't try scrolling again in update_window. */
16556 w
->desired_matrix
->no_scrolling_p
= 1;
16559 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16563 else if (CHARPOS (new_start
) > CHARPOS (start
))
16565 struct glyph_row
*pt_row
, *row
;
16566 struct glyph_row
*first_reusable_row
;
16567 struct glyph_row
*first_row_to_display
;
16569 int yb
= window_text_bottom_y (w
);
16571 /* Find the row starting at new_start, if there is one. Don't
16572 reuse a partially visible line at the end. */
16573 first_reusable_row
= start_row
;
16574 while (first_reusable_row
->enabled_p
16575 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16576 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16577 < CHARPOS (new_start
)))
16578 ++first_reusable_row
;
16580 /* Give up if there is no row to reuse. */
16581 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16582 || !first_reusable_row
->enabled_p
16583 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16584 != CHARPOS (new_start
)))
16587 /* We can reuse fully visible rows beginning with
16588 first_reusable_row to the end of the window. Set
16589 first_row_to_display to the first row that cannot be reused.
16590 Set pt_row to the row containing point, if there is any. */
16592 for (first_row_to_display
= first_reusable_row
;
16593 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16594 ++first_row_to_display
)
16596 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16597 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16598 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16599 && first_row_to_display
->ends_at_zv_p
16600 && pt_row
== NULL
)))
16601 pt_row
= first_row_to_display
;
16604 /* Start displaying at the start of first_row_to_display. */
16605 eassert (first_row_to_display
->y
< yb
);
16606 init_to_row_start (&it
, w
, first_row_to_display
);
16608 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16610 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16612 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16613 + WINDOW_HEADER_LINE_HEIGHT (w
));
16615 /* Display lines beginning with first_row_to_display in the
16616 desired matrix. Set last_text_row to the last row displayed
16617 that displays text. */
16618 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16619 if (pt_row
== NULL
)
16620 w
->cursor
.vpos
= -1;
16621 last_text_row
= NULL
;
16622 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16623 if (display_line (&it
))
16624 last_text_row
= it
.glyph_row
- 1;
16626 /* If point is in a reused row, adjust y and vpos of the cursor
16630 w
->cursor
.vpos
-= nrows_scrolled
;
16631 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16634 /* Give up if point isn't in a row displayed or reused. (This
16635 also handles the case where w->cursor.vpos < nrows_scrolled
16636 after the calls to display_line, which can happen with scroll
16637 margins. See bug#1295.) */
16638 if (w
->cursor
.vpos
< 0)
16640 clear_glyph_matrix (w
->desired_matrix
);
16644 /* Scroll the display. */
16645 run
.current_y
= first_reusable_row
->y
;
16646 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16647 run
.height
= it
.last_visible_y
- run
.current_y
;
16648 dy
= run
.current_y
- run
.desired_y
;
16653 FRAME_RIF (f
)->update_window_begin_hook (w
);
16654 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16655 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16656 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16660 /* Adjust Y positions of reused rows. */
16661 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16662 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16663 max_y
= it
.last_visible_y
;
16664 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16667 row
->visible_height
= row
->height
;
16668 if (row
->y
< min_y
)
16669 row
->visible_height
-= min_y
- row
->y
;
16670 if (row
->y
+ row
->height
> max_y
)
16671 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16672 if (row
->fringe_bitmap_periodic_p
)
16673 row
->redraw_fringe_bitmaps_p
= 1;
16676 /* Scroll the current matrix. */
16677 eassert (nrows_scrolled
> 0);
16678 rotate_matrix (w
->current_matrix
,
16680 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16683 /* Disable rows not reused. */
16684 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16685 row
->enabled_p
= 0;
16687 /* Point may have moved to a different line, so we cannot assume that
16688 the previous cursor position is valid; locate the correct row. */
16691 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16693 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16694 && !row
->ends_at_zv_p
;
16698 w
->cursor
.y
= row
->y
;
16700 if (row
< bottom_row
)
16702 /* Can't simply scan the row for point with
16703 bidi-reordered glyph rows. Let set_cursor_from_row
16704 figure out where to put the cursor, and if it fails,
16706 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
16708 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
16711 clear_glyph_matrix (w
->desired_matrix
);
16717 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16718 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16721 && (!BUFFERP (glyph
->object
)
16722 || glyph
->charpos
< PT
);
16726 w
->cursor
.x
+= glyph
->pixel_width
;
16732 /* Adjust window end. A null value of last_text_row means that
16733 the window end is in reused rows which in turn means that
16734 only its vpos can have changed. */
16736 adjust_window_ends (w
, last_text_row
, 0);
16738 w
->window_end_vpos
-= nrows_scrolled
;
16740 w
->window_end_valid
= 0;
16741 w
->desired_matrix
->no_scrolling_p
= 1;
16744 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16754 /************************************************************************
16755 Window redisplay reusing current matrix when buffer has changed
16756 ************************************************************************/
16758 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16759 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16760 ptrdiff_t *, ptrdiff_t *);
16761 static struct glyph_row
*
16762 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16763 struct glyph_row
*);
16766 /* Return the last row in MATRIX displaying text. If row START is
16767 non-null, start searching with that row. IT gives the dimensions
16768 of the display. Value is null if matrix is empty; otherwise it is
16769 a pointer to the row found. */
16771 static struct glyph_row
*
16772 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16773 struct glyph_row
*start
)
16775 struct glyph_row
*row
, *row_found
;
16777 /* Set row_found to the last row in IT->w's current matrix
16778 displaying text. The loop looks funny but think of partially
16781 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16782 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16784 eassert (row
->enabled_p
);
16786 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16795 /* Return the last row in the current matrix of W that is not affected
16796 by changes at the start of current_buffer that occurred since W's
16797 current matrix was built. Value is null if no such row exists.
16799 BEG_UNCHANGED us the number of characters unchanged at the start of
16800 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16801 first changed character in current_buffer. Characters at positions <
16802 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16803 when the current matrix was built. */
16805 static struct glyph_row
*
16806 find_last_unchanged_at_beg_row (struct window
*w
)
16808 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16809 struct glyph_row
*row
;
16810 struct glyph_row
*row_found
= NULL
;
16811 int yb
= window_text_bottom_y (w
);
16813 /* Find the last row displaying unchanged text. */
16814 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16815 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16816 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16819 if (/* If row ends before first_changed_pos, it is unchanged,
16820 except in some case. */
16821 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16822 /* When row ends in ZV and we write at ZV it is not
16824 && !row
->ends_at_zv_p
16825 /* When first_changed_pos is the end of a continued line,
16826 row is not unchanged because it may be no longer
16828 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16829 && (row
->continued_p
16830 || row
->exact_window_width_line_p
))
16831 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16832 needs to be recomputed, so don't consider this row as
16833 unchanged. This happens when the last line was
16834 bidi-reordered and was killed immediately before this
16835 redisplay cycle. In that case, ROW->end stores the
16836 buffer position of the first visual-order character of
16837 the killed text, which is now beyond ZV. */
16838 && CHARPOS (row
->end
.pos
) <= ZV
)
16841 /* Stop if last visible row. */
16842 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16850 /* Find the first glyph row in the current matrix of W that is not
16851 affected by changes at the end of current_buffer since the
16852 time W's current matrix was built.
16854 Return in *DELTA the number of chars by which buffer positions in
16855 unchanged text at the end of current_buffer must be adjusted.
16857 Return in *DELTA_BYTES the corresponding number of bytes.
16859 Value is null if no such row exists, i.e. all rows are affected by
16862 static struct glyph_row
*
16863 find_first_unchanged_at_end_row (struct window
*w
,
16864 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16866 struct glyph_row
*row
;
16867 struct glyph_row
*row_found
= NULL
;
16869 *delta
= *delta_bytes
= 0;
16871 /* Display must not have been paused, otherwise the current matrix
16872 is not up to date. */
16873 eassert (w
->window_end_valid
);
16875 /* A value of window_end_pos >= END_UNCHANGED means that the window
16876 end is in the range of changed text. If so, there is no
16877 unchanged row at the end of W's current matrix. */
16878 if (w
->window_end_pos
>= END_UNCHANGED
)
16881 /* Set row to the last row in W's current matrix displaying text. */
16882 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
16884 /* If matrix is entirely empty, no unchanged row exists. */
16885 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16887 /* The value of row is the last glyph row in the matrix having a
16888 meaningful buffer position in it. The end position of row
16889 corresponds to window_end_pos. This allows us to translate
16890 buffer positions in the current matrix to current buffer
16891 positions for characters not in changed text. */
16893 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
16894 ptrdiff_t Z_BYTE_old
=
16895 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16896 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
16897 struct glyph_row
*first_text_row
16898 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16900 *delta
= Z
- Z_old
;
16901 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16903 /* Set last_unchanged_pos to the buffer position of the last
16904 character in the buffer that has not been changed. Z is the
16905 index + 1 of the last character in current_buffer, i.e. by
16906 subtracting END_UNCHANGED we get the index of the last
16907 unchanged character, and we have to add BEG to get its buffer
16909 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16910 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16912 /* Search backward from ROW for a row displaying a line that
16913 starts at a minimum position >= last_unchanged_pos_old. */
16914 for (; row
> first_text_row
; --row
)
16916 /* This used to abort, but it can happen.
16917 It is ok to just stop the search instead here. KFS. */
16918 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16921 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16926 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16932 /* Make sure that glyph rows in the current matrix of window W
16933 reference the same glyph memory as corresponding rows in the
16934 frame's frame matrix. This function is called after scrolling W's
16935 current matrix on a terminal frame in try_window_id and
16936 try_window_reusing_current_matrix. */
16939 sync_frame_with_window_matrix_rows (struct window
*w
)
16941 struct frame
*f
= XFRAME (w
->frame
);
16942 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16944 /* Preconditions: W must be a leaf window and full-width. Its frame
16945 must have a frame matrix. */
16946 eassert (BUFFERP (w
->contents
));
16947 eassert (WINDOW_FULL_WIDTH_P (w
));
16948 eassert (!FRAME_WINDOW_P (f
));
16950 /* If W is a full-width window, glyph pointers in W's current matrix
16951 have, by definition, to be the same as glyph pointers in the
16952 corresponding frame matrix. Note that frame matrices have no
16953 marginal areas (see build_frame_matrix). */
16954 window_row
= w
->current_matrix
->rows
;
16955 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16956 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16957 while (window_row
< window_row_end
)
16959 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16960 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16962 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16963 frame_row
->glyphs
[TEXT_AREA
] = start
;
16964 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16965 frame_row
->glyphs
[LAST_AREA
] = end
;
16967 /* Disable frame rows whose corresponding window rows have
16968 been disabled in try_window_id. */
16969 if (!window_row
->enabled_p
)
16970 frame_row
->enabled_p
= 0;
16972 ++window_row
, ++frame_row
;
16977 /* Find the glyph row in window W containing CHARPOS. Consider all
16978 rows between START and END (not inclusive). END null means search
16979 all rows to the end of the display area of W. Value is the row
16980 containing CHARPOS or null. */
16983 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
16984 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16986 struct glyph_row
*row
= start
;
16987 struct glyph_row
*best_row
= NULL
;
16988 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
16991 /* If we happen to start on a header-line, skip that. */
16992 if (row
->mode_line_p
)
16995 if ((end
&& row
>= end
) || !row
->enabled_p
)
16998 last_y
= window_text_bottom_y (w
) - dy
;
17002 /* Give up if we have gone too far. */
17003 if (end
&& row
>= end
)
17005 /* This formerly returned if they were equal.
17006 I think that both quantities are of a "last plus one" type;
17007 if so, when they are equal, the row is within the screen. -- rms. */
17008 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17011 /* If it is in this row, return this row. */
17012 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17013 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17014 /* The end position of a row equals the start
17015 position of the next row. If CHARPOS is there, we
17016 would rather consider it displayed in the next
17017 line, except when this line ends in ZV. */
17018 && !row_for_charpos_p (row
, charpos
)))
17019 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17023 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17024 || (!best_row
&& !row
->continued_p
))
17026 /* In bidi-reordered rows, there could be several rows whose
17027 edges surround CHARPOS, all of these rows belonging to
17028 the same continued line. We need to find the row which
17029 fits CHARPOS the best. */
17030 for (g
= row
->glyphs
[TEXT_AREA
];
17031 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17034 if (!STRINGP (g
->object
))
17036 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17038 mindif
= eabs (g
->charpos
- charpos
);
17040 /* Exact match always wins. */
17047 else if (best_row
&& !row
->continued_p
)
17054 /* Try to redisplay window W by reusing its existing display. W's
17055 current matrix must be up to date when this function is called,
17056 i.e. window_end_valid must be nonzero.
17060 1 if display has been updated
17061 0 if otherwise unsuccessful
17062 -1 if redisplay with same window start is known not to succeed
17064 The following steps are performed:
17066 1. Find the last row in the current matrix of W that is not
17067 affected by changes at the start of current_buffer. If no such row
17070 2. Find the first row in W's current matrix that is not affected by
17071 changes at the end of current_buffer. Maybe there is no such row.
17073 3. Display lines beginning with the row + 1 found in step 1 to the
17074 row found in step 2 or, if step 2 didn't find a row, to the end of
17077 4. If cursor is not known to appear on the window, give up.
17079 5. If display stopped at the row found in step 2, scroll the
17080 display and current matrix as needed.
17082 6. Maybe display some lines at the end of W, if we must. This can
17083 happen under various circumstances, like a partially visible line
17084 becoming fully visible, or because newly displayed lines are displayed
17085 in smaller font sizes.
17087 7. Update W's window end information. */
17090 try_window_id (struct window
*w
)
17092 struct frame
*f
= XFRAME (w
->frame
);
17093 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17094 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17095 struct glyph_row
*last_unchanged_at_beg_row
;
17096 struct glyph_row
*first_unchanged_at_end_row
;
17097 struct glyph_row
*row
;
17098 struct glyph_row
*bottom_row
;
17101 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17103 struct text_pos start_pos
;
17105 int first_unchanged_at_end_vpos
= 0;
17106 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17107 struct text_pos start
;
17108 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17111 if (inhibit_try_window_id
)
17115 /* This is handy for debugging. */
17117 #define GIVE_UP(X) \
17119 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17123 #define GIVE_UP(X) return 0
17126 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17128 /* Don't use this for mini-windows because these can show
17129 messages and mini-buffers, and we don't handle that here. */
17130 if (MINI_WINDOW_P (w
))
17133 /* This flag is used to prevent redisplay optimizations. */
17134 if (windows_or_buffers_changed
|| cursor_type_changed
)
17137 /* Verify that narrowing has not changed.
17138 Also verify that we were not told to prevent redisplay optimizations.
17139 It would be nice to further
17140 reduce the number of cases where this prevents try_window_id. */
17141 if (current_buffer
->clip_changed
17142 || current_buffer
->prevent_redisplay_optimizations_p
)
17145 /* Window must either use window-based redisplay or be full width. */
17146 if (!FRAME_WINDOW_P (f
)
17147 && (!FRAME_LINE_INS_DEL_OK (f
)
17148 || !WINDOW_FULL_WIDTH_P (w
)))
17151 /* Give up if point is known NOT to appear in W. */
17152 if (PT
< CHARPOS (start
))
17155 /* Another way to prevent redisplay optimizations. */
17156 if (w
->last_modified
== 0)
17159 /* Verify that window is not hscrolled. */
17160 if (w
->hscroll
!= 0)
17163 /* Verify that display wasn't paused. */
17164 if (!w
->window_end_valid
)
17167 /* Can't use this if highlighting a region because a cursor movement
17168 will do more than just set the cursor. */
17169 if (markpos_of_region () >= 0)
17172 /* Likewise if highlighting trailing whitespace. */
17173 if (!NILP (Vshow_trailing_whitespace
))
17176 /* Likewise if showing a region. */
17177 if (w
->region_showing
)
17180 /* Can't use this if overlay arrow position and/or string have
17182 if (overlay_arrows_changed_p ())
17185 /* When word-wrap is on, adding a space to the first word of a
17186 wrapped line can change the wrap position, altering the line
17187 above it. It might be worthwhile to handle this more
17188 intelligently, but for now just redisplay from scratch. */
17189 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17192 /* Under bidi reordering, adding or deleting a character in the
17193 beginning of a paragraph, before the first strong directional
17194 character, can change the base direction of the paragraph (unless
17195 the buffer specifies a fixed paragraph direction), which will
17196 require to redisplay the whole paragraph. It might be worthwhile
17197 to find the paragraph limits and widen the range of redisplayed
17198 lines to that, but for now just give up this optimization and
17199 redisplay from scratch. */
17200 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17201 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17204 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17205 only if buffer has really changed. The reason is that the gap is
17206 initially at Z for freshly visited files. The code below would
17207 set end_unchanged to 0 in that case. */
17208 if (MODIFF
> SAVE_MODIFF
17209 /* This seems to happen sometimes after saving a buffer. */
17210 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17212 if (GPT
- BEG
< BEG_UNCHANGED
)
17213 BEG_UNCHANGED
= GPT
- BEG
;
17214 if (Z
- GPT
< END_UNCHANGED
)
17215 END_UNCHANGED
= Z
- GPT
;
17218 /* The position of the first and last character that has been changed. */
17219 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17220 last_changed_charpos
= Z
- END_UNCHANGED
;
17222 /* If window starts after a line end, and the last change is in
17223 front of that newline, then changes don't affect the display.
17224 This case happens with stealth-fontification. Note that although
17225 the display is unchanged, glyph positions in the matrix have to
17226 be adjusted, of course. */
17227 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17228 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17229 && ((last_changed_charpos
< CHARPOS (start
)
17230 && CHARPOS (start
) == BEGV
)
17231 || (last_changed_charpos
< CHARPOS (start
) - 1
17232 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17234 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17235 struct glyph_row
*r0
;
17237 /* Compute how many chars/bytes have been added to or removed
17238 from the buffer. */
17239 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17240 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17241 Z_delta
= Z
- Z_old
;
17242 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17244 /* Give up if PT is not in the window. Note that it already has
17245 been checked at the start of try_window_id that PT is not in
17246 front of the window start. */
17247 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17250 /* If window start is unchanged, we can reuse the whole matrix
17251 as is, after adjusting glyph positions. No need to compute
17252 the window end again, since its offset from Z hasn't changed. */
17253 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17254 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17255 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17256 /* PT must not be in a partially visible line. */
17257 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17258 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17260 /* Adjust positions in the glyph matrix. */
17261 if (Z_delta
|| Z_delta_bytes
)
17263 struct glyph_row
*r1
17264 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17265 increment_matrix_positions (w
->current_matrix
,
17266 MATRIX_ROW_VPOS (r0
, current_matrix
),
17267 MATRIX_ROW_VPOS (r1
, current_matrix
),
17268 Z_delta
, Z_delta_bytes
);
17271 /* Set the cursor. */
17272 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17274 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17281 /* Handle the case that changes are all below what is displayed in
17282 the window, and that PT is in the window. This shortcut cannot
17283 be taken if ZV is visible in the window, and text has been added
17284 there that is visible in the window. */
17285 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17286 /* ZV is not visible in the window, or there are no
17287 changes at ZV, actually. */
17288 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17289 || first_changed_charpos
== last_changed_charpos
))
17291 struct glyph_row
*r0
;
17293 /* Give up if PT is not in the window. Note that it already has
17294 been checked at the start of try_window_id that PT is not in
17295 front of the window start. */
17296 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17299 /* If window start is unchanged, we can reuse the whole matrix
17300 as is, without changing glyph positions since no text has
17301 been added/removed in front of the window end. */
17302 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17303 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17304 /* PT must not be in a partially visible line. */
17305 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17306 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17308 /* We have to compute the window end anew since text
17309 could have been added/removed after it. */
17310 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17311 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17313 /* Set the cursor. */
17314 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17316 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17323 /* Give up if window start is in the changed area.
17325 The condition used to read
17327 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17329 but why that was tested escapes me at the moment. */
17330 if (CHARPOS (start
) >= first_changed_charpos
17331 && CHARPOS (start
) <= last_changed_charpos
)
17334 /* Check that window start agrees with the start of the first glyph
17335 row in its current matrix. Check this after we know the window
17336 start is not in changed text, otherwise positions would not be
17338 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17339 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17342 /* Give up if the window ends in strings. Overlay strings
17343 at the end are difficult to handle, so don't try. */
17344 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
17345 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17348 /* Compute the position at which we have to start displaying new
17349 lines. Some of the lines at the top of the window might be
17350 reusable because they are not displaying changed text. Find the
17351 last row in W's current matrix not affected by changes at the
17352 start of current_buffer. Value is null if changes start in the
17353 first line of window. */
17354 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17355 if (last_unchanged_at_beg_row
)
17357 /* Avoid starting to display in the middle of a character, a TAB
17358 for instance. This is easier than to set up the iterator
17359 exactly, and it's not a frequent case, so the additional
17360 effort wouldn't really pay off. */
17361 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17362 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17363 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17364 --last_unchanged_at_beg_row
;
17366 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17369 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17371 start_pos
= it
.current
.pos
;
17373 /* Start displaying new lines in the desired matrix at the same
17374 vpos we would use in the current matrix, i.e. below
17375 last_unchanged_at_beg_row. */
17376 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17378 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17379 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17381 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17385 /* There are no reusable lines at the start of the window.
17386 Start displaying in the first text line. */
17387 start_display (&it
, w
, start
);
17388 it
.vpos
= it
.first_vpos
;
17389 start_pos
= it
.current
.pos
;
17392 /* Find the first row that is not affected by changes at the end of
17393 the buffer. Value will be null if there is no unchanged row, in
17394 which case we must redisplay to the end of the window. delta
17395 will be set to the value by which buffer positions beginning with
17396 first_unchanged_at_end_row have to be adjusted due to text
17398 first_unchanged_at_end_row
17399 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17400 IF_DEBUG (debug_delta
= delta
);
17401 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17403 /* Set stop_pos to the buffer position up to which we will have to
17404 display new lines. If first_unchanged_at_end_row != NULL, this
17405 is the buffer position of the start of the line displayed in that
17406 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17407 that we don't stop at a buffer position. */
17409 if (first_unchanged_at_end_row
)
17411 eassert (last_unchanged_at_beg_row
== NULL
17412 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17414 /* If this is a continuation line, move forward to the next one
17415 that isn't. Changes in lines above affect this line.
17416 Caution: this may move first_unchanged_at_end_row to a row
17417 not displaying text. */
17418 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17419 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17420 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17421 < it
.last_visible_y
))
17422 ++first_unchanged_at_end_row
;
17424 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17425 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17426 >= it
.last_visible_y
))
17427 first_unchanged_at_end_row
= NULL
;
17430 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17432 first_unchanged_at_end_vpos
17433 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17434 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17437 else if (last_unchanged_at_beg_row
== NULL
)
17443 /* Either there is no unchanged row at the end, or the one we have
17444 now displays text. This is a necessary condition for the window
17445 end pos calculation at the end of this function. */
17446 eassert (first_unchanged_at_end_row
== NULL
17447 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17449 debug_last_unchanged_at_beg_vpos
17450 = (last_unchanged_at_beg_row
17451 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17453 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17455 #endif /* GLYPH_DEBUG */
17458 /* Display new lines. Set last_text_row to the last new line
17459 displayed which has text on it, i.e. might end up as being the
17460 line where the window_end_vpos is. */
17461 w
->cursor
.vpos
= -1;
17462 last_text_row
= NULL
;
17463 overlay_arrow_seen
= 0;
17464 while (it
.current_y
< it
.last_visible_y
17465 && !fonts_changed_p
17466 && (first_unchanged_at_end_row
== NULL
17467 || IT_CHARPOS (it
) < stop_pos
))
17469 if (display_line (&it
))
17470 last_text_row
= it
.glyph_row
- 1;
17473 if (fonts_changed_p
)
17477 /* Compute differences in buffer positions, y-positions etc. for
17478 lines reused at the bottom of the window. Compute what we can
17480 if (first_unchanged_at_end_row
17481 /* No lines reused because we displayed everything up to the
17482 bottom of the window. */
17483 && it
.current_y
< it
.last_visible_y
)
17486 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17488 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17489 run
.current_y
= first_unchanged_at_end_row
->y
;
17490 run
.desired_y
= run
.current_y
+ dy
;
17491 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17495 delta
= delta_bytes
= dvpos
= dy
17496 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17497 first_unchanged_at_end_row
= NULL
;
17499 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17502 /* Find the cursor if not already found. We have to decide whether
17503 PT will appear on this window (it sometimes doesn't, but this is
17504 not a very frequent case.) This decision has to be made before
17505 the current matrix is altered. A value of cursor.vpos < 0 means
17506 that PT is either in one of the lines beginning at
17507 first_unchanged_at_end_row or below the window. Don't care for
17508 lines that might be displayed later at the window end; as
17509 mentioned, this is not a frequent case. */
17510 if (w
->cursor
.vpos
< 0)
17512 /* Cursor in unchanged rows at the top? */
17513 if (PT
< CHARPOS (start_pos
)
17514 && last_unchanged_at_beg_row
)
17516 row
= row_containing_pos (w
, PT
,
17517 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17518 last_unchanged_at_beg_row
+ 1, 0);
17520 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17523 /* Start from first_unchanged_at_end_row looking for PT. */
17524 else if (first_unchanged_at_end_row
)
17526 row
= row_containing_pos (w
, PT
- delta
,
17527 first_unchanged_at_end_row
, NULL
, 0);
17529 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17530 delta_bytes
, dy
, dvpos
);
17533 /* Give up if cursor was not found. */
17534 if (w
->cursor
.vpos
< 0)
17536 clear_glyph_matrix (w
->desired_matrix
);
17541 /* Don't let the cursor end in the scroll margins. */
17543 int this_scroll_margin
, cursor_height
;
17544 int frame_line_height
= default_line_pixel_height (w
);
17545 int window_total_lines
17546 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
17548 this_scroll_margin
=
17549 max (0, min (scroll_margin
, window_total_lines
/ 4));
17550 this_scroll_margin
*= frame_line_height
;
17551 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17553 if ((w
->cursor
.y
< this_scroll_margin
17554 && CHARPOS (start
) > BEGV
)
17555 /* Old redisplay didn't take scroll margin into account at the bottom,
17556 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17557 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17558 ? cursor_height
+ this_scroll_margin
17559 : 1)) > it
.last_visible_y
)
17561 w
->cursor
.vpos
= -1;
17562 clear_glyph_matrix (w
->desired_matrix
);
17567 /* Scroll the display. Do it before changing the current matrix so
17568 that xterm.c doesn't get confused about where the cursor glyph is
17570 if (dy
&& run
.height
)
17574 if (FRAME_WINDOW_P (f
))
17576 FRAME_RIF (f
)->update_window_begin_hook (w
);
17577 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17578 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17579 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17583 /* Terminal frame. In this case, dvpos gives the number of
17584 lines to scroll by; dvpos < 0 means scroll up. */
17586 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17587 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17588 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17589 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17590 + window_internal_height (w
));
17592 #if defined (HAVE_GPM) || defined (MSDOS)
17593 x_clear_window_mouse_face (w
);
17595 /* Perform the operation on the screen. */
17598 /* Scroll last_unchanged_at_beg_row to the end of the
17599 window down dvpos lines. */
17600 set_terminal_window (f
, end
);
17602 /* On dumb terminals delete dvpos lines at the end
17603 before inserting dvpos empty lines. */
17604 if (!FRAME_SCROLL_REGION_OK (f
))
17605 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17607 /* Insert dvpos empty lines in front of
17608 last_unchanged_at_beg_row. */
17609 ins_del_lines (f
, from
, dvpos
);
17611 else if (dvpos
< 0)
17613 /* Scroll up last_unchanged_at_beg_vpos to the end of
17614 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17615 set_terminal_window (f
, end
);
17617 /* Delete dvpos lines in front of
17618 last_unchanged_at_beg_vpos. ins_del_lines will set
17619 the cursor to the given vpos and emit |dvpos| delete
17621 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17623 /* On a dumb terminal insert dvpos empty lines at the
17625 if (!FRAME_SCROLL_REGION_OK (f
))
17626 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17629 set_terminal_window (f
, 0);
17635 /* Shift reused rows of the current matrix to the right position.
17636 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17638 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17639 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17642 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17643 bottom_vpos
, dvpos
);
17644 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17647 else if (dvpos
> 0)
17649 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17650 bottom_vpos
, dvpos
);
17651 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17652 first_unchanged_at_end_vpos
+ dvpos
);
17655 /* For frame-based redisplay, make sure that current frame and window
17656 matrix are in sync with respect to glyph memory. */
17657 if (!FRAME_WINDOW_P (f
))
17658 sync_frame_with_window_matrix_rows (w
);
17660 /* Adjust buffer positions in reused rows. */
17661 if (delta
|| delta_bytes
)
17662 increment_matrix_positions (current_matrix
,
17663 first_unchanged_at_end_vpos
+ dvpos
,
17664 bottom_vpos
, delta
, delta_bytes
);
17666 /* Adjust Y positions. */
17668 shift_glyph_matrix (w
, current_matrix
,
17669 first_unchanged_at_end_vpos
+ dvpos
,
17672 if (first_unchanged_at_end_row
)
17674 first_unchanged_at_end_row
+= dvpos
;
17675 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17676 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17677 first_unchanged_at_end_row
= NULL
;
17680 /* If scrolling up, there may be some lines to display at the end of
17682 last_text_row_at_end
= NULL
;
17685 /* Scrolling up can leave for example a partially visible line
17686 at the end of the window to be redisplayed. */
17687 /* Set last_row to the glyph row in the current matrix where the
17688 window end line is found. It has been moved up or down in
17689 the matrix by dvpos. */
17690 int last_vpos
= w
->window_end_vpos
+ dvpos
;
17691 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17693 /* If last_row is the window end line, it should display text. */
17694 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
17696 /* If window end line was partially visible before, begin
17697 displaying at that line. Otherwise begin displaying with the
17698 line following it. */
17699 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17701 init_to_row_start (&it
, w
, last_row
);
17702 it
.vpos
= last_vpos
;
17703 it
.current_y
= last_row
->y
;
17707 init_to_row_end (&it
, w
, last_row
);
17708 it
.vpos
= 1 + last_vpos
;
17709 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17713 /* We may start in a continuation line. If so, we have to
17714 get the right continuation_lines_width and current_x. */
17715 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17716 it
.hpos
= it
.current_x
= 0;
17718 /* Display the rest of the lines at the window end. */
17719 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17720 while (it
.current_y
< it
.last_visible_y
17721 && !fonts_changed_p
)
17723 /* Is it always sure that the display agrees with lines in
17724 the current matrix? I don't think so, so we mark rows
17725 displayed invalid in the current matrix by setting their
17726 enabled_p flag to zero. */
17727 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17728 if (display_line (&it
))
17729 last_text_row_at_end
= it
.glyph_row
- 1;
17733 /* Update window_end_pos and window_end_vpos. */
17734 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
17736 /* Window end line if one of the preserved rows from the current
17737 matrix. Set row to the last row displaying text in current
17738 matrix starting at first_unchanged_at_end_row, after
17740 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17741 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17742 first_unchanged_at_end_row
);
17743 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17744 adjust_window_ends (w
, row
, 1);
17745 eassert (w
->window_end_bytepos
>= 0);
17746 IF_DEBUG (debug_method_add (w
, "A"));
17748 else if (last_text_row_at_end
)
17750 adjust_window_ends (w
, last_text_row_at_end
, 0);
17751 eassert (w
->window_end_bytepos
>= 0);
17752 IF_DEBUG (debug_method_add (w
, "B"));
17754 else if (last_text_row
)
17756 /* We have displayed either to the end of the window or at the
17757 end of the window, i.e. the last row with text is to be found
17758 in the desired matrix. */
17759 adjust_window_ends (w
, last_text_row
, 0);
17760 eassert (w
->window_end_bytepos
>= 0);
17762 else if (first_unchanged_at_end_row
== NULL
17763 && last_text_row
== NULL
17764 && last_text_row_at_end
== NULL
)
17766 /* Displayed to end of window, but no line containing text was
17767 displayed. Lines were deleted at the end of the window. */
17768 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17769 int vpos
= w
->window_end_vpos
;
17770 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17771 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17774 row
== NULL
&& vpos
>= first_vpos
;
17775 --vpos
, --current_row
, --desired_row
)
17777 if (desired_row
->enabled_p
)
17779 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
17782 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
17786 eassert (row
!= NULL
);
17787 w
->window_end_vpos
= vpos
+ 1;
17788 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17789 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17790 eassert (w
->window_end_bytepos
>= 0);
17791 IF_DEBUG (debug_method_add (w
, "C"));
17796 IF_DEBUG (debug_end_pos
= w
->window_end_pos
;
17797 debug_end_vpos
= w
->window_end_vpos
);
17799 /* Record that display has not been completed. */
17800 w
->window_end_valid
= 0;
17801 w
->desired_matrix
->no_scrolling_p
= 1;
17809 /***********************************************************************
17810 More debugging support
17811 ***********************************************************************/
17815 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17816 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17817 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17820 /* Dump the contents of glyph matrix MATRIX on stderr.
17822 GLYPHS 0 means don't show glyph contents.
17823 GLYPHS 1 means show glyphs in short form
17824 GLYPHS > 1 means show glyphs in long form. */
17827 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17830 for (i
= 0; i
< matrix
->nrows
; ++i
)
17831 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17835 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17836 the glyph row and area where the glyph comes from. */
17839 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17841 if (glyph
->type
== CHAR_GLYPH
17842 || glyph
->type
== GLYPHLESS_GLYPH
)
17845 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
17846 glyph
- row
->glyphs
[TEXT_AREA
],
17847 (glyph
->type
== CHAR_GLYPH
17851 (BUFFERP (glyph
->object
)
17853 : (STRINGP (glyph
->object
)
17855 : (INTEGERP (glyph
->object
)
17858 glyph
->pixel_width
,
17860 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17864 glyph
->left_box_line_p
,
17865 glyph
->right_box_line_p
);
17867 else if (glyph
->type
== STRETCH_GLYPH
)
17870 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
17871 glyph
- row
->glyphs
[TEXT_AREA
],
17874 (BUFFERP (glyph
->object
)
17876 : (STRINGP (glyph
->object
)
17878 : (INTEGERP (glyph
->object
)
17881 glyph
->pixel_width
,
17885 glyph
->left_box_line_p
,
17886 glyph
->right_box_line_p
);
17888 else if (glyph
->type
== IMAGE_GLYPH
)
17891 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
17892 glyph
- row
->glyphs
[TEXT_AREA
],
17895 (BUFFERP (glyph
->object
)
17897 : (STRINGP (glyph
->object
)
17899 : (INTEGERP (glyph
->object
)
17902 glyph
->pixel_width
,
17906 glyph
->left_box_line_p
,
17907 glyph
->right_box_line_p
);
17909 else if (glyph
->type
== COMPOSITE_GLYPH
)
17912 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
17913 glyph
- row
->glyphs
[TEXT_AREA
],
17916 (BUFFERP (glyph
->object
)
17918 : (STRINGP (glyph
->object
)
17920 : (INTEGERP (glyph
->object
)
17923 glyph
->pixel_width
,
17925 if (glyph
->u
.cmp
.automatic
)
17928 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17929 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17931 glyph
->left_box_line_p
,
17932 glyph
->right_box_line_p
);
17937 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17938 GLYPHS 0 means don't show glyph contents.
17939 GLYPHS 1 means show glyphs in short form
17940 GLYPHS > 1 means show glyphs in long form. */
17943 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17947 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17948 fprintf (stderr
, "==============================================================================\n");
17950 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17951 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17953 MATRIX_ROW_START_CHARPOS (row
),
17954 MATRIX_ROW_END_CHARPOS (row
),
17955 row
->used
[TEXT_AREA
],
17956 row
->contains_overlapping_glyphs_p
,
17958 row
->truncated_on_left_p
,
17959 row
->truncated_on_right_p
,
17961 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17962 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
17965 row
->ends_in_middle_of_char_p
,
17966 row
->starts_in_middle_of_char_p
,
17972 row
->visible_height
,
17975 /* The next 3 lines should align to "Start" in the header. */
17976 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
17977 row
->end
.overlay_string_index
,
17978 row
->continuation_lines_width
);
17979 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
17980 CHARPOS (row
->start
.string_pos
),
17981 CHARPOS (row
->end
.string_pos
));
17982 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
17983 row
->end
.dpvec_index
);
17990 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17992 struct glyph
*glyph
= row
->glyphs
[area
];
17993 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17995 /* Glyph for a line end in text. */
17996 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17999 if (glyph
< glyph_end
)
18000 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18002 for (; glyph
< glyph_end
; ++glyph
)
18003 dump_glyph (row
, glyph
, area
);
18006 else if (glyphs
== 1)
18010 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18012 char *s
= alloca (row
->used
[area
] + 4);
18015 for (i
= 0; i
< row
->used
[area
]; ++i
)
18017 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18018 if (i
== row
->used
[area
] - 1
18019 && area
== TEXT_AREA
18020 && INTEGERP (glyph
->object
)
18021 && glyph
->type
== CHAR_GLYPH
18022 && glyph
->u
.ch
== ' ')
18024 strcpy (&s
[i
], "[\\n]");
18027 else if (glyph
->type
== CHAR_GLYPH
18028 && glyph
->u
.ch
< 0x80
18029 && glyph
->u
.ch
>= ' ')
18030 s
[i
] = glyph
->u
.ch
;
18036 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18042 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18043 Sdump_glyph_matrix
, 0, 1, "p",
18044 doc
: /* Dump the current matrix of the selected window to stderr.
18045 Shows contents of glyph row structures. With non-nil
18046 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18047 glyphs in short form, otherwise show glyphs in long form. */)
18048 (Lisp_Object glyphs
)
18050 struct window
*w
= XWINDOW (selected_window
);
18051 struct buffer
*buffer
= XBUFFER (w
->contents
);
18053 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18054 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18055 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18056 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18057 fprintf (stderr
, "=============================================\n");
18058 dump_glyph_matrix (w
->current_matrix
,
18059 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18064 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18065 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18068 struct frame
*f
= XFRAME (selected_frame
);
18069 dump_glyph_matrix (f
->current_matrix
, 1);
18074 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18075 doc
: /* Dump glyph row ROW to stderr.
18076 GLYPH 0 means don't dump glyphs.
18077 GLYPH 1 means dump glyphs in short form.
18078 GLYPH > 1 or omitted means dump glyphs in long form. */)
18079 (Lisp_Object row
, Lisp_Object glyphs
)
18081 struct glyph_matrix
*matrix
;
18084 CHECK_NUMBER (row
);
18085 matrix
= XWINDOW (selected_window
)->current_matrix
;
18087 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18088 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18090 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18095 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18096 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18097 GLYPH 0 means don't dump glyphs.
18098 GLYPH 1 means dump glyphs in short form.
18099 GLYPH > 1 or omitted means dump glyphs in long form. */)
18100 (Lisp_Object row
, Lisp_Object glyphs
)
18102 struct frame
*sf
= SELECTED_FRAME ();
18103 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18106 CHECK_NUMBER (row
);
18108 if (vpos
>= 0 && vpos
< m
->nrows
)
18109 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18110 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18115 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18116 doc
: /* Toggle tracing of redisplay.
18117 With ARG, turn tracing on if and only if ARG is positive. */)
18121 trace_redisplay_p
= !trace_redisplay_p
;
18124 arg
= Fprefix_numeric_value (arg
);
18125 trace_redisplay_p
= XINT (arg
) > 0;
18132 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18133 doc
: /* Like `format', but print result to stderr.
18134 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18135 (ptrdiff_t nargs
, Lisp_Object
*args
)
18137 Lisp_Object s
= Fformat (nargs
, args
);
18138 fprintf (stderr
, "%s", SDATA (s
));
18142 #endif /* GLYPH_DEBUG */
18146 /***********************************************************************
18147 Building Desired Matrix Rows
18148 ***********************************************************************/
18150 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18151 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18153 static struct glyph_row
*
18154 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18156 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18157 struct buffer
*buffer
= XBUFFER (w
->contents
);
18158 struct buffer
*old
= current_buffer
;
18159 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18160 int arrow_len
= SCHARS (overlay_arrow_string
);
18161 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18162 const unsigned char *p
;
18165 int n_glyphs_before
;
18167 set_buffer_temp (buffer
);
18168 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18169 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18170 SET_TEXT_POS (it
.position
, 0, 0);
18172 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18174 while (p
< arrow_end
)
18176 Lisp_Object face
, ilisp
;
18178 /* Get the next character. */
18180 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18183 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18184 if (! ASCII_CHAR_P (it
.c
))
18185 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18189 /* Get its face. */
18190 ilisp
= make_number (p
- arrow_string
);
18191 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18192 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18194 /* Compute its width, get its glyphs. */
18195 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18196 SET_TEXT_POS (it
.position
, -1, -1);
18197 PRODUCE_GLYPHS (&it
);
18199 /* If this character doesn't fit any more in the line, we have
18200 to remove some glyphs. */
18201 if (it
.current_x
> it
.last_visible_x
)
18203 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18208 set_buffer_temp (old
);
18209 return it
.glyph_row
;
18213 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18214 glyphs to insert is determined by produce_special_glyphs. */
18217 insert_left_trunc_glyphs (struct it
*it
)
18219 struct it truncate_it
;
18220 struct glyph
*from
, *end
, *to
, *toend
;
18222 eassert (!FRAME_WINDOW_P (it
->f
)
18223 || (!it
->glyph_row
->reversed_p
18224 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18225 || (it
->glyph_row
->reversed_p
18226 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18228 /* Get the truncation glyphs. */
18230 truncate_it
.current_x
= 0;
18231 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18232 truncate_it
.glyph_row
= &scratch_glyph_row
;
18233 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18234 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18235 truncate_it
.object
= make_number (0);
18236 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18238 /* Overwrite glyphs from IT with truncation glyphs. */
18239 if (!it
->glyph_row
->reversed_p
)
18241 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18243 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18244 end
= from
+ tused
;
18245 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18246 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18247 if (FRAME_WINDOW_P (it
->f
))
18249 /* On GUI frames, when variable-size fonts are displayed,
18250 the truncation glyphs may need more pixels than the row's
18251 glyphs they overwrite. We overwrite more glyphs to free
18252 enough screen real estate, and enlarge the stretch glyph
18253 on the right (see display_line), if there is one, to
18254 preserve the screen position of the truncation glyphs on
18257 struct glyph
*g
= to
;
18260 /* The first glyph could be partially visible, in which case
18261 it->glyph_row->x will be negative. But we want the left
18262 truncation glyphs to be aligned at the left margin of the
18263 window, so we override the x coordinate at which the row
18265 it
->glyph_row
->x
= 0;
18266 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18268 w
+= g
->pixel_width
;
18271 if (g
- to
- tused
> 0)
18273 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18274 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18276 used
= it
->glyph_row
->used
[TEXT_AREA
];
18277 if (it
->glyph_row
->truncated_on_right_p
18278 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18279 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18282 int extra
= w
- it
->truncation_pixel_width
;
18284 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18291 /* There may be padding glyphs left over. Overwrite them too. */
18292 if (!FRAME_WINDOW_P (it
->f
))
18294 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18296 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18303 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18307 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18309 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18310 that back to front. */
18311 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18312 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18313 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18314 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18315 if (FRAME_WINDOW_P (it
->f
))
18318 struct glyph
*g
= to
;
18320 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18322 w
+= g
->pixel_width
;
18325 if (to
- g
- tused
> 0)
18327 if (it
->glyph_row
->truncated_on_right_p
18328 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18329 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18331 int extra
= w
- it
->truncation_pixel_width
;
18333 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18337 while (from
>= end
&& to
>= toend
)
18339 if (!FRAME_WINDOW_P (it
->f
))
18341 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18344 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18345 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18346 while (from
>= end
&& to
>= toend
)
18352 /* Need to free some room before prepending additional
18354 int move_by
= from
- end
+ 1;
18355 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18356 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18358 for ( ; g
>= g0
; g
--)
18360 while (from
>= end
)
18362 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18367 /* Compute the hash code for ROW. */
18369 row_hash (struct glyph_row
*row
)
18372 unsigned hashval
= 0;
18374 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18375 for (k
= 0; k
< row
->used
[area
]; ++k
)
18376 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18377 + row
->glyphs
[area
][k
].u
.val
18378 + row
->glyphs
[area
][k
].face_id
18379 + row
->glyphs
[area
][k
].padding_p
18380 + (row
->glyphs
[area
][k
].type
<< 2));
18385 /* Compute the pixel height and width of IT->glyph_row.
18387 Most of the time, ascent and height of a display line will be equal
18388 to the max_ascent and max_height values of the display iterator
18389 structure. This is not the case if
18391 1. We hit ZV without displaying anything. In this case, max_ascent
18392 and max_height will be zero.
18394 2. We have some glyphs that don't contribute to the line height.
18395 (The glyph row flag contributes_to_line_height_p is for future
18396 pixmap extensions).
18398 The first case is easily covered by using default values because in
18399 these cases, the line height does not really matter, except that it
18400 must not be zero. */
18403 compute_line_metrics (struct it
*it
)
18405 struct glyph_row
*row
= it
->glyph_row
;
18407 if (FRAME_WINDOW_P (it
->f
))
18409 int i
, min_y
, max_y
;
18411 /* The line may consist of one space only, that was added to
18412 place the cursor on it. If so, the row's height hasn't been
18414 if (row
->height
== 0)
18416 if (it
->max_ascent
+ it
->max_descent
== 0)
18417 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18418 row
->ascent
= it
->max_ascent
;
18419 row
->height
= it
->max_ascent
+ it
->max_descent
;
18420 row
->phys_ascent
= it
->max_phys_ascent
;
18421 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18422 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18425 /* Compute the width of this line. */
18426 row
->pixel_width
= row
->x
;
18427 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18428 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18430 eassert (row
->pixel_width
>= 0);
18431 eassert (row
->ascent
>= 0 && row
->height
> 0);
18433 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18434 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18436 /* If first line's physical ascent is larger than its logical
18437 ascent, use the physical ascent, and make the row taller.
18438 This makes accented characters fully visible. */
18439 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18440 && row
->phys_ascent
> row
->ascent
)
18442 row
->height
+= row
->phys_ascent
- row
->ascent
;
18443 row
->ascent
= row
->phys_ascent
;
18446 /* Compute how much of the line is visible. */
18447 row
->visible_height
= row
->height
;
18449 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18450 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18452 if (row
->y
< min_y
)
18453 row
->visible_height
-= min_y
- row
->y
;
18454 if (row
->y
+ row
->height
> max_y
)
18455 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18459 row
->pixel_width
= row
->used
[TEXT_AREA
];
18460 if (row
->continued_p
)
18461 row
->pixel_width
-= it
->continuation_pixel_width
;
18462 else if (row
->truncated_on_right_p
)
18463 row
->pixel_width
-= it
->truncation_pixel_width
;
18464 row
->ascent
= row
->phys_ascent
= 0;
18465 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18466 row
->extra_line_spacing
= 0;
18469 /* Compute a hash code for this row. */
18470 row
->hash
= row_hash (row
);
18472 it
->max_ascent
= it
->max_descent
= 0;
18473 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18477 /* Append one space to the glyph row of iterator IT if doing a
18478 window-based redisplay. The space has the same face as
18479 IT->face_id. Value is non-zero if a space was added.
18481 This function is called to make sure that there is always one glyph
18482 at the end of a glyph row that the cursor can be set on under
18483 window-systems. (If there weren't such a glyph we would not know
18484 how wide and tall a box cursor should be displayed).
18486 At the same time this space let's a nicely handle clearing to the
18487 end of the line if the row ends in italic text. */
18490 append_space_for_newline (struct it
*it
, int default_face_p
)
18492 if (FRAME_WINDOW_P (it
->f
))
18494 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18496 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18497 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18499 /* Save some values that must not be changed.
18500 Must save IT->c and IT->len because otherwise
18501 ITERATOR_AT_END_P wouldn't work anymore after
18502 append_space_for_newline has been called. */
18503 enum display_element_type saved_what
= it
->what
;
18504 int saved_c
= it
->c
, saved_len
= it
->len
;
18505 int saved_char_to_display
= it
->char_to_display
;
18506 int saved_x
= it
->current_x
;
18507 int saved_face_id
= it
->face_id
;
18508 int saved_box_end
= it
->end_of_box_run_p
;
18509 struct text_pos saved_pos
;
18510 Lisp_Object saved_object
;
18513 saved_object
= it
->object
;
18514 saved_pos
= it
->position
;
18516 it
->what
= IT_CHARACTER
;
18517 memset (&it
->position
, 0, sizeof it
->position
);
18518 it
->object
= make_number (0);
18519 it
->c
= it
->char_to_display
= ' ';
18522 /* If the default face was remapped, be sure to use the
18523 remapped face for the appended newline. */
18524 if (default_face_p
)
18525 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18526 else if (it
->face_before_selective_p
)
18527 it
->face_id
= it
->saved_face_id
;
18528 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18529 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18530 /* In R2L rows, we will prepend a stretch glyph that will
18531 have the end_of_box_run_p flag set for it, so there's no
18532 need for the appended newline glyph to have that flag
18534 if (it
->glyph_row
->reversed_p
18535 /* But if the appended newline glyph goes all the way to
18536 the end of the row, there will be no stretch glyph,
18537 so leave the box flag set. */
18538 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
18539 it
->end_of_box_run_p
= 0;
18541 PRODUCE_GLYPHS (it
);
18543 it
->override_ascent
= -1;
18544 it
->constrain_row_ascent_descent_p
= 0;
18545 it
->current_x
= saved_x
;
18546 it
->object
= saved_object
;
18547 it
->position
= saved_pos
;
18548 it
->what
= saved_what
;
18549 it
->face_id
= saved_face_id
;
18550 it
->len
= saved_len
;
18552 it
->char_to_display
= saved_char_to_display
;
18553 it
->end_of_box_run_p
= saved_box_end
;
18562 /* Extend the face of the last glyph in the text area of IT->glyph_row
18563 to the end of the display line. Called from display_line. If the
18564 glyph row is empty, add a space glyph to it so that we know the
18565 face to draw. Set the glyph row flag fill_line_p. If the glyph
18566 row is R2L, prepend a stretch glyph to cover the empty space to the
18567 left of the leftmost glyph. */
18570 extend_face_to_end_of_line (struct it
*it
)
18572 struct face
*face
, *default_face
;
18573 struct frame
*f
= it
->f
;
18575 /* If line is already filled, do nothing. Non window-system frames
18576 get a grace of one more ``pixel'' because their characters are
18577 1-``pixel'' wide, so they hit the equality too early. This grace
18578 is needed only for R2L rows that are not continued, to produce
18579 one extra blank where we could display the cursor. */
18580 if (it
->current_x
>= it
->last_visible_x
18581 + (!FRAME_WINDOW_P (f
)
18582 && it
->glyph_row
->reversed_p
18583 && !it
->glyph_row
->continued_p
))
18586 /* The default face, possibly remapped. */
18587 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18589 /* Face extension extends the background and box of IT->face_id
18590 to the end of the line. If the background equals the background
18591 of the frame, we don't have to do anything. */
18592 if (it
->face_before_selective_p
)
18593 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18595 face
= FACE_FROM_ID (f
, it
->face_id
);
18597 if (FRAME_WINDOW_P (f
)
18598 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
18599 && face
->box
== FACE_NO_BOX
18600 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18602 && !it
->glyph_row
->reversed_p
)
18605 /* Set the glyph row flag indicating that the face of the last glyph
18606 in the text area has to be drawn to the end of the text area. */
18607 it
->glyph_row
->fill_line_p
= 1;
18609 /* If current character of IT is not ASCII, make sure we have the
18610 ASCII face. This will be automatically undone the next time
18611 get_next_display_element returns a multibyte character. Note
18612 that the character will always be single byte in unibyte
18614 if (!ASCII_CHAR_P (it
->c
))
18616 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18619 if (FRAME_WINDOW_P (f
))
18621 /* If the row is empty, add a space with the current face of IT,
18622 so that we know which face to draw. */
18623 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18625 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18626 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18627 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18629 #ifdef HAVE_WINDOW_SYSTEM
18630 if (it
->glyph_row
->reversed_p
)
18632 /* Prepend a stretch glyph to the row, such that the
18633 rightmost glyph will be drawn flushed all the way to the
18634 right margin of the window. The stretch glyph that will
18635 occupy the empty space, if any, to the left of the
18637 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18638 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18639 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18641 int row_width
, stretch_ascent
, stretch_width
;
18642 struct text_pos saved_pos
;
18643 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
18645 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18646 row_width
+= g
->pixel_width
;
18647 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18648 if (stretch_width
> 0)
18651 (((it
->ascent
+ it
->descent
)
18652 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18653 saved_pos
= it
->position
;
18654 memset (&it
->position
, 0, sizeof it
->position
);
18655 saved_avoid_cursor
= it
->avoid_cursor_p
;
18656 it
->avoid_cursor_p
= 1;
18657 saved_face_id
= it
->face_id
;
18658 saved_box_start
= it
->start_of_box_run_p
;
18659 /* The last row's stretch glyph should get the default
18660 face, to avoid painting the rest of the window with
18661 the region face, if the region ends at ZV. */
18662 if (it
->glyph_row
->ends_at_zv_p
)
18663 it
->face_id
= default_face
->id
;
18665 it
->face_id
= face
->id
;
18666 it
->start_of_box_run_p
= 0;
18667 append_stretch_glyph (it
, make_number (0), stretch_width
,
18668 it
->ascent
+ it
->descent
, stretch_ascent
);
18669 it
->position
= saved_pos
;
18670 it
->avoid_cursor_p
= saved_avoid_cursor
;
18671 it
->face_id
= saved_face_id
;
18672 it
->start_of_box_run_p
= saved_box_start
;
18675 #endif /* HAVE_WINDOW_SYSTEM */
18679 /* Save some values that must not be changed. */
18680 int saved_x
= it
->current_x
;
18681 struct text_pos saved_pos
;
18682 Lisp_Object saved_object
;
18683 enum display_element_type saved_what
= it
->what
;
18684 int saved_face_id
= it
->face_id
;
18686 saved_object
= it
->object
;
18687 saved_pos
= it
->position
;
18689 it
->what
= IT_CHARACTER
;
18690 memset (&it
->position
, 0, sizeof it
->position
);
18691 it
->object
= make_number (0);
18692 it
->c
= it
->char_to_display
= ' ';
18694 /* The last row's blank glyphs should get the default face, to
18695 avoid painting the rest of the window with the region face,
18696 if the region ends at ZV. */
18697 if (it
->glyph_row
->ends_at_zv_p
)
18698 it
->face_id
= default_face
->id
;
18700 it
->face_id
= face
->id
;
18702 PRODUCE_GLYPHS (it
);
18704 while (it
->current_x
<= it
->last_visible_x
)
18705 PRODUCE_GLYPHS (it
);
18707 /* Don't count these blanks really. It would let us insert a left
18708 truncation glyph below and make us set the cursor on them, maybe. */
18709 it
->current_x
= saved_x
;
18710 it
->object
= saved_object
;
18711 it
->position
= saved_pos
;
18712 it
->what
= saved_what
;
18713 it
->face_id
= saved_face_id
;
18718 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18719 trailing whitespace. */
18722 trailing_whitespace_p (ptrdiff_t charpos
)
18724 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18727 while (bytepos
< ZV_BYTE
18728 && (c
= FETCH_CHAR (bytepos
),
18729 c
== ' ' || c
== '\t'))
18732 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18734 if (bytepos
!= PT_BYTE
)
18741 /* Highlight trailing whitespace, if any, in ROW. */
18744 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18746 int used
= row
->used
[TEXT_AREA
];
18750 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18751 struct glyph
*glyph
= start
+ used
- 1;
18753 if (row
->reversed_p
)
18755 /* Right-to-left rows need to be processed in the opposite
18756 direction, so swap the edge pointers. */
18758 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18761 /* Skip over glyphs inserted to display the cursor at the
18762 end of a line, for extending the face of the last glyph
18763 to the end of the line on terminals, and for truncation
18764 and continuation glyphs. */
18765 if (!row
->reversed_p
)
18767 while (glyph
>= start
18768 && glyph
->type
== CHAR_GLYPH
18769 && INTEGERP (glyph
->object
))
18774 while (glyph
<= start
18775 && glyph
->type
== CHAR_GLYPH
18776 && INTEGERP (glyph
->object
))
18780 /* If last glyph is a space or stretch, and it's trailing
18781 whitespace, set the face of all trailing whitespace glyphs in
18782 IT->glyph_row to `trailing-whitespace'. */
18783 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18784 && BUFFERP (glyph
->object
)
18785 && (glyph
->type
== STRETCH_GLYPH
18786 || (glyph
->type
== CHAR_GLYPH
18787 && glyph
->u
.ch
== ' '))
18788 && trailing_whitespace_p (glyph
->charpos
))
18790 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18794 if (!row
->reversed_p
)
18796 while (glyph
>= start
18797 && BUFFERP (glyph
->object
)
18798 && (glyph
->type
== STRETCH_GLYPH
18799 || (glyph
->type
== CHAR_GLYPH
18800 && glyph
->u
.ch
== ' ')))
18801 (glyph
--)->face_id
= face_id
;
18805 while (glyph
<= start
18806 && BUFFERP (glyph
->object
)
18807 && (glyph
->type
== STRETCH_GLYPH
18808 || (glyph
->type
== CHAR_GLYPH
18809 && glyph
->u
.ch
== ' ')))
18810 (glyph
++)->face_id
= face_id
;
18817 /* Value is non-zero if glyph row ROW should be
18818 considered to hold the buffer position CHARPOS. */
18821 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
18825 if (charpos
== CHARPOS (row
->end
.pos
)
18826 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
18828 /* Suppose the row ends on a string.
18829 Unless the row is continued, that means it ends on a newline
18830 in the string. If it's anything other than a display string
18831 (e.g., a before-string from an overlay), we don't want the
18832 cursor there. (This heuristic seems to give the optimal
18833 behavior for the various types of multi-line strings.)
18834 One exception: if the string has `cursor' property on one of
18835 its characters, we _do_ want the cursor there. */
18836 if (CHARPOS (row
->end
.string_pos
) >= 0)
18838 if (row
->continued_p
)
18842 /* Check for `display' property. */
18843 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18844 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18845 struct glyph
*glyph
;
18848 for (glyph
= end
; glyph
>= beg
; --glyph
)
18849 if (STRINGP (glyph
->object
))
18852 = Fget_char_property (make_number (charpos
),
18856 && display_prop_string_p (prop
, glyph
->object
));
18857 /* If there's a `cursor' property on one of the
18858 string's characters, this row is a cursor row,
18859 even though this is not a display string. */
18862 Lisp_Object s
= glyph
->object
;
18864 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18866 ptrdiff_t gpos
= glyph
->charpos
;
18868 if (!NILP (Fget_char_property (make_number (gpos
),
18880 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18882 /* If the row ends in middle of a real character,
18883 and the line is continued, we want the cursor here.
18884 That's because CHARPOS (ROW->end.pos) would equal
18885 PT if PT is before the character. */
18886 if (!row
->ends_in_ellipsis_p
)
18887 result
= row
->continued_p
;
18889 /* If the row ends in an ellipsis, then
18890 CHARPOS (ROW->end.pos) will equal point after the
18891 invisible text. We want that position to be displayed
18892 after the ellipsis. */
18895 /* If the row ends at ZV, display the cursor at the end of that
18896 row instead of at the start of the row below. */
18897 else if (row
->ends_at_zv_p
)
18906 /* Value is non-zero if glyph row ROW should be
18907 used to hold the cursor. */
18910 cursor_row_p (struct glyph_row
*row
)
18912 return row_for_charpos_p (row
, PT
);
18917 /* Push the property PROP so that it will be rendered at the current
18918 position in IT. Return 1 if PROP was successfully pushed, 0
18919 otherwise. Called from handle_line_prefix to handle the
18920 `line-prefix' and `wrap-prefix' properties. */
18923 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18925 struct text_pos pos
=
18926 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18928 eassert (it
->method
== GET_FROM_BUFFER
18929 || it
->method
== GET_FROM_DISPLAY_VECTOR
18930 || it
->method
== GET_FROM_STRING
);
18932 /* We need to save the current buffer/string position, so it will be
18933 restored by pop_it, because iterate_out_of_display_property
18934 depends on that being set correctly, but some situations leave
18935 it->position not yet set when this function is called. */
18936 push_it (it
, &pos
);
18938 if (STRINGP (prop
))
18940 if (SCHARS (prop
) == 0)
18947 it
->string_from_prefix_prop_p
= 1;
18948 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18949 it
->current
.overlay_string_index
= -1;
18950 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18951 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18952 it
->method
= GET_FROM_STRING
;
18953 it
->stop_charpos
= 0;
18955 it
->base_level_stop
= 0;
18957 /* Force paragraph direction to be that of the parent
18959 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18960 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18962 it
->paragraph_embedding
= L2R
;
18964 /* Set up the bidi iterator for this display string. */
18967 it
->bidi_it
.string
.lstring
= it
->string
;
18968 it
->bidi_it
.string
.s
= NULL
;
18969 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18970 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18971 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18972 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18973 it
->bidi_it
.w
= it
->w
;
18974 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18977 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18979 it
->method
= GET_FROM_STRETCH
;
18982 #ifdef HAVE_WINDOW_SYSTEM
18983 else if (IMAGEP (prop
))
18985 it
->what
= IT_IMAGE
;
18986 it
->image_id
= lookup_image (it
->f
, prop
);
18987 it
->method
= GET_FROM_IMAGE
;
18989 #endif /* HAVE_WINDOW_SYSTEM */
18992 pop_it (it
); /* bogus display property, give up */
18999 /* Return the character-property PROP at the current position in IT. */
19002 get_it_property (struct it
*it
, Lisp_Object prop
)
19004 Lisp_Object position
, object
= it
->object
;
19006 if (STRINGP (object
))
19007 position
= make_number (IT_STRING_CHARPOS (*it
));
19008 else if (BUFFERP (object
))
19010 position
= make_number (IT_CHARPOS (*it
));
19011 object
= it
->window
;
19016 return Fget_char_property (position
, prop
, object
);
19019 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19022 handle_line_prefix (struct it
*it
)
19024 Lisp_Object prefix
;
19026 if (it
->continuation_lines_width
> 0)
19028 prefix
= get_it_property (it
, Qwrap_prefix
);
19030 prefix
= Vwrap_prefix
;
19034 prefix
= get_it_property (it
, Qline_prefix
);
19036 prefix
= Vline_prefix
;
19038 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19040 /* If the prefix is wider than the window, and we try to wrap
19041 it, it would acquire its own wrap prefix, and so on till the
19042 iterator stack overflows. So, don't wrap the prefix. */
19043 it
->line_wrap
= TRUNCATE
;
19044 it
->avoid_cursor_p
= 1;
19050 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19051 only for R2L lines from display_line and display_string, when they
19052 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19053 the line/string needs to be continued on the next glyph row. */
19055 unproduce_glyphs (struct it
*it
, int n
)
19057 struct glyph
*glyph
, *end
;
19059 eassert (it
->glyph_row
);
19060 eassert (it
->glyph_row
->reversed_p
);
19061 eassert (it
->area
== TEXT_AREA
);
19062 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19064 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19065 n
= it
->glyph_row
->used
[TEXT_AREA
];
19066 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19067 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19068 for ( ; glyph
< end
; glyph
++)
19069 glyph
[-n
] = *glyph
;
19072 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19073 and ROW->maxpos. */
19075 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19076 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19077 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19079 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19080 lines' rows is implemented for bidi-reordered rows. */
19082 /* ROW->minpos is the value of min_pos, the minimal buffer position
19083 we have in ROW, or ROW->start.pos if that is smaller. */
19084 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19085 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19087 /* We didn't find buffer positions smaller than ROW->start, or
19088 didn't find _any_ valid buffer positions in any of the glyphs,
19089 so we must trust the iterator's computed positions. */
19090 row
->minpos
= row
->start
.pos
;
19093 max_pos
= CHARPOS (it
->current
.pos
);
19094 max_bpos
= BYTEPOS (it
->current
.pos
);
19097 /* Here are the various use-cases for ending the row, and the
19098 corresponding values for ROW->maxpos:
19100 Line ends in a newline from buffer eol_pos + 1
19101 Line is continued from buffer max_pos + 1
19102 Line is truncated on right it->current.pos
19103 Line ends in a newline from string max_pos + 1(*)
19104 (*) + 1 only when line ends in a forward scan
19105 Line is continued from string max_pos
19106 Line is continued from display vector max_pos
19107 Line is entirely from a string min_pos == max_pos
19108 Line is entirely from a display vector min_pos == max_pos
19109 Line that ends at ZV ZV
19111 If you discover other use-cases, please add them here as
19113 if (row
->ends_at_zv_p
)
19114 row
->maxpos
= it
->current
.pos
;
19115 else if (row
->used
[TEXT_AREA
])
19117 int seen_this_string
= 0;
19118 struct glyph_row
*r1
= row
- 1;
19120 /* Did we see the same display string on the previous row? */
19121 if (STRINGP (it
->object
)
19122 /* this is not the first row */
19123 && row
> it
->w
->desired_matrix
->rows
19124 /* previous row is not the header line */
19125 && !r1
->mode_line_p
19126 /* previous row also ends in a newline from a string */
19127 && r1
->ends_in_newline_from_string_p
)
19129 struct glyph
*start
, *end
;
19131 /* Search for the last glyph of the previous row that came
19132 from buffer or string. Depending on whether the row is
19133 L2R or R2L, we need to process it front to back or the
19134 other way round. */
19135 if (!r1
->reversed_p
)
19137 start
= r1
->glyphs
[TEXT_AREA
];
19138 end
= start
+ r1
->used
[TEXT_AREA
];
19139 /* Glyphs inserted by redisplay have an integer (zero)
19140 as their object. */
19142 && INTEGERP ((end
- 1)->object
)
19143 && (end
- 1)->charpos
<= 0)
19147 if (EQ ((end
- 1)->object
, it
->object
))
19148 seen_this_string
= 1;
19151 /* If all the glyphs of the previous row were inserted
19152 by redisplay, it means the previous row was
19153 produced from a single newline, which is only
19154 possible if that newline came from the same string
19155 as the one which produced this ROW. */
19156 seen_this_string
= 1;
19160 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19161 start
= end
+ r1
->used
[TEXT_AREA
];
19163 && INTEGERP ((end
+ 1)->object
)
19164 && (end
+ 1)->charpos
<= 0)
19168 if (EQ ((end
+ 1)->object
, it
->object
))
19169 seen_this_string
= 1;
19172 seen_this_string
= 1;
19175 /* Take note of each display string that covers a newline only
19176 once, the first time we see it. This is for when a display
19177 string includes more than one newline in it. */
19178 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19180 /* If we were scanning the buffer forward when we displayed
19181 the string, we want to account for at least one buffer
19182 position that belongs to this row (position covered by
19183 the display string), so that cursor positioning will
19184 consider this row as a candidate when point is at the end
19185 of the visual line represented by this row. This is not
19186 required when scanning back, because max_pos will already
19187 have a much larger value. */
19188 if (CHARPOS (row
->end
.pos
) > max_pos
)
19189 INC_BOTH (max_pos
, max_bpos
);
19190 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19192 else if (CHARPOS (it
->eol_pos
) > 0)
19193 SET_TEXT_POS (row
->maxpos
,
19194 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19195 else if (row
->continued_p
)
19197 /* If max_pos is different from IT's current position, it
19198 means IT->method does not belong to the display element
19199 at max_pos. However, it also means that the display
19200 element at max_pos was displayed in its entirety on this
19201 line, which is equivalent to saying that the next line
19202 starts at the next buffer position. */
19203 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19204 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19207 INC_BOTH (max_pos
, max_bpos
);
19208 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19211 else if (row
->truncated_on_right_p
)
19212 /* display_line already called reseat_at_next_visible_line_start,
19213 which puts the iterator at the beginning of the next line, in
19214 the logical order. */
19215 row
->maxpos
= it
->current
.pos
;
19216 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19217 /* A line that is entirely from a string/image/stretch... */
19218 row
->maxpos
= row
->minpos
;
19223 row
->maxpos
= it
->current
.pos
;
19226 /* Construct the glyph row IT->glyph_row in the desired matrix of
19227 IT->w from text at the current position of IT. See dispextern.h
19228 for an overview of struct it. Value is non-zero if
19229 IT->glyph_row displays text, as opposed to a line displaying ZV
19233 display_line (struct it
*it
)
19235 struct glyph_row
*row
= it
->glyph_row
;
19236 Lisp_Object overlay_arrow_string
;
19238 void *wrap_data
= NULL
;
19239 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19240 int wrap_row_used
= -1;
19241 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19242 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19243 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19244 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19245 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19247 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19248 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19250 /* We always start displaying at hpos zero even if hscrolled. */
19251 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19253 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19254 >= it
->w
->desired_matrix
->nrows
)
19256 it
->w
->nrows_scale_factor
++;
19257 fonts_changed_p
= 1;
19261 /* Is IT->w showing the region? */
19262 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? it
->region_beg_charpos
: 0;
19264 /* Clear the result glyph row and enable it. */
19265 prepare_desired_row (row
);
19267 row
->y
= it
->current_y
;
19268 row
->start
= it
->start
;
19269 row
->continuation_lines_width
= it
->continuation_lines_width
;
19270 row
->displays_text_p
= 1;
19271 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19272 it
->starts_in_middle_of_char_p
= 0;
19274 /* Arrange the overlays nicely for our purposes. Usually, we call
19275 display_line on only one line at a time, in which case this
19276 can't really hurt too much, or we call it on lines which appear
19277 one after another in the buffer, in which case all calls to
19278 recenter_overlay_lists but the first will be pretty cheap. */
19279 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19281 /* Move over display elements that are not visible because we are
19282 hscrolled. This may stop at an x-position < IT->first_visible_x
19283 if the first glyph is partially visible or if we hit a line end. */
19284 if (it
->current_x
< it
->first_visible_x
)
19286 enum move_it_result move_result
;
19288 this_line_min_pos
= row
->start
.pos
;
19289 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19290 MOVE_TO_POS
| MOVE_TO_X
);
19291 /* If we are under a large hscroll, move_it_in_display_line_to
19292 could hit the end of the line without reaching
19293 it->first_visible_x. Pretend that we did reach it. This is
19294 especially important on a TTY, where we will call
19295 extend_face_to_end_of_line, which needs to know how many
19296 blank glyphs to produce. */
19297 if (it
->current_x
< it
->first_visible_x
19298 && (move_result
== MOVE_NEWLINE_OR_CR
19299 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19300 it
->current_x
= it
->first_visible_x
;
19302 /* Record the smallest positions seen while we moved over
19303 display elements that are not visible. This is needed by
19304 redisplay_internal for optimizing the case where the cursor
19305 stays inside the same line. The rest of this function only
19306 considers positions that are actually displayed, so
19307 RECORD_MAX_MIN_POS will not otherwise record positions that
19308 are hscrolled to the left of the left edge of the window. */
19309 min_pos
= CHARPOS (this_line_min_pos
);
19310 min_bpos
= BYTEPOS (this_line_min_pos
);
19314 /* We only do this when not calling `move_it_in_display_line_to'
19315 above, because move_it_in_display_line_to calls
19316 handle_line_prefix itself. */
19317 handle_line_prefix (it
);
19320 /* Get the initial row height. This is either the height of the
19321 text hscrolled, if there is any, or zero. */
19322 row
->ascent
= it
->max_ascent
;
19323 row
->height
= it
->max_ascent
+ it
->max_descent
;
19324 row
->phys_ascent
= it
->max_phys_ascent
;
19325 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19326 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19328 /* Utility macro to record max and min buffer positions seen until now. */
19329 #define RECORD_MAX_MIN_POS(IT) \
19332 int composition_p = !STRINGP ((IT)->string) \
19333 && ((IT)->what == IT_COMPOSITION); \
19334 ptrdiff_t current_pos = \
19335 composition_p ? (IT)->cmp_it.charpos \
19336 : IT_CHARPOS (*(IT)); \
19337 ptrdiff_t current_bpos = \
19338 composition_p ? CHAR_TO_BYTE (current_pos) \
19339 : IT_BYTEPOS (*(IT)); \
19340 if (current_pos < min_pos) \
19342 min_pos = current_pos; \
19343 min_bpos = current_bpos; \
19345 if (IT_CHARPOS (*it) > max_pos) \
19347 max_pos = IT_CHARPOS (*it); \
19348 max_bpos = IT_BYTEPOS (*it); \
19353 /* Loop generating characters. The loop is left with IT on the next
19354 character to display. */
19357 int n_glyphs_before
, hpos_before
, x_before
;
19359 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19361 /* Retrieve the next thing to display. Value is zero if end of
19363 if (!get_next_display_element (it
))
19365 /* Maybe add a space at the end of this line that is used to
19366 display the cursor there under X. Set the charpos of the
19367 first glyph of blank lines not corresponding to any text
19369 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19370 row
->exact_window_width_line_p
= 1;
19371 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19372 || row
->used
[TEXT_AREA
] == 0)
19374 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19375 row
->displays_text_p
= 0;
19377 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
19378 && (!MINI_WINDOW_P (it
->w
)
19379 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19380 row
->indicate_empty_line_p
= 1;
19383 it
->continuation_lines_width
= 0;
19384 row
->ends_at_zv_p
= 1;
19385 /* A row that displays right-to-left text must always have
19386 its last face extended all the way to the end of line,
19387 even if this row ends in ZV, because we still write to
19388 the screen left to right. We also need to extend the
19389 last face if the default face is remapped to some
19390 different face, otherwise the functions that clear
19391 portions of the screen will clear with the default face's
19392 background color. */
19393 if (row
->reversed_p
19394 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19395 extend_face_to_end_of_line (it
);
19399 /* Now, get the metrics of what we want to display. This also
19400 generates glyphs in `row' (which is IT->glyph_row). */
19401 n_glyphs_before
= row
->used
[TEXT_AREA
];
19404 /* Remember the line height so far in case the next element doesn't
19405 fit on the line. */
19406 if (it
->line_wrap
!= TRUNCATE
)
19408 ascent
= it
->max_ascent
;
19409 descent
= it
->max_descent
;
19410 phys_ascent
= it
->max_phys_ascent
;
19411 phys_descent
= it
->max_phys_descent
;
19413 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19415 if (IT_DISPLAYING_WHITESPACE (it
))
19419 SAVE_IT (wrap_it
, *it
, wrap_data
);
19421 wrap_row_used
= row
->used
[TEXT_AREA
];
19422 wrap_row_ascent
= row
->ascent
;
19423 wrap_row_height
= row
->height
;
19424 wrap_row_phys_ascent
= row
->phys_ascent
;
19425 wrap_row_phys_height
= row
->phys_height
;
19426 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19427 wrap_row_min_pos
= min_pos
;
19428 wrap_row_min_bpos
= min_bpos
;
19429 wrap_row_max_pos
= max_pos
;
19430 wrap_row_max_bpos
= max_bpos
;
19436 PRODUCE_GLYPHS (it
);
19438 /* If this display element was in marginal areas, continue with
19440 if (it
->area
!= TEXT_AREA
)
19442 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19443 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19444 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19445 row
->phys_height
= max (row
->phys_height
,
19446 it
->max_phys_ascent
+ it
->max_phys_descent
);
19447 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19448 it
->max_extra_line_spacing
);
19449 set_iterator_to_next (it
, 1);
19453 /* Does the display element fit on the line? If we truncate
19454 lines, we should draw past the right edge of the window. If
19455 we don't truncate, we want to stop so that we can display the
19456 continuation glyph before the right margin. If lines are
19457 continued, there are two possible strategies for characters
19458 resulting in more than 1 glyph (e.g. tabs): Display as many
19459 glyphs as possible in this line and leave the rest for the
19460 continuation line, or display the whole element in the next
19461 line. Original redisplay did the former, so we do it also. */
19462 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19463 hpos_before
= it
->hpos
;
19466 if (/* Not a newline. */
19468 /* Glyphs produced fit entirely in the line. */
19469 && it
->current_x
< it
->last_visible_x
)
19471 it
->hpos
+= nglyphs
;
19472 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19473 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19474 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19475 row
->phys_height
= max (row
->phys_height
,
19476 it
->max_phys_ascent
+ it
->max_phys_descent
);
19477 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19478 it
->max_extra_line_spacing
);
19479 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19480 row
->x
= x
- it
->first_visible_x
;
19481 /* Record the maximum and minimum buffer positions seen so
19482 far in glyphs that will be displayed by this row. */
19484 RECORD_MAX_MIN_POS (it
);
19489 struct glyph
*glyph
;
19491 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19493 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19494 new_x
= x
+ glyph
->pixel_width
;
19496 if (/* Lines are continued. */
19497 it
->line_wrap
!= TRUNCATE
19498 && (/* Glyph doesn't fit on the line. */
19499 new_x
> it
->last_visible_x
19500 /* Or it fits exactly on a window system frame. */
19501 || (new_x
== it
->last_visible_x
19502 && FRAME_WINDOW_P (it
->f
)
19503 && (row
->reversed_p
19504 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19505 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19507 /* End of a continued line. */
19510 || (new_x
== it
->last_visible_x
19511 && FRAME_WINDOW_P (it
->f
)
19512 && (row
->reversed_p
19513 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19514 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19516 /* Current glyph is the only one on the line or
19517 fits exactly on the line. We must continue
19518 the line because we can't draw the cursor
19519 after the glyph. */
19520 row
->continued_p
= 1;
19521 it
->current_x
= new_x
;
19522 it
->continuation_lines_width
+= new_x
;
19524 if (i
== nglyphs
- 1)
19526 /* If line-wrap is on, check if a previous
19527 wrap point was found. */
19528 if (wrap_row_used
> 0
19529 /* Even if there is a previous wrap
19530 point, continue the line here as
19531 usual, if (i) the previous character
19532 was a space or tab AND (ii) the
19533 current character is not. */
19535 || IT_DISPLAYING_WHITESPACE (it
)))
19538 /* Record the maximum and minimum buffer
19539 positions seen so far in glyphs that will be
19540 displayed by this row. */
19542 RECORD_MAX_MIN_POS (it
);
19543 set_iterator_to_next (it
, 1);
19544 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19546 if (!get_next_display_element (it
))
19548 row
->exact_window_width_line_p
= 1;
19549 it
->continuation_lines_width
= 0;
19550 row
->continued_p
= 0;
19551 row
->ends_at_zv_p
= 1;
19553 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19555 row
->continued_p
= 0;
19556 row
->exact_window_width_line_p
= 1;
19560 else if (it
->bidi_p
)
19561 RECORD_MAX_MIN_POS (it
);
19563 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19564 && !FRAME_WINDOW_P (it
->f
))
19566 /* A padding glyph that doesn't fit on this line.
19567 This means the whole character doesn't fit
19569 if (row
->reversed_p
)
19570 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19571 - n_glyphs_before
);
19572 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19574 /* Fill the rest of the row with continuation
19575 glyphs like in 20.x. */
19576 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19577 < row
->glyphs
[1 + TEXT_AREA
])
19578 produce_special_glyphs (it
, IT_CONTINUATION
);
19580 row
->continued_p
= 1;
19581 it
->current_x
= x_before
;
19582 it
->continuation_lines_width
+= x_before
;
19584 /* Restore the height to what it was before the
19585 element not fitting on the line. */
19586 it
->max_ascent
= ascent
;
19587 it
->max_descent
= descent
;
19588 it
->max_phys_ascent
= phys_ascent
;
19589 it
->max_phys_descent
= phys_descent
;
19591 else if (wrap_row_used
> 0)
19594 if (row
->reversed_p
)
19595 unproduce_glyphs (it
,
19596 row
->used
[TEXT_AREA
] - wrap_row_used
);
19597 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19598 it
->continuation_lines_width
+= wrap_x
;
19599 row
->used
[TEXT_AREA
] = wrap_row_used
;
19600 row
->ascent
= wrap_row_ascent
;
19601 row
->height
= wrap_row_height
;
19602 row
->phys_ascent
= wrap_row_phys_ascent
;
19603 row
->phys_height
= wrap_row_phys_height
;
19604 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19605 min_pos
= wrap_row_min_pos
;
19606 min_bpos
= wrap_row_min_bpos
;
19607 max_pos
= wrap_row_max_pos
;
19608 max_bpos
= wrap_row_max_bpos
;
19609 row
->continued_p
= 1;
19610 row
->ends_at_zv_p
= 0;
19611 row
->exact_window_width_line_p
= 0;
19612 it
->continuation_lines_width
+= x
;
19614 /* Make sure that a non-default face is extended
19615 up to the right margin of the window. */
19616 extend_face_to_end_of_line (it
);
19618 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19620 /* A TAB that extends past the right edge of the
19621 window. This produces a single glyph on
19622 window system frames. We leave the glyph in
19623 this row and let it fill the row, but don't
19624 consume the TAB. */
19625 if ((row
->reversed_p
19626 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19627 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19628 produce_special_glyphs (it
, IT_CONTINUATION
);
19629 it
->continuation_lines_width
+= it
->last_visible_x
;
19630 row
->ends_in_middle_of_char_p
= 1;
19631 row
->continued_p
= 1;
19632 glyph
->pixel_width
= it
->last_visible_x
- x
;
19633 it
->starts_in_middle_of_char_p
= 1;
19637 /* Something other than a TAB that draws past
19638 the right edge of the window. Restore
19639 positions to values before the element. */
19640 if (row
->reversed_p
)
19641 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19642 - (n_glyphs_before
+ i
));
19643 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19645 /* Display continuation glyphs. */
19646 it
->current_x
= x_before
;
19647 it
->continuation_lines_width
+= x
;
19648 if (!FRAME_WINDOW_P (it
->f
)
19649 || (row
->reversed_p
19650 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19651 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19652 produce_special_glyphs (it
, IT_CONTINUATION
);
19653 row
->continued_p
= 1;
19655 extend_face_to_end_of_line (it
);
19657 if (nglyphs
> 1 && i
> 0)
19659 row
->ends_in_middle_of_char_p
= 1;
19660 it
->starts_in_middle_of_char_p
= 1;
19663 /* Restore the height to what it was before the
19664 element not fitting on the line. */
19665 it
->max_ascent
= ascent
;
19666 it
->max_descent
= descent
;
19667 it
->max_phys_ascent
= phys_ascent
;
19668 it
->max_phys_descent
= phys_descent
;
19673 else if (new_x
> it
->first_visible_x
)
19675 /* Increment number of glyphs actually displayed. */
19678 /* Record the maximum and minimum buffer positions
19679 seen so far in glyphs that will be displayed by
19682 RECORD_MAX_MIN_POS (it
);
19684 if (x
< it
->first_visible_x
)
19685 /* Glyph is partially visible, i.e. row starts at
19686 negative X position. */
19687 row
->x
= x
- it
->first_visible_x
;
19691 /* Glyph is completely off the left margin of the
19692 window. This should not happen because of the
19693 move_it_in_display_line at the start of this
19694 function, unless the text display area of the
19695 window is empty. */
19696 eassert (it
->first_visible_x
<= it
->last_visible_x
);
19699 /* Even if this display element produced no glyphs at all,
19700 we want to record its position. */
19701 if (it
->bidi_p
&& nglyphs
== 0)
19702 RECORD_MAX_MIN_POS (it
);
19704 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19705 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19706 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19707 row
->phys_height
= max (row
->phys_height
,
19708 it
->max_phys_ascent
+ it
->max_phys_descent
);
19709 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19710 it
->max_extra_line_spacing
);
19712 /* End of this display line if row is continued. */
19713 if (row
->continued_p
|| row
->ends_at_zv_p
)
19718 /* Is this a line end? If yes, we're also done, after making
19719 sure that a non-default face is extended up to the right
19720 margin of the window. */
19721 if (ITERATOR_AT_END_OF_LINE_P (it
))
19723 int used_before
= row
->used
[TEXT_AREA
];
19725 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19727 /* Add a space at the end of the line that is used to
19728 display the cursor there. */
19729 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19730 append_space_for_newline (it
, 0);
19732 /* Extend the face to the end of the line. */
19733 extend_face_to_end_of_line (it
);
19735 /* Make sure we have the position. */
19736 if (used_before
== 0)
19737 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19739 /* Record the position of the newline, for use in
19741 it
->eol_pos
= it
->current
.pos
;
19743 /* Consume the line end. This skips over invisible lines. */
19744 set_iterator_to_next (it
, 1);
19745 it
->continuation_lines_width
= 0;
19749 /* Proceed with next display element. Note that this skips
19750 over lines invisible because of selective display. */
19751 set_iterator_to_next (it
, 1);
19753 /* If we truncate lines, we are done when the last displayed
19754 glyphs reach past the right margin of the window. */
19755 if (it
->line_wrap
== TRUNCATE
19756 && (FRAME_WINDOW_P (it
->f
) && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19757 ? (it
->current_x
>= it
->last_visible_x
)
19758 : (it
->current_x
> it
->last_visible_x
)))
19760 /* Maybe add truncation glyphs. */
19761 if (!FRAME_WINDOW_P (it
->f
)
19762 || (row
->reversed_p
19763 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19764 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19768 if (!row
->reversed_p
)
19770 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19771 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19776 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19777 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19779 /* Remove any padding glyphs at the front of ROW, to
19780 make room for the truncation glyphs we will be
19781 adding below. The loop below always inserts at
19782 least one truncation glyph, so also remove the
19783 last glyph added to ROW. */
19784 unproduce_glyphs (it
, i
+ 1);
19785 /* Adjust i for the loop below. */
19786 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19789 it
->current_x
= x_before
;
19790 if (!FRAME_WINDOW_P (it
->f
))
19792 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19794 row
->used
[TEXT_AREA
] = i
;
19795 produce_special_glyphs (it
, IT_TRUNCATION
);
19800 row
->used
[TEXT_AREA
] = i
;
19801 produce_special_glyphs (it
, IT_TRUNCATION
);
19804 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19806 /* Don't truncate if we can overflow newline into fringe. */
19807 if (!get_next_display_element (it
))
19809 it
->continuation_lines_width
= 0;
19810 row
->ends_at_zv_p
= 1;
19811 row
->exact_window_width_line_p
= 1;
19814 if (ITERATOR_AT_END_OF_LINE_P (it
))
19816 row
->exact_window_width_line_p
= 1;
19817 goto at_end_of_line
;
19819 it
->current_x
= x_before
;
19822 row
->truncated_on_right_p
= 1;
19823 it
->continuation_lines_width
= 0;
19824 reseat_at_next_visible_line_start (it
, 0);
19825 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19826 it
->hpos
= hpos_before
;
19832 bidi_unshelve_cache (wrap_data
, 1);
19834 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19835 at the left window margin. */
19836 if (it
->first_visible_x
19837 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19839 if (!FRAME_WINDOW_P (it
->f
)
19840 || (row
->reversed_p
19841 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19842 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
19843 insert_left_trunc_glyphs (it
);
19844 row
->truncated_on_left_p
= 1;
19847 /* Remember the position at which this line ends.
19849 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19850 cannot be before the call to find_row_edges below, since that is
19851 where these positions are determined. */
19852 row
->end
= it
->current
;
19855 row
->minpos
= row
->start
.pos
;
19856 row
->maxpos
= row
->end
.pos
;
19860 /* ROW->minpos and ROW->maxpos must be the smallest and
19861 `1 + the largest' buffer positions in ROW. But if ROW was
19862 bidi-reordered, these two positions can be anywhere in the
19863 row, so we must determine them now. */
19864 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19867 /* If the start of this line is the overlay arrow-position, then
19868 mark this glyph row as the one containing the overlay arrow.
19869 This is clearly a mess with variable size fonts. It would be
19870 better to let it be displayed like cursors under X. */
19871 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
19872 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19873 !NILP (overlay_arrow_string
)))
19875 /* Overlay arrow in window redisplay is a fringe bitmap. */
19876 if (STRINGP (overlay_arrow_string
))
19878 struct glyph_row
*arrow_row
19879 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19880 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19881 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19882 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19883 struct glyph
*p2
, *end
;
19885 /* Copy the arrow glyphs. */
19886 while (glyph
< arrow_end
)
19889 /* Throw away padding glyphs. */
19891 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19892 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19898 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19903 eassert (INTEGERP (overlay_arrow_string
));
19904 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19906 overlay_arrow_seen
= 1;
19909 /* Highlight trailing whitespace. */
19910 if (!NILP (Vshow_trailing_whitespace
))
19911 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19913 /* Compute pixel dimensions of this line. */
19914 compute_line_metrics (it
);
19916 /* Implementation note: No changes in the glyphs of ROW or in their
19917 faces can be done past this point, because compute_line_metrics
19918 computes ROW's hash value and stores it within the glyph_row
19921 /* Record whether this row ends inside an ellipsis. */
19922 row
->ends_in_ellipsis_p
19923 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19924 && it
->ellipsis_p
);
19926 /* Save fringe bitmaps in this row. */
19927 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19928 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19929 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19930 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19932 it
->left_user_fringe_bitmap
= 0;
19933 it
->left_user_fringe_face_id
= 0;
19934 it
->right_user_fringe_bitmap
= 0;
19935 it
->right_user_fringe_face_id
= 0;
19937 /* Maybe set the cursor. */
19938 cvpos
= it
->w
->cursor
.vpos
;
19940 /* In bidi-reordered rows, keep checking for proper cursor
19941 position even if one has been found already, because buffer
19942 positions in such rows change non-linearly with ROW->VPOS,
19943 when a line is continued. One exception: when we are at ZV,
19944 display cursor on the first suitable glyph row, since all
19945 the empty rows after that also have their position set to ZV. */
19946 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19947 lines' rows is implemented for bidi-reordered rows. */
19949 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19950 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19951 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19952 && cursor_row_p (row
))
19953 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19955 /* Prepare for the next line. This line starts horizontally at (X
19956 HPOS) = (0 0). Vertical positions are incremented. As a
19957 convenience for the caller, IT->glyph_row is set to the next
19959 it
->current_x
= it
->hpos
= 0;
19960 it
->current_y
+= row
->height
;
19961 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19964 /* The next row should by default use the same value of the
19965 reversed_p flag as this one. set_iterator_to_next decides when
19966 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19967 the flag accordingly. */
19968 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19969 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19970 it
->start
= row
->end
;
19971 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
19973 #undef RECORD_MAX_MIN_POS
19976 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19977 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19978 doc
: /* Return paragraph direction at point in BUFFER.
19979 Value is either `left-to-right' or `right-to-left'.
19980 If BUFFER is omitted or nil, it defaults to the current buffer.
19982 Paragraph direction determines how the text in the paragraph is displayed.
19983 In left-to-right paragraphs, text begins at the left margin of the window
19984 and the reading direction is generally left to right. In right-to-left
19985 paragraphs, text begins at the right margin and is read from right to left.
19987 See also `bidi-paragraph-direction'. */)
19988 (Lisp_Object buffer
)
19990 struct buffer
*buf
= current_buffer
;
19991 struct buffer
*old
= buf
;
19993 if (! NILP (buffer
))
19995 CHECK_BUFFER (buffer
);
19996 buf
= XBUFFER (buffer
);
19999 if (NILP (BVAR (buf
, bidi_display_reordering
))
20000 || NILP (BVAR (buf
, enable_multibyte_characters
))
20001 /* When we are loading loadup.el, the character property tables
20002 needed for bidi iteration are not yet available. */
20003 || !NILP (Vpurify_flag
))
20004 return Qleft_to_right
;
20005 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20006 return BVAR (buf
, bidi_paragraph_direction
);
20009 /* Determine the direction from buffer text. We could try to
20010 use current_matrix if it is up to date, but this seems fast
20011 enough as it is. */
20012 struct bidi_it itb
;
20013 ptrdiff_t pos
= BUF_PT (buf
);
20014 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20016 void *itb_data
= bidi_shelve_cache ();
20018 set_buffer_temp (buf
);
20019 /* bidi_paragraph_init finds the base direction of the paragraph
20020 by searching forward from paragraph start. We need the base
20021 direction of the current or _previous_ paragraph, so we need
20022 to make sure we are within that paragraph. To that end, find
20023 the previous non-empty line. */
20024 if (pos
>= ZV
&& pos
> BEGV
)
20025 DEC_BOTH (pos
, bytepos
);
20026 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20027 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20029 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20030 || c
== ' ' || c
== '\t' || c
== '\f')
20032 if (bytepos
<= BEGV_BYTE
)
20037 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20040 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20041 itb
.paragraph_dir
= NEUTRAL_DIR
;
20042 itb
.string
.s
= NULL
;
20043 itb
.string
.lstring
= Qnil
;
20044 itb
.string
.bufpos
= 0;
20045 itb
.string
.unibyte
= 0;
20046 /* We have no window to use here for ignoring window-specific
20047 overlays. Using NULL for window pointer will cause
20048 compute_display_string_pos to use the current buffer. */
20050 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20051 bidi_unshelve_cache (itb_data
, 0);
20052 set_buffer_temp (old
);
20053 switch (itb
.paragraph_dir
)
20056 return Qleft_to_right
;
20059 return Qright_to_left
;
20067 DEFUN ("move-point-visually", Fmove_point_visually
,
20068 Smove_point_visually
, 1, 1, 0,
20069 doc
: /* Move point in the visual order in the specified DIRECTION.
20070 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20073 Value is the new character position of point. */)
20074 (Lisp_Object direction
)
20076 struct window
*w
= XWINDOW (selected_window
);
20077 struct buffer
*b
= XBUFFER (w
->contents
);
20078 struct glyph_row
*row
;
20080 Lisp_Object paragraph_dir
;
20082 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20083 (!(ROW)->continued_p \
20084 && INTEGERP ((GLYPH)->object) \
20085 && (GLYPH)->type == CHAR_GLYPH \
20086 && (GLYPH)->u.ch == ' ' \
20087 && (GLYPH)->charpos >= 0 \
20088 && !(GLYPH)->avoid_cursor_p)
20090 CHECK_NUMBER (direction
);
20091 dir
= XINT (direction
);
20097 /* If current matrix is up-to-date, we can use the information
20098 recorded in the glyphs, at least as long as the goal is on the
20100 if (w
->window_end_valid
20101 && !windows_or_buffers_changed
20103 && !b
->clip_changed
20104 && !b
->prevent_redisplay_optimizations_p
20105 && !window_outdated (w
)
20106 && w
->cursor
.vpos
>= 0
20107 && w
->cursor
.vpos
< w
->current_matrix
->nrows
20108 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
20110 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
20111 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
20112 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
20114 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
20116 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
20118 SET_PT (g
->charpos
);
20119 w
->cursor
.vpos
= -1;
20120 return make_number (PT
);
20122 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
20126 if (BUFFERP (gpt
->object
))
20129 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
20130 new_pos
+= (row
->reversed_p
? -dir
: dir
);
20132 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
20134 else if (BUFFERP (g
->object
))
20135 new_pos
= g
->charpos
;
20139 w
->cursor
.vpos
= -1;
20140 return make_number (PT
);
20142 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
20144 /* Glyphs inserted at the end of a non-empty line for
20145 positioning the cursor have zero charpos, so we must
20146 deduce the value of point by other means. */
20147 if (g
->charpos
> 0)
20148 SET_PT (g
->charpos
);
20149 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
20151 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
20152 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20155 w
->cursor
.vpos
= -1;
20156 return make_number (PT
);
20159 if (g
== e
|| INTEGERP (g
->object
))
20161 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
20162 goto simulate_display
;
20163 if (!row
->reversed_p
)
20167 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
20168 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
20169 goto simulate_display
;
20173 if (row
->reversed_p
&& !row
->continued_p
)
20175 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20176 w
->cursor
.vpos
= -1;
20177 return make_number (PT
);
20179 g
= row
->glyphs
[TEXT_AREA
];
20180 e
= g
+ row
->used
[TEXT_AREA
];
20181 for ( ; g
< e
; g
++)
20183 if (BUFFERP (g
->object
)
20184 /* Empty lines have only one glyph, which stands
20185 for the newline, and whose charpos is the
20186 buffer position of the newline. */
20187 || ROW_GLYPH_NEWLINE_P (row
, g
)
20188 /* When the buffer ends in a newline, the line at
20189 EOB also has one glyph, but its charpos is -1. */
20190 || (row
->ends_at_zv_p
20191 && !row
->reversed_p
20192 && INTEGERP (g
->object
)
20193 && g
->type
== CHAR_GLYPH
20194 && g
->u
.ch
== ' '))
20196 if (g
->charpos
> 0)
20197 SET_PT (g
->charpos
);
20198 else if (!row
->reversed_p
20199 && row
->ends_at_zv_p
20204 w
->cursor
.vpos
= -1;
20205 return make_number (PT
);
20211 if (!row
->reversed_p
&& !row
->continued_p
)
20213 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20214 w
->cursor
.vpos
= -1;
20215 return make_number (PT
);
20217 e
= row
->glyphs
[TEXT_AREA
];
20218 g
= e
+ row
->used
[TEXT_AREA
] - 1;
20219 for ( ; g
>= e
; g
--)
20221 if (BUFFERP (g
->object
)
20222 || (ROW_GLYPH_NEWLINE_P (row
, g
)
20224 /* Empty R2L lines on GUI frames have the buffer
20225 position of the newline stored in the stretch
20227 || g
->type
== STRETCH_GLYPH
20228 || (row
->ends_at_zv_p
20230 && INTEGERP (g
->object
)
20231 && g
->type
== CHAR_GLYPH
20232 && g
->u
.ch
== ' '))
20234 if (g
->charpos
> 0)
20235 SET_PT (g
->charpos
);
20236 else if (row
->reversed_p
20237 && row
->ends_at_zv_p
20242 w
->cursor
.vpos
= -1;
20243 return make_number (PT
);
20252 /* If we wind up here, we failed to move by using the glyphs, so we
20253 need to simulate display instead. */
20256 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
20258 paragraph_dir
= Qleft_to_right
;
20259 if (EQ (paragraph_dir
, Qright_to_left
))
20261 if (PT
<= BEGV
&& dir
< 0)
20262 xsignal0 (Qbeginning_of_buffer
);
20263 else if (PT
>= ZV
&& dir
> 0)
20264 xsignal0 (Qend_of_buffer
);
20267 struct text_pos pt
;
20269 int pt_x
, target_x
, pixel_width
, pt_vpos
;
20271 bool overshoot_expected
= false;
20272 bool target_is_eol_p
= false;
20274 /* Setup the arena. */
20275 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
20276 start_display (&it
, w
, pt
);
20278 if (it
.cmp_it
.id
< 0
20279 && it
.method
== GET_FROM_STRING
20280 && it
.area
== TEXT_AREA
20281 && it
.string_from_display_prop_p
20282 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
20283 overshoot_expected
= true;
20285 /* Find the X coordinate of point. We start from the beginning
20286 of this or previous line to make sure we are before point in
20287 the logical order (since the move_it_* functions can only
20289 reseat_at_previous_visible_line_start (&it
);
20290 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
20291 if (IT_CHARPOS (it
) != PT
)
20292 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
20293 -1, -1, -1, MOVE_TO_POS
);
20294 pt_x
= it
.current_x
;
20296 if (dir
> 0 || overshoot_expected
)
20298 struct glyph_row
*row
= it
.glyph_row
;
20300 /* When point is at beginning of line, we don't have
20301 information about the glyph there loaded into struct
20302 it. Calling get_next_display_element fixes that. */
20304 get_next_display_element (&it
);
20305 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
20306 it
.glyph_row
= NULL
;
20307 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
20308 it
.glyph_row
= row
;
20309 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
20310 it, lest it will become out of sync with it's buffer
20312 it
.current_x
= pt_x
;
20315 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
20316 pixel_width
= it
.pixel_width
;
20317 if (overshoot_expected
&& at_eol_p
)
20319 else if (pixel_width
<= 0)
20322 /* If there's a display string at point, we are actually at the
20323 glyph to the left of point, so we need to correct the X
20325 if (overshoot_expected
)
20326 pt_x
+= pixel_width
;
20328 /* Compute target X coordinate, either to the left or to the
20329 right of point. On TTY frames, all characters have the same
20330 pixel width of 1, so we can use that. On GUI frames we don't
20331 have an easy way of getting at the pixel width of the
20332 character to the left of point, so we use a different method
20333 of getting to that place. */
20335 target_x
= pt_x
+ pixel_width
;
20337 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
20339 /* Target X coordinate could be one line above or below the line
20340 of point, in which case we need to adjust the target X
20341 coordinate. Also, if moving to the left, we need to begin at
20342 the left edge of the point's screen line. */
20347 start_display (&it
, w
, pt
);
20348 reseat_at_previous_visible_line_start (&it
);
20349 it
.current_x
= it
.current_y
= it
.hpos
= 0;
20351 move_it_by_lines (&it
, pt_vpos
);
20355 move_it_by_lines (&it
, -1);
20356 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
20357 target_is_eol_p
= true;
20363 || (target_x
>= it
.last_visible_x
20364 && it
.line_wrap
!= TRUNCATE
))
20367 move_it_by_lines (&it
, 0);
20368 move_it_by_lines (&it
, 1);
20373 /* Move to the target X coordinate. */
20374 #ifdef HAVE_WINDOW_SYSTEM
20375 /* On GUI frames, as we don't know the X coordinate of the
20376 character to the left of point, moving point to the left
20377 requires walking, one grapheme cluster at a time, until we
20378 find ourself at a place immediately to the left of the
20379 character at point. */
20380 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
20382 struct text_pos new_pos
= it
.current
.pos
;
20383 enum move_it_result rc
= MOVE_X_REACHED
;
20385 while (it
.current_x
+ it
.pixel_width
<= target_x
20386 && rc
== MOVE_X_REACHED
)
20388 int new_x
= it
.current_x
+ it
.pixel_width
;
20390 new_pos
= it
.current
.pos
;
20391 if (new_x
== it
.current_x
)
20393 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
20394 MOVE_TO_POS
| MOVE_TO_X
);
20395 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
20398 /* If we ended up on a composed character inside
20399 bidi-reordered text (e.g., Hebrew text with diacritics),
20400 the iterator gives us the buffer position of the last (in
20401 logical order) character of the composed grapheme cluster,
20402 which is not what we want. So we cheat: we compute the
20403 character position of the character that follows (in the
20404 logical order) the one where the above loop stopped. That
20405 character will appear on display to the left of point. */
20407 && it
.bidi_it
.scan_dir
== -1
20408 && new_pos
.charpos
- IT_CHARPOS (it
) > 1)
20410 new_pos
.charpos
= IT_CHARPOS (it
) + 1;
20411 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
20413 it
.current
.pos
= new_pos
;
20417 if (it
.current_x
!= target_x
)
20418 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
20420 /* When lines are truncated, the above loop will stop at the
20421 window edge. But we want to get to the end of line, even if
20422 it is beyond the window edge; automatic hscroll will then
20423 scroll the window to show point as appropriate. */
20424 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
20425 && get_next_display_element (&it
))
20427 struct text_pos new_pos
= it
.current
.pos
;
20429 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
20431 set_iterator_to_next (&it
, 0);
20432 if (it
.method
== GET_FROM_BUFFER
)
20433 new_pos
= it
.current
.pos
;
20434 if (!get_next_display_element (&it
))
20438 it
.current
.pos
= new_pos
;
20441 /* If we ended up in a display string that covers point, move to
20442 buffer position to the right in the visual order. */
20445 while (IT_CHARPOS (it
) == PT
)
20447 set_iterator_to_next (&it
, 0);
20448 if (!get_next_display_element (&it
))
20453 /* Move point to that position. */
20454 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
20457 return make_number (PT
);
20459 #undef ROW_GLYPH_NEWLINE_P
20463 /***********************************************************************
20465 ***********************************************************************/
20467 /* Redisplay the menu bar in the frame for window W.
20469 The menu bar of X frames that don't have X toolkit support is
20470 displayed in a special window W->frame->menu_bar_window.
20472 The menu bar of terminal frames is treated specially as far as
20473 glyph matrices are concerned. Menu bar lines are not part of
20474 windows, so the update is done directly on the frame matrix rows
20475 for the menu bar. */
20478 display_menu_bar (struct window
*w
)
20480 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20485 /* Don't do all this for graphical frames. */
20487 if (FRAME_W32_P (f
))
20490 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
20496 if (FRAME_NS_P (f
))
20498 #endif /* HAVE_NS */
20500 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
20501 eassert (!FRAME_WINDOW_P (f
));
20502 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
20503 it
.first_visible_x
= 0;
20504 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20505 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
20506 if (FRAME_WINDOW_P (f
))
20508 /* Menu bar lines are displayed in the desired matrix of the
20509 dummy window menu_bar_window. */
20510 struct window
*menu_w
;
20511 menu_w
= XWINDOW (f
->menu_bar_window
);
20512 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
20514 it
.first_visible_x
= 0;
20515 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20518 #endif /* not USE_X_TOOLKIT and not USE_GTK */
20520 /* This is a TTY frame, i.e. character hpos/vpos are used as
20522 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
20524 it
.first_visible_x
= 0;
20525 it
.last_visible_x
= FRAME_COLS (f
);
20528 /* FIXME: This should be controlled by a user option. See the
20529 comments in redisplay_tool_bar and display_mode_line about
20531 it
.paragraph_embedding
= L2R
;
20533 /* Clear all rows of the menu bar. */
20534 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
20536 struct glyph_row
*row
= it
.glyph_row
+ i
;
20537 clear_glyph_row (row
);
20538 row
->enabled_p
= 1;
20539 row
->full_width_p
= 1;
20542 /* Display all items of the menu bar. */
20543 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
20544 for (i
= 0; i
< ASIZE (items
); i
+= 4)
20546 Lisp_Object string
;
20548 /* Stop at nil string. */
20549 string
= AREF (items
, i
+ 1);
20553 /* Remember where item was displayed. */
20554 ASET (items
, i
+ 3, make_number (it
.hpos
));
20556 /* Display the item, pad with one space. */
20557 if (it
.current_x
< it
.last_visible_x
)
20558 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
20559 SCHARS (string
) + 1, 0, 0, -1);
20562 /* Fill out the line with spaces. */
20563 if (it
.current_x
< it
.last_visible_x
)
20564 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
20566 /* Compute the total height of the lines. */
20567 compute_line_metrics (&it
);
20572 /***********************************************************************
20574 ***********************************************************************/
20576 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20577 FORCE is non-zero, redisplay mode lines unconditionally.
20578 Otherwise, redisplay only mode lines that are garbaged. Value is
20579 the number of windows whose mode lines were redisplayed. */
20582 redisplay_mode_lines (Lisp_Object window
, int force
)
20586 while (!NILP (window
))
20588 struct window
*w
= XWINDOW (window
);
20590 if (WINDOWP (w
->contents
))
20591 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
20593 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20594 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20596 struct text_pos lpoint
;
20597 struct buffer
*old
= current_buffer
;
20599 /* Set the window's buffer for the mode line display. */
20600 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20601 set_buffer_internal_1 (XBUFFER (w
->contents
));
20603 /* Point refers normally to the selected window. For any
20604 other window, set up appropriate value. */
20605 if (!EQ (window
, selected_window
))
20607 struct text_pos pt
;
20609 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20610 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20613 /* Display mode lines. */
20614 clear_glyph_matrix (w
->desired_matrix
);
20615 if (display_mode_lines (w
))
20618 w
->must_be_updated_p
= 1;
20621 /* Restore old settings. */
20622 set_buffer_internal_1 (old
);
20623 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20633 /* Display the mode and/or header line of window W. Value is the
20634 sum number of mode lines and header lines displayed. */
20637 display_mode_lines (struct window
*w
)
20639 Lisp_Object old_selected_window
= selected_window
;
20640 Lisp_Object old_selected_frame
= selected_frame
;
20641 Lisp_Object new_frame
= w
->frame
;
20642 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
20645 selected_frame
= new_frame
;
20646 /* FIXME: If we were to allow the mode-line's computation changing the buffer
20647 or window's point, then we'd need select_window_1 here as well. */
20648 XSETWINDOW (selected_window
, w
);
20649 XFRAME (new_frame
)->selected_window
= selected_window
;
20651 /* These will be set while the mode line specs are processed. */
20652 line_number_displayed
= 0;
20653 w
->column_number_displayed
= -1;
20655 if (WINDOW_WANTS_MODELINE_P (w
))
20657 struct window
*sel_w
= XWINDOW (old_selected_window
);
20659 /* Select mode line face based on the real selected window. */
20660 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20661 BVAR (current_buffer
, mode_line_format
));
20665 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20667 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20668 BVAR (current_buffer
, header_line_format
));
20672 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
20673 selected_frame
= old_selected_frame
;
20674 selected_window
= old_selected_window
;
20679 /* Display mode or header line of window W. FACE_ID specifies which
20680 line to display; it is either MODE_LINE_FACE_ID or
20681 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20682 display. Value is the pixel height of the mode/header line
20686 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20690 ptrdiff_t count
= SPECPDL_INDEX ();
20692 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20693 /* Don't extend on a previously drawn mode-line.
20694 This may happen if called from pos_visible_p. */
20695 it
.glyph_row
->enabled_p
= 0;
20696 prepare_desired_row (it
.glyph_row
);
20698 it
.glyph_row
->mode_line_p
= 1;
20700 /* FIXME: This should be controlled by a user option. But
20701 supporting such an option is not trivial, since the mode line is
20702 made up of many separate strings. */
20703 it
.paragraph_embedding
= L2R
;
20705 record_unwind_protect (unwind_format_mode_line
,
20706 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
20708 mode_line_target
= MODE_LINE_DISPLAY
;
20710 /* Temporarily make frame's keyboard the current kboard so that
20711 kboard-local variables in the mode_line_format will get the right
20713 push_kboard (FRAME_KBOARD (it
.f
));
20714 record_unwind_save_match_data ();
20715 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20718 unbind_to (count
, Qnil
);
20720 /* Fill up with spaces. */
20721 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20723 compute_line_metrics (&it
);
20724 it
.glyph_row
->full_width_p
= 1;
20725 it
.glyph_row
->continued_p
= 0;
20726 it
.glyph_row
->truncated_on_left_p
= 0;
20727 it
.glyph_row
->truncated_on_right_p
= 0;
20729 /* Make a 3D mode-line have a shadow at its right end. */
20730 face
= FACE_FROM_ID (it
.f
, face_id
);
20731 extend_face_to_end_of_line (&it
);
20732 if (face
->box
!= FACE_NO_BOX
)
20734 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20735 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20736 last
->right_box_line_p
= 1;
20739 return it
.glyph_row
->height
;
20742 /* Move element ELT in LIST to the front of LIST.
20743 Return the updated list. */
20746 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20748 register Lisp_Object tail
, prev
;
20749 register Lisp_Object tem
;
20753 while (CONSP (tail
))
20759 /* Splice out the link TAIL. */
20761 list
= XCDR (tail
);
20763 Fsetcdr (prev
, XCDR (tail
));
20765 /* Now make it the first. */
20766 Fsetcdr (tail
, list
);
20771 tail
= XCDR (tail
);
20775 /* Not found--return unchanged LIST. */
20779 /* Contribute ELT to the mode line for window IT->w. How it
20780 translates into text depends on its data type.
20782 IT describes the display environment in which we display, as usual.
20784 DEPTH is the depth in recursion. It is used to prevent
20785 infinite recursion here.
20787 FIELD_WIDTH is the number of characters the display of ELT should
20788 occupy in the mode line, and PRECISION is the maximum number of
20789 characters to display from ELT's representation. See
20790 display_string for details.
20792 Returns the hpos of the end of the text generated by ELT.
20794 PROPS is a property list to add to any string we encounter.
20796 If RISKY is nonzero, remove (disregard) any properties in any string
20797 we encounter, and ignore :eval and :propertize.
20799 The global variable `mode_line_target' determines whether the
20800 output is passed to `store_mode_line_noprop',
20801 `store_mode_line_string', or `display_string'. */
20804 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20805 Lisp_Object elt
, Lisp_Object props
, int risky
)
20807 int n
= 0, field
, prec
;
20812 elt
= build_string ("*too-deep*");
20816 switch (XTYPE (elt
))
20820 /* A string: output it and check for %-constructs within it. */
20822 ptrdiff_t offset
= 0;
20824 if (SCHARS (elt
) > 0
20825 && (!NILP (props
) || risky
))
20827 Lisp_Object oprops
, aelt
;
20828 oprops
= Ftext_properties_at (make_number (0), elt
);
20830 /* If the starting string's properties are not what
20831 we want, translate the string. Also, if the string
20832 is risky, do that anyway. */
20834 if (NILP (Fequal (props
, oprops
)) || risky
)
20836 /* If the starting string has properties,
20837 merge the specified ones onto the existing ones. */
20838 if (! NILP (oprops
) && !risky
)
20842 oprops
= Fcopy_sequence (oprops
);
20844 while (CONSP (tem
))
20846 oprops
= Fplist_put (oprops
, XCAR (tem
),
20847 XCAR (XCDR (tem
)));
20848 tem
= XCDR (XCDR (tem
));
20853 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20854 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20856 /* AELT is what we want. Move it to the front
20857 without consing. */
20859 mode_line_proptrans_alist
20860 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20866 /* If AELT has the wrong props, it is useless.
20867 so get rid of it. */
20869 mode_line_proptrans_alist
20870 = Fdelq (aelt
, mode_line_proptrans_alist
);
20872 elt
= Fcopy_sequence (elt
);
20873 Fset_text_properties (make_number (0), Flength (elt
),
20875 /* Add this item to mode_line_proptrans_alist. */
20876 mode_line_proptrans_alist
20877 = Fcons (Fcons (elt
, props
),
20878 mode_line_proptrans_alist
);
20879 /* Truncate mode_line_proptrans_alist
20880 to at most 50 elements. */
20881 tem
= Fnthcdr (make_number (50),
20882 mode_line_proptrans_alist
);
20884 XSETCDR (tem
, Qnil
);
20893 prec
= precision
- n
;
20894 switch (mode_line_target
)
20896 case MODE_LINE_NOPROP
:
20897 case MODE_LINE_TITLE
:
20898 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20900 case MODE_LINE_STRING
:
20901 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20903 case MODE_LINE_DISPLAY
:
20904 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20905 0, prec
, 0, STRING_MULTIBYTE (elt
));
20912 /* Handle the non-literal case. */
20914 while ((precision
<= 0 || n
< precision
)
20915 && SREF (elt
, offset
) != 0
20916 && (mode_line_target
!= MODE_LINE_DISPLAY
20917 || it
->current_x
< it
->last_visible_x
))
20919 ptrdiff_t last_offset
= offset
;
20921 /* Advance to end of string or next format specifier. */
20922 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20925 if (offset
- 1 != last_offset
)
20927 ptrdiff_t nchars
, nbytes
;
20929 /* Output to end of string or up to '%'. Field width
20930 is length of string. Don't output more than
20931 PRECISION allows us. */
20934 prec
= c_string_width (SDATA (elt
) + last_offset
,
20935 offset
- last_offset
, precision
- n
,
20938 switch (mode_line_target
)
20940 case MODE_LINE_NOPROP
:
20941 case MODE_LINE_TITLE
:
20942 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20944 case MODE_LINE_STRING
:
20946 ptrdiff_t bytepos
= last_offset
;
20947 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20948 ptrdiff_t endpos
= (precision
<= 0
20949 ? string_byte_to_char (elt
, offset
)
20950 : charpos
+ nchars
);
20952 n
+= store_mode_line_string (NULL
,
20953 Fsubstring (elt
, make_number (charpos
),
20954 make_number (endpos
)),
20958 case MODE_LINE_DISPLAY
:
20960 ptrdiff_t bytepos
= last_offset
;
20961 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20963 if (precision
<= 0)
20964 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20965 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20967 STRING_MULTIBYTE (elt
));
20972 else /* c == '%' */
20974 ptrdiff_t percent_position
= offset
;
20976 /* Get the specified minimum width. Zero means
20979 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20980 field
= field
* 10 + c
- '0';
20982 /* Don't pad beyond the total padding allowed. */
20983 if (field_width
- n
> 0 && field
> field_width
- n
)
20984 field
= field_width
- n
;
20986 /* Note that either PRECISION <= 0 or N < PRECISION. */
20987 prec
= precision
- n
;
20990 n
+= display_mode_element (it
, depth
, field
, prec
,
20991 Vglobal_mode_string
, props
,
20996 ptrdiff_t bytepos
, charpos
;
20998 Lisp_Object string
;
21000 bytepos
= percent_position
;
21001 charpos
= (STRING_MULTIBYTE (elt
)
21002 ? string_byte_to_char (elt
, bytepos
)
21004 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
21005 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
21007 switch (mode_line_target
)
21009 case MODE_LINE_NOPROP
:
21010 case MODE_LINE_TITLE
:
21011 n
+= store_mode_line_noprop (spec
, field
, prec
);
21013 case MODE_LINE_STRING
:
21015 Lisp_Object tem
= build_string (spec
);
21016 props
= Ftext_properties_at (make_number (charpos
), elt
);
21017 /* Should only keep face property in props */
21018 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
21021 case MODE_LINE_DISPLAY
:
21023 int nglyphs_before
, nwritten
;
21025 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
21026 nwritten
= display_string (spec
, string
, elt
,
21031 /* Assign to the glyphs written above the
21032 string where the `%x' came from, position
21036 struct glyph
*glyph
21037 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
21041 for (i
= 0; i
< nwritten
; ++i
)
21043 glyph
[i
].object
= elt
;
21044 glyph
[i
].charpos
= charpos
;
21061 /* A symbol: process the value of the symbol recursively
21062 as if it appeared here directly. Avoid error if symbol void.
21063 Special case: if value of symbol is a string, output the string
21066 register Lisp_Object tem
;
21068 /* If the variable is not marked as risky to set
21069 then its contents are risky to use. */
21070 if (NILP (Fget (elt
, Qrisky_local_variable
)))
21073 tem
= Fboundp (elt
);
21076 tem
= Fsymbol_value (elt
);
21077 /* If value is a string, output that string literally:
21078 don't check for % within it. */
21082 if (!EQ (tem
, elt
))
21084 /* Give up right away for nil or t. */
21094 register Lisp_Object car
, tem
;
21096 /* A cons cell: five distinct cases.
21097 If first element is :eval or :propertize, do something special.
21098 If first element is a string or a cons, process all the elements
21099 and effectively concatenate them.
21100 If first element is a negative number, truncate displaying cdr to
21101 at most that many characters. If positive, pad (with spaces)
21102 to at least that many characters.
21103 If first element is a symbol, process the cadr or caddr recursively
21104 according to whether the symbol's value is non-nil or nil. */
21106 if (EQ (car
, QCeval
))
21108 /* An element of the form (:eval FORM) means evaluate FORM
21109 and use the result as mode line elements. */
21114 if (CONSP (XCDR (elt
)))
21117 spec
= safe_eval (XCAR (XCDR (elt
)));
21118 n
+= display_mode_element (it
, depth
, field_width
- n
,
21119 precision
- n
, spec
, props
,
21123 else if (EQ (car
, QCpropertize
))
21125 /* An element of the form (:propertize ELT PROPS...)
21126 means display ELT but applying properties PROPS. */
21131 if (CONSP (XCDR (elt
)))
21132 n
+= display_mode_element (it
, depth
, field_width
- n
,
21133 precision
- n
, XCAR (XCDR (elt
)),
21134 XCDR (XCDR (elt
)), risky
);
21136 else if (SYMBOLP (car
))
21138 tem
= Fboundp (car
);
21142 /* elt is now the cdr, and we know it is a cons cell.
21143 Use its car if CAR has a non-nil value. */
21146 tem
= Fsymbol_value (car
);
21153 /* Symbol's value is nil (or symbol is unbound)
21154 Get the cddr of the original list
21155 and if possible find the caddr and use that. */
21159 else if (!CONSP (elt
))
21164 else if (INTEGERP (car
))
21166 register int lim
= XINT (car
);
21170 /* Negative int means reduce maximum width. */
21171 if (precision
<= 0)
21174 precision
= min (precision
, -lim
);
21178 /* Padding specified. Don't let it be more than
21179 current maximum. */
21181 lim
= min (precision
, lim
);
21183 /* If that's more padding than already wanted, queue it.
21184 But don't reduce padding already specified even if
21185 that is beyond the current truncation point. */
21186 field_width
= max (lim
, field_width
);
21190 else if (STRINGP (car
) || CONSP (car
))
21192 Lisp_Object halftail
= elt
;
21196 && (precision
<= 0 || n
< precision
))
21198 n
+= display_mode_element (it
, depth
,
21199 /* Do padding only after the last
21200 element in the list. */
21201 (! CONSP (XCDR (elt
))
21204 precision
- n
, XCAR (elt
),
21208 if ((len
& 1) == 0)
21209 halftail
= XCDR (halftail
);
21210 /* Check for cycle. */
21211 if (EQ (halftail
, elt
))
21220 elt
= build_string ("*invalid*");
21224 /* Pad to FIELD_WIDTH. */
21225 if (field_width
> 0 && n
< field_width
)
21227 switch (mode_line_target
)
21229 case MODE_LINE_NOPROP
:
21230 case MODE_LINE_TITLE
:
21231 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
21233 case MODE_LINE_STRING
:
21234 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
21236 case MODE_LINE_DISPLAY
:
21237 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
21246 /* Store a mode-line string element in mode_line_string_list.
21248 If STRING is non-null, display that C string. Otherwise, the Lisp
21249 string LISP_STRING is displayed.
21251 FIELD_WIDTH is the minimum number of output glyphs to produce.
21252 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21253 with spaces. FIELD_WIDTH <= 0 means don't pad.
21255 PRECISION is the maximum number of characters to output from
21256 STRING. PRECISION <= 0 means don't truncate the string.
21258 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
21259 properties to the string.
21261 PROPS are the properties to add to the string.
21262 The mode_line_string_face face property is always added to the string.
21266 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
21267 int field_width
, int precision
, Lisp_Object props
)
21272 if (string
!= NULL
)
21274 len
= strlen (string
);
21275 if (precision
> 0 && len
> precision
)
21277 lisp_string
= make_string (string
, len
);
21279 props
= mode_line_string_face_prop
;
21280 else if (!NILP (mode_line_string_face
))
21282 Lisp_Object face
= Fplist_get (props
, Qface
);
21283 props
= Fcopy_sequence (props
);
21285 face
= mode_line_string_face
;
21287 face
= list2 (face
, mode_line_string_face
);
21288 props
= Fplist_put (props
, Qface
, face
);
21290 Fadd_text_properties (make_number (0), make_number (len
),
21291 props
, lisp_string
);
21295 len
= XFASTINT (Flength (lisp_string
));
21296 if (precision
> 0 && len
> precision
)
21299 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
21302 if (!NILP (mode_line_string_face
))
21306 props
= Ftext_properties_at (make_number (0), lisp_string
);
21307 face
= Fplist_get (props
, Qface
);
21309 face
= mode_line_string_face
;
21311 face
= list2 (face
, mode_line_string_face
);
21312 props
= list2 (Qface
, face
);
21314 lisp_string
= Fcopy_sequence (lisp_string
);
21317 Fadd_text_properties (make_number (0), make_number (len
),
21318 props
, lisp_string
);
21323 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
21327 if (field_width
> len
)
21329 field_width
-= len
;
21330 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
21332 Fadd_text_properties (make_number (0), make_number (field_width
),
21333 props
, lisp_string
);
21334 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
21342 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
21344 doc
: /* Format a string out of a mode line format specification.
21345 First arg FORMAT specifies the mode line format (see `mode-line-format'
21346 for details) to use.
21348 By default, the format is evaluated for the currently selected window.
21350 Optional second arg FACE specifies the face property to put on all
21351 characters for which no face is specified. The value nil means the
21352 default face. The value t means whatever face the window's mode line
21353 currently uses (either `mode-line' or `mode-line-inactive',
21354 depending on whether the window is the selected window or not).
21355 An integer value means the value string has no text
21358 Optional third and fourth args WINDOW and BUFFER specify the window
21359 and buffer to use as the context for the formatting (defaults
21360 are the selected window and the WINDOW's buffer). */)
21361 (Lisp_Object format
, Lisp_Object face
,
21362 Lisp_Object window
, Lisp_Object buffer
)
21367 struct buffer
*old_buffer
= NULL
;
21369 int no_props
= INTEGERP (face
);
21370 ptrdiff_t count
= SPECPDL_INDEX ();
21372 int string_start
= 0;
21374 w
= decode_any_window (window
);
21375 XSETWINDOW (window
, w
);
21378 buffer
= w
->contents
;
21379 CHECK_BUFFER (buffer
);
21381 /* Make formatting the modeline a non-op when noninteractive, otherwise
21382 there will be problems later caused by a partially initialized frame. */
21383 if (NILP (format
) || noninteractive
)
21384 return empty_unibyte_string
;
21389 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
21390 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
21391 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
21392 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
21393 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
21394 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
21395 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
21398 old_buffer
= current_buffer
;
21400 /* Save things including mode_line_proptrans_alist,
21401 and set that to nil so that we don't alter the outer value. */
21402 record_unwind_protect (unwind_format_mode_line
,
21403 format_mode_line_unwind_data
21404 (XFRAME (WINDOW_FRAME (w
)),
21405 old_buffer
, selected_window
, 1));
21406 mode_line_proptrans_alist
= Qnil
;
21408 Fselect_window (window
, Qt
);
21409 set_buffer_internal_1 (XBUFFER (buffer
));
21411 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21415 mode_line_target
= MODE_LINE_NOPROP
;
21416 mode_line_string_face_prop
= Qnil
;
21417 mode_line_string_list
= Qnil
;
21418 string_start
= MODE_LINE_NOPROP_LEN (0);
21422 mode_line_target
= MODE_LINE_STRING
;
21423 mode_line_string_list
= Qnil
;
21424 mode_line_string_face
= face
;
21425 mode_line_string_face_prop
21426 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
21429 push_kboard (FRAME_KBOARD (it
.f
));
21430 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21435 len
= MODE_LINE_NOPROP_LEN (string_start
);
21436 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
21440 mode_line_string_list
= Fnreverse (mode_line_string_list
);
21441 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
21442 empty_unibyte_string
);
21445 unbind_to (count
, Qnil
);
21449 /* Write a null-terminated, right justified decimal representation of
21450 the positive integer D to BUF using a minimal field width WIDTH. */
21453 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
21455 register char *p
= buf
;
21463 *p
++ = d
% 10 + '0';
21468 for (width
-= (int) (p
- buf
); width
> 0; --width
)
21479 /* Write a null-terminated, right justified decimal and "human
21480 readable" representation of the nonnegative integer D to BUF using
21481 a minimal field width WIDTH. D should be smaller than 999.5e24. */
21483 static const char power_letter
[] =
21497 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
21499 /* We aim to represent the nonnegative integer D as
21500 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
21501 ptrdiff_t quotient
= d
;
21503 /* -1 means: do not use TENTHS. */
21507 /* Length of QUOTIENT.TENTHS as a string. */
21513 if (quotient
>= 1000)
21515 /* Scale to the appropriate EXPONENT. */
21518 remainder
= quotient
% 1000;
21522 while (quotient
>= 1000);
21524 /* Round to nearest and decide whether to use TENTHS or not. */
21527 tenths
= remainder
/ 100;
21528 if (remainder
% 100 >= 50)
21535 if (quotient
== 10)
21543 if (remainder
>= 500)
21545 if (quotient
< 999)
21556 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21557 if (tenths
== -1 && quotient
<= 99)
21564 p
= psuffix
= buf
+ max (width
, length
);
21566 /* Print EXPONENT. */
21567 *psuffix
++ = power_letter
[exponent
];
21570 /* Print TENTHS. */
21573 *--p
= '0' + tenths
;
21577 /* Print QUOTIENT. */
21580 int digit
= quotient
% 10;
21581 *--p
= '0' + digit
;
21583 while ((quotient
/= 10) != 0);
21585 /* Print leading spaces. */
21590 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21591 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21592 type of CODING_SYSTEM. Return updated pointer into BUF. */
21594 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21597 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21600 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21601 const unsigned char *eol_str
;
21603 /* The EOL conversion we are using. */
21604 Lisp_Object eoltype
;
21606 val
= CODING_SYSTEM_SPEC (coding_system
);
21609 if (!VECTORP (val
)) /* Not yet decided. */
21611 *buf
++ = multibyte
? '-' : ' ';
21613 eoltype
= eol_mnemonic_undecided
;
21614 /* Don't mention EOL conversion if it isn't decided. */
21619 Lisp_Object eolvalue
;
21621 attrs
= AREF (val
, 0);
21622 eolvalue
= AREF (val
, 2);
21625 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21630 /* The EOL conversion that is normal on this system. */
21632 if (NILP (eolvalue
)) /* Not yet decided. */
21633 eoltype
= eol_mnemonic_undecided
;
21634 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21635 eoltype
= eol_mnemonic_undecided
;
21636 else /* eolvalue is Qunix, Qdos, or Qmac. */
21637 eoltype
= (EQ (eolvalue
, Qunix
)
21638 ? eol_mnemonic_unix
21639 : (EQ (eolvalue
, Qdos
) == 1
21640 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21646 /* Mention the EOL conversion if it is not the usual one. */
21647 if (STRINGP (eoltype
))
21649 eol_str
= SDATA (eoltype
);
21650 eol_str_len
= SBYTES (eoltype
);
21652 else if (CHARACTERP (eoltype
))
21654 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
21655 int c
= XFASTINT (eoltype
);
21656 eol_str_len
= CHAR_STRING (c
, tmp
);
21661 eol_str
= invalid_eol_type
;
21662 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21664 memcpy (buf
, eol_str
, eol_str_len
);
21665 buf
+= eol_str_len
;
21671 /* Return a string for the output of a mode line %-spec for window W,
21672 generated by character C. FIELD_WIDTH > 0 means pad the string
21673 returned with spaces to that value. Return a Lisp string in
21674 *STRING if the resulting string is taken from that Lisp string.
21676 Note we operate on the current buffer for most purposes. */
21678 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21680 static const char *
21681 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21682 Lisp_Object
*string
)
21685 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21686 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21687 /* We are going to use f->decode_mode_spec_buffer as the buffer to
21688 produce strings from numerical values, so limit preposterously
21689 large values of FIELD_WIDTH to avoid overrunning the buffer's
21690 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
21691 bytes plus the terminating null. */
21692 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
21693 struct buffer
*b
= current_buffer
;
21701 if (!NILP (BVAR (b
, read_only
)))
21703 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21708 /* This differs from %* only for a modified read-only buffer. */
21709 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21711 if (!NILP (BVAR (b
, read_only
)))
21716 /* This differs from %* in ignoring read-only-ness. */
21717 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21729 if (command_loop_level
> 5)
21731 p
= decode_mode_spec_buf
;
21732 for (i
= 0; i
< command_loop_level
; i
++)
21735 return decode_mode_spec_buf
;
21743 if (command_loop_level
> 5)
21745 p
= decode_mode_spec_buf
;
21746 for (i
= 0; i
< command_loop_level
; i
++)
21749 return decode_mode_spec_buf
;
21756 /* Let lots_of_dashes be a string of infinite length. */
21757 if (mode_line_target
== MODE_LINE_NOPROP
21758 || mode_line_target
== MODE_LINE_STRING
)
21760 if (field_width
<= 0
21761 || field_width
> sizeof (lots_of_dashes
))
21763 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21764 decode_mode_spec_buf
[i
] = '-';
21765 decode_mode_spec_buf
[i
] = '\0';
21766 return decode_mode_spec_buf
;
21769 return lots_of_dashes
;
21773 obj
= BVAR (b
, name
);
21777 /* %c and %l are ignored in `frame-title-format'.
21778 (In redisplay_internal, the frame title is drawn _before_ the
21779 windows are updated, so the stuff which depends on actual
21780 window contents (such as %l) may fail to render properly, or
21781 even crash emacs.) */
21782 if (mode_line_target
== MODE_LINE_TITLE
)
21786 ptrdiff_t col
= current_column ();
21787 w
->column_number_displayed
= col
;
21788 pint2str (decode_mode_spec_buf
, width
, col
);
21789 return decode_mode_spec_buf
;
21793 #ifndef SYSTEM_MALLOC
21795 if (NILP (Vmemory_full
))
21798 return "!MEM FULL! ";
21805 /* %F displays the frame name. */
21806 if (!NILP (f
->title
))
21807 return SSDATA (f
->title
);
21808 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21809 return SSDATA (f
->name
);
21813 obj
= BVAR (b
, filename
);
21818 ptrdiff_t size
= ZV
- BEGV
;
21819 pint2str (decode_mode_spec_buf
, width
, size
);
21820 return decode_mode_spec_buf
;
21825 ptrdiff_t size
= ZV
- BEGV
;
21826 pint2hrstr (decode_mode_spec_buf
, width
, size
);
21827 return decode_mode_spec_buf
;
21832 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21833 ptrdiff_t topline
, nlines
, height
;
21836 /* %c and %l are ignored in `frame-title-format'. */
21837 if (mode_line_target
== MODE_LINE_TITLE
)
21840 startpos
= marker_position (w
->start
);
21841 startpos_byte
= marker_byte_position (w
->start
);
21842 height
= WINDOW_TOTAL_LINES (w
);
21844 /* If we decided that this buffer isn't suitable for line numbers,
21845 don't forget that too fast. */
21846 if (w
->base_line_pos
== -1)
21849 /* If the buffer is very big, don't waste time. */
21850 if (INTEGERP (Vline_number_display_limit
)
21851 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21853 w
->base_line_pos
= 0;
21854 w
->base_line_number
= 0;
21858 if (w
->base_line_number
> 0
21859 && w
->base_line_pos
> 0
21860 && w
->base_line_pos
<= startpos
)
21862 line
= w
->base_line_number
;
21863 linepos
= w
->base_line_pos
;
21864 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21869 linepos
= BUF_BEGV (b
);
21870 linepos_byte
= BUF_BEGV_BYTE (b
);
21873 /* Count lines from base line to window start position. */
21874 nlines
= display_count_lines (linepos_byte
,
21878 topline
= nlines
+ line
;
21880 /* Determine a new base line, if the old one is too close
21881 or too far away, or if we did not have one.
21882 "Too close" means it's plausible a scroll-down would
21883 go back past it. */
21884 if (startpos
== BUF_BEGV (b
))
21886 w
->base_line_number
= topline
;
21887 w
->base_line_pos
= BUF_BEGV (b
);
21889 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21890 || linepos
== BUF_BEGV (b
))
21892 ptrdiff_t limit
= BUF_BEGV (b
);
21893 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21894 ptrdiff_t position
;
21895 ptrdiff_t distance
=
21896 (height
* 2 + 30) * line_number_display_limit_width
;
21898 if (startpos
- distance
> limit
)
21900 limit
= startpos
- distance
;
21901 limit_byte
= CHAR_TO_BYTE (limit
);
21904 nlines
= display_count_lines (startpos_byte
,
21906 - (height
* 2 + 30),
21908 /* If we couldn't find the lines we wanted within
21909 line_number_display_limit_width chars per line,
21910 give up on line numbers for this window. */
21911 if (position
== limit_byte
&& limit
== startpos
- distance
)
21913 w
->base_line_pos
= -1;
21914 w
->base_line_number
= 0;
21918 w
->base_line_number
= topline
- nlines
;
21919 w
->base_line_pos
= BYTE_TO_CHAR (position
);
21922 /* Now count lines from the start pos to point. */
21923 nlines
= display_count_lines (startpos_byte
,
21924 PT_BYTE
, PT
, &junk
);
21926 /* Record that we did display the line number. */
21927 line_number_displayed
= 1;
21929 /* Make the string to show. */
21930 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
21931 return decode_mode_spec_buf
;
21934 char* p
= decode_mode_spec_buf
;
21935 int pad
= width
- 2;
21941 return decode_mode_spec_buf
;
21947 obj
= BVAR (b
, mode_name
);
21951 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21957 ptrdiff_t pos
= marker_position (w
->start
);
21958 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21960 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
21962 if (pos
<= BUF_BEGV (b
))
21967 else if (pos
<= BUF_BEGV (b
))
21971 if (total
> 1000000)
21972 /* Do it differently for a large value, to avoid overflow. */
21973 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21975 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21976 /* We can't normally display a 3-digit number,
21977 so get us a 2-digit number that is close. */
21980 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21981 return decode_mode_spec_buf
;
21985 /* Display percentage of size above the bottom of the screen. */
21988 ptrdiff_t toppos
= marker_position (w
->start
);
21989 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
21990 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21992 if (botpos
>= BUF_ZV (b
))
21994 if (toppos
<= BUF_BEGV (b
))
22001 if (total
> 1000000)
22002 /* Do it differently for a large value, to avoid overflow. */
22003 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22005 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22006 /* We can't normally display a 3-digit number,
22007 so get us a 2-digit number that is close. */
22010 if (toppos
<= BUF_BEGV (b
))
22011 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
22013 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22014 return decode_mode_spec_buf
;
22019 /* status of process */
22020 obj
= Fget_buffer_process (Fcurrent_buffer ());
22022 return "no process";
22024 obj
= Fsymbol_name (Fprocess_status (obj
));
22030 ptrdiff_t count
= inhibit_garbage_collection ();
22031 Lisp_Object val
= call1 (intern ("file-remote-p"),
22032 BVAR (current_buffer
, directory
));
22033 unbind_to (count
, Qnil
);
22042 /* coding-system (not including end-of-line format) */
22044 /* coding-system (including end-of-line type) */
22046 int eol_flag
= (c
== 'Z');
22047 char *p
= decode_mode_spec_buf
;
22049 if (! FRAME_WINDOW_P (f
))
22051 /* No need to mention EOL here--the terminal never needs
22052 to do EOL conversion. */
22053 p
= decode_mode_spec_coding (CODING_ID_NAME
22054 (FRAME_KEYBOARD_CODING (f
)->id
),
22056 p
= decode_mode_spec_coding (CODING_ID_NAME
22057 (FRAME_TERMINAL_CODING (f
)->id
),
22060 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
22063 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
22064 #ifdef subprocesses
22065 obj
= Fget_buffer_process (Fcurrent_buffer ());
22066 if (PROCESSP (obj
))
22068 p
= decode_mode_spec_coding
22069 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
22070 p
= decode_mode_spec_coding
22071 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
22073 #endif /* subprocesses */
22076 return decode_mode_spec_buf
;
22083 return SSDATA (obj
);
22090 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
22091 means count lines back from START_BYTE. But don't go beyond
22092 LIMIT_BYTE. Return the number of lines thus found (always
22095 Set *BYTE_POS_PTR to the byte position where we stopped. This is
22096 either the position COUNT lines after/before START_BYTE, if we
22097 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
22101 display_count_lines (ptrdiff_t start_byte
,
22102 ptrdiff_t limit_byte
, ptrdiff_t count
,
22103 ptrdiff_t *byte_pos_ptr
)
22105 register unsigned char *cursor
;
22106 unsigned char *base
;
22108 register ptrdiff_t ceiling
;
22109 register unsigned char *ceiling_addr
;
22110 ptrdiff_t orig_count
= count
;
22112 /* If we are not in selective display mode,
22113 check only for newlines. */
22114 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
22115 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
22119 while (start_byte
< limit_byte
)
22121 ceiling
= BUFFER_CEILING_OF (start_byte
);
22122 ceiling
= min (limit_byte
- 1, ceiling
);
22123 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
22124 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
22128 if (selective_display
)
22130 while (*cursor
!= '\n' && *cursor
!= 015
22131 && ++cursor
!= ceiling_addr
)
22133 if (cursor
== ceiling_addr
)
22138 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
22147 start_byte
+= cursor
- base
;
22148 *byte_pos_ptr
= start_byte
;
22152 while (cursor
< ceiling_addr
);
22154 start_byte
+= ceiling_addr
- base
;
22159 while (start_byte
> limit_byte
)
22161 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
22162 ceiling
= max (limit_byte
, ceiling
);
22163 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
22164 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
22167 if (selective_display
)
22169 while (--cursor
>= ceiling_addr
22170 && *cursor
!= '\n' && *cursor
!= 015)
22172 if (cursor
< ceiling_addr
)
22177 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
22184 start_byte
+= cursor
- base
+ 1;
22185 *byte_pos_ptr
= start_byte
;
22186 /* When scanning backwards, we should
22187 not count the newline posterior to which we stop. */
22188 return - orig_count
- 1;
22191 start_byte
+= ceiling_addr
- base
;
22195 *byte_pos_ptr
= limit_byte
;
22198 return - orig_count
+ count
;
22199 return orig_count
- count
;
22205 /***********************************************************************
22207 ***********************************************************************/
22209 /* Display a NUL-terminated string, starting with index START.
22211 If STRING is non-null, display that C string. Otherwise, the Lisp
22212 string LISP_STRING is displayed. There's a case that STRING is
22213 non-null and LISP_STRING is not nil. It means STRING is a string
22214 data of LISP_STRING. In that case, we display LISP_STRING while
22215 ignoring its text properties.
22217 If FACE_STRING is not nil, FACE_STRING_POS is a position in
22218 FACE_STRING. Display STRING or LISP_STRING with the face at
22219 FACE_STRING_POS in FACE_STRING:
22221 Display the string in the environment given by IT, but use the
22222 standard display table, temporarily.
22224 FIELD_WIDTH is the minimum number of output glyphs to produce.
22225 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22226 with spaces. If STRING has more characters, more than FIELD_WIDTH
22227 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
22229 PRECISION is the maximum number of characters to output from
22230 STRING. PRECISION < 0 means don't truncate the string.
22232 This is roughly equivalent to printf format specifiers:
22234 FIELD_WIDTH PRECISION PRINTF
22235 ----------------------------------------
22241 MULTIBYTE zero means do not display multibyte chars, > 0 means do
22242 display them, and < 0 means obey the current buffer's value of
22243 enable_multibyte_characters.
22245 Value is the number of columns displayed. */
22248 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
22249 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
22250 int field_width
, int precision
, int max_x
, int multibyte
)
22252 int hpos_at_start
= it
->hpos
;
22253 int saved_face_id
= it
->face_id
;
22254 struct glyph_row
*row
= it
->glyph_row
;
22255 ptrdiff_t it_charpos
;
22257 /* Initialize the iterator IT for iteration over STRING beginning
22258 with index START. */
22259 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
22260 precision
, field_width
, multibyte
);
22261 if (string
&& STRINGP (lisp_string
))
22262 /* LISP_STRING is the one returned by decode_mode_spec. We should
22263 ignore its text properties. */
22264 it
->stop_charpos
= it
->end_charpos
;
22266 /* If displaying STRING, set up the face of the iterator from
22267 FACE_STRING, if that's given. */
22268 if (STRINGP (face_string
))
22274 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
22275 0, it
->region_beg_charpos
,
22276 it
->region_end_charpos
,
22277 &endptr
, it
->base_face_id
, 0);
22278 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22279 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
22282 /* Set max_x to the maximum allowed X position. Don't let it go
22283 beyond the right edge of the window. */
22285 max_x
= it
->last_visible_x
;
22287 max_x
= min (max_x
, it
->last_visible_x
);
22289 /* Skip over display elements that are not visible. because IT->w is
22291 if (it
->current_x
< it
->first_visible_x
)
22292 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
22293 MOVE_TO_POS
| MOVE_TO_X
);
22295 row
->ascent
= it
->max_ascent
;
22296 row
->height
= it
->max_ascent
+ it
->max_descent
;
22297 row
->phys_ascent
= it
->max_phys_ascent
;
22298 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
22299 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
22301 if (STRINGP (it
->string
))
22302 it_charpos
= IT_STRING_CHARPOS (*it
);
22304 it_charpos
= IT_CHARPOS (*it
);
22306 /* This condition is for the case that we are called with current_x
22307 past last_visible_x. */
22308 while (it
->current_x
< max_x
)
22310 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
22312 /* Get the next display element. */
22313 if (!get_next_display_element (it
))
22316 /* Produce glyphs. */
22317 x_before
= it
->current_x
;
22318 n_glyphs_before
= row
->used
[TEXT_AREA
];
22319 PRODUCE_GLYPHS (it
);
22321 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
22324 while (i
< nglyphs
)
22326 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
22328 if (it
->line_wrap
!= TRUNCATE
22329 && x
+ glyph
->pixel_width
> max_x
)
22331 /* End of continued line or max_x reached. */
22332 if (CHAR_GLYPH_PADDING_P (*glyph
))
22334 /* A wide character is unbreakable. */
22335 if (row
->reversed_p
)
22336 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
22337 - n_glyphs_before
);
22338 row
->used
[TEXT_AREA
] = n_glyphs_before
;
22339 it
->current_x
= x_before
;
22343 if (row
->reversed_p
)
22344 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
22345 - (n_glyphs_before
+ i
));
22346 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
22351 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
22353 /* Glyph is at least partially visible. */
22355 if (x
< it
->first_visible_x
)
22356 row
->x
= x
- it
->first_visible_x
;
22360 /* Glyph is off the left margin of the display area.
22361 Should not happen. */
22365 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
22366 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
22367 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
22368 row
->phys_height
= max (row
->phys_height
,
22369 it
->max_phys_ascent
+ it
->max_phys_descent
);
22370 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
22371 it
->max_extra_line_spacing
);
22372 x
+= glyph
->pixel_width
;
22376 /* Stop if max_x reached. */
22380 /* Stop at line ends. */
22381 if (ITERATOR_AT_END_OF_LINE_P (it
))
22383 it
->continuation_lines_width
= 0;
22387 set_iterator_to_next (it
, 1);
22388 if (STRINGP (it
->string
))
22389 it_charpos
= IT_STRING_CHARPOS (*it
);
22391 it_charpos
= IT_CHARPOS (*it
);
22393 /* Stop if truncating at the right edge. */
22394 if (it
->line_wrap
== TRUNCATE
22395 && it
->current_x
>= it
->last_visible_x
)
22397 /* Add truncation mark, but don't do it if the line is
22398 truncated at a padding space. */
22399 if (it_charpos
< it
->string_nchars
)
22401 if (!FRAME_WINDOW_P (it
->f
))
22405 if (it
->current_x
> it
->last_visible_x
)
22407 if (!row
->reversed_p
)
22409 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
22410 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22415 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
22416 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22418 unproduce_glyphs (it
, ii
+ 1);
22419 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
22421 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
22423 row
->used
[TEXT_AREA
] = ii
;
22424 produce_special_glyphs (it
, IT_TRUNCATION
);
22427 produce_special_glyphs (it
, IT_TRUNCATION
);
22429 row
->truncated_on_right_p
= 1;
22435 /* Maybe insert a truncation at the left. */
22436 if (it
->first_visible_x
22439 if (!FRAME_WINDOW_P (it
->f
)
22440 || (row
->reversed_p
22441 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22442 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
22443 insert_left_trunc_glyphs (it
);
22444 row
->truncated_on_left_p
= 1;
22447 it
->face_id
= saved_face_id
;
22449 /* Value is number of columns displayed. */
22450 return it
->hpos
- hpos_at_start
;
22455 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
22456 appears as an element of LIST or as the car of an element of LIST.
22457 If PROPVAL is a list, compare each element against LIST in that
22458 way, and return 1/2 if any element of PROPVAL is found in LIST.
22459 Otherwise return 0. This function cannot quit.
22460 The return value is 2 if the text is invisible but with an ellipsis
22461 and 1 if it's invisible and without an ellipsis. */
22464 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
22466 register Lisp_Object tail
, proptail
;
22468 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22470 register Lisp_Object tem
;
22472 if (EQ (propval
, tem
))
22474 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
22475 return NILP (XCDR (tem
)) ? 1 : 2;
22478 if (CONSP (propval
))
22480 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
22482 Lisp_Object propelt
;
22483 propelt
= XCAR (proptail
);
22484 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22486 register Lisp_Object tem
;
22488 if (EQ (propelt
, tem
))
22490 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
22491 return NILP (XCDR (tem
)) ? 1 : 2;
22499 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
22500 doc
: /* Non-nil if the property makes the text invisible.
22501 POS-OR-PROP can be a marker or number, in which case it is taken to be
22502 a position in the current buffer and the value of the `invisible' property
22503 is checked; or it can be some other value, which is then presumed to be the
22504 value of the `invisible' property of the text of interest.
22505 The non-nil value returned can be t for truly invisible text or something
22506 else if the text is replaced by an ellipsis. */)
22507 (Lisp_Object pos_or_prop
)
22510 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
22511 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
22513 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
22514 return (invis
== 0 ? Qnil
22516 : make_number (invis
));
22519 /* Calculate a width or height in pixels from a specification using
22520 the following elements:
22523 NUM - a (fractional) multiple of the default font width/height
22524 (NUM) - specifies exactly NUM pixels
22525 UNIT - a fixed number of pixels, see below.
22526 ELEMENT - size of a display element in pixels, see below.
22527 (NUM . SPEC) - equals NUM * SPEC
22528 (+ SPEC SPEC ...) - add pixel values
22529 (- SPEC SPEC ...) - subtract pixel values
22530 (- SPEC) - negate pixel value
22533 INT or FLOAT - a number constant
22534 SYMBOL - use symbol's (buffer local) variable binding.
22537 in - pixels per inch *)
22538 mm - pixels per 1/1000 meter *)
22539 cm - pixels per 1/100 meter *)
22540 width - width of current font in pixels.
22541 height - height of current font in pixels.
22543 *) using the ratio(s) defined in display-pixels-per-inch.
22547 left-fringe - left fringe width in pixels
22548 right-fringe - right fringe width in pixels
22550 left-margin - left margin width in pixels
22551 right-margin - right margin width in pixels
22553 scroll-bar - scroll-bar area width in pixels
22557 Pixels corresponding to 5 inches:
22560 Total width of non-text areas on left side of window (if scroll-bar is on left):
22561 '(space :width (+ left-fringe left-margin scroll-bar))
22563 Align to first text column (in header line):
22564 '(space :align-to 0)
22566 Align to middle of text area minus half the width of variable `my-image'
22567 containing a loaded image:
22568 '(space :align-to (0.5 . (- text my-image)))
22570 Width of left margin minus width of 1 character in the default font:
22571 '(space :width (- left-margin 1))
22573 Width of left margin minus width of 2 characters in the current font:
22574 '(space :width (- left-margin (2 . width)))
22576 Center 1 character over left-margin (in header line):
22577 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22579 Different ways to express width of left fringe plus left margin minus one pixel:
22580 '(space :width (- (+ left-fringe left-margin) (1)))
22581 '(space :width (+ left-fringe left-margin (- (1))))
22582 '(space :width (+ left-fringe left-margin (-1)))
22587 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22588 struct font
*font
, int width_p
, int *align_to
)
22592 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22593 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22596 return OK_PIXELS (0);
22598 eassert (FRAME_LIVE_P (it
->f
));
22600 if (SYMBOLP (prop
))
22602 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22604 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22606 if (unit
[0] == 'i' && unit
[1] == 'n')
22608 else if (unit
[0] == 'm' && unit
[1] == 'm')
22610 else if (unit
[0] == 'c' && unit
[1] == 'm')
22616 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
22617 : FRAME_RES_Y (it
->f
));
22620 return OK_PIXELS (ppi
/ pixels
);
22625 #ifdef HAVE_WINDOW_SYSTEM
22626 if (EQ (prop
, Qheight
))
22627 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22628 if (EQ (prop
, Qwidth
))
22629 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22631 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22632 return OK_PIXELS (1);
22635 if (EQ (prop
, Qtext
))
22636 return OK_PIXELS (width_p
22637 ? window_box_width (it
->w
, TEXT_AREA
)
22638 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22640 if (align_to
&& *align_to
< 0)
22643 if (EQ (prop
, Qleft
))
22644 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22645 if (EQ (prop
, Qright
))
22646 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22647 if (EQ (prop
, Qcenter
))
22648 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22649 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22650 if (EQ (prop
, Qleft_fringe
))
22651 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22652 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22653 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22654 if (EQ (prop
, Qright_fringe
))
22655 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22656 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22657 : window_box_right_offset (it
->w
, TEXT_AREA
));
22658 if (EQ (prop
, Qleft_margin
))
22659 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22660 if (EQ (prop
, Qright_margin
))
22661 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22662 if (EQ (prop
, Qscroll_bar
))
22663 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22665 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22666 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22667 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22672 if (EQ (prop
, Qleft_fringe
))
22673 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22674 if (EQ (prop
, Qright_fringe
))
22675 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22676 if (EQ (prop
, Qleft_margin
))
22677 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22678 if (EQ (prop
, Qright_margin
))
22679 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22680 if (EQ (prop
, Qscroll_bar
))
22681 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22684 prop
= buffer_local_value_1 (prop
, it
->w
->contents
);
22685 if (EQ (prop
, Qunbound
))
22689 if (INTEGERP (prop
) || FLOATP (prop
))
22691 int base_unit
= (width_p
22692 ? FRAME_COLUMN_WIDTH (it
->f
)
22693 : FRAME_LINE_HEIGHT (it
->f
));
22694 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22699 Lisp_Object car
= XCAR (prop
);
22700 Lisp_Object cdr
= XCDR (prop
);
22704 #ifdef HAVE_WINDOW_SYSTEM
22705 if (FRAME_WINDOW_P (it
->f
)
22706 && valid_image_p (prop
))
22708 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22709 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22711 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22714 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22720 while (CONSP (cdr
))
22722 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22723 font
, width_p
, align_to
))
22726 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22731 if (EQ (car
, Qminus
))
22733 return OK_PIXELS (pixels
);
22736 car
= buffer_local_value_1 (car
, it
->w
->contents
);
22737 if (EQ (car
, Qunbound
))
22741 if (INTEGERP (car
) || FLOATP (car
))
22744 pixels
= XFLOATINT (car
);
22746 return OK_PIXELS (pixels
);
22747 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22748 font
, width_p
, align_to
))
22749 return OK_PIXELS (pixels
* fact
);
22760 /***********************************************************************
22762 ***********************************************************************/
22764 #ifdef HAVE_WINDOW_SYSTEM
22769 dump_glyph_string (struct glyph_string
*s
)
22771 fprintf (stderr
, "glyph string\n");
22772 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22773 s
->x
, s
->y
, s
->width
, s
->height
);
22774 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22775 fprintf (stderr
, " hl = %d\n", s
->hl
);
22776 fprintf (stderr
, " left overhang = %d, right = %d\n",
22777 s
->left_overhang
, s
->right_overhang
);
22778 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22779 fprintf (stderr
, " extends to end of line = %d\n",
22780 s
->extends_to_end_of_line_p
);
22781 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22782 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22785 #endif /* GLYPH_DEBUG */
22787 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22788 of XChar2b structures for S; it can't be allocated in
22789 init_glyph_string because it must be allocated via `alloca'. W
22790 is the window on which S is drawn. ROW and AREA are the glyph row
22791 and area within the row from which S is constructed. START is the
22792 index of the first glyph structure covered by S. HL is a
22793 face-override for drawing S. */
22796 #define OPTIONAL_HDC(hdc) HDC hdc,
22797 #define DECLARE_HDC(hdc) HDC hdc;
22798 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22799 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22802 #ifndef OPTIONAL_HDC
22803 #define OPTIONAL_HDC(hdc)
22804 #define DECLARE_HDC(hdc)
22805 #define ALLOCATE_HDC(hdc, f)
22806 #define RELEASE_HDC(hdc, f)
22810 init_glyph_string (struct glyph_string
*s
,
22812 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22813 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22815 memset (s
, 0, sizeof *s
);
22817 s
->f
= XFRAME (w
->frame
);
22821 s
->display
= FRAME_X_DISPLAY (s
->f
);
22822 s
->window
= FRAME_X_WINDOW (s
->f
);
22823 s
->char2b
= char2b
;
22827 s
->first_glyph
= row
->glyphs
[area
] + start
;
22828 s
->height
= row
->height
;
22829 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22830 s
->ybase
= s
->y
+ row
->ascent
;
22834 /* Append the list of glyph strings with head H and tail T to the list
22835 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22838 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22839 struct glyph_string
*h
, struct glyph_string
*t
)
22853 /* Prepend the list of glyph strings with head H and tail T to the
22854 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22858 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22859 struct glyph_string
*h
, struct glyph_string
*t
)
22873 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22874 Set *HEAD and *TAIL to the resulting list. */
22877 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22878 struct glyph_string
*s
)
22880 s
->next
= s
->prev
= NULL
;
22881 append_glyph_string_lists (head
, tail
, s
, s
);
22885 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22886 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22887 make sure that X resources for the face returned are allocated.
22888 Value is a pointer to a realized face that is ready for display if
22889 DISPLAY_P is non-zero. */
22891 static struct face
*
22892 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22893 XChar2b
*char2b
, int display_p
)
22895 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22900 code
= face
->font
->driver
->encode_char (face
->font
, c
);
22902 if (code
== FONT_INVALID_CODE
)
22905 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22907 /* Make sure X resources of the face are allocated. */
22908 #ifdef HAVE_X_WINDOWS
22912 eassert (face
!= NULL
);
22913 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22920 /* Get face and two-byte form of character glyph GLYPH on frame F.
22921 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22922 a pointer to a realized face that is ready for display. */
22924 static struct face
*
22925 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22926 XChar2b
*char2b
, int *two_byte_p
)
22931 eassert (glyph
->type
== CHAR_GLYPH
);
22932 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22934 /* Make sure X resources of the face are allocated. */
22935 eassert (face
!= NULL
);
22936 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22943 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22944 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22946 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22948 if (code
== FONT_INVALID_CODE
)
22952 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22957 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22958 Return 1 if FONT has a glyph for C, otherwise return 0. */
22961 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22965 if (CHAR_BYTE8_P (c
))
22966 code
= CHAR_TO_BYTE8 (c
);
22968 code
= font
->driver
->encode_char (font
, c
);
22970 if (code
== FONT_INVALID_CODE
)
22972 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22977 /* Fill glyph string S with composition components specified by S->cmp.
22979 BASE_FACE is the base face of the composition.
22980 S->cmp_from is the index of the first component for S.
22982 OVERLAPS non-zero means S should draw the foreground only, and use
22983 its physical height for clipping. See also draw_glyphs.
22985 Value is the index of a component not in S. */
22988 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22992 /* For all glyphs of this composition, starting at the offset
22993 S->cmp_from, until we reach the end of the definition or encounter a
22994 glyph that requires the different face, add it to S. */
22999 s
->for_overlaps
= overlaps
;
23002 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
23004 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
23006 /* TAB in a composition means display glyphs with padding space
23007 on the left or right. */
23010 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
23013 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
23020 s
->font
= s
->face
->font
;
23022 else if (s
->face
!= face
)
23030 if (s
->face
== NULL
)
23032 s
->face
= base_face
->ascii_face
;
23033 s
->font
= s
->face
->font
;
23036 /* All glyph strings for the same composition has the same width,
23037 i.e. the width set for the first component of the composition. */
23038 s
->width
= s
->first_glyph
->pixel_width
;
23040 /* If the specified font could not be loaded, use the frame's
23041 default font, but record the fact that we couldn't load it in
23042 the glyph string so that we can draw rectangles for the
23043 characters of the glyph string. */
23044 if (s
->font
== NULL
)
23046 s
->font_not_found_p
= 1;
23047 s
->font
= FRAME_FONT (s
->f
);
23050 /* Adjust base line for subscript/superscript text. */
23051 s
->ybase
+= s
->first_glyph
->voffset
;
23053 /* This glyph string must always be drawn with 16-bit functions. */
23060 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
23061 int start
, int end
, int overlaps
)
23063 struct glyph
*glyph
, *last
;
23064 Lisp_Object lgstring
;
23067 s
->for_overlaps
= overlaps
;
23068 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23069 last
= s
->row
->glyphs
[s
->area
] + end
;
23070 s
->cmp_id
= glyph
->u
.cmp
.id
;
23071 s
->cmp_from
= glyph
->slice
.cmp
.from
;
23072 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
23073 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23074 lgstring
= composition_gstring_from_id (s
->cmp_id
);
23075 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
23077 while (glyph
< last
23078 && glyph
->u
.cmp
.automatic
23079 && glyph
->u
.cmp
.id
== s
->cmp_id
23080 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
23081 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
23083 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
23085 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
23086 unsigned code
= LGLYPH_CODE (lglyph
);
23088 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
23090 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
23091 return glyph
- s
->row
->glyphs
[s
->area
];
23095 /* Fill glyph string S from a sequence glyphs for glyphless characters.
23096 See the comment of fill_glyph_string for arguments.
23097 Value is the index of the first glyph not in S. */
23101 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
23102 int start
, int end
, int overlaps
)
23104 struct glyph
*glyph
, *last
;
23107 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
23108 s
->for_overlaps
= overlaps
;
23109 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23110 last
= s
->row
->glyphs
[s
->area
] + end
;
23111 voffset
= glyph
->voffset
;
23112 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23113 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
23115 s
->width
= glyph
->pixel_width
;
23117 while (glyph
< last
23118 && glyph
->type
== GLYPHLESS_GLYPH
23119 && glyph
->voffset
== voffset
23120 && glyph
->face_id
== face_id
)
23123 s
->width
+= glyph
->pixel_width
;
23126 s
->ybase
+= voffset
;
23127 return glyph
- s
->row
->glyphs
[s
->area
];
23131 /* Fill glyph string S from a sequence of character glyphs.
23133 FACE_ID is the face id of the string. START is the index of the
23134 first glyph to consider, END is the index of the last + 1.
23135 OVERLAPS non-zero means S should draw the foreground only, and use
23136 its physical height for clipping. See also draw_glyphs.
23138 Value is the index of the first glyph not in S. */
23141 fill_glyph_string (struct glyph_string
*s
, int face_id
,
23142 int start
, int end
, int overlaps
)
23144 struct glyph
*glyph
, *last
;
23146 int glyph_not_available_p
;
23148 eassert (s
->f
== XFRAME (s
->w
->frame
));
23149 eassert (s
->nchars
== 0);
23150 eassert (start
>= 0 && end
> start
);
23152 s
->for_overlaps
= overlaps
;
23153 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23154 last
= s
->row
->glyphs
[s
->area
] + end
;
23155 voffset
= glyph
->voffset
;
23156 s
->padding_p
= glyph
->padding_p
;
23157 glyph_not_available_p
= glyph
->glyph_not_available_p
;
23159 while (glyph
< last
23160 && glyph
->type
== CHAR_GLYPH
23161 && glyph
->voffset
== voffset
23162 /* Same face id implies same font, nowadays. */
23163 && glyph
->face_id
== face_id
23164 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
23168 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
23169 s
->char2b
+ s
->nchars
,
23171 s
->two_byte_p
= two_byte_p
;
23173 eassert (s
->nchars
<= end
- start
);
23174 s
->width
+= glyph
->pixel_width
;
23175 if (glyph
++->padding_p
!= s
->padding_p
)
23179 s
->font
= s
->face
->font
;
23181 /* If the specified font could not be loaded, use the frame's font,
23182 but record the fact that we couldn't load it in
23183 S->font_not_found_p so that we can draw rectangles for the
23184 characters of the glyph string. */
23185 if (s
->font
== NULL
|| glyph_not_available_p
)
23187 s
->font_not_found_p
= 1;
23188 s
->font
= FRAME_FONT (s
->f
);
23191 /* Adjust base line for subscript/superscript text. */
23192 s
->ybase
+= voffset
;
23194 eassert (s
->face
&& s
->face
->gc
);
23195 return glyph
- s
->row
->glyphs
[s
->area
];
23199 /* Fill glyph string S from image glyph S->first_glyph. */
23202 fill_image_glyph_string (struct glyph_string
*s
)
23204 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
23205 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
23207 s
->slice
= s
->first_glyph
->slice
.img
;
23208 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
23209 s
->font
= s
->face
->font
;
23210 s
->width
= s
->first_glyph
->pixel_width
;
23212 /* Adjust base line for subscript/superscript text. */
23213 s
->ybase
+= s
->first_glyph
->voffset
;
23217 /* Fill glyph string S from a sequence of stretch glyphs.
23219 START is the index of the first glyph to consider,
23220 END is the index of the last + 1.
23222 Value is the index of the first glyph not in S. */
23225 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
23227 struct glyph
*glyph
, *last
;
23228 int voffset
, face_id
;
23230 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
23232 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23233 last
= s
->row
->glyphs
[s
->area
] + end
;
23234 face_id
= glyph
->face_id
;
23235 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23236 s
->font
= s
->face
->font
;
23237 s
->width
= glyph
->pixel_width
;
23239 voffset
= glyph
->voffset
;
23243 && glyph
->type
== STRETCH_GLYPH
23244 && glyph
->voffset
== voffset
23245 && glyph
->face_id
== face_id
);
23247 s
->width
+= glyph
->pixel_width
;
23249 /* Adjust base line for subscript/superscript text. */
23250 s
->ybase
+= voffset
;
23252 /* The case that face->gc == 0 is handled when drawing the glyph
23253 string by calling PREPARE_FACE_FOR_DISPLAY. */
23255 return glyph
- s
->row
->glyphs
[s
->area
];
23258 static struct font_metrics
*
23259 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
23261 static struct font_metrics metrics
;
23266 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
23267 if (code
== FONT_INVALID_CODE
)
23269 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
23274 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
23275 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
23276 assumed to be zero. */
23279 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
23281 *left
= *right
= 0;
23283 if (glyph
->type
== CHAR_GLYPH
)
23287 struct font_metrics
*pcm
;
23289 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
23290 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
23292 if (pcm
->rbearing
> pcm
->width
)
23293 *right
= pcm
->rbearing
- pcm
->width
;
23294 if (pcm
->lbearing
< 0)
23295 *left
= -pcm
->lbearing
;
23298 else if (glyph
->type
== COMPOSITE_GLYPH
)
23300 if (! glyph
->u
.cmp
.automatic
)
23302 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
23304 if (cmp
->rbearing
> cmp
->pixel_width
)
23305 *right
= cmp
->rbearing
- cmp
->pixel_width
;
23306 if (cmp
->lbearing
< 0)
23307 *left
= - cmp
->lbearing
;
23311 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
23312 struct font_metrics metrics
;
23314 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
23315 glyph
->slice
.cmp
.to
+ 1, &metrics
);
23316 if (metrics
.rbearing
> metrics
.width
)
23317 *right
= metrics
.rbearing
- metrics
.width
;
23318 if (metrics
.lbearing
< 0)
23319 *left
= - metrics
.lbearing
;
23325 /* Return the index of the first glyph preceding glyph string S that
23326 is overwritten by S because of S's left overhang. Value is -1
23327 if no glyphs are overwritten. */
23330 left_overwritten (struct glyph_string
*s
)
23334 if (s
->left_overhang
)
23337 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23338 int first
= s
->first_glyph
- glyphs
;
23340 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
23341 x
-= glyphs
[i
].pixel_width
;
23352 /* Return the index of the first glyph preceding glyph string S that
23353 is overwriting S because of its right overhang. Value is -1 if no
23354 glyph in front of S overwrites S. */
23357 left_overwriting (struct glyph_string
*s
)
23360 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23361 int first
= s
->first_glyph
- glyphs
;
23365 for (i
= first
- 1; i
>= 0; --i
)
23368 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23371 x
-= glyphs
[i
].pixel_width
;
23378 /* Return the index of the last glyph following glyph string S that is
23379 overwritten by S because of S's right overhang. Value is -1 if
23380 no such glyph is found. */
23383 right_overwritten (struct glyph_string
*s
)
23387 if (s
->right_overhang
)
23390 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23391 int first
= (s
->first_glyph
- glyphs
23392 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23393 int end
= s
->row
->used
[s
->area
];
23395 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
23396 x
+= glyphs
[i
].pixel_width
;
23405 /* Return the index of the last glyph following glyph string S that
23406 overwrites S because of its left overhang. Value is negative
23407 if no such glyph is found. */
23410 right_overwriting (struct glyph_string
*s
)
23413 int end
= s
->row
->used
[s
->area
];
23414 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23415 int first
= (s
->first_glyph
- glyphs
23416 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23420 for (i
= first
; i
< end
; ++i
)
23423 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23426 x
+= glyphs
[i
].pixel_width
;
23433 /* Set background width of glyph string S. START is the index of the
23434 first glyph following S. LAST_X is the right-most x-position + 1
23435 in the drawing area. */
23438 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
23440 /* If the face of this glyph string has to be drawn to the end of
23441 the drawing area, set S->extends_to_end_of_line_p. */
23443 if (start
== s
->row
->used
[s
->area
]
23444 && s
->area
== TEXT_AREA
23445 && ((s
->row
->fill_line_p
23446 && (s
->hl
== DRAW_NORMAL_TEXT
23447 || s
->hl
== DRAW_IMAGE_RAISED
23448 || s
->hl
== DRAW_IMAGE_SUNKEN
))
23449 || s
->hl
== DRAW_MOUSE_FACE
))
23450 s
->extends_to_end_of_line_p
= 1;
23452 /* If S extends its face to the end of the line, set its
23453 background_width to the distance to the right edge of the drawing
23455 if (s
->extends_to_end_of_line_p
)
23456 s
->background_width
= last_x
- s
->x
+ 1;
23458 s
->background_width
= s
->width
;
23462 /* Compute overhangs and x-positions for glyph string S and its
23463 predecessors, or successors. X is the starting x-position for S.
23464 BACKWARD_P non-zero means process predecessors. */
23467 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
23473 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23474 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23484 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23485 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23495 /* The following macros are only called from draw_glyphs below.
23496 They reference the following parameters of that function directly:
23497 `w', `row', `area', and `overlap_p'
23498 as well as the following local variables:
23499 `s', `f', and `hdc' (in W32) */
23502 /* On W32, silently add local `hdc' variable to argument list of
23503 init_glyph_string. */
23504 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23505 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23507 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23508 init_glyph_string (s, char2b, w, row, area, start, hl)
23511 /* Add a glyph string for a stretch glyph to the list of strings
23512 between HEAD and TAIL. START is the index of the stretch glyph in
23513 row area AREA of glyph row ROW. END is the index of the last glyph
23514 in that glyph row area. X is the current output position assigned
23515 to the new glyph string constructed. HL overrides that face of the
23516 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23517 is the right-most x-position of the drawing area. */
23519 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23520 and below -- keep them on one line. */
23521 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23524 s = alloca (sizeof *s); \
23525 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23526 START = fill_stretch_glyph_string (s, START, END); \
23527 append_glyph_string (&HEAD, &TAIL, s); \
23533 /* Add a glyph string for an image glyph to the list of strings
23534 between HEAD and TAIL. START is the index of the image glyph in
23535 row area AREA of glyph row ROW. END is the index of the last glyph
23536 in that glyph row area. X is the current output position assigned
23537 to the new glyph string constructed. HL overrides that face of the
23538 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23539 is the right-most x-position of the drawing area. */
23541 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23544 s = alloca (sizeof *s); \
23545 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23546 fill_image_glyph_string (s); \
23547 append_glyph_string (&HEAD, &TAIL, s); \
23554 /* Add a glyph string for a sequence of character glyphs to the list
23555 of strings between HEAD and TAIL. START is the index of the first
23556 glyph in row area AREA of glyph row ROW that is part of the new
23557 glyph string. END is the index of the last glyph in that glyph row
23558 area. X is the current output position assigned to the new glyph
23559 string constructed. HL overrides that face of the glyph; e.g. it
23560 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23561 right-most x-position of the drawing area. */
23563 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23569 face_id = (row)->glyphs[area][START].face_id; \
23571 s = alloca (sizeof *s); \
23572 char2b = alloca ((END - START) * sizeof *char2b); \
23573 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23574 append_glyph_string (&HEAD, &TAIL, s); \
23576 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23581 /* Add a glyph string for a composite sequence to the list of strings
23582 between HEAD and TAIL. START is the index of the first glyph in
23583 row area AREA of glyph row ROW that is part of the new glyph
23584 string. END is the index of the last glyph in that glyph row area.
23585 X is the current output position assigned to the new glyph string
23586 constructed. HL overrides that face of the glyph; e.g. it is
23587 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23588 x-position of the drawing area. */
23590 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23592 int face_id = (row)->glyphs[area][START].face_id; \
23593 struct face *base_face = FACE_FROM_ID (f, face_id); \
23594 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23595 struct composition *cmp = composition_table[cmp_id]; \
23597 struct glyph_string *first_s = NULL; \
23600 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23602 /* Make glyph_strings for each glyph sequence that is drawable by \
23603 the same face, and append them to HEAD/TAIL. */ \
23604 for (n = 0; n < cmp->glyph_len;) \
23606 s = alloca (sizeof *s); \
23607 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23608 append_glyph_string (&(HEAD), &(TAIL), s); \
23614 n = fill_composite_glyph_string (s, base_face, overlaps); \
23622 /* Add a glyph string for a glyph-string sequence to the list of strings
23623 between HEAD and TAIL. */
23625 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23629 Lisp_Object gstring; \
23631 face_id = (row)->glyphs[area][START].face_id; \
23632 gstring = (composition_gstring_from_id \
23633 ((row)->glyphs[area][START].u.cmp.id)); \
23634 s = alloca (sizeof *s); \
23635 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23636 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23637 append_glyph_string (&(HEAD), &(TAIL), s); \
23639 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23643 /* Add a glyph string for a sequence of glyphless character's glyphs
23644 to the list of strings between HEAD and TAIL. The meanings of
23645 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23647 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23652 face_id = (row)->glyphs[area][START].face_id; \
23654 s = alloca (sizeof *s); \
23655 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23656 append_glyph_string (&HEAD, &TAIL, s); \
23658 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23664 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23665 of AREA of glyph row ROW on window W between indices START and END.
23666 HL overrides the face for drawing glyph strings, e.g. it is
23667 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23668 x-positions of the drawing area.
23670 This is an ugly monster macro construct because we must use alloca
23671 to allocate glyph strings (because draw_glyphs can be called
23672 asynchronously). */
23674 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23677 HEAD = TAIL = NULL; \
23678 while (START < END) \
23680 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23681 switch (first_glyph->type) \
23684 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23688 case COMPOSITE_GLYPH: \
23689 if (first_glyph->u.cmp.automatic) \
23690 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23693 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23697 case STRETCH_GLYPH: \
23698 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23702 case IMAGE_GLYPH: \
23703 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23707 case GLYPHLESS_GLYPH: \
23708 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23718 set_glyph_string_background_width (s, START, LAST_X); \
23725 /* Draw glyphs between START and END in AREA of ROW on window W,
23726 starting at x-position X. X is relative to AREA in W. HL is a
23727 face-override with the following meaning:
23729 DRAW_NORMAL_TEXT draw normally
23730 DRAW_CURSOR draw in cursor face
23731 DRAW_MOUSE_FACE draw in mouse face.
23732 DRAW_INVERSE_VIDEO draw in mode line face
23733 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23734 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23736 If OVERLAPS is non-zero, draw only the foreground of characters and
23737 clip to the physical height of ROW. Non-zero value also defines
23738 the overlapping part to be drawn:
23740 OVERLAPS_PRED overlap with preceding rows
23741 OVERLAPS_SUCC overlap with succeeding rows
23742 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23743 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23745 Value is the x-position reached, relative to AREA of W. */
23748 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23749 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23750 enum draw_glyphs_face hl
, int overlaps
)
23752 struct glyph_string
*head
, *tail
;
23753 struct glyph_string
*s
;
23754 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23755 int i
, j
, x_reached
, last_x
, area_left
= 0;
23756 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23759 ALLOCATE_HDC (hdc
, f
);
23761 /* Let's rather be paranoid than getting a SEGV. */
23762 end
= min (end
, row
->used
[area
]);
23763 start
= clip_to_bounds (0, start
, end
);
23765 /* Translate X to frame coordinates. Set last_x to the right
23766 end of the drawing area. */
23767 if (row
->full_width_p
)
23769 /* X is relative to the left edge of W, without scroll bars
23771 area_left
= WINDOW_LEFT_EDGE_X (w
);
23772 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23776 area_left
= window_box_left (w
, area
);
23777 last_x
= area_left
+ window_box_width (w
, area
);
23781 /* Build a doubly-linked list of glyph_string structures between
23782 head and tail from what we have to draw. Note that the macro
23783 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23784 the reason we use a separate variable `i'. */
23786 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23788 x_reached
= tail
->x
+ tail
->background_width
;
23792 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23793 the row, redraw some glyphs in front or following the glyph
23794 strings built above. */
23795 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23797 struct glyph_string
*h
, *t
;
23798 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23799 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23800 int check_mouse_face
= 0;
23803 /* If mouse highlighting is on, we may need to draw adjacent
23804 glyphs using mouse-face highlighting. */
23805 if (area
== TEXT_AREA
&& row
->mouse_face_p
23806 && hlinfo
->mouse_face_beg_row
>= 0
23807 && hlinfo
->mouse_face_end_row
>= 0)
23809 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23811 if (row_vpos
>= hlinfo
->mouse_face_beg_row
23812 && row_vpos
<= hlinfo
->mouse_face_end_row
)
23814 check_mouse_face
= 1;
23815 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
23816 ? hlinfo
->mouse_face_beg_col
: 0;
23817 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
23818 ? hlinfo
->mouse_face_end_col
23819 : row
->used
[TEXT_AREA
];
23823 /* Compute overhangs for all glyph strings. */
23824 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23825 for (s
= head
; s
; s
= s
->next
)
23826 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23828 /* Prepend glyph strings for glyphs in front of the first glyph
23829 string that are overwritten because of the first glyph
23830 string's left overhang. The background of all strings
23831 prepended must be drawn because the first glyph string
23833 i
= left_overwritten (head
);
23836 enum draw_glyphs_face overlap_hl
;
23838 /* If this row contains mouse highlighting, attempt to draw
23839 the overlapped glyphs with the correct highlight. This
23840 code fails if the overlap encompasses more than one glyph
23841 and mouse-highlight spans only some of these glyphs.
23842 However, making it work perfectly involves a lot more
23843 code, and I don't know if the pathological case occurs in
23844 practice, so we'll stick to this for now. --- cyd */
23845 if (check_mouse_face
23846 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23847 overlap_hl
= DRAW_MOUSE_FACE
;
23849 overlap_hl
= DRAW_NORMAL_TEXT
;
23852 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23853 overlap_hl
, dummy_x
, last_x
);
23855 compute_overhangs_and_x (t
, head
->x
, 1);
23856 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23860 /* Prepend glyph strings for glyphs in front of the first glyph
23861 string that overwrite that glyph string because of their
23862 right overhang. For these strings, only the foreground must
23863 be drawn, because it draws over the glyph string at `head'.
23864 The background must not be drawn because this would overwrite
23865 right overhangs of preceding glyphs for which no glyph
23867 i
= left_overwriting (head
);
23870 enum draw_glyphs_face overlap_hl
;
23872 if (check_mouse_face
23873 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23874 overlap_hl
= DRAW_MOUSE_FACE
;
23876 overlap_hl
= DRAW_NORMAL_TEXT
;
23879 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23880 overlap_hl
, dummy_x
, last_x
);
23881 for (s
= h
; s
; s
= s
->next
)
23882 s
->background_filled_p
= 1;
23883 compute_overhangs_and_x (t
, head
->x
, 1);
23884 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23887 /* Append glyphs strings for glyphs following the last glyph
23888 string tail that are overwritten by tail. The background of
23889 these strings has to be drawn because tail's foreground draws
23891 i
= right_overwritten (tail
);
23894 enum draw_glyphs_face overlap_hl
;
23896 if (check_mouse_face
23897 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23898 overlap_hl
= DRAW_MOUSE_FACE
;
23900 overlap_hl
= DRAW_NORMAL_TEXT
;
23902 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23903 overlap_hl
, x
, last_x
);
23904 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23905 we don't have `end = i;' here. */
23906 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23907 append_glyph_string_lists (&head
, &tail
, h
, t
);
23911 /* Append glyph strings for glyphs following the last glyph
23912 string tail that overwrite tail. The foreground of such
23913 glyphs has to be drawn because it writes into the background
23914 of tail. The background must not be drawn because it could
23915 paint over the foreground of following glyphs. */
23916 i
= right_overwriting (tail
);
23919 enum draw_glyphs_face overlap_hl
;
23920 if (check_mouse_face
23921 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23922 overlap_hl
= DRAW_MOUSE_FACE
;
23924 overlap_hl
= DRAW_NORMAL_TEXT
;
23927 i
++; /* We must include the Ith glyph. */
23928 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23929 overlap_hl
, x
, last_x
);
23930 for (s
= h
; s
; s
= s
->next
)
23931 s
->background_filled_p
= 1;
23932 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23933 append_glyph_string_lists (&head
, &tail
, h
, t
);
23935 if (clip_head
|| clip_tail
)
23936 for (s
= head
; s
; s
= s
->next
)
23938 s
->clip_head
= clip_head
;
23939 s
->clip_tail
= clip_tail
;
23943 /* Draw all strings. */
23944 for (s
= head
; s
; s
= s
->next
)
23945 FRAME_RIF (f
)->draw_glyph_string (s
);
23948 /* When focus a sole frame and move horizontally, this sets on_p to 0
23949 causing a failure to erase prev cursor position. */
23950 if (area
== TEXT_AREA
23951 && !row
->full_width_p
23952 /* When drawing overlapping rows, only the glyph strings'
23953 foreground is drawn, which doesn't erase a cursor
23957 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23958 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23959 : (tail
? tail
->x
+ tail
->background_width
: x
));
23963 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23964 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23968 /* Value is the x-position up to which drawn, relative to AREA of W.
23969 This doesn't include parts drawn because of overhangs. */
23970 if (row
->full_width_p
)
23971 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23973 x_reached
-= area_left
;
23975 RELEASE_HDC (hdc
, f
);
23980 /* Expand row matrix if too narrow. Don't expand if area
23983 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23985 if (!fonts_changed_p \
23986 && (it->glyph_row->glyphs[area] \
23987 < it->glyph_row->glyphs[area + 1])) \
23989 it->w->ncols_scale_factor++; \
23990 fonts_changed_p = 1; \
23994 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23995 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23998 append_glyph (struct it
*it
)
24000 struct glyph
*glyph
;
24001 enum glyph_row_area area
= it
->area
;
24003 eassert (it
->glyph_row
);
24004 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
24006 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24007 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24009 /* If the glyph row is reversed, we need to prepend the glyph
24010 rather than append it. */
24011 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24015 /* Make room for the additional glyph. */
24016 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24018 glyph
= it
->glyph_row
->glyphs
[area
];
24020 glyph
->charpos
= CHARPOS (it
->position
);
24021 glyph
->object
= it
->object
;
24022 if (it
->pixel_width
> 0)
24024 glyph
->pixel_width
= it
->pixel_width
;
24025 glyph
->padding_p
= 0;
24029 /* Assure at least 1-pixel width. Otherwise, cursor can't
24030 be displayed correctly. */
24031 glyph
->pixel_width
= 1;
24032 glyph
->padding_p
= 1;
24034 glyph
->ascent
= it
->ascent
;
24035 glyph
->descent
= it
->descent
;
24036 glyph
->voffset
= it
->voffset
;
24037 glyph
->type
= CHAR_GLYPH
;
24038 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24039 glyph
->multibyte_p
= it
->multibyte_p
;
24040 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24042 /* In R2L rows, the left and the right box edges need to be
24043 drawn in reverse direction. */
24044 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24045 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24049 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24050 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24052 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24053 || it
->phys_descent
> it
->descent
);
24054 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
24055 glyph
->face_id
= it
->face_id
;
24056 glyph
->u
.ch
= it
->char_to_display
;
24057 glyph
->slice
.img
= null_glyph_slice
;
24058 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24061 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24062 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24064 glyph
->bidi_type
= it
->bidi_it
.type
;
24068 glyph
->resolved_level
= 0;
24069 glyph
->bidi_type
= UNKNOWN_BT
;
24071 ++it
->glyph_row
->used
[area
];
24074 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24077 /* Store one glyph for the composition IT->cmp_it.id in
24078 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
24082 append_composite_glyph (struct it
*it
)
24084 struct glyph
*glyph
;
24085 enum glyph_row_area area
= it
->area
;
24087 eassert (it
->glyph_row
);
24089 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24090 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24092 /* If the glyph row is reversed, we need to prepend the glyph
24093 rather than append it. */
24094 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
24098 /* Make room for the new glyph. */
24099 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
24101 glyph
= it
->glyph_row
->glyphs
[it
->area
];
24103 glyph
->charpos
= it
->cmp_it
.charpos
;
24104 glyph
->object
= it
->object
;
24105 glyph
->pixel_width
= it
->pixel_width
;
24106 glyph
->ascent
= it
->ascent
;
24107 glyph
->descent
= it
->descent
;
24108 glyph
->voffset
= it
->voffset
;
24109 glyph
->type
= COMPOSITE_GLYPH
;
24110 if (it
->cmp_it
.ch
< 0)
24112 glyph
->u
.cmp
.automatic
= 0;
24113 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24114 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
24118 glyph
->u
.cmp
.automatic
= 1;
24119 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24120 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
24121 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
24123 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24124 glyph
->multibyte_p
= it
->multibyte_p
;
24125 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24127 /* In R2L rows, the left and the right box edges need to be
24128 drawn in reverse direction. */
24129 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24130 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24134 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24135 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24137 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24138 || it
->phys_descent
> it
->descent
);
24139 glyph
->padding_p
= 0;
24140 glyph
->glyph_not_available_p
= 0;
24141 glyph
->face_id
= it
->face_id
;
24142 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24145 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24146 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24148 glyph
->bidi_type
= it
->bidi_it
.type
;
24150 ++it
->glyph_row
->used
[area
];
24153 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24157 /* Change IT->ascent and IT->height according to the setting of
24161 take_vertical_position_into_account (struct it
*it
)
24165 if (it
->voffset
< 0)
24166 /* Increase the ascent so that we can display the text higher
24168 it
->ascent
-= it
->voffset
;
24170 /* Increase the descent so that we can display the text lower
24172 it
->descent
+= it
->voffset
;
24177 /* Produce glyphs/get display metrics for the image IT is loaded with.
24178 See the description of struct display_iterator in dispextern.h for
24179 an overview of struct display_iterator. */
24182 produce_image_glyph (struct it
*it
)
24186 int glyph_ascent
, crop
;
24187 struct glyph_slice slice
;
24189 eassert (it
->what
== IT_IMAGE
);
24191 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24193 /* Make sure X resources of the face is loaded. */
24194 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24196 if (it
->image_id
< 0)
24198 /* Fringe bitmap. */
24199 it
->ascent
= it
->phys_ascent
= 0;
24200 it
->descent
= it
->phys_descent
= 0;
24201 it
->pixel_width
= 0;
24206 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
24208 /* Make sure X resources of the image is loaded. */
24209 prepare_image_for_display (it
->f
, img
);
24211 slice
.x
= slice
.y
= 0;
24212 slice
.width
= img
->width
;
24213 slice
.height
= img
->height
;
24215 if (INTEGERP (it
->slice
.x
))
24216 slice
.x
= XINT (it
->slice
.x
);
24217 else if (FLOATP (it
->slice
.x
))
24218 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
24220 if (INTEGERP (it
->slice
.y
))
24221 slice
.y
= XINT (it
->slice
.y
);
24222 else if (FLOATP (it
->slice
.y
))
24223 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
24225 if (INTEGERP (it
->slice
.width
))
24226 slice
.width
= XINT (it
->slice
.width
);
24227 else if (FLOATP (it
->slice
.width
))
24228 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
24230 if (INTEGERP (it
->slice
.height
))
24231 slice
.height
= XINT (it
->slice
.height
);
24232 else if (FLOATP (it
->slice
.height
))
24233 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
24235 if (slice
.x
>= img
->width
)
24236 slice
.x
= img
->width
;
24237 if (slice
.y
>= img
->height
)
24238 slice
.y
= img
->height
;
24239 if (slice
.x
+ slice
.width
>= img
->width
)
24240 slice
.width
= img
->width
- slice
.x
;
24241 if (slice
.y
+ slice
.height
> img
->height
)
24242 slice
.height
= img
->height
- slice
.y
;
24244 if (slice
.width
== 0 || slice
.height
== 0)
24247 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
24249 it
->descent
= slice
.height
- glyph_ascent
;
24251 it
->descent
+= img
->vmargin
;
24252 if (slice
.y
+ slice
.height
== img
->height
)
24253 it
->descent
+= img
->vmargin
;
24254 it
->phys_descent
= it
->descent
;
24256 it
->pixel_width
= slice
.width
;
24258 it
->pixel_width
+= img
->hmargin
;
24259 if (slice
.x
+ slice
.width
== img
->width
)
24260 it
->pixel_width
+= img
->hmargin
;
24262 /* It's quite possible for images to have an ascent greater than
24263 their height, so don't get confused in that case. */
24264 if (it
->descent
< 0)
24269 if (face
->box
!= FACE_NO_BOX
)
24271 if (face
->box_line_width
> 0)
24274 it
->ascent
+= face
->box_line_width
;
24275 if (slice
.y
+ slice
.height
== img
->height
)
24276 it
->descent
+= face
->box_line_width
;
24279 if (it
->start_of_box_run_p
&& slice
.x
== 0)
24280 it
->pixel_width
+= eabs (face
->box_line_width
);
24281 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
24282 it
->pixel_width
+= eabs (face
->box_line_width
);
24285 take_vertical_position_into_account (it
);
24287 /* Automatically crop wide image glyphs at right edge so we can
24288 draw the cursor on same display row. */
24289 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
24290 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
24292 it
->pixel_width
-= crop
;
24293 slice
.width
-= crop
;
24298 struct glyph
*glyph
;
24299 enum glyph_row_area area
= it
->area
;
24301 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24302 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24304 glyph
->charpos
= CHARPOS (it
->position
);
24305 glyph
->object
= it
->object
;
24306 glyph
->pixel_width
= it
->pixel_width
;
24307 glyph
->ascent
= glyph_ascent
;
24308 glyph
->descent
= it
->descent
;
24309 glyph
->voffset
= it
->voffset
;
24310 glyph
->type
= IMAGE_GLYPH
;
24311 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24312 glyph
->multibyte_p
= it
->multibyte_p
;
24313 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24315 /* In R2L rows, the left and the right box edges need to be
24316 drawn in reverse direction. */
24317 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24318 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24322 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24323 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24325 glyph
->overlaps_vertically_p
= 0;
24326 glyph
->padding_p
= 0;
24327 glyph
->glyph_not_available_p
= 0;
24328 glyph
->face_id
= it
->face_id
;
24329 glyph
->u
.img_id
= img
->id
;
24330 glyph
->slice
.img
= slice
;
24331 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24334 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24335 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24337 glyph
->bidi_type
= it
->bidi_it
.type
;
24339 ++it
->glyph_row
->used
[area
];
24342 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24347 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
24348 of the glyph, WIDTH and HEIGHT are the width and height of the
24349 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
24352 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
24353 int width
, int height
, int ascent
)
24355 struct glyph
*glyph
;
24356 enum glyph_row_area area
= it
->area
;
24358 eassert (ascent
>= 0 && ascent
<= height
);
24360 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24361 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24363 /* If the glyph row is reversed, we need to prepend the glyph
24364 rather than append it. */
24365 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24369 /* Make room for the additional glyph. */
24370 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24372 glyph
= it
->glyph_row
->glyphs
[area
];
24374 glyph
->charpos
= CHARPOS (it
->position
);
24375 glyph
->object
= object
;
24376 glyph
->pixel_width
= width
;
24377 glyph
->ascent
= ascent
;
24378 glyph
->descent
= height
- ascent
;
24379 glyph
->voffset
= it
->voffset
;
24380 glyph
->type
= STRETCH_GLYPH
;
24381 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24382 glyph
->multibyte_p
= it
->multibyte_p
;
24383 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24385 /* In R2L rows, the left and the right box edges need to be
24386 drawn in reverse direction. */
24387 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24388 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24392 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24393 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24395 glyph
->overlaps_vertically_p
= 0;
24396 glyph
->padding_p
= 0;
24397 glyph
->glyph_not_available_p
= 0;
24398 glyph
->face_id
= it
->face_id
;
24399 glyph
->u
.stretch
.ascent
= ascent
;
24400 glyph
->u
.stretch
.height
= height
;
24401 glyph
->slice
.img
= null_glyph_slice
;
24402 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24405 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24406 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24408 glyph
->bidi_type
= it
->bidi_it
.type
;
24412 glyph
->resolved_level
= 0;
24413 glyph
->bidi_type
= UNKNOWN_BT
;
24415 ++it
->glyph_row
->used
[area
];
24418 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24421 #endif /* HAVE_WINDOW_SYSTEM */
24423 /* Produce a stretch glyph for iterator IT. IT->object is the value
24424 of the glyph property displayed. The value must be a list
24425 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
24428 1. `:width WIDTH' specifies that the space should be WIDTH *
24429 canonical char width wide. WIDTH may be an integer or floating
24432 2. `:relative-width FACTOR' specifies that the width of the stretch
24433 should be computed from the width of the first character having the
24434 `glyph' property, and should be FACTOR times that width.
24436 3. `:align-to HPOS' specifies that the space should be wide enough
24437 to reach HPOS, a value in canonical character units.
24439 Exactly one of the above pairs must be present.
24441 4. `:height HEIGHT' specifies that the height of the stretch produced
24442 should be HEIGHT, measured in canonical character units.
24444 5. `:relative-height FACTOR' specifies that the height of the
24445 stretch should be FACTOR times the height of the characters having
24446 the glyph property.
24448 Either none or exactly one of 4 or 5 must be present.
24450 6. `:ascent ASCENT' specifies that ASCENT percent of the height
24451 of the stretch should be used for the ascent of the stretch.
24452 ASCENT must be in the range 0 <= ASCENT <= 100. */
24455 produce_stretch_glyph (struct it
*it
)
24457 /* (space :width WIDTH :height HEIGHT ...) */
24458 Lisp_Object prop
, plist
;
24459 int width
= 0, height
= 0, align_to
= -1;
24460 int zero_width_ok_p
= 0;
24462 struct font
*font
= NULL
;
24464 #ifdef HAVE_WINDOW_SYSTEM
24466 int zero_height_ok_p
= 0;
24468 if (FRAME_WINDOW_P (it
->f
))
24470 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24471 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24472 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24476 /* List should start with `space'. */
24477 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
24478 plist
= XCDR (it
->object
);
24480 /* Compute the width of the stretch. */
24481 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
24482 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
24484 /* Absolute width `:width WIDTH' specified and valid. */
24485 zero_width_ok_p
= 1;
24488 #ifdef HAVE_WINDOW_SYSTEM
24489 else if (FRAME_WINDOW_P (it
->f
)
24490 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
24492 /* Relative width `:relative-width FACTOR' specified and valid.
24493 Compute the width of the characters having the `glyph'
24496 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
24499 if (it
->multibyte_p
)
24500 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
24503 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
24504 if (! ASCII_CHAR_P (it2
.c
))
24505 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
24508 it2
.glyph_row
= NULL
;
24509 it2
.what
= IT_CHARACTER
;
24510 x_produce_glyphs (&it2
);
24511 width
= NUMVAL (prop
) * it2
.pixel_width
;
24513 #endif /* HAVE_WINDOW_SYSTEM */
24514 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
24515 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
24517 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
24518 align_to
= (align_to
< 0
24520 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
24521 else if (align_to
< 0)
24522 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
24523 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
24524 zero_width_ok_p
= 1;
24527 /* Nothing specified -> width defaults to canonical char width. */
24528 width
= FRAME_COLUMN_WIDTH (it
->f
);
24530 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
24533 #ifdef HAVE_WINDOW_SYSTEM
24534 /* Compute height. */
24535 if (FRAME_WINDOW_P (it
->f
))
24537 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
24538 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24541 zero_height_ok_p
= 1;
24543 else if (prop
= Fplist_get (plist
, QCrelative_height
),
24545 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
24547 height
= FONT_HEIGHT (font
);
24549 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
24552 /* Compute percentage of height used for ascent. If
24553 `:ascent ASCENT' is present and valid, use that. Otherwise,
24554 derive the ascent from the font in use. */
24555 if (prop
= Fplist_get (plist
, QCascent
),
24556 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
24557 ascent
= height
* NUMVAL (prop
) / 100.0;
24558 else if (!NILP (prop
)
24559 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24560 ascent
= min (max (0, (int)tem
), height
);
24562 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
24565 #endif /* HAVE_WINDOW_SYSTEM */
24568 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24569 && it
->current_x
+ width
> it
->last_visible_x
)
24571 width
= it
->last_visible_x
- it
->current_x
;
24572 #ifdef HAVE_WINDOW_SYSTEM
24573 /* Subtract one more pixel from the stretch width, but only on
24574 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24575 width
-= FRAME_WINDOW_P (it
->f
);
24579 if (width
> 0 && height
> 0 && it
->glyph_row
)
24581 Lisp_Object o_object
= it
->object
;
24582 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24585 if (!STRINGP (object
))
24586 object
= it
->w
->contents
;
24587 #ifdef HAVE_WINDOW_SYSTEM
24588 if (FRAME_WINDOW_P (it
->f
))
24589 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24593 it
->object
= object
;
24594 it
->char_to_display
= ' ';
24595 it
->pixel_width
= it
->len
= 1;
24597 tty_append_glyph (it
);
24598 it
->object
= o_object
;
24602 it
->pixel_width
= width
;
24603 #ifdef HAVE_WINDOW_SYSTEM
24604 if (FRAME_WINDOW_P (it
->f
))
24606 it
->ascent
= it
->phys_ascent
= ascent
;
24607 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24608 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24609 take_vertical_position_into_account (it
);
24613 it
->nglyphs
= width
;
24616 /* Get information about special display element WHAT in an
24617 environment described by IT. WHAT is one of IT_TRUNCATION or
24618 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24619 non-null glyph_row member. This function ensures that fields like
24620 face_id, c, len of IT are left untouched. */
24623 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
24630 temp_it
.object
= make_number (0);
24631 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
24633 if (what
== IT_CONTINUATION
)
24635 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24636 if (it
->bidi_it
.paragraph_dir
== R2L
)
24637 SET_GLYPH_FROM_CHAR (glyph
, '/');
24639 SET_GLYPH_FROM_CHAR (glyph
, '\\');
24641 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24643 /* FIXME: Should we mirror GC for R2L lines? */
24644 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24645 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24648 else if (what
== IT_TRUNCATION
)
24650 /* Truncation glyph. */
24651 SET_GLYPH_FROM_CHAR (glyph
, '$');
24653 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24655 /* FIXME: Should we mirror GC for R2L lines? */
24656 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24657 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24663 #ifdef HAVE_WINDOW_SYSTEM
24664 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24665 is turned off, we precede the truncation/continuation glyphs by a
24666 stretch glyph whose width is computed such that these special
24667 glyphs are aligned at the window margin, even when very different
24668 fonts are used in different glyph rows. */
24669 if (FRAME_WINDOW_P (temp_it
.f
)
24670 /* init_iterator calls this with it->glyph_row == NULL, and it
24671 wants only the pixel width of the truncation/continuation
24673 && temp_it
.glyph_row
24674 /* insert_left_trunc_glyphs calls us at the beginning of the
24675 row, and it has its own calculation of the stretch glyph
24677 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
24678 && (temp_it
.glyph_row
->reversed_p
24679 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
24680 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
24682 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
24684 if (stretch_width
> 0)
24686 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
24687 struct font
*font
=
24688 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
24689 int stretch_ascent
=
24690 (((temp_it
.ascent
+ temp_it
.descent
)
24691 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
24693 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
24694 temp_it
.ascent
+ temp_it
.descent
,
24701 temp_it
.what
= IT_CHARACTER
;
24703 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
24704 temp_it
.face_id
= GLYPH_FACE (glyph
);
24705 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
24707 PRODUCE_GLYPHS (&temp_it
);
24708 it
->pixel_width
= temp_it
.pixel_width
;
24709 it
->nglyphs
= temp_it
.pixel_width
;
24712 #ifdef HAVE_WINDOW_SYSTEM
24714 /* Calculate line-height and line-spacing properties.
24715 An integer value specifies explicit pixel value.
24716 A float value specifies relative value to current face height.
24717 A cons (float . face-name) specifies relative value to
24718 height of specified face font.
24720 Returns height in pixels, or nil. */
24724 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24725 int boff
, int override
)
24727 Lisp_Object face_name
= Qnil
;
24728 int ascent
, descent
, height
;
24730 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24735 face_name
= XCAR (val
);
24737 if (!NUMBERP (val
))
24738 val
= make_number (1);
24739 if (NILP (face_name
))
24741 height
= it
->ascent
+ it
->descent
;
24746 if (NILP (face_name
))
24748 font
= FRAME_FONT (it
->f
);
24749 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24751 else if (EQ (face_name
, Qt
))
24760 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24762 return make_number (-1);
24764 face
= FACE_FROM_ID (it
->f
, face_id
);
24767 return make_number (-1);
24768 boff
= font
->baseline_offset
;
24769 if (font
->vertical_centering
)
24770 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24773 ascent
= FONT_BASE (font
) + boff
;
24774 descent
= FONT_DESCENT (font
) - boff
;
24778 it
->override_ascent
= ascent
;
24779 it
->override_descent
= descent
;
24780 it
->override_boff
= boff
;
24783 height
= ascent
+ descent
;
24787 height
= (int)(XFLOAT_DATA (val
) * height
);
24788 else if (INTEGERP (val
))
24789 height
*= XINT (val
);
24791 return make_number (height
);
24795 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24796 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24797 and only if this is for a character for which no font was found.
24799 If the display method (it->glyphless_method) is
24800 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24801 length of the acronym or the hexadecimal string, UPPER_XOFF and
24802 UPPER_YOFF are pixel offsets for the upper part of the string,
24803 LOWER_XOFF and LOWER_YOFF are for the lower part.
24805 For the other display methods, LEN through LOWER_YOFF are zero. */
24808 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24809 short upper_xoff
, short upper_yoff
,
24810 short lower_xoff
, short lower_yoff
)
24812 struct glyph
*glyph
;
24813 enum glyph_row_area area
= it
->area
;
24815 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24816 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24818 /* If the glyph row is reversed, we need to prepend the glyph
24819 rather than append it. */
24820 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24824 /* Make room for the additional glyph. */
24825 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24827 glyph
= it
->glyph_row
->glyphs
[area
];
24829 glyph
->charpos
= CHARPOS (it
->position
);
24830 glyph
->object
= it
->object
;
24831 glyph
->pixel_width
= it
->pixel_width
;
24832 glyph
->ascent
= it
->ascent
;
24833 glyph
->descent
= it
->descent
;
24834 glyph
->voffset
= it
->voffset
;
24835 glyph
->type
= GLYPHLESS_GLYPH
;
24836 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24837 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24838 glyph
->u
.glyphless
.len
= len
;
24839 glyph
->u
.glyphless
.ch
= it
->c
;
24840 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24841 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24842 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24843 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24844 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24845 glyph
->multibyte_p
= it
->multibyte_p
;
24846 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24848 /* In R2L rows, the left and the right box edges need to be
24849 drawn in reverse direction. */
24850 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24851 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24855 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24856 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24858 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24859 || it
->phys_descent
> it
->descent
);
24860 glyph
->padding_p
= 0;
24861 glyph
->glyph_not_available_p
= 0;
24862 glyph
->face_id
= face_id
;
24863 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24866 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24867 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24869 glyph
->bidi_type
= it
->bidi_it
.type
;
24871 ++it
->glyph_row
->used
[area
];
24874 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24878 /* Produce a glyph for a glyphless character for iterator IT.
24879 IT->glyphless_method specifies which method to use for displaying
24880 the character. See the description of enum
24881 glyphless_display_method in dispextern.h for the detail.
24883 FOR_NO_FONT is nonzero if and only if this is for a character for
24884 which no font was found. ACRONYM, if non-nil, is an acronym string
24885 for the character. */
24888 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24893 int base_width
, base_height
, width
, height
;
24894 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24897 /* Get the metrics of the base font. We always refer to the current
24899 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24900 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24901 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24902 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24903 base_height
= it
->ascent
+ it
->descent
;
24904 base_width
= font
->average_width
;
24906 /* Get a face ID for the glyph by utilizing a cache (the same way as
24907 done for `escape-glyph' in get_next_display_element). */
24908 if (it
->f
== last_glyphless_glyph_frame
24909 && it
->face_id
== last_glyphless_glyph_face_id
)
24911 face_id
= last_glyphless_glyph_merged_face_id
;
24915 /* Merge the `glyphless-char' face into the current face. */
24916 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24917 last_glyphless_glyph_frame
= it
->f
;
24918 last_glyphless_glyph_face_id
= it
->face_id
;
24919 last_glyphless_glyph_merged_face_id
= face_id
;
24922 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24924 it
->pixel_width
= THIN_SPACE_WIDTH
;
24926 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24928 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24930 width
= CHAR_WIDTH (it
->c
);
24933 else if (width
> 4)
24935 it
->pixel_width
= base_width
* width
;
24937 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24943 unsigned int code
[6];
24945 int ascent
, descent
;
24946 struct font_metrics metrics_upper
, metrics_lower
;
24948 face
= FACE_FROM_ID (it
->f
, face_id
);
24949 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24950 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24952 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24954 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24955 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24956 if (CONSP (acronym
))
24957 acronym
= XCAR (acronym
);
24958 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24962 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24963 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24966 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24967 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24968 upper_len
= (len
+ 1) / 2;
24969 font
->driver
->text_extents (font
, code
, upper_len
,
24971 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24976 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24977 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24978 upper_xoff
= upper_yoff
= 2; /* the typical case */
24979 if (base_width
>= width
)
24981 /* Align the upper to the left, the lower to the right. */
24982 it
->pixel_width
= base_width
;
24983 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24987 /* Center the shorter one. */
24988 it
->pixel_width
= width
;
24989 if (metrics_upper
.width
>= metrics_lower
.width
)
24990 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24993 /* FIXME: This code doesn't look right. It formerly was
24994 missing the "lower_xoff = 0;", which couldn't have
24995 been right since it left lower_xoff uninitialized. */
24997 upper_xoff
= (width
- metrics_upper
.width
) / 2;
25001 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
25002 top, bottom, and between upper and lower strings. */
25003 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
25004 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
25005 /* Center vertically.
25006 H:base_height, D:base_descent
25007 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
25009 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
25010 descent = D - H/2 + h/2;
25011 lower_yoff = descent - 2 - ld;
25012 upper_yoff = lower_yoff - la - 1 - ud; */
25013 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
25014 descent
= it
->descent
- (base_height
- height
) / 2;
25015 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
25016 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
25017 - metrics_upper
.descent
);
25018 /* Don't make the height shorter than the base height. */
25019 if (height
> base_height
)
25021 it
->ascent
= ascent
;
25022 it
->descent
= descent
;
25026 it
->phys_ascent
= it
->ascent
;
25027 it
->phys_descent
= it
->descent
;
25029 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
25030 upper_xoff
, upper_yoff
,
25031 lower_xoff
, lower_yoff
);
25033 take_vertical_position_into_account (it
);
25038 Produce glyphs/get display metrics for the display element IT is
25039 loaded with. See the description of struct it in dispextern.h
25040 for an overview of struct it. */
25043 x_produce_glyphs (struct it
*it
)
25045 int extra_line_spacing
= it
->extra_line_spacing
;
25047 it
->glyph_not_available_p
= 0;
25049 if (it
->what
== IT_CHARACTER
)
25052 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25053 struct font
*font
= face
->font
;
25054 struct font_metrics
*pcm
= NULL
;
25055 int boff
; /* baseline offset */
25059 /* When no suitable font is found, display this character by
25060 the method specified in the first extra slot of
25061 Vglyphless_char_display. */
25062 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
25064 eassert (it
->what
== IT_GLYPHLESS
);
25065 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
25069 boff
= font
->baseline_offset
;
25070 if (font
->vertical_centering
)
25071 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25073 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
25079 if (it
->override_ascent
>= 0)
25081 it
->ascent
= it
->override_ascent
;
25082 it
->descent
= it
->override_descent
;
25083 boff
= it
->override_boff
;
25087 it
->ascent
= FONT_BASE (font
) + boff
;
25088 it
->descent
= FONT_DESCENT (font
) - boff
;
25091 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
25093 pcm
= get_per_char_metric (font
, &char2b
);
25094 if (pcm
->width
== 0
25095 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
25101 it
->phys_ascent
= pcm
->ascent
+ boff
;
25102 it
->phys_descent
= pcm
->descent
- boff
;
25103 it
->pixel_width
= pcm
->width
;
25107 it
->glyph_not_available_p
= 1;
25108 it
->phys_ascent
= it
->ascent
;
25109 it
->phys_descent
= it
->descent
;
25110 it
->pixel_width
= font
->space_width
;
25113 if (it
->constrain_row_ascent_descent_p
)
25115 if (it
->descent
> it
->max_descent
)
25117 it
->ascent
+= it
->descent
- it
->max_descent
;
25118 it
->descent
= it
->max_descent
;
25120 if (it
->ascent
> it
->max_ascent
)
25122 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
25123 it
->ascent
= it
->max_ascent
;
25125 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
25126 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
25127 extra_line_spacing
= 0;
25130 /* If this is a space inside a region of text with
25131 `space-width' property, change its width. */
25132 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
25134 it
->pixel_width
*= XFLOATINT (it
->space_width
);
25136 /* If face has a box, add the box thickness to the character
25137 height. If character has a box line to the left and/or
25138 right, add the box line width to the character's width. */
25139 if (face
->box
!= FACE_NO_BOX
)
25141 int thick
= face
->box_line_width
;
25145 it
->ascent
+= thick
;
25146 it
->descent
+= thick
;
25151 if (it
->start_of_box_run_p
)
25152 it
->pixel_width
+= thick
;
25153 if (it
->end_of_box_run_p
)
25154 it
->pixel_width
+= thick
;
25157 /* If face has an overline, add the height of the overline
25158 (1 pixel) and a 1 pixel margin to the character height. */
25159 if (face
->overline_p
)
25160 it
->ascent
+= overline_margin
;
25162 if (it
->constrain_row_ascent_descent_p
)
25164 if (it
->ascent
> it
->max_ascent
)
25165 it
->ascent
= it
->max_ascent
;
25166 if (it
->descent
> it
->max_descent
)
25167 it
->descent
= it
->max_descent
;
25170 take_vertical_position_into_account (it
);
25172 /* If we have to actually produce glyphs, do it. */
25177 /* Translate a space with a `space-width' property
25178 into a stretch glyph. */
25179 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
25180 / FONT_HEIGHT (font
));
25181 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
25182 it
->ascent
+ it
->descent
, ascent
);
25187 /* If characters with lbearing or rbearing are displayed
25188 in this line, record that fact in a flag of the
25189 glyph row. This is used to optimize X output code. */
25190 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
25191 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25193 if (! stretched_p
&& it
->pixel_width
== 0)
25194 /* We assure that all visible glyphs have at least 1-pixel
25196 it
->pixel_width
= 1;
25198 else if (it
->char_to_display
== '\n')
25200 /* A newline has no width, but we need the height of the
25201 line. But if previous part of the line sets a height,
25202 don't increase that height */
25204 Lisp_Object height
;
25205 Lisp_Object total_height
= Qnil
;
25207 it
->override_ascent
= -1;
25208 it
->pixel_width
= 0;
25211 height
= get_it_property (it
, Qline_height
);
25212 /* Split (line-height total-height) list */
25214 && CONSP (XCDR (height
))
25215 && NILP (XCDR (XCDR (height
))))
25217 total_height
= XCAR (XCDR (height
));
25218 height
= XCAR (height
);
25220 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
25222 if (it
->override_ascent
>= 0)
25224 it
->ascent
= it
->override_ascent
;
25225 it
->descent
= it
->override_descent
;
25226 boff
= it
->override_boff
;
25230 it
->ascent
= FONT_BASE (font
) + boff
;
25231 it
->descent
= FONT_DESCENT (font
) - boff
;
25234 if (EQ (height
, Qt
))
25236 if (it
->descent
> it
->max_descent
)
25238 it
->ascent
+= it
->descent
- it
->max_descent
;
25239 it
->descent
= it
->max_descent
;
25241 if (it
->ascent
> it
->max_ascent
)
25243 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
25244 it
->ascent
= it
->max_ascent
;
25246 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
25247 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
25248 it
->constrain_row_ascent_descent_p
= 1;
25249 extra_line_spacing
= 0;
25253 Lisp_Object spacing
;
25255 it
->phys_ascent
= it
->ascent
;
25256 it
->phys_descent
= it
->descent
;
25258 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
25259 && face
->box
!= FACE_NO_BOX
25260 && face
->box_line_width
> 0)
25262 it
->ascent
+= face
->box_line_width
;
25263 it
->descent
+= face
->box_line_width
;
25266 && XINT (height
) > it
->ascent
+ it
->descent
)
25267 it
->ascent
= XINT (height
) - it
->descent
;
25269 if (!NILP (total_height
))
25270 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
25273 spacing
= get_it_property (it
, Qline_spacing
);
25274 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
25276 if (INTEGERP (spacing
))
25278 extra_line_spacing
= XINT (spacing
);
25279 if (!NILP (total_height
))
25280 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
25284 else /* i.e. (it->char_to_display == '\t') */
25286 if (font
->space_width
> 0)
25288 int tab_width
= it
->tab_width
* font
->space_width
;
25289 int x
= it
->current_x
+ it
->continuation_lines_width
;
25290 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
25292 /* If the distance from the current position to the next tab
25293 stop is less than a space character width, use the
25294 tab stop after that. */
25295 if (next_tab_x
- x
< font
->space_width
)
25296 next_tab_x
+= tab_width
;
25298 it
->pixel_width
= next_tab_x
- x
;
25300 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
25301 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
25305 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
25306 it
->ascent
+ it
->descent
, it
->ascent
);
25311 it
->pixel_width
= 0;
25316 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
25318 /* A static composition.
25320 Note: A composition is represented as one glyph in the
25321 glyph matrix. There are no padding glyphs.
25323 Important note: pixel_width, ascent, and descent are the
25324 values of what is drawn by draw_glyphs (i.e. the values of
25325 the overall glyphs composed). */
25326 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25327 int boff
; /* baseline offset */
25328 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
25329 int glyph_len
= cmp
->glyph_len
;
25330 struct font
*font
= face
->font
;
25334 /* If we have not yet calculated pixel size data of glyphs of
25335 the composition for the current face font, calculate them
25336 now. Theoretically, we have to check all fonts for the
25337 glyphs, but that requires much time and memory space. So,
25338 here we check only the font of the first glyph. This may
25339 lead to incorrect display, but it's very rare, and C-l
25340 (recenter-top-bottom) can correct the display anyway. */
25341 if (! cmp
->font
|| cmp
->font
!= font
)
25343 /* Ascent and descent of the font of the first character
25344 of this composition (adjusted by baseline offset).
25345 Ascent and descent of overall glyphs should not be less
25346 than these, respectively. */
25347 int font_ascent
, font_descent
, font_height
;
25348 /* Bounding box of the overall glyphs. */
25349 int leftmost
, rightmost
, lowest
, highest
;
25350 int lbearing
, rbearing
;
25351 int i
, width
, ascent
, descent
;
25352 int left_padded
= 0, right_padded
= 0;
25353 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
25355 struct font_metrics
*pcm
;
25356 int font_not_found_p
;
25359 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
25360 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
25362 if (glyph_len
< cmp
->glyph_len
)
25364 for (i
= 0; i
< glyph_len
; i
++)
25366 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
25368 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25373 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
25374 : IT_CHARPOS (*it
));
25375 /* If no suitable font is found, use the default font. */
25376 font_not_found_p
= font
== NULL
;
25377 if (font_not_found_p
)
25379 face
= face
->ascii_face
;
25382 boff
= font
->baseline_offset
;
25383 if (font
->vertical_centering
)
25384 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25385 font_ascent
= FONT_BASE (font
) + boff
;
25386 font_descent
= FONT_DESCENT (font
) - boff
;
25387 font_height
= FONT_HEIGHT (font
);
25392 if (! font_not_found_p
)
25394 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
25396 pcm
= get_per_char_metric (font
, &char2b
);
25399 /* Initialize the bounding box. */
25402 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
25403 ascent
= pcm
->ascent
;
25404 descent
= pcm
->descent
;
25405 lbearing
= pcm
->lbearing
;
25406 rbearing
= pcm
->rbearing
;
25410 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
25411 ascent
= FONT_BASE (font
);
25412 descent
= FONT_DESCENT (font
);
25419 lowest
= - descent
+ boff
;
25420 highest
= ascent
+ boff
;
25422 if (! font_not_found_p
25423 && font
->default_ascent
25424 && CHAR_TABLE_P (Vuse_default_ascent
)
25425 && !NILP (Faref (Vuse_default_ascent
,
25426 make_number (it
->char_to_display
))))
25427 highest
= font
->default_ascent
+ boff
;
25429 /* Draw the first glyph at the normal position. It may be
25430 shifted to right later if some other glyphs are drawn
25432 cmp
->offsets
[i
* 2] = 0;
25433 cmp
->offsets
[i
* 2 + 1] = boff
;
25434 cmp
->lbearing
= lbearing
;
25435 cmp
->rbearing
= rbearing
;
25437 /* Set cmp->offsets for the remaining glyphs. */
25438 for (i
++; i
< glyph_len
; i
++)
25440 int left
, right
, btm
, top
;
25441 int ch
= COMPOSITION_GLYPH (cmp
, i
);
25443 struct face
*this_face
;
25447 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
25448 this_face
= FACE_FROM_ID (it
->f
, face_id
);
25449 font
= this_face
->font
;
25455 get_char_face_and_encoding (it
->f
, ch
, face_id
,
25457 pcm
= get_per_char_metric (font
, &char2b
);
25460 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25463 width
= pcm
->width
;
25464 ascent
= pcm
->ascent
;
25465 descent
= pcm
->descent
;
25466 lbearing
= pcm
->lbearing
;
25467 rbearing
= pcm
->rbearing
;
25468 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
25470 /* Relative composition with or without
25471 alternate chars. */
25472 left
= (leftmost
+ rightmost
- width
) / 2;
25473 btm
= - descent
+ boff
;
25474 if (font
->relative_compose
25475 && (! CHAR_TABLE_P (Vignore_relative_composition
)
25476 || NILP (Faref (Vignore_relative_composition
,
25477 make_number (ch
)))))
25480 if (- descent
>= font
->relative_compose
)
25481 /* One extra pixel between two glyphs. */
25483 else if (ascent
<= 0)
25484 /* One extra pixel between two glyphs. */
25485 btm
= lowest
- 1 - ascent
- descent
;
25490 /* A composition rule is specified by an integer
25491 value that encodes global and new reference
25492 points (GREF and NREF). GREF and NREF are
25493 specified by numbers as below:
25495 0---1---2 -- ascent
25499 9--10--11 -- center
25501 ---3---4---5--- baseline
25503 6---7---8 -- descent
25505 int rule
= COMPOSITION_RULE (cmp
, i
);
25506 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
25508 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
25509 grefx
= gref
% 3, nrefx
= nref
% 3;
25510 grefy
= gref
/ 3, nrefy
= nref
/ 3;
25512 xoff
= font_height
* (xoff
- 128) / 256;
25514 yoff
= font_height
* (yoff
- 128) / 256;
25517 + grefx
* (rightmost
- leftmost
) / 2
25518 - nrefx
* width
/ 2
25521 btm
= ((grefy
== 0 ? highest
25523 : grefy
== 2 ? lowest
25524 : (highest
+ lowest
) / 2)
25525 - (nrefy
== 0 ? ascent
+ descent
25526 : nrefy
== 1 ? descent
- boff
25528 : (ascent
+ descent
) / 2)
25532 cmp
->offsets
[i
* 2] = left
;
25533 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
25535 /* Update the bounding box of the overall glyphs. */
25538 right
= left
+ width
;
25539 if (left
< leftmost
)
25541 if (right
> rightmost
)
25544 top
= btm
+ descent
+ ascent
;
25550 if (cmp
->lbearing
> left
+ lbearing
)
25551 cmp
->lbearing
= left
+ lbearing
;
25552 if (cmp
->rbearing
< left
+ rbearing
)
25553 cmp
->rbearing
= left
+ rbearing
;
25557 /* If there are glyphs whose x-offsets are negative,
25558 shift all glyphs to the right and make all x-offsets
25562 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25563 cmp
->offsets
[i
* 2] -= leftmost
;
25564 rightmost
-= leftmost
;
25565 cmp
->lbearing
-= leftmost
;
25566 cmp
->rbearing
-= leftmost
;
25569 if (left_padded
&& cmp
->lbearing
< 0)
25571 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25572 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
25573 rightmost
-= cmp
->lbearing
;
25574 cmp
->rbearing
-= cmp
->lbearing
;
25577 if (right_padded
&& rightmost
< cmp
->rbearing
)
25579 rightmost
= cmp
->rbearing
;
25582 cmp
->pixel_width
= rightmost
;
25583 cmp
->ascent
= highest
;
25584 cmp
->descent
= - lowest
;
25585 if (cmp
->ascent
< font_ascent
)
25586 cmp
->ascent
= font_ascent
;
25587 if (cmp
->descent
< font_descent
)
25588 cmp
->descent
= font_descent
;
25592 && (cmp
->lbearing
< 0
25593 || cmp
->rbearing
> cmp
->pixel_width
))
25594 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25596 it
->pixel_width
= cmp
->pixel_width
;
25597 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
25598 it
->descent
= it
->phys_descent
= cmp
->descent
;
25599 if (face
->box
!= FACE_NO_BOX
)
25601 int thick
= face
->box_line_width
;
25605 it
->ascent
+= thick
;
25606 it
->descent
+= thick
;
25611 if (it
->start_of_box_run_p
)
25612 it
->pixel_width
+= thick
;
25613 if (it
->end_of_box_run_p
)
25614 it
->pixel_width
+= thick
;
25617 /* If face has an overline, add the height of the overline
25618 (1 pixel) and a 1 pixel margin to the character height. */
25619 if (face
->overline_p
)
25620 it
->ascent
+= overline_margin
;
25622 take_vertical_position_into_account (it
);
25623 if (it
->ascent
< 0)
25625 if (it
->descent
< 0)
25628 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
25629 append_composite_glyph (it
);
25631 else if (it
->what
== IT_COMPOSITION
)
25633 /* A dynamic (automatic) composition. */
25634 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25635 Lisp_Object gstring
;
25636 struct font_metrics metrics
;
25640 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
25642 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
25645 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
25646 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25647 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
25648 it
->descent
= it
->phys_descent
= metrics
.descent
;
25649 if (face
->box
!= FACE_NO_BOX
)
25651 int thick
= face
->box_line_width
;
25655 it
->ascent
+= thick
;
25656 it
->descent
+= thick
;
25661 if (it
->start_of_box_run_p
)
25662 it
->pixel_width
+= thick
;
25663 if (it
->end_of_box_run_p
)
25664 it
->pixel_width
+= thick
;
25666 /* If face has an overline, add the height of the overline
25667 (1 pixel) and a 1 pixel margin to the character height. */
25668 if (face
->overline_p
)
25669 it
->ascent
+= overline_margin
;
25670 take_vertical_position_into_account (it
);
25671 if (it
->ascent
< 0)
25673 if (it
->descent
< 0)
25677 append_composite_glyph (it
);
25679 else if (it
->what
== IT_GLYPHLESS
)
25680 produce_glyphless_glyph (it
, 0, Qnil
);
25681 else if (it
->what
== IT_IMAGE
)
25682 produce_image_glyph (it
);
25683 else if (it
->what
== IT_STRETCH
)
25684 produce_stretch_glyph (it
);
25687 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25688 because this isn't true for images with `:ascent 100'. */
25689 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
25690 if (it
->area
== TEXT_AREA
)
25691 it
->current_x
+= it
->pixel_width
;
25693 if (extra_line_spacing
> 0)
25695 it
->descent
+= extra_line_spacing
;
25696 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25697 it
->max_extra_line_spacing
= extra_line_spacing
;
25700 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25701 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25702 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25703 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25707 Output LEN glyphs starting at START at the nominal cursor position.
25708 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
25709 being updated, and UPDATED_AREA is the area of that row being updated. */
25712 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
25713 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
25715 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
25717 eassert (updated_row
);
25718 /* When the window is hscrolled, cursor hpos can legitimately be out
25719 of bounds, but we draw the cursor at the corresponding window
25720 margin in that case. */
25721 if (!updated_row
->reversed_p
&& chpos
< 0)
25723 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25724 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25728 /* Write glyphs. */
25730 hpos
= start
- updated_row
->glyphs
[updated_area
];
25731 x
= draw_glyphs (w
, w
->output_cursor
.x
,
25732 updated_row
, updated_area
,
25734 DRAW_NORMAL_TEXT
, 0);
25736 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25737 if (updated_area
== TEXT_AREA
25738 && w
->phys_cursor_on_p
25739 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
25741 && chpos
< hpos
+ len
)
25742 w
->phys_cursor_on_p
= 0;
25746 /* Advance the output cursor. */
25747 w
->output_cursor
.hpos
+= len
;
25748 w
->output_cursor
.x
= x
;
25753 Insert LEN glyphs from START at the nominal cursor position. */
25756 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
25757 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
25760 int line_height
, shift_by_width
, shifted_region_width
;
25761 struct glyph_row
*row
;
25762 struct glyph
*glyph
;
25763 int frame_x
, frame_y
;
25766 eassert (updated_row
);
25768 f
= XFRAME (WINDOW_FRAME (w
));
25770 /* Get the height of the line we are in. */
25772 line_height
= row
->height
;
25774 /* Get the width of the glyphs to insert. */
25775 shift_by_width
= 0;
25776 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25777 shift_by_width
+= glyph
->pixel_width
;
25779 /* Get the width of the region to shift right. */
25780 shifted_region_width
= (window_box_width (w
, updated_area
)
25781 - w
->output_cursor
.x
25785 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
25786 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
25788 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25789 line_height
, shift_by_width
);
25791 /* Write the glyphs. */
25792 hpos
= start
- row
->glyphs
[updated_area
];
25793 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
25795 DRAW_NORMAL_TEXT
, 0);
25797 /* Advance the output cursor. */
25798 w
->output_cursor
.hpos
+= len
;
25799 w
->output_cursor
.x
+= shift_by_width
;
25805 Erase the current text line from the nominal cursor position
25806 (inclusive) to pixel column TO_X (exclusive). The idea is that
25807 everything from TO_X onward is already erased.
25809 TO_X is a pixel position relative to UPDATED_AREA of currently
25810 updated window W. TO_X == -1 means clear to the end of this area. */
25813 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
25814 enum glyph_row_area updated_area
, int to_x
)
25817 int max_x
, min_y
, max_y
;
25818 int from_x
, from_y
, to_y
;
25820 eassert (updated_row
);
25821 f
= XFRAME (w
->frame
);
25823 if (updated_row
->full_width_p
)
25824 max_x
= WINDOW_TOTAL_WIDTH (w
);
25826 max_x
= window_box_width (w
, updated_area
);
25827 max_y
= window_text_bottom_y (w
);
25829 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25830 of window. For TO_X > 0, truncate to end of drawing area. */
25836 to_x
= min (to_x
, max_x
);
25838 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
25840 /* Notice if the cursor will be cleared by this operation. */
25841 if (!updated_row
->full_width_p
)
25842 notice_overwritten_cursor (w
, updated_area
,
25843 w
->output_cursor
.x
, -1,
25845 MATRIX_ROW_BOTTOM_Y (updated_row
));
25847 from_x
= w
->output_cursor
.x
;
25849 /* Translate to frame coordinates. */
25850 if (updated_row
->full_width_p
)
25852 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25853 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25857 int area_left
= window_box_left (w
, updated_area
);
25858 from_x
+= area_left
;
25862 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25863 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
25864 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25866 /* Prevent inadvertently clearing to end of the X window. */
25867 if (to_x
> from_x
&& to_y
> from_y
)
25870 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25871 to_x
- from_x
, to_y
- from_y
);
25876 #endif /* HAVE_WINDOW_SYSTEM */
25880 /***********************************************************************
25882 ***********************************************************************/
25884 /* Value is the internal representation of the specified cursor type
25885 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25886 of the bar cursor. */
25888 static enum text_cursor_kinds
25889 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25891 enum text_cursor_kinds type
;
25896 if (EQ (arg
, Qbox
))
25897 return FILLED_BOX_CURSOR
;
25899 if (EQ (arg
, Qhollow
))
25900 return HOLLOW_BOX_CURSOR
;
25902 if (EQ (arg
, Qbar
))
25909 && EQ (XCAR (arg
), Qbar
)
25910 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25912 *width
= XINT (XCDR (arg
));
25916 if (EQ (arg
, Qhbar
))
25919 return HBAR_CURSOR
;
25923 && EQ (XCAR (arg
), Qhbar
)
25924 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25926 *width
= XINT (XCDR (arg
));
25927 return HBAR_CURSOR
;
25930 /* Treat anything unknown as "hollow box cursor".
25931 It was bad to signal an error; people have trouble fixing
25932 .Xdefaults with Emacs, when it has something bad in it. */
25933 type
= HOLLOW_BOX_CURSOR
;
25938 /* Set the default cursor types for specified frame. */
25940 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25945 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25946 FRAME_CURSOR_WIDTH (f
) = width
;
25948 /* By default, set up the blink-off state depending on the on-state. */
25950 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25953 FRAME_BLINK_OFF_CURSOR (f
)
25954 = get_specified_cursor_type (XCDR (tem
), &width
);
25955 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25958 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25960 /* Make sure the cursor gets redrawn. */
25961 cursor_type_changed
= 1;
25965 #ifdef HAVE_WINDOW_SYSTEM
25967 /* Return the cursor we want to be displayed in window W. Return
25968 width of bar/hbar cursor through WIDTH arg. Return with
25969 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25970 (i.e. if the `system caret' should track this cursor).
25972 In a mini-buffer window, we want the cursor only to appear if we
25973 are reading input from this window. For the selected window, we
25974 want the cursor type given by the frame parameter or buffer local
25975 setting of cursor-type. If explicitly marked off, draw no cursor.
25976 In all other cases, we want a hollow box cursor. */
25978 static enum text_cursor_kinds
25979 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25980 int *active_cursor
)
25982 struct frame
*f
= XFRAME (w
->frame
);
25983 struct buffer
*b
= XBUFFER (w
->contents
);
25984 int cursor_type
= DEFAULT_CURSOR
;
25985 Lisp_Object alt_cursor
;
25986 int non_selected
= 0;
25988 *active_cursor
= 1;
25991 if (cursor_in_echo_area
25992 && FRAME_HAS_MINIBUF_P (f
)
25993 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25995 if (w
== XWINDOW (echo_area_window
))
25997 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25999 *width
= FRAME_CURSOR_WIDTH (f
);
26000 return FRAME_DESIRED_CURSOR (f
);
26003 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26006 *active_cursor
= 0;
26010 /* Detect a nonselected window or nonselected frame. */
26011 else if (w
!= XWINDOW (f
->selected_window
)
26012 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
26014 *active_cursor
= 0;
26016 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
26022 /* Never display a cursor in a window in which cursor-type is nil. */
26023 if (NILP (BVAR (b
, cursor_type
)))
26026 /* Get the normal cursor type for this window. */
26027 if (EQ (BVAR (b
, cursor_type
), Qt
))
26029 cursor_type
= FRAME_DESIRED_CURSOR (f
);
26030 *width
= FRAME_CURSOR_WIDTH (f
);
26033 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26035 /* Use cursor-in-non-selected-windows instead
26036 for non-selected window or frame. */
26039 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
26040 if (!EQ (Qt
, alt_cursor
))
26041 return get_specified_cursor_type (alt_cursor
, width
);
26042 /* t means modify the normal cursor type. */
26043 if (cursor_type
== FILLED_BOX_CURSOR
)
26044 cursor_type
= HOLLOW_BOX_CURSOR
;
26045 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
26047 return cursor_type
;
26050 /* Use normal cursor if not blinked off. */
26051 if (!w
->cursor_off_p
)
26053 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26055 if (cursor_type
== FILLED_BOX_CURSOR
)
26057 /* Using a block cursor on large images can be very annoying.
26058 So use a hollow cursor for "large" images.
26059 If image is not transparent (no mask), also use hollow cursor. */
26060 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26061 if (img
!= NULL
&& IMAGEP (img
->spec
))
26063 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
26064 where N = size of default frame font size.
26065 This should cover most of the "tiny" icons people may use. */
26067 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
26068 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
26069 cursor_type
= HOLLOW_BOX_CURSOR
;
26072 else if (cursor_type
!= NO_CURSOR
)
26074 /* Display current only supports BOX and HOLLOW cursors for images.
26075 So for now, unconditionally use a HOLLOW cursor when cursor is
26076 not a solid box cursor. */
26077 cursor_type
= HOLLOW_BOX_CURSOR
;
26080 return cursor_type
;
26083 /* Cursor is blinked off, so determine how to "toggle" it. */
26085 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
26086 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
26087 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
26089 /* Then see if frame has specified a specific blink off cursor type. */
26090 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
26092 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
26093 return FRAME_BLINK_OFF_CURSOR (f
);
26097 /* Some people liked having a permanently visible blinking cursor,
26098 while others had very strong opinions against it. So it was
26099 decided to remove it. KFS 2003-09-03 */
26101 /* Finally perform built-in cursor blinking:
26102 filled box <-> hollow box
26103 wide [h]bar <-> narrow [h]bar
26104 narrow [h]bar <-> no cursor
26105 other type <-> no cursor */
26107 if (cursor_type
== FILLED_BOX_CURSOR
)
26108 return HOLLOW_BOX_CURSOR
;
26110 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
26113 return cursor_type
;
26121 /* Notice when the text cursor of window W has been completely
26122 overwritten by a drawing operation that outputs glyphs in AREA
26123 starting at X0 and ending at X1 in the line starting at Y0 and
26124 ending at Y1. X coordinates are area-relative. X1 < 0 means all
26125 the rest of the line after X0 has been written. Y coordinates
26126 are window-relative. */
26129 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
26130 int x0
, int x1
, int y0
, int y1
)
26132 int cx0
, cx1
, cy0
, cy1
;
26133 struct glyph_row
*row
;
26135 if (!w
->phys_cursor_on_p
)
26137 if (area
!= TEXT_AREA
)
26140 if (w
->phys_cursor
.vpos
< 0
26141 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
26142 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
26143 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
26146 if (row
->cursor_in_fringe_p
)
26148 row
->cursor_in_fringe_p
= 0;
26149 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
26150 w
->phys_cursor_on_p
= 0;
26154 cx0
= w
->phys_cursor
.x
;
26155 cx1
= cx0
+ w
->phys_cursor_width
;
26156 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
26159 /* The cursor image will be completely removed from the
26160 screen if the output area intersects the cursor area in
26161 y-direction. When we draw in [y0 y1[, and some part of
26162 the cursor is at y < y0, that part must have been drawn
26163 before. When scrolling, the cursor is erased before
26164 actually scrolling, so we don't come here. When not
26165 scrolling, the rows above the old cursor row must have
26166 changed, and in this case these rows must have written
26167 over the cursor image.
26169 Likewise if part of the cursor is below y1, with the
26170 exception of the cursor being in the first blank row at
26171 the buffer and window end because update_text_area
26172 doesn't draw that row. (Except when it does, but
26173 that's handled in update_text_area.) */
26175 cy0
= w
->phys_cursor
.y
;
26176 cy1
= cy0
+ w
->phys_cursor_height
;
26177 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
26180 w
->phys_cursor_on_p
= 0;
26183 #endif /* HAVE_WINDOW_SYSTEM */
26186 /************************************************************************
26188 ************************************************************************/
26190 #ifdef HAVE_WINDOW_SYSTEM
26193 Fix the display of area AREA of overlapping row ROW in window W
26194 with respect to the overlapping part OVERLAPS. */
26197 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
26198 enum glyph_row_area area
, int overlaps
)
26205 for (i
= 0; i
< row
->used
[area
];)
26207 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
26209 int start
= i
, start_x
= x
;
26213 x
+= row
->glyphs
[area
][i
].pixel_width
;
26216 while (i
< row
->used
[area
]
26217 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
26219 draw_glyphs (w
, start_x
, row
, area
,
26221 DRAW_NORMAL_TEXT
, overlaps
);
26225 x
+= row
->glyphs
[area
][i
].pixel_width
;
26235 Draw the cursor glyph of window W in glyph row ROW. See the
26236 comment of draw_glyphs for the meaning of HL. */
26239 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
26240 enum draw_glyphs_face hl
)
26242 /* If cursor hpos is out of bounds, don't draw garbage. This can
26243 happen in mini-buffer windows when switching between echo area
26244 glyphs and mini-buffer. */
26245 if ((row
->reversed_p
26246 ? (w
->phys_cursor
.hpos
>= 0)
26247 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
26249 int on_p
= w
->phys_cursor_on_p
;
26251 int hpos
= w
->phys_cursor
.hpos
;
26253 /* When the window is hscrolled, cursor hpos can legitimately be
26254 out of bounds, but we draw the cursor at the corresponding
26255 window margin in that case. */
26256 if (!row
->reversed_p
&& hpos
< 0)
26258 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26259 hpos
= row
->used
[TEXT_AREA
] - 1;
26261 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
26263 w
->phys_cursor_on_p
= on_p
;
26265 if (hl
== DRAW_CURSOR
)
26266 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
26267 /* When we erase the cursor, and ROW is overlapped by other
26268 rows, make sure that these overlapping parts of other rows
26270 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
26272 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
26274 if (row
> w
->current_matrix
->rows
26275 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
26276 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
26277 OVERLAPS_ERASED_CURSOR
);
26279 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
26280 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
26281 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
26282 OVERLAPS_ERASED_CURSOR
);
26289 Erase the image of a cursor of window W from the screen. */
26292 erase_phys_cursor (struct window
*w
)
26294 struct frame
*f
= XFRAME (w
->frame
);
26295 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26296 int hpos
= w
->phys_cursor
.hpos
;
26297 int vpos
= w
->phys_cursor
.vpos
;
26298 int mouse_face_here_p
= 0;
26299 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
26300 struct glyph_row
*cursor_row
;
26301 struct glyph
*cursor_glyph
;
26302 enum draw_glyphs_face hl
;
26304 /* No cursor displayed or row invalidated => nothing to do on the
26306 if (w
->phys_cursor_type
== NO_CURSOR
)
26307 goto mark_cursor_off
;
26309 /* VPOS >= active_glyphs->nrows means that window has been resized.
26310 Don't bother to erase the cursor. */
26311 if (vpos
>= active_glyphs
->nrows
)
26312 goto mark_cursor_off
;
26314 /* If row containing cursor is marked invalid, there is nothing we
26316 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
26317 if (!cursor_row
->enabled_p
)
26318 goto mark_cursor_off
;
26320 /* If line spacing is > 0, old cursor may only be partially visible in
26321 window after split-window. So adjust visible height. */
26322 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
26323 window_text_bottom_y (w
) - cursor_row
->y
);
26325 /* If row is completely invisible, don't attempt to delete a cursor which
26326 isn't there. This can happen if cursor is at top of a window, and
26327 we switch to a buffer with a header line in that window. */
26328 if (cursor_row
->visible_height
<= 0)
26329 goto mark_cursor_off
;
26331 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
26332 if (cursor_row
->cursor_in_fringe_p
)
26334 cursor_row
->cursor_in_fringe_p
= 0;
26335 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
26336 goto mark_cursor_off
;
26339 /* This can happen when the new row is shorter than the old one.
26340 In this case, either draw_glyphs or clear_end_of_line
26341 should have cleared the cursor. Note that we wouldn't be
26342 able to erase the cursor in this case because we don't have a
26343 cursor glyph at hand. */
26344 if ((cursor_row
->reversed_p
26345 ? (w
->phys_cursor
.hpos
< 0)
26346 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
26347 goto mark_cursor_off
;
26349 /* When the window is hscrolled, cursor hpos can legitimately be out
26350 of bounds, but we draw the cursor at the corresponding window
26351 margin in that case. */
26352 if (!cursor_row
->reversed_p
&& hpos
< 0)
26354 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
26355 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
26357 /* If the cursor is in the mouse face area, redisplay that when
26358 we clear the cursor. */
26359 if (! NILP (hlinfo
->mouse_face_window
)
26360 && coords_in_mouse_face_p (w
, hpos
, vpos
)
26361 /* Don't redraw the cursor's spot in mouse face if it is at the
26362 end of a line (on a newline). The cursor appears there, but
26363 mouse highlighting does not. */
26364 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
26365 mouse_face_here_p
= 1;
26367 /* Maybe clear the display under the cursor. */
26368 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
26371 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
26374 cursor_glyph
= get_phys_cursor_glyph (w
);
26375 if (cursor_glyph
== NULL
)
26376 goto mark_cursor_off
;
26378 width
= cursor_glyph
->pixel_width
;
26379 left_x
= window_box_left_offset (w
, TEXT_AREA
);
26380 x
= w
->phys_cursor
.x
;
26382 width
-= left_x
- x
;
26383 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
26384 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
26385 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
26388 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
26391 /* Erase the cursor by redrawing the character underneath it. */
26392 if (mouse_face_here_p
)
26393 hl
= DRAW_MOUSE_FACE
;
26395 hl
= DRAW_NORMAL_TEXT
;
26396 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
26399 w
->phys_cursor_on_p
= 0;
26400 w
->phys_cursor_type
= NO_CURSOR
;
26405 Display or clear cursor of window W. If ON is zero, clear the
26406 cursor. If it is non-zero, display the cursor. If ON is nonzero,
26407 where to put the cursor is specified by HPOS, VPOS, X and Y. */
26410 display_and_set_cursor (struct window
*w
, bool on
,
26411 int hpos
, int vpos
, int x
, int y
)
26413 struct frame
*f
= XFRAME (w
->frame
);
26414 int new_cursor_type
;
26415 int new_cursor_width
;
26417 struct glyph_row
*glyph_row
;
26418 struct glyph
*glyph
;
26420 /* This is pointless on invisible frames, and dangerous on garbaged
26421 windows and frames; in the latter case, the frame or window may
26422 be in the midst of changing its size, and x and y may be off the
26424 if (! FRAME_VISIBLE_P (f
)
26425 || FRAME_GARBAGED_P (f
)
26426 || vpos
>= w
->current_matrix
->nrows
26427 || hpos
>= w
->current_matrix
->matrix_w
)
26430 /* If cursor is off and we want it off, return quickly. */
26431 if (!on
&& !w
->phys_cursor_on_p
)
26434 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26435 /* If cursor row is not enabled, we don't really know where to
26436 display the cursor. */
26437 if (!glyph_row
->enabled_p
)
26439 w
->phys_cursor_on_p
= 0;
26444 if (!glyph_row
->exact_window_width_line_p
26445 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
26446 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
26448 eassert (input_blocked_p ());
26450 /* Set new_cursor_type to the cursor we want to be displayed. */
26451 new_cursor_type
= get_window_cursor_type (w
, glyph
,
26452 &new_cursor_width
, &active_cursor
);
26454 /* If cursor is currently being shown and we don't want it to be or
26455 it is in the wrong place, or the cursor type is not what we want,
26457 if (w
->phys_cursor_on_p
26459 || w
->phys_cursor
.x
!= x
26460 || w
->phys_cursor
.y
!= y
26461 || new_cursor_type
!= w
->phys_cursor_type
26462 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
26463 && new_cursor_width
!= w
->phys_cursor_width
)))
26464 erase_phys_cursor (w
);
26466 /* Don't check phys_cursor_on_p here because that flag is only set
26467 to zero in some cases where we know that the cursor has been
26468 completely erased, to avoid the extra work of erasing the cursor
26469 twice. In other words, phys_cursor_on_p can be 1 and the cursor
26470 still not be visible, or it has only been partly erased. */
26473 w
->phys_cursor_ascent
= glyph_row
->ascent
;
26474 w
->phys_cursor_height
= glyph_row
->height
;
26476 /* Set phys_cursor_.* before x_draw_.* is called because some
26477 of them may need the information. */
26478 w
->phys_cursor
.x
= x
;
26479 w
->phys_cursor
.y
= glyph_row
->y
;
26480 w
->phys_cursor
.hpos
= hpos
;
26481 w
->phys_cursor
.vpos
= vpos
;
26484 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
26485 new_cursor_type
, new_cursor_width
,
26486 on
, active_cursor
);
26490 /* Switch the display of W's cursor on or off, according to the value
26494 update_window_cursor (struct window
*w
, bool on
)
26496 /* Don't update cursor in windows whose frame is in the process
26497 of being deleted. */
26498 if (w
->current_matrix
)
26500 int hpos
= w
->phys_cursor
.hpos
;
26501 int vpos
= w
->phys_cursor
.vpos
;
26502 struct glyph_row
*row
;
26504 if (vpos
>= w
->current_matrix
->nrows
26505 || hpos
>= w
->current_matrix
->matrix_w
)
26508 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26510 /* When the window is hscrolled, cursor hpos can legitimately be
26511 out of bounds, but we draw the cursor at the corresponding
26512 window margin in that case. */
26513 if (!row
->reversed_p
&& hpos
< 0)
26515 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26516 hpos
= row
->used
[TEXT_AREA
] - 1;
26519 display_and_set_cursor (w
, on
, hpos
, vpos
,
26520 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26526 /* Call update_window_cursor with parameter ON_P on all leaf windows
26527 in the window tree rooted at W. */
26530 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
26534 if (WINDOWP (w
->contents
))
26535 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
26537 update_window_cursor (w
, on_p
);
26539 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
26545 Display the cursor on window W, or clear it, according to ON_P.
26546 Don't change the cursor's position. */
26549 x_update_cursor (struct frame
*f
, bool on_p
)
26551 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
26556 Clear the cursor of window W to background color, and mark the
26557 cursor as not shown. This is used when the text where the cursor
26558 is about to be rewritten. */
26561 x_clear_cursor (struct window
*w
)
26563 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
26564 update_window_cursor (w
, 0);
26567 #endif /* HAVE_WINDOW_SYSTEM */
26569 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26572 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
26573 int start_hpos
, int end_hpos
,
26574 enum draw_glyphs_face draw
)
26576 #ifdef HAVE_WINDOW_SYSTEM
26577 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
26579 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
26583 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26584 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
26588 /* Display the active region described by mouse_face_* according to DRAW. */
26591 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
26593 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
26594 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26596 if (/* If window is in the process of being destroyed, don't bother
26598 w
->current_matrix
!= NULL
26599 /* Don't update mouse highlight if hidden */
26600 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
26601 /* Recognize when we are called to operate on rows that don't exist
26602 anymore. This can happen when a window is split. */
26603 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
26605 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
26606 struct glyph_row
*row
, *first
, *last
;
26608 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
26609 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
26611 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
26613 int start_hpos
, end_hpos
, start_x
;
26615 /* For all but the first row, the highlight starts at column 0. */
26618 /* R2L rows have BEG and END in reversed order, but the
26619 screen drawing geometry is always left to right. So
26620 we need to mirror the beginning and end of the
26621 highlighted area in R2L rows. */
26622 if (!row
->reversed_p
)
26624 start_hpos
= hlinfo
->mouse_face_beg_col
;
26625 start_x
= hlinfo
->mouse_face_beg_x
;
26627 else if (row
== last
)
26629 start_hpos
= hlinfo
->mouse_face_end_col
;
26630 start_x
= hlinfo
->mouse_face_end_x
;
26638 else if (row
->reversed_p
&& row
== last
)
26640 start_hpos
= hlinfo
->mouse_face_end_col
;
26641 start_x
= hlinfo
->mouse_face_end_x
;
26651 if (!row
->reversed_p
)
26652 end_hpos
= hlinfo
->mouse_face_end_col
;
26653 else if (row
== first
)
26654 end_hpos
= hlinfo
->mouse_face_beg_col
;
26657 end_hpos
= row
->used
[TEXT_AREA
];
26658 if (draw
== DRAW_NORMAL_TEXT
)
26659 row
->fill_line_p
= 1; /* Clear to end of line */
26662 else if (row
->reversed_p
&& row
== first
)
26663 end_hpos
= hlinfo
->mouse_face_beg_col
;
26666 end_hpos
= row
->used
[TEXT_AREA
];
26667 if (draw
== DRAW_NORMAL_TEXT
)
26668 row
->fill_line_p
= 1; /* Clear to end of line */
26671 if (end_hpos
> start_hpos
)
26673 draw_row_with_mouse_face (w
, start_x
, row
,
26674 start_hpos
, end_hpos
, draw
);
26677 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26681 #ifdef HAVE_WINDOW_SYSTEM
26682 /* When we've written over the cursor, arrange for it to
26683 be displayed again. */
26684 if (FRAME_WINDOW_P (f
)
26685 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26687 int hpos
= w
->phys_cursor
.hpos
;
26689 /* When the window is hscrolled, cursor hpos can legitimately be
26690 out of bounds, but we draw the cursor at the corresponding
26691 window margin in that case. */
26692 if (!row
->reversed_p
&& hpos
< 0)
26694 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26695 hpos
= row
->used
[TEXT_AREA
] - 1;
26698 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26699 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26702 #endif /* HAVE_WINDOW_SYSTEM */
26705 #ifdef HAVE_WINDOW_SYSTEM
26706 /* Change the mouse cursor. */
26707 if (FRAME_WINDOW_P (f
))
26709 if (draw
== DRAW_NORMAL_TEXT
26710 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26711 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26712 else if (draw
== DRAW_MOUSE_FACE
)
26713 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26715 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26717 #endif /* HAVE_WINDOW_SYSTEM */
26721 Clear out the mouse-highlighted active region.
26722 Redraw it un-highlighted first. Value is non-zero if mouse
26723 face was actually drawn unhighlighted. */
26726 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26730 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26732 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26736 reset_mouse_highlight (hlinfo
);
26740 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26741 within the mouse face on that window. */
26743 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26745 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26747 /* Quickly resolve the easy cases. */
26748 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26749 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26751 if (vpos
< hlinfo
->mouse_face_beg_row
26752 || vpos
> hlinfo
->mouse_face_end_row
)
26754 if (vpos
> hlinfo
->mouse_face_beg_row
26755 && vpos
< hlinfo
->mouse_face_end_row
)
26758 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26760 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26762 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26765 else if ((vpos
== hlinfo
->mouse_face_beg_row
26766 && hpos
>= hlinfo
->mouse_face_beg_col
)
26767 || (vpos
== hlinfo
->mouse_face_end_row
26768 && hpos
< hlinfo
->mouse_face_end_col
))
26773 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26775 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26778 else if ((vpos
== hlinfo
->mouse_face_beg_row
26779 && hpos
<= hlinfo
->mouse_face_beg_col
)
26780 || (vpos
== hlinfo
->mouse_face_end_row
26781 && hpos
> hlinfo
->mouse_face_end_col
))
26789 Non-zero if physical cursor of window W is within mouse face. */
26792 cursor_in_mouse_face_p (struct window
*w
)
26794 int hpos
= w
->phys_cursor
.hpos
;
26795 int vpos
= w
->phys_cursor
.vpos
;
26796 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26798 /* When the window is hscrolled, cursor hpos can legitimately be out
26799 of bounds, but we draw the cursor at the corresponding window
26800 margin in that case. */
26801 if (!row
->reversed_p
&& hpos
< 0)
26803 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26804 hpos
= row
->used
[TEXT_AREA
] - 1;
26806 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26811 /* Find the glyph rows START_ROW and END_ROW of window W that display
26812 characters between buffer positions START_CHARPOS and END_CHARPOS
26813 (excluding END_CHARPOS). DISP_STRING is a display string that
26814 covers these buffer positions. This is similar to
26815 row_containing_pos, but is more accurate when bidi reordering makes
26816 buffer positions change non-linearly with glyph rows. */
26818 rows_from_pos_range (struct window
*w
,
26819 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26820 Lisp_Object disp_string
,
26821 struct glyph_row
**start
, struct glyph_row
**end
)
26823 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26824 int last_y
= window_text_bottom_y (w
);
26825 struct glyph_row
*row
;
26830 while (!first
->enabled_p
26831 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26834 /* Find the START row. */
26836 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26839 /* A row can potentially be the START row if the range of the
26840 characters it displays intersects the range
26841 [START_CHARPOS..END_CHARPOS). */
26842 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26843 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26844 /* See the commentary in row_containing_pos, for the
26845 explanation of the complicated way to check whether
26846 some position is beyond the end of the characters
26847 displayed by a row. */
26848 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26849 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26850 && !row
->ends_at_zv_p
26851 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26852 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26853 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26854 && !row
->ends_at_zv_p
26855 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26857 /* Found a candidate row. Now make sure at least one of the
26858 glyphs it displays has a charpos from the range
26859 [START_CHARPOS..END_CHARPOS).
26861 This is not obvious because bidi reordering could make
26862 buffer positions of a row be 1,2,3,102,101,100, and if we
26863 want to highlight characters in [50..60), we don't want
26864 this row, even though [50..60) does intersect [1..103),
26865 the range of character positions given by the row's start
26866 and end positions. */
26867 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26868 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26872 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26873 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26874 /* A glyph that comes from DISP_STRING is by
26875 definition to be highlighted. */
26876 || EQ (g
->object
, disp_string
))
26885 /* Find the END row. */
26887 /* If the last row is partially visible, start looking for END
26888 from that row, instead of starting from FIRST. */
26889 && !(row
->enabled_p
26890 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26892 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26894 struct glyph_row
*next
= row
+ 1;
26895 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26897 if (!next
->enabled_p
26898 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26899 /* The first row >= START whose range of displayed characters
26900 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26901 is the row END + 1. */
26902 || (start_charpos
< next_start
26903 && end_charpos
< next_start
)
26904 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26905 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26906 && !next
->ends_at_zv_p
26907 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26908 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26909 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26910 && !next
->ends_at_zv_p
26911 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26918 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26919 but none of the characters it displays are in the range, it is
26921 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26922 struct glyph
*s
= g
;
26923 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26927 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26928 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26929 /* If the buffer position of the first glyph in
26930 the row is equal to END_CHARPOS, it means
26931 the last character to be highlighted is the
26932 newline of ROW, and we must consider NEXT as
26934 || (((!next
->reversed_p
&& g
== s
)
26935 || (next
->reversed_p
&& g
== e
- 1))
26936 && (g
->charpos
== end_charpos
26937 /* Special case for when NEXT is an
26938 empty line at ZV. */
26939 || (g
->charpos
== -1
26940 && !row
->ends_at_zv_p
26941 && next_start
== end_charpos
)))))
26942 /* A glyph that comes from DISP_STRING is by
26943 definition to be highlighted. */
26944 || EQ (g
->object
, disp_string
))
26953 /* The first row that ends at ZV must be the last to be
26955 else if (next
->ends_at_zv_p
)
26964 /* This function sets the mouse_face_* elements of HLINFO, assuming
26965 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26966 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26967 for the overlay or run of text properties specifying the mouse
26968 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26969 before-string and after-string that must also be highlighted.
26970 DISP_STRING, if non-nil, is a display string that may cover some
26971 or all of the highlighted text. */
26974 mouse_face_from_buffer_pos (Lisp_Object window
,
26975 Mouse_HLInfo
*hlinfo
,
26976 ptrdiff_t mouse_charpos
,
26977 ptrdiff_t start_charpos
,
26978 ptrdiff_t end_charpos
,
26979 Lisp_Object before_string
,
26980 Lisp_Object after_string
,
26981 Lisp_Object disp_string
)
26983 struct window
*w
= XWINDOW (window
);
26984 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26985 struct glyph_row
*r1
, *r2
;
26986 struct glyph
*glyph
, *end
;
26987 ptrdiff_t ignore
, pos
;
26990 eassert (NILP (disp_string
) || STRINGP (disp_string
));
26991 eassert (NILP (before_string
) || STRINGP (before_string
));
26992 eassert (NILP (after_string
) || STRINGP (after_string
));
26994 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26995 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26997 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
26998 /* If the before-string or display-string contains newlines,
26999 rows_from_pos_range skips to its last row. Move back. */
27000 if (!NILP (before_string
) || !NILP (disp_string
))
27002 struct glyph_row
*prev
;
27003 while ((prev
= r1
- 1, prev
>= first
)
27004 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
27005 && prev
->used
[TEXT_AREA
] > 0)
27007 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
27008 glyph
= beg
+ prev
->used
[TEXT_AREA
];
27009 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
27011 || !(EQ (glyph
->object
, before_string
)
27012 || EQ (glyph
->object
, disp_string
)))
27019 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27020 hlinfo
->mouse_face_past_end
= 1;
27022 else if (!NILP (after_string
))
27024 /* If the after-string has newlines, advance to its last row. */
27025 struct glyph_row
*next
;
27026 struct glyph_row
*last
27027 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27029 for (next
= r2
+ 1;
27031 && next
->used
[TEXT_AREA
] > 0
27032 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
27036 /* The rest of the display engine assumes that mouse_face_beg_row is
27037 either above mouse_face_end_row or identical to it. But with
27038 bidi-reordered continued lines, the row for START_CHARPOS could
27039 be below the row for END_CHARPOS. If so, swap the rows and store
27040 them in correct order. */
27043 struct glyph_row
*tem
= r2
;
27049 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
27050 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
27052 /* For a bidi-reordered row, the positions of BEFORE_STRING,
27053 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
27054 could be anywhere in the row and in any order. The strategy
27055 below is to find the leftmost and the rightmost glyph that
27056 belongs to either of these 3 strings, or whose position is
27057 between START_CHARPOS and END_CHARPOS, and highlight all the
27058 glyphs between those two. This may cover more than just the text
27059 between START_CHARPOS and END_CHARPOS if the range of characters
27060 strides the bidi level boundary, e.g. if the beginning is in R2L
27061 text while the end is in L2R text or vice versa. */
27062 if (!r1
->reversed_p
)
27064 /* This row is in a left to right paragraph. Scan it left to
27066 glyph
= r1
->glyphs
[TEXT_AREA
];
27067 end
= glyph
+ r1
->used
[TEXT_AREA
];
27070 /* Skip truncation glyphs at the start of the glyph row. */
27071 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27073 && INTEGERP (glyph
->object
)
27074 && glyph
->charpos
< 0;
27076 x
+= glyph
->pixel_width
;
27078 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27079 or DISP_STRING, and the first glyph from buffer whose
27080 position is between START_CHARPOS and END_CHARPOS. */
27082 && !INTEGERP (glyph
->object
)
27083 && !EQ (glyph
->object
, disp_string
)
27084 && !(BUFFERP (glyph
->object
)
27085 && (glyph
->charpos
>= start_charpos
27086 && glyph
->charpos
< end_charpos
));
27089 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27090 are present at buffer positions between START_CHARPOS and
27091 END_CHARPOS, or if they come from an overlay. */
27092 if (EQ (glyph
->object
, before_string
))
27094 pos
= string_buffer_position (before_string
,
27096 /* If pos == 0, it means before_string came from an
27097 overlay, not from a buffer position. */
27098 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27101 else if (EQ (glyph
->object
, after_string
))
27103 pos
= string_buffer_position (after_string
, end_charpos
);
27104 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27107 x
+= glyph
->pixel_width
;
27109 hlinfo
->mouse_face_beg_x
= x
;
27110 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27114 /* This row is in a right to left paragraph. Scan it right to
27118 end
= r1
->glyphs
[TEXT_AREA
] - 1;
27119 glyph
= end
+ r1
->used
[TEXT_AREA
];
27121 /* Skip truncation glyphs at the start of the glyph row. */
27122 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27124 && INTEGERP (glyph
->object
)
27125 && glyph
->charpos
< 0;
27129 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27130 or DISP_STRING, and the first glyph from buffer whose
27131 position is between START_CHARPOS and END_CHARPOS. */
27133 && !INTEGERP (glyph
->object
)
27134 && !EQ (glyph
->object
, disp_string
)
27135 && !(BUFFERP (glyph
->object
)
27136 && (glyph
->charpos
>= start_charpos
27137 && glyph
->charpos
< end_charpos
));
27140 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27141 are present at buffer positions between START_CHARPOS and
27142 END_CHARPOS, or if they come from an overlay. */
27143 if (EQ (glyph
->object
, before_string
))
27145 pos
= string_buffer_position (before_string
, start_charpos
);
27146 /* If pos == 0, it means before_string came from an
27147 overlay, not from a buffer position. */
27148 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27151 else if (EQ (glyph
->object
, after_string
))
27153 pos
= string_buffer_position (after_string
, end_charpos
);
27154 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27159 glyph
++; /* first glyph to the right of the highlighted area */
27160 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
27161 x
+= g
->pixel_width
;
27162 hlinfo
->mouse_face_beg_x
= x
;
27163 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27166 /* If the highlight ends in a different row, compute GLYPH and END
27167 for the end row. Otherwise, reuse the values computed above for
27168 the row where the highlight begins. */
27171 if (!r2
->reversed_p
)
27173 glyph
= r2
->glyphs
[TEXT_AREA
];
27174 end
= glyph
+ r2
->used
[TEXT_AREA
];
27179 end
= r2
->glyphs
[TEXT_AREA
] - 1;
27180 glyph
= end
+ r2
->used
[TEXT_AREA
];
27184 if (!r2
->reversed_p
)
27186 /* Skip truncation and continuation glyphs near the end of the
27187 row, and also blanks and stretch glyphs inserted by
27188 extend_face_to_end_of_line. */
27190 && INTEGERP ((end
- 1)->object
))
27192 /* Scan the rest of the glyph row from the end, looking for the
27193 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
27194 DISP_STRING, or whose position is between START_CHARPOS
27198 && !INTEGERP (end
->object
)
27199 && !EQ (end
->object
, disp_string
)
27200 && !(BUFFERP (end
->object
)
27201 && (end
->charpos
>= start_charpos
27202 && end
->charpos
< end_charpos
));
27205 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27206 are present at buffer positions between START_CHARPOS and
27207 END_CHARPOS, or if they come from an overlay. */
27208 if (EQ (end
->object
, before_string
))
27210 pos
= string_buffer_position (before_string
, start_charpos
);
27211 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27214 else if (EQ (end
->object
, after_string
))
27216 pos
= string_buffer_position (after_string
, end_charpos
);
27217 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27221 /* Find the X coordinate of the last glyph to be highlighted. */
27222 for (; glyph
<= end
; ++glyph
)
27223 x
+= glyph
->pixel_width
;
27225 hlinfo
->mouse_face_end_x
= x
;
27226 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
27230 /* Skip truncation and continuation glyphs near the end of the
27231 row, and also blanks and stretch glyphs inserted by
27232 extend_face_to_end_of_line. */
27236 && INTEGERP (end
->object
))
27238 x
+= end
->pixel_width
;
27241 /* Scan the rest of the glyph row from the end, looking for the
27242 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
27243 DISP_STRING, or whose position is between START_CHARPOS
27247 && !INTEGERP (end
->object
)
27248 && !EQ (end
->object
, disp_string
)
27249 && !(BUFFERP (end
->object
)
27250 && (end
->charpos
>= start_charpos
27251 && end
->charpos
< end_charpos
));
27254 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27255 are present at buffer positions between START_CHARPOS and
27256 END_CHARPOS, or if they come from an overlay. */
27257 if (EQ (end
->object
, before_string
))
27259 pos
= string_buffer_position (before_string
, start_charpos
);
27260 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27263 else if (EQ (end
->object
, after_string
))
27265 pos
= string_buffer_position (after_string
, end_charpos
);
27266 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27269 x
+= end
->pixel_width
;
27271 /* If we exited the above loop because we arrived at the last
27272 glyph of the row, and its buffer position is still not in
27273 range, it means the last character in range is the preceding
27274 newline. Bump the end column and x values to get past the
27277 && BUFFERP (end
->object
)
27278 && (end
->charpos
< start_charpos
27279 || end
->charpos
>= end_charpos
))
27281 x
+= end
->pixel_width
;
27284 hlinfo
->mouse_face_end_x
= x
;
27285 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
27288 hlinfo
->mouse_face_window
= window
;
27289 hlinfo
->mouse_face_face_id
27290 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
27292 !hlinfo
->mouse_face_hidden
, -1);
27293 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27296 /* The following function is not used anymore (replaced with
27297 mouse_face_from_string_pos), but I leave it here for the time
27298 being, in case someone would. */
27300 #if 0 /* not used */
27302 /* Find the position of the glyph for position POS in OBJECT in
27303 window W's current matrix, and return in *X, *Y the pixel
27304 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
27306 RIGHT_P non-zero means return the position of the right edge of the
27307 glyph, RIGHT_P zero means return the left edge position.
27309 If no glyph for POS exists in the matrix, return the position of
27310 the glyph with the next smaller position that is in the matrix, if
27311 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
27312 exists in the matrix, return the position of the glyph with the
27313 next larger position in OBJECT.
27315 Value is non-zero if a glyph was found. */
27318 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
27319 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
27321 int yb
= window_text_bottom_y (w
);
27322 struct glyph_row
*r
;
27323 struct glyph
*best_glyph
= NULL
;
27324 struct glyph_row
*best_row
= NULL
;
27327 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27328 r
->enabled_p
&& r
->y
< yb
;
27331 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
27332 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
27335 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27336 if (EQ (g
->object
, object
))
27338 if (g
->charpos
== pos
)
27345 else if (best_glyph
== NULL
27346 || ((eabs (g
->charpos
- pos
)
27347 < eabs (best_glyph
->charpos
- pos
))
27350 : g
->charpos
> pos
)))
27364 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
27368 *x
+= best_glyph
->pixel_width
;
27373 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
27376 return best_glyph
!= NULL
;
27378 #endif /* not used */
27380 /* Find the positions of the first and the last glyphs in window W's
27381 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
27382 (assumed to be a string), and return in HLINFO's mouse_face_*
27383 members the pixel and column/row coordinates of those glyphs. */
27386 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
27387 Lisp_Object object
,
27388 ptrdiff_t startpos
, ptrdiff_t endpos
)
27390 int yb
= window_text_bottom_y (w
);
27391 struct glyph_row
*r
;
27392 struct glyph
*g
, *e
;
27396 /* Find the glyph row with at least one position in the range
27397 [STARTPOS..ENDPOS], and the first glyph in that row whose
27398 position belongs to that range. */
27399 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27400 r
->enabled_p
&& r
->y
< yb
;
27403 if (!r
->reversed_p
)
27405 g
= r
->glyphs
[TEXT_AREA
];
27406 e
= g
+ r
->used
[TEXT_AREA
];
27407 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27408 if (EQ (g
->object
, object
)
27409 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27411 hlinfo
->mouse_face_beg_row
27412 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
27413 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27414 hlinfo
->mouse_face_beg_x
= gx
;
27423 e
= r
->glyphs
[TEXT_AREA
];
27424 g
= e
+ r
->used
[TEXT_AREA
];
27425 for ( ; g
> e
; --g
)
27426 if (EQ ((g
-1)->object
, object
)
27427 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
27429 hlinfo
->mouse_face_beg_row
27430 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
27431 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27432 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
27433 gx
+= g1
->pixel_width
;
27434 hlinfo
->mouse_face_beg_x
= gx
;
27446 /* Starting with the next row, look for the first row which does NOT
27447 include any glyphs whose positions are in the range. */
27448 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
27450 g
= r
->glyphs
[TEXT_AREA
];
27451 e
= g
+ r
->used
[TEXT_AREA
];
27453 for ( ; g
< e
; ++g
)
27454 if (EQ (g
->object
, object
)
27455 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27464 /* The highlighted region ends on the previous row. */
27467 /* Set the end row. */
27468 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
27470 /* Compute and set the end column and the end column's horizontal
27471 pixel coordinate. */
27472 if (!r
->reversed_p
)
27474 g
= r
->glyphs
[TEXT_AREA
];
27475 e
= g
+ r
->used
[TEXT_AREA
];
27476 for ( ; e
> g
; --e
)
27477 if (EQ ((e
-1)->object
, object
)
27478 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
27480 hlinfo
->mouse_face_end_col
= e
- g
;
27482 for (gx
= r
->x
; g
< e
; ++g
)
27483 gx
+= g
->pixel_width
;
27484 hlinfo
->mouse_face_end_x
= gx
;
27488 e
= r
->glyphs
[TEXT_AREA
];
27489 g
= e
+ r
->used
[TEXT_AREA
];
27490 for (gx
= r
->x
; e
< g
; ++e
)
27492 if (EQ (e
->object
, object
)
27493 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
27495 gx
+= e
->pixel_width
;
27497 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
27498 hlinfo
->mouse_face_end_x
= gx
;
27502 #ifdef HAVE_WINDOW_SYSTEM
27504 /* See if position X, Y is within a hot-spot of an image. */
27507 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
27509 if (!CONSP (hot_spot
))
27512 if (EQ (XCAR (hot_spot
), Qrect
))
27514 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27515 Lisp_Object rect
= XCDR (hot_spot
);
27519 if (!CONSP (XCAR (rect
)))
27521 if (!CONSP (XCDR (rect
)))
27523 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
27525 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
27527 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
27529 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
27533 else if (EQ (XCAR (hot_spot
), Qcircle
))
27535 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27536 Lisp_Object circ
= XCDR (hot_spot
);
27537 Lisp_Object lr
, lx0
, ly0
;
27539 && CONSP (XCAR (circ
))
27540 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
27541 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
27542 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
27544 double r
= XFLOATINT (lr
);
27545 double dx
= XINT (lx0
) - x
;
27546 double dy
= XINT (ly0
) - y
;
27547 return (dx
* dx
+ dy
* dy
<= r
* r
);
27550 else if (EQ (XCAR (hot_spot
), Qpoly
))
27552 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27553 if (VECTORP (XCDR (hot_spot
)))
27555 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
27556 Lisp_Object
*poly
= v
->contents
;
27557 ptrdiff_t n
= v
->header
.size
;
27560 Lisp_Object lx
, ly
;
27563 /* Need an even number of coordinates, and at least 3 edges. */
27564 if (n
< 6 || n
& 1)
27567 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27568 If count is odd, we are inside polygon. Pixels on edges
27569 may or may not be included depending on actual geometry of the
27571 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
27572 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
27574 x0
= XINT (lx
), y0
= XINT (ly
);
27575 for (i
= 0; i
< n
; i
+= 2)
27577 int x1
= x0
, y1
= y0
;
27578 if ((lx
= poly
[i
], !INTEGERP (lx
))
27579 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
27581 x0
= XINT (lx
), y0
= XINT (ly
);
27583 /* Does this segment cross the X line? */
27591 if (y
> y0
&& y
> y1
)
27593 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
27603 find_hot_spot (Lisp_Object map
, int x
, int y
)
27605 while (CONSP (map
))
27607 if (CONSP (XCAR (map
))
27608 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
27616 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
27618 doc
: /* Lookup in image map MAP coordinates X and Y.
27619 An image map is an alist where each element has the format (AREA ID PLIST).
27620 An AREA is specified as either a rectangle, a circle, or a polygon:
27621 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27622 pixel coordinates of the upper left and bottom right corners.
27623 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27624 and the radius of the circle; r may be a float or integer.
27625 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27626 vector describes one corner in the polygon.
27627 Returns the alist element for the first matching AREA in MAP. */)
27628 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
27636 return find_hot_spot (map
,
27637 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
27638 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
27642 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27644 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
27646 /* Do not change cursor shape while dragging mouse. */
27647 if (!NILP (do_mouse_tracking
))
27650 if (!NILP (pointer
))
27652 if (EQ (pointer
, Qarrow
))
27653 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27654 else if (EQ (pointer
, Qhand
))
27655 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27656 else if (EQ (pointer
, Qtext
))
27657 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27658 else if (EQ (pointer
, intern ("hdrag")))
27659 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27660 #ifdef HAVE_X_WINDOWS
27661 else if (EQ (pointer
, intern ("vdrag")))
27662 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27664 else if (EQ (pointer
, intern ("hourglass")))
27665 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27666 else if (EQ (pointer
, Qmodeline
))
27667 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27669 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27672 if (cursor
!= No_Cursor
)
27673 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27676 #endif /* HAVE_WINDOW_SYSTEM */
27678 /* Take proper action when mouse has moved to the mode or header line
27679 or marginal area AREA of window W, x-position X and y-position Y.
27680 X is relative to the start of the text display area of W, so the
27681 width of bitmap areas and scroll bars must be subtracted to get a
27682 position relative to the start of the mode line. */
27685 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27686 enum window_part area
)
27688 struct window
*w
= XWINDOW (window
);
27689 struct frame
*f
= XFRAME (w
->frame
);
27690 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27691 #ifdef HAVE_WINDOW_SYSTEM
27692 Display_Info
*dpyinfo
;
27694 Cursor cursor
= No_Cursor
;
27695 Lisp_Object pointer
= Qnil
;
27696 int dx
, dy
, width
, height
;
27698 Lisp_Object string
, object
= Qnil
;
27699 Lisp_Object pos
IF_LINT (= Qnil
), help
;
27701 Lisp_Object mouse_face
;
27702 int original_x_pixel
= x
;
27703 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27704 struct glyph_row
*row
IF_LINT (= 0);
27706 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27711 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27712 returns them in row/column units! */
27713 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27714 &object
, &dx
, &dy
, &width
, &height
);
27716 row
= (area
== ON_MODE_LINE
27717 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27718 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27720 /* Find the glyph under the mouse pointer. */
27721 if (row
->mode_line_p
&& row
->enabled_p
)
27723 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27724 end
= glyph
+ row
->used
[TEXT_AREA
];
27726 for (x0
= original_x_pixel
;
27727 glyph
< end
&& x0
>= glyph
->pixel_width
;
27729 x0
-= glyph
->pixel_width
;
27737 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27738 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27739 returns them in row/column units! */
27740 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27741 &object
, &dx
, &dy
, &width
, &height
);
27746 #ifdef HAVE_WINDOW_SYSTEM
27747 if (IMAGEP (object
))
27749 Lisp_Object image_map
, hotspot
;
27750 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27752 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27754 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27758 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27759 If so, we could look for mouse-enter, mouse-leave
27760 properties in PLIST (and do something...). */
27761 hotspot
= XCDR (hotspot
);
27762 if (CONSP (hotspot
)
27763 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27765 pointer
= Fplist_get (plist
, Qpointer
);
27766 if (NILP (pointer
))
27768 help
= Fplist_get (plist
, Qhelp_echo
);
27771 help_echo_string
= help
;
27772 XSETWINDOW (help_echo_window
, w
);
27773 help_echo_object
= w
->contents
;
27774 help_echo_pos
= charpos
;
27778 if (NILP (pointer
))
27779 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27781 #endif /* HAVE_WINDOW_SYSTEM */
27783 if (STRINGP (string
))
27784 pos
= make_number (charpos
);
27786 /* Set the help text and mouse pointer. If the mouse is on a part
27787 of the mode line without any text (e.g. past the right edge of
27788 the mode line text), use the default help text and pointer. */
27789 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27791 /* Arrange to display the help by setting the global variables
27792 help_echo_string, help_echo_object, and help_echo_pos. */
27795 if (STRINGP (string
))
27796 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27800 help_echo_string
= help
;
27801 XSETWINDOW (help_echo_window
, w
);
27802 help_echo_object
= string
;
27803 help_echo_pos
= charpos
;
27805 else if (area
== ON_MODE_LINE
)
27807 Lisp_Object default_help
27808 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27811 if (STRINGP (default_help
))
27813 help_echo_string
= default_help
;
27814 XSETWINDOW (help_echo_window
, w
);
27815 help_echo_object
= Qnil
;
27816 help_echo_pos
= -1;
27821 #ifdef HAVE_WINDOW_SYSTEM
27822 /* Change the mouse pointer according to what is under it. */
27823 if (FRAME_WINDOW_P (f
))
27825 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27826 if (STRINGP (string
))
27828 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27830 if (NILP (pointer
))
27831 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27833 /* Change the mouse pointer according to what is under X/Y. */
27835 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27838 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27839 if (!KEYMAPP (map
))
27840 map
= Fget_text_property (pos
, Qkeymap
, string
);
27841 if (!KEYMAPP (map
))
27842 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27846 /* Default mode-line pointer. */
27847 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27852 /* Change the mouse face according to what is under X/Y. */
27853 if (STRINGP (string
))
27855 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27856 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
27857 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27862 struct glyph
* tmp_glyph
;
27866 int total_pixel_width
;
27867 ptrdiff_t begpos
, endpos
, ignore
;
27871 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27872 Qmouse_face
, string
, Qnil
);
27878 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27880 endpos
= SCHARS (string
);
27884 /* Calculate the glyph position GPOS of GLYPH in the
27885 displayed string, relative to the beginning of the
27886 highlighted part of the string.
27888 Note: GPOS is different from CHARPOS. CHARPOS is the
27889 position of GLYPH in the internal string object. A mode
27890 line string format has structures which are converted to
27891 a flattened string by the Emacs Lisp interpreter. The
27892 internal string is an element of those structures. The
27893 displayed string is the flattened string. */
27894 tmp_glyph
= row_start_glyph
;
27895 while (tmp_glyph
< glyph
27896 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27897 && begpos
<= tmp_glyph
->charpos
27898 && tmp_glyph
->charpos
< endpos
)))
27900 gpos
= glyph
- tmp_glyph
;
27902 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27903 the highlighted part of the displayed string to which
27904 GLYPH belongs. Note: GSEQ_LENGTH is different from
27905 SCHARS (STRING), because the latter returns the length of
27906 the internal string. */
27907 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27909 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27910 && begpos
<= tmp_glyph
->charpos
27911 && tmp_glyph
->charpos
< endpos
));
27914 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27916 /* Calculate the total pixel width of all the glyphs between
27917 the beginning of the highlighted area and GLYPH. */
27918 total_pixel_width
= 0;
27919 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27920 total_pixel_width
+= tmp_glyph
->pixel_width
;
27922 /* Pre calculation of re-rendering position. Note: X is in
27923 column units here, after the call to mode_line_string or
27924 marginal_area_string. */
27926 vpos
= (area
== ON_MODE_LINE
27927 ? (w
->current_matrix
)->nrows
- 1
27930 /* If GLYPH's position is included in the region that is
27931 already drawn in mouse face, we have nothing to do. */
27932 if ( EQ (window
, hlinfo
->mouse_face_window
)
27933 && (!row
->reversed_p
27934 ? (hlinfo
->mouse_face_beg_col
<= hpos
27935 && hpos
< hlinfo
->mouse_face_end_col
)
27936 /* In R2L rows we swap BEG and END, see below. */
27937 : (hlinfo
->mouse_face_end_col
<= hpos
27938 && hpos
< hlinfo
->mouse_face_beg_col
))
27939 && hlinfo
->mouse_face_beg_row
== vpos
)
27942 if (clear_mouse_face (hlinfo
))
27943 cursor
= No_Cursor
;
27945 if (!row
->reversed_p
)
27947 hlinfo
->mouse_face_beg_col
= hpos
;
27948 hlinfo
->mouse_face_beg_x
= original_x_pixel
27949 - (total_pixel_width
+ dx
);
27950 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27951 hlinfo
->mouse_face_end_x
= 0;
27955 /* In R2L rows, show_mouse_face expects BEG and END
27956 coordinates to be swapped. */
27957 hlinfo
->mouse_face_end_col
= hpos
;
27958 hlinfo
->mouse_face_end_x
= original_x_pixel
27959 - (total_pixel_width
+ dx
);
27960 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27961 hlinfo
->mouse_face_beg_x
= 0;
27964 hlinfo
->mouse_face_beg_row
= vpos
;
27965 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27966 hlinfo
->mouse_face_past_end
= 0;
27967 hlinfo
->mouse_face_window
= window
;
27969 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27975 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27977 if (NILP (pointer
))
27980 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27981 clear_mouse_face (hlinfo
);
27983 #ifdef HAVE_WINDOW_SYSTEM
27984 if (FRAME_WINDOW_P (f
))
27985 define_frame_cursor1 (f
, cursor
, pointer
);
27991 Take proper action when the mouse has moved to position X, Y on
27992 frame F with regards to highlighting portions of display that have
27993 mouse-face properties. Also de-highlight portions of display where
27994 the mouse was before, set the mouse pointer shape as appropriate
27995 for the mouse coordinates, and activate help echo (tooltips).
27996 X and Y can be negative or out of range. */
27999 note_mouse_highlight (struct frame
*f
, int x
, int y
)
28001 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28002 enum window_part part
= ON_NOTHING
;
28003 Lisp_Object window
;
28005 Cursor cursor
= No_Cursor
;
28006 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
28009 /* When a menu is active, don't highlight because this looks odd. */
28010 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
28011 if (popup_activated ())
28015 if (!f
->glyphs_initialized_p
28016 || f
->pointer_invisible
)
28019 hlinfo
->mouse_face_mouse_x
= x
;
28020 hlinfo
->mouse_face_mouse_y
= y
;
28021 hlinfo
->mouse_face_mouse_frame
= f
;
28023 if (hlinfo
->mouse_face_defer
)
28026 /* Which window is that in? */
28027 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
28029 /* If displaying active text in another window, clear that. */
28030 if (! EQ (window
, hlinfo
->mouse_face_window
)
28031 /* Also clear if we move out of text area in same window. */
28032 || (!NILP (hlinfo
->mouse_face_window
)
28035 && part
!= ON_MODE_LINE
28036 && part
!= ON_HEADER_LINE
))
28037 clear_mouse_face (hlinfo
);
28039 /* Not on a window -> return. */
28040 if (!WINDOWP (window
))
28043 /* Reset help_echo_string. It will get recomputed below. */
28044 help_echo_string
= Qnil
;
28046 /* Convert to window-relative pixel coordinates. */
28047 w
= XWINDOW (window
);
28048 frame_to_window_pixel_xy (w
, &x
, &y
);
28050 #ifdef HAVE_WINDOW_SYSTEM
28051 /* Handle tool-bar window differently since it doesn't display a
28053 if (EQ (window
, f
->tool_bar_window
))
28055 note_tool_bar_highlight (f
, x
, y
);
28060 /* Mouse is on the mode, header line or margin? */
28061 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
28062 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28064 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
28068 #ifdef HAVE_WINDOW_SYSTEM
28069 if (part
== ON_VERTICAL_BORDER
)
28071 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28072 help_echo_string
= build_string ("drag-mouse-1: resize");
28074 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
28075 || part
== ON_SCROLL_BAR
)
28076 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28078 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28081 /* Are we in a window whose display is up to date?
28082 And verify the buffer's text has not changed. */
28083 b
= XBUFFER (w
->contents
);
28084 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
28086 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
28088 struct glyph
*glyph
;
28089 Lisp_Object object
;
28090 Lisp_Object mouse_face
= Qnil
, position
;
28091 Lisp_Object
*overlay_vec
= NULL
;
28092 ptrdiff_t i
, noverlays
;
28093 struct buffer
*obuf
;
28094 ptrdiff_t obegv
, ozv
;
28097 /* Find the glyph under X/Y. */
28098 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
28100 #ifdef HAVE_WINDOW_SYSTEM
28101 /* Look for :pointer property on image. */
28102 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
28104 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
28105 if (img
!= NULL
&& IMAGEP (img
->spec
))
28107 Lisp_Object image_map
, hotspot
;
28108 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
28110 && (hotspot
= find_hot_spot (image_map
,
28111 glyph
->slice
.img
.x
+ dx
,
28112 glyph
->slice
.img
.y
+ dy
),
28114 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28118 /* Could check XCAR (hotspot) to see if we enter/leave
28120 If so, we could look for mouse-enter, mouse-leave
28121 properties in PLIST (and do something...). */
28122 hotspot
= XCDR (hotspot
);
28123 if (CONSP (hotspot
)
28124 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28126 pointer
= Fplist_get (plist
, Qpointer
);
28127 if (NILP (pointer
))
28129 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
28130 if (!NILP (help_echo_string
))
28132 help_echo_window
= window
;
28133 help_echo_object
= glyph
->object
;
28134 help_echo_pos
= glyph
->charpos
;
28138 if (NILP (pointer
))
28139 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
28142 #endif /* HAVE_WINDOW_SYSTEM */
28144 /* Clear mouse face if X/Y not over text. */
28146 || area
!= TEXT_AREA
28147 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
28148 /* Glyph's OBJECT is an integer for glyphs inserted by the
28149 display engine for its internal purposes, like truncation
28150 and continuation glyphs and blanks beyond the end of
28151 line's text on text terminals. If we are over such a
28152 glyph, we are not over any text. */
28153 || INTEGERP (glyph
->object
)
28154 /* R2L rows have a stretch glyph at their front, which
28155 stands for no text, whereas L2R rows have no glyphs at
28156 all beyond the end of text. Treat such stretch glyphs
28157 like we do with NULL glyphs in L2R rows. */
28158 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
28159 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
28160 && glyph
->type
== STRETCH_GLYPH
28161 && glyph
->avoid_cursor_p
))
28163 if (clear_mouse_face (hlinfo
))
28164 cursor
= No_Cursor
;
28165 #ifdef HAVE_WINDOW_SYSTEM
28166 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28168 if (area
!= TEXT_AREA
)
28169 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28171 pointer
= Vvoid_text_area_pointer
;
28177 pos
= glyph
->charpos
;
28178 object
= glyph
->object
;
28179 if (!STRINGP (object
) && !BUFFERP (object
))
28182 /* If we get an out-of-range value, return now; avoid an error. */
28183 if (BUFFERP (object
) && pos
> BUF_Z (b
))
28186 /* Make the window's buffer temporarily current for
28187 overlays_at and compute_char_face. */
28188 obuf
= current_buffer
;
28189 current_buffer
= b
;
28195 /* Is this char mouse-active or does it have help-echo? */
28196 position
= make_number (pos
);
28198 if (BUFFERP (object
))
28200 /* Put all the overlays we want in a vector in overlay_vec. */
28201 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
28202 /* Sort overlays into increasing priority order. */
28203 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
28208 if (NILP (Vmouse_highlight
))
28210 clear_mouse_face (hlinfo
);
28211 goto check_help_echo
;
28214 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
28217 cursor
= No_Cursor
;
28219 /* Check mouse-face highlighting. */
28221 /* If there exists an overlay with mouse-face overlapping
28222 the one we are currently highlighting, we have to
28223 check if we enter the overlapping overlay, and then
28224 highlight only that. */
28225 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
28226 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
28228 /* Find the highest priority overlay with a mouse-face. */
28229 Lisp_Object overlay
= Qnil
;
28230 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
28232 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
28233 if (!NILP (mouse_face
))
28234 overlay
= overlay_vec
[i
];
28237 /* If we're highlighting the same overlay as before, there's
28238 no need to do that again. */
28239 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
28240 goto check_help_echo
;
28241 hlinfo
->mouse_face_overlay
= overlay
;
28243 /* Clear the display of the old active region, if any. */
28244 if (clear_mouse_face (hlinfo
))
28245 cursor
= No_Cursor
;
28247 /* If no overlay applies, get a text property. */
28248 if (NILP (overlay
))
28249 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
28251 /* Next, compute the bounds of the mouse highlighting and
28253 if (!NILP (mouse_face
) && STRINGP (object
))
28255 /* The mouse-highlighting comes from a display string
28256 with a mouse-face. */
28260 s
= Fprevious_single_property_change
28261 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
28262 e
= Fnext_single_property_change
28263 (position
, Qmouse_face
, object
, Qnil
);
28265 s
= make_number (0);
28267 e
= make_number (SCHARS (object
) - 1);
28268 mouse_face_from_string_pos (w
, hlinfo
, object
,
28269 XINT (s
), XINT (e
));
28270 hlinfo
->mouse_face_past_end
= 0;
28271 hlinfo
->mouse_face_window
= window
;
28272 hlinfo
->mouse_face_face_id
28273 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
28274 glyph
->face_id
, 1);
28275 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28276 cursor
= No_Cursor
;
28280 /* The mouse-highlighting, if any, comes from an overlay
28281 or text property in the buffer. */
28282 Lisp_Object buffer
IF_LINT (= Qnil
);
28283 Lisp_Object disp_string
IF_LINT (= Qnil
);
28285 if (STRINGP (object
))
28287 /* If we are on a display string with no mouse-face,
28288 check if the text under it has one. */
28289 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
28290 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28291 pos
= string_buffer_position (object
, start
);
28294 mouse_face
= get_char_property_and_overlay
28295 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
28296 buffer
= w
->contents
;
28297 disp_string
= object
;
28303 disp_string
= Qnil
;
28306 if (!NILP (mouse_face
))
28308 Lisp_Object before
, after
;
28309 Lisp_Object before_string
, after_string
;
28310 /* To correctly find the limits of mouse highlight
28311 in a bidi-reordered buffer, we must not use the
28312 optimization of limiting the search in
28313 previous-single-property-change and
28314 next-single-property-change, because
28315 rows_from_pos_range needs the real start and end
28316 positions to DTRT in this case. That's because
28317 the first row visible in a window does not
28318 necessarily display the character whose position
28319 is the smallest. */
28321 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
28322 ? Fmarker_position (w
->start
)
28325 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
28326 ? make_number (BUF_Z (XBUFFER (buffer
)) - w
->window_end_pos
)
28329 if (NILP (overlay
))
28331 /* Handle the text property case. */
28332 before
= Fprevious_single_property_change
28333 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
28334 after
= Fnext_single_property_change
28335 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
28336 before_string
= after_string
= Qnil
;
28340 /* Handle the overlay case. */
28341 before
= Foverlay_start (overlay
);
28342 after
= Foverlay_end (overlay
);
28343 before_string
= Foverlay_get (overlay
, Qbefore_string
);
28344 after_string
= Foverlay_get (overlay
, Qafter_string
);
28346 if (!STRINGP (before_string
)) before_string
= Qnil
;
28347 if (!STRINGP (after_string
)) after_string
= Qnil
;
28350 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
28353 : XFASTINT (before
),
28355 ? BUF_Z (XBUFFER (buffer
))
28356 : XFASTINT (after
),
28357 before_string
, after_string
,
28359 cursor
= No_Cursor
;
28366 /* Look for a `help-echo' property. */
28367 if (NILP (help_echo_string
)) {
28368 Lisp_Object help
, overlay
;
28370 /* Check overlays first. */
28371 help
= overlay
= Qnil
;
28372 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
28374 overlay
= overlay_vec
[i
];
28375 help
= Foverlay_get (overlay
, Qhelp_echo
);
28380 help_echo_string
= help
;
28381 help_echo_window
= window
;
28382 help_echo_object
= overlay
;
28383 help_echo_pos
= pos
;
28387 Lisp_Object obj
= glyph
->object
;
28388 ptrdiff_t charpos
= glyph
->charpos
;
28390 /* Try text properties. */
28393 && charpos
< SCHARS (obj
))
28395 help
= Fget_text_property (make_number (charpos
),
28399 /* If the string itself doesn't specify a help-echo,
28400 see if the buffer text ``under'' it does. */
28401 struct glyph_row
*r
28402 = MATRIX_ROW (w
->current_matrix
, vpos
);
28403 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28404 ptrdiff_t p
= string_buffer_position (obj
, start
);
28407 help
= Fget_char_property (make_number (p
),
28408 Qhelp_echo
, w
->contents
);
28417 else if (BUFFERP (obj
)
28420 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
28425 help_echo_string
= help
;
28426 help_echo_window
= window
;
28427 help_echo_object
= obj
;
28428 help_echo_pos
= charpos
;
28433 #ifdef HAVE_WINDOW_SYSTEM
28434 /* Look for a `pointer' property. */
28435 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28437 /* Check overlays first. */
28438 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
28439 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
28441 if (NILP (pointer
))
28443 Lisp_Object obj
= glyph
->object
;
28444 ptrdiff_t charpos
= glyph
->charpos
;
28446 /* Try text properties. */
28449 && charpos
< SCHARS (obj
))
28451 pointer
= Fget_text_property (make_number (charpos
),
28453 if (NILP (pointer
))
28455 /* If the string itself doesn't specify a pointer,
28456 see if the buffer text ``under'' it does. */
28457 struct glyph_row
*r
28458 = MATRIX_ROW (w
->current_matrix
, vpos
);
28459 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28460 ptrdiff_t p
= string_buffer_position (obj
, start
);
28462 pointer
= Fget_char_property (make_number (p
),
28463 Qpointer
, w
->contents
);
28466 else if (BUFFERP (obj
)
28469 pointer
= Fget_text_property (make_number (charpos
),
28473 #endif /* HAVE_WINDOW_SYSTEM */
28477 current_buffer
= obuf
;
28482 #ifdef HAVE_WINDOW_SYSTEM
28483 if (FRAME_WINDOW_P (f
))
28484 define_frame_cursor1 (f
, cursor
, pointer
);
28486 /* This is here to prevent a compiler error, about "label at end of
28487 compound statement". */
28494 Clear any mouse-face on window W. This function is part of the
28495 redisplay interface, and is called from try_window_id and similar
28496 functions to ensure the mouse-highlight is off. */
28499 x_clear_window_mouse_face (struct window
*w
)
28501 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28502 Lisp_Object window
;
28505 XSETWINDOW (window
, w
);
28506 if (EQ (window
, hlinfo
->mouse_face_window
))
28507 clear_mouse_face (hlinfo
);
28513 Just discard the mouse face information for frame F, if any.
28514 This is used when the size of F is changed. */
28517 cancel_mouse_face (struct frame
*f
)
28519 Lisp_Object window
;
28520 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28522 window
= hlinfo
->mouse_face_window
;
28523 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
28524 reset_mouse_highlight (hlinfo
);
28529 /***********************************************************************
28531 ***********************************************************************/
28533 #ifdef HAVE_WINDOW_SYSTEM
28535 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28536 which intersects rectangle R. R is in window-relative coordinates. */
28539 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
28540 enum glyph_row_area area
)
28542 struct glyph
*first
= row
->glyphs
[area
];
28543 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
28544 struct glyph
*last
;
28545 int first_x
, start_x
, x
;
28547 if (area
== TEXT_AREA
&& row
->fill_line_p
)
28548 /* If row extends face to end of line write the whole line. */
28549 draw_glyphs (w
, 0, row
, area
,
28550 0, row
->used
[area
],
28551 DRAW_NORMAL_TEXT
, 0);
28554 /* Set START_X to the window-relative start position for drawing glyphs of
28555 AREA. The first glyph of the text area can be partially visible.
28556 The first glyphs of other areas cannot. */
28557 start_x
= window_box_left_offset (w
, area
);
28559 if (area
== TEXT_AREA
)
28562 /* Find the first glyph that must be redrawn. */
28564 && x
+ first
->pixel_width
< r
->x
)
28566 x
+= first
->pixel_width
;
28570 /* Find the last one. */
28574 && x
< r
->x
+ r
->width
)
28576 x
+= last
->pixel_width
;
28582 draw_glyphs (w
, first_x
- start_x
, row
, area
,
28583 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
28584 DRAW_NORMAL_TEXT
, 0);
28589 /* Redraw the parts of the glyph row ROW on window W intersecting
28590 rectangle R. R is in window-relative coordinates. Value is
28591 non-zero if mouse-face was overwritten. */
28594 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
28596 eassert (row
->enabled_p
);
28598 if (row
->mode_line_p
|| w
->pseudo_window_p
)
28599 draw_glyphs (w
, 0, row
, TEXT_AREA
,
28600 0, row
->used
[TEXT_AREA
],
28601 DRAW_NORMAL_TEXT
, 0);
28604 if (row
->used
[LEFT_MARGIN_AREA
])
28605 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
28606 if (row
->used
[TEXT_AREA
])
28607 expose_area (w
, row
, r
, TEXT_AREA
);
28608 if (row
->used
[RIGHT_MARGIN_AREA
])
28609 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
28610 draw_row_fringe_bitmaps (w
, row
);
28613 return row
->mouse_face_p
;
28617 /* Redraw those parts of glyphs rows during expose event handling that
28618 overlap other rows. Redrawing of an exposed line writes over parts
28619 of lines overlapping that exposed line; this function fixes that.
28621 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28622 row in W's current matrix that is exposed and overlaps other rows.
28623 LAST_OVERLAPPING_ROW is the last such row. */
28626 expose_overlaps (struct window
*w
,
28627 struct glyph_row
*first_overlapping_row
,
28628 struct glyph_row
*last_overlapping_row
,
28631 struct glyph_row
*row
;
28633 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
28634 if (row
->overlapping_p
)
28636 eassert (row
->enabled_p
&& !row
->mode_line_p
);
28639 if (row
->used
[LEFT_MARGIN_AREA
])
28640 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
28642 if (row
->used
[TEXT_AREA
])
28643 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
28645 if (row
->used
[RIGHT_MARGIN_AREA
])
28646 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
28652 /* Return non-zero if W's cursor intersects rectangle R. */
28655 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
28657 XRectangle cr
, result
;
28658 struct glyph
*cursor_glyph
;
28659 struct glyph_row
*row
;
28661 if (w
->phys_cursor
.vpos
>= 0
28662 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
28663 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
28665 && row
->cursor_in_fringe_p
)
28667 /* Cursor is in the fringe. */
28668 cr
.x
= window_box_right_offset (w
,
28669 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
28670 ? RIGHT_MARGIN_AREA
28673 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
28674 cr
.height
= row
->height
;
28675 return x_intersect_rectangles (&cr
, r
, &result
);
28678 cursor_glyph
= get_phys_cursor_glyph (w
);
28681 /* r is relative to W's box, but w->phys_cursor.x is relative
28682 to left edge of W's TEXT area. Adjust it. */
28683 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28684 cr
.y
= w
->phys_cursor
.y
;
28685 cr
.width
= cursor_glyph
->pixel_width
;
28686 cr
.height
= w
->phys_cursor_height
;
28687 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28688 I assume the effect is the same -- and this is portable. */
28689 return x_intersect_rectangles (&cr
, r
, &result
);
28691 /* If we don't understand the format, pretend we're not in the hot-spot. */
28697 Draw a vertical window border to the right of window W if W doesn't
28698 have vertical scroll bars. */
28701 x_draw_vertical_border (struct window
*w
)
28703 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28705 /* We could do better, if we knew what type of scroll-bar the adjacent
28706 windows (on either side) have... But we don't :-(
28707 However, I think this works ok. ++KFS 2003-04-25 */
28709 /* Redraw borders between horizontally adjacent windows. Don't
28710 do it for frames with vertical scroll bars because either the
28711 right scroll bar of a window, or the left scroll bar of its
28712 neighbor will suffice as a border. */
28713 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28716 /* Note: It is necessary to redraw both the left and the right
28717 borders, for when only this single window W is being
28719 if (!WINDOW_RIGHTMOST_P (w
)
28720 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28722 int x0
, x1
, y0
, y1
;
28724 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
28727 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28730 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28732 if (!WINDOW_LEFTMOST_P (w
)
28733 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28735 int x0
, x1
, y0
, y1
;
28737 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
28740 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28743 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28748 /* Redraw the part of window W intersection rectangle FR. Pixel
28749 coordinates in FR are frame-relative. Call this function with
28750 input blocked. Value is non-zero if the exposure overwrites
28754 expose_window (struct window
*w
, XRectangle
*fr
)
28756 struct frame
*f
= XFRAME (w
->frame
);
28758 int mouse_face_overwritten_p
= 0;
28760 /* If window is not yet fully initialized, do nothing. This can
28761 happen when toolkit scroll bars are used and a window is split.
28762 Reconfiguring the scroll bar will generate an expose for a newly
28764 if (w
->current_matrix
== NULL
)
28767 /* When we're currently updating the window, display and current
28768 matrix usually don't agree. Arrange for a thorough display
28770 if (w
->must_be_updated_p
)
28772 SET_FRAME_GARBAGED (f
);
28776 /* Frame-relative pixel rectangle of W. */
28777 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28778 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28779 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28780 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28782 if (x_intersect_rectangles (fr
, &wr
, &r
))
28784 int yb
= window_text_bottom_y (w
);
28785 struct glyph_row
*row
;
28786 int cursor_cleared_p
, phys_cursor_on_p
;
28787 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28789 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28790 r
.x
, r
.y
, r
.width
, r
.height
));
28792 /* Convert to window coordinates. */
28793 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28794 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28796 /* Turn off the cursor. */
28797 if (!w
->pseudo_window_p
28798 && phys_cursor_in_rect_p (w
, &r
))
28800 x_clear_cursor (w
);
28801 cursor_cleared_p
= 1;
28804 cursor_cleared_p
= 0;
28806 /* If the row containing the cursor extends face to end of line,
28807 then expose_area might overwrite the cursor outside the
28808 rectangle and thus notice_overwritten_cursor might clear
28809 w->phys_cursor_on_p. We remember the original value and
28810 check later if it is changed. */
28811 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28813 /* Update lines intersecting rectangle R. */
28814 first_overlapping_row
= last_overlapping_row
= NULL
;
28815 for (row
= w
->current_matrix
->rows
;
28820 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28822 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28823 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28824 || (r
.y
>= y0
&& r
.y
< y1
)
28825 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28827 /* A header line may be overlapping, but there is no need
28828 to fix overlapping areas for them. KFS 2005-02-12 */
28829 if (row
->overlapping_p
&& !row
->mode_line_p
)
28831 if (first_overlapping_row
== NULL
)
28832 first_overlapping_row
= row
;
28833 last_overlapping_row
= row
;
28837 if (expose_line (w
, row
, &r
))
28838 mouse_face_overwritten_p
= 1;
28841 else if (row
->overlapping_p
)
28843 /* We must redraw a row overlapping the exposed area. */
28845 ? y0
+ row
->phys_height
> r
.y
28846 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28848 if (first_overlapping_row
== NULL
)
28849 first_overlapping_row
= row
;
28850 last_overlapping_row
= row
;
28858 /* Display the mode line if there is one. */
28859 if (WINDOW_WANTS_MODELINE_P (w
)
28860 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28862 && row
->y
< r
.y
+ r
.height
)
28864 if (expose_line (w
, row
, &r
))
28865 mouse_face_overwritten_p
= 1;
28868 if (!w
->pseudo_window_p
)
28870 /* Fix the display of overlapping rows. */
28871 if (first_overlapping_row
)
28872 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28875 /* Draw border between windows. */
28876 x_draw_vertical_border (w
);
28878 /* Turn the cursor on again. */
28879 if (cursor_cleared_p
28880 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28881 update_window_cursor (w
, 1);
28885 return mouse_face_overwritten_p
;
28890 /* Redraw (parts) of all windows in the window tree rooted at W that
28891 intersect R. R contains frame pixel coordinates. Value is
28892 non-zero if the exposure overwrites mouse-face. */
28895 expose_window_tree (struct window
*w
, XRectangle
*r
)
28897 struct frame
*f
= XFRAME (w
->frame
);
28898 int mouse_face_overwritten_p
= 0;
28900 while (w
&& !FRAME_GARBAGED_P (f
))
28902 if (WINDOWP (w
->contents
))
28903 mouse_face_overwritten_p
28904 |= expose_window_tree (XWINDOW (w
->contents
), r
);
28906 mouse_face_overwritten_p
|= expose_window (w
, r
);
28908 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28911 return mouse_face_overwritten_p
;
28916 Redisplay an exposed area of frame F. X and Y are the upper-left
28917 corner of the exposed rectangle. W and H are width and height of
28918 the exposed area. All are pixel values. W or H zero means redraw
28919 the entire frame. */
28922 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28925 int mouse_face_overwritten_p
= 0;
28927 TRACE ((stderr
, "expose_frame "));
28929 /* No need to redraw if frame will be redrawn soon. */
28930 if (FRAME_GARBAGED_P (f
))
28932 TRACE ((stderr
, " garbaged\n"));
28936 /* If basic faces haven't been realized yet, there is no point in
28937 trying to redraw anything. This can happen when we get an expose
28938 event while Emacs is starting, e.g. by moving another window. */
28939 if (FRAME_FACE_CACHE (f
) == NULL
28940 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28942 TRACE ((stderr
, " no faces\n"));
28946 if (w
== 0 || h
== 0)
28949 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28950 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28960 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28961 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28963 if (WINDOWP (f
->tool_bar_window
))
28964 mouse_face_overwritten_p
28965 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28967 #ifdef HAVE_X_WINDOWS
28969 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
28970 if (WINDOWP (f
->menu_bar_window
))
28971 mouse_face_overwritten_p
28972 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28973 #endif /* not USE_X_TOOLKIT and not USE_GTK */
28977 /* Some window managers support a focus-follows-mouse style with
28978 delayed raising of frames. Imagine a partially obscured frame,
28979 and moving the mouse into partially obscured mouse-face on that
28980 frame. The visible part of the mouse-face will be highlighted,
28981 then the WM raises the obscured frame. With at least one WM, KDE
28982 2.1, Emacs is not getting any event for the raising of the frame
28983 (even tried with SubstructureRedirectMask), only Expose events.
28984 These expose events will draw text normally, i.e. not
28985 highlighted. Which means we must redo the highlight here.
28986 Subsume it under ``we love X''. --gerd 2001-08-15 */
28987 /* Included in Windows version because Windows most likely does not
28988 do the right thing if any third party tool offers
28989 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28990 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28992 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28993 if (f
== hlinfo
->mouse_face_mouse_frame
)
28995 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28996 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28997 clear_mouse_face (hlinfo
);
28998 note_mouse_highlight (f
, mouse_x
, mouse_y
);
29005 Determine the intersection of two rectangles R1 and R2. Return
29006 the intersection in *RESULT. Value is non-zero if RESULT is not
29010 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
29012 XRectangle
*left
, *right
;
29013 XRectangle
*upper
, *lower
;
29014 int intersection_p
= 0;
29016 /* Rearrange so that R1 is the left-most rectangle. */
29018 left
= r1
, right
= r2
;
29020 left
= r2
, right
= r1
;
29022 /* X0 of the intersection is right.x0, if this is inside R1,
29023 otherwise there is no intersection. */
29024 if (right
->x
<= left
->x
+ left
->width
)
29026 result
->x
= right
->x
;
29028 /* The right end of the intersection is the minimum of
29029 the right ends of left and right. */
29030 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
29033 /* Same game for Y. */
29035 upper
= r1
, lower
= r2
;
29037 upper
= r2
, lower
= r1
;
29039 /* The upper end of the intersection is lower.y0, if this is inside
29040 of upper. Otherwise, there is no intersection. */
29041 if (lower
->y
<= upper
->y
+ upper
->height
)
29043 result
->y
= lower
->y
;
29045 /* The lower end of the intersection is the minimum of the lower
29046 ends of upper and lower. */
29047 result
->height
= (min (lower
->y
+ lower
->height
,
29048 upper
->y
+ upper
->height
)
29050 intersection_p
= 1;
29054 return intersection_p
;
29057 #endif /* HAVE_WINDOW_SYSTEM */
29060 /***********************************************************************
29062 ***********************************************************************/
29065 syms_of_xdisp (void)
29067 Vwith_echo_area_save_vector
= Qnil
;
29068 staticpro (&Vwith_echo_area_save_vector
);
29070 Vmessage_stack
= Qnil
;
29071 staticpro (&Vmessage_stack
);
29073 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
29074 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
29076 message_dolog_marker1
= Fmake_marker ();
29077 staticpro (&message_dolog_marker1
);
29078 message_dolog_marker2
= Fmake_marker ();
29079 staticpro (&message_dolog_marker2
);
29080 message_dolog_marker3
= Fmake_marker ();
29081 staticpro (&message_dolog_marker3
);
29084 defsubr (&Sdump_frame_glyph_matrix
);
29085 defsubr (&Sdump_glyph_matrix
);
29086 defsubr (&Sdump_glyph_row
);
29087 defsubr (&Sdump_tool_bar_row
);
29088 defsubr (&Strace_redisplay
);
29089 defsubr (&Strace_to_stderr
);
29091 #ifdef HAVE_WINDOW_SYSTEM
29092 defsubr (&Stool_bar_lines_needed
);
29093 defsubr (&Slookup_image_map
);
29095 defsubr (&Sline_pixel_height
);
29096 defsubr (&Sformat_mode_line
);
29097 defsubr (&Sinvisible_p
);
29098 defsubr (&Scurrent_bidi_paragraph_direction
);
29099 defsubr (&Smove_point_visually
);
29101 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
29102 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
29103 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
29104 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
29105 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
29106 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
29107 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
29108 DEFSYM (Qeval
, "eval");
29109 DEFSYM (QCdata
, ":data");
29110 DEFSYM (Qdisplay
, "display");
29111 DEFSYM (Qspace_width
, "space-width");
29112 DEFSYM (Qraise
, "raise");
29113 DEFSYM (Qslice
, "slice");
29114 DEFSYM (Qspace
, "space");
29115 DEFSYM (Qmargin
, "margin");
29116 DEFSYM (Qpointer
, "pointer");
29117 DEFSYM (Qleft_margin
, "left-margin");
29118 DEFSYM (Qright_margin
, "right-margin");
29119 DEFSYM (Qcenter
, "center");
29120 DEFSYM (Qline_height
, "line-height");
29121 DEFSYM (QCalign_to
, ":align-to");
29122 DEFSYM (QCrelative_width
, ":relative-width");
29123 DEFSYM (QCrelative_height
, ":relative-height");
29124 DEFSYM (QCeval
, ":eval");
29125 DEFSYM (QCpropertize
, ":propertize");
29126 DEFSYM (QCfile
, ":file");
29127 DEFSYM (Qfontified
, "fontified");
29128 DEFSYM (Qfontification_functions
, "fontification-functions");
29129 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
29130 DEFSYM (Qescape_glyph
, "escape-glyph");
29131 DEFSYM (Qnobreak_space
, "nobreak-space");
29132 DEFSYM (Qimage
, "image");
29133 DEFSYM (Qtext
, "text");
29134 DEFSYM (Qboth
, "both");
29135 DEFSYM (Qboth_horiz
, "both-horiz");
29136 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
29137 DEFSYM (QCmap
, ":map");
29138 DEFSYM (QCpointer
, ":pointer");
29139 DEFSYM (Qrect
, "rect");
29140 DEFSYM (Qcircle
, "circle");
29141 DEFSYM (Qpoly
, "poly");
29142 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
29143 DEFSYM (Qgrow_only
, "grow-only");
29144 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
29145 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
29146 DEFSYM (Qposition
, "position");
29147 DEFSYM (Qbuffer_position
, "buffer-position");
29148 DEFSYM (Qobject
, "object");
29149 DEFSYM (Qbar
, "bar");
29150 DEFSYM (Qhbar
, "hbar");
29151 DEFSYM (Qbox
, "box");
29152 DEFSYM (Qhollow
, "hollow");
29153 DEFSYM (Qhand
, "hand");
29154 DEFSYM (Qarrow
, "arrow");
29155 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
29157 list_of_error
= list1 (list2 (intern_c_string ("error"),
29158 intern_c_string ("void-variable")));
29159 staticpro (&list_of_error
);
29161 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
29162 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
29163 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
29164 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
29166 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
29167 staticpro (&echo_buffer
[0]);
29168 staticpro (&echo_buffer
[1]);
29170 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
29171 staticpro (&echo_area_buffer
[0]);
29172 staticpro (&echo_area_buffer
[1]);
29174 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
29175 staticpro (&Vmessages_buffer_name
);
29177 mode_line_proptrans_alist
= Qnil
;
29178 staticpro (&mode_line_proptrans_alist
);
29179 mode_line_string_list
= Qnil
;
29180 staticpro (&mode_line_string_list
);
29181 mode_line_string_face
= Qnil
;
29182 staticpro (&mode_line_string_face
);
29183 mode_line_string_face_prop
= Qnil
;
29184 staticpro (&mode_line_string_face_prop
);
29185 Vmode_line_unwind_vector
= Qnil
;
29186 staticpro (&Vmode_line_unwind_vector
);
29188 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
29190 help_echo_string
= Qnil
;
29191 staticpro (&help_echo_string
);
29192 help_echo_object
= Qnil
;
29193 staticpro (&help_echo_object
);
29194 help_echo_window
= Qnil
;
29195 staticpro (&help_echo_window
);
29196 previous_help_echo_string
= Qnil
;
29197 staticpro (&previous_help_echo_string
);
29198 help_echo_pos
= -1;
29200 DEFSYM (Qright_to_left
, "right-to-left");
29201 DEFSYM (Qleft_to_right
, "left-to-right");
29203 #ifdef HAVE_WINDOW_SYSTEM
29204 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
29205 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
29206 For example, if a block cursor is over a tab, it will be drawn as
29207 wide as that tab on the display. */);
29208 x_stretch_cursor_p
= 0;
29211 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
29212 doc
: /* Non-nil means highlight trailing whitespace.
29213 The face used for trailing whitespace is `trailing-whitespace'. */);
29214 Vshow_trailing_whitespace
= Qnil
;
29216 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
29217 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
29218 If the value is t, Emacs highlights non-ASCII chars which have the
29219 same appearance as an ASCII space or hyphen, using the `nobreak-space'
29220 or `escape-glyph' face respectively.
29222 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
29223 U+2011 (non-breaking hyphen) are affected.
29225 Any other non-nil value means to display these characters as a escape
29226 glyph followed by an ordinary space or hyphen.
29228 A value of nil means no special handling of these characters. */);
29229 Vnobreak_char_display
= Qt
;
29231 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
29232 doc
: /* The pointer shape to show in void text areas.
29233 A value of nil means to show the text pointer. Other options are `arrow',
29234 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
29235 Vvoid_text_area_pointer
= Qarrow
;
29237 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
29238 doc
: /* Non-nil means don't actually do any redisplay.
29239 This is used for internal purposes. */);
29240 Vinhibit_redisplay
= Qnil
;
29242 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
29243 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
29244 Vglobal_mode_string
= Qnil
;
29246 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
29247 doc
: /* Marker for where to display an arrow on top of the buffer text.
29248 This must be the beginning of a line in order to work.
29249 See also `overlay-arrow-string'. */);
29250 Voverlay_arrow_position
= Qnil
;
29252 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
29253 doc
: /* String to display as an arrow in non-window frames.
29254 See also `overlay-arrow-position'. */);
29255 Voverlay_arrow_string
= build_pure_c_string ("=>");
29257 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
29258 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
29259 The symbols on this list are examined during redisplay to determine
29260 where to display overlay arrows. */);
29261 Voverlay_arrow_variable_list
29262 = list1 (intern_c_string ("overlay-arrow-position"));
29264 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
29265 doc
: /* The number of lines to try scrolling a window by when point moves out.
29266 If that fails to bring point back on frame, point is centered instead.
29267 If this is zero, point is always centered after it moves off frame.
29268 If you want scrolling to always be a line at a time, you should set
29269 `scroll-conservatively' to a large value rather than set this to 1. */);
29271 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
29272 doc
: /* Scroll up to this many lines, to bring point back on screen.
29273 If point moves off-screen, redisplay will scroll by up to
29274 `scroll-conservatively' lines in order to bring point just barely
29275 onto the screen again. If that cannot be done, then redisplay
29276 recenters point as usual.
29278 If the value is greater than 100, redisplay will never recenter point,
29279 but will always scroll just enough text to bring point into view, even
29280 if you move far away.
29282 A value of zero means always recenter point if it moves off screen. */);
29283 scroll_conservatively
= 0;
29285 DEFVAR_INT ("scroll-margin", scroll_margin
,
29286 doc
: /* Number of lines of margin at the top and bottom of a window.
29287 Recenter the window whenever point gets within this many lines
29288 of the top or bottom of the window. */);
29291 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
29292 doc
: /* Pixels per inch value for non-window system displays.
29293 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
29294 Vdisplay_pixels_per_inch
= make_float (72.0);
29297 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
29300 DEFVAR_LISP ("truncate-partial-width-windows",
29301 Vtruncate_partial_width_windows
,
29302 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
29303 For an integer value, truncate lines in each window narrower than the
29304 full frame width, provided the window width is less than that integer;
29305 otherwise, respect the value of `truncate-lines'.
29307 For any other non-nil value, truncate lines in all windows that do
29308 not span the full frame width.
29310 A value of nil means to respect the value of `truncate-lines'.
29312 If `word-wrap' is enabled, you might want to reduce this. */);
29313 Vtruncate_partial_width_windows
= make_number (50);
29315 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
29316 doc
: /* Maximum buffer size for which line number should be displayed.
29317 If the buffer is bigger than this, the line number does not appear
29318 in the mode line. A value of nil means no limit. */);
29319 Vline_number_display_limit
= Qnil
;
29321 DEFVAR_INT ("line-number-display-limit-width",
29322 line_number_display_limit_width
,
29323 doc
: /* Maximum line width (in characters) for line number display.
29324 If the average length of the lines near point is bigger than this, then the
29325 line number may be omitted from the mode line. */);
29326 line_number_display_limit_width
= 200;
29328 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
29329 doc
: /* Non-nil means highlight region even in nonselected windows. */);
29330 highlight_nonselected_windows
= 0;
29332 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
29333 doc
: /* Non-nil if more than one frame is visible on this display.
29334 Minibuffer-only frames don't count, but iconified frames do.
29335 This variable is not guaranteed to be accurate except while processing
29336 `frame-title-format' and `icon-title-format'. */);
29338 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
29339 doc
: /* Template for displaying the title bar of visible frames.
29340 \(Assuming the window manager supports this feature.)
29342 This variable has the same structure as `mode-line-format', except that
29343 the %c and %l constructs are ignored. It is used only on frames for
29344 which no explicit name has been set \(see `modify-frame-parameters'). */);
29346 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
29347 doc
: /* Template for displaying the title bar of an iconified frame.
29348 \(Assuming the window manager supports this feature.)
29349 This variable has the same structure as `mode-line-format' (which see),
29350 and is used only on frames for which no explicit name has been set
29351 \(see `modify-frame-parameters'). */);
29353 = Vframe_title_format
29354 = listn (CONSTYPE_PURE
, 3,
29355 intern_c_string ("multiple-frames"),
29356 build_pure_c_string ("%b"),
29357 listn (CONSTYPE_PURE
, 4,
29358 empty_unibyte_string
,
29359 intern_c_string ("invocation-name"),
29360 build_pure_c_string ("@"),
29361 intern_c_string ("system-name")));
29363 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
29364 doc
: /* Maximum number of lines to keep in the message log buffer.
29365 If nil, disable message logging. If t, log messages but don't truncate
29366 the buffer when it becomes large. */);
29367 Vmessage_log_max
= make_number (1000);
29369 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
29370 doc
: /* Functions called before redisplay, if window sizes have changed.
29371 The value should be a list of functions that take one argument.
29372 Just before redisplay, for each frame, if any of its windows have changed
29373 size since the last redisplay, or have been split or deleted,
29374 all the functions in the list are called, with the frame as argument. */);
29375 Vwindow_size_change_functions
= Qnil
;
29377 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
29378 doc
: /* List of functions to call before redisplaying a window with scrolling.
29379 Each function is called with two arguments, the window and its new
29380 display-start position. Note that these functions are also called by
29381 `set-window-buffer'. Also note that the value of `window-end' is not
29382 valid when these functions are called.
29384 Warning: Do not use this feature to alter the way the window
29385 is scrolled. It is not designed for that, and such use probably won't
29387 Vwindow_scroll_functions
= Qnil
;
29389 DEFVAR_LISP ("window-text-change-functions",
29390 Vwindow_text_change_functions
,
29391 doc
: /* Functions to call in redisplay when text in the window might change. */);
29392 Vwindow_text_change_functions
= Qnil
;
29394 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
29395 doc
: /* Functions called when redisplay of a window reaches the end trigger.
29396 Each function is called with two arguments, the window and the end trigger value.
29397 See `set-window-redisplay-end-trigger'. */);
29398 Vredisplay_end_trigger_functions
= Qnil
;
29400 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
29401 doc
: /* Non-nil means autoselect window with mouse pointer.
29402 If nil, do not autoselect windows.
29403 A positive number means delay autoselection by that many seconds: a
29404 window is autoselected only after the mouse has remained in that
29405 window for the duration of the delay.
29406 A negative number has a similar effect, but causes windows to be
29407 autoselected only after the mouse has stopped moving. \(Because of
29408 the way Emacs compares mouse events, you will occasionally wait twice
29409 that time before the window gets selected.\)
29410 Any other value means to autoselect window instantaneously when the
29411 mouse pointer enters it.
29413 Autoselection selects the minibuffer only if it is active, and never
29414 unselects the minibuffer if it is active.
29416 When customizing this variable make sure that the actual value of
29417 `focus-follows-mouse' matches the behavior of your window manager. */);
29418 Vmouse_autoselect_window
= Qnil
;
29420 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
29421 doc
: /* Non-nil means automatically resize tool-bars.
29422 This dynamically changes the tool-bar's height to the minimum height
29423 that is needed to make all tool-bar items visible.
29424 If value is `grow-only', the tool-bar's height is only increased
29425 automatically; to decrease the tool-bar height, use \\[recenter]. */);
29426 Vauto_resize_tool_bars
= Qt
;
29428 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
29429 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
29430 auto_raise_tool_bar_buttons_p
= 1;
29432 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
29433 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
29434 make_cursor_line_fully_visible_p
= 1;
29436 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
29437 doc
: /* Border below tool-bar in pixels.
29438 If an integer, use it as the height of the border.
29439 If it is one of `internal-border-width' or `border-width', use the
29440 value of the corresponding frame parameter.
29441 Otherwise, no border is added below the tool-bar. */);
29442 Vtool_bar_border
= Qinternal_border_width
;
29444 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
29445 doc
: /* Margin around tool-bar buttons in pixels.
29446 If an integer, use that for both horizontal and vertical margins.
29447 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
29448 HORZ specifying the horizontal margin, and VERT specifying the
29449 vertical margin. */);
29450 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
29452 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
29453 doc
: /* Relief thickness of tool-bar buttons. */);
29454 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
29456 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
29457 doc
: /* Tool bar style to use.
29459 image - show images only
29460 text - show text only
29461 both - show both, text below image
29462 both-horiz - show text to the right of the image
29463 text-image-horiz - show text to the left of the image
29464 any other - use system default or image if no system default.
29466 This variable only affects the GTK+ toolkit version of Emacs. */);
29467 Vtool_bar_style
= Qnil
;
29469 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
29470 doc
: /* Maximum number of characters a label can have to be shown.
29471 The tool bar style must also show labels for this to have any effect, see
29472 `tool-bar-style'. */);
29473 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
29475 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
29476 doc
: /* List of functions to call to fontify regions of text.
29477 Each function is called with one argument POS. Functions must
29478 fontify a region starting at POS in the current buffer, and give
29479 fontified regions the property `fontified'. */);
29480 Vfontification_functions
= Qnil
;
29481 Fmake_variable_buffer_local (Qfontification_functions
);
29483 DEFVAR_BOOL ("unibyte-display-via-language-environment",
29484 unibyte_display_via_language_environment
,
29485 doc
: /* Non-nil means display unibyte text according to language environment.
29486 Specifically, this means that raw bytes in the range 160-255 decimal
29487 are displayed by converting them to the equivalent multibyte characters
29488 according to the current language environment. As a result, they are
29489 displayed according to the current fontset.
29491 Note that this variable affects only how these bytes are displayed,
29492 but does not change the fact they are interpreted as raw bytes. */);
29493 unibyte_display_via_language_environment
= 0;
29495 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
29496 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29497 If a float, it specifies a fraction of the mini-window frame's height.
29498 If an integer, it specifies a number of lines. */);
29499 Vmax_mini_window_height
= make_float (0.25);
29501 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
29502 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
29503 A value of nil means don't automatically resize mini-windows.
29504 A value of t means resize them to fit the text displayed in them.
29505 A value of `grow-only', the default, means let mini-windows grow only;
29506 they return to their normal size when the minibuffer is closed, or the
29507 echo area becomes empty. */);
29508 Vresize_mini_windows
= Qgrow_only
;
29510 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
29511 doc
: /* Alist specifying how to blink the cursor off.
29512 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29513 `cursor-type' frame-parameter or variable equals ON-STATE,
29514 comparing using `equal', Emacs uses OFF-STATE to specify
29515 how to blink it off. ON-STATE and OFF-STATE are values for
29516 the `cursor-type' frame parameter.
29518 If a frame's ON-STATE has no entry in this list,
29519 the frame's other specifications determine how to blink the cursor off. */);
29520 Vblink_cursor_alist
= Qnil
;
29522 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
29523 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
29524 If non-nil, windows are automatically scrolled horizontally to make
29525 point visible. */);
29526 automatic_hscrolling_p
= 1;
29527 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
29529 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
29530 doc
: /* How many columns away from the window edge point is allowed to get
29531 before automatic hscrolling will horizontally scroll the window. */);
29532 hscroll_margin
= 5;
29534 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
29535 doc
: /* How many columns to scroll the window when point gets too close to the edge.
29536 When point is less than `hscroll-margin' columns from the window
29537 edge, automatic hscrolling will scroll the window by the amount of columns
29538 determined by this variable. If its value is a positive integer, scroll that
29539 many columns. If it's a positive floating-point number, it specifies the
29540 fraction of the window's width to scroll. If it's nil or zero, point will be
29541 centered horizontally after the scroll. Any other value, including negative
29542 numbers, are treated as if the value were zero.
29544 Automatic hscrolling always moves point outside the scroll margin, so if
29545 point was more than scroll step columns inside the margin, the window will
29546 scroll more than the value given by the scroll step.
29548 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29549 and `scroll-right' overrides this variable's effect. */);
29550 Vhscroll_step
= make_number (0);
29552 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
29553 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
29554 Bind this around calls to `message' to let it take effect. */);
29555 message_truncate_lines
= 0;
29557 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
29558 doc
: /* Normal hook run to update the menu bar definitions.
29559 Redisplay runs this hook before it redisplays the menu bar.
29560 This is used to update submenus such as Buffers,
29561 whose contents depend on various data. */);
29562 Vmenu_bar_update_hook
= Qnil
;
29564 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
29565 doc
: /* Frame for which we are updating a menu.
29566 The enable predicate for a menu binding should check this variable. */);
29567 Vmenu_updating_frame
= Qnil
;
29569 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
29570 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
29571 inhibit_menubar_update
= 0;
29573 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
29574 doc
: /* Prefix prepended to all continuation lines at display time.
29575 The value may be a string, an image, or a stretch-glyph; it is
29576 interpreted in the same way as the value of a `display' text property.
29578 This variable is overridden by any `wrap-prefix' text or overlay
29581 To add a prefix to non-continuation lines, use `line-prefix'. */);
29582 Vwrap_prefix
= Qnil
;
29583 DEFSYM (Qwrap_prefix
, "wrap-prefix");
29584 Fmake_variable_buffer_local (Qwrap_prefix
);
29586 DEFVAR_LISP ("line-prefix", Vline_prefix
,
29587 doc
: /* Prefix prepended to all non-continuation lines at display time.
29588 The value may be a string, an image, or a stretch-glyph; it is
29589 interpreted in the same way as the value of a `display' text property.
29591 This variable is overridden by any `line-prefix' text or overlay
29594 To add a prefix to continuation lines, use `wrap-prefix'. */);
29595 Vline_prefix
= Qnil
;
29596 DEFSYM (Qline_prefix
, "line-prefix");
29597 Fmake_variable_buffer_local (Qline_prefix
);
29599 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
29600 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
29601 inhibit_eval_during_redisplay
= 0;
29603 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
29604 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
29605 inhibit_free_realized_faces
= 0;
29608 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
29609 doc
: /* Inhibit try_window_id display optimization. */);
29610 inhibit_try_window_id
= 0;
29612 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
29613 doc
: /* Inhibit try_window_reusing display optimization. */);
29614 inhibit_try_window_reusing
= 0;
29616 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
29617 doc
: /* Inhibit try_cursor_movement display optimization. */);
29618 inhibit_try_cursor_movement
= 0;
29619 #endif /* GLYPH_DEBUG */
29621 DEFVAR_INT ("overline-margin", overline_margin
,
29622 doc
: /* Space between overline and text, in pixels.
29623 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29624 margin to the character height. */);
29625 overline_margin
= 2;
29627 DEFVAR_INT ("underline-minimum-offset",
29628 underline_minimum_offset
,
29629 doc
: /* Minimum distance between baseline and underline.
29630 This can improve legibility of underlined text at small font sizes,
29631 particularly when using variable `x-use-underline-position-properties'
29632 with fonts that specify an UNDERLINE_POSITION relatively close to the
29633 baseline. The default value is 1. */);
29634 underline_minimum_offset
= 1;
29636 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
29637 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29638 This feature only works when on a window system that can change
29639 cursor shapes. */);
29640 display_hourglass_p
= 1;
29642 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
29643 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29644 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
29646 hourglass_atimer
= NULL
;
29647 hourglass_shown_p
= 0;
29649 DEFSYM (Qglyphless_char
, "glyphless-char");
29650 DEFSYM (Qhex_code
, "hex-code");
29651 DEFSYM (Qempty_box
, "empty-box");
29652 DEFSYM (Qthin_space
, "thin-space");
29653 DEFSYM (Qzero_width
, "zero-width");
29655 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
29656 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
29658 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
29659 doc
: /* Char-table defining glyphless characters.
29660 Each element, if non-nil, should be one of the following:
29661 an ASCII acronym string: display this string in a box
29662 `hex-code': display the hexadecimal code of a character in a box
29663 `empty-box': display as an empty box
29664 `thin-space': display as 1-pixel width space
29665 `zero-width': don't display
29666 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29667 display method for graphical terminals and text terminals respectively.
29668 GRAPHICAL and TEXT should each have one of the values listed above.
29670 The char-table has one extra slot to control the display of a character for
29671 which no font is found. This slot only takes effect on graphical terminals.
29672 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29673 `thin-space'. The default is `empty-box'. */);
29674 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29675 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29678 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
29679 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
29680 Vdebug_on_message
= Qnil
;
29684 /* Initialize this module when Emacs starts. */
29689 current_header_line_height
= current_mode_line_height
= -1;
29691 CHARPOS (this_line_start_pos
) = 0;
29693 if (!noninteractive
)
29695 struct window
*m
= XWINDOW (minibuf_window
);
29696 Lisp_Object frame
= m
->frame
;
29697 struct frame
*f
= XFRAME (frame
);
29698 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29699 struct window
*r
= XWINDOW (root
);
29702 echo_area_window
= minibuf_window
;
29704 r
->top_line
= FRAME_TOP_MARGIN (f
);
29705 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
29706 r
->total_cols
= FRAME_COLS (f
);
29708 m
->top_line
= FRAME_LINES (f
) - 1;
29709 m
->total_lines
= 1;
29710 m
->total_cols
= FRAME_COLS (f
);
29712 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29713 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29714 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29716 /* The default ellipsis glyphs `...'. */
29717 for (i
= 0; i
< 3; ++i
)
29718 default_invis_vector
[i
] = make_number ('.');
29722 /* Allocate the buffer for frame titles.
29723 Also used for `format-mode-line'. */
29725 mode_line_noprop_buf
= xmalloc (size
);
29726 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29727 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29728 mode_line_target
= MODE_LINE_DISPLAY
;
29731 help_echo_showing_p
= 0;
29734 /* Platform-independent portion of hourglass implementation. */
29736 /* Cancel a currently active hourglass timer, and start a new one. */
29738 start_hourglass (void)
29740 #if defined (HAVE_WINDOW_SYSTEM)
29741 struct timespec delay
;
29743 cancel_hourglass ();
29745 if (INTEGERP (Vhourglass_delay
)
29746 && XINT (Vhourglass_delay
) > 0)
29747 delay
= make_timespec (min (XINT (Vhourglass_delay
),
29748 TYPE_MAXIMUM (time_t)),
29750 else if (FLOATP (Vhourglass_delay
)
29751 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29752 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
29754 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
29758 extern void w32_note_current_window (void);
29759 w32_note_current_window ();
29761 #endif /* HAVE_NTGUI */
29763 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29764 show_hourglass
, NULL
);
29769 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29772 cancel_hourglass (void)
29774 #if defined (HAVE_WINDOW_SYSTEM)
29775 if (hourglass_atimer
)
29777 cancel_atimer (hourglass_atimer
);
29778 hourglass_atimer
= NULL
;
29781 if (hourglass_shown_p
)