1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
284 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
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 /* These setters are used only in this file, so they can be private. */
370 wset_base_line_number (struct window
*w
, Lisp_Object val
)
372 w
->base_line_number
= val
;
375 wset_base_line_pos (struct window
*w
, Lisp_Object val
)
377 w
->base_line_pos
= val
;
380 wset_column_number_displayed (struct window
*w
, Lisp_Object val
)
382 w
->column_number_displayed
= val
;
385 wset_region_showing (struct window
*w
, Lisp_Object val
)
387 w
->region_showing
= val
;
390 #ifdef HAVE_WINDOW_SYSTEM
392 /* Test if overflow newline into fringe. Called with iterator IT
393 at or past right window margin, and with IT->current_x set. */
395 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
396 (!NILP (Voverflow_newline_into_fringe) \
397 && FRAME_WINDOW_P ((IT)->f) \
398 && ((IT)->bidi_it.paragraph_dir == R2L \
399 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
400 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
401 && (IT)->current_x == (IT)->last_visible_x \
402 && (IT)->line_wrap != WORD_WRAP)
404 #else /* !HAVE_WINDOW_SYSTEM */
405 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
406 #endif /* HAVE_WINDOW_SYSTEM */
408 /* Test if the display element loaded in IT, or the underlying buffer
409 or string character, is a space or a TAB character. This is used
410 to determine where word wrapping can occur. */
412 #define IT_DISPLAYING_WHITESPACE(it) \
413 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
414 || ((STRINGP (it->string) \
415 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
416 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
418 && (it->s[IT_BYTEPOS (*it)] == ' ' \
419 || it->s[IT_BYTEPOS (*it)] == '\t')) \
420 || (IT_BYTEPOS (*it) < ZV_BYTE \
421 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
422 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
424 /* Name of the face used to highlight trailing whitespace. */
426 static Lisp_Object Qtrailing_whitespace
;
428 /* Name and number of the face used to highlight escape glyphs. */
430 static Lisp_Object Qescape_glyph
;
432 /* Name and number of the face used to highlight non-breaking spaces. */
434 static Lisp_Object Qnobreak_space
;
436 /* The symbol `image' which is the car of the lists used to represent
437 images in Lisp. Also a tool bar style. */
441 /* The image map types. */
443 static Lisp_Object QCpointer
;
444 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
446 /* Tool bar styles */
447 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
449 /* Non-zero means print newline to stdout before next mini-buffer
452 int noninteractive_need_newline
;
454 /* Non-zero means print newline to message log before next message. */
456 static int message_log_need_newline
;
458 /* Three markers that message_dolog uses.
459 It could allocate them itself, but that causes trouble
460 in handling memory-full errors. */
461 static Lisp_Object message_dolog_marker1
;
462 static Lisp_Object message_dolog_marker2
;
463 static Lisp_Object message_dolog_marker3
;
465 /* The buffer position of the first character appearing entirely or
466 partially on the line of the selected window which contains the
467 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
468 redisplay optimization in redisplay_internal. */
470 static struct text_pos this_line_start_pos
;
472 /* Number of characters past the end of the line above, including the
473 terminating newline. */
475 static struct text_pos this_line_end_pos
;
477 /* The vertical positions and the height of this line. */
479 static int this_line_vpos
;
480 static int this_line_y
;
481 static int this_line_pixel_height
;
483 /* X position at which this display line starts. Usually zero;
484 negative if first character is partially visible. */
486 static int this_line_start_x
;
488 /* The smallest character position seen by move_it_* functions as they
489 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
490 hscrolled lines, see display_line. */
492 static struct text_pos this_line_min_pos
;
494 /* Buffer that this_line_.* variables are referring to. */
496 static struct buffer
*this_line_buffer
;
499 /* Values of those variables at last redisplay are stored as
500 properties on `overlay-arrow-position' symbol. However, if
501 Voverlay_arrow_position is a marker, last-arrow-position is its
502 numerical position. */
504 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
506 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
507 properties on a symbol in overlay-arrow-variable-list. */
509 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
511 Lisp_Object Qmenu_bar_update_hook
;
513 /* Nonzero if an overlay arrow has been displayed in this window. */
515 static int overlay_arrow_seen
;
517 /* Number of windows showing the buffer of the selected window (or
518 another buffer with the same base buffer). keyboard.c refers to
523 /* Vector containing glyphs for an ellipsis `...'. */
525 static Lisp_Object default_invis_vector
[3];
527 /* This is the window where the echo area message was displayed. It
528 is always a mini-buffer window, but it may not be the same window
529 currently active as a mini-buffer. */
531 Lisp_Object echo_area_window
;
533 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
534 pushes the current message and the value of
535 message_enable_multibyte on the stack, the function restore_message
536 pops the stack and displays MESSAGE again. */
538 static Lisp_Object Vmessage_stack
;
540 /* Nonzero means multibyte characters were enabled when the echo area
541 message was specified. */
543 static int message_enable_multibyte
;
545 /* Nonzero if we should redraw the mode lines on the next redisplay. */
547 int update_mode_lines
;
549 /* Nonzero if window sizes or contents have changed since last
550 redisplay that finished. */
552 int windows_or_buffers_changed
;
554 /* Nonzero means a frame's cursor type has been changed. */
556 int cursor_type_changed
;
558 /* Nonzero after display_mode_line if %l was used and it displayed a
561 static int line_number_displayed
;
563 /* The name of the *Messages* buffer, a string. */
565 static Lisp_Object Vmessages_buffer_name
;
567 /* Current, index 0, and last displayed echo area message. Either
568 buffers from echo_buffers, or nil to indicate no message. */
570 Lisp_Object echo_area_buffer
[2];
572 /* The buffers referenced from echo_area_buffer. */
574 static Lisp_Object echo_buffer
[2];
576 /* A vector saved used in with_area_buffer to reduce consing. */
578 static Lisp_Object Vwith_echo_area_save_vector
;
580 /* Non-zero means display_echo_area should display the last echo area
581 message again. Set by redisplay_preserve_echo_area. */
583 static int display_last_displayed_message_p
;
585 /* Nonzero if echo area is being used by print; zero if being used by
588 static int message_buf_print
;
590 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
592 static Lisp_Object Qinhibit_menubar_update
;
593 static Lisp_Object Qmessage_truncate_lines
;
595 /* Set to 1 in clear_message to make redisplay_internal aware
596 of an emptied echo area. */
598 static int message_cleared_p
;
600 /* A scratch glyph row with contents used for generating truncation
601 glyphs. Also used in direct_output_for_insert. */
603 #define MAX_SCRATCH_GLYPHS 100
604 static struct glyph_row scratch_glyph_row
;
605 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
607 /* Ascent and height of the last line processed by move_it_to. */
609 static int last_max_ascent
, last_height
;
611 /* Non-zero if there's a help-echo in the echo area. */
613 int help_echo_showing_p
;
615 /* If >= 0, computed, exact values of mode-line and header-line height
616 to use in the macros CURRENT_MODE_LINE_HEIGHT and
617 CURRENT_HEADER_LINE_HEIGHT. */
619 int current_mode_line_height
, current_header_line_height
;
621 /* The maximum distance to look ahead for text properties. Values
622 that are too small let us call compute_char_face and similar
623 functions too often which is expensive. Values that are too large
624 let us call compute_char_face and alike too often because we
625 might not be interested in text properties that far away. */
627 #define TEXT_PROP_DISTANCE_LIMIT 100
629 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
630 iterator state and later restore it. This is needed because the
631 bidi iterator on bidi.c keeps a stacked cache of its states, which
632 is really a singleton. When we use scratch iterator objects to
633 move around the buffer, we can cause the bidi cache to be pushed or
634 popped, and therefore we need to restore the cache state when we
635 return to the original iterator. */
636 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
639 bidi_unshelve_cache (CACHE, 1); \
641 CACHE = bidi_shelve_cache (); \
644 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
646 if (pITORIG != pITCOPY) \
647 *(pITORIG) = *(pITCOPY); \
648 bidi_unshelve_cache (CACHE, 0); \
654 /* Non-zero means print traces of redisplay if compiled with
655 GLYPH_DEBUG defined. */
657 int trace_redisplay_p
;
659 #endif /* GLYPH_DEBUG */
661 #ifdef DEBUG_TRACE_MOVE
662 /* Non-zero means trace with TRACE_MOVE to stderr. */
665 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
667 #define TRACE_MOVE(x) (void) 0
670 static Lisp_Object Qauto_hscroll_mode
;
672 /* Buffer being redisplayed -- for redisplay_window_error. */
674 static struct buffer
*displayed_buffer
;
676 /* Value returned from text property handlers (see below). */
681 HANDLED_RECOMPUTE_PROPS
,
682 HANDLED_OVERLAY_STRING_CONSUMED
,
686 /* A description of text properties that redisplay is interested
691 /* The name of the property. */
694 /* A unique index for the property. */
697 /* A handler function called to set up iterator IT from the property
698 at IT's current position. Value is used to steer handle_stop. */
699 enum prop_handled (*handler
) (struct it
*it
);
702 static enum prop_handled
handle_face_prop (struct it
*);
703 static enum prop_handled
handle_invisible_prop (struct it
*);
704 static enum prop_handled
handle_display_prop (struct it
*);
705 static enum prop_handled
handle_composition_prop (struct it
*);
706 static enum prop_handled
handle_overlay_change (struct it
*);
707 static enum prop_handled
handle_fontified_prop (struct it
*);
709 /* Properties handled by iterators. */
711 static struct props it_props
[] =
713 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
714 /* Handle `face' before `display' because some sub-properties of
715 `display' need to know the face. */
716 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
717 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
718 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
719 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
723 /* Value is the position described by X. If X is a marker, value is
724 the marker_position of X. Otherwise, value is X. */
726 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
728 /* Enumeration returned by some move_it_.* functions internally. */
732 /* Not used. Undefined value. */
735 /* Move ended at the requested buffer position or ZV. */
736 MOVE_POS_MATCH_OR_ZV
,
738 /* Move ended at the requested X pixel position. */
741 /* Move within a line ended at the end of a line that must be
745 /* Move within a line ended at the end of a line that would
746 be displayed truncated. */
749 /* Move within a line ended at a line end. */
753 /* This counter is used to clear the face cache every once in a while
754 in redisplay_internal. It is incremented for each redisplay.
755 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
758 #define CLEAR_FACE_CACHE_COUNT 500
759 static int clear_face_cache_count
;
761 /* Similarly for the image cache. */
763 #ifdef HAVE_WINDOW_SYSTEM
764 #define CLEAR_IMAGE_CACHE_COUNT 101
765 static int clear_image_cache_count
;
767 /* Null glyph slice */
768 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
771 /* True while redisplay_internal is in progress. */
775 static Lisp_Object Qinhibit_free_realized_faces
;
776 static Lisp_Object Qmode_line_default_help_echo
;
778 /* If a string, XTread_socket generates an event to display that string.
779 (The display is done in read_char.) */
781 Lisp_Object help_echo_string
;
782 Lisp_Object help_echo_window
;
783 Lisp_Object help_echo_object
;
784 ptrdiff_t help_echo_pos
;
786 /* Temporary variable for XTread_socket. */
788 Lisp_Object previous_help_echo_string
;
790 /* Platform-independent portion of hourglass implementation. */
792 /* Non-zero means an hourglass cursor is currently shown. */
793 int hourglass_shown_p
;
795 /* If non-null, an asynchronous timer that, when it expires, displays
796 an hourglass cursor on all frames. */
797 struct atimer
*hourglass_atimer
;
799 /* Name of the face used to display glyphless characters. */
800 Lisp_Object Qglyphless_char
;
802 /* Symbol for the purpose of Vglyphless_char_display. */
803 static Lisp_Object Qglyphless_char_display
;
805 /* Method symbols for Vglyphless_char_display. */
806 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
808 /* Default pixel width of `thin-space' display method. */
809 #define THIN_SPACE_WIDTH 1
811 /* Default number of seconds to wait before displaying an hourglass
813 #define DEFAULT_HOURGLASS_DELAY 1
816 /* Function prototypes. */
818 static void setup_for_ellipsis (struct it
*, int);
819 static void set_iterator_to_next (struct it
*, int);
820 static void mark_window_display_accurate_1 (struct window
*, int);
821 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
822 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
823 static int cursor_row_p (struct glyph_row
*);
824 static int redisplay_mode_lines (Lisp_Object
, int);
825 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
827 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
829 static void handle_line_prefix (struct it
*);
831 static void pint2str (char *, int, ptrdiff_t);
832 static void pint2hrstr (char *, int, ptrdiff_t);
833 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
835 static void reconsider_clip_changes (struct window
*, struct buffer
*);
836 static int text_outside_line_unchanged_p (struct window
*,
837 ptrdiff_t, ptrdiff_t);
838 static void store_mode_line_noprop_char (char);
839 static int store_mode_line_noprop (const char *, int, int);
840 static void handle_stop (struct it
*);
841 static void handle_stop_backwards (struct it
*, ptrdiff_t);
842 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
843 static void ensure_echo_area_buffers (void);
844 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
845 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
846 static int with_echo_area_buffer (struct window
*, int,
847 int (*) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
848 ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
849 static void clear_garbaged_frames (void);
850 static int current_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
851 static void pop_message (void);
852 static int truncate_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
853 static void set_message (const char *, Lisp_Object
, ptrdiff_t, int);
854 static int set_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
855 static int display_echo_area (struct window
*);
856 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
857 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
858 static Lisp_Object
unwind_redisplay (Lisp_Object
);
859 static int string_char_and_length (const unsigned char *, int *);
860 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
862 static int compute_window_start_on_continuation_line (struct window
*);
863 static void insert_left_trunc_glyphs (struct it
*);
864 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
866 static void extend_face_to_end_of_line (struct it
*);
867 static int append_space_for_newline (struct it
*, int);
868 static int cursor_row_fully_visible_p (struct window
*, int, int);
869 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
870 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
871 static int trailing_whitespace_p (ptrdiff_t);
872 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
873 static void push_it (struct it
*, struct text_pos
*);
874 static void iterate_out_of_display_property (struct it
*);
875 static void pop_it (struct it
*);
876 static void sync_frame_with_window_matrix_rows (struct window
*);
877 static void select_frame_for_redisplay (Lisp_Object
);
878 static void redisplay_internal (void);
879 static int echo_area_display (int);
880 static void redisplay_windows (Lisp_Object
);
881 static void redisplay_window (Lisp_Object
, int);
882 static Lisp_Object
redisplay_window_error (Lisp_Object
);
883 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
884 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
885 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
886 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
888 static int update_menu_bar (struct frame
*, int, int);
889 static int try_window_reusing_current_matrix (struct window
*);
890 static int try_window_id (struct window
*);
891 static int display_line (struct it
*);
892 static int display_mode_lines (struct window
*);
893 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
894 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
895 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
896 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
897 static void display_menu_bar (struct window
*);
898 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
900 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
901 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
902 static void compute_line_metrics (struct it
*);
903 static void run_redisplay_end_trigger_hook (struct it
*);
904 static int get_overlay_strings (struct it
*, ptrdiff_t);
905 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
906 static void next_overlay_string (struct it
*);
907 static void reseat (struct it
*, struct text_pos
, int);
908 static void reseat_1 (struct it
*, struct text_pos
, int);
909 static void back_to_previous_visible_line_start (struct it
*);
910 void reseat_at_previous_visible_line_start (struct it
*);
911 static void reseat_at_next_visible_line_start (struct it
*, int);
912 static int next_element_from_ellipsis (struct it
*);
913 static int next_element_from_display_vector (struct it
*);
914 static int next_element_from_string (struct it
*);
915 static int next_element_from_c_string (struct it
*);
916 static int next_element_from_buffer (struct it
*);
917 static int next_element_from_composition (struct it
*);
918 static int next_element_from_image (struct it
*);
919 static int next_element_from_stretch (struct it
*);
920 static void load_overlay_strings (struct it
*, ptrdiff_t);
921 static int init_from_display_pos (struct it
*, struct window
*,
922 struct display_pos
*);
923 static void reseat_to_string (struct it
*, const char *,
924 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
925 static int get_next_display_element (struct it
*);
926 static enum move_it_result
927 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
928 enum move_operation_enum
);
929 void move_it_vertically_backward (struct it
*, int);
930 static void init_to_row_start (struct it
*, struct window
*,
932 static int init_to_row_end (struct it
*, struct window
*,
934 static void back_to_previous_line_start (struct it
*);
935 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
936 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
937 Lisp_Object
, ptrdiff_t);
938 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
939 static struct text_pos
c_string_pos (ptrdiff_t, const char *, int);
940 static ptrdiff_t number_of_chars (const char *, int);
941 static void compute_stop_pos (struct it
*);
942 static void compute_string_pos (struct text_pos
*, struct text_pos
,
944 static int face_before_or_after_it_pos (struct it
*, int);
945 static ptrdiff_t next_overlay_change (ptrdiff_t);
946 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
947 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
948 static int handle_single_display_spec (struct it
*, Lisp_Object
,
949 Lisp_Object
, Lisp_Object
,
950 struct text_pos
*, ptrdiff_t, int, int);
951 static int underlying_face_id (struct it
*);
952 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
955 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
956 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
958 #ifdef HAVE_WINDOW_SYSTEM
960 static void x_consider_frame_title (Lisp_Object
);
961 static int tool_bar_lines_needed (struct frame
*, int *);
962 static void update_tool_bar (struct frame
*, int);
963 static void build_desired_tool_bar_string (struct frame
*f
);
964 static int redisplay_tool_bar (struct frame
*);
965 static void display_tool_bar_line (struct it
*, int);
966 static void notice_overwritten_cursor (struct window
*,
969 static void append_stretch_glyph (struct it
*, Lisp_Object
,
973 #endif /* HAVE_WINDOW_SYSTEM */
975 static void produce_special_glyphs (struct it
*, enum display_element_type
);
976 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
977 static int coords_in_mouse_face_p (struct window
*, int, int);
981 /***********************************************************************
982 Window display dimensions
983 ***********************************************************************/
985 /* Return the bottom boundary y-position for text lines in window W.
986 This is the first y position at which a line cannot start.
987 It is relative to the top of the window.
989 This is the height of W minus the height of a mode line, if any. */
992 window_text_bottom_y (struct window
*w
)
994 int height
= WINDOW_TOTAL_HEIGHT (w
);
996 if (WINDOW_WANTS_MODELINE_P (w
))
997 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1001 /* Return the pixel width of display area AREA of window W. AREA < 0
1002 means return the total width of W, not including fringes to
1003 the left and right of the window. */
1006 window_box_width (struct window
*w
, int area
)
1008 int cols
= XFASTINT (w
->total_cols
);
1011 if (!w
->pseudo_window_p
)
1013 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1015 if (area
== TEXT_AREA
)
1017 if (INTEGERP (w
->left_margin_cols
))
1018 cols
-= XFASTINT (w
->left_margin_cols
);
1019 if (INTEGERP (w
->right_margin_cols
))
1020 cols
-= XFASTINT (w
->right_margin_cols
);
1021 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1023 else if (area
== LEFT_MARGIN_AREA
)
1025 cols
= (INTEGERP (w
->left_margin_cols
)
1026 ? XFASTINT (w
->left_margin_cols
) : 0);
1029 else if (area
== RIGHT_MARGIN_AREA
)
1031 cols
= (INTEGERP (w
->right_margin_cols
)
1032 ? XFASTINT (w
->right_margin_cols
) : 0);
1037 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1041 /* Return the pixel height of the display area of window W, not
1042 including mode lines of W, if any. */
1045 window_box_height (struct window
*w
)
1047 struct frame
*f
= XFRAME (w
->frame
);
1048 int height
= WINDOW_TOTAL_HEIGHT (w
);
1050 eassert (height
>= 0);
1052 /* Note: the code below that determines the mode-line/header-line
1053 height is essentially the same as that contained in the macro
1054 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1055 the appropriate glyph row has its `mode_line_p' flag set,
1056 and if it doesn't, uses estimate_mode_line_height instead. */
1058 if (WINDOW_WANTS_MODELINE_P (w
))
1060 struct glyph_row
*ml_row
1061 = (w
->current_matrix
&& w
->current_matrix
->rows
1062 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1064 if (ml_row
&& ml_row
->mode_line_p
)
1065 height
-= ml_row
->height
;
1067 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1070 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1072 struct glyph_row
*hl_row
1073 = (w
->current_matrix
&& w
->current_matrix
->rows
1074 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1076 if (hl_row
&& hl_row
->mode_line_p
)
1077 height
-= hl_row
->height
;
1079 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1082 /* With a very small font and a mode-line that's taller than
1083 default, we might end up with a negative height. */
1084 return max (0, height
);
1087 /* Return the window-relative coordinate of the left edge of display
1088 area AREA of window W. AREA < 0 means return the left edge of the
1089 whole window, to the right of the left fringe of W. */
1092 window_box_left_offset (struct window
*w
, int area
)
1096 if (w
->pseudo_window_p
)
1099 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1101 if (area
== TEXT_AREA
)
1102 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1103 + window_box_width (w
, LEFT_MARGIN_AREA
));
1104 else if (area
== RIGHT_MARGIN_AREA
)
1105 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1106 + window_box_width (w
, LEFT_MARGIN_AREA
)
1107 + window_box_width (w
, TEXT_AREA
)
1108 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1110 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1111 else if (area
== LEFT_MARGIN_AREA
1112 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1113 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1119 /* Return the window-relative coordinate of the right edge of display
1120 area AREA of window W. AREA < 0 means return the right edge of the
1121 whole window, to the left of the right fringe of W. */
1124 window_box_right_offset (struct window
*w
, int area
)
1126 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1129 /* Return the frame-relative coordinate of the left edge of display
1130 area AREA of window W. AREA < 0 means return the left edge of the
1131 whole window, to the right of the left fringe of W. */
1134 window_box_left (struct window
*w
, int area
)
1136 struct frame
*f
= XFRAME (w
->frame
);
1139 if (w
->pseudo_window_p
)
1140 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1142 x
= (WINDOW_LEFT_EDGE_X (w
)
1143 + window_box_left_offset (w
, area
));
1149 /* Return the frame-relative coordinate of the right edge of display
1150 area AREA of window W. AREA < 0 means return the right edge of the
1151 whole window, to the left of the right fringe of W. */
1154 window_box_right (struct window
*w
, int area
)
1156 return window_box_left (w
, area
) + window_box_width (w
, area
);
1159 /* Get the bounding box of the display area AREA of window W, without
1160 mode lines, in frame-relative coordinates. AREA < 0 means the
1161 whole window, not including the left and right fringes of
1162 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1163 coordinates of the upper-left corner of the box. Return in
1164 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1167 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1168 int *box_width
, int *box_height
)
1171 *box_width
= window_box_width (w
, area
);
1173 *box_height
= window_box_height (w
);
1175 *box_x
= window_box_left (w
, area
);
1178 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1179 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1180 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1185 /* Get the bounding box of the display area AREA of window W, without
1186 mode lines. AREA < 0 means the whole window, not including the
1187 left and right fringe of the window. Return in *TOP_LEFT_X
1188 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1189 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1190 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1194 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1195 int *bottom_right_x
, int *bottom_right_y
)
1197 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1199 *bottom_right_x
+= *top_left_x
;
1200 *bottom_right_y
+= *top_left_y
;
1205 /***********************************************************************
1207 ***********************************************************************/
1209 /* Return the bottom y-position of the line the iterator IT is in.
1210 This can modify IT's settings. */
1213 line_bottom_y (struct it
*it
)
1215 int line_height
= it
->max_ascent
+ it
->max_descent
;
1216 int line_top_y
= it
->current_y
;
1218 if (line_height
== 0)
1221 line_height
= last_height
;
1222 else if (IT_CHARPOS (*it
) < ZV
)
1224 move_it_by_lines (it
, 1);
1225 line_height
= (it
->max_ascent
|| it
->max_descent
1226 ? it
->max_ascent
+ it
->max_descent
1231 struct glyph_row
*row
= it
->glyph_row
;
1233 /* Use the default character height. */
1234 it
->glyph_row
= NULL
;
1235 it
->what
= IT_CHARACTER
;
1238 PRODUCE_GLYPHS (it
);
1239 line_height
= it
->ascent
+ it
->descent
;
1240 it
->glyph_row
= row
;
1244 return line_top_y
+ line_height
;
1247 /* Subroutine of pos_visible_p below. Extracts a display string, if
1248 any, from the display spec given as its argument. */
1250 string_from_display_spec (Lisp_Object spec
)
1254 while (CONSP (spec
))
1256 if (STRINGP (XCAR (spec
)))
1261 else if (VECTORP (spec
))
1265 for (i
= 0; i
< ASIZE (spec
); i
++)
1267 if (STRINGP (AREF (spec
, i
)))
1268 return AREF (spec
, i
);
1277 /* Limit insanely large values of W->hscroll on frame F to the largest
1278 value that will still prevent first_visible_x and last_visible_x of
1279 'struct it' from overflowing an int. */
1281 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1283 ptrdiff_t window_hscroll
= w
->hscroll
;
1284 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1285 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1287 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1288 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1290 return window_hscroll
;
1293 /* Return 1 if position CHARPOS is visible in window W.
1294 CHARPOS < 0 means return info about WINDOW_END position.
1295 If visible, set *X and *Y to pixel coordinates of top left corner.
1296 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1297 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1300 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1301 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1304 void *itdata
= bidi_shelve_cache ();
1305 struct text_pos top
;
1307 struct buffer
*old_buffer
= NULL
;
1309 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1312 if (XBUFFER (w
->buffer
) != current_buffer
)
1314 old_buffer
= current_buffer
;
1315 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1318 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1319 /* Scrolling a minibuffer window via scroll bar when the echo area
1320 shows long text sometimes resets the minibuffer contents behind
1322 if (CHARPOS (top
) > ZV
)
1323 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1325 /* Compute exact mode line heights. */
1326 if (WINDOW_WANTS_MODELINE_P (w
))
1327 current_mode_line_height
1328 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1329 BVAR (current_buffer
, mode_line_format
));
1331 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1332 current_header_line_height
1333 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1334 BVAR (current_buffer
, header_line_format
));
1336 start_display (&it
, w
, top
);
1337 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1338 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1341 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1342 && IT_CHARPOS (it
) >= charpos
)
1343 /* When scanning backwards under bidi iteration, move_it_to
1344 stops at or _before_ CHARPOS, because it stops at or to
1345 the _right_ of the character at CHARPOS. */
1346 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1347 && IT_CHARPOS (it
) <= charpos
)))
1349 /* We have reached CHARPOS, or passed it. How the call to
1350 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1351 or covered by a display property, move_it_to stops at the end
1352 of the invisible text, to the right of CHARPOS. (ii) If
1353 CHARPOS is in a display vector, move_it_to stops on its last
1355 int top_x
= it
.current_x
;
1356 int top_y
= it
.current_y
;
1357 /* Calling line_bottom_y may change it.method, it.position, etc. */
1358 enum it_method it_method
= it
.method
;
1359 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1360 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1362 if (top_y
< window_top_y
)
1363 visible_p
= bottom_y
> window_top_y
;
1364 else if (top_y
< it
.last_visible_y
)
1366 if (bottom_y
>= it
.last_visible_y
1367 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1368 && IT_CHARPOS (it
) < charpos
)
1370 /* When the last line of the window is scanned backwards
1371 under bidi iteration, we could be duped into thinking
1372 that we have passed CHARPOS, when in fact move_it_to
1373 simply stopped short of CHARPOS because it reached
1374 last_visible_y. To see if that's what happened, we call
1375 move_it_to again with a slightly larger vertical limit,
1376 and see if it actually moved vertically; if it did, we
1377 didn't really reach CHARPOS, which is beyond window end. */
1378 struct it save_it
= it
;
1379 /* Why 10? because we don't know how many canonical lines
1380 will the height of the next line(s) be. So we guess. */
1381 int ten_more_lines
=
1382 10 * FRAME_LINE_HEIGHT (XFRAME (WINDOW_FRAME (w
)));
1384 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1385 MOVE_TO_POS
| MOVE_TO_Y
);
1386 if (it
.current_y
> top_y
)
1393 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1395 /* We stopped on the last glyph of a display vector.
1396 Try and recompute. Hack alert! */
1397 if (charpos
< 2 || top
.charpos
>= charpos
)
1398 top_x
= it
.glyph_row
->x
;
1402 start_display (&it2
, w
, top
);
1403 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1404 get_next_display_element (&it2
);
1405 PRODUCE_GLYPHS (&it2
);
1406 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1407 || it2
.current_x
> it2
.last_visible_x
)
1408 top_x
= it
.glyph_row
->x
;
1411 top_x
= it2
.current_x
;
1412 top_y
= it2
.current_y
;
1416 else if (IT_CHARPOS (it
) != charpos
)
1418 Lisp_Object cpos
= make_number (charpos
);
1419 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1420 Lisp_Object string
= string_from_display_spec (spec
);
1421 int newline_in_string
= 0;
1423 if (STRINGP (string
))
1425 const char *s
= SSDATA (string
);
1426 const char *e
= s
+ SBYTES (string
);
1431 newline_in_string
= 1;
1436 /* The tricky code below is needed because there's a
1437 discrepancy between move_it_to and how we set cursor
1438 when the display line ends in a newline from a
1439 display string. move_it_to will stop _after_ such
1440 display strings, whereas set_cursor_from_row
1441 conspires with cursor_row_p to place the cursor on
1442 the first glyph produced from the display string. */
1444 /* We have overshoot PT because it is covered by a
1445 display property whose value is a string. If the
1446 string includes embedded newlines, we are also in the
1447 wrong display line. Backtrack to the correct line,
1448 where the display string begins. */
1449 if (newline_in_string
)
1451 Lisp_Object startpos
, endpos
;
1452 EMACS_INT start
, end
;
1456 /* Find the first and the last buffer positions
1457 covered by the display string. */
1459 Fnext_single_char_property_change (cpos
, Qdisplay
,
1462 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1464 start
= XFASTINT (startpos
);
1465 end
= XFASTINT (endpos
);
1466 /* Move to the last buffer position before the
1467 display property. */
1468 start_display (&it3
, w
, top
);
1469 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1470 /* Move forward one more line if the position before
1471 the display string is a newline or if it is the
1472 rightmost character on a line that is
1473 continued or word-wrapped. */
1474 if (it3
.method
== GET_FROM_BUFFER
1476 move_it_by_lines (&it3
, 1);
1477 else if (move_it_in_display_line_to (&it3
, -1,
1481 == MOVE_LINE_CONTINUED
)
1483 move_it_by_lines (&it3
, 1);
1484 /* When we are under word-wrap, the #$@%!
1485 move_it_by_lines moves 2 lines, so we need to
1487 if (it3
.line_wrap
== WORD_WRAP
)
1488 move_it_by_lines (&it3
, -1);
1491 /* Record the vertical coordinate of the display
1492 line where we wound up. */
1493 top_y
= it3
.current_y
;
1496 /* When characters are reordered for display,
1497 the character displayed to the left of the
1498 display string could be _after_ the display
1499 property in the logical order. Use the
1500 smallest vertical position of these two. */
1501 start_display (&it3
, w
, top
);
1502 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1503 if (it3
.current_y
< top_y
)
1504 top_y
= it3
.current_y
;
1506 /* Move from the top of the window to the beginning
1507 of the display line where the display string
1509 start_display (&it3
, w
, top
);
1510 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1511 /* If it3_moved stays zero after the 'while' loop
1512 below, that means we already were at a newline
1513 before the loop (e.g., the display string begins
1514 with a newline), so we don't need to (and cannot)
1515 inspect the glyphs of it3.glyph_row, because
1516 PRODUCE_GLYPHS will not produce anything for a
1517 newline, and thus it3.glyph_row stays at its
1518 stale content it got at top of the window. */
1520 /* Finally, advance the iterator until we hit the
1521 first display element whose character position is
1522 CHARPOS, or until the first newline from the
1523 display string, which signals the end of the
1525 while (get_next_display_element (&it3
))
1527 PRODUCE_GLYPHS (&it3
);
1528 if (IT_CHARPOS (it3
) == charpos
1529 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1532 set_iterator_to_next (&it3
, 0);
1534 top_x
= it3
.current_x
- it3
.pixel_width
;
1535 /* Normally, we would exit the above loop because we
1536 found the display element whose character
1537 position is CHARPOS. For the contingency that we
1538 didn't, and stopped at the first newline from the
1539 display string, move back over the glyphs
1540 produced from the string, until we find the
1541 rightmost glyph not from the string. */
1543 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1545 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1546 + it3
.glyph_row
->used
[TEXT_AREA
];
1548 while (EQ ((g
- 1)->object
, string
))
1551 top_x
-= g
->pixel_width
;
1553 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1554 + it3
.glyph_row
->used
[TEXT_AREA
]);
1560 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1561 *rtop
= max (0, window_top_y
- top_y
);
1562 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1563 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1564 - max (top_y
, window_top_y
)));
1570 /* We were asked to provide info about WINDOW_END. */
1572 void *it2data
= NULL
;
1574 SAVE_IT (it2
, it
, it2data
);
1575 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1576 move_it_by_lines (&it
, 1);
1577 if (charpos
< IT_CHARPOS (it
)
1578 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1581 RESTORE_IT (&it2
, &it2
, it2data
);
1582 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1584 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1585 *rtop
= max (0, -it2
.current_y
);
1586 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1587 - it
.last_visible_y
));
1588 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1590 - max (it2
.current_y
,
1591 WINDOW_HEADER_LINE_HEIGHT (w
))));
1595 bidi_unshelve_cache (it2data
, 1);
1597 bidi_unshelve_cache (itdata
, 0);
1600 set_buffer_internal_1 (old_buffer
);
1602 current_header_line_height
= current_mode_line_height
= -1;
1604 if (visible_p
&& w
->hscroll
> 0)
1606 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1607 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1610 /* Debugging code. */
1612 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1613 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1615 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1622 /* Return the next character from STR. Return in *LEN the length of
1623 the character. This is like STRING_CHAR_AND_LENGTH but never
1624 returns an invalid character. If we find one, we return a `?', but
1625 with the length of the invalid character. */
1628 string_char_and_length (const unsigned char *str
, int *len
)
1632 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1633 if (!CHAR_VALID_P (c
))
1634 /* We may not change the length here because other places in Emacs
1635 don't use this function, i.e. they silently accept invalid
1644 /* Given a position POS containing a valid character and byte position
1645 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1647 static struct text_pos
1648 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1650 eassert (STRINGP (string
) && nchars
>= 0);
1652 if (STRING_MULTIBYTE (string
))
1654 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1659 string_char_and_length (p
, &len
);
1662 BYTEPOS (pos
) += len
;
1666 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1672 /* Value is the text position, i.e. character and byte position,
1673 for character position CHARPOS in STRING. */
1675 static inline struct text_pos
1676 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1678 struct text_pos pos
;
1679 eassert (STRINGP (string
));
1680 eassert (charpos
>= 0);
1681 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1686 /* Value is a text position, i.e. character and byte position, for
1687 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1688 means recognize multibyte characters. */
1690 static struct text_pos
1691 c_string_pos (ptrdiff_t charpos
, const char *s
, int multibyte_p
)
1693 struct text_pos pos
;
1695 eassert (s
!= NULL
);
1696 eassert (charpos
>= 0);
1702 SET_TEXT_POS (pos
, 0, 0);
1705 string_char_and_length ((const unsigned char *) s
, &len
);
1708 BYTEPOS (pos
) += len
;
1712 SET_TEXT_POS (pos
, charpos
, charpos
);
1718 /* Value is the number of characters in C string S. MULTIBYTE_P
1719 non-zero means recognize multibyte characters. */
1722 number_of_chars (const char *s
, int multibyte_p
)
1728 ptrdiff_t rest
= strlen (s
);
1730 const unsigned char *p
= (const unsigned char *) s
;
1732 for (nchars
= 0; rest
> 0; ++nchars
)
1734 string_char_and_length (p
, &len
);
1735 rest
-= len
, p
+= len
;
1739 nchars
= strlen (s
);
1745 /* Compute byte position NEWPOS->bytepos corresponding to
1746 NEWPOS->charpos. POS is a known position in string STRING.
1747 NEWPOS->charpos must be >= POS.charpos. */
1750 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1752 eassert (STRINGP (string
));
1753 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1755 if (STRING_MULTIBYTE (string
))
1756 *newpos
= string_pos_nchars_ahead (pos
, string
,
1757 CHARPOS (*newpos
) - CHARPOS (pos
));
1759 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1763 Return an estimation of the pixel height of mode or header lines on
1764 frame F. FACE_ID specifies what line's height to estimate. */
1767 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1769 #ifdef HAVE_WINDOW_SYSTEM
1770 if (FRAME_WINDOW_P (f
))
1772 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1774 /* This function is called so early when Emacs starts that the face
1775 cache and mode line face are not yet initialized. */
1776 if (FRAME_FACE_CACHE (f
))
1778 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1782 height
= FONT_HEIGHT (face
->font
);
1783 if (face
->box_line_width
> 0)
1784 height
+= 2 * face
->box_line_width
;
1795 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1796 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1797 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1798 not force the value into range. */
1801 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1802 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1805 #ifdef HAVE_WINDOW_SYSTEM
1806 if (FRAME_WINDOW_P (f
))
1808 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1809 even for negative values. */
1811 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1813 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1815 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1816 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1819 STORE_NATIVE_RECT (*bounds
,
1820 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1821 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1822 FRAME_COLUMN_WIDTH (f
) - 1,
1823 FRAME_LINE_HEIGHT (f
) - 1);
1829 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1830 pix_x
= FRAME_TOTAL_COLS (f
);
1834 else if (pix_y
> FRAME_LINES (f
))
1835 pix_y
= FRAME_LINES (f
);
1845 /* Find the glyph under window-relative coordinates X/Y in window W.
1846 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1847 strings. Return in *HPOS and *VPOS the row and column number of
1848 the glyph found. Return in *AREA the glyph area containing X.
1849 Value is a pointer to the glyph found or null if X/Y is not on
1850 text, or we can't tell because W's current matrix is not up to
1855 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1856 int *dx
, int *dy
, int *area
)
1858 struct glyph
*glyph
, *end
;
1859 struct glyph_row
*row
= NULL
;
1862 /* Find row containing Y. Give up if some row is not enabled. */
1863 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1865 row
= MATRIX_ROW (w
->current_matrix
, i
);
1866 if (!row
->enabled_p
)
1868 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1875 /* Give up if Y is not in the window. */
1876 if (i
== w
->current_matrix
->nrows
)
1879 /* Get the glyph area containing X. */
1880 if (w
->pseudo_window_p
)
1887 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1889 *area
= LEFT_MARGIN_AREA
;
1890 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1892 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1895 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1899 *area
= RIGHT_MARGIN_AREA
;
1900 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1904 /* Find glyph containing X. */
1905 glyph
= row
->glyphs
[*area
];
1906 end
= glyph
+ row
->used
[*area
];
1908 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1910 x
-= glyph
->pixel_width
;
1920 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1923 *hpos
= glyph
- row
->glyphs
[*area
];
1927 /* Convert frame-relative x/y to coordinates relative to window W.
1928 Takes pseudo-windows into account. */
1931 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1933 if (w
->pseudo_window_p
)
1935 /* A pseudo-window is always full-width, and starts at the
1936 left edge of the frame, plus a frame border. */
1937 struct frame
*f
= XFRAME (w
->frame
);
1938 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1939 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1943 *x
-= WINDOW_LEFT_EDGE_X (w
);
1944 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1948 #ifdef HAVE_WINDOW_SYSTEM
1951 Return in RECTS[] at most N clipping rectangles for glyph string S.
1952 Return the number of stored rectangles. */
1955 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1962 if (s
->row
->full_width_p
)
1964 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1965 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1966 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1968 /* Unless displaying a mode or menu bar line, which are always
1969 fully visible, clip to the visible part of the row. */
1970 if (s
->w
->pseudo_window_p
)
1971 r
.height
= s
->row
->visible_height
;
1973 r
.height
= s
->height
;
1977 /* This is a text line that may be partially visible. */
1978 r
.x
= window_box_left (s
->w
, s
->area
);
1979 r
.width
= window_box_width (s
->w
, s
->area
);
1980 r
.height
= s
->row
->visible_height
;
1984 if (r
.x
< s
->clip_head
->x
)
1986 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1987 r
.width
-= s
->clip_head
->x
- r
.x
;
1990 r
.x
= s
->clip_head
->x
;
1993 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1995 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1996 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2001 /* If S draws overlapping rows, it's sufficient to use the top and
2002 bottom of the window for clipping because this glyph string
2003 intentionally draws over other lines. */
2004 if (s
->for_overlaps
)
2006 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2007 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2009 /* Alas, the above simple strategy does not work for the
2010 environments with anti-aliased text: if the same text is
2011 drawn onto the same place multiple times, it gets thicker.
2012 If the overlap we are processing is for the erased cursor, we
2013 take the intersection with the rectangle of the cursor. */
2014 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2016 XRectangle rc
, r_save
= r
;
2018 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2019 rc
.y
= s
->w
->phys_cursor
.y
;
2020 rc
.width
= s
->w
->phys_cursor_width
;
2021 rc
.height
= s
->w
->phys_cursor_height
;
2023 x_intersect_rectangles (&r_save
, &rc
, &r
);
2028 /* Don't use S->y for clipping because it doesn't take partially
2029 visible lines into account. For example, it can be negative for
2030 partially visible lines at the top of a window. */
2031 if (!s
->row
->full_width_p
2032 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2033 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2035 r
.y
= max (0, s
->row
->y
);
2038 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2040 /* If drawing the cursor, don't let glyph draw outside its
2041 advertised boundaries. Cleartype does this under some circumstances. */
2042 if (s
->hl
== DRAW_CURSOR
)
2044 struct glyph
*glyph
= s
->first_glyph
;
2049 r
.width
-= s
->x
- r
.x
;
2052 r
.width
= min (r
.width
, glyph
->pixel_width
);
2054 /* If r.y is below window bottom, ensure that we still see a cursor. */
2055 height
= min (glyph
->ascent
+ glyph
->descent
,
2056 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2057 max_y
= window_text_bottom_y (s
->w
) - height
;
2058 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2059 if (s
->ybase
- glyph
->ascent
> max_y
)
2066 /* Don't draw cursor glyph taller than our actual glyph. */
2067 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2068 if (height
< r
.height
)
2070 max_y
= r
.y
+ r
.height
;
2071 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2072 r
.height
= min (max_y
- r
.y
, height
);
2079 XRectangle r_save
= r
;
2081 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2085 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2086 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2088 #ifdef CONVERT_FROM_XRECT
2089 CONVERT_FROM_XRECT (r
, *rects
);
2097 /* If we are processing overlapping and allowed to return
2098 multiple clipping rectangles, we exclude the row of the glyph
2099 string from the clipping rectangle. This is to avoid drawing
2100 the same text on the environment with anti-aliasing. */
2101 #ifdef CONVERT_FROM_XRECT
2104 XRectangle
*rs
= rects
;
2106 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2108 if (s
->for_overlaps
& OVERLAPS_PRED
)
2111 if (r
.y
+ r
.height
> row_y
)
2114 rs
[i
].height
= row_y
- r
.y
;
2120 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2123 if (r
.y
< row_y
+ s
->row
->visible_height
)
2125 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2127 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2128 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2137 #ifdef CONVERT_FROM_XRECT
2138 for (i
= 0; i
< n
; i
++)
2139 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2146 Return in *NR the clipping rectangle for glyph string S. */
2149 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2151 get_glyph_string_clip_rects (s
, nr
, 1);
2156 Return the position and height of the phys cursor in window W.
2157 Set w->phys_cursor_width to width of phys cursor.
2161 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2162 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2164 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2165 int x
, y
, wd
, h
, h0
, y0
;
2167 /* Compute the width of the rectangle to draw. If on a stretch
2168 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2169 rectangle as wide as the glyph, but use a canonical character
2171 wd
= glyph
->pixel_width
- 1;
2172 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2176 x
= w
->phys_cursor
.x
;
2183 if (glyph
->type
== STRETCH_GLYPH
2184 && !x_stretch_cursor_p
)
2185 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2186 w
->phys_cursor_width
= wd
;
2188 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2190 /* If y is below window bottom, ensure that we still see a cursor. */
2191 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2193 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2194 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2196 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2199 h
= max (h
- (y0
- y
) + 1, h0
);
2204 y0
= window_text_bottom_y (w
) - h0
;
2212 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2213 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2218 * Remember which glyph the mouse is over.
2222 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2226 struct glyph_row
*r
, *gr
, *end_row
;
2227 enum window_part part
;
2228 enum glyph_row_area area
;
2229 int x
, y
, width
, height
;
2231 /* Try to determine frame pixel position and size of the glyph under
2232 frame pixel coordinates X/Y on frame F. */
2234 if (!f
->glyphs_initialized_p
2235 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2238 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2239 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2243 w
= XWINDOW (window
);
2244 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2245 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2247 x
= window_relative_x_coord (w
, part
, gx
);
2248 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2250 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2251 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2253 if (w
->pseudo_window_p
)
2256 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2262 case ON_LEFT_MARGIN
:
2263 area
= LEFT_MARGIN_AREA
;
2266 case ON_RIGHT_MARGIN
:
2267 area
= RIGHT_MARGIN_AREA
;
2270 case ON_HEADER_LINE
:
2272 gr
= (part
== ON_HEADER_LINE
2273 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2274 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2277 goto text_glyph_row_found
;
2284 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2285 if (r
->y
+ r
->height
> y
)
2291 text_glyph_row_found
:
2294 struct glyph
*g
= gr
->glyphs
[area
];
2295 struct glyph
*end
= g
+ gr
->used
[area
];
2297 height
= gr
->height
;
2298 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2299 if (gx
+ g
->pixel_width
> x
)
2304 if (g
->type
== IMAGE_GLYPH
)
2306 /* Don't remember when mouse is over image, as
2307 image may have hot-spots. */
2308 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2311 width
= g
->pixel_width
;
2315 /* Use nominal char spacing at end of line. */
2317 gx
+= (x
/ width
) * width
;
2320 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2321 gx
+= window_box_left_offset (w
, area
);
2325 /* Use nominal line height at end of window. */
2326 gx
= (x
/ width
) * width
;
2328 gy
+= (y
/ height
) * height
;
2332 case ON_LEFT_FRINGE
:
2333 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2334 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2335 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2336 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2339 case ON_RIGHT_FRINGE
:
2340 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2341 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2342 : window_box_right_offset (w
, TEXT_AREA
));
2343 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2347 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2349 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2350 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2351 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2353 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2357 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2358 if (r
->y
+ r
->height
> y
)
2365 height
= gr
->height
;
2368 /* Use nominal line height at end of window. */
2370 gy
+= (y
/ height
) * height
;
2377 /* If there is no glyph under the mouse, then we divide the screen
2378 into a grid of the smallest glyph in the frame, and use that
2381 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2382 round down even for negative values. */
2388 gx
= (gx
/ width
) * width
;
2389 gy
= (gy
/ height
) * height
;
2394 gx
+= WINDOW_LEFT_EDGE_X (w
);
2395 gy
+= WINDOW_TOP_EDGE_Y (w
);
2398 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2400 /* Visible feedback for debugging. */
2403 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2404 f
->output_data
.x
->normal_gc
,
2405 gx
, gy
, width
, height
);
2411 #endif /* HAVE_WINDOW_SYSTEM */
2414 /***********************************************************************
2415 Lisp form evaluation
2416 ***********************************************************************/
2418 /* Error handler for safe_eval and safe_call. */
2421 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2423 add_to_log ("Error during redisplay: %S signaled %S",
2424 Flist (nargs
, args
), arg
);
2428 /* Call function FUNC with the rest of NARGS - 1 arguments
2429 following. Return the result, or nil if something went
2430 wrong. Prevent redisplay during the evaluation. */
2433 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2437 if (inhibit_eval_during_redisplay
)
2443 ptrdiff_t count
= SPECPDL_INDEX ();
2444 struct gcpro gcpro1
;
2445 Lisp_Object
*args
= alloca (nargs
* word_size
);
2448 va_start (ap
, func
);
2449 for (i
= 1; i
< nargs
; i
++)
2450 args
[i
] = va_arg (ap
, Lisp_Object
);
2454 gcpro1
.nvars
= nargs
;
2455 specbind (Qinhibit_redisplay
, Qt
);
2456 /* Use Qt to ensure debugger does not run,
2457 so there is no possibility of wanting to redisplay. */
2458 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2461 val
= unbind_to (count
, val
);
2468 /* Call function FN with one argument ARG.
2469 Return the result, or nil if something went wrong. */
2472 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2474 return safe_call (2, fn
, arg
);
2477 static Lisp_Object Qeval
;
2480 safe_eval (Lisp_Object sexpr
)
2482 return safe_call1 (Qeval
, sexpr
);
2485 /* Call function FN with two arguments ARG1 and ARG2.
2486 Return the result, or nil if something went wrong. */
2489 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2491 return safe_call (3, fn
, arg1
, arg2
);
2496 /***********************************************************************
2498 ***********************************************************************/
2502 /* Define CHECK_IT to perform sanity checks on iterators.
2503 This is for debugging. It is too slow to do unconditionally. */
2506 check_it (struct it
*it
)
2508 if (it
->method
== GET_FROM_STRING
)
2510 eassert (STRINGP (it
->string
));
2511 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2515 eassert (IT_STRING_CHARPOS (*it
) < 0);
2516 if (it
->method
== GET_FROM_BUFFER
)
2518 /* Check that character and byte positions agree. */
2519 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2524 eassert (it
->current
.dpvec_index
>= 0);
2526 eassert (it
->current
.dpvec_index
< 0);
2529 #define CHECK_IT(IT) check_it ((IT))
2533 #define CHECK_IT(IT) (void) 0
2538 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2540 /* Check that the window end of window W is what we expect it
2541 to be---the last row in the current matrix displaying text. */
2544 check_window_end (struct window
*w
)
2546 if (!MINI_WINDOW_P (w
)
2547 && !NILP (w
->window_end_valid
))
2549 struct glyph_row
*row
;
2550 eassert ((row
= MATRIX_ROW (w
->current_matrix
,
2551 XFASTINT (w
->window_end_vpos
)),
2553 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2554 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2558 #define CHECK_WINDOW_END(W) check_window_end ((W))
2562 #define CHECK_WINDOW_END(W) (void) 0
2564 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2568 /***********************************************************************
2569 Iterator initialization
2570 ***********************************************************************/
2572 /* Initialize IT for displaying current_buffer in window W, starting
2573 at character position CHARPOS. CHARPOS < 0 means that no buffer
2574 position is specified which is useful when the iterator is assigned
2575 a position later. BYTEPOS is the byte position corresponding to
2576 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2578 If ROW is not null, calls to produce_glyphs with IT as parameter
2579 will produce glyphs in that row.
2581 BASE_FACE_ID is the id of a base face to use. It must be one of
2582 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2583 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2584 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2586 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2587 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2588 will be initialized to use the corresponding mode line glyph row of
2589 the desired matrix of W. */
2592 init_iterator (struct it
*it
, struct window
*w
,
2593 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2594 struct glyph_row
*row
, enum face_id base_face_id
)
2596 int highlight_region_p
;
2597 enum face_id remapped_base_face_id
= base_face_id
;
2599 /* Some precondition checks. */
2600 eassert (w
!= NULL
&& it
!= NULL
);
2601 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2604 /* If face attributes have been changed since the last redisplay,
2605 free realized faces now because they depend on face definitions
2606 that might have changed. Don't free faces while there might be
2607 desired matrices pending which reference these faces. */
2608 if (face_change_count
&& !inhibit_free_realized_faces
)
2610 face_change_count
= 0;
2611 free_all_realized_faces (Qnil
);
2614 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2615 if (! NILP (Vface_remapping_alist
))
2616 remapped_base_face_id
2617 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2619 /* Use one of the mode line rows of W's desired matrix if
2623 if (base_face_id
== MODE_LINE_FACE_ID
2624 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2625 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2626 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2627 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2631 memset (it
, 0, sizeof *it
);
2632 it
->current
.overlay_string_index
= -1;
2633 it
->current
.dpvec_index
= -1;
2634 it
->base_face_id
= remapped_base_face_id
;
2636 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2637 it
->paragraph_embedding
= L2R
;
2638 it
->bidi_it
.string
.lstring
= Qnil
;
2639 it
->bidi_it
.string
.s
= NULL
;
2640 it
->bidi_it
.string
.bufpos
= 0;
2642 /* The window in which we iterate over current_buffer: */
2643 XSETWINDOW (it
->window
, w
);
2645 it
->f
= XFRAME (w
->frame
);
2649 /* Extra space between lines (on window systems only). */
2650 if (base_face_id
== DEFAULT_FACE_ID
2651 && FRAME_WINDOW_P (it
->f
))
2653 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2654 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2655 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2656 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2657 * FRAME_LINE_HEIGHT (it
->f
));
2658 else if (it
->f
->extra_line_spacing
> 0)
2659 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2660 it
->max_extra_line_spacing
= 0;
2663 /* If realized faces have been removed, e.g. because of face
2664 attribute changes of named faces, recompute them. When running
2665 in batch mode, the face cache of the initial frame is null. If
2666 we happen to get called, make a dummy face cache. */
2667 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2668 init_frame_faces (it
->f
);
2669 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2670 recompute_basic_faces (it
->f
);
2672 /* Current value of the `slice', `space-width', and 'height' properties. */
2673 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2674 it
->space_width
= Qnil
;
2675 it
->font_height
= Qnil
;
2676 it
->override_ascent
= -1;
2678 /* Are control characters displayed as `^C'? */
2679 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2681 /* -1 means everything between a CR and the following line end
2682 is invisible. >0 means lines indented more than this value are
2684 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2686 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2688 : (!NILP (BVAR (current_buffer
, selective_display
))
2690 it
->selective_display_ellipsis_p
2691 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2693 /* Display table to use. */
2694 it
->dp
= window_display_table (w
);
2696 /* Are multibyte characters enabled in current_buffer? */
2697 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2699 /* Non-zero if we should highlight the region. */
2701 = (!NILP (Vtransient_mark_mode
)
2702 && !NILP (BVAR (current_buffer
, mark_active
))
2703 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2705 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2706 start and end of a visible region in window IT->w. Set both to
2707 -1 to indicate no region. */
2708 if (highlight_region_p
2709 /* Maybe highlight only in selected window. */
2710 && (/* Either show region everywhere. */
2711 highlight_nonselected_windows
2712 /* Or show region in the selected window. */
2713 || w
== XWINDOW (selected_window
)
2714 /* Or show the region if we are in the mini-buffer and W is
2715 the window the mini-buffer refers to. */
2716 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2717 && WINDOWP (minibuf_selected_window
)
2718 && w
== XWINDOW (minibuf_selected_window
))))
2720 ptrdiff_t markpos
= marker_position (BVAR (current_buffer
, mark
));
2721 it
->region_beg_charpos
= min (PT
, markpos
);
2722 it
->region_end_charpos
= max (PT
, markpos
);
2725 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2727 /* Get the position at which the redisplay_end_trigger hook should
2728 be run, if it is to be run at all. */
2729 if (MARKERP (w
->redisplay_end_trigger
)
2730 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2731 it
->redisplay_end_trigger_charpos
2732 = marker_position (w
->redisplay_end_trigger
);
2733 else if (INTEGERP (w
->redisplay_end_trigger
))
2734 it
->redisplay_end_trigger_charpos
=
2735 clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
), PTRDIFF_MAX
);
2737 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2739 /* Are lines in the display truncated? */
2740 if (base_face_id
!= DEFAULT_FACE_ID
2742 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2743 && ((!NILP (Vtruncate_partial_width_windows
)
2744 && !INTEGERP (Vtruncate_partial_width_windows
))
2745 || (INTEGERP (Vtruncate_partial_width_windows
)
2746 && (WINDOW_TOTAL_COLS (it
->w
)
2747 < XINT (Vtruncate_partial_width_windows
))))))
2748 it
->line_wrap
= TRUNCATE
;
2749 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2750 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2751 ? WINDOW_WRAP
: WORD_WRAP
;
2753 it
->line_wrap
= TRUNCATE
;
2755 /* Get dimensions of truncation and continuation glyphs. These are
2756 displayed as fringe bitmaps under X, but we need them for such
2757 frames when the fringes are turned off. But leave the dimensions
2758 zero for tooltip frames, as these glyphs look ugly there and also
2759 sabotage calculations of tooltip dimensions in x-show-tip. */
2760 #ifdef HAVE_WINDOW_SYSTEM
2761 if (!(FRAME_WINDOW_P (it
->f
)
2762 && FRAMEP (tip_frame
)
2763 && it
->f
== XFRAME (tip_frame
)))
2766 if (it
->line_wrap
== TRUNCATE
)
2768 /* We will need the truncation glyph. */
2769 eassert (it
->glyph_row
== NULL
);
2770 produce_special_glyphs (it
, IT_TRUNCATION
);
2771 it
->truncation_pixel_width
= it
->pixel_width
;
2775 /* We will need the continuation glyph. */
2776 eassert (it
->glyph_row
== NULL
);
2777 produce_special_glyphs (it
, IT_CONTINUATION
);
2778 it
->continuation_pixel_width
= it
->pixel_width
;
2782 /* Reset these values to zero because the produce_special_glyphs
2783 above has changed them. */
2784 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2785 it
->phys_ascent
= it
->phys_descent
= 0;
2787 /* Set this after getting the dimensions of truncation and
2788 continuation glyphs, so that we don't produce glyphs when calling
2789 produce_special_glyphs, above. */
2790 it
->glyph_row
= row
;
2791 it
->area
= TEXT_AREA
;
2793 /* Forget any previous info about this row being reversed. */
2795 it
->glyph_row
->reversed_p
= 0;
2797 /* Get the dimensions of the display area. The display area
2798 consists of the visible window area plus a horizontally scrolled
2799 part to the left of the window. All x-values are relative to the
2800 start of this total display area. */
2801 if (base_face_id
!= DEFAULT_FACE_ID
)
2803 /* Mode lines, menu bar in terminal frames. */
2804 it
->first_visible_x
= 0;
2805 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2809 it
->first_visible_x
=
2810 window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2811 it
->last_visible_x
= (it
->first_visible_x
2812 + window_box_width (w
, TEXT_AREA
));
2814 /* If we truncate lines, leave room for the truncation glyph(s) at
2815 the right margin. Otherwise, leave room for the continuation
2816 glyph(s). Done only if the window has no fringes. Since we
2817 don't know at this point whether there will be any R2L lines in
2818 the window, we reserve space for truncation/continuation glyphs
2819 even if only one of the fringes is absent. */
2820 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
2821 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
2823 if (it
->line_wrap
== TRUNCATE
)
2824 it
->last_visible_x
-= it
->truncation_pixel_width
;
2826 it
->last_visible_x
-= it
->continuation_pixel_width
;
2829 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2830 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2833 /* Leave room for a border glyph. */
2834 if (!FRAME_WINDOW_P (it
->f
)
2835 && !WINDOW_RIGHTMOST_P (it
->w
))
2836 it
->last_visible_x
-= 1;
2838 it
->last_visible_y
= window_text_bottom_y (w
);
2840 /* For mode lines and alike, arrange for the first glyph having a
2841 left box line if the face specifies a box. */
2842 if (base_face_id
!= DEFAULT_FACE_ID
)
2846 it
->face_id
= remapped_base_face_id
;
2848 /* If we have a boxed mode line, make the first character appear
2849 with a left box line. */
2850 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2851 if (face
->box
!= FACE_NO_BOX
)
2852 it
->start_of_box_run_p
= 1;
2855 /* If a buffer position was specified, set the iterator there,
2856 getting overlays and face properties from that position. */
2857 if (charpos
>= BUF_BEG (current_buffer
))
2859 it
->end_charpos
= ZV
;
2860 IT_CHARPOS (*it
) = charpos
;
2862 /* We will rely on `reseat' to set this up properly, via
2863 handle_face_prop. */
2864 it
->face_id
= it
->base_face_id
;
2866 /* Compute byte position if not specified. */
2867 if (bytepos
< charpos
)
2868 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2870 IT_BYTEPOS (*it
) = bytepos
;
2872 it
->start
= it
->current
;
2873 /* Do we need to reorder bidirectional text? Not if this is a
2874 unibyte buffer: by definition, none of the single-byte
2875 characters are strong R2L, so no reordering is needed. And
2876 bidi.c doesn't support unibyte buffers anyway. Also, don't
2877 reorder while we are loading loadup.el, since the tables of
2878 character properties needed for reordering are not yet
2882 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2885 /* If we are to reorder bidirectional text, init the bidi
2889 /* Note the paragraph direction that this buffer wants to
2891 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2893 it
->paragraph_embedding
= L2R
;
2894 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2896 it
->paragraph_embedding
= R2L
;
2898 it
->paragraph_embedding
= NEUTRAL_DIR
;
2899 bidi_unshelve_cache (NULL
, 0);
2900 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2904 /* Compute faces etc. */
2905 reseat (it
, it
->current
.pos
, 1);
2912 /* Initialize IT for the display of window W with window start POS. */
2915 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2917 struct glyph_row
*row
;
2918 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2920 row
= w
->desired_matrix
->rows
+ first_vpos
;
2921 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2922 it
->first_vpos
= first_vpos
;
2924 /* Don't reseat to previous visible line start if current start
2925 position is in a string or image. */
2926 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2928 int start_at_line_beg_p
;
2929 int first_y
= it
->current_y
;
2931 /* If window start is not at a line start, skip forward to POS to
2932 get the correct continuation lines width. */
2933 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2934 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2935 if (!start_at_line_beg_p
)
2939 reseat_at_previous_visible_line_start (it
);
2940 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2942 new_x
= it
->current_x
+ it
->pixel_width
;
2944 /* If lines are continued, this line may end in the middle
2945 of a multi-glyph character (e.g. a control character
2946 displayed as \003, or in the middle of an overlay
2947 string). In this case move_it_to above will not have
2948 taken us to the start of the continuation line but to the
2949 end of the continued line. */
2950 if (it
->current_x
> 0
2951 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2952 && (/* And glyph doesn't fit on the line. */
2953 new_x
> it
->last_visible_x
2954 /* Or it fits exactly and we're on a window
2956 || (new_x
== it
->last_visible_x
2957 && FRAME_WINDOW_P (it
->f
)
2958 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2959 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2960 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2962 if ((it
->current
.dpvec_index
>= 0
2963 || it
->current
.overlay_string_index
>= 0)
2964 /* If we are on a newline from a display vector or
2965 overlay string, then we are already at the end of
2966 a screen line; no need to go to the next line in
2967 that case, as this line is not really continued.
2968 (If we do go to the next line, C-e will not DTRT.) */
2971 set_iterator_to_next (it
, 1);
2972 move_it_in_display_line_to (it
, -1, -1, 0);
2975 it
->continuation_lines_width
+= it
->current_x
;
2977 /* If the character at POS is displayed via a display
2978 vector, move_it_to above stops at the final glyph of
2979 IT->dpvec. To make the caller redisplay that character
2980 again (a.k.a. start at POS), we need to reset the
2981 dpvec_index to the beginning of IT->dpvec. */
2982 else if (it
->current
.dpvec_index
>= 0)
2983 it
->current
.dpvec_index
= 0;
2985 /* We're starting a new display line, not affected by the
2986 height of the continued line, so clear the appropriate
2987 fields in the iterator structure. */
2988 it
->max_ascent
= it
->max_descent
= 0;
2989 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2991 it
->current_y
= first_y
;
2993 it
->current_x
= it
->hpos
= 0;
2999 /* Return 1 if POS is a position in ellipses displayed for invisible
3000 text. W is the window we display, for text property lookup. */
3003 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3005 Lisp_Object prop
, window
;
3007 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3009 /* If POS specifies a position in a display vector, this might
3010 be for an ellipsis displayed for invisible text. We won't
3011 get the iterator set up for delivering that ellipsis unless
3012 we make sure that it gets aware of the invisible text. */
3013 if (pos
->dpvec_index
>= 0
3014 && pos
->overlay_string_index
< 0
3015 && CHARPOS (pos
->string_pos
) < 0
3017 && (XSETWINDOW (window
, w
),
3018 prop
= Fget_char_property (make_number (charpos
),
3019 Qinvisible
, window
),
3020 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3022 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3024 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3031 /* Initialize IT for stepping through current_buffer in window W,
3032 starting at position POS that includes overlay string and display
3033 vector/ control character translation position information. Value
3034 is zero if there are overlay strings with newlines at POS. */
3037 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3039 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3040 int i
, overlay_strings_with_newlines
= 0;
3042 /* If POS specifies a position in a display vector, this might
3043 be for an ellipsis displayed for invisible text. We won't
3044 get the iterator set up for delivering that ellipsis unless
3045 we make sure that it gets aware of the invisible text. */
3046 if (in_ellipses_for_invisible_text_p (pos
, w
))
3052 /* Keep in mind: the call to reseat in init_iterator skips invisible
3053 text, so we might end up at a position different from POS. This
3054 is only a problem when POS is a row start after a newline and an
3055 overlay starts there with an after-string, and the overlay has an
3056 invisible property. Since we don't skip invisible text in
3057 display_line and elsewhere immediately after consuming the
3058 newline before the row start, such a POS will not be in a string,
3059 but the call to init_iterator below will move us to the
3061 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3063 /* This only scans the current chunk -- it should scan all chunks.
3064 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3065 to 16 in 22.1 to make this a lesser problem. */
3066 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3068 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3069 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3071 while (s
< e
&& *s
!= '\n')
3076 overlay_strings_with_newlines
= 1;
3081 /* If position is within an overlay string, set up IT to the right
3083 if (pos
->overlay_string_index
>= 0)
3087 /* If the first overlay string happens to have a `display'
3088 property for an image, the iterator will be set up for that
3089 image, and we have to undo that setup first before we can
3090 correct the overlay string index. */
3091 if (it
->method
== GET_FROM_IMAGE
)
3094 /* We already have the first chunk of overlay strings in
3095 IT->overlay_strings. Load more until the one for
3096 pos->overlay_string_index is in IT->overlay_strings. */
3097 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3099 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3100 it
->current
.overlay_string_index
= 0;
3103 load_overlay_strings (it
, 0);
3104 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3108 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3109 relative_index
= (it
->current
.overlay_string_index
3110 % OVERLAY_STRING_CHUNK_SIZE
);
3111 it
->string
= it
->overlay_strings
[relative_index
];
3112 eassert (STRINGP (it
->string
));
3113 it
->current
.string_pos
= pos
->string_pos
;
3114 it
->method
= GET_FROM_STRING
;
3117 if (CHARPOS (pos
->string_pos
) >= 0)
3119 /* Recorded position is not in an overlay string, but in another
3120 string. This can only be a string from a `display' property.
3121 IT should already be filled with that string. */
3122 it
->current
.string_pos
= pos
->string_pos
;
3123 eassert (STRINGP (it
->string
));
3126 /* Restore position in display vector translations, control
3127 character translations or ellipses. */
3128 if (pos
->dpvec_index
>= 0)
3130 if (it
->dpvec
== NULL
)
3131 get_next_display_element (it
);
3132 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3133 it
->current
.dpvec_index
= pos
->dpvec_index
;
3137 return !overlay_strings_with_newlines
;
3141 /* Initialize IT for stepping through current_buffer in window W
3142 starting at ROW->start. */
3145 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3147 init_from_display_pos (it
, w
, &row
->start
);
3148 it
->start
= row
->start
;
3149 it
->continuation_lines_width
= row
->continuation_lines_width
;
3154 /* Initialize IT for stepping through current_buffer in window W
3155 starting in the line following ROW, i.e. starting at ROW->end.
3156 Value is zero if there are overlay strings with newlines at ROW's
3160 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3164 if (init_from_display_pos (it
, w
, &row
->end
))
3166 if (row
->continued_p
)
3167 it
->continuation_lines_width
3168 = row
->continuation_lines_width
+ row
->pixel_width
;
3179 /***********************************************************************
3181 ***********************************************************************/
3183 /* Called when IT reaches IT->stop_charpos. Handle text property and
3184 overlay changes. Set IT->stop_charpos to the next position where
3188 handle_stop (struct it
*it
)
3190 enum prop_handled handled
;
3191 int handle_overlay_change_p
;
3195 it
->current
.dpvec_index
= -1;
3196 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3197 it
->ignore_overlay_strings_at_pos_p
= 0;
3200 /* Use face of preceding text for ellipsis (if invisible) */
3201 if (it
->selective_display_ellipsis_p
)
3202 it
->saved_face_id
= it
->face_id
;
3206 handled
= HANDLED_NORMALLY
;
3208 /* Call text property handlers. */
3209 for (p
= it_props
; p
->handler
; ++p
)
3211 handled
= p
->handler (it
);
3213 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3215 else if (handled
== HANDLED_RETURN
)
3217 /* We still want to show before and after strings from
3218 overlays even if the actual buffer text is replaced. */
3219 if (!handle_overlay_change_p
3221 /* Don't call get_overlay_strings_1 if we already
3222 have overlay strings loaded, because doing so
3223 will load them again and push the iterator state
3224 onto the stack one more time, which is not
3225 expected by the rest of the code that processes
3227 || (it
->current
.overlay_string_index
< 0
3228 ? !get_overlay_strings_1 (it
, 0, 0)
3232 setup_for_ellipsis (it
, 0);
3233 /* When handling a display spec, we might load an
3234 empty string. In that case, discard it here. We
3235 used to discard it in handle_single_display_spec,
3236 but that causes get_overlay_strings_1, above, to
3237 ignore overlay strings that we must check. */
3238 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3242 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3246 it
->ignore_overlay_strings_at_pos_p
= 1;
3247 it
->string_from_display_prop_p
= 0;
3248 it
->from_disp_prop_p
= 0;
3249 handle_overlay_change_p
= 0;
3251 handled
= HANDLED_RECOMPUTE_PROPS
;
3254 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3255 handle_overlay_change_p
= 0;
3258 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3260 /* Don't check for overlay strings below when set to deliver
3261 characters from a display vector. */
3262 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3263 handle_overlay_change_p
= 0;
3265 /* Handle overlay changes.
3266 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3267 if it finds overlays. */
3268 if (handle_overlay_change_p
)
3269 handled
= handle_overlay_change (it
);
3274 setup_for_ellipsis (it
, 0);
3278 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3280 /* Determine where to stop next. */
3281 if (handled
== HANDLED_NORMALLY
)
3282 compute_stop_pos (it
);
3286 /* Compute IT->stop_charpos from text property and overlay change
3287 information for IT's current position. */
3290 compute_stop_pos (struct it
*it
)
3292 register INTERVAL iv
, next_iv
;
3293 Lisp_Object object
, limit
, position
;
3294 ptrdiff_t charpos
, bytepos
;
3296 if (STRINGP (it
->string
))
3298 /* Strings are usually short, so don't limit the search for
3300 it
->stop_charpos
= it
->end_charpos
;
3301 object
= it
->string
;
3303 charpos
= IT_STRING_CHARPOS (*it
);
3304 bytepos
= IT_STRING_BYTEPOS (*it
);
3310 /* If end_charpos is out of range for some reason, such as a
3311 misbehaving display function, rationalize it (Bug#5984). */
3312 if (it
->end_charpos
> ZV
)
3313 it
->end_charpos
= ZV
;
3314 it
->stop_charpos
= it
->end_charpos
;
3316 /* If next overlay change is in front of the current stop pos
3317 (which is IT->end_charpos), stop there. Note: value of
3318 next_overlay_change is point-max if no overlay change
3320 charpos
= IT_CHARPOS (*it
);
3321 bytepos
= IT_BYTEPOS (*it
);
3322 pos
= next_overlay_change (charpos
);
3323 if (pos
< it
->stop_charpos
)
3324 it
->stop_charpos
= pos
;
3326 /* If showing the region, we have to stop at the region
3327 start or end because the face might change there. */
3328 if (it
->region_beg_charpos
> 0)
3330 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3331 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3332 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3333 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3336 /* Set up variables for computing the stop position from text
3337 property changes. */
3338 XSETBUFFER (object
, current_buffer
);
3339 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3342 /* Get the interval containing IT's position. Value is a null
3343 interval if there isn't such an interval. */
3344 position
= make_number (charpos
);
3345 iv
= validate_interval_range (object
, &position
, &position
, 0);
3348 Lisp_Object values_here
[LAST_PROP_IDX
];
3351 /* Get properties here. */
3352 for (p
= it_props
; p
->handler
; ++p
)
3353 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3355 /* Look for an interval following iv that has different
3357 for (next_iv
= next_interval (iv
);
3360 || XFASTINT (limit
) > next_iv
->position
));
3361 next_iv
= next_interval (next_iv
))
3363 for (p
= it_props
; p
->handler
; ++p
)
3365 Lisp_Object new_value
;
3367 new_value
= textget (next_iv
->plist
, *p
->name
);
3368 if (!EQ (values_here
[p
->idx
], new_value
))
3378 if (INTEGERP (limit
)
3379 && next_iv
->position
>= XFASTINT (limit
))
3380 /* No text property change up to limit. */
3381 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3383 /* Text properties change in next_iv. */
3384 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3388 if (it
->cmp_it
.id
< 0)
3390 ptrdiff_t stoppos
= it
->end_charpos
;
3392 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3394 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3395 stoppos
, it
->string
);
3398 eassert (STRINGP (it
->string
)
3399 || (it
->stop_charpos
>= BEGV
3400 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3404 /* Return the position of the next overlay change after POS in
3405 current_buffer. Value is point-max if no overlay change
3406 follows. This is like `next-overlay-change' but doesn't use
3410 next_overlay_change (ptrdiff_t pos
)
3412 ptrdiff_t i
, noverlays
;
3414 Lisp_Object
*overlays
;
3416 /* Get all overlays at the given position. */
3417 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3419 /* If any of these overlays ends before endpos,
3420 use its ending point instead. */
3421 for (i
= 0; i
< noverlays
; ++i
)
3426 oend
= OVERLAY_END (overlays
[i
]);
3427 oendpos
= OVERLAY_POSITION (oend
);
3428 endpos
= min (endpos
, oendpos
);
3434 /* How many characters forward to search for a display property or
3435 display string. Searching too far forward makes the bidi display
3436 sluggish, especially in small windows. */
3437 #define MAX_DISP_SCAN 250
3439 /* Return the character position of a display string at or after
3440 position specified by POSITION. If no display string exists at or
3441 after POSITION, return ZV. A display string is either an overlay
3442 with `display' property whose value is a string, or a `display'
3443 text property whose value is a string. STRING is data about the
3444 string to iterate; if STRING->lstring is nil, we are iterating a
3445 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3446 on a GUI frame. DISP_PROP is set to zero if we searched
3447 MAX_DISP_SCAN characters forward without finding any display
3448 strings, non-zero otherwise. It is set to 2 if the display string
3449 uses any kind of `(space ...)' spec that will produce a stretch of
3450 white space in the text area. */
3452 compute_display_string_pos (struct text_pos
*position
,
3453 struct bidi_string_data
*string
,
3454 int frame_window_p
, int *disp_prop
)
3456 /* OBJECT = nil means current buffer. */
3457 Lisp_Object object
=
3458 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3459 Lisp_Object pos
, spec
, limpos
;
3460 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3461 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3462 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3463 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3465 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3466 struct text_pos tpos
;
3472 /* We don't support display properties whose values are strings
3473 that have display string properties. */
3474 || string
->from_disp_str
3475 /* C strings cannot have display properties. */
3476 || (string
->s
&& !STRINGP (object
)))
3482 /* If the character at CHARPOS is where the display string begins,
3484 pos
= make_number (charpos
);
3485 if (STRINGP (object
))
3486 bufpos
= string
->bufpos
;
3490 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3492 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3495 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3503 /* Look forward for the first character with a `display' property
3504 that will replace the underlying text when displayed. */
3505 limpos
= make_number (lim
);
3507 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3508 CHARPOS (tpos
) = XFASTINT (pos
);
3509 if (CHARPOS (tpos
) >= lim
)
3514 if (STRINGP (object
))
3515 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3517 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3518 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3519 if (!STRINGP (object
))
3520 bufpos
= CHARPOS (tpos
);
3521 } while (NILP (spec
)
3522 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3523 bufpos
, frame_window_p
)));
3527 return CHARPOS (tpos
);
3530 /* Return the character position of the end of the display string that
3531 started at CHARPOS. If there's no display string at CHARPOS,
3532 return -1. A display string is either an overlay with `display'
3533 property whose value is a string or a `display' text property whose
3534 value is a string. */
3536 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3538 /* OBJECT = nil means current buffer. */
3539 Lisp_Object object
=
3540 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3541 Lisp_Object pos
= make_number (charpos
);
3543 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3545 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3548 /* It could happen that the display property or overlay was removed
3549 since we found it in compute_display_string_pos above. One way
3550 this can happen is if JIT font-lock was called (through
3551 handle_fontified_prop), and jit-lock-functions remove text
3552 properties or overlays from the portion of buffer that includes
3553 CHARPOS. Muse mode is known to do that, for example. In this
3554 case, we return -1 to the caller, to signal that no display
3555 string is actually present at CHARPOS. See bidi_fetch_char for
3556 how this is handled.
3558 An alternative would be to never look for display properties past
3559 it->stop_charpos. But neither compute_display_string_pos nor
3560 bidi_fetch_char that calls it know or care where the next
3562 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3565 /* Look forward for the first character where the `display' property
3567 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3569 return XFASTINT (pos
);
3574 /***********************************************************************
3576 ***********************************************************************/
3578 /* Handle changes in the `fontified' property of the current buffer by
3579 calling hook functions from Qfontification_functions to fontify
3582 static enum prop_handled
3583 handle_fontified_prop (struct it
*it
)
3585 Lisp_Object prop
, pos
;
3586 enum prop_handled handled
= HANDLED_NORMALLY
;
3588 if (!NILP (Vmemory_full
))
3591 /* Get the value of the `fontified' property at IT's current buffer
3592 position. (The `fontified' property doesn't have a special
3593 meaning in strings.) If the value is nil, call functions from
3594 Qfontification_functions. */
3595 if (!STRINGP (it
->string
)
3597 && !NILP (Vfontification_functions
)
3598 && !NILP (Vrun_hooks
)
3599 && (pos
= make_number (IT_CHARPOS (*it
)),
3600 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3601 /* Ignore the special cased nil value always present at EOB since
3602 no amount of fontifying will be able to change it. */
3603 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3605 ptrdiff_t count
= SPECPDL_INDEX ();
3607 struct buffer
*obuf
= current_buffer
;
3608 int begv
= BEGV
, zv
= ZV
;
3609 int old_clip_changed
= current_buffer
->clip_changed
;
3611 val
= Vfontification_functions
;
3612 specbind (Qfontification_functions
, Qnil
);
3614 eassert (it
->end_charpos
== ZV
);
3616 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3617 safe_call1 (val
, pos
);
3620 Lisp_Object fns
, fn
;
3621 struct gcpro gcpro1
, gcpro2
;
3626 for (; CONSP (val
); val
= XCDR (val
))
3632 /* A value of t indicates this hook has a local
3633 binding; it means to run the global binding too.
3634 In a global value, t should not occur. If it
3635 does, we must ignore it to avoid an endless
3637 for (fns
= Fdefault_value (Qfontification_functions
);
3643 safe_call1 (fn
, pos
);
3647 safe_call1 (fn
, pos
);
3653 unbind_to (count
, Qnil
);
3655 /* Fontification functions routinely call `save-restriction'.
3656 Normally, this tags clip_changed, which can confuse redisplay
3657 (see discussion in Bug#6671). Since we don't perform any
3658 special handling of fontification changes in the case where
3659 `save-restriction' isn't called, there's no point doing so in
3660 this case either. So, if the buffer's restrictions are
3661 actually left unchanged, reset clip_changed. */
3662 if (obuf
== current_buffer
)
3664 if (begv
== BEGV
&& zv
== ZV
)
3665 current_buffer
->clip_changed
= old_clip_changed
;
3667 /* There isn't much we can reasonably do to protect against
3668 misbehaving fontification, but here's a fig leaf. */
3669 else if (BUFFER_LIVE_P (obuf
))
3670 set_buffer_internal_1 (obuf
);
3672 /* The fontification code may have added/removed text.
3673 It could do even a lot worse, but let's at least protect against
3674 the most obvious case where only the text past `pos' gets changed',
3675 as is/was done in grep.el where some escapes sequences are turned
3676 into face properties (bug#7876). */
3677 it
->end_charpos
= ZV
;
3679 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3680 something. This avoids an endless loop if they failed to
3681 fontify the text for which reason ever. */
3682 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3683 handled
= HANDLED_RECOMPUTE_PROPS
;
3691 /***********************************************************************
3693 ***********************************************************************/
3695 /* Set up iterator IT from face properties at its current position.
3696 Called from handle_stop. */
3698 static enum prop_handled
3699 handle_face_prop (struct it
*it
)
3702 ptrdiff_t next_stop
;
3704 if (!STRINGP (it
->string
))
3707 = face_at_buffer_position (it
->w
,
3709 it
->region_beg_charpos
,
3710 it
->region_end_charpos
,
3713 + TEXT_PROP_DISTANCE_LIMIT
),
3714 0, it
->base_face_id
);
3716 /* Is this a start of a run of characters with box face?
3717 Caveat: this can be called for a freshly initialized
3718 iterator; face_id is -1 in this case. We know that the new
3719 face will not change until limit, i.e. if the new face has a
3720 box, all characters up to limit will have one. But, as
3721 usual, we don't know whether limit is really the end. */
3722 if (new_face_id
!= it
->face_id
)
3724 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3726 /* If new face has a box but old face has not, this is
3727 the start of a run of characters with box, i.e. it has
3728 a shadow on the left side. The value of face_id of the
3729 iterator will be -1 if this is the initial call that gets
3730 the face. In this case, we have to look in front of IT's
3731 position and see whether there is a face != new_face_id. */
3732 it
->start_of_box_run_p
3733 = (new_face
->box
!= FACE_NO_BOX
3734 && (it
->face_id
>= 0
3735 || IT_CHARPOS (*it
) == BEG
3736 || new_face_id
!= face_before_it_pos (it
)));
3737 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3745 Lisp_Object from_overlay
3746 = (it
->current
.overlay_string_index
>= 0
3747 ? it
->string_overlays
[it
->current
.overlay_string_index
3748 % OVERLAY_STRING_CHUNK_SIZE
]
3751 /* See if we got to this string directly or indirectly from
3752 an overlay property. That includes the before-string or
3753 after-string of an overlay, strings in display properties
3754 provided by an overlay, their text properties, etc.
3756 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3757 if (! NILP (from_overlay
))
3758 for (i
= it
->sp
- 1; i
>= 0; i
--)
3760 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3762 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3763 % OVERLAY_STRING_CHUNK_SIZE
];
3764 else if (! NILP (it
->stack
[i
].from_overlay
))
3765 from_overlay
= it
->stack
[i
].from_overlay
;
3767 if (!NILP (from_overlay
))
3771 if (! NILP (from_overlay
))
3773 bufpos
= IT_CHARPOS (*it
);
3774 /* For a string from an overlay, the base face depends
3775 only on text properties and ignores overlays. */
3777 = face_for_overlay_string (it
->w
,
3779 it
->region_beg_charpos
,
3780 it
->region_end_charpos
,
3783 + TEXT_PROP_DISTANCE_LIMIT
),
3791 /* For strings from a `display' property, use the face at
3792 IT's current buffer position as the base face to merge
3793 with, so that overlay strings appear in the same face as
3794 surrounding text, unless they specify their own
3796 base_face_id
= it
->string_from_prefix_prop_p
3798 : underlying_face_id (it
);
3801 new_face_id
= face_at_string_position (it
->w
,
3803 IT_STRING_CHARPOS (*it
),
3805 it
->region_beg_charpos
,
3806 it
->region_end_charpos
,
3810 /* Is this a start of a run of characters with box? Caveat:
3811 this can be called for a freshly allocated iterator; face_id
3812 is -1 is this case. We know that the new face will not
3813 change until the next check pos, i.e. if the new face has a
3814 box, all characters up to that position will have a
3815 box. But, as usual, we don't know whether that position
3816 is really the end. */
3817 if (new_face_id
!= it
->face_id
)
3819 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3820 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3822 /* If new face has a box but old face hasn't, this is the
3823 start of a run of characters with box, i.e. it has a
3824 shadow on the left side. */
3825 it
->start_of_box_run_p
3826 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3827 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3831 it
->face_id
= new_face_id
;
3832 return HANDLED_NORMALLY
;
3836 /* Return the ID of the face ``underlying'' IT's current position,
3837 which is in a string. If the iterator is associated with a
3838 buffer, return the face at IT's current buffer position.
3839 Otherwise, use the iterator's base_face_id. */
3842 underlying_face_id (struct it
*it
)
3844 int face_id
= it
->base_face_id
, i
;
3846 eassert (STRINGP (it
->string
));
3848 for (i
= it
->sp
- 1; i
>= 0; --i
)
3849 if (NILP (it
->stack
[i
].string
))
3850 face_id
= it
->stack
[i
].face_id
;
3856 /* Compute the face one character before or after the current position
3857 of IT, in the visual order. BEFORE_P non-zero means get the face
3858 in front (to the left in L2R paragraphs, to the right in R2L
3859 paragraphs) of IT's screen position. Value is the ID of the face. */
3862 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3865 ptrdiff_t next_check_charpos
;
3867 void *it_copy_data
= NULL
;
3869 eassert (it
->s
== NULL
);
3871 if (STRINGP (it
->string
))
3873 ptrdiff_t bufpos
, charpos
;
3876 /* No face change past the end of the string (for the case
3877 we are padding with spaces). No face change before the
3879 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3880 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3885 /* Set charpos to the position before or after IT's current
3886 position, in the logical order, which in the non-bidi
3887 case is the same as the visual order. */
3889 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3890 else if (it
->what
== IT_COMPOSITION
)
3891 /* For composition, we must check the character after the
3893 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3895 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3901 /* With bidi iteration, the character before the current
3902 in the visual order cannot be found by simple
3903 iteration, because "reverse" reordering is not
3904 supported. Instead, we need to use the move_it_*
3905 family of functions. */
3906 /* Ignore face changes before the first visible
3907 character on this display line. */
3908 if (it
->current_x
<= it
->first_visible_x
)
3910 SAVE_IT (it_copy
, *it
, it_copy_data
);
3911 /* Implementation note: Since move_it_in_display_line
3912 works in the iterator geometry, and thinks the first
3913 character is always the leftmost, even in R2L lines,
3914 we don't need to distinguish between the R2L and L2R
3916 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3917 it_copy
.current_x
- 1, MOVE_TO_X
);
3918 charpos
= IT_STRING_CHARPOS (it_copy
);
3919 RESTORE_IT (it
, it
, it_copy_data
);
3923 /* Set charpos to the string position of the character
3924 that comes after IT's current position in the visual
3926 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3930 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3932 charpos
= it_copy
.bidi_it
.charpos
;
3935 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3937 if (it
->current
.overlay_string_index
>= 0)
3938 bufpos
= IT_CHARPOS (*it
);
3942 base_face_id
= underlying_face_id (it
);
3944 /* Get the face for ASCII, or unibyte. */
3945 face_id
= face_at_string_position (it
->w
,
3949 it
->region_beg_charpos
,
3950 it
->region_end_charpos
,
3951 &next_check_charpos
,
3954 /* Correct the face for charsets different from ASCII. Do it
3955 for the multibyte case only. The face returned above is
3956 suitable for unibyte text if IT->string is unibyte. */
3957 if (STRING_MULTIBYTE (it
->string
))
3959 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3960 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3962 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3964 c
= string_char_and_length (p
, &len
);
3965 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3970 struct text_pos pos
;
3972 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3973 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3976 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3977 pos
= it
->current
.pos
;
3982 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3985 if (it
->what
== IT_COMPOSITION
)
3987 /* For composition, we must check the position after
3989 pos
.charpos
+= it
->cmp_it
.nchars
;
3990 pos
.bytepos
+= it
->len
;
3993 INC_TEXT_POS (pos
, it
->multibyte_p
);
4000 /* With bidi iteration, the character before the current
4001 in the visual order cannot be found by simple
4002 iteration, because "reverse" reordering is not
4003 supported. Instead, we need to use the move_it_*
4004 family of functions. */
4005 /* Ignore face changes before the first visible
4006 character on this display line. */
4007 if (it
->current_x
<= it
->first_visible_x
)
4009 SAVE_IT (it_copy
, *it
, it_copy_data
);
4010 /* Implementation note: Since move_it_in_display_line
4011 works in the iterator geometry, and thinks the first
4012 character is always the leftmost, even in R2L lines,
4013 we don't need to distinguish between the R2L and L2R
4015 move_it_in_display_line (&it_copy
, ZV
,
4016 it_copy
.current_x
- 1, MOVE_TO_X
);
4017 pos
= it_copy
.current
.pos
;
4018 RESTORE_IT (it
, it
, it_copy_data
);
4022 /* Set charpos to the buffer position of the character
4023 that comes after IT's current position in the visual
4025 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4029 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4032 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4035 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4037 /* Determine face for CHARSET_ASCII, or unibyte. */
4038 face_id
= face_at_buffer_position (it
->w
,
4040 it
->region_beg_charpos
,
4041 it
->region_end_charpos
,
4042 &next_check_charpos
,
4045 /* Correct the face for charsets different from ASCII. Do it
4046 for the multibyte case only. The face returned above is
4047 suitable for unibyte text if current_buffer is unibyte. */
4048 if (it
->multibyte_p
)
4050 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4051 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4052 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4061 /***********************************************************************
4063 ***********************************************************************/
4065 /* Set up iterator IT from invisible properties at its current
4066 position. Called from handle_stop. */
4068 static enum prop_handled
4069 handle_invisible_prop (struct it
*it
)
4071 enum prop_handled handled
= HANDLED_NORMALLY
;
4075 if (STRINGP (it
->string
))
4077 Lisp_Object end_charpos
, limit
, charpos
;
4079 /* Get the value of the invisible text property at the
4080 current position. Value will be nil if there is no such
4082 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4083 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4084 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4086 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4088 /* Record whether we have to display an ellipsis for the
4090 int display_ellipsis_p
= (invis_p
== 2);
4091 ptrdiff_t len
, endpos
;
4093 handled
= HANDLED_RECOMPUTE_PROPS
;
4095 /* Get the position at which the next visible text can be
4096 found in IT->string, if any. */
4097 endpos
= len
= SCHARS (it
->string
);
4098 XSETINT (limit
, len
);
4101 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4103 if (INTEGERP (end_charpos
))
4105 endpos
= XFASTINT (end_charpos
);
4106 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4107 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4109 display_ellipsis_p
= 1;
4112 while (invis_p
&& endpos
< len
);
4114 if (display_ellipsis_p
)
4119 /* Text at END_CHARPOS is visible. Move IT there. */
4120 struct text_pos old
;
4123 old
= it
->current
.string_pos
;
4124 oldpos
= CHARPOS (old
);
4127 if (it
->bidi_it
.first_elt
4128 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4129 bidi_paragraph_init (it
->paragraph_embedding
,
4131 /* Bidi-iterate out of the invisible text. */
4134 bidi_move_to_visually_next (&it
->bidi_it
);
4136 while (oldpos
<= it
->bidi_it
.charpos
4137 && it
->bidi_it
.charpos
< endpos
);
4139 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4140 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4141 if (IT_CHARPOS (*it
) >= endpos
)
4142 it
->prev_stop
= endpos
;
4146 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4147 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4152 /* The rest of the string is invisible. If this is an
4153 overlay string, proceed with the next overlay string
4154 or whatever comes and return a character from there. */
4155 if (it
->current
.overlay_string_index
>= 0
4156 && !display_ellipsis_p
)
4158 next_overlay_string (it
);
4159 /* Don't check for overlay strings when we just
4160 finished processing them. */
4161 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4165 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4166 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4173 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4174 Lisp_Object pos
, overlay
;
4176 /* First of all, is there invisible text at this position? */
4177 tem
= start_charpos
= IT_CHARPOS (*it
);
4178 pos
= make_number (tem
);
4179 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4181 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4183 /* If we are on invisible text, skip over it. */
4184 if (invis_p
&& start_charpos
< it
->end_charpos
)
4186 /* Record whether we have to display an ellipsis for the
4188 int display_ellipsis_p
= invis_p
== 2;
4190 handled
= HANDLED_RECOMPUTE_PROPS
;
4192 /* Loop skipping over invisible text. The loop is left at
4193 ZV or with IT on the first char being visible again. */
4196 /* Try to skip some invisible text. Return value is the
4197 position reached which can be equal to where we start
4198 if there is nothing invisible there. This skips both
4199 over invisible text properties and overlays with
4200 invisible property. */
4201 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4203 /* If we skipped nothing at all we weren't at invisible
4204 text in the first place. If everything to the end of
4205 the buffer was skipped, end the loop. */
4206 if (newpos
== tem
|| newpos
>= ZV
)
4210 /* We skipped some characters but not necessarily
4211 all there are. Check if we ended up on visible
4212 text. Fget_char_property returns the property of
4213 the char before the given position, i.e. if we
4214 get invis_p = 0, this means that the char at
4215 newpos is visible. */
4216 pos
= make_number (newpos
);
4217 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4218 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4221 /* If we ended up on invisible text, proceed to
4222 skip starting with next_stop. */
4226 /* If there are adjacent invisible texts, don't lose the
4227 second one's ellipsis. */
4229 display_ellipsis_p
= 1;
4233 /* The position newpos is now either ZV or on visible text. */
4236 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4238 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4240 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4242 /* If the invisible text ends on a newline or on a
4243 character after a newline, we can avoid the costly,
4244 character by character, bidi iteration to NEWPOS, and
4245 instead simply reseat the iterator there. That's
4246 because all bidi reordering information is tossed at
4247 the newline. This is a big win for modes that hide
4248 complete lines, like Outline, Org, etc. */
4249 if (on_newline
|| after_newline
)
4251 struct text_pos tpos
;
4252 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4254 SET_TEXT_POS (tpos
, newpos
, bpos
);
4255 reseat_1 (it
, tpos
, 0);
4256 /* If we reseat on a newline/ZV, we need to prep the
4257 bidi iterator for advancing to the next character
4258 after the newline/EOB, keeping the current paragraph
4259 direction (so that PRODUCE_GLYPHS does TRT wrt
4260 prepending/appending glyphs to a glyph row). */
4263 it
->bidi_it
.first_elt
= 0;
4264 it
->bidi_it
.paragraph_dir
= pdir
;
4265 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4266 it
->bidi_it
.nchars
= 1;
4267 it
->bidi_it
.ch_len
= 1;
4270 else /* Must use the slow method. */
4272 /* With bidi iteration, the region of invisible text
4273 could start and/or end in the middle of a
4274 non-base embedding level. Therefore, we need to
4275 skip invisible text using the bidi iterator,
4276 starting at IT's current position, until we find
4277 ourselves outside of the invisible text.
4278 Skipping invisible text _after_ bidi iteration
4279 avoids affecting the visual order of the
4280 displayed text when invisible properties are
4281 added or removed. */
4282 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4284 /* If we were `reseat'ed to a new paragraph,
4285 determine the paragraph base direction. We
4286 need to do it now because
4287 next_element_from_buffer may not have a
4288 chance to do it, if we are going to skip any
4289 text at the beginning, which resets the
4291 bidi_paragraph_init (it
->paragraph_embedding
,
4296 bidi_move_to_visually_next (&it
->bidi_it
);
4298 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4299 && it
->bidi_it
.charpos
< newpos
);
4300 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4301 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4302 /* If we overstepped NEWPOS, record its position in
4303 the iterator, so that we skip invisible text if
4304 later the bidi iteration lands us in the
4305 invisible region again. */
4306 if (IT_CHARPOS (*it
) >= newpos
)
4307 it
->prev_stop
= newpos
;
4312 IT_CHARPOS (*it
) = newpos
;
4313 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4316 /* If there are before-strings at the start of invisible
4317 text, and the text is invisible because of a text
4318 property, arrange to show before-strings because 20.x did
4319 it that way. (If the text is invisible because of an
4320 overlay property instead of a text property, this is
4321 already handled in the overlay code.) */
4323 && get_overlay_strings (it
, it
->stop_charpos
))
4325 handled
= HANDLED_RECOMPUTE_PROPS
;
4326 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4328 else if (display_ellipsis_p
)
4330 /* Make sure that the glyphs of the ellipsis will get
4331 correct `charpos' values. If we would not update
4332 it->position here, the glyphs would belong to the
4333 last visible character _before_ the invisible
4334 text, which confuses `set_cursor_from_row'.
4336 We use the last invisible position instead of the
4337 first because this way the cursor is always drawn on
4338 the first "." of the ellipsis, whenever PT is inside
4339 the invisible text. Otherwise the cursor would be
4340 placed _after_ the ellipsis when the point is after the
4341 first invisible character. */
4342 if (!STRINGP (it
->object
))
4344 it
->position
.charpos
= newpos
- 1;
4345 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4348 /* Let the ellipsis display before
4349 considering any properties of the following char.
4350 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4351 handled
= HANDLED_RETURN
;
4360 /* Make iterator IT return `...' next.
4361 Replaces LEN characters from buffer. */
4364 setup_for_ellipsis (struct it
*it
, int len
)
4366 /* Use the display table definition for `...'. Invalid glyphs
4367 will be handled by the method returning elements from dpvec. */
4368 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4370 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4371 it
->dpvec
= v
->contents
;
4372 it
->dpend
= v
->contents
+ v
->header
.size
;
4376 /* Default `...'. */
4377 it
->dpvec
= default_invis_vector
;
4378 it
->dpend
= default_invis_vector
+ 3;
4381 it
->dpvec_char_len
= len
;
4382 it
->current
.dpvec_index
= 0;
4383 it
->dpvec_face_id
= -1;
4385 /* Remember the current face id in case glyphs specify faces.
4386 IT's face is restored in set_iterator_to_next.
4387 saved_face_id was set to preceding char's face in handle_stop. */
4388 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4389 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4391 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4397 /***********************************************************************
4399 ***********************************************************************/
4401 /* Set up iterator IT from `display' property at its current position.
4402 Called from handle_stop.
4403 We return HANDLED_RETURN if some part of the display property
4404 overrides the display of the buffer text itself.
4405 Otherwise we return HANDLED_NORMALLY. */
4407 static enum prop_handled
4408 handle_display_prop (struct it
*it
)
4410 Lisp_Object propval
, object
, overlay
;
4411 struct text_pos
*position
;
4413 /* Nonzero if some property replaces the display of the text itself. */
4414 int display_replaced_p
= 0;
4416 if (STRINGP (it
->string
))
4418 object
= it
->string
;
4419 position
= &it
->current
.string_pos
;
4420 bufpos
= CHARPOS (it
->current
.pos
);
4424 XSETWINDOW (object
, it
->w
);
4425 position
= &it
->current
.pos
;
4426 bufpos
= CHARPOS (*position
);
4429 /* Reset those iterator values set from display property values. */
4430 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4431 it
->space_width
= Qnil
;
4432 it
->font_height
= Qnil
;
4435 /* We don't support recursive `display' properties, i.e. string
4436 values that have a string `display' property, that have a string
4437 `display' property etc. */
4438 if (!it
->string_from_display_prop_p
)
4439 it
->area
= TEXT_AREA
;
4441 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4442 Qdisplay
, object
, &overlay
);
4444 return HANDLED_NORMALLY
;
4445 /* Now OVERLAY is the overlay that gave us this property, or nil
4446 if it was a text property. */
4448 if (!STRINGP (it
->string
))
4449 object
= it
->w
->buffer
;
4451 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4453 FRAME_WINDOW_P (it
->f
));
4455 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4458 /* Subroutine of handle_display_prop. Returns non-zero if the display
4459 specification in SPEC is a replacing specification, i.e. it would
4460 replace the text covered by `display' property with something else,
4461 such as an image or a display string. If SPEC includes any kind or
4462 `(space ...) specification, the value is 2; this is used by
4463 compute_display_string_pos, which see.
4465 See handle_single_display_spec for documentation of arguments.
4466 frame_window_p is non-zero if the window being redisplayed is on a
4467 GUI frame; this argument is used only if IT is NULL, see below.
4469 IT can be NULL, if this is called by the bidi reordering code
4470 through compute_display_string_pos, which see. In that case, this
4471 function only examines SPEC, but does not otherwise "handle" it, in
4472 the sense that it doesn't set up members of IT from the display
4475 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4476 Lisp_Object overlay
, struct text_pos
*position
,
4477 ptrdiff_t bufpos
, int frame_window_p
)
4479 int replacing_p
= 0;
4483 /* Simple specifications. */
4484 && !EQ (XCAR (spec
), Qimage
)
4485 && !EQ (XCAR (spec
), Qspace
)
4486 && !EQ (XCAR (spec
), Qwhen
)
4487 && !EQ (XCAR (spec
), Qslice
)
4488 && !EQ (XCAR (spec
), Qspace_width
)
4489 && !EQ (XCAR (spec
), Qheight
)
4490 && !EQ (XCAR (spec
), Qraise
)
4491 /* Marginal area specifications. */
4492 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4493 && !EQ (XCAR (spec
), Qleft_fringe
)
4494 && !EQ (XCAR (spec
), Qright_fringe
)
4495 && !NILP (XCAR (spec
)))
4497 for (; CONSP (spec
); spec
= XCDR (spec
))
4499 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4500 overlay
, position
, bufpos
,
4501 replacing_p
, frame_window_p
)))
4504 /* If some text in a string is replaced, `position' no
4505 longer points to the position of `object'. */
4506 if (!it
|| STRINGP (object
))
4511 else if (VECTORP (spec
))
4514 for (i
= 0; i
< ASIZE (spec
); ++i
)
4515 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4516 overlay
, position
, bufpos
,
4517 replacing_p
, frame_window_p
)))
4520 /* If some text in a string is replaced, `position' no
4521 longer points to the position of `object'. */
4522 if (!it
|| STRINGP (object
))
4528 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4529 position
, bufpos
, 0,
4537 /* Value is the position of the end of the `display' property starting
4538 at START_POS in OBJECT. */
4540 static struct text_pos
4541 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4544 struct text_pos end_pos
;
4546 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4547 Qdisplay
, object
, Qnil
);
4548 CHARPOS (end_pos
) = XFASTINT (end
);
4549 if (STRINGP (object
))
4550 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4552 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4558 /* Set up IT from a single `display' property specification SPEC. OBJECT
4559 is the object in which the `display' property was found. *POSITION
4560 is the position in OBJECT at which the `display' property was found.
4561 BUFPOS is the buffer position of OBJECT (different from POSITION if
4562 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4563 previously saw a display specification which already replaced text
4564 display with something else, for example an image; we ignore such
4565 properties after the first one has been processed.
4567 OVERLAY is the overlay this `display' property came from,
4568 or nil if it was a text property.
4570 If SPEC is a `space' or `image' specification, and in some other
4571 cases too, set *POSITION to the position where the `display'
4574 If IT is NULL, only examine the property specification in SPEC, but
4575 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4576 is intended to be displayed in a window on a GUI frame.
4578 Value is non-zero if something was found which replaces the display
4579 of buffer or string text. */
4582 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4583 Lisp_Object overlay
, struct text_pos
*position
,
4584 ptrdiff_t bufpos
, int display_replaced_p
,
4588 Lisp_Object location
, value
;
4589 struct text_pos start_pos
= *position
;
4592 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4593 If the result is non-nil, use VALUE instead of SPEC. */
4595 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4604 if (!NILP (form
) && !EQ (form
, Qt
))
4606 ptrdiff_t count
= SPECPDL_INDEX ();
4607 struct gcpro gcpro1
;
4609 /* Bind `object' to the object having the `display' property, a
4610 buffer or string. Bind `position' to the position in the
4611 object where the property was found, and `buffer-position'
4612 to the current position in the buffer. */
4615 XSETBUFFER (object
, current_buffer
);
4616 specbind (Qobject
, object
);
4617 specbind (Qposition
, make_number (CHARPOS (*position
)));
4618 specbind (Qbuffer_position
, make_number (bufpos
));
4620 form
= safe_eval (form
);
4622 unbind_to (count
, Qnil
);
4628 /* Handle `(height HEIGHT)' specifications. */
4630 && EQ (XCAR (spec
), Qheight
)
4631 && CONSP (XCDR (spec
)))
4635 if (!FRAME_WINDOW_P (it
->f
))
4638 it
->font_height
= XCAR (XCDR (spec
));
4639 if (!NILP (it
->font_height
))
4641 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4642 int new_height
= -1;
4644 if (CONSP (it
->font_height
)
4645 && (EQ (XCAR (it
->font_height
), Qplus
)
4646 || EQ (XCAR (it
->font_height
), Qminus
))
4647 && CONSP (XCDR (it
->font_height
))
4648 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4650 /* `(+ N)' or `(- N)' where N is an integer. */
4651 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4652 if (EQ (XCAR (it
->font_height
), Qplus
))
4654 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4656 else if (FUNCTIONP (it
->font_height
))
4658 /* Call function with current height as argument.
4659 Value is the new height. */
4661 height
= safe_call1 (it
->font_height
,
4662 face
->lface
[LFACE_HEIGHT_INDEX
]);
4663 if (NUMBERP (height
))
4664 new_height
= XFLOATINT (height
);
4666 else if (NUMBERP (it
->font_height
))
4668 /* Value is a multiple of the canonical char height. */
4671 f
= FACE_FROM_ID (it
->f
,
4672 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4673 new_height
= (XFLOATINT (it
->font_height
)
4674 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4678 /* Evaluate IT->font_height with `height' bound to the
4679 current specified height to get the new height. */
4680 ptrdiff_t count
= SPECPDL_INDEX ();
4682 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4683 value
= safe_eval (it
->font_height
);
4684 unbind_to (count
, Qnil
);
4686 if (NUMBERP (value
))
4687 new_height
= XFLOATINT (value
);
4691 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4698 /* Handle `(space-width WIDTH)'. */
4700 && EQ (XCAR (spec
), Qspace_width
)
4701 && CONSP (XCDR (spec
)))
4705 if (!FRAME_WINDOW_P (it
->f
))
4708 value
= XCAR (XCDR (spec
));
4709 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4710 it
->space_width
= value
;
4716 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4718 && EQ (XCAR (spec
), Qslice
))
4724 if (!FRAME_WINDOW_P (it
->f
))
4727 if (tem
= XCDR (spec
), CONSP (tem
))
4729 it
->slice
.x
= XCAR (tem
);
4730 if (tem
= XCDR (tem
), CONSP (tem
))
4732 it
->slice
.y
= XCAR (tem
);
4733 if (tem
= XCDR (tem
), CONSP (tem
))
4735 it
->slice
.width
= XCAR (tem
);
4736 if (tem
= XCDR (tem
), CONSP (tem
))
4737 it
->slice
.height
= XCAR (tem
);
4746 /* Handle `(raise FACTOR)'. */
4748 && EQ (XCAR (spec
), Qraise
)
4749 && CONSP (XCDR (spec
)))
4753 if (!FRAME_WINDOW_P (it
->f
))
4756 #ifdef HAVE_WINDOW_SYSTEM
4757 value
= XCAR (XCDR (spec
));
4758 if (NUMBERP (value
))
4760 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4761 it
->voffset
= - (XFLOATINT (value
)
4762 * (FONT_HEIGHT (face
->font
)));
4764 #endif /* HAVE_WINDOW_SYSTEM */
4770 /* Don't handle the other kinds of display specifications
4771 inside a string that we got from a `display' property. */
4772 if (it
&& it
->string_from_display_prop_p
)
4775 /* Characters having this form of property are not displayed, so
4776 we have to find the end of the property. */
4779 start_pos
= *position
;
4780 *position
= display_prop_end (it
, object
, start_pos
);
4784 /* Stop the scan at that end position--we assume that all
4785 text properties change there. */
4787 it
->stop_charpos
= position
->charpos
;
4789 /* Handle `(left-fringe BITMAP [FACE])'
4790 and `(right-fringe BITMAP [FACE])'. */
4792 && (EQ (XCAR (spec
), Qleft_fringe
)
4793 || EQ (XCAR (spec
), Qright_fringe
))
4794 && CONSP (XCDR (spec
)))
4800 if (!FRAME_WINDOW_P (it
->f
))
4801 /* If we return here, POSITION has been advanced
4802 across the text with this property. */
4804 /* Synchronize the bidi iterator with POSITION. This is
4805 needed because we are not going to push the iterator
4806 on behalf of this display property, so there will be
4807 no pop_it call to do this synchronization for us. */
4810 it
->position
= *position
;
4811 iterate_out_of_display_property (it
);
4812 *position
= it
->position
;
4817 else if (!frame_window_p
)
4820 #ifdef HAVE_WINDOW_SYSTEM
4821 value
= XCAR (XCDR (spec
));
4822 if (!SYMBOLP (value
)
4823 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4824 /* If we return here, POSITION has been advanced
4825 across the text with this property. */
4827 if (it
&& it
->bidi_p
)
4829 it
->position
= *position
;
4830 iterate_out_of_display_property (it
);
4831 *position
= it
->position
;
4838 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4840 if (CONSP (XCDR (XCDR (spec
))))
4842 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4843 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4849 /* Save current settings of IT so that we can restore them
4850 when we are finished with the glyph property value. */
4851 push_it (it
, position
);
4853 it
->area
= TEXT_AREA
;
4854 it
->what
= IT_IMAGE
;
4855 it
->image_id
= -1; /* no image */
4856 it
->position
= start_pos
;
4857 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4858 it
->method
= GET_FROM_IMAGE
;
4859 it
->from_overlay
= Qnil
;
4860 it
->face_id
= face_id
;
4861 it
->from_disp_prop_p
= 1;
4863 /* Say that we haven't consumed the characters with
4864 `display' property yet. The call to pop_it in
4865 set_iterator_to_next will clean this up. */
4866 *position
= start_pos
;
4868 if (EQ (XCAR (spec
), Qleft_fringe
))
4870 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4871 it
->left_user_fringe_face_id
= face_id
;
4875 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4876 it
->right_user_fringe_face_id
= face_id
;
4879 #endif /* HAVE_WINDOW_SYSTEM */
4883 /* Prepare to handle `((margin left-margin) ...)',
4884 `((margin right-margin) ...)' and `((margin nil) ...)'
4885 prefixes for display specifications. */
4886 location
= Qunbound
;
4887 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4891 value
= XCDR (spec
);
4893 value
= XCAR (value
);
4896 if (EQ (XCAR (tem
), Qmargin
)
4897 && (tem
= XCDR (tem
),
4898 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4900 || EQ (tem
, Qleft_margin
)
4901 || EQ (tem
, Qright_margin
))))
4905 if (EQ (location
, Qunbound
))
4911 /* After this point, VALUE is the property after any
4912 margin prefix has been stripped. It must be a string,
4913 an image specification, or `(space ...)'.
4915 LOCATION specifies where to display: `left-margin',
4916 `right-margin' or nil. */
4918 valid_p
= (STRINGP (value
)
4919 #ifdef HAVE_WINDOW_SYSTEM
4920 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4921 && valid_image_p (value
))
4922 #endif /* not HAVE_WINDOW_SYSTEM */
4923 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4925 if (valid_p
&& !display_replaced_p
)
4931 /* Callers need to know whether the display spec is any kind
4932 of `(space ...)' spec that is about to affect text-area
4934 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4939 /* Save current settings of IT so that we can restore them
4940 when we are finished with the glyph property value. */
4941 push_it (it
, position
);
4942 it
->from_overlay
= overlay
;
4943 it
->from_disp_prop_p
= 1;
4945 if (NILP (location
))
4946 it
->area
= TEXT_AREA
;
4947 else if (EQ (location
, Qleft_margin
))
4948 it
->area
= LEFT_MARGIN_AREA
;
4950 it
->area
= RIGHT_MARGIN_AREA
;
4952 if (STRINGP (value
))
4955 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4956 it
->current
.overlay_string_index
= -1;
4957 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4958 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4959 it
->method
= GET_FROM_STRING
;
4960 it
->stop_charpos
= 0;
4962 it
->base_level_stop
= 0;
4963 it
->string_from_display_prop_p
= 1;
4964 /* Say that we haven't consumed the characters with
4965 `display' property yet. The call to pop_it in
4966 set_iterator_to_next will clean this up. */
4967 if (BUFFERP (object
))
4968 *position
= start_pos
;
4970 /* Force paragraph direction to be that of the parent
4971 object. If the parent object's paragraph direction is
4972 not yet determined, default to L2R. */
4973 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4974 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4976 it
->paragraph_embedding
= L2R
;
4978 /* Set up the bidi iterator for this display string. */
4981 it
->bidi_it
.string
.lstring
= it
->string
;
4982 it
->bidi_it
.string
.s
= NULL
;
4983 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4984 it
->bidi_it
.string
.bufpos
= bufpos
;
4985 it
->bidi_it
.string
.from_disp_str
= 1;
4986 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4987 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4990 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4992 it
->method
= GET_FROM_STRETCH
;
4994 *position
= it
->position
= start_pos
;
4995 retval
= 1 + (it
->area
== TEXT_AREA
);
4997 #ifdef HAVE_WINDOW_SYSTEM
5000 it
->what
= IT_IMAGE
;
5001 it
->image_id
= lookup_image (it
->f
, value
);
5002 it
->position
= start_pos
;
5003 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
5004 it
->method
= GET_FROM_IMAGE
;
5006 /* Say that we haven't consumed the characters with
5007 `display' property yet. The call to pop_it in
5008 set_iterator_to_next will clean this up. */
5009 *position
= start_pos
;
5011 #endif /* HAVE_WINDOW_SYSTEM */
5016 /* Invalid property or property not supported. Restore
5017 POSITION to what it was before. */
5018 *position
= start_pos
;
5022 /* Check if PROP is a display property value whose text should be
5023 treated as intangible. OVERLAY is the overlay from which PROP
5024 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5025 specify the buffer position covered by PROP. */
5028 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5029 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5031 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5032 struct text_pos position
;
5034 SET_TEXT_POS (position
, charpos
, bytepos
);
5035 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5036 &position
, charpos
, frame_window_p
);
5040 /* Return 1 if PROP is a display sub-property value containing STRING.
5042 Implementation note: this and the following function are really
5043 special cases of handle_display_spec and
5044 handle_single_display_spec, and should ideally use the same code.
5045 Until they do, these two pairs must be consistent and must be
5046 modified in sync. */
5049 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5051 if (EQ (string
, prop
))
5054 /* Skip over `when FORM'. */
5055 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5060 /* Actually, the condition following `when' should be eval'ed,
5061 like handle_single_display_spec does, and we should return
5062 zero if it evaluates to nil. However, this function is
5063 called only when the buffer was already displayed and some
5064 glyph in the glyph matrix was found to come from a display
5065 string. Therefore, the condition was already evaluated, and
5066 the result was non-nil, otherwise the display string wouldn't
5067 have been displayed and we would have never been called for
5068 this property. Thus, we can skip the evaluation and assume
5069 its result is non-nil. */
5074 /* Skip over `margin LOCATION'. */
5075 if (EQ (XCAR (prop
), Qmargin
))
5086 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5090 /* Return 1 if STRING appears in the `display' property PROP. */
5093 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5096 && !EQ (XCAR (prop
), Qwhen
)
5097 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5099 /* A list of sub-properties. */
5100 while (CONSP (prop
))
5102 if (single_display_spec_string_p (XCAR (prop
), string
))
5107 else if (VECTORP (prop
))
5109 /* A vector of sub-properties. */
5111 for (i
= 0; i
< ASIZE (prop
); ++i
)
5112 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5116 return single_display_spec_string_p (prop
, string
);
5121 /* Look for STRING in overlays and text properties in the current
5122 buffer, between character positions FROM and TO (excluding TO).
5123 BACK_P non-zero means look back (in this case, TO is supposed to be
5125 Value is the first character position where STRING was found, or
5126 zero if it wasn't found before hitting TO.
5128 This function may only use code that doesn't eval because it is
5129 called asynchronously from note_mouse_highlight. */
5132 string_buffer_position_lim (Lisp_Object string
,
5133 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5135 Lisp_Object limit
, prop
, pos
;
5138 pos
= make_number (max (from
, BEGV
));
5140 if (!back_p
) /* looking forward */
5142 limit
= make_number (min (to
, ZV
));
5143 while (!found
&& !EQ (pos
, limit
))
5145 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5146 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5149 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5153 else /* looking back */
5155 limit
= make_number (max (to
, BEGV
));
5156 while (!found
&& !EQ (pos
, limit
))
5158 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5159 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5162 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5167 return found
? XINT (pos
) : 0;
5170 /* Determine which buffer position in current buffer STRING comes from.
5171 AROUND_CHARPOS is an approximate position where it could come from.
5172 Value is the buffer position or 0 if it couldn't be determined.
5174 This function is necessary because we don't record buffer positions
5175 in glyphs generated from strings (to keep struct glyph small).
5176 This function may only use code that doesn't eval because it is
5177 called asynchronously from note_mouse_highlight. */
5180 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5182 const int MAX_DISTANCE
= 1000;
5183 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5184 around_charpos
+ MAX_DISTANCE
,
5188 found
= string_buffer_position_lim (string
, around_charpos
,
5189 around_charpos
- MAX_DISTANCE
, 1);
5195 /***********************************************************************
5196 `composition' property
5197 ***********************************************************************/
5199 /* Set up iterator IT from `composition' property at its current
5200 position. Called from handle_stop. */
5202 static enum prop_handled
5203 handle_composition_prop (struct it
*it
)
5205 Lisp_Object prop
, string
;
5206 ptrdiff_t pos
, pos_byte
, start
, end
;
5208 if (STRINGP (it
->string
))
5212 pos
= IT_STRING_CHARPOS (*it
);
5213 pos_byte
= IT_STRING_BYTEPOS (*it
);
5214 string
= it
->string
;
5215 s
= SDATA (string
) + pos_byte
;
5216 it
->c
= STRING_CHAR (s
);
5220 pos
= IT_CHARPOS (*it
);
5221 pos_byte
= IT_BYTEPOS (*it
);
5223 it
->c
= FETCH_CHAR (pos_byte
);
5226 /* If there's a valid composition and point is not inside of the
5227 composition (in the case that the composition is from the current
5228 buffer), draw a glyph composed from the composition components. */
5229 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5230 && COMPOSITION_VALID_P (start
, end
, prop
)
5231 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5234 /* As we can't handle this situation (perhaps font-lock added
5235 a new composition), we just return here hoping that next
5236 redisplay will detect this composition much earlier. */
5237 return HANDLED_NORMALLY
;
5240 if (STRINGP (it
->string
))
5241 pos_byte
= string_char_to_byte (it
->string
, start
);
5243 pos_byte
= CHAR_TO_BYTE (start
);
5245 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5248 if (it
->cmp_it
.id
>= 0)
5251 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5252 it
->cmp_it
.nglyphs
= -1;
5256 return HANDLED_NORMALLY
;
5261 /***********************************************************************
5263 ***********************************************************************/
5265 /* The following structure is used to record overlay strings for
5266 later sorting in load_overlay_strings. */
5268 struct overlay_entry
5270 Lisp_Object overlay
;
5277 /* Set up iterator IT from overlay strings at its current position.
5278 Called from handle_stop. */
5280 static enum prop_handled
5281 handle_overlay_change (struct it
*it
)
5283 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5284 return HANDLED_RECOMPUTE_PROPS
;
5286 return HANDLED_NORMALLY
;
5290 /* Set up the next overlay string for delivery by IT, if there is an
5291 overlay string to deliver. Called by set_iterator_to_next when the
5292 end of the current overlay string is reached. If there are more
5293 overlay strings to display, IT->string and
5294 IT->current.overlay_string_index are set appropriately here.
5295 Otherwise IT->string is set to nil. */
5298 next_overlay_string (struct it
*it
)
5300 ++it
->current
.overlay_string_index
;
5301 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5303 /* No more overlay strings. Restore IT's settings to what
5304 they were before overlay strings were processed, and
5305 continue to deliver from current_buffer. */
5307 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5310 || (NILP (it
->string
)
5311 && it
->method
== GET_FROM_BUFFER
5312 && it
->stop_charpos
>= BEGV
5313 && it
->stop_charpos
<= it
->end_charpos
));
5314 it
->current
.overlay_string_index
= -1;
5315 it
->n_overlay_strings
= 0;
5316 it
->overlay_strings_charpos
= -1;
5317 /* If there's an empty display string on the stack, pop the
5318 stack, to resync the bidi iterator with IT's position. Such
5319 empty strings are pushed onto the stack in
5320 get_overlay_strings_1. */
5321 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5324 /* If we're at the end of the buffer, record that we have
5325 processed the overlay strings there already, so that
5326 next_element_from_buffer doesn't try it again. */
5327 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5328 it
->overlay_strings_at_end_processed_p
= 1;
5332 /* There are more overlay strings to process. If
5333 IT->current.overlay_string_index has advanced to a position
5334 where we must load IT->overlay_strings with more strings, do
5335 it. We must load at the IT->overlay_strings_charpos where
5336 IT->n_overlay_strings was originally computed; when invisible
5337 text is present, this might not be IT_CHARPOS (Bug#7016). */
5338 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5340 if (it
->current
.overlay_string_index
&& i
== 0)
5341 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5343 /* Initialize IT to deliver display elements from the overlay
5345 it
->string
= it
->overlay_strings
[i
];
5346 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5347 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5348 it
->method
= GET_FROM_STRING
;
5349 it
->stop_charpos
= 0;
5350 if (it
->cmp_it
.stop_pos
>= 0)
5351 it
->cmp_it
.stop_pos
= 0;
5353 it
->base_level_stop
= 0;
5355 /* Set up the bidi iterator for this overlay string. */
5358 it
->bidi_it
.string
.lstring
= it
->string
;
5359 it
->bidi_it
.string
.s
= NULL
;
5360 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5361 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5362 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5363 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5364 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5372 /* Compare two overlay_entry structures E1 and E2. Used as a
5373 comparison function for qsort in load_overlay_strings. Overlay
5374 strings for the same position are sorted so that
5376 1. All after-strings come in front of before-strings, except
5377 when they come from the same overlay.
5379 2. Within after-strings, strings are sorted so that overlay strings
5380 from overlays with higher priorities come first.
5382 2. Within before-strings, strings are sorted so that overlay
5383 strings from overlays with higher priorities come last.
5385 Value is analogous to strcmp. */
5389 compare_overlay_entries (const void *e1
, const void *e2
)
5391 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5392 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5395 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5397 /* Let after-strings appear in front of before-strings if
5398 they come from different overlays. */
5399 if (EQ (entry1
->overlay
, entry2
->overlay
))
5400 result
= entry1
->after_string_p
? 1 : -1;
5402 result
= entry1
->after_string_p
? -1 : 1;
5404 else if (entry1
->priority
!= entry2
->priority
)
5406 if (entry1
->after_string_p
)
5407 /* After-strings sorted in order of decreasing priority. */
5408 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5410 /* Before-strings sorted in order of increasing priority. */
5411 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5420 /* Load the vector IT->overlay_strings with overlay strings from IT's
5421 current buffer position, or from CHARPOS if that is > 0. Set
5422 IT->n_overlays to the total number of overlay strings found.
5424 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5425 a time. On entry into load_overlay_strings,
5426 IT->current.overlay_string_index gives the number of overlay
5427 strings that have already been loaded by previous calls to this
5430 IT->add_overlay_start contains an additional overlay start
5431 position to consider for taking overlay strings from, if non-zero.
5432 This position comes into play when the overlay has an `invisible'
5433 property, and both before and after-strings. When we've skipped to
5434 the end of the overlay, because of its `invisible' property, we
5435 nevertheless want its before-string to appear.
5436 IT->add_overlay_start will contain the overlay start position
5439 Overlay strings are sorted so that after-string strings come in
5440 front of before-string strings. Within before and after-strings,
5441 strings are sorted by overlay priority. See also function
5442 compare_overlay_entries. */
5445 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5447 Lisp_Object overlay
, window
, str
, invisible
;
5448 struct Lisp_Overlay
*ov
;
5449 ptrdiff_t start
, end
;
5450 ptrdiff_t size
= 20;
5451 ptrdiff_t n
= 0, i
, j
;
5453 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5457 charpos
= IT_CHARPOS (*it
);
5459 /* Append the overlay string STRING of overlay OVERLAY to vector
5460 `entries' which has size `size' and currently contains `n'
5461 elements. AFTER_P non-zero means STRING is an after-string of
5463 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5466 Lisp_Object priority; \
5470 struct overlay_entry *old = entries; \
5471 SAFE_NALLOCA (entries, 2, size); \
5472 memcpy (entries, old, size * sizeof *entries); \
5476 entries[n].string = (STRING); \
5477 entries[n].overlay = (OVERLAY); \
5478 priority = Foverlay_get ((OVERLAY), Qpriority); \
5479 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5480 entries[n].after_string_p = (AFTER_P); \
5485 /* Process overlay before the overlay center. */
5486 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5488 XSETMISC (overlay
, ov
);
5489 eassert (OVERLAYP (overlay
));
5490 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5491 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5496 /* Skip this overlay if it doesn't start or end at IT's current
5498 if (end
!= charpos
&& start
!= charpos
)
5501 /* Skip this overlay if it doesn't apply to IT->w. */
5502 window
= Foverlay_get (overlay
, Qwindow
);
5503 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5506 /* If the text ``under'' the overlay is invisible, both before-
5507 and after-strings from this overlay are visible; start and
5508 end position are indistinguishable. */
5509 invisible
= Foverlay_get (overlay
, Qinvisible
);
5510 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5512 /* If overlay has a non-empty before-string, record it. */
5513 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5514 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5516 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5518 /* If overlay has a non-empty after-string, record it. */
5519 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5520 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5522 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5525 /* Process overlays after the overlay center. */
5526 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5528 XSETMISC (overlay
, ov
);
5529 eassert (OVERLAYP (overlay
));
5530 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5531 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5533 if (start
> charpos
)
5536 /* Skip this overlay if it doesn't start or end at IT's current
5538 if (end
!= charpos
&& start
!= charpos
)
5541 /* Skip this overlay if it doesn't apply to IT->w. */
5542 window
= Foverlay_get (overlay
, Qwindow
);
5543 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5546 /* If the text ``under'' the overlay is invisible, it has a zero
5547 dimension, and both before- and after-strings apply. */
5548 invisible
= Foverlay_get (overlay
, Qinvisible
);
5549 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5551 /* If overlay has a non-empty before-string, record it. */
5552 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5553 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5555 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5557 /* If overlay has a non-empty after-string, record it. */
5558 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5559 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5561 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5564 #undef RECORD_OVERLAY_STRING
5568 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5570 /* Record number of overlay strings, and where we computed it. */
5571 it
->n_overlay_strings
= n
;
5572 it
->overlay_strings_charpos
= charpos
;
5574 /* IT->current.overlay_string_index is the number of overlay strings
5575 that have already been consumed by IT. Copy some of the
5576 remaining overlay strings to IT->overlay_strings. */
5578 j
= it
->current
.overlay_string_index
;
5579 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5581 it
->overlay_strings
[i
] = entries
[j
].string
;
5582 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5590 /* Get the first chunk of overlay strings at IT's current buffer
5591 position, or at CHARPOS if that is > 0. Value is non-zero if at
5592 least one overlay string was found. */
5595 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5597 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5598 process. This fills IT->overlay_strings with strings, and sets
5599 IT->n_overlay_strings to the total number of strings to process.
5600 IT->pos.overlay_string_index has to be set temporarily to zero
5601 because load_overlay_strings needs this; it must be set to -1
5602 when no overlay strings are found because a zero value would
5603 indicate a position in the first overlay string. */
5604 it
->current
.overlay_string_index
= 0;
5605 load_overlay_strings (it
, charpos
);
5607 /* If we found overlay strings, set up IT to deliver display
5608 elements from the first one. Otherwise set up IT to deliver
5609 from current_buffer. */
5610 if (it
->n_overlay_strings
)
5612 /* Make sure we know settings in current_buffer, so that we can
5613 restore meaningful values when we're done with the overlay
5616 compute_stop_pos (it
);
5617 eassert (it
->face_id
>= 0);
5619 /* Save IT's settings. They are restored after all overlay
5620 strings have been processed. */
5621 eassert (!compute_stop_p
|| it
->sp
== 0);
5623 /* When called from handle_stop, there might be an empty display
5624 string loaded. In that case, don't bother saving it. But
5625 don't use this optimization with the bidi iterator, since we
5626 need the corresponding pop_it call to resync the bidi
5627 iterator's position with IT's position, after we are done
5628 with the overlay strings. (The corresponding call to pop_it
5629 in case of an empty display string is in
5630 next_overlay_string.) */
5632 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5635 /* Set up IT to deliver display elements from the first overlay
5637 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5638 it
->string
= it
->overlay_strings
[0];
5639 it
->from_overlay
= Qnil
;
5640 it
->stop_charpos
= 0;
5641 eassert (STRINGP (it
->string
));
5642 it
->end_charpos
= SCHARS (it
->string
);
5644 it
->base_level_stop
= 0;
5645 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5646 it
->method
= GET_FROM_STRING
;
5647 it
->from_disp_prop_p
= 0;
5649 /* Force paragraph direction to be that of the parent
5651 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5652 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5654 it
->paragraph_embedding
= L2R
;
5656 /* Set up the bidi iterator for this overlay string. */
5659 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5661 it
->bidi_it
.string
.lstring
= it
->string
;
5662 it
->bidi_it
.string
.s
= NULL
;
5663 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5664 it
->bidi_it
.string
.bufpos
= pos
;
5665 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5666 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5667 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5672 it
->current
.overlay_string_index
= -1;
5677 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5680 it
->method
= GET_FROM_BUFFER
;
5682 (void) get_overlay_strings_1 (it
, charpos
, 1);
5686 /* Value is non-zero if we found at least one overlay string. */
5687 return STRINGP (it
->string
);
5692 /***********************************************************************
5693 Saving and restoring state
5694 ***********************************************************************/
5696 /* Save current settings of IT on IT->stack. Called, for example,
5697 before setting up IT for an overlay string, to be able to restore
5698 IT's settings to what they were after the overlay string has been
5699 processed. If POSITION is non-NULL, it is the position to save on
5700 the stack instead of IT->position. */
5703 push_it (struct it
*it
, struct text_pos
*position
)
5705 struct iterator_stack_entry
*p
;
5707 eassert (it
->sp
< IT_STACK_SIZE
);
5708 p
= it
->stack
+ it
->sp
;
5710 p
->stop_charpos
= it
->stop_charpos
;
5711 p
->prev_stop
= it
->prev_stop
;
5712 p
->base_level_stop
= it
->base_level_stop
;
5713 p
->cmp_it
= it
->cmp_it
;
5714 eassert (it
->face_id
>= 0);
5715 p
->face_id
= it
->face_id
;
5716 p
->string
= it
->string
;
5717 p
->method
= it
->method
;
5718 p
->from_overlay
= it
->from_overlay
;
5721 case GET_FROM_IMAGE
:
5722 p
->u
.image
.object
= it
->object
;
5723 p
->u
.image
.image_id
= it
->image_id
;
5724 p
->u
.image
.slice
= it
->slice
;
5726 case GET_FROM_STRETCH
:
5727 p
->u
.stretch
.object
= it
->object
;
5730 p
->position
= position
? *position
: it
->position
;
5731 p
->current
= it
->current
;
5732 p
->end_charpos
= it
->end_charpos
;
5733 p
->string_nchars
= it
->string_nchars
;
5735 p
->multibyte_p
= it
->multibyte_p
;
5736 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5737 p
->space_width
= it
->space_width
;
5738 p
->font_height
= it
->font_height
;
5739 p
->voffset
= it
->voffset
;
5740 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5741 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5742 p
->display_ellipsis_p
= 0;
5743 p
->line_wrap
= it
->line_wrap
;
5744 p
->bidi_p
= it
->bidi_p
;
5745 p
->paragraph_embedding
= it
->paragraph_embedding
;
5746 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5749 /* Save the state of the bidi iterator as well. */
5751 bidi_push_it (&it
->bidi_it
);
5755 iterate_out_of_display_property (struct it
*it
)
5757 int buffer_p
= !STRINGP (it
->string
);
5758 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5759 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5761 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5763 /* Maybe initialize paragraph direction. If we are at the beginning
5764 of a new paragraph, next_element_from_buffer may not have a
5765 chance to do that. */
5766 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5767 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5768 /* prev_stop can be zero, so check against BEGV as well. */
5769 while (it
->bidi_it
.charpos
>= bob
5770 && it
->prev_stop
<= it
->bidi_it
.charpos
5771 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5772 && it
->bidi_it
.charpos
< eob
)
5773 bidi_move_to_visually_next (&it
->bidi_it
);
5774 /* Record the stop_pos we just crossed, for when we cross it
5776 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5777 it
->prev_stop
= CHARPOS (it
->position
);
5778 /* If we ended up not where pop_it put us, resync IT's
5779 positional members with the bidi iterator. */
5780 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5781 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5783 it
->current
.pos
= it
->position
;
5785 it
->current
.string_pos
= it
->position
;
5788 /* Restore IT's settings from IT->stack. Called, for example, when no
5789 more overlay strings must be processed, and we return to delivering
5790 display elements from a buffer, or when the end of a string from a
5791 `display' property is reached and we return to delivering display
5792 elements from an overlay string, or from a buffer. */
5795 pop_it (struct it
*it
)
5797 struct iterator_stack_entry
*p
;
5798 int from_display_prop
= it
->from_disp_prop_p
;
5800 eassert (it
->sp
> 0);
5802 p
= it
->stack
+ it
->sp
;
5803 it
->stop_charpos
= p
->stop_charpos
;
5804 it
->prev_stop
= p
->prev_stop
;
5805 it
->base_level_stop
= p
->base_level_stop
;
5806 it
->cmp_it
= p
->cmp_it
;
5807 it
->face_id
= p
->face_id
;
5808 it
->current
= p
->current
;
5809 it
->position
= p
->position
;
5810 it
->string
= p
->string
;
5811 it
->from_overlay
= p
->from_overlay
;
5812 if (NILP (it
->string
))
5813 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5814 it
->method
= p
->method
;
5817 case GET_FROM_IMAGE
:
5818 it
->image_id
= p
->u
.image
.image_id
;
5819 it
->object
= p
->u
.image
.object
;
5820 it
->slice
= p
->u
.image
.slice
;
5822 case GET_FROM_STRETCH
:
5823 it
->object
= p
->u
.stretch
.object
;
5825 case GET_FROM_BUFFER
:
5826 it
->object
= it
->w
->buffer
;
5828 case GET_FROM_STRING
:
5829 it
->object
= it
->string
;
5831 case GET_FROM_DISPLAY_VECTOR
:
5833 it
->method
= GET_FROM_C_STRING
;
5834 else if (STRINGP (it
->string
))
5835 it
->method
= GET_FROM_STRING
;
5838 it
->method
= GET_FROM_BUFFER
;
5839 it
->object
= it
->w
->buffer
;
5842 it
->end_charpos
= p
->end_charpos
;
5843 it
->string_nchars
= p
->string_nchars
;
5845 it
->multibyte_p
= p
->multibyte_p
;
5846 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5847 it
->space_width
= p
->space_width
;
5848 it
->font_height
= p
->font_height
;
5849 it
->voffset
= p
->voffset
;
5850 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5851 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5852 it
->line_wrap
= p
->line_wrap
;
5853 it
->bidi_p
= p
->bidi_p
;
5854 it
->paragraph_embedding
= p
->paragraph_embedding
;
5855 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5858 bidi_pop_it (&it
->bidi_it
);
5859 /* Bidi-iterate until we get out of the portion of text, if any,
5860 covered by a `display' text property or by an overlay with
5861 `display' property. (We cannot just jump there, because the
5862 internal coherency of the bidi iterator state can not be
5863 preserved across such jumps.) We also must determine the
5864 paragraph base direction if the overlay we just processed is
5865 at the beginning of a new paragraph. */
5866 if (from_display_prop
5867 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5868 iterate_out_of_display_property (it
);
5870 eassert ((BUFFERP (it
->object
)
5871 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5872 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5873 || (STRINGP (it
->object
)
5874 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5875 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5876 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5882 /***********************************************************************
5884 ***********************************************************************/
5886 /* Set IT's current position to the previous line start. */
5889 back_to_previous_line_start (struct it
*it
)
5891 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5892 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5896 /* Move IT to the next line start.
5898 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5899 we skipped over part of the text (as opposed to moving the iterator
5900 continuously over the text). Otherwise, don't change the value
5903 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5904 iterator on the newline, if it was found.
5906 Newlines may come from buffer text, overlay strings, or strings
5907 displayed via the `display' property. That's the reason we can't
5908 simply use find_next_newline_no_quit.
5910 Note that this function may not skip over invisible text that is so
5911 because of text properties and immediately follows a newline. If
5912 it would, function reseat_at_next_visible_line_start, when called
5913 from set_iterator_to_next, would effectively make invisible
5914 characters following a newline part of the wrong glyph row, which
5915 leads to wrong cursor motion. */
5918 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5919 struct bidi_it
*bidi_it_prev
)
5921 ptrdiff_t old_selective
;
5922 int newline_found_p
, n
;
5923 const int MAX_NEWLINE_DISTANCE
= 500;
5925 /* If already on a newline, just consume it to avoid unintended
5926 skipping over invisible text below. */
5927 if (it
->what
== IT_CHARACTER
5929 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5931 if (it
->bidi_p
&& bidi_it_prev
)
5932 *bidi_it_prev
= it
->bidi_it
;
5933 set_iterator_to_next (it
, 0);
5938 /* Don't handle selective display in the following. It's (a)
5939 unnecessary because it's done by the caller, and (b) leads to an
5940 infinite recursion because next_element_from_ellipsis indirectly
5941 calls this function. */
5942 old_selective
= it
->selective
;
5945 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5946 from buffer text. */
5947 for (n
= newline_found_p
= 0;
5948 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5949 n
+= STRINGP (it
->string
) ? 0 : 1)
5951 if (!get_next_display_element (it
))
5953 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5954 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5955 *bidi_it_prev
= it
->bidi_it
;
5956 set_iterator_to_next (it
, 0);
5959 /* If we didn't find a newline near enough, see if we can use a
5961 if (!newline_found_p
)
5963 ptrdiff_t start
= IT_CHARPOS (*it
);
5964 ptrdiff_t limit
= find_next_newline_no_quit (start
, 1);
5967 eassert (!STRINGP (it
->string
));
5969 /* If there isn't any `display' property in sight, and no
5970 overlays, we can just use the position of the newline in
5972 if (it
->stop_charpos
>= limit
5973 || ((pos
= Fnext_single_property_change (make_number (start
),
5975 make_number (limit
)),
5977 && next_overlay_change (start
) == ZV
))
5981 IT_CHARPOS (*it
) = limit
;
5982 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5986 struct bidi_it bprev
;
5988 /* Help bidi.c avoid expensive searches for display
5989 properties and overlays, by telling it that there are
5990 none up to `limit'. */
5991 if (it
->bidi_it
.disp_pos
< limit
)
5993 it
->bidi_it
.disp_pos
= limit
;
5994 it
->bidi_it
.disp_prop
= 0;
5997 bprev
= it
->bidi_it
;
5998 bidi_move_to_visually_next (&it
->bidi_it
);
5999 } while (it
->bidi_it
.charpos
!= limit
);
6000 IT_CHARPOS (*it
) = limit
;
6001 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6003 *bidi_it_prev
= bprev
;
6005 *skipped_p
= newline_found_p
= 1;
6009 while (get_next_display_element (it
)
6010 && !newline_found_p
)
6012 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6013 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6014 *bidi_it_prev
= it
->bidi_it
;
6015 set_iterator_to_next (it
, 0);
6020 it
->selective
= old_selective
;
6021 return newline_found_p
;
6025 /* Set IT's current position to the previous visible line start. Skip
6026 invisible text that is so either due to text properties or due to
6027 selective display. Caution: this does not change IT->current_x and
6031 back_to_previous_visible_line_start (struct it
*it
)
6033 while (IT_CHARPOS (*it
) > BEGV
)
6035 back_to_previous_line_start (it
);
6037 if (IT_CHARPOS (*it
) <= BEGV
)
6040 /* If selective > 0, then lines indented more than its value are
6042 if (it
->selective
> 0
6043 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6047 /* Check the newline before point for invisibility. */
6050 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6051 Qinvisible
, it
->window
);
6052 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6056 if (IT_CHARPOS (*it
) <= BEGV
)
6061 void *it2data
= NULL
;
6064 Lisp_Object val
, overlay
;
6066 SAVE_IT (it2
, *it
, it2data
);
6068 /* If newline is part of a composition, continue from start of composition */
6069 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6070 && beg
< IT_CHARPOS (*it
))
6073 /* If newline is replaced by a display property, find start of overlay
6074 or interval and continue search from that point. */
6075 pos
= --IT_CHARPOS (it2
);
6078 bidi_unshelve_cache (NULL
, 0);
6079 it2
.string_from_display_prop_p
= 0;
6080 it2
.from_disp_prop_p
= 0;
6081 if (handle_display_prop (&it2
) == HANDLED_RETURN
6082 && !NILP (val
= get_char_property_and_overlay
6083 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6084 && (OVERLAYP (overlay
)
6085 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6086 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6088 RESTORE_IT (it
, it
, it2data
);
6092 /* Newline is not replaced by anything -- so we are done. */
6093 RESTORE_IT (it
, it
, it2data
);
6099 IT_CHARPOS (*it
) = beg
;
6100 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6104 it
->continuation_lines_width
= 0;
6106 eassert (IT_CHARPOS (*it
) >= BEGV
);
6107 eassert (IT_CHARPOS (*it
) == BEGV
6108 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6113 /* Reseat iterator IT at the previous visible line start. Skip
6114 invisible text that is so either due to text properties or due to
6115 selective display. At the end, update IT's overlay information,
6116 face information etc. */
6119 reseat_at_previous_visible_line_start (struct it
*it
)
6121 back_to_previous_visible_line_start (it
);
6122 reseat (it
, it
->current
.pos
, 1);
6127 /* Reseat iterator IT on the next visible line start in the current
6128 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6129 preceding the line start. Skip over invisible text that is so
6130 because of selective display. Compute faces, overlays etc at the
6131 new position. Note that this function does not skip over text that
6132 is invisible because of text properties. */
6135 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6137 int newline_found_p
, skipped_p
= 0;
6138 struct bidi_it bidi_it_prev
;
6140 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6142 /* Skip over lines that are invisible because they are indented
6143 more than the value of IT->selective. */
6144 if (it
->selective
> 0)
6145 while (IT_CHARPOS (*it
) < ZV
6146 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6149 eassert (IT_BYTEPOS (*it
) == BEGV
6150 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6152 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6155 /* Position on the newline if that's what's requested. */
6156 if (on_newline_p
&& newline_found_p
)
6158 if (STRINGP (it
->string
))
6160 if (IT_STRING_CHARPOS (*it
) > 0)
6164 --IT_STRING_CHARPOS (*it
);
6165 --IT_STRING_BYTEPOS (*it
);
6169 /* We need to restore the bidi iterator to the state
6170 it had on the newline, and resync the IT's
6171 position with that. */
6172 it
->bidi_it
= bidi_it_prev
;
6173 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6174 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6178 else if (IT_CHARPOS (*it
) > BEGV
)
6187 /* We need to restore the bidi iterator to the state it
6188 had on the newline and resync IT with that. */
6189 it
->bidi_it
= bidi_it_prev
;
6190 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6191 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6193 reseat (it
, it
->current
.pos
, 0);
6197 reseat (it
, it
->current
.pos
, 0);
6204 /***********************************************************************
6205 Changing an iterator's position
6206 ***********************************************************************/
6208 /* Change IT's current position to POS in current_buffer. If FORCE_P
6209 is non-zero, always check for text properties at the new position.
6210 Otherwise, text properties are only looked up if POS >=
6211 IT->check_charpos of a property. */
6214 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6216 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6218 reseat_1 (it
, pos
, 0);
6220 /* Determine where to check text properties. Avoid doing it
6221 where possible because text property lookup is very expensive. */
6223 || CHARPOS (pos
) > it
->stop_charpos
6224 || CHARPOS (pos
) < original_pos
)
6228 /* For bidi iteration, we need to prime prev_stop and
6229 base_level_stop with our best estimations. */
6230 /* Implementation note: Of course, POS is not necessarily a
6231 stop position, so assigning prev_pos to it is a lie; we
6232 should have called compute_stop_backwards. However, if
6233 the current buffer does not include any R2L characters,
6234 that call would be a waste of cycles, because the
6235 iterator will never move back, and thus never cross this
6236 "fake" stop position. So we delay that backward search
6237 until the time we really need it, in next_element_from_buffer. */
6238 if (CHARPOS (pos
) != it
->prev_stop
)
6239 it
->prev_stop
= CHARPOS (pos
);
6240 if (CHARPOS (pos
) < it
->base_level_stop
)
6241 it
->base_level_stop
= 0; /* meaning it's unknown */
6247 it
->prev_stop
= it
->base_level_stop
= 0;
6256 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6257 IT->stop_pos to POS, also. */
6260 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6262 /* Don't call this function when scanning a C string. */
6263 eassert (it
->s
== NULL
);
6265 /* POS must be a reasonable value. */
6266 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6268 it
->current
.pos
= it
->position
= pos
;
6269 it
->end_charpos
= ZV
;
6271 it
->current
.dpvec_index
= -1;
6272 it
->current
.overlay_string_index
= -1;
6273 IT_STRING_CHARPOS (*it
) = -1;
6274 IT_STRING_BYTEPOS (*it
) = -1;
6276 it
->method
= GET_FROM_BUFFER
;
6277 it
->object
= it
->w
->buffer
;
6278 it
->area
= TEXT_AREA
;
6279 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6281 it
->string_from_display_prop_p
= 0;
6282 it
->string_from_prefix_prop_p
= 0;
6284 it
->from_disp_prop_p
= 0;
6285 it
->face_before_selective_p
= 0;
6288 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6290 bidi_unshelve_cache (NULL
, 0);
6291 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6292 it
->bidi_it
.string
.s
= NULL
;
6293 it
->bidi_it
.string
.lstring
= Qnil
;
6294 it
->bidi_it
.string
.bufpos
= 0;
6295 it
->bidi_it
.string
.unibyte
= 0;
6300 it
->stop_charpos
= CHARPOS (pos
);
6301 it
->base_level_stop
= CHARPOS (pos
);
6306 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6307 If S is non-null, it is a C string to iterate over. Otherwise,
6308 STRING gives a Lisp string to iterate over.
6310 If PRECISION > 0, don't return more then PRECISION number of
6311 characters from the string.
6313 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6314 characters have been returned. FIELD_WIDTH < 0 means an infinite
6317 MULTIBYTE = 0 means disable processing of multibyte characters,
6318 MULTIBYTE > 0 means enable it,
6319 MULTIBYTE < 0 means use IT->multibyte_p.
6321 IT must be initialized via a prior call to init_iterator before
6322 calling this function. */
6325 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6326 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6329 /* No region in strings. */
6330 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6332 /* No text property checks performed by default, but see below. */
6333 it
->stop_charpos
= -1;
6335 /* Set iterator position and end position. */
6336 memset (&it
->current
, 0, sizeof it
->current
);
6337 it
->current
.overlay_string_index
= -1;
6338 it
->current
.dpvec_index
= -1;
6339 eassert (charpos
>= 0);
6341 /* If STRING is specified, use its multibyteness, otherwise use the
6342 setting of MULTIBYTE, if specified. */
6344 it
->multibyte_p
= multibyte
> 0;
6346 /* Bidirectional reordering of strings is controlled by the default
6347 value of bidi-display-reordering. Don't try to reorder while
6348 loading loadup.el, as the necessary character property tables are
6349 not yet available. */
6352 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6356 eassert (STRINGP (string
));
6357 it
->string
= string
;
6359 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6360 it
->method
= GET_FROM_STRING
;
6361 it
->current
.string_pos
= string_pos (charpos
, string
);
6365 it
->bidi_it
.string
.lstring
= string
;
6366 it
->bidi_it
.string
.s
= NULL
;
6367 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6368 it
->bidi_it
.string
.bufpos
= 0;
6369 it
->bidi_it
.string
.from_disp_str
= 0;
6370 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6371 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6372 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6377 it
->s
= (const unsigned char *) s
;
6380 /* Note that we use IT->current.pos, not it->current.string_pos,
6381 for displaying C strings. */
6382 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6383 if (it
->multibyte_p
)
6385 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6386 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6390 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6391 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6396 it
->bidi_it
.string
.lstring
= Qnil
;
6397 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6398 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6399 it
->bidi_it
.string
.bufpos
= 0;
6400 it
->bidi_it
.string
.from_disp_str
= 0;
6401 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6402 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6405 it
->method
= GET_FROM_C_STRING
;
6408 /* PRECISION > 0 means don't return more than PRECISION characters
6410 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6412 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6414 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6417 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6418 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6419 FIELD_WIDTH < 0 means infinite field width. This is useful for
6420 padding with `-' at the end of a mode line. */
6421 if (field_width
< 0)
6422 field_width
= INFINITY
;
6423 /* Implementation note: We deliberately don't enlarge
6424 it->bidi_it.string.schars here to fit it->end_charpos, because
6425 the bidi iterator cannot produce characters out of thin air. */
6426 if (field_width
> it
->end_charpos
- charpos
)
6427 it
->end_charpos
= charpos
+ field_width
;
6429 /* Use the standard display table for displaying strings. */
6430 if (DISP_TABLE_P (Vstandard_display_table
))
6431 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6433 it
->stop_charpos
= charpos
;
6434 it
->prev_stop
= charpos
;
6435 it
->base_level_stop
= 0;
6438 it
->bidi_it
.first_elt
= 1;
6439 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6440 it
->bidi_it
.disp_pos
= -1;
6442 if (s
== NULL
&& it
->multibyte_p
)
6444 ptrdiff_t endpos
= SCHARS (it
->string
);
6445 if (endpos
> it
->end_charpos
)
6446 endpos
= it
->end_charpos
;
6447 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6455 /***********************************************************************
6457 ***********************************************************************/
6459 /* Map enum it_method value to corresponding next_element_from_* function. */
6461 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6463 next_element_from_buffer
,
6464 next_element_from_display_vector
,
6465 next_element_from_string
,
6466 next_element_from_c_string
,
6467 next_element_from_image
,
6468 next_element_from_stretch
6471 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6474 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6475 (possibly with the following characters). */
6477 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6478 ((IT)->cmp_it.id >= 0 \
6479 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6480 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6481 END_CHARPOS, (IT)->w, \
6482 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6486 /* Lookup the char-table Vglyphless_char_display for character C (-1
6487 if we want information for no-font case), and return the display
6488 method symbol. By side-effect, update it->what and
6489 it->glyphless_method. This function is called from
6490 get_next_display_element for each character element, and from
6491 x_produce_glyphs when no suitable font was found. */
6494 lookup_glyphless_char_display (int c
, struct it
*it
)
6496 Lisp_Object glyphless_method
= Qnil
;
6498 if (CHAR_TABLE_P (Vglyphless_char_display
)
6499 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6503 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6504 if (CONSP (glyphless_method
))
6505 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6506 ? XCAR (glyphless_method
)
6507 : XCDR (glyphless_method
);
6510 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6514 if (NILP (glyphless_method
))
6517 /* The default is to display the character by a proper font. */
6519 /* The default for the no-font case is to display an empty box. */
6520 glyphless_method
= Qempty_box
;
6522 if (EQ (glyphless_method
, Qzero_width
))
6525 return glyphless_method
;
6526 /* This method can't be used for the no-font case. */
6527 glyphless_method
= Qempty_box
;
6529 if (EQ (glyphless_method
, Qthin_space
))
6530 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6531 else if (EQ (glyphless_method
, Qempty_box
))
6532 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6533 else if (EQ (glyphless_method
, Qhex_code
))
6534 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6535 else if (STRINGP (glyphless_method
))
6536 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6539 /* Invalid value. We use the default method. */
6540 glyphless_method
= Qnil
;
6543 it
->what
= IT_GLYPHLESS
;
6544 return glyphless_method
;
6547 /* Load IT's display element fields with information about the next
6548 display element from the current position of IT. Value is zero if
6549 end of buffer (or C string) is reached. */
6551 static struct frame
*last_escape_glyph_frame
= NULL
;
6552 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6553 static int last_escape_glyph_merged_face_id
= 0;
6555 struct frame
*last_glyphless_glyph_frame
= NULL
;
6556 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6557 int last_glyphless_glyph_merged_face_id
= 0;
6560 get_next_display_element (struct it
*it
)
6562 /* Non-zero means that we found a display element. Zero means that
6563 we hit the end of what we iterate over. Performance note: the
6564 function pointer `method' used here turns out to be faster than
6565 using a sequence of if-statements. */
6569 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6571 if (it
->what
== IT_CHARACTER
)
6573 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6574 and only if (a) the resolved directionality of that character
6576 /* FIXME: Do we need an exception for characters from display
6578 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6579 it
->c
= bidi_mirror_char (it
->c
);
6580 /* Map via display table or translate control characters.
6581 IT->c, IT->len etc. have been set to the next character by
6582 the function call above. If we have a display table, and it
6583 contains an entry for IT->c, translate it. Don't do this if
6584 IT->c itself comes from a display table, otherwise we could
6585 end up in an infinite recursion. (An alternative could be to
6586 count the recursion depth of this function and signal an
6587 error when a certain maximum depth is reached.) Is it worth
6589 if (success_p
&& it
->dpvec
== NULL
)
6592 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6593 int nonascii_space_p
= 0;
6594 int nonascii_hyphen_p
= 0;
6595 int c
= it
->c
; /* This is the character to display. */
6597 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6599 eassert (SINGLE_BYTE_CHAR_P (c
));
6600 if (unibyte_display_via_language_environment
)
6602 c
= DECODE_CHAR (unibyte
, c
);
6604 c
= BYTE8_TO_CHAR (it
->c
);
6607 c
= BYTE8_TO_CHAR (it
->c
);
6611 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6614 struct Lisp_Vector
*v
= XVECTOR (dv
);
6616 /* Return the first character from the display table
6617 entry, if not empty. If empty, don't display the
6618 current character. */
6621 it
->dpvec_char_len
= it
->len
;
6622 it
->dpvec
= v
->contents
;
6623 it
->dpend
= v
->contents
+ v
->header
.size
;
6624 it
->current
.dpvec_index
= 0;
6625 it
->dpvec_face_id
= -1;
6626 it
->saved_face_id
= it
->face_id
;
6627 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6632 set_iterator_to_next (it
, 0);
6637 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6639 if (it
->what
== IT_GLYPHLESS
)
6641 /* Don't display this character. */
6642 set_iterator_to_next (it
, 0);
6646 /* If `nobreak-char-display' is non-nil, we display
6647 non-ASCII spaces and hyphens specially. */
6648 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6651 nonascii_space_p
= 1;
6652 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6653 nonascii_hyphen_p
= 1;
6656 /* Translate control characters into `\003' or `^C' form.
6657 Control characters coming from a display table entry are
6658 currently not translated because we use IT->dpvec to hold
6659 the translation. This could easily be changed but I
6660 don't believe that it is worth doing.
6662 The characters handled by `nobreak-char-display' must be
6665 Non-printable characters and raw-byte characters are also
6666 translated to octal form. */
6667 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6668 ? (it
->area
!= TEXT_AREA
6669 /* In mode line, treat \n, \t like other crl chars. */
6672 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6673 || (c
!= '\n' && c
!= '\t'))
6675 || nonascii_hyphen_p
6677 || ! CHAR_PRINTABLE_P (c
))))
6679 /* C is a control character, non-ASCII space/hyphen,
6680 raw-byte, or a non-printable character which must be
6681 displayed either as '\003' or as `^C' where the '\\'
6682 and '^' can be defined in the display table. Fill
6683 IT->ctl_chars with glyphs for what we have to
6684 display. Then, set IT->dpvec to these glyphs. */
6691 /* Handle control characters with ^. */
6693 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6697 g
= '^'; /* default glyph for Control */
6698 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6700 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6702 g
= GLYPH_CODE_CHAR (gc
);
6703 lface_id
= GLYPH_CODE_FACE (gc
);
6707 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6709 else if (it
->f
== last_escape_glyph_frame
6710 && it
->face_id
== last_escape_glyph_face_id
)
6712 face_id
= last_escape_glyph_merged_face_id
;
6716 /* Merge the escape-glyph face into the current face. */
6717 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6719 last_escape_glyph_frame
= it
->f
;
6720 last_escape_glyph_face_id
= it
->face_id
;
6721 last_escape_glyph_merged_face_id
= face_id
;
6724 XSETINT (it
->ctl_chars
[0], g
);
6725 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6727 goto display_control
;
6730 /* Handle non-ascii space in the mode where it only gets
6733 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6735 /* Merge `nobreak-space' into the current face. */
6736 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6738 XSETINT (it
->ctl_chars
[0], ' ');
6740 goto display_control
;
6743 /* Handle sequences that start with the "escape glyph". */
6745 /* the default escape glyph is \. */
6746 escape_glyph
= '\\';
6749 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6751 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6752 lface_id
= GLYPH_CODE_FACE (gc
);
6756 /* The display table specified a face.
6757 Merge it into face_id and also into escape_glyph. */
6758 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6761 else if (it
->f
== last_escape_glyph_frame
6762 && it
->face_id
== last_escape_glyph_face_id
)
6764 face_id
= last_escape_glyph_merged_face_id
;
6768 /* Merge the escape-glyph face into the current face. */
6769 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6771 last_escape_glyph_frame
= it
->f
;
6772 last_escape_glyph_face_id
= it
->face_id
;
6773 last_escape_glyph_merged_face_id
= face_id
;
6776 /* Draw non-ASCII hyphen with just highlighting: */
6778 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6780 XSETINT (it
->ctl_chars
[0], '-');
6782 goto display_control
;
6785 /* Draw non-ASCII space/hyphen with escape glyph: */
6787 if (nonascii_space_p
|| nonascii_hyphen_p
)
6789 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6790 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6792 goto display_control
;
6799 if (CHAR_BYTE8_P (c
))
6800 /* Display \200 instead of \17777600. */
6801 c
= CHAR_TO_BYTE8 (c
);
6802 len
= sprintf (str
, "%03o", c
);
6804 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6805 for (i
= 0; i
< len
; i
++)
6806 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6811 /* Set up IT->dpvec and return first character from it. */
6812 it
->dpvec_char_len
= it
->len
;
6813 it
->dpvec
= it
->ctl_chars
;
6814 it
->dpend
= it
->dpvec
+ ctl_len
;
6815 it
->current
.dpvec_index
= 0;
6816 it
->dpvec_face_id
= face_id
;
6817 it
->saved_face_id
= it
->face_id
;
6818 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6822 it
->char_to_display
= c
;
6826 it
->char_to_display
= it
->c
;
6830 /* Adjust face id for a multibyte character. There are no multibyte
6831 character in unibyte text. */
6832 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6835 && FRAME_WINDOW_P (it
->f
))
6837 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6839 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6841 /* Automatic composition with glyph-string. */
6842 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6844 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6848 ptrdiff_t pos
= (it
->s
? -1
6849 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6850 : IT_CHARPOS (*it
));
6853 if (it
->what
== IT_CHARACTER
)
6854 c
= it
->char_to_display
;
6857 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6861 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6862 /* TAB in a composition means display glyphs with
6863 padding space on the left or right. */
6864 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6867 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6872 /* Is this character the last one of a run of characters with
6873 box? If yes, set IT->end_of_box_run_p to 1. */
6877 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6879 int face_id
= underlying_face_id (it
);
6880 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6884 if (face
->box
== FACE_NO_BOX
)
6886 /* If the box comes from face properties in a
6887 display string, check faces in that string. */
6888 int string_face_id
= face_after_it_pos (it
);
6889 it
->end_of_box_run_p
6890 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6893 /* Otherwise, the box comes from the underlying face.
6894 If this is the last string character displayed, check
6895 the next buffer location. */
6896 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6897 && (it
->current
.overlay_string_index
6898 == it
->n_overlay_strings
- 1))
6902 struct text_pos pos
= it
->current
.pos
;
6903 INC_TEXT_POS (pos
, it
->multibyte_p
);
6905 next_face_id
= face_at_buffer_position
6906 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6907 it
->region_end_charpos
, &ignore
,
6908 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6910 it
->end_of_box_run_p
6911 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6918 int face_id
= face_after_it_pos (it
);
6919 it
->end_of_box_run_p
6920 = (face_id
!= it
->face_id
6921 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6924 /* If we reached the end of the object we've been iterating (e.g., a
6925 display string or an overlay string), and there's something on
6926 IT->stack, proceed with what's on the stack. It doesn't make
6927 sense to return zero if there's unprocessed stuff on the stack,
6928 because otherwise that stuff will never be displayed. */
6929 if (!success_p
&& it
->sp
> 0)
6931 set_iterator_to_next (it
, 0);
6932 success_p
= get_next_display_element (it
);
6935 /* Value is 0 if end of buffer or string reached. */
6940 /* Move IT to the next display element.
6942 RESEAT_P non-zero means if called on a newline in buffer text,
6943 skip to the next visible line start.
6945 Functions get_next_display_element and set_iterator_to_next are
6946 separate because I find this arrangement easier to handle than a
6947 get_next_display_element function that also increments IT's
6948 position. The way it is we can first look at an iterator's current
6949 display element, decide whether it fits on a line, and if it does,
6950 increment the iterator position. The other way around we probably
6951 would either need a flag indicating whether the iterator has to be
6952 incremented the next time, or we would have to implement a
6953 decrement position function which would not be easy to write. */
6956 set_iterator_to_next (struct it
*it
, int reseat_p
)
6958 /* Reset flags indicating start and end of a sequence of characters
6959 with box. Reset them at the start of this function because
6960 moving the iterator to a new position might set them. */
6961 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6965 case GET_FROM_BUFFER
:
6966 /* The current display element of IT is a character from
6967 current_buffer. Advance in the buffer, and maybe skip over
6968 invisible lines that are so because of selective display. */
6969 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6970 reseat_at_next_visible_line_start (it
, 0);
6971 else if (it
->cmp_it
.id
>= 0)
6973 /* We are currently getting glyphs from a composition. */
6978 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6979 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6980 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6982 it
->cmp_it
.from
= it
->cmp_it
.to
;
6987 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6989 it
->end_charpos
, Qnil
);
6992 else if (! it
->cmp_it
.reversed_p
)
6994 /* Composition created while scanning forward. */
6995 /* Update IT's char/byte positions to point to the first
6996 character of the next grapheme cluster, or to the
6997 character visually after the current composition. */
6998 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6999 bidi_move_to_visually_next (&it
->bidi_it
);
7000 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7001 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7003 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7005 /* Proceed to the next grapheme cluster. */
7006 it
->cmp_it
.from
= it
->cmp_it
.to
;
7010 /* No more grapheme clusters in this composition.
7011 Find the next stop position. */
7012 ptrdiff_t stop
= it
->end_charpos
;
7013 if (it
->bidi_it
.scan_dir
< 0)
7014 /* Now we are scanning backward and don't know
7017 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7018 IT_BYTEPOS (*it
), stop
, Qnil
);
7023 /* Composition created while scanning backward. */
7024 /* Update IT's char/byte positions to point to the last
7025 character of the previous grapheme cluster, or the
7026 character visually after the current composition. */
7027 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7028 bidi_move_to_visually_next (&it
->bidi_it
);
7029 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7030 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7031 if (it
->cmp_it
.from
> 0)
7033 /* Proceed to the previous grapheme cluster. */
7034 it
->cmp_it
.to
= it
->cmp_it
.from
;
7038 /* No more grapheme clusters in this composition.
7039 Find the next stop position. */
7040 ptrdiff_t stop
= it
->end_charpos
;
7041 if (it
->bidi_it
.scan_dir
< 0)
7042 /* Now we are scanning backward and don't know
7045 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7046 IT_BYTEPOS (*it
), stop
, Qnil
);
7052 eassert (it
->len
!= 0);
7056 IT_BYTEPOS (*it
) += it
->len
;
7057 IT_CHARPOS (*it
) += 1;
7061 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7062 /* If this is a new paragraph, determine its base
7063 direction (a.k.a. its base embedding level). */
7064 if (it
->bidi_it
.new_paragraph
)
7065 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7066 bidi_move_to_visually_next (&it
->bidi_it
);
7067 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7068 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7069 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7071 /* As the scan direction was changed, we must
7072 re-compute the stop position for composition. */
7073 ptrdiff_t stop
= it
->end_charpos
;
7074 if (it
->bidi_it
.scan_dir
< 0)
7076 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7077 IT_BYTEPOS (*it
), stop
, Qnil
);
7080 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7084 case GET_FROM_C_STRING
:
7085 /* Current display element of IT is from a C string. */
7087 /* If the string position is beyond string's end, it means
7088 next_element_from_c_string is padding the string with
7089 blanks, in which case we bypass the bidi iterator,
7090 because it cannot deal with such virtual characters. */
7091 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7093 IT_BYTEPOS (*it
) += it
->len
;
7094 IT_CHARPOS (*it
) += 1;
7098 bidi_move_to_visually_next (&it
->bidi_it
);
7099 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7100 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7104 case GET_FROM_DISPLAY_VECTOR
:
7105 /* Current display element of IT is from a display table entry.
7106 Advance in the display table definition. Reset it to null if
7107 end reached, and continue with characters from buffers/
7109 ++it
->current
.dpvec_index
;
7111 /* Restore face of the iterator to what they were before the
7112 display vector entry (these entries may contain faces). */
7113 it
->face_id
= it
->saved_face_id
;
7115 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7117 int recheck_faces
= it
->ellipsis_p
;
7120 it
->method
= GET_FROM_C_STRING
;
7121 else if (STRINGP (it
->string
))
7122 it
->method
= GET_FROM_STRING
;
7125 it
->method
= GET_FROM_BUFFER
;
7126 it
->object
= it
->w
->buffer
;
7130 it
->current
.dpvec_index
= -1;
7132 /* Skip over characters which were displayed via IT->dpvec. */
7133 if (it
->dpvec_char_len
< 0)
7134 reseat_at_next_visible_line_start (it
, 1);
7135 else if (it
->dpvec_char_len
> 0)
7137 if (it
->method
== GET_FROM_STRING
7138 && it
->n_overlay_strings
> 0)
7139 it
->ignore_overlay_strings_at_pos_p
= 1;
7140 it
->len
= it
->dpvec_char_len
;
7141 set_iterator_to_next (it
, reseat_p
);
7144 /* Maybe recheck faces after display vector */
7146 it
->stop_charpos
= IT_CHARPOS (*it
);
7150 case GET_FROM_STRING
:
7151 /* Current display element is a character from a Lisp string. */
7152 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7153 /* Don't advance past string end. These conditions are true
7154 when set_iterator_to_next is called at the end of
7155 get_next_display_element, in which case the Lisp string is
7156 already exhausted, and all we want is pop the iterator
7158 if (it
->current
.overlay_string_index
>= 0)
7160 /* This is an overlay string, so there's no padding with
7161 spaces, and the number of characters in the string is
7162 where the string ends. */
7163 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7164 goto consider_string_end
;
7168 /* Not an overlay string. There could be padding, so test
7169 against it->end_charpos . */
7170 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7171 goto consider_string_end
;
7173 if (it
->cmp_it
.id
>= 0)
7179 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7180 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7181 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7182 it
->cmp_it
.from
= it
->cmp_it
.to
;
7186 composition_compute_stop_pos (&it
->cmp_it
,
7187 IT_STRING_CHARPOS (*it
),
7188 IT_STRING_BYTEPOS (*it
),
7189 it
->end_charpos
, it
->string
);
7192 else if (! it
->cmp_it
.reversed_p
)
7194 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7195 bidi_move_to_visually_next (&it
->bidi_it
);
7196 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7197 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7199 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7200 it
->cmp_it
.from
= it
->cmp_it
.to
;
7203 ptrdiff_t stop
= it
->end_charpos
;
7204 if (it
->bidi_it
.scan_dir
< 0)
7206 composition_compute_stop_pos (&it
->cmp_it
,
7207 IT_STRING_CHARPOS (*it
),
7208 IT_STRING_BYTEPOS (*it
), stop
,
7214 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7215 bidi_move_to_visually_next (&it
->bidi_it
);
7216 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7217 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7218 if (it
->cmp_it
.from
> 0)
7219 it
->cmp_it
.to
= it
->cmp_it
.from
;
7222 ptrdiff_t stop
= it
->end_charpos
;
7223 if (it
->bidi_it
.scan_dir
< 0)
7225 composition_compute_stop_pos (&it
->cmp_it
,
7226 IT_STRING_CHARPOS (*it
),
7227 IT_STRING_BYTEPOS (*it
), stop
,
7235 /* If the string position is beyond string's end, it
7236 means next_element_from_string is padding the string
7237 with blanks, in which case we bypass the bidi
7238 iterator, because it cannot deal with such virtual
7240 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7242 IT_STRING_BYTEPOS (*it
) += it
->len
;
7243 IT_STRING_CHARPOS (*it
) += 1;
7247 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7249 bidi_move_to_visually_next (&it
->bidi_it
);
7250 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7251 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7252 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7254 ptrdiff_t stop
= it
->end_charpos
;
7256 if (it
->bidi_it
.scan_dir
< 0)
7258 composition_compute_stop_pos (&it
->cmp_it
,
7259 IT_STRING_CHARPOS (*it
),
7260 IT_STRING_BYTEPOS (*it
), stop
,
7266 consider_string_end
:
7268 if (it
->current
.overlay_string_index
>= 0)
7270 /* IT->string is an overlay string. Advance to the
7271 next, if there is one. */
7272 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7275 next_overlay_string (it
);
7277 setup_for_ellipsis (it
, 0);
7282 /* IT->string is not an overlay string. If we reached
7283 its end, and there is something on IT->stack, proceed
7284 with what is on the stack. This can be either another
7285 string, this time an overlay string, or a buffer. */
7286 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7290 if (it
->method
== GET_FROM_STRING
)
7291 goto consider_string_end
;
7296 case GET_FROM_IMAGE
:
7297 case GET_FROM_STRETCH
:
7298 /* The position etc with which we have to proceed are on
7299 the stack. The position may be at the end of a string,
7300 if the `display' property takes up the whole string. */
7301 eassert (it
->sp
> 0);
7303 if (it
->method
== GET_FROM_STRING
)
7304 goto consider_string_end
;
7308 /* There are no other methods defined, so this should be a bug. */
7312 eassert (it
->method
!= GET_FROM_STRING
7313 || (STRINGP (it
->string
)
7314 && IT_STRING_CHARPOS (*it
) >= 0));
7317 /* Load IT's display element fields with information about the next
7318 display element which comes from a display table entry or from the
7319 result of translating a control character to one of the forms `^C'
7322 IT->dpvec holds the glyphs to return as characters.
7323 IT->saved_face_id holds the face id before the display vector--it
7324 is restored into IT->face_id in set_iterator_to_next. */
7327 next_element_from_display_vector (struct it
*it
)
7332 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7334 it
->face_id
= it
->saved_face_id
;
7336 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7337 That seemed totally bogus - so I changed it... */
7338 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7340 if (GLYPH_CODE_P (gc
))
7342 it
->c
= GLYPH_CODE_CHAR (gc
);
7343 it
->len
= CHAR_BYTES (it
->c
);
7345 /* The entry may contain a face id to use. Such a face id is
7346 the id of a Lisp face, not a realized face. A face id of
7347 zero means no face is specified. */
7348 if (it
->dpvec_face_id
>= 0)
7349 it
->face_id
= it
->dpvec_face_id
;
7352 int lface_id
= GLYPH_CODE_FACE (gc
);
7354 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7359 /* Display table entry is invalid. Return a space. */
7360 it
->c
= ' ', it
->len
= 1;
7362 /* Don't change position and object of the iterator here. They are
7363 still the values of the character that had this display table
7364 entry or was translated, and that's what we want. */
7365 it
->what
= IT_CHARACTER
;
7369 /* Get the first element of string/buffer in the visual order, after
7370 being reseated to a new position in a string or a buffer. */
7372 get_visually_first_element (struct it
*it
)
7374 int string_p
= STRINGP (it
->string
) || it
->s
;
7375 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7376 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7378 if (STRINGP (it
->string
))
7380 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7381 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7385 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7386 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7389 if (it
->bidi_it
.charpos
== eob
)
7391 /* Nothing to do, but reset the FIRST_ELT flag, like
7392 bidi_paragraph_init does, because we are not going to
7394 it
->bidi_it
.first_elt
= 0;
7396 else if (it
->bidi_it
.charpos
== bob
7398 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7399 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7401 /* If we are at the beginning of a line/string, we can produce
7402 the next element right away. */
7403 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7404 bidi_move_to_visually_next (&it
->bidi_it
);
7408 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7410 /* We need to prime the bidi iterator starting at the line's or
7411 string's beginning, before we will be able to produce the
7414 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7417 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7419 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7421 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7424 /* Now return to buffer/string position where we were asked
7425 to get the next display element, and produce that. */
7426 bidi_move_to_visually_next (&it
->bidi_it
);
7428 while (it
->bidi_it
.bytepos
!= orig_bytepos
7429 && it
->bidi_it
.charpos
< eob
);
7432 /* Adjust IT's position information to where we ended up. */
7433 if (STRINGP (it
->string
))
7435 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7436 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7440 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7441 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7444 if (STRINGP (it
->string
) || !it
->s
)
7446 ptrdiff_t stop
, charpos
, bytepos
;
7448 if (STRINGP (it
->string
))
7451 stop
= SCHARS (it
->string
);
7452 if (stop
> it
->end_charpos
)
7453 stop
= it
->end_charpos
;
7454 charpos
= IT_STRING_CHARPOS (*it
);
7455 bytepos
= IT_STRING_BYTEPOS (*it
);
7459 stop
= it
->end_charpos
;
7460 charpos
= IT_CHARPOS (*it
);
7461 bytepos
= IT_BYTEPOS (*it
);
7463 if (it
->bidi_it
.scan_dir
< 0)
7465 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7470 /* Load IT with the next display element from Lisp string IT->string.
7471 IT->current.string_pos is the current position within the string.
7472 If IT->current.overlay_string_index >= 0, the Lisp string is an
7476 next_element_from_string (struct it
*it
)
7478 struct text_pos position
;
7480 eassert (STRINGP (it
->string
));
7481 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7482 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7483 position
= it
->current
.string_pos
;
7485 /* With bidi reordering, the character to display might not be the
7486 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7487 that we were reseat()ed to a new string, whose paragraph
7488 direction is not known. */
7489 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7491 get_visually_first_element (it
);
7492 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7495 /* Time to check for invisible text? */
7496 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7498 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7501 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7502 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7504 /* With bidi non-linear iteration, we could find
7505 ourselves far beyond the last computed stop_charpos,
7506 with several other stop positions in between that we
7507 missed. Scan them all now, in buffer's logical
7508 order, until we find and handle the last stop_charpos
7509 that precedes our current position. */
7510 handle_stop_backwards (it
, it
->stop_charpos
);
7511 return GET_NEXT_DISPLAY_ELEMENT (it
);
7517 /* Take note of the stop position we just moved
7518 across, for when we will move back across it. */
7519 it
->prev_stop
= it
->stop_charpos
;
7520 /* If we are at base paragraph embedding level, take
7521 note of the last stop position seen at this
7523 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7524 it
->base_level_stop
= it
->stop_charpos
;
7528 /* Since a handler may have changed IT->method, we must
7530 return GET_NEXT_DISPLAY_ELEMENT (it
);
7534 /* If we are before prev_stop, we may have overstepped
7535 on our way backwards a stop_pos, and if so, we need
7536 to handle that stop_pos. */
7537 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7538 /* We can sometimes back up for reasons that have nothing
7539 to do with bidi reordering. E.g., compositions. The
7540 code below is only needed when we are above the base
7541 embedding level, so test for that explicitly. */
7542 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7544 /* If we lost track of base_level_stop, we have no better
7545 place for handle_stop_backwards to start from than string
7546 beginning. This happens, e.g., when we were reseated to
7547 the previous screenful of text by vertical-motion. */
7548 if (it
->base_level_stop
<= 0
7549 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7550 it
->base_level_stop
= 0;
7551 handle_stop_backwards (it
, it
->base_level_stop
);
7552 return GET_NEXT_DISPLAY_ELEMENT (it
);
7556 if (it
->current
.overlay_string_index
>= 0)
7558 /* Get the next character from an overlay string. In overlay
7559 strings, there is no field width or padding with spaces to
7561 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7566 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7567 IT_STRING_BYTEPOS (*it
),
7568 it
->bidi_it
.scan_dir
< 0
7570 : SCHARS (it
->string
))
7571 && next_element_from_composition (it
))
7575 else if (STRING_MULTIBYTE (it
->string
))
7577 const unsigned char *s
= (SDATA (it
->string
)
7578 + IT_STRING_BYTEPOS (*it
));
7579 it
->c
= string_char_and_length (s
, &it
->len
);
7583 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7589 /* Get the next character from a Lisp string that is not an
7590 overlay string. Such strings come from the mode line, for
7591 example. We may have to pad with spaces, or truncate the
7592 string. See also next_element_from_c_string. */
7593 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7598 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7600 /* Pad with spaces. */
7601 it
->c
= ' ', it
->len
= 1;
7602 CHARPOS (position
) = BYTEPOS (position
) = -1;
7604 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7605 IT_STRING_BYTEPOS (*it
),
7606 it
->bidi_it
.scan_dir
< 0
7608 : it
->string_nchars
)
7609 && next_element_from_composition (it
))
7613 else if (STRING_MULTIBYTE (it
->string
))
7615 const unsigned char *s
= (SDATA (it
->string
)
7616 + IT_STRING_BYTEPOS (*it
));
7617 it
->c
= string_char_and_length (s
, &it
->len
);
7621 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7626 /* Record what we have and where it came from. */
7627 it
->what
= IT_CHARACTER
;
7628 it
->object
= it
->string
;
7629 it
->position
= position
;
7634 /* Load IT with next display element from C string IT->s.
7635 IT->string_nchars is the maximum number of characters to return
7636 from the string. IT->end_charpos may be greater than
7637 IT->string_nchars when this function is called, in which case we
7638 may have to return padding spaces. Value is zero if end of string
7639 reached, including padding spaces. */
7642 next_element_from_c_string (struct it
*it
)
7647 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7648 it
->what
= IT_CHARACTER
;
7649 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7652 /* With bidi reordering, the character to display might not be the
7653 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7654 we were reseated to a new string, whose paragraph direction is
7656 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7657 get_visually_first_element (it
);
7659 /* IT's position can be greater than IT->string_nchars in case a
7660 field width or precision has been specified when the iterator was
7662 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7664 /* End of the game. */
7668 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7670 /* Pad with spaces. */
7671 it
->c
= ' ', it
->len
= 1;
7672 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7674 else if (it
->multibyte_p
)
7675 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7677 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7683 /* Set up IT to return characters from an ellipsis, if appropriate.
7684 The definition of the ellipsis glyphs may come from a display table
7685 entry. This function fills IT with the first glyph from the
7686 ellipsis if an ellipsis is to be displayed. */
7689 next_element_from_ellipsis (struct it
*it
)
7691 if (it
->selective_display_ellipsis_p
)
7692 setup_for_ellipsis (it
, it
->len
);
7695 /* The face at the current position may be different from the
7696 face we find after the invisible text. Remember what it
7697 was in IT->saved_face_id, and signal that it's there by
7698 setting face_before_selective_p. */
7699 it
->saved_face_id
= it
->face_id
;
7700 it
->method
= GET_FROM_BUFFER
;
7701 it
->object
= it
->w
->buffer
;
7702 reseat_at_next_visible_line_start (it
, 1);
7703 it
->face_before_selective_p
= 1;
7706 return GET_NEXT_DISPLAY_ELEMENT (it
);
7710 /* Deliver an image display element. The iterator IT is already
7711 filled with image information (done in handle_display_prop). Value
7716 next_element_from_image (struct it
*it
)
7718 it
->what
= IT_IMAGE
;
7719 it
->ignore_overlay_strings_at_pos_p
= 0;
7724 /* Fill iterator IT with next display element from a stretch glyph
7725 property. IT->object is the value of the text property. Value is
7729 next_element_from_stretch (struct it
*it
)
7731 it
->what
= IT_STRETCH
;
7735 /* Scan backwards from IT's current position until we find a stop
7736 position, or until BEGV. This is called when we find ourself
7737 before both the last known prev_stop and base_level_stop while
7738 reordering bidirectional text. */
7741 compute_stop_pos_backwards (struct it
*it
)
7743 const int SCAN_BACK_LIMIT
= 1000;
7744 struct text_pos pos
;
7745 struct display_pos save_current
= it
->current
;
7746 struct text_pos save_position
= it
->position
;
7747 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7748 ptrdiff_t where_we_are
= charpos
;
7749 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7750 ptrdiff_t save_end_pos
= it
->end_charpos
;
7752 eassert (NILP (it
->string
) && !it
->s
);
7753 eassert (it
->bidi_p
);
7757 it
->end_charpos
= min (charpos
+ 1, ZV
);
7758 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7759 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7760 reseat_1 (it
, pos
, 0);
7761 compute_stop_pos (it
);
7762 /* We must advance forward, right? */
7763 if (it
->stop_charpos
<= charpos
)
7766 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7768 if (it
->stop_charpos
<= where_we_are
)
7769 it
->prev_stop
= it
->stop_charpos
;
7771 it
->prev_stop
= BEGV
;
7773 it
->current
= save_current
;
7774 it
->position
= save_position
;
7775 it
->stop_charpos
= save_stop_pos
;
7776 it
->end_charpos
= save_end_pos
;
7779 /* Scan forward from CHARPOS in the current buffer/string, until we
7780 find a stop position > current IT's position. Then handle the stop
7781 position before that. This is called when we bump into a stop
7782 position while reordering bidirectional text. CHARPOS should be
7783 the last previously processed stop_pos (or BEGV/0, if none were
7784 processed yet) whose position is less that IT's current
7788 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7790 int bufp
= !STRINGP (it
->string
);
7791 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7792 struct display_pos save_current
= it
->current
;
7793 struct text_pos save_position
= it
->position
;
7794 struct text_pos pos1
;
7795 ptrdiff_t next_stop
;
7797 /* Scan in strict logical order. */
7798 eassert (it
->bidi_p
);
7802 it
->prev_stop
= charpos
;
7805 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7806 reseat_1 (it
, pos1
, 0);
7809 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7810 compute_stop_pos (it
);
7811 /* We must advance forward, right? */
7812 if (it
->stop_charpos
<= it
->prev_stop
)
7814 charpos
= it
->stop_charpos
;
7816 while (charpos
<= where_we_are
);
7819 it
->current
= save_current
;
7820 it
->position
= save_position
;
7821 next_stop
= it
->stop_charpos
;
7822 it
->stop_charpos
= it
->prev_stop
;
7824 it
->stop_charpos
= next_stop
;
7827 /* Load IT with the next display element from current_buffer. Value
7828 is zero if end of buffer reached. IT->stop_charpos is the next
7829 position at which to stop and check for text properties or buffer
7833 next_element_from_buffer (struct it
*it
)
7837 eassert (IT_CHARPOS (*it
) >= BEGV
);
7838 eassert (NILP (it
->string
) && !it
->s
);
7839 eassert (!it
->bidi_p
7840 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7841 && it
->bidi_it
.string
.s
== NULL
));
7843 /* With bidi reordering, the character to display might not be the
7844 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7845 we were reseat()ed to a new buffer position, which is potentially
7846 a different paragraph. */
7847 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7849 get_visually_first_element (it
);
7850 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7853 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7855 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7857 int overlay_strings_follow_p
;
7859 /* End of the game, except when overlay strings follow that
7860 haven't been returned yet. */
7861 if (it
->overlay_strings_at_end_processed_p
)
7862 overlay_strings_follow_p
= 0;
7865 it
->overlay_strings_at_end_processed_p
= 1;
7866 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7869 if (overlay_strings_follow_p
)
7870 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7874 it
->position
= it
->current
.pos
;
7878 else if (!(!it
->bidi_p
7879 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7880 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7882 /* With bidi non-linear iteration, we could find ourselves
7883 far beyond the last computed stop_charpos, with several
7884 other stop positions in between that we missed. Scan
7885 them all now, in buffer's logical order, until we find
7886 and handle the last stop_charpos that precedes our
7887 current position. */
7888 handle_stop_backwards (it
, it
->stop_charpos
);
7889 return GET_NEXT_DISPLAY_ELEMENT (it
);
7895 /* Take note of the stop position we just moved across,
7896 for when we will move back across it. */
7897 it
->prev_stop
= it
->stop_charpos
;
7898 /* If we are at base paragraph embedding level, take
7899 note of the last stop position seen at this
7901 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7902 it
->base_level_stop
= it
->stop_charpos
;
7905 return GET_NEXT_DISPLAY_ELEMENT (it
);
7909 /* If we are before prev_stop, we may have overstepped on
7910 our way backwards a stop_pos, and if so, we need to
7911 handle that stop_pos. */
7912 && IT_CHARPOS (*it
) < it
->prev_stop
7913 /* We can sometimes back up for reasons that have nothing
7914 to do with bidi reordering. E.g., compositions. The
7915 code below is only needed when we are above the base
7916 embedding level, so test for that explicitly. */
7917 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7919 if (it
->base_level_stop
<= 0
7920 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7922 /* If we lost track of base_level_stop, we need to find
7923 prev_stop by looking backwards. This happens, e.g., when
7924 we were reseated to the previous screenful of text by
7926 it
->base_level_stop
= BEGV
;
7927 compute_stop_pos_backwards (it
);
7928 handle_stop_backwards (it
, it
->prev_stop
);
7931 handle_stop_backwards (it
, it
->base_level_stop
);
7932 return GET_NEXT_DISPLAY_ELEMENT (it
);
7936 /* No face changes, overlays etc. in sight, so just return a
7937 character from current_buffer. */
7941 /* Maybe run the redisplay end trigger hook. Performance note:
7942 This doesn't seem to cost measurable time. */
7943 if (it
->redisplay_end_trigger_charpos
7945 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7946 run_redisplay_end_trigger_hook (it
);
7948 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7949 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7951 && next_element_from_composition (it
))
7956 /* Get the next character, maybe multibyte. */
7957 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7958 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7959 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7961 it
->c
= *p
, it
->len
= 1;
7963 /* Record what we have and where it came from. */
7964 it
->what
= IT_CHARACTER
;
7965 it
->object
= it
->w
->buffer
;
7966 it
->position
= it
->current
.pos
;
7968 /* Normally we return the character found above, except when we
7969 really want to return an ellipsis for selective display. */
7974 /* A value of selective > 0 means hide lines indented more
7975 than that number of columns. */
7976 if (it
->selective
> 0
7977 && IT_CHARPOS (*it
) + 1 < ZV
7978 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7979 IT_BYTEPOS (*it
) + 1,
7982 success_p
= next_element_from_ellipsis (it
);
7983 it
->dpvec_char_len
= -1;
7986 else if (it
->c
== '\r' && it
->selective
== -1)
7988 /* A value of selective == -1 means that everything from the
7989 CR to the end of the line is invisible, with maybe an
7990 ellipsis displayed for it. */
7991 success_p
= next_element_from_ellipsis (it
);
7992 it
->dpvec_char_len
= -1;
7997 /* Value is zero if end of buffer reached. */
7998 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8003 /* Run the redisplay end trigger hook for IT. */
8006 run_redisplay_end_trigger_hook (struct it
*it
)
8008 Lisp_Object args
[3];
8010 /* IT->glyph_row should be non-null, i.e. we should be actually
8011 displaying something, or otherwise we should not run the hook. */
8012 eassert (it
->glyph_row
);
8014 /* Set up hook arguments. */
8015 args
[0] = Qredisplay_end_trigger_functions
;
8016 args
[1] = it
->window
;
8017 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8018 it
->redisplay_end_trigger_charpos
= 0;
8020 /* Since we are *trying* to run these functions, don't try to run
8021 them again, even if they get an error. */
8022 wset_redisplay_end_trigger (it
->w
, Qnil
);
8023 Frun_hook_with_args (3, args
);
8025 /* Notice if it changed the face of the character we are on. */
8026 handle_face_prop (it
);
8030 /* Deliver a composition display element. Unlike the other
8031 next_element_from_XXX, this function is not registered in the array
8032 get_next_element[]. It is called from next_element_from_buffer and
8033 next_element_from_string when necessary. */
8036 next_element_from_composition (struct it
*it
)
8038 it
->what
= IT_COMPOSITION
;
8039 it
->len
= it
->cmp_it
.nbytes
;
8040 if (STRINGP (it
->string
))
8044 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8045 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8048 it
->position
= it
->current
.string_pos
;
8049 it
->object
= it
->string
;
8050 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8051 IT_STRING_BYTEPOS (*it
), it
->string
);
8057 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8058 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8061 if (it
->bidi_it
.new_paragraph
)
8062 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8063 /* Resync the bidi iterator with IT's new position.
8064 FIXME: this doesn't support bidirectional text. */
8065 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8066 bidi_move_to_visually_next (&it
->bidi_it
);
8070 it
->position
= it
->current
.pos
;
8071 it
->object
= it
->w
->buffer
;
8072 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8073 IT_BYTEPOS (*it
), Qnil
);
8080 /***********************************************************************
8081 Moving an iterator without producing glyphs
8082 ***********************************************************************/
8084 /* Check if iterator is at a position corresponding to a valid buffer
8085 position after some move_it_ call. */
8087 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8088 ((it)->method == GET_FROM_STRING \
8089 ? IT_STRING_CHARPOS (*it) == 0 \
8093 /* Move iterator IT to a specified buffer or X position within one
8094 line on the display without producing glyphs.
8096 OP should be a bit mask including some or all of these bits:
8097 MOVE_TO_X: Stop upon reaching x-position TO_X.
8098 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8099 Regardless of OP's value, stop upon reaching the end of the display line.
8101 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8102 This means, in particular, that TO_X includes window's horizontal
8105 The return value has several possible values that
8106 say what condition caused the scan to stop:
8108 MOVE_POS_MATCH_OR_ZV
8109 - when TO_POS or ZV was reached.
8112 -when TO_X was reached before TO_POS or ZV were reached.
8115 - when we reached the end of the display area and the line must
8119 - when we reached the end of the display area and the line is
8123 - when we stopped at a line end, i.e. a newline or a CR and selective
8126 static enum move_it_result
8127 move_it_in_display_line_to (struct it
*it
,
8128 ptrdiff_t to_charpos
, int to_x
,
8129 enum move_operation_enum op
)
8131 enum move_it_result result
= MOVE_UNDEFINED
;
8132 struct glyph_row
*saved_glyph_row
;
8133 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8134 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8135 void *ppos_data
= NULL
;
8137 enum it_method prev_method
= it
->method
;
8138 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8139 int saw_smaller_pos
= prev_pos
< to_charpos
;
8141 /* Don't produce glyphs in produce_glyphs. */
8142 saved_glyph_row
= it
->glyph_row
;
8143 it
->glyph_row
= NULL
;
8145 /* Use wrap_it to save a copy of IT wherever a word wrap could
8146 occur. Use atpos_it to save a copy of IT at the desired buffer
8147 position, if found, so that we can scan ahead and check if the
8148 word later overshoots the window edge. Use atx_it similarly, for
8154 /* Use ppos_it under bidi reordering to save a copy of IT for the
8155 position > CHARPOS that is the closest to CHARPOS. We restore
8156 that position in IT when we have scanned the entire display line
8157 without finding a match for CHARPOS and all the character
8158 positions are greater than CHARPOS. */
8161 SAVE_IT (ppos_it
, *it
, ppos_data
);
8162 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8163 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8164 SAVE_IT (ppos_it
, *it
, ppos_data
);
8167 #define BUFFER_POS_REACHED_P() \
8168 ((op & MOVE_TO_POS) != 0 \
8169 && BUFFERP (it->object) \
8170 && (IT_CHARPOS (*it) == to_charpos \
8172 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8173 && IT_CHARPOS (*it) > to_charpos) \
8174 || (it->what == IT_COMPOSITION \
8175 && ((IT_CHARPOS (*it) > to_charpos \
8176 && to_charpos >= it->cmp_it.charpos) \
8177 || (IT_CHARPOS (*it) < to_charpos \
8178 && to_charpos <= it->cmp_it.charpos)))) \
8179 && (it->method == GET_FROM_BUFFER \
8180 || (it->method == GET_FROM_DISPLAY_VECTOR \
8181 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8183 /* If there's a line-/wrap-prefix, handle it. */
8184 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8185 && it
->current_y
< it
->last_visible_y
)
8186 handle_line_prefix (it
);
8188 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8189 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8193 int x
, i
, ascent
= 0, descent
= 0;
8195 /* Utility macro to reset an iterator with x, ascent, and descent. */
8196 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8197 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8198 (IT)->max_descent = descent)
8200 /* Stop if we move beyond TO_CHARPOS (after an image or a
8201 display string or stretch glyph). */
8202 if ((op
& MOVE_TO_POS
) != 0
8203 && BUFFERP (it
->object
)
8204 && it
->method
== GET_FROM_BUFFER
8206 /* When the iterator is at base embedding level, we
8207 are guaranteed that characters are delivered for
8208 display in strictly increasing order of their
8209 buffer positions. */
8210 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8211 && IT_CHARPOS (*it
) > to_charpos
)
8213 && (prev_method
== GET_FROM_IMAGE
8214 || prev_method
== GET_FROM_STRETCH
8215 || prev_method
== GET_FROM_STRING
)
8216 /* Passed TO_CHARPOS from left to right. */
8217 && ((prev_pos
< to_charpos
8218 && IT_CHARPOS (*it
) > to_charpos
)
8219 /* Passed TO_CHARPOS from right to left. */
8220 || (prev_pos
> to_charpos
8221 && IT_CHARPOS (*it
) < to_charpos
)))))
8223 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8225 result
= MOVE_POS_MATCH_OR_ZV
;
8228 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8229 /* If wrap_it is valid, the current position might be in a
8230 word that is wrapped. So, save the iterator in
8231 atpos_it and continue to see if wrapping happens. */
8232 SAVE_IT (atpos_it
, *it
, atpos_data
);
8235 /* Stop when ZV reached.
8236 We used to stop here when TO_CHARPOS reached as well, but that is
8237 too soon if this glyph does not fit on this line. So we handle it
8238 explicitly below. */
8239 if (!get_next_display_element (it
))
8241 result
= MOVE_POS_MATCH_OR_ZV
;
8245 if (it
->line_wrap
== TRUNCATE
)
8247 if (BUFFER_POS_REACHED_P ())
8249 result
= MOVE_POS_MATCH_OR_ZV
;
8255 if (it
->line_wrap
== WORD_WRAP
)
8257 if (IT_DISPLAYING_WHITESPACE (it
))
8261 /* We have reached a glyph that follows one or more
8262 whitespace characters. If the position is
8263 already found, we are done. */
8264 if (atpos_it
.sp
>= 0)
8266 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8267 result
= MOVE_POS_MATCH_OR_ZV
;
8272 RESTORE_IT (it
, &atx_it
, atx_data
);
8273 result
= MOVE_X_REACHED
;
8276 /* Otherwise, we can wrap here. */
8277 SAVE_IT (wrap_it
, *it
, wrap_data
);
8283 /* Remember the line height for the current line, in case
8284 the next element doesn't fit on the line. */
8285 ascent
= it
->max_ascent
;
8286 descent
= it
->max_descent
;
8288 /* The call to produce_glyphs will get the metrics of the
8289 display element IT is loaded with. Record the x-position
8290 before this display element, in case it doesn't fit on the
8294 PRODUCE_GLYPHS (it
);
8296 if (it
->area
!= TEXT_AREA
)
8298 prev_method
= it
->method
;
8299 if (it
->method
== GET_FROM_BUFFER
)
8300 prev_pos
= IT_CHARPOS (*it
);
8301 set_iterator_to_next (it
, 1);
8302 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8303 SET_TEXT_POS (this_line_min_pos
,
8304 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8306 && (op
& MOVE_TO_POS
)
8307 && IT_CHARPOS (*it
) > to_charpos
8308 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8309 SAVE_IT (ppos_it
, *it
, ppos_data
);
8313 /* The number of glyphs we get back in IT->nglyphs will normally
8314 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8315 character on a terminal frame, or (iii) a line end. For the
8316 second case, IT->nglyphs - 1 padding glyphs will be present.
8317 (On X frames, there is only one glyph produced for a
8318 composite character.)
8320 The behavior implemented below means, for continuation lines,
8321 that as many spaces of a TAB as fit on the current line are
8322 displayed there. For terminal frames, as many glyphs of a
8323 multi-glyph character are displayed in the current line, too.
8324 This is what the old redisplay code did, and we keep it that
8325 way. Under X, the whole shape of a complex character must
8326 fit on the line or it will be completely displayed in the
8329 Note that both for tabs and padding glyphs, all glyphs have
8333 /* More than one glyph or glyph doesn't fit on line. All
8334 glyphs have the same width. */
8335 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8337 int x_before_this_char
= x
;
8338 int hpos_before_this_char
= it
->hpos
;
8340 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8342 new_x
= x
+ single_glyph_width
;
8344 /* We want to leave anything reaching TO_X to the caller. */
8345 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8347 if (BUFFER_POS_REACHED_P ())
8349 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8350 goto buffer_pos_reached
;
8351 if (atpos_it
.sp
< 0)
8353 SAVE_IT (atpos_it
, *it
, atpos_data
);
8354 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8359 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8362 result
= MOVE_X_REACHED
;
8367 SAVE_IT (atx_it
, *it
, atx_data
);
8368 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8373 if (/* Lines are continued. */
8374 it
->line_wrap
!= TRUNCATE
8375 && (/* And glyph doesn't fit on the line. */
8376 new_x
> it
->last_visible_x
8377 /* Or it fits exactly and we're on a window
8379 || (new_x
== it
->last_visible_x
8380 && FRAME_WINDOW_P (it
->f
)
8381 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8382 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8383 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8385 if (/* IT->hpos == 0 means the very first glyph
8386 doesn't fit on the line, e.g. a wide image. */
8388 || (new_x
== it
->last_visible_x
8389 && FRAME_WINDOW_P (it
->f
)))
8392 it
->current_x
= new_x
;
8394 /* The character's last glyph just barely fits
8396 if (i
== it
->nglyphs
- 1)
8398 /* If this is the destination position,
8399 return a position *before* it in this row,
8400 now that we know it fits in this row. */
8401 if (BUFFER_POS_REACHED_P ())
8403 if (it
->line_wrap
!= WORD_WRAP
8406 it
->hpos
= hpos_before_this_char
;
8407 it
->current_x
= x_before_this_char
;
8408 result
= MOVE_POS_MATCH_OR_ZV
;
8411 if (it
->line_wrap
== WORD_WRAP
8414 SAVE_IT (atpos_it
, *it
, atpos_data
);
8415 atpos_it
.current_x
= x_before_this_char
;
8416 atpos_it
.hpos
= hpos_before_this_char
;
8420 prev_method
= it
->method
;
8421 if (it
->method
== GET_FROM_BUFFER
)
8422 prev_pos
= IT_CHARPOS (*it
);
8423 set_iterator_to_next (it
, 1);
8424 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8425 SET_TEXT_POS (this_line_min_pos
,
8426 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8427 /* On graphical terminals, newlines may
8428 "overflow" into the fringe if
8429 overflow-newline-into-fringe is non-nil.
8430 On text terminals, and on graphical
8431 terminals with no right margin, newlines
8432 may overflow into the last glyph on the
8434 if (!FRAME_WINDOW_P (it
->f
)
8436 && it
->bidi_it
.paragraph_dir
== R2L
)
8437 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8438 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8439 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8441 if (!get_next_display_element (it
))
8443 result
= MOVE_POS_MATCH_OR_ZV
;
8446 if (BUFFER_POS_REACHED_P ())
8448 if (ITERATOR_AT_END_OF_LINE_P (it
))
8449 result
= MOVE_POS_MATCH_OR_ZV
;
8451 result
= MOVE_LINE_CONTINUED
;
8454 if (ITERATOR_AT_END_OF_LINE_P (it
))
8456 result
= MOVE_NEWLINE_OR_CR
;
8463 IT_RESET_X_ASCENT_DESCENT (it
);
8465 if (wrap_it
.sp
>= 0)
8467 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8472 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8474 result
= MOVE_LINE_CONTINUED
;
8478 if (BUFFER_POS_REACHED_P ())
8480 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8481 goto buffer_pos_reached
;
8482 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8484 SAVE_IT (atpos_it
, *it
, atpos_data
);
8485 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8489 if (new_x
> it
->first_visible_x
)
8491 /* Glyph is visible. Increment number of glyphs that
8492 would be displayed. */
8497 if (result
!= MOVE_UNDEFINED
)
8500 else if (BUFFER_POS_REACHED_P ())
8503 IT_RESET_X_ASCENT_DESCENT (it
);
8504 result
= MOVE_POS_MATCH_OR_ZV
;
8507 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8509 /* Stop when TO_X specified and reached. This check is
8510 necessary here because of lines consisting of a line end,
8511 only. The line end will not produce any glyphs and we
8512 would never get MOVE_X_REACHED. */
8513 eassert (it
->nglyphs
== 0);
8514 result
= MOVE_X_REACHED
;
8518 /* Is this a line end? If yes, we're done. */
8519 if (ITERATOR_AT_END_OF_LINE_P (it
))
8521 /* If we are past TO_CHARPOS, but never saw any character
8522 positions smaller than TO_CHARPOS, return
8523 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8525 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8527 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8529 if (IT_CHARPOS (ppos_it
) < ZV
)
8531 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8532 result
= MOVE_POS_MATCH_OR_ZV
;
8535 goto buffer_pos_reached
;
8537 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8538 && IT_CHARPOS (*it
) > to_charpos
)
8539 goto buffer_pos_reached
;
8541 result
= MOVE_NEWLINE_OR_CR
;
8544 result
= MOVE_NEWLINE_OR_CR
;
8548 prev_method
= it
->method
;
8549 if (it
->method
== GET_FROM_BUFFER
)
8550 prev_pos
= IT_CHARPOS (*it
);
8551 /* The current display element has been consumed. Advance
8553 set_iterator_to_next (it
, 1);
8554 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8555 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8556 if (IT_CHARPOS (*it
) < to_charpos
)
8557 saw_smaller_pos
= 1;
8559 && (op
& MOVE_TO_POS
)
8560 && IT_CHARPOS (*it
) >= to_charpos
8561 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8562 SAVE_IT (ppos_it
, *it
, ppos_data
);
8564 /* Stop if lines are truncated and IT's current x-position is
8565 past the right edge of the window now. */
8566 if (it
->line_wrap
== TRUNCATE
8567 && it
->current_x
>= it
->last_visible_x
)
8569 if (!FRAME_WINDOW_P (it
->f
)
8570 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8571 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8572 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8573 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8577 if ((at_eob_p
= !get_next_display_element (it
))
8578 || BUFFER_POS_REACHED_P ()
8579 /* If we are past TO_CHARPOS, but never saw any
8580 character positions smaller than TO_CHARPOS,
8581 return MOVE_POS_MATCH_OR_ZV, like the
8582 unidirectional display did. */
8583 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8585 && IT_CHARPOS (*it
) > to_charpos
))
8588 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8589 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8590 result
= MOVE_POS_MATCH_OR_ZV
;
8593 if (ITERATOR_AT_END_OF_LINE_P (it
))
8595 result
= MOVE_NEWLINE_OR_CR
;
8599 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8601 && IT_CHARPOS (*it
) > to_charpos
)
8603 if (IT_CHARPOS (ppos_it
) < ZV
)
8604 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8605 result
= MOVE_POS_MATCH_OR_ZV
;
8608 result
= MOVE_LINE_TRUNCATED
;
8611 #undef IT_RESET_X_ASCENT_DESCENT
8614 #undef BUFFER_POS_REACHED_P
8616 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8617 restore the saved iterator. */
8618 if (atpos_it
.sp
>= 0)
8619 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8620 else if (atx_it
.sp
>= 0)
8621 RESTORE_IT (it
, &atx_it
, atx_data
);
8626 bidi_unshelve_cache (atpos_data
, 1);
8628 bidi_unshelve_cache (atx_data
, 1);
8630 bidi_unshelve_cache (wrap_data
, 1);
8632 bidi_unshelve_cache (ppos_data
, 1);
8634 /* Restore the iterator settings altered at the beginning of this
8636 it
->glyph_row
= saved_glyph_row
;
8640 /* For external use. */
8642 move_it_in_display_line (struct it
*it
,
8643 ptrdiff_t to_charpos
, int to_x
,
8644 enum move_operation_enum op
)
8646 if (it
->line_wrap
== WORD_WRAP
8647 && (op
& MOVE_TO_X
))
8650 void *save_data
= NULL
;
8653 SAVE_IT (save_it
, *it
, save_data
);
8654 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8655 /* When word-wrap is on, TO_X may lie past the end
8656 of a wrapped line. Then it->current is the
8657 character on the next line, so backtrack to the
8658 space before the wrap point. */
8659 if (skip
== MOVE_LINE_CONTINUED
)
8661 int prev_x
= max (it
->current_x
- 1, 0);
8662 RESTORE_IT (it
, &save_it
, save_data
);
8663 move_it_in_display_line_to
8664 (it
, -1, prev_x
, MOVE_TO_X
);
8667 bidi_unshelve_cache (save_data
, 1);
8670 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8674 /* Move IT forward until it satisfies one or more of the criteria in
8675 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8677 OP is a bit-mask that specifies where to stop, and in particular,
8678 which of those four position arguments makes a difference. See the
8679 description of enum move_operation_enum.
8681 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8682 screen line, this function will set IT to the next position that is
8683 displayed to the right of TO_CHARPOS on the screen. */
8686 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8688 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8689 int line_height
, line_start_x
= 0, reached
= 0;
8690 void *backup_data
= NULL
;
8694 if (op
& MOVE_TO_VPOS
)
8696 /* If no TO_CHARPOS and no TO_X specified, stop at the
8697 start of the line TO_VPOS. */
8698 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8700 if (it
->vpos
== to_vpos
)
8706 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8710 /* TO_VPOS >= 0 means stop at TO_X in the line at
8711 TO_VPOS, or at TO_POS, whichever comes first. */
8712 if (it
->vpos
== to_vpos
)
8718 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8720 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8725 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8727 /* We have reached TO_X but not in the line we want. */
8728 skip
= move_it_in_display_line_to (it
, to_charpos
,
8730 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8738 else if (op
& MOVE_TO_Y
)
8740 struct it it_backup
;
8742 if (it
->line_wrap
== WORD_WRAP
)
8743 SAVE_IT (it_backup
, *it
, backup_data
);
8745 /* TO_Y specified means stop at TO_X in the line containing
8746 TO_Y---or at TO_CHARPOS if this is reached first. The
8747 problem is that we can't really tell whether the line
8748 contains TO_Y before we have completely scanned it, and
8749 this may skip past TO_X. What we do is to first scan to
8752 If TO_X is not specified, use a TO_X of zero. The reason
8753 is to make the outcome of this function more predictable.
8754 If we didn't use TO_X == 0, we would stop at the end of
8755 the line which is probably not what a caller would expect
8757 skip
= move_it_in_display_line_to
8758 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8759 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8761 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8762 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8764 else if (skip
== MOVE_X_REACHED
)
8766 /* If TO_X was reached, we want to know whether TO_Y is
8767 in the line. We know this is the case if the already
8768 scanned glyphs make the line tall enough. Otherwise,
8769 we must check by scanning the rest of the line. */
8770 line_height
= it
->max_ascent
+ it
->max_descent
;
8771 if (to_y
>= it
->current_y
8772 && to_y
< it
->current_y
+ line_height
)
8777 SAVE_IT (it_backup
, *it
, backup_data
);
8778 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8779 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8781 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8782 line_height
= it
->max_ascent
+ it
->max_descent
;
8783 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8785 if (to_y
>= it
->current_y
8786 && to_y
< it
->current_y
+ line_height
)
8788 /* If TO_Y is in this line and TO_X was reached
8789 above, we scanned too far. We have to restore
8790 IT's settings to the ones before skipping. But
8791 keep the more accurate values of max_ascent and
8792 max_descent we've found while skipping the rest
8793 of the line, for the sake of callers, such as
8794 pos_visible_p, that need to know the line
8796 int max_ascent
= it
->max_ascent
;
8797 int max_descent
= it
->max_descent
;
8799 RESTORE_IT (it
, &it_backup
, backup_data
);
8800 it
->max_ascent
= max_ascent
;
8801 it
->max_descent
= max_descent
;
8807 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8813 /* Check whether TO_Y is in this line. */
8814 line_height
= it
->max_ascent
+ it
->max_descent
;
8815 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8817 if (to_y
>= it
->current_y
8818 && to_y
< it
->current_y
+ line_height
)
8820 /* When word-wrap is on, TO_X may lie past the end
8821 of a wrapped line. Then it->current is the
8822 character on the next line, so backtrack to the
8823 space before the wrap point. */
8824 if (skip
== MOVE_LINE_CONTINUED
8825 && it
->line_wrap
== WORD_WRAP
)
8827 int prev_x
= max (it
->current_x
- 1, 0);
8828 RESTORE_IT (it
, &it_backup
, backup_data
);
8829 skip
= move_it_in_display_line_to
8830 (it
, -1, prev_x
, MOVE_TO_X
);
8839 else if (BUFFERP (it
->object
)
8840 && (it
->method
== GET_FROM_BUFFER
8841 || it
->method
== GET_FROM_STRETCH
)
8842 && IT_CHARPOS (*it
) >= to_charpos
8843 /* Under bidi iteration, a call to set_iterator_to_next
8844 can scan far beyond to_charpos if the initial
8845 portion of the next line needs to be reordered. In
8846 that case, give move_it_in_display_line_to another
8849 && it
->bidi_it
.scan_dir
== -1))
8850 skip
= MOVE_POS_MATCH_OR_ZV
;
8852 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8856 case MOVE_POS_MATCH_OR_ZV
:
8860 case MOVE_NEWLINE_OR_CR
:
8861 set_iterator_to_next (it
, 1);
8862 it
->continuation_lines_width
= 0;
8865 case MOVE_LINE_TRUNCATED
:
8866 it
->continuation_lines_width
= 0;
8867 reseat_at_next_visible_line_start (it
, 0);
8868 if ((op
& MOVE_TO_POS
) != 0
8869 && IT_CHARPOS (*it
) > to_charpos
)
8876 case MOVE_LINE_CONTINUED
:
8877 /* For continued lines ending in a tab, some of the glyphs
8878 associated with the tab are displayed on the current
8879 line. Since it->current_x does not include these glyphs,
8880 we use it->last_visible_x instead. */
8883 it
->continuation_lines_width
+= it
->last_visible_x
;
8884 /* When moving by vpos, ensure that the iterator really
8885 advances to the next line (bug#847, bug#969). Fixme:
8886 do we need to do this in other circumstances? */
8887 if (it
->current_x
!= it
->last_visible_x
8888 && (op
& MOVE_TO_VPOS
)
8889 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8891 line_start_x
= it
->current_x
+ it
->pixel_width
8892 - it
->last_visible_x
;
8893 set_iterator_to_next (it
, 0);
8897 it
->continuation_lines_width
+= it
->current_x
;
8904 /* Reset/increment for the next run. */
8905 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8906 it
->current_x
= line_start_x
;
8909 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8911 last_height
= it
->max_ascent
+ it
->max_descent
;
8912 last_max_ascent
= it
->max_ascent
;
8913 it
->max_ascent
= it
->max_descent
= 0;
8918 /* On text terminals, we may stop at the end of a line in the middle
8919 of a multi-character glyph. If the glyph itself is continued,
8920 i.e. it is actually displayed on the next line, don't treat this
8921 stopping point as valid; move to the next line instead (unless
8922 that brings us offscreen). */
8923 if (!FRAME_WINDOW_P (it
->f
)
8925 && IT_CHARPOS (*it
) == to_charpos
8926 && it
->what
== IT_CHARACTER
8928 && it
->line_wrap
== WINDOW_WRAP
8929 && it
->current_x
== it
->last_visible_x
- 1
8932 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8934 it
->continuation_lines_width
+= it
->current_x
;
8935 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8936 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8938 last_height
= it
->max_ascent
+ it
->max_descent
;
8939 last_max_ascent
= it
->max_ascent
;
8943 bidi_unshelve_cache (backup_data
, 1);
8945 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8949 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8951 If DY > 0, move IT backward at least that many pixels. DY = 0
8952 means move IT backward to the preceding line start or BEGV. This
8953 function may move over more than DY pixels if IT->current_y - DY
8954 ends up in the middle of a line; in this case IT->current_y will be
8955 set to the top of the line moved to. */
8958 move_it_vertically_backward (struct it
*it
, int dy
)
8962 void *it2data
= NULL
, *it3data
= NULL
;
8963 ptrdiff_t start_pos
;
8968 start_pos
= IT_CHARPOS (*it
);
8970 /* Estimate how many newlines we must move back. */
8971 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8973 /* Set the iterator's position that many lines back. */
8974 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8975 back_to_previous_visible_line_start (it
);
8977 /* Reseat the iterator here. When moving backward, we don't want
8978 reseat to skip forward over invisible text, set up the iterator
8979 to deliver from overlay strings at the new position etc. So,
8980 use reseat_1 here. */
8981 reseat_1 (it
, it
->current
.pos
, 1);
8983 /* We are now surely at a line start. */
8984 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8985 reordering is in effect. */
8986 it
->continuation_lines_width
= 0;
8988 /* Move forward and see what y-distance we moved. First move to the
8989 start of the next line so that we get its height. We need this
8990 height to be able to tell whether we reached the specified
8992 SAVE_IT (it2
, *it
, it2data
);
8993 it2
.max_ascent
= it2
.max_descent
= 0;
8996 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8997 MOVE_TO_POS
| MOVE_TO_VPOS
);
8999 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9000 /* If we are in a display string which starts at START_POS,
9001 and that display string includes a newline, and we are
9002 right after that newline (i.e. at the beginning of a
9003 display line), exit the loop, because otherwise we will
9004 infloop, since move_it_to will see that it is already at
9005 START_POS and will not move. */
9006 || (it2
.method
== GET_FROM_STRING
9007 && IT_CHARPOS (it2
) == start_pos
9008 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9009 eassert (IT_CHARPOS (*it
) >= BEGV
);
9010 SAVE_IT (it3
, it2
, it3data
);
9012 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9013 eassert (IT_CHARPOS (*it
) >= BEGV
);
9014 /* H is the actual vertical distance from the position in *IT
9015 and the starting position. */
9016 h
= it2
.current_y
- it
->current_y
;
9017 /* NLINES is the distance in number of lines. */
9018 nlines
= it2
.vpos
- it
->vpos
;
9020 /* Correct IT's y and vpos position
9021 so that they are relative to the starting point. */
9027 /* DY == 0 means move to the start of the screen line. The
9028 value of nlines is > 0 if continuation lines were involved,
9029 or if the original IT position was at start of a line. */
9030 RESTORE_IT (it
, it
, it2data
);
9032 move_it_by_lines (it
, nlines
);
9033 /* The above code moves us to some position NLINES down,
9034 usually to its first glyph (leftmost in an L2R line), but
9035 that's not necessarily the start of the line, under bidi
9036 reordering. We want to get to the character position
9037 that is immediately after the newline of the previous
9040 && !it
->continuation_lines_width
9041 && !STRINGP (it
->string
)
9042 && IT_CHARPOS (*it
) > BEGV
9043 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9046 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
9048 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
9050 bidi_unshelve_cache (it3data
, 1);
9054 /* The y-position we try to reach, relative to *IT.
9055 Note that H has been subtracted in front of the if-statement. */
9056 int target_y
= it
->current_y
+ h
- dy
;
9057 int y0
= it3
.current_y
;
9061 RESTORE_IT (&it3
, &it3
, it3data
);
9062 y1
= line_bottom_y (&it3
);
9063 line_height
= y1
- y0
;
9064 RESTORE_IT (it
, it
, it2data
);
9065 /* If we did not reach target_y, try to move further backward if
9066 we can. If we moved too far backward, try to move forward. */
9067 if (target_y
< it
->current_y
9068 /* This is heuristic. In a window that's 3 lines high, with
9069 a line height of 13 pixels each, recentering with point
9070 on the bottom line will try to move -39/2 = 19 pixels
9071 backward. Try to avoid moving into the first line. */
9072 && (it
->current_y
- target_y
9073 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9074 && IT_CHARPOS (*it
) > BEGV
)
9076 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9077 target_y
- it
->current_y
));
9078 dy
= it
->current_y
- target_y
;
9079 goto move_further_back
;
9081 else if (target_y
>= it
->current_y
+ line_height
9082 && IT_CHARPOS (*it
) < ZV
)
9084 /* Should move forward by at least one line, maybe more.
9086 Note: Calling move_it_by_lines can be expensive on
9087 terminal frames, where compute_motion is used (via
9088 vmotion) to do the job, when there are very long lines
9089 and truncate-lines is nil. That's the reason for
9090 treating terminal frames specially here. */
9092 if (!FRAME_WINDOW_P (it
->f
))
9093 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9098 move_it_by_lines (it
, 1);
9100 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9107 /* Move IT by a specified amount of pixel lines DY. DY negative means
9108 move backwards. DY = 0 means move to start of screen line. At the
9109 end, IT will be on the start of a screen line. */
9112 move_it_vertically (struct it
*it
, int dy
)
9115 move_it_vertically_backward (it
, -dy
);
9118 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9119 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9120 MOVE_TO_POS
| MOVE_TO_Y
);
9121 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9123 /* If buffer ends in ZV without a newline, move to the start of
9124 the line to satisfy the post-condition. */
9125 if (IT_CHARPOS (*it
) == ZV
9127 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9128 move_it_by_lines (it
, 0);
9133 /* Move iterator IT past the end of the text line it is in. */
9136 move_it_past_eol (struct it
*it
)
9138 enum move_it_result rc
;
9140 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9141 if (rc
== MOVE_NEWLINE_OR_CR
)
9142 set_iterator_to_next (it
, 0);
9146 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9147 negative means move up. DVPOS == 0 means move to the start of the
9150 Optimization idea: If we would know that IT->f doesn't use
9151 a face with proportional font, we could be faster for
9152 truncate-lines nil. */
9155 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9158 /* The commented-out optimization uses vmotion on terminals. This
9159 gives bad results, because elements like it->what, on which
9160 callers such as pos_visible_p rely, aren't updated. */
9161 /* struct position pos;
9162 if (!FRAME_WINDOW_P (it->f))
9164 struct text_pos textpos;
9166 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9167 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9168 reseat (it, textpos, 1);
9169 it->vpos += pos.vpos;
9170 it->current_y += pos.vpos;
9176 /* DVPOS == 0 means move to the start of the screen line. */
9177 move_it_vertically_backward (it
, 0);
9178 /* Let next call to line_bottom_y calculate real line height */
9183 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9184 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9186 /* Only move to the next buffer position if we ended up in a
9187 string from display property, not in an overlay string
9188 (before-string or after-string). That is because the
9189 latter don't conceal the underlying buffer position, so
9190 we can ask to move the iterator to the exact position we
9191 are interested in. Note that, even if we are already at
9192 IT_CHARPOS (*it), the call below is not a no-op, as it
9193 will detect that we are at the end of the string, pop the
9194 iterator, and compute it->current_x and it->hpos
9196 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9197 -1, -1, -1, MOVE_TO_POS
);
9203 void *it2data
= NULL
;
9204 ptrdiff_t start_charpos
, i
;
9206 /* Start at the beginning of the screen line containing IT's
9207 position. This may actually move vertically backwards,
9208 in case of overlays, so adjust dvpos accordingly. */
9210 move_it_vertically_backward (it
, 0);
9213 /* Go back -DVPOS visible lines and reseat the iterator there. */
9214 start_charpos
= IT_CHARPOS (*it
);
9215 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
9216 back_to_previous_visible_line_start (it
);
9217 reseat (it
, it
->current
.pos
, 1);
9219 /* Move further back if we end up in a string or an image. */
9220 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9222 /* First try to move to start of display line. */
9224 move_it_vertically_backward (it
, 0);
9226 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9228 /* If start of line is still in string or image,
9229 move further back. */
9230 back_to_previous_visible_line_start (it
);
9231 reseat (it
, it
->current
.pos
, 1);
9235 it
->current_x
= it
->hpos
= 0;
9237 /* Above call may have moved too far if continuation lines
9238 are involved. Scan forward and see if it did. */
9239 SAVE_IT (it2
, *it
, it2data
);
9240 it2
.vpos
= it2
.current_y
= 0;
9241 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9242 it
->vpos
-= it2
.vpos
;
9243 it
->current_y
-= it2
.current_y
;
9244 it
->current_x
= it
->hpos
= 0;
9246 /* If we moved too far back, move IT some lines forward. */
9247 if (it2
.vpos
> -dvpos
)
9249 int delta
= it2
.vpos
+ dvpos
;
9251 RESTORE_IT (&it2
, &it2
, it2data
);
9252 SAVE_IT (it2
, *it
, it2data
);
9253 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9254 /* Move back again if we got too far ahead. */
9255 if (IT_CHARPOS (*it
) >= start_charpos
)
9256 RESTORE_IT (it
, &it2
, it2data
);
9258 bidi_unshelve_cache (it2data
, 1);
9261 RESTORE_IT (it
, it
, it2data
);
9265 /* Return 1 if IT points into the middle of a display vector. */
9268 in_display_vector_p (struct it
*it
)
9270 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9271 && it
->current
.dpvec_index
> 0
9272 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9276 /***********************************************************************
9278 ***********************************************************************/
9281 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9285 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9287 Lisp_Object args
[3];
9288 Lisp_Object msg
, fmt
;
9291 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9294 /* Do nothing if called asynchronously. Inserting text into
9295 a buffer may call after-change-functions and alike and
9296 that would means running Lisp asynchronously. */
9297 if (handling_signal
)
9301 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9303 args
[0] = fmt
= build_string (format
);
9306 msg
= Fformat (3, args
);
9308 len
= SBYTES (msg
) + 1;
9309 buffer
= SAFE_ALLOCA (len
);
9310 memcpy (buffer
, SDATA (msg
), len
);
9312 message_dolog (buffer
, len
- 1, 1, 0);
9319 /* Output a newline in the *Messages* buffer if "needs" one. */
9322 message_log_maybe_newline (void)
9324 if (message_log_need_newline
)
9325 message_dolog ("", 0, 1, 0);
9329 /* Add a string M of length NBYTES to the message log, optionally
9330 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9331 nonzero, means interpret the contents of M as multibyte. This
9332 function calls low-level routines in order to bypass text property
9333 hooks, etc. which might not be safe to run.
9335 This may GC (insert may run before/after change hooks),
9336 so the buffer M must NOT point to a Lisp string. */
9339 message_dolog (const char *m
, ptrdiff_t nbytes
, int nlflag
, int multibyte
)
9341 const unsigned char *msg
= (const unsigned char *) m
;
9343 if (!NILP (Vmemory_full
))
9346 if (!NILP (Vmessage_log_max
))
9348 struct buffer
*oldbuf
;
9349 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9350 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9351 ptrdiff_t point_at_end
= 0;
9352 ptrdiff_t zv_at_end
= 0;
9353 Lisp_Object old_deactivate_mark
, tem
;
9354 struct gcpro gcpro1
;
9356 old_deactivate_mark
= Vdeactivate_mark
;
9357 oldbuf
= current_buffer
;
9358 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9359 bset_undo_list (current_buffer
, Qt
);
9361 oldpoint
= message_dolog_marker1
;
9362 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9363 oldbegv
= message_dolog_marker2
;
9364 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9365 oldzv
= message_dolog_marker3
;
9366 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9367 GCPRO1 (old_deactivate_mark
);
9375 BEGV_BYTE
= BEG_BYTE
;
9378 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9380 /* Insert the string--maybe converting multibyte to single byte
9381 or vice versa, so that all the text fits the buffer. */
9383 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9389 /* Convert a multibyte string to single-byte
9390 for the *Message* buffer. */
9391 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9393 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9394 work
[0] = (ASCII_CHAR_P (c
)
9396 : multibyte_char_to_unibyte (c
));
9397 insert_1_both (work
, 1, 1, 1, 0, 0);
9400 else if (! multibyte
9401 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9405 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9406 /* Convert a single-byte string to multibyte
9407 for the *Message* buffer. */
9408 for (i
= 0; i
< nbytes
; i
++)
9411 MAKE_CHAR_MULTIBYTE (c
);
9412 char_bytes
= CHAR_STRING (c
, str
);
9413 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9417 insert_1 (m
, nbytes
, 1, 0, 0);
9421 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9423 insert_1 ("\n", 1, 1, 0, 0);
9425 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9427 this_bol_byte
= PT_BYTE
;
9429 /* See if this line duplicates the previous one.
9430 If so, combine duplicates. */
9433 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9435 prev_bol_byte
= PT_BYTE
;
9437 dups
= message_log_check_duplicate (prev_bol_byte
,
9441 del_range_both (prev_bol
, prev_bol_byte
,
9442 this_bol
, this_bol_byte
, 0);
9445 char dupstr
[sizeof " [ times]"
9446 + INT_STRLEN_BOUND (printmax_t
)];
9448 /* If you change this format, don't forget to also
9449 change message_log_check_duplicate. */
9450 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9451 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9452 insert_1 (dupstr
, duplen
, 1, 0, 1);
9457 /* If we have more than the desired maximum number of lines
9458 in the *Messages* buffer now, delete the oldest ones.
9459 This is safe because we don't have undo in this buffer. */
9461 if (NATNUMP (Vmessage_log_max
))
9463 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9464 -XFASTINT (Vmessage_log_max
) - 1, 0);
9465 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9468 BEGV
= XMARKER (oldbegv
)->charpos
;
9469 BEGV_BYTE
= marker_byte_position (oldbegv
);
9478 ZV
= XMARKER (oldzv
)->charpos
;
9479 ZV_BYTE
= marker_byte_position (oldzv
);
9483 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9485 /* We can't do Fgoto_char (oldpoint) because it will run some
9487 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9488 XMARKER (oldpoint
)->bytepos
);
9491 unchain_marker (XMARKER (oldpoint
));
9492 unchain_marker (XMARKER (oldbegv
));
9493 unchain_marker (XMARKER (oldzv
));
9495 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9496 set_buffer_internal (oldbuf
);
9498 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9499 message_log_need_newline
= !nlflag
;
9500 Vdeactivate_mark
= old_deactivate_mark
;
9505 /* We are at the end of the buffer after just having inserted a newline.
9506 (Note: We depend on the fact we won't be crossing the gap.)
9507 Check to see if the most recent message looks a lot like the previous one.
9508 Return 0 if different, 1 if the new one should just replace it, or a
9509 value N > 1 if we should also append " [N times]". */
9512 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9515 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9517 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9518 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9520 for (i
= 0; i
< len
; i
++)
9522 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9530 if (*p1
++ == ' ' && *p1
++ == '[')
9533 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9534 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9541 /* Display an echo area message M with a specified length of NBYTES
9542 bytes. The string may include null characters. If M is 0, clear
9543 out any existing message, and let the mini-buffer text show
9546 This may GC, so the buffer M must NOT point to a Lisp string. */
9549 message2 (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9551 /* First flush out any partial line written with print. */
9552 message_log_maybe_newline ();
9554 message_dolog (m
, nbytes
, 1, multibyte
);
9555 message2_nolog (m
, nbytes
, multibyte
);
9559 /* The non-logging counterpart of message2. */
9562 message2_nolog (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9564 struct frame
*sf
= SELECTED_FRAME ();
9565 message_enable_multibyte
= multibyte
;
9567 if (FRAME_INITIAL_P (sf
))
9569 if (noninteractive_need_newline
)
9570 putc ('\n', stderr
);
9571 noninteractive_need_newline
= 0;
9573 fwrite (m
, nbytes
, 1, stderr
);
9574 if (cursor_in_echo_area
== 0)
9575 fprintf (stderr
, "\n");
9578 /* A null message buffer means that the frame hasn't really been
9579 initialized yet. Error messages get reported properly by
9580 cmd_error, so this must be just an informative message; toss it. */
9581 else if (INTERACTIVE
9582 && sf
->glyphs_initialized_p
9583 && FRAME_MESSAGE_BUF (sf
))
9585 Lisp_Object mini_window
;
9588 /* Get the frame containing the mini-buffer
9589 that the selected frame is using. */
9590 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9591 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9593 FRAME_SAMPLE_VISIBILITY (f
);
9594 if (FRAME_VISIBLE_P (sf
)
9595 && ! FRAME_VISIBLE_P (f
))
9596 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9600 set_message (m
, Qnil
, nbytes
, multibyte
);
9601 if (minibuffer_auto_raise
)
9602 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9605 clear_message (1, 1);
9607 do_pending_window_change (0);
9608 echo_area_display (1);
9609 do_pending_window_change (0);
9610 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9611 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9616 /* Display an echo area message M with a specified length of NBYTES
9617 bytes. The string may include null characters. If M is not a
9618 string, clear out any existing message, and let the mini-buffer
9621 This function cancels echoing. */
9624 message3 (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9626 struct gcpro gcpro1
;
9629 clear_message (1,1);
9632 /* First flush out any partial line written with print. */
9633 message_log_maybe_newline ();
9637 char *buffer
= SAFE_ALLOCA (nbytes
);
9638 memcpy (buffer
, SDATA (m
), nbytes
);
9639 message_dolog (buffer
, nbytes
, 1, multibyte
);
9642 message3_nolog (m
, nbytes
, multibyte
);
9648 /* The non-logging version of message3.
9649 This does not cancel echoing, because it is used for echoing.
9650 Perhaps we need to make a separate function for echoing
9651 and make this cancel echoing. */
9654 message3_nolog (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9656 struct frame
*sf
= SELECTED_FRAME ();
9657 message_enable_multibyte
= multibyte
;
9659 if (FRAME_INITIAL_P (sf
))
9661 if (noninteractive_need_newline
)
9662 putc ('\n', stderr
);
9663 noninteractive_need_newline
= 0;
9665 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9666 if (cursor_in_echo_area
== 0)
9667 fprintf (stderr
, "\n");
9670 /* A null message buffer means that the frame hasn't really been
9671 initialized yet. Error messages get reported properly by
9672 cmd_error, so this must be just an informative message; toss it. */
9673 else if (INTERACTIVE
9674 && sf
->glyphs_initialized_p
9675 && FRAME_MESSAGE_BUF (sf
))
9677 Lisp_Object mini_window
;
9681 /* Get the frame containing the mini-buffer
9682 that the selected frame is using. */
9683 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9684 frame
= XWINDOW (mini_window
)->frame
;
9687 FRAME_SAMPLE_VISIBILITY (f
);
9688 if (FRAME_VISIBLE_P (sf
)
9689 && !FRAME_VISIBLE_P (f
))
9690 Fmake_frame_visible (frame
);
9692 if (STRINGP (m
) && SCHARS (m
) > 0)
9694 set_message (NULL
, m
, nbytes
, multibyte
);
9695 if (minibuffer_auto_raise
)
9696 Fraise_frame (frame
);
9697 /* Assume we are not echoing.
9698 (If we are, echo_now will override this.) */
9699 echo_message_buffer
= Qnil
;
9702 clear_message (1, 1);
9704 do_pending_window_change (0);
9705 echo_area_display (1);
9706 do_pending_window_change (0);
9707 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9708 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9713 /* Display a null-terminated echo area message M. If M is 0, clear
9714 out any existing message, and let the mini-buffer text show through.
9716 The buffer M must continue to exist until after the echo area gets
9717 cleared or some other message gets displayed there. Do not pass
9718 text that is stored in a Lisp string. Do not pass text in a buffer
9719 that was alloca'd. */
9722 message1 (const char *m
)
9724 message2 (m
, (m
? strlen (m
) : 0), 0);
9728 /* The non-logging counterpart of message1. */
9731 message1_nolog (const char *m
)
9733 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9736 /* Display a message M which contains a single %s
9737 which gets replaced with STRING. */
9740 message_with_string (const char *m
, Lisp_Object string
, int log
)
9742 CHECK_STRING (string
);
9748 if (noninteractive_need_newline
)
9749 putc ('\n', stderr
);
9750 noninteractive_need_newline
= 0;
9751 fprintf (stderr
, m
, SDATA (string
));
9752 if (!cursor_in_echo_area
)
9753 fprintf (stderr
, "\n");
9757 else if (INTERACTIVE
)
9759 /* The frame whose minibuffer we're going to display the message on.
9760 It may be larger than the selected frame, so we need
9761 to use its buffer, not the selected frame's buffer. */
9762 Lisp_Object mini_window
;
9763 struct frame
*f
, *sf
= SELECTED_FRAME ();
9765 /* Get the frame containing the minibuffer
9766 that the selected frame is using. */
9767 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9768 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9770 /* A null message buffer means that the frame hasn't really been
9771 initialized yet. Error messages get reported properly by
9772 cmd_error, so this must be just an informative message; toss it. */
9773 if (FRAME_MESSAGE_BUF (f
))
9775 Lisp_Object args
[2], msg
;
9776 struct gcpro gcpro1
, gcpro2
;
9778 args
[0] = build_string (m
);
9779 args
[1] = msg
= string
;
9780 GCPRO2 (args
[0], msg
);
9783 msg
= Fformat (2, args
);
9786 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9788 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9792 /* Print should start at the beginning of the message
9793 buffer next time. */
9794 message_buf_print
= 0;
9800 /* Dump an informative message to the minibuf. If M is 0, clear out
9801 any existing message, and let the mini-buffer text show through. */
9804 vmessage (const char *m
, va_list ap
)
9810 if (noninteractive_need_newline
)
9811 putc ('\n', stderr
);
9812 noninteractive_need_newline
= 0;
9813 vfprintf (stderr
, m
, ap
);
9814 if (cursor_in_echo_area
== 0)
9815 fprintf (stderr
, "\n");
9819 else if (INTERACTIVE
)
9821 /* The frame whose mini-buffer we're going to display the message
9822 on. It may be larger than the selected frame, so we need to
9823 use its buffer, not the selected frame's buffer. */
9824 Lisp_Object mini_window
;
9825 struct frame
*f
, *sf
= SELECTED_FRAME ();
9827 /* Get the frame containing the mini-buffer
9828 that the selected frame is using. */
9829 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9830 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9832 /* A null message buffer means that the frame hasn't really been
9833 initialized yet. Error messages get reported properly by
9834 cmd_error, so this must be just an informative message; toss
9836 if (FRAME_MESSAGE_BUF (f
))
9842 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9843 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9845 message2 (FRAME_MESSAGE_BUF (f
), len
, 1);
9850 /* Print should start at the beginning of the message
9851 buffer next time. */
9852 message_buf_print
= 0;
9858 message (const char *m
, ...)
9868 /* The non-logging version of message. */
9871 message_nolog (const char *m
, ...)
9873 Lisp_Object old_log_max
;
9876 old_log_max
= Vmessage_log_max
;
9877 Vmessage_log_max
= Qnil
;
9879 Vmessage_log_max
= old_log_max
;
9885 /* Display the current message in the current mini-buffer. This is
9886 only called from error handlers in process.c, and is not time
9890 update_echo_area (void)
9892 if (!NILP (echo_area_buffer
[0]))
9895 string
= Fcurrent_message ();
9896 message3 (string
, SBYTES (string
),
9897 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9902 /* Make sure echo area buffers in `echo_buffers' are live.
9903 If they aren't, make new ones. */
9906 ensure_echo_area_buffers (void)
9910 for (i
= 0; i
< 2; ++i
)
9911 if (!BUFFERP (echo_buffer
[i
])
9912 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
9915 Lisp_Object old_buffer
;
9918 old_buffer
= echo_buffer
[i
];
9919 echo_buffer
[i
] = Fget_buffer_create
9920 (make_formatted_string (name
, " *Echo Area %d*", i
));
9921 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
9922 /* to force word wrap in echo area -
9923 it was decided to postpone this*/
9924 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9926 for (j
= 0; j
< 2; ++j
)
9927 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9928 echo_area_buffer
[j
] = echo_buffer
[i
];
9933 /* Call FN with args A1..A4 with either the current or last displayed
9934 echo_area_buffer as current buffer.
9936 WHICH zero means use the current message buffer
9937 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9938 from echo_buffer[] and clear it.
9940 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9941 suitable buffer from echo_buffer[] and clear it.
9943 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9944 that the current message becomes the last displayed one, make
9945 choose a suitable buffer for echo_area_buffer[0], and clear it.
9947 Value is what FN returns. */
9950 with_echo_area_buffer (struct window
*w
, int which
,
9951 int (*fn
) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
9952 ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
9955 int this_one
, the_other
, clear_buffer_p
, rc
;
9956 ptrdiff_t count
= SPECPDL_INDEX ();
9958 /* If buffers aren't live, make new ones. */
9959 ensure_echo_area_buffers ();
9964 this_one
= 0, the_other
= 1;
9966 this_one
= 1, the_other
= 0;
9969 this_one
= 0, the_other
= 1;
9972 /* We need a fresh one in case the current echo buffer equals
9973 the one containing the last displayed echo area message. */
9974 if (!NILP (echo_area_buffer
[this_one
])
9975 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9976 echo_area_buffer
[this_one
] = Qnil
;
9979 /* Choose a suitable buffer from echo_buffer[] is we don't
9981 if (NILP (echo_area_buffer
[this_one
]))
9983 echo_area_buffer
[this_one
]
9984 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9985 ? echo_buffer
[the_other
]
9986 : echo_buffer
[this_one
]);
9990 buffer
= echo_area_buffer
[this_one
];
9992 /* Don't get confused by reusing the buffer used for echoing
9993 for a different purpose. */
9994 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9997 record_unwind_protect (unwind_with_echo_area_buffer
,
9998 with_echo_area_buffer_unwind_data (w
));
10000 /* Make the echo area buffer current. Note that for display
10001 purposes, it is not necessary that the displayed window's buffer
10002 == current_buffer, except for text property lookup. So, let's
10003 only set that buffer temporarily here without doing a full
10004 Fset_window_buffer. We must also change w->pointm, though,
10005 because otherwise an assertions in unshow_buffer fails, and Emacs
10007 set_buffer_internal_1 (XBUFFER (buffer
));
10010 wset_buffer (w
, buffer
);
10011 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10014 bset_undo_list (current_buffer
, Qt
);
10015 bset_read_only (current_buffer
, Qnil
);
10016 specbind (Qinhibit_read_only
, Qt
);
10017 specbind (Qinhibit_modification_hooks
, Qt
);
10019 if (clear_buffer_p
&& Z
> BEG
)
10020 del_range (BEG
, Z
);
10022 eassert (BEGV
>= BEG
);
10023 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10025 rc
= fn (a1
, a2
, a3
, a4
);
10027 eassert (BEGV
>= BEG
);
10028 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10030 unbind_to (count
, Qnil
);
10035 /* Save state that should be preserved around the call to the function
10036 FN called in with_echo_area_buffer. */
10039 with_echo_area_buffer_unwind_data (struct window
*w
)
10042 Lisp_Object vector
, tmp
;
10044 /* Reduce consing by keeping one vector in
10045 Vwith_echo_area_save_vector. */
10046 vector
= Vwith_echo_area_save_vector
;
10047 Vwith_echo_area_save_vector
= Qnil
;
10050 vector
= Fmake_vector (make_number (7), Qnil
);
10052 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10053 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10054 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10058 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10059 ASET (vector
, i
, w
->buffer
); ++i
;
10060 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
10061 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
10066 for (; i
< end
; ++i
)
10067 ASET (vector
, i
, Qnil
);
10070 eassert (i
== ASIZE (vector
));
10075 /* Restore global state from VECTOR which was created by
10076 with_echo_area_buffer_unwind_data. */
10079 unwind_with_echo_area_buffer (Lisp_Object vector
)
10081 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10082 Vdeactivate_mark
= AREF (vector
, 1);
10083 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10085 if (WINDOWP (AREF (vector
, 3)))
10088 Lisp_Object buffer
, charpos
, bytepos
;
10090 w
= XWINDOW (AREF (vector
, 3));
10091 buffer
= AREF (vector
, 4);
10092 charpos
= AREF (vector
, 5);
10093 bytepos
= AREF (vector
, 6);
10095 wset_buffer (w
, buffer
);
10096 set_marker_both (w
->pointm
, buffer
,
10097 XFASTINT (charpos
), XFASTINT (bytepos
));
10100 Vwith_echo_area_save_vector
= vector
;
10105 /* Set up the echo area for use by print functions. MULTIBYTE_P
10106 non-zero means we will print multibyte. */
10109 setup_echo_area_for_printing (int multibyte_p
)
10111 /* If we can't find an echo area any more, exit. */
10112 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10113 Fkill_emacs (Qnil
);
10115 ensure_echo_area_buffers ();
10117 if (!message_buf_print
)
10119 /* A message has been output since the last time we printed.
10120 Choose a fresh echo area buffer. */
10121 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10122 echo_area_buffer
[0] = echo_buffer
[1];
10124 echo_area_buffer
[0] = echo_buffer
[0];
10126 /* Switch to that buffer and clear it. */
10127 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10128 bset_truncate_lines (current_buffer
, Qnil
);
10132 ptrdiff_t count
= SPECPDL_INDEX ();
10133 specbind (Qinhibit_read_only
, Qt
);
10134 /* Note that undo recording is always disabled. */
10135 del_range (BEG
, Z
);
10136 unbind_to (count
, Qnil
);
10138 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10140 /* Set up the buffer for the multibyteness we need. */
10142 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10143 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10145 /* Raise the frame containing the echo area. */
10146 if (minibuffer_auto_raise
)
10148 struct frame
*sf
= SELECTED_FRAME ();
10149 Lisp_Object mini_window
;
10150 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10151 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10154 message_log_maybe_newline ();
10155 message_buf_print
= 1;
10159 if (NILP (echo_area_buffer
[0]))
10161 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10162 echo_area_buffer
[0] = echo_buffer
[1];
10164 echo_area_buffer
[0] = echo_buffer
[0];
10167 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10169 /* Someone switched buffers between print requests. */
10170 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10171 bset_truncate_lines (current_buffer
, Qnil
);
10177 /* Display an echo area message in window W. Value is non-zero if W's
10178 height is changed. If display_last_displayed_message_p is
10179 non-zero, display the message that was last displayed, otherwise
10180 display the current message. */
10183 display_echo_area (struct window
*w
)
10185 int i
, no_message_p
, window_height_changed_p
;
10187 /* Temporarily disable garbage collections while displaying the echo
10188 area. This is done because a GC can print a message itself.
10189 That message would modify the echo area buffer's contents while a
10190 redisplay of the buffer is going on, and seriously confuse
10192 ptrdiff_t count
= inhibit_garbage_collection ();
10194 /* If there is no message, we must call display_echo_area_1
10195 nevertheless because it resizes the window. But we will have to
10196 reset the echo_area_buffer in question to nil at the end because
10197 with_echo_area_buffer will sets it to an empty buffer. */
10198 i
= display_last_displayed_message_p
? 1 : 0;
10199 no_message_p
= NILP (echo_area_buffer
[i
]);
10201 window_height_changed_p
10202 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10203 display_echo_area_1
,
10204 (intptr_t) w
, Qnil
, 0, 0);
10207 echo_area_buffer
[i
] = Qnil
;
10209 unbind_to (count
, Qnil
);
10210 return window_height_changed_p
;
10214 /* Helper for display_echo_area. Display the current buffer which
10215 contains the current echo area message in window W, a mini-window,
10216 a pointer to which is passed in A1. A2..A4 are currently not used.
10217 Change the height of W so that all of the message is displayed.
10218 Value is non-zero if height of W was changed. */
10221 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10224 struct window
*w
= (struct window
*) i1
;
10225 Lisp_Object window
;
10226 struct text_pos start
;
10227 int window_height_changed_p
= 0;
10229 /* Do this before displaying, so that we have a large enough glyph
10230 matrix for the display. If we can't get enough space for the
10231 whole text, display the last N lines. That works by setting w->start. */
10232 window_height_changed_p
= resize_mini_window (w
, 0);
10234 /* Use the starting position chosen by resize_mini_window. */
10235 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10238 clear_glyph_matrix (w
->desired_matrix
);
10239 XSETWINDOW (window
, w
);
10240 try_window (window
, start
, 0);
10242 return window_height_changed_p
;
10246 /* Resize the echo area window to exactly the size needed for the
10247 currently displayed message, if there is one. If a mini-buffer
10248 is active, don't shrink it. */
10251 resize_echo_area_exactly (void)
10253 if (BUFFERP (echo_area_buffer
[0])
10254 && WINDOWP (echo_area_window
))
10256 struct window
*w
= XWINDOW (echo_area_window
);
10258 Lisp_Object resize_exactly
;
10260 if (minibuf_level
== 0)
10261 resize_exactly
= Qt
;
10263 resize_exactly
= Qnil
;
10265 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10266 (intptr_t) w
, resize_exactly
,
10270 ++windows_or_buffers_changed
;
10271 ++update_mode_lines
;
10272 redisplay_internal ();
10278 /* Callback function for with_echo_area_buffer, when used from
10279 resize_echo_area_exactly. A1 contains a pointer to the window to
10280 resize, EXACTLY non-nil means resize the mini-window exactly to the
10281 size of the text displayed. A3 and A4 are not used. Value is what
10282 resize_mini_window returns. */
10285 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
, ptrdiff_t a3
, ptrdiff_t a4
)
10288 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10292 /* Resize mini-window W to fit the size of its contents. EXACT_P
10293 means size the window exactly to the size needed. Otherwise, it's
10294 only enlarged until W's buffer is empty.
10296 Set W->start to the right place to begin display. If the whole
10297 contents fit, start at the beginning. Otherwise, start so as
10298 to make the end of the contents appear. This is particularly
10299 important for y-or-n-p, but seems desirable generally.
10301 Value is non-zero if the window height has been changed. */
10304 resize_mini_window (struct window
*w
, int exact_p
)
10306 struct frame
*f
= XFRAME (w
->frame
);
10307 int window_height_changed_p
= 0;
10309 eassert (MINI_WINDOW_P (w
));
10311 /* By default, start display at the beginning. */
10312 set_marker_both (w
->start
, w
->buffer
,
10313 BUF_BEGV (XBUFFER (w
->buffer
)),
10314 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10316 /* Don't resize windows while redisplaying a window; it would
10317 confuse redisplay functions when the size of the window they are
10318 displaying changes from under them. Such a resizing can happen,
10319 for instance, when which-func prints a long message while
10320 we are running fontification-functions. We're running these
10321 functions with safe_call which binds inhibit-redisplay to t. */
10322 if (!NILP (Vinhibit_redisplay
))
10325 /* Nil means don't try to resize. */
10326 if (NILP (Vresize_mini_windows
)
10327 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10330 if (!FRAME_MINIBUF_ONLY_P (f
))
10333 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10334 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10336 EMACS_INT max_height
;
10337 int unit
= FRAME_LINE_HEIGHT (f
);
10338 struct text_pos start
;
10339 struct buffer
*old_current_buffer
= NULL
;
10341 if (current_buffer
!= XBUFFER (w
->buffer
))
10343 old_current_buffer
= current_buffer
;
10344 set_buffer_internal (XBUFFER (w
->buffer
));
10347 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10349 /* Compute the max. number of lines specified by the user. */
10350 if (FLOATP (Vmax_mini_window_height
))
10351 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10352 else if (INTEGERP (Vmax_mini_window_height
))
10353 max_height
= XINT (Vmax_mini_window_height
);
10355 max_height
= total_height
/ 4;
10357 /* Correct that max. height if it's bogus. */
10358 max_height
= max (1, max_height
);
10359 max_height
= min (total_height
, max_height
);
10361 /* Find out the height of the text in the window. */
10362 if (it
.line_wrap
== TRUNCATE
)
10367 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10368 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10369 height
= it
.current_y
+ last_height
;
10371 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10372 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10373 height
= (height
+ unit
- 1) / unit
;
10376 /* Compute a suitable window start. */
10377 if (height
> max_height
)
10379 height
= max_height
;
10380 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10381 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10382 start
= it
.current
.pos
;
10385 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10386 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10388 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10390 /* Let it grow only, until we display an empty message, in which
10391 case the window shrinks again. */
10392 if (height
> WINDOW_TOTAL_LINES (w
))
10394 int old_height
= WINDOW_TOTAL_LINES (w
);
10395 freeze_window_starts (f
, 1);
10396 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10397 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10399 else if (height
< WINDOW_TOTAL_LINES (w
)
10400 && (exact_p
|| BEGV
== ZV
))
10402 int old_height
= WINDOW_TOTAL_LINES (w
);
10403 freeze_window_starts (f
, 0);
10404 shrink_mini_window (w
);
10405 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10410 /* Always resize to exact size needed. */
10411 if (height
> WINDOW_TOTAL_LINES (w
))
10413 int old_height
= WINDOW_TOTAL_LINES (w
);
10414 freeze_window_starts (f
, 1);
10415 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10416 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10418 else if (height
< WINDOW_TOTAL_LINES (w
))
10420 int old_height
= WINDOW_TOTAL_LINES (w
);
10421 freeze_window_starts (f
, 0);
10422 shrink_mini_window (w
);
10426 freeze_window_starts (f
, 1);
10427 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10430 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10434 if (old_current_buffer
)
10435 set_buffer_internal (old_current_buffer
);
10438 return window_height_changed_p
;
10442 /* Value is the current message, a string, or nil if there is no
10443 current message. */
10446 current_message (void)
10450 if (!BUFFERP (echo_area_buffer
[0]))
10454 with_echo_area_buffer (0, 0, current_message_1
,
10455 (intptr_t) &msg
, Qnil
, 0, 0);
10457 echo_area_buffer
[0] = Qnil
;
10465 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10468 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10471 *msg
= make_buffer_string (BEG
, Z
, 1);
10478 /* Push the current message on Vmessage_stack for later restoration
10479 by restore_message. Value is non-zero if the current message isn't
10480 empty. This is a relatively infrequent operation, so it's not
10481 worth optimizing. */
10484 push_message (void)
10486 Lisp_Object msg
= current_message ();
10487 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10488 return STRINGP (msg
);
10492 /* Restore message display from the top of Vmessage_stack. */
10495 restore_message (void)
10499 eassert (CONSP (Vmessage_stack
));
10500 msg
= XCAR (Vmessage_stack
);
10502 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10504 message3_nolog (msg
, 0, 0);
10508 /* Handler for record_unwind_protect calling pop_message. */
10511 pop_message_unwind (Lisp_Object dummy
)
10517 /* Pop the top-most entry off Vmessage_stack. */
10522 eassert (CONSP (Vmessage_stack
));
10523 Vmessage_stack
= XCDR (Vmessage_stack
);
10527 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10528 exits. If the stack is not empty, we have a missing pop_message
10532 check_message_stack (void)
10534 if (!NILP (Vmessage_stack
))
10539 /* Truncate to NCHARS what will be displayed in the echo area the next
10540 time we display it---but don't redisplay it now. */
10543 truncate_echo_area (ptrdiff_t nchars
)
10546 echo_area_buffer
[0] = Qnil
;
10547 /* A null message buffer means that the frame hasn't really been
10548 initialized yet. Error messages get reported properly by
10549 cmd_error, so this must be just an informative message; toss it. */
10550 else if (!noninteractive
10552 && !NILP (echo_area_buffer
[0]))
10554 struct frame
*sf
= SELECTED_FRAME ();
10555 if (FRAME_MESSAGE_BUF (sf
))
10556 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10561 /* Helper function for truncate_echo_area. Truncate the current
10562 message to at most NCHARS characters. */
10565 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10567 if (BEG
+ nchars
< Z
)
10568 del_range (BEG
+ nchars
, Z
);
10570 echo_area_buffer
[0] = Qnil
;
10574 /* Set the current message to a substring of S or STRING.
10576 If STRING is a Lisp string, set the message to the first NBYTES
10577 bytes from STRING. NBYTES zero means use the whole string. If
10578 STRING is multibyte, the message will be displayed multibyte.
10580 If S is not null, set the message to the first LEN bytes of S. LEN
10581 zero means use the whole string. MULTIBYTE_P non-zero means S is
10582 multibyte. Display the message multibyte in that case.
10584 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10585 to t before calling set_message_1 (which calls insert).
10589 set_message (const char *s
, Lisp_Object string
,
10590 ptrdiff_t nbytes
, int multibyte_p
)
10592 message_enable_multibyte
10593 = ((s
&& multibyte_p
)
10594 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10596 with_echo_area_buffer (0, -1, set_message_1
,
10597 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10598 message_buf_print
= 0;
10599 help_echo_showing_p
= 0;
10601 if (STRINGP (Vdebug_on_message
)
10602 && fast_string_match (Vdebug_on_message
, string
) >= 0)
10603 call_debugger (list2 (Qerror
, string
));
10607 /* Helper function for set_message. Arguments have the same meaning
10608 as there, with A1 corresponding to S and A2 corresponding to STRING
10609 This function is called with the echo area buffer being
10613 set_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t nbytes
, ptrdiff_t multibyte_p
)
10616 const char *s
= (const char *) i1
;
10617 const unsigned char *msg
= (const unsigned char *) s
;
10618 Lisp_Object string
= a2
;
10620 /* Change multibyteness of the echo buffer appropriately. */
10621 if (message_enable_multibyte
10622 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10623 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10625 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
10626 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10627 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
10629 /* Insert new message at BEG. */
10630 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10632 if (STRINGP (string
))
10637 nbytes
= SBYTES (string
);
10638 nchars
= string_byte_to_char (string
, nbytes
);
10640 /* This function takes care of single/multibyte conversion. We
10641 just have to ensure that the echo area buffer has the right
10642 setting of enable_multibyte_characters. */
10643 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10648 nbytes
= strlen (s
);
10650 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10652 /* Convert from multi-byte to single-byte. */
10657 /* Convert a multibyte string to single-byte. */
10658 for (i
= 0; i
< nbytes
; i
+= n
)
10660 c
= string_char_and_length (msg
+ i
, &n
);
10661 work
[0] = (ASCII_CHAR_P (c
)
10663 : multibyte_char_to_unibyte (c
));
10664 insert_1_both (work
, 1, 1, 1, 0, 0);
10667 else if (!multibyte_p
10668 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10670 /* Convert from single-byte to multi-byte. */
10673 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10675 /* Convert a single-byte string to multibyte. */
10676 for (i
= 0; i
< nbytes
; i
++)
10679 MAKE_CHAR_MULTIBYTE (c
);
10680 n
= CHAR_STRING (c
, str
);
10681 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10685 insert_1 (s
, nbytes
, 1, 0, 0);
10692 /* Clear messages. CURRENT_P non-zero means clear the current
10693 message. LAST_DISPLAYED_P non-zero means clear the message
10697 clear_message (int current_p
, int last_displayed_p
)
10701 echo_area_buffer
[0] = Qnil
;
10702 message_cleared_p
= 1;
10705 if (last_displayed_p
)
10706 echo_area_buffer
[1] = Qnil
;
10708 message_buf_print
= 0;
10711 /* Clear garbaged frames.
10713 This function is used where the old redisplay called
10714 redraw_garbaged_frames which in turn called redraw_frame which in
10715 turn called clear_frame. The call to clear_frame was a source of
10716 flickering. I believe a clear_frame is not necessary. It should
10717 suffice in the new redisplay to invalidate all current matrices,
10718 and ensure a complete redisplay of all windows. */
10721 clear_garbaged_frames (void)
10723 if (frame_garbaged
)
10725 Lisp_Object tail
, frame
;
10726 int changed_count
= 0;
10728 FOR_EACH_FRAME (tail
, frame
)
10730 struct frame
*f
= XFRAME (frame
);
10732 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10736 Fredraw_frame (frame
);
10737 f
->force_flush_display_p
= 1;
10739 clear_current_matrices (f
);
10746 frame_garbaged
= 0;
10748 ++windows_or_buffers_changed
;
10753 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10754 is non-zero update selected_frame. Value is non-zero if the
10755 mini-windows height has been changed. */
10758 echo_area_display (int update_frame_p
)
10760 Lisp_Object mini_window
;
10763 int window_height_changed_p
= 0;
10764 struct frame
*sf
= SELECTED_FRAME ();
10766 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10767 w
= XWINDOW (mini_window
);
10768 f
= XFRAME (WINDOW_FRAME (w
));
10770 /* Don't display if frame is invisible or not yet initialized. */
10771 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10774 #ifdef HAVE_WINDOW_SYSTEM
10775 /* When Emacs starts, selected_frame may be the initial terminal
10776 frame. If we let this through, a message would be displayed on
10778 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10780 #endif /* HAVE_WINDOW_SYSTEM */
10782 /* Redraw garbaged frames. */
10783 if (frame_garbaged
)
10784 clear_garbaged_frames ();
10786 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10788 echo_area_window
= mini_window
;
10789 window_height_changed_p
= display_echo_area (w
);
10790 w
->must_be_updated_p
= 1;
10792 /* Update the display, unless called from redisplay_internal.
10793 Also don't update the screen during redisplay itself. The
10794 update will happen at the end of redisplay, and an update
10795 here could cause confusion. */
10796 if (update_frame_p
&& !redisplaying_p
)
10800 /* If the display update has been interrupted by pending
10801 input, update mode lines in the frame. Due to the
10802 pending input, it might have been that redisplay hasn't
10803 been called, so that mode lines above the echo area are
10804 garbaged. This looks odd, so we prevent it here. */
10805 if (!display_completed
)
10806 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10808 if (window_height_changed_p
10809 /* Don't do this if Emacs is shutting down. Redisplay
10810 needs to run hooks. */
10811 && !NILP (Vrun_hooks
))
10813 /* Must update other windows. Likewise as in other
10814 cases, don't let this update be interrupted by
10816 ptrdiff_t count
= SPECPDL_INDEX ();
10817 specbind (Qredisplay_dont_pause
, Qt
);
10818 windows_or_buffers_changed
= 1;
10819 redisplay_internal ();
10820 unbind_to (count
, Qnil
);
10822 else if (FRAME_WINDOW_P (f
) && n
== 0)
10824 /* Window configuration is the same as before.
10825 Can do with a display update of the echo area,
10826 unless we displayed some mode lines. */
10827 update_single_window (w
, 1);
10828 FRAME_RIF (f
)->flush_display (f
);
10831 update_frame (f
, 1, 1);
10833 /* If cursor is in the echo area, make sure that the next
10834 redisplay displays the minibuffer, so that the cursor will
10835 be replaced with what the minibuffer wants. */
10836 if (cursor_in_echo_area
)
10837 ++windows_or_buffers_changed
;
10840 else if (!EQ (mini_window
, selected_window
))
10841 windows_or_buffers_changed
++;
10843 /* Last displayed message is now the current message. */
10844 echo_area_buffer
[1] = echo_area_buffer
[0];
10845 /* Inform read_char that we're not echoing. */
10846 echo_message_buffer
= Qnil
;
10848 /* Prevent redisplay optimization in redisplay_internal by resetting
10849 this_line_start_pos. This is done because the mini-buffer now
10850 displays the message instead of its buffer text. */
10851 if (EQ (mini_window
, selected_window
))
10852 CHARPOS (this_line_start_pos
) = 0;
10854 return window_height_changed_p
;
10859 /***********************************************************************
10860 Mode Lines and Frame Titles
10861 ***********************************************************************/
10863 /* A buffer for constructing non-propertized mode-line strings and
10864 frame titles in it; allocated from the heap in init_xdisp and
10865 resized as needed in store_mode_line_noprop_char. */
10867 static char *mode_line_noprop_buf
;
10869 /* The buffer's end, and a current output position in it. */
10871 static char *mode_line_noprop_buf_end
;
10872 static char *mode_line_noprop_ptr
;
10874 #define MODE_LINE_NOPROP_LEN(start) \
10875 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10878 MODE_LINE_DISPLAY
= 0,
10882 } mode_line_target
;
10884 /* Alist that caches the results of :propertize.
10885 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10886 static Lisp_Object mode_line_proptrans_alist
;
10888 /* List of strings making up the mode-line. */
10889 static Lisp_Object mode_line_string_list
;
10891 /* Base face property when building propertized mode line string. */
10892 static Lisp_Object mode_line_string_face
;
10893 static Lisp_Object mode_line_string_face_prop
;
10896 /* Unwind data for mode line strings */
10898 static Lisp_Object Vmode_line_unwind_vector
;
10901 format_mode_line_unwind_data (struct frame
*target_frame
,
10902 struct buffer
*obuf
,
10904 int save_proptrans
)
10906 Lisp_Object vector
, tmp
;
10908 /* Reduce consing by keeping one vector in
10909 Vwith_echo_area_save_vector. */
10910 vector
= Vmode_line_unwind_vector
;
10911 Vmode_line_unwind_vector
= Qnil
;
10914 vector
= Fmake_vector (make_number (10), Qnil
);
10916 ASET (vector
, 0, make_number (mode_line_target
));
10917 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10918 ASET (vector
, 2, mode_line_string_list
);
10919 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10920 ASET (vector
, 4, mode_line_string_face
);
10921 ASET (vector
, 5, mode_line_string_face_prop
);
10924 XSETBUFFER (tmp
, obuf
);
10927 ASET (vector
, 6, tmp
);
10928 ASET (vector
, 7, owin
);
10931 /* Similarly to `with-selected-window', if the operation selects
10932 a window on another frame, we must restore that frame's
10933 selected window, and (for a tty) the top-frame. */
10934 ASET (vector
, 8, target_frame
->selected_window
);
10935 if (FRAME_TERMCAP_P (target_frame
))
10936 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
10943 unwind_format_mode_line (Lisp_Object vector
)
10945 Lisp_Object old_window
= AREF (vector
, 7);
10946 Lisp_Object target_frame_window
= AREF (vector
, 8);
10947 Lisp_Object old_top_frame
= AREF (vector
, 9);
10949 mode_line_target
= XINT (AREF (vector
, 0));
10950 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10951 mode_line_string_list
= AREF (vector
, 2);
10952 if (! EQ (AREF (vector
, 3), Qt
))
10953 mode_line_proptrans_alist
= AREF (vector
, 3);
10954 mode_line_string_face
= AREF (vector
, 4);
10955 mode_line_string_face_prop
= AREF (vector
, 5);
10957 /* Select window before buffer, since it may change the buffer. */
10958 if (!NILP (old_window
))
10960 /* If the operation that we are unwinding had selected a window
10961 on a different frame, reset its frame-selected-window. For a
10962 text terminal, reset its top-frame if necessary. */
10963 if (!NILP (target_frame_window
))
10966 = WINDOW_FRAME (XWINDOW (target_frame_window
));
10968 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
10969 Fselect_window (target_frame_window
, Qt
);
10971 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
10972 Fselect_frame (old_top_frame
, Qt
);
10975 Fselect_window (old_window
, Qt
);
10978 if (!NILP (AREF (vector
, 6)))
10980 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10981 ASET (vector
, 6, Qnil
);
10984 Vmode_line_unwind_vector
= vector
;
10989 /* Store a single character C for the frame title in mode_line_noprop_buf.
10990 Re-allocate mode_line_noprop_buf if necessary. */
10993 store_mode_line_noprop_char (char c
)
10995 /* If output position has reached the end of the allocated buffer,
10996 increase the buffer's size. */
10997 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10999 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11000 ptrdiff_t size
= len
;
11001 mode_line_noprop_buf
=
11002 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11003 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11004 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11007 *mode_line_noprop_ptr
++ = c
;
11011 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11012 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11013 characters that yield more columns than PRECISION; PRECISION <= 0
11014 means copy the whole string. Pad with spaces until FIELD_WIDTH
11015 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11016 pad. Called from display_mode_element when it is used to build a
11020 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11022 const unsigned char *str
= (const unsigned char *) string
;
11024 ptrdiff_t dummy
, nbytes
;
11026 /* Copy at most PRECISION chars from STR. */
11027 nbytes
= strlen (string
);
11028 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11030 store_mode_line_noprop_char (*str
++);
11032 /* Fill up with spaces until FIELD_WIDTH reached. */
11033 while (field_width
> 0
11034 && n
< field_width
)
11036 store_mode_line_noprop_char (' ');
11043 /***********************************************************************
11045 ***********************************************************************/
11047 #ifdef HAVE_WINDOW_SYSTEM
11049 /* Set the title of FRAME, if it has changed. The title format is
11050 Vicon_title_format if FRAME is iconified, otherwise it is
11051 frame_title_format. */
11054 x_consider_frame_title (Lisp_Object frame
)
11056 struct frame
*f
= XFRAME (frame
);
11058 if (FRAME_WINDOW_P (f
)
11059 || FRAME_MINIBUF_ONLY_P (f
)
11060 || f
->explicit_name
)
11062 /* Do we have more than one visible frame on this X display? */
11065 ptrdiff_t title_start
;
11069 ptrdiff_t count
= SPECPDL_INDEX ();
11071 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
11073 Lisp_Object other_frame
= XCAR (tail
);
11074 struct frame
*tf
= XFRAME (other_frame
);
11077 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11078 && !FRAME_MINIBUF_ONLY_P (tf
)
11079 && !EQ (other_frame
, tip_frame
)
11080 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11084 /* Set global variable indicating that multiple frames exist. */
11085 multiple_frames
= CONSP (tail
);
11087 /* Switch to the buffer of selected window of the frame. Set up
11088 mode_line_target so that display_mode_element will output into
11089 mode_line_noprop_buf; then display the title. */
11090 record_unwind_protect (unwind_format_mode_line
,
11091 format_mode_line_unwind_data
11092 (f
, current_buffer
, selected_window
, 0));
11094 Fselect_window (f
->selected_window
, Qt
);
11095 set_buffer_internal_1
11096 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
11097 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11099 mode_line_target
= MODE_LINE_TITLE
;
11100 title_start
= MODE_LINE_NOPROP_LEN (0);
11101 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11102 NULL
, DEFAULT_FACE_ID
);
11103 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11104 len
= MODE_LINE_NOPROP_LEN (title_start
);
11105 title
= mode_line_noprop_buf
+ title_start
;
11106 unbind_to (count
, Qnil
);
11108 /* Set the title only if it's changed. This avoids consing in
11109 the common case where it hasn't. (If it turns out that we've
11110 already wasted too much time by walking through the list with
11111 display_mode_element, then we might need to optimize at a
11112 higher level than this.) */
11113 if (! STRINGP (f
->name
)
11114 || SBYTES (f
->name
) != len
11115 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11116 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11120 #endif /* not HAVE_WINDOW_SYSTEM */
11123 /***********************************************************************
11125 ***********************************************************************/
11128 /* Prepare for redisplay by updating menu-bar item lists when
11129 appropriate. This can call eval. */
11132 prepare_menu_bars (void)
11135 struct gcpro gcpro1
, gcpro2
;
11137 Lisp_Object tooltip_frame
;
11139 #ifdef HAVE_WINDOW_SYSTEM
11140 tooltip_frame
= tip_frame
;
11142 tooltip_frame
= Qnil
;
11145 /* Update all frame titles based on their buffer names, etc. We do
11146 this before the menu bars so that the buffer-menu will show the
11147 up-to-date frame titles. */
11148 #ifdef HAVE_WINDOW_SYSTEM
11149 if (windows_or_buffers_changed
|| update_mode_lines
)
11151 Lisp_Object tail
, frame
;
11153 FOR_EACH_FRAME (tail
, frame
)
11155 f
= XFRAME (frame
);
11156 if (!EQ (frame
, tooltip_frame
)
11157 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
11158 x_consider_frame_title (frame
);
11161 #endif /* HAVE_WINDOW_SYSTEM */
11163 /* Update the menu bar item lists, if appropriate. This has to be
11164 done before any actual redisplay or generation of display lines. */
11165 all_windows
= (update_mode_lines
11166 || buffer_shared
> 1
11167 || windows_or_buffers_changed
);
11170 Lisp_Object tail
, frame
;
11171 ptrdiff_t count
= SPECPDL_INDEX ();
11172 /* 1 means that update_menu_bar has run its hooks
11173 so any further calls to update_menu_bar shouldn't do so again. */
11174 int menu_bar_hooks_run
= 0;
11176 record_unwind_save_match_data ();
11178 FOR_EACH_FRAME (tail
, frame
)
11180 f
= XFRAME (frame
);
11182 /* Ignore tooltip frame. */
11183 if (EQ (frame
, tooltip_frame
))
11186 /* If a window on this frame changed size, report that to
11187 the user and clear the size-change flag. */
11188 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11190 Lisp_Object functions
;
11192 /* Clear flag first in case we get an error below. */
11193 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11194 functions
= Vwindow_size_change_functions
;
11195 GCPRO2 (tail
, functions
);
11197 while (CONSP (functions
))
11199 if (!EQ (XCAR (functions
), Qt
))
11200 call1 (XCAR (functions
), frame
);
11201 functions
= XCDR (functions
);
11207 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11208 #ifdef HAVE_WINDOW_SYSTEM
11209 update_tool_bar (f
, 0);
11212 if (windows_or_buffers_changed
11215 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->buffer
));
11220 unbind_to (count
, Qnil
);
11224 struct frame
*sf
= SELECTED_FRAME ();
11225 update_menu_bar (sf
, 1, 0);
11226 #ifdef HAVE_WINDOW_SYSTEM
11227 update_tool_bar (sf
, 1);
11233 /* Update the menu bar item list for frame F. This has to be done
11234 before we start to fill in any display lines, because it can call
11237 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11239 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11240 already ran the menu bar hooks for this redisplay, so there
11241 is no need to run them again. The return value is the
11242 updated value of this flag, to pass to the next call. */
11245 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11247 Lisp_Object window
;
11248 register struct window
*w
;
11250 /* If called recursively during a menu update, do nothing. This can
11251 happen when, for instance, an activate-menubar-hook causes a
11253 if (inhibit_menubar_update
)
11256 window
= FRAME_SELECTED_WINDOW (f
);
11257 w
= XWINDOW (window
);
11259 if (FRAME_WINDOW_P (f
)
11261 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11262 || defined (HAVE_NS) || defined (USE_GTK)
11263 FRAME_EXTERNAL_MENU_BAR (f
)
11265 FRAME_MENU_BAR_LINES (f
) > 0
11267 : FRAME_MENU_BAR_LINES (f
) > 0)
11269 /* If the user has switched buffers or windows, we need to
11270 recompute to reflect the new bindings. But we'll
11271 recompute when update_mode_lines is set too; that means
11272 that people can use force-mode-line-update to request
11273 that the menu bar be recomputed. The adverse effect on
11274 the rest of the redisplay algorithm is about the same as
11275 windows_or_buffers_changed anyway. */
11276 if (windows_or_buffers_changed
11277 /* This used to test w->update_mode_line, but we believe
11278 there is no need to recompute the menu in that case. */
11279 || update_mode_lines
11280 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11281 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11282 != w
->last_had_star
)
11283 || ((!NILP (Vtransient_mark_mode
)
11284 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11285 != !NILP (w
->region_showing
)))
11287 struct buffer
*prev
= current_buffer
;
11288 ptrdiff_t count
= SPECPDL_INDEX ();
11290 specbind (Qinhibit_menubar_update
, Qt
);
11292 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11293 if (save_match_data
)
11294 record_unwind_save_match_data ();
11295 if (NILP (Voverriding_local_map_menu_flag
))
11297 specbind (Qoverriding_terminal_local_map
, Qnil
);
11298 specbind (Qoverriding_local_map
, Qnil
);
11303 /* Run the Lucid hook. */
11304 safe_run_hooks (Qactivate_menubar_hook
);
11306 /* If it has changed current-menubar from previous value,
11307 really recompute the menu-bar from the value. */
11308 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11309 call0 (Qrecompute_lucid_menubar
);
11311 safe_run_hooks (Qmenu_bar_update_hook
);
11316 XSETFRAME (Vmenu_updating_frame
, f
);
11317 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11319 /* Redisplay the menu bar in case we changed it. */
11320 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11321 || defined (HAVE_NS) || defined (USE_GTK)
11322 if (FRAME_WINDOW_P (f
))
11324 #if defined (HAVE_NS)
11325 /* All frames on Mac OS share the same menubar. So only
11326 the selected frame should be allowed to set it. */
11327 if (f
== SELECTED_FRAME ())
11329 set_frame_menubar (f
, 0, 0);
11332 /* On a terminal screen, the menu bar is an ordinary screen
11333 line, and this makes it get updated. */
11334 w
->update_mode_line
= 1;
11335 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11336 /* In the non-toolkit version, the menu bar is an ordinary screen
11337 line, and this makes it get updated. */
11338 w
->update_mode_line
= 1;
11339 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11341 unbind_to (count
, Qnil
);
11342 set_buffer_internal_1 (prev
);
11351 /***********************************************************************
11353 ***********************************************************************/
11355 #ifdef HAVE_WINDOW_SYSTEM
11358 Nominal cursor position -- where to draw output.
11359 HPOS and VPOS are window relative glyph matrix coordinates.
11360 X and Y are window relative pixel coordinates. */
11362 struct cursor_pos output_cursor
;
11366 Set the global variable output_cursor to CURSOR. All cursor
11367 positions are relative to updated_window. */
11370 set_output_cursor (struct cursor_pos
*cursor
)
11372 output_cursor
.hpos
= cursor
->hpos
;
11373 output_cursor
.vpos
= cursor
->vpos
;
11374 output_cursor
.x
= cursor
->x
;
11375 output_cursor
.y
= cursor
->y
;
11380 Set a nominal cursor position.
11382 HPOS and VPOS are column/row positions in a window glyph matrix. X
11383 and Y are window text area relative pixel positions.
11385 If this is done during an update, updated_window will contain the
11386 window that is being updated and the position is the future output
11387 cursor position for that window. If updated_window is null, use
11388 selected_window and display the cursor at the given position. */
11391 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11395 /* If updated_window is not set, work on selected_window. */
11396 if (updated_window
)
11397 w
= updated_window
;
11399 w
= XWINDOW (selected_window
);
11401 /* Set the output cursor. */
11402 output_cursor
.hpos
= hpos
;
11403 output_cursor
.vpos
= vpos
;
11404 output_cursor
.x
= x
;
11405 output_cursor
.y
= y
;
11407 /* If not called as part of an update, really display the cursor.
11408 This will also set the cursor position of W. */
11409 if (updated_window
== NULL
)
11412 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11413 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11414 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11419 #endif /* HAVE_WINDOW_SYSTEM */
11422 /***********************************************************************
11424 ***********************************************************************/
11426 #ifdef HAVE_WINDOW_SYSTEM
11428 /* Where the mouse was last time we reported a mouse event. */
11430 FRAME_PTR last_mouse_frame
;
11432 /* Tool-bar item index of the item on which a mouse button was pressed
11435 int last_tool_bar_item
;
11439 update_tool_bar_unwind (Lisp_Object frame
)
11441 selected_frame
= frame
;
11445 /* Update the tool-bar item list for frame F. This has to be done
11446 before we start to fill in any display lines. Called from
11447 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11448 and restore it here. */
11451 update_tool_bar (struct frame
*f
, int save_match_data
)
11453 #if defined (USE_GTK) || defined (HAVE_NS)
11454 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11456 int do_update
= WINDOWP (f
->tool_bar_window
)
11457 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11462 Lisp_Object window
;
11465 window
= FRAME_SELECTED_WINDOW (f
);
11466 w
= XWINDOW (window
);
11468 /* If the user has switched buffers or windows, we need to
11469 recompute to reflect the new bindings. But we'll
11470 recompute when update_mode_lines is set too; that means
11471 that people can use force-mode-line-update to request
11472 that the menu bar be recomputed. The adverse effect on
11473 the rest of the redisplay algorithm is about the same as
11474 windows_or_buffers_changed anyway. */
11475 if (windows_or_buffers_changed
11476 || w
->update_mode_line
11477 || update_mode_lines
11478 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11479 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11480 != w
->last_had_star
)
11481 || ((!NILP (Vtransient_mark_mode
)
11482 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11483 != !NILP (w
->region_showing
)))
11485 struct buffer
*prev
= current_buffer
;
11486 ptrdiff_t count
= SPECPDL_INDEX ();
11487 Lisp_Object frame
, new_tool_bar
;
11488 int new_n_tool_bar
;
11489 struct gcpro gcpro1
;
11491 /* Set current_buffer to the buffer of the selected
11492 window of the frame, so that we get the right local
11494 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11496 /* Save match data, if we must. */
11497 if (save_match_data
)
11498 record_unwind_save_match_data ();
11500 /* Make sure that we don't accidentally use bogus keymaps. */
11501 if (NILP (Voverriding_local_map_menu_flag
))
11503 specbind (Qoverriding_terminal_local_map
, Qnil
);
11504 specbind (Qoverriding_local_map
, Qnil
);
11507 GCPRO1 (new_tool_bar
);
11509 /* We must temporarily set the selected frame to this frame
11510 before calling tool_bar_items, because the calculation of
11511 the tool-bar keymap uses the selected frame (see
11512 `tool-bar-make-keymap' in tool-bar.el). */
11513 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11514 XSETFRAME (frame
, f
);
11515 selected_frame
= frame
;
11517 /* Build desired tool-bar items from keymaps. */
11519 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11522 /* Redisplay the tool-bar if we changed it. */
11523 if (new_n_tool_bar
!= f
->n_tool_bar_items
11524 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11526 /* Redisplay that happens asynchronously due to an expose event
11527 may access f->tool_bar_items. Make sure we update both
11528 variables within BLOCK_INPUT so no such event interrupts. */
11530 fset_tool_bar_items (f
, new_tool_bar
);
11531 f
->n_tool_bar_items
= new_n_tool_bar
;
11532 w
->update_mode_line
= 1;
11538 unbind_to (count
, Qnil
);
11539 set_buffer_internal_1 (prev
);
11545 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11546 F's desired tool-bar contents. F->tool_bar_items must have
11547 been set up previously by calling prepare_menu_bars. */
11550 build_desired_tool_bar_string (struct frame
*f
)
11552 int i
, size
, size_needed
;
11553 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11554 Lisp_Object image
, plist
, props
;
11556 image
= plist
= props
= Qnil
;
11557 GCPRO3 (image
, plist
, props
);
11559 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11560 Otherwise, make a new string. */
11562 /* The size of the string we might be able to reuse. */
11563 size
= (STRINGP (f
->desired_tool_bar_string
)
11564 ? SCHARS (f
->desired_tool_bar_string
)
11567 /* We need one space in the string for each image. */
11568 size_needed
= f
->n_tool_bar_items
;
11570 /* Reuse f->desired_tool_bar_string, if possible. */
11571 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11572 fset_desired_tool_bar_string
11573 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11576 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11577 Fremove_text_properties (make_number (0), make_number (size
),
11578 props
, f
->desired_tool_bar_string
);
11581 /* Put a `display' property on the string for the images to display,
11582 put a `menu_item' property on tool-bar items with a value that
11583 is the index of the item in F's tool-bar item vector. */
11584 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11586 #define PROP(IDX) \
11587 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11589 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11590 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11591 int hmargin
, vmargin
, relief
, idx
, end
;
11593 /* If image is a vector, choose the image according to the
11595 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11596 if (VECTORP (image
))
11600 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11601 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11604 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11605 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11607 eassert (ASIZE (image
) >= idx
);
11608 image
= AREF (image
, idx
);
11613 /* Ignore invalid image specifications. */
11614 if (!valid_image_p (image
))
11617 /* Display the tool-bar button pressed, or depressed. */
11618 plist
= Fcopy_sequence (XCDR (image
));
11620 /* Compute margin and relief to draw. */
11621 relief
= (tool_bar_button_relief
>= 0
11622 ? tool_bar_button_relief
11623 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11624 hmargin
= vmargin
= relief
;
11626 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11627 INT_MAX
- max (hmargin
, vmargin
)))
11629 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11630 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11632 else if (CONSP (Vtool_bar_button_margin
))
11634 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11635 INT_MAX
- hmargin
))
11636 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11638 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11639 INT_MAX
- vmargin
))
11640 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11643 if (auto_raise_tool_bar_buttons_p
)
11645 /* Add a `:relief' property to the image spec if the item is
11649 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11656 /* If image is selected, display it pressed, i.e. with a
11657 negative relief. If it's not selected, display it with a
11659 plist
= Fplist_put (plist
, QCrelief
,
11661 ? make_number (-relief
)
11662 : make_number (relief
)));
11667 /* Put a margin around the image. */
11668 if (hmargin
|| vmargin
)
11670 if (hmargin
== vmargin
)
11671 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11673 plist
= Fplist_put (plist
, QCmargin
,
11674 Fcons (make_number (hmargin
),
11675 make_number (vmargin
)));
11678 /* If button is not enabled, and we don't have special images
11679 for the disabled state, make the image appear disabled by
11680 applying an appropriate algorithm to it. */
11681 if (!enabled_p
&& idx
< 0)
11682 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11684 /* Put a `display' text property on the string for the image to
11685 display. Put a `menu-item' property on the string that gives
11686 the start of this item's properties in the tool-bar items
11688 image
= Fcons (Qimage
, plist
);
11689 props
= list4 (Qdisplay
, image
,
11690 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11692 /* Let the last image hide all remaining spaces in the tool bar
11693 string. The string can be longer than needed when we reuse a
11694 previous string. */
11695 if (i
+ 1 == f
->n_tool_bar_items
)
11696 end
= SCHARS (f
->desired_tool_bar_string
);
11699 Fadd_text_properties (make_number (i
), make_number (end
),
11700 props
, f
->desired_tool_bar_string
);
11708 /* Display one line of the tool-bar of frame IT->f.
11710 HEIGHT specifies the desired height of the tool-bar line.
11711 If the actual height of the glyph row is less than HEIGHT, the
11712 row's height is increased to HEIGHT, and the icons are centered
11713 vertically in the new height.
11715 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11716 count a final empty row in case the tool-bar width exactly matches
11721 display_tool_bar_line (struct it
*it
, int height
)
11723 struct glyph_row
*row
= it
->glyph_row
;
11724 int max_x
= it
->last_visible_x
;
11725 struct glyph
*last
;
11727 prepare_desired_row (row
);
11728 row
->y
= it
->current_y
;
11730 /* Note that this isn't made use of if the face hasn't a box,
11731 so there's no need to check the face here. */
11732 it
->start_of_box_run_p
= 1;
11734 while (it
->current_x
< max_x
)
11736 int x
, n_glyphs_before
, i
, nglyphs
;
11737 struct it it_before
;
11739 /* Get the next display element. */
11740 if (!get_next_display_element (it
))
11742 /* Don't count empty row if we are counting needed tool-bar lines. */
11743 if (height
< 0 && !it
->hpos
)
11748 /* Produce glyphs. */
11749 n_glyphs_before
= row
->used
[TEXT_AREA
];
11752 PRODUCE_GLYPHS (it
);
11754 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11756 x
= it_before
.current_x
;
11757 while (i
< nglyphs
)
11759 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11761 if (x
+ glyph
->pixel_width
> max_x
)
11763 /* Glyph doesn't fit on line. Backtrack. */
11764 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11766 /* If this is the only glyph on this line, it will never fit on the
11767 tool-bar, so skip it. But ensure there is at least one glyph,
11768 so we don't accidentally disable the tool-bar. */
11769 if (n_glyphs_before
== 0
11770 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11776 x
+= glyph
->pixel_width
;
11780 /* Stop at line end. */
11781 if (ITERATOR_AT_END_OF_LINE_P (it
))
11784 set_iterator_to_next (it
, 1);
11789 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11791 /* Use default face for the border below the tool bar.
11793 FIXME: When auto-resize-tool-bars is grow-only, there is
11794 no additional border below the possibly empty tool-bar lines.
11795 So to make the extra empty lines look "normal", we have to
11796 use the tool-bar face for the border too. */
11797 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11798 it
->face_id
= DEFAULT_FACE_ID
;
11800 extend_face_to_end_of_line (it
);
11801 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11802 last
->right_box_line_p
= 1;
11803 if (last
== row
->glyphs
[TEXT_AREA
])
11804 last
->left_box_line_p
= 1;
11806 /* Make line the desired height and center it vertically. */
11807 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11809 /* Don't add more than one line height. */
11810 height
%= FRAME_LINE_HEIGHT (it
->f
);
11811 it
->max_ascent
+= height
/ 2;
11812 it
->max_descent
+= (height
+ 1) / 2;
11815 compute_line_metrics (it
);
11817 /* If line is empty, make it occupy the rest of the tool-bar. */
11818 if (!row
->displays_text_p
)
11820 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11821 row
->visible_height
= row
->height
;
11822 row
->ascent
= row
->phys_ascent
= 0;
11823 row
->extra_line_spacing
= 0;
11826 row
->full_width_p
= 1;
11827 row
->continued_p
= 0;
11828 row
->truncated_on_left_p
= 0;
11829 row
->truncated_on_right_p
= 0;
11831 it
->current_x
= it
->hpos
= 0;
11832 it
->current_y
+= row
->height
;
11838 /* Max tool-bar height. */
11840 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11841 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11843 /* Value is the number of screen lines needed to make all tool-bar
11844 items of frame F visible. The number of actual rows needed is
11845 returned in *N_ROWS if non-NULL. */
11848 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11850 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11852 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11853 the desired matrix, so use (unused) mode-line row as temporary row to
11854 avoid destroying the first tool-bar row. */
11855 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11857 /* Initialize an iterator for iteration over
11858 F->desired_tool_bar_string in the tool-bar window of frame F. */
11859 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11860 it
.first_visible_x
= 0;
11861 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11862 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11863 it
.paragraph_embedding
= L2R
;
11865 while (!ITERATOR_AT_END_P (&it
))
11867 clear_glyph_row (temp_row
);
11868 it
.glyph_row
= temp_row
;
11869 display_tool_bar_line (&it
, -1);
11871 clear_glyph_row (temp_row
);
11873 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11875 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11877 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11881 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11883 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11884 (Lisp_Object frame
)
11891 frame
= selected_frame
;
11893 CHECK_FRAME (frame
);
11894 f
= XFRAME (frame
);
11896 if (WINDOWP (f
->tool_bar_window
)
11897 && (w
= XWINDOW (f
->tool_bar_window
),
11898 WINDOW_TOTAL_LINES (w
) > 0))
11900 update_tool_bar (f
, 1);
11901 if (f
->n_tool_bar_items
)
11903 build_desired_tool_bar_string (f
);
11904 nlines
= tool_bar_lines_needed (f
, NULL
);
11908 return make_number (nlines
);
11912 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11913 height should be changed. */
11916 redisplay_tool_bar (struct frame
*f
)
11920 struct glyph_row
*row
;
11922 #if defined (USE_GTK) || defined (HAVE_NS)
11923 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11924 update_frame_tool_bar (f
);
11928 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11929 do anything. This means you must start with tool-bar-lines
11930 non-zero to get the auto-sizing effect. Or in other words, you
11931 can turn off tool-bars by specifying tool-bar-lines zero. */
11932 if (!WINDOWP (f
->tool_bar_window
)
11933 || (w
= XWINDOW (f
->tool_bar_window
),
11934 WINDOW_TOTAL_LINES (w
) == 0))
11937 /* Set up an iterator for the tool-bar window. */
11938 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11939 it
.first_visible_x
= 0;
11940 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11941 row
= it
.glyph_row
;
11943 /* Build a string that represents the contents of the tool-bar. */
11944 build_desired_tool_bar_string (f
);
11945 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11946 /* FIXME: This should be controlled by a user option. But it
11947 doesn't make sense to have an R2L tool bar if the menu bar cannot
11948 be drawn also R2L, and making the menu bar R2L is tricky due
11949 toolkit-specific code that implements it. If an R2L tool bar is
11950 ever supported, display_tool_bar_line should also be augmented to
11951 call unproduce_glyphs like display_line and display_string
11953 it
.paragraph_embedding
= L2R
;
11955 if (f
->n_tool_bar_rows
== 0)
11959 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11960 nlines
!= WINDOW_TOTAL_LINES (w
)))
11963 int old_height
= WINDOW_TOTAL_LINES (w
);
11965 XSETFRAME (frame
, f
);
11966 Fmodify_frame_parameters (frame
,
11967 Fcons (Fcons (Qtool_bar_lines
,
11968 make_number (nlines
)),
11970 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11972 clear_glyph_matrix (w
->desired_matrix
);
11973 fonts_changed_p
= 1;
11979 /* Display as many lines as needed to display all tool-bar items. */
11981 if (f
->n_tool_bar_rows
> 0)
11983 int border
, rows
, height
, extra
;
11985 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
11986 border
= XINT (Vtool_bar_border
);
11987 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11988 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11989 else if (EQ (Vtool_bar_border
, Qborder_width
))
11990 border
= f
->border_width
;
11996 rows
= f
->n_tool_bar_rows
;
11997 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11998 extra
= it
.last_visible_y
- border
- height
* rows
;
12000 while (it
.current_y
< it
.last_visible_y
)
12003 if (extra
> 0 && rows
-- > 0)
12005 h
= (extra
+ rows
- 1) / rows
;
12008 display_tool_bar_line (&it
, height
+ h
);
12013 while (it
.current_y
< it
.last_visible_y
)
12014 display_tool_bar_line (&it
, 0);
12017 /* It doesn't make much sense to try scrolling in the tool-bar
12018 window, so don't do it. */
12019 w
->desired_matrix
->no_scrolling_p
= 1;
12020 w
->must_be_updated_p
= 1;
12022 if (!NILP (Vauto_resize_tool_bars
))
12024 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12025 int change_height_p
= 0;
12027 /* If we couldn't display everything, change the tool-bar's
12028 height if there is room for more. */
12029 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12030 && it
.current_y
< max_tool_bar_height
)
12031 change_height_p
= 1;
12033 row
= it
.glyph_row
- 1;
12035 /* If there are blank lines at the end, except for a partially
12036 visible blank line at the end that is smaller than
12037 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12038 if (!row
->displays_text_p
12039 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12040 change_height_p
= 1;
12042 /* If row displays tool-bar items, but is partially visible,
12043 change the tool-bar's height. */
12044 if (row
->displays_text_p
12045 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12046 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12047 change_height_p
= 1;
12049 /* Resize windows as needed by changing the `tool-bar-lines'
12050 frame parameter. */
12051 if (change_height_p
)
12054 int old_height
= WINDOW_TOTAL_LINES (w
);
12056 int nlines
= tool_bar_lines_needed (f
, &nrows
);
12058 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12059 && !f
->minimize_tool_bar_window_p
)
12060 ? (nlines
> old_height
)
12061 : (nlines
!= old_height
));
12062 f
->minimize_tool_bar_window_p
= 0;
12064 if (change_height_p
)
12066 XSETFRAME (frame
, f
);
12067 Fmodify_frame_parameters (frame
,
12068 Fcons (Fcons (Qtool_bar_lines
,
12069 make_number (nlines
)),
12071 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12073 clear_glyph_matrix (w
->desired_matrix
);
12074 f
->n_tool_bar_rows
= nrows
;
12075 fonts_changed_p
= 1;
12082 f
->minimize_tool_bar_window_p
= 0;
12087 /* Get information about the tool-bar item which is displayed in GLYPH
12088 on frame F. Return in *PROP_IDX the index where tool-bar item
12089 properties start in F->tool_bar_items. Value is zero if
12090 GLYPH doesn't display a tool-bar item. */
12093 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12099 /* This function can be called asynchronously, which means we must
12100 exclude any possibility that Fget_text_property signals an
12102 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12103 charpos
= max (0, charpos
);
12105 /* Get the text property `menu-item' at pos. The value of that
12106 property is the start index of this item's properties in
12107 F->tool_bar_items. */
12108 prop
= Fget_text_property (make_number (charpos
),
12109 Qmenu_item
, f
->current_tool_bar_string
);
12110 if (INTEGERP (prop
))
12112 *prop_idx
= XINT (prop
);
12122 /* Get information about the tool-bar item at position X/Y on frame F.
12123 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12124 the current matrix of the tool-bar window of F, or NULL if not
12125 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12126 item in F->tool_bar_items. Value is
12128 -1 if X/Y is not on a tool-bar item
12129 0 if X/Y is on the same item that was highlighted before.
12133 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12134 int *hpos
, int *vpos
, int *prop_idx
)
12136 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12137 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12140 /* Find the glyph under X/Y. */
12141 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12142 if (*glyph
== NULL
)
12145 /* Get the start of this tool-bar item's properties in
12146 f->tool_bar_items. */
12147 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12150 /* Is mouse on the highlighted item? */
12151 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12152 && *vpos
>= hlinfo
->mouse_face_beg_row
12153 && *vpos
<= hlinfo
->mouse_face_end_row
12154 && (*vpos
> hlinfo
->mouse_face_beg_row
12155 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12156 && (*vpos
< hlinfo
->mouse_face_end_row
12157 || *hpos
< hlinfo
->mouse_face_end_col
12158 || hlinfo
->mouse_face_past_end
))
12166 Handle mouse button event on the tool-bar of frame F, at
12167 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12168 0 for button release. MODIFIERS is event modifiers for button
12172 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12175 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12176 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12177 int hpos
, vpos
, prop_idx
;
12178 struct glyph
*glyph
;
12179 Lisp_Object enabled_p
;
12181 /* If not on the highlighted tool-bar item, return. */
12182 frame_to_window_pixel_xy (w
, &x
, &y
);
12183 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12186 /* If item is disabled, do nothing. */
12187 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12188 if (NILP (enabled_p
))
12193 /* Show item in pressed state. */
12194 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12195 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
12196 last_tool_bar_item
= prop_idx
;
12200 Lisp_Object key
, frame
;
12201 struct input_event event
;
12202 EVENT_INIT (event
);
12204 /* Show item in released state. */
12205 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12206 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
12208 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12210 XSETFRAME (frame
, f
);
12211 event
.kind
= TOOL_BAR_EVENT
;
12212 event
.frame_or_window
= frame
;
12214 kbd_buffer_store_event (&event
);
12216 event
.kind
= TOOL_BAR_EVENT
;
12217 event
.frame_or_window
= frame
;
12219 event
.modifiers
= modifiers
;
12220 kbd_buffer_store_event (&event
);
12221 last_tool_bar_item
= -1;
12226 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12227 tool-bar window-relative coordinates X/Y. Called from
12228 note_mouse_highlight. */
12231 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12233 Lisp_Object window
= f
->tool_bar_window
;
12234 struct window
*w
= XWINDOW (window
);
12235 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12236 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12238 struct glyph
*glyph
;
12239 struct glyph_row
*row
;
12241 Lisp_Object enabled_p
;
12243 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12244 int mouse_down_p
, rc
;
12246 /* Function note_mouse_highlight is called with negative X/Y
12247 values when mouse moves outside of the frame. */
12248 if (x
<= 0 || y
<= 0)
12250 clear_mouse_face (hlinfo
);
12254 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12257 /* Not on tool-bar item. */
12258 clear_mouse_face (hlinfo
);
12262 /* On same tool-bar item as before. */
12263 goto set_help_echo
;
12265 clear_mouse_face (hlinfo
);
12267 /* Mouse is down, but on different tool-bar item? */
12268 mouse_down_p
= (dpyinfo
->grabbed
12269 && f
== last_mouse_frame
12270 && FRAME_LIVE_P (f
));
12272 && last_tool_bar_item
!= prop_idx
)
12275 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
12276 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12278 /* If tool-bar item is not enabled, don't highlight it. */
12279 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12280 if (!NILP (enabled_p
))
12282 /* Compute the x-position of the glyph. In front and past the
12283 image is a space. We include this in the highlighted area. */
12284 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12285 for (i
= x
= 0; i
< hpos
; ++i
)
12286 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12288 /* Record this as the current active region. */
12289 hlinfo
->mouse_face_beg_col
= hpos
;
12290 hlinfo
->mouse_face_beg_row
= vpos
;
12291 hlinfo
->mouse_face_beg_x
= x
;
12292 hlinfo
->mouse_face_beg_y
= row
->y
;
12293 hlinfo
->mouse_face_past_end
= 0;
12295 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12296 hlinfo
->mouse_face_end_row
= vpos
;
12297 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12298 hlinfo
->mouse_face_end_y
= row
->y
;
12299 hlinfo
->mouse_face_window
= window
;
12300 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12302 /* Display it as active. */
12303 show_mouse_face (hlinfo
, draw
);
12304 hlinfo
->mouse_face_image_state
= draw
;
12309 /* Set help_echo_string to a help string to display for this tool-bar item.
12310 XTread_socket does the rest. */
12311 help_echo_object
= help_echo_window
= Qnil
;
12312 help_echo_pos
= -1;
12313 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12314 if (NILP (help_echo_string
))
12315 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12318 #endif /* HAVE_WINDOW_SYSTEM */
12322 /************************************************************************
12323 Horizontal scrolling
12324 ************************************************************************/
12326 static int hscroll_window_tree (Lisp_Object
);
12327 static int hscroll_windows (Lisp_Object
);
12329 /* For all leaf windows in the window tree rooted at WINDOW, set their
12330 hscroll value so that PT is (i) visible in the window, and (ii) so
12331 that it is not within a certain margin at the window's left and
12332 right border. Value is non-zero if any window's hscroll has been
12336 hscroll_window_tree (Lisp_Object window
)
12338 int hscrolled_p
= 0;
12339 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12340 int hscroll_step_abs
= 0;
12341 double hscroll_step_rel
= 0;
12343 if (hscroll_relative_p
)
12345 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12346 if (hscroll_step_rel
< 0)
12348 hscroll_relative_p
= 0;
12349 hscroll_step_abs
= 0;
12352 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12354 hscroll_step_abs
= XINT (Vhscroll_step
);
12355 if (hscroll_step_abs
< 0)
12356 hscroll_step_abs
= 0;
12359 hscroll_step_abs
= 0;
12361 while (WINDOWP (window
))
12363 struct window
*w
= XWINDOW (window
);
12365 if (WINDOWP (w
->hchild
))
12366 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12367 else if (WINDOWP (w
->vchild
))
12368 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12369 else if (w
->cursor
.vpos
>= 0)
12372 int text_area_width
;
12373 struct glyph_row
*current_cursor_row
12374 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12375 struct glyph_row
*desired_cursor_row
12376 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12377 struct glyph_row
*cursor_row
12378 = (desired_cursor_row
->enabled_p
12379 ? desired_cursor_row
12380 : current_cursor_row
);
12381 int row_r2l_p
= cursor_row
->reversed_p
;
12383 text_area_width
= window_box_width (w
, TEXT_AREA
);
12385 /* Scroll when cursor is inside this scroll margin. */
12386 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12388 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12389 /* For left-to-right rows, hscroll when cursor is either
12390 (i) inside the right hscroll margin, or (ii) if it is
12391 inside the left margin and the window is already
12395 && w
->cursor
.x
<= h_margin
)
12396 || (cursor_row
->enabled_p
12397 && cursor_row
->truncated_on_right_p
12398 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12399 /* For right-to-left rows, the logic is similar,
12400 except that rules for scrolling to left and right
12401 are reversed. E.g., if cursor.x <= h_margin, we
12402 need to hscroll "to the right" unconditionally,
12403 and that will scroll the screen to the left so as
12404 to reveal the next portion of the row. */
12406 && ((cursor_row
->enabled_p
12407 /* FIXME: It is confusing to set the
12408 truncated_on_right_p flag when R2L rows
12409 are actually truncated on the left. */
12410 && cursor_row
->truncated_on_right_p
12411 && w
->cursor
.x
<= h_margin
)
12413 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12417 struct buffer
*saved_current_buffer
;
12421 /* Find point in a display of infinite width. */
12422 saved_current_buffer
= current_buffer
;
12423 current_buffer
= XBUFFER (w
->buffer
);
12425 if (w
== XWINDOW (selected_window
))
12429 pt
= marker_position (w
->pointm
);
12430 pt
= max (BEGV
, pt
);
12434 /* Move iterator to pt starting at cursor_row->start in
12435 a line with infinite width. */
12436 init_to_row_start (&it
, w
, cursor_row
);
12437 it
.last_visible_x
= INFINITY
;
12438 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12439 current_buffer
= saved_current_buffer
;
12441 /* Position cursor in window. */
12442 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12443 hscroll
= max (0, (it
.current_x
12444 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12445 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12446 : (text_area_width
/ 2))))
12447 / FRAME_COLUMN_WIDTH (it
.f
);
12448 else if ((!row_r2l_p
12449 && w
->cursor
.x
>= text_area_width
- h_margin
)
12450 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12452 if (hscroll_relative_p
)
12453 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12456 wanted_x
= text_area_width
12457 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12460 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12464 if (hscroll_relative_p
)
12465 wanted_x
= text_area_width
* hscroll_step_rel
12468 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12471 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12473 hscroll
= max (hscroll
, w
->min_hscroll
);
12475 /* Don't prevent redisplay optimizations if hscroll
12476 hasn't changed, as it will unnecessarily slow down
12478 if (w
->hscroll
!= hscroll
)
12480 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12481 w
->hscroll
= hscroll
;
12490 /* Value is non-zero if hscroll of any leaf window has been changed. */
12491 return hscrolled_p
;
12495 /* Set hscroll so that cursor is visible and not inside horizontal
12496 scroll margins for all windows in the tree rooted at WINDOW. See
12497 also hscroll_window_tree above. Value is non-zero if any window's
12498 hscroll has been changed. If it has, desired matrices on the frame
12499 of WINDOW are cleared. */
12502 hscroll_windows (Lisp_Object window
)
12504 int hscrolled_p
= hscroll_window_tree (window
);
12506 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12507 return hscrolled_p
;
12512 /************************************************************************
12514 ************************************************************************/
12516 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12517 to a non-zero value. This is sometimes handy to have in a debugger
12522 /* First and last unchanged row for try_window_id. */
12524 static int debug_first_unchanged_at_end_vpos
;
12525 static int debug_last_unchanged_at_beg_vpos
;
12527 /* Delta vpos and y. */
12529 static int debug_dvpos
, debug_dy
;
12531 /* Delta in characters and bytes for try_window_id. */
12533 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12535 /* Values of window_end_pos and window_end_vpos at the end of
12538 static ptrdiff_t debug_end_vpos
;
12540 /* Append a string to W->desired_matrix->method. FMT is a printf
12541 format string. If trace_redisplay_p is non-zero also printf the
12542 resulting string to stderr. */
12544 static void debug_method_add (struct window
*, char const *, ...)
12545 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12548 debug_method_add (struct window
*w
, char const *fmt
, ...)
12550 char *method
= w
->desired_matrix
->method
;
12551 int len
= strlen (method
);
12552 int size
= sizeof w
->desired_matrix
->method
;
12553 int remaining
= size
- len
- 1;
12556 if (len
&& remaining
)
12559 --remaining
, ++len
;
12562 va_start (ap
, fmt
);
12563 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12566 if (trace_redisplay_p
)
12567 fprintf (stderr
, "%p (%s): %s\n",
12569 ((BUFFERP (w
->buffer
)
12570 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12571 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12576 #endif /* GLYPH_DEBUG */
12579 /* Value is non-zero if all changes in window W, which displays
12580 current_buffer, are in the text between START and END. START is a
12581 buffer position, END is given as a distance from Z. Used in
12582 redisplay_internal for display optimization. */
12585 text_outside_line_unchanged_p (struct window
*w
,
12586 ptrdiff_t start
, ptrdiff_t end
)
12588 int unchanged_p
= 1;
12590 /* If text or overlays have changed, see where. */
12591 if (w
->last_modified
< MODIFF
12592 || w
->last_overlay_modified
< OVERLAY_MODIFF
)
12594 /* Gap in the line? */
12595 if (GPT
< start
|| Z
- GPT
< end
)
12598 /* Changes start in front of the line, or end after it? */
12600 && (BEG_UNCHANGED
< start
- 1
12601 || END_UNCHANGED
< end
))
12604 /* If selective display, can't optimize if changes start at the
12605 beginning of the line. */
12607 && INTEGERP (BVAR (current_buffer
, selective_display
))
12608 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12609 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12612 /* If there are overlays at the start or end of the line, these
12613 may have overlay strings with newlines in them. A change at
12614 START, for instance, may actually concern the display of such
12615 overlay strings as well, and they are displayed on different
12616 lines. So, quickly rule out this case. (For the future, it
12617 might be desirable to implement something more telling than
12618 just BEG/END_UNCHANGED.) */
12621 if (BEG
+ BEG_UNCHANGED
== start
12622 && overlay_touches_p (start
))
12624 if (END_UNCHANGED
== end
12625 && overlay_touches_p (Z
- end
))
12629 /* Under bidi reordering, adding or deleting a character in the
12630 beginning of a paragraph, before the first strong directional
12631 character, can change the base direction of the paragraph (unless
12632 the buffer specifies a fixed paragraph direction), which will
12633 require to redisplay the whole paragraph. It might be worthwhile
12634 to find the paragraph limits and widen the range of redisplayed
12635 lines to that, but for now just give up this optimization. */
12636 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12637 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12641 return unchanged_p
;
12645 /* Do a frame update, taking possible shortcuts into account. This is
12646 the main external entry point for redisplay.
12648 If the last redisplay displayed an echo area message and that message
12649 is no longer requested, we clear the echo area or bring back the
12650 mini-buffer if that is in use. */
12655 redisplay_internal ();
12660 overlay_arrow_string_or_property (Lisp_Object var
)
12664 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12667 return Voverlay_arrow_string
;
12670 /* Return 1 if there are any overlay-arrows in current_buffer. */
12672 overlay_arrow_in_current_buffer_p (void)
12676 for (vlist
= Voverlay_arrow_variable_list
;
12678 vlist
= XCDR (vlist
))
12680 Lisp_Object var
= XCAR (vlist
);
12683 if (!SYMBOLP (var
))
12685 val
= find_symbol_value (var
);
12687 && current_buffer
== XMARKER (val
)->buffer
)
12694 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12698 overlay_arrows_changed_p (void)
12702 for (vlist
= Voverlay_arrow_variable_list
;
12704 vlist
= XCDR (vlist
))
12706 Lisp_Object var
= XCAR (vlist
);
12707 Lisp_Object val
, pstr
;
12709 if (!SYMBOLP (var
))
12711 val
= find_symbol_value (var
);
12712 if (!MARKERP (val
))
12714 if (! EQ (COERCE_MARKER (val
),
12715 Fget (var
, Qlast_arrow_position
))
12716 || ! (pstr
= overlay_arrow_string_or_property (var
),
12717 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12723 /* Mark overlay arrows to be updated on next redisplay. */
12726 update_overlay_arrows (int up_to_date
)
12730 for (vlist
= Voverlay_arrow_variable_list
;
12732 vlist
= XCDR (vlist
))
12734 Lisp_Object var
= XCAR (vlist
);
12736 if (!SYMBOLP (var
))
12739 if (up_to_date
> 0)
12741 Lisp_Object val
= find_symbol_value (var
);
12742 Fput (var
, Qlast_arrow_position
,
12743 COERCE_MARKER (val
));
12744 Fput (var
, Qlast_arrow_string
,
12745 overlay_arrow_string_or_property (var
));
12747 else if (up_to_date
< 0
12748 || !NILP (Fget (var
, Qlast_arrow_position
)))
12750 Fput (var
, Qlast_arrow_position
, Qt
);
12751 Fput (var
, Qlast_arrow_string
, Qt
);
12757 /* Return overlay arrow string to display at row.
12758 Return integer (bitmap number) for arrow bitmap in left fringe.
12759 Return nil if no overlay arrow. */
12762 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12766 for (vlist
= Voverlay_arrow_variable_list
;
12768 vlist
= XCDR (vlist
))
12770 Lisp_Object var
= XCAR (vlist
);
12773 if (!SYMBOLP (var
))
12776 val
= find_symbol_value (var
);
12779 && current_buffer
== XMARKER (val
)->buffer
12780 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12782 if (FRAME_WINDOW_P (it
->f
)
12783 /* FIXME: if ROW->reversed_p is set, this should test
12784 the right fringe, not the left one. */
12785 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12787 #ifdef HAVE_WINDOW_SYSTEM
12788 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12791 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12792 return make_number (fringe_bitmap
);
12795 return make_number (-1); /* Use default arrow bitmap. */
12797 return overlay_arrow_string_or_property (var
);
12804 /* Return 1 if point moved out of or into a composition. Otherwise
12805 return 0. PREV_BUF and PREV_PT are the last point buffer and
12806 position. BUF and PT are the current point buffer and position. */
12809 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12810 struct buffer
*buf
, ptrdiff_t pt
)
12812 ptrdiff_t start
, end
;
12814 Lisp_Object buffer
;
12816 XSETBUFFER (buffer
, buf
);
12817 /* Check a composition at the last point if point moved within the
12819 if (prev_buf
== buf
)
12822 /* Point didn't move. */
12825 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12826 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12827 && COMPOSITION_VALID_P (start
, end
, prop
)
12828 && start
< prev_pt
&& end
> prev_pt
)
12829 /* The last point was within the composition. Return 1 iff
12830 point moved out of the composition. */
12831 return (pt
<= start
|| pt
>= end
);
12834 /* Check a composition at the current point. */
12835 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12836 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12837 && COMPOSITION_VALID_P (start
, end
, prop
)
12838 && start
< pt
&& end
> pt
);
12842 /* Reconsider the setting of B->clip_changed which is displayed
12846 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12848 if (b
->clip_changed
12849 && !NILP (w
->window_end_valid
)
12850 && w
->current_matrix
->buffer
== b
12851 && w
->current_matrix
->zv
== BUF_ZV (b
)
12852 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12853 b
->clip_changed
= 0;
12855 /* If display wasn't paused, and W is not a tool bar window, see if
12856 point has been moved into or out of a composition. In that case,
12857 we set b->clip_changed to 1 to force updating the screen. If
12858 b->clip_changed has already been set to 1, we can skip this
12860 if (!b
->clip_changed
12861 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12865 if (w
== XWINDOW (selected_window
))
12868 pt
= marker_position (w
->pointm
);
12870 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12871 || pt
!= w
->last_point
)
12872 && check_point_in_composition (w
->current_matrix
->buffer
,
12874 XBUFFER (w
->buffer
), pt
))
12875 b
->clip_changed
= 1;
12880 /* Select FRAME to forward the values of frame-local variables into C
12881 variables so that the redisplay routines can access those values
12885 select_frame_for_redisplay (Lisp_Object frame
)
12887 Lisp_Object tail
, tem
;
12888 Lisp_Object old
= selected_frame
;
12889 struct Lisp_Symbol
*sym
;
12891 eassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12893 selected_frame
= frame
;
12896 for (tail
= XFRAME (frame
)->param_alist
;
12897 CONSP (tail
); tail
= XCDR (tail
))
12898 if (CONSP (XCAR (tail
))
12899 && (tem
= XCAR (XCAR (tail
)),
12901 && (sym
= indirect_variable (XSYMBOL (tem
)),
12902 sym
->redirect
== SYMBOL_LOCALIZED
)
12903 && sym
->val
.blv
->frame_local
)
12904 /* Use find_symbol_value rather than Fsymbol_value
12905 to avoid an error if it is void. */
12906 find_symbol_value (tem
);
12907 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12911 #define STOP_POLLING \
12912 do { if (! polling_stopped_here) stop_polling (); \
12913 polling_stopped_here = 1; } while (0)
12915 #define RESUME_POLLING \
12916 do { if (polling_stopped_here) start_polling (); \
12917 polling_stopped_here = 0; } while (0)
12920 /* Perhaps in the future avoid recentering windows if it
12921 is not necessary; currently that causes some problems. */
12924 redisplay_internal (void)
12926 struct window
*w
= XWINDOW (selected_window
);
12930 int must_finish
= 0;
12931 struct text_pos tlbufpos
, tlendpos
;
12932 int number_of_visible_frames
;
12933 ptrdiff_t count
, count1
;
12935 int polling_stopped_here
= 0;
12936 Lisp_Object old_frame
= selected_frame
;
12938 /* Non-zero means redisplay has to consider all windows on all
12939 frames. Zero means, only selected_window is considered. */
12940 int consider_all_windows_p
;
12942 /* Non-zero means redisplay has to redisplay the miniwindow */
12943 int update_miniwindow_p
= 0;
12945 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12947 /* No redisplay if running in batch mode or frame is not yet fully
12948 initialized, or redisplay is explicitly turned off by setting
12949 Vinhibit_redisplay. */
12950 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12951 || !NILP (Vinhibit_redisplay
))
12954 /* Don't examine these until after testing Vinhibit_redisplay.
12955 When Emacs is shutting down, perhaps because its connection to
12956 X has dropped, we should not look at them at all. */
12957 fr
= XFRAME (w
->frame
);
12958 sf
= SELECTED_FRAME ();
12960 if (!fr
->glyphs_initialized_p
)
12963 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12964 if (popup_activated ())
12968 /* I don't think this happens but let's be paranoid. */
12969 if (redisplaying_p
)
12972 /* Record a function that clears redisplaying_p
12973 when we leave this function. */
12974 count
= SPECPDL_INDEX ();
12975 record_unwind_protect (unwind_redisplay
, selected_frame
);
12976 redisplaying_p
= 1;
12977 specbind (Qinhibit_free_realized_faces
, Qnil
);
12980 Lisp_Object tail
, frame
;
12982 FOR_EACH_FRAME (tail
, frame
)
12984 struct frame
*f
= XFRAME (frame
);
12985 f
->already_hscrolled_p
= 0;
12990 /* Remember the currently selected window. */
12993 if (!EQ (old_frame
, selected_frame
)
12994 && FRAME_LIVE_P (XFRAME (old_frame
)))
12995 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12996 selected_frame and selected_window to be temporarily out-of-sync so
12997 when we come back here via `goto retry', we need to resync because we
12998 may need to run Elisp code (via prepare_menu_bars). */
12999 select_frame_for_redisplay (old_frame
);
13002 reconsider_clip_changes (w
, current_buffer
);
13003 last_escape_glyph_frame
= NULL
;
13004 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13005 last_glyphless_glyph_frame
= NULL
;
13006 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13008 /* If new fonts have been loaded that make a glyph matrix adjustment
13009 necessary, do it. */
13010 if (fonts_changed_p
)
13012 adjust_glyphs (NULL
);
13013 ++windows_or_buffers_changed
;
13014 fonts_changed_p
= 0;
13017 /* If face_change_count is non-zero, init_iterator will free all
13018 realized faces, which includes the faces referenced from current
13019 matrices. So, we can't reuse current matrices in this case. */
13020 if (face_change_count
)
13021 ++windows_or_buffers_changed
;
13023 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13024 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13026 /* Since frames on a single ASCII terminal share the same
13027 display area, displaying a different frame means redisplay
13028 the whole thing. */
13029 windows_or_buffers_changed
++;
13030 SET_FRAME_GARBAGED (sf
);
13032 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13034 FRAME_TTY (sf
)->previous_frame
= sf
;
13037 /* Set the visible flags for all frames. Do this before checking
13038 for resized or garbaged frames; they want to know if their frames
13039 are visible. See the comment in frame.h for
13040 FRAME_SAMPLE_VISIBILITY. */
13042 Lisp_Object tail
, frame
;
13044 number_of_visible_frames
= 0;
13046 FOR_EACH_FRAME (tail
, frame
)
13048 struct frame
*f
= XFRAME (frame
);
13050 FRAME_SAMPLE_VISIBILITY (f
);
13051 if (FRAME_VISIBLE_P (f
))
13052 ++number_of_visible_frames
;
13053 clear_desired_matrices (f
);
13057 /* Notice any pending interrupt request to change frame size. */
13058 do_pending_window_change (1);
13060 /* do_pending_window_change could change the selected_window due to
13061 frame resizing which makes the selected window too small. */
13062 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13065 reconsider_clip_changes (w
, current_buffer
);
13068 /* Clear frames marked as garbaged. */
13069 if (frame_garbaged
)
13070 clear_garbaged_frames ();
13072 /* Build menubar and tool-bar items. */
13073 if (NILP (Vmemory_full
))
13074 prepare_menu_bars ();
13076 if (windows_or_buffers_changed
)
13077 update_mode_lines
++;
13079 /* Detect case that we need to write or remove a star in the mode line. */
13080 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13082 w
->update_mode_line
= 1;
13083 if (buffer_shared
> 1)
13084 update_mode_lines
++;
13087 /* Avoid invocation of point motion hooks by `current_column' below. */
13088 count1
= SPECPDL_INDEX ();
13089 specbind (Qinhibit_point_motion_hooks
, Qt
);
13091 /* If %c is in the mode line, update it if needed. */
13092 if (!NILP (w
->column_number_displayed
)
13093 /* This alternative quickly identifies a common case
13094 where no change is needed. */
13095 && !(PT
== w
->last_point
13096 && w
->last_modified
>= MODIFF
13097 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)
13098 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13099 w
->update_mode_line
= 1;
13101 unbind_to (count1
, Qnil
);
13103 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
13105 /* The variable buffer_shared is set in redisplay_window and
13106 indicates that we redisplay a buffer in different windows. See
13108 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
13109 || cursor_type_changed
);
13111 /* If specs for an arrow have changed, do thorough redisplay
13112 to ensure we remove any arrow that should no longer exist. */
13113 if (overlay_arrows_changed_p ())
13114 consider_all_windows_p
= windows_or_buffers_changed
= 1;
13116 /* Normally the message* functions will have already displayed and
13117 updated the echo area, but the frame may have been trashed, or
13118 the update may have been preempted, so display the echo area
13119 again here. Checking message_cleared_p captures the case that
13120 the echo area should be cleared. */
13121 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13122 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13123 || (message_cleared_p
13124 && minibuf_level
== 0
13125 /* If the mini-window is currently selected, this means the
13126 echo-area doesn't show through. */
13127 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13129 int window_height_changed_p
= echo_area_display (0);
13131 if (message_cleared_p
)
13132 update_miniwindow_p
= 1;
13136 /* If we don't display the current message, don't clear the
13137 message_cleared_p flag, because, if we did, we wouldn't clear
13138 the echo area in the next redisplay which doesn't preserve
13140 if (!display_last_displayed_message_p
)
13141 message_cleared_p
= 0;
13143 if (fonts_changed_p
)
13145 else if (window_height_changed_p
)
13147 consider_all_windows_p
= 1;
13148 ++update_mode_lines
;
13149 ++windows_or_buffers_changed
;
13151 /* If window configuration was changed, frames may have been
13152 marked garbaged. Clear them or we will experience
13153 surprises wrt scrolling. */
13154 if (frame_garbaged
)
13155 clear_garbaged_frames ();
13158 else if (EQ (selected_window
, minibuf_window
)
13159 && (current_buffer
->clip_changed
13160 || w
->last_modified
< MODIFF
13161 || w
->last_overlay_modified
< OVERLAY_MODIFF
)
13162 && resize_mini_window (w
, 0))
13164 /* Resized active mini-window to fit the size of what it is
13165 showing if its contents might have changed. */
13167 /* FIXME: this causes all frames to be updated, which seems unnecessary
13168 since only the current frame needs to be considered. This function needs
13169 to be rewritten with two variables, consider_all_windows and
13170 consider_all_frames. */
13171 consider_all_windows_p
= 1;
13172 ++windows_or_buffers_changed
;
13173 ++update_mode_lines
;
13175 /* If window configuration was changed, frames may have been
13176 marked garbaged. Clear them or we will experience
13177 surprises wrt scrolling. */
13178 if (frame_garbaged
)
13179 clear_garbaged_frames ();
13183 /* If showing the region, and mark has changed, we must redisplay
13184 the whole window. The assignment to this_line_start_pos prevents
13185 the optimization directly below this if-statement. */
13186 if (((!NILP (Vtransient_mark_mode
)
13187 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
13188 != !NILP (w
->region_showing
))
13189 || (!NILP (w
->region_showing
)
13190 && !EQ (w
->region_showing
,
13191 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
13192 CHARPOS (this_line_start_pos
) = 0;
13194 /* Optimize the case that only the line containing the cursor in the
13195 selected window has changed. Variables starting with this_ are
13196 set in display_line and record information about the line
13197 containing the cursor. */
13198 tlbufpos
= this_line_start_pos
;
13199 tlendpos
= this_line_end_pos
;
13200 if (!consider_all_windows_p
13201 && CHARPOS (tlbufpos
) > 0
13202 && !w
->update_mode_line
13203 && !current_buffer
->clip_changed
13204 && !current_buffer
->prevent_redisplay_optimizations_p
13205 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13206 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13207 /* Make sure recorded data applies to current buffer, etc. */
13208 && this_line_buffer
== current_buffer
13209 && current_buffer
== XBUFFER (w
->buffer
)
13211 && !w
->optional_new_start
13212 /* Point must be on the line that we have info recorded about. */
13213 && PT
>= CHARPOS (tlbufpos
)
13214 && PT
<= Z
- CHARPOS (tlendpos
)
13215 /* All text outside that line, including its final newline,
13216 must be unchanged. */
13217 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13218 CHARPOS (tlendpos
)))
13220 if (CHARPOS (tlbufpos
) > BEGV
13221 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13222 && (CHARPOS (tlbufpos
) == ZV
13223 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13224 /* Former continuation line has disappeared by becoming empty. */
13226 else if (w
->last_modified
< MODIFF
13227 || w
->last_overlay_modified
< OVERLAY_MODIFF
13228 || MINI_WINDOW_P (w
))
13230 /* We have to handle the case of continuation around a
13231 wide-column character (see the comment in indent.c around
13234 For instance, in the following case:
13236 -------- Insert --------
13237 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13238 J_I_ ==> J_I_ `^^' are cursors.
13242 As we have to redraw the line above, we cannot use this
13246 int line_height_before
= this_line_pixel_height
;
13248 /* Note that start_display will handle the case that the
13249 line starting at tlbufpos is a continuation line. */
13250 start_display (&it
, w
, tlbufpos
);
13252 /* Implementation note: It this still necessary? */
13253 if (it
.current_x
!= this_line_start_x
)
13256 TRACE ((stderr
, "trying display optimization 1\n"));
13257 w
->cursor
.vpos
= -1;
13258 overlay_arrow_seen
= 0;
13259 it
.vpos
= this_line_vpos
;
13260 it
.current_y
= this_line_y
;
13261 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13262 display_line (&it
);
13264 /* If line contains point, is not continued,
13265 and ends at same distance from eob as before, we win. */
13266 if (w
->cursor
.vpos
>= 0
13267 /* Line is not continued, otherwise this_line_start_pos
13268 would have been set to 0 in display_line. */
13269 && CHARPOS (this_line_start_pos
)
13270 /* Line ends as before. */
13271 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13272 /* Line has same height as before. Otherwise other lines
13273 would have to be shifted up or down. */
13274 && this_line_pixel_height
== line_height_before
)
13276 /* If this is not the window's last line, we must adjust
13277 the charstarts of the lines below. */
13278 if (it
.current_y
< it
.last_visible_y
)
13280 struct glyph_row
*row
13281 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13282 ptrdiff_t delta
, delta_bytes
;
13284 /* We used to distinguish between two cases here,
13285 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13286 when the line ends in a newline or the end of the
13287 buffer's accessible portion. But both cases did
13288 the same, so they were collapsed. */
13290 - CHARPOS (tlendpos
)
13291 - MATRIX_ROW_START_CHARPOS (row
));
13292 delta_bytes
= (Z_BYTE
13293 - BYTEPOS (tlendpos
)
13294 - MATRIX_ROW_START_BYTEPOS (row
));
13296 increment_matrix_positions (w
->current_matrix
,
13297 this_line_vpos
+ 1,
13298 w
->current_matrix
->nrows
,
13299 delta
, delta_bytes
);
13302 /* If this row displays text now but previously didn't,
13303 or vice versa, w->window_end_vpos may have to be
13305 if ((it
.glyph_row
- 1)->displays_text_p
)
13307 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13308 wset_window_end_vpos (w
, make_number (this_line_vpos
));
13310 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13311 && this_line_vpos
> 0)
13312 wset_window_end_vpos (w
, make_number (this_line_vpos
- 1));
13313 wset_window_end_valid (w
, Qnil
);
13315 /* Update hint: No need to try to scroll in update_window. */
13316 w
->desired_matrix
->no_scrolling_p
= 1;
13319 *w
->desired_matrix
->method
= 0;
13320 debug_method_add (w
, "optimization 1");
13322 #ifdef HAVE_WINDOW_SYSTEM
13323 update_window_fringes (w
, 0);
13330 else if (/* Cursor position hasn't changed. */
13331 PT
== w
->last_point
13332 /* Make sure the cursor was last displayed
13333 in this window. Otherwise we have to reposition it. */
13334 && 0 <= w
->cursor
.vpos
13335 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13339 do_pending_window_change (1);
13340 /* If selected_window changed, redisplay again. */
13341 if (WINDOWP (selected_window
)
13342 && (w
= XWINDOW (selected_window
)) != sw
)
13345 /* We used to always goto end_of_redisplay here, but this
13346 isn't enough if we have a blinking cursor. */
13347 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13348 goto end_of_redisplay
;
13352 /* If highlighting the region, or if the cursor is in the echo area,
13353 then we can't just move the cursor. */
13354 else if (! (!NILP (Vtransient_mark_mode
)
13355 && !NILP (BVAR (current_buffer
, mark_active
)))
13356 && (EQ (selected_window
,
13357 BVAR (current_buffer
, last_selected_window
))
13358 || highlight_nonselected_windows
)
13359 && NILP (w
->region_showing
)
13360 && NILP (Vshow_trailing_whitespace
)
13361 && !cursor_in_echo_area
)
13364 struct glyph_row
*row
;
13366 /* Skip from tlbufpos to PT and see where it is. Note that
13367 PT may be in invisible text. If so, we will end at the
13368 next visible position. */
13369 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13370 NULL
, DEFAULT_FACE_ID
);
13371 it
.current_x
= this_line_start_x
;
13372 it
.current_y
= this_line_y
;
13373 it
.vpos
= this_line_vpos
;
13375 /* The call to move_it_to stops in front of PT, but
13376 moves over before-strings. */
13377 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13379 if (it
.vpos
== this_line_vpos
13380 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13383 eassert (this_line_vpos
== it
.vpos
);
13384 eassert (this_line_y
== it
.current_y
);
13385 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13387 *w
->desired_matrix
->method
= 0;
13388 debug_method_add (w
, "optimization 3");
13397 /* Text changed drastically or point moved off of line. */
13398 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13401 CHARPOS (this_line_start_pos
) = 0;
13402 consider_all_windows_p
|= buffer_shared
> 1;
13403 ++clear_face_cache_count
;
13404 #ifdef HAVE_WINDOW_SYSTEM
13405 ++clear_image_cache_count
;
13408 /* Build desired matrices, and update the display. If
13409 consider_all_windows_p is non-zero, do it for all windows on all
13410 frames. Otherwise do it for selected_window, only. */
13412 if (consider_all_windows_p
)
13414 Lisp_Object tail
, frame
;
13416 FOR_EACH_FRAME (tail
, frame
)
13417 XFRAME (frame
)->updated_p
= 0;
13419 /* Recompute # windows showing selected buffer. This will be
13420 incremented each time such a window is displayed. */
13423 FOR_EACH_FRAME (tail
, frame
)
13425 struct frame
*f
= XFRAME (frame
);
13427 /* We don't have to do anything for unselected terminal
13429 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13430 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13433 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13435 if (! EQ (frame
, selected_frame
))
13436 /* Select the frame, for the sake of frame-local
13438 select_frame_for_redisplay (frame
);
13440 /* Mark all the scroll bars to be removed; we'll redeem
13441 the ones we want when we redisplay their windows. */
13442 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13443 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13445 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13446 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13448 /* The X error handler may have deleted that frame. */
13449 if (!FRAME_LIVE_P (f
))
13452 /* Any scroll bars which redisplay_windows should have
13453 nuked should now go away. */
13454 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13455 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13457 /* If fonts changed, display again. */
13458 /* ??? rms: I suspect it is a mistake to jump all the way
13459 back to retry here. It should just retry this frame. */
13460 if (fonts_changed_p
)
13463 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13465 /* See if we have to hscroll. */
13466 if (!f
->already_hscrolled_p
)
13468 f
->already_hscrolled_p
= 1;
13469 if (hscroll_windows (f
->root_window
))
13473 /* Prevent various kinds of signals during display
13474 update. stdio is not robust about handling
13475 signals, which can cause an apparent I/O
13477 if (interrupt_input
)
13478 unrequest_sigio ();
13481 /* Update the display. */
13482 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13483 pending
|= update_frame (f
, 0, 0);
13489 if (!EQ (old_frame
, selected_frame
)
13490 && FRAME_LIVE_P (XFRAME (old_frame
)))
13491 /* We played a bit fast-and-loose above and allowed selected_frame
13492 and selected_window to be temporarily out-of-sync but let's make
13493 sure this stays contained. */
13494 select_frame_for_redisplay (old_frame
);
13495 eassert (EQ (XFRAME (selected_frame
)->selected_window
,
13500 /* Do the mark_window_display_accurate after all windows have
13501 been redisplayed because this call resets flags in buffers
13502 which are needed for proper redisplay. */
13503 FOR_EACH_FRAME (tail
, frame
)
13505 struct frame
*f
= XFRAME (frame
);
13508 mark_window_display_accurate (f
->root_window
, 1);
13509 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13510 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13515 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13517 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13518 struct frame
*mini_frame
;
13520 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13521 /* Use list_of_error, not Qerror, so that
13522 we catch only errors and don't run the debugger. */
13523 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13525 redisplay_window_error
);
13526 if (update_miniwindow_p
)
13527 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13529 redisplay_window_error
);
13531 /* Compare desired and current matrices, perform output. */
13534 /* If fonts changed, display again. */
13535 if (fonts_changed_p
)
13538 /* Prevent various kinds of signals during display update.
13539 stdio is not robust about handling signals,
13540 which can cause an apparent I/O error. */
13541 if (interrupt_input
)
13542 unrequest_sigio ();
13545 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13547 if (hscroll_windows (selected_window
))
13550 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13551 pending
= update_frame (sf
, 0, 0);
13554 /* We may have called echo_area_display at the top of this
13555 function. If the echo area is on another frame, that may
13556 have put text on a frame other than the selected one, so the
13557 above call to update_frame would not have caught it. Catch
13559 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13560 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13562 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13564 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13565 pending
|= update_frame (mini_frame
, 0, 0);
13566 if (!pending
&& hscroll_windows (mini_window
))
13571 /* If display was paused because of pending input, make sure we do a
13572 thorough update the next time. */
13575 /* Prevent the optimization at the beginning of
13576 redisplay_internal that tries a single-line update of the
13577 line containing the cursor in the selected window. */
13578 CHARPOS (this_line_start_pos
) = 0;
13580 /* Let the overlay arrow be updated the next time. */
13581 update_overlay_arrows (0);
13583 /* If we pause after scrolling, some rows in the current
13584 matrices of some windows are not valid. */
13585 if (!WINDOW_FULL_WIDTH_P (w
)
13586 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13587 update_mode_lines
= 1;
13591 if (!consider_all_windows_p
)
13593 /* This has already been done above if
13594 consider_all_windows_p is set. */
13595 mark_window_display_accurate_1 (w
, 1);
13597 /* Say overlay arrows are up to date. */
13598 update_overlay_arrows (1);
13600 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13601 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13604 update_mode_lines
= 0;
13605 windows_or_buffers_changed
= 0;
13606 cursor_type_changed
= 0;
13609 /* Start SIGIO interrupts coming again. Having them off during the
13610 code above makes it less likely one will discard output, but not
13611 impossible, since there might be stuff in the system buffer here.
13612 But it is much hairier to try to do anything about that. */
13613 if (interrupt_input
)
13617 /* If a frame has become visible which was not before, redisplay
13618 again, so that we display it. Expose events for such a frame
13619 (which it gets when becoming visible) don't call the parts of
13620 redisplay constructing glyphs, so simply exposing a frame won't
13621 display anything in this case. So, we have to display these
13622 frames here explicitly. */
13625 Lisp_Object tail
, frame
;
13628 FOR_EACH_FRAME (tail
, frame
)
13630 int this_is_visible
= 0;
13632 if (XFRAME (frame
)->visible
)
13633 this_is_visible
= 1;
13634 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13635 if (XFRAME (frame
)->visible
)
13636 this_is_visible
= 1;
13638 if (this_is_visible
)
13642 if (new_count
!= number_of_visible_frames
)
13643 windows_or_buffers_changed
++;
13646 /* Change frame size now if a change is pending. */
13647 do_pending_window_change (1);
13649 /* If we just did a pending size change, or have additional
13650 visible frames, or selected_window changed, redisplay again. */
13651 if ((windows_or_buffers_changed
&& !pending
)
13652 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13655 /* Clear the face and image caches.
13657 We used to do this only if consider_all_windows_p. But the cache
13658 needs to be cleared if a timer creates images in the current
13659 buffer (e.g. the test case in Bug#6230). */
13661 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13663 clear_face_cache (0);
13664 clear_face_cache_count
= 0;
13667 #ifdef HAVE_WINDOW_SYSTEM
13668 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13670 clear_image_caches (Qnil
);
13671 clear_image_cache_count
= 0;
13673 #endif /* HAVE_WINDOW_SYSTEM */
13676 unbind_to (count
, Qnil
);
13681 /* Redisplay, but leave alone any recent echo area message unless
13682 another message has been requested in its place.
13684 This is useful in situations where you need to redisplay but no
13685 user action has occurred, making it inappropriate for the message
13686 area to be cleared. See tracking_off and
13687 wait_reading_process_output for examples of these situations.
13689 FROM_WHERE is an integer saying from where this function was
13690 called. This is useful for debugging. */
13693 redisplay_preserve_echo_area (int from_where
)
13695 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13697 if (!NILP (echo_area_buffer
[1]))
13699 /* We have a previously displayed message, but no current
13700 message. Redisplay the previous message. */
13701 display_last_displayed_message_p
= 1;
13702 redisplay_internal ();
13703 display_last_displayed_message_p
= 0;
13706 redisplay_internal ();
13708 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13709 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13710 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13714 /* Function registered with record_unwind_protect in redisplay_internal.
13715 Clear redisplaying_p. Also, select the previously
13716 selected frame, unless it has been deleted (by an X connection
13717 failure during redisplay, for example). */
13720 unwind_redisplay (Lisp_Object old_frame
)
13722 redisplaying_p
= 0;
13723 if (! EQ (old_frame
, selected_frame
)
13724 && FRAME_LIVE_P (XFRAME (old_frame
)))
13725 select_frame_for_redisplay (old_frame
);
13730 /* Mark the display of window W as accurate or inaccurate. If
13731 ACCURATE_P is non-zero mark display of W as accurate. If
13732 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13733 redisplay_internal is called. */
13736 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13738 if (BUFFERP (w
->buffer
))
13740 struct buffer
*b
= XBUFFER (w
->buffer
);
13742 w
->last_modified
= accurate_p
? BUF_MODIFF(b
) : 0;
13743 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF(b
) : 0;
13745 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13749 b
->clip_changed
= 0;
13750 b
->prevent_redisplay_optimizations_p
= 0;
13752 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13753 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13754 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13755 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13757 w
->current_matrix
->buffer
= b
;
13758 w
->current_matrix
->begv
= BUF_BEGV (b
);
13759 w
->current_matrix
->zv
= BUF_ZV (b
);
13761 w
->last_cursor
= w
->cursor
;
13762 w
->last_cursor_off_p
= w
->cursor_off_p
;
13764 if (w
== XWINDOW (selected_window
))
13765 w
->last_point
= BUF_PT (b
);
13767 w
->last_point
= XMARKER (w
->pointm
)->charpos
;
13773 wset_window_end_valid (w
, w
->buffer
);
13774 w
->update_mode_line
= 0;
13779 /* Mark the display of windows in the window tree rooted at WINDOW as
13780 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13781 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13782 be redisplayed the next time redisplay_internal is called. */
13785 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13789 for (; !NILP (window
); window
= w
->next
)
13791 w
= XWINDOW (window
);
13792 mark_window_display_accurate_1 (w
, accurate_p
);
13794 if (!NILP (w
->vchild
))
13795 mark_window_display_accurate (w
->vchild
, accurate_p
);
13796 if (!NILP (w
->hchild
))
13797 mark_window_display_accurate (w
->hchild
, accurate_p
);
13802 update_overlay_arrows (1);
13806 /* Force a thorough redisplay the next time by setting
13807 last_arrow_position and last_arrow_string to t, which is
13808 unequal to any useful value of Voverlay_arrow_... */
13809 update_overlay_arrows (-1);
13814 /* Return value in display table DP (Lisp_Char_Table *) for character
13815 C. Since a display table doesn't have any parent, we don't have to
13816 follow parent. Do not call this function directly but use the
13817 macro DISP_CHAR_VECTOR. */
13820 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13824 if (ASCII_CHAR_P (c
))
13827 if (SUB_CHAR_TABLE_P (val
))
13828 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13834 XSETCHAR_TABLE (table
, dp
);
13835 val
= char_table_ref (table
, c
);
13844 /***********************************************************************
13846 ***********************************************************************/
13848 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13851 redisplay_windows (Lisp_Object window
)
13853 while (!NILP (window
))
13855 struct window
*w
= XWINDOW (window
);
13857 if (!NILP (w
->hchild
))
13858 redisplay_windows (w
->hchild
);
13859 else if (!NILP (w
->vchild
))
13860 redisplay_windows (w
->vchild
);
13861 else if (!NILP (w
->buffer
))
13863 displayed_buffer
= XBUFFER (w
->buffer
);
13864 /* Use list_of_error, not Qerror, so that
13865 we catch only errors and don't run the debugger. */
13866 internal_condition_case_1 (redisplay_window_0
, window
,
13868 redisplay_window_error
);
13876 redisplay_window_error (Lisp_Object ignore
)
13878 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13883 redisplay_window_0 (Lisp_Object window
)
13885 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13886 redisplay_window (window
, 0);
13891 redisplay_window_1 (Lisp_Object window
)
13893 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13894 redisplay_window (window
, 1);
13899 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13900 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13901 which positions recorded in ROW differ from current buffer
13904 Return 0 if cursor is not on this row, 1 otherwise. */
13907 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13908 struct glyph_matrix
*matrix
,
13909 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13912 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13913 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13914 struct glyph
*cursor
= NULL
;
13915 /* The last known character position in row. */
13916 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13918 ptrdiff_t pt_old
= PT
- delta
;
13919 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13920 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13921 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13922 /* A glyph beyond the edge of TEXT_AREA which we should never
13924 struct glyph
*glyphs_end
= end
;
13925 /* Non-zero means we've found a match for cursor position, but that
13926 glyph has the avoid_cursor_p flag set. */
13927 int match_with_avoid_cursor
= 0;
13928 /* Non-zero means we've seen at least one glyph that came from a
13930 int string_seen
= 0;
13931 /* Largest and smallest buffer positions seen so far during scan of
13933 ptrdiff_t bpos_max
= pos_before
;
13934 ptrdiff_t bpos_min
= pos_after
;
13935 /* Last buffer position covered by an overlay string with an integer
13936 `cursor' property. */
13937 ptrdiff_t bpos_covered
= 0;
13938 /* Non-zero means the display string on which to display the cursor
13939 comes from a text property, not from an overlay. */
13940 int string_from_text_prop
= 0;
13942 /* Don't even try doing anything if called for a mode-line or
13943 header-line row, since the rest of the code isn't prepared to
13944 deal with such calamities. */
13945 eassert (!row
->mode_line_p
);
13946 if (row
->mode_line_p
)
13949 /* Skip over glyphs not having an object at the start and the end of
13950 the row. These are special glyphs like truncation marks on
13951 terminal frames. */
13952 if (row
->displays_text_p
)
13954 if (!row
->reversed_p
)
13957 && INTEGERP (glyph
->object
)
13958 && glyph
->charpos
< 0)
13960 x
+= glyph
->pixel_width
;
13964 && INTEGERP ((end
- 1)->object
)
13965 /* CHARPOS is zero for blanks and stretch glyphs
13966 inserted by extend_face_to_end_of_line. */
13967 && (end
- 1)->charpos
<= 0)
13969 glyph_before
= glyph
- 1;
13976 /* If the glyph row is reversed, we need to process it from back
13977 to front, so swap the edge pointers. */
13978 glyphs_end
= end
= glyph
- 1;
13979 glyph
+= row
->used
[TEXT_AREA
] - 1;
13981 while (glyph
> end
+ 1
13982 && INTEGERP (glyph
->object
)
13983 && glyph
->charpos
< 0)
13986 x
-= glyph
->pixel_width
;
13988 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13990 /* By default, in reversed rows we put the cursor on the
13991 rightmost (first in the reading order) glyph. */
13992 for (g
= end
+ 1; g
< glyph
; g
++)
13993 x
+= g
->pixel_width
;
13995 && INTEGERP ((end
+ 1)->object
)
13996 && (end
+ 1)->charpos
<= 0)
13998 glyph_before
= glyph
+ 1;
14002 else if (row
->reversed_p
)
14004 /* In R2L rows that don't display text, put the cursor on the
14005 rightmost glyph. Case in point: an empty last line that is
14006 part of an R2L paragraph. */
14008 /* Avoid placing the cursor on the last glyph of the row, where
14009 on terminal frames we hold the vertical border between
14010 adjacent windows. */
14011 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14012 && !WINDOW_RIGHTMOST_P (w
)
14013 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14015 x
= -1; /* will be computed below, at label compute_x */
14018 /* Step 1: Try to find the glyph whose character position
14019 corresponds to point. If that's not possible, find 2 glyphs
14020 whose character positions are the closest to point, one before
14021 point, the other after it. */
14022 if (!row
->reversed_p
)
14023 while (/* not marched to end of glyph row */
14025 /* glyph was not inserted by redisplay for internal purposes */
14026 && !INTEGERP (glyph
->object
))
14028 if (BUFFERP (glyph
->object
))
14030 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14032 if (glyph
->charpos
> bpos_max
)
14033 bpos_max
= glyph
->charpos
;
14034 if (glyph
->charpos
< bpos_min
)
14035 bpos_min
= glyph
->charpos
;
14036 if (!glyph
->avoid_cursor_p
)
14038 /* If we hit point, we've found the glyph on which to
14039 display the cursor. */
14042 match_with_avoid_cursor
= 0;
14045 /* See if we've found a better approximation to
14046 POS_BEFORE or to POS_AFTER. */
14047 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14049 pos_before
= glyph
->charpos
;
14050 glyph_before
= glyph
;
14052 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14054 pos_after
= glyph
->charpos
;
14055 glyph_after
= glyph
;
14058 else if (dpos
== 0)
14059 match_with_avoid_cursor
= 1;
14061 else if (STRINGP (glyph
->object
))
14063 Lisp_Object chprop
;
14064 ptrdiff_t glyph_pos
= glyph
->charpos
;
14066 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14068 if (!NILP (chprop
))
14070 /* If the string came from a `display' text property,
14071 look up the buffer position of that property and
14072 use that position to update bpos_max, as if we
14073 actually saw such a position in one of the row's
14074 glyphs. This helps with supporting integer values
14075 of `cursor' property on the display string in
14076 situations where most or all of the row's buffer
14077 text is completely covered by display properties,
14078 so that no glyph with valid buffer positions is
14079 ever seen in the row. */
14080 ptrdiff_t prop_pos
=
14081 string_buffer_position_lim (glyph
->object
, pos_before
,
14084 if (prop_pos
>= pos_before
)
14085 bpos_max
= prop_pos
- 1;
14087 if (INTEGERP (chprop
))
14089 bpos_covered
= bpos_max
+ XINT (chprop
);
14090 /* If the `cursor' property covers buffer positions up
14091 to and including point, we should display cursor on
14092 this glyph. Note that, if a `cursor' property on one
14093 of the string's characters has an integer value, we
14094 will break out of the loop below _before_ we get to
14095 the position match above. IOW, integer values of
14096 the `cursor' property override the "exact match for
14097 point" strategy of positioning the cursor. */
14098 /* Implementation note: bpos_max == pt_old when, e.g.,
14099 we are in an empty line, where bpos_max is set to
14100 MATRIX_ROW_START_CHARPOS, see above. */
14101 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14110 x
+= glyph
->pixel_width
;
14113 else if (glyph
> end
) /* row is reversed */
14114 while (!INTEGERP (glyph
->object
))
14116 if (BUFFERP (glyph
->object
))
14118 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14120 if (glyph
->charpos
> bpos_max
)
14121 bpos_max
= glyph
->charpos
;
14122 if (glyph
->charpos
< bpos_min
)
14123 bpos_min
= glyph
->charpos
;
14124 if (!glyph
->avoid_cursor_p
)
14128 match_with_avoid_cursor
= 0;
14131 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14133 pos_before
= glyph
->charpos
;
14134 glyph_before
= glyph
;
14136 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14138 pos_after
= glyph
->charpos
;
14139 glyph_after
= glyph
;
14142 else if (dpos
== 0)
14143 match_with_avoid_cursor
= 1;
14145 else if (STRINGP (glyph
->object
))
14147 Lisp_Object chprop
;
14148 ptrdiff_t glyph_pos
= glyph
->charpos
;
14150 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14152 if (!NILP (chprop
))
14154 ptrdiff_t prop_pos
=
14155 string_buffer_position_lim (glyph
->object
, pos_before
,
14158 if (prop_pos
>= pos_before
)
14159 bpos_max
= prop_pos
- 1;
14161 if (INTEGERP (chprop
))
14163 bpos_covered
= bpos_max
+ XINT (chprop
);
14164 /* If the `cursor' property covers buffer positions up
14165 to and including point, we should display cursor on
14167 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14176 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14178 x
--; /* can't use any pixel_width */
14181 x
-= glyph
->pixel_width
;
14184 /* Step 2: If we didn't find an exact match for point, we need to
14185 look for a proper place to put the cursor among glyphs between
14186 GLYPH_BEFORE and GLYPH_AFTER. */
14187 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14188 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14189 && bpos_covered
< pt_old
)
14191 /* An empty line has a single glyph whose OBJECT is zero and
14192 whose CHARPOS is the position of a newline on that line.
14193 Note that on a TTY, there are more glyphs after that, which
14194 were produced by extend_face_to_end_of_line, but their
14195 CHARPOS is zero or negative. */
14197 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14198 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
14200 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14202 ptrdiff_t ellipsis_pos
;
14204 /* Scan back over the ellipsis glyphs. */
14205 if (!row
->reversed_p
)
14207 ellipsis_pos
= (glyph
- 1)->charpos
;
14208 while (glyph
> row
->glyphs
[TEXT_AREA
]
14209 && (glyph
- 1)->charpos
== ellipsis_pos
)
14210 glyph
--, x
-= glyph
->pixel_width
;
14211 /* That loop always goes one position too far, including
14212 the glyph before the ellipsis. So scan forward over
14214 x
+= glyph
->pixel_width
;
14217 else /* row is reversed */
14219 ellipsis_pos
= (glyph
+ 1)->charpos
;
14220 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14221 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14222 glyph
++, x
+= glyph
->pixel_width
;
14223 x
-= glyph
->pixel_width
;
14227 else if (match_with_avoid_cursor
)
14229 cursor
= glyph_after
;
14232 else if (string_seen
)
14234 int incr
= row
->reversed_p
? -1 : +1;
14236 /* Need to find the glyph that came out of a string which is
14237 present at point. That glyph is somewhere between
14238 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14239 positioned between POS_BEFORE and POS_AFTER in the
14241 struct glyph
*start
, *stop
;
14242 ptrdiff_t pos
= pos_before
;
14246 /* If the row ends in a newline from a display string,
14247 reordering could have moved the glyphs belonging to the
14248 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14249 in this case we extend the search to the last glyph in
14250 the row that was not inserted by redisplay. */
14251 if (row
->ends_in_newline_from_string_p
)
14254 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14257 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14258 correspond to POS_BEFORE and POS_AFTER, respectively. We
14259 need START and STOP in the order that corresponds to the
14260 row's direction as given by its reversed_p flag. If the
14261 directionality of characters between POS_BEFORE and
14262 POS_AFTER is the opposite of the row's base direction,
14263 these characters will have been reordered for display,
14264 and we need to reverse START and STOP. */
14265 if (!row
->reversed_p
)
14267 start
= min (glyph_before
, glyph_after
);
14268 stop
= max (glyph_before
, glyph_after
);
14272 start
= max (glyph_before
, glyph_after
);
14273 stop
= min (glyph_before
, glyph_after
);
14275 for (glyph
= start
+ incr
;
14276 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14279 /* Any glyphs that come from the buffer are here because
14280 of bidi reordering. Skip them, and only pay
14281 attention to glyphs that came from some string. */
14282 if (STRINGP (glyph
->object
))
14286 /* If the display property covers the newline, we
14287 need to search for it one position farther. */
14288 ptrdiff_t lim
= pos_after
14289 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14291 string_from_text_prop
= 0;
14292 str
= glyph
->object
;
14293 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14294 if (tem
== 0 /* from overlay */
14297 /* If the string from which this glyph came is
14298 found in the buffer at point, or at position
14299 that is closer to point than pos_after, then
14300 we've found the glyph we've been looking for.
14301 If it comes from an overlay (tem == 0), and
14302 it has the `cursor' property on one of its
14303 glyphs, record that glyph as a candidate for
14304 displaying the cursor. (As in the
14305 unidirectional version, we will display the
14306 cursor on the last candidate we find.) */
14309 || (tem
- pt_old
> 0 && tem
< pos_after
))
14311 /* The glyphs from this string could have
14312 been reordered. Find the one with the
14313 smallest string position. Or there could
14314 be a character in the string with the
14315 `cursor' property, which means display
14316 cursor on that character's glyph. */
14317 ptrdiff_t strpos
= glyph
->charpos
;
14322 string_from_text_prop
= 1;
14325 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14326 && EQ (glyph
->object
, str
);
14330 ptrdiff_t gpos
= glyph
->charpos
;
14332 cprop
= Fget_char_property (make_number (gpos
),
14340 if (tem
&& glyph
->charpos
< strpos
)
14342 strpos
= glyph
->charpos
;
14348 || (tem
- pt_old
> 0 && tem
< pos_after
))
14352 pos
= tem
+ 1; /* don't find previous instances */
14354 /* This string is not what we want; skip all of the
14355 glyphs that came from it. */
14356 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14357 && EQ (glyph
->object
, str
))
14364 /* If we reached the end of the line, and END was from a string,
14365 the cursor is not on this line. */
14367 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14368 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14369 && STRINGP (end
->object
)
14370 && row
->continued_p
)
14373 /* A truncated row may not include PT among its character positions.
14374 Setting the cursor inside the scroll margin will trigger
14375 recalculation of hscroll in hscroll_window_tree. But if a
14376 display string covers point, defer to the string-handling
14377 code below to figure this out. */
14378 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14380 cursor
= glyph_before
;
14383 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14384 /* Zero-width characters produce no glyphs. */
14386 && (row
->reversed_p
14387 ? glyph_after
> glyphs_end
14388 : glyph_after
< glyphs_end
)))
14390 cursor
= glyph_after
;
14396 if (cursor
!= NULL
)
14398 else if (glyph
== glyphs_end
14399 && pos_before
== pos_after
14400 && STRINGP ((row
->reversed_p
14401 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14402 : row
->glyphs
[TEXT_AREA
])->object
))
14404 /* If all the glyphs of this row came from strings, put the
14405 cursor on the first glyph of the row. This avoids having the
14406 cursor outside of the text area in this very rare and hard
14410 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14411 : row
->glyphs
[TEXT_AREA
];
14417 /* Need to compute x that corresponds to GLYPH. */
14418 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14420 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14422 x
+= g
->pixel_width
;
14426 /* ROW could be part of a continued line, which, under bidi
14427 reordering, might have other rows whose start and end charpos
14428 occlude point. Only set w->cursor if we found a better
14429 approximation to the cursor position than we have from previously
14430 examined candidate rows belonging to the same continued line. */
14431 if (/* we already have a candidate row */
14432 w
->cursor
.vpos
>= 0
14433 /* that candidate is not the row we are processing */
14434 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14435 /* Make sure cursor.vpos specifies a row whose start and end
14436 charpos occlude point, and it is valid candidate for being a
14437 cursor-row. This is because some callers of this function
14438 leave cursor.vpos at the row where the cursor was displayed
14439 during the last redisplay cycle. */
14440 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14441 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14442 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14445 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14447 /* Don't consider glyphs that are outside TEXT_AREA. */
14448 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14450 /* Keep the candidate whose buffer position is the closest to
14451 point or has the `cursor' property. */
14452 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14453 w
->cursor
.hpos
>= 0
14454 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14455 && ((BUFFERP (g1
->object
)
14456 && (g1
->charpos
== pt_old
/* an exact match always wins */
14457 || (BUFFERP (glyph
->object
)
14458 && eabs (g1
->charpos
- pt_old
)
14459 < eabs (glyph
->charpos
- pt_old
))))
14460 /* previous candidate is a glyph from a string that has
14461 a non-nil `cursor' property */
14462 || (STRINGP (g1
->object
)
14463 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14464 Qcursor
, g1
->object
))
14465 /* previous candidate is from the same display
14466 string as this one, and the display string
14467 came from a text property */
14468 || (EQ (g1
->object
, glyph
->object
)
14469 && string_from_text_prop
)
14470 /* this candidate is from newline and its
14471 position is not an exact match */
14472 || (INTEGERP (glyph
->object
)
14473 && glyph
->charpos
!= pt_old
)))))
14475 /* If this candidate gives an exact match, use that. */
14476 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14477 /* If this candidate is a glyph created for the
14478 terminating newline of a line, and point is on that
14479 newline, it wins because it's an exact match. */
14480 || (!row
->continued_p
14481 && INTEGERP (glyph
->object
)
14482 && glyph
->charpos
== 0
14483 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14484 /* Otherwise, keep the candidate that comes from a row
14485 spanning less buffer positions. This may win when one or
14486 both candidate positions are on glyphs that came from
14487 display strings, for which we cannot compare buffer
14489 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14490 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14491 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14494 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14496 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14497 w
->cursor
.y
= row
->y
+ dy
;
14499 if (w
== XWINDOW (selected_window
))
14501 if (!row
->continued_p
14502 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14505 this_line_buffer
= XBUFFER (w
->buffer
);
14507 CHARPOS (this_line_start_pos
)
14508 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14509 BYTEPOS (this_line_start_pos
)
14510 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14512 CHARPOS (this_line_end_pos
)
14513 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14514 BYTEPOS (this_line_end_pos
)
14515 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14517 this_line_y
= w
->cursor
.y
;
14518 this_line_pixel_height
= row
->height
;
14519 this_line_vpos
= w
->cursor
.vpos
;
14520 this_line_start_x
= row
->x
;
14523 CHARPOS (this_line_start_pos
) = 0;
14530 /* Run window scroll functions, if any, for WINDOW with new window
14531 start STARTP. Sets the window start of WINDOW to that position.
14533 We assume that the window's buffer is really current. */
14535 static inline struct text_pos
14536 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14538 struct window
*w
= XWINDOW (window
);
14539 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14541 if (current_buffer
!= XBUFFER (w
->buffer
))
14544 if (!NILP (Vwindow_scroll_functions
))
14546 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14547 make_number (CHARPOS (startp
)));
14548 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14549 /* In case the hook functions switch buffers. */
14550 set_buffer_internal (XBUFFER (w
->buffer
));
14557 /* Make sure the line containing the cursor is fully visible.
14558 A value of 1 means there is nothing to be done.
14559 (Either the line is fully visible, or it cannot be made so,
14560 or we cannot tell.)
14562 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14563 is higher than window.
14565 A value of 0 means the caller should do scrolling
14566 as if point had gone off the screen. */
14569 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14571 struct glyph_matrix
*matrix
;
14572 struct glyph_row
*row
;
14575 if (!make_cursor_line_fully_visible_p
)
14578 /* It's not always possible to find the cursor, e.g, when a window
14579 is full of overlay strings. Don't do anything in that case. */
14580 if (w
->cursor
.vpos
< 0)
14583 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14584 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14586 /* If the cursor row is not partially visible, there's nothing to do. */
14587 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14590 /* If the row the cursor is in is taller than the window's height,
14591 it's not clear what to do, so do nothing. */
14592 window_height
= window_box_height (w
);
14593 if (row
->height
>= window_height
)
14595 if (!force_p
|| MINI_WINDOW_P (w
)
14596 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14603 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14604 non-zero means only WINDOW is redisplayed in redisplay_internal.
14605 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14606 in redisplay_window to bring a partially visible line into view in
14607 the case that only the cursor has moved.
14609 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14610 last screen line's vertical height extends past the end of the screen.
14614 1 if scrolling succeeded
14616 0 if scrolling didn't find point.
14618 -1 if new fonts have been loaded so that we must interrupt
14619 redisplay, adjust glyph matrices, and try again. */
14625 SCROLLING_NEED_LARGER_MATRICES
14628 /* If scroll-conservatively is more than this, never recenter.
14630 If you change this, don't forget to update the doc string of
14631 `scroll-conservatively' and the Emacs manual. */
14632 #define SCROLL_LIMIT 100
14635 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14636 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14637 int temp_scroll_step
, int last_line_misfit
)
14639 struct window
*w
= XWINDOW (window
);
14640 struct frame
*f
= XFRAME (w
->frame
);
14641 struct text_pos pos
, startp
;
14643 int this_scroll_margin
, scroll_max
, rc
, height
;
14644 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14645 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14646 Lisp_Object aggressive
;
14647 /* We will never try scrolling more than this number of lines. */
14648 int scroll_limit
= SCROLL_LIMIT
;
14651 debug_method_add (w
, "try_scrolling");
14654 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14656 /* Compute scroll margin height in pixels. We scroll when point is
14657 within this distance from the top or bottom of the window. */
14658 if (scroll_margin
> 0)
14659 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14660 * FRAME_LINE_HEIGHT (f
);
14662 this_scroll_margin
= 0;
14664 /* Force arg_scroll_conservatively to have a reasonable value, to
14665 avoid scrolling too far away with slow move_it_* functions. Note
14666 that the user can supply scroll-conservatively equal to
14667 `most-positive-fixnum', which can be larger than INT_MAX. */
14668 if (arg_scroll_conservatively
> scroll_limit
)
14670 arg_scroll_conservatively
= scroll_limit
+ 1;
14671 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14673 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14674 /* Compute how much we should try to scroll maximally to bring
14675 point into view. */
14676 scroll_max
= (max (scroll_step
,
14677 max (arg_scroll_conservatively
, temp_scroll_step
))
14678 * FRAME_LINE_HEIGHT (f
));
14679 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14680 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14681 /* We're trying to scroll because of aggressive scrolling but no
14682 scroll_step is set. Choose an arbitrary one. */
14683 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14689 /* Decide whether to scroll down. */
14690 if (PT
> CHARPOS (startp
))
14692 int scroll_margin_y
;
14694 /* Compute the pixel ypos of the scroll margin, then move IT to
14695 either that ypos or PT, whichever comes first. */
14696 start_display (&it
, w
, startp
);
14697 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14698 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14699 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14700 (MOVE_TO_POS
| MOVE_TO_Y
));
14702 if (PT
> CHARPOS (it
.current
.pos
))
14704 int y0
= line_bottom_y (&it
);
14705 /* Compute how many pixels below window bottom to stop searching
14706 for PT. This avoids costly search for PT that is far away if
14707 the user limited scrolling by a small number of lines, but
14708 always finds PT if scroll_conservatively is set to a large
14709 number, such as most-positive-fixnum. */
14710 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14711 int y_to_move
= it
.last_visible_y
+ slack
;
14713 /* Compute the distance from the scroll margin to PT or to
14714 the scroll limit, whichever comes first. This should
14715 include the height of the cursor line, to make that line
14717 move_it_to (&it
, PT
, -1, y_to_move
,
14718 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14719 dy
= line_bottom_y (&it
) - y0
;
14721 if (dy
> scroll_max
)
14722 return SCROLLING_FAILED
;
14731 /* Point is in or below the bottom scroll margin, so move the
14732 window start down. If scrolling conservatively, move it just
14733 enough down to make point visible. If scroll_step is set,
14734 move it down by scroll_step. */
14735 if (arg_scroll_conservatively
)
14737 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14738 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14739 else if (scroll_step
|| temp_scroll_step
)
14740 amount_to_scroll
= scroll_max
;
14743 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14744 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14745 if (NUMBERP (aggressive
))
14747 double float_amount
= XFLOATINT (aggressive
) * height
;
14748 amount_to_scroll
= float_amount
;
14749 if (amount_to_scroll
== 0 && float_amount
> 0)
14750 amount_to_scroll
= 1;
14751 /* Don't let point enter the scroll margin near top of
14753 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14754 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14758 if (amount_to_scroll
<= 0)
14759 return SCROLLING_FAILED
;
14761 start_display (&it
, w
, startp
);
14762 if (arg_scroll_conservatively
<= scroll_limit
)
14763 move_it_vertically (&it
, amount_to_scroll
);
14766 /* Extra precision for users who set scroll-conservatively
14767 to a large number: make sure the amount we scroll
14768 the window start is never less than amount_to_scroll,
14769 which was computed as distance from window bottom to
14770 point. This matters when lines at window top and lines
14771 below window bottom have different height. */
14773 void *it1data
= NULL
;
14774 /* We use a temporary it1 because line_bottom_y can modify
14775 its argument, if it moves one line down; see there. */
14778 SAVE_IT (it1
, it
, it1data
);
14779 start_y
= line_bottom_y (&it1
);
14781 RESTORE_IT (&it
, &it
, it1data
);
14782 move_it_by_lines (&it
, 1);
14783 SAVE_IT (it1
, it
, it1data
);
14784 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14787 /* If STARTP is unchanged, move it down another screen line. */
14788 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14789 move_it_by_lines (&it
, 1);
14790 startp
= it
.current
.pos
;
14794 struct text_pos scroll_margin_pos
= startp
;
14796 /* See if point is inside the scroll margin at the top of the
14798 if (this_scroll_margin
)
14800 start_display (&it
, w
, startp
);
14801 move_it_vertically (&it
, this_scroll_margin
);
14802 scroll_margin_pos
= it
.current
.pos
;
14805 if (PT
< CHARPOS (scroll_margin_pos
))
14807 /* Point is in the scroll margin at the top of the window or
14808 above what is displayed in the window. */
14811 /* Compute the vertical distance from PT to the scroll
14812 margin position. Move as far as scroll_max allows, or
14813 one screenful, or 10 screen lines, whichever is largest.
14814 Give up if distance is greater than scroll_max. */
14815 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14816 start_display (&it
, w
, pos
);
14818 y_to_move
= max (it
.last_visible_y
,
14819 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14820 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14822 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14823 dy
= it
.current_y
- y0
;
14824 if (dy
> scroll_max
)
14825 return SCROLLING_FAILED
;
14827 /* Compute new window start. */
14828 start_display (&it
, w
, startp
);
14830 if (arg_scroll_conservatively
)
14831 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14832 max (scroll_step
, temp_scroll_step
));
14833 else if (scroll_step
|| temp_scroll_step
)
14834 amount_to_scroll
= scroll_max
;
14837 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14838 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14839 if (NUMBERP (aggressive
))
14841 double float_amount
= XFLOATINT (aggressive
) * height
;
14842 amount_to_scroll
= float_amount
;
14843 if (amount_to_scroll
== 0 && float_amount
> 0)
14844 amount_to_scroll
= 1;
14845 amount_to_scroll
-=
14846 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14847 /* Don't let point enter the scroll margin near
14848 bottom of the window. */
14849 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14850 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14854 if (amount_to_scroll
<= 0)
14855 return SCROLLING_FAILED
;
14857 move_it_vertically_backward (&it
, amount_to_scroll
);
14858 startp
= it
.current
.pos
;
14862 /* Run window scroll functions. */
14863 startp
= run_window_scroll_functions (window
, startp
);
14865 /* Display the window. Give up if new fonts are loaded, or if point
14867 if (!try_window (window
, startp
, 0))
14868 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14869 else if (w
->cursor
.vpos
< 0)
14871 clear_glyph_matrix (w
->desired_matrix
);
14872 rc
= SCROLLING_FAILED
;
14876 /* Maybe forget recorded base line for line number display. */
14877 if (!just_this_one_p
14878 || current_buffer
->clip_changed
14879 || BEG_UNCHANGED
< CHARPOS (startp
))
14880 wset_base_line_number (w
, Qnil
);
14882 /* If cursor ends up on a partially visible line,
14883 treat that as being off the bottom of the screen. */
14884 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14885 /* It's possible that the cursor is on the first line of the
14886 buffer, which is partially obscured due to a vscroll
14887 (Bug#7537). In that case, avoid looping forever . */
14888 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14890 clear_glyph_matrix (w
->desired_matrix
);
14891 ++extra_scroll_margin_lines
;
14894 rc
= SCROLLING_SUCCESS
;
14901 /* Compute a suitable window start for window W if display of W starts
14902 on a continuation line. Value is non-zero if a new window start
14905 The new window start will be computed, based on W's width, starting
14906 from the start of the continued line. It is the start of the
14907 screen line with the minimum distance from the old start W->start. */
14910 compute_window_start_on_continuation_line (struct window
*w
)
14912 struct text_pos pos
, start_pos
;
14913 int window_start_changed_p
= 0;
14915 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14917 /* If window start is on a continuation line... Window start may be
14918 < BEGV in case there's invisible text at the start of the
14919 buffer (M-x rmail, for example). */
14920 if (CHARPOS (start_pos
) > BEGV
14921 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14924 struct glyph_row
*row
;
14926 /* Handle the case that the window start is out of range. */
14927 if (CHARPOS (start_pos
) < BEGV
)
14928 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14929 else if (CHARPOS (start_pos
) > ZV
)
14930 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14932 /* Find the start of the continued line. This should be fast
14933 because scan_buffer is fast (newline cache). */
14934 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14935 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14936 row
, DEFAULT_FACE_ID
);
14937 reseat_at_previous_visible_line_start (&it
);
14939 /* If the line start is "too far" away from the window start,
14940 say it takes too much time to compute a new window start. */
14941 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14942 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14944 int min_distance
, distance
;
14946 /* Move forward by display lines to find the new window
14947 start. If window width was enlarged, the new start can
14948 be expected to be > the old start. If window width was
14949 decreased, the new window start will be < the old start.
14950 So, we're looking for the display line start with the
14951 minimum distance from the old window start. */
14952 pos
= it
.current
.pos
;
14953 min_distance
= INFINITY
;
14954 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14955 distance
< min_distance
)
14957 min_distance
= distance
;
14958 pos
= it
.current
.pos
;
14959 move_it_by_lines (&it
, 1);
14962 /* Set the window start there. */
14963 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14964 window_start_changed_p
= 1;
14968 return window_start_changed_p
;
14972 /* Try cursor movement in case text has not changed in window WINDOW,
14973 with window start STARTP. Value is
14975 CURSOR_MOVEMENT_SUCCESS if successful
14977 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14979 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14980 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14981 we want to scroll as if scroll-step were set to 1. See the code.
14983 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14984 which case we have to abort this redisplay, and adjust matrices
14989 CURSOR_MOVEMENT_SUCCESS
,
14990 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14991 CURSOR_MOVEMENT_MUST_SCROLL
,
14992 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14996 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14998 struct window
*w
= XWINDOW (window
);
14999 struct frame
*f
= XFRAME (w
->frame
);
15000 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15003 if (inhibit_try_cursor_movement
)
15007 /* Previously, there was a check for Lisp integer in the
15008 if-statement below. Now, this field is converted to
15009 ptrdiff_t, thus zero means invalid position in a buffer. */
15010 eassert (w
->last_point
> 0);
15012 /* Handle case where text has not changed, only point, and it has
15013 not moved off the frame. */
15014 if (/* Point may be in this window. */
15015 PT
>= CHARPOS (startp
)
15016 /* Selective display hasn't changed. */
15017 && !current_buffer
->clip_changed
15018 /* Function force-mode-line-update is used to force a thorough
15019 redisplay. It sets either windows_or_buffers_changed or
15020 update_mode_lines. So don't take a shortcut here for these
15022 && !update_mode_lines
15023 && !windows_or_buffers_changed
15024 && !cursor_type_changed
15025 /* Can't use this case if highlighting a region. When a
15026 region exists, cursor movement has to do more than just
15028 && !(!NILP (Vtransient_mark_mode
)
15029 && !NILP (BVAR (current_buffer
, mark_active
)))
15030 && NILP (w
->region_showing
)
15031 && NILP (Vshow_trailing_whitespace
)
15032 /* This code is not used for mini-buffer for the sake of the case
15033 of redisplaying to replace an echo area message; since in
15034 that case the mini-buffer contents per se are usually
15035 unchanged. This code is of no real use in the mini-buffer
15036 since the handling of this_line_start_pos, etc., in redisplay
15037 handles the same cases. */
15038 && !EQ (window
, minibuf_window
)
15039 /* When splitting windows or for new windows, it happens that
15040 redisplay is called with a nil window_end_vpos or one being
15041 larger than the window. This should really be fixed in
15042 window.c. I don't have this on my list, now, so we do
15043 approximately the same as the old redisplay code. --gerd. */
15044 && INTEGERP (w
->window_end_vpos
)
15045 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
15046 && (FRAME_WINDOW_P (f
)
15047 || !overlay_arrow_in_current_buffer_p ()))
15049 int this_scroll_margin
, top_scroll_margin
;
15050 struct glyph_row
*row
= NULL
;
15053 debug_method_add (w
, "cursor movement");
15056 /* Scroll if point within this distance from the top or bottom
15057 of the window. This is a pixel value. */
15058 if (scroll_margin
> 0)
15060 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15061 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15064 this_scroll_margin
= 0;
15066 top_scroll_margin
= this_scroll_margin
;
15067 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15068 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15070 /* Start with the row the cursor was displayed during the last
15071 not paused redisplay. Give up if that row is not valid. */
15072 if (w
->last_cursor
.vpos
< 0
15073 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
15074 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15077 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
15078 if (row
->mode_line_p
)
15080 if (!row
->enabled_p
)
15081 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15084 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15086 int scroll_p
= 0, must_scroll
= 0;
15087 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15089 if (PT
> w
->last_point
)
15091 /* Point has moved forward. */
15092 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15093 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15095 eassert (row
->enabled_p
);
15099 /* If the end position of a row equals the start
15100 position of the next row, and PT is at that position,
15101 we would rather display cursor in the next line. */
15102 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15103 && MATRIX_ROW_END_CHARPOS (row
) == PT
15104 && row
< w
->current_matrix
->rows
15105 + w
->current_matrix
->nrows
- 1
15106 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15107 && !cursor_row_p (row
))
15110 /* If within the scroll margin, scroll. Note that
15111 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15112 the next line would be drawn, and that
15113 this_scroll_margin can be zero. */
15114 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15115 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15116 /* Line is completely visible last line in window
15117 and PT is to be set in the next line. */
15118 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15119 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15120 && !row
->ends_at_zv_p
15121 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15124 else if (PT
< w
->last_point
)
15126 /* Cursor has to be moved backward. Note that PT >=
15127 CHARPOS (startp) because of the outer if-statement. */
15128 while (!row
->mode_line_p
15129 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15130 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15131 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15132 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15133 row
> w
->current_matrix
->rows
15134 && (row
-1)->ends_in_newline_from_string_p
))))
15135 && (row
->y
> top_scroll_margin
15136 || CHARPOS (startp
) == BEGV
))
15138 eassert (row
->enabled_p
);
15142 /* Consider the following case: Window starts at BEGV,
15143 there is invisible, intangible text at BEGV, so that
15144 display starts at some point START > BEGV. It can
15145 happen that we are called with PT somewhere between
15146 BEGV and START. Try to handle that case. */
15147 if (row
< w
->current_matrix
->rows
15148 || row
->mode_line_p
)
15150 row
= w
->current_matrix
->rows
;
15151 if (row
->mode_line_p
)
15155 /* Due to newlines in overlay strings, we may have to
15156 skip forward over overlay strings. */
15157 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15158 && MATRIX_ROW_END_CHARPOS (row
) == PT
15159 && !cursor_row_p (row
))
15162 /* If within the scroll margin, scroll. */
15163 if (row
->y
< top_scroll_margin
15164 && CHARPOS (startp
) != BEGV
)
15169 /* Cursor did not move. So don't scroll even if cursor line
15170 is partially visible, as it was so before. */
15171 rc
= CURSOR_MOVEMENT_SUCCESS
;
15174 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15175 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15177 /* if PT is not in the glyph row, give up. */
15178 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15181 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15182 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15184 struct glyph_row
*row1
;
15186 /* If rows are bidi-reordered and point moved, back up
15187 until we find a row that does not belong to a
15188 continuation line. This is because we must consider
15189 all rows of a continued line as candidates for the
15190 new cursor positioning, since row start and end
15191 positions change non-linearly with vertical position
15193 /* FIXME: Revisit this when glyph ``spilling'' in
15194 continuation lines' rows is implemented for
15195 bidi-reordered rows. */
15196 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15197 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15200 /* If we hit the beginning of the displayed portion
15201 without finding the first row of a continued
15205 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15208 eassert (row
->enabled_p
);
15213 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15214 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15215 /* Make sure this isn't a header line by any chance, since
15216 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15217 && !row
->mode_line_p
15218 && make_cursor_line_fully_visible_p
)
15220 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15221 && !row
->ends_at_zv_p
15222 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15223 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15224 else if (row
->height
> window_box_height (w
))
15226 /* If we end up in a partially visible line, let's
15227 make it fully visible, except when it's taller
15228 than the window, in which case we can't do much
15231 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15235 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15236 if (!cursor_row_fully_visible_p (w
, 0, 1))
15237 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15239 rc
= CURSOR_MOVEMENT_SUCCESS
;
15243 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15244 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15245 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15247 /* With bidi-reordered rows, there could be more than
15248 one candidate row whose start and end positions
15249 occlude point. We need to let set_cursor_from_row
15250 find the best candidate. */
15251 /* FIXME: Revisit this when glyph ``spilling'' in
15252 continuation lines' rows is implemented for
15253 bidi-reordered rows. */
15258 int at_zv_p
= 0, exact_match_p
= 0;
15260 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15261 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15262 && cursor_row_p (row
))
15263 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15265 /* As soon as we've found the exact match for point,
15266 or the first suitable row whose ends_at_zv_p flag
15267 is set, we are done. */
15269 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15271 && w
->cursor
.hpos
>= 0
15272 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15275 struct glyph_row
*candidate
=
15276 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15278 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15279 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15282 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15283 || (INTEGERP (g
->object
)
15284 && (g
->charpos
== PT
15285 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15287 if (rv
&& (at_zv_p
|| exact_match_p
))
15289 rc
= CURSOR_MOVEMENT_SUCCESS
;
15292 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15296 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15297 || row
->continued_p
)
15298 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15299 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15300 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15301 /* If we didn't find any candidate rows, or exited the
15302 loop before all the candidates were examined, signal
15303 to the caller that this method failed. */
15304 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15306 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15307 && !row
->continued_p
))
15308 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15310 rc
= CURSOR_MOVEMENT_SUCCESS
;
15316 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15318 rc
= CURSOR_MOVEMENT_SUCCESS
;
15323 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15324 && MATRIX_ROW_START_CHARPOS (row
) == PT
15325 && cursor_row_p (row
));
15333 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15337 set_vertical_scroll_bar (struct window
*w
)
15339 ptrdiff_t start
, end
, whole
;
15341 /* Calculate the start and end positions for the current window.
15342 At some point, it would be nice to choose between scrollbars
15343 which reflect the whole buffer size, with special markers
15344 indicating narrowing, and scrollbars which reflect only the
15347 Note that mini-buffers sometimes aren't displaying any text. */
15348 if (!MINI_WINDOW_P (w
)
15349 || (w
== XWINDOW (minibuf_window
)
15350 && NILP (echo_area_buffer
[0])))
15352 struct buffer
*buf
= XBUFFER (w
->buffer
);
15353 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15354 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15355 /* I don't think this is guaranteed to be right. For the
15356 moment, we'll pretend it is. */
15357 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15361 if (whole
< (end
- start
))
15362 whole
= end
- start
;
15365 start
= end
= whole
= 0;
15367 /* Indicate what this scroll bar ought to be displaying now. */
15368 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15369 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15370 (w
, end
- start
, whole
, start
);
15374 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15375 selected_window is redisplayed.
15377 We can return without actually redisplaying the window if
15378 fonts_changed_p. In that case, redisplay_internal will
15382 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15384 struct window
*w
= XWINDOW (window
);
15385 struct frame
*f
= XFRAME (w
->frame
);
15386 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15387 struct buffer
*old
= current_buffer
;
15388 struct text_pos lpoint
, opoint
, startp
;
15389 int update_mode_line
;
15392 /* Record it now because it's overwritten. */
15393 int current_matrix_up_to_date_p
= 0;
15394 int used_current_matrix_p
= 0;
15395 /* This is less strict than current_matrix_up_to_date_p.
15396 It indicates that the buffer contents and narrowing are unchanged. */
15397 int buffer_unchanged_p
= 0;
15398 int temp_scroll_step
= 0;
15399 ptrdiff_t count
= SPECPDL_INDEX ();
15401 int centering_position
= -1;
15402 int last_line_misfit
= 0;
15403 ptrdiff_t beg_unchanged
, end_unchanged
;
15405 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15408 /* W must be a leaf window here. */
15409 eassert (!NILP (w
->buffer
));
15411 *w
->desired_matrix
->method
= 0;
15415 reconsider_clip_changes (w
, buffer
);
15417 /* Has the mode line to be updated? */
15418 update_mode_line
= (w
->update_mode_line
15419 || update_mode_lines
15420 || buffer
->clip_changed
15421 || buffer
->prevent_redisplay_optimizations_p
);
15423 if (MINI_WINDOW_P (w
))
15425 if (w
== XWINDOW (echo_area_window
)
15426 && !NILP (echo_area_buffer
[0]))
15428 if (update_mode_line
)
15429 /* We may have to update a tty frame's menu bar or a
15430 tool-bar. Example `M-x C-h C-h C-g'. */
15431 goto finish_menu_bars
;
15433 /* We've already displayed the echo area glyphs in this window. */
15434 goto finish_scroll_bars
;
15436 else if ((w
!= XWINDOW (minibuf_window
)
15437 || minibuf_level
== 0)
15438 /* When buffer is nonempty, redisplay window normally. */
15439 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15440 /* Quail displays non-mini buffers in minibuffer window.
15441 In that case, redisplay the window normally. */
15442 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15444 /* W is a mini-buffer window, but it's not active, so clear
15446 int yb
= window_text_bottom_y (w
);
15447 struct glyph_row
*row
;
15450 for (y
= 0, row
= w
->desired_matrix
->rows
;
15452 y
+= row
->height
, ++row
)
15453 blank_row (w
, row
, y
);
15454 goto finish_scroll_bars
;
15457 clear_glyph_matrix (w
->desired_matrix
);
15460 /* Otherwise set up data on this window; select its buffer and point
15462 /* Really select the buffer, for the sake of buffer-local
15464 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15466 current_matrix_up_to_date_p
15467 = (!NILP (w
->window_end_valid
)
15468 && !current_buffer
->clip_changed
15469 && !current_buffer
->prevent_redisplay_optimizations_p
15470 && w
->last_modified
>= MODIFF
15471 && w
->last_overlay_modified
>= OVERLAY_MODIFF
);
15473 /* Run the window-bottom-change-functions
15474 if it is possible that the text on the screen has changed
15475 (either due to modification of the text, or any other reason). */
15476 if (!current_matrix_up_to_date_p
15477 && !NILP (Vwindow_text_change_functions
))
15479 safe_run_hooks (Qwindow_text_change_functions
);
15483 beg_unchanged
= BEG_UNCHANGED
;
15484 end_unchanged
= END_UNCHANGED
;
15486 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15488 specbind (Qinhibit_point_motion_hooks
, Qt
);
15491 = (!NILP (w
->window_end_valid
)
15492 && !current_buffer
->clip_changed
15493 && w
->last_modified
>= MODIFF
15494 && w
->last_overlay_modified
>= OVERLAY_MODIFF
);
15496 /* When windows_or_buffers_changed is non-zero, we can't rely on
15497 the window end being valid, so set it to nil there. */
15498 if (windows_or_buffers_changed
)
15500 /* If window starts on a continuation line, maybe adjust the
15501 window start in case the window's width changed. */
15502 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15503 compute_window_start_on_continuation_line (w
);
15505 wset_window_end_valid (w
, Qnil
);
15508 /* Some sanity checks. */
15509 CHECK_WINDOW_END (w
);
15510 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15512 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15515 /* If %c is in mode line, update it if needed. */
15516 if (!NILP (w
->column_number_displayed
)
15517 /* This alternative quickly identifies a common case
15518 where no change is needed. */
15519 && !(PT
== w
->last_point
15520 && w
->last_modified
>= MODIFF
15521 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)
15522 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15523 update_mode_line
= 1;
15525 /* Count number of windows showing the selected buffer. An indirect
15526 buffer counts as its base buffer. */
15527 if (!just_this_one_p
)
15529 struct buffer
*current_base
, *window_base
;
15530 current_base
= current_buffer
;
15531 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15532 if (current_base
->base_buffer
)
15533 current_base
= current_base
->base_buffer
;
15534 if (window_base
->base_buffer
)
15535 window_base
= window_base
->base_buffer
;
15536 if (current_base
== window_base
)
15540 /* Point refers normally to the selected window. For any other
15541 window, set up appropriate value. */
15542 if (!EQ (window
, selected_window
))
15544 ptrdiff_t new_pt
= XMARKER (w
->pointm
)->charpos
;
15545 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15549 new_pt_byte
= BEGV_BYTE
;
15550 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15552 else if (new_pt
> (ZV
- 1))
15555 new_pt_byte
= ZV_BYTE
;
15556 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15559 /* We don't use SET_PT so that the point-motion hooks don't run. */
15560 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15563 /* If any of the character widths specified in the display table
15564 have changed, invalidate the width run cache. It's true that
15565 this may be a bit late to catch such changes, but the rest of
15566 redisplay goes (non-fatally) haywire when the display table is
15567 changed, so why should we worry about doing any better? */
15568 if (current_buffer
->width_run_cache
)
15570 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15572 if (! disptab_matches_widthtab
15573 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15575 invalidate_region_cache (current_buffer
,
15576 current_buffer
->width_run_cache
,
15578 recompute_width_table (current_buffer
, disptab
);
15582 /* If window-start is screwed up, choose a new one. */
15583 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15586 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15588 /* If someone specified a new starting point but did not insist,
15589 check whether it can be used. */
15590 if (w
->optional_new_start
15591 && CHARPOS (startp
) >= BEGV
15592 && CHARPOS (startp
) <= ZV
)
15594 w
->optional_new_start
= 0;
15595 start_display (&it
, w
, startp
);
15596 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15597 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15598 if (IT_CHARPOS (it
) == PT
)
15599 w
->force_start
= 1;
15600 /* IT may overshoot PT if text at PT is invisible. */
15601 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15602 w
->force_start
= 1;
15607 /* Handle case where place to start displaying has been specified,
15608 unless the specified location is outside the accessible range. */
15609 if (w
->force_start
|| w
->frozen_window_start_p
)
15611 /* We set this later on if we have to adjust point. */
15614 w
->force_start
= 0;
15616 wset_window_end_valid (w
, Qnil
);
15618 /* Forget any recorded base line for line number display. */
15619 if (!buffer_unchanged_p
)
15620 wset_base_line_number (w
, Qnil
);
15622 /* Redisplay the mode line. Select the buffer properly for that.
15623 Also, run the hook window-scroll-functions
15624 because we have scrolled. */
15625 /* Note, we do this after clearing force_start because
15626 if there's an error, it is better to forget about force_start
15627 than to get into an infinite loop calling the hook functions
15628 and having them get more errors. */
15629 if (!update_mode_line
15630 || ! NILP (Vwindow_scroll_functions
))
15632 update_mode_line
= 1;
15633 w
->update_mode_line
= 1;
15634 startp
= run_window_scroll_functions (window
, startp
);
15637 w
->last_modified
= 0;
15638 w
->last_overlay_modified
= 0;
15639 if (CHARPOS (startp
) < BEGV
)
15640 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15641 else if (CHARPOS (startp
) > ZV
)
15642 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15644 /* Redisplay, then check if cursor has been set during the
15645 redisplay. Give up if new fonts were loaded. */
15646 /* We used to issue a CHECK_MARGINS argument to try_window here,
15647 but this causes scrolling to fail when point begins inside
15648 the scroll margin (bug#148) -- cyd */
15649 if (!try_window (window
, startp
, 0))
15651 w
->force_start
= 1;
15652 clear_glyph_matrix (w
->desired_matrix
);
15653 goto need_larger_matrices
;
15656 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15658 /* If point does not appear, try to move point so it does
15659 appear. The desired matrix has been built above, so we
15660 can use it here. */
15661 new_vpos
= window_box_height (w
) / 2;
15664 if (!cursor_row_fully_visible_p (w
, 0, 0))
15666 /* Point does appear, but on a line partly visible at end of window.
15667 Move it back to a fully-visible line. */
15668 new_vpos
= window_box_height (w
);
15671 /* If we need to move point for either of the above reasons,
15672 now actually do it. */
15675 struct glyph_row
*row
;
15677 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15678 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15681 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15682 MATRIX_ROW_START_BYTEPOS (row
));
15684 if (w
!= XWINDOW (selected_window
))
15685 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15686 else if (current_buffer
== old
)
15687 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15689 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15691 /* If we are highlighting the region, then we just changed
15692 the region, so redisplay to show it. */
15693 if (!NILP (Vtransient_mark_mode
)
15694 && !NILP (BVAR (current_buffer
, mark_active
)))
15696 clear_glyph_matrix (w
->desired_matrix
);
15697 if (!try_window (window
, startp
, 0))
15698 goto need_larger_matrices
;
15703 debug_method_add (w
, "forced window start");
15708 /* Handle case where text has not changed, only point, and it has
15709 not moved off the frame, and we are not retrying after hscroll.
15710 (current_matrix_up_to_date_p is nonzero when retrying.) */
15711 if (current_matrix_up_to_date_p
15712 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15713 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15717 case CURSOR_MOVEMENT_SUCCESS
:
15718 used_current_matrix_p
= 1;
15721 case CURSOR_MOVEMENT_MUST_SCROLL
:
15722 goto try_to_scroll
;
15728 /* If current starting point was originally the beginning of a line
15729 but no longer is, find a new starting point. */
15730 else if (w
->start_at_line_beg
15731 && !(CHARPOS (startp
) <= BEGV
15732 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15735 debug_method_add (w
, "recenter 1");
15740 /* Try scrolling with try_window_id. Value is > 0 if update has
15741 been done, it is -1 if we know that the same window start will
15742 not work. It is 0 if unsuccessful for some other reason. */
15743 else if ((tem
= try_window_id (w
)) != 0)
15746 debug_method_add (w
, "try_window_id %d", tem
);
15749 if (fonts_changed_p
)
15750 goto need_larger_matrices
;
15754 /* Otherwise try_window_id has returned -1 which means that we
15755 don't want the alternative below this comment to execute. */
15757 else if (CHARPOS (startp
) >= BEGV
15758 && CHARPOS (startp
) <= ZV
15759 && PT
>= CHARPOS (startp
)
15760 && (CHARPOS (startp
) < ZV
15761 /* Avoid starting at end of buffer. */
15762 || CHARPOS (startp
) == BEGV
15763 || (w
->last_modified
>= MODIFF
15764 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)))
15766 int d1
, d2
, d3
, d4
, d5
, d6
;
15768 /* If first window line is a continuation line, and window start
15769 is inside the modified region, but the first change is before
15770 current window start, we must select a new window start.
15772 However, if this is the result of a down-mouse event (e.g. by
15773 extending the mouse-drag-overlay), we don't want to select a
15774 new window start, since that would change the position under
15775 the mouse, resulting in an unwanted mouse-movement rather
15776 than a simple mouse-click. */
15777 if (!w
->start_at_line_beg
15778 && NILP (do_mouse_tracking
)
15779 && CHARPOS (startp
) > BEGV
15780 && CHARPOS (startp
) > BEG
+ beg_unchanged
15781 && CHARPOS (startp
) <= Z
- end_unchanged
15782 /* Even if w->start_at_line_beg is nil, a new window may
15783 start at a line_beg, since that's how set_buffer_window
15784 sets it. So, we need to check the return value of
15785 compute_window_start_on_continuation_line. (See also
15787 && XMARKER (w
->start
)->buffer
== current_buffer
15788 && compute_window_start_on_continuation_line (w
)
15789 /* It doesn't make sense to force the window start like we
15790 do at label force_start if it is already known that point
15791 will not be visible in the resulting window, because
15792 doing so will move point from its correct position
15793 instead of scrolling the window to bring point into view.
15795 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15797 w
->force_start
= 1;
15798 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15803 debug_method_add (w
, "same window start");
15806 /* Try to redisplay starting at same place as before.
15807 If point has not moved off frame, accept the results. */
15808 if (!current_matrix_up_to_date_p
15809 /* Don't use try_window_reusing_current_matrix in this case
15810 because a window scroll function can have changed the
15812 || !NILP (Vwindow_scroll_functions
)
15813 || MINI_WINDOW_P (w
)
15814 || !(used_current_matrix_p
15815 = try_window_reusing_current_matrix (w
)))
15817 IF_DEBUG (debug_method_add (w
, "1"));
15818 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15819 /* -1 means we need to scroll.
15820 0 means we need new matrices, but fonts_changed_p
15821 is set in that case, so we will detect it below. */
15822 goto try_to_scroll
;
15825 if (fonts_changed_p
)
15826 goto need_larger_matrices
;
15828 if (w
->cursor
.vpos
>= 0)
15830 if (!just_this_one_p
15831 || current_buffer
->clip_changed
15832 || BEG_UNCHANGED
< CHARPOS (startp
))
15833 /* Forget any recorded base line for line number display. */
15834 wset_base_line_number (w
, Qnil
);
15836 if (!cursor_row_fully_visible_p (w
, 1, 0))
15838 clear_glyph_matrix (w
->desired_matrix
);
15839 last_line_misfit
= 1;
15841 /* Drop through and scroll. */
15846 clear_glyph_matrix (w
->desired_matrix
);
15851 w
->last_modified
= 0;
15852 w
->last_overlay_modified
= 0;
15854 /* Redisplay the mode line. Select the buffer properly for that. */
15855 if (!update_mode_line
)
15857 update_mode_line
= 1;
15858 w
->update_mode_line
= 1;
15861 /* Try to scroll by specified few lines. */
15862 if ((scroll_conservatively
15863 || emacs_scroll_step
15864 || temp_scroll_step
15865 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15866 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15867 && CHARPOS (startp
) >= BEGV
15868 && CHARPOS (startp
) <= ZV
)
15870 /* The function returns -1 if new fonts were loaded, 1 if
15871 successful, 0 if not successful. */
15872 int ss
= try_scrolling (window
, just_this_one_p
,
15873 scroll_conservatively
,
15875 temp_scroll_step
, last_line_misfit
);
15878 case SCROLLING_SUCCESS
:
15881 case SCROLLING_NEED_LARGER_MATRICES
:
15882 goto need_larger_matrices
;
15884 case SCROLLING_FAILED
:
15892 /* Finally, just choose a place to start which positions point
15893 according to user preferences. */
15898 debug_method_add (w
, "recenter");
15901 /* w->vscroll = 0; */
15903 /* Forget any previously recorded base line for line number display. */
15904 if (!buffer_unchanged_p
)
15905 wset_base_line_number (w
, Qnil
);
15907 /* Determine the window start relative to point. */
15908 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15909 it
.current_y
= it
.last_visible_y
;
15910 if (centering_position
< 0)
15914 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15916 ptrdiff_t margin_pos
= CHARPOS (startp
);
15917 Lisp_Object aggressive
;
15920 /* If there is a scroll margin at the top of the window, find
15921 its character position. */
15923 /* Cannot call start_display if startp is not in the
15924 accessible region of the buffer. This can happen when we
15925 have just switched to a different buffer and/or changed
15926 its restriction. In that case, startp is initialized to
15927 the character position 1 (BEGV) because we did not yet
15928 have chance to display the buffer even once. */
15929 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15932 void *it1data
= NULL
;
15934 SAVE_IT (it1
, it
, it1data
);
15935 start_display (&it1
, w
, startp
);
15936 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15937 margin_pos
= IT_CHARPOS (it1
);
15938 RESTORE_IT (&it
, &it
, it1data
);
15940 scrolling_up
= PT
> margin_pos
;
15943 ? BVAR (current_buffer
, scroll_up_aggressively
)
15944 : BVAR (current_buffer
, scroll_down_aggressively
);
15946 if (!MINI_WINDOW_P (w
)
15947 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15951 /* Setting scroll-conservatively overrides
15952 scroll-*-aggressively. */
15953 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15955 double float_amount
= XFLOATINT (aggressive
);
15957 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15958 if (pt_offset
== 0 && float_amount
> 0)
15960 if (pt_offset
&& margin
> 0)
15963 /* Compute how much to move the window start backward from
15964 point so that point will be displayed where the user
15968 centering_position
= it
.last_visible_y
;
15970 centering_position
-= pt_offset
;
15971 centering_position
-=
15972 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15973 + WINDOW_HEADER_LINE_HEIGHT (w
);
15974 /* Don't let point enter the scroll margin near top of
15976 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15977 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15980 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15983 /* Set the window start half the height of the window backward
15985 centering_position
= window_box_height (w
) / 2;
15987 move_it_vertically_backward (&it
, centering_position
);
15989 eassert (IT_CHARPOS (it
) >= BEGV
);
15991 /* The function move_it_vertically_backward may move over more
15992 than the specified y-distance. If it->w is small, e.g. a
15993 mini-buffer window, we may end up in front of the window's
15994 display area. Start displaying at the start of the line
15995 containing PT in this case. */
15996 if (it
.current_y
<= 0)
15998 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15999 move_it_vertically_backward (&it
, 0);
16003 it
.current_x
= it
.hpos
= 0;
16005 /* Set the window start position here explicitly, to avoid an
16006 infinite loop in case the functions in window-scroll-functions
16008 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16010 /* Run scroll hooks. */
16011 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16013 /* Redisplay the window. */
16014 if (!current_matrix_up_to_date_p
16015 || windows_or_buffers_changed
16016 || cursor_type_changed
16017 /* Don't use try_window_reusing_current_matrix in this case
16018 because it can have changed the buffer. */
16019 || !NILP (Vwindow_scroll_functions
)
16020 || !just_this_one_p
16021 || MINI_WINDOW_P (w
)
16022 || !(used_current_matrix_p
16023 = try_window_reusing_current_matrix (w
)))
16024 try_window (window
, startp
, 0);
16026 /* If new fonts have been loaded (due to fontsets), give up. We
16027 have to start a new redisplay since we need to re-adjust glyph
16029 if (fonts_changed_p
)
16030 goto need_larger_matrices
;
16032 /* If cursor did not appear assume that the middle of the window is
16033 in the first line of the window. Do it again with the next line.
16034 (Imagine a window of height 100, displaying two lines of height
16035 60. Moving back 50 from it->last_visible_y will end in the first
16037 if (w
->cursor
.vpos
< 0)
16039 if (!NILP (w
->window_end_valid
)
16040 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
16042 clear_glyph_matrix (w
->desired_matrix
);
16043 move_it_by_lines (&it
, 1);
16044 try_window (window
, it
.current
.pos
, 0);
16046 else if (PT
< IT_CHARPOS (it
))
16048 clear_glyph_matrix (w
->desired_matrix
);
16049 move_it_by_lines (&it
, -1);
16050 try_window (window
, it
.current
.pos
, 0);
16054 /* Not much we can do about it. */
16058 /* Consider the following case: Window starts at BEGV, there is
16059 invisible, intangible text at BEGV, so that display starts at
16060 some point START > BEGV. It can happen that we are called with
16061 PT somewhere between BEGV and START. Try to handle that case. */
16062 if (w
->cursor
.vpos
< 0)
16064 struct glyph_row
*row
= w
->current_matrix
->rows
;
16065 if (row
->mode_line_p
)
16067 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16070 if (!cursor_row_fully_visible_p (w
, 0, 0))
16072 /* If vscroll is enabled, disable it and try again. */
16076 clear_glyph_matrix (w
->desired_matrix
);
16080 /* Users who set scroll-conservatively to a large number want
16081 point just above/below the scroll margin. If we ended up
16082 with point's row partially visible, move the window start to
16083 make that row fully visible and out of the margin. */
16084 if (scroll_conservatively
> SCROLL_LIMIT
)
16088 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
16090 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
16092 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16093 clear_glyph_matrix (w
->desired_matrix
);
16094 if (1 == try_window (window
, it
.current
.pos
,
16095 TRY_WINDOW_CHECK_MARGINS
))
16099 /* If centering point failed to make the whole line visible,
16100 put point at the top instead. That has to make the whole line
16101 visible, if it can be done. */
16102 if (centering_position
== 0)
16105 clear_glyph_matrix (w
->desired_matrix
);
16106 centering_position
= 0;
16112 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16113 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16114 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16116 /* Display the mode line, if we must. */
16117 if ((update_mode_line
16118 /* If window not full width, must redo its mode line
16119 if (a) the window to its side is being redone and
16120 (b) we do a frame-based redisplay. This is a consequence
16121 of how inverted lines are drawn in frame-based redisplay. */
16122 || (!just_this_one_p
16123 && !FRAME_WINDOW_P (f
)
16124 && !WINDOW_FULL_WIDTH_P (w
))
16125 /* Line number to display. */
16126 || INTEGERP (w
->base_line_pos
)
16127 /* Column number is displayed and different from the one displayed. */
16128 || (!NILP (w
->column_number_displayed
)
16129 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
16130 /* This means that the window has a mode line. */
16131 && (WINDOW_WANTS_MODELINE_P (w
)
16132 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16134 display_mode_lines (w
);
16136 /* If mode line height has changed, arrange for a thorough
16137 immediate redisplay using the correct mode line height. */
16138 if (WINDOW_WANTS_MODELINE_P (w
)
16139 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16141 fonts_changed_p
= 1;
16142 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16143 = DESIRED_MODE_LINE_HEIGHT (w
);
16146 /* If header line height has changed, arrange for a thorough
16147 immediate redisplay using the correct header line height. */
16148 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16149 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16151 fonts_changed_p
= 1;
16152 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16153 = DESIRED_HEADER_LINE_HEIGHT (w
);
16156 if (fonts_changed_p
)
16157 goto need_larger_matrices
;
16160 if (!line_number_displayed
16161 && !BUFFERP (w
->base_line_pos
))
16163 wset_base_line_pos (w
, Qnil
);
16164 wset_base_line_number (w
, Qnil
);
16169 /* When we reach a frame's selected window, redo the frame's menu bar. */
16170 if (update_mode_line
16171 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16173 int redisplay_menu_p
= 0;
16175 if (FRAME_WINDOW_P (f
))
16177 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16178 || defined (HAVE_NS) || defined (USE_GTK)
16179 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16181 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16185 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16187 if (redisplay_menu_p
)
16188 display_menu_bar (w
);
16190 #ifdef HAVE_WINDOW_SYSTEM
16191 if (FRAME_WINDOW_P (f
))
16193 #if defined (USE_GTK) || defined (HAVE_NS)
16194 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16195 redisplay_tool_bar (f
);
16197 if (WINDOWP (f
->tool_bar_window
)
16198 && (FRAME_TOOL_BAR_LINES (f
) > 0
16199 || !NILP (Vauto_resize_tool_bars
))
16200 && redisplay_tool_bar (f
))
16201 ignore_mouse_drag_p
= 1;
16207 #ifdef HAVE_WINDOW_SYSTEM
16208 if (FRAME_WINDOW_P (f
)
16209 && update_window_fringes (w
, (just_this_one_p
16210 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16211 || w
->pseudo_window_p
)))
16215 if (draw_window_fringes (w
, 1))
16216 x_draw_vertical_border (w
);
16220 #endif /* HAVE_WINDOW_SYSTEM */
16222 /* We go to this label, with fonts_changed_p set,
16223 if it is necessary to try again using larger glyph matrices.
16224 We have to redeem the scroll bar even in this case,
16225 because the loop in redisplay_internal expects that. */
16226 need_larger_matrices
:
16228 finish_scroll_bars
:
16230 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16232 /* Set the thumb's position and size. */
16233 set_vertical_scroll_bar (w
);
16235 /* Note that we actually used the scroll bar attached to this
16236 window, so it shouldn't be deleted at the end of redisplay. */
16237 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16238 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16241 /* Restore current_buffer and value of point in it. The window
16242 update may have changed the buffer, so first make sure `opoint'
16243 is still valid (Bug#6177). */
16244 if (CHARPOS (opoint
) < BEGV
)
16245 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16246 else if (CHARPOS (opoint
) > ZV
)
16247 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16249 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16251 set_buffer_internal_1 (old
);
16252 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16253 shorter. This can be caused by log truncation in *Messages*. */
16254 if (CHARPOS (lpoint
) <= ZV
)
16255 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16257 unbind_to (count
, Qnil
);
16261 /* Build the complete desired matrix of WINDOW with a window start
16262 buffer position POS.
16264 Value is 1 if successful. It is zero if fonts were loaded during
16265 redisplay which makes re-adjusting glyph matrices necessary, and -1
16266 if point would appear in the scroll margins.
16267 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16268 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16272 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16274 struct window
*w
= XWINDOW (window
);
16276 struct glyph_row
*last_text_row
= NULL
;
16277 struct frame
*f
= XFRAME (w
->frame
);
16279 /* Make POS the new window start. */
16280 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16282 /* Mark cursor position as unknown. No overlay arrow seen. */
16283 w
->cursor
.vpos
= -1;
16284 overlay_arrow_seen
= 0;
16286 /* Initialize iterator and info to start at POS. */
16287 start_display (&it
, w
, pos
);
16289 /* Display all lines of W. */
16290 while (it
.current_y
< it
.last_visible_y
)
16292 if (display_line (&it
))
16293 last_text_row
= it
.glyph_row
- 1;
16294 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16298 /* Don't let the cursor end in the scroll margins. */
16299 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16300 && !MINI_WINDOW_P (w
))
16302 int this_scroll_margin
;
16304 if (scroll_margin
> 0)
16306 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16307 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16310 this_scroll_margin
= 0;
16312 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16313 && w
->cursor
.y
< this_scroll_margin
16314 && CHARPOS (pos
) > BEGV
16315 && IT_CHARPOS (it
) < ZV
)
16316 /* rms: considering make_cursor_line_fully_visible_p here
16317 seems to give wrong results. We don't want to recenter
16318 when the last line is partly visible, we want to allow
16319 that case to be handled in the usual way. */
16320 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16322 w
->cursor
.vpos
= -1;
16323 clear_glyph_matrix (w
->desired_matrix
);
16328 /* If bottom moved off end of frame, change mode line percentage. */
16329 if (XFASTINT (w
->window_end_pos
) <= 0
16330 && Z
!= IT_CHARPOS (it
))
16331 w
->update_mode_line
= 1;
16333 /* Set window_end_pos to the offset of the last character displayed
16334 on the window from the end of current_buffer. Set
16335 window_end_vpos to its row number. */
16338 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16339 w
->window_end_bytepos
16340 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16341 wset_window_end_pos
16342 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16343 wset_window_end_vpos
16344 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
)));
16346 (MATRIX_ROW (w
->desired_matrix
,
16347 XFASTINT (w
->window_end_vpos
))->displays_text_p
);
16351 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16352 wset_window_end_pos (w
, make_number (Z
- ZV
));
16353 wset_window_end_vpos (w
, make_number (0));
16356 /* But that is not valid info until redisplay finishes. */
16357 wset_window_end_valid (w
, Qnil
);
16363 /************************************************************************
16364 Window redisplay reusing current matrix when buffer has not changed
16365 ************************************************************************/
16367 /* Try redisplay of window W showing an unchanged buffer with a
16368 different window start than the last time it was displayed by
16369 reusing its current matrix. Value is non-zero if successful.
16370 W->start is the new window start. */
16373 try_window_reusing_current_matrix (struct window
*w
)
16375 struct frame
*f
= XFRAME (w
->frame
);
16376 struct glyph_row
*bottom_row
;
16379 struct text_pos start
, new_start
;
16380 int nrows_scrolled
, i
;
16381 struct glyph_row
*last_text_row
;
16382 struct glyph_row
*last_reused_text_row
;
16383 struct glyph_row
*start_row
;
16384 int start_vpos
, min_y
, max_y
;
16387 if (inhibit_try_window_reusing
)
16391 if (/* This function doesn't handle terminal frames. */
16392 !FRAME_WINDOW_P (f
)
16393 /* Don't try to reuse the display if windows have been split
16395 || windows_or_buffers_changed
16396 || cursor_type_changed
)
16399 /* Can't do this if region may have changed. */
16400 if ((!NILP (Vtransient_mark_mode
)
16401 && !NILP (BVAR (current_buffer
, mark_active
)))
16402 || !NILP (w
->region_showing
)
16403 || !NILP (Vshow_trailing_whitespace
))
16406 /* If top-line visibility has changed, give up. */
16407 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16408 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16411 /* Give up if old or new display is scrolled vertically. We could
16412 make this function handle this, but right now it doesn't. */
16413 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16414 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16417 /* The variable new_start now holds the new window start. The old
16418 start `start' can be determined from the current matrix. */
16419 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16420 start
= start_row
->minpos
;
16421 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16423 /* Clear the desired matrix for the display below. */
16424 clear_glyph_matrix (w
->desired_matrix
);
16426 if (CHARPOS (new_start
) <= CHARPOS (start
))
16428 /* Don't use this method if the display starts with an ellipsis
16429 displayed for invisible text. It's not easy to handle that case
16430 below, and it's certainly not worth the effort since this is
16431 not a frequent case. */
16432 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16435 IF_DEBUG (debug_method_add (w
, "twu1"));
16437 /* Display up to a row that can be reused. The variable
16438 last_text_row is set to the last row displayed that displays
16439 text. Note that it.vpos == 0 if or if not there is a
16440 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16441 start_display (&it
, w
, new_start
);
16442 w
->cursor
.vpos
= -1;
16443 last_text_row
= last_reused_text_row
= NULL
;
16445 while (it
.current_y
< it
.last_visible_y
16446 && !fonts_changed_p
)
16448 /* If we have reached into the characters in the START row,
16449 that means the line boundaries have changed. So we
16450 can't start copying with the row START. Maybe it will
16451 work to start copying with the following row. */
16452 while (IT_CHARPOS (it
) > CHARPOS (start
))
16454 /* Advance to the next row as the "start". */
16456 start
= start_row
->minpos
;
16457 /* If there are no more rows to try, or just one, give up. */
16458 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16459 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16460 || CHARPOS (start
) == ZV
)
16462 clear_glyph_matrix (w
->desired_matrix
);
16466 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16468 /* If we have reached alignment, we can copy the rest of the
16470 if (IT_CHARPOS (it
) == CHARPOS (start
)
16471 /* Don't accept "alignment" inside a display vector,
16472 since start_row could have started in the middle of
16473 that same display vector (thus their character
16474 positions match), and we have no way of telling if
16475 that is the case. */
16476 && it
.current
.dpvec_index
< 0)
16479 if (display_line (&it
))
16480 last_text_row
= it
.glyph_row
- 1;
16484 /* A value of current_y < last_visible_y means that we stopped
16485 at the previous window start, which in turn means that we
16486 have at least one reusable row. */
16487 if (it
.current_y
< it
.last_visible_y
)
16489 struct glyph_row
*row
;
16491 /* IT.vpos always starts from 0; it counts text lines. */
16492 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16494 /* Find PT if not already found in the lines displayed. */
16495 if (w
->cursor
.vpos
< 0)
16497 int dy
= it
.current_y
- start_row
->y
;
16499 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16500 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16502 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16503 dy
, nrows_scrolled
);
16506 clear_glyph_matrix (w
->desired_matrix
);
16511 /* Scroll the display. Do it before the current matrix is
16512 changed. The problem here is that update has not yet
16513 run, i.e. part of the current matrix is not up to date.
16514 scroll_run_hook will clear the cursor, and use the
16515 current matrix to get the height of the row the cursor is
16517 run
.current_y
= start_row
->y
;
16518 run
.desired_y
= it
.current_y
;
16519 run
.height
= it
.last_visible_y
- it
.current_y
;
16521 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16524 FRAME_RIF (f
)->update_window_begin_hook (w
);
16525 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16526 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16527 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16531 /* Shift current matrix down by nrows_scrolled lines. */
16532 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16533 rotate_matrix (w
->current_matrix
,
16535 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16538 /* Disable lines that must be updated. */
16539 for (i
= 0; i
< nrows_scrolled
; ++i
)
16540 (start_row
+ i
)->enabled_p
= 0;
16542 /* Re-compute Y positions. */
16543 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16544 max_y
= it
.last_visible_y
;
16545 for (row
= start_row
+ nrows_scrolled
;
16549 row
->y
= it
.current_y
;
16550 row
->visible_height
= row
->height
;
16552 if (row
->y
< min_y
)
16553 row
->visible_height
-= min_y
- row
->y
;
16554 if (row
->y
+ row
->height
> max_y
)
16555 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16556 if (row
->fringe_bitmap_periodic_p
)
16557 row
->redraw_fringe_bitmaps_p
= 1;
16559 it
.current_y
+= row
->height
;
16561 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16562 last_reused_text_row
= row
;
16563 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16567 /* Disable lines in the current matrix which are now
16568 below the window. */
16569 for (++row
; row
< bottom_row
; ++row
)
16570 row
->enabled_p
= row
->mode_line_p
= 0;
16573 /* Update window_end_pos etc.; last_reused_text_row is the last
16574 reused row from the current matrix containing text, if any.
16575 The value of last_text_row is the last displayed line
16576 containing text. */
16577 if (last_reused_text_row
)
16579 w
->window_end_bytepos
16580 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16581 wset_window_end_pos
16583 - MATRIX_ROW_END_CHARPOS (last_reused_text_row
)));
16584 wset_window_end_vpos
16585 (w
, make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16586 w
->current_matrix
)));
16588 else if (last_text_row
)
16590 w
->window_end_bytepos
16591 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16592 wset_window_end_pos
16593 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16594 wset_window_end_vpos
16595 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16596 w
->desired_matrix
)));
16600 /* This window must be completely empty. */
16601 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16602 wset_window_end_pos (w
, make_number (Z
- ZV
));
16603 wset_window_end_vpos (w
, make_number (0));
16605 wset_window_end_valid (w
, Qnil
);
16607 /* Update hint: don't try scrolling again in update_window. */
16608 w
->desired_matrix
->no_scrolling_p
= 1;
16611 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16615 else if (CHARPOS (new_start
) > CHARPOS (start
))
16617 struct glyph_row
*pt_row
, *row
;
16618 struct glyph_row
*first_reusable_row
;
16619 struct glyph_row
*first_row_to_display
;
16621 int yb
= window_text_bottom_y (w
);
16623 /* Find the row starting at new_start, if there is one. Don't
16624 reuse a partially visible line at the end. */
16625 first_reusable_row
= start_row
;
16626 while (first_reusable_row
->enabled_p
16627 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16628 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16629 < CHARPOS (new_start
)))
16630 ++first_reusable_row
;
16632 /* Give up if there is no row to reuse. */
16633 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16634 || !first_reusable_row
->enabled_p
16635 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16636 != CHARPOS (new_start
)))
16639 /* We can reuse fully visible rows beginning with
16640 first_reusable_row to the end of the window. Set
16641 first_row_to_display to the first row that cannot be reused.
16642 Set pt_row to the row containing point, if there is any. */
16644 for (first_row_to_display
= first_reusable_row
;
16645 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16646 ++first_row_to_display
)
16648 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16649 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16650 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16651 && first_row_to_display
->ends_at_zv_p
16652 && pt_row
== NULL
)))
16653 pt_row
= first_row_to_display
;
16656 /* Start displaying at the start of first_row_to_display. */
16657 eassert (first_row_to_display
->y
< yb
);
16658 init_to_row_start (&it
, w
, first_row_to_display
);
16660 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16662 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16664 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16665 + WINDOW_HEADER_LINE_HEIGHT (w
));
16667 /* Display lines beginning with first_row_to_display in the
16668 desired matrix. Set last_text_row to the last row displayed
16669 that displays text. */
16670 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16671 if (pt_row
== NULL
)
16672 w
->cursor
.vpos
= -1;
16673 last_text_row
= NULL
;
16674 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16675 if (display_line (&it
))
16676 last_text_row
= it
.glyph_row
- 1;
16678 /* If point is in a reused row, adjust y and vpos of the cursor
16682 w
->cursor
.vpos
-= nrows_scrolled
;
16683 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16686 /* Give up if point isn't in a row displayed or reused. (This
16687 also handles the case where w->cursor.vpos < nrows_scrolled
16688 after the calls to display_line, which can happen with scroll
16689 margins. See bug#1295.) */
16690 if (w
->cursor
.vpos
< 0)
16692 clear_glyph_matrix (w
->desired_matrix
);
16696 /* Scroll the display. */
16697 run
.current_y
= first_reusable_row
->y
;
16698 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16699 run
.height
= it
.last_visible_y
- run
.current_y
;
16700 dy
= run
.current_y
- run
.desired_y
;
16705 FRAME_RIF (f
)->update_window_begin_hook (w
);
16706 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16707 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16708 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16712 /* Adjust Y positions of reused rows. */
16713 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16714 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16715 max_y
= it
.last_visible_y
;
16716 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16719 row
->visible_height
= row
->height
;
16720 if (row
->y
< min_y
)
16721 row
->visible_height
-= min_y
- row
->y
;
16722 if (row
->y
+ row
->height
> max_y
)
16723 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16724 if (row
->fringe_bitmap_periodic_p
)
16725 row
->redraw_fringe_bitmaps_p
= 1;
16728 /* Scroll the current matrix. */
16729 eassert (nrows_scrolled
> 0);
16730 rotate_matrix (w
->current_matrix
,
16732 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16735 /* Disable rows not reused. */
16736 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16737 row
->enabled_p
= 0;
16739 /* Point may have moved to a different line, so we cannot assume that
16740 the previous cursor position is valid; locate the correct row. */
16743 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16745 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16746 && !row
->ends_at_zv_p
;
16750 w
->cursor
.y
= row
->y
;
16752 if (row
< bottom_row
)
16754 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16755 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16757 /* Can't use this optimization with bidi-reordered glyph
16758 rows, unless cursor is already at point. */
16759 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16761 if (!(w
->cursor
.hpos
>= 0
16762 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16763 && BUFFERP (glyph
->object
)
16764 && glyph
->charpos
== PT
))
16769 && (!BUFFERP (glyph
->object
)
16770 || glyph
->charpos
< PT
);
16774 w
->cursor
.x
+= glyph
->pixel_width
;
16779 /* Adjust window end. A null value of last_text_row means that
16780 the window end is in reused rows which in turn means that
16781 only its vpos can have changed. */
16784 w
->window_end_bytepos
16785 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16786 wset_window_end_pos
16787 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16788 wset_window_end_vpos
16789 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16790 w
->desired_matrix
)));
16794 wset_window_end_vpos
16795 (w
, make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
));
16798 wset_window_end_valid (w
, Qnil
);
16799 w
->desired_matrix
->no_scrolling_p
= 1;
16802 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16812 /************************************************************************
16813 Window redisplay reusing current matrix when buffer has changed
16814 ************************************************************************/
16816 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16817 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16818 ptrdiff_t *, ptrdiff_t *);
16819 static struct glyph_row
*
16820 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16821 struct glyph_row
*);
16824 /* Return the last row in MATRIX displaying text. If row START is
16825 non-null, start searching with that row. IT gives the dimensions
16826 of the display. Value is null if matrix is empty; otherwise it is
16827 a pointer to the row found. */
16829 static struct glyph_row
*
16830 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16831 struct glyph_row
*start
)
16833 struct glyph_row
*row
, *row_found
;
16835 /* Set row_found to the last row in IT->w's current matrix
16836 displaying text. The loop looks funny but think of partially
16839 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16840 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16842 eassert (row
->enabled_p
);
16844 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16853 /* Return the last row in the current matrix of W that is not affected
16854 by changes at the start of current_buffer that occurred since W's
16855 current matrix was built. Value is null if no such row exists.
16857 BEG_UNCHANGED us the number of characters unchanged at the start of
16858 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16859 first changed character in current_buffer. Characters at positions <
16860 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16861 when the current matrix was built. */
16863 static struct glyph_row
*
16864 find_last_unchanged_at_beg_row (struct window
*w
)
16866 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16867 struct glyph_row
*row
;
16868 struct glyph_row
*row_found
= NULL
;
16869 int yb
= window_text_bottom_y (w
);
16871 /* Find the last row displaying unchanged text. */
16872 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16873 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16874 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16877 if (/* If row ends before first_changed_pos, it is unchanged,
16878 except in some case. */
16879 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16880 /* When row ends in ZV and we write at ZV it is not
16882 && !row
->ends_at_zv_p
16883 /* When first_changed_pos is the end of a continued line,
16884 row is not unchanged because it may be no longer
16886 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16887 && (row
->continued_p
16888 || row
->exact_window_width_line_p
))
16889 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16890 needs to be recomputed, so don't consider this row as
16891 unchanged. This happens when the last line was
16892 bidi-reordered and was killed immediately before this
16893 redisplay cycle. In that case, ROW->end stores the
16894 buffer position of the first visual-order character of
16895 the killed text, which is now beyond ZV. */
16896 && CHARPOS (row
->end
.pos
) <= ZV
)
16899 /* Stop if last visible row. */
16900 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16908 /* Find the first glyph row in the current matrix of W that is not
16909 affected by changes at the end of current_buffer since the
16910 time W's current matrix was built.
16912 Return in *DELTA the number of chars by which buffer positions in
16913 unchanged text at the end of current_buffer must be adjusted.
16915 Return in *DELTA_BYTES the corresponding number of bytes.
16917 Value is null if no such row exists, i.e. all rows are affected by
16920 static struct glyph_row
*
16921 find_first_unchanged_at_end_row (struct window
*w
,
16922 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16924 struct glyph_row
*row
;
16925 struct glyph_row
*row_found
= NULL
;
16927 *delta
= *delta_bytes
= 0;
16929 /* Display must not have been paused, otherwise the current matrix
16930 is not up to date. */
16931 eassert (!NILP (w
->window_end_valid
));
16933 /* A value of window_end_pos >= END_UNCHANGED means that the window
16934 end is in the range of changed text. If so, there is no
16935 unchanged row at the end of W's current matrix. */
16936 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16939 /* Set row to the last row in W's current matrix displaying text. */
16940 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16942 /* If matrix is entirely empty, no unchanged row exists. */
16943 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16945 /* The value of row is the last glyph row in the matrix having a
16946 meaningful buffer position in it. The end position of row
16947 corresponds to window_end_pos. This allows us to translate
16948 buffer positions in the current matrix to current buffer
16949 positions for characters not in changed text. */
16951 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16952 ptrdiff_t Z_BYTE_old
=
16953 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16954 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
16955 struct glyph_row
*first_text_row
16956 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16958 *delta
= Z
- Z_old
;
16959 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16961 /* Set last_unchanged_pos to the buffer position of the last
16962 character in the buffer that has not been changed. Z is the
16963 index + 1 of the last character in current_buffer, i.e. by
16964 subtracting END_UNCHANGED we get the index of the last
16965 unchanged character, and we have to add BEG to get its buffer
16967 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16968 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16970 /* Search backward from ROW for a row displaying a line that
16971 starts at a minimum position >= last_unchanged_pos_old. */
16972 for (; row
> first_text_row
; --row
)
16974 /* This used to abort, but it can happen.
16975 It is ok to just stop the search instead here. KFS. */
16976 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16979 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16984 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16990 /* Make sure that glyph rows in the current matrix of window W
16991 reference the same glyph memory as corresponding rows in the
16992 frame's frame matrix. This function is called after scrolling W's
16993 current matrix on a terminal frame in try_window_id and
16994 try_window_reusing_current_matrix. */
16997 sync_frame_with_window_matrix_rows (struct window
*w
)
16999 struct frame
*f
= XFRAME (w
->frame
);
17000 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17002 /* Preconditions: W must be a leaf window and full-width. Its frame
17003 must have a frame matrix. */
17004 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
17005 eassert (WINDOW_FULL_WIDTH_P (w
));
17006 eassert (!FRAME_WINDOW_P (f
));
17008 /* If W is a full-width window, glyph pointers in W's current matrix
17009 have, by definition, to be the same as glyph pointers in the
17010 corresponding frame matrix. Note that frame matrices have no
17011 marginal areas (see build_frame_matrix). */
17012 window_row
= w
->current_matrix
->rows
;
17013 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17014 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17015 while (window_row
< window_row_end
)
17017 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17018 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17020 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17021 frame_row
->glyphs
[TEXT_AREA
] = start
;
17022 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17023 frame_row
->glyphs
[LAST_AREA
] = end
;
17025 /* Disable frame rows whose corresponding window rows have
17026 been disabled in try_window_id. */
17027 if (!window_row
->enabled_p
)
17028 frame_row
->enabled_p
= 0;
17030 ++window_row
, ++frame_row
;
17035 /* Find the glyph row in window W containing CHARPOS. Consider all
17036 rows between START and END (not inclusive). END null means search
17037 all rows to the end of the display area of W. Value is the row
17038 containing CHARPOS or null. */
17041 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17042 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17044 struct glyph_row
*row
= start
;
17045 struct glyph_row
*best_row
= NULL
;
17046 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
17049 /* If we happen to start on a header-line, skip that. */
17050 if (row
->mode_line_p
)
17053 if ((end
&& row
>= end
) || !row
->enabled_p
)
17056 last_y
= window_text_bottom_y (w
) - dy
;
17060 /* Give up if we have gone too far. */
17061 if (end
&& row
>= end
)
17063 /* This formerly returned if they were equal.
17064 I think that both quantities are of a "last plus one" type;
17065 if so, when they are equal, the row is within the screen. -- rms. */
17066 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17069 /* If it is in this row, return this row. */
17070 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17071 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17072 /* The end position of a row equals the start
17073 position of the next row. If CHARPOS is there, we
17074 would rather display it in the next line, except
17075 when this line ends in ZV. */
17076 && !row
->ends_at_zv_p
17077 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
17078 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17082 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17083 || (!best_row
&& !row
->continued_p
))
17085 /* In bidi-reordered rows, there could be several rows
17086 occluding point, all of them belonging to the same
17087 continued line. We need to find the row which fits
17088 CHARPOS the best. */
17089 for (g
= row
->glyphs
[TEXT_AREA
];
17090 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17093 if (!STRINGP (g
->object
))
17095 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17097 mindif
= eabs (g
->charpos
- charpos
);
17099 /* Exact match always wins. */
17106 else if (best_row
&& !row
->continued_p
)
17113 /* Try to redisplay window W by reusing its existing display. W's
17114 current matrix must be up to date when this function is called,
17115 i.e. window_end_valid must not be nil.
17119 1 if display has been updated
17120 0 if otherwise unsuccessful
17121 -1 if redisplay with same window start is known not to succeed
17123 The following steps are performed:
17125 1. Find the last row in the current matrix of W that is not
17126 affected by changes at the start of current_buffer. If no such row
17129 2. Find the first row in W's current matrix that is not affected by
17130 changes at the end of current_buffer. Maybe there is no such row.
17132 3. Display lines beginning with the row + 1 found in step 1 to the
17133 row found in step 2 or, if step 2 didn't find a row, to the end of
17136 4. If cursor is not known to appear on the window, give up.
17138 5. If display stopped at the row found in step 2, scroll the
17139 display and current matrix as needed.
17141 6. Maybe display some lines at the end of W, if we must. This can
17142 happen under various circumstances, like a partially visible line
17143 becoming fully visible, or because newly displayed lines are displayed
17144 in smaller font sizes.
17146 7. Update W's window end information. */
17149 try_window_id (struct window
*w
)
17151 struct frame
*f
= XFRAME (w
->frame
);
17152 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17153 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17154 struct glyph_row
*last_unchanged_at_beg_row
;
17155 struct glyph_row
*first_unchanged_at_end_row
;
17156 struct glyph_row
*row
;
17157 struct glyph_row
*bottom_row
;
17160 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17162 struct text_pos start_pos
;
17164 int first_unchanged_at_end_vpos
= 0;
17165 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17166 struct text_pos start
;
17167 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17170 if (inhibit_try_window_id
)
17174 /* This is handy for debugging. */
17176 #define GIVE_UP(X) \
17178 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17182 #define GIVE_UP(X) return 0
17185 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17187 /* Don't use this for mini-windows because these can show
17188 messages and mini-buffers, and we don't handle that here. */
17189 if (MINI_WINDOW_P (w
))
17192 /* This flag is used to prevent redisplay optimizations. */
17193 if (windows_or_buffers_changed
|| cursor_type_changed
)
17196 /* Verify that narrowing has not changed.
17197 Also verify that we were not told to prevent redisplay optimizations.
17198 It would be nice to further
17199 reduce the number of cases where this prevents try_window_id. */
17200 if (current_buffer
->clip_changed
17201 || current_buffer
->prevent_redisplay_optimizations_p
)
17204 /* Window must either use window-based redisplay or be full width. */
17205 if (!FRAME_WINDOW_P (f
)
17206 && (!FRAME_LINE_INS_DEL_OK (f
)
17207 || !WINDOW_FULL_WIDTH_P (w
)))
17210 /* Give up if point is known NOT to appear in W. */
17211 if (PT
< CHARPOS (start
))
17214 /* Another way to prevent redisplay optimizations. */
17215 if (w
->last_modified
== 0)
17218 /* Verify that window is not hscrolled. */
17219 if (w
->hscroll
!= 0)
17222 /* Verify that display wasn't paused. */
17223 if (NILP (w
->window_end_valid
))
17226 /* Can't use this if highlighting a region because a cursor movement
17227 will do more than just set the cursor. */
17228 if (!NILP (Vtransient_mark_mode
)
17229 && !NILP (BVAR (current_buffer
, mark_active
)))
17232 /* Likewise if highlighting trailing whitespace. */
17233 if (!NILP (Vshow_trailing_whitespace
))
17236 /* Likewise if showing a region. */
17237 if (!NILP (w
->region_showing
))
17240 /* Can't use this if overlay arrow position and/or string have
17242 if (overlay_arrows_changed_p ())
17245 /* When word-wrap is on, adding a space to the first word of a
17246 wrapped line can change the wrap position, altering the line
17247 above it. It might be worthwhile to handle this more
17248 intelligently, but for now just redisplay from scratch. */
17249 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
17252 /* Under bidi reordering, adding or deleting a character in the
17253 beginning of a paragraph, before the first strong directional
17254 character, can change the base direction of the paragraph (unless
17255 the buffer specifies a fixed paragraph direction), which will
17256 require to redisplay the whole paragraph. It might be worthwhile
17257 to find the paragraph limits and widen the range of redisplayed
17258 lines to that, but for now just give up this optimization and
17259 redisplay from scratch. */
17260 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17261 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
17264 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17265 only if buffer has really changed. The reason is that the gap is
17266 initially at Z for freshly visited files. The code below would
17267 set end_unchanged to 0 in that case. */
17268 if (MODIFF
> SAVE_MODIFF
17269 /* This seems to happen sometimes after saving a buffer. */
17270 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17272 if (GPT
- BEG
< BEG_UNCHANGED
)
17273 BEG_UNCHANGED
= GPT
- BEG
;
17274 if (Z
- GPT
< END_UNCHANGED
)
17275 END_UNCHANGED
= Z
- GPT
;
17278 /* The position of the first and last character that has been changed. */
17279 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17280 last_changed_charpos
= Z
- END_UNCHANGED
;
17282 /* If window starts after a line end, and the last change is in
17283 front of that newline, then changes don't affect the display.
17284 This case happens with stealth-fontification. Note that although
17285 the display is unchanged, glyph positions in the matrix have to
17286 be adjusted, of course. */
17287 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17288 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17289 && ((last_changed_charpos
< CHARPOS (start
)
17290 && CHARPOS (start
) == BEGV
)
17291 || (last_changed_charpos
< CHARPOS (start
) - 1
17292 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17294 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17295 struct glyph_row
*r0
;
17297 /* Compute how many chars/bytes have been added to or removed
17298 from the buffer. */
17299 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17300 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17301 Z_delta
= Z
- Z_old
;
17302 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17304 /* Give up if PT is not in the window. Note that it already has
17305 been checked at the start of try_window_id that PT is not in
17306 front of the window start. */
17307 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17310 /* If window start is unchanged, we can reuse the whole matrix
17311 as is, after adjusting glyph positions. No need to compute
17312 the window end again, since its offset from Z hasn't changed. */
17313 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17314 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17315 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17316 /* PT must not be in a partially visible line. */
17317 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17318 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17320 /* Adjust positions in the glyph matrix. */
17321 if (Z_delta
|| Z_delta_bytes
)
17323 struct glyph_row
*r1
17324 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17325 increment_matrix_positions (w
->current_matrix
,
17326 MATRIX_ROW_VPOS (r0
, current_matrix
),
17327 MATRIX_ROW_VPOS (r1
, current_matrix
),
17328 Z_delta
, Z_delta_bytes
);
17331 /* Set the cursor. */
17332 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17334 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17341 /* Handle the case that changes are all below what is displayed in
17342 the window, and that PT is in the window. This shortcut cannot
17343 be taken if ZV is visible in the window, and text has been added
17344 there that is visible in the window. */
17345 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17346 /* ZV is not visible in the window, or there are no
17347 changes at ZV, actually. */
17348 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17349 || first_changed_charpos
== last_changed_charpos
))
17351 struct glyph_row
*r0
;
17353 /* Give up if PT is not in the window. Note that it already has
17354 been checked at the start of try_window_id that PT is not in
17355 front of the window start. */
17356 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17359 /* If window start is unchanged, we can reuse the whole matrix
17360 as is, without changing glyph positions since no text has
17361 been added/removed in front of the window end. */
17362 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17363 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17364 /* PT must not be in a partially visible line. */
17365 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17366 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17368 /* We have to compute the window end anew since text
17369 could have been added/removed after it. */
17370 wset_window_end_pos
17371 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17372 w
->window_end_bytepos
17373 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17375 /* Set the cursor. */
17376 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17378 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17385 /* Give up if window start is in the changed area.
17387 The condition used to read
17389 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17391 but why that was tested escapes me at the moment. */
17392 if (CHARPOS (start
) >= first_changed_charpos
17393 && CHARPOS (start
) <= last_changed_charpos
)
17396 /* Check that window start agrees with the start of the first glyph
17397 row in its current matrix. Check this after we know the window
17398 start is not in changed text, otherwise positions would not be
17400 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17401 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17404 /* Give up if the window ends in strings. Overlay strings
17405 at the end are difficult to handle, so don't try. */
17406 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17407 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17410 /* Compute the position at which we have to start displaying new
17411 lines. Some of the lines at the top of the window might be
17412 reusable because they are not displaying changed text. Find the
17413 last row in W's current matrix not affected by changes at the
17414 start of current_buffer. Value is null if changes start in the
17415 first line of window. */
17416 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17417 if (last_unchanged_at_beg_row
)
17419 /* Avoid starting to display in the middle of a character, a TAB
17420 for instance. This is easier than to set up the iterator
17421 exactly, and it's not a frequent case, so the additional
17422 effort wouldn't really pay off. */
17423 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17424 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17425 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17426 --last_unchanged_at_beg_row
;
17428 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17431 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17433 start_pos
= it
.current
.pos
;
17435 /* Start displaying new lines in the desired matrix at the same
17436 vpos we would use in the current matrix, i.e. below
17437 last_unchanged_at_beg_row. */
17438 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17440 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17441 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17443 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17447 /* There are no reusable lines at the start of the window.
17448 Start displaying in the first text line. */
17449 start_display (&it
, w
, start
);
17450 it
.vpos
= it
.first_vpos
;
17451 start_pos
= it
.current
.pos
;
17454 /* Find the first row that is not affected by changes at the end of
17455 the buffer. Value will be null if there is no unchanged row, in
17456 which case we must redisplay to the end of the window. delta
17457 will be set to the value by which buffer positions beginning with
17458 first_unchanged_at_end_row have to be adjusted due to text
17460 first_unchanged_at_end_row
17461 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17462 IF_DEBUG (debug_delta
= delta
);
17463 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17465 /* Set stop_pos to the buffer position up to which we will have to
17466 display new lines. If first_unchanged_at_end_row != NULL, this
17467 is the buffer position of the start of the line displayed in that
17468 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17469 that we don't stop at a buffer position. */
17471 if (first_unchanged_at_end_row
)
17473 eassert (last_unchanged_at_beg_row
== NULL
17474 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17476 /* If this is a continuation line, move forward to the next one
17477 that isn't. Changes in lines above affect this line.
17478 Caution: this may move first_unchanged_at_end_row to a row
17479 not displaying text. */
17480 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17481 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17482 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17483 < it
.last_visible_y
))
17484 ++first_unchanged_at_end_row
;
17486 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17487 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17488 >= it
.last_visible_y
))
17489 first_unchanged_at_end_row
= NULL
;
17492 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17494 first_unchanged_at_end_vpos
17495 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17496 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17499 else if (last_unchanged_at_beg_row
== NULL
)
17505 /* Either there is no unchanged row at the end, or the one we have
17506 now displays text. This is a necessary condition for the window
17507 end pos calculation at the end of this function. */
17508 eassert (first_unchanged_at_end_row
== NULL
17509 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17511 debug_last_unchanged_at_beg_vpos
17512 = (last_unchanged_at_beg_row
17513 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17515 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17517 #endif /* GLYPH_DEBUG */
17520 /* Display new lines. Set last_text_row to the last new line
17521 displayed which has text on it, i.e. might end up as being the
17522 line where the window_end_vpos is. */
17523 w
->cursor
.vpos
= -1;
17524 last_text_row
= NULL
;
17525 overlay_arrow_seen
= 0;
17526 while (it
.current_y
< it
.last_visible_y
17527 && !fonts_changed_p
17528 && (first_unchanged_at_end_row
== NULL
17529 || IT_CHARPOS (it
) < stop_pos
))
17531 if (display_line (&it
))
17532 last_text_row
= it
.glyph_row
- 1;
17535 if (fonts_changed_p
)
17539 /* Compute differences in buffer positions, y-positions etc. for
17540 lines reused at the bottom of the window. Compute what we can
17542 if (first_unchanged_at_end_row
17543 /* No lines reused because we displayed everything up to the
17544 bottom of the window. */
17545 && it
.current_y
< it
.last_visible_y
)
17548 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17550 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17551 run
.current_y
= first_unchanged_at_end_row
->y
;
17552 run
.desired_y
= run
.current_y
+ dy
;
17553 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17557 delta
= delta_bytes
= dvpos
= dy
17558 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17559 first_unchanged_at_end_row
= NULL
;
17561 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17564 /* Find the cursor if not already found. We have to decide whether
17565 PT will appear on this window (it sometimes doesn't, but this is
17566 not a very frequent case.) This decision has to be made before
17567 the current matrix is altered. A value of cursor.vpos < 0 means
17568 that PT is either in one of the lines beginning at
17569 first_unchanged_at_end_row or below the window. Don't care for
17570 lines that might be displayed later at the window end; as
17571 mentioned, this is not a frequent case. */
17572 if (w
->cursor
.vpos
< 0)
17574 /* Cursor in unchanged rows at the top? */
17575 if (PT
< CHARPOS (start_pos
)
17576 && last_unchanged_at_beg_row
)
17578 row
= row_containing_pos (w
, PT
,
17579 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17580 last_unchanged_at_beg_row
+ 1, 0);
17582 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17585 /* Start from first_unchanged_at_end_row looking for PT. */
17586 else if (first_unchanged_at_end_row
)
17588 row
= row_containing_pos (w
, PT
- delta
,
17589 first_unchanged_at_end_row
, NULL
, 0);
17591 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17592 delta_bytes
, dy
, dvpos
);
17595 /* Give up if cursor was not found. */
17596 if (w
->cursor
.vpos
< 0)
17598 clear_glyph_matrix (w
->desired_matrix
);
17603 /* Don't let the cursor end in the scroll margins. */
17605 int this_scroll_margin
, cursor_height
;
17607 this_scroll_margin
=
17608 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17609 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17610 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17612 if ((w
->cursor
.y
< this_scroll_margin
17613 && CHARPOS (start
) > BEGV
)
17614 /* Old redisplay didn't take scroll margin into account at the bottom,
17615 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17616 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17617 ? cursor_height
+ this_scroll_margin
17618 : 1)) > it
.last_visible_y
)
17620 w
->cursor
.vpos
= -1;
17621 clear_glyph_matrix (w
->desired_matrix
);
17626 /* Scroll the display. Do it before changing the current matrix so
17627 that xterm.c doesn't get confused about where the cursor glyph is
17629 if (dy
&& run
.height
)
17633 if (FRAME_WINDOW_P (f
))
17635 FRAME_RIF (f
)->update_window_begin_hook (w
);
17636 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17637 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17638 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17642 /* Terminal frame. In this case, dvpos gives the number of
17643 lines to scroll by; dvpos < 0 means scroll up. */
17645 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17646 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17647 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17648 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17649 + window_internal_height (w
));
17651 #if defined (HAVE_GPM) || defined (MSDOS)
17652 x_clear_window_mouse_face (w
);
17654 /* Perform the operation on the screen. */
17657 /* Scroll last_unchanged_at_beg_row to the end of the
17658 window down dvpos lines. */
17659 set_terminal_window (f
, end
);
17661 /* On dumb terminals delete dvpos lines at the end
17662 before inserting dvpos empty lines. */
17663 if (!FRAME_SCROLL_REGION_OK (f
))
17664 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17666 /* Insert dvpos empty lines in front of
17667 last_unchanged_at_beg_row. */
17668 ins_del_lines (f
, from
, dvpos
);
17670 else if (dvpos
< 0)
17672 /* Scroll up last_unchanged_at_beg_vpos to the end of
17673 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17674 set_terminal_window (f
, end
);
17676 /* Delete dvpos lines in front of
17677 last_unchanged_at_beg_vpos. ins_del_lines will set
17678 the cursor to the given vpos and emit |dvpos| delete
17680 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17682 /* On a dumb terminal insert dvpos empty lines at the
17684 if (!FRAME_SCROLL_REGION_OK (f
))
17685 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17688 set_terminal_window (f
, 0);
17694 /* Shift reused rows of the current matrix to the right position.
17695 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17697 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17698 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17701 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17702 bottom_vpos
, dvpos
);
17703 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17706 else if (dvpos
> 0)
17708 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17709 bottom_vpos
, dvpos
);
17710 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17711 first_unchanged_at_end_vpos
+ dvpos
);
17714 /* For frame-based redisplay, make sure that current frame and window
17715 matrix are in sync with respect to glyph memory. */
17716 if (!FRAME_WINDOW_P (f
))
17717 sync_frame_with_window_matrix_rows (w
);
17719 /* Adjust buffer positions in reused rows. */
17720 if (delta
|| delta_bytes
)
17721 increment_matrix_positions (current_matrix
,
17722 first_unchanged_at_end_vpos
+ dvpos
,
17723 bottom_vpos
, delta
, delta_bytes
);
17725 /* Adjust Y positions. */
17727 shift_glyph_matrix (w
, current_matrix
,
17728 first_unchanged_at_end_vpos
+ dvpos
,
17731 if (first_unchanged_at_end_row
)
17733 first_unchanged_at_end_row
+= dvpos
;
17734 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17735 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17736 first_unchanged_at_end_row
= NULL
;
17739 /* If scrolling up, there may be some lines to display at the end of
17741 last_text_row_at_end
= NULL
;
17744 /* Scrolling up can leave for example a partially visible line
17745 at the end of the window to be redisplayed. */
17746 /* Set last_row to the glyph row in the current matrix where the
17747 window end line is found. It has been moved up or down in
17748 the matrix by dvpos. */
17749 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17750 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17752 /* If last_row is the window end line, it should display text. */
17753 eassert (last_row
->displays_text_p
);
17755 /* If window end line was partially visible before, begin
17756 displaying at that line. Otherwise begin displaying with the
17757 line following it. */
17758 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17760 init_to_row_start (&it
, w
, last_row
);
17761 it
.vpos
= last_vpos
;
17762 it
.current_y
= last_row
->y
;
17766 init_to_row_end (&it
, w
, last_row
);
17767 it
.vpos
= 1 + last_vpos
;
17768 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17772 /* We may start in a continuation line. If so, we have to
17773 get the right continuation_lines_width and current_x. */
17774 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17775 it
.hpos
= it
.current_x
= 0;
17777 /* Display the rest of the lines at the window end. */
17778 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17779 while (it
.current_y
< it
.last_visible_y
17780 && !fonts_changed_p
)
17782 /* Is it always sure that the display agrees with lines in
17783 the current matrix? I don't think so, so we mark rows
17784 displayed invalid in the current matrix by setting their
17785 enabled_p flag to zero. */
17786 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17787 if (display_line (&it
))
17788 last_text_row_at_end
= it
.glyph_row
- 1;
17792 /* Update window_end_pos and window_end_vpos. */
17793 if (first_unchanged_at_end_row
17794 && !last_text_row_at_end
)
17796 /* Window end line if one of the preserved rows from the current
17797 matrix. Set row to the last row displaying text in current
17798 matrix starting at first_unchanged_at_end_row, after
17800 eassert (first_unchanged_at_end_row
->displays_text_p
);
17801 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17802 first_unchanged_at_end_row
);
17803 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17805 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17806 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17807 wset_window_end_vpos
17808 (w
, make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
)));
17809 eassert (w
->window_end_bytepos
>= 0);
17810 IF_DEBUG (debug_method_add (w
, "A"));
17812 else if (last_text_row_at_end
)
17814 wset_window_end_pos
17815 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
)));
17816 w
->window_end_bytepos
17817 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17818 wset_window_end_vpos
17819 (w
, make_number (MATRIX_ROW_VPOS (last_text_row_at_end
,
17821 eassert (w
->window_end_bytepos
>= 0);
17822 IF_DEBUG (debug_method_add (w
, "B"));
17824 else if (last_text_row
)
17826 /* We have displayed either to the end of the window or at the
17827 end of the window, i.e. the last row with text is to be found
17828 in the desired matrix. */
17829 wset_window_end_pos
17830 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
17831 w
->window_end_bytepos
17832 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17833 wset_window_end_vpos
17834 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
)));
17835 eassert (w
->window_end_bytepos
>= 0);
17837 else if (first_unchanged_at_end_row
== NULL
17838 && last_text_row
== NULL
17839 && last_text_row_at_end
== NULL
)
17841 /* Displayed to end of window, but no line containing text was
17842 displayed. Lines were deleted at the end of the window. */
17843 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17844 int vpos
= XFASTINT (w
->window_end_vpos
);
17845 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17846 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17849 row
== NULL
&& vpos
>= first_vpos
;
17850 --vpos
, --current_row
, --desired_row
)
17852 if (desired_row
->enabled_p
)
17854 if (desired_row
->displays_text_p
)
17857 else if (current_row
->displays_text_p
)
17861 eassert (row
!= NULL
);
17862 wset_window_end_vpos (w
, make_number (vpos
+ 1));
17863 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17864 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17865 eassert (w
->window_end_bytepos
>= 0);
17866 IF_DEBUG (debug_method_add (w
, "C"));
17871 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17872 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17874 /* Record that display has not been completed. */
17875 wset_window_end_valid (w
, Qnil
);
17876 w
->desired_matrix
->no_scrolling_p
= 1;
17884 /***********************************************************************
17885 More debugging support
17886 ***********************************************************************/
17890 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17891 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17892 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17895 /* Dump the contents of glyph matrix MATRIX on stderr.
17897 GLYPHS 0 means don't show glyph contents.
17898 GLYPHS 1 means show glyphs in short form
17899 GLYPHS > 1 means show glyphs in long form. */
17902 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17905 for (i
= 0; i
< matrix
->nrows
; ++i
)
17906 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17910 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17911 the glyph row and area where the glyph comes from. */
17914 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17916 if (glyph
->type
== CHAR_GLYPH
)
17919 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17920 glyph
- row
->glyphs
[TEXT_AREA
],
17923 (BUFFERP (glyph
->object
)
17925 : (STRINGP (glyph
->object
)
17928 glyph
->pixel_width
,
17930 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17934 glyph
->left_box_line_p
,
17935 glyph
->right_box_line_p
);
17937 else if (glyph
->type
== STRETCH_GLYPH
)
17940 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17941 glyph
- row
->glyphs
[TEXT_AREA
],
17944 (BUFFERP (glyph
->object
)
17946 : (STRINGP (glyph
->object
)
17949 glyph
->pixel_width
,
17953 glyph
->left_box_line_p
,
17954 glyph
->right_box_line_p
);
17956 else if (glyph
->type
== IMAGE_GLYPH
)
17959 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17960 glyph
- row
->glyphs
[TEXT_AREA
],
17963 (BUFFERP (glyph
->object
)
17965 : (STRINGP (glyph
->object
)
17968 glyph
->pixel_width
,
17972 glyph
->left_box_line_p
,
17973 glyph
->right_box_line_p
);
17975 else if (glyph
->type
== COMPOSITE_GLYPH
)
17978 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17979 glyph
- row
->glyphs
[TEXT_AREA
],
17982 (BUFFERP (glyph
->object
)
17984 : (STRINGP (glyph
->object
)
17987 glyph
->pixel_width
,
17989 if (glyph
->u
.cmp
.automatic
)
17992 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17993 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17995 glyph
->left_box_line_p
,
17996 glyph
->right_box_line_p
);
18001 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18002 GLYPHS 0 means don't show glyph contents.
18003 GLYPHS 1 means show glyphs in short form
18004 GLYPHS > 1 means show glyphs in long form. */
18007 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18011 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18012 fprintf (stderr
, "======================================================================\n");
18014 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18015 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18017 MATRIX_ROW_START_CHARPOS (row
),
18018 MATRIX_ROW_END_CHARPOS (row
),
18019 row
->used
[TEXT_AREA
],
18020 row
->contains_overlapping_glyphs_p
,
18022 row
->truncated_on_left_p
,
18023 row
->truncated_on_right_p
,
18025 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18026 row
->displays_text_p
,
18029 row
->ends_in_middle_of_char_p
,
18030 row
->starts_in_middle_of_char_p
,
18036 row
->visible_height
,
18039 fprintf (stderr
, "%9"pD
"d %5"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18040 row
->end
.overlay_string_index
,
18041 row
->continuation_lines_width
);
18042 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
18043 CHARPOS (row
->start
.string_pos
),
18044 CHARPOS (row
->end
.string_pos
));
18045 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
18046 row
->end
.dpvec_index
);
18053 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18055 struct glyph
*glyph
= row
->glyphs
[area
];
18056 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18058 /* Glyph for a line end in text. */
18059 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18062 if (glyph
< glyph_end
)
18063 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
18065 for (; glyph
< glyph_end
; ++glyph
)
18066 dump_glyph (row
, glyph
, area
);
18069 else if (glyphs
== 1)
18073 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18075 char *s
= alloca (row
->used
[area
] + 1);
18078 for (i
= 0; i
< row
->used
[area
]; ++i
)
18080 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18081 if (glyph
->type
== CHAR_GLYPH
18082 && glyph
->u
.ch
< 0x80
18083 && glyph
->u
.ch
>= ' ')
18084 s
[i
] = glyph
->u
.ch
;
18090 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18096 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18097 Sdump_glyph_matrix
, 0, 1, "p",
18098 doc
: /* Dump the current matrix of the selected window to stderr.
18099 Shows contents of glyph row structures. With non-nil
18100 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18101 glyphs in short form, otherwise show glyphs in long form. */)
18102 (Lisp_Object glyphs
)
18104 struct window
*w
= XWINDOW (selected_window
);
18105 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18107 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18108 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18109 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18110 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18111 fprintf (stderr
, "=============================================\n");
18112 dump_glyph_matrix (w
->current_matrix
,
18113 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18118 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18119 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18122 struct frame
*f
= XFRAME (selected_frame
);
18123 dump_glyph_matrix (f
->current_matrix
, 1);
18128 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18129 doc
: /* Dump glyph row ROW to stderr.
18130 GLYPH 0 means don't dump glyphs.
18131 GLYPH 1 means dump glyphs in short form.
18132 GLYPH > 1 or omitted means dump glyphs in long form. */)
18133 (Lisp_Object row
, Lisp_Object glyphs
)
18135 struct glyph_matrix
*matrix
;
18138 CHECK_NUMBER (row
);
18139 matrix
= XWINDOW (selected_window
)->current_matrix
;
18141 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18142 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18144 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18149 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18150 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18151 GLYPH 0 means don't dump glyphs.
18152 GLYPH 1 means dump glyphs in short form.
18153 GLYPH > 1 or omitted means dump glyphs in long form. */)
18154 (Lisp_Object row
, Lisp_Object glyphs
)
18156 struct frame
*sf
= SELECTED_FRAME ();
18157 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18160 CHECK_NUMBER (row
);
18162 if (vpos
>= 0 && vpos
< m
->nrows
)
18163 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18164 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18169 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18170 doc
: /* Toggle tracing of redisplay.
18171 With ARG, turn tracing on if and only if ARG is positive. */)
18175 trace_redisplay_p
= !trace_redisplay_p
;
18178 arg
= Fprefix_numeric_value (arg
);
18179 trace_redisplay_p
= XINT (arg
) > 0;
18186 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18187 doc
: /* Like `format', but print result to stderr.
18188 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18189 (ptrdiff_t nargs
, Lisp_Object
*args
)
18191 Lisp_Object s
= Fformat (nargs
, args
);
18192 fprintf (stderr
, "%s", SDATA (s
));
18196 #endif /* GLYPH_DEBUG */
18200 /***********************************************************************
18201 Building Desired Matrix Rows
18202 ***********************************************************************/
18204 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18205 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18207 static struct glyph_row
*
18208 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18210 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18211 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18212 struct buffer
*old
= current_buffer
;
18213 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18214 int arrow_len
= SCHARS (overlay_arrow_string
);
18215 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18216 const unsigned char *p
;
18219 int n_glyphs_before
;
18221 set_buffer_temp (buffer
);
18222 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18223 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18224 SET_TEXT_POS (it
.position
, 0, 0);
18226 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18228 while (p
< arrow_end
)
18230 Lisp_Object face
, ilisp
;
18232 /* Get the next character. */
18234 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18237 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18238 if (! ASCII_CHAR_P (it
.c
))
18239 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18243 /* Get its face. */
18244 ilisp
= make_number (p
- arrow_string
);
18245 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18246 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18248 /* Compute its width, get its glyphs. */
18249 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18250 SET_TEXT_POS (it
.position
, -1, -1);
18251 PRODUCE_GLYPHS (&it
);
18253 /* If this character doesn't fit any more in the line, we have
18254 to remove some glyphs. */
18255 if (it
.current_x
> it
.last_visible_x
)
18257 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18262 set_buffer_temp (old
);
18263 return it
.glyph_row
;
18267 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18268 glyphs to insert is determined by produce_special_glyphs. */
18271 insert_left_trunc_glyphs (struct it
*it
)
18273 struct it truncate_it
;
18274 struct glyph
*from
, *end
, *to
, *toend
;
18276 eassert (!FRAME_WINDOW_P (it
->f
)
18277 || (!it
->glyph_row
->reversed_p
18278 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18279 || (it
->glyph_row
->reversed_p
18280 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18282 /* Get the truncation glyphs. */
18284 truncate_it
.current_x
= 0;
18285 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18286 truncate_it
.glyph_row
= &scratch_glyph_row
;
18287 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18288 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18289 truncate_it
.object
= make_number (0);
18290 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18292 /* Overwrite glyphs from IT with truncation glyphs. */
18293 if (!it
->glyph_row
->reversed_p
)
18295 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18297 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18298 end
= from
+ tused
;
18299 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18300 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18301 if (FRAME_WINDOW_P (it
->f
))
18303 /* On GUI frames, when variable-size fonts are displayed,
18304 the truncation glyphs may need more pixels than the row's
18305 glyphs they overwrite. We overwrite more glyphs to free
18306 enough screen real estate, and enlarge the stretch glyph
18307 on the right (see display_line), if there is one, to
18308 preserve the screen position of the truncation glyphs on
18311 struct glyph
*g
= to
;
18314 /* The first glyph could be partially visible, in which case
18315 it->glyph_row->x will be negative. But we want the left
18316 truncation glyphs to be aligned at the left margin of the
18317 window, so we override the x coordinate at which the row
18319 it
->glyph_row
->x
= 0;
18320 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18322 w
+= g
->pixel_width
;
18325 if (g
- to
- tused
> 0)
18327 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18328 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18330 used
= it
->glyph_row
->used
[TEXT_AREA
];
18331 if (it
->glyph_row
->truncated_on_right_p
18332 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18333 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18336 int extra
= w
- it
->truncation_pixel_width
;
18338 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18345 /* There may be padding glyphs left over. Overwrite them too. */
18346 if (!FRAME_WINDOW_P (it
->f
))
18348 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18350 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18357 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18361 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18363 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18364 that back to front. */
18365 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18366 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18367 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18368 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18369 if (FRAME_WINDOW_P (it
->f
))
18372 struct glyph
*g
= to
;
18374 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18376 w
+= g
->pixel_width
;
18379 if (to
- g
- tused
> 0)
18381 if (it
->glyph_row
->truncated_on_right_p
18382 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18383 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18385 int extra
= w
- it
->truncation_pixel_width
;
18387 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18391 while (from
>= end
&& to
>= toend
)
18393 if (!FRAME_WINDOW_P (it
->f
))
18395 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18398 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18399 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18400 while (from
>= end
&& to
>= toend
)
18406 /* Need to free some room before prepending additional
18408 int move_by
= from
- end
+ 1;
18409 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18410 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18412 for ( ; g
>= g0
; g
--)
18414 while (from
>= end
)
18416 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18421 /* Compute the hash code for ROW. */
18423 row_hash (struct glyph_row
*row
)
18426 unsigned hashval
= 0;
18428 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18429 for (k
= 0; k
< row
->used
[area
]; ++k
)
18430 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18431 + row
->glyphs
[area
][k
].u
.val
18432 + row
->glyphs
[area
][k
].face_id
18433 + row
->glyphs
[area
][k
].padding_p
18434 + (row
->glyphs
[area
][k
].type
<< 2));
18439 /* Compute the pixel height and width of IT->glyph_row.
18441 Most of the time, ascent and height of a display line will be equal
18442 to the max_ascent and max_height values of the display iterator
18443 structure. This is not the case if
18445 1. We hit ZV without displaying anything. In this case, max_ascent
18446 and max_height will be zero.
18448 2. We have some glyphs that don't contribute to the line height.
18449 (The glyph row flag contributes_to_line_height_p is for future
18450 pixmap extensions).
18452 The first case is easily covered by using default values because in
18453 these cases, the line height does not really matter, except that it
18454 must not be zero. */
18457 compute_line_metrics (struct it
*it
)
18459 struct glyph_row
*row
= it
->glyph_row
;
18461 if (FRAME_WINDOW_P (it
->f
))
18463 int i
, min_y
, max_y
;
18465 /* The line may consist of one space only, that was added to
18466 place the cursor on it. If so, the row's height hasn't been
18468 if (row
->height
== 0)
18470 if (it
->max_ascent
+ it
->max_descent
== 0)
18471 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18472 row
->ascent
= it
->max_ascent
;
18473 row
->height
= it
->max_ascent
+ it
->max_descent
;
18474 row
->phys_ascent
= it
->max_phys_ascent
;
18475 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18476 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18479 /* Compute the width of this line. */
18480 row
->pixel_width
= row
->x
;
18481 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18482 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18484 eassert (row
->pixel_width
>= 0);
18485 eassert (row
->ascent
>= 0 && row
->height
> 0);
18487 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18488 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18490 /* If first line's physical ascent is larger than its logical
18491 ascent, use the physical ascent, and make the row taller.
18492 This makes accented characters fully visible. */
18493 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18494 && row
->phys_ascent
> row
->ascent
)
18496 row
->height
+= row
->phys_ascent
- row
->ascent
;
18497 row
->ascent
= row
->phys_ascent
;
18500 /* Compute how much of the line is visible. */
18501 row
->visible_height
= row
->height
;
18503 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18504 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18506 if (row
->y
< min_y
)
18507 row
->visible_height
-= min_y
- row
->y
;
18508 if (row
->y
+ row
->height
> max_y
)
18509 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18513 row
->pixel_width
= row
->used
[TEXT_AREA
];
18514 if (row
->continued_p
)
18515 row
->pixel_width
-= it
->continuation_pixel_width
;
18516 else if (row
->truncated_on_right_p
)
18517 row
->pixel_width
-= it
->truncation_pixel_width
;
18518 row
->ascent
= row
->phys_ascent
= 0;
18519 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18520 row
->extra_line_spacing
= 0;
18523 /* Compute a hash code for this row. */
18524 row
->hash
= row_hash (row
);
18526 it
->max_ascent
= it
->max_descent
= 0;
18527 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18531 /* Append one space to the glyph row of iterator IT if doing a
18532 window-based redisplay. The space has the same face as
18533 IT->face_id. Value is non-zero if a space was added.
18535 This function is called to make sure that there is always one glyph
18536 at the end of a glyph row that the cursor can be set on under
18537 window-systems. (If there weren't such a glyph we would not know
18538 how wide and tall a box cursor should be displayed).
18540 At the same time this space let's a nicely handle clearing to the
18541 end of the line if the row ends in italic text. */
18544 append_space_for_newline (struct it
*it
, int default_face_p
)
18546 if (FRAME_WINDOW_P (it
->f
))
18548 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18550 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18551 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18553 /* Save some values that must not be changed.
18554 Must save IT->c and IT->len because otherwise
18555 ITERATOR_AT_END_P wouldn't work anymore after
18556 append_space_for_newline has been called. */
18557 enum display_element_type saved_what
= it
->what
;
18558 int saved_c
= it
->c
, saved_len
= it
->len
;
18559 int saved_char_to_display
= it
->char_to_display
;
18560 int saved_x
= it
->current_x
;
18561 int saved_face_id
= it
->face_id
;
18562 struct text_pos saved_pos
;
18563 Lisp_Object saved_object
;
18566 saved_object
= it
->object
;
18567 saved_pos
= it
->position
;
18569 it
->what
= IT_CHARACTER
;
18570 memset (&it
->position
, 0, sizeof it
->position
);
18571 it
->object
= make_number (0);
18572 it
->c
= it
->char_to_display
= ' ';
18575 /* If the default face was remapped, be sure to use the
18576 remapped face for the appended newline. */
18577 if (default_face_p
)
18578 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18579 else if (it
->face_before_selective_p
)
18580 it
->face_id
= it
->saved_face_id
;
18581 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18582 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18584 PRODUCE_GLYPHS (it
);
18586 it
->override_ascent
= -1;
18587 it
->constrain_row_ascent_descent_p
= 0;
18588 it
->current_x
= saved_x
;
18589 it
->object
= saved_object
;
18590 it
->position
= saved_pos
;
18591 it
->what
= saved_what
;
18592 it
->face_id
= saved_face_id
;
18593 it
->len
= saved_len
;
18595 it
->char_to_display
= saved_char_to_display
;
18604 /* Extend the face of the last glyph in the text area of IT->glyph_row
18605 to the end of the display line. Called from display_line. If the
18606 glyph row is empty, add a space glyph to it so that we know the
18607 face to draw. Set the glyph row flag fill_line_p. If the glyph
18608 row is R2L, prepend a stretch glyph to cover the empty space to the
18609 left of the leftmost glyph. */
18612 extend_face_to_end_of_line (struct it
*it
)
18614 struct face
*face
, *default_face
;
18615 struct frame
*f
= it
->f
;
18617 /* If line is already filled, do nothing. Non window-system frames
18618 get a grace of one more ``pixel'' because their characters are
18619 1-``pixel'' wide, so they hit the equality too early. This grace
18620 is needed only for R2L rows that are not continued, to produce
18621 one extra blank where we could display the cursor. */
18622 if (it
->current_x
>= it
->last_visible_x
18623 + (!FRAME_WINDOW_P (f
)
18624 && it
->glyph_row
->reversed_p
18625 && !it
->glyph_row
->continued_p
))
18628 /* The default face, possibly remapped. */
18629 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18631 /* Face extension extends the background and box of IT->face_id
18632 to the end of the line. If the background equals the background
18633 of the frame, we don't have to do anything. */
18634 if (it
->face_before_selective_p
)
18635 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18637 face
= FACE_FROM_ID (f
, it
->face_id
);
18639 if (FRAME_WINDOW_P (f
)
18640 && it
->glyph_row
->displays_text_p
18641 && face
->box
== FACE_NO_BOX
18642 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18644 && !it
->glyph_row
->reversed_p
)
18647 /* Set the glyph row flag indicating that the face of the last glyph
18648 in the text area has to be drawn to the end of the text area. */
18649 it
->glyph_row
->fill_line_p
= 1;
18651 /* If current character of IT is not ASCII, make sure we have the
18652 ASCII face. This will be automatically undone the next time
18653 get_next_display_element returns a multibyte character. Note
18654 that the character will always be single byte in unibyte
18656 if (!ASCII_CHAR_P (it
->c
))
18658 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18661 if (FRAME_WINDOW_P (f
))
18663 /* If the row is empty, add a space with the current face of IT,
18664 so that we know which face to draw. */
18665 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18667 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18668 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18669 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18671 #ifdef HAVE_WINDOW_SYSTEM
18672 if (it
->glyph_row
->reversed_p
)
18674 /* Prepend a stretch glyph to the row, such that the
18675 rightmost glyph will be drawn flushed all the way to the
18676 right margin of the window. The stretch glyph that will
18677 occupy the empty space, if any, to the left of the
18679 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18680 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18681 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18683 int row_width
, stretch_ascent
, stretch_width
;
18684 struct text_pos saved_pos
;
18685 int saved_face_id
, saved_avoid_cursor
;
18687 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18688 row_width
+= g
->pixel_width
;
18689 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18690 if (stretch_width
> 0)
18693 (((it
->ascent
+ it
->descent
)
18694 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18695 saved_pos
= it
->position
;
18696 memset (&it
->position
, 0, sizeof it
->position
);
18697 saved_avoid_cursor
= it
->avoid_cursor_p
;
18698 it
->avoid_cursor_p
= 1;
18699 saved_face_id
= it
->face_id
;
18700 /* The last row's stretch glyph should get the default
18701 face, to avoid painting the rest of the window with
18702 the region face, if the region ends at ZV. */
18703 if (it
->glyph_row
->ends_at_zv_p
)
18704 it
->face_id
= default_face
->id
;
18706 it
->face_id
= face
->id
;
18707 append_stretch_glyph (it
, make_number (0), stretch_width
,
18708 it
->ascent
+ it
->descent
, stretch_ascent
);
18709 it
->position
= saved_pos
;
18710 it
->avoid_cursor_p
= saved_avoid_cursor
;
18711 it
->face_id
= saved_face_id
;
18714 #endif /* HAVE_WINDOW_SYSTEM */
18718 /* Save some values that must not be changed. */
18719 int saved_x
= it
->current_x
;
18720 struct text_pos saved_pos
;
18721 Lisp_Object saved_object
;
18722 enum display_element_type saved_what
= it
->what
;
18723 int saved_face_id
= it
->face_id
;
18725 saved_object
= it
->object
;
18726 saved_pos
= it
->position
;
18728 it
->what
= IT_CHARACTER
;
18729 memset (&it
->position
, 0, sizeof it
->position
);
18730 it
->object
= make_number (0);
18731 it
->c
= it
->char_to_display
= ' ';
18733 /* The last row's blank glyphs should get the default face, to
18734 avoid painting the rest of the window with the region face,
18735 if the region ends at ZV. */
18736 if (it
->glyph_row
->ends_at_zv_p
)
18737 it
->face_id
= default_face
->id
;
18739 it
->face_id
= face
->id
;
18741 PRODUCE_GLYPHS (it
);
18743 while (it
->current_x
<= it
->last_visible_x
)
18744 PRODUCE_GLYPHS (it
);
18746 /* Don't count these blanks really. It would let us insert a left
18747 truncation glyph below and make us set the cursor on them, maybe. */
18748 it
->current_x
= saved_x
;
18749 it
->object
= saved_object
;
18750 it
->position
= saved_pos
;
18751 it
->what
= saved_what
;
18752 it
->face_id
= saved_face_id
;
18757 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18758 trailing whitespace. */
18761 trailing_whitespace_p (ptrdiff_t charpos
)
18763 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18766 while (bytepos
< ZV_BYTE
18767 && (c
= FETCH_CHAR (bytepos
),
18768 c
== ' ' || c
== '\t'))
18771 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18773 if (bytepos
!= PT_BYTE
)
18780 /* Highlight trailing whitespace, if any, in ROW. */
18783 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18785 int used
= row
->used
[TEXT_AREA
];
18789 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18790 struct glyph
*glyph
= start
+ used
- 1;
18792 if (row
->reversed_p
)
18794 /* Right-to-left rows need to be processed in the opposite
18795 direction, so swap the edge pointers. */
18797 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18800 /* Skip over glyphs inserted to display the cursor at the
18801 end of a line, for extending the face of the last glyph
18802 to the end of the line on terminals, and for truncation
18803 and continuation glyphs. */
18804 if (!row
->reversed_p
)
18806 while (glyph
>= start
18807 && glyph
->type
== CHAR_GLYPH
18808 && INTEGERP (glyph
->object
))
18813 while (glyph
<= start
18814 && glyph
->type
== CHAR_GLYPH
18815 && INTEGERP (glyph
->object
))
18819 /* If last glyph is a space or stretch, and it's trailing
18820 whitespace, set the face of all trailing whitespace glyphs in
18821 IT->glyph_row to `trailing-whitespace'. */
18822 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18823 && BUFFERP (glyph
->object
)
18824 && (glyph
->type
== STRETCH_GLYPH
18825 || (glyph
->type
== CHAR_GLYPH
18826 && glyph
->u
.ch
== ' '))
18827 && trailing_whitespace_p (glyph
->charpos
))
18829 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18833 if (!row
->reversed_p
)
18835 while (glyph
>= start
18836 && BUFFERP (glyph
->object
)
18837 && (glyph
->type
== STRETCH_GLYPH
18838 || (glyph
->type
== CHAR_GLYPH
18839 && glyph
->u
.ch
== ' ')))
18840 (glyph
--)->face_id
= face_id
;
18844 while (glyph
<= start
18845 && BUFFERP (glyph
->object
)
18846 && (glyph
->type
== STRETCH_GLYPH
18847 || (glyph
->type
== CHAR_GLYPH
18848 && glyph
->u
.ch
== ' ')))
18849 (glyph
++)->face_id
= face_id
;
18856 /* Value is non-zero if glyph row ROW should be
18857 used to hold the cursor. */
18860 cursor_row_p (struct glyph_row
*row
)
18864 if (PT
== CHARPOS (row
->end
.pos
)
18865 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18867 /* Suppose the row ends on a string.
18868 Unless the row is continued, that means it ends on a newline
18869 in the string. If it's anything other than a display string
18870 (e.g., a before-string from an overlay), we don't want the
18871 cursor there. (This heuristic seems to give the optimal
18872 behavior for the various types of multi-line strings.)
18873 One exception: if the string has `cursor' property on one of
18874 its characters, we _do_ want the cursor there. */
18875 if (CHARPOS (row
->end
.string_pos
) >= 0)
18877 if (row
->continued_p
)
18881 /* Check for `display' property. */
18882 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18883 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18884 struct glyph
*glyph
;
18887 for (glyph
= end
; glyph
>= beg
; --glyph
)
18888 if (STRINGP (glyph
->object
))
18891 = Fget_char_property (make_number (PT
),
18895 && display_prop_string_p (prop
, glyph
->object
));
18896 /* If there's a `cursor' property on one of the
18897 string's characters, this row is a cursor row,
18898 even though this is not a display string. */
18901 Lisp_Object s
= glyph
->object
;
18903 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18905 ptrdiff_t gpos
= glyph
->charpos
;
18907 if (!NILP (Fget_char_property (make_number (gpos
),
18919 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18921 /* If the row ends in middle of a real character,
18922 and the line is continued, we want the cursor here.
18923 That's because CHARPOS (ROW->end.pos) would equal
18924 PT if PT is before the character. */
18925 if (!row
->ends_in_ellipsis_p
)
18926 result
= row
->continued_p
;
18928 /* If the row ends in an ellipsis, then
18929 CHARPOS (ROW->end.pos) will equal point after the
18930 invisible text. We want that position to be displayed
18931 after the ellipsis. */
18934 /* If the row ends at ZV, display the cursor at the end of that
18935 row instead of at the start of the row below. */
18936 else if (row
->ends_at_zv_p
)
18947 /* Push the property PROP so that it will be rendered at the current
18948 position in IT. Return 1 if PROP was successfully pushed, 0
18949 otherwise. Called from handle_line_prefix to handle the
18950 `line-prefix' and `wrap-prefix' properties. */
18953 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18955 struct text_pos pos
=
18956 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18958 eassert (it
->method
== GET_FROM_BUFFER
18959 || it
->method
== GET_FROM_DISPLAY_VECTOR
18960 || it
->method
== GET_FROM_STRING
);
18962 /* We need to save the current buffer/string position, so it will be
18963 restored by pop_it, because iterate_out_of_display_property
18964 depends on that being set correctly, but some situations leave
18965 it->position not yet set when this function is called. */
18966 push_it (it
, &pos
);
18968 if (STRINGP (prop
))
18970 if (SCHARS (prop
) == 0)
18977 it
->string_from_prefix_prop_p
= 1;
18978 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18979 it
->current
.overlay_string_index
= -1;
18980 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18981 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18982 it
->method
= GET_FROM_STRING
;
18983 it
->stop_charpos
= 0;
18985 it
->base_level_stop
= 0;
18987 /* Force paragraph direction to be that of the parent
18989 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18990 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18992 it
->paragraph_embedding
= L2R
;
18994 /* Set up the bidi iterator for this display string. */
18997 it
->bidi_it
.string
.lstring
= it
->string
;
18998 it
->bidi_it
.string
.s
= NULL
;
18999 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19000 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19001 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19002 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19003 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19006 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19008 it
->method
= GET_FROM_STRETCH
;
19011 #ifdef HAVE_WINDOW_SYSTEM
19012 else if (IMAGEP (prop
))
19014 it
->what
= IT_IMAGE
;
19015 it
->image_id
= lookup_image (it
->f
, prop
);
19016 it
->method
= GET_FROM_IMAGE
;
19018 #endif /* HAVE_WINDOW_SYSTEM */
19021 pop_it (it
); /* bogus display property, give up */
19028 /* Return the character-property PROP at the current position in IT. */
19031 get_it_property (struct it
*it
, Lisp_Object prop
)
19033 Lisp_Object position
;
19035 if (STRINGP (it
->object
))
19036 position
= make_number (IT_STRING_CHARPOS (*it
));
19037 else if (BUFFERP (it
->object
))
19038 position
= make_number (IT_CHARPOS (*it
));
19042 return Fget_char_property (position
, prop
, it
->object
);
19045 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19048 handle_line_prefix (struct it
*it
)
19050 Lisp_Object prefix
;
19052 if (it
->continuation_lines_width
> 0)
19054 prefix
= get_it_property (it
, Qwrap_prefix
);
19056 prefix
= Vwrap_prefix
;
19060 prefix
= get_it_property (it
, Qline_prefix
);
19062 prefix
= Vline_prefix
;
19064 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19066 /* If the prefix is wider than the window, and we try to wrap
19067 it, it would acquire its own wrap prefix, and so on till the
19068 iterator stack overflows. So, don't wrap the prefix. */
19069 it
->line_wrap
= TRUNCATE
;
19070 it
->avoid_cursor_p
= 1;
19076 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19077 only for R2L lines from display_line and display_string, when they
19078 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19079 the line/string needs to be continued on the next glyph row. */
19081 unproduce_glyphs (struct it
*it
, int n
)
19083 struct glyph
*glyph
, *end
;
19085 eassert (it
->glyph_row
);
19086 eassert (it
->glyph_row
->reversed_p
);
19087 eassert (it
->area
== TEXT_AREA
);
19088 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19090 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19091 n
= it
->glyph_row
->used
[TEXT_AREA
];
19092 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19093 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19094 for ( ; glyph
< end
; glyph
++)
19095 glyph
[-n
] = *glyph
;
19098 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19099 and ROW->maxpos. */
19101 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19102 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19103 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19105 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19106 lines' rows is implemented for bidi-reordered rows. */
19108 /* ROW->minpos is the value of min_pos, the minimal buffer position
19109 we have in ROW, or ROW->start.pos if that is smaller. */
19110 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19111 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19113 /* We didn't find buffer positions smaller than ROW->start, or
19114 didn't find _any_ valid buffer positions in any of the glyphs,
19115 so we must trust the iterator's computed positions. */
19116 row
->minpos
= row
->start
.pos
;
19119 max_pos
= CHARPOS (it
->current
.pos
);
19120 max_bpos
= BYTEPOS (it
->current
.pos
);
19123 /* Here are the various use-cases for ending the row, and the
19124 corresponding values for ROW->maxpos:
19126 Line ends in a newline from buffer eol_pos + 1
19127 Line is continued from buffer max_pos + 1
19128 Line is truncated on right it->current.pos
19129 Line ends in a newline from string max_pos + 1(*)
19130 (*) + 1 only when line ends in a forward scan
19131 Line is continued from string max_pos
19132 Line is continued from display vector max_pos
19133 Line is entirely from a string min_pos == max_pos
19134 Line is entirely from a display vector min_pos == max_pos
19135 Line that ends at ZV ZV
19137 If you discover other use-cases, please add them here as
19139 if (row
->ends_at_zv_p
)
19140 row
->maxpos
= it
->current
.pos
;
19141 else if (row
->used
[TEXT_AREA
])
19143 int seen_this_string
= 0;
19144 struct glyph_row
*r1
= row
- 1;
19146 /* Did we see the same display string on the previous row? */
19147 if (STRINGP (it
->object
)
19148 /* this is not the first row */
19149 && row
> it
->w
->desired_matrix
->rows
19150 /* previous row is not the header line */
19151 && !r1
->mode_line_p
19152 /* previous row also ends in a newline from a string */
19153 && r1
->ends_in_newline_from_string_p
)
19155 struct glyph
*start
, *end
;
19157 /* Search for the last glyph of the previous row that came
19158 from buffer or string. Depending on whether the row is
19159 L2R or R2L, we need to process it front to back or the
19160 other way round. */
19161 if (!r1
->reversed_p
)
19163 start
= r1
->glyphs
[TEXT_AREA
];
19164 end
= start
+ r1
->used
[TEXT_AREA
];
19165 /* Glyphs inserted by redisplay have an integer (zero)
19166 as their object. */
19168 && INTEGERP ((end
- 1)->object
)
19169 && (end
- 1)->charpos
<= 0)
19173 if (EQ ((end
- 1)->object
, it
->object
))
19174 seen_this_string
= 1;
19177 /* If all the glyphs of the previous row were inserted
19178 by redisplay, it means the previous row was
19179 produced from a single newline, which is only
19180 possible if that newline came from the same string
19181 as the one which produced this ROW. */
19182 seen_this_string
= 1;
19186 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19187 start
= end
+ r1
->used
[TEXT_AREA
];
19189 && INTEGERP ((end
+ 1)->object
)
19190 && (end
+ 1)->charpos
<= 0)
19194 if (EQ ((end
+ 1)->object
, it
->object
))
19195 seen_this_string
= 1;
19198 seen_this_string
= 1;
19201 /* Take note of each display string that covers a newline only
19202 once, the first time we see it. This is for when a display
19203 string includes more than one newline in it. */
19204 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19206 /* If we were scanning the buffer forward when we displayed
19207 the string, we want to account for at least one buffer
19208 position that belongs to this row (position covered by
19209 the display string), so that cursor positioning will
19210 consider this row as a candidate when point is at the end
19211 of the visual line represented by this row. This is not
19212 required when scanning back, because max_pos will already
19213 have a much larger value. */
19214 if (CHARPOS (row
->end
.pos
) > max_pos
)
19215 INC_BOTH (max_pos
, max_bpos
);
19216 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19218 else if (CHARPOS (it
->eol_pos
) > 0)
19219 SET_TEXT_POS (row
->maxpos
,
19220 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19221 else if (row
->continued_p
)
19223 /* If max_pos is different from IT's current position, it
19224 means IT->method does not belong to the display element
19225 at max_pos. However, it also means that the display
19226 element at max_pos was displayed in its entirety on this
19227 line, which is equivalent to saying that the next line
19228 starts at the next buffer position. */
19229 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19230 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19233 INC_BOTH (max_pos
, max_bpos
);
19234 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19237 else if (row
->truncated_on_right_p
)
19238 /* display_line already called reseat_at_next_visible_line_start,
19239 which puts the iterator at the beginning of the next line, in
19240 the logical order. */
19241 row
->maxpos
= it
->current
.pos
;
19242 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19243 /* A line that is entirely from a string/image/stretch... */
19244 row
->maxpos
= row
->minpos
;
19249 row
->maxpos
= it
->current
.pos
;
19252 /* Construct the glyph row IT->glyph_row in the desired matrix of
19253 IT->w from text at the current position of IT. See dispextern.h
19254 for an overview of struct it. Value is non-zero if
19255 IT->glyph_row displays text, as opposed to a line displaying ZV
19259 display_line (struct it
*it
)
19261 struct glyph_row
*row
= it
->glyph_row
;
19262 Lisp_Object overlay_arrow_string
;
19264 void *wrap_data
= NULL
;
19265 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19266 int wrap_row_used
= -1;
19267 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19268 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19269 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19270 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19271 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19273 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19274 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19276 /* We always start displaying at hpos zero even if hscrolled. */
19277 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19279 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19280 >= it
->w
->desired_matrix
->nrows
)
19282 it
->w
->nrows_scale_factor
++;
19283 fonts_changed_p
= 1;
19287 /* Is IT->w showing the region? */
19288 wset_region_showing (it
->w
, it
->region_beg_charpos
> 0 ? Qt
: Qnil
);
19290 /* Clear the result glyph row and enable it. */
19291 prepare_desired_row (row
);
19293 row
->y
= it
->current_y
;
19294 row
->start
= it
->start
;
19295 row
->continuation_lines_width
= it
->continuation_lines_width
;
19296 row
->displays_text_p
= 1;
19297 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19298 it
->starts_in_middle_of_char_p
= 0;
19300 /* Arrange the overlays nicely for our purposes. Usually, we call
19301 display_line on only one line at a time, in which case this
19302 can't really hurt too much, or we call it on lines which appear
19303 one after another in the buffer, in which case all calls to
19304 recenter_overlay_lists but the first will be pretty cheap. */
19305 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19307 /* Move over display elements that are not visible because we are
19308 hscrolled. This may stop at an x-position < IT->first_visible_x
19309 if the first glyph is partially visible or if we hit a line end. */
19310 if (it
->current_x
< it
->first_visible_x
)
19312 enum move_it_result move_result
;
19314 this_line_min_pos
= row
->start
.pos
;
19315 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19316 MOVE_TO_POS
| MOVE_TO_X
);
19317 /* If we are under a large hscroll, move_it_in_display_line_to
19318 could hit the end of the line without reaching
19319 it->first_visible_x. Pretend that we did reach it. This is
19320 especially important on a TTY, where we will call
19321 extend_face_to_end_of_line, which needs to know how many
19322 blank glyphs to produce. */
19323 if (it
->current_x
< it
->first_visible_x
19324 && (move_result
== MOVE_NEWLINE_OR_CR
19325 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19326 it
->current_x
= it
->first_visible_x
;
19328 /* Record the smallest positions seen while we moved over
19329 display elements that are not visible. This is needed by
19330 redisplay_internal for optimizing the case where the cursor
19331 stays inside the same line. The rest of this function only
19332 considers positions that are actually displayed, so
19333 RECORD_MAX_MIN_POS will not otherwise record positions that
19334 are hscrolled to the left of the left edge of the window. */
19335 min_pos
= CHARPOS (this_line_min_pos
);
19336 min_bpos
= BYTEPOS (this_line_min_pos
);
19340 /* We only do this when not calling `move_it_in_display_line_to'
19341 above, because move_it_in_display_line_to calls
19342 handle_line_prefix itself. */
19343 handle_line_prefix (it
);
19346 /* Get the initial row height. This is either the height of the
19347 text hscrolled, if there is any, or zero. */
19348 row
->ascent
= it
->max_ascent
;
19349 row
->height
= it
->max_ascent
+ it
->max_descent
;
19350 row
->phys_ascent
= it
->max_phys_ascent
;
19351 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19352 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19354 /* Utility macro to record max and min buffer positions seen until now. */
19355 #define RECORD_MAX_MIN_POS(IT) \
19358 int composition_p = !STRINGP ((IT)->string) \
19359 && ((IT)->what == IT_COMPOSITION); \
19360 ptrdiff_t current_pos = \
19361 composition_p ? (IT)->cmp_it.charpos \
19362 : IT_CHARPOS (*(IT)); \
19363 ptrdiff_t current_bpos = \
19364 composition_p ? CHAR_TO_BYTE (current_pos) \
19365 : IT_BYTEPOS (*(IT)); \
19366 if (current_pos < min_pos) \
19368 min_pos = current_pos; \
19369 min_bpos = current_bpos; \
19371 if (IT_CHARPOS (*it) > max_pos) \
19373 max_pos = IT_CHARPOS (*it); \
19374 max_bpos = IT_BYTEPOS (*it); \
19379 /* Loop generating characters. The loop is left with IT on the next
19380 character to display. */
19383 int n_glyphs_before
, hpos_before
, x_before
;
19385 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19387 /* Retrieve the next thing to display. Value is zero if end of
19389 if (!get_next_display_element (it
))
19391 /* Maybe add a space at the end of this line that is used to
19392 display the cursor there under X. Set the charpos of the
19393 first glyph of blank lines not corresponding to any text
19395 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19396 row
->exact_window_width_line_p
= 1;
19397 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19398 || row
->used
[TEXT_AREA
] == 0)
19400 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19401 row
->displays_text_p
= 0;
19403 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19404 && (!MINI_WINDOW_P (it
->w
)
19405 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19406 row
->indicate_empty_line_p
= 1;
19409 it
->continuation_lines_width
= 0;
19410 row
->ends_at_zv_p
= 1;
19411 /* A row that displays right-to-left text must always have
19412 its last face extended all the way to the end of line,
19413 even if this row ends in ZV, because we still write to
19414 the screen left to right. We also need to extend the
19415 last face if the default face is remapped to some
19416 different face, otherwise the functions that clear
19417 portions of the screen will clear with the default face's
19418 background color. */
19419 if (row
->reversed_p
19420 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19421 extend_face_to_end_of_line (it
);
19425 /* Now, get the metrics of what we want to display. This also
19426 generates glyphs in `row' (which is IT->glyph_row). */
19427 n_glyphs_before
= row
->used
[TEXT_AREA
];
19430 /* Remember the line height so far in case the next element doesn't
19431 fit on the line. */
19432 if (it
->line_wrap
!= TRUNCATE
)
19434 ascent
= it
->max_ascent
;
19435 descent
= it
->max_descent
;
19436 phys_ascent
= it
->max_phys_ascent
;
19437 phys_descent
= it
->max_phys_descent
;
19439 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19441 if (IT_DISPLAYING_WHITESPACE (it
))
19445 SAVE_IT (wrap_it
, *it
, wrap_data
);
19447 wrap_row_used
= row
->used
[TEXT_AREA
];
19448 wrap_row_ascent
= row
->ascent
;
19449 wrap_row_height
= row
->height
;
19450 wrap_row_phys_ascent
= row
->phys_ascent
;
19451 wrap_row_phys_height
= row
->phys_height
;
19452 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19453 wrap_row_min_pos
= min_pos
;
19454 wrap_row_min_bpos
= min_bpos
;
19455 wrap_row_max_pos
= max_pos
;
19456 wrap_row_max_bpos
= max_bpos
;
19462 PRODUCE_GLYPHS (it
);
19464 /* If this display element was in marginal areas, continue with
19466 if (it
->area
!= TEXT_AREA
)
19468 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19469 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19470 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19471 row
->phys_height
= max (row
->phys_height
,
19472 it
->max_phys_ascent
+ it
->max_phys_descent
);
19473 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19474 it
->max_extra_line_spacing
);
19475 set_iterator_to_next (it
, 1);
19479 /* Does the display element fit on the line? If we truncate
19480 lines, we should draw past the right edge of the window. If
19481 we don't truncate, we want to stop so that we can display the
19482 continuation glyph before the right margin. If lines are
19483 continued, there are two possible strategies for characters
19484 resulting in more than 1 glyph (e.g. tabs): Display as many
19485 glyphs as possible in this line and leave the rest for the
19486 continuation line, or display the whole element in the next
19487 line. Original redisplay did the former, so we do it also. */
19488 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19489 hpos_before
= it
->hpos
;
19492 if (/* Not a newline. */
19494 /* Glyphs produced fit entirely in the line. */
19495 && it
->current_x
< it
->last_visible_x
)
19497 it
->hpos
+= nglyphs
;
19498 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19499 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19500 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19501 row
->phys_height
= max (row
->phys_height
,
19502 it
->max_phys_ascent
+ it
->max_phys_descent
);
19503 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19504 it
->max_extra_line_spacing
);
19505 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19506 row
->x
= x
- it
->first_visible_x
;
19507 /* Record the maximum and minimum buffer positions seen so
19508 far in glyphs that will be displayed by this row. */
19510 RECORD_MAX_MIN_POS (it
);
19515 struct glyph
*glyph
;
19517 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19519 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19520 new_x
= x
+ glyph
->pixel_width
;
19522 if (/* Lines are continued. */
19523 it
->line_wrap
!= TRUNCATE
19524 && (/* Glyph doesn't fit on the line. */
19525 new_x
> it
->last_visible_x
19526 /* Or it fits exactly on a window system frame. */
19527 || (new_x
== it
->last_visible_x
19528 && FRAME_WINDOW_P (it
->f
)
19529 && (row
->reversed_p
19530 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19531 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19533 /* End of a continued line. */
19536 || (new_x
== it
->last_visible_x
19537 && FRAME_WINDOW_P (it
->f
)
19538 && (row
->reversed_p
19539 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19540 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19542 /* Current glyph is the only one on the line or
19543 fits exactly on the line. We must continue
19544 the line because we can't draw the cursor
19545 after the glyph. */
19546 row
->continued_p
= 1;
19547 it
->current_x
= new_x
;
19548 it
->continuation_lines_width
+= new_x
;
19550 if (i
== nglyphs
- 1)
19552 /* If line-wrap is on, check if a previous
19553 wrap point was found. */
19554 if (wrap_row_used
> 0
19555 /* Even if there is a previous wrap
19556 point, continue the line here as
19557 usual, if (i) the previous character
19558 was a space or tab AND (ii) the
19559 current character is not. */
19561 || IT_DISPLAYING_WHITESPACE (it
)))
19564 /* Record the maximum and minimum buffer
19565 positions seen so far in glyphs that will be
19566 displayed by this row. */
19568 RECORD_MAX_MIN_POS (it
);
19569 set_iterator_to_next (it
, 1);
19570 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19572 if (!get_next_display_element (it
))
19574 row
->exact_window_width_line_p
= 1;
19575 it
->continuation_lines_width
= 0;
19576 row
->continued_p
= 0;
19577 row
->ends_at_zv_p
= 1;
19579 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19581 row
->continued_p
= 0;
19582 row
->exact_window_width_line_p
= 1;
19586 else if (it
->bidi_p
)
19587 RECORD_MAX_MIN_POS (it
);
19589 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19590 && !FRAME_WINDOW_P (it
->f
))
19592 /* A padding glyph that doesn't fit on this line.
19593 This means the whole character doesn't fit
19595 if (row
->reversed_p
)
19596 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19597 - n_glyphs_before
);
19598 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19600 /* Fill the rest of the row with continuation
19601 glyphs like in 20.x. */
19602 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19603 < row
->glyphs
[1 + TEXT_AREA
])
19604 produce_special_glyphs (it
, IT_CONTINUATION
);
19606 row
->continued_p
= 1;
19607 it
->current_x
= x_before
;
19608 it
->continuation_lines_width
+= x_before
;
19610 /* Restore the height to what it was before the
19611 element not fitting on the line. */
19612 it
->max_ascent
= ascent
;
19613 it
->max_descent
= descent
;
19614 it
->max_phys_ascent
= phys_ascent
;
19615 it
->max_phys_descent
= phys_descent
;
19617 else if (wrap_row_used
> 0)
19620 if (row
->reversed_p
)
19621 unproduce_glyphs (it
,
19622 row
->used
[TEXT_AREA
] - wrap_row_used
);
19623 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19624 it
->continuation_lines_width
+= wrap_x
;
19625 row
->used
[TEXT_AREA
] = wrap_row_used
;
19626 row
->ascent
= wrap_row_ascent
;
19627 row
->height
= wrap_row_height
;
19628 row
->phys_ascent
= wrap_row_phys_ascent
;
19629 row
->phys_height
= wrap_row_phys_height
;
19630 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19631 min_pos
= wrap_row_min_pos
;
19632 min_bpos
= wrap_row_min_bpos
;
19633 max_pos
= wrap_row_max_pos
;
19634 max_bpos
= wrap_row_max_bpos
;
19635 row
->continued_p
= 1;
19636 row
->ends_at_zv_p
= 0;
19637 row
->exact_window_width_line_p
= 0;
19638 it
->continuation_lines_width
+= x
;
19640 /* Make sure that a non-default face is extended
19641 up to the right margin of the window. */
19642 extend_face_to_end_of_line (it
);
19644 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19646 /* A TAB that extends past the right edge of the
19647 window. This produces a single glyph on
19648 window system frames. We leave the glyph in
19649 this row and let it fill the row, but don't
19650 consume the TAB. */
19651 if ((row
->reversed_p
19652 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19653 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19654 produce_special_glyphs (it
, IT_CONTINUATION
);
19655 it
->continuation_lines_width
+= it
->last_visible_x
;
19656 row
->ends_in_middle_of_char_p
= 1;
19657 row
->continued_p
= 1;
19658 glyph
->pixel_width
= it
->last_visible_x
- x
;
19659 it
->starts_in_middle_of_char_p
= 1;
19663 /* Something other than a TAB that draws past
19664 the right edge of the window. Restore
19665 positions to values before the element. */
19666 if (row
->reversed_p
)
19667 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19668 - (n_glyphs_before
+ i
));
19669 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19671 /* Display continuation glyphs. */
19672 it
->current_x
= x_before
;
19673 it
->continuation_lines_width
+= x
;
19674 if (!FRAME_WINDOW_P (it
->f
)
19675 || (row
->reversed_p
19676 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19677 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19678 produce_special_glyphs (it
, IT_CONTINUATION
);
19679 row
->continued_p
= 1;
19681 extend_face_to_end_of_line (it
);
19683 if (nglyphs
> 1 && i
> 0)
19685 row
->ends_in_middle_of_char_p
= 1;
19686 it
->starts_in_middle_of_char_p
= 1;
19689 /* Restore the height to what it was before the
19690 element not fitting on the line. */
19691 it
->max_ascent
= ascent
;
19692 it
->max_descent
= descent
;
19693 it
->max_phys_ascent
= phys_ascent
;
19694 it
->max_phys_descent
= phys_descent
;
19699 else if (new_x
> it
->first_visible_x
)
19701 /* Increment number of glyphs actually displayed. */
19704 /* Record the maximum and minimum buffer positions
19705 seen so far in glyphs that will be displayed by
19708 RECORD_MAX_MIN_POS (it
);
19710 if (x
< it
->first_visible_x
)
19711 /* Glyph is partially visible, i.e. row starts at
19712 negative X position. */
19713 row
->x
= x
- it
->first_visible_x
;
19717 /* Glyph is completely off the left margin of the
19718 window. This should not happen because of the
19719 move_it_in_display_line at the start of this
19720 function, unless the text display area of the
19721 window is empty. */
19722 eassert (it
->first_visible_x
<= it
->last_visible_x
);
19725 /* Even if this display element produced no glyphs at all,
19726 we want to record its position. */
19727 if (it
->bidi_p
&& nglyphs
== 0)
19728 RECORD_MAX_MIN_POS (it
);
19730 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19731 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19732 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19733 row
->phys_height
= max (row
->phys_height
,
19734 it
->max_phys_ascent
+ it
->max_phys_descent
);
19735 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19736 it
->max_extra_line_spacing
);
19738 /* End of this display line if row is continued. */
19739 if (row
->continued_p
|| row
->ends_at_zv_p
)
19744 /* Is this a line end? If yes, we're also done, after making
19745 sure that a non-default face is extended up to the right
19746 margin of the window. */
19747 if (ITERATOR_AT_END_OF_LINE_P (it
))
19749 int used_before
= row
->used
[TEXT_AREA
];
19751 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19753 /* Add a space at the end of the line that is used to
19754 display the cursor there. */
19755 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19756 append_space_for_newline (it
, 0);
19758 /* Extend the face to the end of the line. */
19759 extend_face_to_end_of_line (it
);
19761 /* Make sure we have the position. */
19762 if (used_before
== 0)
19763 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19765 /* Record the position of the newline, for use in
19767 it
->eol_pos
= it
->current
.pos
;
19769 /* Consume the line end. This skips over invisible lines. */
19770 set_iterator_to_next (it
, 1);
19771 it
->continuation_lines_width
= 0;
19775 /* Proceed with next display element. Note that this skips
19776 over lines invisible because of selective display. */
19777 set_iterator_to_next (it
, 1);
19779 /* If we truncate lines, we are done when the last displayed
19780 glyphs reach past the right margin of the window. */
19781 if (it
->line_wrap
== TRUNCATE
19782 && (FRAME_WINDOW_P (it
->f
) && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19783 ? (it
->current_x
>= it
->last_visible_x
)
19784 : (it
->current_x
> it
->last_visible_x
)))
19786 /* Maybe add truncation glyphs. */
19787 if (!FRAME_WINDOW_P (it
->f
)
19788 || (row
->reversed_p
19789 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19790 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19794 if (!row
->reversed_p
)
19796 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19797 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19802 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19803 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19805 /* Remove any padding glyphs at the front of ROW, to
19806 make room for the truncation glyphs we will be
19807 adding below. The loop below always inserts at
19808 least one truncation glyph, so also remove the
19809 last glyph added to ROW. */
19810 unproduce_glyphs (it
, i
+ 1);
19811 /* Adjust i for the loop below. */
19812 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19815 it
->current_x
= x_before
;
19816 if (!FRAME_WINDOW_P (it
->f
))
19818 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19820 row
->used
[TEXT_AREA
] = i
;
19821 produce_special_glyphs (it
, IT_TRUNCATION
);
19826 row
->used
[TEXT_AREA
] = i
;
19827 produce_special_glyphs (it
, IT_TRUNCATION
);
19830 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19832 /* Don't truncate if we can overflow newline into fringe. */
19833 if (!get_next_display_element (it
))
19835 it
->continuation_lines_width
= 0;
19836 row
->ends_at_zv_p
= 1;
19837 row
->exact_window_width_line_p
= 1;
19840 if (ITERATOR_AT_END_OF_LINE_P (it
))
19842 row
->exact_window_width_line_p
= 1;
19843 goto at_end_of_line
;
19845 it
->current_x
= x_before
;
19848 row
->truncated_on_right_p
= 1;
19849 it
->continuation_lines_width
= 0;
19850 reseat_at_next_visible_line_start (it
, 0);
19851 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19852 it
->hpos
= hpos_before
;
19858 bidi_unshelve_cache (wrap_data
, 1);
19860 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19861 at the left window margin. */
19862 if (it
->first_visible_x
19863 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19865 if (!FRAME_WINDOW_P (it
->f
)
19866 || (row
->reversed_p
19867 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19868 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
19869 insert_left_trunc_glyphs (it
);
19870 row
->truncated_on_left_p
= 1;
19873 /* Remember the position at which this line ends.
19875 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19876 cannot be before the call to find_row_edges below, since that is
19877 where these positions are determined. */
19878 row
->end
= it
->current
;
19881 row
->minpos
= row
->start
.pos
;
19882 row
->maxpos
= row
->end
.pos
;
19886 /* ROW->minpos and ROW->maxpos must be the smallest and
19887 `1 + the largest' buffer positions in ROW. But if ROW was
19888 bidi-reordered, these two positions can be anywhere in the
19889 row, so we must determine them now. */
19890 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19893 /* If the start of this line is the overlay arrow-position, then
19894 mark this glyph row as the one containing the overlay arrow.
19895 This is clearly a mess with variable size fonts. It would be
19896 better to let it be displayed like cursors under X. */
19897 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19898 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19899 !NILP (overlay_arrow_string
)))
19901 /* Overlay arrow in window redisplay is a fringe bitmap. */
19902 if (STRINGP (overlay_arrow_string
))
19904 struct glyph_row
*arrow_row
19905 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19906 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19907 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19908 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19909 struct glyph
*p2
, *end
;
19911 /* Copy the arrow glyphs. */
19912 while (glyph
< arrow_end
)
19915 /* Throw away padding glyphs. */
19917 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19918 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19924 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19929 eassert (INTEGERP (overlay_arrow_string
));
19930 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19932 overlay_arrow_seen
= 1;
19935 /* Highlight trailing whitespace. */
19936 if (!NILP (Vshow_trailing_whitespace
))
19937 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19939 /* Compute pixel dimensions of this line. */
19940 compute_line_metrics (it
);
19942 /* Implementation note: No changes in the glyphs of ROW or in their
19943 faces can be done past this point, because compute_line_metrics
19944 computes ROW's hash value and stores it within the glyph_row
19947 /* Record whether this row ends inside an ellipsis. */
19948 row
->ends_in_ellipsis_p
19949 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19950 && it
->ellipsis_p
);
19952 /* Save fringe bitmaps in this row. */
19953 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19954 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19955 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19956 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19958 it
->left_user_fringe_bitmap
= 0;
19959 it
->left_user_fringe_face_id
= 0;
19960 it
->right_user_fringe_bitmap
= 0;
19961 it
->right_user_fringe_face_id
= 0;
19963 /* Maybe set the cursor. */
19964 cvpos
= it
->w
->cursor
.vpos
;
19966 /* In bidi-reordered rows, keep checking for proper cursor
19967 position even if one has been found already, because buffer
19968 positions in such rows change non-linearly with ROW->VPOS,
19969 when a line is continued. One exception: when we are at ZV,
19970 display cursor on the first suitable glyph row, since all
19971 the empty rows after that also have their position set to ZV. */
19972 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19973 lines' rows is implemented for bidi-reordered rows. */
19975 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19976 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19977 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19978 && cursor_row_p (row
))
19979 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19981 /* Prepare for the next line. This line starts horizontally at (X
19982 HPOS) = (0 0). Vertical positions are incremented. As a
19983 convenience for the caller, IT->glyph_row is set to the next
19985 it
->current_x
= it
->hpos
= 0;
19986 it
->current_y
+= row
->height
;
19987 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19990 /* The next row should by default use the same value of the
19991 reversed_p flag as this one. set_iterator_to_next decides when
19992 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19993 the flag accordingly. */
19994 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19995 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19996 it
->start
= row
->end
;
19997 return row
->displays_text_p
;
19999 #undef RECORD_MAX_MIN_POS
20002 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20003 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20004 doc
: /* Return paragraph direction at point in BUFFER.
20005 Value is either `left-to-right' or `right-to-left'.
20006 If BUFFER is omitted or nil, it defaults to the current buffer.
20008 Paragraph direction determines how the text in the paragraph is displayed.
20009 In left-to-right paragraphs, text begins at the left margin of the window
20010 and the reading direction is generally left to right. In right-to-left
20011 paragraphs, text begins at the right margin and is read from right to left.
20013 See also `bidi-paragraph-direction'. */)
20014 (Lisp_Object buffer
)
20016 struct buffer
*buf
= current_buffer
;
20017 struct buffer
*old
= buf
;
20019 if (! NILP (buffer
))
20021 CHECK_BUFFER (buffer
);
20022 buf
= XBUFFER (buffer
);
20025 if (NILP (BVAR (buf
, bidi_display_reordering
))
20026 || NILP (BVAR (buf
, enable_multibyte_characters
))
20027 /* When we are loading loadup.el, the character property tables
20028 needed for bidi iteration are not yet available. */
20029 || !NILP (Vpurify_flag
))
20030 return Qleft_to_right
;
20031 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20032 return BVAR (buf
, bidi_paragraph_direction
);
20035 /* Determine the direction from buffer text. We could try to
20036 use current_matrix if it is up to date, but this seems fast
20037 enough as it is. */
20038 struct bidi_it itb
;
20039 ptrdiff_t pos
= BUF_PT (buf
);
20040 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20042 void *itb_data
= bidi_shelve_cache ();
20044 set_buffer_temp (buf
);
20045 /* bidi_paragraph_init finds the base direction of the paragraph
20046 by searching forward from paragraph start. We need the base
20047 direction of the current or _previous_ paragraph, so we need
20048 to make sure we are within that paragraph. To that end, find
20049 the previous non-empty line. */
20050 if (pos
>= ZV
&& pos
> BEGV
)
20053 bytepos
= CHAR_TO_BYTE (pos
);
20055 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20056 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20058 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20059 || c
== ' ' || c
== '\t' || c
== '\f')
20061 if (bytepos
<= BEGV_BYTE
)
20066 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20069 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20070 itb
.paragraph_dir
= NEUTRAL_DIR
;
20071 itb
.string
.s
= NULL
;
20072 itb
.string
.lstring
= Qnil
;
20073 itb
.string
.bufpos
= 0;
20074 itb
.string
.unibyte
= 0;
20075 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20076 bidi_unshelve_cache (itb_data
, 0);
20077 set_buffer_temp (old
);
20078 switch (itb
.paragraph_dir
)
20081 return Qleft_to_right
;
20084 return Qright_to_left
;
20094 /***********************************************************************
20096 ***********************************************************************/
20098 /* Redisplay the menu bar in the frame for window W.
20100 The menu bar of X frames that don't have X toolkit support is
20101 displayed in a special window W->frame->menu_bar_window.
20103 The menu bar of terminal frames is treated specially as far as
20104 glyph matrices are concerned. Menu bar lines are not part of
20105 windows, so the update is done directly on the frame matrix rows
20106 for the menu bar. */
20109 display_menu_bar (struct window
*w
)
20111 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20116 /* Don't do all this for graphical frames. */
20118 if (FRAME_W32_P (f
))
20121 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
20127 if (FRAME_NS_P (f
))
20129 #endif /* HAVE_NS */
20131 #ifdef USE_X_TOOLKIT
20132 eassert (!FRAME_WINDOW_P (f
));
20133 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
20134 it
.first_visible_x
= 0;
20135 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20136 #else /* not USE_X_TOOLKIT */
20137 if (FRAME_WINDOW_P (f
))
20139 /* Menu bar lines are displayed in the desired matrix of the
20140 dummy window menu_bar_window. */
20141 struct window
*menu_w
;
20142 eassert (WINDOWP (f
->menu_bar_window
));
20143 menu_w
= XWINDOW (f
->menu_bar_window
);
20144 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
20146 it
.first_visible_x
= 0;
20147 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20151 /* This is a TTY frame, i.e. character hpos/vpos are used as
20153 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
20155 it
.first_visible_x
= 0;
20156 it
.last_visible_x
= FRAME_COLS (f
);
20158 #endif /* not USE_X_TOOLKIT */
20160 /* FIXME: This should be controlled by a user option. See the
20161 comments in redisplay_tool_bar and display_mode_line about
20163 it
.paragraph_embedding
= L2R
;
20165 if (! mode_line_inverse_video
)
20166 /* Force the menu-bar to be displayed in the default face. */
20167 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
20169 /* Clear all rows of the menu bar. */
20170 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
20172 struct glyph_row
*row
= it
.glyph_row
+ i
;
20173 clear_glyph_row (row
);
20174 row
->enabled_p
= 1;
20175 row
->full_width_p
= 1;
20178 /* Display all items of the menu bar. */
20179 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
20180 for (i
= 0; i
< ASIZE (items
); i
+= 4)
20182 Lisp_Object string
;
20184 /* Stop at nil string. */
20185 string
= AREF (items
, i
+ 1);
20189 /* Remember where item was displayed. */
20190 ASET (items
, i
+ 3, make_number (it
.hpos
));
20192 /* Display the item, pad with one space. */
20193 if (it
.current_x
< it
.last_visible_x
)
20194 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
20195 SCHARS (string
) + 1, 0, 0, -1);
20198 /* Fill out the line with spaces. */
20199 if (it
.current_x
< it
.last_visible_x
)
20200 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
20202 /* Compute the total height of the lines. */
20203 compute_line_metrics (&it
);
20208 /***********************************************************************
20210 ***********************************************************************/
20212 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20213 FORCE is non-zero, redisplay mode lines unconditionally.
20214 Otherwise, redisplay only mode lines that are garbaged. Value is
20215 the number of windows whose mode lines were redisplayed. */
20218 redisplay_mode_lines (Lisp_Object window
, int force
)
20222 while (!NILP (window
))
20224 struct window
*w
= XWINDOW (window
);
20226 if (WINDOWP (w
->hchild
))
20227 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
20228 else if (WINDOWP (w
->vchild
))
20229 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
20231 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20232 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20234 struct text_pos lpoint
;
20235 struct buffer
*old
= current_buffer
;
20237 /* Set the window's buffer for the mode line display. */
20238 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20239 set_buffer_internal_1 (XBUFFER (w
->buffer
));
20241 /* Point refers normally to the selected window. For any
20242 other window, set up appropriate value. */
20243 if (!EQ (window
, selected_window
))
20245 struct text_pos pt
;
20247 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20248 if (CHARPOS (pt
) < BEGV
)
20249 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
20250 else if (CHARPOS (pt
) > (ZV
- 1))
20251 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
20253 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20256 /* Display mode lines. */
20257 clear_glyph_matrix (w
->desired_matrix
);
20258 if (display_mode_lines (w
))
20261 w
->must_be_updated_p
= 1;
20264 /* Restore old settings. */
20265 set_buffer_internal_1 (old
);
20266 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20276 /* Display the mode and/or header line of window W. Value is the
20277 sum number of mode lines and header lines displayed. */
20280 display_mode_lines (struct window
*w
)
20282 Lisp_Object old_selected_window
, old_selected_frame
;
20285 old_selected_frame
= selected_frame
;
20286 selected_frame
= w
->frame
;
20287 old_selected_window
= selected_window
;
20288 XSETWINDOW (selected_window
, w
);
20290 /* These will be set while the mode line specs are processed. */
20291 line_number_displayed
= 0;
20292 wset_column_number_displayed (w
, Qnil
);
20294 if (WINDOW_WANTS_MODELINE_P (w
))
20296 struct window
*sel_w
= XWINDOW (old_selected_window
);
20298 /* Select mode line face based on the real selected window. */
20299 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20300 BVAR (current_buffer
, mode_line_format
));
20304 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20306 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20307 BVAR (current_buffer
, header_line_format
));
20311 selected_frame
= old_selected_frame
;
20312 selected_window
= old_selected_window
;
20317 /* Display mode or header line of window W. FACE_ID specifies which
20318 line to display; it is either MODE_LINE_FACE_ID or
20319 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20320 display. Value is the pixel height of the mode/header line
20324 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20328 ptrdiff_t count
= SPECPDL_INDEX ();
20330 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20331 /* Don't extend on a previously drawn mode-line.
20332 This may happen if called from pos_visible_p. */
20333 it
.glyph_row
->enabled_p
= 0;
20334 prepare_desired_row (it
.glyph_row
);
20336 it
.glyph_row
->mode_line_p
= 1;
20338 if (! mode_line_inverse_video
)
20339 /* Force the mode-line to be displayed in the default face. */
20340 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
20342 /* FIXME: This should be controlled by a user option. But
20343 supporting such an option is not trivial, since the mode line is
20344 made up of many separate strings. */
20345 it
.paragraph_embedding
= L2R
;
20347 record_unwind_protect (unwind_format_mode_line
,
20348 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
20350 mode_line_target
= MODE_LINE_DISPLAY
;
20352 /* Temporarily make frame's keyboard the current kboard so that
20353 kboard-local variables in the mode_line_format will get the right
20355 push_kboard (FRAME_KBOARD (it
.f
));
20356 record_unwind_save_match_data ();
20357 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20360 unbind_to (count
, Qnil
);
20362 /* Fill up with spaces. */
20363 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20365 compute_line_metrics (&it
);
20366 it
.glyph_row
->full_width_p
= 1;
20367 it
.glyph_row
->continued_p
= 0;
20368 it
.glyph_row
->truncated_on_left_p
= 0;
20369 it
.glyph_row
->truncated_on_right_p
= 0;
20371 /* Make a 3D mode-line have a shadow at its right end. */
20372 face
= FACE_FROM_ID (it
.f
, face_id
);
20373 extend_face_to_end_of_line (&it
);
20374 if (face
->box
!= FACE_NO_BOX
)
20376 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20377 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20378 last
->right_box_line_p
= 1;
20381 return it
.glyph_row
->height
;
20384 /* Move element ELT in LIST to the front of LIST.
20385 Return the updated list. */
20388 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20390 register Lisp_Object tail
, prev
;
20391 register Lisp_Object tem
;
20395 while (CONSP (tail
))
20401 /* Splice out the link TAIL. */
20403 list
= XCDR (tail
);
20405 Fsetcdr (prev
, XCDR (tail
));
20407 /* Now make it the first. */
20408 Fsetcdr (tail
, list
);
20413 tail
= XCDR (tail
);
20417 /* Not found--return unchanged LIST. */
20421 /* Contribute ELT to the mode line for window IT->w. How it
20422 translates into text depends on its data type.
20424 IT describes the display environment in which we display, as usual.
20426 DEPTH is the depth in recursion. It is used to prevent
20427 infinite recursion here.
20429 FIELD_WIDTH is the number of characters the display of ELT should
20430 occupy in the mode line, and PRECISION is the maximum number of
20431 characters to display from ELT's representation. See
20432 display_string for details.
20434 Returns the hpos of the end of the text generated by ELT.
20436 PROPS is a property list to add to any string we encounter.
20438 If RISKY is nonzero, remove (disregard) any properties in any string
20439 we encounter, and ignore :eval and :propertize.
20441 The global variable `mode_line_target' determines whether the
20442 output is passed to `store_mode_line_noprop',
20443 `store_mode_line_string', or `display_string'. */
20446 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20447 Lisp_Object elt
, Lisp_Object props
, int risky
)
20449 int n
= 0, field
, prec
;
20454 elt
= build_string ("*too-deep*");
20458 switch (XTYPE (elt
))
20462 /* A string: output it and check for %-constructs within it. */
20464 ptrdiff_t offset
= 0;
20466 if (SCHARS (elt
) > 0
20467 && (!NILP (props
) || risky
))
20469 Lisp_Object oprops
, aelt
;
20470 oprops
= Ftext_properties_at (make_number (0), elt
);
20472 /* If the starting string's properties are not what
20473 we want, translate the string. Also, if the string
20474 is risky, do that anyway. */
20476 if (NILP (Fequal (props
, oprops
)) || risky
)
20478 /* If the starting string has properties,
20479 merge the specified ones onto the existing ones. */
20480 if (! NILP (oprops
) && !risky
)
20484 oprops
= Fcopy_sequence (oprops
);
20486 while (CONSP (tem
))
20488 oprops
= Fplist_put (oprops
, XCAR (tem
),
20489 XCAR (XCDR (tem
)));
20490 tem
= XCDR (XCDR (tem
));
20495 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20496 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20498 /* AELT is what we want. Move it to the front
20499 without consing. */
20501 mode_line_proptrans_alist
20502 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20508 /* If AELT has the wrong props, it is useless.
20509 so get rid of it. */
20511 mode_line_proptrans_alist
20512 = Fdelq (aelt
, mode_line_proptrans_alist
);
20514 elt
= Fcopy_sequence (elt
);
20515 Fset_text_properties (make_number (0), Flength (elt
),
20517 /* Add this item to mode_line_proptrans_alist. */
20518 mode_line_proptrans_alist
20519 = Fcons (Fcons (elt
, props
),
20520 mode_line_proptrans_alist
);
20521 /* Truncate mode_line_proptrans_alist
20522 to at most 50 elements. */
20523 tem
= Fnthcdr (make_number (50),
20524 mode_line_proptrans_alist
);
20526 XSETCDR (tem
, Qnil
);
20535 prec
= precision
- n
;
20536 switch (mode_line_target
)
20538 case MODE_LINE_NOPROP
:
20539 case MODE_LINE_TITLE
:
20540 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20542 case MODE_LINE_STRING
:
20543 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20545 case MODE_LINE_DISPLAY
:
20546 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20547 0, prec
, 0, STRING_MULTIBYTE (elt
));
20554 /* Handle the non-literal case. */
20556 while ((precision
<= 0 || n
< precision
)
20557 && SREF (elt
, offset
) != 0
20558 && (mode_line_target
!= MODE_LINE_DISPLAY
20559 || it
->current_x
< it
->last_visible_x
))
20561 ptrdiff_t last_offset
= offset
;
20563 /* Advance to end of string or next format specifier. */
20564 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20567 if (offset
- 1 != last_offset
)
20569 ptrdiff_t nchars
, nbytes
;
20571 /* Output to end of string or up to '%'. Field width
20572 is length of string. Don't output more than
20573 PRECISION allows us. */
20576 prec
= c_string_width (SDATA (elt
) + last_offset
,
20577 offset
- last_offset
, precision
- n
,
20580 switch (mode_line_target
)
20582 case MODE_LINE_NOPROP
:
20583 case MODE_LINE_TITLE
:
20584 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20586 case MODE_LINE_STRING
:
20588 ptrdiff_t bytepos
= last_offset
;
20589 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20590 ptrdiff_t endpos
= (precision
<= 0
20591 ? string_byte_to_char (elt
, offset
)
20592 : charpos
+ nchars
);
20594 n
+= store_mode_line_string (NULL
,
20595 Fsubstring (elt
, make_number (charpos
),
20596 make_number (endpos
)),
20600 case MODE_LINE_DISPLAY
:
20602 ptrdiff_t bytepos
= last_offset
;
20603 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20605 if (precision
<= 0)
20606 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20607 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20609 STRING_MULTIBYTE (elt
));
20614 else /* c == '%' */
20616 ptrdiff_t percent_position
= offset
;
20618 /* Get the specified minimum width. Zero means
20621 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20622 field
= field
* 10 + c
- '0';
20624 /* Don't pad beyond the total padding allowed. */
20625 if (field_width
- n
> 0 && field
> field_width
- n
)
20626 field
= field_width
- n
;
20628 /* Note that either PRECISION <= 0 or N < PRECISION. */
20629 prec
= precision
- n
;
20632 n
+= display_mode_element (it
, depth
, field
, prec
,
20633 Vglobal_mode_string
, props
,
20638 ptrdiff_t bytepos
, charpos
;
20640 Lisp_Object string
;
20642 bytepos
= percent_position
;
20643 charpos
= (STRING_MULTIBYTE (elt
)
20644 ? string_byte_to_char (elt
, bytepos
)
20646 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20647 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20649 switch (mode_line_target
)
20651 case MODE_LINE_NOPROP
:
20652 case MODE_LINE_TITLE
:
20653 n
+= store_mode_line_noprop (spec
, field
, prec
);
20655 case MODE_LINE_STRING
:
20657 Lisp_Object tem
= build_string (spec
);
20658 props
= Ftext_properties_at (make_number (charpos
), elt
);
20659 /* Should only keep face property in props */
20660 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20663 case MODE_LINE_DISPLAY
:
20665 int nglyphs_before
, nwritten
;
20667 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20668 nwritten
= display_string (spec
, string
, elt
,
20673 /* Assign to the glyphs written above the
20674 string where the `%x' came from, position
20678 struct glyph
*glyph
20679 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20683 for (i
= 0; i
< nwritten
; ++i
)
20685 glyph
[i
].object
= elt
;
20686 glyph
[i
].charpos
= charpos
;
20703 /* A symbol: process the value of the symbol recursively
20704 as if it appeared here directly. Avoid error if symbol void.
20705 Special case: if value of symbol is a string, output the string
20708 register Lisp_Object tem
;
20710 /* If the variable is not marked as risky to set
20711 then its contents are risky to use. */
20712 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20715 tem
= Fboundp (elt
);
20718 tem
= Fsymbol_value (elt
);
20719 /* If value is a string, output that string literally:
20720 don't check for % within it. */
20724 if (!EQ (tem
, elt
))
20726 /* Give up right away for nil or t. */
20736 register Lisp_Object car
, tem
;
20738 /* A cons cell: five distinct cases.
20739 If first element is :eval or :propertize, do something special.
20740 If first element is a string or a cons, process all the elements
20741 and effectively concatenate them.
20742 If first element is a negative number, truncate displaying cdr to
20743 at most that many characters. If positive, pad (with spaces)
20744 to at least that many characters.
20745 If first element is a symbol, process the cadr or caddr recursively
20746 according to whether the symbol's value is non-nil or nil. */
20748 if (EQ (car
, QCeval
))
20750 /* An element of the form (:eval FORM) means evaluate FORM
20751 and use the result as mode line elements. */
20756 if (CONSP (XCDR (elt
)))
20759 spec
= safe_eval (XCAR (XCDR (elt
)));
20760 n
+= display_mode_element (it
, depth
, field_width
- n
,
20761 precision
- n
, spec
, props
,
20765 else if (EQ (car
, QCpropertize
))
20767 /* An element of the form (:propertize ELT PROPS...)
20768 means display ELT but applying properties PROPS. */
20773 if (CONSP (XCDR (elt
)))
20774 n
+= display_mode_element (it
, depth
, field_width
- n
,
20775 precision
- n
, XCAR (XCDR (elt
)),
20776 XCDR (XCDR (elt
)), risky
);
20778 else if (SYMBOLP (car
))
20780 tem
= Fboundp (car
);
20784 /* elt is now the cdr, and we know it is a cons cell.
20785 Use its car if CAR has a non-nil value. */
20788 tem
= Fsymbol_value (car
);
20795 /* Symbol's value is nil (or symbol is unbound)
20796 Get the cddr of the original list
20797 and if possible find the caddr and use that. */
20801 else if (!CONSP (elt
))
20806 else if (INTEGERP (car
))
20808 register int lim
= XINT (car
);
20812 /* Negative int means reduce maximum width. */
20813 if (precision
<= 0)
20816 precision
= min (precision
, -lim
);
20820 /* Padding specified. Don't let it be more than
20821 current maximum. */
20823 lim
= min (precision
, lim
);
20825 /* If that's more padding than already wanted, queue it.
20826 But don't reduce padding already specified even if
20827 that is beyond the current truncation point. */
20828 field_width
= max (lim
, field_width
);
20832 else if (STRINGP (car
) || CONSP (car
))
20834 Lisp_Object halftail
= elt
;
20838 && (precision
<= 0 || n
< precision
))
20840 n
+= display_mode_element (it
, depth
,
20841 /* Do padding only after the last
20842 element in the list. */
20843 (! CONSP (XCDR (elt
))
20846 precision
- n
, XCAR (elt
),
20850 if ((len
& 1) == 0)
20851 halftail
= XCDR (halftail
);
20852 /* Check for cycle. */
20853 if (EQ (halftail
, elt
))
20862 elt
= build_string ("*invalid*");
20866 /* Pad to FIELD_WIDTH. */
20867 if (field_width
> 0 && n
< field_width
)
20869 switch (mode_line_target
)
20871 case MODE_LINE_NOPROP
:
20872 case MODE_LINE_TITLE
:
20873 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20875 case MODE_LINE_STRING
:
20876 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20878 case MODE_LINE_DISPLAY
:
20879 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20888 /* Store a mode-line string element in mode_line_string_list.
20890 If STRING is non-null, display that C string. Otherwise, the Lisp
20891 string LISP_STRING is displayed.
20893 FIELD_WIDTH is the minimum number of output glyphs to produce.
20894 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20895 with spaces. FIELD_WIDTH <= 0 means don't pad.
20897 PRECISION is the maximum number of characters to output from
20898 STRING. PRECISION <= 0 means don't truncate the string.
20900 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20901 properties to the string.
20903 PROPS are the properties to add to the string.
20904 The mode_line_string_face face property is always added to the string.
20908 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20909 int field_width
, int precision
, Lisp_Object props
)
20914 if (string
!= NULL
)
20916 len
= strlen (string
);
20917 if (precision
> 0 && len
> precision
)
20919 lisp_string
= make_string (string
, len
);
20921 props
= mode_line_string_face_prop
;
20922 else if (!NILP (mode_line_string_face
))
20924 Lisp_Object face
= Fplist_get (props
, Qface
);
20925 props
= Fcopy_sequence (props
);
20927 face
= mode_line_string_face
;
20929 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20930 props
= Fplist_put (props
, Qface
, face
);
20932 Fadd_text_properties (make_number (0), make_number (len
),
20933 props
, lisp_string
);
20937 len
= XFASTINT (Flength (lisp_string
));
20938 if (precision
> 0 && len
> precision
)
20941 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20944 if (!NILP (mode_line_string_face
))
20948 props
= Ftext_properties_at (make_number (0), lisp_string
);
20949 face
= Fplist_get (props
, Qface
);
20951 face
= mode_line_string_face
;
20953 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20954 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20956 lisp_string
= Fcopy_sequence (lisp_string
);
20959 Fadd_text_properties (make_number (0), make_number (len
),
20960 props
, lisp_string
);
20965 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20969 if (field_width
> len
)
20971 field_width
-= len
;
20972 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20974 Fadd_text_properties (make_number (0), make_number (field_width
),
20975 props
, lisp_string
);
20976 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20984 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20986 doc
: /* Format a string out of a mode line format specification.
20987 First arg FORMAT specifies the mode line format (see `mode-line-format'
20988 for details) to use.
20990 By default, the format is evaluated for the currently selected window.
20992 Optional second arg FACE specifies the face property to put on all
20993 characters for which no face is specified. The value nil means the
20994 default face. The value t means whatever face the window's mode line
20995 currently uses (either `mode-line' or `mode-line-inactive',
20996 depending on whether the window is the selected window or not).
20997 An integer value means the value string has no text
21000 Optional third and fourth args WINDOW and BUFFER specify the window
21001 and buffer to use as the context for the formatting (defaults
21002 are the selected window and the WINDOW's buffer). */)
21003 (Lisp_Object format
, Lisp_Object face
,
21004 Lisp_Object window
, Lisp_Object buffer
)
21009 struct buffer
*old_buffer
= NULL
;
21011 int no_props
= INTEGERP (face
);
21012 ptrdiff_t count
= SPECPDL_INDEX ();
21014 int string_start
= 0;
21017 window
= selected_window
;
21018 CHECK_WINDOW (window
);
21019 w
= XWINDOW (window
);
21022 buffer
= w
->buffer
;
21023 CHECK_BUFFER (buffer
);
21025 /* Make formatting the modeline a non-op when noninteractive, otherwise
21026 there will be problems later caused by a partially initialized frame. */
21027 if (NILP (format
) || noninteractive
)
21028 return empty_unibyte_string
;
21033 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
21034 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
21035 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
21036 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
21037 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
21038 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
21039 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
21042 old_buffer
= current_buffer
;
21044 /* Save things including mode_line_proptrans_alist,
21045 and set that to nil so that we don't alter the outer value. */
21046 record_unwind_protect (unwind_format_mode_line
,
21047 format_mode_line_unwind_data
21048 (XFRAME (WINDOW_FRAME (XWINDOW (window
))),
21049 old_buffer
, selected_window
, 1));
21050 mode_line_proptrans_alist
= Qnil
;
21052 Fselect_window (window
, Qt
);
21053 set_buffer_internal_1 (XBUFFER (buffer
));
21055 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21059 mode_line_target
= MODE_LINE_NOPROP
;
21060 mode_line_string_face_prop
= Qnil
;
21061 mode_line_string_list
= Qnil
;
21062 string_start
= MODE_LINE_NOPROP_LEN (0);
21066 mode_line_target
= MODE_LINE_STRING
;
21067 mode_line_string_list
= Qnil
;
21068 mode_line_string_face
= face
;
21069 mode_line_string_face_prop
21070 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
21073 push_kboard (FRAME_KBOARD (it
.f
));
21074 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21079 len
= MODE_LINE_NOPROP_LEN (string_start
);
21080 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
21084 mode_line_string_list
= Fnreverse (mode_line_string_list
);
21085 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
21086 empty_unibyte_string
);
21089 unbind_to (count
, Qnil
);
21093 /* Write a null-terminated, right justified decimal representation of
21094 the positive integer D to BUF using a minimal field width WIDTH. */
21097 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
21099 register char *p
= buf
;
21107 *p
++ = d
% 10 + '0';
21112 for (width
-= (int) (p
- buf
); width
> 0; --width
)
21123 /* Write a null-terminated, right justified decimal and "human
21124 readable" representation of the nonnegative integer D to BUF using
21125 a minimal field width WIDTH. D should be smaller than 999.5e24. */
21127 static const char power_letter
[] =
21141 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
21143 /* We aim to represent the nonnegative integer D as
21144 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
21145 ptrdiff_t quotient
= d
;
21147 /* -1 means: do not use TENTHS. */
21151 /* Length of QUOTIENT.TENTHS as a string. */
21157 if (1000 <= quotient
)
21159 /* Scale to the appropriate EXPONENT. */
21162 remainder
= quotient
% 1000;
21166 while (1000 <= quotient
);
21168 /* Round to nearest and decide whether to use TENTHS or not. */
21171 tenths
= remainder
/ 100;
21172 if (50 <= remainder
% 100)
21179 if (quotient
== 10)
21187 if (500 <= remainder
)
21189 if (quotient
< 999)
21200 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21201 if (tenths
== -1 && quotient
<= 99)
21208 p
= psuffix
= buf
+ max (width
, length
);
21210 /* Print EXPONENT. */
21211 *psuffix
++ = power_letter
[exponent
];
21214 /* Print TENTHS. */
21217 *--p
= '0' + tenths
;
21221 /* Print QUOTIENT. */
21224 int digit
= quotient
% 10;
21225 *--p
= '0' + digit
;
21227 while ((quotient
/= 10) != 0);
21229 /* Print leading spaces. */
21234 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21235 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21236 type of CODING_SYSTEM. Return updated pointer into BUF. */
21238 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21241 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21244 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21245 const unsigned char *eol_str
;
21247 /* The EOL conversion we are using. */
21248 Lisp_Object eoltype
;
21250 val
= CODING_SYSTEM_SPEC (coding_system
);
21253 if (!VECTORP (val
)) /* Not yet decided. */
21255 *buf
++ = multibyte
? '-' : ' ';
21257 eoltype
= eol_mnemonic_undecided
;
21258 /* Don't mention EOL conversion if it isn't decided. */
21263 Lisp_Object eolvalue
;
21265 attrs
= AREF (val
, 0);
21266 eolvalue
= AREF (val
, 2);
21269 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21274 /* The EOL conversion that is normal on this system. */
21276 if (NILP (eolvalue
)) /* Not yet decided. */
21277 eoltype
= eol_mnemonic_undecided
;
21278 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21279 eoltype
= eol_mnemonic_undecided
;
21280 else /* eolvalue is Qunix, Qdos, or Qmac. */
21281 eoltype
= (EQ (eolvalue
, Qunix
)
21282 ? eol_mnemonic_unix
21283 : (EQ (eolvalue
, Qdos
) == 1
21284 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21290 /* Mention the EOL conversion if it is not the usual one. */
21291 if (STRINGP (eoltype
))
21293 eol_str
= SDATA (eoltype
);
21294 eol_str_len
= SBYTES (eoltype
);
21296 else if (CHARACTERP (eoltype
))
21298 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
21299 int c
= XFASTINT (eoltype
);
21300 eol_str_len
= CHAR_STRING (c
, tmp
);
21305 eol_str
= invalid_eol_type
;
21306 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21308 memcpy (buf
, eol_str
, eol_str_len
);
21309 buf
+= eol_str_len
;
21315 /* Return a string for the output of a mode line %-spec for window W,
21316 generated by character C. FIELD_WIDTH > 0 means pad the string
21317 returned with spaces to that value. Return a Lisp string in
21318 *STRING if the resulting string is taken from that Lisp string.
21320 Note we operate on the current buffer for most purposes,
21321 the exception being w->base_line_pos. */
21323 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21325 static const char *
21326 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21327 Lisp_Object
*string
)
21330 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21331 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21332 struct buffer
*b
= current_buffer
;
21340 if (!NILP (BVAR (b
, read_only
)))
21342 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21347 /* This differs from %* only for a modified read-only buffer. */
21348 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21350 if (!NILP (BVAR (b
, read_only
)))
21355 /* This differs from %* in ignoring read-only-ness. */
21356 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21368 if (command_loop_level
> 5)
21370 p
= decode_mode_spec_buf
;
21371 for (i
= 0; i
< command_loop_level
; i
++)
21374 return decode_mode_spec_buf
;
21382 if (command_loop_level
> 5)
21384 p
= decode_mode_spec_buf
;
21385 for (i
= 0; i
< command_loop_level
; i
++)
21388 return decode_mode_spec_buf
;
21395 /* Let lots_of_dashes be a string of infinite length. */
21396 if (mode_line_target
== MODE_LINE_NOPROP
||
21397 mode_line_target
== MODE_LINE_STRING
)
21399 if (field_width
<= 0
21400 || field_width
> sizeof (lots_of_dashes
))
21402 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21403 decode_mode_spec_buf
[i
] = '-';
21404 decode_mode_spec_buf
[i
] = '\0';
21405 return decode_mode_spec_buf
;
21408 return lots_of_dashes
;
21412 obj
= BVAR (b
, name
);
21416 /* %c and %l are ignored in `frame-title-format'.
21417 (In redisplay_internal, the frame title is drawn _before_ the
21418 windows are updated, so the stuff which depends on actual
21419 window contents (such as %l) may fail to render properly, or
21420 even crash emacs.) */
21421 if (mode_line_target
== MODE_LINE_TITLE
)
21425 ptrdiff_t col
= current_column ();
21426 wset_column_number_displayed (w
, make_number (col
));
21427 pint2str (decode_mode_spec_buf
, field_width
, col
);
21428 return decode_mode_spec_buf
;
21432 #ifndef SYSTEM_MALLOC
21434 if (NILP (Vmemory_full
))
21437 return "!MEM FULL! ";
21444 /* %F displays the frame name. */
21445 if (!NILP (f
->title
))
21446 return SSDATA (f
->title
);
21447 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21448 return SSDATA (f
->name
);
21452 obj
= BVAR (b
, filename
);
21457 ptrdiff_t size
= ZV
- BEGV
;
21458 pint2str (decode_mode_spec_buf
, field_width
, size
);
21459 return decode_mode_spec_buf
;
21464 ptrdiff_t size
= ZV
- BEGV
;
21465 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
21466 return decode_mode_spec_buf
;
21471 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21472 ptrdiff_t topline
, nlines
, height
;
21475 /* %c and %l are ignored in `frame-title-format'. */
21476 if (mode_line_target
== MODE_LINE_TITLE
)
21479 startpos
= XMARKER (w
->start
)->charpos
;
21480 startpos_byte
= marker_byte_position (w
->start
);
21481 height
= WINDOW_TOTAL_LINES (w
);
21483 /* If we decided that this buffer isn't suitable for line numbers,
21484 don't forget that too fast. */
21485 if (EQ (w
->base_line_pos
, w
->buffer
))
21487 /* But do forget it, if the window shows a different buffer now. */
21488 else if (BUFFERP (w
->base_line_pos
))
21489 wset_base_line_pos (w
, Qnil
);
21491 /* If the buffer is very big, don't waste time. */
21492 if (INTEGERP (Vline_number_display_limit
)
21493 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21495 wset_base_line_pos (w
, Qnil
);
21496 wset_base_line_number (w
, Qnil
);
21500 if (INTEGERP (w
->base_line_number
)
21501 && INTEGERP (w
->base_line_pos
)
21502 && XFASTINT (w
->base_line_pos
) <= startpos
)
21504 line
= XFASTINT (w
->base_line_number
);
21505 linepos
= XFASTINT (w
->base_line_pos
);
21506 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21511 linepos
= BUF_BEGV (b
);
21512 linepos_byte
= BUF_BEGV_BYTE (b
);
21515 /* Count lines from base line to window start position. */
21516 nlines
= display_count_lines (linepos_byte
,
21520 topline
= nlines
+ line
;
21522 /* Determine a new base line, if the old one is too close
21523 or too far away, or if we did not have one.
21524 "Too close" means it's plausible a scroll-down would
21525 go back past it. */
21526 if (startpos
== BUF_BEGV (b
))
21528 wset_base_line_number (w
, make_number (topline
));
21529 wset_base_line_pos (w
, make_number (BUF_BEGV (b
)));
21531 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21532 || linepos
== BUF_BEGV (b
))
21534 ptrdiff_t limit
= BUF_BEGV (b
);
21535 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21536 ptrdiff_t position
;
21537 ptrdiff_t distance
=
21538 (height
* 2 + 30) * line_number_display_limit_width
;
21540 if (startpos
- distance
> limit
)
21542 limit
= startpos
- distance
;
21543 limit_byte
= CHAR_TO_BYTE (limit
);
21546 nlines
= display_count_lines (startpos_byte
,
21548 - (height
* 2 + 30),
21550 /* If we couldn't find the lines we wanted within
21551 line_number_display_limit_width chars per line,
21552 give up on line numbers for this window. */
21553 if (position
== limit_byte
&& limit
== startpos
- distance
)
21555 wset_base_line_pos (w
, w
->buffer
);
21556 wset_base_line_number (w
, Qnil
);
21560 wset_base_line_number (w
, make_number (topline
- nlines
));
21561 wset_base_line_pos (w
, make_number (BYTE_TO_CHAR (position
)));
21564 /* Now count lines from the start pos to point. */
21565 nlines
= display_count_lines (startpos_byte
,
21566 PT_BYTE
, PT
, &junk
);
21568 /* Record that we did display the line number. */
21569 line_number_displayed
= 1;
21571 /* Make the string to show. */
21572 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21573 return decode_mode_spec_buf
;
21576 char* p
= decode_mode_spec_buf
;
21577 int pad
= field_width
- 2;
21583 return decode_mode_spec_buf
;
21589 obj
= BVAR (b
, mode_name
);
21593 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21599 ptrdiff_t pos
= marker_position (w
->start
);
21600 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21602 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21604 if (pos
<= BUF_BEGV (b
))
21609 else if (pos
<= BUF_BEGV (b
))
21613 if (total
> 1000000)
21614 /* Do it differently for a large value, to avoid overflow. */
21615 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21617 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21618 /* We can't normally display a 3-digit number,
21619 so get us a 2-digit number that is close. */
21622 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21623 return decode_mode_spec_buf
;
21627 /* Display percentage of size above the bottom of the screen. */
21630 ptrdiff_t toppos
= marker_position (w
->start
);
21631 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21632 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21634 if (botpos
>= BUF_ZV (b
))
21636 if (toppos
<= BUF_BEGV (b
))
21643 if (total
> 1000000)
21644 /* Do it differently for a large value, to avoid overflow. */
21645 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21647 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21648 /* We can't normally display a 3-digit number,
21649 so get us a 2-digit number that is close. */
21652 if (toppos
<= BUF_BEGV (b
))
21653 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21655 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21656 return decode_mode_spec_buf
;
21661 /* status of process */
21662 obj
= Fget_buffer_process (Fcurrent_buffer ());
21664 return "no process";
21666 obj
= Fsymbol_name (Fprocess_status (obj
));
21672 ptrdiff_t count
= inhibit_garbage_collection ();
21673 Lisp_Object val
= call1 (intern ("file-remote-p"),
21674 BVAR (current_buffer
, directory
));
21675 unbind_to (count
, Qnil
);
21683 case 't': /* indicate TEXT or BINARY */
21687 /* coding-system (not including end-of-line format) */
21689 /* coding-system (including end-of-line type) */
21691 int eol_flag
= (c
== 'Z');
21692 char *p
= decode_mode_spec_buf
;
21694 if (! FRAME_WINDOW_P (f
))
21696 /* No need to mention EOL here--the terminal never needs
21697 to do EOL conversion. */
21698 p
= decode_mode_spec_coding (CODING_ID_NAME
21699 (FRAME_KEYBOARD_CODING (f
)->id
),
21701 p
= decode_mode_spec_coding (CODING_ID_NAME
21702 (FRAME_TERMINAL_CODING (f
)->id
),
21705 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21708 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21709 #ifdef subprocesses
21710 obj
= Fget_buffer_process (Fcurrent_buffer ());
21711 if (PROCESSP (obj
))
21713 p
= decode_mode_spec_coding
21714 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
21715 p
= decode_mode_spec_coding
21716 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
21718 #endif /* subprocesses */
21721 return decode_mode_spec_buf
;
21728 return SSDATA (obj
);
21735 /* Count up to COUNT lines starting from START_BYTE.
21736 But don't go beyond LIMIT_BYTE.
21737 Return the number of lines thus found (always nonnegative).
21739 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21742 display_count_lines (ptrdiff_t start_byte
,
21743 ptrdiff_t limit_byte
, ptrdiff_t count
,
21744 ptrdiff_t *byte_pos_ptr
)
21746 register unsigned char *cursor
;
21747 unsigned char *base
;
21749 register ptrdiff_t ceiling
;
21750 register unsigned char *ceiling_addr
;
21751 ptrdiff_t orig_count
= count
;
21753 /* If we are not in selective display mode,
21754 check only for newlines. */
21755 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21756 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21760 while (start_byte
< limit_byte
)
21762 ceiling
= BUFFER_CEILING_OF (start_byte
);
21763 ceiling
= min (limit_byte
- 1, ceiling
);
21764 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21765 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21768 if (selective_display
)
21769 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21772 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21775 if (cursor
!= ceiling_addr
)
21779 start_byte
+= cursor
- base
+ 1;
21780 *byte_pos_ptr
= start_byte
;
21784 if (++cursor
== ceiling_addr
)
21790 start_byte
+= cursor
- base
;
21795 while (start_byte
> limit_byte
)
21797 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21798 ceiling
= max (limit_byte
, ceiling
);
21799 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21800 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21803 if (selective_display
)
21804 while (--cursor
!= ceiling_addr
21805 && *cursor
!= '\n' && *cursor
!= 015)
21808 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21811 if (cursor
!= ceiling_addr
)
21815 start_byte
+= cursor
- base
+ 1;
21816 *byte_pos_ptr
= start_byte
;
21817 /* When scanning backwards, we should
21818 not count the newline posterior to which we stop. */
21819 return - orig_count
- 1;
21825 /* Here we add 1 to compensate for the last decrement
21826 of CURSOR, which took it past the valid range. */
21827 start_byte
+= cursor
- base
+ 1;
21831 *byte_pos_ptr
= limit_byte
;
21834 return - orig_count
+ count
;
21835 return orig_count
- count
;
21841 /***********************************************************************
21843 ***********************************************************************/
21845 /* Display a NUL-terminated string, starting with index START.
21847 If STRING is non-null, display that C string. Otherwise, the Lisp
21848 string LISP_STRING is displayed. There's a case that STRING is
21849 non-null and LISP_STRING is not nil. It means STRING is a string
21850 data of LISP_STRING. In that case, we display LISP_STRING while
21851 ignoring its text properties.
21853 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21854 FACE_STRING. Display STRING or LISP_STRING with the face at
21855 FACE_STRING_POS in FACE_STRING:
21857 Display the string in the environment given by IT, but use the
21858 standard display table, temporarily.
21860 FIELD_WIDTH is the minimum number of output glyphs to produce.
21861 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21862 with spaces. If STRING has more characters, more than FIELD_WIDTH
21863 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21865 PRECISION is the maximum number of characters to output from
21866 STRING. PRECISION < 0 means don't truncate the string.
21868 This is roughly equivalent to printf format specifiers:
21870 FIELD_WIDTH PRECISION PRINTF
21871 ----------------------------------------
21877 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21878 display them, and < 0 means obey the current buffer's value of
21879 enable_multibyte_characters.
21881 Value is the number of columns displayed. */
21884 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21885 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
21886 int field_width
, int precision
, int max_x
, int multibyte
)
21888 int hpos_at_start
= it
->hpos
;
21889 int saved_face_id
= it
->face_id
;
21890 struct glyph_row
*row
= it
->glyph_row
;
21891 ptrdiff_t it_charpos
;
21893 /* Initialize the iterator IT for iteration over STRING beginning
21894 with index START. */
21895 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21896 precision
, field_width
, multibyte
);
21897 if (string
&& STRINGP (lisp_string
))
21898 /* LISP_STRING is the one returned by decode_mode_spec. We should
21899 ignore its text properties. */
21900 it
->stop_charpos
= it
->end_charpos
;
21902 /* If displaying STRING, set up the face of the iterator from
21903 FACE_STRING, if that's given. */
21904 if (STRINGP (face_string
))
21910 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21911 0, it
->region_beg_charpos
,
21912 it
->region_end_charpos
,
21913 &endptr
, it
->base_face_id
, 0);
21914 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21915 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21918 /* Set max_x to the maximum allowed X position. Don't let it go
21919 beyond the right edge of the window. */
21921 max_x
= it
->last_visible_x
;
21923 max_x
= min (max_x
, it
->last_visible_x
);
21925 /* Skip over display elements that are not visible. because IT->w is
21927 if (it
->current_x
< it
->first_visible_x
)
21928 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21929 MOVE_TO_POS
| MOVE_TO_X
);
21931 row
->ascent
= it
->max_ascent
;
21932 row
->height
= it
->max_ascent
+ it
->max_descent
;
21933 row
->phys_ascent
= it
->max_phys_ascent
;
21934 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21935 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21937 if (STRINGP (it
->string
))
21938 it_charpos
= IT_STRING_CHARPOS (*it
);
21940 it_charpos
= IT_CHARPOS (*it
);
21942 /* This condition is for the case that we are called with current_x
21943 past last_visible_x. */
21944 while (it
->current_x
< max_x
)
21946 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21948 /* Get the next display element. */
21949 if (!get_next_display_element (it
))
21952 /* Produce glyphs. */
21953 x_before
= it
->current_x
;
21954 n_glyphs_before
= row
->used
[TEXT_AREA
];
21955 PRODUCE_GLYPHS (it
);
21957 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21960 while (i
< nglyphs
)
21962 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21964 if (it
->line_wrap
!= TRUNCATE
21965 && x
+ glyph
->pixel_width
> max_x
)
21967 /* End of continued line or max_x reached. */
21968 if (CHAR_GLYPH_PADDING_P (*glyph
))
21970 /* A wide character is unbreakable. */
21971 if (row
->reversed_p
)
21972 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21973 - n_glyphs_before
);
21974 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21975 it
->current_x
= x_before
;
21979 if (row
->reversed_p
)
21980 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21981 - (n_glyphs_before
+ i
));
21982 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21987 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21989 /* Glyph is at least partially visible. */
21991 if (x
< it
->first_visible_x
)
21992 row
->x
= x
- it
->first_visible_x
;
21996 /* Glyph is off the left margin of the display area.
21997 Should not happen. */
22001 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
22002 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
22003 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
22004 row
->phys_height
= max (row
->phys_height
,
22005 it
->max_phys_ascent
+ it
->max_phys_descent
);
22006 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
22007 it
->max_extra_line_spacing
);
22008 x
+= glyph
->pixel_width
;
22012 /* Stop if max_x reached. */
22016 /* Stop at line ends. */
22017 if (ITERATOR_AT_END_OF_LINE_P (it
))
22019 it
->continuation_lines_width
= 0;
22023 set_iterator_to_next (it
, 1);
22024 if (STRINGP (it
->string
))
22025 it_charpos
= IT_STRING_CHARPOS (*it
);
22027 it_charpos
= IT_CHARPOS (*it
);
22029 /* Stop if truncating at the right edge. */
22030 if (it
->line_wrap
== TRUNCATE
22031 && it
->current_x
>= it
->last_visible_x
)
22033 /* Add truncation mark, but don't do it if the line is
22034 truncated at a padding space. */
22035 if (it_charpos
< it
->string_nchars
)
22037 if (!FRAME_WINDOW_P (it
->f
))
22041 if (it
->current_x
> it
->last_visible_x
)
22043 if (!row
->reversed_p
)
22045 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
22046 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22051 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
22052 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22054 unproduce_glyphs (it
, ii
+ 1);
22055 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
22057 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
22059 row
->used
[TEXT_AREA
] = ii
;
22060 produce_special_glyphs (it
, IT_TRUNCATION
);
22063 produce_special_glyphs (it
, IT_TRUNCATION
);
22065 row
->truncated_on_right_p
= 1;
22071 /* Maybe insert a truncation at the left. */
22072 if (it
->first_visible_x
22075 if (!FRAME_WINDOW_P (it
->f
)
22076 || (row
->reversed_p
22077 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22078 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
22079 insert_left_trunc_glyphs (it
);
22080 row
->truncated_on_left_p
= 1;
22083 it
->face_id
= saved_face_id
;
22085 /* Value is number of columns displayed. */
22086 return it
->hpos
- hpos_at_start
;
22091 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
22092 appears as an element of LIST or as the car of an element of LIST.
22093 If PROPVAL is a list, compare each element against LIST in that
22094 way, and return 1/2 if any element of PROPVAL is found in LIST.
22095 Otherwise return 0. This function cannot quit.
22096 The return value is 2 if the text is invisible but with an ellipsis
22097 and 1 if it's invisible and without an ellipsis. */
22100 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
22102 register Lisp_Object tail
, proptail
;
22104 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22106 register Lisp_Object tem
;
22108 if (EQ (propval
, tem
))
22110 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
22111 return NILP (XCDR (tem
)) ? 1 : 2;
22114 if (CONSP (propval
))
22116 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
22118 Lisp_Object propelt
;
22119 propelt
= XCAR (proptail
);
22120 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22122 register Lisp_Object tem
;
22124 if (EQ (propelt
, tem
))
22126 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
22127 return NILP (XCDR (tem
)) ? 1 : 2;
22135 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
22136 doc
: /* Non-nil if the property makes the text invisible.
22137 POS-OR-PROP can be a marker or number, in which case it is taken to be
22138 a position in the current buffer and the value of the `invisible' property
22139 is checked; or it can be some other value, which is then presumed to be the
22140 value of the `invisible' property of the text of interest.
22141 The non-nil value returned can be t for truly invisible text or something
22142 else if the text is replaced by an ellipsis. */)
22143 (Lisp_Object pos_or_prop
)
22146 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
22147 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
22149 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
22150 return (invis
== 0 ? Qnil
22152 : make_number (invis
));
22155 /* Calculate a width or height in pixels from a specification using
22156 the following elements:
22159 NUM - a (fractional) multiple of the default font width/height
22160 (NUM) - specifies exactly NUM pixels
22161 UNIT - a fixed number of pixels, see below.
22162 ELEMENT - size of a display element in pixels, see below.
22163 (NUM . SPEC) - equals NUM * SPEC
22164 (+ SPEC SPEC ...) - add pixel values
22165 (- SPEC SPEC ...) - subtract pixel values
22166 (- SPEC) - negate pixel value
22169 INT or FLOAT - a number constant
22170 SYMBOL - use symbol's (buffer local) variable binding.
22173 in - pixels per inch *)
22174 mm - pixels per 1/1000 meter *)
22175 cm - pixels per 1/100 meter *)
22176 width - width of current font in pixels.
22177 height - height of current font in pixels.
22179 *) using the ratio(s) defined in display-pixels-per-inch.
22183 left-fringe - left fringe width in pixels
22184 right-fringe - right fringe width in pixels
22186 left-margin - left margin width in pixels
22187 right-margin - right margin width in pixels
22189 scroll-bar - scroll-bar area width in pixels
22193 Pixels corresponding to 5 inches:
22196 Total width of non-text areas on left side of window (if scroll-bar is on left):
22197 '(space :width (+ left-fringe left-margin scroll-bar))
22199 Align to first text column (in header line):
22200 '(space :align-to 0)
22202 Align to middle of text area minus half the width of variable `my-image'
22203 containing a loaded image:
22204 '(space :align-to (0.5 . (- text my-image)))
22206 Width of left margin minus width of 1 character in the default font:
22207 '(space :width (- left-margin 1))
22209 Width of left margin minus width of 2 characters in the current font:
22210 '(space :width (- left-margin (2 . width)))
22212 Center 1 character over left-margin (in header line):
22213 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22215 Different ways to express width of left fringe plus left margin minus one pixel:
22216 '(space :width (- (+ left-fringe left-margin) (1)))
22217 '(space :width (+ left-fringe left-margin (- (1))))
22218 '(space :width (+ left-fringe left-margin (-1)))
22222 #define NUMVAL(X) \
22223 ((INTEGERP (X) || FLOATP (X)) \
22228 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22229 struct font
*font
, int width_p
, int *align_to
)
22233 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22234 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22237 return OK_PIXELS (0);
22239 eassert (FRAME_LIVE_P (it
->f
));
22241 if (SYMBOLP (prop
))
22243 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22245 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22247 if (unit
[0] == 'i' && unit
[1] == 'n')
22249 else if (unit
[0] == 'm' && unit
[1] == 'm')
22251 else if (unit
[0] == 'c' && unit
[1] == 'm')
22258 #ifdef HAVE_WINDOW_SYSTEM
22259 if (FRAME_WINDOW_P (it
->f
)
22261 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
22262 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
22264 return OK_PIXELS (ppi
/ pixels
);
22267 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
22268 || (CONSP (Vdisplay_pixels_per_inch
)
22270 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
22271 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
22273 return OK_PIXELS (ppi
/ pixels
);
22279 #ifdef HAVE_WINDOW_SYSTEM
22280 if (EQ (prop
, Qheight
))
22281 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22282 if (EQ (prop
, Qwidth
))
22283 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22285 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22286 return OK_PIXELS (1);
22289 if (EQ (prop
, Qtext
))
22290 return OK_PIXELS (width_p
22291 ? window_box_width (it
->w
, TEXT_AREA
)
22292 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22294 if (align_to
&& *align_to
< 0)
22297 if (EQ (prop
, Qleft
))
22298 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22299 if (EQ (prop
, Qright
))
22300 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22301 if (EQ (prop
, Qcenter
))
22302 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22303 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22304 if (EQ (prop
, Qleft_fringe
))
22305 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22306 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22307 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22308 if (EQ (prop
, Qright_fringe
))
22309 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22310 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22311 : window_box_right_offset (it
->w
, TEXT_AREA
));
22312 if (EQ (prop
, Qleft_margin
))
22313 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22314 if (EQ (prop
, Qright_margin
))
22315 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22316 if (EQ (prop
, Qscroll_bar
))
22317 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22319 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22320 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22321 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22326 if (EQ (prop
, Qleft_fringe
))
22327 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22328 if (EQ (prop
, Qright_fringe
))
22329 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22330 if (EQ (prop
, Qleft_margin
))
22331 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22332 if (EQ (prop
, Qright_margin
))
22333 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22334 if (EQ (prop
, Qscroll_bar
))
22335 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22338 prop
= buffer_local_value_1 (prop
, it
->w
->buffer
);
22339 if (EQ (prop
, Qunbound
))
22343 if (INTEGERP (prop
) || FLOATP (prop
))
22345 int base_unit
= (width_p
22346 ? FRAME_COLUMN_WIDTH (it
->f
)
22347 : FRAME_LINE_HEIGHT (it
->f
));
22348 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22353 Lisp_Object car
= XCAR (prop
);
22354 Lisp_Object cdr
= XCDR (prop
);
22358 #ifdef HAVE_WINDOW_SYSTEM
22359 if (FRAME_WINDOW_P (it
->f
)
22360 && valid_image_p (prop
))
22362 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22363 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22365 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22368 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22374 while (CONSP (cdr
))
22376 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22377 font
, width_p
, align_to
))
22380 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22385 if (EQ (car
, Qminus
))
22387 return OK_PIXELS (pixels
);
22390 car
= buffer_local_value_1 (car
, it
->w
->buffer
);
22391 if (EQ (car
, Qunbound
))
22395 if (INTEGERP (car
) || FLOATP (car
))
22398 pixels
= XFLOATINT (car
);
22400 return OK_PIXELS (pixels
);
22401 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22402 font
, width_p
, align_to
))
22403 return OK_PIXELS (pixels
* fact
);
22414 /***********************************************************************
22416 ***********************************************************************/
22418 #ifdef HAVE_WINDOW_SYSTEM
22423 dump_glyph_string (struct glyph_string
*s
)
22425 fprintf (stderr
, "glyph string\n");
22426 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22427 s
->x
, s
->y
, s
->width
, s
->height
);
22428 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22429 fprintf (stderr
, " hl = %d\n", s
->hl
);
22430 fprintf (stderr
, " left overhang = %d, right = %d\n",
22431 s
->left_overhang
, s
->right_overhang
);
22432 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22433 fprintf (stderr
, " extends to end of line = %d\n",
22434 s
->extends_to_end_of_line_p
);
22435 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22436 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22439 #endif /* GLYPH_DEBUG */
22441 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22442 of XChar2b structures for S; it can't be allocated in
22443 init_glyph_string because it must be allocated via `alloca'. W
22444 is the window on which S is drawn. ROW and AREA are the glyph row
22445 and area within the row from which S is constructed. START is the
22446 index of the first glyph structure covered by S. HL is a
22447 face-override for drawing S. */
22450 #define OPTIONAL_HDC(hdc) HDC hdc,
22451 #define DECLARE_HDC(hdc) HDC hdc;
22452 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22453 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22456 #ifndef OPTIONAL_HDC
22457 #define OPTIONAL_HDC(hdc)
22458 #define DECLARE_HDC(hdc)
22459 #define ALLOCATE_HDC(hdc, f)
22460 #define RELEASE_HDC(hdc, f)
22464 init_glyph_string (struct glyph_string
*s
,
22466 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22467 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22469 memset (s
, 0, sizeof *s
);
22471 s
->f
= XFRAME (w
->frame
);
22475 s
->display
= FRAME_X_DISPLAY (s
->f
);
22476 s
->window
= FRAME_X_WINDOW (s
->f
);
22477 s
->char2b
= char2b
;
22481 s
->first_glyph
= row
->glyphs
[area
] + start
;
22482 s
->height
= row
->height
;
22483 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22484 s
->ybase
= s
->y
+ row
->ascent
;
22488 /* Append the list of glyph strings with head H and tail T to the list
22489 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22492 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22493 struct glyph_string
*h
, struct glyph_string
*t
)
22507 /* Prepend the list of glyph strings with head H and tail T to the
22508 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22512 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22513 struct glyph_string
*h
, struct glyph_string
*t
)
22527 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22528 Set *HEAD and *TAIL to the resulting list. */
22531 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22532 struct glyph_string
*s
)
22534 s
->next
= s
->prev
= NULL
;
22535 append_glyph_string_lists (head
, tail
, s
, s
);
22539 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22540 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22541 make sure that X resources for the face returned are allocated.
22542 Value is a pointer to a realized face that is ready for display if
22543 DISPLAY_P is non-zero. */
22545 static inline struct face
*
22546 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22547 XChar2b
*char2b
, int display_p
)
22549 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22553 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22555 if (code
!= FONT_INVALID_CODE
)
22556 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22558 STORE_XCHAR2B (char2b
, 0, 0);
22561 /* Make sure X resources of the face are allocated. */
22562 #ifdef HAVE_X_WINDOWS
22566 eassert (face
!= NULL
);
22567 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22574 /* Get face and two-byte form of character glyph GLYPH on frame F.
22575 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22576 a pointer to a realized face that is ready for display. */
22578 static inline struct face
*
22579 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22580 XChar2b
*char2b
, int *two_byte_p
)
22584 eassert (glyph
->type
== CHAR_GLYPH
);
22585 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22594 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22595 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22597 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22599 if (code
!= FONT_INVALID_CODE
)
22600 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22602 STORE_XCHAR2B (char2b
, 0, 0);
22605 /* Make sure X resources of the face are allocated. */
22606 eassert (face
!= NULL
);
22607 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22612 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22613 Return 1 if FONT has a glyph for C, otherwise return 0. */
22616 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22620 if (CHAR_BYTE8_P (c
))
22621 code
= CHAR_TO_BYTE8 (c
);
22623 code
= font
->driver
->encode_char (font
, c
);
22625 if (code
== FONT_INVALID_CODE
)
22627 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22632 /* Fill glyph string S with composition components specified by S->cmp.
22634 BASE_FACE is the base face of the composition.
22635 S->cmp_from is the index of the first component for S.
22637 OVERLAPS non-zero means S should draw the foreground only, and use
22638 its physical height for clipping. See also draw_glyphs.
22640 Value is the index of a component not in S. */
22643 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22647 /* For all glyphs of this composition, starting at the offset
22648 S->cmp_from, until we reach the end of the definition or encounter a
22649 glyph that requires the different face, add it to S. */
22654 s
->for_overlaps
= overlaps
;
22657 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22659 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22661 /* TAB in a composition means display glyphs with padding space
22662 on the left or right. */
22665 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22668 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22675 s
->font
= s
->face
->font
;
22677 else if (s
->face
!= face
)
22685 if (s
->face
== NULL
)
22687 s
->face
= base_face
->ascii_face
;
22688 s
->font
= s
->face
->font
;
22691 /* All glyph strings for the same composition has the same width,
22692 i.e. the width set for the first component of the composition. */
22693 s
->width
= s
->first_glyph
->pixel_width
;
22695 /* If the specified font could not be loaded, use the frame's
22696 default font, but record the fact that we couldn't load it in
22697 the glyph string so that we can draw rectangles for the
22698 characters of the glyph string. */
22699 if (s
->font
== NULL
)
22701 s
->font_not_found_p
= 1;
22702 s
->font
= FRAME_FONT (s
->f
);
22705 /* Adjust base line for subscript/superscript text. */
22706 s
->ybase
+= s
->first_glyph
->voffset
;
22708 /* This glyph string must always be drawn with 16-bit functions. */
22715 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22716 int start
, int end
, int overlaps
)
22718 struct glyph
*glyph
, *last
;
22719 Lisp_Object lgstring
;
22722 s
->for_overlaps
= overlaps
;
22723 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22724 last
= s
->row
->glyphs
[s
->area
] + end
;
22725 s
->cmp_id
= glyph
->u
.cmp
.id
;
22726 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22727 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22728 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22729 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22730 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22732 while (glyph
< last
22733 && glyph
->u
.cmp
.automatic
22734 && glyph
->u
.cmp
.id
== s
->cmp_id
22735 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22736 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22738 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22740 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22741 unsigned code
= LGLYPH_CODE (lglyph
);
22743 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22745 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22746 return glyph
- s
->row
->glyphs
[s
->area
];
22750 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22751 See the comment of fill_glyph_string for arguments.
22752 Value is the index of the first glyph not in S. */
22756 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22757 int start
, int end
, int overlaps
)
22759 struct glyph
*glyph
, *last
;
22762 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22763 s
->for_overlaps
= overlaps
;
22764 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22765 last
= s
->row
->glyphs
[s
->area
] + end
;
22766 voffset
= glyph
->voffset
;
22767 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22768 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
22770 s
->width
= glyph
->pixel_width
;
22772 while (glyph
< last
22773 && glyph
->type
== GLYPHLESS_GLYPH
22774 && glyph
->voffset
== voffset
22775 && glyph
->face_id
== face_id
)
22778 s
->width
+= glyph
->pixel_width
;
22781 s
->ybase
+= voffset
;
22782 return glyph
- s
->row
->glyphs
[s
->area
];
22786 /* Fill glyph string S from a sequence of character glyphs.
22788 FACE_ID is the face id of the string. START is the index of the
22789 first glyph to consider, END is the index of the last + 1.
22790 OVERLAPS non-zero means S should draw the foreground only, and use
22791 its physical height for clipping. See also draw_glyphs.
22793 Value is the index of the first glyph not in S. */
22796 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22797 int start
, int end
, int overlaps
)
22799 struct glyph
*glyph
, *last
;
22801 int glyph_not_available_p
;
22803 eassert (s
->f
== XFRAME (s
->w
->frame
));
22804 eassert (s
->nchars
== 0);
22805 eassert (start
>= 0 && end
> start
);
22807 s
->for_overlaps
= overlaps
;
22808 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22809 last
= s
->row
->glyphs
[s
->area
] + end
;
22810 voffset
= glyph
->voffset
;
22811 s
->padding_p
= glyph
->padding_p
;
22812 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22814 while (glyph
< last
22815 && glyph
->type
== CHAR_GLYPH
22816 && glyph
->voffset
== voffset
22817 /* Same face id implies same font, nowadays. */
22818 && glyph
->face_id
== face_id
22819 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22823 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22824 s
->char2b
+ s
->nchars
,
22826 s
->two_byte_p
= two_byte_p
;
22828 eassert (s
->nchars
<= end
- start
);
22829 s
->width
+= glyph
->pixel_width
;
22830 if (glyph
++->padding_p
!= s
->padding_p
)
22834 s
->font
= s
->face
->font
;
22836 /* If the specified font could not be loaded, use the frame's font,
22837 but record the fact that we couldn't load it in
22838 S->font_not_found_p so that we can draw rectangles for the
22839 characters of the glyph string. */
22840 if (s
->font
== NULL
|| glyph_not_available_p
)
22842 s
->font_not_found_p
= 1;
22843 s
->font
= FRAME_FONT (s
->f
);
22846 /* Adjust base line for subscript/superscript text. */
22847 s
->ybase
+= voffset
;
22849 eassert (s
->face
&& s
->face
->gc
);
22850 return glyph
- s
->row
->glyphs
[s
->area
];
22854 /* Fill glyph string S from image glyph S->first_glyph. */
22857 fill_image_glyph_string (struct glyph_string
*s
)
22859 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22860 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22862 s
->slice
= s
->first_glyph
->slice
.img
;
22863 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22864 s
->font
= s
->face
->font
;
22865 s
->width
= s
->first_glyph
->pixel_width
;
22867 /* Adjust base line for subscript/superscript text. */
22868 s
->ybase
+= s
->first_glyph
->voffset
;
22872 /* Fill glyph string S from a sequence of stretch glyphs.
22874 START is the index of the first glyph to consider,
22875 END is the index of the last + 1.
22877 Value is the index of the first glyph not in S. */
22880 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22882 struct glyph
*glyph
, *last
;
22883 int voffset
, face_id
;
22885 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22887 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22888 last
= s
->row
->glyphs
[s
->area
] + end
;
22889 face_id
= glyph
->face_id
;
22890 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22891 s
->font
= s
->face
->font
;
22892 s
->width
= glyph
->pixel_width
;
22894 voffset
= glyph
->voffset
;
22898 && glyph
->type
== STRETCH_GLYPH
22899 && glyph
->voffset
== voffset
22900 && glyph
->face_id
== face_id
);
22902 s
->width
+= glyph
->pixel_width
;
22904 /* Adjust base line for subscript/superscript text. */
22905 s
->ybase
+= voffset
;
22907 /* The case that face->gc == 0 is handled when drawing the glyph
22908 string by calling PREPARE_FACE_FOR_DISPLAY. */
22910 return glyph
- s
->row
->glyphs
[s
->area
];
22913 static struct font_metrics
*
22914 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22916 static struct font_metrics metrics
;
22917 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22919 if (! font
|| code
== FONT_INVALID_CODE
)
22921 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22926 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22927 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22928 assumed to be zero. */
22931 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22933 *left
= *right
= 0;
22935 if (glyph
->type
== CHAR_GLYPH
)
22939 struct font_metrics
*pcm
;
22941 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22942 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22944 if (pcm
->rbearing
> pcm
->width
)
22945 *right
= pcm
->rbearing
- pcm
->width
;
22946 if (pcm
->lbearing
< 0)
22947 *left
= -pcm
->lbearing
;
22950 else if (glyph
->type
== COMPOSITE_GLYPH
)
22952 if (! glyph
->u
.cmp
.automatic
)
22954 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22956 if (cmp
->rbearing
> cmp
->pixel_width
)
22957 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22958 if (cmp
->lbearing
< 0)
22959 *left
= - cmp
->lbearing
;
22963 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22964 struct font_metrics metrics
;
22966 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22967 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22968 if (metrics
.rbearing
> metrics
.width
)
22969 *right
= metrics
.rbearing
- metrics
.width
;
22970 if (metrics
.lbearing
< 0)
22971 *left
= - metrics
.lbearing
;
22977 /* Return the index of the first glyph preceding glyph string S that
22978 is overwritten by S because of S's left overhang. Value is -1
22979 if no glyphs are overwritten. */
22982 left_overwritten (struct glyph_string
*s
)
22986 if (s
->left_overhang
)
22989 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22990 int first
= s
->first_glyph
- glyphs
;
22992 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22993 x
-= glyphs
[i
].pixel_width
;
23004 /* Return the index of the first glyph preceding glyph string S that
23005 is overwriting S because of its right overhang. Value is -1 if no
23006 glyph in front of S overwrites S. */
23009 left_overwriting (struct glyph_string
*s
)
23012 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23013 int first
= s
->first_glyph
- glyphs
;
23017 for (i
= first
- 1; i
>= 0; --i
)
23020 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23023 x
-= glyphs
[i
].pixel_width
;
23030 /* Return the index of the last glyph following glyph string S that is
23031 overwritten by S because of S's right overhang. Value is -1 if
23032 no such glyph is found. */
23035 right_overwritten (struct glyph_string
*s
)
23039 if (s
->right_overhang
)
23042 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23043 int first
= (s
->first_glyph
- glyphs
23044 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23045 int end
= s
->row
->used
[s
->area
];
23047 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
23048 x
+= glyphs
[i
].pixel_width
;
23057 /* Return the index of the last glyph following glyph string S that
23058 overwrites S because of its left overhang. Value is negative
23059 if no such glyph is found. */
23062 right_overwriting (struct glyph_string
*s
)
23065 int end
= s
->row
->used
[s
->area
];
23066 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23067 int first
= (s
->first_glyph
- glyphs
23068 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23072 for (i
= first
; i
< end
; ++i
)
23075 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23078 x
+= glyphs
[i
].pixel_width
;
23085 /* Set background width of glyph string S. START is the index of the
23086 first glyph following S. LAST_X is the right-most x-position + 1
23087 in the drawing area. */
23090 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
23092 /* If the face of this glyph string has to be drawn to the end of
23093 the drawing area, set S->extends_to_end_of_line_p. */
23095 if (start
== s
->row
->used
[s
->area
]
23096 && s
->area
== TEXT_AREA
23097 && ((s
->row
->fill_line_p
23098 && (s
->hl
== DRAW_NORMAL_TEXT
23099 || s
->hl
== DRAW_IMAGE_RAISED
23100 || s
->hl
== DRAW_IMAGE_SUNKEN
))
23101 || s
->hl
== DRAW_MOUSE_FACE
))
23102 s
->extends_to_end_of_line_p
= 1;
23104 /* If S extends its face to the end of the line, set its
23105 background_width to the distance to the right edge of the drawing
23107 if (s
->extends_to_end_of_line_p
)
23108 s
->background_width
= last_x
- s
->x
+ 1;
23110 s
->background_width
= s
->width
;
23114 /* Compute overhangs and x-positions for glyph string S and its
23115 predecessors, or successors. X is the starting x-position for S.
23116 BACKWARD_P non-zero means process predecessors. */
23119 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
23125 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23126 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23136 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23137 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23147 /* The following macros are only called from draw_glyphs below.
23148 They reference the following parameters of that function directly:
23149 `w', `row', `area', and `overlap_p'
23150 as well as the following local variables:
23151 `s', `f', and `hdc' (in W32) */
23154 /* On W32, silently add local `hdc' variable to argument list of
23155 init_glyph_string. */
23156 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23157 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23159 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23160 init_glyph_string (s, char2b, w, row, area, start, hl)
23163 /* Add a glyph string for a stretch glyph to the list of strings
23164 between HEAD and TAIL. START is the index of the stretch glyph in
23165 row area AREA of glyph row ROW. END is the index of the last glyph
23166 in that glyph row area. X is the current output position assigned
23167 to the new glyph string constructed. HL overrides that face of the
23168 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23169 is the right-most x-position of the drawing area. */
23171 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23172 and below -- keep them on one line. */
23173 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23176 s = alloca (sizeof *s); \
23177 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23178 START = fill_stretch_glyph_string (s, START, END); \
23179 append_glyph_string (&HEAD, &TAIL, s); \
23185 /* Add a glyph string for an image glyph to the list of strings
23186 between HEAD and TAIL. START is the index of the image glyph in
23187 row area AREA of glyph row ROW. END is the index of the last glyph
23188 in that glyph row area. X is the current output position assigned
23189 to the new glyph string constructed. HL overrides that face of the
23190 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23191 is the right-most x-position of the drawing area. */
23193 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23196 s = alloca (sizeof *s); \
23197 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23198 fill_image_glyph_string (s); \
23199 append_glyph_string (&HEAD, &TAIL, s); \
23206 /* Add a glyph string for a sequence of character glyphs to the list
23207 of strings between HEAD and TAIL. START is the index of the first
23208 glyph in row area AREA of glyph row ROW that is part of the new
23209 glyph string. END is the index of the last glyph in that glyph row
23210 area. X is the current output position assigned to the new glyph
23211 string constructed. HL overrides that face of the glyph; e.g. it
23212 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23213 right-most x-position of the drawing area. */
23215 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23221 face_id = (row)->glyphs[area][START].face_id; \
23223 s = alloca (sizeof *s); \
23224 char2b = alloca ((END - START) * sizeof *char2b); \
23225 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23226 append_glyph_string (&HEAD, &TAIL, s); \
23228 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23233 /* Add a glyph string for a composite sequence to the list of strings
23234 between HEAD and TAIL. START is the index of the first glyph in
23235 row area AREA of glyph row ROW that is part of the new glyph
23236 string. END is the index of the last glyph in that glyph row area.
23237 X is the current output position assigned to the new glyph string
23238 constructed. HL overrides that face of the glyph; e.g. it is
23239 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23240 x-position of the drawing area. */
23242 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23244 int face_id = (row)->glyphs[area][START].face_id; \
23245 struct face *base_face = FACE_FROM_ID (f, face_id); \
23246 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23247 struct composition *cmp = composition_table[cmp_id]; \
23249 struct glyph_string *first_s = NULL; \
23252 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23254 /* Make glyph_strings for each glyph sequence that is drawable by \
23255 the same face, and append them to HEAD/TAIL. */ \
23256 for (n = 0; n < cmp->glyph_len;) \
23258 s = alloca (sizeof *s); \
23259 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23260 append_glyph_string (&(HEAD), &(TAIL), s); \
23266 n = fill_composite_glyph_string (s, base_face, overlaps); \
23274 /* Add a glyph string for a glyph-string sequence to the list of strings
23275 between HEAD and TAIL. */
23277 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23281 Lisp_Object gstring; \
23283 face_id = (row)->glyphs[area][START].face_id; \
23284 gstring = (composition_gstring_from_id \
23285 ((row)->glyphs[area][START].u.cmp.id)); \
23286 s = alloca (sizeof *s); \
23287 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23288 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23289 append_glyph_string (&(HEAD), &(TAIL), s); \
23291 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23295 /* Add a glyph string for a sequence of glyphless character's glyphs
23296 to the list of strings between HEAD and TAIL. The meanings of
23297 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23299 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23304 face_id = (row)->glyphs[area][START].face_id; \
23306 s = alloca (sizeof *s); \
23307 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23308 append_glyph_string (&HEAD, &TAIL, s); \
23310 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23316 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23317 of AREA of glyph row ROW on window W between indices START and END.
23318 HL overrides the face for drawing glyph strings, e.g. it is
23319 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23320 x-positions of the drawing area.
23322 This is an ugly monster macro construct because we must use alloca
23323 to allocate glyph strings (because draw_glyphs can be called
23324 asynchronously). */
23326 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23329 HEAD = TAIL = NULL; \
23330 while (START < END) \
23332 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23333 switch (first_glyph->type) \
23336 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23340 case COMPOSITE_GLYPH: \
23341 if (first_glyph->u.cmp.automatic) \
23342 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23345 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23349 case STRETCH_GLYPH: \
23350 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23354 case IMAGE_GLYPH: \
23355 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23359 case GLYPHLESS_GLYPH: \
23360 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23370 set_glyph_string_background_width (s, START, LAST_X); \
23377 /* Draw glyphs between START and END in AREA of ROW on window W,
23378 starting at x-position X. X is relative to AREA in W. HL is a
23379 face-override with the following meaning:
23381 DRAW_NORMAL_TEXT draw normally
23382 DRAW_CURSOR draw in cursor face
23383 DRAW_MOUSE_FACE draw in mouse face.
23384 DRAW_INVERSE_VIDEO draw in mode line face
23385 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23386 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23388 If OVERLAPS is non-zero, draw only the foreground of characters and
23389 clip to the physical height of ROW. Non-zero value also defines
23390 the overlapping part to be drawn:
23392 OVERLAPS_PRED overlap with preceding rows
23393 OVERLAPS_SUCC overlap with succeeding rows
23394 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23395 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23397 Value is the x-position reached, relative to AREA of W. */
23400 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23401 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23402 enum draw_glyphs_face hl
, int overlaps
)
23404 struct glyph_string
*head
, *tail
;
23405 struct glyph_string
*s
;
23406 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23407 int i
, j
, x_reached
, last_x
, area_left
= 0;
23408 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23411 ALLOCATE_HDC (hdc
, f
);
23413 /* Let's rather be paranoid than getting a SEGV. */
23414 end
= min (end
, row
->used
[area
]);
23415 start
= max (0, start
);
23416 start
= min (end
, start
);
23418 /* Translate X to frame coordinates. Set last_x to the right
23419 end of the drawing area. */
23420 if (row
->full_width_p
)
23422 /* X is relative to the left edge of W, without scroll bars
23424 area_left
= WINDOW_LEFT_EDGE_X (w
);
23425 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23429 area_left
= window_box_left (w
, area
);
23430 last_x
= area_left
+ window_box_width (w
, area
);
23434 /* Build a doubly-linked list of glyph_string structures between
23435 head and tail from what we have to draw. Note that the macro
23436 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23437 the reason we use a separate variable `i'. */
23439 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23441 x_reached
= tail
->x
+ tail
->background_width
;
23445 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23446 the row, redraw some glyphs in front or following the glyph
23447 strings built above. */
23448 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23450 struct glyph_string
*h
, *t
;
23451 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23452 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23453 int check_mouse_face
= 0;
23456 /* If mouse highlighting is on, we may need to draw adjacent
23457 glyphs using mouse-face highlighting. */
23458 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
23460 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23462 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23463 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23465 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23467 check_mouse_face
= 1;
23468 mouse_beg_col
= (row
== mouse_beg_row
)
23469 ? hlinfo
->mouse_face_beg_col
: 0;
23470 mouse_end_col
= (row
== mouse_end_row
)
23471 ? hlinfo
->mouse_face_end_col
23472 : row
->used
[TEXT_AREA
];
23476 /* Compute overhangs for all glyph strings. */
23477 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23478 for (s
= head
; s
; s
= s
->next
)
23479 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23481 /* Prepend glyph strings for glyphs in front of the first glyph
23482 string that are overwritten because of the first glyph
23483 string's left overhang. The background of all strings
23484 prepended must be drawn because the first glyph string
23486 i
= left_overwritten (head
);
23489 enum draw_glyphs_face overlap_hl
;
23491 /* If this row contains mouse highlighting, attempt to draw
23492 the overlapped glyphs with the correct highlight. This
23493 code fails if the overlap encompasses more than one glyph
23494 and mouse-highlight spans only some of these glyphs.
23495 However, making it work perfectly involves a lot more
23496 code, and I don't know if the pathological case occurs in
23497 practice, so we'll stick to this for now. --- cyd */
23498 if (check_mouse_face
23499 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23500 overlap_hl
= DRAW_MOUSE_FACE
;
23502 overlap_hl
= DRAW_NORMAL_TEXT
;
23505 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23506 overlap_hl
, dummy_x
, last_x
);
23508 compute_overhangs_and_x (t
, head
->x
, 1);
23509 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23513 /* Prepend glyph strings for glyphs in front of the first glyph
23514 string that overwrite that glyph string because of their
23515 right overhang. For these strings, only the foreground must
23516 be drawn, because it draws over the glyph string at `head'.
23517 The background must not be drawn because this would overwrite
23518 right overhangs of preceding glyphs for which no glyph
23520 i
= left_overwriting (head
);
23523 enum draw_glyphs_face overlap_hl
;
23525 if (check_mouse_face
23526 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23527 overlap_hl
= DRAW_MOUSE_FACE
;
23529 overlap_hl
= DRAW_NORMAL_TEXT
;
23532 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23533 overlap_hl
, dummy_x
, last_x
);
23534 for (s
= h
; s
; s
= s
->next
)
23535 s
->background_filled_p
= 1;
23536 compute_overhangs_and_x (t
, head
->x
, 1);
23537 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23540 /* Append glyphs strings for glyphs following the last glyph
23541 string tail that are overwritten by tail. The background of
23542 these strings has to be drawn because tail's foreground draws
23544 i
= right_overwritten (tail
);
23547 enum draw_glyphs_face overlap_hl
;
23549 if (check_mouse_face
23550 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23551 overlap_hl
= DRAW_MOUSE_FACE
;
23553 overlap_hl
= DRAW_NORMAL_TEXT
;
23555 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23556 overlap_hl
, x
, last_x
);
23557 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23558 we don't have `end = i;' here. */
23559 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23560 append_glyph_string_lists (&head
, &tail
, h
, t
);
23564 /* Append glyph strings for glyphs following the last glyph
23565 string tail that overwrite tail. The foreground of such
23566 glyphs has to be drawn because it writes into the background
23567 of tail. The background must not be drawn because it could
23568 paint over the foreground of following glyphs. */
23569 i
= right_overwriting (tail
);
23572 enum draw_glyphs_face overlap_hl
;
23573 if (check_mouse_face
23574 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23575 overlap_hl
= DRAW_MOUSE_FACE
;
23577 overlap_hl
= DRAW_NORMAL_TEXT
;
23580 i
++; /* We must include the Ith glyph. */
23581 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23582 overlap_hl
, x
, last_x
);
23583 for (s
= h
; s
; s
= s
->next
)
23584 s
->background_filled_p
= 1;
23585 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23586 append_glyph_string_lists (&head
, &tail
, h
, t
);
23588 if (clip_head
|| clip_tail
)
23589 for (s
= head
; s
; s
= s
->next
)
23591 s
->clip_head
= clip_head
;
23592 s
->clip_tail
= clip_tail
;
23596 /* Draw all strings. */
23597 for (s
= head
; s
; s
= s
->next
)
23598 FRAME_RIF (f
)->draw_glyph_string (s
);
23601 /* When focus a sole frame and move horizontally, this sets on_p to 0
23602 causing a failure to erase prev cursor position. */
23603 if (area
== TEXT_AREA
23604 && !row
->full_width_p
23605 /* When drawing overlapping rows, only the glyph strings'
23606 foreground is drawn, which doesn't erase a cursor
23610 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23611 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23612 : (tail
? tail
->x
+ tail
->background_width
: x
));
23616 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23617 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23621 /* Value is the x-position up to which drawn, relative to AREA of W.
23622 This doesn't include parts drawn because of overhangs. */
23623 if (row
->full_width_p
)
23624 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23626 x_reached
-= area_left
;
23628 RELEASE_HDC (hdc
, f
);
23633 /* Expand row matrix if too narrow. Don't expand if area
23636 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23638 if (!fonts_changed_p \
23639 && (it->glyph_row->glyphs[area] \
23640 < it->glyph_row->glyphs[area + 1])) \
23642 it->w->ncols_scale_factor++; \
23643 fonts_changed_p = 1; \
23647 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23648 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23651 append_glyph (struct it
*it
)
23653 struct glyph
*glyph
;
23654 enum glyph_row_area area
= it
->area
;
23656 eassert (it
->glyph_row
);
23657 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23659 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23660 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23662 /* If the glyph row is reversed, we need to prepend the glyph
23663 rather than append it. */
23664 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23668 /* Make room for the additional glyph. */
23669 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23671 glyph
= it
->glyph_row
->glyphs
[area
];
23673 glyph
->charpos
= CHARPOS (it
->position
);
23674 glyph
->object
= it
->object
;
23675 if (it
->pixel_width
> 0)
23677 glyph
->pixel_width
= it
->pixel_width
;
23678 glyph
->padding_p
= 0;
23682 /* Assure at least 1-pixel width. Otherwise, cursor can't
23683 be displayed correctly. */
23684 glyph
->pixel_width
= 1;
23685 glyph
->padding_p
= 1;
23687 glyph
->ascent
= it
->ascent
;
23688 glyph
->descent
= it
->descent
;
23689 glyph
->voffset
= it
->voffset
;
23690 glyph
->type
= CHAR_GLYPH
;
23691 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23692 glyph
->multibyte_p
= it
->multibyte_p
;
23693 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23694 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23695 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23696 || it
->phys_descent
> it
->descent
);
23697 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23698 glyph
->face_id
= it
->face_id
;
23699 glyph
->u
.ch
= it
->char_to_display
;
23700 glyph
->slice
.img
= null_glyph_slice
;
23701 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23704 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23705 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23707 glyph
->bidi_type
= it
->bidi_it
.type
;
23711 glyph
->resolved_level
= 0;
23712 glyph
->bidi_type
= UNKNOWN_BT
;
23714 ++it
->glyph_row
->used
[area
];
23717 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23720 /* Store one glyph for the composition IT->cmp_it.id in
23721 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23725 append_composite_glyph (struct it
*it
)
23727 struct glyph
*glyph
;
23728 enum glyph_row_area area
= it
->area
;
23730 eassert (it
->glyph_row
);
23732 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23733 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23735 /* If the glyph row is reversed, we need to prepend the glyph
23736 rather than append it. */
23737 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23741 /* Make room for the new glyph. */
23742 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23744 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23746 glyph
->charpos
= it
->cmp_it
.charpos
;
23747 glyph
->object
= it
->object
;
23748 glyph
->pixel_width
= it
->pixel_width
;
23749 glyph
->ascent
= it
->ascent
;
23750 glyph
->descent
= it
->descent
;
23751 glyph
->voffset
= it
->voffset
;
23752 glyph
->type
= COMPOSITE_GLYPH
;
23753 if (it
->cmp_it
.ch
< 0)
23755 glyph
->u
.cmp
.automatic
= 0;
23756 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23757 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23761 glyph
->u
.cmp
.automatic
= 1;
23762 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23763 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23764 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23766 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23767 glyph
->multibyte_p
= it
->multibyte_p
;
23768 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23769 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23770 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23771 || it
->phys_descent
> it
->descent
);
23772 glyph
->padding_p
= 0;
23773 glyph
->glyph_not_available_p
= 0;
23774 glyph
->face_id
= it
->face_id
;
23775 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23778 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23779 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23781 glyph
->bidi_type
= it
->bidi_it
.type
;
23783 ++it
->glyph_row
->used
[area
];
23786 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23790 /* Change IT->ascent and IT->height according to the setting of
23794 take_vertical_position_into_account (struct it
*it
)
23798 if (it
->voffset
< 0)
23799 /* Increase the ascent so that we can display the text higher
23801 it
->ascent
-= it
->voffset
;
23803 /* Increase the descent so that we can display the text lower
23805 it
->descent
+= it
->voffset
;
23810 /* Produce glyphs/get display metrics for the image IT is loaded with.
23811 See the description of struct display_iterator in dispextern.h for
23812 an overview of struct display_iterator. */
23815 produce_image_glyph (struct it
*it
)
23819 int glyph_ascent
, crop
;
23820 struct glyph_slice slice
;
23822 eassert (it
->what
== IT_IMAGE
);
23824 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23826 /* Make sure X resources of the face is loaded. */
23827 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23829 if (it
->image_id
< 0)
23831 /* Fringe bitmap. */
23832 it
->ascent
= it
->phys_ascent
= 0;
23833 it
->descent
= it
->phys_descent
= 0;
23834 it
->pixel_width
= 0;
23839 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23841 /* Make sure X resources of the image is loaded. */
23842 prepare_image_for_display (it
->f
, img
);
23844 slice
.x
= slice
.y
= 0;
23845 slice
.width
= img
->width
;
23846 slice
.height
= img
->height
;
23848 if (INTEGERP (it
->slice
.x
))
23849 slice
.x
= XINT (it
->slice
.x
);
23850 else if (FLOATP (it
->slice
.x
))
23851 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23853 if (INTEGERP (it
->slice
.y
))
23854 slice
.y
= XINT (it
->slice
.y
);
23855 else if (FLOATP (it
->slice
.y
))
23856 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23858 if (INTEGERP (it
->slice
.width
))
23859 slice
.width
= XINT (it
->slice
.width
);
23860 else if (FLOATP (it
->slice
.width
))
23861 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23863 if (INTEGERP (it
->slice
.height
))
23864 slice
.height
= XINT (it
->slice
.height
);
23865 else if (FLOATP (it
->slice
.height
))
23866 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23868 if (slice
.x
>= img
->width
)
23869 slice
.x
= img
->width
;
23870 if (slice
.y
>= img
->height
)
23871 slice
.y
= img
->height
;
23872 if (slice
.x
+ slice
.width
>= img
->width
)
23873 slice
.width
= img
->width
- slice
.x
;
23874 if (slice
.y
+ slice
.height
> img
->height
)
23875 slice
.height
= img
->height
- slice
.y
;
23877 if (slice
.width
== 0 || slice
.height
== 0)
23880 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23882 it
->descent
= slice
.height
- glyph_ascent
;
23884 it
->descent
+= img
->vmargin
;
23885 if (slice
.y
+ slice
.height
== img
->height
)
23886 it
->descent
+= img
->vmargin
;
23887 it
->phys_descent
= it
->descent
;
23889 it
->pixel_width
= slice
.width
;
23891 it
->pixel_width
+= img
->hmargin
;
23892 if (slice
.x
+ slice
.width
== img
->width
)
23893 it
->pixel_width
+= img
->hmargin
;
23895 /* It's quite possible for images to have an ascent greater than
23896 their height, so don't get confused in that case. */
23897 if (it
->descent
< 0)
23902 if (face
->box
!= FACE_NO_BOX
)
23904 if (face
->box_line_width
> 0)
23907 it
->ascent
+= face
->box_line_width
;
23908 if (slice
.y
+ slice
.height
== img
->height
)
23909 it
->descent
+= face
->box_line_width
;
23912 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23913 it
->pixel_width
+= eabs (face
->box_line_width
);
23914 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23915 it
->pixel_width
+= eabs (face
->box_line_width
);
23918 take_vertical_position_into_account (it
);
23920 /* Automatically crop wide image glyphs at right edge so we can
23921 draw the cursor on same display row. */
23922 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23923 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23925 it
->pixel_width
-= crop
;
23926 slice
.width
-= crop
;
23931 struct glyph
*glyph
;
23932 enum glyph_row_area area
= it
->area
;
23934 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23935 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23937 glyph
->charpos
= CHARPOS (it
->position
);
23938 glyph
->object
= it
->object
;
23939 glyph
->pixel_width
= it
->pixel_width
;
23940 glyph
->ascent
= glyph_ascent
;
23941 glyph
->descent
= it
->descent
;
23942 glyph
->voffset
= it
->voffset
;
23943 glyph
->type
= IMAGE_GLYPH
;
23944 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23945 glyph
->multibyte_p
= it
->multibyte_p
;
23946 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23947 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23948 glyph
->overlaps_vertically_p
= 0;
23949 glyph
->padding_p
= 0;
23950 glyph
->glyph_not_available_p
= 0;
23951 glyph
->face_id
= it
->face_id
;
23952 glyph
->u
.img_id
= img
->id
;
23953 glyph
->slice
.img
= slice
;
23954 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23957 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23958 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23960 glyph
->bidi_type
= it
->bidi_it
.type
;
23962 ++it
->glyph_row
->used
[area
];
23965 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23970 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23971 of the glyph, WIDTH and HEIGHT are the width and height of the
23972 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23975 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23976 int width
, int height
, int ascent
)
23978 struct glyph
*glyph
;
23979 enum glyph_row_area area
= it
->area
;
23981 eassert (ascent
>= 0 && ascent
<= height
);
23983 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23984 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23986 /* If the glyph row is reversed, we need to prepend the glyph
23987 rather than append it. */
23988 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23992 /* Make room for the additional glyph. */
23993 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23995 glyph
= it
->glyph_row
->glyphs
[area
];
23997 glyph
->charpos
= CHARPOS (it
->position
);
23998 glyph
->object
= object
;
23999 glyph
->pixel_width
= width
;
24000 glyph
->ascent
= ascent
;
24001 glyph
->descent
= height
- ascent
;
24002 glyph
->voffset
= it
->voffset
;
24003 glyph
->type
= STRETCH_GLYPH
;
24004 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24005 glyph
->multibyte_p
= it
->multibyte_p
;
24006 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24007 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24008 glyph
->overlaps_vertically_p
= 0;
24009 glyph
->padding_p
= 0;
24010 glyph
->glyph_not_available_p
= 0;
24011 glyph
->face_id
= it
->face_id
;
24012 glyph
->u
.stretch
.ascent
= ascent
;
24013 glyph
->u
.stretch
.height
= height
;
24014 glyph
->slice
.img
= null_glyph_slice
;
24015 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24018 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24019 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24021 glyph
->bidi_type
= it
->bidi_it
.type
;
24025 glyph
->resolved_level
= 0;
24026 glyph
->bidi_type
= UNKNOWN_BT
;
24028 ++it
->glyph_row
->used
[area
];
24031 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24034 #endif /* HAVE_WINDOW_SYSTEM */
24036 /* Produce a stretch glyph for iterator IT. IT->object is the value
24037 of the glyph property displayed. The value must be a list
24038 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
24041 1. `:width WIDTH' specifies that the space should be WIDTH *
24042 canonical char width wide. WIDTH may be an integer or floating
24045 2. `:relative-width FACTOR' specifies that the width of the stretch
24046 should be computed from the width of the first character having the
24047 `glyph' property, and should be FACTOR times that width.
24049 3. `:align-to HPOS' specifies that the space should be wide enough
24050 to reach HPOS, a value in canonical character units.
24052 Exactly one of the above pairs must be present.
24054 4. `:height HEIGHT' specifies that the height of the stretch produced
24055 should be HEIGHT, measured in canonical character units.
24057 5. `:relative-height FACTOR' specifies that the height of the
24058 stretch should be FACTOR times the height of the characters having
24059 the glyph property.
24061 Either none or exactly one of 4 or 5 must be present.
24063 6. `:ascent ASCENT' specifies that ASCENT percent of the height
24064 of the stretch should be used for the ascent of the stretch.
24065 ASCENT must be in the range 0 <= ASCENT <= 100. */
24068 produce_stretch_glyph (struct it
*it
)
24070 /* (space :width WIDTH :height HEIGHT ...) */
24071 Lisp_Object prop
, plist
;
24072 int width
= 0, height
= 0, align_to
= -1;
24073 int zero_width_ok_p
= 0;
24076 struct face
*face
= NULL
;
24077 struct font
*font
= NULL
;
24079 #ifdef HAVE_WINDOW_SYSTEM
24080 int zero_height_ok_p
= 0;
24082 if (FRAME_WINDOW_P (it
->f
))
24084 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24085 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24086 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24090 /* List should start with `space'. */
24091 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
24092 plist
= XCDR (it
->object
);
24094 /* Compute the width of the stretch. */
24095 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
24096 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
24098 /* Absolute width `:width WIDTH' specified and valid. */
24099 zero_width_ok_p
= 1;
24102 #ifdef HAVE_WINDOW_SYSTEM
24103 else if (FRAME_WINDOW_P (it
->f
)
24104 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
24106 /* Relative width `:relative-width FACTOR' specified and valid.
24107 Compute the width of the characters having the `glyph'
24110 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
24113 if (it
->multibyte_p
)
24114 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
24117 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
24118 if (! ASCII_CHAR_P (it2
.c
))
24119 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
24122 it2
.glyph_row
= NULL
;
24123 it2
.what
= IT_CHARACTER
;
24124 x_produce_glyphs (&it2
);
24125 width
= NUMVAL (prop
) * it2
.pixel_width
;
24127 #endif /* HAVE_WINDOW_SYSTEM */
24128 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
24129 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
24131 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
24132 align_to
= (align_to
< 0
24134 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
24135 else if (align_to
< 0)
24136 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
24137 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
24138 zero_width_ok_p
= 1;
24141 /* Nothing specified -> width defaults to canonical char width. */
24142 width
= FRAME_COLUMN_WIDTH (it
->f
);
24144 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
24147 #ifdef HAVE_WINDOW_SYSTEM
24148 /* Compute height. */
24149 if (FRAME_WINDOW_P (it
->f
))
24151 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
24152 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24155 zero_height_ok_p
= 1;
24157 else if (prop
= Fplist_get (plist
, QCrelative_height
),
24159 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
24161 height
= FONT_HEIGHT (font
);
24163 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
24166 /* Compute percentage of height used for ascent. If
24167 `:ascent ASCENT' is present and valid, use that. Otherwise,
24168 derive the ascent from the font in use. */
24169 if (prop
= Fplist_get (plist
, QCascent
),
24170 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
24171 ascent
= height
* NUMVAL (prop
) / 100.0;
24172 else if (!NILP (prop
)
24173 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24174 ascent
= min (max (0, (int)tem
), height
);
24176 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
24179 #endif /* HAVE_WINDOW_SYSTEM */
24182 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24183 && it
->current_x
+ width
> it
->last_visible_x
)
24185 width
= it
->last_visible_x
- it
->current_x
;
24186 #ifdef HAVE_WINDOW_SYSTEM
24187 /* Subtract one more pixel from the stretch width, but only on
24188 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24189 width
-= FRAME_WINDOW_P (it
->f
);
24193 if (width
> 0 && height
> 0 && it
->glyph_row
)
24195 Lisp_Object o_object
= it
->object
;
24196 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24199 if (!STRINGP (object
))
24200 object
= it
->w
->buffer
;
24201 #ifdef HAVE_WINDOW_SYSTEM
24202 if (FRAME_WINDOW_P (it
->f
))
24203 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24207 it
->object
= object
;
24208 it
->char_to_display
= ' ';
24209 it
->pixel_width
= it
->len
= 1;
24211 tty_append_glyph (it
);
24212 it
->object
= o_object
;
24216 it
->pixel_width
= width
;
24217 #ifdef HAVE_WINDOW_SYSTEM
24218 if (FRAME_WINDOW_P (it
->f
))
24220 it
->ascent
= it
->phys_ascent
= ascent
;
24221 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24222 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24223 take_vertical_position_into_account (it
);
24227 it
->nglyphs
= width
;
24230 /* Get information about special display element WHAT in an
24231 environment described by IT. WHAT is one of IT_TRUNCATION or
24232 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24233 non-null glyph_row member. This function ensures that fields like
24234 face_id, c, len of IT are left untouched. */
24237 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
24244 temp_it
.object
= make_number (0);
24245 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
24247 if (what
== IT_CONTINUATION
)
24249 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24250 if (it
->bidi_it
.paragraph_dir
== R2L
)
24251 SET_GLYPH_FROM_CHAR (glyph
, '/');
24253 SET_GLYPH_FROM_CHAR (glyph
, '\\');
24255 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24257 /* FIXME: Should we mirror GC for R2L lines? */
24258 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24259 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24262 else if (what
== IT_TRUNCATION
)
24264 /* Truncation glyph. */
24265 SET_GLYPH_FROM_CHAR (glyph
, '$');
24267 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24269 /* FIXME: Should we mirror GC for R2L lines? */
24270 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24271 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24277 #ifdef HAVE_WINDOW_SYSTEM
24278 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24279 is turned off, we precede the truncation/continuation glyphs by a
24280 stretch glyph whose width is computed such that these special
24281 glyphs are aligned at the window margin, even when very different
24282 fonts are used in different glyph rows. */
24283 if (FRAME_WINDOW_P (temp_it
.f
)
24284 /* init_iterator calls this with it->glyph_row == NULL, and it
24285 wants only the pixel width of the truncation/continuation
24287 && temp_it
.glyph_row
24288 /* insert_left_trunc_glyphs calls us at the beginning of the
24289 row, and it has its own calculation of the stretch glyph
24291 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
24292 && (temp_it
.glyph_row
->reversed_p
24293 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
24294 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
24296 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
24298 if (stretch_width
> 0)
24300 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
24301 struct font
*font
=
24302 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
24303 int stretch_ascent
=
24304 (((temp_it
.ascent
+ temp_it
.descent
)
24305 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
24307 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
24308 temp_it
.ascent
+ temp_it
.descent
,
24315 temp_it
.what
= IT_CHARACTER
;
24317 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
24318 temp_it
.face_id
= GLYPH_FACE (glyph
);
24319 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
24321 PRODUCE_GLYPHS (&temp_it
);
24322 it
->pixel_width
= temp_it
.pixel_width
;
24323 it
->nglyphs
= temp_it
.pixel_width
;
24326 #ifdef HAVE_WINDOW_SYSTEM
24328 /* Calculate line-height and line-spacing properties.
24329 An integer value specifies explicit pixel value.
24330 A float value specifies relative value to current face height.
24331 A cons (float . face-name) specifies relative value to
24332 height of specified face font.
24334 Returns height in pixels, or nil. */
24338 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24339 int boff
, int override
)
24341 Lisp_Object face_name
= Qnil
;
24342 int ascent
, descent
, height
;
24344 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24349 face_name
= XCAR (val
);
24351 if (!NUMBERP (val
))
24352 val
= make_number (1);
24353 if (NILP (face_name
))
24355 height
= it
->ascent
+ it
->descent
;
24360 if (NILP (face_name
))
24362 font
= FRAME_FONT (it
->f
);
24363 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24365 else if (EQ (face_name
, Qt
))
24374 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24376 return make_number (-1);
24378 face
= FACE_FROM_ID (it
->f
, face_id
);
24381 return make_number (-1);
24382 boff
= font
->baseline_offset
;
24383 if (font
->vertical_centering
)
24384 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24387 ascent
= FONT_BASE (font
) + boff
;
24388 descent
= FONT_DESCENT (font
) - boff
;
24392 it
->override_ascent
= ascent
;
24393 it
->override_descent
= descent
;
24394 it
->override_boff
= boff
;
24397 height
= ascent
+ descent
;
24401 height
= (int)(XFLOAT_DATA (val
) * height
);
24402 else if (INTEGERP (val
))
24403 height
*= XINT (val
);
24405 return make_number (height
);
24409 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24410 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24411 and only if this is for a character for which no font was found.
24413 If the display method (it->glyphless_method) is
24414 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24415 length of the acronym or the hexadecimal string, UPPER_XOFF and
24416 UPPER_YOFF are pixel offsets for the upper part of the string,
24417 LOWER_XOFF and LOWER_YOFF are for the lower part.
24419 For the other display methods, LEN through LOWER_YOFF are zero. */
24422 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24423 short upper_xoff
, short upper_yoff
,
24424 short lower_xoff
, short lower_yoff
)
24426 struct glyph
*glyph
;
24427 enum glyph_row_area area
= it
->area
;
24429 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24430 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24432 /* If the glyph row is reversed, we need to prepend the glyph
24433 rather than append it. */
24434 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24438 /* Make room for the additional glyph. */
24439 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24441 glyph
= it
->glyph_row
->glyphs
[area
];
24443 glyph
->charpos
= CHARPOS (it
->position
);
24444 glyph
->object
= it
->object
;
24445 glyph
->pixel_width
= it
->pixel_width
;
24446 glyph
->ascent
= it
->ascent
;
24447 glyph
->descent
= it
->descent
;
24448 glyph
->voffset
= it
->voffset
;
24449 glyph
->type
= GLYPHLESS_GLYPH
;
24450 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24451 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24452 glyph
->u
.glyphless
.len
= len
;
24453 glyph
->u
.glyphless
.ch
= it
->c
;
24454 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24455 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24456 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24457 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24458 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24459 glyph
->multibyte_p
= it
->multibyte_p
;
24460 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24461 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24462 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24463 || it
->phys_descent
> it
->descent
);
24464 glyph
->padding_p
= 0;
24465 glyph
->glyph_not_available_p
= 0;
24466 glyph
->face_id
= face_id
;
24467 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24470 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24471 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24473 glyph
->bidi_type
= it
->bidi_it
.type
;
24475 ++it
->glyph_row
->used
[area
];
24478 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24482 /* Produce a glyph for a glyphless character for iterator IT.
24483 IT->glyphless_method specifies which method to use for displaying
24484 the character. See the description of enum
24485 glyphless_display_method in dispextern.h for the detail.
24487 FOR_NO_FONT is nonzero if and only if this is for a character for
24488 which no font was found. ACRONYM, if non-nil, is an acronym string
24489 for the character. */
24492 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24497 int base_width
, base_height
, width
, height
;
24498 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24501 /* Get the metrics of the base font. We always refer to the current
24503 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24504 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24505 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24506 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24507 base_height
= it
->ascent
+ it
->descent
;
24508 base_width
= font
->average_width
;
24510 /* Get a face ID for the glyph by utilizing a cache (the same way as
24511 done for `escape-glyph' in get_next_display_element). */
24512 if (it
->f
== last_glyphless_glyph_frame
24513 && it
->face_id
== last_glyphless_glyph_face_id
)
24515 face_id
= last_glyphless_glyph_merged_face_id
;
24519 /* Merge the `glyphless-char' face into the current face. */
24520 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24521 last_glyphless_glyph_frame
= it
->f
;
24522 last_glyphless_glyph_face_id
= it
->face_id
;
24523 last_glyphless_glyph_merged_face_id
= face_id
;
24526 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24528 it
->pixel_width
= THIN_SPACE_WIDTH
;
24530 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24532 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24534 width
= CHAR_WIDTH (it
->c
);
24537 else if (width
> 4)
24539 it
->pixel_width
= base_width
* width
;
24541 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24547 unsigned int code
[6];
24549 int ascent
, descent
;
24550 struct font_metrics metrics_upper
, metrics_lower
;
24552 face
= FACE_FROM_ID (it
->f
, face_id
);
24553 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24554 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24556 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24558 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24559 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24560 if (CONSP (acronym
))
24561 acronym
= XCAR (acronym
);
24562 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24566 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24567 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24570 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24571 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24572 upper_len
= (len
+ 1) / 2;
24573 font
->driver
->text_extents (font
, code
, upper_len
,
24575 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24580 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24581 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24582 upper_xoff
= upper_yoff
= 2; /* the typical case */
24583 if (base_width
>= width
)
24585 /* Align the upper to the left, the lower to the right. */
24586 it
->pixel_width
= base_width
;
24587 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24591 /* Center the shorter one. */
24592 it
->pixel_width
= width
;
24593 if (metrics_upper
.width
>= metrics_lower
.width
)
24594 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24597 /* FIXME: This code doesn't look right. It formerly was
24598 missing the "lower_xoff = 0;", which couldn't have
24599 been right since it left lower_xoff uninitialized. */
24601 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24605 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24606 top, bottom, and between upper and lower strings. */
24607 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24608 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24609 /* Center vertically.
24610 H:base_height, D:base_descent
24611 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24613 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24614 descent = D - H/2 + h/2;
24615 lower_yoff = descent - 2 - ld;
24616 upper_yoff = lower_yoff - la - 1 - ud; */
24617 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24618 descent
= it
->descent
- (base_height
- height
) / 2;
24619 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24620 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24621 - metrics_upper
.descent
);
24622 /* Don't make the height shorter than the base height. */
24623 if (height
> base_height
)
24625 it
->ascent
= ascent
;
24626 it
->descent
= descent
;
24630 it
->phys_ascent
= it
->ascent
;
24631 it
->phys_descent
= it
->descent
;
24633 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24634 upper_xoff
, upper_yoff
,
24635 lower_xoff
, lower_yoff
);
24637 take_vertical_position_into_account (it
);
24642 Produce glyphs/get display metrics for the display element IT is
24643 loaded with. See the description of struct it in dispextern.h
24644 for an overview of struct it. */
24647 x_produce_glyphs (struct it
*it
)
24649 int extra_line_spacing
= it
->extra_line_spacing
;
24651 it
->glyph_not_available_p
= 0;
24653 if (it
->what
== IT_CHARACTER
)
24656 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24657 struct font
*font
= face
->font
;
24658 struct font_metrics
*pcm
= NULL
;
24659 int boff
; /* baseline offset */
24663 /* When no suitable font is found, display this character by
24664 the method specified in the first extra slot of
24665 Vglyphless_char_display. */
24666 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24668 eassert (it
->what
== IT_GLYPHLESS
);
24669 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24673 boff
= font
->baseline_offset
;
24674 if (font
->vertical_centering
)
24675 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24677 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24683 if (it
->override_ascent
>= 0)
24685 it
->ascent
= it
->override_ascent
;
24686 it
->descent
= it
->override_descent
;
24687 boff
= it
->override_boff
;
24691 it
->ascent
= FONT_BASE (font
) + boff
;
24692 it
->descent
= FONT_DESCENT (font
) - boff
;
24695 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24697 pcm
= get_per_char_metric (font
, &char2b
);
24698 if (pcm
->width
== 0
24699 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24705 it
->phys_ascent
= pcm
->ascent
+ boff
;
24706 it
->phys_descent
= pcm
->descent
- boff
;
24707 it
->pixel_width
= pcm
->width
;
24711 it
->glyph_not_available_p
= 1;
24712 it
->phys_ascent
= it
->ascent
;
24713 it
->phys_descent
= it
->descent
;
24714 it
->pixel_width
= font
->space_width
;
24717 if (it
->constrain_row_ascent_descent_p
)
24719 if (it
->descent
> it
->max_descent
)
24721 it
->ascent
+= it
->descent
- it
->max_descent
;
24722 it
->descent
= it
->max_descent
;
24724 if (it
->ascent
> it
->max_ascent
)
24726 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24727 it
->ascent
= it
->max_ascent
;
24729 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24730 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24731 extra_line_spacing
= 0;
24734 /* If this is a space inside a region of text with
24735 `space-width' property, change its width. */
24736 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24738 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24740 /* If face has a box, add the box thickness to the character
24741 height. If character has a box line to the left and/or
24742 right, add the box line width to the character's width. */
24743 if (face
->box
!= FACE_NO_BOX
)
24745 int thick
= face
->box_line_width
;
24749 it
->ascent
+= thick
;
24750 it
->descent
+= thick
;
24755 if (it
->start_of_box_run_p
)
24756 it
->pixel_width
+= thick
;
24757 if (it
->end_of_box_run_p
)
24758 it
->pixel_width
+= thick
;
24761 /* If face has an overline, add the height of the overline
24762 (1 pixel) and a 1 pixel margin to the character height. */
24763 if (face
->overline_p
)
24764 it
->ascent
+= overline_margin
;
24766 if (it
->constrain_row_ascent_descent_p
)
24768 if (it
->ascent
> it
->max_ascent
)
24769 it
->ascent
= it
->max_ascent
;
24770 if (it
->descent
> it
->max_descent
)
24771 it
->descent
= it
->max_descent
;
24774 take_vertical_position_into_account (it
);
24776 /* If we have to actually produce glyphs, do it. */
24781 /* Translate a space with a `space-width' property
24782 into a stretch glyph. */
24783 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24784 / FONT_HEIGHT (font
));
24785 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24786 it
->ascent
+ it
->descent
, ascent
);
24791 /* If characters with lbearing or rbearing are displayed
24792 in this line, record that fact in a flag of the
24793 glyph row. This is used to optimize X output code. */
24794 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24795 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24797 if (! stretched_p
&& it
->pixel_width
== 0)
24798 /* We assure that all visible glyphs have at least 1-pixel
24800 it
->pixel_width
= 1;
24802 else if (it
->char_to_display
== '\n')
24804 /* A newline has no width, but we need the height of the
24805 line. But if previous part of the line sets a height,
24806 don't increase that height */
24808 Lisp_Object height
;
24809 Lisp_Object total_height
= Qnil
;
24811 it
->override_ascent
= -1;
24812 it
->pixel_width
= 0;
24815 height
= get_it_property (it
, Qline_height
);
24816 /* Split (line-height total-height) list */
24818 && CONSP (XCDR (height
))
24819 && NILP (XCDR (XCDR (height
))))
24821 total_height
= XCAR (XCDR (height
));
24822 height
= XCAR (height
);
24824 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24826 if (it
->override_ascent
>= 0)
24828 it
->ascent
= it
->override_ascent
;
24829 it
->descent
= it
->override_descent
;
24830 boff
= it
->override_boff
;
24834 it
->ascent
= FONT_BASE (font
) + boff
;
24835 it
->descent
= FONT_DESCENT (font
) - boff
;
24838 if (EQ (height
, Qt
))
24840 if (it
->descent
> it
->max_descent
)
24842 it
->ascent
+= it
->descent
- it
->max_descent
;
24843 it
->descent
= it
->max_descent
;
24845 if (it
->ascent
> it
->max_ascent
)
24847 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24848 it
->ascent
= it
->max_ascent
;
24850 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24851 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24852 it
->constrain_row_ascent_descent_p
= 1;
24853 extra_line_spacing
= 0;
24857 Lisp_Object spacing
;
24859 it
->phys_ascent
= it
->ascent
;
24860 it
->phys_descent
= it
->descent
;
24862 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24863 && face
->box
!= FACE_NO_BOX
24864 && face
->box_line_width
> 0)
24866 it
->ascent
+= face
->box_line_width
;
24867 it
->descent
+= face
->box_line_width
;
24870 && XINT (height
) > it
->ascent
+ it
->descent
)
24871 it
->ascent
= XINT (height
) - it
->descent
;
24873 if (!NILP (total_height
))
24874 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24877 spacing
= get_it_property (it
, Qline_spacing
);
24878 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24880 if (INTEGERP (spacing
))
24882 extra_line_spacing
= XINT (spacing
);
24883 if (!NILP (total_height
))
24884 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24888 else /* i.e. (it->char_to_display == '\t') */
24890 if (font
->space_width
> 0)
24892 int tab_width
= it
->tab_width
* font
->space_width
;
24893 int x
= it
->current_x
+ it
->continuation_lines_width
;
24894 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24896 /* If the distance from the current position to the next tab
24897 stop is less than a space character width, use the
24898 tab stop after that. */
24899 if (next_tab_x
- x
< font
->space_width
)
24900 next_tab_x
+= tab_width
;
24902 it
->pixel_width
= next_tab_x
- x
;
24904 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24905 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24909 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24910 it
->ascent
+ it
->descent
, it
->ascent
);
24915 it
->pixel_width
= 0;
24920 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24922 /* A static composition.
24924 Note: A composition is represented as one glyph in the
24925 glyph matrix. There are no padding glyphs.
24927 Important note: pixel_width, ascent, and descent are the
24928 values of what is drawn by draw_glyphs (i.e. the values of
24929 the overall glyphs composed). */
24930 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24931 int boff
; /* baseline offset */
24932 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24933 int glyph_len
= cmp
->glyph_len
;
24934 struct font
*font
= face
->font
;
24938 /* If we have not yet calculated pixel size data of glyphs of
24939 the composition for the current face font, calculate them
24940 now. Theoretically, we have to check all fonts for the
24941 glyphs, but that requires much time and memory space. So,
24942 here we check only the font of the first glyph. This may
24943 lead to incorrect display, but it's very rare, and C-l
24944 (recenter-top-bottom) can correct the display anyway. */
24945 if (! cmp
->font
|| cmp
->font
!= font
)
24947 /* Ascent and descent of the font of the first character
24948 of this composition (adjusted by baseline offset).
24949 Ascent and descent of overall glyphs should not be less
24950 than these, respectively. */
24951 int font_ascent
, font_descent
, font_height
;
24952 /* Bounding box of the overall glyphs. */
24953 int leftmost
, rightmost
, lowest
, highest
;
24954 int lbearing
, rbearing
;
24955 int i
, width
, ascent
, descent
;
24956 int left_padded
= 0, right_padded
= 0;
24957 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24959 struct font_metrics
*pcm
;
24960 int font_not_found_p
;
24963 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24964 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24966 if (glyph_len
< cmp
->glyph_len
)
24968 for (i
= 0; i
< glyph_len
; i
++)
24970 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24972 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24977 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24978 : IT_CHARPOS (*it
));
24979 /* If no suitable font is found, use the default font. */
24980 font_not_found_p
= font
== NULL
;
24981 if (font_not_found_p
)
24983 face
= face
->ascii_face
;
24986 boff
= font
->baseline_offset
;
24987 if (font
->vertical_centering
)
24988 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24989 font_ascent
= FONT_BASE (font
) + boff
;
24990 font_descent
= FONT_DESCENT (font
) - boff
;
24991 font_height
= FONT_HEIGHT (font
);
24996 if (! font_not_found_p
)
24998 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
25000 pcm
= get_per_char_metric (font
, &char2b
);
25003 /* Initialize the bounding box. */
25006 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
25007 ascent
= pcm
->ascent
;
25008 descent
= pcm
->descent
;
25009 lbearing
= pcm
->lbearing
;
25010 rbearing
= pcm
->rbearing
;
25014 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
25015 ascent
= FONT_BASE (font
);
25016 descent
= FONT_DESCENT (font
);
25023 lowest
= - descent
+ boff
;
25024 highest
= ascent
+ boff
;
25026 if (! font_not_found_p
25027 && font
->default_ascent
25028 && CHAR_TABLE_P (Vuse_default_ascent
)
25029 && !NILP (Faref (Vuse_default_ascent
,
25030 make_number (it
->char_to_display
))))
25031 highest
= font
->default_ascent
+ boff
;
25033 /* Draw the first glyph at the normal position. It may be
25034 shifted to right later if some other glyphs are drawn
25036 cmp
->offsets
[i
* 2] = 0;
25037 cmp
->offsets
[i
* 2 + 1] = boff
;
25038 cmp
->lbearing
= lbearing
;
25039 cmp
->rbearing
= rbearing
;
25041 /* Set cmp->offsets for the remaining glyphs. */
25042 for (i
++; i
< glyph_len
; i
++)
25044 int left
, right
, btm
, top
;
25045 int ch
= COMPOSITION_GLYPH (cmp
, i
);
25047 struct face
*this_face
;
25051 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
25052 this_face
= FACE_FROM_ID (it
->f
, face_id
);
25053 font
= this_face
->font
;
25059 get_char_face_and_encoding (it
->f
, ch
, face_id
,
25061 pcm
= get_per_char_metric (font
, &char2b
);
25064 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25067 width
= pcm
->width
;
25068 ascent
= pcm
->ascent
;
25069 descent
= pcm
->descent
;
25070 lbearing
= pcm
->lbearing
;
25071 rbearing
= pcm
->rbearing
;
25072 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
25074 /* Relative composition with or without
25075 alternate chars. */
25076 left
= (leftmost
+ rightmost
- width
) / 2;
25077 btm
= - descent
+ boff
;
25078 if (font
->relative_compose
25079 && (! CHAR_TABLE_P (Vignore_relative_composition
)
25080 || NILP (Faref (Vignore_relative_composition
,
25081 make_number (ch
)))))
25084 if (- descent
>= font
->relative_compose
)
25085 /* One extra pixel between two glyphs. */
25087 else if (ascent
<= 0)
25088 /* One extra pixel between two glyphs. */
25089 btm
= lowest
- 1 - ascent
- descent
;
25094 /* A composition rule is specified by an integer
25095 value that encodes global and new reference
25096 points (GREF and NREF). GREF and NREF are
25097 specified by numbers as below:
25099 0---1---2 -- ascent
25103 9--10--11 -- center
25105 ---3---4---5--- baseline
25107 6---7---8 -- descent
25109 int rule
= COMPOSITION_RULE (cmp
, i
);
25110 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
25112 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
25113 grefx
= gref
% 3, nrefx
= nref
% 3;
25114 grefy
= gref
/ 3, nrefy
= nref
/ 3;
25116 xoff
= font_height
* (xoff
- 128) / 256;
25118 yoff
= font_height
* (yoff
- 128) / 256;
25121 + grefx
* (rightmost
- leftmost
) / 2
25122 - nrefx
* width
/ 2
25125 btm
= ((grefy
== 0 ? highest
25127 : grefy
== 2 ? lowest
25128 : (highest
+ lowest
) / 2)
25129 - (nrefy
== 0 ? ascent
+ descent
25130 : nrefy
== 1 ? descent
- boff
25132 : (ascent
+ descent
) / 2)
25136 cmp
->offsets
[i
* 2] = left
;
25137 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
25139 /* Update the bounding box of the overall glyphs. */
25142 right
= left
+ width
;
25143 if (left
< leftmost
)
25145 if (right
> rightmost
)
25148 top
= btm
+ descent
+ ascent
;
25154 if (cmp
->lbearing
> left
+ lbearing
)
25155 cmp
->lbearing
= left
+ lbearing
;
25156 if (cmp
->rbearing
< left
+ rbearing
)
25157 cmp
->rbearing
= left
+ rbearing
;
25161 /* If there are glyphs whose x-offsets are negative,
25162 shift all glyphs to the right and make all x-offsets
25166 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25167 cmp
->offsets
[i
* 2] -= leftmost
;
25168 rightmost
-= leftmost
;
25169 cmp
->lbearing
-= leftmost
;
25170 cmp
->rbearing
-= leftmost
;
25173 if (left_padded
&& cmp
->lbearing
< 0)
25175 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25176 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
25177 rightmost
-= cmp
->lbearing
;
25178 cmp
->rbearing
-= cmp
->lbearing
;
25181 if (right_padded
&& rightmost
< cmp
->rbearing
)
25183 rightmost
= cmp
->rbearing
;
25186 cmp
->pixel_width
= rightmost
;
25187 cmp
->ascent
= highest
;
25188 cmp
->descent
= - lowest
;
25189 if (cmp
->ascent
< font_ascent
)
25190 cmp
->ascent
= font_ascent
;
25191 if (cmp
->descent
< font_descent
)
25192 cmp
->descent
= font_descent
;
25196 && (cmp
->lbearing
< 0
25197 || cmp
->rbearing
> cmp
->pixel_width
))
25198 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25200 it
->pixel_width
= cmp
->pixel_width
;
25201 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
25202 it
->descent
= it
->phys_descent
= cmp
->descent
;
25203 if (face
->box
!= FACE_NO_BOX
)
25205 int thick
= face
->box_line_width
;
25209 it
->ascent
+= thick
;
25210 it
->descent
+= thick
;
25215 if (it
->start_of_box_run_p
)
25216 it
->pixel_width
+= thick
;
25217 if (it
->end_of_box_run_p
)
25218 it
->pixel_width
+= thick
;
25221 /* If face has an overline, add the height of the overline
25222 (1 pixel) and a 1 pixel margin to the character height. */
25223 if (face
->overline_p
)
25224 it
->ascent
+= overline_margin
;
25226 take_vertical_position_into_account (it
);
25227 if (it
->ascent
< 0)
25229 if (it
->descent
< 0)
25232 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
25233 append_composite_glyph (it
);
25235 else if (it
->what
== IT_COMPOSITION
)
25237 /* A dynamic (automatic) composition. */
25238 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25239 Lisp_Object gstring
;
25240 struct font_metrics metrics
;
25244 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
25246 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
25249 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
25250 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25251 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
25252 it
->descent
= it
->phys_descent
= metrics
.descent
;
25253 if (face
->box
!= FACE_NO_BOX
)
25255 int thick
= face
->box_line_width
;
25259 it
->ascent
+= thick
;
25260 it
->descent
+= thick
;
25265 if (it
->start_of_box_run_p
)
25266 it
->pixel_width
+= thick
;
25267 if (it
->end_of_box_run_p
)
25268 it
->pixel_width
+= thick
;
25270 /* If face has an overline, add the height of the overline
25271 (1 pixel) and a 1 pixel margin to the character height. */
25272 if (face
->overline_p
)
25273 it
->ascent
+= overline_margin
;
25274 take_vertical_position_into_account (it
);
25275 if (it
->ascent
< 0)
25277 if (it
->descent
< 0)
25281 append_composite_glyph (it
);
25283 else if (it
->what
== IT_GLYPHLESS
)
25284 produce_glyphless_glyph (it
, 0, Qnil
);
25285 else if (it
->what
== IT_IMAGE
)
25286 produce_image_glyph (it
);
25287 else if (it
->what
== IT_STRETCH
)
25288 produce_stretch_glyph (it
);
25291 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25292 because this isn't true for images with `:ascent 100'. */
25293 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
25294 if (it
->area
== TEXT_AREA
)
25295 it
->current_x
+= it
->pixel_width
;
25297 if (extra_line_spacing
> 0)
25299 it
->descent
+= extra_line_spacing
;
25300 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25301 it
->max_extra_line_spacing
= extra_line_spacing
;
25304 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25305 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25306 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25307 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25311 Output LEN glyphs starting at START at the nominal cursor position.
25312 Advance the nominal cursor over the text. The global variable
25313 updated_window contains the window being updated, updated_row is
25314 the glyph row being updated, and updated_area is the area of that
25315 row being updated. */
25318 x_write_glyphs (struct glyph
*start
, int len
)
25320 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25322 eassert (updated_window
&& updated_row
);
25323 /* When the window is hscrolled, cursor hpos can legitimately be out
25324 of bounds, but we draw the cursor at the corresponding window
25325 margin in that case. */
25326 if (!updated_row
->reversed_p
&& chpos
< 0)
25328 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25329 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25333 /* Write glyphs. */
25335 hpos
= start
- updated_row
->glyphs
[updated_area
];
25336 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25337 updated_row
, updated_area
,
25339 DRAW_NORMAL_TEXT
, 0);
25341 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25342 if (updated_area
== TEXT_AREA
25343 && updated_window
->phys_cursor_on_p
25344 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25346 && chpos
< hpos
+ len
)
25347 updated_window
->phys_cursor_on_p
= 0;
25351 /* Advance the output cursor. */
25352 output_cursor
.hpos
+= len
;
25353 output_cursor
.x
= x
;
25358 Insert LEN glyphs from START at the nominal cursor position. */
25361 x_insert_glyphs (struct glyph
*start
, int len
)
25365 int line_height
, shift_by_width
, shifted_region_width
;
25366 struct glyph_row
*row
;
25367 struct glyph
*glyph
;
25368 int frame_x
, frame_y
;
25371 eassert (updated_window
&& updated_row
);
25373 w
= updated_window
;
25374 f
= XFRAME (WINDOW_FRAME (w
));
25376 /* Get the height of the line we are in. */
25378 line_height
= row
->height
;
25380 /* Get the width of the glyphs to insert. */
25381 shift_by_width
= 0;
25382 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25383 shift_by_width
+= glyph
->pixel_width
;
25385 /* Get the width of the region to shift right. */
25386 shifted_region_width
= (window_box_width (w
, updated_area
)
25391 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25392 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25394 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25395 line_height
, shift_by_width
);
25397 /* Write the glyphs. */
25398 hpos
= start
- row
->glyphs
[updated_area
];
25399 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25401 DRAW_NORMAL_TEXT
, 0);
25403 /* Advance the output cursor. */
25404 output_cursor
.hpos
+= len
;
25405 output_cursor
.x
+= shift_by_width
;
25411 Erase the current text line from the nominal cursor position
25412 (inclusive) to pixel column TO_X (exclusive). The idea is that
25413 everything from TO_X onward is already erased.
25415 TO_X is a pixel position relative to updated_area of
25416 updated_window. TO_X == -1 means clear to the end of this area. */
25419 x_clear_end_of_line (int to_x
)
25422 struct window
*w
= updated_window
;
25423 int max_x
, min_y
, max_y
;
25424 int from_x
, from_y
, to_y
;
25426 eassert (updated_window
&& updated_row
);
25427 f
= XFRAME (w
->frame
);
25429 if (updated_row
->full_width_p
)
25430 max_x
= WINDOW_TOTAL_WIDTH (w
);
25432 max_x
= window_box_width (w
, updated_area
);
25433 max_y
= window_text_bottom_y (w
);
25435 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25436 of window. For TO_X > 0, truncate to end of drawing area. */
25442 to_x
= min (to_x
, max_x
);
25444 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25446 /* Notice if the cursor will be cleared by this operation. */
25447 if (!updated_row
->full_width_p
)
25448 notice_overwritten_cursor (w
, updated_area
,
25449 output_cursor
.x
, -1,
25451 MATRIX_ROW_BOTTOM_Y (updated_row
));
25453 from_x
= output_cursor
.x
;
25455 /* Translate to frame coordinates. */
25456 if (updated_row
->full_width_p
)
25458 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25459 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25463 int area_left
= window_box_left (w
, updated_area
);
25464 from_x
+= area_left
;
25468 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25469 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25470 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25472 /* Prevent inadvertently clearing to end of the X window. */
25473 if (to_x
> from_x
&& to_y
> from_y
)
25476 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25477 to_x
- from_x
, to_y
- from_y
);
25482 #endif /* HAVE_WINDOW_SYSTEM */
25486 /***********************************************************************
25488 ***********************************************************************/
25490 /* Value is the internal representation of the specified cursor type
25491 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25492 of the bar cursor. */
25494 static enum text_cursor_kinds
25495 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25497 enum text_cursor_kinds type
;
25502 if (EQ (arg
, Qbox
))
25503 return FILLED_BOX_CURSOR
;
25505 if (EQ (arg
, Qhollow
))
25506 return HOLLOW_BOX_CURSOR
;
25508 if (EQ (arg
, Qbar
))
25515 && EQ (XCAR (arg
), Qbar
)
25516 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25518 *width
= XINT (XCDR (arg
));
25522 if (EQ (arg
, Qhbar
))
25525 return HBAR_CURSOR
;
25529 && EQ (XCAR (arg
), Qhbar
)
25530 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25532 *width
= XINT (XCDR (arg
));
25533 return HBAR_CURSOR
;
25536 /* Treat anything unknown as "hollow box cursor".
25537 It was bad to signal an error; people have trouble fixing
25538 .Xdefaults with Emacs, when it has something bad in it. */
25539 type
= HOLLOW_BOX_CURSOR
;
25544 /* Set the default cursor types for specified frame. */
25546 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25551 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25552 FRAME_CURSOR_WIDTH (f
) = width
;
25554 /* By default, set up the blink-off state depending on the on-state. */
25556 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25559 FRAME_BLINK_OFF_CURSOR (f
)
25560 = get_specified_cursor_type (XCDR (tem
), &width
);
25561 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25564 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25568 #ifdef HAVE_WINDOW_SYSTEM
25570 /* Return the cursor we want to be displayed in window W. Return
25571 width of bar/hbar cursor through WIDTH arg. Return with
25572 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25573 (i.e. if the `system caret' should track this cursor).
25575 In a mini-buffer window, we want the cursor only to appear if we
25576 are reading input from this window. For the selected window, we
25577 want the cursor type given by the frame parameter or buffer local
25578 setting of cursor-type. If explicitly marked off, draw no cursor.
25579 In all other cases, we want a hollow box cursor. */
25581 static enum text_cursor_kinds
25582 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25583 int *active_cursor
)
25585 struct frame
*f
= XFRAME (w
->frame
);
25586 struct buffer
*b
= XBUFFER (w
->buffer
);
25587 int cursor_type
= DEFAULT_CURSOR
;
25588 Lisp_Object alt_cursor
;
25589 int non_selected
= 0;
25591 *active_cursor
= 1;
25594 if (cursor_in_echo_area
25595 && FRAME_HAS_MINIBUF_P (f
)
25596 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25598 if (w
== XWINDOW (echo_area_window
))
25600 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25602 *width
= FRAME_CURSOR_WIDTH (f
);
25603 return FRAME_DESIRED_CURSOR (f
);
25606 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25609 *active_cursor
= 0;
25613 /* Detect a nonselected window or nonselected frame. */
25614 else if (w
!= XWINDOW (f
->selected_window
)
25615 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25617 *active_cursor
= 0;
25619 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25625 /* Never display a cursor in a window in which cursor-type is nil. */
25626 if (NILP (BVAR (b
, cursor_type
)))
25629 /* Get the normal cursor type for this window. */
25630 if (EQ (BVAR (b
, cursor_type
), Qt
))
25632 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25633 *width
= FRAME_CURSOR_WIDTH (f
);
25636 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25638 /* Use cursor-in-non-selected-windows instead
25639 for non-selected window or frame. */
25642 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25643 if (!EQ (Qt
, alt_cursor
))
25644 return get_specified_cursor_type (alt_cursor
, width
);
25645 /* t means modify the normal cursor type. */
25646 if (cursor_type
== FILLED_BOX_CURSOR
)
25647 cursor_type
= HOLLOW_BOX_CURSOR
;
25648 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25650 return cursor_type
;
25653 /* Use normal cursor if not blinked off. */
25654 if (!w
->cursor_off_p
)
25656 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25658 if (cursor_type
== FILLED_BOX_CURSOR
)
25660 /* Using a block cursor on large images can be very annoying.
25661 So use a hollow cursor for "large" images.
25662 If image is not transparent (no mask), also use hollow cursor. */
25663 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25664 if (img
!= NULL
&& IMAGEP (img
->spec
))
25666 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25667 where N = size of default frame font size.
25668 This should cover most of the "tiny" icons people may use. */
25670 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25671 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25672 cursor_type
= HOLLOW_BOX_CURSOR
;
25675 else if (cursor_type
!= NO_CURSOR
)
25677 /* Display current only supports BOX and HOLLOW cursors for images.
25678 So for now, unconditionally use a HOLLOW cursor when cursor is
25679 not a solid box cursor. */
25680 cursor_type
= HOLLOW_BOX_CURSOR
;
25683 return cursor_type
;
25686 /* Cursor is blinked off, so determine how to "toggle" it. */
25688 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25689 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25690 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25692 /* Then see if frame has specified a specific blink off cursor type. */
25693 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25695 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25696 return FRAME_BLINK_OFF_CURSOR (f
);
25700 /* Some people liked having a permanently visible blinking cursor,
25701 while others had very strong opinions against it. So it was
25702 decided to remove it. KFS 2003-09-03 */
25704 /* Finally perform built-in cursor blinking:
25705 filled box <-> hollow box
25706 wide [h]bar <-> narrow [h]bar
25707 narrow [h]bar <-> no cursor
25708 other type <-> no cursor */
25710 if (cursor_type
== FILLED_BOX_CURSOR
)
25711 return HOLLOW_BOX_CURSOR
;
25713 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25716 return cursor_type
;
25724 /* Notice when the text cursor of window W has been completely
25725 overwritten by a drawing operation that outputs glyphs in AREA
25726 starting at X0 and ending at X1 in the line starting at Y0 and
25727 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25728 the rest of the line after X0 has been written. Y coordinates
25729 are window-relative. */
25732 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25733 int x0
, int x1
, int y0
, int y1
)
25735 int cx0
, cx1
, cy0
, cy1
;
25736 struct glyph_row
*row
;
25738 if (!w
->phys_cursor_on_p
)
25740 if (area
!= TEXT_AREA
)
25743 if (w
->phys_cursor
.vpos
< 0
25744 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25745 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25746 !(row
->enabled_p
&& row
->displays_text_p
)))
25749 if (row
->cursor_in_fringe_p
)
25751 row
->cursor_in_fringe_p
= 0;
25752 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25753 w
->phys_cursor_on_p
= 0;
25757 cx0
= w
->phys_cursor
.x
;
25758 cx1
= cx0
+ w
->phys_cursor_width
;
25759 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25762 /* The cursor image will be completely removed from the
25763 screen if the output area intersects the cursor area in
25764 y-direction. When we draw in [y0 y1[, and some part of
25765 the cursor is at y < y0, that part must have been drawn
25766 before. When scrolling, the cursor is erased before
25767 actually scrolling, so we don't come here. When not
25768 scrolling, the rows above the old cursor row must have
25769 changed, and in this case these rows must have written
25770 over the cursor image.
25772 Likewise if part of the cursor is below y1, with the
25773 exception of the cursor being in the first blank row at
25774 the buffer and window end because update_text_area
25775 doesn't draw that row. (Except when it does, but
25776 that's handled in update_text_area.) */
25778 cy0
= w
->phys_cursor
.y
;
25779 cy1
= cy0
+ w
->phys_cursor_height
;
25780 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25783 w
->phys_cursor_on_p
= 0;
25786 #endif /* HAVE_WINDOW_SYSTEM */
25789 /************************************************************************
25791 ************************************************************************/
25793 #ifdef HAVE_WINDOW_SYSTEM
25796 Fix the display of area AREA of overlapping row ROW in window W
25797 with respect to the overlapping part OVERLAPS. */
25800 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25801 enum glyph_row_area area
, int overlaps
)
25808 for (i
= 0; i
< row
->used
[area
];)
25810 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25812 int start
= i
, start_x
= x
;
25816 x
+= row
->glyphs
[area
][i
].pixel_width
;
25819 while (i
< row
->used
[area
]
25820 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25822 draw_glyphs (w
, start_x
, row
, area
,
25824 DRAW_NORMAL_TEXT
, overlaps
);
25828 x
+= row
->glyphs
[area
][i
].pixel_width
;
25838 Draw the cursor glyph of window W in glyph row ROW. See the
25839 comment of draw_glyphs for the meaning of HL. */
25842 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25843 enum draw_glyphs_face hl
)
25845 /* If cursor hpos is out of bounds, don't draw garbage. This can
25846 happen in mini-buffer windows when switching between echo area
25847 glyphs and mini-buffer. */
25848 if ((row
->reversed_p
25849 ? (w
->phys_cursor
.hpos
>= 0)
25850 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25852 int on_p
= w
->phys_cursor_on_p
;
25854 int hpos
= w
->phys_cursor
.hpos
;
25856 /* When the window is hscrolled, cursor hpos can legitimately be
25857 out of bounds, but we draw the cursor at the corresponding
25858 window margin in that case. */
25859 if (!row
->reversed_p
&& hpos
< 0)
25861 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25862 hpos
= row
->used
[TEXT_AREA
] - 1;
25864 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25866 w
->phys_cursor_on_p
= on_p
;
25868 if (hl
== DRAW_CURSOR
)
25869 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25870 /* When we erase the cursor, and ROW is overlapped by other
25871 rows, make sure that these overlapping parts of other rows
25873 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25875 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25877 if (row
> w
->current_matrix
->rows
25878 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25879 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25880 OVERLAPS_ERASED_CURSOR
);
25882 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25883 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25884 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25885 OVERLAPS_ERASED_CURSOR
);
25892 Erase the image of a cursor of window W from the screen. */
25895 erase_phys_cursor (struct window
*w
)
25897 struct frame
*f
= XFRAME (w
->frame
);
25898 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25899 int hpos
= w
->phys_cursor
.hpos
;
25900 int vpos
= w
->phys_cursor
.vpos
;
25901 int mouse_face_here_p
= 0;
25902 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25903 struct glyph_row
*cursor_row
;
25904 struct glyph
*cursor_glyph
;
25905 enum draw_glyphs_face hl
;
25907 /* No cursor displayed or row invalidated => nothing to do on the
25909 if (w
->phys_cursor_type
== NO_CURSOR
)
25910 goto mark_cursor_off
;
25912 /* VPOS >= active_glyphs->nrows means that window has been resized.
25913 Don't bother to erase the cursor. */
25914 if (vpos
>= active_glyphs
->nrows
)
25915 goto mark_cursor_off
;
25917 /* If row containing cursor is marked invalid, there is nothing we
25919 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25920 if (!cursor_row
->enabled_p
)
25921 goto mark_cursor_off
;
25923 /* If line spacing is > 0, old cursor may only be partially visible in
25924 window after split-window. So adjust visible height. */
25925 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25926 window_text_bottom_y (w
) - cursor_row
->y
);
25928 /* If row is completely invisible, don't attempt to delete a cursor which
25929 isn't there. This can happen if cursor is at top of a window, and
25930 we switch to a buffer with a header line in that window. */
25931 if (cursor_row
->visible_height
<= 0)
25932 goto mark_cursor_off
;
25934 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25935 if (cursor_row
->cursor_in_fringe_p
)
25937 cursor_row
->cursor_in_fringe_p
= 0;
25938 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25939 goto mark_cursor_off
;
25942 /* This can happen when the new row is shorter than the old one.
25943 In this case, either draw_glyphs or clear_end_of_line
25944 should have cleared the cursor. Note that we wouldn't be
25945 able to erase the cursor in this case because we don't have a
25946 cursor glyph at hand. */
25947 if ((cursor_row
->reversed_p
25948 ? (w
->phys_cursor
.hpos
< 0)
25949 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25950 goto mark_cursor_off
;
25952 /* When the window is hscrolled, cursor hpos can legitimately be out
25953 of bounds, but we draw the cursor at the corresponding window
25954 margin in that case. */
25955 if (!cursor_row
->reversed_p
&& hpos
< 0)
25957 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25958 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25960 /* If the cursor is in the mouse face area, redisplay that when
25961 we clear the cursor. */
25962 if (! NILP (hlinfo
->mouse_face_window
)
25963 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25964 /* Don't redraw the cursor's spot in mouse face if it is at the
25965 end of a line (on a newline). The cursor appears there, but
25966 mouse highlighting does not. */
25967 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25968 mouse_face_here_p
= 1;
25970 /* Maybe clear the display under the cursor. */
25971 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25974 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25977 cursor_glyph
= get_phys_cursor_glyph (w
);
25978 if (cursor_glyph
== NULL
)
25979 goto mark_cursor_off
;
25981 width
= cursor_glyph
->pixel_width
;
25982 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25983 x
= w
->phys_cursor
.x
;
25985 width
-= left_x
- x
;
25986 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25987 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25988 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25991 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25994 /* Erase the cursor by redrawing the character underneath it. */
25995 if (mouse_face_here_p
)
25996 hl
= DRAW_MOUSE_FACE
;
25998 hl
= DRAW_NORMAL_TEXT
;
25999 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
26002 w
->phys_cursor_on_p
= 0;
26003 w
->phys_cursor_type
= NO_CURSOR
;
26008 Display or clear cursor of window W. If ON is zero, clear the
26009 cursor. If it is non-zero, display the cursor. If ON is nonzero,
26010 where to put the cursor is specified by HPOS, VPOS, X and Y. */
26013 display_and_set_cursor (struct window
*w
, int on
,
26014 int hpos
, int vpos
, int x
, int y
)
26016 struct frame
*f
= XFRAME (w
->frame
);
26017 int new_cursor_type
;
26018 int new_cursor_width
;
26020 struct glyph_row
*glyph_row
;
26021 struct glyph
*glyph
;
26023 /* This is pointless on invisible frames, and dangerous on garbaged
26024 windows and frames; in the latter case, the frame or window may
26025 be in the midst of changing its size, and x and y may be off the
26027 if (! FRAME_VISIBLE_P (f
)
26028 || FRAME_GARBAGED_P (f
)
26029 || vpos
>= w
->current_matrix
->nrows
26030 || hpos
>= w
->current_matrix
->matrix_w
)
26033 /* If cursor is off and we want it off, return quickly. */
26034 if (!on
&& !w
->phys_cursor_on_p
)
26037 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26038 /* If cursor row is not enabled, we don't really know where to
26039 display the cursor. */
26040 if (!glyph_row
->enabled_p
)
26042 w
->phys_cursor_on_p
= 0;
26047 if (!glyph_row
->exact_window_width_line_p
26048 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
26049 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
26051 eassert (interrupt_input_blocked
);
26053 /* Set new_cursor_type to the cursor we want to be displayed. */
26054 new_cursor_type
= get_window_cursor_type (w
, glyph
,
26055 &new_cursor_width
, &active_cursor
);
26057 /* If cursor is currently being shown and we don't want it to be or
26058 it is in the wrong place, or the cursor type is not what we want,
26060 if (w
->phys_cursor_on_p
26062 || w
->phys_cursor
.x
!= x
26063 || w
->phys_cursor
.y
!= y
26064 || new_cursor_type
!= w
->phys_cursor_type
26065 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
26066 && new_cursor_width
!= w
->phys_cursor_width
)))
26067 erase_phys_cursor (w
);
26069 /* Don't check phys_cursor_on_p here because that flag is only set
26070 to zero in some cases where we know that the cursor has been
26071 completely erased, to avoid the extra work of erasing the cursor
26072 twice. In other words, phys_cursor_on_p can be 1 and the cursor
26073 still not be visible, or it has only been partly erased. */
26076 w
->phys_cursor_ascent
= glyph_row
->ascent
;
26077 w
->phys_cursor_height
= glyph_row
->height
;
26079 /* Set phys_cursor_.* before x_draw_.* is called because some
26080 of them may need the information. */
26081 w
->phys_cursor
.x
= x
;
26082 w
->phys_cursor
.y
= glyph_row
->y
;
26083 w
->phys_cursor
.hpos
= hpos
;
26084 w
->phys_cursor
.vpos
= vpos
;
26087 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
26088 new_cursor_type
, new_cursor_width
,
26089 on
, active_cursor
);
26093 /* Switch the display of W's cursor on or off, according to the value
26097 update_window_cursor (struct window
*w
, int on
)
26099 /* Don't update cursor in windows whose frame is in the process
26100 of being deleted. */
26101 if (w
->current_matrix
)
26103 int hpos
= w
->phys_cursor
.hpos
;
26104 int vpos
= w
->phys_cursor
.vpos
;
26105 struct glyph_row
*row
;
26107 if (vpos
>= w
->current_matrix
->nrows
26108 || hpos
>= w
->current_matrix
->matrix_w
)
26111 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26113 /* When the window is hscrolled, cursor hpos can legitimately be
26114 out of bounds, but we draw the cursor at the corresponding
26115 window margin in that case. */
26116 if (!row
->reversed_p
&& hpos
< 0)
26118 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26119 hpos
= row
->used
[TEXT_AREA
] - 1;
26122 display_and_set_cursor (w
, on
, hpos
, vpos
,
26123 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26129 /* Call update_window_cursor with parameter ON_P on all leaf windows
26130 in the window tree rooted at W. */
26133 update_cursor_in_window_tree (struct window
*w
, int on_p
)
26137 if (!NILP (w
->hchild
))
26138 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
26139 else if (!NILP (w
->vchild
))
26140 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
26142 update_window_cursor (w
, on_p
);
26144 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
26150 Display the cursor on window W, or clear it, according to ON_P.
26151 Don't change the cursor's position. */
26154 x_update_cursor (struct frame
*f
, int on_p
)
26156 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
26161 Clear the cursor of window W to background color, and mark the
26162 cursor as not shown. This is used when the text where the cursor
26163 is about to be rewritten. */
26166 x_clear_cursor (struct window
*w
)
26168 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
26169 update_window_cursor (w
, 0);
26172 #endif /* HAVE_WINDOW_SYSTEM */
26174 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26177 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
26178 int start_hpos
, int end_hpos
,
26179 enum draw_glyphs_face draw
)
26181 #ifdef HAVE_WINDOW_SYSTEM
26182 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
26184 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
26188 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26189 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
26193 /* Display the active region described by mouse_face_* according to DRAW. */
26196 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
26198 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
26199 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26201 if (/* If window is in the process of being destroyed, don't bother
26203 w
->current_matrix
!= NULL
26204 /* Don't update mouse highlight if hidden */
26205 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
26206 /* Recognize when we are called to operate on rows that don't exist
26207 anymore. This can happen when a window is split. */
26208 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
26210 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
26211 struct glyph_row
*row
, *first
, *last
;
26213 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
26214 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
26216 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
26218 int start_hpos
, end_hpos
, start_x
;
26220 /* For all but the first row, the highlight starts at column 0. */
26223 /* R2L rows have BEG and END in reversed order, but the
26224 screen drawing geometry is always left to right. So
26225 we need to mirror the beginning and end of the
26226 highlighted area in R2L rows. */
26227 if (!row
->reversed_p
)
26229 start_hpos
= hlinfo
->mouse_face_beg_col
;
26230 start_x
= hlinfo
->mouse_face_beg_x
;
26232 else if (row
== last
)
26234 start_hpos
= hlinfo
->mouse_face_end_col
;
26235 start_x
= hlinfo
->mouse_face_end_x
;
26243 else if (row
->reversed_p
&& row
== last
)
26245 start_hpos
= hlinfo
->mouse_face_end_col
;
26246 start_x
= hlinfo
->mouse_face_end_x
;
26256 if (!row
->reversed_p
)
26257 end_hpos
= hlinfo
->mouse_face_end_col
;
26258 else if (row
== first
)
26259 end_hpos
= hlinfo
->mouse_face_beg_col
;
26262 end_hpos
= row
->used
[TEXT_AREA
];
26263 if (draw
== DRAW_NORMAL_TEXT
)
26264 row
->fill_line_p
= 1; /* Clear to end of line */
26267 else if (row
->reversed_p
&& row
== first
)
26268 end_hpos
= hlinfo
->mouse_face_beg_col
;
26271 end_hpos
= row
->used
[TEXT_AREA
];
26272 if (draw
== DRAW_NORMAL_TEXT
)
26273 row
->fill_line_p
= 1; /* Clear to end of line */
26276 if (end_hpos
> start_hpos
)
26278 draw_row_with_mouse_face (w
, start_x
, row
,
26279 start_hpos
, end_hpos
, draw
);
26282 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26286 #ifdef HAVE_WINDOW_SYSTEM
26287 /* When we've written over the cursor, arrange for it to
26288 be displayed again. */
26289 if (FRAME_WINDOW_P (f
)
26290 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26292 int hpos
= w
->phys_cursor
.hpos
;
26294 /* When the window is hscrolled, cursor hpos can legitimately be
26295 out of bounds, but we draw the cursor at the corresponding
26296 window margin in that case. */
26297 if (!row
->reversed_p
&& hpos
< 0)
26299 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26300 hpos
= row
->used
[TEXT_AREA
] - 1;
26303 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26304 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26307 #endif /* HAVE_WINDOW_SYSTEM */
26310 #ifdef HAVE_WINDOW_SYSTEM
26311 /* Change the mouse cursor. */
26312 if (FRAME_WINDOW_P (f
))
26314 if (draw
== DRAW_NORMAL_TEXT
26315 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26316 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26317 else if (draw
== DRAW_MOUSE_FACE
)
26318 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26320 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26322 #endif /* HAVE_WINDOW_SYSTEM */
26326 Clear out the mouse-highlighted active region.
26327 Redraw it un-highlighted first. Value is non-zero if mouse
26328 face was actually drawn unhighlighted. */
26331 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26335 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26337 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26341 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26342 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26343 hlinfo
->mouse_face_window
= Qnil
;
26344 hlinfo
->mouse_face_overlay
= Qnil
;
26348 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26349 within the mouse face on that window. */
26351 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26353 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26355 /* Quickly resolve the easy cases. */
26356 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26357 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26359 if (vpos
< hlinfo
->mouse_face_beg_row
26360 || vpos
> hlinfo
->mouse_face_end_row
)
26362 if (vpos
> hlinfo
->mouse_face_beg_row
26363 && vpos
< hlinfo
->mouse_face_end_row
)
26366 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26368 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26370 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26373 else if ((vpos
== hlinfo
->mouse_face_beg_row
26374 && hpos
>= hlinfo
->mouse_face_beg_col
)
26375 || (vpos
== hlinfo
->mouse_face_end_row
26376 && hpos
< hlinfo
->mouse_face_end_col
))
26381 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26383 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26386 else if ((vpos
== hlinfo
->mouse_face_beg_row
26387 && hpos
<= hlinfo
->mouse_face_beg_col
)
26388 || (vpos
== hlinfo
->mouse_face_end_row
26389 && hpos
> hlinfo
->mouse_face_end_col
))
26397 Non-zero if physical cursor of window W is within mouse face. */
26400 cursor_in_mouse_face_p (struct window
*w
)
26402 int hpos
= w
->phys_cursor
.hpos
;
26403 int vpos
= w
->phys_cursor
.vpos
;
26404 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26406 /* When the window is hscrolled, cursor hpos can legitimately be out
26407 of bounds, but we draw the cursor at the corresponding window
26408 margin in that case. */
26409 if (!row
->reversed_p
&& hpos
< 0)
26411 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26412 hpos
= row
->used
[TEXT_AREA
] - 1;
26414 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26419 /* Find the glyph rows START_ROW and END_ROW of window W that display
26420 characters between buffer positions START_CHARPOS and END_CHARPOS
26421 (excluding END_CHARPOS). DISP_STRING is a display string that
26422 covers these buffer positions. This is similar to
26423 row_containing_pos, but is more accurate when bidi reordering makes
26424 buffer positions change non-linearly with glyph rows. */
26426 rows_from_pos_range (struct window
*w
,
26427 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26428 Lisp_Object disp_string
,
26429 struct glyph_row
**start
, struct glyph_row
**end
)
26431 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26432 int last_y
= window_text_bottom_y (w
);
26433 struct glyph_row
*row
;
26438 while (!first
->enabled_p
26439 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26442 /* Find the START row. */
26444 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26447 /* A row can potentially be the START row if the range of the
26448 characters it displays intersects the range
26449 [START_CHARPOS..END_CHARPOS). */
26450 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26451 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26452 /* See the commentary in row_containing_pos, for the
26453 explanation of the complicated way to check whether
26454 some position is beyond the end of the characters
26455 displayed by a row. */
26456 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26457 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26458 && !row
->ends_at_zv_p
26459 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26460 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26461 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26462 && !row
->ends_at_zv_p
26463 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26465 /* Found a candidate row. Now make sure at least one of the
26466 glyphs it displays has a charpos from the range
26467 [START_CHARPOS..END_CHARPOS).
26469 This is not obvious because bidi reordering could make
26470 buffer positions of a row be 1,2,3,102,101,100, and if we
26471 want to highlight characters in [50..60), we don't want
26472 this row, even though [50..60) does intersect [1..103),
26473 the range of character positions given by the row's start
26474 and end positions. */
26475 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26476 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26480 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26481 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26482 /* A glyph that comes from DISP_STRING is by
26483 definition to be highlighted. */
26484 || EQ (g
->object
, disp_string
))
26493 /* Find the END row. */
26495 /* If the last row is partially visible, start looking for END
26496 from that row, instead of starting from FIRST. */
26497 && !(row
->enabled_p
26498 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26500 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26502 struct glyph_row
*next
= row
+ 1;
26503 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26505 if (!next
->enabled_p
26506 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26507 /* The first row >= START whose range of displayed characters
26508 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26509 is the row END + 1. */
26510 || (start_charpos
< next_start
26511 && end_charpos
< next_start
)
26512 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26513 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26514 && !next
->ends_at_zv_p
26515 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26516 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26517 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26518 && !next
->ends_at_zv_p
26519 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26526 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26527 but none of the characters it displays are in the range, it is
26529 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26530 struct glyph
*s
= g
;
26531 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26535 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26536 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26537 /* If the buffer position of the first glyph in
26538 the row is equal to END_CHARPOS, it means
26539 the last character to be highlighted is the
26540 newline of ROW, and we must consider NEXT as
26542 || (((!next
->reversed_p
&& g
== s
)
26543 || (next
->reversed_p
&& g
== e
- 1))
26544 && (g
->charpos
== end_charpos
26545 /* Special case for when NEXT is an
26546 empty line at ZV. */
26547 || (g
->charpos
== -1
26548 && !row
->ends_at_zv_p
26549 && next_start
== end_charpos
)))))
26550 /* A glyph that comes from DISP_STRING is by
26551 definition to be highlighted. */
26552 || EQ (g
->object
, disp_string
))
26561 /* The first row that ends at ZV must be the last to be
26563 else if (next
->ends_at_zv_p
)
26572 /* This function sets the mouse_face_* elements of HLINFO, assuming
26573 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26574 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26575 for the overlay or run of text properties specifying the mouse
26576 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26577 before-string and after-string that must also be highlighted.
26578 DISP_STRING, if non-nil, is a display string that may cover some
26579 or all of the highlighted text. */
26582 mouse_face_from_buffer_pos (Lisp_Object window
,
26583 Mouse_HLInfo
*hlinfo
,
26584 ptrdiff_t mouse_charpos
,
26585 ptrdiff_t start_charpos
,
26586 ptrdiff_t end_charpos
,
26587 Lisp_Object before_string
,
26588 Lisp_Object after_string
,
26589 Lisp_Object disp_string
)
26591 struct window
*w
= XWINDOW (window
);
26592 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26593 struct glyph_row
*r1
, *r2
;
26594 struct glyph
*glyph
, *end
;
26595 ptrdiff_t ignore
, pos
;
26598 eassert (NILP (disp_string
) || STRINGP (disp_string
));
26599 eassert (NILP (before_string
) || STRINGP (before_string
));
26600 eassert (NILP (after_string
) || STRINGP (after_string
));
26602 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26603 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26605 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26606 /* If the before-string or display-string contains newlines,
26607 rows_from_pos_range skips to its last row. Move back. */
26608 if (!NILP (before_string
) || !NILP (disp_string
))
26610 struct glyph_row
*prev
;
26611 while ((prev
= r1
- 1, prev
>= first
)
26612 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26613 && prev
->used
[TEXT_AREA
] > 0)
26615 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26616 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26617 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26619 || !(EQ (glyph
->object
, before_string
)
26620 || EQ (glyph
->object
, disp_string
)))
26627 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26628 hlinfo
->mouse_face_past_end
= 1;
26630 else if (!NILP (after_string
))
26632 /* If the after-string has newlines, advance to its last row. */
26633 struct glyph_row
*next
;
26634 struct glyph_row
*last
26635 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26637 for (next
= r2
+ 1;
26639 && next
->used
[TEXT_AREA
] > 0
26640 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26644 /* The rest of the display engine assumes that mouse_face_beg_row is
26645 either above mouse_face_end_row or identical to it. But with
26646 bidi-reordered continued lines, the row for START_CHARPOS could
26647 be below the row for END_CHARPOS. If so, swap the rows and store
26648 them in correct order. */
26651 struct glyph_row
*tem
= r2
;
26657 hlinfo
->mouse_face_beg_y
= r1
->y
;
26658 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26659 hlinfo
->mouse_face_end_y
= r2
->y
;
26660 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26662 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26663 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26664 could be anywhere in the row and in any order. The strategy
26665 below is to find the leftmost and the rightmost glyph that
26666 belongs to either of these 3 strings, or whose position is
26667 between START_CHARPOS and END_CHARPOS, and highlight all the
26668 glyphs between those two. This may cover more than just the text
26669 between START_CHARPOS and END_CHARPOS if the range of characters
26670 strides the bidi level boundary, e.g. if the beginning is in R2L
26671 text while the end is in L2R text or vice versa. */
26672 if (!r1
->reversed_p
)
26674 /* This row is in a left to right paragraph. Scan it left to
26676 glyph
= r1
->glyphs
[TEXT_AREA
];
26677 end
= glyph
+ r1
->used
[TEXT_AREA
];
26680 /* Skip truncation glyphs at the start of the glyph row. */
26681 if (r1
->displays_text_p
)
26683 && INTEGERP (glyph
->object
)
26684 && glyph
->charpos
< 0;
26686 x
+= glyph
->pixel_width
;
26688 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26689 or DISP_STRING, and the first glyph from buffer whose
26690 position is between START_CHARPOS and END_CHARPOS. */
26692 && !INTEGERP (glyph
->object
)
26693 && !EQ (glyph
->object
, disp_string
)
26694 && !(BUFFERP (glyph
->object
)
26695 && (glyph
->charpos
>= start_charpos
26696 && glyph
->charpos
< end_charpos
));
26699 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26700 are present at buffer positions between START_CHARPOS and
26701 END_CHARPOS, or if they come from an overlay. */
26702 if (EQ (glyph
->object
, before_string
))
26704 pos
= string_buffer_position (before_string
,
26706 /* If pos == 0, it means before_string came from an
26707 overlay, not from a buffer position. */
26708 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26711 else if (EQ (glyph
->object
, after_string
))
26713 pos
= string_buffer_position (after_string
, end_charpos
);
26714 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26717 x
+= glyph
->pixel_width
;
26719 hlinfo
->mouse_face_beg_x
= x
;
26720 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26724 /* This row is in a right to left paragraph. Scan it right to
26728 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26729 glyph
= end
+ r1
->used
[TEXT_AREA
];
26731 /* Skip truncation glyphs at the start of the glyph row. */
26732 if (r1
->displays_text_p
)
26734 && INTEGERP (glyph
->object
)
26735 && glyph
->charpos
< 0;
26739 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26740 or DISP_STRING, and the first glyph from buffer whose
26741 position is between START_CHARPOS and END_CHARPOS. */
26743 && !INTEGERP (glyph
->object
)
26744 && !EQ (glyph
->object
, disp_string
)
26745 && !(BUFFERP (glyph
->object
)
26746 && (glyph
->charpos
>= start_charpos
26747 && glyph
->charpos
< end_charpos
));
26750 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26751 are present at buffer positions between START_CHARPOS and
26752 END_CHARPOS, or if they come from an overlay. */
26753 if (EQ (glyph
->object
, before_string
))
26755 pos
= string_buffer_position (before_string
, start_charpos
);
26756 /* If pos == 0, it means before_string came from an
26757 overlay, not from a buffer position. */
26758 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26761 else if (EQ (glyph
->object
, after_string
))
26763 pos
= string_buffer_position (after_string
, end_charpos
);
26764 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26769 glyph
++; /* first glyph to the right of the highlighted area */
26770 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26771 x
+= g
->pixel_width
;
26772 hlinfo
->mouse_face_beg_x
= x
;
26773 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26776 /* If the highlight ends in a different row, compute GLYPH and END
26777 for the end row. Otherwise, reuse the values computed above for
26778 the row where the highlight begins. */
26781 if (!r2
->reversed_p
)
26783 glyph
= r2
->glyphs
[TEXT_AREA
];
26784 end
= glyph
+ r2
->used
[TEXT_AREA
];
26789 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26790 glyph
= end
+ r2
->used
[TEXT_AREA
];
26794 if (!r2
->reversed_p
)
26796 /* Skip truncation and continuation glyphs near the end of the
26797 row, and also blanks and stretch glyphs inserted by
26798 extend_face_to_end_of_line. */
26800 && INTEGERP ((end
- 1)->object
))
26802 /* Scan the rest of the glyph row from the end, looking for the
26803 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26804 DISP_STRING, or whose position is between START_CHARPOS
26808 && !INTEGERP (end
->object
)
26809 && !EQ (end
->object
, disp_string
)
26810 && !(BUFFERP (end
->object
)
26811 && (end
->charpos
>= start_charpos
26812 && end
->charpos
< end_charpos
));
26815 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26816 are present at buffer positions between START_CHARPOS and
26817 END_CHARPOS, or if they come from an overlay. */
26818 if (EQ (end
->object
, before_string
))
26820 pos
= string_buffer_position (before_string
, start_charpos
);
26821 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26824 else if (EQ (end
->object
, after_string
))
26826 pos
= string_buffer_position (after_string
, end_charpos
);
26827 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26831 /* Find the X coordinate of the last glyph to be highlighted. */
26832 for (; glyph
<= end
; ++glyph
)
26833 x
+= glyph
->pixel_width
;
26835 hlinfo
->mouse_face_end_x
= x
;
26836 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26840 /* Skip truncation and continuation glyphs near the end of the
26841 row, and also blanks and stretch glyphs inserted by
26842 extend_face_to_end_of_line. */
26846 && INTEGERP (end
->object
))
26848 x
+= end
->pixel_width
;
26851 /* Scan the rest of the glyph row from the end, looking for the
26852 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26853 DISP_STRING, or whose position is between START_CHARPOS
26857 && !INTEGERP (end
->object
)
26858 && !EQ (end
->object
, disp_string
)
26859 && !(BUFFERP (end
->object
)
26860 && (end
->charpos
>= start_charpos
26861 && end
->charpos
< end_charpos
));
26864 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26865 are present at buffer positions between START_CHARPOS and
26866 END_CHARPOS, or if they come from an overlay. */
26867 if (EQ (end
->object
, before_string
))
26869 pos
= string_buffer_position (before_string
, start_charpos
);
26870 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26873 else if (EQ (end
->object
, after_string
))
26875 pos
= string_buffer_position (after_string
, end_charpos
);
26876 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26879 x
+= end
->pixel_width
;
26881 /* If we exited the above loop because we arrived at the last
26882 glyph of the row, and its buffer position is still not in
26883 range, it means the last character in range is the preceding
26884 newline. Bump the end column and x values to get past the
26887 && BUFFERP (end
->object
)
26888 && (end
->charpos
< start_charpos
26889 || end
->charpos
>= end_charpos
))
26891 x
+= end
->pixel_width
;
26894 hlinfo
->mouse_face_end_x
= x
;
26895 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26898 hlinfo
->mouse_face_window
= window
;
26899 hlinfo
->mouse_face_face_id
26900 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26902 !hlinfo
->mouse_face_hidden
, -1);
26903 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26906 /* The following function is not used anymore (replaced with
26907 mouse_face_from_string_pos), but I leave it here for the time
26908 being, in case someone would. */
26910 #if 0 /* not used */
26912 /* Find the position of the glyph for position POS in OBJECT in
26913 window W's current matrix, and return in *X, *Y the pixel
26914 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26916 RIGHT_P non-zero means return the position of the right edge of the
26917 glyph, RIGHT_P zero means return the left edge position.
26919 If no glyph for POS exists in the matrix, return the position of
26920 the glyph with the next smaller position that is in the matrix, if
26921 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26922 exists in the matrix, return the position of the glyph with the
26923 next larger position in OBJECT.
26925 Value is non-zero if a glyph was found. */
26928 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
26929 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26931 int yb
= window_text_bottom_y (w
);
26932 struct glyph_row
*r
;
26933 struct glyph
*best_glyph
= NULL
;
26934 struct glyph_row
*best_row
= NULL
;
26937 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26938 r
->enabled_p
&& r
->y
< yb
;
26941 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26942 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26945 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26946 if (EQ (g
->object
, object
))
26948 if (g
->charpos
== pos
)
26955 else if (best_glyph
== NULL
26956 || ((eabs (g
->charpos
- pos
)
26957 < eabs (best_glyph
->charpos
- pos
))
26960 : g
->charpos
> pos
)))
26974 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26978 *x
+= best_glyph
->pixel_width
;
26983 *vpos
= best_row
- w
->current_matrix
->rows
;
26986 return best_glyph
!= NULL
;
26988 #endif /* not used */
26990 /* Find the positions of the first and the last glyphs in window W's
26991 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26992 (assumed to be a string), and return in HLINFO's mouse_face_*
26993 members the pixel and column/row coordinates of those glyphs. */
26996 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26997 Lisp_Object object
,
26998 ptrdiff_t startpos
, ptrdiff_t endpos
)
27000 int yb
= window_text_bottom_y (w
);
27001 struct glyph_row
*r
;
27002 struct glyph
*g
, *e
;
27006 /* Find the glyph row with at least one position in the range
27007 [STARTPOS..ENDPOS], and the first glyph in that row whose
27008 position belongs to that range. */
27009 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27010 r
->enabled_p
&& r
->y
< yb
;
27013 if (!r
->reversed_p
)
27015 g
= r
->glyphs
[TEXT_AREA
];
27016 e
= g
+ r
->used
[TEXT_AREA
];
27017 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27018 if (EQ (g
->object
, object
)
27019 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27021 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27022 hlinfo
->mouse_face_beg_y
= r
->y
;
27023 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27024 hlinfo
->mouse_face_beg_x
= gx
;
27033 e
= r
->glyphs
[TEXT_AREA
];
27034 g
= e
+ r
->used
[TEXT_AREA
];
27035 for ( ; g
> e
; --g
)
27036 if (EQ ((g
-1)->object
, object
)
27037 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
27039 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27040 hlinfo
->mouse_face_beg_y
= r
->y
;
27041 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27042 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
27043 gx
+= g1
->pixel_width
;
27044 hlinfo
->mouse_face_beg_x
= gx
;
27056 /* Starting with the next row, look for the first row which does NOT
27057 include any glyphs whose positions are in the range. */
27058 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
27060 g
= r
->glyphs
[TEXT_AREA
];
27061 e
= g
+ r
->used
[TEXT_AREA
];
27063 for ( ; g
< e
; ++g
)
27064 if (EQ (g
->object
, object
)
27065 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27074 /* The highlighted region ends on the previous row. */
27077 /* Set the end row and its vertical pixel coordinate. */
27078 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
27079 hlinfo
->mouse_face_end_y
= r
->y
;
27081 /* Compute and set the end column and the end column's horizontal
27082 pixel coordinate. */
27083 if (!r
->reversed_p
)
27085 g
= r
->glyphs
[TEXT_AREA
];
27086 e
= g
+ r
->used
[TEXT_AREA
];
27087 for ( ; e
> g
; --e
)
27088 if (EQ ((e
-1)->object
, object
)
27089 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
27091 hlinfo
->mouse_face_end_col
= e
- g
;
27093 for (gx
= r
->x
; g
< e
; ++g
)
27094 gx
+= g
->pixel_width
;
27095 hlinfo
->mouse_face_end_x
= gx
;
27099 e
= r
->glyphs
[TEXT_AREA
];
27100 g
= e
+ r
->used
[TEXT_AREA
];
27101 for (gx
= r
->x
; e
< g
; ++e
)
27103 if (EQ (e
->object
, object
)
27104 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
27106 gx
+= e
->pixel_width
;
27108 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
27109 hlinfo
->mouse_face_end_x
= gx
;
27113 #ifdef HAVE_WINDOW_SYSTEM
27115 /* See if position X, Y is within a hot-spot of an image. */
27118 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
27120 if (!CONSP (hot_spot
))
27123 if (EQ (XCAR (hot_spot
), Qrect
))
27125 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27126 Lisp_Object rect
= XCDR (hot_spot
);
27130 if (!CONSP (XCAR (rect
)))
27132 if (!CONSP (XCDR (rect
)))
27134 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
27136 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
27138 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
27140 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
27144 else if (EQ (XCAR (hot_spot
), Qcircle
))
27146 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27147 Lisp_Object circ
= XCDR (hot_spot
);
27148 Lisp_Object lr
, lx0
, ly0
;
27150 && CONSP (XCAR (circ
))
27151 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
27152 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
27153 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
27155 double r
= XFLOATINT (lr
);
27156 double dx
= XINT (lx0
) - x
;
27157 double dy
= XINT (ly0
) - y
;
27158 return (dx
* dx
+ dy
* dy
<= r
* r
);
27161 else if (EQ (XCAR (hot_spot
), Qpoly
))
27163 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27164 if (VECTORP (XCDR (hot_spot
)))
27166 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
27167 Lisp_Object
*poly
= v
->contents
;
27168 ptrdiff_t n
= v
->header
.size
;
27171 Lisp_Object lx
, ly
;
27174 /* Need an even number of coordinates, and at least 3 edges. */
27175 if (n
< 6 || n
& 1)
27178 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27179 If count is odd, we are inside polygon. Pixels on edges
27180 may or may not be included depending on actual geometry of the
27182 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
27183 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
27185 x0
= XINT (lx
), y0
= XINT (ly
);
27186 for (i
= 0; i
< n
; i
+= 2)
27188 int x1
= x0
, y1
= y0
;
27189 if ((lx
= poly
[i
], !INTEGERP (lx
))
27190 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
27192 x0
= XINT (lx
), y0
= XINT (ly
);
27194 /* Does this segment cross the X line? */
27202 if (y
> y0
&& y
> y1
)
27204 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
27214 find_hot_spot (Lisp_Object map
, int x
, int y
)
27216 while (CONSP (map
))
27218 if (CONSP (XCAR (map
))
27219 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
27227 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
27229 doc
: /* Lookup in image map MAP coordinates X and Y.
27230 An image map is an alist where each element has the format (AREA ID PLIST).
27231 An AREA is specified as either a rectangle, a circle, or a polygon:
27232 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27233 pixel coordinates of the upper left and bottom right corners.
27234 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27235 and the radius of the circle; r may be a float or integer.
27236 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27237 vector describes one corner in the polygon.
27238 Returns the alist element for the first matching AREA in MAP. */)
27239 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
27247 return find_hot_spot (map
,
27248 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
27249 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
27253 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27255 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
27257 /* Do not change cursor shape while dragging mouse. */
27258 if (!NILP (do_mouse_tracking
))
27261 if (!NILP (pointer
))
27263 if (EQ (pointer
, Qarrow
))
27264 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27265 else if (EQ (pointer
, Qhand
))
27266 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27267 else if (EQ (pointer
, Qtext
))
27268 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27269 else if (EQ (pointer
, intern ("hdrag")))
27270 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27271 #ifdef HAVE_X_WINDOWS
27272 else if (EQ (pointer
, intern ("vdrag")))
27273 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27275 else if (EQ (pointer
, intern ("hourglass")))
27276 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27277 else if (EQ (pointer
, Qmodeline
))
27278 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27280 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27283 if (cursor
!= No_Cursor
)
27284 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27287 #endif /* HAVE_WINDOW_SYSTEM */
27289 /* Take proper action when mouse has moved to the mode or header line
27290 or marginal area AREA of window W, x-position X and y-position Y.
27291 X is relative to the start of the text display area of W, so the
27292 width of bitmap areas and scroll bars must be subtracted to get a
27293 position relative to the start of the mode line. */
27296 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27297 enum window_part area
)
27299 struct window
*w
= XWINDOW (window
);
27300 struct frame
*f
= XFRAME (w
->frame
);
27301 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27302 #ifdef HAVE_WINDOW_SYSTEM
27303 Display_Info
*dpyinfo
;
27305 Cursor cursor
= No_Cursor
;
27306 Lisp_Object pointer
= Qnil
;
27307 int dx
, dy
, width
, height
;
27309 Lisp_Object string
, object
= Qnil
;
27310 Lisp_Object pos
IF_LINT (= Qnil
), help
;
27312 Lisp_Object mouse_face
;
27313 int original_x_pixel
= x
;
27314 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27315 struct glyph_row
*row
IF_LINT (= 0);
27317 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27322 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27323 returns them in row/column units! */
27324 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27325 &object
, &dx
, &dy
, &width
, &height
);
27327 row
= (area
== ON_MODE_LINE
27328 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27329 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27331 /* Find the glyph under the mouse pointer. */
27332 if (row
->mode_line_p
&& row
->enabled_p
)
27334 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27335 end
= glyph
+ row
->used
[TEXT_AREA
];
27337 for (x0
= original_x_pixel
;
27338 glyph
< end
&& x0
>= glyph
->pixel_width
;
27340 x0
-= glyph
->pixel_width
;
27348 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27349 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27350 returns them in row/column units! */
27351 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27352 &object
, &dx
, &dy
, &width
, &height
);
27357 #ifdef HAVE_WINDOW_SYSTEM
27358 if (IMAGEP (object
))
27360 Lisp_Object image_map
, hotspot
;
27361 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27363 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27365 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27369 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27370 If so, we could look for mouse-enter, mouse-leave
27371 properties in PLIST (and do something...). */
27372 hotspot
= XCDR (hotspot
);
27373 if (CONSP (hotspot
)
27374 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27376 pointer
= Fplist_get (plist
, Qpointer
);
27377 if (NILP (pointer
))
27379 help
= Fplist_get (plist
, Qhelp_echo
);
27382 help_echo_string
= help
;
27383 XSETWINDOW (help_echo_window
, w
);
27384 help_echo_object
= w
->buffer
;
27385 help_echo_pos
= charpos
;
27389 if (NILP (pointer
))
27390 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27392 #endif /* HAVE_WINDOW_SYSTEM */
27394 if (STRINGP (string
))
27395 pos
= make_number (charpos
);
27397 /* Set the help text and mouse pointer. If the mouse is on a part
27398 of the mode line without any text (e.g. past the right edge of
27399 the mode line text), use the default help text and pointer. */
27400 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27402 /* Arrange to display the help by setting the global variables
27403 help_echo_string, help_echo_object, and help_echo_pos. */
27406 if (STRINGP (string
))
27407 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27411 help_echo_string
= help
;
27412 XSETWINDOW (help_echo_window
, w
);
27413 help_echo_object
= string
;
27414 help_echo_pos
= charpos
;
27416 else if (area
== ON_MODE_LINE
)
27418 Lisp_Object default_help
27419 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27422 if (STRINGP (default_help
))
27424 help_echo_string
= default_help
;
27425 XSETWINDOW (help_echo_window
, w
);
27426 help_echo_object
= Qnil
;
27427 help_echo_pos
= -1;
27432 #ifdef HAVE_WINDOW_SYSTEM
27433 /* Change the mouse pointer according to what is under it. */
27434 if (FRAME_WINDOW_P (f
))
27436 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27437 if (STRINGP (string
))
27439 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27441 if (NILP (pointer
))
27442 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27444 /* Change the mouse pointer according to what is under X/Y. */
27446 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27449 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27450 if (!KEYMAPP (map
))
27451 map
= Fget_text_property (pos
, Qkeymap
, string
);
27452 if (!KEYMAPP (map
))
27453 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27457 /* Default mode-line pointer. */
27458 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27463 /* Change the mouse face according to what is under X/Y. */
27464 if (STRINGP (string
))
27466 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27467 if (!NILP (mouse_face
)
27468 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27473 struct glyph
* tmp_glyph
;
27477 int total_pixel_width
;
27478 ptrdiff_t begpos
, endpos
, ignore
;
27482 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27483 Qmouse_face
, string
, Qnil
);
27489 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27491 endpos
= SCHARS (string
);
27495 /* Calculate the glyph position GPOS of GLYPH in the
27496 displayed string, relative to the beginning of the
27497 highlighted part of the string.
27499 Note: GPOS is different from CHARPOS. CHARPOS is the
27500 position of GLYPH in the internal string object. A mode
27501 line string format has structures which are converted to
27502 a flattened string by the Emacs Lisp interpreter. The
27503 internal string is an element of those structures. The
27504 displayed string is the flattened string. */
27505 tmp_glyph
= row_start_glyph
;
27506 while (tmp_glyph
< glyph
27507 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27508 && begpos
<= tmp_glyph
->charpos
27509 && tmp_glyph
->charpos
< endpos
)))
27511 gpos
= glyph
- tmp_glyph
;
27513 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27514 the highlighted part of the displayed string to which
27515 GLYPH belongs. Note: GSEQ_LENGTH is different from
27516 SCHARS (STRING), because the latter returns the length of
27517 the internal string. */
27518 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27520 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27521 && begpos
<= tmp_glyph
->charpos
27522 && tmp_glyph
->charpos
< endpos
));
27525 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27527 /* Calculate the total pixel width of all the glyphs between
27528 the beginning of the highlighted area and GLYPH. */
27529 total_pixel_width
= 0;
27530 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27531 total_pixel_width
+= tmp_glyph
->pixel_width
;
27533 /* Pre calculation of re-rendering position. Note: X is in
27534 column units here, after the call to mode_line_string or
27535 marginal_area_string. */
27537 vpos
= (area
== ON_MODE_LINE
27538 ? (w
->current_matrix
)->nrows
- 1
27541 /* If GLYPH's position is included in the region that is
27542 already drawn in mouse face, we have nothing to do. */
27543 if ( EQ (window
, hlinfo
->mouse_face_window
)
27544 && (!row
->reversed_p
27545 ? (hlinfo
->mouse_face_beg_col
<= hpos
27546 && hpos
< hlinfo
->mouse_face_end_col
)
27547 /* In R2L rows we swap BEG and END, see below. */
27548 : (hlinfo
->mouse_face_end_col
<= hpos
27549 && hpos
< hlinfo
->mouse_face_beg_col
))
27550 && hlinfo
->mouse_face_beg_row
== vpos
)
27553 if (clear_mouse_face (hlinfo
))
27554 cursor
= No_Cursor
;
27556 if (!row
->reversed_p
)
27558 hlinfo
->mouse_face_beg_col
= hpos
;
27559 hlinfo
->mouse_face_beg_x
= original_x_pixel
27560 - (total_pixel_width
+ dx
);
27561 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27562 hlinfo
->mouse_face_end_x
= 0;
27566 /* In R2L rows, show_mouse_face expects BEG and END
27567 coordinates to be swapped. */
27568 hlinfo
->mouse_face_end_col
= hpos
;
27569 hlinfo
->mouse_face_end_x
= original_x_pixel
27570 - (total_pixel_width
+ dx
);
27571 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27572 hlinfo
->mouse_face_beg_x
= 0;
27575 hlinfo
->mouse_face_beg_row
= vpos
;
27576 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27577 hlinfo
->mouse_face_beg_y
= 0;
27578 hlinfo
->mouse_face_end_y
= 0;
27579 hlinfo
->mouse_face_past_end
= 0;
27580 hlinfo
->mouse_face_window
= window
;
27582 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27588 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27590 if (NILP (pointer
))
27593 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27594 clear_mouse_face (hlinfo
);
27596 #ifdef HAVE_WINDOW_SYSTEM
27597 if (FRAME_WINDOW_P (f
))
27598 define_frame_cursor1 (f
, cursor
, pointer
);
27604 Take proper action when the mouse has moved to position X, Y on
27605 frame F as regards highlighting characters that have mouse-face
27606 properties. Also de-highlighting chars where the mouse was before.
27607 X and Y can be negative or out of range. */
27610 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27612 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27613 enum window_part part
= ON_NOTHING
;
27614 Lisp_Object window
;
27616 Cursor cursor
= No_Cursor
;
27617 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27620 /* When a menu is active, don't highlight because this looks odd. */
27621 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27622 if (popup_activated ())
27626 if (NILP (Vmouse_highlight
)
27627 || !f
->glyphs_initialized_p
27628 || f
->pointer_invisible
)
27631 hlinfo
->mouse_face_mouse_x
= x
;
27632 hlinfo
->mouse_face_mouse_y
= y
;
27633 hlinfo
->mouse_face_mouse_frame
= f
;
27635 if (hlinfo
->mouse_face_defer
)
27638 if (gc_in_progress
)
27640 hlinfo
->mouse_face_deferred_gc
= 1;
27644 /* Which window is that in? */
27645 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27647 /* If displaying active text in another window, clear that. */
27648 if (! EQ (window
, hlinfo
->mouse_face_window
)
27649 /* Also clear if we move out of text area in same window. */
27650 || (!NILP (hlinfo
->mouse_face_window
)
27653 && part
!= ON_MODE_LINE
27654 && part
!= ON_HEADER_LINE
))
27655 clear_mouse_face (hlinfo
);
27657 /* Not on a window -> return. */
27658 if (!WINDOWP (window
))
27661 /* Reset help_echo_string. It will get recomputed below. */
27662 help_echo_string
= Qnil
;
27664 /* Convert to window-relative pixel coordinates. */
27665 w
= XWINDOW (window
);
27666 frame_to_window_pixel_xy (w
, &x
, &y
);
27668 #ifdef HAVE_WINDOW_SYSTEM
27669 /* Handle tool-bar window differently since it doesn't display a
27671 if (EQ (window
, f
->tool_bar_window
))
27673 note_tool_bar_highlight (f
, x
, y
);
27678 /* Mouse is on the mode, header line or margin? */
27679 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27680 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27682 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27686 #ifdef HAVE_WINDOW_SYSTEM
27687 if (part
== ON_VERTICAL_BORDER
)
27689 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27690 help_echo_string
= build_string ("drag-mouse-1: resize");
27692 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27693 || part
== ON_SCROLL_BAR
)
27694 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27696 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27699 /* Are we in a window whose display is up to date?
27700 And verify the buffer's text has not changed. */
27701 b
= XBUFFER (w
->buffer
);
27702 if (part
== ON_TEXT
27703 && EQ (w
->window_end_valid
, w
->buffer
)
27704 && w
->last_modified
== BUF_MODIFF (b
)
27705 && w
->last_overlay_modified
== BUF_OVERLAY_MODIFF (b
))
27707 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27709 struct glyph
*glyph
;
27710 Lisp_Object object
;
27711 Lisp_Object mouse_face
= Qnil
, position
;
27712 Lisp_Object
*overlay_vec
= NULL
;
27713 ptrdiff_t i
, noverlays
;
27714 struct buffer
*obuf
;
27715 ptrdiff_t obegv
, ozv
;
27718 /* Find the glyph under X/Y. */
27719 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27721 #ifdef HAVE_WINDOW_SYSTEM
27722 /* Look for :pointer property on image. */
27723 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27725 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27726 if (img
!= NULL
&& IMAGEP (img
->spec
))
27728 Lisp_Object image_map
, hotspot
;
27729 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27731 && (hotspot
= find_hot_spot (image_map
,
27732 glyph
->slice
.img
.x
+ dx
,
27733 glyph
->slice
.img
.y
+ dy
),
27735 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27739 /* Could check XCAR (hotspot) to see if we enter/leave
27741 If so, we could look for mouse-enter, mouse-leave
27742 properties in PLIST (and do something...). */
27743 hotspot
= XCDR (hotspot
);
27744 if (CONSP (hotspot
)
27745 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27747 pointer
= Fplist_get (plist
, Qpointer
);
27748 if (NILP (pointer
))
27750 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27751 if (!NILP (help_echo_string
))
27753 help_echo_window
= window
;
27754 help_echo_object
= glyph
->object
;
27755 help_echo_pos
= glyph
->charpos
;
27759 if (NILP (pointer
))
27760 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27763 #endif /* HAVE_WINDOW_SYSTEM */
27765 /* Clear mouse face if X/Y not over text. */
27767 || area
!= TEXT_AREA
27768 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27769 /* Glyph's OBJECT is an integer for glyphs inserted by the
27770 display engine for its internal purposes, like truncation
27771 and continuation glyphs and blanks beyond the end of
27772 line's text on text terminals. If we are over such a
27773 glyph, we are not over any text. */
27774 || INTEGERP (glyph
->object
)
27775 /* R2L rows have a stretch glyph at their front, which
27776 stands for no text, whereas L2R rows have no glyphs at
27777 all beyond the end of text. Treat such stretch glyphs
27778 like we do with NULL glyphs in L2R rows. */
27779 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27780 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27781 && glyph
->type
== STRETCH_GLYPH
27782 && glyph
->avoid_cursor_p
))
27784 if (clear_mouse_face (hlinfo
))
27785 cursor
= No_Cursor
;
27786 #ifdef HAVE_WINDOW_SYSTEM
27787 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27789 if (area
!= TEXT_AREA
)
27790 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27792 pointer
= Vvoid_text_area_pointer
;
27798 pos
= glyph
->charpos
;
27799 object
= glyph
->object
;
27800 if (!STRINGP (object
) && !BUFFERP (object
))
27803 /* If we get an out-of-range value, return now; avoid an error. */
27804 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27807 /* Make the window's buffer temporarily current for
27808 overlays_at and compute_char_face. */
27809 obuf
= current_buffer
;
27810 current_buffer
= b
;
27816 /* Is this char mouse-active or does it have help-echo? */
27817 position
= make_number (pos
);
27819 if (BUFFERP (object
))
27821 /* Put all the overlays we want in a vector in overlay_vec. */
27822 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27823 /* Sort overlays into increasing priority order. */
27824 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27829 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27832 cursor
= No_Cursor
;
27834 /* Check mouse-face highlighting. */
27836 /* If there exists an overlay with mouse-face overlapping
27837 the one we are currently highlighting, we have to
27838 check if we enter the overlapping overlay, and then
27839 highlight only that. */
27840 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27841 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27843 /* Find the highest priority overlay with a mouse-face. */
27844 Lisp_Object overlay
= Qnil
;
27845 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27847 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27848 if (!NILP (mouse_face
))
27849 overlay
= overlay_vec
[i
];
27852 /* If we're highlighting the same overlay as before, there's
27853 no need to do that again. */
27854 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27855 goto check_help_echo
;
27856 hlinfo
->mouse_face_overlay
= overlay
;
27858 /* Clear the display of the old active region, if any. */
27859 if (clear_mouse_face (hlinfo
))
27860 cursor
= No_Cursor
;
27862 /* If no overlay applies, get a text property. */
27863 if (NILP (overlay
))
27864 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27866 /* Next, compute the bounds of the mouse highlighting and
27868 if (!NILP (mouse_face
) && STRINGP (object
))
27870 /* The mouse-highlighting comes from a display string
27871 with a mouse-face. */
27875 s
= Fprevious_single_property_change
27876 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27877 e
= Fnext_single_property_change
27878 (position
, Qmouse_face
, object
, Qnil
);
27880 s
= make_number (0);
27882 e
= make_number (SCHARS (object
) - 1);
27883 mouse_face_from_string_pos (w
, hlinfo
, object
,
27884 XINT (s
), XINT (e
));
27885 hlinfo
->mouse_face_past_end
= 0;
27886 hlinfo
->mouse_face_window
= window
;
27887 hlinfo
->mouse_face_face_id
27888 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27889 glyph
->face_id
, 1);
27890 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27891 cursor
= No_Cursor
;
27895 /* The mouse-highlighting, if any, comes from an overlay
27896 or text property in the buffer. */
27897 Lisp_Object buffer
IF_LINT (= Qnil
);
27898 Lisp_Object disp_string
IF_LINT (= Qnil
);
27900 if (STRINGP (object
))
27902 /* If we are on a display string with no mouse-face,
27903 check if the text under it has one. */
27904 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27905 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27906 pos
= string_buffer_position (object
, start
);
27909 mouse_face
= get_char_property_and_overlay
27910 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27911 buffer
= w
->buffer
;
27912 disp_string
= object
;
27918 disp_string
= Qnil
;
27921 if (!NILP (mouse_face
))
27923 Lisp_Object before
, after
;
27924 Lisp_Object before_string
, after_string
;
27925 /* To correctly find the limits of mouse highlight
27926 in a bidi-reordered buffer, we must not use the
27927 optimization of limiting the search in
27928 previous-single-property-change and
27929 next-single-property-change, because
27930 rows_from_pos_range needs the real start and end
27931 positions to DTRT in this case. That's because
27932 the first row visible in a window does not
27933 necessarily display the character whose position
27934 is the smallest. */
27936 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27937 ? Fmarker_position (w
->start
)
27940 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27941 ? make_number (BUF_Z (XBUFFER (buffer
))
27942 - XFASTINT (w
->window_end_pos
))
27945 if (NILP (overlay
))
27947 /* Handle the text property case. */
27948 before
= Fprevious_single_property_change
27949 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27950 after
= Fnext_single_property_change
27951 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27952 before_string
= after_string
= Qnil
;
27956 /* Handle the overlay case. */
27957 before
= Foverlay_start (overlay
);
27958 after
= Foverlay_end (overlay
);
27959 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27960 after_string
= Foverlay_get (overlay
, Qafter_string
);
27962 if (!STRINGP (before_string
)) before_string
= Qnil
;
27963 if (!STRINGP (after_string
)) after_string
= Qnil
;
27966 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27969 : XFASTINT (before
),
27971 ? BUF_Z (XBUFFER (buffer
))
27972 : XFASTINT (after
),
27973 before_string
, after_string
,
27975 cursor
= No_Cursor
;
27982 /* Look for a `help-echo' property. */
27983 if (NILP (help_echo_string
)) {
27984 Lisp_Object help
, overlay
;
27986 /* Check overlays first. */
27987 help
= overlay
= Qnil
;
27988 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27990 overlay
= overlay_vec
[i
];
27991 help
= Foverlay_get (overlay
, Qhelp_echo
);
27996 help_echo_string
= help
;
27997 help_echo_window
= window
;
27998 help_echo_object
= overlay
;
27999 help_echo_pos
= pos
;
28003 Lisp_Object obj
= glyph
->object
;
28004 ptrdiff_t charpos
= glyph
->charpos
;
28006 /* Try text properties. */
28009 && charpos
< SCHARS (obj
))
28011 help
= Fget_text_property (make_number (charpos
),
28015 /* If the string itself doesn't specify a help-echo,
28016 see if the buffer text ``under'' it does. */
28017 struct glyph_row
*r
28018 = MATRIX_ROW (w
->current_matrix
, vpos
);
28019 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28020 ptrdiff_t p
= string_buffer_position (obj
, start
);
28023 help
= Fget_char_property (make_number (p
),
28024 Qhelp_echo
, w
->buffer
);
28033 else if (BUFFERP (obj
)
28036 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
28041 help_echo_string
= help
;
28042 help_echo_window
= window
;
28043 help_echo_object
= obj
;
28044 help_echo_pos
= charpos
;
28049 #ifdef HAVE_WINDOW_SYSTEM
28050 /* Look for a `pointer' property. */
28051 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28053 /* Check overlays first. */
28054 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
28055 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
28057 if (NILP (pointer
))
28059 Lisp_Object obj
= glyph
->object
;
28060 ptrdiff_t charpos
= glyph
->charpos
;
28062 /* Try text properties. */
28065 && charpos
< SCHARS (obj
))
28067 pointer
= Fget_text_property (make_number (charpos
),
28069 if (NILP (pointer
))
28071 /* If the string itself doesn't specify a pointer,
28072 see if the buffer text ``under'' it does. */
28073 struct glyph_row
*r
28074 = MATRIX_ROW (w
->current_matrix
, vpos
);
28075 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28076 ptrdiff_t p
= string_buffer_position (obj
, start
);
28078 pointer
= Fget_char_property (make_number (p
),
28079 Qpointer
, w
->buffer
);
28082 else if (BUFFERP (obj
)
28085 pointer
= Fget_text_property (make_number (charpos
),
28089 #endif /* HAVE_WINDOW_SYSTEM */
28093 current_buffer
= obuf
;
28098 #ifdef HAVE_WINDOW_SYSTEM
28099 if (FRAME_WINDOW_P (f
))
28100 define_frame_cursor1 (f
, cursor
, pointer
);
28102 /* This is here to prevent a compiler error, about "label at end of
28103 compound statement". */
28110 Clear any mouse-face on window W. This function is part of the
28111 redisplay interface, and is called from try_window_id and similar
28112 functions to ensure the mouse-highlight is off. */
28115 x_clear_window_mouse_face (struct window
*w
)
28117 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28118 Lisp_Object window
;
28121 XSETWINDOW (window
, w
);
28122 if (EQ (window
, hlinfo
->mouse_face_window
))
28123 clear_mouse_face (hlinfo
);
28129 Just discard the mouse face information for frame F, if any.
28130 This is used when the size of F is changed. */
28133 cancel_mouse_face (struct frame
*f
)
28135 Lisp_Object window
;
28136 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28138 window
= hlinfo
->mouse_face_window
;
28139 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
28141 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28142 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28143 hlinfo
->mouse_face_window
= Qnil
;
28149 /***********************************************************************
28151 ***********************************************************************/
28153 #ifdef HAVE_WINDOW_SYSTEM
28155 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28156 which intersects rectangle R. R is in window-relative coordinates. */
28159 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
28160 enum glyph_row_area area
)
28162 struct glyph
*first
= row
->glyphs
[area
];
28163 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
28164 struct glyph
*last
;
28165 int first_x
, start_x
, x
;
28167 if (area
== TEXT_AREA
&& row
->fill_line_p
)
28168 /* If row extends face to end of line write the whole line. */
28169 draw_glyphs (w
, 0, row
, area
,
28170 0, row
->used
[area
],
28171 DRAW_NORMAL_TEXT
, 0);
28174 /* Set START_X to the window-relative start position for drawing glyphs of
28175 AREA. The first glyph of the text area can be partially visible.
28176 The first glyphs of other areas cannot. */
28177 start_x
= window_box_left_offset (w
, area
);
28179 if (area
== TEXT_AREA
)
28182 /* Find the first glyph that must be redrawn. */
28184 && x
+ first
->pixel_width
< r
->x
)
28186 x
+= first
->pixel_width
;
28190 /* Find the last one. */
28194 && x
< r
->x
+ r
->width
)
28196 x
+= last
->pixel_width
;
28202 draw_glyphs (w
, first_x
- start_x
, row
, area
,
28203 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
28204 DRAW_NORMAL_TEXT
, 0);
28209 /* Redraw the parts of the glyph row ROW on window W intersecting
28210 rectangle R. R is in window-relative coordinates. Value is
28211 non-zero if mouse-face was overwritten. */
28214 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
28216 eassert (row
->enabled_p
);
28218 if (row
->mode_line_p
|| w
->pseudo_window_p
)
28219 draw_glyphs (w
, 0, row
, TEXT_AREA
,
28220 0, row
->used
[TEXT_AREA
],
28221 DRAW_NORMAL_TEXT
, 0);
28224 if (row
->used
[LEFT_MARGIN_AREA
])
28225 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
28226 if (row
->used
[TEXT_AREA
])
28227 expose_area (w
, row
, r
, TEXT_AREA
);
28228 if (row
->used
[RIGHT_MARGIN_AREA
])
28229 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
28230 draw_row_fringe_bitmaps (w
, row
);
28233 return row
->mouse_face_p
;
28237 /* Redraw those parts of glyphs rows during expose event handling that
28238 overlap other rows. Redrawing of an exposed line writes over parts
28239 of lines overlapping that exposed line; this function fixes that.
28241 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28242 row in W's current matrix that is exposed and overlaps other rows.
28243 LAST_OVERLAPPING_ROW is the last such row. */
28246 expose_overlaps (struct window
*w
,
28247 struct glyph_row
*first_overlapping_row
,
28248 struct glyph_row
*last_overlapping_row
,
28251 struct glyph_row
*row
;
28253 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
28254 if (row
->overlapping_p
)
28256 eassert (row
->enabled_p
&& !row
->mode_line_p
);
28259 if (row
->used
[LEFT_MARGIN_AREA
])
28260 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
28262 if (row
->used
[TEXT_AREA
])
28263 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
28265 if (row
->used
[RIGHT_MARGIN_AREA
])
28266 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
28272 /* Return non-zero if W's cursor intersects rectangle R. */
28275 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
28277 XRectangle cr
, result
;
28278 struct glyph
*cursor_glyph
;
28279 struct glyph_row
*row
;
28281 if (w
->phys_cursor
.vpos
>= 0
28282 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
28283 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
28285 && row
->cursor_in_fringe_p
)
28287 /* Cursor is in the fringe. */
28288 cr
.x
= window_box_right_offset (w
,
28289 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
28290 ? RIGHT_MARGIN_AREA
28293 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
28294 cr
.height
= row
->height
;
28295 return x_intersect_rectangles (&cr
, r
, &result
);
28298 cursor_glyph
= get_phys_cursor_glyph (w
);
28301 /* r is relative to W's box, but w->phys_cursor.x is relative
28302 to left edge of W's TEXT area. Adjust it. */
28303 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28304 cr
.y
= w
->phys_cursor
.y
;
28305 cr
.width
= cursor_glyph
->pixel_width
;
28306 cr
.height
= w
->phys_cursor_height
;
28307 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28308 I assume the effect is the same -- and this is portable. */
28309 return x_intersect_rectangles (&cr
, r
, &result
);
28311 /* If we don't understand the format, pretend we're not in the hot-spot. */
28317 Draw a vertical window border to the right of window W if W doesn't
28318 have vertical scroll bars. */
28321 x_draw_vertical_border (struct window
*w
)
28323 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28325 /* We could do better, if we knew what type of scroll-bar the adjacent
28326 windows (on either side) have... But we don't :-(
28327 However, I think this works ok. ++KFS 2003-04-25 */
28329 /* Redraw borders between horizontally adjacent windows. Don't
28330 do it for frames with vertical scroll bars because either the
28331 right scroll bar of a window, or the left scroll bar of its
28332 neighbor will suffice as a border. */
28333 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28336 if (!WINDOW_RIGHTMOST_P (w
)
28337 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28339 int x0
, x1
, y0
, y1
;
28341 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28344 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28347 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28349 else if (!WINDOW_LEFTMOST_P (w
)
28350 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28352 int x0
, x1
, y0
, y1
;
28354 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28357 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28360 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28365 /* Redraw the part of window W intersection rectangle FR. Pixel
28366 coordinates in FR are frame-relative. Call this function with
28367 input blocked. Value is non-zero if the exposure overwrites
28371 expose_window (struct window
*w
, XRectangle
*fr
)
28373 struct frame
*f
= XFRAME (w
->frame
);
28375 int mouse_face_overwritten_p
= 0;
28377 /* If window is not yet fully initialized, do nothing. This can
28378 happen when toolkit scroll bars are used and a window is split.
28379 Reconfiguring the scroll bar will generate an expose for a newly
28381 if (w
->current_matrix
== NULL
)
28384 /* When we're currently updating the window, display and current
28385 matrix usually don't agree. Arrange for a thorough display
28387 if (w
== updated_window
)
28389 SET_FRAME_GARBAGED (f
);
28393 /* Frame-relative pixel rectangle of W. */
28394 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28395 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28396 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28397 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28399 if (x_intersect_rectangles (fr
, &wr
, &r
))
28401 int yb
= window_text_bottom_y (w
);
28402 struct glyph_row
*row
;
28403 int cursor_cleared_p
, phys_cursor_on_p
;
28404 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28406 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28407 r
.x
, r
.y
, r
.width
, r
.height
));
28409 /* Convert to window coordinates. */
28410 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28411 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28413 /* Turn off the cursor. */
28414 if (!w
->pseudo_window_p
28415 && phys_cursor_in_rect_p (w
, &r
))
28417 x_clear_cursor (w
);
28418 cursor_cleared_p
= 1;
28421 cursor_cleared_p
= 0;
28423 /* If the row containing the cursor extends face to end of line,
28424 then expose_area might overwrite the cursor outside the
28425 rectangle and thus notice_overwritten_cursor might clear
28426 w->phys_cursor_on_p. We remember the original value and
28427 check later if it is changed. */
28428 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28430 /* Update lines intersecting rectangle R. */
28431 first_overlapping_row
= last_overlapping_row
= NULL
;
28432 for (row
= w
->current_matrix
->rows
;
28437 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28439 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28440 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28441 || (r
.y
>= y0
&& r
.y
< y1
)
28442 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28444 /* A header line may be overlapping, but there is no need
28445 to fix overlapping areas for them. KFS 2005-02-12 */
28446 if (row
->overlapping_p
&& !row
->mode_line_p
)
28448 if (first_overlapping_row
== NULL
)
28449 first_overlapping_row
= row
;
28450 last_overlapping_row
= row
;
28454 if (expose_line (w
, row
, &r
))
28455 mouse_face_overwritten_p
= 1;
28458 else if (row
->overlapping_p
)
28460 /* We must redraw a row overlapping the exposed area. */
28462 ? y0
+ row
->phys_height
> r
.y
28463 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28465 if (first_overlapping_row
== NULL
)
28466 first_overlapping_row
= row
;
28467 last_overlapping_row
= row
;
28475 /* Display the mode line if there is one. */
28476 if (WINDOW_WANTS_MODELINE_P (w
)
28477 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28479 && row
->y
< r
.y
+ r
.height
)
28481 if (expose_line (w
, row
, &r
))
28482 mouse_face_overwritten_p
= 1;
28485 if (!w
->pseudo_window_p
)
28487 /* Fix the display of overlapping rows. */
28488 if (first_overlapping_row
)
28489 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28492 /* Draw border between windows. */
28493 x_draw_vertical_border (w
);
28495 /* Turn the cursor on again. */
28496 if (cursor_cleared_p
28497 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28498 update_window_cursor (w
, 1);
28502 return mouse_face_overwritten_p
;
28507 /* Redraw (parts) of all windows in the window tree rooted at W that
28508 intersect R. R contains frame pixel coordinates. Value is
28509 non-zero if the exposure overwrites mouse-face. */
28512 expose_window_tree (struct window
*w
, XRectangle
*r
)
28514 struct frame
*f
= XFRAME (w
->frame
);
28515 int mouse_face_overwritten_p
= 0;
28517 while (w
&& !FRAME_GARBAGED_P (f
))
28519 if (!NILP (w
->hchild
))
28520 mouse_face_overwritten_p
28521 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28522 else if (!NILP (w
->vchild
))
28523 mouse_face_overwritten_p
28524 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28526 mouse_face_overwritten_p
|= expose_window (w
, r
);
28528 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28531 return mouse_face_overwritten_p
;
28536 Redisplay an exposed area of frame F. X and Y are the upper-left
28537 corner of the exposed rectangle. W and H are width and height of
28538 the exposed area. All are pixel values. W or H zero means redraw
28539 the entire frame. */
28542 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28545 int mouse_face_overwritten_p
= 0;
28547 TRACE ((stderr
, "expose_frame "));
28549 /* No need to redraw if frame will be redrawn soon. */
28550 if (FRAME_GARBAGED_P (f
))
28552 TRACE ((stderr
, " garbaged\n"));
28556 /* If basic faces haven't been realized yet, there is no point in
28557 trying to redraw anything. This can happen when we get an expose
28558 event while Emacs is starting, e.g. by moving another window. */
28559 if (FRAME_FACE_CACHE (f
) == NULL
28560 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28562 TRACE ((stderr
, " no faces\n"));
28566 if (w
== 0 || h
== 0)
28569 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28570 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28580 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28581 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28583 if (WINDOWP (f
->tool_bar_window
))
28584 mouse_face_overwritten_p
28585 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28587 #ifdef HAVE_X_WINDOWS
28589 #ifndef USE_X_TOOLKIT
28590 if (WINDOWP (f
->menu_bar_window
))
28591 mouse_face_overwritten_p
28592 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28593 #endif /* not USE_X_TOOLKIT */
28597 /* Some window managers support a focus-follows-mouse style with
28598 delayed raising of frames. Imagine a partially obscured frame,
28599 and moving the mouse into partially obscured mouse-face on that
28600 frame. The visible part of the mouse-face will be highlighted,
28601 then the WM raises the obscured frame. With at least one WM, KDE
28602 2.1, Emacs is not getting any event for the raising of the frame
28603 (even tried with SubstructureRedirectMask), only Expose events.
28604 These expose events will draw text normally, i.e. not
28605 highlighted. Which means we must redo the highlight here.
28606 Subsume it under ``we love X''. --gerd 2001-08-15 */
28607 /* Included in Windows version because Windows most likely does not
28608 do the right thing if any third party tool offers
28609 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28610 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28612 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28613 if (f
== hlinfo
->mouse_face_mouse_frame
)
28615 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28616 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28617 clear_mouse_face (hlinfo
);
28618 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28625 Determine the intersection of two rectangles R1 and R2. Return
28626 the intersection in *RESULT. Value is non-zero if RESULT is not
28630 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28632 XRectangle
*left
, *right
;
28633 XRectangle
*upper
, *lower
;
28634 int intersection_p
= 0;
28636 /* Rearrange so that R1 is the left-most rectangle. */
28638 left
= r1
, right
= r2
;
28640 left
= r2
, right
= r1
;
28642 /* X0 of the intersection is right.x0, if this is inside R1,
28643 otherwise there is no intersection. */
28644 if (right
->x
<= left
->x
+ left
->width
)
28646 result
->x
= right
->x
;
28648 /* The right end of the intersection is the minimum of
28649 the right ends of left and right. */
28650 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28653 /* Same game for Y. */
28655 upper
= r1
, lower
= r2
;
28657 upper
= r2
, lower
= r1
;
28659 /* The upper end of the intersection is lower.y0, if this is inside
28660 of upper. Otherwise, there is no intersection. */
28661 if (lower
->y
<= upper
->y
+ upper
->height
)
28663 result
->y
= lower
->y
;
28665 /* The lower end of the intersection is the minimum of the lower
28666 ends of upper and lower. */
28667 result
->height
= (min (lower
->y
+ lower
->height
,
28668 upper
->y
+ upper
->height
)
28670 intersection_p
= 1;
28674 return intersection_p
;
28677 #endif /* HAVE_WINDOW_SYSTEM */
28680 /***********************************************************************
28682 ***********************************************************************/
28685 syms_of_xdisp (void)
28687 Vwith_echo_area_save_vector
= Qnil
;
28688 staticpro (&Vwith_echo_area_save_vector
);
28690 Vmessage_stack
= Qnil
;
28691 staticpro (&Vmessage_stack
);
28693 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28695 message_dolog_marker1
= Fmake_marker ();
28696 staticpro (&message_dolog_marker1
);
28697 message_dolog_marker2
= Fmake_marker ();
28698 staticpro (&message_dolog_marker2
);
28699 message_dolog_marker3
= Fmake_marker ();
28700 staticpro (&message_dolog_marker3
);
28703 defsubr (&Sdump_frame_glyph_matrix
);
28704 defsubr (&Sdump_glyph_matrix
);
28705 defsubr (&Sdump_glyph_row
);
28706 defsubr (&Sdump_tool_bar_row
);
28707 defsubr (&Strace_redisplay
);
28708 defsubr (&Strace_to_stderr
);
28710 #ifdef HAVE_WINDOW_SYSTEM
28711 defsubr (&Stool_bar_lines_needed
);
28712 defsubr (&Slookup_image_map
);
28714 defsubr (&Sformat_mode_line
);
28715 defsubr (&Sinvisible_p
);
28716 defsubr (&Scurrent_bidi_paragraph_direction
);
28718 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28719 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28720 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28721 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28722 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28723 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28724 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28725 DEFSYM (Qeval
, "eval");
28726 DEFSYM (QCdata
, ":data");
28727 DEFSYM (Qdisplay
, "display");
28728 DEFSYM (Qspace_width
, "space-width");
28729 DEFSYM (Qraise
, "raise");
28730 DEFSYM (Qslice
, "slice");
28731 DEFSYM (Qspace
, "space");
28732 DEFSYM (Qmargin
, "margin");
28733 DEFSYM (Qpointer
, "pointer");
28734 DEFSYM (Qleft_margin
, "left-margin");
28735 DEFSYM (Qright_margin
, "right-margin");
28736 DEFSYM (Qcenter
, "center");
28737 DEFSYM (Qline_height
, "line-height");
28738 DEFSYM (QCalign_to
, ":align-to");
28739 DEFSYM (QCrelative_width
, ":relative-width");
28740 DEFSYM (QCrelative_height
, ":relative-height");
28741 DEFSYM (QCeval
, ":eval");
28742 DEFSYM (QCpropertize
, ":propertize");
28743 DEFSYM (QCfile
, ":file");
28744 DEFSYM (Qfontified
, "fontified");
28745 DEFSYM (Qfontification_functions
, "fontification-functions");
28746 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28747 DEFSYM (Qescape_glyph
, "escape-glyph");
28748 DEFSYM (Qnobreak_space
, "nobreak-space");
28749 DEFSYM (Qimage
, "image");
28750 DEFSYM (Qtext
, "text");
28751 DEFSYM (Qboth
, "both");
28752 DEFSYM (Qboth_horiz
, "both-horiz");
28753 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28754 DEFSYM (QCmap
, ":map");
28755 DEFSYM (QCpointer
, ":pointer");
28756 DEFSYM (Qrect
, "rect");
28757 DEFSYM (Qcircle
, "circle");
28758 DEFSYM (Qpoly
, "poly");
28759 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28760 DEFSYM (Qgrow_only
, "grow-only");
28761 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28762 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28763 DEFSYM (Qposition
, "position");
28764 DEFSYM (Qbuffer_position
, "buffer-position");
28765 DEFSYM (Qobject
, "object");
28766 DEFSYM (Qbar
, "bar");
28767 DEFSYM (Qhbar
, "hbar");
28768 DEFSYM (Qbox
, "box");
28769 DEFSYM (Qhollow
, "hollow");
28770 DEFSYM (Qhand
, "hand");
28771 DEFSYM (Qarrow
, "arrow");
28772 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28774 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28775 Fcons (intern_c_string ("void-variable"), Qnil
)),
28777 staticpro (&list_of_error
);
28779 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28780 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28781 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28782 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28784 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28785 staticpro (&echo_buffer
[0]);
28786 staticpro (&echo_buffer
[1]);
28788 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28789 staticpro (&echo_area_buffer
[0]);
28790 staticpro (&echo_area_buffer
[1]);
28792 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
28793 staticpro (&Vmessages_buffer_name
);
28795 mode_line_proptrans_alist
= Qnil
;
28796 staticpro (&mode_line_proptrans_alist
);
28797 mode_line_string_list
= Qnil
;
28798 staticpro (&mode_line_string_list
);
28799 mode_line_string_face
= Qnil
;
28800 staticpro (&mode_line_string_face
);
28801 mode_line_string_face_prop
= Qnil
;
28802 staticpro (&mode_line_string_face_prop
);
28803 Vmode_line_unwind_vector
= Qnil
;
28804 staticpro (&Vmode_line_unwind_vector
);
28806 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
28808 help_echo_string
= Qnil
;
28809 staticpro (&help_echo_string
);
28810 help_echo_object
= Qnil
;
28811 staticpro (&help_echo_object
);
28812 help_echo_window
= Qnil
;
28813 staticpro (&help_echo_window
);
28814 previous_help_echo_string
= Qnil
;
28815 staticpro (&previous_help_echo_string
);
28816 help_echo_pos
= -1;
28818 DEFSYM (Qright_to_left
, "right-to-left");
28819 DEFSYM (Qleft_to_right
, "left-to-right");
28821 #ifdef HAVE_WINDOW_SYSTEM
28822 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28823 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
28824 For example, if a block cursor is over a tab, it will be drawn as
28825 wide as that tab on the display. */);
28826 x_stretch_cursor_p
= 0;
28829 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28830 doc
: /* Non-nil means highlight trailing whitespace.
28831 The face used for trailing whitespace is `trailing-whitespace'. */);
28832 Vshow_trailing_whitespace
= Qnil
;
28834 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28835 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28836 If the value is t, Emacs highlights non-ASCII chars which have the
28837 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28838 or `escape-glyph' face respectively.
28840 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28841 U+2011 (non-breaking hyphen) are affected.
28843 Any other non-nil value means to display these characters as a escape
28844 glyph followed by an ordinary space or hyphen.
28846 A value of nil means no special handling of these characters. */);
28847 Vnobreak_char_display
= Qt
;
28849 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28850 doc
: /* The pointer shape to show in void text areas.
28851 A value of nil means to show the text pointer. Other options are `arrow',
28852 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28853 Vvoid_text_area_pointer
= Qarrow
;
28855 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28856 doc
: /* Non-nil means don't actually do any redisplay.
28857 This is used for internal purposes. */);
28858 Vinhibit_redisplay
= Qnil
;
28860 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28861 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28862 Vglobal_mode_string
= Qnil
;
28864 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28865 doc
: /* Marker for where to display an arrow on top of the buffer text.
28866 This must be the beginning of a line in order to work.
28867 See also `overlay-arrow-string'. */);
28868 Voverlay_arrow_position
= Qnil
;
28870 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28871 doc
: /* String to display as an arrow in non-window frames.
28872 See also `overlay-arrow-position'. */);
28873 Voverlay_arrow_string
= build_pure_c_string ("=>");
28875 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28876 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28877 The symbols on this list are examined during redisplay to determine
28878 where to display overlay arrows. */);
28879 Voverlay_arrow_variable_list
28880 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28882 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28883 doc
: /* The number of lines to try scrolling a window by when point moves out.
28884 If that fails to bring point back on frame, point is centered instead.
28885 If this is zero, point is always centered after it moves off frame.
28886 If you want scrolling to always be a line at a time, you should set
28887 `scroll-conservatively' to a large value rather than set this to 1. */);
28889 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28890 doc
: /* Scroll up to this many lines, to bring point back on screen.
28891 If point moves off-screen, redisplay will scroll by up to
28892 `scroll-conservatively' lines in order to bring point just barely
28893 onto the screen again. If that cannot be done, then redisplay
28894 recenters point as usual.
28896 If the value is greater than 100, redisplay will never recenter point,
28897 but will always scroll just enough text to bring point into view, even
28898 if you move far away.
28900 A value of zero means always recenter point if it moves off screen. */);
28901 scroll_conservatively
= 0;
28903 DEFVAR_INT ("scroll-margin", scroll_margin
,
28904 doc
: /* Number of lines of margin at the top and bottom of a window.
28905 Recenter the window whenever point gets within this many lines
28906 of the top or bottom of the window. */);
28909 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28910 doc
: /* Pixels per inch value for non-window system displays.
28911 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28912 Vdisplay_pixels_per_inch
= make_float (72.0);
28915 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28918 DEFVAR_LISP ("truncate-partial-width-windows",
28919 Vtruncate_partial_width_windows
,
28920 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28921 For an integer value, truncate lines in each window narrower than the
28922 full frame width, provided the window width is less than that integer;
28923 otherwise, respect the value of `truncate-lines'.
28925 For any other non-nil value, truncate lines in all windows that do
28926 not span the full frame width.
28928 A value of nil means to respect the value of `truncate-lines'.
28930 If `word-wrap' is enabled, you might want to reduce this. */);
28931 Vtruncate_partial_width_windows
= make_number (50);
28933 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28934 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28935 Any other value means to use the appropriate face, `mode-line',
28936 `header-line', or `menu' respectively. */);
28937 mode_line_inverse_video
= 1;
28939 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28940 doc
: /* Maximum buffer size for which line number should be displayed.
28941 If the buffer is bigger than this, the line number does not appear
28942 in the mode line. A value of nil means no limit. */);
28943 Vline_number_display_limit
= Qnil
;
28945 DEFVAR_INT ("line-number-display-limit-width",
28946 line_number_display_limit_width
,
28947 doc
: /* Maximum line width (in characters) for line number display.
28948 If the average length of the lines near point is bigger than this, then the
28949 line number may be omitted from the mode line. */);
28950 line_number_display_limit_width
= 200;
28952 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28953 doc
: /* Non-nil means highlight region even in nonselected windows. */);
28954 highlight_nonselected_windows
= 0;
28956 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28957 doc
: /* Non-nil if more than one frame is visible on this display.
28958 Minibuffer-only frames don't count, but iconified frames do.
28959 This variable is not guaranteed to be accurate except while processing
28960 `frame-title-format' and `icon-title-format'. */);
28962 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28963 doc
: /* Template for displaying the title bar of visible frames.
28964 \(Assuming the window manager supports this feature.)
28966 This variable has the same structure as `mode-line-format', except that
28967 the %c and %l constructs are ignored. It is used only on frames for
28968 which no explicit name has been set \(see `modify-frame-parameters'). */);
28970 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28971 doc
: /* Template for displaying the title bar of an iconified frame.
28972 \(Assuming the window manager supports this feature.)
28973 This variable has the same structure as `mode-line-format' (which see),
28974 and is used only on frames for which no explicit name has been set
28975 \(see `modify-frame-parameters'). */);
28977 = Vframe_title_format
28978 = listn (CONSTYPE_PURE
, 3,
28979 intern_c_string ("multiple-frames"),
28980 build_pure_c_string ("%b"),
28981 listn (CONSTYPE_PURE
, 4,
28982 empty_unibyte_string
,
28983 intern_c_string ("invocation-name"),
28984 build_pure_c_string ("@"),
28985 intern_c_string ("system-name")));
28987 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28988 doc
: /* Maximum number of lines to keep in the message log buffer.
28989 If nil, disable message logging. If t, log messages but don't truncate
28990 the buffer when it becomes large. */);
28991 Vmessage_log_max
= make_number (100);
28993 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28994 doc
: /* Functions called before redisplay, if window sizes have changed.
28995 The value should be a list of functions that take one argument.
28996 Just before redisplay, for each frame, if any of its windows have changed
28997 size since the last redisplay, or have been split or deleted,
28998 all the functions in the list are called, with the frame as argument. */);
28999 Vwindow_size_change_functions
= Qnil
;
29001 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
29002 doc
: /* List of functions to call before redisplaying a window with scrolling.
29003 Each function is called with two arguments, the window and its new
29004 display-start position. Note that these functions are also called by
29005 `set-window-buffer'. Also note that the value of `window-end' is not
29006 valid when these functions are called.
29008 Warning: Do not use this feature to alter the way the window
29009 is scrolled. It is not designed for that, and such use probably won't
29011 Vwindow_scroll_functions
= Qnil
;
29013 DEFVAR_LISP ("window-text-change-functions",
29014 Vwindow_text_change_functions
,
29015 doc
: /* Functions to call in redisplay when text in the window might change. */);
29016 Vwindow_text_change_functions
= Qnil
;
29018 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
29019 doc
: /* Functions called when redisplay of a window reaches the end trigger.
29020 Each function is called with two arguments, the window and the end trigger value.
29021 See `set-window-redisplay-end-trigger'. */);
29022 Vredisplay_end_trigger_functions
= Qnil
;
29024 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
29025 doc
: /* Non-nil means autoselect window with mouse pointer.
29026 If nil, do not autoselect windows.
29027 A positive number means delay autoselection by that many seconds: a
29028 window is autoselected only after the mouse has remained in that
29029 window for the duration of the delay.
29030 A negative number has a similar effect, but causes windows to be
29031 autoselected only after the mouse has stopped moving. \(Because of
29032 the way Emacs compares mouse events, you will occasionally wait twice
29033 that time before the window gets selected.\)
29034 Any other value means to autoselect window instantaneously when the
29035 mouse pointer enters it.
29037 Autoselection selects the minibuffer only if it is active, and never
29038 unselects the minibuffer if it is active.
29040 When customizing this variable make sure that the actual value of
29041 `focus-follows-mouse' matches the behavior of your window manager. */);
29042 Vmouse_autoselect_window
= Qnil
;
29044 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
29045 doc
: /* Non-nil means automatically resize tool-bars.
29046 This dynamically changes the tool-bar's height to the minimum height
29047 that is needed to make all tool-bar items visible.
29048 If value is `grow-only', the tool-bar's height is only increased
29049 automatically; to decrease the tool-bar height, use \\[recenter]. */);
29050 Vauto_resize_tool_bars
= Qt
;
29052 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
29053 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
29054 auto_raise_tool_bar_buttons_p
= 1;
29056 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
29057 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
29058 make_cursor_line_fully_visible_p
= 1;
29060 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
29061 doc
: /* Border below tool-bar in pixels.
29062 If an integer, use it as the height of the border.
29063 If it is one of `internal-border-width' or `border-width', use the
29064 value of the corresponding frame parameter.
29065 Otherwise, no border is added below the tool-bar. */);
29066 Vtool_bar_border
= Qinternal_border_width
;
29068 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
29069 doc
: /* Margin around tool-bar buttons in pixels.
29070 If an integer, use that for both horizontal and vertical margins.
29071 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
29072 HORZ specifying the horizontal margin, and VERT specifying the
29073 vertical margin. */);
29074 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
29076 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
29077 doc
: /* Relief thickness of tool-bar buttons. */);
29078 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
29080 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
29081 doc
: /* Tool bar style to use.
29083 image - show images only
29084 text - show text only
29085 both - show both, text below image
29086 both-horiz - show text to the right of the image
29087 text-image-horiz - show text to the left of the image
29088 any other - use system default or image if no system default.
29090 This variable only affects the GTK+ toolkit version of Emacs. */);
29091 Vtool_bar_style
= Qnil
;
29093 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
29094 doc
: /* Maximum number of characters a label can have to be shown.
29095 The tool bar style must also show labels for this to have any effect, see
29096 `tool-bar-style'. */);
29097 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
29099 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
29100 doc
: /* List of functions to call to fontify regions of text.
29101 Each function is called with one argument POS. Functions must
29102 fontify a region starting at POS in the current buffer, and give
29103 fontified regions the property `fontified'. */);
29104 Vfontification_functions
= Qnil
;
29105 Fmake_variable_buffer_local (Qfontification_functions
);
29107 DEFVAR_BOOL ("unibyte-display-via-language-environment",
29108 unibyte_display_via_language_environment
,
29109 doc
: /* Non-nil means display unibyte text according to language environment.
29110 Specifically, this means that raw bytes in the range 160-255 decimal
29111 are displayed by converting them to the equivalent multibyte characters
29112 according to the current language environment. As a result, they are
29113 displayed according to the current fontset.
29115 Note that this variable affects only how these bytes are displayed,
29116 but does not change the fact they are interpreted as raw bytes. */);
29117 unibyte_display_via_language_environment
= 0;
29119 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
29120 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29121 If a float, it specifies a fraction of the mini-window frame's height.
29122 If an integer, it specifies a number of lines. */);
29123 Vmax_mini_window_height
= make_float (0.25);
29125 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
29126 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
29127 A value of nil means don't automatically resize mini-windows.
29128 A value of t means resize them to fit the text displayed in them.
29129 A value of `grow-only', the default, means let mini-windows grow only;
29130 they return to their normal size when the minibuffer is closed, or the
29131 echo area becomes empty. */);
29132 Vresize_mini_windows
= Qgrow_only
;
29134 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
29135 doc
: /* Alist specifying how to blink the cursor off.
29136 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29137 `cursor-type' frame-parameter or variable equals ON-STATE,
29138 comparing using `equal', Emacs uses OFF-STATE to specify
29139 how to blink it off. ON-STATE and OFF-STATE are values for
29140 the `cursor-type' frame parameter.
29142 If a frame's ON-STATE has no entry in this list,
29143 the frame's other specifications determine how to blink the cursor off. */);
29144 Vblink_cursor_alist
= Qnil
;
29146 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
29147 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
29148 If non-nil, windows are automatically scrolled horizontally to make
29149 point visible. */);
29150 automatic_hscrolling_p
= 1;
29151 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
29153 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
29154 doc
: /* How many columns away from the window edge point is allowed to get
29155 before automatic hscrolling will horizontally scroll the window. */);
29156 hscroll_margin
= 5;
29158 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
29159 doc
: /* How many columns to scroll the window when point gets too close to the edge.
29160 When point is less than `hscroll-margin' columns from the window
29161 edge, automatic hscrolling will scroll the window by the amount of columns
29162 determined by this variable. If its value is a positive integer, scroll that
29163 many columns. If it's a positive floating-point number, it specifies the
29164 fraction of the window's width to scroll. If it's nil or zero, point will be
29165 centered horizontally after the scroll. Any other value, including negative
29166 numbers, are treated as if the value were zero.
29168 Automatic hscrolling always moves point outside the scroll margin, so if
29169 point was more than scroll step columns inside the margin, the window will
29170 scroll more than the value given by the scroll step.
29172 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29173 and `scroll-right' overrides this variable's effect. */);
29174 Vhscroll_step
= make_number (0);
29176 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
29177 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
29178 Bind this around calls to `message' to let it take effect. */);
29179 message_truncate_lines
= 0;
29181 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
29182 doc
: /* Normal hook run to update the menu bar definitions.
29183 Redisplay runs this hook before it redisplays the menu bar.
29184 This is used to update submenus such as Buffers,
29185 whose contents depend on various data. */);
29186 Vmenu_bar_update_hook
= Qnil
;
29188 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
29189 doc
: /* Frame for which we are updating a menu.
29190 The enable predicate for a menu binding should check this variable. */);
29191 Vmenu_updating_frame
= Qnil
;
29193 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
29194 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
29195 inhibit_menubar_update
= 0;
29197 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
29198 doc
: /* Prefix prepended to all continuation lines at display time.
29199 The value may be a string, an image, or a stretch-glyph; it is
29200 interpreted in the same way as the value of a `display' text property.
29202 This variable is overridden by any `wrap-prefix' text or overlay
29205 To add a prefix to non-continuation lines, use `line-prefix'. */);
29206 Vwrap_prefix
= Qnil
;
29207 DEFSYM (Qwrap_prefix
, "wrap-prefix");
29208 Fmake_variable_buffer_local (Qwrap_prefix
);
29210 DEFVAR_LISP ("line-prefix", Vline_prefix
,
29211 doc
: /* Prefix prepended to all non-continuation lines at display time.
29212 The value may be a string, an image, or a stretch-glyph; it is
29213 interpreted in the same way as the value of a `display' text property.
29215 This variable is overridden by any `line-prefix' text or overlay
29218 To add a prefix to continuation lines, use `wrap-prefix'. */);
29219 Vline_prefix
= Qnil
;
29220 DEFSYM (Qline_prefix
, "line-prefix");
29221 Fmake_variable_buffer_local (Qline_prefix
);
29223 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
29224 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
29225 inhibit_eval_during_redisplay
= 0;
29227 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
29228 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
29229 inhibit_free_realized_faces
= 0;
29232 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
29233 doc
: /* Inhibit try_window_id display optimization. */);
29234 inhibit_try_window_id
= 0;
29236 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
29237 doc
: /* Inhibit try_window_reusing display optimization. */);
29238 inhibit_try_window_reusing
= 0;
29240 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
29241 doc
: /* Inhibit try_cursor_movement display optimization. */);
29242 inhibit_try_cursor_movement
= 0;
29243 #endif /* GLYPH_DEBUG */
29245 DEFVAR_INT ("overline-margin", overline_margin
,
29246 doc
: /* Space between overline and text, in pixels.
29247 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29248 margin to the character height. */);
29249 overline_margin
= 2;
29251 DEFVAR_INT ("underline-minimum-offset",
29252 underline_minimum_offset
,
29253 doc
: /* Minimum distance between baseline and underline.
29254 This can improve legibility of underlined text at small font sizes,
29255 particularly when using variable `x-use-underline-position-properties'
29256 with fonts that specify an UNDERLINE_POSITION relatively close to the
29257 baseline. The default value is 1. */);
29258 underline_minimum_offset
= 1;
29260 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
29261 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29262 This feature only works when on a window system that can change
29263 cursor shapes. */);
29264 display_hourglass_p
= 1;
29266 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
29267 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29268 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
29270 hourglass_atimer
= NULL
;
29271 hourglass_shown_p
= 0;
29273 DEFSYM (Qglyphless_char
, "glyphless-char");
29274 DEFSYM (Qhex_code
, "hex-code");
29275 DEFSYM (Qempty_box
, "empty-box");
29276 DEFSYM (Qthin_space
, "thin-space");
29277 DEFSYM (Qzero_width
, "zero-width");
29279 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
29280 /* Intern this now in case it isn't already done.
29281 Setting this variable twice is harmless.
29282 But don't staticpro it here--that is done in alloc.c. */
29283 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
29284 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
29286 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
29287 doc
: /* Char-table defining glyphless characters.
29288 Each element, if non-nil, should be one of the following:
29289 an ASCII acronym string: display this string in a box
29290 `hex-code': display the hexadecimal code of a character in a box
29291 `empty-box': display as an empty box
29292 `thin-space': display as 1-pixel width space
29293 `zero-width': don't display
29294 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29295 display method for graphical terminals and text terminals respectively.
29296 GRAPHICAL and TEXT should each have one of the values listed above.
29298 The char-table has one extra slot to control the display of a character for
29299 which no font is found. This slot only takes effect on graphical terminals.
29300 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29301 `thin-space'. The default is `empty-box'. */);
29302 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29303 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29306 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
29307 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
29308 Vdebug_on_message
= Qnil
;
29312 /* Initialize this module when Emacs starts. */
29317 current_header_line_height
= current_mode_line_height
= -1;
29319 CHARPOS (this_line_start_pos
) = 0;
29321 if (!noninteractive
)
29323 struct window
*m
= XWINDOW (minibuf_window
);
29324 Lisp_Object frame
= m
->frame
;
29325 struct frame
*f
= XFRAME (frame
);
29326 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29327 struct window
*r
= XWINDOW (root
);
29330 echo_area_window
= minibuf_window
;
29332 wset_top_line (r
, make_number (FRAME_TOP_MARGIN (f
)));
29334 (r
, make_number (FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
)));
29335 wset_total_cols (r
, make_number (FRAME_COLS (f
)));
29336 wset_top_line (m
, make_number (FRAME_LINES (f
) - 1));
29337 wset_total_lines (m
, make_number (1));
29338 wset_total_cols (m
, make_number (FRAME_COLS (f
)));
29340 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29341 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29342 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29344 /* The default ellipsis glyphs `...'. */
29345 for (i
= 0; i
< 3; ++i
)
29346 default_invis_vector
[i
] = make_number ('.');
29350 /* Allocate the buffer for frame titles.
29351 Also used for `format-mode-line'. */
29353 mode_line_noprop_buf
= xmalloc (size
);
29354 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29355 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29356 mode_line_target
= MODE_LINE_DISPLAY
;
29359 help_echo_showing_p
= 0;
29362 /* Since w32 does not support atimers, it defines its own implementation of
29363 the following three functions in w32fns.c. */
29366 /* Platform-independent portion of hourglass implementation. */
29368 /* Cancel a currently active hourglass timer, and start a new one. */
29370 start_hourglass (void)
29372 #if defined (HAVE_WINDOW_SYSTEM)
29375 cancel_hourglass ();
29377 if (INTEGERP (Vhourglass_delay
)
29378 && XINT (Vhourglass_delay
) > 0)
29379 delay
= make_emacs_time (min (XINT (Vhourglass_delay
),
29380 TYPE_MAXIMUM (time_t)),
29382 else if (FLOATP (Vhourglass_delay
)
29383 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29384 delay
= EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (Vhourglass_delay
));
29386 delay
= make_emacs_time (DEFAULT_HOURGLASS_DELAY
, 0);
29388 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29389 show_hourglass
, NULL
);
29394 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29397 cancel_hourglass (void)
29399 #if defined (HAVE_WINDOW_SYSTEM)
29400 if (hourglass_atimer
)
29402 cancel_atimer (hourglass_atimer
);
29403 hourglass_atimer
= NULL
;
29406 if (hourglass_shown_p
)
29410 #endif /* ! WINDOWSNT */