1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 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 Calls to get_next_display_element fill the iterator structure with
134 relevant information about the next thing to display. Calls to
135 set_iterator_to_next move the iterator to the next thing.
137 Besides this, an iterator also contains information about the
138 display environment in which glyphs for display elements are to be
139 produced. It has fields for the width and height of the display,
140 the information whether long lines are truncated or continued, a
141 current X and Y position, and lots of other stuff you can better
144 Glyphs in a desired matrix are normally constructed in a loop
145 calling get_next_display_element and then PRODUCE_GLYPHS. The call
146 to PRODUCE_GLYPHS will fill the iterator structure with pixel
147 information about the element being displayed and at the same time
148 produce glyphs for it. If the display element fits on the line
149 being displayed, set_iterator_to_next is called next, otherwise the
150 glyphs produced are discarded. The function display_line is the
151 workhorse of filling glyph rows in the desired matrix with glyphs.
152 In addition to producing glyphs, it also handles line truncation
153 and continuation, word wrap, and cursor positioning (for the
154 latter, see also set_cursor_from_row).
158 That just couldn't be all, could it? What about terminal types not
159 supporting operations on sub-windows of the screen? To update the
160 display on such a terminal, window-based glyph matrices are not
161 well suited. To be able to reuse part of the display (scrolling
162 lines up and down), we must instead have a view of the whole
163 screen. This is what `frame matrices' are for. They are a trick.
165 Frames on terminals like above have a glyph pool. Windows on such
166 a frame sub-allocate their glyph memory from their frame's glyph
167 pool. The frame itself is given its own glyph matrices. By
168 coincidence---or maybe something else---rows in window glyph
169 matrices are slices of corresponding rows in frame matrices. Thus
170 writing to window matrices implicitly updates a frame matrix which
171 provides us with the view of the whole screen that we originally
172 wanted to have without having to move many bytes around. To be
173 honest, there is a little bit more done, but not much more. If you
174 plan to extend that code, take a look at dispnew.c. The function
175 build_frame_matrix is a good starting point.
177 Bidirectional display.
179 Bidirectional display adds quite some hair to this already complex
180 design. The good news are that a large portion of that hairy stuff
181 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
182 reordering engine which is called by set_iterator_to_next and
183 returns the next character to display in the visual order. See
184 commentary on bidi.c for more details. As far as redisplay is
185 concerned, the effect of calling bidi_move_to_visually_next, the
186 main interface of the reordering engine, is that the iterator gets
187 magically placed on the buffer or string position that is to be
188 displayed next. In other words, a linear iteration through the
189 buffer/string is replaced with a non-linear one. All the rest of
190 the redisplay is oblivious to the bidi reordering.
192 Well, almost oblivious---there are still complications, most of
193 them due to the fact that buffer and string positions no longer
194 change monotonously with glyph indices in a glyph row. Moreover,
195 for continued lines, the buffer positions may not even be
196 monotonously changing with vertical positions. Also, accounting
197 for face changes, overlays, etc. becomes more complex because
198 non-linear iteration could potentially skip many positions with
199 changes, and then cross them again on the way back...
201 One other prominent effect of bidirectional display is that some
202 paragraphs of text need to be displayed starting at the right
203 margin of the window---the so-called right-to-left, or R2L
204 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
205 which have their reversed_p flag set. The bidi reordering engine
206 produces characters in such rows starting from the character which
207 should be the rightmost on display. PRODUCE_GLYPHS then reverses
208 the order, when it fills up the glyph row whose reversed_p flag is
209 set, by prepending each new glyph to what is already there, instead
210 of appending it. When the glyph row is complete, the function
211 extend_face_to_end_of_line fills the empty space to the left of the
212 leftmost character with special glyphs, which will display as,
213 well, empty. On text terminals, these special glyphs are simply
214 blank characters. On graphics terminals, there's a single stretch
215 glyph of a suitably computed width. Both the blanks and the
216 stretch glyph are given the face of the background of the line.
217 This way, the terminal-specific back-end can still draw the glyphs
218 left to right, even for R2L lines.
220 Bidirectional display and character compositions
222 Some scripts cannot be displayed by drawing each character
223 individually, because adjacent characters change each other's shape
224 on display. For example, Arabic and Indic scripts belong to this
227 Emacs display supports this by providing "character compositions",
228 most of which is implemented in composite.c. During the buffer
229 scan that delivers characters to PRODUCE_GLYPHS, if the next
230 character to be delivered is a composed character, the iteration
231 calls composition_reseat_it and next_element_from_composition. If
232 they succeed to compose the character with one or more of the
233 following characters, the whole sequence of characters that where
234 composed is recorded in the `struct composition_it' object that is
235 part of the buffer iterator. The composed sequence could produce
236 one or more font glyphs (called "grapheme clusters") on the screen.
237 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
238 in the direction corresponding to the current bidi scan direction
239 (recorded in the scan_dir member of the `struct bidi_it' object
240 that is part of the buffer iterator). In particular, if the bidi
241 iterator currently scans the buffer backwards, the grapheme
242 clusters are delivered back to front. This reorders the grapheme
243 clusters as appropriate for the current bidi context. Note that
244 this means that the grapheme clusters are always stored in the
245 LGSTRING object (see composite.c) in the logical order.
247 Moving an iterator in bidirectional text
248 without producing glyphs
250 Note one important detail mentioned above: that the bidi reordering
251 engine, driven by the iterator, produces characters in R2L rows
252 starting at the character that will be the rightmost on display.
253 As far as the iterator is concerned, the geometry of such rows is
254 still left to right, i.e. the iterator "thinks" the first character
255 is at the leftmost pixel position. The iterator does not know that
256 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
257 delivers. This is important when functions from the the move_it_*
258 family are used to get to certain screen position or to match
259 screen coordinates with buffer coordinates: these functions use the
260 iterator geometry, which is left to right even in R2L paragraphs.
261 This works well with most callers of move_it_*, because they need
262 to get to a specific column, and columns are still numbered in the
263 reading order, i.e. the rightmost character in a R2L paragraph is
264 still column zero. But some callers do not get well with this; a
265 notable example is mouse clicks that need to find the character
266 that corresponds to certain pixel coordinates. See
267 buffer_posn_from_coords in dispnew.c for how this is handled. */
275 #include "keyboard.h"
278 #include "termchar.h"
279 #include "dispextern.h"
281 #include "character.h"
284 #include "commands.h"
288 #include "termhooks.h"
289 #include "termopts.h"
290 #include "intervals.h"
293 #include "region-cache.h"
296 #include "blockinput.h"
298 #ifdef HAVE_X_WINDOWS
313 #ifndef FRAME_X_OUTPUT
314 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
317 #define INFINITY 10000000
319 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
320 Lisp_Object Qwindow_scroll_functions
;
321 Lisp_Object Qwindow_text_change_functions
;
322 Lisp_Object Qredisplay_end_trigger_functions
;
323 Lisp_Object Qinhibit_point_motion_hooks
;
324 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
325 Lisp_Object Qfontified
;
326 Lisp_Object Qgrow_only
;
327 Lisp_Object Qinhibit_eval_during_redisplay
;
328 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
329 Lisp_Object Qright_to_left
, Qleft_to_right
;
332 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
335 Lisp_Object Qarrow
, Qhand
, Qtext
;
337 /* Holds the list (error). */
338 Lisp_Object list_of_error
;
340 Lisp_Object Qfontification_functions
;
342 Lisp_Object Qwrap_prefix
;
343 Lisp_Object Qline_prefix
;
345 /* Non-nil means don't actually do any redisplay. */
347 Lisp_Object Qinhibit_redisplay
;
349 /* Names of text properties relevant for redisplay. */
351 Lisp_Object Qdisplay
;
353 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
354 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
357 Lisp_Object Qmargin
, Qpointer
;
358 Lisp_Object Qline_height
;
360 #ifdef HAVE_WINDOW_SYSTEM
362 /* Test if overflow newline into fringe. Called with iterator IT
363 at or past right window margin, and with IT->current_x set. */
365 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
366 (!NILP (Voverflow_newline_into_fringe) \
367 && FRAME_WINDOW_P ((IT)->f) \
368 && ((IT)->bidi_it.paragraph_dir == R2L \
369 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
370 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
371 && (IT)->current_x == (IT)->last_visible_x \
372 && (IT)->line_wrap != WORD_WRAP)
374 #else /* !HAVE_WINDOW_SYSTEM */
375 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
376 #endif /* HAVE_WINDOW_SYSTEM */
378 /* Test if the display element loaded in IT is a space or tab
379 character. This is used to determine word wrapping. */
381 #define IT_DISPLAYING_WHITESPACE(it) \
382 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
384 /* Name of the face used to highlight trailing whitespace. */
386 Lisp_Object Qtrailing_whitespace
;
388 /* Name and number of the face used to highlight escape glyphs. */
390 Lisp_Object Qescape_glyph
;
392 /* Name and number of the face used to highlight non-breaking spaces. */
394 Lisp_Object Qnobreak_space
;
396 /* The symbol `image' which is the car of the lists used to represent
397 images in Lisp. Also a tool bar style. */
401 /* The image map types. */
402 Lisp_Object QCmap
, QCpointer
;
403 Lisp_Object Qrect
, Qcircle
, Qpoly
;
405 /* Tool bar styles */
406 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
408 /* Non-zero means print newline to stdout before next mini-buffer
411 int noninteractive_need_newline
;
413 /* Non-zero means print newline to message log before next message. */
415 static int message_log_need_newline
;
417 /* Three markers that message_dolog uses.
418 It could allocate them itself, but that causes trouble
419 in handling memory-full errors. */
420 static Lisp_Object message_dolog_marker1
;
421 static Lisp_Object message_dolog_marker2
;
422 static Lisp_Object message_dolog_marker3
;
424 /* The buffer position of the first character appearing entirely or
425 partially on the line of the selected window which contains the
426 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
427 redisplay optimization in redisplay_internal. */
429 static struct text_pos this_line_start_pos
;
431 /* Number of characters past the end of the line above, including the
432 terminating newline. */
434 static struct text_pos this_line_end_pos
;
436 /* The vertical positions and the height of this line. */
438 static int this_line_vpos
;
439 static int this_line_y
;
440 static int this_line_pixel_height
;
442 /* X position at which this display line starts. Usually zero;
443 negative if first character is partially visible. */
445 static int this_line_start_x
;
447 /* The smallest character position seen by move_it_* functions as they
448 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
449 hscrolled lines, see display_line. */
451 static struct text_pos this_line_min_pos
;
453 /* Buffer that this_line_.* variables are referring to. */
455 static struct buffer
*this_line_buffer
;
458 /* Values of those variables at last redisplay are stored as
459 properties on `overlay-arrow-position' symbol. However, if
460 Voverlay_arrow_position is a marker, last-arrow-position is its
461 numerical position. */
463 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
465 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
466 properties on a symbol in overlay-arrow-variable-list. */
468 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
470 Lisp_Object Qmenu_bar_update_hook
;
472 /* Nonzero if an overlay arrow has been displayed in this window. */
474 static int overlay_arrow_seen
;
476 /* Number of windows showing the buffer of the selected window (or
477 another buffer with the same base buffer). keyboard.c refers to
482 /* Vector containing glyphs for an ellipsis `...'. */
484 static Lisp_Object default_invis_vector
[3];
486 /* This is the window where the echo area message was displayed. It
487 is always a mini-buffer window, but it may not be the same window
488 currently active as a mini-buffer. */
490 Lisp_Object echo_area_window
;
492 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
493 pushes the current message and the value of
494 message_enable_multibyte on the stack, the function restore_message
495 pops the stack and displays MESSAGE again. */
497 Lisp_Object Vmessage_stack
;
499 /* Nonzero means multibyte characters were enabled when the echo area
500 message was specified. */
502 int message_enable_multibyte
;
504 /* Nonzero if we should redraw the mode lines on the next redisplay. */
506 int update_mode_lines
;
508 /* Nonzero if window sizes or contents have changed since last
509 redisplay that finished. */
511 int windows_or_buffers_changed
;
513 /* Nonzero means a frame's cursor type has been changed. */
515 int cursor_type_changed
;
517 /* Nonzero after display_mode_line if %l was used and it displayed a
520 int line_number_displayed
;
522 /* The name of the *Messages* buffer, a string. */
524 static Lisp_Object Vmessages_buffer_name
;
526 /* Current, index 0, and last displayed echo area message. Either
527 buffers from echo_buffers, or nil to indicate no message. */
529 Lisp_Object echo_area_buffer
[2];
531 /* The buffers referenced from echo_area_buffer. */
533 static Lisp_Object echo_buffer
[2];
535 /* A vector saved used in with_area_buffer to reduce consing. */
537 static Lisp_Object Vwith_echo_area_save_vector
;
539 /* Non-zero means display_echo_area should display the last echo area
540 message again. Set by redisplay_preserve_echo_area. */
542 static int display_last_displayed_message_p
;
544 /* Nonzero if echo area is being used by print; zero if being used by
547 int message_buf_print
;
549 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
551 Lisp_Object Qinhibit_menubar_update
;
552 Lisp_Object Qmessage_truncate_lines
;
554 /* Set to 1 in clear_message to make redisplay_internal aware
555 of an emptied echo area. */
557 static int message_cleared_p
;
559 /* A scratch glyph row with contents used for generating truncation
560 glyphs. Also used in direct_output_for_insert. */
562 #define MAX_SCRATCH_GLYPHS 100
563 struct glyph_row scratch_glyph_row
;
564 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
566 /* Ascent and height of the last line processed by move_it_to. */
568 static int last_max_ascent
, last_height
;
570 /* Non-zero if there's a help-echo in the echo area. */
572 int help_echo_showing_p
;
574 /* If >= 0, computed, exact values of mode-line and header-line height
575 to use in the macros CURRENT_MODE_LINE_HEIGHT and
576 CURRENT_HEADER_LINE_HEIGHT. */
578 int current_mode_line_height
, current_header_line_height
;
580 /* The maximum distance to look ahead for text properties. Values
581 that are too small let us call compute_char_face and similar
582 functions too often which is expensive. Values that are too large
583 let us call compute_char_face and alike too often because we
584 might not be interested in text properties that far away. */
586 #define TEXT_PROP_DISTANCE_LIMIT 100
590 /* Non-zero means print traces of redisplay if compiled with
593 int trace_redisplay_p
;
595 #endif /* GLYPH_DEBUG */
597 #ifdef DEBUG_TRACE_MOVE
598 /* Non-zero means trace with TRACE_MOVE to stderr. */
601 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
603 #define TRACE_MOVE(x) (void) 0
606 Lisp_Object Qauto_hscroll_mode
;
608 /* Buffer being redisplayed -- for redisplay_window_error. */
610 struct buffer
*displayed_buffer
;
612 /* Value returned from text property handlers (see below). */
617 HANDLED_RECOMPUTE_PROPS
,
618 HANDLED_OVERLAY_STRING_CONSUMED
,
622 /* A description of text properties that redisplay is interested
627 /* The name of the property. */
630 /* A unique index for the property. */
633 /* A handler function called to set up iterator IT from the property
634 at IT's current position. Value is used to steer handle_stop. */
635 enum prop_handled (*handler
) (struct it
*it
);
638 static enum prop_handled
handle_face_prop (struct it
*);
639 static enum prop_handled
handle_invisible_prop (struct it
*);
640 static enum prop_handled
handle_display_prop (struct it
*);
641 static enum prop_handled
handle_composition_prop (struct it
*);
642 static enum prop_handled
handle_overlay_change (struct it
*);
643 static enum prop_handled
handle_fontified_prop (struct it
*);
645 /* Properties handled by iterators. */
647 static struct props it_props
[] =
649 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
650 /* Handle `face' before `display' because some sub-properties of
651 `display' need to know the face. */
652 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
653 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
654 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
655 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
659 /* Value is the position described by X. If X is a marker, value is
660 the marker_position of X. Otherwise, value is X. */
662 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
664 /* Enumeration returned by some move_it_.* functions internally. */
668 /* Not used. Undefined value. */
671 /* Move ended at the requested buffer position or ZV. */
672 MOVE_POS_MATCH_OR_ZV
,
674 /* Move ended at the requested X pixel position. */
677 /* Move within a line ended at the end of a line that must be
681 /* Move within a line ended at the end of a line that would
682 be displayed truncated. */
685 /* Move within a line ended at a line end. */
689 /* This counter is used to clear the face cache every once in a while
690 in redisplay_internal. It is incremented for each redisplay.
691 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
694 #define CLEAR_FACE_CACHE_COUNT 500
695 static int clear_face_cache_count
;
697 /* Similarly for the image cache. */
699 #ifdef HAVE_WINDOW_SYSTEM
700 #define CLEAR_IMAGE_CACHE_COUNT 101
701 static int clear_image_cache_count
;
703 /* Null glyph slice */
704 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
707 /* Non-zero while redisplay_internal is in progress. */
711 Lisp_Object Qinhibit_free_realized_faces
;
713 /* If a string, XTread_socket generates an event to display that string.
714 (The display is done in read_char.) */
716 Lisp_Object help_echo_string
;
717 Lisp_Object help_echo_window
;
718 Lisp_Object help_echo_object
;
719 EMACS_INT help_echo_pos
;
721 /* Temporary variable for XTread_socket. */
723 Lisp_Object previous_help_echo_string
;
725 /* Platform-independent portion of hourglass implementation. */
727 /* Non-zero means an hourglass cursor is currently shown. */
728 int hourglass_shown_p
;
730 /* If non-null, an asynchronous timer that, when it expires, displays
731 an hourglass cursor on all frames. */
732 struct atimer
*hourglass_atimer
;
734 /* Name of the face used to display glyphless characters. */
735 Lisp_Object Qglyphless_char
;
737 /* Symbol for the purpose of Vglyphless_char_display. */
738 Lisp_Object Qglyphless_char_display
;
740 /* Method symbols for Vglyphless_char_display. */
741 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
743 /* Default pixel width of `thin-space' display method. */
744 #define THIN_SPACE_WIDTH 1
746 /* Default number of seconds to wait before displaying an hourglass
748 #define DEFAULT_HOURGLASS_DELAY 1
751 /* Function prototypes. */
753 static void setup_for_ellipsis (struct it
*, int);
754 static void mark_window_display_accurate_1 (struct window
*, int);
755 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
756 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
757 static int cursor_row_p (struct glyph_row
*);
758 static int redisplay_mode_lines (Lisp_Object
, int);
759 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
761 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
763 static void handle_line_prefix (struct it
*);
765 static void pint2str (char *, int, EMACS_INT
);
766 static void pint2hrstr (char *, int, EMACS_INT
);
767 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
769 static void reconsider_clip_changes (struct window
*, struct buffer
*);
770 static int text_outside_line_unchanged_p (struct window
*,
771 EMACS_INT
, EMACS_INT
);
772 static void store_mode_line_noprop_char (char);
773 static int store_mode_line_noprop (const char *, int, int);
774 static void handle_stop (struct it
*);
775 static void handle_stop_backwards (struct it
*, EMACS_INT
);
776 static int single_display_spec_intangible_p (Lisp_Object
);
777 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
778 static void ensure_echo_area_buffers (void);
779 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
780 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
781 static int with_echo_area_buffer (struct window
*, int,
782 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
783 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
784 static void clear_garbaged_frames (void);
785 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
786 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
787 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
788 static int display_echo_area (struct window
*);
789 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
790 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
791 static Lisp_Object
unwind_redisplay (Lisp_Object
);
792 static int string_char_and_length (const unsigned char *, int *);
793 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
795 static int compute_window_start_on_continuation_line (struct window
*);
796 static Lisp_Object
safe_eval_handler (Lisp_Object
);
797 static void insert_left_trunc_glyphs (struct it
*);
798 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
800 static void extend_face_to_end_of_line (struct it
*);
801 static int append_space_for_newline (struct it
*, int);
802 static int cursor_row_fully_visible_p (struct window
*, int, int);
803 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
804 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
805 static int trailing_whitespace_p (EMACS_INT
);
806 static unsigned long int message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
807 static void push_it (struct it
*);
808 static void pop_it (struct it
*);
809 static void sync_frame_with_window_matrix_rows (struct window
*);
810 static void select_frame_for_redisplay (Lisp_Object
);
811 static void redisplay_internal (void);
812 static int echo_area_display (int);
813 static void redisplay_windows (Lisp_Object
);
814 static void redisplay_window (Lisp_Object
, int);
815 static Lisp_Object
redisplay_window_error (Lisp_Object
);
816 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
817 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
818 static int update_menu_bar (struct frame
*, int, int);
819 static int try_window_reusing_current_matrix (struct window
*);
820 static int try_window_id (struct window
*);
821 static int display_line (struct it
*);
822 static int display_mode_lines (struct window
*);
823 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
824 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
825 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
826 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
827 static void display_menu_bar (struct window
*);
828 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
830 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
831 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
832 static void compute_line_metrics (struct it
*);
833 static void run_redisplay_end_trigger_hook (struct it
*);
834 static int get_overlay_strings (struct it
*, EMACS_INT
);
835 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
836 static void next_overlay_string (struct it
*);
837 static void reseat (struct it
*, struct text_pos
, int);
838 static void reseat_1 (struct it
*, struct text_pos
, int);
839 static void back_to_previous_visible_line_start (struct it
*);
840 void reseat_at_previous_visible_line_start (struct it
*);
841 static void reseat_at_next_visible_line_start (struct it
*, int);
842 static int next_element_from_ellipsis (struct it
*);
843 static int next_element_from_display_vector (struct it
*);
844 static int next_element_from_string (struct it
*);
845 static int next_element_from_c_string (struct it
*);
846 static int next_element_from_buffer (struct it
*);
847 static int next_element_from_composition (struct it
*);
848 static int next_element_from_image (struct it
*);
849 static int next_element_from_stretch (struct it
*);
850 static void load_overlay_strings (struct it
*, EMACS_INT
);
851 static int init_from_display_pos (struct it
*, struct window
*,
852 struct display_pos
*);
853 static void reseat_to_string (struct it
*, const char *,
854 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
855 static enum move_it_result
856 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
857 enum move_operation_enum
);
858 void move_it_vertically_backward (struct it
*, int);
859 static void init_to_row_start (struct it
*, struct window
*,
861 static int init_to_row_end (struct it
*, struct window
*,
863 static void back_to_previous_line_start (struct it
*);
864 static int forward_to_next_line_start (struct it
*, int *);
865 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
866 Lisp_Object
, EMACS_INT
);
867 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
868 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
869 static EMACS_INT
number_of_chars (const char *, int);
870 static void compute_stop_pos (struct it
*);
871 static void compute_string_pos (struct text_pos
*, struct text_pos
,
873 static int face_before_or_after_it_pos (struct it
*, int);
874 static EMACS_INT
next_overlay_change (EMACS_INT
);
875 static int handle_single_display_spec (struct it
*, Lisp_Object
,
876 Lisp_Object
, Lisp_Object
,
877 struct text_pos
*, int);
878 static int underlying_face_id (struct it
*);
879 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
882 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
883 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
885 #ifdef HAVE_WINDOW_SYSTEM
887 static void x_consider_frame_title (Lisp_Object
);
888 static int tool_bar_lines_needed (struct frame
*, int *);
889 static void update_tool_bar (struct frame
*, int);
890 static void build_desired_tool_bar_string (struct frame
*f
);
891 static int redisplay_tool_bar (struct frame
*);
892 static void display_tool_bar_line (struct it
*, int);
893 static void notice_overwritten_cursor (struct window
*,
896 static void append_stretch_glyph (struct it
*, Lisp_Object
,
900 #endif /* HAVE_WINDOW_SYSTEM */
902 static int coords_in_mouse_face_p (struct window
*, int, int);
906 /***********************************************************************
907 Window display dimensions
908 ***********************************************************************/
910 /* Return the bottom boundary y-position for text lines in window W.
911 This is the first y position at which a line cannot start.
912 It is relative to the top of the window.
914 This is the height of W minus the height of a mode line, if any. */
917 window_text_bottom_y (struct window
*w
)
919 int height
= WINDOW_TOTAL_HEIGHT (w
);
921 if (WINDOW_WANTS_MODELINE_P (w
))
922 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
926 /* Return the pixel width of display area AREA of window W. AREA < 0
927 means return the total width of W, not including fringes to
928 the left and right of the window. */
931 window_box_width (struct window
*w
, int area
)
933 int cols
= XFASTINT (w
->total_cols
);
936 if (!w
->pseudo_window_p
)
938 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
940 if (area
== TEXT_AREA
)
942 if (INTEGERP (w
->left_margin_cols
))
943 cols
-= XFASTINT (w
->left_margin_cols
);
944 if (INTEGERP (w
->right_margin_cols
))
945 cols
-= XFASTINT (w
->right_margin_cols
);
946 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
948 else if (area
== LEFT_MARGIN_AREA
)
950 cols
= (INTEGERP (w
->left_margin_cols
)
951 ? XFASTINT (w
->left_margin_cols
) : 0);
954 else if (area
== RIGHT_MARGIN_AREA
)
956 cols
= (INTEGERP (w
->right_margin_cols
)
957 ? XFASTINT (w
->right_margin_cols
) : 0);
962 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
966 /* Return the pixel height of the display area of window W, not
967 including mode lines of W, if any. */
970 window_box_height (struct window
*w
)
972 struct frame
*f
= XFRAME (w
->frame
);
973 int height
= WINDOW_TOTAL_HEIGHT (w
);
975 xassert (height
>= 0);
977 /* Note: the code below that determines the mode-line/header-line
978 height is essentially the same as that contained in the macro
979 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
980 the appropriate glyph row has its `mode_line_p' flag set,
981 and if it doesn't, uses estimate_mode_line_height instead. */
983 if (WINDOW_WANTS_MODELINE_P (w
))
985 struct glyph_row
*ml_row
986 = (w
->current_matrix
&& w
->current_matrix
->rows
987 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
989 if (ml_row
&& ml_row
->mode_line_p
)
990 height
-= ml_row
->height
;
992 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
995 if (WINDOW_WANTS_HEADER_LINE_P (w
))
997 struct glyph_row
*hl_row
998 = (w
->current_matrix
&& w
->current_matrix
->rows
999 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1001 if (hl_row
&& hl_row
->mode_line_p
)
1002 height
-= hl_row
->height
;
1004 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1007 /* With a very small font and a mode-line that's taller than
1008 default, we might end up with a negative height. */
1009 return max (0, height
);
1012 /* Return the window-relative coordinate of the left edge of display
1013 area AREA of window W. AREA < 0 means return the left edge of the
1014 whole window, to the right of the left fringe of W. */
1017 window_box_left_offset (struct window
*w
, int area
)
1021 if (w
->pseudo_window_p
)
1024 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1026 if (area
== TEXT_AREA
)
1027 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1028 + window_box_width (w
, LEFT_MARGIN_AREA
));
1029 else if (area
== RIGHT_MARGIN_AREA
)
1030 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1031 + window_box_width (w
, LEFT_MARGIN_AREA
)
1032 + window_box_width (w
, TEXT_AREA
)
1033 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1035 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1036 else if (area
== LEFT_MARGIN_AREA
1037 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1038 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1044 /* Return the window-relative coordinate of the right edge of display
1045 area AREA of window W. AREA < 0 means return the right edge of the
1046 whole window, to the left of the right fringe of W. */
1049 window_box_right_offset (struct window
*w
, int area
)
1051 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1054 /* Return the frame-relative coordinate of the left edge of display
1055 area AREA of window W. AREA < 0 means return the left edge of the
1056 whole window, to the right of the left fringe of W. */
1059 window_box_left (struct window
*w
, int area
)
1061 struct frame
*f
= XFRAME (w
->frame
);
1064 if (w
->pseudo_window_p
)
1065 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1067 x
= (WINDOW_LEFT_EDGE_X (w
)
1068 + window_box_left_offset (w
, area
));
1074 /* Return the frame-relative coordinate of the right edge of display
1075 area AREA of window W. AREA < 0 means return the right edge of the
1076 whole window, to the left of the right fringe of W. */
1079 window_box_right (struct window
*w
, int area
)
1081 return window_box_left (w
, area
) + window_box_width (w
, area
);
1084 /* Get the bounding box of the display area AREA of window W, without
1085 mode lines, in frame-relative coordinates. AREA < 0 means the
1086 whole window, not including the left and right fringes of
1087 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1088 coordinates of the upper-left corner of the box. Return in
1089 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1092 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1093 int *box_width
, int *box_height
)
1096 *box_width
= window_box_width (w
, area
);
1098 *box_height
= window_box_height (w
);
1100 *box_x
= window_box_left (w
, area
);
1103 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1104 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1105 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1110 /* Get the bounding box of the display area AREA of window W, without
1111 mode lines. AREA < 0 means the whole window, not including the
1112 left and right fringe of the window. Return in *TOP_LEFT_X
1113 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1114 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1115 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1119 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1120 int *bottom_right_x
, int *bottom_right_y
)
1122 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1124 *bottom_right_x
+= *top_left_x
;
1125 *bottom_right_y
+= *top_left_y
;
1130 /***********************************************************************
1132 ***********************************************************************/
1134 /* Return the bottom y-position of the line the iterator IT is in.
1135 This can modify IT's settings. */
1138 line_bottom_y (struct it
*it
)
1140 int line_height
= it
->max_ascent
+ it
->max_descent
;
1141 int line_top_y
= it
->current_y
;
1143 if (line_height
== 0)
1146 line_height
= last_height
;
1147 else if (IT_CHARPOS (*it
) < ZV
)
1149 move_it_by_lines (it
, 1);
1150 line_height
= (it
->max_ascent
|| it
->max_descent
1151 ? it
->max_ascent
+ it
->max_descent
1156 struct glyph_row
*row
= it
->glyph_row
;
1158 /* Use the default character height. */
1159 it
->glyph_row
= NULL
;
1160 it
->what
= IT_CHARACTER
;
1163 PRODUCE_GLYPHS (it
);
1164 line_height
= it
->ascent
+ it
->descent
;
1165 it
->glyph_row
= row
;
1169 return line_top_y
+ line_height
;
1173 /* Return 1 if position CHARPOS is visible in window W.
1174 CHARPOS < 0 means return info about WINDOW_END position.
1175 If visible, set *X and *Y to pixel coordinates of top left corner.
1176 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1177 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1180 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1181 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1184 struct text_pos top
;
1186 struct buffer
*old_buffer
= NULL
;
1188 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1191 if (XBUFFER (w
->buffer
) != current_buffer
)
1193 old_buffer
= current_buffer
;
1194 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1197 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1199 /* Compute exact mode line heights. */
1200 if (WINDOW_WANTS_MODELINE_P (w
))
1201 current_mode_line_height
1202 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1203 BVAR (current_buffer
, mode_line_format
));
1205 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1206 current_header_line_height
1207 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1208 BVAR (current_buffer
, header_line_format
));
1210 start_display (&it
, w
, top
);
1211 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1212 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1214 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1216 /* We have reached CHARPOS, or passed it. How the call to
1217 move_it_to can overshoot: (i) If CHARPOS is on invisible
1218 text, move_it_to stops at the end of the invisible text,
1219 after CHARPOS. (ii) If CHARPOS is in a display vector,
1220 move_it_to stops on its last glyph. */
1221 int top_x
= it
.current_x
;
1222 int top_y
= it
.current_y
;
1223 enum it_method it_method
= it
.method
;
1224 /* Calling line_bottom_y may change it.method, it.position, etc. */
1225 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1226 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1228 if (top_y
< window_top_y
)
1229 visible_p
= bottom_y
> window_top_y
;
1230 else if (top_y
< it
.last_visible_y
)
1234 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1236 /* We stopped on the last glyph of a display vector.
1237 Try and recompute. Hack alert! */
1238 if (charpos
< 2 || top
.charpos
>= charpos
)
1239 top_x
= it
.glyph_row
->x
;
1243 start_display (&it2
, w
, top
);
1244 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1245 get_next_display_element (&it2
);
1246 PRODUCE_GLYPHS (&it2
);
1247 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1248 || it2
.current_x
> it2
.last_visible_x
)
1249 top_x
= it
.glyph_row
->x
;
1252 top_x
= it2
.current_x
;
1253 top_y
= it2
.current_y
;
1259 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1260 *rtop
= max (0, window_top_y
- top_y
);
1261 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1262 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1263 - max (top_y
, window_top_y
)));
1272 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1273 move_it_by_lines (&it
, 1);
1274 if (charpos
< IT_CHARPOS (it
)
1275 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1278 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1280 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1281 *rtop
= max (0, -it2
.current_y
);
1282 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1283 - it
.last_visible_y
));
1284 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1286 - max (it2
.current_y
,
1287 WINDOW_HEADER_LINE_HEIGHT (w
))));
1293 set_buffer_internal_1 (old_buffer
);
1295 current_header_line_height
= current_mode_line_height
= -1;
1297 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1298 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1301 /* Debugging code. */
1303 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1304 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1306 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1313 /* Return the next character from STR. Return in *LEN the length of
1314 the character. This is like STRING_CHAR_AND_LENGTH but never
1315 returns an invalid character. If we find one, we return a `?', but
1316 with the length of the invalid character. */
1319 string_char_and_length (const unsigned char *str
, int *len
)
1323 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1324 if (!CHAR_VALID_P (c
, 1))
1325 /* We may not change the length here because other places in Emacs
1326 don't use this function, i.e. they silently accept invalid
1335 /* Given a position POS containing a valid character and byte position
1336 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1338 static struct text_pos
1339 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1341 xassert (STRINGP (string
) && nchars
>= 0);
1343 if (STRING_MULTIBYTE (string
))
1345 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1350 string_char_and_length (p
, &len
);
1353 BYTEPOS (pos
) += len
;
1357 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1363 /* Value is the text position, i.e. character and byte position,
1364 for character position CHARPOS in STRING. */
1366 static INLINE
struct text_pos
1367 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1369 struct text_pos pos
;
1370 xassert (STRINGP (string
));
1371 xassert (charpos
>= 0);
1372 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1377 /* Value is a text position, i.e. character and byte position, for
1378 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1379 means recognize multibyte characters. */
1381 static struct text_pos
1382 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1384 struct text_pos pos
;
1386 xassert (s
!= NULL
);
1387 xassert (charpos
>= 0);
1393 SET_TEXT_POS (pos
, 0, 0);
1396 string_char_and_length ((const unsigned char *) s
, &len
);
1399 BYTEPOS (pos
) += len
;
1403 SET_TEXT_POS (pos
, charpos
, charpos
);
1409 /* Value is the number of characters in C string S. MULTIBYTE_P
1410 non-zero means recognize multibyte characters. */
1413 number_of_chars (const char *s
, int multibyte_p
)
1419 EMACS_INT rest
= strlen (s
);
1421 const unsigned char *p
= (const unsigned char *) s
;
1423 for (nchars
= 0; rest
> 0; ++nchars
)
1425 string_char_and_length (p
, &len
);
1426 rest
-= len
, p
+= len
;
1430 nchars
= strlen (s
);
1436 /* Compute byte position NEWPOS->bytepos corresponding to
1437 NEWPOS->charpos. POS is a known position in string STRING.
1438 NEWPOS->charpos must be >= POS.charpos. */
1441 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1443 xassert (STRINGP (string
));
1444 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1446 if (STRING_MULTIBYTE (string
))
1447 *newpos
= string_pos_nchars_ahead (pos
, string
,
1448 CHARPOS (*newpos
) - CHARPOS (pos
));
1450 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1454 Return an estimation of the pixel height of mode or header lines on
1455 frame F. FACE_ID specifies what line's height to estimate. */
1458 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1460 #ifdef HAVE_WINDOW_SYSTEM
1461 if (FRAME_WINDOW_P (f
))
1463 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1465 /* This function is called so early when Emacs starts that the face
1466 cache and mode line face are not yet initialized. */
1467 if (FRAME_FACE_CACHE (f
))
1469 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1473 height
= FONT_HEIGHT (face
->font
);
1474 if (face
->box_line_width
> 0)
1475 height
+= 2 * face
->box_line_width
;
1486 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1487 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1488 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1489 not force the value into range. */
1492 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1493 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1496 #ifdef HAVE_WINDOW_SYSTEM
1497 if (FRAME_WINDOW_P (f
))
1499 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1500 even for negative values. */
1502 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1504 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1506 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1507 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1510 STORE_NATIVE_RECT (*bounds
,
1511 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1512 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1513 FRAME_COLUMN_WIDTH (f
) - 1,
1514 FRAME_LINE_HEIGHT (f
) - 1);
1520 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1521 pix_x
= FRAME_TOTAL_COLS (f
);
1525 else if (pix_y
> FRAME_LINES (f
))
1526 pix_y
= FRAME_LINES (f
);
1536 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1537 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1538 can't tell the positions because W's display is not up to date,
1542 glyph_to_pixel_coords (struct window
*w
, int hpos
, int vpos
,
1543 int *frame_x
, int *frame_y
)
1545 #ifdef HAVE_WINDOW_SYSTEM
1546 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1550 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1551 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1553 if (display_completed
)
1555 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1556 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1557 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1563 hpos
+= glyph
->pixel_width
;
1567 /* If first glyph is partially visible, its first visible position is still 0. */
1579 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1580 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1591 /* Find the glyph under window-relative coordinates X/Y in window W.
1592 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1593 strings. Return in *HPOS and *VPOS the row and column number of
1594 the glyph found. Return in *AREA the glyph area containing X.
1595 Value is a pointer to the glyph found or null if X/Y is not on
1596 text, or we can't tell because W's current matrix is not up to
1601 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1602 int *dx
, int *dy
, int *area
)
1604 struct glyph
*glyph
, *end
;
1605 struct glyph_row
*row
= NULL
;
1608 /* Find row containing Y. Give up if some row is not enabled. */
1609 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1611 row
= MATRIX_ROW (w
->current_matrix
, i
);
1612 if (!row
->enabled_p
)
1614 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1621 /* Give up if Y is not in the window. */
1622 if (i
== w
->current_matrix
->nrows
)
1625 /* Get the glyph area containing X. */
1626 if (w
->pseudo_window_p
)
1633 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1635 *area
= LEFT_MARGIN_AREA
;
1636 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1638 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1641 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1645 *area
= RIGHT_MARGIN_AREA
;
1646 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1650 /* Find glyph containing X. */
1651 glyph
= row
->glyphs
[*area
];
1652 end
= glyph
+ row
->used
[*area
];
1654 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1656 x
-= glyph
->pixel_width
;
1666 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1669 *hpos
= glyph
- row
->glyphs
[*area
];
1674 Convert frame-relative x/y to coordinates relative to window W.
1675 Takes pseudo-windows into account. */
1678 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1680 if (w
->pseudo_window_p
)
1682 /* A pseudo-window is always full-width, and starts at the
1683 left edge of the frame, plus a frame border. */
1684 struct frame
*f
= XFRAME (w
->frame
);
1685 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1686 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1690 *x
-= WINDOW_LEFT_EDGE_X (w
);
1691 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1695 #ifdef HAVE_WINDOW_SYSTEM
1698 Return in RECTS[] at most N clipping rectangles for glyph string S.
1699 Return the number of stored rectangles. */
1702 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1709 if (s
->row
->full_width_p
)
1711 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1712 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1713 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1715 /* Unless displaying a mode or menu bar line, which are always
1716 fully visible, clip to the visible part of the row. */
1717 if (s
->w
->pseudo_window_p
)
1718 r
.height
= s
->row
->visible_height
;
1720 r
.height
= s
->height
;
1724 /* This is a text line that may be partially visible. */
1725 r
.x
= window_box_left (s
->w
, s
->area
);
1726 r
.width
= window_box_width (s
->w
, s
->area
);
1727 r
.height
= s
->row
->visible_height
;
1731 if (r
.x
< s
->clip_head
->x
)
1733 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1734 r
.width
-= s
->clip_head
->x
- r
.x
;
1737 r
.x
= s
->clip_head
->x
;
1740 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1742 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1743 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1748 /* If S draws overlapping rows, it's sufficient to use the top and
1749 bottom of the window for clipping because this glyph string
1750 intentionally draws over other lines. */
1751 if (s
->for_overlaps
)
1753 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1754 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1756 /* Alas, the above simple strategy does not work for the
1757 environments with anti-aliased text: if the same text is
1758 drawn onto the same place multiple times, it gets thicker.
1759 If the overlap we are processing is for the erased cursor, we
1760 take the intersection with the rectagle of the cursor. */
1761 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1763 XRectangle rc
, r_save
= r
;
1765 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1766 rc
.y
= s
->w
->phys_cursor
.y
;
1767 rc
.width
= s
->w
->phys_cursor_width
;
1768 rc
.height
= s
->w
->phys_cursor_height
;
1770 x_intersect_rectangles (&r_save
, &rc
, &r
);
1775 /* Don't use S->y for clipping because it doesn't take partially
1776 visible lines into account. For example, it can be negative for
1777 partially visible lines at the top of a window. */
1778 if (!s
->row
->full_width_p
1779 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1780 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1782 r
.y
= max (0, s
->row
->y
);
1785 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1787 /* If drawing the cursor, don't let glyph draw outside its
1788 advertised boundaries. Cleartype does this under some circumstances. */
1789 if (s
->hl
== DRAW_CURSOR
)
1791 struct glyph
*glyph
= s
->first_glyph
;
1796 r
.width
-= s
->x
- r
.x
;
1799 r
.width
= min (r
.width
, glyph
->pixel_width
);
1801 /* If r.y is below window bottom, ensure that we still see a cursor. */
1802 height
= min (glyph
->ascent
+ glyph
->descent
,
1803 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1804 max_y
= window_text_bottom_y (s
->w
) - height
;
1805 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1806 if (s
->ybase
- glyph
->ascent
> max_y
)
1813 /* Don't draw cursor glyph taller than our actual glyph. */
1814 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1815 if (height
< r
.height
)
1817 max_y
= r
.y
+ r
.height
;
1818 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1819 r
.height
= min (max_y
- r
.y
, height
);
1826 XRectangle r_save
= r
;
1828 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1832 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1833 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1835 #ifdef CONVERT_FROM_XRECT
1836 CONVERT_FROM_XRECT (r
, *rects
);
1844 /* If we are processing overlapping and allowed to return
1845 multiple clipping rectangles, we exclude the row of the glyph
1846 string from the clipping rectangle. This is to avoid drawing
1847 the same text on the environment with anti-aliasing. */
1848 #ifdef CONVERT_FROM_XRECT
1851 XRectangle
*rs
= rects
;
1853 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1855 if (s
->for_overlaps
& OVERLAPS_PRED
)
1858 if (r
.y
+ r
.height
> row_y
)
1861 rs
[i
].height
= row_y
- r
.y
;
1867 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1870 if (r
.y
< row_y
+ s
->row
->visible_height
)
1872 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1874 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1875 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1884 #ifdef CONVERT_FROM_XRECT
1885 for (i
= 0; i
< n
; i
++)
1886 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1893 Return in *NR the clipping rectangle for glyph string S. */
1896 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1898 get_glyph_string_clip_rects (s
, nr
, 1);
1903 Return the position and height of the phys cursor in window W.
1904 Set w->phys_cursor_width to width of phys cursor.
1908 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1909 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1911 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1912 int x
, y
, wd
, h
, h0
, y0
;
1914 /* Compute the width of the rectangle to draw. If on a stretch
1915 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1916 rectangle as wide as the glyph, but use a canonical character
1918 wd
= glyph
->pixel_width
- 1;
1919 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1923 x
= w
->phys_cursor
.x
;
1930 if (glyph
->type
== STRETCH_GLYPH
1931 && !x_stretch_cursor_p
)
1932 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1933 w
->phys_cursor_width
= wd
;
1935 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1937 /* If y is below window bottom, ensure that we still see a cursor. */
1938 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1940 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1941 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1943 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1946 h
= max (h
- (y0
- y
) + 1, h0
);
1951 y0
= window_text_bottom_y (w
) - h0
;
1959 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1960 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1965 * Remember which glyph the mouse is over.
1969 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1973 struct glyph_row
*r
, *gr
, *end_row
;
1974 enum window_part part
;
1975 enum glyph_row_area area
;
1976 int x
, y
, width
, height
;
1978 /* Try to determine frame pixel position and size of the glyph under
1979 frame pixel coordinates X/Y on frame F. */
1981 if (!f
->glyphs_initialized_p
1982 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1985 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1986 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1990 w
= XWINDOW (window
);
1991 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1992 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1994 x
= window_relative_x_coord (w
, part
, gx
);
1995 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1997 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1998 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2000 if (w
->pseudo_window_p
)
2003 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2009 case ON_LEFT_MARGIN
:
2010 area
= LEFT_MARGIN_AREA
;
2013 case ON_RIGHT_MARGIN
:
2014 area
= RIGHT_MARGIN_AREA
;
2017 case ON_HEADER_LINE
:
2019 gr
= (part
== ON_HEADER_LINE
2020 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2021 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2024 goto text_glyph_row_found
;
2031 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2032 if (r
->y
+ r
->height
> y
)
2038 text_glyph_row_found
:
2041 struct glyph
*g
= gr
->glyphs
[area
];
2042 struct glyph
*end
= g
+ gr
->used
[area
];
2044 height
= gr
->height
;
2045 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2046 if (gx
+ g
->pixel_width
> x
)
2051 if (g
->type
== IMAGE_GLYPH
)
2053 /* Don't remember when mouse is over image, as
2054 image may have hot-spots. */
2055 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2058 width
= g
->pixel_width
;
2062 /* Use nominal char spacing at end of line. */
2064 gx
+= (x
/ width
) * width
;
2067 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2068 gx
+= window_box_left_offset (w
, area
);
2072 /* Use nominal line height at end of window. */
2073 gx
= (x
/ width
) * width
;
2075 gy
+= (y
/ height
) * height
;
2079 case ON_LEFT_FRINGE
:
2080 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2081 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2082 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2083 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2086 case ON_RIGHT_FRINGE
:
2087 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2088 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2089 : window_box_right_offset (w
, TEXT_AREA
));
2090 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2094 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2096 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2097 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2098 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2100 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2104 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2105 if (r
->y
+ r
->height
> y
)
2112 height
= gr
->height
;
2115 /* Use nominal line height at end of window. */
2117 gy
+= (y
/ height
) * height
;
2124 /* If there is no glyph under the mouse, then we divide the screen
2125 into a grid of the smallest glyph in the frame, and use that
2128 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2129 round down even for negative values. */
2135 gx
= (gx
/ width
) * width
;
2136 gy
= (gy
/ height
) * height
;
2141 gx
+= WINDOW_LEFT_EDGE_X (w
);
2142 gy
+= WINDOW_TOP_EDGE_Y (w
);
2145 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2147 /* Visible feedback for debugging. */
2150 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2151 f
->output_data
.x
->normal_gc
,
2152 gx
, gy
, width
, height
);
2158 #endif /* HAVE_WINDOW_SYSTEM */
2161 /***********************************************************************
2162 Lisp form evaluation
2163 ***********************************************************************/
2165 /* Error handler for safe_eval and safe_call. */
2168 safe_eval_handler (Lisp_Object arg
)
2170 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2175 /* Evaluate SEXPR and return the result, or nil if something went
2176 wrong. Prevent redisplay during the evaluation. */
2178 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2179 Return the result, or nil if something went wrong. Prevent
2180 redisplay during the evaluation. */
2183 safe_call (size_t nargs
, Lisp_Object
*args
)
2187 if (inhibit_eval_during_redisplay
)
2191 int count
= SPECPDL_INDEX ();
2192 struct gcpro gcpro1
;
2195 gcpro1
.nvars
= nargs
;
2196 specbind (Qinhibit_redisplay
, Qt
);
2197 /* Use Qt to ensure debugger does not run,
2198 so there is no possibility of wanting to redisplay. */
2199 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2202 val
= unbind_to (count
, val
);
2209 /* Call function FN with one argument ARG.
2210 Return the result, or nil if something went wrong. */
2213 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2215 Lisp_Object args
[2];
2218 return safe_call (2, args
);
2221 static Lisp_Object Qeval
;
2224 safe_eval (Lisp_Object sexpr
)
2226 return safe_call1 (Qeval
, sexpr
);
2229 /* Call function FN with one argument ARG.
2230 Return the result, or nil if something went wrong. */
2233 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2235 Lisp_Object args
[3];
2239 return safe_call (3, args
);
2244 /***********************************************************************
2246 ***********************************************************************/
2250 /* Define CHECK_IT to perform sanity checks on iterators.
2251 This is for debugging. It is too slow to do unconditionally. */
2257 if (it
->method
== GET_FROM_STRING
)
2259 xassert (STRINGP (it
->string
));
2260 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2264 xassert (IT_STRING_CHARPOS (*it
) < 0);
2265 if (it
->method
== GET_FROM_BUFFER
)
2267 /* Check that character and byte positions agree. */
2268 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2273 xassert (it
->current
.dpvec_index
>= 0);
2275 xassert (it
->current
.dpvec_index
< 0);
2278 #define CHECK_IT(IT) check_it ((IT))
2282 #define CHECK_IT(IT) (void) 0
2289 /* Check that the window end of window W is what we expect it
2290 to be---the last row in the current matrix displaying text. */
2293 check_window_end (w
)
2296 if (!MINI_WINDOW_P (w
)
2297 && !NILP (w
->window_end_valid
))
2299 struct glyph_row
*row
;
2300 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2301 XFASTINT (w
->window_end_vpos
)),
2303 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2304 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2308 #define CHECK_WINDOW_END(W) check_window_end ((W))
2310 #else /* not GLYPH_DEBUG */
2312 #define CHECK_WINDOW_END(W) (void) 0
2314 #endif /* not GLYPH_DEBUG */
2318 /***********************************************************************
2319 Iterator initialization
2320 ***********************************************************************/
2322 /* Initialize IT for displaying current_buffer in window W, starting
2323 at character position CHARPOS. CHARPOS < 0 means that no buffer
2324 position is specified which is useful when the iterator is assigned
2325 a position later. BYTEPOS is the byte position corresponding to
2326 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2328 If ROW is not null, calls to produce_glyphs with IT as parameter
2329 will produce glyphs in that row.
2331 BASE_FACE_ID is the id of a base face to use. It must be one of
2332 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2333 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2334 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2336 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2337 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2338 will be initialized to use the corresponding mode line glyph row of
2339 the desired matrix of W. */
2342 init_iterator (struct it
*it
, struct window
*w
,
2343 EMACS_INT charpos
, EMACS_INT bytepos
,
2344 struct glyph_row
*row
, enum face_id base_face_id
)
2346 int highlight_region_p
;
2347 enum face_id remapped_base_face_id
= base_face_id
;
2349 /* Some precondition checks. */
2350 xassert (w
!= NULL
&& it
!= NULL
);
2351 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2354 /* If face attributes have been changed since the last redisplay,
2355 free realized faces now because they depend on face definitions
2356 that might have changed. Don't free faces while there might be
2357 desired matrices pending which reference these faces. */
2358 if (face_change_count
&& !inhibit_free_realized_faces
)
2360 face_change_count
= 0;
2361 free_all_realized_faces (Qnil
);
2364 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2365 if (! NILP (Vface_remapping_alist
))
2366 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2368 /* Use one of the mode line rows of W's desired matrix if
2372 if (base_face_id
== MODE_LINE_FACE_ID
2373 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2374 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2375 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2376 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2380 memset (it
, 0, sizeof *it
);
2381 it
->current
.overlay_string_index
= -1;
2382 it
->current
.dpvec_index
= -1;
2383 it
->base_face_id
= remapped_base_face_id
;
2385 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2387 /* The window in which we iterate over current_buffer: */
2388 XSETWINDOW (it
->window
, w
);
2390 it
->f
= XFRAME (w
->frame
);
2394 /* Extra space between lines (on window systems only). */
2395 if (base_face_id
== DEFAULT_FACE_ID
2396 && FRAME_WINDOW_P (it
->f
))
2398 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2399 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2400 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2401 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2402 * FRAME_LINE_HEIGHT (it
->f
));
2403 else if (it
->f
->extra_line_spacing
> 0)
2404 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2405 it
->max_extra_line_spacing
= 0;
2408 /* If realized faces have been removed, e.g. because of face
2409 attribute changes of named faces, recompute them. When running
2410 in batch mode, the face cache of the initial frame is null. If
2411 we happen to get called, make a dummy face cache. */
2412 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2413 init_frame_faces (it
->f
);
2414 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2415 recompute_basic_faces (it
->f
);
2417 /* Current value of the `slice', `space-width', and 'height' properties. */
2418 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2419 it
->space_width
= Qnil
;
2420 it
->font_height
= Qnil
;
2421 it
->override_ascent
= -1;
2423 /* Are control characters displayed as `^C'? */
2424 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2426 /* -1 means everything between a CR and the following line end
2427 is invisible. >0 means lines indented more than this value are
2429 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2430 ? XFASTINT (BVAR (current_buffer
, selective_display
))
2431 : (!NILP (BVAR (current_buffer
, selective_display
))
2433 it
->selective_display_ellipsis_p
2434 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2436 /* Display table to use. */
2437 it
->dp
= window_display_table (w
);
2439 /* Are multibyte characters enabled in current_buffer? */
2440 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2442 /* Do we need to reorder bidirectional text? Not if this is a
2443 unibyte buffer: by definition, none of the single-byte characters
2444 are strong R2L, so no reordering is needed. And bidi.c doesn't
2445 support unibyte buffers anyway. */
2447 = !NILP (BVAR (current_buffer
, bidi_display_reordering
)) && it
->multibyte_p
;
2449 /* Non-zero if we should highlight the region. */
2451 = (!NILP (Vtransient_mark_mode
)
2452 && !NILP (BVAR (current_buffer
, mark_active
))
2453 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2455 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2456 start and end of a visible region in window IT->w. Set both to
2457 -1 to indicate no region. */
2458 if (highlight_region_p
2459 /* Maybe highlight only in selected window. */
2460 && (/* Either show region everywhere. */
2461 highlight_nonselected_windows
2462 /* Or show region in the selected window. */
2463 || w
== XWINDOW (selected_window
)
2464 /* Or show the region if we are in the mini-buffer and W is
2465 the window the mini-buffer refers to. */
2466 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2467 && WINDOWP (minibuf_selected_window
)
2468 && w
== XWINDOW (minibuf_selected_window
))))
2470 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2471 it
->region_beg_charpos
= min (PT
, markpos
);
2472 it
->region_end_charpos
= max (PT
, markpos
);
2475 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2477 /* Get the position at which the redisplay_end_trigger hook should
2478 be run, if it is to be run at all. */
2479 if (MARKERP (w
->redisplay_end_trigger
)
2480 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2481 it
->redisplay_end_trigger_charpos
2482 = marker_position (w
->redisplay_end_trigger
);
2483 else if (INTEGERP (w
->redisplay_end_trigger
))
2484 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2486 /* Correct bogus values of tab_width. */
2487 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2488 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2491 /* Are lines in the display truncated? */
2492 if (base_face_id
!= DEFAULT_FACE_ID
2493 || XINT (it
->w
->hscroll
)
2494 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2495 && ((!NILP (Vtruncate_partial_width_windows
)
2496 && !INTEGERP (Vtruncate_partial_width_windows
))
2497 || (INTEGERP (Vtruncate_partial_width_windows
)
2498 && (WINDOW_TOTAL_COLS (it
->w
)
2499 < XINT (Vtruncate_partial_width_windows
))))))
2500 it
->line_wrap
= TRUNCATE
;
2501 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2502 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2503 ? WINDOW_WRAP
: WORD_WRAP
;
2505 it
->line_wrap
= TRUNCATE
;
2507 /* Get dimensions of truncation and continuation glyphs. These are
2508 displayed as fringe bitmaps under X, so we don't need them for such
2510 if (!FRAME_WINDOW_P (it
->f
))
2512 if (it
->line_wrap
== TRUNCATE
)
2514 /* We will need the truncation glyph. */
2515 xassert (it
->glyph_row
== NULL
);
2516 produce_special_glyphs (it
, IT_TRUNCATION
);
2517 it
->truncation_pixel_width
= it
->pixel_width
;
2521 /* We will need the continuation glyph. */
2522 xassert (it
->glyph_row
== NULL
);
2523 produce_special_glyphs (it
, IT_CONTINUATION
);
2524 it
->continuation_pixel_width
= it
->pixel_width
;
2527 /* Reset these values to zero because the produce_special_glyphs
2528 above has changed them. */
2529 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2530 it
->phys_ascent
= it
->phys_descent
= 0;
2533 /* Set this after getting the dimensions of truncation and
2534 continuation glyphs, so that we don't produce glyphs when calling
2535 produce_special_glyphs, above. */
2536 it
->glyph_row
= row
;
2537 it
->area
= TEXT_AREA
;
2539 /* Forget any previous info about this row being reversed. */
2541 it
->glyph_row
->reversed_p
= 0;
2543 /* Get the dimensions of the display area. The display area
2544 consists of the visible window area plus a horizontally scrolled
2545 part to the left of the window. All x-values are relative to the
2546 start of this total display area. */
2547 if (base_face_id
!= DEFAULT_FACE_ID
)
2549 /* Mode lines, menu bar in terminal frames. */
2550 it
->first_visible_x
= 0;
2551 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2556 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2557 it
->last_visible_x
= (it
->first_visible_x
2558 + window_box_width (w
, TEXT_AREA
));
2560 /* If we truncate lines, leave room for the truncator glyph(s) at
2561 the right margin. Otherwise, leave room for the continuation
2562 glyph(s). Truncation and continuation glyphs are not inserted
2563 for window-based redisplay. */
2564 if (!FRAME_WINDOW_P (it
->f
))
2566 if (it
->line_wrap
== TRUNCATE
)
2567 it
->last_visible_x
-= it
->truncation_pixel_width
;
2569 it
->last_visible_x
-= it
->continuation_pixel_width
;
2572 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2573 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2576 /* Leave room for a border glyph. */
2577 if (!FRAME_WINDOW_P (it
->f
)
2578 && !WINDOW_RIGHTMOST_P (it
->w
))
2579 it
->last_visible_x
-= 1;
2581 it
->last_visible_y
= window_text_bottom_y (w
);
2583 /* For mode lines and alike, arrange for the first glyph having a
2584 left box line if the face specifies a box. */
2585 if (base_face_id
!= DEFAULT_FACE_ID
)
2589 it
->face_id
= remapped_base_face_id
;
2591 /* If we have a boxed mode line, make the first character appear
2592 with a left box line. */
2593 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2594 if (face
->box
!= FACE_NO_BOX
)
2595 it
->start_of_box_run_p
= 1;
2598 /* If we are to reorder bidirectional text, init the bidi
2602 /* Note the paragraph direction that this buffer wants to
2604 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qleft_to_right
))
2605 it
->paragraph_embedding
= L2R
;
2606 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qright_to_left
))
2607 it
->paragraph_embedding
= R2L
;
2609 it
->paragraph_embedding
= NEUTRAL_DIR
;
2610 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2613 /* If a buffer position was specified, set the iterator there,
2614 getting overlays and face properties from that position. */
2615 if (charpos
>= BUF_BEG (current_buffer
))
2617 it
->end_charpos
= ZV
;
2619 IT_CHARPOS (*it
) = charpos
;
2621 /* Compute byte position if not specified. */
2622 if (bytepos
< charpos
)
2623 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2625 IT_BYTEPOS (*it
) = bytepos
;
2627 it
->start
= it
->current
;
2629 /* Compute faces etc. */
2630 reseat (it
, it
->current
.pos
, 1);
2637 /* Initialize IT for the display of window W with window start POS. */
2640 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2642 struct glyph_row
*row
;
2643 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2645 row
= w
->desired_matrix
->rows
+ first_vpos
;
2646 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2647 it
->first_vpos
= first_vpos
;
2649 /* Don't reseat to previous visible line start if current start
2650 position is in a string or image. */
2651 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2653 int start_at_line_beg_p
;
2654 int first_y
= it
->current_y
;
2656 /* If window start is not at a line start, skip forward to POS to
2657 get the correct continuation lines width. */
2658 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2659 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2660 if (!start_at_line_beg_p
)
2664 reseat_at_previous_visible_line_start (it
);
2665 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2667 new_x
= it
->current_x
+ it
->pixel_width
;
2669 /* If lines are continued, this line may end in the middle
2670 of a multi-glyph character (e.g. a control character
2671 displayed as \003, or in the middle of an overlay
2672 string). In this case move_it_to above will not have
2673 taken us to the start of the continuation line but to the
2674 end of the continued line. */
2675 if (it
->current_x
> 0
2676 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2677 && (/* And glyph doesn't fit on the line. */
2678 new_x
> it
->last_visible_x
2679 /* Or it fits exactly and we're on a window
2681 || (new_x
== it
->last_visible_x
2682 && FRAME_WINDOW_P (it
->f
))))
2684 if (it
->current
.dpvec_index
>= 0
2685 || it
->current
.overlay_string_index
>= 0)
2687 set_iterator_to_next (it
, 1);
2688 move_it_in_display_line_to (it
, -1, -1, 0);
2691 it
->continuation_lines_width
+= it
->current_x
;
2694 /* We're starting a new display line, not affected by the
2695 height of the continued line, so clear the appropriate
2696 fields in the iterator structure. */
2697 it
->max_ascent
= it
->max_descent
= 0;
2698 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2700 it
->current_y
= first_y
;
2702 it
->current_x
= it
->hpos
= 0;
2708 /* Return 1 if POS is a position in ellipses displayed for invisible
2709 text. W is the window we display, for text property lookup. */
2712 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2714 Lisp_Object prop
, window
;
2716 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2718 /* If POS specifies a position in a display vector, this might
2719 be for an ellipsis displayed for invisible text. We won't
2720 get the iterator set up for delivering that ellipsis unless
2721 we make sure that it gets aware of the invisible text. */
2722 if (pos
->dpvec_index
>= 0
2723 && pos
->overlay_string_index
< 0
2724 && CHARPOS (pos
->string_pos
) < 0
2726 && (XSETWINDOW (window
, w
),
2727 prop
= Fget_char_property (make_number (charpos
),
2728 Qinvisible
, window
),
2729 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2731 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2733 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2740 /* Initialize IT for stepping through current_buffer in window W,
2741 starting at position POS that includes overlay string and display
2742 vector/ control character translation position information. Value
2743 is zero if there are overlay strings with newlines at POS. */
2746 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2748 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2749 int i
, overlay_strings_with_newlines
= 0;
2751 /* If POS specifies a position in a display vector, this might
2752 be for an ellipsis displayed for invisible text. We won't
2753 get the iterator set up for delivering that ellipsis unless
2754 we make sure that it gets aware of the invisible text. */
2755 if (in_ellipses_for_invisible_text_p (pos
, w
))
2761 /* Keep in mind: the call to reseat in init_iterator skips invisible
2762 text, so we might end up at a position different from POS. This
2763 is only a problem when POS is a row start after a newline and an
2764 overlay starts there with an after-string, and the overlay has an
2765 invisible property. Since we don't skip invisible text in
2766 display_line and elsewhere immediately after consuming the
2767 newline before the row start, such a POS will not be in a string,
2768 but the call to init_iterator below will move us to the
2770 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2772 /* This only scans the current chunk -- it should scan all chunks.
2773 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2774 to 16 in 22.1 to make this a lesser problem. */
2775 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2777 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2778 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2780 while (s
< e
&& *s
!= '\n')
2785 overlay_strings_with_newlines
= 1;
2790 /* If position is within an overlay string, set up IT to the right
2792 if (pos
->overlay_string_index
>= 0)
2796 /* If the first overlay string happens to have a `display'
2797 property for an image, the iterator will be set up for that
2798 image, and we have to undo that setup first before we can
2799 correct the overlay string index. */
2800 if (it
->method
== GET_FROM_IMAGE
)
2803 /* We already have the first chunk of overlay strings in
2804 IT->overlay_strings. Load more until the one for
2805 pos->overlay_string_index is in IT->overlay_strings. */
2806 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2808 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2809 it
->current
.overlay_string_index
= 0;
2812 load_overlay_strings (it
, 0);
2813 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2817 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2818 relative_index
= (it
->current
.overlay_string_index
2819 % OVERLAY_STRING_CHUNK_SIZE
);
2820 it
->string
= it
->overlay_strings
[relative_index
];
2821 xassert (STRINGP (it
->string
));
2822 it
->current
.string_pos
= pos
->string_pos
;
2823 it
->method
= GET_FROM_STRING
;
2826 if (CHARPOS (pos
->string_pos
) >= 0)
2828 /* Recorded position is not in an overlay string, but in another
2829 string. This can only be a string from a `display' property.
2830 IT should already be filled with that string. */
2831 it
->current
.string_pos
= pos
->string_pos
;
2832 xassert (STRINGP (it
->string
));
2835 /* Restore position in display vector translations, control
2836 character translations or ellipses. */
2837 if (pos
->dpvec_index
>= 0)
2839 if (it
->dpvec
== NULL
)
2840 get_next_display_element (it
);
2841 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2842 it
->current
.dpvec_index
= pos
->dpvec_index
;
2846 return !overlay_strings_with_newlines
;
2850 /* Initialize IT for stepping through current_buffer in window W
2851 starting at ROW->start. */
2854 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2856 init_from_display_pos (it
, w
, &row
->start
);
2857 it
->start
= row
->start
;
2858 it
->continuation_lines_width
= row
->continuation_lines_width
;
2863 /* Initialize IT for stepping through current_buffer in window W
2864 starting in the line following ROW, i.e. starting at ROW->end.
2865 Value is zero if there are overlay strings with newlines at ROW's
2869 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2873 if (init_from_display_pos (it
, w
, &row
->end
))
2875 if (row
->continued_p
)
2876 it
->continuation_lines_width
2877 = row
->continuation_lines_width
+ row
->pixel_width
;
2888 /***********************************************************************
2890 ***********************************************************************/
2892 /* Called when IT reaches IT->stop_charpos. Handle text property and
2893 overlay changes. Set IT->stop_charpos to the next position where
2897 handle_stop (struct it
*it
)
2899 enum prop_handled handled
;
2900 int handle_overlay_change_p
;
2904 it
->current
.dpvec_index
= -1;
2905 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2906 it
->ignore_overlay_strings_at_pos_p
= 0;
2909 /* Use face of preceding text for ellipsis (if invisible) */
2910 if (it
->selective_display_ellipsis_p
)
2911 it
->saved_face_id
= it
->face_id
;
2915 handled
= HANDLED_NORMALLY
;
2917 /* Call text property handlers. */
2918 for (p
= it_props
; p
->handler
; ++p
)
2920 handled
= p
->handler (it
);
2922 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2924 else if (handled
== HANDLED_RETURN
)
2926 /* We still want to show before and after strings from
2927 overlays even if the actual buffer text is replaced. */
2928 if (!handle_overlay_change_p
2930 || !get_overlay_strings_1 (it
, 0, 0))
2933 setup_for_ellipsis (it
, 0);
2934 /* When handling a display spec, we might load an
2935 empty string. In that case, discard it here. We
2936 used to discard it in handle_single_display_spec,
2937 but that causes get_overlay_strings_1, above, to
2938 ignore overlay strings that we must check. */
2939 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2943 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2947 it
->ignore_overlay_strings_at_pos_p
= 1;
2948 it
->string_from_display_prop_p
= 0;
2949 handle_overlay_change_p
= 0;
2951 handled
= HANDLED_RECOMPUTE_PROPS
;
2954 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2955 handle_overlay_change_p
= 0;
2958 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2960 /* Don't check for overlay strings below when set to deliver
2961 characters from a display vector. */
2962 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2963 handle_overlay_change_p
= 0;
2965 /* Handle overlay changes.
2966 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2967 if it finds overlays. */
2968 if (handle_overlay_change_p
)
2969 handled
= handle_overlay_change (it
);
2974 setup_for_ellipsis (it
, 0);
2978 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2980 /* Determine where to stop next. */
2981 if (handled
== HANDLED_NORMALLY
)
2982 compute_stop_pos (it
);
2986 /* Compute IT->stop_charpos from text property and overlay change
2987 information for IT's current position. */
2990 compute_stop_pos (struct it
*it
)
2992 register INTERVAL iv
, next_iv
;
2993 Lisp_Object object
, limit
, position
;
2994 EMACS_INT charpos
, bytepos
;
2996 /* If nowhere else, stop at the end. */
2997 it
->stop_charpos
= it
->end_charpos
;
2999 if (STRINGP (it
->string
))
3001 /* Strings are usually short, so don't limit the search for
3003 object
= it
->string
;
3005 charpos
= IT_STRING_CHARPOS (*it
);
3006 bytepos
= IT_STRING_BYTEPOS (*it
);
3012 /* If next overlay change is in front of the current stop pos
3013 (which is IT->end_charpos), stop there. Note: value of
3014 next_overlay_change is point-max if no overlay change
3016 charpos
= IT_CHARPOS (*it
);
3017 bytepos
= IT_BYTEPOS (*it
);
3018 pos
= next_overlay_change (charpos
);
3019 if (pos
< it
->stop_charpos
)
3020 it
->stop_charpos
= pos
;
3022 /* If showing the region, we have to stop at the region
3023 start or end because the face might change there. */
3024 if (it
->region_beg_charpos
> 0)
3026 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3027 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3028 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3029 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3032 /* Set up variables for computing the stop position from text
3033 property changes. */
3034 XSETBUFFER (object
, current_buffer
);
3035 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3038 /* Get the interval containing IT's position. Value is a null
3039 interval if there isn't such an interval. */
3040 position
= make_number (charpos
);
3041 iv
= validate_interval_range (object
, &position
, &position
, 0);
3042 if (!NULL_INTERVAL_P (iv
))
3044 Lisp_Object values_here
[LAST_PROP_IDX
];
3047 /* Get properties here. */
3048 for (p
= it_props
; p
->handler
; ++p
)
3049 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3051 /* Look for an interval following iv that has different
3053 for (next_iv
= next_interval (iv
);
3054 (!NULL_INTERVAL_P (next_iv
)
3056 || XFASTINT (limit
) > next_iv
->position
));
3057 next_iv
= next_interval (next_iv
))
3059 for (p
= it_props
; p
->handler
; ++p
)
3061 Lisp_Object new_value
;
3063 new_value
= textget (next_iv
->plist
, *p
->name
);
3064 if (!EQ (values_here
[p
->idx
], new_value
))
3072 if (!NULL_INTERVAL_P (next_iv
))
3074 if (INTEGERP (limit
)
3075 && next_iv
->position
>= XFASTINT (limit
))
3076 /* No text property change up to limit. */
3077 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3079 /* Text properties change in next_iv. */
3080 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3084 if (it
->cmp_it
.id
< 0)
3086 EMACS_INT stoppos
= it
->end_charpos
;
3088 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3090 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3091 stoppos
, it
->string
);
3094 xassert (STRINGP (it
->string
)
3095 || (it
->stop_charpos
>= BEGV
3096 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3100 /* Return the position of the next overlay change after POS in
3101 current_buffer. Value is point-max if no overlay change
3102 follows. This is like `next-overlay-change' but doesn't use
3106 next_overlay_change (EMACS_INT pos
)
3110 Lisp_Object
*overlays
;
3113 /* Get all overlays at the given position. */
3114 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3116 /* If any of these overlays ends before endpos,
3117 use its ending point instead. */
3118 for (i
= 0; i
< noverlays
; ++i
)
3123 oend
= OVERLAY_END (overlays
[i
]);
3124 oendpos
= OVERLAY_POSITION (oend
);
3125 endpos
= min (endpos
, oendpos
);
3133 /***********************************************************************
3135 ***********************************************************************/
3137 /* Handle changes in the `fontified' property of the current buffer by
3138 calling hook functions from Qfontification_functions to fontify
3141 static enum prop_handled
3142 handle_fontified_prop (struct it
*it
)
3144 Lisp_Object prop
, pos
;
3145 enum prop_handled handled
= HANDLED_NORMALLY
;
3147 if (!NILP (Vmemory_full
))
3150 /* Get the value of the `fontified' property at IT's current buffer
3151 position. (The `fontified' property doesn't have a special
3152 meaning in strings.) If the value is nil, call functions from
3153 Qfontification_functions. */
3154 if (!STRINGP (it
->string
)
3156 && !NILP (Vfontification_functions
)
3157 && !NILP (Vrun_hooks
)
3158 && (pos
= make_number (IT_CHARPOS (*it
)),
3159 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3160 /* Ignore the special cased nil value always present at EOB since
3161 no amount of fontifying will be able to change it. */
3162 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3164 int count
= SPECPDL_INDEX ();
3166 struct buffer
*obuf
= current_buffer
;
3167 int begv
= BEGV
, zv
= ZV
;
3168 int old_clip_changed
= current_buffer
->clip_changed
;
3170 val
= Vfontification_functions
;
3171 specbind (Qfontification_functions
, Qnil
);
3173 xassert (it
->end_charpos
== ZV
);
3175 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3176 safe_call1 (val
, pos
);
3179 Lisp_Object fns
, fn
;
3180 struct gcpro gcpro1
, gcpro2
;
3185 for (; CONSP (val
); val
= XCDR (val
))
3191 /* A value of t indicates this hook has a local
3192 binding; it means to run the global binding too.
3193 In a global value, t should not occur. If it
3194 does, we must ignore it to avoid an endless
3196 for (fns
= Fdefault_value (Qfontification_functions
);
3202 safe_call1 (fn
, pos
);
3206 safe_call1 (fn
, pos
);
3212 unbind_to (count
, Qnil
);
3214 /* Fontification functions routinely call `save-restriction'.
3215 Normally, this tags clip_changed, which can confuse redisplay
3216 (see discussion in Bug#6671). Since we don't perform any
3217 special handling of fontification changes in the case where
3218 `save-restriction' isn't called, there's no point doing so in
3219 this case either. So, if the buffer's restrictions are
3220 actually left unchanged, reset clip_changed. */
3221 if (obuf
== current_buffer
)
3223 if (begv
== BEGV
&& zv
== ZV
)
3224 current_buffer
->clip_changed
= old_clip_changed
;
3226 /* There isn't much we can reasonably do to protect against
3227 misbehaving fontification, but here's a fig leaf. */
3228 else if (!NILP (BVAR (obuf
, name
)))
3229 set_buffer_internal_1 (obuf
);
3231 /* The fontification code may have added/removed text.
3232 It could do even a lot worse, but let's at least protect against
3233 the most obvious case where only the text past `pos' gets changed',
3234 as is/was done in grep.el where some escapes sequences are turned
3235 into face properties (bug#7876). */
3236 it
->end_charpos
= ZV
;
3238 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3239 something. This avoids an endless loop if they failed to
3240 fontify the text for which reason ever. */
3241 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3242 handled
= HANDLED_RECOMPUTE_PROPS
;
3250 /***********************************************************************
3252 ***********************************************************************/
3254 /* Set up iterator IT from face properties at its current position.
3255 Called from handle_stop. */
3257 static enum prop_handled
3258 handle_face_prop (struct it
*it
)
3261 EMACS_INT next_stop
;
3263 if (!STRINGP (it
->string
))
3266 = face_at_buffer_position (it
->w
,
3268 it
->region_beg_charpos
,
3269 it
->region_end_charpos
,
3272 + TEXT_PROP_DISTANCE_LIMIT
),
3273 0, it
->base_face_id
);
3275 /* Is this a start of a run of characters with box face?
3276 Caveat: this can be called for a freshly initialized
3277 iterator; face_id is -1 in this case. We know that the new
3278 face will not change until limit, i.e. if the new face has a
3279 box, all characters up to limit will have one. But, as
3280 usual, we don't know whether limit is really the end. */
3281 if (new_face_id
!= it
->face_id
)
3283 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3285 /* If new face has a box but old face has not, this is
3286 the start of a run of characters with box, i.e. it has
3287 a shadow on the left side. The value of face_id of the
3288 iterator will be -1 if this is the initial call that gets
3289 the face. In this case, we have to look in front of IT's
3290 position and see whether there is a face != new_face_id. */
3291 it
->start_of_box_run_p
3292 = (new_face
->box
!= FACE_NO_BOX
3293 && (it
->face_id
>= 0
3294 || IT_CHARPOS (*it
) == BEG
3295 || new_face_id
!= face_before_it_pos (it
)));
3296 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3304 Lisp_Object from_overlay
3305 = (it
->current
.overlay_string_index
>= 0
3306 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3309 /* See if we got to this string directly or indirectly from
3310 an overlay property. That includes the before-string or
3311 after-string of an overlay, strings in display properties
3312 provided by an overlay, their text properties, etc.
3314 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3315 if (! NILP (from_overlay
))
3316 for (i
= it
->sp
- 1; i
>= 0; i
--)
3318 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3320 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3321 else if (! NILP (it
->stack
[i
].from_overlay
))
3322 from_overlay
= it
->stack
[i
].from_overlay
;
3324 if (!NILP (from_overlay
))
3328 if (! NILP (from_overlay
))
3330 bufpos
= IT_CHARPOS (*it
);
3331 /* For a string from an overlay, the base face depends
3332 only on text properties and ignores overlays. */
3334 = face_for_overlay_string (it
->w
,
3336 it
->region_beg_charpos
,
3337 it
->region_end_charpos
,
3340 + TEXT_PROP_DISTANCE_LIMIT
),
3348 /* For strings from a `display' property, use the face at
3349 IT's current buffer position as the base face to merge
3350 with, so that overlay strings appear in the same face as
3351 surrounding text, unless they specify their own
3353 base_face_id
= underlying_face_id (it
);
3356 new_face_id
= face_at_string_position (it
->w
,
3358 IT_STRING_CHARPOS (*it
),
3360 it
->region_beg_charpos
,
3361 it
->region_end_charpos
,
3365 /* Is this a start of a run of characters with box? Caveat:
3366 this can be called for a freshly allocated iterator; face_id
3367 is -1 is this case. We know that the new face will not
3368 change until the next check pos, i.e. if the new face has a
3369 box, all characters up to that position will have a
3370 box. But, as usual, we don't know whether that position
3371 is really the end. */
3372 if (new_face_id
!= it
->face_id
)
3374 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3375 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3377 /* If new face has a box but old face hasn't, this is the
3378 start of a run of characters with box, i.e. it has a
3379 shadow on the left side. */
3380 it
->start_of_box_run_p
3381 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3382 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3386 it
->face_id
= new_face_id
;
3387 return HANDLED_NORMALLY
;
3391 /* Return the ID of the face ``underlying'' IT's current position,
3392 which is in a string. If the iterator is associated with a
3393 buffer, return the face at IT's current buffer position.
3394 Otherwise, use the iterator's base_face_id. */
3397 underlying_face_id (struct it
*it
)
3399 int face_id
= it
->base_face_id
, i
;
3401 xassert (STRINGP (it
->string
));
3403 for (i
= it
->sp
- 1; i
>= 0; --i
)
3404 if (NILP (it
->stack
[i
].string
))
3405 face_id
= it
->stack
[i
].face_id
;
3411 /* Compute the face one character before or after the current position
3412 of IT. BEFORE_P non-zero means get the face in front of IT's
3413 position. Value is the id of the face. */
3416 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3419 EMACS_INT next_check_charpos
;
3420 struct text_pos pos
;
3422 xassert (it
->s
== NULL
);
3424 if (STRINGP (it
->string
))
3429 /* No face change past the end of the string (for the case
3430 we are padding with spaces). No face change before the
3432 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3433 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3436 /* Set pos to the position before or after IT's current position. */
3438 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3440 /* For composition, we must check the character after the
3442 pos
= (it
->what
== IT_COMPOSITION
3443 ? string_pos (IT_STRING_CHARPOS (*it
)
3444 + it
->cmp_it
.nchars
, it
->string
)
3445 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3447 if (it
->current
.overlay_string_index
>= 0)
3448 bufpos
= IT_CHARPOS (*it
);
3452 base_face_id
= underlying_face_id (it
);
3454 /* Get the face for ASCII, or unibyte. */
3455 face_id
= face_at_string_position (it
->w
,
3459 it
->region_beg_charpos
,
3460 it
->region_end_charpos
,
3461 &next_check_charpos
,
3464 /* Correct the face for charsets different from ASCII. Do it
3465 for the multibyte case only. The face returned above is
3466 suitable for unibyte text if IT->string is unibyte. */
3467 if (STRING_MULTIBYTE (it
->string
))
3469 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3471 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3473 c
= string_char_and_length (p
, &len
);
3474 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3479 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3480 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3483 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3484 pos
= it
->current
.pos
;
3487 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3490 if (it
->what
== IT_COMPOSITION
)
3491 /* For composition, we must check the position after the
3493 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3495 INC_TEXT_POS (pos
, it
->multibyte_p
);
3498 /* Determine face for CHARSET_ASCII, or unibyte. */
3499 face_id
= face_at_buffer_position (it
->w
,
3501 it
->region_beg_charpos
,
3502 it
->region_end_charpos
,
3503 &next_check_charpos
,
3506 /* Correct the face for charsets different from ASCII. Do it
3507 for the multibyte case only. The face returned above is
3508 suitable for unibyte text if current_buffer is unibyte. */
3509 if (it
->multibyte_p
)
3511 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3512 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3513 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3522 /***********************************************************************
3524 ***********************************************************************/
3526 /* Set up iterator IT from invisible properties at its current
3527 position. Called from handle_stop. */
3529 static enum prop_handled
3530 handle_invisible_prop (struct it
*it
)
3532 enum prop_handled handled
= HANDLED_NORMALLY
;
3534 if (STRINGP (it
->string
))
3536 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3538 /* Get the value of the invisible text property at the
3539 current position. Value will be nil if there is no such
3541 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3542 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3545 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3547 handled
= HANDLED_RECOMPUTE_PROPS
;
3549 /* Get the position at which the next change of the
3550 invisible text property can be found in IT->string.
3551 Value will be nil if the property value is the same for
3552 all the rest of IT->string. */
3553 XSETINT (limit
, SCHARS (it
->string
));
3554 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3557 /* Text at current position is invisible. The next
3558 change in the property is at position end_charpos.
3559 Move IT's current position to that position. */
3560 if (INTEGERP (end_charpos
)
3561 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3563 struct text_pos old
;
3564 old
= it
->current
.string_pos
;
3565 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3566 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3570 /* The rest of the string is invisible. If this is an
3571 overlay string, proceed with the next overlay string
3572 or whatever comes and return a character from there. */
3573 if (it
->current
.overlay_string_index
>= 0)
3575 next_overlay_string (it
);
3576 /* Don't check for overlay strings when we just
3577 finished processing them. */
3578 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3582 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3583 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3591 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3592 Lisp_Object pos
, prop
, overlay
;
3594 /* First of all, is there invisible text at this position? */
3595 tem
= start_charpos
= IT_CHARPOS (*it
);
3596 pos
= make_number (tem
);
3597 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3599 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3601 /* If we are on invisible text, skip over it. */
3602 if (invis_p
&& start_charpos
< it
->end_charpos
)
3604 /* Record whether we have to display an ellipsis for the
3606 int display_ellipsis_p
= invis_p
== 2;
3608 handled
= HANDLED_RECOMPUTE_PROPS
;
3610 /* Loop skipping over invisible text. The loop is left at
3611 ZV or with IT on the first char being visible again. */
3614 /* Try to skip some invisible text. Return value is the
3615 position reached which can be equal to where we start
3616 if there is nothing invisible there. This skips both
3617 over invisible text properties and overlays with
3618 invisible property. */
3619 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3621 /* If we skipped nothing at all we weren't at invisible
3622 text in the first place. If everything to the end of
3623 the buffer was skipped, end the loop. */
3624 if (newpos
== tem
|| newpos
>= ZV
)
3628 /* We skipped some characters but not necessarily
3629 all there are. Check if we ended up on visible
3630 text. Fget_char_property returns the property of
3631 the char before the given position, i.e. if we
3632 get invis_p = 0, this means that the char at
3633 newpos is visible. */
3634 pos
= make_number (newpos
);
3635 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3636 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3639 /* If we ended up on invisible text, proceed to
3640 skip starting with next_stop. */
3644 /* If there are adjacent invisible texts, don't lose the
3645 second one's ellipsis. */
3647 display_ellipsis_p
= 1;
3651 /* The position newpos is now either ZV or on visible text. */
3652 if (it
->bidi_p
&& newpos
< ZV
)
3654 /* With bidi iteration, the region of invisible text
3655 could start and/or end in the middle of a non-base
3656 embedding level. Therefore, we need to skip
3657 invisible text using the bidi iterator, starting at
3658 IT's current position, until we find ourselves
3659 outside the invisible text. Skipping invisible text
3660 _after_ bidi iteration avoids affecting the visual
3661 order of the displayed text when invisible properties
3662 are added or removed. */
3663 if (it
->bidi_it
.first_elt
)
3665 /* If we were `reseat'ed to a new paragraph,
3666 determine the paragraph base direction. We need
3667 to do it now because next_element_from_buffer may
3668 not have a chance to do it, if we are going to
3669 skip any text at the beginning, which resets the
3671 bidi_paragraph_init (it
->paragraph_embedding
,
3676 bidi_move_to_visually_next (&it
->bidi_it
);
3678 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3679 && it
->bidi_it
.charpos
< newpos
);
3680 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3681 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3682 /* If we overstepped NEWPOS, record its position in the
3683 iterator, so that we skip invisible text if later the
3684 bidi iteration lands us in the invisible region
3686 if (IT_CHARPOS (*it
) >= newpos
)
3687 it
->prev_stop
= newpos
;
3691 IT_CHARPOS (*it
) = newpos
;
3692 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3695 /* If there are before-strings at the start of invisible
3696 text, and the text is invisible because of a text
3697 property, arrange to show before-strings because 20.x did
3698 it that way. (If the text is invisible because of an
3699 overlay property instead of a text property, this is
3700 already handled in the overlay code.) */
3702 && get_overlay_strings (it
, it
->stop_charpos
))
3704 handled
= HANDLED_RECOMPUTE_PROPS
;
3705 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3707 else if (display_ellipsis_p
)
3709 /* Make sure that the glyphs of the ellipsis will get
3710 correct `charpos' values. If we would not update
3711 it->position here, the glyphs would belong to the
3712 last visible character _before_ the invisible
3713 text, which confuses `set_cursor_from_row'.
3715 We use the last invisible position instead of the
3716 first because this way the cursor is always drawn on
3717 the first "." of the ellipsis, whenever PT is inside
3718 the invisible text. Otherwise the cursor would be
3719 placed _after_ the ellipsis when the point is after the
3720 first invisible character. */
3721 if (!STRINGP (it
->object
))
3723 it
->position
.charpos
= newpos
- 1;
3724 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3727 /* Let the ellipsis display before
3728 considering any properties of the following char.
3729 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3730 handled
= HANDLED_RETURN
;
3739 /* Make iterator IT return `...' next.
3740 Replaces LEN characters from buffer. */
3743 setup_for_ellipsis (struct it
*it
, int len
)
3745 /* Use the display table definition for `...'. Invalid glyphs
3746 will be handled by the method returning elements from dpvec. */
3747 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3749 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3750 it
->dpvec
= v
->contents
;
3751 it
->dpend
= v
->contents
+ v
->size
;
3755 /* Default `...'. */
3756 it
->dpvec
= default_invis_vector
;
3757 it
->dpend
= default_invis_vector
+ 3;
3760 it
->dpvec_char_len
= len
;
3761 it
->current
.dpvec_index
= 0;
3762 it
->dpvec_face_id
= -1;
3764 /* Remember the current face id in case glyphs specify faces.
3765 IT's face is restored in set_iterator_to_next.
3766 saved_face_id was set to preceding char's face in handle_stop. */
3767 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3768 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3770 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3776 /***********************************************************************
3778 ***********************************************************************/
3780 /* Set up iterator IT from `display' property at its current position.
3781 Called from handle_stop.
3782 We return HANDLED_RETURN if some part of the display property
3783 overrides the display of the buffer text itself.
3784 Otherwise we return HANDLED_NORMALLY. */
3786 static enum prop_handled
3787 handle_display_prop (struct it
*it
)
3789 Lisp_Object prop
, object
, overlay
;
3790 struct text_pos
*position
;
3791 /* Nonzero if some property replaces the display of the text itself. */
3792 int display_replaced_p
= 0;
3794 if (STRINGP (it
->string
))
3796 object
= it
->string
;
3797 position
= &it
->current
.string_pos
;
3801 XSETWINDOW (object
, it
->w
);
3802 position
= &it
->current
.pos
;
3805 /* Reset those iterator values set from display property values. */
3806 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3807 it
->space_width
= Qnil
;
3808 it
->font_height
= Qnil
;
3811 /* We don't support recursive `display' properties, i.e. string
3812 values that have a string `display' property, that have a string
3813 `display' property etc. */
3814 if (!it
->string_from_display_prop_p
)
3815 it
->area
= TEXT_AREA
;
3817 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3818 Qdisplay
, object
, &overlay
);
3820 return HANDLED_NORMALLY
;
3821 /* Now OVERLAY is the overlay that gave us this property, or nil
3822 if it was a text property. */
3824 if (!STRINGP (it
->string
))
3825 object
= it
->w
->buffer
;
3828 /* Simple properties. */
3829 && !EQ (XCAR (prop
), Qimage
)
3830 && !EQ (XCAR (prop
), Qspace
)
3831 && !EQ (XCAR (prop
), Qwhen
)
3832 && !EQ (XCAR (prop
), Qslice
)
3833 && !EQ (XCAR (prop
), Qspace_width
)
3834 && !EQ (XCAR (prop
), Qheight
)
3835 && !EQ (XCAR (prop
), Qraise
)
3836 /* Marginal area specifications. */
3837 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3838 && !EQ (XCAR (prop
), Qleft_fringe
)
3839 && !EQ (XCAR (prop
), Qright_fringe
)
3840 && !NILP (XCAR (prop
)))
3842 for (; CONSP (prop
); prop
= XCDR (prop
))
3844 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3845 position
, display_replaced_p
))
3847 display_replaced_p
= 1;
3848 /* If some text in a string is replaced, `position' no
3849 longer points to the position of `object'. */
3850 if (STRINGP (object
))
3855 else if (VECTORP (prop
))
3858 for (i
= 0; i
< ASIZE (prop
); ++i
)
3859 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3860 position
, display_replaced_p
))
3862 display_replaced_p
= 1;
3863 /* If some text in a string is replaced, `position' no
3864 longer points to the position of `object'. */
3865 if (STRINGP (object
))
3871 if (handle_single_display_spec (it
, prop
, object
, overlay
,
3873 display_replaced_p
= 1;
3876 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3880 /* Value is the position of the end of the `display' property starting
3881 at START_POS in OBJECT. */
3883 static struct text_pos
3884 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3887 struct text_pos end_pos
;
3889 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3890 Qdisplay
, object
, Qnil
);
3891 CHARPOS (end_pos
) = XFASTINT (end
);
3892 if (STRINGP (object
))
3893 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3895 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3901 /* Set up IT from a single `display' specification PROP. OBJECT
3902 is the object in which the `display' property was found. *POSITION
3903 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3904 means that we previously saw a display specification which already
3905 replaced text display with something else, for example an image;
3906 we ignore such properties after the first one has been processed.
3908 OVERLAY is the overlay this `display' property came from,
3909 or nil if it was a text property.
3911 If PROP is a `space' or `image' specification, and in some other
3912 cases too, set *POSITION to the position where the `display'
3915 Value is non-zero if something was found which replaces the display
3916 of buffer or string text. */
3919 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3920 Lisp_Object overlay
, struct text_pos
*position
,
3921 int display_replaced_before_p
)
3924 Lisp_Object location
, value
;
3925 struct text_pos start_pos
, save_pos
;
3928 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
3929 If the result is non-nil, use VALUE instead of SPEC. */
3931 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
3940 if (!NILP (form
) && !EQ (form
, Qt
))
3942 int count
= SPECPDL_INDEX ();
3943 struct gcpro gcpro1
;
3945 /* Bind `object' to the object having the `display' property, a
3946 buffer or string. Bind `position' to the position in the
3947 object where the property was found, and `buffer-position'
3948 to the current position in the buffer. */
3949 specbind (Qobject
, object
);
3950 specbind (Qposition
, make_number (CHARPOS (*position
)));
3951 specbind (Qbuffer_position
,
3952 make_number (STRINGP (object
)
3953 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
3955 form
= safe_eval (form
);
3957 unbind_to (count
, Qnil
);
3963 /* Handle `(height HEIGHT)' specifications. */
3965 && EQ (XCAR (spec
), Qheight
)
3966 && CONSP (XCDR (spec
)))
3968 if (!FRAME_WINDOW_P (it
->f
))
3971 it
->font_height
= XCAR (XCDR (spec
));
3972 if (!NILP (it
->font_height
))
3974 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3975 int new_height
= -1;
3977 if (CONSP (it
->font_height
)
3978 && (EQ (XCAR (it
->font_height
), Qplus
)
3979 || EQ (XCAR (it
->font_height
), Qminus
))
3980 && CONSP (XCDR (it
->font_height
))
3981 && INTEGERP (XCAR (XCDR (it
->font_height
))))
3983 /* `(+ N)' or `(- N)' where N is an integer. */
3984 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
3985 if (EQ (XCAR (it
->font_height
), Qplus
))
3987 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
3989 else if (FUNCTIONP (it
->font_height
))
3991 /* Call function with current height as argument.
3992 Value is the new height. */
3994 height
= safe_call1 (it
->font_height
,
3995 face
->lface
[LFACE_HEIGHT_INDEX
]);
3996 if (NUMBERP (height
))
3997 new_height
= XFLOATINT (height
);
3999 else if (NUMBERP (it
->font_height
))
4001 /* Value is a multiple of the canonical char height. */
4004 f
= FACE_FROM_ID (it
->f
,
4005 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4006 new_height
= (XFLOATINT (it
->font_height
)
4007 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4011 /* Evaluate IT->font_height with `height' bound to the
4012 current specified height to get the new height. */
4013 int count
= SPECPDL_INDEX ();
4015 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4016 value
= safe_eval (it
->font_height
);
4017 unbind_to (count
, Qnil
);
4019 if (NUMBERP (value
))
4020 new_height
= XFLOATINT (value
);
4024 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4030 /* Handle `(space-width WIDTH)'. */
4032 && EQ (XCAR (spec
), Qspace_width
)
4033 && CONSP (XCDR (spec
)))
4035 if (!FRAME_WINDOW_P (it
->f
))
4038 value
= XCAR (XCDR (spec
));
4039 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4040 it
->space_width
= value
;
4045 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4047 && EQ (XCAR (spec
), Qslice
))
4051 if (!FRAME_WINDOW_P (it
->f
))
4054 if (tem
= XCDR (spec
), CONSP (tem
))
4056 it
->slice
.x
= XCAR (tem
);
4057 if (tem
= XCDR (tem
), CONSP (tem
))
4059 it
->slice
.y
= XCAR (tem
);
4060 if (tem
= XCDR (tem
), CONSP (tem
))
4062 it
->slice
.width
= XCAR (tem
);
4063 if (tem
= XCDR (tem
), CONSP (tem
))
4064 it
->slice
.height
= XCAR (tem
);
4072 /* Handle `(raise FACTOR)'. */
4074 && EQ (XCAR (spec
), Qraise
)
4075 && CONSP (XCDR (spec
)))
4077 if (!FRAME_WINDOW_P (it
->f
))
4080 #ifdef HAVE_WINDOW_SYSTEM
4081 value
= XCAR (XCDR (spec
));
4082 if (NUMBERP (value
))
4084 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4085 it
->voffset
= - (XFLOATINT (value
)
4086 * (FONT_HEIGHT (face
->font
)));
4088 #endif /* HAVE_WINDOW_SYSTEM */
4093 /* Don't handle the other kinds of display specifications
4094 inside a string that we got from a `display' property. */
4095 if (it
->string_from_display_prop_p
)
4098 /* Characters having this form of property are not displayed, so
4099 we have to find the end of the property. */
4100 start_pos
= *position
;
4101 *position
= display_prop_end (it
, object
, start_pos
);
4104 /* Stop the scan at that end position--we assume that all
4105 text properties change there. */
4106 it
->stop_charpos
= position
->charpos
;
4108 /* Handle `(left-fringe BITMAP [FACE])'
4109 and `(right-fringe BITMAP [FACE])'. */
4111 && (EQ (XCAR (spec
), Qleft_fringe
)
4112 || EQ (XCAR (spec
), Qright_fringe
))
4113 && CONSP (XCDR (spec
)))
4115 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4118 if (!FRAME_WINDOW_P (it
->f
))
4119 /* If we return here, POSITION has been advanced
4120 across the text with this property. */
4123 #ifdef HAVE_WINDOW_SYSTEM
4124 value
= XCAR (XCDR (spec
));
4125 if (!SYMBOLP (value
)
4126 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4127 /* If we return here, POSITION has been advanced
4128 across the text with this property. */
4131 if (CONSP (XCDR (XCDR (spec
))))
4133 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4134 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4140 /* Save current settings of IT so that we can restore them
4141 when we are finished with the glyph property value. */
4143 save_pos
= it
->position
;
4144 it
->position
= *position
;
4146 it
->position
= save_pos
;
4148 it
->area
= TEXT_AREA
;
4149 it
->what
= IT_IMAGE
;
4150 it
->image_id
= -1; /* no image */
4151 it
->position
= start_pos
;
4152 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4153 it
->method
= GET_FROM_IMAGE
;
4154 it
->from_overlay
= Qnil
;
4155 it
->face_id
= face_id
;
4157 /* Say that we haven't consumed the characters with
4158 `display' property yet. The call to pop_it in
4159 set_iterator_to_next will clean this up. */
4160 *position
= start_pos
;
4162 if (EQ (XCAR (spec
), Qleft_fringe
))
4164 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4165 it
->left_user_fringe_face_id
= face_id
;
4169 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4170 it
->right_user_fringe_face_id
= face_id
;
4172 #endif /* HAVE_WINDOW_SYSTEM */
4176 /* Prepare to handle `((margin left-margin) ...)',
4177 `((margin right-margin) ...)' and `((margin nil) ...)'
4178 prefixes for display specifications. */
4179 location
= Qunbound
;
4180 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4184 value
= XCDR (spec
);
4186 value
= XCAR (value
);
4189 if (EQ (XCAR (tem
), Qmargin
)
4190 && (tem
= XCDR (tem
),
4191 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4193 || EQ (tem
, Qleft_margin
)
4194 || EQ (tem
, Qright_margin
))))
4198 if (EQ (location
, Qunbound
))
4204 /* After this point, VALUE is the property after any
4205 margin prefix has been stripped. It must be a string,
4206 an image specification, or `(space ...)'.
4208 LOCATION specifies where to display: `left-margin',
4209 `right-margin' or nil. */
4211 valid_p
= (STRINGP (value
)
4212 #ifdef HAVE_WINDOW_SYSTEM
4213 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4214 #endif /* not HAVE_WINDOW_SYSTEM */
4215 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4217 if (valid_p
&& !display_replaced_before_p
)
4219 /* Save current settings of IT so that we can restore them
4220 when we are finished with the glyph property value. */
4221 save_pos
= it
->position
;
4222 it
->position
= *position
;
4224 it
->position
= save_pos
;
4225 it
->from_overlay
= overlay
;
4227 if (NILP (location
))
4228 it
->area
= TEXT_AREA
;
4229 else if (EQ (location
, Qleft_margin
))
4230 it
->area
= LEFT_MARGIN_AREA
;
4232 it
->area
= RIGHT_MARGIN_AREA
;
4234 if (STRINGP (value
))
4237 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4238 it
->current
.overlay_string_index
= -1;
4239 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4240 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4241 it
->method
= GET_FROM_STRING
;
4242 it
->stop_charpos
= 0;
4243 it
->string_from_display_prop_p
= 1;
4244 /* Say that we haven't consumed the characters with
4245 `display' property yet. The call to pop_it in
4246 set_iterator_to_next will clean this up. */
4247 if (BUFFERP (object
))
4248 *position
= start_pos
;
4250 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4252 it
->method
= GET_FROM_STRETCH
;
4254 *position
= it
->position
= start_pos
;
4256 #ifdef HAVE_WINDOW_SYSTEM
4259 it
->what
= IT_IMAGE
;
4260 it
->image_id
= lookup_image (it
->f
, value
);
4261 it
->position
= start_pos
;
4262 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4263 it
->method
= GET_FROM_IMAGE
;
4265 /* Say that we haven't consumed the characters with
4266 `display' property yet. The call to pop_it in
4267 set_iterator_to_next will clean this up. */
4268 *position
= start_pos
;
4270 #endif /* HAVE_WINDOW_SYSTEM */
4275 /* Invalid property or property not supported. Restore
4276 POSITION to what it was before. */
4277 *position
= start_pos
;
4282 /* Check if SPEC is a display sub-property value whose text should be
4283 treated as intangible. */
4286 single_display_spec_intangible_p (Lisp_Object prop
)
4288 /* Skip over `when FORM'. */
4289 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4303 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4304 we don't need to treat text as intangible. */
4305 if (EQ (XCAR (prop
), Qmargin
))
4313 || EQ (XCAR (prop
), Qleft_margin
)
4314 || EQ (XCAR (prop
), Qright_margin
))
4318 return (CONSP (prop
)
4319 && (EQ (XCAR (prop
), Qimage
)
4320 || EQ (XCAR (prop
), Qspace
)));
4324 /* Check if PROP is a display property value whose text should be
4325 treated as intangible. */
4328 display_prop_intangible_p (Lisp_Object prop
)
4331 && CONSP (XCAR (prop
))
4332 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4334 /* A list of sub-properties. */
4335 while (CONSP (prop
))
4337 if (single_display_spec_intangible_p (XCAR (prop
)))
4342 else if (VECTORP (prop
))
4344 /* A vector of sub-properties. */
4346 for (i
= 0; i
< ASIZE (prop
); ++i
)
4347 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4351 return single_display_spec_intangible_p (prop
);
4357 /* Return 1 if PROP is a display sub-property value containing STRING. */
4360 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4362 if (EQ (string
, prop
))
4365 /* Skip over `when FORM'. */
4366 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4375 /* Skip over `margin LOCATION'. */
4376 if (EQ (XCAR (prop
), Qmargin
))
4387 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4391 /* Return 1 if STRING appears in the `display' property PROP. */
4394 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4397 && CONSP (XCAR (prop
))
4398 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4400 /* A list of sub-properties. */
4401 while (CONSP (prop
))
4403 if (single_display_spec_string_p (XCAR (prop
), string
))
4408 else if (VECTORP (prop
))
4410 /* A vector of sub-properties. */
4412 for (i
= 0; i
< ASIZE (prop
); ++i
)
4413 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4417 return single_display_spec_string_p (prop
, string
);
4422 /* Look for STRING in overlays and text properties in the current
4423 buffer, between character positions FROM and TO (excluding TO).
4424 BACK_P non-zero means look back (in this case, TO is supposed to be
4426 Value is the first character position where STRING was found, or
4427 zero if it wasn't found before hitting TO.
4429 This function may only use code that doesn't eval because it is
4430 called asynchronously from note_mouse_highlight. */
4433 string_buffer_position_lim (Lisp_Object string
,
4434 EMACS_INT from
, EMACS_INT to
, int back_p
)
4436 Lisp_Object limit
, prop
, pos
;
4439 pos
= make_number (from
);
4441 if (!back_p
) /* looking forward */
4443 limit
= make_number (min (to
, ZV
));
4444 while (!found
&& !EQ (pos
, limit
))
4446 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4447 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4450 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4454 else /* looking back */
4456 limit
= make_number (max (to
, BEGV
));
4457 while (!found
&& !EQ (pos
, limit
))
4459 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4460 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4463 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4468 return found
? XINT (pos
) : 0;
4471 /* Determine which buffer position in current buffer STRING comes from.
4472 AROUND_CHARPOS is an approximate position where it could come from.
4473 Value is the buffer position or 0 if it couldn't be determined.
4475 This function is necessary because we don't record buffer positions
4476 in glyphs generated from strings (to keep struct glyph small).
4477 This function may only use code that doesn't eval because it is
4478 called asynchronously from note_mouse_highlight. */
4481 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4483 const int MAX_DISTANCE
= 1000;
4484 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4485 around_charpos
+ MAX_DISTANCE
,
4489 found
= string_buffer_position_lim (string
, around_charpos
,
4490 around_charpos
- MAX_DISTANCE
, 1);
4496 /***********************************************************************
4497 `composition' property
4498 ***********************************************************************/
4500 /* Set up iterator IT from `composition' property at its current
4501 position. Called from handle_stop. */
4503 static enum prop_handled
4504 handle_composition_prop (struct it
*it
)
4506 Lisp_Object prop
, string
;
4507 EMACS_INT pos
, pos_byte
, start
, end
;
4509 if (STRINGP (it
->string
))
4513 pos
= IT_STRING_CHARPOS (*it
);
4514 pos_byte
= IT_STRING_BYTEPOS (*it
);
4515 string
= it
->string
;
4516 s
= SDATA (string
) + pos_byte
;
4517 it
->c
= STRING_CHAR (s
);
4521 pos
= IT_CHARPOS (*it
);
4522 pos_byte
= IT_BYTEPOS (*it
);
4524 it
->c
= FETCH_CHAR (pos_byte
);
4527 /* If there's a valid composition and point is not inside of the
4528 composition (in the case that the composition is from the current
4529 buffer), draw a glyph composed from the composition components. */
4530 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4531 && COMPOSITION_VALID_P (start
, end
, prop
)
4532 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4536 if (STRINGP (it
->string
))
4537 pos_byte
= string_char_to_byte (it
->string
, start
);
4539 pos_byte
= CHAR_TO_BYTE (start
);
4541 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4544 if (it
->cmp_it
.id
>= 0)
4547 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4548 it
->cmp_it
.nglyphs
= -1;
4552 return HANDLED_NORMALLY
;
4557 /***********************************************************************
4559 ***********************************************************************/
4561 /* The following structure is used to record overlay strings for
4562 later sorting in load_overlay_strings. */
4564 struct overlay_entry
4566 Lisp_Object overlay
;
4573 /* Set up iterator IT from overlay strings at its current position.
4574 Called from handle_stop. */
4576 static enum prop_handled
4577 handle_overlay_change (struct it
*it
)
4579 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4580 return HANDLED_RECOMPUTE_PROPS
;
4582 return HANDLED_NORMALLY
;
4586 /* Set up the next overlay string for delivery by IT, if there is an
4587 overlay string to deliver. Called by set_iterator_to_next when the
4588 end of the current overlay string is reached. If there are more
4589 overlay strings to display, IT->string and
4590 IT->current.overlay_string_index are set appropriately here.
4591 Otherwise IT->string is set to nil. */
4594 next_overlay_string (struct it
*it
)
4596 ++it
->current
.overlay_string_index
;
4597 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4599 /* No more overlay strings. Restore IT's settings to what
4600 they were before overlay strings were processed, and
4601 continue to deliver from current_buffer. */
4603 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4606 || (NILP (it
->string
)
4607 && it
->method
== GET_FROM_BUFFER
4608 && it
->stop_charpos
>= BEGV
4609 && it
->stop_charpos
<= it
->end_charpos
));
4610 it
->current
.overlay_string_index
= -1;
4611 it
->n_overlay_strings
= 0;
4612 it
->overlay_strings_charpos
= -1;
4614 /* If we're at the end of the buffer, record that we have
4615 processed the overlay strings there already, so that
4616 next_element_from_buffer doesn't try it again. */
4617 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4618 it
->overlay_strings_at_end_processed_p
= 1;
4622 /* There are more overlay strings to process. If
4623 IT->current.overlay_string_index has advanced to a position
4624 where we must load IT->overlay_strings with more strings, do
4625 it. We must load at the IT->overlay_strings_charpos where
4626 IT->n_overlay_strings was originally computed; when invisible
4627 text is present, this might not be IT_CHARPOS (Bug#7016). */
4628 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4630 if (it
->current
.overlay_string_index
&& i
== 0)
4631 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4633 /* Initialize IT to deliver display elements from the overlay
4635 it
->string
= it
->overlay_strings
[i
];
4636 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4637 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4638 it
->method
= GET_FROM_STRING
;
4639 it
->stop_charpos
= 0;
4640 if (it
->cmp_it
.stop_pos
>= 0)
4641 it
->cmp_it
.stop_pos
= 0;
4648 /* Compare two overlay_entry structures E1 and E2. Used as a
4649 comparison function for qsort in load_overlay_strings. Overlay
4650 strings for the same position are sorted so that
4652 1. All after-strings come in front of before-strings, except
4653 when they come from the same overlay.
4655 2. Within after-strings, strings are sorted so that overlay strings
4656 from overlays with higher priorities come first.
4658 2. Within before-strings, strings are sorted so that overlay
4659 strings from overlays with higher priorities come last.
4661 Value is analogous to strcmp. */
4665 compare_overlay_entries (const void *e1
, const void *e2
)
4667 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4668 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4671 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4673 /* Let after-strings appear in front of before-strings if
4674 they come from different overlays. */
4675 if (EQ (entry1
->overlay
, entry2
->overlay
))
4676 result
= entry1
->after_string_p
? 1 : -1;
4678 result
= entry1
->after_string_p
? -1 : 1;
4680 else if (entry1
->after_string_p
)
4681 /* After-strings sorted in order of decreasing priority. */
4682 result
= entry2
->priority
- entry1
->priority
;
4684 /* Before-strings sorted in order of increasing priority. */
4685 result
= entry1
->priority
- entry2
->priority
;
4691 /* Load the vector IT->overlay_strings with overlay strings from IT's
4692 current buffer position, or from CHARPOS if that is > 0. Set
4693 IT->n_overlays to the total number of overlay strings found.
4695 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4696 a time. On entry into load_overlay_strings,
4697 IT->current.overlay_string_index gives the number of overlay
4698 strings that have already been loaded by previous calls to this
4701 IT->add_overlay_start contains an additional overlay start
4702 position to consider for taking overlay strings from, if non-zero.
4703 This position comes into play when the overlay has an `invisible'
4704 property, and both before and after-strings. When we've skipped to
4705 the end of the overlay, because of its `invisible' property, we
4706 nevertheless want its before-string to appear.
4707 IT->add_overlay_start will contain the overlay start position
4710 Overlay strings are sorted so that after-string strings come in
4711 front of before-string strings. Within before and after-strings,
4712 strings are sorted by overlay priority. See also function
4713 compare_overlay_entries. */
4716 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4718 Lisp_Object overlay
, window
, str
, invisible
;
4719 struct Lisp_Overlay
*ov
;
4720 EMACS_INT start
, end
;
4722 int n
= 0, i
, j
, invis_p
;
4723 struct overlay_entry
*entries
4724 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4727 charpos
= IT_CHARPOS (*it
);
4729 /* Append the overlay string STRING of overlay OVERLAY to vector
4730 `entries' which has size `size' and currently contains `n'
4731 elements. AFTER_P non-zero means STRING is an after-string of
4733 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4736 Lisp_Object priority; \
4740 int new_size = 2 * size; \
4741 struct overlay_entry *old = entries; \
4743 (struct overlay_entry *) alloca (new_size \
4744 * sizeof *entries); \
4745 memcpy (entries, old, size * sizeof *entries); \
4749 entries[n].string = (STRING); \
4750 entries[n].overlay = (OVERLAY); \
4751 priority = Foverlay_get ((OVERLAY), Qpriority); \
4752 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4753 entries[n].after_string_p = (AFTER_P); \
4758 /* Process overlay before the overlay center. */
4759 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4761 XSETMISC (overlay
, ov
);
4762 xassert (OVERLAYP (overlay
));
4763 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4764 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4769 /* Skip this overlay if it doesn't start or end at IT's current
4771 if (end
!= charpos
&& start
!= charpos
)
4774 /* Skip this overlay if it doesn't apply to IT->w. */
4775 window
= Foverlay_get (overlay
, Qwindow
);
4776 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4779 /* If the text ``under'' the overlay is invisible, both before-
4780 and after-strings from this overlay are visible; start and
4781 end position are indistinguishable. */
4782 invisible
= Foverlay_get (overlay
, Qinvisible
);
4783 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4785 /* If overlay has a non-empty before-string, record it. */
4786 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4787 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4789 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4791 /* If overlay has a non-empty after-string, record it. */
4792 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4793 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4795 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4798 /* Process overlays after the overlay center. */
4799 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4801 XSETMISC (overlay
, ov
);
4802 xassert (OVERLAYP (overlay
));
4803 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4804 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4806 if (start
> charpos
)
4809 /* Skip this overlay if it doesn't start or end at IT's current
4811 if (end
!= charpos
&& start
!= charpos
)
4814 /* Skip this overlay if it doesn't apply to IT->w. */
4815 window
= Foverlay_get (overlay
, Qwindow
);
4816 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4819 /* If the text ``under'' the overlay is invisible, it has a zero
4820 dimension, and both before- and after-strings apply. */
4821 invisible
= Foverlay_get (overlay
, Qinvisible
);
4822 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4824 /* If overlay has a non-empty before-string, record it. */
4825 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4826 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4828 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4830 /* If overlay has a non-empty after-string, record it. */
4831 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4832 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4834 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4837 #undef RECORD_OVERLAY_STRING
4841 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4843 /* Record number of overlay strings, and where we computed it. */
4844 it
->n_overlay_strings
= n
;
4845 it
->overlay_strings_charpos
= charpos
;
4847 /* IT->current.overlay_string_index is the number of overlay strings
4848 that have already been consumed by IT. Copy some of the
4849 remaining overlay strings to IT->overlay_strings. */
4851 j
= it
->current
.overlay_string_index
;
4852 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4854 it
->overlay_strings
[i
] = entries
[j
].string
;
4855 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4862 /* Get the first chunk of overlay strings at IT's current buffer
4863 position, or at CHARPOS if that is > 0. Value is non-zero if at
4864 least one overlay string was found. */
4867 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4869 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4870 process. This fills IT->overlay_strings with strings, and sets
4871 IT->n_overlay_strings to the total number of strings to process.
4872 IT->pos.overlay_string_index has to be set temporarily to zero
4873 because load_overlay_strings needs this; it must be set to -1
4874 when no overlay strings are found because a zero value would
4875 indicate a position in the first overlay string. */
4876 it
->current
.overlay_string_index
= 0;
4877 load_overlay_strings (it
, charpos
);
4879 /* If we found overlay strings, set up IT to deliver display
4880 elements from the first one. Otherwise set up IT to deliver
4881 from current_buffer. */
4882 if (it
->n_overlay_strings
)
4884 /* Make sure we know settings in current_buffer, so that we can
4885 restore meaningful values when we're done with the overlay
4888 compute_stop_pos (it
);
4889 xassert (it
->face_id
>= 0);
4891 /* Save IT's settings. They are restored after all overlay
4892 strings have been processed. */
4893 xassert (!compute_stop_p
|| it
->sp
== 0);
4895 /* When called from handle_stop, there might be an empty display
4896 string loaded. In that case, don't bother saving it. */
4897 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4900 /* Set up IT to deliver display elements from the first overlay
4902 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4903 it
->string
= it
->overlay_strings
[0];
4904 it
->from_overlay
= Qnil
;
4905 it
->stop_charpos
= 0;
4906 xassert (STRINGP (it
->string
));
4907 it
->end_charpos
= SCHARS (it
->string
);
4908 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4909 it
->method
= GET_FROM_STRING
;
4913 it
->current
.overlay_string_index
= -1;
4918 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4921 it
->method
= GET_FROM_BUFFER
;
4923 (void) get_overlay_strings_1 (it
, charpos
, 1);
4927 /* Value is non-zero if we found at least one overlay string. */
4928 return STRINGP (it
->string
);
4933 /***********************************************************************
4934 Saving and restoring state
4935 ***********************************************************************/
4937 /* Save current settings of IT on IT->stack. Called, for example,
4938 before setting up IT for an overlay string, to be able to restore
4939 IT's settings to what they were after the overlay string has been
4943 push_it (struct it
*it
)
4945 struct iterator_stack_entry
*p
;
4947 xassert (it
->sp
< IT_STACK_SIZE
);
4948 p
= it
->stack
+ it
->sp
;
4950 p
->stop_charpos
= it
->stop_charpos
;
4951 p
->prev_stop
= it
->prev_stop
;
4952 p
->base_level_stop
= it
->base_level_stop
;
4953 p
->cmp_it
= it
->cmp_it
;
4954 xassert (it
->face_id
>= 0);
4955 p
->face_id
= it
->face_id
;
4956 p
->string
= it
->string
;
4957 p
->method
= it
->method
;
4958 p
->from_overlay
= it
->from_overlay
;
4961 case GET_FROM_IMAGE
:
4962 p
->u
.image
.object
= it
->object
;
4963 p
->u
.image
.image_id
= it
->image_id
;
4964 p
->u
.image
.slice
= it
->slice
;
4966 case GET_FROM_STRETCH
:
4967 p
->u
.stretch
.object
= it
->object
;
4970 p
->position
= it
->position
;
4971 p
->current
= it
->current
;
4972 p
->end_charpos
= it
->end_charpos
;
4973 p
->string_nchars
= it
->string_nchars
;
4975 p
->multibyte_p
= it
->multibyte_p
;
4976 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
4977 p
->space_width
= it
->space_width
;
4978 p
->font_height
= it
->font_height
;
4979 p
->voffset
= it
->voffset
;
4980 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4981 p
->display_ellipsis_p
= 0;
4982 p
->line_wrap
= it
->line_wrap
;
4987 iterate_out_of_display_property (struct it
*it
)
4989 /* Maybe initialize paragraph direction. If we are at the beginning
4990 of a new paragraph, next_element_from_buffer may not have a
4991 chance to do that. */
4992 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4993 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
4994 /* prev_stop can be zero, so check against BEGV as well. */
4995 while (it
->bidi_it
.charpos
>= BEGV
4996 && it
->prev_stop
<= it
->bidi_it
.charpos
4997 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
4998 bidi_move_to_visually_next (&it
->bidi_it
);
4999 /* Record the stop_pos we just crossed, for when we cross it
5001 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5002 it
->prev_stop
= CHARPOS (it
->position
);
5003 /* If we ended up not where pop_it put us, resync IT's
5004 positional members with the bidi iterator. */
5005 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5007 SET_TEXT_POS (it
->position
,
5008 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5009 it
->current
.pos
= it
->position
;
5013 /* Restore IT's settings from IT->stack. Called, for example, when no
5014 more overlay strings must be processed, and we return to delivering
5015 display elements from a buffer, or when the end of a string from a
5016 `display' property is reached and we return to delivering display
5017 elements from an overlay string, or from a buffer. */
5020 pop_it (struct it
*it
)
5022 struct iterator_stack_entry
*p
;
5024 xassert (it
->sp
> 0);
5026 p
= it
->stack
+ it
->sp
;
5027 it
->stop_charpos
= p
->stop_charpos
;
5028 it
->prev_stop
= p
->prev_stop
;
5029 it
->base_level_stop
= p
->base_level_stop
;
5030 it
->cmp_it
= p
->cmp_it
;
5031 it
->face_id
= p
->face_id
;
5032 it
->current
= p
->current
;
5033 it
->position
= p
->position
;
5034 it
->string
= p
->string
;
5035 it
->from_overlay
= p
->from_overlay
;
5036 if (NILP (it
->string
))
5037 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5038 it
->method
= p
->method
;
5041 case GET_FROM_IMAGE
:
5042 it
->image_id
= p
->u
.image
.image_id
;
5043 it
->object
= p
->u
.image
.object
;
5044 it
->slice
= p
->u
.image
.slice
;
5046 case GET_FROM_STRETCH
:
5047 it
->object
= p
->u
.comp
.object
;
5049 case GET_FROM_BUFFER
:
5050 it
->object
= it
->w
->buffer
;
5053 /* Bidi-iterate until we get out of the portion of text, if
5054 any, covered by a `display' text property or an overlay
5055 with `display' property. (We cannot just jump there,
5056 because the internal coherency of the bidi iterator state
5057 can not be preserved across such jumps.) We also must
5058 determine the paragraph base direction if the overlay we
5059 just processed is at the beginning of a new
5061 iterate_out_of_display_property (it
);
5064 case GET_FROM_STRING
:
5065 it
->object
= it
->string
;
5067 case GET_FROM_DISPLAY_VECTOR
:
5069 it
->method
= GET_FROM_C_STRING
;
5070 else if (STRINGP (it
->string
))
5071 it
->method
= GET_FROM_STRING
;
5074 it
->method
= GET_FROM_BUFFER
;
5075 it
->object
= it
->w
->buffer
;
5078 it
->end_charpos
= p
->end_charpos
;
5079 it
->string_nchars
= p
->string_nchars
;
5081 it
->multibyte_p
= p
->multibyte_p
;
5082 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5083 it
->space_width
= p
->space_width
;
5084 it
->font_height
= p
->font_height
;
5085 it
->voffset
= p
->voffset
;
5086 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5087 it
->line_wrap
= p
->line_wrap
;
5092 /***********************************************************************
5094 ***********************************************************************/
5096 /* Set IT's current position to the previous line start. */
5099 back_to_previous_line_start (struct it
*it
)
5101 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5102 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5106 /* Move IT to the next line start.
5108 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5109 we skipped over part of the text (as opposed to moving the iterator
5110 continuously over the text). Otherwise, don't change the value
5113 Newlines may come from buffer text, overlay strings, or strings
5114 displayed via the `display' property. That's the reason we can't
5115 simply use find_next_newline_no_quit.
5117 Note that this function may not skip over invisible text that is so
5118 because of text properties and immediately follows a newline. If
5119 it would, function reseat_at_next_visible_line_start, when called
5120 from set_iterator_to_next, would effectively make invisible
5121 characters following a newline part of the wrong glyph row, which
5122 leads to wrong cursor motion. */
5125 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5127 int old_selective
, newline_found_p
, n
;
5128 const int MAX_NEWLINE_DISTANCE
= 500;
5130 /* If already on a newline, just consume it to avoid unintended
5131 skipping over invisible text below. */
5132 if (it
->what
== IT_CHARACTER
5134 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5136 set_iterator_to_next (it
, 0);
5141 /* Don't handle selective display in the following. It's (a)
5142 unnecessary because it's done by the caller, and (b) leads to an
5143 infinite recursion because next_element_from_ellipsis indirectly
5144 calls this function. */
5145 old_selective
= it
->selective
;
5148 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5149 from buffer text. */
5150 for (n
= newline_found_p
= 0;
5151 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5152 n
+= STRINGP (it
->string
) ? 0 : 1)
5154 if (!get_next_display_element (it
))
5156 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5157 set_iterator_to_next (it
, 0);
5160 /* If we didn't find a newline near enough, see if we can use a
5162 if (!newline_found_p
)
5164 EMACS_INT start
= IT_CHARPOS (*it
);
5165 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5168 xassert (!STRINGP (it
->string
));
5170 /* If there isn't any `display' property in sight, and no
5171 overlays, we can just use the position of the newline in
5173 if (it
->stop_charpos
>= limit
5174 || ((pos
= Fnext_single_property_change (make_number (start
),
5176 Qnil
, make_number (limit
)),
5178 && next_overlay_change (start
) == ZV
))
5180 IT_CHARPOS (*it
) = limit
;
5181 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5182 *skipped_p
= newline_found_p
= 1;
5186 while (get_next_display_element (it
)
5187 && !newline_found_p
)
5189 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5190 set_iterator_to_next (it
, 0);
5195 it
->selective
= old_selective
;
5196 return newline_found_p
;
5200 /* Set IT's current position to the previous visible line start. Skip
5201 invisible text that is so either due to text properties or due to
5202 selective display. Caution: this does not change IT->current_x and
5206 back_to_previous_visible_line_start (struct it
*it
)
5208 while (IT_CHARPOS (*it
) > BEGV
)
5210 back_to_previous_line_start (it
);
5212 if (IT_CHARPOS (*it
) <= BEGV
)
5215 /* If selective > 0, then lines indented more than its value are
5217 if (it
->selective
> 0
5218 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5219 (double) it
->selective
)) /* iftc */
5222 /* Check the newline before point for invisibility. */
5225 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5226 Qinvisible
, it
->window
);
5227 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5231 if (IT_CHARPOS (*it
) <= BEGV
)
5238 Lisp_Object val
, overlay
;
5240 /* If newline is part of a composition, continue from start of composition */
5241 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5242 && beg
< IT_CHARPOS (*it
))
5245 /* If newline is replaced by a display property, find start of overlay
5246 or interval and continue search from that point. */
5248 pos
= --IT_CHARPOS (it2
);
5251 it2
.string_from_display_prop_p
= 0;
5252 if (handle_display_prop (&it2
) == HANDLED_RETURN
5253 && !NILP (val
= get_char_property_and_overlay
5254 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5255 && (OVERLAYP (overlay
)
5256 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5257 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5260 /* Newline is not replaced by anything -- so we are done. */
5266 IT_CHARPOS (*it
) = beg
;
5267 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5271 it
->continuation_lines_width
= 0;
5273 xassert (IT_CHARPOS (*it
) >= BEGV
);
5274 xassert (IT_CHARPOS (*it
) == BEGV
5275 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5280 /* Reseat iterator IT at the previous visible line start. Skip
5281 invisible text that is so either due to text properties or due to
5282 selective display. At the end, update IT's overlay information,
5283 face information etc. */
5286 reseat_at_previous_visible_line_start (struct it
*it
)
5288 back_to_previous_visible_line_start (it
);
5289 reseat (it
, it
->current
.pos
, 1);
5294 /* Reseat iterator IT on the next visible line start in the current
5295 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5296 preceding the line start. Skip over invisible text that is so
5297 because of selective display. Compute faces, overlays etc at the
5298 new position. Note that this function does not skip over text that
5299 is invisible because of text properties. */
5302 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5304 int newline_found_p
, skipped_p
= 0;
5306 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5308 /* Skip over lines that are invisible because they are indented
5309 more than the value of IT->selective. */
5310 if (it
->selective
> 0)
5311 while (IT_CHARPOS (*it
) < ZV
5312 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5313 (double) it
->selective
)) /* iftc */
5315 xassert (IT_BYTEPOS (*it
) == BEGV
5316 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5317 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5320 /* Position on the newline if that's what's requested. */
5321 if (on_newline_p
&& newline_found_p
)
5323 if (STRINGP (it
->string
))
5325 if (IT_STRING_CHARPOS (*it
) > 0)
5327 --IT_STRING_CHARPOS (*it
);
5328 --IT_STRING_BYTEPOS (*it
);
5331 else if (IT_CHARPOS (*it
) > BEGV
)
5335 reseat (it
, it
->current
.pos
, 0);
5339 reseat (it
, it
->current
.pos
, 0);
5346 /***********************************************************************
5347 Changing an iterator's position
5348 ***********************************************************************/
5350 /* Change IT's current position to POS in current_buffer. If FORCE_P
5351 is non-zero, always check for text properties at the new position.
5352 Otherwise, text properties are only looked up if POS >=
5353 IT->check_charpos of a property. */
5356 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5358 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5360 reseat_1 (it
, pos
, 0);
5362 /* Determine where to check text properties. Avoid doing it
5363 where possible because text property lookup is very expensive. */
5365 || CHARPOS (pos
) > it
->stop_charpos
5366 || CHARPOS (pos
) < original_pos
)
5370 /* For bidi iteration, we need to prime prev_stop and
5371 base_level_stop with our best estimations. */
5372 if (CHARPOS (pos
) < it
->prev_stop
)
5374 handle_stop_backwards (it
, BEGV
);
5375 if (CHARPOS (pos
) < it
->base_level_stop
)
5376 it
->base_level_stop
= 0;
5378 else if (CHARPOS (pos
) > it
->stop_charpos
5379 && it
->stop_charpos
>= BEGV
)
5380 handle_stop_backwards (it
, it
->stop_charpos
);
5387 it
->prev_stop
= it
->base_level_stop
= 0;
5396 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5397 IT->stop_pos to POS, also. */
5400 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5402 /* Don't call this function when scanning a C string. */
5403 xassert (it
->s
== NULL
);
5405 /* POS must be a reasonable value. */
5406 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5408 it
->current
.pos
= it
->position
= pos
;
5409 it
->end_charpos
= ZV
;
5411 it
->current
.dpvec_index
= -1;
5412 it
->current
.overlay_string_index
= -1;
5413 IT_STRING_CHARPOS (*it
) = -1;
5414 IT_STRING_BYTEPOS (*it
) = -1;
5416 it
->string_from_display_prop_p
= 0;
5417 it
->method
= GET_FROM_BUFFER
;
5418 it
->object
= it
->w
->buffer
;
5419 it
->area
= TEXT_AREA
;
5420 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5422 it
->string_from_display_prop_p
= 0;
5423 it
->face_before_selective_p
= 0;
5426 it
->bidi_it
.first_elt
= 1;
5427 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5432 it
->stop_charpos
= CHARPOS (pos
);
5433 it
->base_level_stop
= CHARPOS (pos
);
5438 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5439 If S is non-null, it is a C string to iterate over. Otherwise,
5440 STRING gives a Lisp string to iterate over.
5442 If PRECISION > 0, don't return more then PRECISION number of
5443 characters from the string.
5445 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5446 characters have been returned. FIELD_WIDTH < 0 means an infinite
5449 MULTIBYTE = 0 means disable processing of multibyte characters,
5450 MULTIBYTE > 0 means enable it,
5451 MULTIBYTE < 0 means use IT->multibyte_p.
5453 IT must be initialized via a prior call to init_iterator before
5454 calling this function. */
5457 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5458 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5461 /* No region in strings. */
5462 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5464 /* No text property checks performed by default, but see below. */
5465 it
->stop_charpos
= -1;
5467 /* Set iterator position and end position. */
5468 memset (&it
->current
, 0, sizeof it
->current
);
5469 it
->current
.overlay_string_index
= -1;
5470 it
->current
.dpvec_index
= -1;
5471 xassert (charpos
>= 0);
5473 /* If STRING is specified, use its multibyteness, otherwise use the
5474 setting of MULTIBYTE, if specified. */
5476 it
->multibyte_p
= multibyte
> 0;
5480 xassert (STRINGP (string
));
5481 it
->string
= string
;
5483 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5484 it
->method
= GET_FROM_STRING
;
5485 it
->current
.string_pos
= string_pos (charpos
, string
);
5489 it
->s
= (const unsigned char *) s
;
5492 /* Note that we use IT->current.pos, not it->current.string_pos,
5493 for displaying C strings. */
5494 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5495 if (it
->multibyte_p
)
5497 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5498 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5502 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5503 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5506 it
->method
= GET_FROM_C_STRING
;
5509 /* PRECISION > 0 means don't return more than PRECISION characters
5511 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5512 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5514 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5515 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5516 FIELD_WIDTH < 0 means infinite field width. This is useful for
5517 padding with `-' at the end of a mode line. */
5518 if (field_width
< 0)
5519 field_width
= INFINITY
;
5520 if (field_width
> it
->end_charpos
- charpos
)
5521 it
->end_charpos
= charpos
+ field_width
;
5523 /* Use the standard display table for displaying strings. */
5524 if (DISP_TABLE_P (Vstandard_display_table
))
5525 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5527 it
->stop_charpos
= charpos
;
5528 if (s
== NULL
&& it
->multibyte_p
)
5530 EMACS_INT endpos
= SCHARS (it
->string
);
5531 if (endpos
> it
->end_charpos
)
5532 endpos
= it
->end_charpos
;
5533 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5541 /***********************************************************************
5543 ***********************************************************************/
5545 /* Map enum it_method value to corresponding next_element_from_* function. */
5547 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5549 next_element_from_buffer
,
5550 next_element_from_display_vector
,
5551 next_element_from_string
,
5552 next_element_from_c_string
,
5553 next_element_from_image
,
5554 next_element_from_stretch
5557 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5560 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5561 (possibly with the following characters). */
5563 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5564 ((IT)->cmp_it.id >= 0 \
5565 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5566 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5567 END_CHARPOS, (IT)->w, \
5568 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5572 /* Lookup the char-table Vglyphless_char_display for character C (-1
5573 if we want information for no-font case), and return the display
5574 method symbol. By side-effect, update it->what and
5575 it->glyphless_method. This function is called from
5576 get_next_display_element for each character element, and from
5577 x_produce_glyphs when no suitable font was found. */
5580 lookup_glyphless_char_display (int c
, struct it
*it
)
5582 Lisp_Object glyphless_method
= Qnil
;
5584 if (CHAR_TABLE_P (Vglyphless_char_display
)
5585 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5586 glyphless_method
= (c
>= 0
5587 ? CHAR_TABLE_REF (Vglyphless_char_display
, c
)
5588 : XCHAR_TABLE (Vglyphless_char_display
)->extras
[0]);
5590 if (NILP (glyphless_method
))
5593 /* The default is to display the character by a proper font. */
5595 /* The default for the no-font case is to display an empty box. */
5596 glyphless_method
= Qempty_box
;
5598 if (EQ (glyphless_method
, Qzero_width
))
5601 return glyphless_method
;
5602 /* This method can't be used for the no-font case. */
5603 glyphless_method
= Qempty_box
;
5605 if (EQ (glyphless_method
, Qthin_space
))
5606 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5607 else if (EQ (glyphless_method
, Qempty_box
))
5608 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5609 else if (EQ (glyphless_method
, Qhex_code
))
5610 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5611 else if (STRINGP (glyphless_method
))
5612 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5615 /* Invalid value. We use the default method. */
5616 glyphless_method
= Qnil
;
5619 it
->what
= IT_GLYPHLESS
;
5620 return glyphless_method
;
5623 /* Load IT's display element fields with information about the next
5624 display element from the current position of IT. Value is zero if
5625 end of buffer (or C string) is reached. */
5627 static struct frame
*last_escape_glyph_frame
= NULL
;
5628 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5629 static int last_escape_glyph_merged_face_id
= 0;
5631 struct frame
*last_glyphless_glyph_frame
= NULL
;
5632 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5633 int last_glyphless_glyph_merged_face_id
= 0;
5636 get_next_display_element (struct it
*it
)
5638 /* Non-zero means that we found a display element. Zero means that
5639 we hit the end of what we iterate over. Performance note: the
5640 function pointer `method' used here turns out to be faster than
5641 using a sequence of if-statements. */
5645 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5647 if (it
->what
== IT_CHARACTER
)
5649 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5650 and only if (a) the resolved directionality of that character
5652 /* FIXME: Do we need an exception for characters from display
5654 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5655 it
->c
= bidi_mirror_char (it
->c
);
5656 /* Map via display table or translate control characters.
5657 IT->c, IT->len etc. have been set to the next character by
5658 the function call above. If we have a display table, and it
5659 contains an entry for IT->c, translate it. Don't do this if
5660 IT->c itself comes from a display table, otherwise we could
5661 end up in an infinite recursion. (An alternative could be to
5662 count the recursion depth of this function and signal an
5663 error when a certain maximum depth is reached.) Is it worth
5665 if (success_p
&& it
->dpvec
== NULL
)
5668 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5669 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5670 nbsp_or_shy
= char_is_other
;
5671 int c
= it
->c
; /* This is the character to display. */
5673 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5675 xassert (SINGLE_BYTE_CHAR_P (c
));
5676 if (unibyte_display_via_language_environment
)
5678 c
= DECODE_CHAR (unibyte
, c
);
5680 c
= BYTE8_TO_CHAR (it
->c
);
5683 c
= BYTE8_TO_CHAR (it
->c
);
5687 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5690 struct Lisp_Vector
*v
= XVECTOR (dv
);
5692 /* Return the first character from the display table
5693 entry, if not empty. If empty, don't display the
5694 current character. */
5697 it
->dpvec_char_len
= it
->len
;
5698 it
->dpvec
= v
->contents
;
5699 it
->dpend
= v
->contents
+ v
->size
;
5700 it
->current
.dpvec_index
= 0;
5701 it
->dpvec_face_id
= -1;
5702 it
->saved_face_id
= it
->face_id
;
5703 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5708 set_iterator_to_next (it
, 0);
5713 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5715 if (it
->what
== IT_GLYPHLESS
)
5717 /* Don't display this character. */
5718 set_iterator_to_next (it
, 0);
5722 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5723 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5724 : c
== 0xAD ? char_is_soft_hyphen
5727 /* Translate control characters into `\003' or `^C' form.
5728 Control characters coming from a display table entry are
5729 currently not translated because we use IT->dpvec to hold
5730 the translation. This could easily be changed but I
5731 don't believe that it is worth doing.
5733 NBSP and SOFT-HYPEN are property translated too.
5735 Non-printable characters and raw-byte characters are also
5736 translated to octal form. */
5737 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5738 ? (it
->area
!= TEXT_AREA
5739 /* In mode line, treat \n, \t like other crl chars. */
5742 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5743 || (c
!= '\n' && c
!= '\t'))
5746 || ! CHAR_PRINTABLE_P (c
))))
5748 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5749 or a non-printable character which must be displayed
5750 either as '\003' or as `^C' where the '\\' and '^'
5751 can be defined in the display table. Fill
5752 IT->ctl_chars with glyphs for what we have to
5753 display. Then, set IT->dpvec to these glyphs. */
5756 int face_id
, lface_id
= 0 ;
5759 /* Handle control characters with ^. */
5761 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5765 g
= '^'; /* default glyph for Control */
5766 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5768 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5769 && GLYPH_CODE_CHAR_VALID_P (gc
))
5771 g
= GLYPH_CODE_CHAR (gc
);
5772 lface_id
= GLYPH_CODE_FACE (gc
);
5776 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5778 else if (it
->f
== last_escape_glyph_frame
5779 && it
->face_id
== last_escape_glyph_face_id
)
5781 face_id
= last_escape_glyph_merged_face_id
;
5785 /* Merge the escape-glyph face into the current face. */
5786 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5788 last_escape_glyph_frame
= it
->f
;
5789 last_escape_glyph_face_id
= it
->face_id
;
5790 last_escape_glyph_merged_face_id
= face_id
;
5793 XSETINT (it
->ctl_chars
[0], g
);
5794 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5796 goto display_control
;
5799 /* Handle non-break space in the mode where it only gets
5802 if (EQ (Vnobreak_char_display
, Qt
)
5803 && nbsp_or_shy
== char_is_nbsp
)
5805 /* Merge the no-break-space face into the current face. */
5806 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5810 XSETINT (it
->ctl_chars
[0], ' ');
5812 goto display_control
;
5815 /* Handle sequences that start with the "escape glyph". */
5817 /* the default escape glyph is \. */
5818 escape_glyph
= '\\';
5821 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5822 && GLYPH_CODE_CHAR_VALID_P (gc
))
5824 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5825 lface_id
= GLYPH_CODE_FACE (gc
);
5829 /* The display table specified a face.
5830 Merge it into face_id and also into escape_glyph. */
5831 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5834 else if (it
->f
== last_escape_glyph_frame
5835 && it
->face_id
== last_escape_glyph_face_id
)
5837 face_id
= last_escape_glyph_merged_face_id
;
5841 /* Merge the escape-glyph face into the current face. */
5842 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5844 last_escape_glyph_frame
= it
->f
;
5845 last_escape_glyph_face_id
= it
->face_id
;
5846 last_escape_glyph_merged_face_id
= face_id
;
5849 /* Handle soft hyphens in the mode where they only get
5852 if (EQ (Vnobreak_char_display
, Qt
)
5853 && nbsp_or_shy
== char_is_soft_hyphen
)
5855 XSETINT (it
->ctl_chars
[0], '-');
5857 goto display_control
;
5860 /* Handle non-break space and soft hyphen
5861 with the escape glyph. */
5865 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5866 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5867 XSETINT (it
->ctl_chars
[1], c
);
5869 goto display_control
;
5876 if (CHAR_BYTE8_P (c
))
5877 /* Display \200 instead of \17777600. */
5878 c
= CHAR_TO_BYTE8 (c
);
5879 len
= sprintf (str
, "%03o", c
);
5881 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5882 for (i
= 0; i
< len
; i
++)
5883 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5888 /* Set up IT->dpvec and return first character from it. */
5889 it
->dpvec_char_len
= it
->len
;
5890 it
->dpvec
= it
->ctl_chars
;
5891 it
->dpend
= it
->dpvec
+ ctl_len
;
5892 it
->current
.dpvec_index
= 0;
5893 it
->dpvec_face_id
= face_id
;
5894 it
->saved_face_id
= it
->face_id
;
5895 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5899 it
->char_to_display
= c
;
5903 it
->char_to_display
= it
->c
;
5907 #ifdef HAVE_WINDOW_SYSTEM
5908 /* Adjust face id for a multibyte character. There are no multibyte
5909 character in unibyte text. */
5910 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5913 && FRAME_WINDOW_P (it
->f
))
5915 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5917 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5919 /* Automatic composition with glyph-string. */
5920 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5922 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5926 EMACS_INT pos
= (it
->s
? -1
5927 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5928 : IT_CHARPOS (*it
));
5930 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
5937 /* Is this character the last one of a run of characters with
5938 box? If yes, set IT->end_of_box_run_p to 1. */
5942 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5944 int face_id
= underlying_face_id (it
);
5945 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5949 if (face
->box
== FACE_NO_BOX
)
5951 /* If the box comes from face properties in a
5952 display string, check faces in that string. */
5953 int string_face_id
= face_after_it_pos (it
);
5954 it
->end_of_box_run_p
5955 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5958 /* Otherwise, the box comes from the underlying face.
5959 If this is the last string character displayed, check
5960 the next buffer location. */
5961 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5962 && (it
->current
.overlay_string_index
5963 == it
->n_overlay_strings
- 1))
5967 struct text_pos pos
= it
->current
.pos
;
5968 INC_TEXT_POS (pos
, it
->multibyte_p
);
5970 next_face_id
= face_at_buffer_position
5971 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5972 it
->region_end_charpos
, &ignore
,
5973 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5975 it
->end_of_box_run_p
5976 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5983 int face_id
= face_after_it_pos (it
);
5984 it
->end_of_box_run_p
5985 = (face_id
!= it
->face_id
5986 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5990 /* Value is 0 if end of buffer or string reached. */
5995 /* Move IT to the next display element.
5997 RESEAT_P non-zero means if called on a newline in buffer text,
5998 skip to the next visible line start.
6000 Functions get_next_display_element and set_iterator_to_next are
6001 separate because I find this arrangement easier to handle than a
6002 get_next_display_element function that also increments IT's
6003 position. The way it is we can first look at an iterator's current
6004 display element, decide whether it fits on a line, and if it does,
6005 increment the iterator position. The other way around we probably
6006 would either need a flag indicating whether the iterator has to be
6007 incremented the next time, or we would have to implement a
6008 decrement position function which would not be easy to write. */
6011 set_iterator_to_next (struct it
*it
, int reseat_p
)
6013 /* Reset flags indicating start and end of a sequence of characters
6014 with box. Reset them at the start of this function because
6015 moving the iterator to a new position might set them. */
6016 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6020 case GET_FROM_BUFFER
:
6021 /* The current display element of IT is a character from
6022 current_buffer. Advance in the buffer, and maybe skip over
6023 invisible lines that are so because of selective display. */
6024 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6025 reseat_at_next_visible_line_start (it
, 0);
6026 else if (it
->cmp_it
.id
>= 0)
6028 /* We are currently getting glyphs from a composition. */
6033 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6034 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6035 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6037 it
->cmp_it
.from
= it
->cmp_it
.to
;
6042 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6044 it
->end_charpos
, Qnil
);
6047 else if (! it
->cmp_it
.reversed_p
)
6049 /* Composition created while scanning forward. */
6050 /* Update IT's char/byte positions to point to the first
6051 character of the next grapheme cluster, or to the
6052 character visually after the current composition. */
6053 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6054 bidi_move_to_visually_next (&it
->bidi_it
);
6055 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6056 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6058 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6060 /* Proceed to the next grapheme cluster. */
6061 it
->cmp_it
.from
= it
->cmp_it
.to
;
6065 /* No more grapheme clusters in this composition.
6066 Find the next stop position. */
6067 EMACS_INT stop
= it
->end_charpos
;
6068 if (it
->bidi_it
.scan_dir
< 0)
6069 /* Now we are scanning backward and don't know
6072 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6073 IT_BYTEPOS (*it
), stop
, Qnil
);
6078 /* Composition created while scanning backward. */
6079 /* Update IT's char/byte positions to point to the last
6080 character of the previous grapheme cluster, or the
6081 character visually after the current composition. */
6082 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6083 bidi_move_to_visually_next (&it
->bidi_it
);
6084 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6085 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6086 if (it
->cmp_it
.from
> 0)
6088 /* Proceed to the previous grapheme cluster. */
6089 it
->cmp_it
.to
= it
->cmp_it
.from
;
6093 /* No more grapheme clusters in this composition.
6094 Find the next stop position. */
6095 EMACS_INT stop
= it
->end_charpos
;
6096 if (it
->bidi_it
.scan_dir
< 0)
6097 /* Now we are scanning backward and don't know
6100 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6101 IT_BYTEPOS (*it
), stop
, Qnil
);
6107 xassert (it
->len
!= 0);
6111 IT_BYTEPOS (*it
) += it
->len
;
6112 IT_CHARPOS (*it
) += 1;
6116 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6117 /* If this is a new paragraph, determine its base
6118 direction (a.k.a. its base embedding level). */
6119 if (it
->bidi_it
.new_paragraph
)
6120 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6121 bidi_move_to_visually_next (&it
->bidi_it
);
6122 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6123 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6124 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6126 /* As the scan direction was changed, we must
6127 re-compute the stop position for composition. */
6128 EMACS_INT stop
= it
->end_charpos
;
6129 if (it
->bidi_it
.scan_dir
< 0)
6131 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6132 IT_BYTEPOS (*it
), stop
, Qnil
);
6135 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6139 case GET_FROM_C_STRING
:
6140 /* Current display element of IT is from a C string. */
6141 IT_BYTEPOS (*it
) += it
->len
;
6142 IT_CHARPOS (*it
) += 1;
6145 case GET_FROM_DISPLAY_VECTOR
:
6146 /* Current display element of IT is from a display table entry.
6147 Advance in the display table definition. Reset it to null if
6148 end reached, and continue with characters from buffers/
6150 ++it
->current
.dpvec_index
;
6152 /* Restore face of the iterator to what they were before the
6153 display vector entry (these entries may contain faces). */
6154 it
->face_id
= it
->saved_face_id
;
6156 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6158 int recheck_faces
= it
->ellipsis_p
;
6161 it
->method
= GET_FROM_C_STRING
;
6162 else if (STRINGP (it
->string
))
6163 it
->method
= GET_FROM_STRING
;
6166 it
->method
= GET_FROM_BUFFER
;
6167 it
->object
= it
->w
->buffer
;
6171 it
->current
.dpvec_index
= -1;
6173 /* Skip over characters which were displayed via IT->dpvec. */
6174 if (it
->dpvec_char_len
< 0)
6175 reseat_at_next_visible_line_start (it
, 1);
6176 else if (it
->dpvec_char_len
> 0)
6178 if (it
->method
== GET_FROM_STRING
6179 && it
->n_overlay_strings
> 0)
6180 it
->ignore_overlay_strings_at_pos_p
= 1;
6181 it
->len
= it
->dpvec_char_len
;
6182 set_iterator_to_next (it
, reseat_p
);
6185 /* Maybe recheck faces after display vector */
6187 it
->stop_charpos
= IT_CHARPOS (*it
);
6191 case GET_FROM_STRING
:
6192 /* Current display element is a character from a Lisp string. */
6193 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6194 if (it
->cmp_it
.id
>= 0)
6196 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6197 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6198 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6199 it
->cmp_it
.from
= it
->cmp_it
.to
;
6203 composition_compute_stop_pos (&it
->cmp_it
,
6204 IT_STRING_CHARPOS (*it
),
6205 IT_STRING_BYTEPOS (*it
),
6206 it
->end_charpos
, it
->string
);
6211 IT_STRING_BYTEPOS (*it
) += it
->len
;
6212 IT_STRING_CHARPOS (*it
) += 1;
6215 consider_string_end
:
6217 if (it
->current
.overlay_string_index
>= 0)
6219 /* IT->string is an overlay string. Advance to the
6220 next, if there is one. */
6221 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6224 next_overlay_string (it
);
6226 setup_for_ellipsis (it
, 0);
6231 /* IT->string is not an overlay string. If we reached
6232 its end, and there is something on IT->stack, proceed
6233 with what is on the stack. This can be either another
6234 string, this time an overlay string, or a buffer. */
6235 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6239 if (it
->method
== GET_FROM_STRING
)
6240 goto consider_string_end
;
6245 case GET_FROM_IMAGE
:
6246 case GET_FROM_STRETCH
:
6247 /* The position etc with which we have to proceed are on
6248 the stack. The position may be at the end of a string,
6249 if the `display' property takes up the whole string. */
6250 xassert (it
->sp
> 0);
6252 if (it
->method
== GET_FROM_STRING
)
6253 goto consider_string_end
;
6257 /* There are no other methods defined, so this should be a bug. */
6261 xassert (it
->method
!= GET_FROM_STRING
6262 || (STRINGP (it
->string
)
6263 && IT_STRING_CHARPOS (*it
) >= 0));
6266 /* Load IT's display element fields with information about the next
6267 display element which comes from a display table entry or from the
6268 result of translating a control character to one of the forms `^C'
6271 IT->dpvec holds the glyphs to return as characters.
6272 IT->saved_face_id holds the face id before the display vector--it
6273 is restored into IT->face_id in set_iterator_to_next. */
6276 next_element_from_display_vector (struct it
*it
)
6281 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6283 it
->face_id
= it
->saved_face_id
;
6285 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6286 That seemed totally bogus - so I changed it... */
6287 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6289 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6291 it
->c
= GLYPH_CODE_CHAR (gc
);
6292 it
->len
= CHAR_BYTES (it
->c
);
6294 /* The entry may contain a face id to use. Such a face id is
6295 the id of a Lisp face, not a realized face. A face id of
6296 zero means no face is specified. */
6297 if (it
->dpvec_face_id
>= 0)
6298 it
->face_id
= it
->dpvec_face_id
;
6301 int lface_id
= GLYPH_CODE_FACE (gc
);
6303 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6308 /* Display table entry is invalid. Return a space. */
6309 it
->c
= ' ', it
->len
= 1;
6311 /* Don't change position and object of the iterator here. They are
6312 still the values of the character that had this display table
6313 entry or was translated, and that's what we want. */
6314 it
->what
= IT_CHARACTER
;
6319 /* Load IT with the next display element from Lisp string IT->string.
6320 IT->current.string_pos is the current position within the string.
6321 If IT->current.overlay_string_index >= 0, the Lisp string is an
6325 next_element_from_string (struct it
*it
)
6327 struct text_pos position
;
6329 xassert (STRINGP (it
->string
));
6330 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6331 position
= it
->current
.string_pos
;
6333 /* Time to check for invisible text? */
6334 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6335 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6339 /* Since a handler may have changed IT->method, we must
6341 return GET_NEXT_DISPLAY_ELEMENT (it
);
6344 if (it
->current
.overlay_string_index
>= 0)
6346 /* Get the next character from an overlay string. In overlay
6347 strings, There is no field width or padding with spaces to
6349 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6354 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6355 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6356 && next_element_from_composition (it
))
6360 else if (STRING_MULTIBYTE (it
->string
))
6362 const unsigned char *s
= (SDATA (it
->string
)
6363 + IT_STRING_BYTEPOS (*it
));
6364 it
->c
= string_char_and_length (s
, &it
->len
);
6368 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6374 /* Get the next character from a Lisp string that is not an
6375 overlay string. Such strings come from the mode line, for
6376 example. We may have to pad with spaces, or truncate the
6377 string. See also next_element_from_c_string. */
6378 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6383 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6385 /* Pad with spaces. */
6386 it
->c
= ' ', it
->len
= 1;
6387 CHARPOS (position
) = BYTEPOS (position
) = -1;
6389 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6390 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6391 && next_element_from_composition (it
))
6395 else if (STRING_MULTIBYTE (it
->string
))
6397 const unsigned char *s
= (SDATA (it
->string
)
6398 + IT_STRING_BYTEPOS (*it
));
6399 it
->c
= string_char_and_length (s
, &it
->len
);
6403 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6408 /* Record what we have and where it came from. */
6409 it
->what
= IT_CHARACTER
;
6410 it
->object
= it
->string
;
6411 it
->position
= position
;
6416 /* Load IT with next display element from C string IT->s.
6417 IT->string_nchars is the maximum number of characters to return
6418 from the string. IT->end_charpos may be greater than
6419 IT->string_nchars when this function is called, in which case we
6420 may have to return padding spaces. Value is zero if end of string
6421 reached, including padding spaces. */
6424 next_element_from_c_string (struct it
*it
)
6429 it
->what
= IT_CHARACTER
;
6430 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6433 /* IT's position can be greater IT->string_nchars in case a field
6434 width or precision has been specified when the iterator was
6436 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6438 /* End of the game. */
6442 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6444 /* Pad with spaces. */
6445 it
->c
= ' ', it
->len
= 1;
6446 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6448 else if (it
->multibyte_p
)
6449 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6451 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6457 /* Set up IT to return characters from an ellipsis, if appropriate.
6458 The definition of the ellipsis glyphs may come from a display table
6459 entry. This function fills IT with the first glyph from the
6460 ellipsis if an ellipsis is to be displayed. */
6463 next_element_from_ellipsis (struct it
*it
)
6465 if (it
->selective_display_ellipsis_p
)
6466 setup_for_ellipsis (it
, it
->len
);
6469 /* The face at the current position may be different from the
6470 face we find after the invisible text. Remember what it
6471 was in IT->saved_face_id, and signal that it's there by
6472 setting face_before_selective_p. */
6473 it
->saved_face_id
= it
->face_id
;
6474 it
->method
= GET_FROM_BUFFER
;
6475 it
->object
= it
->w
->buffer
;
6476 reseat_at_next_visible_line_start (it
, 1);
6477 it
->face_before_selective_p
= 1;
6480 return GET_NEXT_DISPLAY_ELEMENT (it
);
6484 /* Deliver an image display element. The iterator IT is already
6485 filled with image information (done in handle_display_prop). Value
6490 next_element_from_image (struct it
*it
)
6492 it
->what
= IT_IMAGE
;
6493 it
->ignore_overlay_strings_at_pos_p
= 0;
6498 /* Fill iterator IT with next display element from a stretch glyph
6499 property. IT->object is the value of the text property. Value is
6503 next_element_from_stretch (struct it
*it
)
6505 it
->what
= IT_STRETCH
;
6509 /* Scan forward from CHARPOS in the current buffer, until we find a
6510 stop position > current IT's position. Then handle the stop
6511 position before that. This is called when we bump into a stop
6512 position while reordering bidirectional text. CHARPOS should be
6513 the last previously processed stop_pos (or BEGV, if none were
6514 processed yet) whose position is less that IT's current
6518 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6520 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6521 struct display_pos save_current
= it
->current
;
6522 struct text_pos save_position
= it
->position
;
6523 struct text_pos pos1
;
6524 EMACS_INT next_stop
;
6526 /* Scan in strict logical order. */
6530 it
->prev_stop
= charpos
;
6531 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6532 reseat_1 (it
, pos1
, 0);
6533 compute_stop_pos (it
);
6534 /* We must advance forward, right? */
6535 if (it
->stop_charpos
<= it
->prev_stop
)
6537 charpos
= it
->stop_charpos
;
6539 while (charpos
<= where_we_are
);
6541 next_stop
= it
->stop_charpos
;
6542 it
->stop_charpos
= it
->prev_stop
;
6544 it
->current
= save_current
;
6545 it
->position
= save_position
;
6547 it
->stop_charpos
= next_stop
;
6550 /* Load IT with the next display element from current_buffer. Value
6551 is zero if end of buffer reached. IT->stop_charpos is the next
6552 position at which to stop and check for text properties or buffer
6556 next_element_from_buffer (struct it
*it
)
6560 xassert (IT_CHARPOS (*it
) >= BEGV
);
6562 /* With bidi reordering, the character to display might not be the
6563 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6564 we were reseat()ed to a new buffer position, which is potentially
6565 a different paragraph. */
6566 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6568 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6569 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6570 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6572 /* Nothing to do, but reset the FIRST_ELT flag, like
6573 bidi_paragraph_init does, because we are not going to
6575 it
->bidi_it
.first_elt
= 0;
6577 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6578 /* FIXME: Should support all Unicode line separators. */
6579 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6580 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6582 /* If we are at the beginning of a line, we can produce the
6583 next element right away. */
6584 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6585 bidi_move_to_visually_next (&it
->bidi_it
);
6589 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6591 /* We need to prime the bidi iterator starting at the line's
6592 beginning, before we will be able to produce the next
6594 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6595 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6596 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6597 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6598 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6601 /* Now return to buffer position where we were asked to
6602 get the next display element, and produce that. */
6603 bidi_move_to_visually_next (&it
->bidi_it
);
6605 while (it
->bidi_it
.bytepos
!= orig_bytepos
6606 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6609 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6610 /* Adjust IT's position information to where we ended up. */
6611 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6612 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6613 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6615 EMACS_INT stop
= it
->end_charpos
;
6616 if (it
->bidi_it
.scan_dir
< 0)
6618 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6619 IT_BYTEPOS (*it
), stop
, Qnil
);
6623 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6625 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6627 int overlay_strings_follow_p
;
6629 /* End of the game, except when overlay strings follow that
6630 haven't been returned yet. */
6631 if (it
->overlay_strings_at_end_processed_p
)
6632 overlay_strings_follow_p
= 0;
6635 it
->overlay_strings_at_end_processed_p
= 1;
6636 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6639 if (overlay_strings_follow_p
)
6640 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6644 it
->position
= it
->current
.pos
;
6648 else if (!(!it
->bidi_p
6649 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6650 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6652 /* With bidi non-linear iteration, we could find ourselves
6653 far beyond the last computed stop_charpos, with several
6654 other stop positions in between that we missed. Scan
6655 them all now, in buffer's logical order, until we find
6656 and handle the last stop_charpos that precedes our
6657 current position. */
6658 handle_stop_backwards (it
, it
->stop_charpos
);
6659 return GET_NEXT_DISPLAY_ELEMENT (it
);
6665 /* Take note of the stop position we just moved across,
6666 for when we will move back across it. */
6667 it
->prev_stop
= it
->stop_charpos
;
6668 /* If we are at base paragraph embedding level, take
6669 note of the last stop position seen at this
6671 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6672 it
->base_level_stop
= it
->stop_charpos
;
6675 return GET_NEXT_DISPLAY_ELEMENT (it
);
6679 /* We can sometimes back up for reasons that have nothing
6680 to do with bidi reordering. E.g., compositions. The
6681 code below is only needed when we are above the base
6682 embedding level, so test for that explicitly. */
6683 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6684 && IT_CHARPOS (*it
) < it
->prev_stop
)
6686 if (it
->base_level_stop
<= 0)
6687 it
->base_level_stop
= BEGV
;
6688 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6690 handle_stop_backwards (it
, it
->base_level_stop
);
6691 return GET_NEXT_DISPLAY_ELEMENT (it
);
6695 /* No face changes, overlays etc. in sight, so just return a
6696 character from current_buffer. */
6700 /* Maybe run the redisplay end trigger hook. Performance note:
6701 This doesn't seem to cost measurable time. */
6702 if (it
->redisplay_end_trigger_charpos
6704 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6705 run_redisplay_end_trigger_hook (it
);
6707 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6708 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6710 && next_element_from_composition (it
))
6715 /* Get the next character, maybe multibyte. */
6716 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6717 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6718 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6720 it
->c
= *p
, it
->len
= 1;
6722 /* Record what we have and where it came from. */
6723 it
->what
= IT_CHARACTER
;
6724 it
->object
= it
->w
->buffer
;
6725 it
->position
= it
->current
.pos
;
6727 /* Normally we return the character found above, except when we
6728 really want to return an ellipsis for selective display. */
6733 /* A value of selective > 0 means hide lines indented more
6734 than that number of columns. */
6735 if (it
->selective
> 0
6736 && IT_CHARPOS (*it
) + 1 < ZV
6737 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6738 IT_BYTEPOS (*it
) + 1,
6739 (double) it
->selective
)) /* iftc */
6741 success_p
= next_element_from_ellipsis (it
);
6742 it
->dpvec_char_len
= -1;
6745 else if (it
->c
== '\r' && it
->selective
== -1)
6747 /* A value of selective == -1 means that everything from the
6748 CR to the end of the line is invisible, with maybe an
6749 ellipsis displayed for it. */
6750 success_p
= next_element_from_ellipsis (it
);
6751 it
->dpvec_char_len
= -1;
6756 /* Value is zero if end of buffer reached. */
6757 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6762 /* Run the redisplay end trigger hook for IT. */
6765 run_redisplay_end_trigger_hook (struct it
*it
)
6767 Lisp_Object args
[3];
6769 /* IT->glyph_row should be non-null, i.e. we should be actually
6770 displaying something, or otherwise we should not run the hook. */
6771 xassert (it
->glyph_row
);
6773 /* Set up hook arguments. */
6774 args
[0] = Qredisplay_end_trigger_functions
;
6775 args
[1] = it
->window
;
6776 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6777 it
->redisplay_end_trigger_charpos
= 0;
6779 /* Since we are *trying* to run these functions, don't try to run
6780 them again, even if they get an error. */
6781 it
->w
->redisplay_end_trigger
= Qnil
;
6782 Frun_hook_with_args (3, args
);
6784 /* Notice if it changed the face of the character we are on. */
6785 handle_face_prop (it
);
6789 /* Deliver a composition display element. Unlike the other
6790 next_element_from_XXX, this function is not registered in the array
6791 get_next_element[]. It is called from next_element_from_buffer and
6792 next_element_from_string when necessary. */
6795 next_element_from_composition (struct it
*it
)
6797 it
->what
= IT_COMPOSITION
;
6798 it
->len
= it
->cmp_it
.nbytes
;
6799 if (STRINGP (it
->string
))
6803 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6804 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6807 it
->position
= it
->current
.string_pos
;
6808 it
->object
= it
->string
;
6809 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6810 IT_STRING_BYTEPOS (*it
), it
->string
);
6816 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6817 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6820 if (it
->bidi_it
.new_paragraph
)
6821 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6822 /* Resync the bidi iterator with IT's new position.
6823 FIXME: this doesn't support bidirectional text. */
6824 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6825 bidi_move_to_visually_next (&it
->bidi_it
);
6829 it
->position
= it
->current
.pos
;
6830 it
->object
= it
->w
->buffer
;
6831 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6832 IT_BYTEPOS (*it
), Qnil
);
6839 /***********************************************************************
6840 Moving an iterator without producing glyphs
6841 ***********************************************************************/
6843 /* Check if iterator is at a position corresponding to a valid buffer
6844 position after some move_it_ call. */
6846 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6847 ((it)->method == GET_FROM_STRING \
6848 ? IT_STRING_CHARPOS (*it) == 0 \
6852 /* Move iterator IT to a specified buffer or X position within one
6853 line on the display without producing glyphs.
6855 OP should be a bit mask including some or all of these bits:
6856 MOVE_TO_X: Stop upon reaching x-position TO_X.
6857 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6858 Regardless of OP's value, stop upon reaching the end of the display line.
6860 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6861 This means, in particular, that TO_X includes window's horizontal
6864 The return value has several possible values that
6865 say what condition caused the scan to stop:
6867 MOVE_POS_MATCH_OR_ZV
6868 - when TO_POS or ZV was reached.
6871 -when TO_X was reached before TO_POS or ZV were reached.
6874 - when we reached the end of the display area and the line must
6878 - when we reached the end of the display area and the line is
6882 - when we stopped at a line end, i.e. a newline or a CR and selective
6885 static enum move_it_result
6886 move_it_in_display_line_to (struct it
*it
,
6887 EMACS_INT to_charpos
, int to_x
,
6888 enum move_operation_enum op
)
6890 enum move_it_result result
= MOVE_UNDEFINED
;
6891 struct glyph_row
*saved_glyph_row
;
6892 struct it wrap_it
, atpos_it
, atx_it
;
6894 enum it_method prev_method
= it
->method
;
6895 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6897 /* Don't produce glyphs in produce_glyphs. */
6898 saved_glyph_row
= it
->glyph_row
;
6899 it
->glyph_row
= NULL
;
6901 /* Use wrap_it to save a copy of IT wherever a word wrap could
6902 occur. Use atpos_it to save a copy of IT at the desired buffer
6903 position, if found, so that we can scan ahead and check if the
6904 word later overshoots the window edge. Use atx_it similarly, for
6910 #define BUFFER_POS_REACHED_P() \
6911 ((op & MOVE_TO_POS) != 0 \
6912 && BUFFERP (it->object) \
6913 && (IT_CHARPOS (*it) == to_charpos \
6914 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6915 && (it->method == GET_FROM_BUFFER \
6916 || (it->method == GET_FROM_DISPLAY_VECTOR \
6917 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6919 /* If there's a line-/wrap-prefix, handle it. */
6920 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6921 && it
->current_y
< it
->last_visible_y
)
6922 handle_line_prefix (it
);
6924 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
6925 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6929 int x
, i
, ascent
= 0, descent
= 0;
6931 /* Utility macro to reset an iterator with x, ascent, and descent. */
6932 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6933 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6934 (IT)->max_descent = descent)
6936 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6938 if ((op
& MOVE_TO_POS
) != 0
6939 && BUFFERP (it
->object
)
6940 && it
->method
== GET_FROM_BUFFER
6941 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
6943 && (prev_method
== GET_FROM_IMAGE
6944 || prev_method
== GET_FROM_STRETCH
)
6945 /* Passed TO_CHARPOS from left to right. */
6946 && ((prev_pos
< to_charpos
6947 && IT_CHARPOS (*it
) > to_charpos
)
6948 /* Passed TO_CHARPOS from right to left. */
6949 || (prev_pos
> to_charpos
6950 && IT_CHARPOS (*it
) < to_charpos
)))))
6952 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6954 result
= MOVE_POS_MATCH_OR_ZV
;
6957 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6958 /* If wrap_it is valid, the current position might be in a
6959 word that is wrapped. So, save the iterator in
6960 atpos_it and continue to see if wrapping happens. */
6964 prev_method
= it
->method
;
6965 if (it
->method
== GET_FROM_BUFFER
)
6966 prev_pos
= IT_CHARPOS (*it
);
6967 /* Stop when ZV reached.
6968 We used to stop here when TO_CHARPOS reached as well, but that is
6969 too soon if this glyph does not fit on this line. So we handle it
6970 explicitly below. */
6971 if (!get_next_display_element (it
))
6973 result
= MOVE_POS_MATCH_OR_ZV
;
6977 if (it
->line_wrap
== TRUNCATE
)
6979 if (BUFFER_POS_REACHED_P ())
6981 result
= MOVE_POS_MATCH_OR_ZV
;
6987 if (it
->line_wrap
== WORD_WRAP
)
6989 if (IT_DISPLAYING_WHITESPACE (it
))
6993 /* We have reached a glyph that follows one or more
6994 whitespace characters. If the position is
6995 already found, we are done. */
6996 if (atpos_it
.sp
>= 0)
6999 result
= MOVE_POS_MATCH_OR_ZV
;
7005 result
= MOVE_X_REACHED
;
7008 /* Otherwise, we can wrap here. */
7015 /* Remember the line height for the current line, in case
7016 the next element doesn't fit on the line. */
7017 ascent
= it
->max_ascent
;
7018 descent
= it
->max_descent
;
7020 /* The call to produce_glyphs will get the metrics of the
7021 display element IT is loaded with. Record the x-position
7022 before this display element, in case it doesn't fit on the
7026 PRODUCE_GLYPHS (it
);
7028 if (it
->area
!= TEXT_AREA
)
7030 set_iterator_to_next (it
, 1);
7031 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7032 SET_TEXT_POS (this_line_min_pos
,
7033 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7037 /* The number of glyphs we get back in IT->nglyphs will normally
7038 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7039 character on a terminal frame, or (iii) a line end. For the
7040 second case, IT->nglyphs - 1 padding glyphs will be present.
7041 (On X frames, there is only one glyph produced for a
7042 composite character.)
7044 The behavior implemented below means, for continuation lines,
7045 that as many spaces of a TAB as fit on the current line are
7046 displayed there. For terminal frames, as many glyphs of a
7047 multi-glyph character are displayed in the current line, too.
7048 This is what the old redisplay code did, and we keep it that
7049 way. Under X, the whole shape of a complex character must
7050 fit on the line or it will be completely displayed in the
7053 Note that both for tabs and padding glyphs, all glyphs have
7057 /* More than one glyph or glyph doesn't fit on line. All
7058 glyphs have the same width. */
7059 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7061 int x_before_this_char
= x
;
7062 int hpos_before_this_char
= it
->hpos
;
7064 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7066 new_x
= x
+ single_glyph_width
;
7068 /* We want to leave anything reaching TO_X to the caller. */
7069 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7071 if (BUFFER_POS_REACHED_P ())
7073 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7074 goto buffer_pos_reached
;
7075 if (atpos_it
.sp
< 0)
7078 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7083 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7086 result
= MOVE_X_REACHED
;
7092 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7097 if (/* Lines are continued. */
7098 it
->line_wrap
!= TRUNCATE
7099 && (/* And glyph doesn't fit on the line. */
7100 new_x
> it
->last_visible_x
7101 /* Or it fits exactly and we're on a window
7103 || (new_x
== it
->last_visible_x
7104 && FRAME_WINDOW_P (it
->f
))))
7106 if (/* IT->hpos == 0 means the very first glyph
7107 doesn't fit on the line, e.g. a wide image. */
7109 || (new_x
== it
->last_visible_x
7110 && FRAME_WINDOW_P (it
->f
)))
7113 it
->current_x
= new_x
;
7115 /* The character's last glyph just barely fits
7117 if (i
== it
->nglyphs
- 1)
7119 /* If this is the destination position,
7120 return a position *before* it in this row,
7121 now that we know it fits in this row. */
7122 if (BUFFER_POS_REACHED_P ())
7124 if (it
->line_wrap
!= WORD_WRAP
7127 it
->hpos
= hpos_before_this_char
;
7128 it
->current_x
= x_before_this_char
;
7129 result
= MOVE_POS_MATCH_OR_ZV
;
7132 if (it
->line_wrap
== WORD_WRAP
7136 atpos_it
.current_x
= x_before_this_char
;
7137 atpos_it
.hpos
= hpos_before_this_char
;
7141 set_iterator_to_next (it
, 1);
7142 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7143 SET_TEXT_POS (this_line_min_pos
,
7144 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7145 /* On graphical terminals, newlines may
7146 "overflow" into the fringe if
7147 overflow-newline-into-fringe is non-nil.
7148 On text-only terminals, newlines may
7149 overflow into the last glyph on the
7151 if (!FRAME_WINDOW_P (it
->f
)
7152 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7154 if (!get_next_display_element (it
))
7156 result
= MOVE_POS_MATCH_OR_ZV
;
7159 if (BUFFER_POS_REACHED_P ())
7161 if (ITERATOR_AT_END_OF_LINE_P (it
))
7162 result
= MOVE_POS_MATCH_OR_ZV
;
7164 result
= MOVE_LINE_CONTINUED
;
7167 if (ITERATOR_AT_END_OF_LINE_P (it
))
7169 result
= MOVE_NEWLINE_OR_CR
;
7176 IT_RESET_X_ASCENT_DESCENT (it
);
7178 if (wrap_it
.sp
>= 0)
7185 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7187 result
= MOVE_LINE_CONTINUED
;
7191 if (BUFFER_POS_REACHED_P ())
7193 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7194 goto buffer_pos_reached
;
7195 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7198 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7202 if (new_x
> it
->first_visible_x
)
7204 /* Glyph is visible. Increment number of glyphs that
7205 would be displayed. */
7210 if (result
!= MOVE_UNDEFINED
)
7213 else if (BUFFER_POS_REACHED_P ())
7216 IT_RESET_X_ASCENT_DESCENT (it
);
7217 result
= MOVE_POS_MATCH_OR_ZV
;
7220 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7222 /* Stop when TO_X specified and reached. This check is
7223 necessary here because of lines consisting of a line end,
7224 only. The line end will not produce any glyphs and we
7225 would never get MOVE_X_REACHED. */
7226 xassert (it
->nglyphs
== 0);
7227 result
= MOVE_X_REACHED
;
7231 /* Is this a line end? If yes, we're done. */
7232 if (ITERATOR_AT_END_OF_LINE_P (it
))
7234 result
= MOVE_NEWLINE_OR_CR
;
7238 if (it
->method
== GET_FROM_BUFFER
)
7239 prev_pos
= IT_CHARPOS (*it
);
7240 /* The current display element has been consumed. Advance
7242 set_iterator_to_next (it
, 1);
7243 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7244 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7246 /* Stop if lines are truncated and IT's current x-position is
7247 past the right edge of the window now. */
7248 if (it
->line_wrap
== TRUNCATE
7249 && it
->current_x
>= it
->last_visible_x
)
7251 if (!FRAME_WINDOW_P (it
->f
)
7252 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7254 if (!get_next_display_element (it
)
7255 || BUFFER_POS_REACHED_P ())
7257 result
= MOVE_POS_MATCH_OR_ZV
;
7260 if (ITERATOR_AT_END_OF_LINE_P (it
))
7262 result
= MOVE_NEWLINE_OR_CR
;
7266 result
= MOVE_LINE_TRUNCATED
;
7269 #undef IT_RESET_X_ASCENT_DESCENT
7272 #undef BUFFER_POS_REACHED_P
7274 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7275 restore the saved iterator. */
7276 if (atpos_it
.sp
>= 0)
7278 else if (atx_it
.sp
>= 0)
7283 /* Restore the iterator settings altered at the beginning of this
7285 it
->glyph_row
= saved_glyph_row
;
7289 /* For external use. */
7291 move_it_in_display_line (struct it
*it
,
7292 EMACS_INT to_charpos
, int to_x
,
7293 enum move_operation_enum op
)
7295 if (it
->line_wrap
== WORD_WRAP
7296 && (op
& MOVE_TO_X
))
7298 struct it save_it
= *it
;
7299 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7300 /* When word-wrap is on, TO_X may lie past the end
7301 of a wrapped line. Then it->current is the
7302 character on the next line, so backtrack to the
7303 space before the wrap point. */
7304 if (skip
== MOVE_LINE_CONTINUED
)
7306 int prev_x
= max (it
->current_x
- 1, 0);
7308 move_it_in_display_line_to
7309 (it
, -1, prev_x
, MOVE_TO_X
);
7313 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7317 /* Move IT forward until it satisfies one or more of the criteria in
7318 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7320 OP is a bit-mask that specifies where to stop, and in particular,
7321 which of those four position arguments makes a difference. See the
7322 description of enum move_operation_enum.
7324 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7325 screen line, this function will set IT to the next position >
7329 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7331 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7332 int line_height
, line_start_x
= 0, reached
= 0;
7336 if (op
& MOVE_TO_VPOS
)
7338 /* If no TO_CHARPOS and no TO_X specified, stop at the
7339 start of the line TO_VPOS. */
7340 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7342 if (it
->vpos
== to_vpos
)
7348 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7352 /* TO_VPOS >= 0 means stop at TO_X in the line at
7353 TO_VPOS, or at TO_POS, whichever comes first. */
7354 if (it
->vpos
== to_vpos
)
7360 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7362 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7367 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7369 /* We have reached TO_X but not in the line we want. */
7370 skip
= move_it_in_display_line_to (it
, to_charpos
,
7372 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7380 else if (op
& MOVE_TO_Y
)
7382 struct it it_backup
;
7384 if (it
->line_wrap
== WORD_WRAP
)
7387 /* TO_Y specified means stop at TO_X in the line containing
7388 TO_Y---or at TO_CHARPOS if this is reached first. The
7389 problem is that we can't really tell whether the line
7390 contains TO_Y before we have completely scanned it, and
7391 this may skip past TO_X. What we do is to first scan to
7394 If TO_X is not specified, use a TO_X of zero. The reason
7395 is to make the outcome of this function more predictable.
7396 If we didn't use TO_X == 0, we would stop at the end of
7397 the line which is probably not what a caller would expect
7399 skip
= move_it_in_display_line_to
7400 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7401 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7403 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7404 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7406 else if (skip
== MOVE_X_REACHED
)
7408 /* If TO_X was reached, we want to know whether TO_Y is
7409 in the line. We know this is the case if the already
7410 scanned glyphs make the line tall enough. Otherwise,
7411 we must check by scanning the rest of the line. */
7412 line_height
= it
->max_ascent
+ it
->max_descent
;
7413 if (to_y
>= it
->current_y
7414 && to_y
< it
->current_y
+ line_height
)
7420 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7421 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7423 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7424 line_height
= it
->max_ascent
+ it
->max_descent
;
7425 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7427 if (to_y
>= it
->current_y
7428 && to_y
< it
->current_y
+ line_height
)
7430 /* If TO_Y is in this line and TO_X was reached
7431 above, we scanned too far. We have to restore
7432 IT's settings to the ones before skipping. */
7439 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7445 /* Check whether TO_Y is in this line. */
7446 line_height
= it
->max_ascent
+ it
->max_descent
;
7447 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7449 if (to_y
>= it
->current_y
7450 && to_y
< it
->current_y
+ line_height
)
7452 /* When word-wrap is on, TO_X may lie past the end
7453 of a wrapped line. Then it->current is the
7454 character on the next line, so backtrack to the
7455 space before the wrap point. */
7456 if (skip
== MOVE_LINE_CONTINUED
7457 && it
->line_wrap
== WORD_WRAP
)
7459 int prev_x
= max (it
->current_x
- 1, 0);
7461 skip
= move_it_in_display_line_to
7462 (it
, -1, prev_x
, MOVE_TO_X
);
7471 else if (BUFFERP (it
->object
)
7472 && (it
->method
== GET_FROM_BUFFER
7473 || it
->method
== GET_FROM_STRETCH
)
7474 && IT_CHARPOS (*it
) >= to_charpos
)
7475 skip
= MOVE_POS_MATCH_OR_ZV
;
7477 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7481 case MOVE_POS_MATCH_OR_ZV
:
7485 case MOVE_NEWLINE_OR_CR
:
7486 set_iterator_to_next (it
, 1);
7487 it
->continuation_lines_width
= 0;
7490 case MOVE_LINE_TRUNCATED
:
7491 it
->continuation_lines_width
= 0;
7492 reseat_at_next_visible_line_start (it
, 0);
7493 if ((op
& MOVE_TO_POS
) != 0
7494 && IT_CHARPOS (*it
) > to_charpos
)
7501 case MOVE_LINE_CONTINUED
:
7502 /* For continued lines ending in a tab, some of the glyphs
7503 associated with the tab are displayed on the current
7504 line. Since it->current_x does not include these glyphs,
7505 we use it->last_visible_x instead. */
7508 it
->continuation_lines_width
+= it
->last_visible_x
;
7509 /* When moving by vpos, ensure that the iterator really
7510 advances to the next line (bug#847, bug#969). Fixme:
7511 do we need to do this in other circumstances? */
7512 if (it
->current_x
!= it
->last_visible_x
7513 && (op
& MOVE_TO_VPOS
)
7514 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7516 line_start_x
= it
->current_x
+ it
->pixel_width
7517 - it
->last_visible_x
;
7518 set_iterator_to_next (it
, 0);
7522 it
->continuation_lines_width
+= it
->current_x
;
7529 /* Reset/increment for the next run. */
7530 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7531 it
->current_x
= line_start_x
;
7534 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7536 last_height
= it
->max_ascent
+ it
->max_descent
;
7537 last_max_ascent
= it
->max_ascent
;
7538 it
->max_ascent
= it
->max_descent
= 0;
7543 /* On text terminals, we may stop at the end of a line in the middle
7544 of a multi-character glyph. If the glyph itself is continued,
7545 i.e. it is actually displayed on the next line, don't treat this
7546 stopping point as valid; move to the next line instead (unless
7547 that brings us offscreen). */
7548 if (!FRAME_WINDOW_P (it
->f
)
7550 && IT_CHARPOS (*it
) == to_charpos
7551 && it
->what
== IT_CHARACTER
7553 && it
->line_wrap
== WINDOW_WRAP
7554 && it
->current_x
== it
->last_visible_x
- 1
7557 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7559 it
->continuation_lines_width
+= it
->current_x
;
7560 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7561 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7563 last_height
= it
->max_ascent
+ it
->max_descent
;
7564 last_max_ascent
= it
->max_ascent
;
7567 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7571 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7573 If DY > 0, move IT backward at least that many pixels. DY = 0
7574 means move IT backward to the preceding line start or BEGV. This
7575 function may move over more than DY pixels if IT->current_y - DY
7576 ends up in the middle of a line; in this case IT->current_y will be
7577 set to the top of the line moved to. */
7580 move_it_vertically_backward (struct it
*it
, int dy
)
7584 EMACS_INT start_pos
;
7589 start_pos
= IT_CHARPOS (*it
);
7591 /* Estimate how many newlines we must move back. */
7592 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7594 /* Set the iterator's position that many lines back. */
7595 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7596 back_to_previous_visible_line_start (it
);
7598 /* Reseat the iterator here. When moving backward, we don't want
7599 reseat to skip forward over invisible text, set up the iterator
7600 to deliver from overlay strings at the new position etc. So,
7601 use reseat_1 here. */
7602 reseat_1 (it
, it
->current
.pos
, 1);
7604 /* We are now surely at a line start. */
7605 it
->current_x
= it
->hpos
= 0;
7606 it
->continuation_lines_width
= 0;
7608 /* Move forward and see what y-distance we moved. First move to the
7609 start of the next line so that we get its height. We need this
7610 height to be able to tell whether we reached the specified
7613 it2
.max_ascent
= it2
.max_descent
= 0;
7616 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7617 MOVE_TO_POS
| MOVE_TO_VPOS
);
7619 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7620 xassert (IT_CHARPOS (*it
) >= BEGV
);
7623 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7624 xassert (IT_CHARPOS (*it
) >= BEGV
);
7625 /* H is the actual vertical distance from the position in *IT
7626 and the starting position. */
7627 h
= it2
.current_y
- it
->current_y
;
7628 /* NLINES is the distance in number of lines. */
7629 nlines
= it2
.vpos
- it
->vpos
;
7631 /* Correct IT's y and vpos position
7632 so that they are relative to the starting point. */
7638 /* DY == 0 means move to the start of the screen line. The
7639 value of nlines is > 0 if continuation lines were involved. */
7641 move_it_by_lines (it
, nlines
);
7645 /* The y-position we try to reach, relative to *IT.
7646 Note that H has been subtracted in front of the if-statement. */
7647 int target_y
= it
->current_y
+ h
- dy
;
7648 int y0
= it3
.current_y
;
7649 int y1
= line_bottom_y (&it3
);
7650 int line_height
= y1
- y0
;
7652 /* If we did not reach target_y, try to move further backward if
7653 we can. If we moved too far backward, try to move forward. */
7654 if (target_y
< it
->current_y
7655 /* This is heuristic. In a window that's 3 lines high, with
7656 a line height of 13 pixels each, recentering with point
7657 on the bottom line will try to move -39/2 = 19 pixels
7658 backward. Try to avoid moving into the first line. */
7659 && (it
->current_y
- target_y
7660 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7661 && IT_CHARPOS (*it
) > BEGV
)
7663 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7664 target_y
- it
->current_y
));
7665 dy
= it
->current_y
- target_y
;
7666 goto move_further_back
;
7668 else if (target_y
>= it
->current_y
+ line_height
7669 && IT_CHARPOS (*it
) < ZV
)
7671 /* Should move forward by at least one line, maybe more.
7673 Note: Calling move_it_by_lines can be expensive on
7674 terminal frames, where compute_motion is used (via
7675 vmotion) to do the job, when there are very long lines
7676 and truncate-lines is nil. That's the reason for
7677 treating terminal frames specially here. */
7679 if (!FRAME_WINDOW_P (it
->f
))
7680 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7685 move_it_by_lines (it
, 1);
7687 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7694 /* Move IT by a specified amount of pixel lines DY. DY negative means
7695 move backwards. DY = 0 means move to start of screen line. At the
7696 end, IT will be on the start of a screen line. */
7699 move_it_vertically (struct it
*it
, int dy
)
7702 move_it_vertically_backward (it
, -dy
);
7705 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7706 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7707 MOVE_TO_POS
| MOVE_TO_Y
);
7708 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7710 /* If buffer ends in ZV without a newline, move to the start of
7711 the line to satisfy the post-condition. */
7712 if (IT_CHARPOS (*it
) == ZV
7714 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7715 move_it_by_lines (it
, 0);
7720 /* Move iterator IT past the end of the text line it is in. */
7723 move_it_past_eol (struct it
*it
)
7725 enum move_it_result rc
;
7727 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7728 if (rc
== MOVE_NEWLINE_OR_CR
)
7729 set_iterator_to_next (it
, 0);
7733 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7734 negative means move up. DVPOS == 0 means move to the start of the
7737 Optimization idea: If we would know that IT->f doesn't use
7738 a face with proportional font, we could be faster for
7739 truncate-lines nil. */
7742 move_it_by_lines (struct it
*it
, int dvpos
)
7745 /* The commented-out optimization uses vmotion on terminals. This
7746 gives bad results, because elements like it->what, on which
7747 callers such as pos_visible_p rely, aren't updated. */
7748 /* struct position pos;
7749 if (!FRAME_WINDOW_P (it->f))
7751 struct text_pos textpos;
7753 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7754 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7755 reseat (it, textpos, 1);
7756 it->vpos += pos.vpos;
7757 it->current_y += pos.vpos;
7763 /* DVPOS == 0 means move to the start of the screen line. */
7764 move_it_vertically_backward (it
, 0);
7765 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7766 /* Let next call to line_bottom_y calculate real line height */
7771 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7772 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7773 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7778 EMACS_INT start_charpos
, i
;
7780 /* Start at the beginning of the screen line containing IT's
7781 position. This may actually move vertically backwards,
7782 in case of overlays, so adjust dvpos accordingly. */
7784 move_it_vertically_backward (it
, 0);
7787 /* Go back -DVPOS visible lines and reseat the iterator there. */
7788 start_charpos
= IT_CHARPOS (*it
);
7789 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7790 back_to_previous_visible_line_start (it
);
7791 reseat (it
, it
->current
.pos
, 1);
7793 /* Move further back if we end up in a string or an image. */
7794 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7796 /* First try to move to start of display line. */
7798 move_it_vertically_backward (it
, 0);
7800 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7802 /* If start of line is still in string or image,
7803 move further back. */
7804 back_to_previous_visible_line_start (it
);
7805 reseat (it
, it
->current
.pos
, 1);
7809 it
->current_x
= it
->hpos
= 0;
7811 /* Above call may have moved too far if continuation lines
7812 are involved. Scan forward and see if it did. */
7814 it2
.vpos
= it2
.current_y
= 0;
7815 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7816 it
->vpos
-= it2
.vpos
;
7817 it
->current_y
-= it2
.current_y
;
7818 it
->current_x
= it
->hpos
= 0;
7820 /* If we moved too far back, move IT some lines forward. */
7821 if (it2
.vpos
> -dvpos
)
7823 int delta
= it2
.vpos
+ dvpos
;
7825 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7826 /* Move back again if we got too far ahead. */
7827 if (IT_CHARPOS (*it
) >= start_charpos
)
7833 /* Return 1 if IT points into the middle of a display vector. */
7836 in_display_vector_p (struct it
*it
)
7838 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7839 && it
->current
.dpvec_index
> 0
7840 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7844 /***********************************************************************
7846 ***********************************************************************/
7849 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7853 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7855 Lisp_Object args
[3];
7856 Lisp_Object msg
, fmt
;
7859 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7862 /* Do nothing if called asynchronously. Inserting text into
7863 a buffer may call after-change-functions and alike and
7864 that would means running Lisp asynchronously. */
7865 if (handling_signal
)
7869 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7871 args
[0] = fmt
= build_string (format
);
7874 msg
= Fformat (3, args
);
7876 len
= SBYTES (msg
) + 1;
7877 SAFE_ALLOCA (buffer
, char *, len
);
7878 memcpy (buffer
, SDATA (msg
), len
);
7880 message_dolog (buffer
, len
- 1, 1, 0);
7887 /* Output a newline in the *Messages* buffer if "needs" one. */
7890 message_log_maybe_newline (void)
7892 if (message_log_need_newline
)
7893 message_dolog ("", 0, 1, 0);
7897 /* Add a string M of length NBYTES to the message log, optionally
7898 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7899 nonzero, means interpret the contents of M as multibyte. This
7900 function calls low-level routines in order to bypass text property
7901 hooks, etc. which might not be safe to run.
7903 This may GC (insert may run before/after change hooks),
7904 so the buffer M must NOT point to a Lisp string. */
7907 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7909 const unsigned char *msg
= (const unsigned char *) m
;
7911 if (!NILP (Vmemory_full
))
7914 if (!NILP (Vmessage_log_max
))
7916 struct buffer
*oldbuf
;
7917 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7918 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7919 EMACS_INT point_at_end
= 0;
7920 EMACS_INT zv_at_end
= 0;
7921 Lisp_Object old_deactivate_mark
, tem
;
7922 struct gcpro gcpro1
;
7924 old_deactivate_mark
= Vdeactivate_mark
;
7925 oldbuf
= current_buffer
;
7926 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7927 BVAR (current_buffer
, undo_list
) = Qt
;
7929 oldpoint
= message_dolog_marker1
;
7930 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7931 oldbegv
= message_dolog_marker2
;
7932 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7933 oldzv
= message_dolog_marker3
;
7934 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7935 GCPRO1 (old_deactivate_mark
);
7943 BEGV_BYTE
= BEG_BYTE
;
7946 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7948 /* Insert the string--maybe converting multibyte to single byte
7949 or vice versa, so that all the text fits the buffer. */
7951 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7957 /* Convert a multibyte string to single-byte
7958 for the *Message* buffer. */
7959 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7961 c
= string_char_and_length (msg
+ i
, &char_bytes
);
7962 work
[0] = (ASCII_CHAR_P (c
)
7964 : multibyte_char_to_unibyte (c
));
7965 insert_1_both (work
, 1, 1, 1, 0, 0);
7968 else if (! multibyte
7969 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7973 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7974 /* Convert a single-byte string to multibyte
7975 for the *Message* buffer. */
7976 for (i
= 0; i
< nbytes
; i
++)
7979 MAKE_CHAR_MULTIBYTE (c
);
7980 char_bytes
= CHAR_STRING (c
, str
);
7981 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
7985 insert_1 (m
, nbytes
, 1, 0, 0);
7989 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
7990 unsigned long int dups
;
7991 insert_1 ("\n", 1, 1, 0, 0);
7993 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7995 this_bol_byte
= PT_BYTE
;
7997 /* See if this line duplicates the previous one.
7998 If so, combine duplicates. */
8001 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8003 prev_bol_byte
= PT_BYTE
;
8005 dups
= message_log_check_duplicate (prev_bol_byte
,
8009 del_range_both (prev_bol
, prev_bol_byte
,
8010 this_bol
, this_bol_byte
, 0);
8016 /* If you change this format, don't forget to also
8017 change message_log_check_duplicate. */
8018 sprintf (dupstr
, " [%lu times]", dups
);
8019 duplen
= strlen (dupstr
);
8020 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8021 insert_1 (dupstr
, duplen
, 1, 0, 1);
8026 /* If we have more than the desired maximum number of lines
8027 in the *Messages* buffer now, delete the oldest ones.
8028 This is safe because we don't have undo in this buffer. */
8030 if (NATNUMP (Vmessage_log_max
))
8032 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8033 -XFASTINT (Vmessage_log_max
) - 1, 0);
8034 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8037 BEGV
= XMARKER (oldbegv
)->charpos
;
8038 BEGV_BYTE
= marker_byte_position (oldbegv
);
8047 ZV
= XMARKER (oldzv
)->charpos
;
8048 ZV_BYTE
= marker_byte_position (oldzv
);
8052 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8054 /* We can't do Fgoto_char (oldpoint) because it will run some
8056 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8057 XMARKER (oldpoint
)->bytepos
);
8060 unchain_marker (XMARKER (oldpoint
));
8061 unchain_marker (XMARKER (oldbegv
));
8062 unchain_marker (XMARKER (oldzv
));
8064 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8065 set_buffer_internal (oldbuf
);
8067 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8068 message_log_need_newline
= !nlflag
;
8069 Vdeactivate_mark
= old_deactivate_mark
;
8074 /* We are at the end of the buffer after just having inserted a newline.
8075 (Note: We depend on the fact we won't be crossing the gap.)
8076 Check to see if the most recent message looks a lot like the previous one.
8077 Return 0 if different, 1 if the new one should just replace it, or a
8078 value N > 1 if we should also append " [N times]". */
8080 static unsigned long int
8081 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8084 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8086 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8087 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8089 for (i
= 0; i
< len
; i
++)
8091 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8099 if (*p1
++ == ' ' && *p1
++ == '[')
8102 unsigned long int n
= strtoul ((char *) p1
, &pend
, 10);
8103 if (strncmp (pend
, " times]\n", 8) == 0)
8110 /* Display an echo area message M with a specified length of NBYTES
8111 bytes. The string may include null characters. If M is 0, clear
8112 out any existing message, and let the mini-buffer text show
8115 This may GC, so the buffer M must NOT point to a Lisp string. */
8118 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8120 /* First flush out any partial line written with print. */
8121 message_log_maybe_newline ();
8123 message_dolog (m
, nbytes
, 1, multibyte
);
8124 message2_nolog (m
, nbytes
, multibyte
);
8128 /* The non-logging counterpart of message2. */
8131 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8133 struct frame
*sf
= SELECTED_FRAME ();
8134 message_enable_multibyte
= multibyte
;
8136 if (FRAME_INITIAL_P (sf
))
8138 if (noninteractive_need_newline
)
8139 putc ('\n', stderr
);
8140 noninteractive_need_newline
= 0;
8142 fwrite (m
, nbytes
, 1, stderr
);
8143 if (cursor_in_echo_area
== 0)
8144 fprintf (stderr
, "\n");
8147 /* A null message buffer means that the frame hasn't really been
8148 initialized yet. Error messages get reported properly by
8149 cmd_error, so this must be just an informative message; toss it. */
8150 else if (INTERACTIVE
8151 && sf
->glyphs_initialized_p
8152 && FRAME_MESSAGE_BUF (sf
))
8154 Lisp_Object mini_window
;
8157 /* Get the frame containing the mini-buffer
8158 that the selected frame is using. */
8159 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8160 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8162 FRAME_SAMPLE_VISIBILITY (f
);
8163 if (FRAME_VISIBLE_P (sf
)
8164 && ! FRAME_VISIBLE_P (f
))
8165 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8169 set_message (m
, Qnil
, nbytes
, multibyte
);
8170 if (minibuffer_auto_raise
)
8171 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8174 clear_message (1, 1);
8176 do_pending_window_change (0);
8177 echo_area_display (1);
8178 do_pending_window_change (0);
8179 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8180 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8185 /* Display an echo area message M with a specified length of NBYTES
8186 bytes. The string may include null characters. If M is not a
8187 string, clear out any existing message, and let the mini-buffer
8190 This function cancels echoing. */
8193 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8195 struct gcpro gcpro1
;
8198 clear_message (1,1);
8201 /* First flush out any partial line written with print. */
8202 message_log_maybe_newline ();
8208 SAFE_ALLOCA (buffer
, char *, nbytes
);
8209 memcpy (buffer
, SDATA (m
), nbytes
);
8210 message_dolog (buffer
, nbytes
, 1, multibyte
);
8213 message3_nolog (m
, nbytes
, multibyte
);
8219 /* The non-logging version of message3.
8220 This does not cancel echoing, because it is used for echoing.
8221 Perhaps we need to make a separate function for echoing
8222 and make this cancel echoing. */
8225 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8227 struct frame
*sf
= SELECTED_FRAME ();
8228 message_enable_multibyte
= multibyte
;
8230 if (FRAME_INITIAL_P (sf
))
8232 if (noninteractive_need_newline
)
8233 putc ('\n', stderr
);
8234 noninteractive_need_newline
= 0;
8236 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8237 if (cursor_in_echo_area
== 0)
8238 fprintf (stderr
, "\n");
8241 /* A null message buffer means that the frame hasn't really been
8242 initialized yet. Error messages get reported properly by
8243 cmd_error, so this must be just an informative message; toss it. */
8244 else if (INTERACTIVE
8245 && sf
->glyphs_initialized_p
8246 && FRAME_MESSAGE_BUF (sf
))
8248 Lisp_Object mini_window
;
8252 /* Get the frame containing the mini-buffer
8253 that the selected frame is using. */
8254 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8255 frame
= XWINDOW (mini_window
)->frame
;
8258 FRAME_SAMPLE_VISIBILITY (f
);
8259 if (FRAME_VISIBLE_P (sf
)
8260 && !FRAME_VISIBLE_P (f
))
8261 Fmake_frame_visible (frame
);
8263 if (STRINGP (m
) && SCHARS (m
) > 0)
8265 set_message (NULL
, m
, nbytes
, multibyte
);
8266 if (minibuffer_auto_raise
)
8267 Fraise_frame (frame
);
8268 /* Assume we are not echoing.
8269 (If we are, echo_now will override this.) */
8270 echo_message_buffer
= Qnil
;
8273 clear_message (1, 1);
8275 do_pending_window_change (0);
8276 echo_area_display (1);
8277 do_pending_window_change (0);
8278 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8279 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8284 /* Display a null-terminated echo area message M. If M is 0, clear
8285 out any existing message, and let the mini-buffer text show through.
8287 The buffer M must continue to exist until after the echo area gets
8288 cleared or some other message gets displayed there. Do not pass
8289 text that is stored in a Lisp string. Do not pass text in a buffer
8290 that was alloca'd. */
8293 message1 (const char *m
)
8295 message2 (m
, (m
? strlen (m
) : 0), 0);
8299 /* The non-logging counterpart of message1. */
8302 message1_nolog (const char *m
)
8304 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8307 /* Display a message M which contains a single %s
8308 which gets replaced with STRING. */
8311 message_with_string (const char *m
, Lisp_Object string
, int log
)
8313 CHECK_STRING (string
);
8319 if (noninteractive_need_newline
)
8320 putc ('\n', stderr
);
8321 noninteractive_need_newline
= 0;
8322 fprintf (stderr
, m
, SDATA (string
));
8323 if (!cursor_in_echo_area
)
8324 fprintf (stderr
, "\n");
8328 else if (INTERACTIVE
)
8330 /* The frame whose minibuffer we're going to display the message on.
8331 It may be larger than the selected frame, so we need
8332 to use its buffer, not the selected frame's buffer. */
8333 Lisp_Object mini_window
;
8334 struct frame
*f
, *sf
= SELECTED_FRAME ();
8336 /* Get the frame containing the minibuffer
8337 that the selected frame is using. */
8338 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8339 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8341 /* A null message buffer means that the frame hasn't really been
8342 initialized yet. Error messages get reported properly by
8343 cmd_error, so this must be just an informative message; toss it. */
8344 if (FRAME_MESSAGE_BUF (f
))
8346 Lisp_Object args
[2], msg
;
8347 struct gcpro gcpro1
, gcpro2
;
8349 args
[0] = build_string (m
);
8350 args
[1] = msg
= string
;
8351 GCPRO2 (args
[0], msg
);
8354 msg
= Fformat (2, args
);
8357 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8359 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8363 /* Print should start at the beginning of the message
8364 buffer next time. */
8365 message_buf_print
= 0;
8371 /* Dump an informative message to the minibuf. If M is 0, clear out
8372 any existing message, and let the mini-buffer text show through. */
8375 vmessage (const char *m
, va_list ap
)
8381 if (noninteractive_need_newline
)
8382 putc ('\n', stderr
);
8383 noninteractive_need_newline
= 0;
8384 vfprintf (stderr
, m
, ap
);
8385 if (cursor_in_echo_area
== 0)
8386 fprintf (stderr
, "\n");
8390 else if (INTERACTIVE
)
8392 /* The frame whose mini-buffer we're going to display the message
8393 on. It may be larger than the selected frame, so we need to
8394 use its buffer, not the selected frame's buffer. */
8395 Lisp_Object mini_window
;
8396 struct frame
*f
, *sf
= SELECTED_FRAME ();
8398 /* Get the frame containing the mini-buffer
8399 that the selected frame is using. */
8400 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8401 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8403 /* A null message buffer means that the frame hasn't really been
8404 initialized yet. Error messages get reported properly by
8405 cmd_error, so this must be just an informative message; toss
8407 if (FRAME_MESSAGE_BUF (f
))
8411 char *buf
= FRAME_MESSAGE_BUF (f
);
8412 size_t bufsize
= FRAME_MESSAGE_BUF_SIZE (f
);
8415 memset (buf
, 0, bufsize
);
8416 len
= vsnprintf (buf
, bufsize
, m
, ap
);
8418 /* Do any truncation at a character boundary. */
8419 if (! (0 <= len
&& len
< bufsize
))
8421 char *end
= memchr (buf
, 0, bufsize
);
8422 for (len
= end
? end
- buf
: bufsize
;
8423 len
&& ! CHAR_HEAD_P (buf
[len
- 1]);
8428 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8433 /* Print should start at the beginning of the message
8434 buffer next time. */
8435 message_buf_print
= 0;
8441 message (const char *m
, ...)
8451 /* The non-logging version of message. */
8454 message_nolog (const char *m
, ...)
8456 Lisp_Object old_log_max
;
8459 old_log_max
= Vmessage_log_max
;
8460 Vmessage_log_max
= Qnil
;
8462 Vmessage_log_max
= old_log_max
;
8468 /* Display the current message in the current mini-buffer. This is
8469 only called from error handlers in process.c, and is not time
8473 update_echo_area (void)
8475 if (!NILP (echo_area_buffer
[0]))
8478 string
= Fcurrent_message ();
8479 message3 (string
, SBYTES (string
),
8480 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8485 /* Make sure echo area buffers in `echo_buffers' are live.
8486 If they aren't, make new ones. */
8489 ensure_echo_area_buffers (void)
8493 for (i
= 0; i
< 2; ++i
)
8494 if (!BUFFERP (echo_buffer
[i
])
8495 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8498 Lisp_Object old_buffer
;
8501 old_buffer
= echo_buffer
[i
];
8502 sprintf (name
, " *Echo Area %d*", i
);
8503 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8504 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8505 /* to force word wrap in echo area -
8506 it was decided to postpone this*/
8507 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8509 for (j
= 0; j
< 2; ++j
)
8510 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8511 echo_area_buffer
[j
] = echo_buffer
[i
];
8516 /* Call FN with args A1..A4 with either the current or last displayed
8517 echo_area_buffer as current buffer.
8519 WHICH zero means use the current message buffer
8520 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8521 from echo_buffer[] and clear it.
8523 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8524 suitable buffer from echo_buffer[] and clear it.
8526 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8527 that the current message becomes the last displayed one, make
8528 choose a suitable buffer for echo_area_buffer[0], and clear it.
8530 Value is what FN returns. */
8533 with_echo_area_buffer (struct window
*w
, int which
,
8534 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8535 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8538 int this_one
, the_other
, clear_buffer_p
, rc
;
8539 int count
= SPECPDL_INDEX ();
8541 /* If buffers aren't live, make new ones. */
8542 ensure_echo_area_buffers ();
8547 this_one
= 0, the_other
= 1;
8549 this_one
= 1, the_other
= 0;
8552 this_one
= 0, the_other
= 1;
8555 /* We need a fresh one in case the current echo buffer equals
8556 the one containing the last displayed echo area message. */
8557 if (!NILP (echo_area_buffer
[this_one
])
8558 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8559 echo_area_buffer
[this_one
] = Qnil
;
8562 /* Choose a suitable buffer from echo_buffer[] is we don't
8564 if (NILP (echo_area_buffer
[this_one
]))
8566 echo_area_buffer
[this_one
]
8567 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8568 ? echo_buffer
[the_other
]
8569 : echo_buffer
[this_one
]);
8573 buffer
= echo_area_buffer
[this_one
];
8575 /* Don't get confused by reusing the buffer used for echoing
8576 for a different purpose. */
8577 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8580 record_unwind_protect (unwind_with_echo_area_buffer
,
8581 with_echo_area_buffer_unwind_data (w
));
8583 /* Make the echo area buffer current. Note that for display
8584 purposes, it is not necessary that the displayed window's buffer
8585 == current_buffer, except for text property lookup. So, let's
8586 only set that buffer temporarily here without doing a full
8587 Fset_window_buffer. We must also change w->pointm, though,
8588 because otherwise an assertions in unshow_buffer fails, and Emacs
8590 set_buffer_internal_1 (XBUFFER (buffer
));
8594 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8597 BVAR (current_buffer
, undo_list
) = Qt
;
8598 BVAR (current_buffer
, read_only
) = Qnil
;
8599 specbind (Qinhibit_read_only
, Qt
);
8600 specbind (Qinhibit_modification_hooks
, Qt
);
8602 if (clear_buffer_p
&& Z
> BEG
)
8605 xassert (BEGV
>= BEG
);
8606 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8608 rc
= fn (a1
, a2
, a3
, a4
);
8610 xassert (BEGV
>= BEG
);
8611 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8613 unbind_to (count
, Qnil
);
8618 /* Save state that should be preserved around the call to the function
8619 FN called in with_echo_area_buffer. */
8622 with_echo_area_buffer_unwind_data (struct window
*w
)
8625 Lisp_Object vector
, tmp
;
8627 /* Reduce consing by keeping one vector in
8628 Vwith_echo_area_save_vector. */
8629 vector
= Vwith_echo_area_save_vector
;
8630 Vwith_echo_area_save_vector
= Qnil
;
8633 vector
= Fmake_vector (make_number (7), Qnil
);
8635 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8636 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8637 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8641 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8642 ASET (vector
, i
, w
->buffer
); ++i
;
8643 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8644 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8649 for (; i
< end
; ++i
)
8650 ASET (vector
, i
, Qnil
);
8653 xassert (i
== ASIZE (vector
));
8658 /* Restore global state from VECTOR which was created by
8659 with_echo_area_buffer_unwind_data. */
8662 unwind_with_echo_area_buffer (Lisp_Object vector
)
8664 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8665 Vdeactivate_mark
= AREF (vector
, 1);
8666 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8668 if (WINDOWP (AREF (vector
, 3)))
8671 Lisp_Object buffer
, charpos
, bytepos
;
8673 w
= XWINDOW (AREF (vector
, 3));
8674 buffer
= AREF (vector
, 4);
8675 charpos
= AREF (vector
, 5);
8676 bytepos
= AREF (vector
, 6);
8679 set_marker_both (w
->pointm
, buffer
,
8680 XFASTINT (charpos
), XFASTINT (bytepos
));
8683 Vwith_echo_area_save_vector
= vector
;
8688 /* Set up the echo area for use by print functions. MULTIBYTE_P
8689 non-zero means we will print multibyte. */
8692 setup_echo_area_for_printing (int multibyte_p
)
8694 /* If we can't find an echo area any more, exit. */
8695 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8698 ensure_echo_area_buffers ();
8700 if (!message_buf_print
)
8702 /* A message has been output since the last time we printed.
8703 Choose a fresh echo area buffer. */
8704 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8705 echo_area_buffer
[0] = echo_buffer
[1];
8707 echo_area_buffer
[0] = echo_buffer
[0];
8709 /* Switch to that buffer and clear it. */
8710 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8711 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8715 int count
= SPECPDL_INDEX ();
8716 specbind (Qinhibit_read_only
, Qt
);
8717 /* Note that undo recording is always disabled. */
8719 unbind_to (count
, Qnil
);
8721 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8723 /* Set up the buffer for the multibyteness we need. */
8725 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8726 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8728 /* Raise the frame containing the echo area. */
8729 if (minibuffer_auto_raise
)
8731 struct frame
*sf
= SELECTED_FRAME ();
8732 Lisp_Object mini_window
;
8733 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8734 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8737 message_log_maybe_newline ();
8738 message_buf_print
= 1;
8742 if (NILP (echo_area_buffer
[0]))
8744 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8745 echo_area_buffer
[0] = echo_buffer
[1];
8747 echo_area_buffer
[0] = echo_buffer
[0];
8750 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8752 /* Someone switched buffers between print requests. */
8753 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8754 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8760 /* Display an echo area message in window W. Value is non-zero if W's
8761 height is changed. If display_last_displayed_message_p is
8762 non-zero, display the message that was last displayed, otherwise
8763 display the current message. */
8766 display_echo_area (struct window
*w
)
8768 int i
, no_message_p
, window_height_changed_p
, count
;
8770 /* Temporarily disable garbage collections while displaying the echo
8771 area. This is done because a GC can print a message itself.
8772 That message would modify the echo area buffer's contents while a
8773 redisplay of the buffer is going on, and seriously confuse
8775 count
= inhibit_garbage_collection ();
8777 /* If there is no message, we must call display_echo_area_1
8778 nevertheless because it resizes the window. But we will have to
8779 reset the echo_area_buffer in question to nil at the end because
8780 with_echo_area_buffer will sets it to an empty buffer. */
8781 i
= display_last_displayed_message_p
? 1 : 0;
8782 no_message_p
= NILP (echo_area_buffer
[i
]);
8784 window_height_changed_p
8785 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8786 display_echo_area_1
,
8787 (EMACS_INT
) w
, Qnil
, 0, 0);
8790 echo_area_buffer
[i
] = Qnil
;
8792 unbind_to (count
, Qnil
);
8793 return window_height_changed_p
;
8797 /* Helper for display_echo_area. Display the current buffer which
8798 contains the current echo area message in window W, a mini-window,
8799 a pointer to which is passed in A1. A2..A4 are currently not used.
8800 Change the height of W so that all of the message is displayed.
8801 Value is non-zero if height of W was changed. */
8804 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8806 struct window
*w
= (struct window
*) a1
;
8808 struct text_pos start
;
8809 int window_height_changed_p
= 0;
8811 /* Do this before displaying, so that we have a large enough glyph
8812 matrix for the display. If we can't get enough space for the
8813 whole text, display the last N lines. That works by setting w->start. */
8814 window_height_changed_p
= resize_mini_window (w
, 0);
8816 /* Use the starting position chosen by resize_mini_window. */
8817 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8820 clear_glyph_matrix (w
->desired_matrix
);
8821 XSETWINDOW (window
, w
);
8822 try_window (window
, start
, 0);
8824 return window_height_changed_p
;
8828 /* Resize the echo area window to exactly the size needed for the
8829 currently displayed message, if there is one. If a mini-buffer
8830 is active, don't shrink it. */
8833 resize_echo_area_exactly (void)
8835 if (BUFFERP (echo_area_buffer
[0])
8836 && WINDOWP (echo_area_window
))
8838 struct window
*w
= XWINDOW (echo_area_window
);
8840 Lisp_Object resize_exactly
;
8842 if (minibuf_level
== 0)
8843 resize_exactly
= Qt
;
8845 resize_exactly
= Qnil
;
8847 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8848 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8851 ++windows_or_buffers_changed
;
8852 ++update_mode_lines
;
8853 redisplay_internal ();
8859 /* Callback function for with_echo_area_buffer, when used from
8860 resize_echo_area_exactly. A1 contains a pointer to the window to
8861 resize, EXACTLY non-nil means resize the mini-window exactly to the
8862 size of the text displayed. A3 and A4 are not used. Value is what
8863 resize_mini_window returns. */
8866 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8868 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8872 /* Resize mini-window W to fit the size of its contents. EXACT_P
8873 means size the window exactly to the size needed. Otherwise, it's
8874 only enlarged until W's buffer is empty.
8876 Set W->start to the right place to begin display. If the whole
8877 contents fit, start at the beginning. Otherwise, start so as
8878 to make the end of the contents appear. This is particularly
8879 important for y-or-n-p, but seems desirable generally.
8881 Value is non-zero if the window height has been changed. */
8884 resize_mini_window (struct window
*w
, int exact_p
)
8886 struct frame
*f
= XFRAME (w
->frame
);
8887 int window_height_changed_p
= 0;
8889 xassert (MINI_WINDOW_P (w
));
8891 /* By default, start display at the beginning. */
8892 set_marker_both (w
->start
, w
->buffer
,
8893 BUF_BEGV (XBUFFER (w
->buffer
)),
8894 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8896 /* Don't resize windows while redisplaying a window; it would
8897 confuse redisplay functions when the size of the window they are
8898 displaying changes from under them. Such a resizing can happen,
8899 for instance, when which-func prints a long message while
8900 we are running fontification-functions. We're running these
8901 functions with safe_call which binds inhibit-redisplay to t. */
8902 if (!NILP (Vinhibit_redisplay
))
8905 /* Nil means don't try to resize. */
8906 if (NILP (Vresize_mini_windows
)
8907 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8910 if (!FRAME_MINIBUF_ONLY_P (f
))
8913 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8914 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8915 int height
, max_height
;
8916 int unit
= FRAME_LINE_HEIGHT (f
);
8917 struct text_pos start
;
8918 struct buffer
*old_current_buffer
= NULL
;
8920 if (current_buffer
!= XBUFFER (w
->buffer
))
8922 old_current_buffer
= current_buffer
;
8923 set_buffer_internal (XBUFFER (w
->buffer
));
8926 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8928 /* Compute the max. number of lines specified by the user. */
8929 if (FLOATP (Vmax_mini_window_height
))
8930 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8931 else if (INTEGERP (Vmax_mini_window_height
))
8932 max_height
= XINT (Vmax_mini_window_height
);
8934 max_height
= total_height
/ 4;
8936 /* Correct that max. height if it's bogus. */
8937 max_height
= max (1, max_height
);
8938 max_height
= min (total_height
, max_height
);
8940 /* Find out the height of the text in the window. */
8941 if (it
.line_wrap
== TRUNCATE
)
8946 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8947 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8948 height
= it
.current_y
+ last_height
;
8950 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8951 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8952 height
= (height
+ unit
- 1) / unit
;
8955 /* Compute a suitable window start. */
8956 if (height
> max_height
)
8958 height
= max_height
;
8959 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8960 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8961 start
= it
.current
.pos
;
8964 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8965 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8967 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8969 /* Let it grow only, until we display an empty message, in which
8970 case the window shrinks again. */
8971 if (height
> WINDOW_TOTAL_LINES (w
))
8973 int old_height
= WINDOW_TOTAL_LINES (w
);
8974 freeze_window_starts (f
, 1);
8975 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8976 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8978 else if (height
< WINDOW_TOTAL_LINES (w
)
8979 && (exact_p
|| BEGV
== ZV
))
8981 int old_height
= WINDOW_TOTAL_LINES (w
);
8982 freeze_window_starts (f
, 0);
8983 shrink_mini_window (w
);
8984 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8989 /* Always resize to exact size needed. */
8990 if (height
> WINDOW_TOTAL_LINES (w
))
8992 int old_height
= WINDOW_TOTAL_LINES (w
);
8993 freeze_window_starts (f
, 1);
8994 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8995 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8997 else if (height
< WINDOW_TOTAL_LINES (w
))
8999 int old_height
= WINDOW_TOTAL_LINES (w
);
9000 freeze_window_starts (f
, 0);
9001 shrink_mini_window (w
);
9005 freeze_window_starts (f
, 1);
9006 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9009 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9013 if (old_current_buffer
)
9014 set_buffer_internal (old_current_buffer
);
9017 return window_height_changed_p
;
9021 /* Value is the current message, a string, or nil if there is no
9025 current_message (void)
9029 if (!BUFFERP (echo_area_buffer
[0]))
9033 with_echo_area_buffer (0, 0, current_message_1
,
9034 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9036 echo_area_buffer
[0] = Qnil
;
9044 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9046 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9049 *msg
= make_buffer_string (BEG
, Z
, 1);
9056 /* Push the current message on Vmessage_stack for later restauration
9057 by restore_message. Value is non-zero if the current message isn't
9058 empty. This is a relatively infrequent operation, so it's not
9059 worth optimizing. */
9065 msg
= current_message ();
9066 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9067 return STRINGP (msg
);
9071 /* Restore message display from the top of Vmessage_stack. */
9074 restore_message (void)
9078 xassert (CONSP (Vmessage_stack
));
9079 msg
= XCAR (Vmessage_stack
);
9081 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9083 message3_nolog (msg
, 0, 0);
9087 /* Handler for record_unwind_protect calling pop_message. */
9090 pop_message_unwind (Lisp_Object dummy
)
9096 /* Pop the top-most entry off Vmessage_stack. */
9101 xassert (CONSP (Vmessage_stack
));
9102 Vmessage_stack
= XCDR (Vmessage_stack
);
9106 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9107 exits. If the stack is not empty, we have a missing pop_message
9111 check_message_stack (void)
9113 if (!NILP (Vmessage_stack
))
9118 /* Truncate to NCHARS what will be displayed in the echo area the next
9119 time we display it---but don't redisplay it now. */
9122 truncate_echo_area (EMACS_INT nchars
)
9125 echo_area_buffer
[0] = Qnil
;
9126 /* A null message buffer means that the frame hasn't really been
9127 initialized yet. Error messages get reported properly by
9128 cmd_error, so this must be just an informative message; toss it. */
9129 else if (!noninteractive
9131 && !NILP (echo_area_buffer
[0]))
9133 struct frame
*sf
= SELECTED_FRAME ();
9134 if (FRAME_MESSAGE_BUF (sf
))
9135 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9140 /* Helper function for truncate_echo_area. Truncate the current
9141 message to at most NCHARS characters. */
9144 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9146 if (BEG
+ nchars
< Z
)
9147 del_range (BEG
+ nchars
, Z
);
9149 echo_area_buffer
[0] = Qnil
;
9154 /* Set the current message to a substring of S or STRING.
9156 If STRING is a Lisp string, set the message to the first NBYTES
9157 bytes from STRING. NBYTES zero means use the whole string. If
9158 STRING is multibyte, the message will be displayed multibyte.
9160 If S is not null, set the message to the first LEN bytes of S. LEN
9161 zero means use the whole string. MULTIBYTE_P non-zero means S is
9162 multibyte. Display the message multibyte in that case.
9164 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9165 to t before calling set_message_1 (which calls insert).
9169 set_message (const char *s
, Lisp_Object string
,
9170 EMACS_INT nbytes
, int multibyte_p
)
9172 message_enable_multibyte
9173 = ((s
&& multibyte_p
)
9174 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9176 with_echo_area_buffer (0, -1, set_message_1
,
9177 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9178 message_buf_print
= 0;
9179 help_echo_showing_p
= 0;
9183 /* Helper function for set_message. Arguments have the same meaning
9184 as there, with A1 corresponding to S and A2 corresponding to STRING
9185 This function is called with the echo area buffer being
9189 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9191 const char *s
= (const char *) a1
;
9192 const unsigned char *msg
= (const unsigned char *) s
;
9193 Lisp_Object string
= a2
;
9195 /* Change multibyteness of the echo buffer appropriately. */
9196 if (message_enable_multibyte
9197 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9198 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9200 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9201 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9202 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9204 /* Insert new message at BEG. */
9205 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9207 if (STRINGP (string
))
9212 nbytes
= SBYTES (string
);
9213 nchars
= string_byte_to_char (string
, nbytes
);
9215 /* This function takes care of single/multibyte conversion. We
9216 just have to ensure that the echo area buffer has the right
9217 setting of enable_multibyte_characters. */
9218 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9223 nbytes
= strlen (s
);
9225 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9227 /* Convert from multi-byte to single-byte. */
9232 /* Convert a multibyte string to single-byte. */
9233 for (i
= 0; i
< nbytes
; i
+= n
)
9235 c
= string_char_and_length (msg
+ i
, &n
);
9236 work
[0] = (ASCII_CHAR_P (c
)
9238 : multibyte_char_to_unibyte (c
));
9239 insert_1_both (work
, 1, 1, 1, 0, 0);
9242 else if (!multibyte_p
9243 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9245 /* Convert from single-byte to multi-byte. */
9248 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9250 /* Convert a single-byte string to multibyte. */
9251 for (i
= 0; i
< nbytes
; i
++)
9254 MAKE_CHAR_MULTIBYTE (c
);
9255 n
= CHAR_STRING (c
, str
);
9256 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9260 insert_1 (s
, nbytes
, 1, 0, 0);
9267 /* Clear messages. CURRENT_P non-zero means clear the current
9268 message. LAST_DISPLAYED_P non-zero means clear the message
9272 clear_message (int current_p
, int last_displayed_p
)
9276 echo_area_buffer
[0] = Qnil
;
9277 message_cleared_p
= 1;
9280 if (last_displayed_p
)
9281 echo_area_buffer
[1] = Qnil
;
9283 message_buf_print
= 0;
9286 /* Clear garbaged frames.
9288 This function is used where the old redisplay called
9289 redraw_garbaged_frames which in turn called redraw_frame which in
9290 turn called clear_frame. The call to clear_frame was a source of
9291 flickering. I believe a clear_frame is not necessary. It should
9292 suffice in the new redisplay to invalidate all current matrices,
9293 and ensure a complete redisplay of all windows. */
9296 clear_garbaged_frames (void)
9300 Lisp_Object tail
, frame
;
9301 int changed_count
= 0;
9303 FOR_EACH_FRAME (tail
, frame
)
9305 struct frame
*f
= XFRAME (frame
);
9307 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9311 Fredraw_frame (frame
);
9312 f
->force_flush_display_p
= 1;
9314 clear_current_matrices (f
);
9323 ++windows_or_buffers_changed
;
9328 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9329 is non-zero update selected_frame. Value is non-zero if the
9330 mini-windows height has been changed. */
9333 echo_area_display (int update_frame_p
)
9335 Lisp_Object mini_window
;
9338 int window_height_changed_p
= 0;
9339 struct frame
*sf
= SELECTED_FRAME ();
9341 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9342 w
= XWINDOW (mini_window
);
9343 f
= XFRAME (WINDOW_FRAME (w
));
9345 /* Don't display if frame is invisible or not yet initialized. */
9346 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9349 #ifdef HAVE_WINDOW_SYSTEM
9350 /* When Emacs starts, selected_frame may be the initial terminal
9351 frame. If we let this through, a message would be displayed on
9353 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9355 #endif /* HAVE_WINDOW_SYSTEM */
9357 /* Redraw garbaged frames. */
9359 clear_garbaged_frames ();
9361 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9363 echo_area_window
= mini_window
;
9364 window_height_changed_p
= display_echo_area (w
);
9365 w
->must_be_updated_p
= 1;
9367 /* Update the display, unless called from redisplay_internal.
9368 Also don't update the screen during redisplay itself. The
9369 update will happen at the end of redisplay, and an update
9370 here could cause confusion. */
9371 if (update_frame_p
&& !redisplaying_p
)
9375 /* If the display update has been interrupted by pending
9376 input, update mode lines in the frame. Due to the
9377 pending input, it might have been that redisplay hasn't
9378 been called, so that mode lines above the echo area are
9379 garbaged. This looks odd, so we prevent it here. */
9380 if (!display_completed
)
9381 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9383 if (window_height_changed_p
9384 /* Don't do this if Emacs is shutting down. Redisplay
9385 needs to run hooks. */
9386 && !NILP (Vrun_hooks
))
9388 /* Must update other windows. Likewise as in other
9389 cases, don't let this update be interrupted by
9391 int count
= SPECPDL_INDEX ();
9392 specbind (Qredisplay_dont_pause
, Qt
);
9393 windows_or_buffers_changed
= 1;
9394 redisplay_internal ();
9395 unbind_to (count
, Qnil
);
9397 else if (FRAME_WINDOW_P (f
) && n
== 0)
9399 /* Window configuration is the same as before.
9400 Can do with a display update of the echo area,
9401 unless we displayed some mode lines. */
9402 update_single_window (w
, 1);
9403 FRAME_RIF (f
)->flush_display (f
);
9406 update_frame (f
, 1, 1);
9408 /* If cursor is in the echo area, make sure that the next
9409 redisplay displays the minibuffer, so that the cursor will
9410 be replaced with what the minibuffer wants. */
9411 if (cursor_in_echo_area
)
9412 ++windows_or_buffers_changed
;
9415 else if (!EQ (mini_window
, selected_window
))
9416 windows_or_buffers_changed
++;
9418 /* Last displayed message is now the current message. */
9419 echo_area_buffer
[1] = echo_area_buffer
[0];
9420 /* Inform read_char that we're not echoing. */
9421 echo_message_buffer
= Qnil
;
9423 /* Prevent redisplay optimization in redisplay_internal by resetting
9424 this_line_start_pos. This is done because the mini-buffer now
9425 displays the message instead of its buffer text. */
9426 if (EQ (mini_window
, selected_window
))
9427 CHARPOS (this_line_start_pos
) = 0;
9429 return window_height_changed_p
;
9434 /***********************************************************************
9435 Mode Lines and Frame Titles
9436 ***********************************************************************/
9438 /* A buffer for constructing non-propertized mode-line strings and
9439 frame titles in it; allocated from the heap in init_xdisp and
9440 resized as needed in store_mode_line_noprop_char. */
9442 static char *mode_line_noprop_buf
;
9444 /* The buffer's end, and a current output position in it. */
9446 static char *mode_line_noprop_buf_end
;
9447 static char *mode_line_noprop_ptr
;
9449 #define MODE_LINE_NOPROP_LEN(start) \
9450 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9453 MODE_LINE_DISPLAY
= 0,
9459 /* Alist that caches the results of :propertize.
9460 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9461 static Lisp_Object mode_line_proptrans_alist
;
9463 /* List of strings making up the mode-line. */
9464 static Lisp_Object mode_line_string_list
;
9466 /* Base face property when building propertized mode line string. */
9467 static Lisp_Object mode_line_string_face
;
9468 static Lisp_Object mode_line_string_face_prop
;
9471 /* Unwind data for mode line strings */
9473 static Lisp_Object Vmode_line_unwind_vector
;
9476 format_mode_line_unwind_data (struct buffer
*obuf
,
9480 Lisp_Object vector
, tmp
;
9482 /* Reduce consing by keeping one vector in
9483 Vwith_echo_area_save_vector. */
9484 vector
= Vmode_line_unwind_vector
;
9485 Vmode_line_unwind_vector
= Qnil
;
9488 vector
= Fmake_vector (make_number (8), Qnil
);
9490 ASET (vector
, 0, make_number (mode_line_target
));
9491 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9492 ASET (vector
, 2, mode_line_string_list
);
9493 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9494 ASET (vector
, 4, mode_line_string_face
);
9495 ASET (vector
, 5, mode_line_string_face_prop
);
9498 XSETBUFFER (tmp
, obuf
);
9501 ASET (vector
, 6, tmp
);
9502 ASET (vector
, 7, owin
);
9508 unwind_format_mode_line (Lisp_Object vector
)
9510 mode_line_target
= XINT (AREF (vector
, 0));
9511 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9512 mode_line_string_list
= AREF (vector
, 2);
9513 if (! EQ (AREF (vector
, 3), Qt
))
9514 mode_line_proptrans_alist
= AREF (vector
, 3);
9515 mode_line_string_face
= AREF (vector
, 4);
9516 mode_line_string_face_prop
= AREF (vector
, 5);
9518 if (!NILP (AREF (vector
, 7)))
9519 /* Select window before buffer, since it may change the buffer. */
9520 Fselect_window (AREF (vector
, 7), Qt
);
9522 if (!NILP (AREF (vector
, 6)))
9524 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9525 ASET (vector
, 6, Qnil
);
9528 Vmode_line_unwind_vector
= vector
;
9533 /* Store a single character C for the frame title in mode_line_noprop_buf.
9534 Re-allocate mode_line_noprop_buf if necessary. */
9537 store_mode_line_noprop_char (char c
)
9539 /* If output position has reached the end of the allocated buffer,
9540 double the buffer's size. */
9541 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9543 int len
= MODE_LINE_NOPROP_LEN (0);
9544 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9545 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9546 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9547 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9550 *mode_line_noprop_ptr
++ = c
;
9554 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9555 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9556 characters that yield more columns than PRECISION; PRECISION <= 0
9557 means copy the whole string. Pad with spaces until FIELD_WIDTH
9558 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9559 pad. Called from display_mode_element when it is used to build a
9563 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9565 const unsigned char *str
= (const unsigned char *) string
;
9567 EMACS_INT dummy
, nbytes
;
9569 /* Copy at most PRECISION chars from STR. */
9570 nbytes
= strlen (string
);
9571 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9573 store_mode_line_noprop_char (*str
++);
9575 /* Fill up with spaces until FIELD_WIDTH reached. */
9576 while (field_width
> 0
9579 store_mode_line_noprop_char (' ');
9586 /***********************************************************************
9588 ***********************************************************************/
9590 #ifdef HAVE_WINDOW_SYSTEM
9592 /* Set the title of FRAME, if it has changed. The title format is
9593 Vicon_title_format if FRAME is iconified, otherwise it is
9594 frame_title_format. */
9597 x_consider_frame_title (Lisp_Object frame
)
9599 struct frame
*f
= XFRAME (frame
);
9601 if (FRAME_WINDOW_P (f
)
9602 || FRAME_MINIBUF_ONLY_P (f
)
9603 || f
->explicit_name
)
9605 /* Do we have more than one visible frame on this X display? */
9612 int count
= SPECPDL_INDEX ();
9614 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9616 Lisp_Object other_frame
= XCAR (tail
);
9617 struct frame
*tf
= XFRAME (other_frame
);
9620 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9621 && !FRAME_MINIBUF_ONLY_P (tf
)
9622 && !EQ (other_frame
, tip_frame
)
9623 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9627 /* Set global variable indicating that multiple frames exist. */
9628 multiple_frames
= CONSP (tail
);
9630 /* Switch to the buffer of selected window of the frame. Set up
9631 mode_line_target so that display_mode_element will output into
9632 mode_line_noprop_buf; then display the title. */
9633 record_unwind_protect (unwind_format_mode_line
,
9634 format_mode_line_unwind_data
9635 (current_buffer
, selected_window
, 0));
9637 Fselect_window (f
->selected_window
, Qt
);
9638 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9639 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9641 mode_line_target
= MODE_LINE_TITLE
;
9642 title_start
= MODE_LINE_NOPROP_LEN (0);
9643 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9644 NULL
, DEFAULT_FACE_ID
);
9645 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9646 len
= MODE_LINE_NOPROP_LEN (title_start
);
9647 title
= mode_line_noprop_buf
+ title_start
;
9648 unbind_to (count
, Qnil
);
9650 /* Set the title only if it's changed. This avoids consing in
9651 the common case where it hasn't. (If it turns out that we've
9652 already wasted too much time by walking through the list with
9653 display_mode_element, then we might need to optimize at a
9654 higher level than this.) */
9655 if (! STRINGP (f
->name
)
9656 || SBYTES (f
->name
) != len
9657 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9658 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9662 #endif /* not HAVE_WINDOW_SYSTEM */
9667 /***********************************************************************
9669 ***********************************************************************/
9672 /* Prepare for redisplay by updating menu-bar item lists when
9673 appropriate. This can call eval. */
9676 prepare_menu_bars (void)
9679 struct gcpro gcpro1
, gcpro2
;
9681 Lisp_Object tooltip_frame
;
9683 #ifdef HAVE_WINDOW_SYSTEM
9684 tooltip_frame
= tip_frame
;
9686 tooltip_frame
= Qnil
;
9689 /* Update all frame titles based on their buffer names, etc. We do
9690 this before the menu bars so that the buffer-menu will show the
9691 up-to-date frame titles. */
9692 #ifdef HAVE_WINDOW_SYSTEM
9693 if (windows_or_buffers_changed
|| update_mode_lines
)
9695 Lisp_Object tail
, frame
;
9697 FOR_EACH_FRAME (tail
, frame
)
9700 if (!EQ (frame
, tooltip_frame
)
9701 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9702 x_consider_frame_title (frame
);
9705 #endif /* HAVE_WINDOW_SYSTEM */
9707 /* Update the menu bar item lists, if appropriate. This has to be
9708 done before any actual redisplay or generation of display lines. */
9709 all_windows
= (update_mode_lines
9710 || buffer_shared
> 1
9711 || windows_or_buffers_changed
);
9714 Lisp_Object tail
, frame
;
9715 int count
= SPECPDL_INDEX ();
9716 /* 1 means that update_menu_bar has run its hooks
9717 so any further calls to update_menu_bar shouldn't do so again. */
9718 int menu_bar_hooks_run
= 0;
9720 record_unwind_save_match_data ();
9722 FOR_EACH_FRAME (tail
, frame
)
9726 /* Ignore tooltip frame. */
9727 if (EQ (frame
, tooltip_frame
))
9730 /* If a window on this frame changed size, report that to
9731 the user and clear the size-change flag. */
9732 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9734 Lisp_Object functions
;
9736 /* Clear flag first in case we get an error below. */
9737 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9738 functions
= Vwindow_size_change_functions
;
9739 GCPRO2 (tail
, functions
);
9741 while (CONSP (functions
))
9743 if (!EQ (XCAR (functions
), Qt
))
9744 call1 (XCAR (functions
), frame
);
9745 functions
= XCDR (functions
);
9751 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9752 #ifdef HAVE_WINDOW_SYSTEM
9753 update_tool_bar (f
, 0);
9756 if (windows_or_buffers_changed
9758 ns_set_doc_edited (f
, Fbuffer_modified_p
9759 (XWINDOW (f
->selected_window
)->buffer
));
9764 unbind_to (count
, Qnil
);
9768 struct frame
*sf
= SELECTED_FRAME ();
9769 update_menu_bar (sf
, 1, 0);
9770 #ifdef HAVE_WINDOW_SYSTEM
9771 update_tool_bar (sf
, 1);
9777 /* Update the menu bar item list for frame F. This has to be done
9778 before we start to fill in any display lines, because it can call
9781 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9783 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9784 already ran the menu bar hooks for this redisplay, so there
9785 is no need to run them again. The return value is the
9786 updated value of this flag, to pass to the next call. */
9789 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9792 register struct window
*w
;
9794 /* If called recursively during a menu update, do nothing. This can
9795 happen when, for instance, an activate-menubar-hook causes a
9797 if (inhibit_menubar_update
)
9800 window
= FRAME_SELECTED_WINDOW (f
);
9801 w
= XWINDOW (window
);
9803 if (FRAME_WINDOW_P (f
)
9805 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9806 || defined (HAVE_NS) || defined (USE_GTK)
9807 FRAME_EXTERNAL_MENU_BAR (f
)
9809 FRAME_MENU_BAR_LINES (f
) > 0
9811 : FRAME_MENU_BAR_LINES (f
) > 0)
9813 /* If the user has switched buffers or windows, we need to
9814 recompute to reflect the new bindings. But we'll
9815 recompute when update_mode_lines is set too; that means
9816 that people can use force-mode-line-update to request
9817 that the menu bar be recomputed. The adverse effect on
9818 the rest of the redisplay algorithm is about the same as
9819 windows_or_buffers_changed anyway. */
9820 if (windows_or_buffers_changed
9821 /* This used to test w->update_mode_line, but we believe
9822 there is no need to recompute the menu in that case. */
9823 || update_mode_lines
9824 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9825 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9826 != !NILP (w
->last_had_star
))
9827 || ((!NILP (Vtransient_mark_mode
)
9828 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9829 != !NILP (w
->region_showing
)))
9831 struct buffer
*prev
= current_buffer
;
9832 int count
= SPECPDL_INDEX ();
9834 specbind (Qinhibit_menubar_update
, Qt
);
9836 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9837 if (save_match_data
)
9838 record_unwind_save_match_data ();
9839 if (NILP (Voverriding_local_map_menu_flag
))
9841 specbind (Qoverriding_terminal_local_map
, Qnil
);
9842 specbind (Qoverriding_local_map
, Qnil
);
9847 /* Run the Lucid hook. */
9848 safe_run_hooks (Qactivate_menubar_hook
);
9850 /* If it has changed current-menubar from previous value,
9851 really recompute the menu-bar from the value. */
9852 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9853 call0 (Qrecompute_lucid_menubar
);
9855 safe_run_hooks (Qmenu_bar_update_hook
);
9860 XSETFRAME (Vmenu_updating_frame
, f
);
9861 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9863 /* Redisplay the menu bar in case we changed it. */
9864 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9865 || defined (HAVE_NS) || defined (USE_GTK)
9866 if (FRAME_WINDOW_P (f
))
9868 #if defined (HAVE_NS)
9869 /* All frames on Mac OS share the same menubar. So only
9870 the selected frame should be allowed to set it. */
9871 if (f
== SELECTED_FRAME ())
9873 set_frame_menubar (f
, 0, 0);
9876 /* On a terminal screen, the menu bar is an ordinary screen
9877 line, and this makes it get updated. */
9878 w
->update_mode_line
= Qt
;
9879 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9880 /* In the non-toolkit version, the menu bar is an ordinary screen
9881 line, and this makes it get updated. */
9882 w
->update_mode_line
= Qt
;
9883 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9885 unbind_to (count
, Qnil
);
9886 set_buffer_internal_1 (prev
);
9895 /***********************************************************************
9897 ***********************************************************************/
9899 #ifdef HAVE_WINDOW_SYSTEM
9902 Nominal cursor position -- where to draw output.
9903 HPOS and VPOS are window relative glyph matrix coordinates.
9904 X and Y are window relative pixel coordinates. */
9906 struct cursor_pos output_cursor
;
9910 Set the global variable output_cursor to CURSOR. All cursor
9911 positions are relative to updated_window. */
9914 set_output_cursor (struct cursor_pos
*cursor
)
9916 output_cursor
.hpos
= cursor
->hpos
;
9917 output_cursor
.vpos
= cursor
->vpos
;
9918 output_cursor
.x
= cursor
->x
;
9919 output_cursor
.y
= cursor
->y
;
9924 Set a nominal cursor position.
9926 HPOS and VPOS are column/row positions in a window glyph matrix. X
9927 and Y are window text area relative pixel positions.
9929 If this is done during an update, updated_window will contain the
9930 window that is being updated and the position is the future output
9931 cursor position for that window. If updated_window is null, use
9932 selected_window and display the cursor at the given position. */
9935 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9939 /* If updated_window is not set, work on selected_window. */
9943 w
= XWINDOW (selected_window
);
9945 /* Set the output cursor. */
9946 output_cursor
.hpos
= hpos
;
9947 output_cursor
.vpos
= vpos
;
9948 output_cursor
.x
= x
;
9949 output_cursor
.y
= y
;
9951 /* If not called as part of an update, really display the cursor.
9952 This will also set the cursor position of W. */
9953 if (updated_window
== NULL
)
9956 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9957 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9958 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9963 #endif /* HAVE_WINDOW_SYSTEM */
9966 /***********************************************************************
9968 ***********************************************************************/
9970 #ifdef HAVE_WINDOW_SYSTEM
9972 /* Where the mouse was last time we reported a mouse event. */
9974 FRAME_PTR last_mouse_frame
;
9976 /* Tool-bar item index of the item on which a mouse button was pressed
9979 int last_tool_bar_item
;
9983 update_tool_bar_unwind (Lisp_Object frame
)
9985 selected_frame
= frame
;
9989 /* Update the tool-bar item list for frame F. This has to be done
9990 before we start to fill in any display lines. Called from
9991 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9992 and restore it here. */
9995 update_tool_bar (struct frame
*f
, int save_match_data
)
9997 #if defined (USE_GTK) || defined (HAVE_NS)
9998 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10000 int do_update
= WINDOWP (f
->tool_bar_window
)
10001 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10006 Lisp_Object window
;
10009 window
= FRAME_SELECTED_WINDOW (f
);
10010 w
= XWINDOW (window
);
10012 /* If the user has switched buffers or windows, we need to
10013 recompute to reflect the new bindings. But we'll
10014 recompute when update_mode_lines is set too; that means
10015 that people can use force-mode-line-update to request
10016 that the menu bar be recomputed. The adverse effect on
10017 the rest of the redisplay algorithm is about the same as
10018 windows_or_buffers_changed anyway. */
10019 if (windows_or_buffers_changed
10020 || !NILP (w
->update_mode_line
)
10021 || update_mode_lines
10022 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10023 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10024 != !NILP (w
->last_had_star
))
10025 || ((!NILP (Vtransient_mark_mode
)
10026 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10027 != !NILP (w
->region_showing
)))
10029 struct buffer
*prev
= current_buffer
;
10030 int count
= SPECPDL_INDEX ();
10031 Lisp_Object frame
, new_tool_bar
;
10032 int new_n_tool_bar
;
10033 struct gcpro gcpro1
;
10035 /* Set current_buffer to the buffer of the selected
10036 window of the frame, so that we get the right local
10038 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10040 /* Save match data, if we must. */
10041 if (save_match_data
)
10042 record_unwind_save_match_data ();
10044 /* Make sure that we don't accidentally use bogus keymaps. */
10045 if (NILP (Voverriding_local_map_menu_flag
))
10047 specbind (Qoverriding_terminal_local_map
, Qnil
);
10048 specbind (Qoverriding_local_map
, Qnil
);
10051 GCPRO1 (new_tool_bar
);
10053 /* We must temporarily set the selected frame to this frame
10054 before calling tool_bar_items, because the calculation of
10055 the tool-bar keymap uses the selected frame (see
10056 `tool-bar-make-keymap' in tool-bar.el). */
10057 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10058 XSETFRAME (frame
, f
);
10059 selected_frame
= frame
;
10061 /* Build desired tool-bar items from keymaps. */
10062 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10065 /* Redisplay the tool-bar if we changed it. */
10066 if (new_n_tool_bar
!= f
->n_tool_bar_items
10067 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10069 /* Redisplay that happens asynchronously due to an expose event
10070 may access f->tool_bar_items. Make sure we update both
10071 variables within BLOCK_INPUT so no such event interrupts. */
10073 f
->tool_bar_items
= new_tool_bar
;
10074 f
->n_tool_bar_items
= new_n_tool_bar
;
10075 w
->update_mode_line
= Qt
;
10081 unbind_to (count
, Qnil
);
10082 set_buffer_internal_1 (prev
);
10088 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10089 F's desired tool-bar contents. F->tool_bar_items must have
10090 been set up previously by calling prepare_menu_bars. */
10093 build_desired_tool_bar_string (struct frame
*f
)
10095 int i
, size
, size_needed
;
10096 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10097 Lisp_Object image
, plist
, props
;
10099 image
= plist
= props
= Qnil
;
10100 GCPRO3 (image
, plist
, props
);
10102 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10103 Otherwise, make a new string. */
10105 /* The size of the string we might be able to reuse. */
10106 size
= (STRINGP (f
->desired_tool_bar_string
)
10107 ? SCHARS (f
->desired_tool_bar_string
)
10110 /* We need one space in the string for each image. */
10111 size_needed
= f
->n_tool_bar_items
;
10113 /* Reuse f->desired_tool_bar_string, if possible. */
10114 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10115 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10116 make_number (' '));
10119 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10120 Fremove_text_properties (make_number (0), make_number (size
),
10121 props
, f
->desired_tool_bar_string
);
10124 /* Put a `display' property on the string for the images to display,
10125 put a `menu_item' property on tool-bar items with a value that
10126 is the index of the item in F's tool-bar item vector. */
10127 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10129 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10131 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10132 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10133 int hmargin
, vmargin
, relief
, idx
, end
;
10135 /* If image is a vector, choose the image according to the
10137 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10138 if (VECTORP (image
))
10142 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10143 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10146 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10147 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10149 xassert (ASIZE (image
) >= idx
);
10150 image
= AREF (image
, idx
);
10155 /* Ignore invalid image specifications. */
10156 if (!valid_image_p (image
))
10159 /* Display the tool-bar button pressed, or depressed. */
10160 plist
= Fcopy_sequence (XCDR (image
));
10162 /* Compute margin and relief to draw. */
10163 relief
= (tool_bar_button_relief
>= 0
10164 ? tool_bar_button_relief
10165 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10166 hmargin
= vmargin
= relief
;
10168 if (INTEGERP (Vtool_bar_button_margin
)
10169 && XINT (Vtool_bar_button_margin
) > 0)
10171 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10172 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10174 else if (CONSP (Vtool_bar_button_margin
))
10176 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10177 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10178 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10180 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10181 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10182 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10185 if (auto_raise_tool_bar_buttons_p
)
10187 /* Add a `:relief' property to the image spec if the item is
10191 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10198 /* If image is selected, display it pressed, i.e. with a
10199 negative relief. If it's not selected, display it with a
10201 plist
= Fplist_put (plist
, QCrelief
,
10203 ? make_number (-relief
)
10204 : make_number (relief
)));
10209 /* Put a margin around the image. */
10210 if (hmargin
|| vmargin
)
10212 if (hmargin
== vmargin
)
10213 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10215 plist
= Fplist_put (plist
, QCmargin
,
10216 Fcons (make_number (hmargin
),
10217 make_number (vmargin
)));
10220 /* If button is not enabled, and we don't have special images
10221 for the disabled state, make the image appear disabled by
10222 applying an appropriate algorithm to it. */
10223 if (!enabled_p
&& idx
< 0)
10224 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10226 /* Put a `display' text property on the string for the image to
10227 display. Put a `menu-item' property on the string that gives
10228 the start of this item's properties in the tool-bar items
10230 image
= Fcons (Qimage
, plist
);
10231 props
= list4 (Qdisplay
, image
,
10232 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10234 /* Let the last image hide all remaining spaces in the tool bar
10235 string. The string can be longer than needed when we reuse a
10236 previous string. */
10237 if (i
+ 1 == f
->n_tool_bar_items
)
10238 end
= SCHARS (f
->desired_tool_bar_string
);
10241 Fadd_text_properties (make_number (i
), make_number (end
),
10242 props
, f
->desired_tool_bar_string
);
10250 /* Display one line of the tool-bar of frame IT->f.
10252 HEIGHT specifies the desired height of the tool-bar line.
10253 If the actual height of the glyph row is less than HEIGHT, the
10254 row's height is increased to HEIGHT, and the icons are centered
10255 vertically in the new height.
10257 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10258 count a final empty row in case the tool-bar width exactly matches
10263 display_tool_bar_line (struct it
*it
, int height
)
10265 struct glyph_row
*row
= it
->glyph_row
;
10266 int max_x
= it
->last_visible_x
;
10267 struct glyph
*last
;
10269 prepare_desired_row (row
);
10270 row
->y
= it
->current_y
;
10272 /* Note that this isn't made use of if the face hasn't a box,
10273 so there's no need to check the face here. */
10274 it
->start_of_box_run_p
= 1;
10276 while (it
->current_x
< max_x
)
10278 int x
, n_glyphs_before
, i
, nglyphs
;
10279 struct it it_before
;
10281 /* Get the next display element. */
10282 if (!get_next_display_element (it
))
10284 /* Don't count empty row if we are counting needed tool-bar lines. */
10285 if (height
< 0 && !it
->hpos
)
10290 /* Produce glyphs. */
10291 n_glyphs_before
= row
->used
[TEXT_AREA
];
10294 PRODUCE_GLYPHS (it
);
10296 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10298 x
= it_before
.current_x
;
10299 while (i
< nglyphs
)
10301 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10303 if (x
+ glyph
->pixel_width
> max_x
)
10305 /* Glyph doesn't fit on line. Backtrack. */
10306 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10308 /* If this is the only glyph on this line, it will never fit on the
10309 tool-bar, so skip it. But ensure there is at least one glyph,
10310 so we don't accidentally disable the tool-bar. */
10311 if (n_glyphs_before
== 0
10312 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10318 x
+= glyph
->pixel_width
;
10322 /* Stop at line ends. */
10323 if (ITERATOR_AT_END_OF_LINE_P (it
))
10326 set_iterator_to_next (it
, 1);
10331 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10333 /* Use default face for the border below the tool bar.
10335 FIXME: When auto-resize-tool-bars is grow-only, there is
10336 no additional border below the possibly empty tool-bar lines.
10337 So to make the extra empty lines look "normal", we have to
10338 use the tool-bar face for the border too. */
10339 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10340 it
->face_id
= DEFAULT_FACE_ID
;
10342 extend_face_to_end_of_line (it
);
10343 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10344 last
->right_box_line_p
= 1;
10345 if (last
== row
->glyphs
[TEXT_AREA
])
10346 last
->left_box_line_p
= 1;
10348 /* Make line the desired height and center it vertically. */
10349 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10351 /* Don't add more than one line height. */
10352 height
%= FRAME_LINE_HEIGHT (it
->f
);
10353 it
->max_ascent
+= height
/ 2;
10354 it
->max_descent
+= (height
+ 1) / 2;
10357 compute_line_metrics (it
);
10359 /* If line is empty, make it occupy the rest of the tool-bar. */
10360 if (!row
->displays_text_p
)
10362 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10363 row
->visible_height
= row
->height
;
10364 row
->ascent
= row
->phys_ascent
= 0;
10365 row
->extra_line_spacing
= 0;
10368 row
->full_width_p
= 1;
10369 row
->continued_p
= 0;
10370 row
->truncated_on_left_p
= 0;
10371 row
->truncated_on_right_p
= 0;
10373 it
->current_x
= it
->hpos
= 0;
10374 it
->current_y
+= row
->height
;
10380 /* Max tool-bar height. */
10382 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10383 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10385 /* Value is the number of screen lines needed to make all tool-bar
10386 items of frame F visible. The number of actual rows needed is
10387 returned in *N_ROWS if non-NULL. */
10390 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10392 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10394 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10395 the desired matrix, so use (unused) mode-line row as temporary row to
10396 avoid destroying the first tool-bar row. */
10397 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10399 /* Initialize an iterator for iteration over
10400 F->desired_tool_bar_string in the tool-bar window of frame F. */
10401 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10402 it
.first_visible_x
= 0;
10403 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10404 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10406 while (!ITERATOR_AT_END_P (&it
))
10408 clear_glyph_row (temp_row
);
10409 it
.glyph_row
= temp_row
;
10410 display_tool_bar_line (&it
, -1);
10412 clear_glyph_row (temp_row
);
10414 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10416 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10418 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10422 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10424 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10425 (Lisp_Object frame
)
10432 frame
= selected_frame
;
10434 CHECK_FRAME (frame
);
10435 f
= XFRAME (frame
);
10437 if (WINDOWP (f
->tool_bar_window
)
10438 || (w
= XWINDOW (f
->tool_bar_window
),
10439 WINDOW_TOTAL_LINES (w
) > 0))
10441 update_tool_bar (f
, 1);
10442 if (f
->n_tool_bar_items
)
10444 build_desired_tool_bar_string (f
);
10445 nlines
= tool_bar_lines_needed (f
, NULL
);
10449 return make_number (nlines
);
10453 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10454 height should be changed. */
10457 redisplay_tool_bar (struct frame
*f
)
10461 struct glyph_row
*row
;
10463 #if defined (USE_GTK) || defined (HAVE_NS)
10464 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10465 update_frame_tool_bar (f
);
10469 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10470 do anything. This means you must start with tool-bar-lines
10471 non-zero to get the auto-sizing effect. Or in other words, you
10472 can turn off tool-bars by specifying tool-bar-lines zero. */
10473 if (!WINDOWP (f
->tool_bar_window
)
10474 || (w
= XWINDOW (f
->tool_bar_window
),
10475 WINDOW_TOTAL_LINES (w
) == 0))
10478 /* Set up an iterator for the tool-bar window. */
10479 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10480 it
.first_visible_x
= 0;
10481 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10482 row
= it
.glyph_row
;
10484 /* Build a string that represents the contents of the tool-bar. */
10485 build_desired_tool_bar_string (f
);
10486 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10488 if (f
->n_tool_bar_rows
== 0)
10492 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10493 nlines
!= WINDOW_TOTAL_LINES (w
)))
10496 int old_height
= WINDOW_TOTAL_LINES (w
);
10498 XSETFRAME (frame
, f
);
10499 Fmodify_frame_parameters (frame
,
10500 Fcons (Fcons (Qtool_bar_lines
,
10501 make_number (nlines
)),
10503 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10505 clear_glyph_matrix (w
->desired_matrix
);
10506 fonts_changed_p
= 1;
10512 /* Display as many lines as needed to display all tool-bar items. */
10514 if (f
->n_tool_bar_rows
> 0)
10516 int border
, rows
, height
, extra
;
10518 if (INTEGERP (Vtool_bar_border
))
10519 border
= XINT (Vtool_bar_border
);
10520 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10521 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10522 else if (EQ (Vtool_bar_border
, Qborder_width
))
10523 border
= f
->border_width
;
10529 rows
= f
->n_tool_bar_rows
;
10530 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10531 extra
= it
.last_visible_y
- border
- height
* rows
;
10533 while (it
.current_y
< it
.last_visible_y
)
10536 if (extra
> 0 && rows
-- > 0)
10538 h
= (extra
+ rows
- 1) / rows
;
10541 display_tool_bar_line (&it
, height
+ h
);
10546 while (it
.current_y
< it
.last_visible_y
)
10547 display_tool_bar_line (&it
, 0);
10550 /* It doesn't make much sense to try scrolling in the tool-bar
10551 window, so don't do it. */
10552 w
->desired_matrix
->no_scrolling_p
= 1;
10553 w
->must_be_updated_p
= 1;
10555 if (!NILP (Vauto_resize_tool_bars
))
10557 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10558 int change_height_p
= 0;
10560 /* If we couldn't display everything, change the tool-bar's
10561 height if there is room for more. */
10562 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10563 && it
.current_y
< max_tool_bar_height
)
10564 change_height_p
= 1;
10566 row
= it
.glyph_row
- 1;
10568 /* If there are blank lines at the end, except for a partially
10569 visible blank line at the end that is smaller than
10570 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10571 if (!row
->displays_text_p
10572 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10573 change_height_p
= 1;
10575 /* If row displays tool-bar items, but is partially visible,
10576 change the tool-bar's height. */
10577 if (row
->displays_text_p
10578 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10579 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10580 change_height_p
= 1;
10582 /* Resize windows as needed by changing the `tool-bar-lines'
10583 frame parameter. */
10584 if (change_height_p
)
10587 int old_height
= WINDOW_TOTAL_LINES (w
);
10589 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10591 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10592 && !f
->minimize_tool_bar_window_p
)
10593 ? (nlines
> old_height
)
10594 : (nlines
!= old_height
));
10595 f
->minimize_tool_bar_window_p
= 0;
10597 if (change_height_p
)
10599 XSETFRAME (frame
, f
);
10600 Fmodify_frame_parameters (frame
,
10601 Fcons (Fcons (Qtool_bar_lines
,
10602 make_number (nlines
)),
10604 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10606 clear_glyph_matrix (w
->desired_matrix
);
10607 f
->n_tool_bar_rows
= nrows
;
10608 fonts_changed_p
= 1;
10615 f
->minimize_tool_bar_window_p
= 0;
10620 /* Get information about the tool-bar item which is displayed in GLYPH
10621 on frame F. Return in *PROP_IDX the index where tool-bar item
10622 properties start in F->tool_bar_items. Value is zero if
10623 GLYPH doesn't display a tool-bar item. */
10626 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10632 /* This function can be called asynchronously, which means we must
10633 exclude any possibility that Fget_text_property signals an
10635 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10636 charpos
= max (0, charpos
);
10638 /* Get the text property `menu-item' at pos. The value of that
10639 property is the start index of this item's properties in
10640 F->tool_bar_items. */
10641 prop
= Fget_text_property (make_number (charpos
),
10642 Qmenu_item
, f
->current_tool_bar_string
);
10643 if (INTEGERP (prop
))
10645 *prop_idx
= XINT (prop
);
10655 /* Get information about the tool-bar item at position X/Y on frame F.
10656 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10657 the current matrix of the tool-bar window of F, or NULL if not
10658 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10659 item in F->tool_bar_items. Value is
10661 -1 if X/Y is not on a tool-bar item
10662 0 if X/Y is on the same item that was highlighted before.
10666 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10667 int *hpos
, int *vpos
, int *prop_idx
)
10669 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10670 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10673 /* Find the glyph under X/Y. */
10674 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10675 if (*glyph
== NULL
)
10678 /* Get the start of this tool-bar item's properties in
10679 f->tool_bar_items. */
10680 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10683 /* Is mouse on the highlighted item? */
10684 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10685 && *vpos
>= hlinfo
->mouse_face_beg_row
10686 && *vpos
<= hlinfo
->mouse_face_end_row
10687 && (*vpos
> hlinfo
->mouse_face_beg_row
10688 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10689 && (*vpos
< hlinfo
->mouse_face_end_row
10690 || *hpos
< hlinfo
->mouse_face_end_col
10691 || hlinfo
->mouse_face_past_end
))
10699 Handle mouse button event on the tool-bar of frame F, at
10700 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10701 0 for button release. MODIFIERS is event modifiers for button
10705 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10706 unsigned int modifiers
)
10708 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10709 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10710 int hpos
, vpos
, prop_idx
;
10711 struct glyph
*glyph
;
10712 Lisp_Object enabled_p
;
10714 /* If not on the highlighted tool-bar item, return. */
10715 frame_to_window_pixel_xy (w
, &x
, &y
);
10716 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10719 /* If item is disabled, do nothing. */
10720 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10721 if (NILP (enabled_p
))
10726 /* Show item in pressed state. */
10727 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10728 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10729 last_tool_bar_item
= prop_idx
;
10733 Lisp_Object key
, frame
;
10734 struct input_event event
;
10735 EVENT_INIT (event
);
10737 /* Show item in released state. */
10738 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10739 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10741 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10743 XSETFRAME (frame
, f
);
10744 event
.kind
= TOOL_BAR_EVENT
;
10745 event
.frame_or_window
= frame
;
10747 kbd_buffer_store_event (&event
);
10749 event
.kind
= TOOL_BAR_EVENT
;
10750 event
.frame_or_window
= frame
;
10752 event
.modifiers
= modifiers
;
10753 kbd_buffer_store_event (&event
);
10754 last_tool_bar_item
= -1;
10759 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10760 tool-bar window-relative coordinates X/Y. Called from
10761 note_mouse_highlight. */
10764 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10766 Lisp_Object window
= f
->tool_bar_window
;
10767 struct window
*w
= XWINDOW (window
);
10768 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10769 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10771 struct glyph
*glyph
;
10772 struct glyph_row
*row
;
10774 Lisp_Object enabled_p
;
10776 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10777 int mouse_down_p
, rc
;
10779 /* Function note_mouse_highlight is called with negative X/Y
10780 values when mouse moves outside of the frame. */
10781 if (x
<= 0 || y
<= 0)
10783 clear_mouse_face (hlinfo
);
10787 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10790 /* Not on tool-bar item. */
10791 clear_mouse_face (hlinfo
);
10795 /* On same tool-bar item as before. */
10796 goto set_help_echo
;
10798 clear_mouse_face (hlinfo
);
10800 /* Mouse is down, but on different tool-bar item? */
10801 mouse_down_p
= (dpyinfo
->grabbed
10802 && f
== last_mouse_frame
10803 && FRAME_LIVE_P (f
));
10805 && last_tool_bar_item
!= prop_idx
)
10808 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10809 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10811 /* If tool-bar item is not enabled, don't highlight it. */
10812 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10813 if (!NILP (enabled_p
))
10815 /* Compute the x-position of the glyph. In front and past the
10816 image is a space. We include this in the highlighted area. */
10817 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10818 for (i
= x
= 0; i
< hpos
; ++i
)
10819 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10821 /* Record this as the current active region. */
10822 hlinfo
->mouse_face_beg_col
= hpos
;
10823 hlinfo
->mouse_face_beg_row
= vpos
;
10824 hlinfo
->mouse_face_beg_x
= x
;
10825 hlinfo
->mouse_face_beg_y
= row
->y
;
10826 hlinfo
->mouse_face_past_end
= 0;
10828 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10829 hlinfo
->mouse_face_end_row
= vpos
;
10830 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10831 hlinfo
->mouse_face_end_y
= row
->y
;
10832 hlinfo
->mouse_face_window
= window
;
10833 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10835 /* Display it as active. */
10836 show_mouse_face (hlinfo
, draw
);
10837 hlinfo
->mouse_face_image_state
= draw
;
10842 /* Set help_echo_string to a help string to display for this tool-bar item.
10843 XTread_socket does the rest. */
10844 help_echo_object
= help_echo_window
= Qnil
;
10845 help_echo_pos
= -1;
10846 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10847 if (NILP (help_echo_string
))
10848 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10851 #endif /* HAVE_WINDOW_SYSTEM */
10855 /************************************************************************
10856 Horizontal scrolling
10857 ************************************************************************/
10859 static int hscroll_window_tree (Lisp_Object
);
10860 static int hscroll_windows (Lisp_Object
);
10862 /* For all leaf windows in the window tree rooted at WINDOW, set their
10863 hscroll value so that PT is (i) visible in the window, and (ii) so
10864 that it is not within a certain margin at the window's left and
10865 right border. Value is non-zero if any window's hscroll has been
10869 hscroll_window_tree (Lisp_Object window
)
10871 int hscrolled_p
= 0;
10872 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10873 int hscroll_step_abs
= 0;
10874 double hscroll_step_rel
= 0;
10876 if (hscroll_relative_p
)
10878 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10879 if (hscroll_step_rel
< 0)
10881 hscroll_relative_p
= 0;
10882 hscroll_step_abs
= 0;
10885 else if (INTEGERP (Vhscroll_step
))
10887 hscroll_step_abs
= XINT (Vhscroll_step
);
10888 if (hscroll_step_abs
< 0)
10889 hscroll_step_abs
= 0;
10892 hscroll_step_abs
= 0;
10894 while (WINDOWP (window
))
10896 struct window
*w
= XWINDOW (window
);
10898 if (WINDOWP (w
->hchild
))
10899 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10900 else if (WINDOWP (w
->vchild
))
10901 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10902 else if (w
->cursor
.vpos
>= 0)
10905 int text_area_width
;
10906 struct glyph_row
*current_cursor_row
10907 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10908 struct glyph_row
*desired_cursor_row
10909 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10910 struct glyph_row
*cursor_row
10911 = (desired_cursor_row
->enabled_p
10912 ? desired_cursor_row
10913 : current_cursor_row
);
10915 text_area_width
= window_box_width (w
, TEXT_AREA
);
10917 /* Scroll when cursor is inside this scroll margin. */
10918 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10920 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10921 && ((XFASTINT (w
->hscroll
)
10922 && w
->cursor
.x
<= h_margin
)
10923 || (cursor_row
->enabled_p
10924 && cursor_row
->truncated_on_right_p
10925 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10929 struct buffer
*saved_current_buffer
;
10933 /* Find point in a display of infinite width. */
10934 saved_current_buffer
= current_buffer
;
10935 current_buffer
= XBUFFER (w
->buffer
);
10937 if (w
== XWINDOW (selected_window
))
10941 pt
= marker_position (w
->pointm
);
10942 pt
= max (BEGV
, pt
);
10946 /* Move iterator to pt starting at cursor_row->start in
10947 a line with infinite width. */
10948 init_to_row_start (&it
, w
, cursor_row
);
10949 it
.last_visible_x
= INFINITY
;
10950 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10951 current_buffer
= saved_current_buffer
;
10953 /* Position cursor in window. */
10954 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10955 hscroll
= max (0, (it
.current_x
10956 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10957 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10958 : (text_area_width
/ 2))))
10959 / FRAME_COLUMN_WIDTH (it
.f
);
10960 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10962 if (hscroll_relative_p
)
10963 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10966 wanted_x
= text_area_width
10967 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10970 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10974 if (hscroll_relative_p
)
10975 wanted_x
= text_area_width
* hscroll_step_rel
10978 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10981 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10983 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10985 /* Don't call Fset_window_hscroll if value hasn't
10986 changed because it will prevent redisplay
10988 if (XFASTINT (w
->hscroll
) != hscroll
)
10990 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10991 w
->hscroll
= make_number (hscroll
);
11000 /* Value is non-zero if hscroll of any leaf window has been changed. */
11001 return hscrolled_p
;
11005 /* Set hscroll so that cursor is visible and not inside horizontal
11006 scroll margins for all windows in the tree rooted at WINDOW. See
11007 also hscroll_window_tree above. Value is non-zero if any window's
11008 hscroll has been changed. If it has, desired matrices on the frame
11009 of WINDOW are cleared. */
11012 hscroll_windows (Lisp_Object window
)
11014 int hscrolled_p
= hscroll_window_tree (window
);
11016 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11017 return hscrolled_p
;
11022 /************************************************************************
11024 ************************************************************************/
11026 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11027 to a non-zero value. This is sometimes handy to have in a debugger
11032 /* First and last unchanged row for try_window_id. */
11034 int debug_first_unchanged_at_end_vpos
;
11035 int debug_last_unchanged_at_beg_vpos
;
11037 /* Delta vpos and y. */
11039 int debug_dvpos
, debug_dy
;
11041 /* Delta in characters and bytes for try_window_id. */
11043 EMACS_INT debug_delta
, debug_delta_bytes
;
11045 /* Values of window_end_pos and window_end_vpos at the end of
11048 EMACS_INT debug_end_vpos
;
11050 /* Append a string to W->desired_matrix->method. FMT is a printf
11051 format string. A1...A9 are a supplement for a variable-length
11052 argument list. If trace_redisplay_p is non-zero also printf the
11053 resulting string to stderr. */
11056 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11059 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11062 char *method
= w
->desired_matrix
->method
;
11063 int len
= strlen (method
);
11064 int size
= sizeof w
->desired_matrix
->method
;
11065 int remaining
= size
- len
- 1;
11067 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11068 if (len
&& remaining
)
11071 --remaining
, ++len
;
11074 strncpy (method
+ len
, buffer
, remaining
);
11076 if (trace_redisplay_p
)
11077 fprintf (stderr
, "%p (%s): %s\n",
11079 ((BUFFERP (w
->buffer
)
11080 && STRINGP (XBUFFER (w
->buffer
)->name
))
11081 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11086 #endif /* GLYPH_DEBUG */
11089 /* Value is non-zero if all changes in window W, which displays
11090 current_buffer, are in the text between START and END. START is a
11091 buffer position, END is given as a distance from Z. Used in
11092 redisplay_internal for display optimization. */
11095 text_outside_line_unchanged_p (struct window
*w
,
11096 EMACS_INT start
, EMACS_INT end
)
11098 int unchanged_p
= 1;
11100 /* If text or overlays have changed, see where. */
11101 if (XFASTINT (w
->last_modified
) < MODIFF
11102 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11104 /* Gap in the line? */
11105 if (GPT
< start
|| Z
- GPT
< end
)
11108 /* Changes start in front of the line, or end after it? */
11110 && (BEG_UNCHANGED
< start
- 1
11111 || END_UNCHANGED
< end
))
11114 /* If selective display, can't optimize if changes start at the
11115 beginning of the line. */
11117 && INTEGERP (BVAR (current_buffer
, selective_display
))
11118 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11119 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11122 /* If there are overlays at the start or end of the line, these
11123 may have overlay strings with newlines in them. A change at
11124 START, for instance, may actually concern the display of such
11125 overlay strings as well, and they are displayed on different
11126 lines. So, quickly rule out this case. (For the future, it
11127 might be desirable to implement something more telling than
11128 just BEG/END_UNCHANGED.) */
11131 if (BEG
+ BEG_UNCHANGED
== start
11132 && overlay_touches_p (start
))
11134 if (END_UNCHANGED
== end
11135 && overlay_touches_p (Z
- end
))
11139 /* Under bidi reordering, adding or deleting a character in the
11140 beginning of a paragraph, before the first strong directional
11141 character, can change the base direction of the paragraph (unless
11142 the buffer specifies a fixed paragraph direction), which will
11143 require to redisplay the whole paragraph. It might be worthwhile
11144 to find the paragraph limits and widen the range of redisplayed
11145 lines to that, but for now just give up this optimization. */
11146 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11147 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11151 return unchanged_p
;
11155 /* Do a frame update, taking possible shortcuts into account. This is
11156 the main external entry point for redisplay.
11158 If the last redisplay displayed an echo area message and that message
11159 is no longer requested, we clear the echo area or bring back the
11160 mini-buffer if that is in use. */
11165 redisplay_internal ();
11170 overlay_arrow_string_or_property (Lisp_Object var
)
11174 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11177 return Voverlay_arrow_string
;
11180 /* Return 1 if there are any overlay-arrows in current_buffer. */
11182 overlay_arrow_in_current_buffer_p (void)
11186 for (vlist
= Voverlay_arrow_variable_list
;
11188 vlist
= XCDR (vlist
))
11190 Lisp_Object var
= XCAR (vlist
);
11193 if (!SYMBOLP (var
))
11195 val
= find_symbol_value (var
);
11197 && current_buffer
== XMARKER (val
)->buffer
)
11204 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11208 overlay_arrows_changed_p (void)
11212 for (vlist
= Voverlay_arrow_variable_list
;
11214 vlist
= XCDR (vlist
))
11216 Lisp_Object var
= XCAR (vlist
);
11217 Lisp_Object val
, pstr
;
11219 if (!SYMBOLP (var
))
11221 val
= find_symbol_value (var
);
11222 if (!MARKERP (val
))
11224 if (! EQ (COERCE_MARKER (val
),
11225 Fget (var
, Qlast_arrow_position
))
11226 || ! (pstr
= overlay_arrow_string_or_property (var
),
11227 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11233 /* Mark overlay arrows to be updated on next redisplay. */
11236 update_overlay_arrows (int up_to_date
)
11240 for (vlist
= Voverlay_arrow_variable_list
;
11242 vlist
= XCDR (vlist
))
11244 Lisp_Object var
= XCAR (vlist
);
11246 if (!SYMBOLP (var
))
11249 if (up_to_date
> 0)
11251 Lisp_Object val
= find_symbol_value (var
);
11252 Fput (var
, Qlast_arrow_position
,
11253 COERCE_MARKER (val
));
11254 Fput (var
, Qlast_arrow_string
,
11255 overlay_arrow_string_or_property (var
));
11257 else if (up_to_date
< 0
11258 || !NILP (Fget (var
, Qlast_arrow_position
)))
11260 Fput (var
, Qlast_arrow_position
, Qt
);
11261 Fput (var
, Qlast_arrow_string
, Qt
);
11267 /* Return overlay arrow string to display at row.
11268 Return integer (bitmap number) for arrow bitmap in left fringe.
11269 Return nil if no overlay arrow. */
11272 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11276 for (vlist
= Voverlay_arrow_variable_list
;
11278 vlist
= XCDR (vlist
))
11280 Lisp_Object var
= XCAR (vlist
);
11283 if (!SYMBOLP (var
))
11286 val
= find_symbol_value (var
);
11289 && current_buffer
== XMARKER (val
)->buffer
11290 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11292 if (FRAME_WINDOW_P (it
->f
)
11293 /* FIXME: if ROW->reversed_p is set, this should test
11294 the right fringe, not the left one. */
11295 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11297 #ifdef HAVE_WINDOW_SYSTEM
11298 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11301 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11302 return make_number (fringe_bitmap
);
11305 return make_number (-1); /* Use default arrow bitmap */
11307 return overlay_arrow_string_or_property (var
);
11314 /* Return 1 if point moved out of or into a composition. Otherwise
11315 return 0. PREV_BUF and PREV_PT are the last point buffer and
11316 position. BUF and PT are the current point buffer and position. */
11319 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11320 struct buffer
*buf
, EMACS_INT pt
)
11322 EMACS_INT start
, end
;
11324 Lisp_Object buffer
;
11326 XSETBUFFER (buffer
, buf
);
11327 /* Check a composition at the last point if point moved within the
11329 if (prev_buf
== buf
)
11332 /* Point didn't move. */
11335 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11336 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11337 && COMPOSITION_VALID_P (start
, end
, prop
)
11338 && start
< prev_pt
&& end
> prev_pt
)
11339 /* The last point was within the composition. Return 1 iff
11340 point moved out of the composition. */
11341 return (pt
<= start
|| pt
>= end
);
11344 /* Check a composition at the current point. */
11345 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11346 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11347 && COMPOSITION_VALID_P (start
, end
, prop
)
11348 && start
< pt
&& end
> pt
);
11352 /* Reconsider the setting of B->clip_changed which is displayed
11356 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11358 if (b
->clip_changed
11359 && !NILP (w
->window_end_valid
)
11360 && w
->current_matrix
->buffer
== b
11361 && w
->current_matrix
->zv
== BUF_ZV (b
)
11362 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11363 b
->clip_changed
= 0;
11365 /* If display wasn't paused, and W is not a tool bar window, see if
11366 point has been moved into or out of a composition. In that case,
11367 we set b->clip_changed to 1 to force updating the screen. If
11368 b->clip_changed has already been set to 1, we can skip this
11370 if (!b
->clip_changed
11371 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11375 if (w
== XWINDOW (selected_window
))
11378 pt
= marker_position (w
->pointm
);
11380 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11381 || pt
!= XINT (w
->last_point
))
11382 && check_point_in_composition (w
->current_matrix
->buffer
,
11383 XINT (w
->last_point
),
11384 XBUFFER (w
->buffer
), pt
))
11385 b
->clip_changed
= 1;
11390 /* Select FRAME to forward the values of frame-local variables into C
11391 variables so that the redisplay routines can access those values
11395 select_frame_for_redisplay (Lisp_Object frame
)
11397 Lisp_Object tail
, tem
;
11398 Lisp_Object old
= selected_frame
;
11399 struct Lisp_Symbol
*sym
;
11401 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11403 selected_frame
= frame
;
11406 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11407 if (CONSP (XCAR (tail
))
11408 && (tem
= XCAR (XCAR (tail
)),
11410 && (sym
= indirect_variable (XSYMBOL (tem
)),
11411 sym
->redirect
== SYMBOL_LOCALIZED
)
11412 && sym
->val
.blv
->frame_local
)
11413 /* Use find_symbol_value rather than Fsymbol_value
11414 to avoid an error if it is void. */
11415 find_symbol_value (tem
);
11416 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11420 #define STOP_POLLING \
11421 do { if (! polling_stopped_here) stop_polling (); \
11422 polling_stopped_here = 1; } while (0)
11424 #define RESUME_POLLING \
11425 do { if (polling_stopped_here) start_polling (); \
11426 polling_stopped_here = 0; } while (0)
11429 /* Perhaps in the future avoid recentering windows if it
11430 is not necessary; currently that causes some problems. */
11433 redisplay_internal (void)
11435 struct window
*w
= XWINDOW (selected_window
);
11439 int must_finish
= 0;
11440 struct text_pos tlbufpos
, tlendpos
;
11441 int number_of_visible_frames
;
11444 int polling_stopped_here
= 0;
11445 Lisp_Object old_frame
= selected_frame
;
11447 /* Non-zero means redisplay has to consider all windows on all
11448 frames. Zero means, only selected_window is considered. */
11449 int consider_all_windows_p
;
11451 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11453 /* No redisplay if running in batch mode or frame is not yet fully
11454 initialized, or redisplay is explicitly turned off by setting
11455 Vinhibit_redisplay. */
11456 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11457 || !NILP (Vinhibit_redisplay
))
11460 /* Don't examine these until after testing Vinhibit_redisplay.
11461 When Emacs is shutting down, perhaps because its connection to
11462 X has dropped, we should not look at them at all. */
11463 fr
= XFRAME (w
->frame
);
11464 sf
= SELECTED_FRAME ();
11466 if (!fr
->glyphs_initialized_p
)
11469 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11470 if (popup_activated ())
11474 /* I don't think this happens but let's be paranoid. */
11475 if (redisplaying_p
)
11478 /* Record a function that resets redisplaying_p to its old value
11479 when we leave this function. */
11480 count
= SPECPDL_INDEX ();
11481 record_unwind_protect (unwind_redisplay
,
11482 Fcons (make_number (redisplaying_p
), selected_frame
));
11484 specbind (Qinhibit_free_realized_faces
, Qnil
);
11487 Lisp_Object tail
, frame
;
11489 FOR_EACH_FRAME (tail
, frame
)
11491 struct frame
*f
= XFRAME (frame
);
11492 f
->already_hscrolled_p
= 0;
11497 /* Remember the currently selected window. */
11500 if (!EQ (old_frame
, selected_frame
)
11501 && FRAME_LIVE_P (XFRAME (old_frame
)))
11502 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11503 selected_frame and selected_window to be temporarily out-of-sync so
11504 when we come back here via `goto retry', we need to resync because we
11505 may need to run Elisp code (via prepare_menu_bars). */
11506 select_frame_for_redisplay (old_frame
);
11509 reconsider_clip_changes (w
, current_buffer
);
11510 last_escape_glyph_frame
= NULL
;
11511 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11512 last_glyphless_glyph_frame
= NULL
;
11513 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11515 /* If new fonts have been loaded that make a glyph matrix adjustment
11516 necessary, do it. */
11517 if (fonts_changed_p
)
11519 adjust_glyphs (NULL
);
11520 ++windows_or_buffers_changed
;
11521 fonts_changed_p
= 0;
11524 /* If face_change_count is non-zero, init_iterator will free all
11525 realized faces, which includes the faces referenced from current
11526 matrices. So, we can't reuse current matrices in this case. */
11527 if (face_change_count
)
11528 ++windows_or_buffers_changed
;
11530 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11531 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11533 /* Since frames on a single ASCII terminal share the same
11534 display area, displaying a different frame means redisplay
11535 the whole thing. */
11536 windows_or_buffers_changed
++;
11537 SET_FRAME_GARBAGED (sf
);
11539 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11541 FRAME_TTY (sf
)->previous_frame
= sf
;
11544 /* Set the visible flags for all frames. Do this before checking
11545 for resized or garbaged frames; they want to know if their frames
11546 are visible. See the comment in frame.h for
11547 FRAME_SAMPLE_VISIBILITY. */
11549 Lisp_Object tail
, frame
;
11551 number_of_visible_frames
= 0;
11553 FOR_EACH_FRAME (tail
, frame
)
11555 struct frame
*f
= XFRAME (frame
);
11557 FRAME_SAMPLE_VISIBILITY (f
);
11558 if (FRAME_VISIBLE_P (f
))
11559 ++number_of_visible_frames
;
11560 clear_desired_matrices (f
);
11564 /* Notice any pending interrupt request to change frame size. */
11565 do_pending_window_change (1);
11567 /* do_pending_window_change could change the selected_window due to
11568 frame resizing which makes the selected window too small. */
11569 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11572 reconsider_clip_changes (w
, current_buffer
);
11575 /* Clear frames marked as garbaged. */
11576 if (frame_garbaged
)
11577 clear_garbaged_frames ();
11579 /* Build menubar and tool-bar items. */
11580 if (NILP (Vmemory_full
))
11581 prepare_menu_bars ();
11583 if (windows_or_buffers_changed
)
11584 update_mode_lines
++;
11586 /* Detect case that we need to write or remove a star in the mode line. */
11587 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11589 w
->update_mode_line
= Qt
;
11590 if (buffer_shared
> 1)
11591 update_mode_lines
++;
11594 /* Avoid invocation of point motion hooks by `current_column' below. */
11595 count1
= SPECPDL_INDEX ();
11596 specbind (Qinhibit_point_motion_hooks
, Qt
);
11598 /* If %c is in the mode line, update it if needed. */
11599 if (!NILP (w
->column_number_displayed
)
11600 /* This alternative quickly identifies a common case
11601 where no change is needed. */
11602 && !(PT
== XFASTINT (w
->last_point
)
11603 && XFASTINT (w
->last_modified
) >= MODIFF
11604 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11605 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11606 w
->update_mode_line
= Qt
;
11608 unbind_to (count1
, Qnil
);
11610 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11612 /* The variable buffer_shared is set in redisplay_window and
11613 indicates that we redisplay a buffer in different windows. See
11615 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11616 || cursor_type_changed
);
11618 /* If specs for an arrow have changed, do thorough redisplay
11619 to ensure we remove any arrow that should no longer exist. */
11620 if (overlay_arrows_changed_p ())
11621 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11623 /* Normally the message* functions will have already displayed and
11624 updated the echo area, but the frame may have been trashed, or
11625 the update may have been preempted, so display the echo area
11626 again here. Checking message_cleared_p captures the case that
11627 the echo area should be cleared. */
11628 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11629 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11630 || (message_cleared_p
11631 && minibuf_level
== 0
11632 /* If the mini-window is currently selected, this means the
11633 echo-area doesn't show through. */
11634 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11636 int window_height_changed_p
= echo_area_display (0);
11639 /* If we don't display the current message, don't clear the
11640 message_cleared_p flag, because, if we did, we wouldn't clear
11641 the echo area in the next redisplay which doesn't preserve
11643 if (!display_last_displayed_message_p
)
11644 message_cleared_p
= 0;
11646 if (fonts_changed_p
)
11648 else if (window_height_changed_p
)
11650 consider_all_windows_p
= 1;
11651 ++update_mode_lines
;
11652 ++windows_or_buffers_changed
;
11654 /* If window configuration was changed, frames may have been
11655 marked garbaged. Clear them or we will experience
11656 surprises wrt scrolling. */
11657 if (frame_garbaged
)
11658 clear_garbaged_frames ();
11661 else if (EQ (selected_window
, minibuf_window
)
11662 && (current_buffer
->clip_changed
11663 || XFASTINT (w
->last_modified
) < MODIFF
11664 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11665 && resize_mini_window (w
, 0))
11667 /* Resized active mini-window to fit the size of what it is
11668 showing if its contents might have changed. */
11670 /* FIXME: this causes all frames to be updated, which seems unnecessary
11671 since only the current frame needs to be considered. This function needs
11672 to be rewritten with two variables, consider_all_windows and
11673 consider_all_frames. */
11674 consider_all_windows_p
= 1;
11675 ++windows_or_buffers_changed
;
11676 ++update_mode_lines
;
11678 /* If window configuration was changed, frames may have been
11679 marked garbaged. Clear them or we will experience
11680 surprises wrt scrolling. */
11681 if (frame_garbaged
)
11682 clear_garbaged_frames ();
11686 /* If showing the region, and mark has changed, we must redisplay
11687 the whole window. The assignment to this_line_start_pos prevents
11688 the optimization directly below this if-statement. */
11689 if (((!NILP (Vtransient_mark_mode
)
11690 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11691 != !NILP (w
->region_showing
))
11692 || (!NILP (w
->region_showing
)
11693 && !EQ (w
->region_showing
,
11694 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11695 CHARPOS (this_line_start_pos
) = 0;
11697 /* Optimize the case that only the line containing the cursor in the
11698 selected window has changed. Variables starting with this_ are
11699 set in display_line and record information about the line
11700 containing the cursor. */
11701 tlbufpos
= this_line_start_pos
;
11702 tlendpos
= this_line_end_pos
;
11703 if (!consider_all_windows_p
11704 && CHARPOS (tlbufpos
) > 0
11705 && NILP (w
->update_mode_line
)
11706 && !current_buffer
->clip_changed
11707 && !current_buffer
->prevent_redisplay_optimizations_p
11708 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11709 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11710 /* Make sure recorded data applies to current buffer, etc. */
11711 && this_line_buffer
== current_buffer
11712 && current_buffer
== XBUFFER (w
->buffer
)
11713 && NILP (w
->force_start
)
11714 && NILP (w
->optional_new_start
)
11715 /* Point must be on the line that we have info recorded about. */
11716 && PT
>= CHARPOS (tlbufpos
)
11717 && PT
<= Z
- CHARPOS (tlendpos
)
11718 /* All text outside that line, including its final newline,
11719 must be unchanged. */
11720 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11721 CHARPOS (tlendpos
)))
11723 if (CHARPOS (tlbufpos
) > BEGV
11724 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11725 && (CHARPOS (tlbufpos
) == ZV
11726 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11727 /* Former continuation line has disappeared by becoming empty. */
11729 else if (XFASTINT (w
->last_modified
) < MODIFF
11730 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11731 || MINI_WINDOW_P (w
))
11733 /* We have to handle the case of continuation around a
11734 wide-column character (see the comment in indent.c around
11737 For instance, in the following case:
11739 -------- Insert --------
11740 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11741 J_I_ ==> J_I_ `^^' are cursors.
11745 As we have to redraw the line above, we cannot use this
11749 int line_height_before
= this_line_pixel_height
;
11751 /* Note that start_display will handle the case that the
11752 line starting at tlbufpos is a continuation line. */
11753 start_display (&it
, w
, tlbufpos
);
11755 /* Implementation note: It this still necessary? */
11756 if (it
.current_x
!= this_line_start_x
)
11759 TRACE ((stderr
, "trying display optimization 1\n"));
11760 w
->cursor
.vpos
= -1;
11761 overlay_arrow_seen
= 0;
11762 it
.vpos
= this_line_vpos
;
11763 it
.current_y
= this_line_y
;
11764 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11765 display_line (&it
);
11767 /* If line contains point, is not continued,
11768 and ends at same distance from eob as before, we win. */
11769 if (w
->cursor
.vpos
>= 0
11770 /* Line is not continued, otherwise this_line_start_pos
11771 would have been set to 0 in display_line. */
11772 && CHARPOS (this_line_start_pos
)
11773 /* Line ends as before. */
11774 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11775 /* Line has same height as before. Otherwise other lines
11776 would have to be shifted up or down. */
11777 && this_line_pixel_height
== line_height_before
)
11779 /* If this is not the window's last line, we must adjust
11780 the charstarts of the lines below. */
11781 if (it
.current_y
< it
.last_visible_y
)
11783 struct glyph_row
*row
11784 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11785 EMACS_INT delta
, delta_bytes
;
11787 /* We used to distinguish between two cases here,
11788 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11789 when the line ends in a newline or the end of the
11790 buffer's accessible portion. But both cases did
11791 the same, so they were collapsed. */
11793 - CHARPOS (tlendpos
)
11794 - MATRIX_ROW_START_CHARPOS (row
));
11795 delta_bytes
= (Z_BYTE
11796 - BYTEPOS (tlendpos
)
11797 - MATRIX_ROW_START_BYTEPOS (row
));
11799 increment_matrix_positions (w
->current_matrix
,
11800 this_line_vpos
+ 1,
11801 w
->current_matrix
->nrows
,
11802 delta
, delta_bytes
);
11805 /* If this row displays text now but previously didn't,
11806 or vice versa, w->window_end_vpos may have to be
11808 if ((it
.glyph_row
- 1)->displays_text_p
)
11810 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11811 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11813 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11814 && this_line_vpos
> 0)
11815 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11816 w
->window_end_valid
= Qnil
;
11818 /* Update hint: No need to try to scroll in update_window. */
11819 w
->desired_matrix
->no_scrolling_p
= 1;
11822 *w
->desired_matrix
->method
= 0;
11823 debug_method_add (w
, "optimization 1");
11825 #ifdef HAVE_WINDOW_SYSTEM
11826 update_window_fringes (w
, 0);
11833 else if (/* Cursor position hasn't changed. */
11834 PT
== XFASTINT (w
->last_point
)
11835 /* Make sure the cursor was last displayed
11836 in this window. Otherwise we have to reposition it. */
11837 && 0 <= w
->cursor
.vpos
11838 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11842 do_pending_window_change (1);
11843 /* If selected_window changed, redisplay again. */
11844 if (WINDOWP (selected_window
)
11845 && (w
= XWINDOW (selected_window
)) != sw
)
11848 /* We used to always goto end_of_redisplay here, but this
11849 isn't enough if we have a blinking cursor. */
11850 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11851 goto end_of_redisplay
;
11855 /* If highlighting the region, or if the cursor is in the echo area,
11856 then we can't just move the cursor. */
11857 else if (! (!NILP (Vtransient_mark_mode
)
11858 && !NILP (BVAR (current_buffer
, mark_active
)))
11859 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11860 || highlight_nonselected_windows
)
11861 && NILP (w
->region_showing
)
11862 && NILP (Vshow_trailing_whitespace
)
11863 && !cursor_in_echo_area
)
11866 struct glyph_row
*row
;
11868 /* Skip from tlbufpos to PT and see where it is. Note that
11869 PT may be in invisible text. If so, we will end at the
11870 next visible position. */
11871 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11872 NULL
, DEFAULT_FACE_ID
);
11873 it
.current_x
= this_line_start_x
;
11874 it
.current_y
= this_line_y
;
11875 it
.vpos
= this_line_vpos
;
11877 /* The call to move_it_to stops in front of PT, but
11878 moves over before-strings. */
11879 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11881 if (it
.vpos
== this_line_vpos
11882 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11885 xassert (this_line_vpos
== it
.vpos
);
11886 xassert (this_line_y
== it
.current_y
);
11887 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11889 *w
->desired_matrix
->method
= 0;
11890 debug_method_add (w
, "optimization 3");
11899 /* Text changed drastically or point moved off of line. */
11900 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11903 CHARPOS (this_line_start_pos
) = 0;
11904 consider_all_windows_p
|= buffer_shared
> 1;
11905 ++clear_face_cache_count
;
11906 #ifdef HAVE_WINDOW_SYSTEM
11907 ++clear_image_cache_count
;
11910 /* Build desired matrices, and update the display. If
11911 consider_all_windows_p is non-zero, do it for all windows on all
11912 frames. Otherwise do it for selected_window, only. */
11914 if (consider_all_windows_p
)
11916 Lisp_Object tail
, frame
;
11918 FOR_EACH_FRAME (tail
, frame
)
11919 XFRAME (frame
)->updated_p
= 0;
11921 /* Recompute # windows showing selected buffer. This will be
11922 incremented each time such a window is displayed. */
11925 FOR_EACH_FRAME (tail
, frame
)
11927 struct frame
*f
= XFRAME (frame
);
11929 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11931 if (! EQ (frame
, selected_frame
))
11932 /* Select the frame, for the sake of frame-local
11934 select_frame_for_redisplay (frame
);
11936 /* Mark all the scroll bars to be removed; we'll redeem
11937 the ones we want when we redisplay their windows. */
11938 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11939 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11941 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11942 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11944 /* The X error handler may have deleted that frame. */
11945 if (!FRAME_LIVE_P (f
))
11948 /* Any scroll bars which redisplay_windows should have
11949 nuked should now go away. */
11950 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11951 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11953 /* If fonts changed, display again. */
11954 /* ??? rms: I suspect it is a mistake to jump all the way
11955 back to retry here. It should just retry this frame. */
11956 if (fonts_changed_p
)
11959 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11961 /* See if we have to hscroll. */
11962 if (!f
->already_hscrolled_p
)
11964 f
->already_hscrolled_p
= 1;
11965 if (hscroll_windows (f
->root_window
))
11969 /* Prevent various kinds of signals during display
11970 update. stdio is not robust about handling
11971 signals, which can cause an apparent I/O
11973 if (interrupt_input
)
11974 unrequest_sigio ();
11977 /* Update the display. */
11978 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11979 pending
|= update_frame (f
, 0, 0);
11985 if (!EQ (old_frame
, selected_frame
)
11986 && FRAME_LIVE_P (XFRAME (old_frame
)))
11987 /* We played a bit fast-and-loose above and allowed selected_frame
11988 and selected_window to be temporarily out-of-sync but let's make
11989 sure this stays contained. */
11990 select_frame_for_redisplay (old_frame
);
11991 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11995 /* Do the mark_window_display_accurate after all windows have
11996 been redisplayed because this call resets flags in buffers
11997 which are needed for proper redisplay. */
11998 FOR_EACH_FRAME (tail
, frame
)
12000 struct frame
*f
= XFRAME (frame
);
12003 mark_window_display_accurate (f
->root_window
, 1);
12004 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12005 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12010 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12012 Lisp_Object mini_window
;
12013 struct frame
*mini_frame
;
12015 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12016 /* Use list_of_error, not Qerror, so that
12017 we catch only errors and don't run the debugger. */
12018 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12020 redisplay_window_error
);
12022 /* Compare desired and current matrices, perform output. */
12025 /* If fonts changed, display again. */
12026 if (fonts_changed_p
)
12029 /* Prevent various kinds of signals during display update.
12030 stdio is not robust about handling signals,
12031 which can cause an apparent I/O error. */
12032 if (interrupt_input
)
12033 unrequest_sigio ();
12036 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12038 if (hscroll_windows (selected_window
))
12041 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12042 pending
= update_frame (sf
, 0, 0);
12045 /* We may have called echo_area_display at the top of this
12046 function. If the echo area is on another frame, that may
12047 have put text on a frame other than the selected one, so the
12048 above call to update_frame would not have caught it. Catch
12050 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12051 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12053 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12055 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12056 pending
|= update_frame (mini_frame
, 0, 0);
12057 if (!pending
&& hscroll_windows (mini_window
))
12062 /* If display was paused because of pending input, make sure we do a
12063 thorough update the next time. */
12066 /* Prevent the optimization at the beginning of
12067 redisplay_internal that tries a single-line update of the
12068 line containing the cursor in the selected window. */
12069 CHARPOS (this_line_start_pos
) = 0;
12071 /* Let the overlay arrow be updated the next time. */
12072 update_overlay_arrows (0);
12074 /* If we pause after scrolling, some rows in the current
12075 matrices of some windows are not valid. */
12076 if (!WINDOW_FULL_WIDTH_P (w
)
12077 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12078 update_mode_lines
= 1;
12082 if (!consider_all_windows_p
)
12084 /* This has already been done above if
12085 consider_all_windows_p is set. */
12086 mark_window_display_accurate_1 (w
, 1);
12088 /* Say overlay arrows are up to date. */
12089 update_overlay_arrows (1);
12091 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12092 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12095 update_mode_lines
= 0;
12096 windows_or_buffers_changed
= 0;
12097 cursor_type_changed
= 0;
12100 /* Start SIGIO interrupts coming again. Having them off during the
12101 code above makes it less likely one will discard output, but not
12102 impossible, since there might be stuff in the system buffer here.
12103 But it is much hairier to try to do anything about that. */
12104 if (interrupt_input
)
12108 /* If a frame has become visible which was not before, redisplay
12109 again, so that we display it. Expose events for such a frame
12110 (which it gets when becoming visible) don't call the parts of
12111 redisplay constructing glyphs, so simply exposing a frame won't
12112 display anything in this case. So, we have to display these
12113 frames here explicitly. */
12116 Lisp_Object tail
, frame
;
12119 FOR_EACH_FRAME (tail
, frame
)
12121 int this_is_visible
= 0;
12123 if (XFRAME (frame
)->visible
)
12124 this_is_visible
= 1;
12125 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12126 if (XFRAME (frame
)->visible
)
12127 this_is_visible
= 1;
12129 if (this_is_visible
)
12133 if (new_count
!= number_of_visible_frames
)
12134 windows_or_buffers_changed
++;
12137 /* Change frame size now if a change is pending. */
12138 do_pending_window_change (1);
12140 /* If we just did a pending size change, or have additional
12141 visible frames, or selected_window changed, redisplay again. */
12142 if ((windows_or_buffers_changed
&& !pending
)
12143 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12146 /* Clear the face and image caches.
12148 We used to do this only if consider_all_windows_p. But the cache
12149 needs to be cleared if a timer creates images in the current
12150 buffer (e.g. the test case in Bug#6230). */
12152 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12154 clear_face_cache (0);
12155 clear_face_cache_count
= 0;
12158 #ifdef HAVE_WINDOW_SYSTEM
12159 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12161 clear_image_caches (Qnil
);
12162 clear_image_cache_count
= 0;
12164 #endif /* HAVE_WINDOW_SYSTEM */
12167 unbind_to (count
, Qnil
);
12172 /* Redisplay, but leave alone any recent echo area message unless
12173 another message has been requested in its place.
12175 This is useful in situations where you need to redisplay but no
12176 user action has occurred, making it inappropriate for the message
12177 area to be cleared. See tracking_off and
12178 wait_reading_process_output for examples of these situations.
12180 FROM_WHERE is an integer saying from where this function was
12181 called. This is useful for debugging. */
12184 redisplay_preserve_echo_area (int from_where
)
12186 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12188 if (!NILP (echo_area_buffer
[1]))
12190 /* We have a previously displayed message, but no current
12191 message. Redisplay the previous message. */
12192 display_last_displayed_message_p
= 1;
12193 redisplay_internal ();
12194 display_last_displayed_message_p
= 0;
12197 redisplay_internal ();
12199 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12200 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12201 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12205 /* Function registered with record_unwind_protect in
12206 redisplay_internal. Reset redisplaying_p to the value it had
12207 before redisplay_internal was called, and clear
12208 prevent_freeing_realized_faces_p. It also selects the previously
12209 selected frame, unless it has been deleted (by an X connection
12210 failure during redisplay, for example). */
12213 unwind_redisplay (Lisp_Object val
)
12215 Lisp_Object old_redisplaying_p
, old_frame
;
12217 old_redisplaying_p
= XCAR (val
);
12218 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12219 old_frame
= XCDR (val
);
12220 if (! EQ (old_frame
, selected_frame
)
12221 && FRAME_LIVE_P (XFRAME (old_frame
)))
12222 select_frame_for_redisplay (old_frame
);
12227 /* Mark the display of window W as accurate or inaccurate. If
12228 ACCURATE_P is non-zero mark display of W as accurate. If
12229 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12230 redisplay_internal is called. */
12233 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12235 if (BUFFERP (w
->buffer
))
12237 struct buffer
*b
= XBUFFER (w
->buffer
);
12240 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12241 w
->last_overlay_modified
12242 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12244 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12248 b
->clip_changed
= 0;
12249 b
->prevent_redisplay_optimizations_p
= 0;
12251 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12252 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12253 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12254 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12256 w
->current_matrix
->buffer
= b
;
12257 w
->current_matrix
->begv
= BUF_BEGV (b
);
12258 w
->current_matrix
->zv
= BUF_ZV (b
);
12260 w
->last_cursor
= w
->cursor
;
12261 w
->last_cursor_off_p
= w
->cursor_off_p
;
12263 if (w
== XWINDOW (selected_window
))
12264 w
->last_point
= make_number (BUF_PT (b
));
12266 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12272 w
->window_end_valid
= w
->buffer
;
12273 w
->update_mode_line
= Qnil
;
12278 /* Mark the display of windows in the window tree rooted at WINDOW as
12279 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12280 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12281 be redisplayed the next time redisplay_internal is called. */
12284 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12288 for (; !NILP (window
); window
= w
->next
)
12290 w
= XWINDOW (window
);
12291 mark_window_display_accurate_1 (w
, accurate_p
);
12293 if (!NILP (w
->vchild
))
12294 mark_window_display_accurate (w
->vchild
, accurate_p
);
12295 if (!NILP (w
->hchild
))
12296 mark_window_display_accurate (w
->hchild
, accurate_p
);
12301 update_overlay_arrows (1);
12305 /* Force a thorough redisplay the next time by setting
12306 last_arrow_position and last_arrow_string to t, which is
12307 unequal to any useful value of Voverlay_arrow_... */
12308 update_overlay_arrows (-1);
12313 /* Return value in display table DP (Lisp_Char_Table *) for character
12314 C. Since a display table doesn't have any parent, we don't have to
12315 follow parent. Do not call this function directly but use the
12316 macro DISP_CHAR_VECTOR. */
12319 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12323 if (ASCII_CHAR_P (c
))
12326 if (SUB_CHAR_TABLE_P (val
))
12327 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12333 XSETCHAR_TABLE (table
, dp
);
12334 val
= char_table_ref (table
, c
);
12343 /***********************************************************************
12345 ***********************************************************************/
12347 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12350 redisplay_windows (Lisp_Object window
)
12352 while (!NILP (window
))
12354 struct window
*w
= XWINDOW (window
);
12356 if (!NILP (w
->hchild
))
12357 redisplay_windows (w
->hchild
);
12358 else if (!NILP (w
->vchild
))
12359 redisplay_windows (w
->vchild
);
12360 else if (!NILP (w
->buffer
))
12362 displayed_buffer
= XBUFFER (w
->buffer
);
12363 /* Use list_of_error, not Qerror, so that
12364 we catch only errors and don't run the debugger. */
12365 internal_condition_case_1 (redisplay_window_0
, window
,
12367 redisplay_window_error
);
12375 redisplay_window_error (Lisp_Object ignore
)
12377 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12382 redisplay_window_0 (Lisp_Object window
)
12384 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12385 redisplay_window (window
, 0);
12390 redisplay_window_1 (Lisp_Object window
)
12392 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12393 redisplay_window (window
, 1);
12398 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12399 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12400 which positions recorded in ROW differ from current buffer
12403 Return 0 if cursor is not on this row, 1 otherwise. */
12406 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12407 struct glyph_matrix
*matrix
,
12408 EMACS_INT delta
, EMACS_INT delta_bytes
,
12411 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12412 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12413 struct glyph
*cursor
= NULL
;
12414 /* The last known character position in row. */
12415 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12417 EMACS_INT pt_old
= PT
- delta
;
12418 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12419 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12420 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12421 /* A glyph beyond the edge of TEXT_AREA which we should never
12423 struct glyph
*glyphs_end
= end
;
12424 /* Non-zero means we've found a match for cursor position, but that
12425 glyph has the avoid_cursor_p flag set. */
12426 int match_with_avoid_cursor
= 0;
12427 /* Non-zero means we've seen at least one glyph that came from a
12429 int string_seen
= 0;
12430 /* Largest and smalles buffer positions seen so far during scan of
12432 EMACS_INT bpos_max
= pos_before
;
12433 EMACS_INT bpos_min
= pos_after
;
12434 /* Last buffer position covered by an overlay string with an integer
12435 `cursor' property. */
12436 EMACS_INT bpos_covered
= 0;
12438 /* Skip over glyphs not having an object at the start and the end of
12439 the row. These are special glyphs like truncation marks on
12440 terminal frames. */
12441 if (row
->displays_text_p
)
12443 if (!row
->reversed_p
)
12446 && INTEGERP (glyph
->object
)
12447 && glyph
->charpos
< 0)
12449 x
+= glyph
->pixel_width
;
12453 && INTEGERP ((end
- 1)->object
)
12454 /* CHARPOS is zero for blanks and stretch glyphs
12455 inserted by extend_face_to_end_of_line. */
12456 && (end
- 1)->charpos
<= 0)
12458 glyph_before
= glyph
- 1;
12465 /* If the glyph row is reversed, we need to process it from back
12466 to front, so swap the edge pointers. */
12467 glyphs_end
= end
= glyph
- 1;
12468 glyph
+= row
->used
[TEXT_AREA
] - 1;
12470 while (glyph
> end
+ 1
12471 && INTEGERP (glyph
->object
)
12472 && glyph
->charpos
< 0)
12475 x
-= glyph
->pixel_width
;
12477 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12479 /* By default, in reversed rows we put the cursor on the
12480 rightmost (first in the reading order) glyph. */
12481 for (g
= end
+ 1; g
< glyph
; g
++)
12482 x
+= g
->pixel_width
;
12484 && INTEGERP ((end
+ 1)->object
)
12485 && (end
+ 1)->charpos
<= 0)
12487 glyph_before
= glyph
+ 1;
12491 else if (row
->reversed_p
)
12493 /* In R2L rows that don't display text, put the cursor on the
12494 rightmost glyph. Case in point: an empty last line that is
12495 part of an R2L paragraph. */
12497 /* Avoid placing the cursor on the last glyph of the row, where
12498 on terminal frames we hold the vertical border between
12499 adjacent windows. */
12500 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12501 && !WINDOW_RIGHTMOST_P (w
)
12502 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12504 x
= -1; /* will be computed below, at label compute_x */
12507 /* Step 1: Try to find the glyph whose character position
12508 corresponds to point. If that's not possible, find 2 glyphs
12509 whose character positions are the closest to point, one before
12510 point, the other after it. */
12511 if (!row
->reversed_p
)
12512 while (/* not marched to end of glyph row */
12514 /* glyph was not inserted by redisplay for internal purposes */
12515 && !INTEGERP (glyph
->object
))
12517 if (BUFFERP (glyph
->object
))
12519 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12521 if (glyph
->charpos
> bpos_max
)
12522 bpos_max
= glyph
->charpos
;
12523 if (glyph
->charpos
< bpos_min
)
12524 bpos_min
= glyph
->charpos
;
12525 if (!glyph
->avoid_cursor_p
)
12527 /* If we hit point, we've found the glyph on which to
12528 display the cursor. */
12531 match_with_avoid_cursor
= 0;
12534 /* See if we've found a better approximation to
12535 POS_BEFORE or to POS_AFTER. Note that we want the
12536 first (leftmost) glyph of all those that are the
12537 closest from below, and the last (rightmost) of all
12538 those from above. */
12539 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12541 pos_before
= glyph
->charpos
;
12542 glyph_before
= glyph
;
12544 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12546 pos_after
= glyph
->charpos
;
12547 glyph_after
= glyph
;
12550 else if (dpos
== 0)
12551 match_with_avoid_cursor
= 1;
12553 else if (STRINGP (glyph
->object
))
12555 Lisp_Object chprop
;
12556 EMACS_INT glyph_pos
= glyph
->charpos
;
12558 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12560 if (INTEGERP (chprop
))
12562 bpos_covered
= bpos_max
+ XINT (chprop
);
12563 /* If the `cursor' property covers buffer positions up
12564 to and including point, we should display cursor on
12565 this glyph. Note that overlays and text properties
12566 with string values stop bidi reordering, so every
12567 buffer position to the left of the string is always
12568 smaller than any position to the right of the
12569 string. Therefore, if a `cursor' property on one
12570 of the string's characters has an integer value, we
12571 will break out of the loop below _before_ we get to
12572 the position match above. IOW, integer values of
12573 the `cursor' property override the "exact match for
12574 point" strategy of positioning the cursor. */
12575 /* Implementation note: bpos_max == pt_old when, e.g.,
12576 we are in an empty line, where bpos_max is set to
12577 MATRIX_ROW_START_CHARPOS, see above. */
12578 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12587 x
+= glyph
->pixel_width
;
12590 else if (glyph
> end
) /* row is reversed */
12591 while (!INTEGERP (glyph
->object
))
12593 if (BUFFERP (glyph
->object
))
12595 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12597 if (glyph
->charpos
> bpos_max
)
12598 bpos_max
= glyph
->charpos
;
12599 if (glyph
->charpos
< bpos_min
)
12600 bpos_min
= glyph
->charpos
;
12601 if (!glyph
->avoid_cursor_p
)
12605 match_with_avoid_cursor
= 0;
12608 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12610 pos_before
= glyph
->charpos
;
12611 glyph_before
= glyph
;
12613 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12615 pos_after
= glyph
->charpos
;
12616 glyph_after
= glyph
;
12619 else if (dpos
== 0)
12620 match_with_avoid_cursor
= 1;
12622 else if (STRINGP (glyph
->object
))
12624 Lisp_Object chprop
;
12625 EMACS_INT glyph_pos
= glyph
->charpos
;
12627 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12629 if (INTEGERP (chprop
))
12631 bpos_covered
= bpos_max
+ XINT (chprop
);
12632 /* If the `cursor' property covers buffer positions up
12633 to and including point, we should display cursor on
12635 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12644 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12646 x
--; /* can't use any pixel_width */
12649 x
-= glyph
->pixel_width
;
12652 /* Step 2: If we didn't find an exact match for point, we need to
12653 look for a proper place to put the cursor among glyphs between
12654 GLYPH_BEFORE and GLYPH_AFTER. */
12655 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12656 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12657 && bpos_covered
< pt_old
)
12659 /* An empty line has a single glyph whose OBJECT is zero and
12660 whose CHARPOS is the position of a newline on that line.
12661 Note that on a TTY, there are more glyphs after that, which
12662 were produced by extend_face_to_end_of_line, but their
12663 CHARPOS is zero or negative. */
12665 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12666 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12668 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12670 EMACS_INT ellipsis_pos
;
12672 /* Scan back over the ellipsis glyphs. */
12673 if (!row
->reversed_p
)
12675 ellipsis_pos
= (glyph
- 1)->charpos
;
12676 while (glyph
> row
->glyphs
[TEXT_AREA
]
12677 && (glyph
- 1)->charpos
== ellipsis_pos
)
12678 glyph
--, x
-= glyph
->pixel_width
;
12679 /* That loop always goes one position too far, including
12680 the glyph before the ellipsis. So scan forward over
12682 x
+= glyph
->pixel_width
;
12685 else /* row is reversed */
12687 ellipsis_pos
= (glyph
+ 1)->charpos
;
12688 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12689 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12690 glyph
++, x
+= glyph
->pixel_width
;
12691 x
-= glyph
->pixel_width
;
12695 else if (match_with_avoid_cursor
12696 /* A truncated row may not include PT among its
12697 character positions. Setting the cursor inside the
12698 scroll margin will trigger recalculation of hscroll
12699 in hscroll_window_tree. */
12700 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12701 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12702 /* Zero-width characters produce no glyphs. */
12705 && (row
->reversed_p
12706 ? glyph_after
> glyphs_end
12707 : glyph_after
< glyphs_end
)))
12709 cursor
= glyph_after
;
12712 else if (string_seen
)
12714 int incr
= row
->reversed_p
? -1 : +1;
12716 /* Need to find the glyph that came out of a string which is
12717 present at point. That glyph is somewhere between
12718 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12719 positioned between POS_BEFORE and POS_AFTER in the
12721 struct glyph
*stop
= glyph_after
;
12722 EMACS_INT pos
= pos_before
;
12725 for (glyph
= glyph_before
+ incr
;
12726 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12729 /* Any glyphs that come from the buffer are here because
12730 of bidi reordering. Skip them, and only pay
12731 attention to glyphs that came from some string. */
12732 if (STRINGP (glyph
->object
))
12737 str
= glyph
->object
;
12738 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
12739 if (tem
== 0 /* from overlay */
12742 /* If the string from which this glyph came is
12743 found in the buffer at point, then we've
12744 found the glyph we've been looking for. If
12745 it comes from an overlay (tem == 0), and it
12746 has the `cursor' property on one of its
12747 glyphs, record that glyph as a candidate for
12748 displaying the cursor. (As in the
12749 unidirectional version, we will display the
12750 cursor on the last candidate we find.) */
12751 if (tem
== 0 || tem
== pt_old
)
12753 /* The glyphs from this string could have
12754 been reordered. Find the one with the
12755 smallest string position. Or there could
12756 be a character in the string with the
12757 `cursor' property, which means display
12758 cursor on that character's glyph. */
12759 EMACS_INT strpos
= glyph
->charpos
;
12764 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12765 && EQ (glyph
->object
, str
);
12769 EMACS_INT gpos
= glyph
->charpos
;
12771 cprop
= Fget_char_property (make_number (gpos
),
12779 if (tem
&& glyph
->charpos
< strpos
)
12781 strpos
= glyph
->charpos
;
12790 pos
= tem
+ 1; /* don't find previous instances */
12792 /* This string is not what we want; skip all of the
12793 glyphs that came from it. */
12794 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12795 && EQ (glyph
->object
, str
))
12802 /* If we reached the end of the line, and END was from a string,
12803 the cursor is not on this line. */
12805 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12806 && STRINGP (end
->object
)
12807 && row
->continued_p
)
12813 if (cursor
!= NULL
)
12819 /* Need to compute x that corresponds to GLYPH. */
12820 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12822 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12824 x
+= g
->pixel_width
;
12828 /* ROW could be part of a continued line, which, under bidi
12829 reordering, might have other rows whose start and end charpos
12830 occlude point. Only set w->cursor if we found a better
12831 approximation to the cursor position than we have from previously
12832 examined candidate rows belonging to the same continued line. */
12833 if (/* we already have a candidate row */
12834 w
->cursor
.vpos
>= 0
12835 /* that candidate is not the row we are processing */
12836 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12837 /* the row we are processing is part of a continued line */
12838 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12839 /* Make sure cursor.vpos specifies a row whose start and end
12840 charpos occlude point. This is because some callers of this
12841 function leave cursor.vpos at the row where the cursor was
12842 displayed during the last redisplay cycle. */
12843 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12844 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12847 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12849 /* Don't consider glyphs that are outside TEXT_AREA. */
12850 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12852 /* Keep the candidate whose buffer position is the closest to
12854 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12855 w
->cursor
.hpos
>= 0
12856 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12857 && BUFFERP (g1
->object
)
12858 && (g1
->charpos
== pt_old
/* an exact match always wins */
12859 || (BUFFERP (glyph
->object
)
12860 && eabs (g1
->charpos
- pt_old
)
12861 < eabs (glyph
->charpos
- pt_old
))))
12863 /* If this candidate gives an exact match, use that. */
12864 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12865 /* Otherwise, keep the candidate that comes from a row
12866 spanning less buffer positions. This may win when one or
12867 both candidate positions are on glyphs that came from
12868 display strings, for which we cannot compare buffer
12870 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12871 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12872 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12875 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12877 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12878 w
->cursor
.y
= row
->y
+ dy
;
12880 if (w
== XWINDOW (selected_window
))
12882 if (!row
->continued_p
12883 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12886 this_line_buffer
= XBUFFER (w
->buffer
);
12888 CHARPOS (this_line_start_pos
)
12889 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12890 BYTEPOS (this_line_start_pos
)
12891 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12893 CHARPOS (this_line_end_pos
)
12894 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12895 BYTEPOS (this_line_end_pos
)
12896 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12898 this_line_y
= w
->cursor
.y
;
12899 this_line_pixel_height
= row
->height
;
12900 this_line_vpos
= w
->cursor
.vpos
;
12901 this_line_start_x
= row
->x
;
12904 CHARPOS (this_line_start_pos
) = 0;
12911 /* Run window scroll functions, if any, for WINDOW with new window
12912 start STARTP. Sets the window start of WINDOW to that position.
12914 We assume that the window's buffer is really current. */
12916 static INLINE
struct text_pos
12917 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12919 struct window
*w
= XWINDOW (window
);
12920 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12922 if (current_buffer
!= XBUFFER (w
->buffer
))
12925 if (!NILP (Vwindow_scroll_functions
))
12927 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12928 make_number (CHARPOS (startp
)));
12929 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12930 /* In case the hook functions switch buffers. */
12931 if (current_buffer
!= XBUFFER (w
->buffer
))
12932 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12939 /* Make sure the line containing the cursor is fully visible.
12940 A value of 1 means there is nothing to be done.
12941 (Either the line is fully visible, or it cannot be made so,
12942 or we cannot tell.)
12944 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12945 is higher than window.
12947 A value of 0 means the caller should do scrolling
12948 as if point had gone off the screen. */
12951 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12953 struct glyph_matrix
*matrix
;
12954 struct glyph_row
*row
;
12957 if (!make_cursor_line_fully_visible_p
)
12960 /* It's not always possible to find the cursor, e.g, when a window
12961 is full of overlay strings. Don't do anything in that case. */
12962 if (w
->cursor
.vpos
< 0)
12965 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12966 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12968 /* If the cursor row is not partially visible, there's nothing to do. */
12969 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12972 /* If the row the cursor is in is taller than the window's height,
12973 it's not clear what to do, so do nothing. */
12974 window_height
= window_box_height (w
);
12975 if (row
->height
>= window_height
)
12977 if (!force_p
|| MINI_WINDOW_P (w
)
12978 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12985 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12986 non-zero means only WINDOW is redisplayed in redisplay_internal.
12987 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
12988 in redisplay_window to bring a partially visible line into view in
12989 the case that only the cursor has moved.
12991 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12992 last screen line's vertical height extends past the end of the screen.
12996 1 if scrolling succeeded
12998 0 if scrolling didn't find point.
13000 -1 if new fonts have been loaded so that we must interrupt
13001 redisplay, adjust glyph matrices, and try again. */
13007 SCROLLING_NEED_LARGER_MATRICES
13010 /* If scroll-conservatively is more than this, never recenter.
13012 If you change this, don't forget to update the doc string of
13013 `scroll-conservatively' and the Emacs manual. */
13014 #define SCROLL_LIMIT 100
13017 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13018 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13019 int temp_scroll_step
, int last_line_misfit
)
13021 struct window
*w
= XWINDOW (window
);
13022 struct frame
*f
= XFRAME (w
->frame
);
13023 struct text_pos pos
, startp
;
13025 int this_scroll_margin
, scroll_max
, rc
, height
;
13026 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13027 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13028 Lisp_Object aggressive
;
13029 /* We will never try scrolling more than this number of lines. */
13030 int scroll_limit
= SCROLL_LIMIT
;
13033 debug_method_add (w
, "try_scrolling");
13036 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13038 /* Compute scroll margin height in pixels. We scroll when point is
13039 within this distance from the top or bottom of the window. */
13040 if (scroll_margin
> 0)
13041 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13042 * FRAME_LINE_HEIGHT (f
);
13044 this_scroll_margin
= 0;
13046 /* Force arg_scroll_conservatively to have a reasonable value, to
13047 avoid scrolling too far away with slow move_it_* functions. Note
13048 that the user can supply scroll-conservatively equal to
13049 `most-positive-fixnum', which can be larger than INT_MAX. */
13050 if (arg_scroll_conservatively
> scroll_limit
)
13052 arg_scroll_conservatively
= scroll_limit
+ 1;
13053 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13055 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13056 /* Compute how much we should try to scroll maximally to bring
13057 point into view. */
13058 scroll_max
= (max (scroll_step
,
13059 max (arg_scroll_conservatively
, temp_scroll_step
))
13060 * FRAME_LINE_HEIGHT (f
));
13061 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13062 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13063 /* We're trying to scroll because of aggressive scrolling but no
13064 scroll_step is set. Choose an arbitrary one. */
13065 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13071 /* Decide whether to scroll down. */
13072 if (PT
> CHARPOS (startp
))
13074 int scroll_margin_y
;
13076 /* Compute the pixel ypos of the scroll margin, then move it to
13077 either that ypos or PT, whichever comes first. */
13078 start_display (&it
, w
, startp
);
13079 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13080 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13081 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13082 (MOVE_TO_POS
| MOVE_TO_Y
));
13084 if (PT
> CHARPOS (it
.current
.pos
))
13086 int y0
= line_bottom_y (&it
);
13087 /* Compute how many pixels below window bottom to stop searching
13088 for PT. This avoids costly search for PT that is far away if
13089 the user limited scrolling by a small number of lines, but
13090 always finds PT if scroll_conservatively is set to a large
13091 number, such as most-positive-fixnum. */
13092 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13093 int y_to_move
= it
.last_visible_y
+ slack
;
13095 /* Compute the distance from the scroll margin to PT or to
13096 the scroll limit, whichever comes first. This should
13097 include the height of the cursor line, to make that line
13099 move_it_to (&it
, PT
, -1, y_to_move
,
13100 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13101 dy
= line_bottom_y (&it
) - y0
;
13103 if (dy
> scroll_max
)
13104 return SCROLLING_FAILED
;
13112 /* Point is in or below the bottom scroll margin, so move the
13113 window start down. If scrolling conservatively, move it just
13114 enough down to make point visible. If scroll_step is set,
13115 move it down by scroll_step. */
13116 if (arg_scroll_conservatively
)
13118 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13119 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13120 else if (scroll_step
|| temp_scroll_step
)
13121 amount_to_scroll
= scroll_max
;
13124 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13125 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13126 if (NUMBERP (aggressive
))
13128 double float_amount
= XFLOATINT (aggressive
) * height
;
13129 amount_to_scroll
= float_amount
;
13130 if (amount_to_scroll
== 0 && float_amount
> 0)
13131 amount_to_scroll
= 1;
13132 /* Don't let point enter the scroll margin near top of
13134 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13135 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13139 if (amount_to_scroll
<= 0)
13140 return SCROLLING_FAILED
;
13142 start_display (&it
, w
, startp
);
13143 if (arg_scroll_conservatively
<= scroll_limit
)
13144 move_it_vertically (&it
, amount_to_scroll
);
13147 /* Extra precision for users who set scroll-conservatively
13148 to a large number: make sure the amount we scroll
13149 the window start is never less than amount_to_scroll,
13150 which was computed as distance from window bottom to
13151 point. This matters when lines at window top and lines
13152 below window bottom have different height. */
13153 struct it it1
= it
;
13154 /* We use a temporary it1 because line_bottom_y can modify
13155 its argument, if it moves one line down; see there. */
13156 int start_y
= line_bottom_y (&it1
);
13159 move_it_by_lines (&it
, 1);
13161 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13164 /* If STARTP is unchanged, move it down another screen line. */
13165 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13166 move_it_by_lines (&it
, 1);
13167 startp
= it
.current
.pos
;
13171 struct text_pos scroll_margin_pos
= startp
;
13173 /* See if point is inside the scroll margin at the top of the
13175 if (this_scroll_margin
)
13177 start_display (&it
, w
, startp
);
13178 move_it_vertically (&it
, this_scroll_margin
);
13179 scroll_margin_pos
= it
.current
.pos
;
13182 if (PT
< CHARPOS (scroll_margin_pos
))
13184 /* Point is in the scroll margin at the top of the window or
13185 above what is displayed in the window. */
13188 /* Compute the vertical distance from PT to the scroll
13189 margin position. Move as far as scroll_max allows, or
13190 one screenful, or 10 screen lines, whichever is largest.
13191 Give up if distance is greater than scroll_max. */
13192 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13193 start_display (&it
, w
, pos
);
13195 y_to_move
= max (it
.last_visible_y
,
13196 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13197 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13199 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13200 dy
= it
.current_y
- y0
;
13201 if (dy
> scroll_max
)
13202 return SCROLLING_FAILED
;
13204 /* Compute new window start. */
13205 start_display (&it
, w
, startp
);
13207 if (arg_scroll_conservatively
)
13208 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13209 max (scroll_step
, temp_scroll_step
));
13210 else if (scroll_step
|| temp_scroll_step
)
13211 amount_to_scroll
= scroll_max
;
13214 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13215 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13216 if (NUMBERP (aggressive
))
13218 double float_amount
= XFLOATINT (aggressive
) * height
;
13219 amount_to_scroll
= float_amount
;
13220 if (amount_to_scroll
== 0 && float_amount
> 0)
13221 amount_to_scroll
= 1;
13222 amount_to_scroll
-=
13223 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13224 /* Don't let point enter the scroll margin near
13225 bottom of the window. */
13226 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13227 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13231 if (amount_to_scroll
<= 0)
13232 return SCROLLING_FAILED
;
13234 move_it_vertically_backward (&it
, amount_to_scroll
);
13235 startp
= it
.current
.pos
;
13239 /* Run window scroll functions. */
13240 startp
= run_window_scroll_functions (window
, startp
);
13242 /* Display the window. Give up if new fonts are loaded, or if point
13244 if (!try_window (window
, startp
, 0))
13245 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13246 else if (w
->cursor
.vpos
< 0)
13248 clear_glyph_matrix (w
->desired_matrix
);
13249 rc
= SCROLLING_FAILED
;
13253 /* Maybe forget recorded base line for line number display. */
13254 if (!just_this_one_p
13255 || current_buffer
->clip_changed
13256 || BEG_UNCHANGED
< CHARPOS (startp
))
13257 w
->base_line_number
= Qnil
;
13259 /* If cursor ends up on a partially visible line,
13260 treat that as being off the bottom of the screen. */
13261 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13262 /* It's possible that the cursor is on the first line of the
13263 buffer, which is partially obscured due to a vscroll
13264 (Bug#7537). In that case, avoid looping forever . */
13265 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13267 clear_glyph_matrix (w
->desired_matrix
);
13268 ++extra_scroll_margin_lines
;
13271 rc
= SCROLLING_SUCCESS
;
13278 /* Compute a suitable window start for window W if display of W starts
13279 on a continuation line. Value is non-zero if a new window start
13282 The new window start will be computed, based on W's width, starting
13283 from the start of the continued line. It is the start of the
13284 screen line with the minimum distance from the old start W->start. */
13287 compute_window_start_on_continuation_line (struct window
*w
)
13289 struct text_pos pos
, start_pos
;
13290 int window_start_changed_p
= 0;
13292 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13294 /* If window start is on a continuation line... Window start may be
13295 < BEGV in case there's invisible text at the start of the
13296 buffer (M-x rmail, for example). */
13297 if (CHARPOS (start_pos
) > BEGV
13298 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13301 struct glyph_row
*row
;
13303 /* Handle the case that the window start is out of range. */
13304 if (CHARPOS (start_pos
) < BEGV
)
13305 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13306 else if (CHARPOS (start_pos
) > ZV
)
13307 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13309 /* Find the start of the continued line. This should be fast
13310 because scan_buffer is fast (newline cache). */
13311 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13312 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13313 row
, DEFAULT_FACE_ID
);
13314 reseat_at_previous_visible_line_start (&it
);
13316 /* If the line start is "too far" away from the window start,
13317 say it takes too much time to compute a new window start. */
13318 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13319 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13321 int min_distance
, distance
;
13323 /* Move forward by display lines to find the new window
13324 start. If window width was enlarged, the new start can
13325 be expected to be > the old start. If window width was
13326 decreased, the new window start will be < the old start.
13327 So, we're looking for the display line start with the
13328 minimum distance from the old window start. */
13329 pos
= it
.current
.pos
;
13330 min_distance
= INFINITY
;
13331 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13332 distance
< min_distance
)
13334 min_distance
= distance
;
13335 pos
= it
.current
.pos
;
13336 move_it_by_lines (&it
, 1);
13339 /* Set the window start there. */
13340 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13341 window_start_changed_p
= 1;
13345 return window_start_changed_p
;
13349 /* Try cursor movement in case text has not changed in window WINDOW,
13350 with window start STARTP. Value is
13352 CURSOR_MOVEMENT_SUCCESS if successful
13354 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13356 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13357 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13358 we want to scroll as if scroll-step were set to 1. See the code.
13360 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13361 which case we have to abort this redisplay, and adjust matrices
13366 CURSOR_MOVEMENT_SUCCESS
,
13367 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13368 CURSOR_MOVEMENT_MUST_SCROLL
,
13369 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13373 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13375 struct window
*w
= XWINDOW (window
);
13376 struct frame
*f
= XFRAME (w
->frame
);
13377 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13380 if (inhibit_try_cursor_movement
)
13384 /* Handle case where text has not changed, only point, and it has
13385 not moved off the frame. */
13386 if (/* Point may be in this window. */
13387 PT
>= CHARPOS (startp
)
13388 /* Selective display hasn't changed. */
13389 && !current_buffer
->clip_changed
13390 /* Function force-mode-line-update is used to force a thorough
13391 redisplay. It sets either windows_or_buffers_changed or
13392 update_mode_lines. So don't take a shortcut here for these
13394 && !update_mode_lines
13395 && !windows_or_buffers_changed
13396 && !cursor_type_changed
13397 /* Can't use this case if highlighting a region. When a
13398 region exists, cursor movement has to do more than just
13400 && !(!NILP (Vtransient_mark_mode
)
13401 && !NILP (BVAR (current_buffer
, mark_active
)))
13402 && NILP (w
->region_showing
)
13403 && NILP (Vshow_trailing_whitespace
)
13404 /* Right after splitting windows, last_point may be nil. */
13405 && INTEGERP (w
->last_point
)
13406 /* This code is not used for mini-buffer for the sake of the case
13407 of redisplaying to replace an echo area message; since in
13408 that case the mini-buffer contents per se are usually
13409 unchanged. This code is of no real use in the mini-buffer
13410 since the handling of this_line_start_pos, etc., in redisplay
13411 handles the same cases. */
13412 && !EQ (window
, minibuf_window
)
13413 /* When splitting windows or for new windows, it happens that
13414 redisplay is called with a nil window_end_vpos or one being
13415 larger than the window. This should really be fixed in
13416 window.c. I don't have this on my list, now, so we do
13417 approximately the same as the old redisplay code. --gerd. */
13418 && INTEGERP (w
->window_end_vpos
)
13419 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13420 && (FRAME_WINDOW_P (f
)
13421 || !overlay_arrow_in_current_buffer_p ()))
13423 int this_scroll_margin
, top_scroll_margin
;
13424 struct glyph_row
*row
= NULL
;
13427 debug_method_add (w
, "cursor movement");
13430 /* Scroll if point within this distance from the top or bottom
13431 of the window. This is a pixel value. */
13432 if (scroll_margin
> 0)
13434 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13435 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13438 this_scroll_margin
= 0;
13440 top_scroll_margin
= this_scroll_margin
;
13441 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13442 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13444 /* Start with the row the cursor was displayed during the last
13445 not paused redisplay. Give up if that row is not valid. */
13446 if (w
->last_cursor
.vpos
< 0
13447 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13448 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13451 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13452 if (row
->mode_line_p
)
13454 if (!row
->enabled_p
)
13455 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13458 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13460 int scroll_p
= 0, must_scroll
= 0;
13461 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13463 if (PT
> XFASTINT (w
->last_point
))
13465 /* Point has moved forward. */
13466 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13467 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13469 xassert (row
->enabled_p
);
13473 /* If the end position of a row equals the start
13474 position of the next row, and PT is at that position,
13475 we would rather display cursor in the next line. */
13476 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13477 && MATRIX_ROW_END_CHARPOS (row
) == PT
13478 && row
< w
->current_matrix
->rows
13479 + w
->current_matrix
->nrows
- 1
13480 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13481 && !cursor_row_p (row
))
13484 /* If within the scroll margin, scroll. Note that
13485 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13486 the next line would be drawn, and that
13487 this_scroll_margin can be zero. */
13488 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13489 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13490 /* Line is completely visible last line in window
13491 and PT is to be set in the next line. */
13492 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13493 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13494 && !row
->ends_at_zv_p
13495 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13498 else if (PT
< XFASTINT (w
->last_point
))
13500 /* Cursor has to be moved backward. Note that PT >=
13501 CHARPOS (startp) because of the outer if-statement. */
13502 while (!row
->mode_line_p
13503 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13504 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13505 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13506 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13507 row
> w
->current_matrix
->rows
13508 && (row
-1)->ends_in_newline_from_string_p
))))
13509 && (row
->y
> top_scroll_margin
13510 || CHARPOS (startp
) == BEGV
))
13512 xassert (row
->enabled_p
);
13516 /* Consider the following case: Window starts at BEGV,
13517 there is invisible, intangible text at BEGV, so that
13518 display starts at some point START > BEGV. It can
13519 happen that we are called with PT somewhere between
13520 BEGV and START. Try to handle that case. */
13521 if (row
< w
->current_matrix
->rows
13522 || row
->mode_line_p
)
13524 row
= w
->current_matrix
->rows
;
13525 if (row
->mode_line_p
)
13529 /* Due to newlines in overlay strings, we may have to
13530 skip forward over overlay strings. */
13531 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13532 && MATRIX_ROW_END_CHARPOS (row
) == PT
13533 && !cursor_row_p (row
))
13536 /* If within the scroll margin, scroll. */
13537 if (row
->y
< top_scroll_margin
13538 && CHARPOS (startp
) != BEGV
)
13543 /* Cursor did not move. So don't scroll even if cursor line
13544 is partially visible, as it was so before. */
13545 rc
= CURSOR_MOVEMENT_SUCCESS
;
13548 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13549 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13551 /* if PT is not in the glyph row, give up. */
13552 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13555 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13556 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13558 /* If rows are bidi-reordered and point moved, back up
13559 until we find a row that does not belong to a
13560 continuation line. This is because we must consider
13561 all rows of a continued line as candidates for the
13562 new cursor positioning, since row start and end
13563 positions change non-linearly with vertical position
13565 /* FIXME: Revisit this when glyph ``spilling'' in
13566 continuation lines' rows is implemented for
13567 bidi-reordered rows. */
13568 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13570 xassert (row
->enabled_p
);
13572 /* If we hit the beginning of the displayed portion
13573 without finding the first row of a continued
13575 if (row
<= w
->current_matrix
->rows
)
13577 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13585 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13586 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13587 && make_cursor_line_fully_visible_p
)
13589 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13590 && !row
->ends_at_zv_p
13591 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13592 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13593 else if (row
->height
> window_box_height (w
))
13595 /* If we end up in a partially visible line, let's
13596 make it fully visible, except when it's taller
13597 than the window, in which case we can't do much
13600 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13604 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13605 if (!cursor_row_fully_visible_p (w
, 0, 1))
13606 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13608 rc
= CURSOR_MOVEMENT_SUCCESS
;
13612 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13613 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13614 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13616 /* With bidi-reordered rows, there could be more than
13617 one candidate row whose start and end positions
13618 occlude point. We need to let set_cursor_from_row
13619 find the best candidate. */
13620 /* FIXME: Revisit this when glyph ``spilling'' in
13621 continuation lines' rows is implemented for
13622 bidi-reordered rows. */
13627 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13628 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13629 && cursor_row_p (row
))
13630 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13632 /* As soon as we've found the first suitable row
13633 whose ends_at_zv_p flag is set, we are done. */
13635 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13637 rc
= CURSOR_MOVEMENT_SUCCESS
;
13642 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13643 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13644 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13645 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13646 /* If we didn't find any candidate rows, or exited the
13647 loop before all the candidates were examined, signal
13648 to the caller that this method failed. */
13649 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13650 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13651 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13653 rc
= CURSOR_MOVEMENT_SUCCESS
;
13659 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13661 rc
= CURSOR_MOVEMENT_SUCCESS
;
13666 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13667 && MATRIX_ROW_START_CHARPOS (row
) == PT
13668 && cursor_row_p (row
));
13677 set_vertical_scroll_bar (struct window
*w
)
13679 EMACS_INT start
, end
, whole
;
13681 /* Calculate the start and end positions for the current window.
13682 At some point, it would be nice to choose between scrollbars
13683 which reflect the whole buffer size, with special markers
13684 indicating narrowing, and scrollbars which reflect only the
13687 Note that mini-buffers sometimes aren't displaying any text. */
13688 if (!MINI_WINDOW_P (w
)
13689 || (w
== XWINDOW (minibuf_window
)
13690 && NILP (echo_area_buffer
[0])))
13692 struct buffer
*buf
= XBUFFER (w
->buffer
);
13693 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13694 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13695 /* I don't think this is guaranteed to be right. For the
13696 moment, we'll pretend it is. */
13697 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13701 if (whole
< (end
- start
))
13702 whole
= end
- start
;
13705 start
= end
= whole
= 0;
13707 /* Indicate what this scroll bar ought to be displaying now. */
13708 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13709 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13710 (w
, end
- start
, whole
, start
);
13714 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13715 selected_window is redisplayed.
13717 We can return without actually redisplaying the window if
13718 fonts_changed_p is nonzero. In that case, redisplay_internal will
13722 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13724 struct window
*w
= XWINDOW (window
);
13725 struct frame
*f
= XFRAME (w
->frame
);
13726 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13727 struct buffer
*old
= current_buffer
;
13728 struct text_pos lpoint
, opoint
, startp
;
13729 int update_mode_line
;
13732 /* Record it now because it's overwritten. */
13733 int current_matrix_up_to_date_p
= 0;
13734 int used_current_matrix_p
= 0;
13735 /* This is less strict than current_matrix_up_to_date_p.
13736 It indictes that the buffer contents and narrowing are unchanged. */
13737 int buffer_unchanged_p
= 0;
13738 int temp_scroll_step
= 0;
13739 int count
= SPECPDL_INDEX ();
13741 int centering_position
= -1;
13742 int last_line_misfit
= 0;
13743 EMACS_INT beg_unchanged
, end_unchanged
;
13745 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13748 /* W must be a leaf window here. */
13749 xassert (!NILP (w
->buffer
));
13751 *w
->desired_matrix
->method
= 0;
13755 reconsider_clip_changes (w
, buffer
);
13757 /* Has the mode line to be updated? */
13758 update_mode_line
= (!NILP (w
->update_mode_line
)
13759 || update_mode_lines
13760 || buffer
->clip_changed
13761 || buffer
->prevent_redisplay_optimizations_p
);
13763 if (MINI_WINDOW_P (w
))
13765 if (w
== XWINDOW (echo_area_window
)
13766 && !NILP (echo_area_buffer
[0]))
13768 if (update_mode_line
)
13769 /* We may have to update a tty frame's menu bar or a
13770 tool-bar. Example `M-x C-h C-h C-g'. */
13771 goto finish_menu_bars
;
13773 /* We've already displayed the echo area glyphs in this window. */
13774 goto finish_scroll_bars
;
13776 else if ((w
!= XWINDOW (minibuf_window
)
13777 || minibuf_level
== 0)
13778 /* When buffer is nonempty, redisplay window normally. */
13779 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13780 /* Quail displays non-mini buffers in minibuffer window.
13781 In that case, redisplay the window normally. */
13782 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13784 /* W is a mini-buffer window, but it's not active, so clear
13786 int yb
= window_text_bottom_y (w
);
13787 struct glyph_row
*row
;
13790 for (y
= 0, row
= w
->desired_matrix
->rows
;
13792 y
+= row
->height
, ++row
)
13793 blank_row (w
, row
, y
);
13794 goto finish_scroll_bars
;
13797 clear_glyph_matrix (w
->desired_matrix
);
13800 /* Otherwise set up data on this window; select its buffer and point
13802 /* Really select the buffer, for the sake of buffer-local
13804 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13806 current_matrix_up_to_date_p
13807 = (!NILP (w
->window_end_valid
)
13808 && !current_buffer
->clip_changed
13809 && !current_buffer
->prevent_redisplay_optimizations_p
13810 && XFASTINT (w
->last_modified
) >= MODIFF
13811 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13813 /* Run the window-bottom-change-functions
13814 if it is possible that the text on the screen has changed
13815 (either due to modification of the text, or any other reason). */
13816 if (!current_matrix_up_to_date_p
13817 && !NILP (Vwindow_text_change_functions
))
13819 safe_run_hooks (Qwindow_text_change_functions
);
13823 beg_unchanged
= BEG_UNCHANGED
;
13824 end_unchanged
= END_UNCHANGED
;
13826 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13828 specbind (Qinhibit_point_motion_hooks
, Qt
);
13831 = (!NILP (w
->window_end_valid
)
13832 && !current_buffer
->clip_changed
13833 && XFASTINT (w
->last_modified
) >= MODIFF
13834 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13836 /* When windows_or_buffers_changed is non-zero, we can't rely on
13837 the window end being valid, so set it to nil there. */
13838 if (windows_or_buffers_changed
)
13840 /* If window starts on a continuation line, maybe adjust the
13841 window start in case the window's width changed. */
13842 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13843 compute_window_start_on_continuation_line (w
);
13845 w
->window_end_valid
= Qnil
;
13848 /* Some sanity checks. */
13849 CHECK_WINDOW_END (w
);
13850 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13852 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13855 /* If %c is in mode line, update it if needed. */
13856 if (!NILP (w
->column_number_displayed
)
13857 /* This alternative quickly identifies a common case
13858 where no change is needed. */
13859 && !(PT
== XFASTINT (w
->last_point
)
13860 && XFASTINT (w
->last_modified
) >= MODIFF
13861 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13862 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13863 update_mode_line
= 1;
13865 /* Count number of windows showing the selected buffer. An indirect
13866 buffer counts as its base buffer. */
13867 if (!just_this_one_p
)
13869 struct buffer
*current_base
, *window_base
;
13870 current_base
= current_buffer
;
13871 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13872 if (current_base
->base_buffer
)
13873 current_base
= current_base
->base_buffer
;
13874 if (window_base
->base_buffer
)
13875 window_base
= window_base
->base_buffer
;
13876 if (current_base
== window_base
)
13880 /* Point refers normally to the selected window. For any other
13881 window, set up appropriate value. */
13882 if (!EQ (window
, selected_window
))
13884 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13885 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13889 new_pt_byte
= BEGV_BYTE
;
13890 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13892 else if (new_pt
> (ZV
- 1))
13895 new_pt_byte
= ZV_BYTE
;
13896 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13899 /* We don't use SET_PT so that the point-motion hooks don't run. */
13900 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13903 /* If any of the character widths specified in the display table
13904 have changed, invalidate the width run cache. It's true that
13905 this may be a bit late to catch such changes, but the rest of
13906 redisplay goes (non-fatally) haywire when the display table is
13907 changed, so why should we worry about doing any better? */
13908 if (current_buffer
->width_run_cache
)
13910 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13912 if (! disptab_matches_widthtab (disptab
,
13913 XVECTOR (BVAR (current_buffer
, width_table
))))
13915 invalidate_region_cache (current_buffer
,
13916 current_buffer
->width_run_cache
,
13918 recompute_width_table (current_buffer
, disptab
);
13922 /* If window-start is screwed up, choose a new one. */
13923 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13926 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13928 /* If someone specified a new starting point but did not insist,
13929 check whether it can be used. */
13930 if (!NILP (w
->optional_new_start
)
13931 && CHARPOS (startp
) >= BEGV
13932 && CHARPOS (startp
) <= ZV
)
13934 w
->optional_new_start
= Qnil
;
13935 start_display (&it
, w
, startp
);
13936 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13937 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13938 if (IT_CHARPOS (it
) == PT
)
13939 w
->force_start
= Qt
;
13940 /* IT may overshoot PT if text at PT is invisible. */
13941 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13942 w
->force_start
= Qt
;
13947 /* Handle case where place to start displaying has been specified,
13948 unless the specified location is outside the accessible range. */
13949 if (!NILP (w
->force_start
)
13950 || w
->frozen_window_start_p
)
13952 /* We set this later on if we have to adjust point. */
13955 w
->force_start
= Qnil
;
13957 w
->window_end_valid
= Qnil
;
13959 /* Forget any recorded base line for line number display. */
13960 if (!buffer_unchanged_p
)
13961 w
->base_line_number
= Qnil
;
13963 /* Redisplay the mode line. Select the buffer properly for that.
13964 Also, run the hook window-scroll-functions
13965 because we have scrolled. */
13966 /* Note, we do this after clearing force_start because
13967 if there's an error, it is better to forget about force_start
13968 than to get into an infinite loop calling the hook functions
13969 and having them get more errors. */
13970 if (!update_mode_line
13971 || ! NILP (Vwindow_scroll_functions
))
13973 update_mode_line
= 1;
13974 w
->update_mode_line
= Qt
;
13975 startp
= run_window_scroll_functions (window
, startp
);
13978 w
->last_modified
= make_number (0);
13979 w
->last_overlay_modified
= make_number (0);
13980 if (CHARPOS (startp
) < BEGV
)
13981 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13982 else if (CHARPOS (startp
) > ZV
)
13983 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13985 /* Redisplay, then check if cursor has been set during the
13986 redisplay. Give up if new fonts were loaded. */
13987 /* We used to issue a CHECK_MARGINS argument to try_window here,
13988 but this causes scrolling to fail when point begins inside
13989 the scroll margin (bug#148) -- cyd */
13990 if (!try_window (window
, startp
, 0))
13992 w
->force_start
= Qt
;
13993 clear_glyph_matrix (w
->desired_matrix
);
13994 goto need_larger_matrices
;
13997 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13999 /* If point does not appear, try to move point so it does
14000 appear. The desired matrix has been built above, so we
14001 can use it here. */
14002 new_vpos
= window_box_height (w
) / 2;
14005 if (!cursor_row_fully_visible_p (w
, 0, 0))
14007 /* Point does appear, but on a line partly visible at end of window.
14008 Move it back to a fully-visible line. */
14009 new_vpos
= window_box_height (w
);
14012 /* If we need to move point for either of the above reasons,
14013 now actually do it. */
14016 struct glyph_row
*row
;
14018 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14019 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14022 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14023 MATRIX_ROW_START_BYTEPOS (row
));
14025 if (w
!= XWINDOW (selected_window
))
14026 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14027 else if (current_buffer
== old
)
14028 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14030 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14032 /* If we are highlighting the region, then we just changed
14033 the region, so redisplay to show it. */
14034 if (!NILP (Vtransient_mark_mode
)
14035 && !NILP (BVAR (current_buffer
, mark_active
)))
14037 clear_glyph_matrix (w
->desired_matrix
);
14038 if (!try_window (window
, startp
, 0))
14039 goto need_larger_matrices
;
14044 debug_method_add (w
, "forced window start");
14049 /* Handle case where text has not changed, only point, and it has
14050 not moved off the frame, and we are not retrying after hscroll.
14051 (current_matrix_up_to_date_p is nonzero when retrying.) */
14052 if (current_matrix_up_to_date_p
14053 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14054 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14058 case CURSOR_MOVEMENT_SUCCESS
:
14059 used_current_matrix_p
= 1;
14062 case CURSOR_MOVEMENT_MUST_SCROLL
:
14063 goto try_to_scroll
;
14069 /* If current starting point was originally the beginning of a line
14070 but no longer is, find a new starting point. */
14071 else if (!NILP (w
->start_at_line_beg
)
14072 && !(CHARPOS (startp
) <= BEGV
14073 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14076 debug_method_add (w
, "recenter 1");
14081 /* Try scrolling with try_window_id. Value is > 0 if update has
14082 been done, it is -1 if we know that the same window start will
14083 not work. It is 0 if unsuccessful for some other reason. */
14084 else if ((tem
= try_window_id (w
)) != 0)
14087 debug_method_add (w
, "try_window_id %d", tem
);
14090 if (fonts_changed_p
)
14091 goto need_larger_matrices
;
14095 /* Otherwise try_window_id has returned -1 which means that we
14096 don't want the alternative below this comment to execute. */
14098 else if (CHARPOS (startp
) >= BEGV
14099 && CHARPOS (startp
) <= ZV
14100 && PT
>= CHARPOS (startp
)
14101 && (CHARPOS (startp
) < ZV
14102 /* Avoid starting at end of buffer. */
14103 || CHARPOS (startp
) == BEGV
14104 || (XFASTINT (w
->last_modified
) >= MODIFF
14105 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14108 /* If first window line is a continuation line, and window start
14109 is inside the modified region, but the first change is before
14110 current window start, we must select a new window start.
14112 However, if this is the result of a down-mouse event (e.g. by
14113 extending the mouse-drag-overlay), we don't want to select a
14114 new window start, since that would change the position under
14115 the mouse, resulting in an unwanted mouse-movement rather
14116 than a simple mouse-click. */
14117 if (NILP (w
->start_at_line_beg
)
14118 && NILP (do_mouse_tracking
)
14119 && CHARPOS (startp
) > BEGV
14120 && CHARPOS (startp
) > BEG
+ beg_unchanged
14121 && CHARPOS (startp
) <= Z
- end_unchanged
14122 /* Even if w->start_at_line_beg is nil, a new window may
14123 start at a line_beg, since that's how set_buffer_window
14124 sets it. So, we need to check the return value of
14125 compute_window_start_on_continuation_line. (See also
14127 && XMARKER (w
->start
)->buffer
== current_buffer
14128 && compute_window_start_on_continuation_line (w
))
14130 w
->force_start
= Qt
;
14131 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14136 debug_method_add (w
, "same window start");
14139 /* Try to redisplay starting at same place as before.
14140 If point has not moved off frame, accept the results. */
14141 if (!current_matrix_up_to_date_p
14142 /* Don't use try_window_reusing_current_matrix in this case
14143 because a window scroll function can have changed the
14145 || !NILP (Vwindow_scroll_functions
)
14146 || MINI_WINDOW_P (w
)
14147 || !(used_current_matrix_p
14148 = try_window_reusing_current_matrix (w
)))
14150 IF_DEBUG (debug_method_add (w
, "1"));
14151 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14152 /* -1 means we need to scroll.
14153 0 means we need new matrices, but fonts_changed_p
14154 is set in that case, so we will detect it below. */
14155 goto try_to_scroll
;
14158 if (fonts_changed_p
)
14159 goto need_larger_matrices
;
14161 if (w
->cursor
.vpos
>= 0)
14163 if (!just_this_one_p
14164 || current_buffer
->clip_changed
14165 || BEG_UNCHANGED
< CHARPOS (startp
))
14166 /* Forget any recorded base line for line number display. */
14167 w
->base_line_number
= Qnil
;
14169 if (!cursor_row_fully_visible_p (w
, 1, 0))
14171 clear_glyph_matrix (w
->desired_matrix
);
14172 last_line_misfit
= 1;
14174 /* Drop through and scroll. */
14179 clear_glyph_matrix (w
->desired_matrix
);
14184 w
->last_modified
= make_number (0);
14185 w
->last_overlay_modified
= make_number (0);
14187 /* Redisplay the mode line. Select the buffer properly for that. */
14188 if (!update_mode_line
)
14190 update_mode_line
= 1;
14191 w
->update_mode_line
= Qt
;
14194 /* Try to scroll by specified few lines. */
14195 if ((scroll_conservatively
14196 || emacs_scroll_step
14197 || temp_scroll_step
14198 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14199 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14200 && CHARPOS (startp
) >= BEGV
14201 && CHARPOS (startp
) <= ZV
)
14203 /* The function returns -1 if new fonts were loaded, 1 if
14204 successful, 0 if not successful. */
14205 int ss
= try_scrolling (window
, just_this_one_p
,
14206 scroll_conservatively
,
14208 temp_scroll_step
, last_line_misfit
);
14211 case SCROLLING_SUCCESS
:
14214 case SCROLLING_NEED_LARGER_MATRICES
:
14215 goto need_larger_matrices
;
14217 case SCROLLING_FAILED
:
14225 /* Finally, just choose a place to start which positions point
14226 according to user preferences. */
14231 debug_method_add (w
, "recenter");
14234 /* w->vscroll = 0; */
14236 /* Forget any previously recorded base line for line number display. */
14237 if (!buffer_unchanged_p
)
14238 w
->base_line_number
= Qnil
;
14240 /* Determine the window start relative to point. */
14241 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14242 it
.current_y
= it
.last_visible_y
;
14243 if (centering_position
< 0)
14247 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14249 EMACS_INT margin_pos
= CHARPOS (startp
);
14251 Lisp_Object aggressive
;
14253 /* If there is a scroll margin at the top of the window, find
14254 its character position. */
14259 start_display (&it1
, w
, startp
);
14260 move_it_vertically (&it1
, margin
);
14261 margin_pos
= IT_CHARPOS (it1
);
14263 scrolling_up
= PT
> margin_pos
;
14266 ? BVAR (current_buffer
, scroll_up_aggressively
)
14267 : BVAR (current_buffer
, scroll_down_aggressively
);
14269 if (!MINI_WINDOW_P (w
)
14270 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
14274 /* Setting scroll-conservatively overrides
14275 scroll-*-aggressively. */
14276 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14278 double float_amount
= XFLOATINT (aggressive
);
14280 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14281 if (pt_offset
== 0 && float_amount
> 0)
14286 /* Compute how much to move the window start backward from
14287 point so that point will be displayed where the user
14291 centering_position
= it
.last_visible_y
;
14293 centering_position
-= pt_offset
;
14294 centering_position
-=
14295 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14296 /* Don't let point enter the scroll margin near top of
14298 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
14299 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
14302 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
14305 /* Set the window start half the height of the window backward
14307 centering_position
= window_box_height (w
) / 2;
14309 move_it_vertically_backward (&it
, centering_position
);
14311 xassert (IT_CHARPOS (it
) >= BEGV
);
14313 /* The function move_it_vertically_backward may move over more
14314 than the specified y-distance. If it->w is small, e.g. a
14315 mini-buffer window, we may end up in front of the window's
14316 display area. Start displaying at the start of the line
14317 containing PT in this case. */
14318 if (it
.current_y
<= 0)
14320 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14321 move_it_vertically_backward (&it
, 0);
14325 it
.current_x
= it
.hpos
= 0;
14327 /* Set the window start position here explicitly, to avoid an
14328 infinite loop in case the functions in window-scroll-functions
14330 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14332 /* Run scroll hooks. */
14333 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14335 /* Redisplay the window. */
14336 if (!current_matrix_up_to_date_p
14337 || windows_or_buffers_changed
14338 || cursor_type_changed
14339 /* Don't use try_window_reusing_current_matrix in this case
14340 because it can have changed the buffer. */
14341 || !NILP (Vwindow_scroll_functions
)
14342 || !just_this_one_p
14343 || MINI_WINDOW_P (w
)
14344 || !(used_current_matrix_p
14345 = try_window_reusing_current_matrix (w
)))
14346 try_window (window
, startp
, 0);
14348 /* If new fonts have been loaded (due to fontsets), give up. We
14349 have to start a new redisplay since we need to re-adjust glyph
14351 if (fonts_changed_p
)
14352 goto need_larger_matrices
;
14354 /* If cursor did not appear assume that the middle of the window is
14355 in the first line of the window. Do it again with the next line.
14356 (Imagine a window of height 100, displaying two lines of height
14357 60. Moving back 50 from it->last_visible_y will end in the first
14359 if (w
->cursor
.vpos
< 0)
14361 if (!NILP (w
->window_end_valid
)
14362 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14364 clear_glyph_matrix (w
->desired_matrix
);
14365 move_it_by_lines (&it
, 1);
14366 try_window (window
, it
.current
.pos
, 0);
14368 else if (PT
< IT_CHARPOS (it
))
14370 clear_glyph_matrix (w
->desired_matrix
);
14371 move_it_by_lines (&it
, -1);
14372 try_window (window
, it
.current
.pos
, 0);
14376 /* Not much we can do about it. */
14380 /* Consider the following case: Window starts at BEGV, there is
14381 invisible, intangible text at BEGV, so that display starts at
14382 some point START > BEGV. It can happen that we are called with
14383 PT somewhere between BEGV and START. Try to handle that case. */
14384 if (w
->cursor
.vpos
< 0)
14386 struct glyph_row
*row
= w
->current_matrix
->rows
;
14387 if (row
->mode_line_p
)
14389 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14392 if (!cursor_row_fully_visible_p (w
, 0, 0))
14394 /* If vscroll is enabled, disable it and try again. */
14398 clear_glyph_matrix (w
->desired_matrix
);
14402 /* If centering point failed to make the whole line visible,
14403 put point at the top instead. That has to make the whole line
14404 visible, if it can be done. */
14405 if (centering_position
== 0)
14408 clear_glyph_matrix (w
->desired_matrix
);
14409 centering_position
= 0;
14415 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14416 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14417 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14420 /* Display the mode line, if we must. */
14421 if ((update_mode_line
14422 /* If window not full width, must redo its mode line
14423 if (a) the window to its side is being redone and
14424 (b) we do a frame-based redisplay. This is a consequence
14425 of how inverted lines are drawn in frame-based redisplay. */
14426 || (!just_this_one_p
14427 && !FRAME_WINDOW_P (f
)
14428 && !WINDOW_FULL_WIDTH_P (w
))
14429 /* Line number to display. */
14430 || INTEGERP (w
->base_line_pos
)
14431 /* Column number is displayed and different from the one displayed. */
14432 || (!NILP (w
->column_number_displayed
)
14433 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14434 /* This means that the window has a mode line. */
14435 && (WINDOW_WANTS_MODELINE_P (w
)
14436 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14438 display_mode_lines (w
);
14440 /* If mode line height has changed, arrange for a thorough
14441 immediate redisplay using the correct mode line height. */
14442 if (WINDOW_WANTS_MODELINE_P (w
)
14443 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14445 fonts_changed_p
= 1;
14446 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14447 = DESIRED_MODE_LINE_HEIGHT (w
);
14450 /* If header line height has changed, arrange for a thorough
14451 immediate redisplay using the correct header line height. */
14452 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14453 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14455 fonts_changed_p
= 1;
14456 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14457 = DESIRED_HEADER_LINE_HEIGHT (w
);
14460 if (fonts_changed_p
)
14461 goto need_larger_matrices
;
14464 if (!line_number_displayed
14465 && !BUFFERP (w
->base_line_pos
))
14467 w
->base_line_pos
= Qnil
;
14468 w
->base_line_number
= Qnil
;
14473 /* When we reach a frame's selected window, redo the frame's menu bar. */
14474 if (update_mode_line
14475 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14477 int redisplay_menu_p
= 0;
14478 int redisplay_tool_bar_p
= 0;
14480 if (FRAME_WINDOW_P (f
))
14482 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14483 || defined (HAVE_NS) || defined (USE_GTK)
14484 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14486 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14490 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14492 if (redisplay_menu_p
)
14493 display_menu_bar (w
);
14495 #ifdef HAVE_WINDOW_SYSTEM
14496 if (FRAME_WINDOW_P (f
))
14498 #if defined (USE_GTK) || defined (HAVE_NS)
14499 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14501 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14502 && (FRAME_TOOL_BAR_LINES (f
) > 0
14503 || !NILP (Vauto_resize_tool_bars
));
14506 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14508 ignore_mouse_drag_p
= 1;
14514 #ifdef HAVE_WINDOW_SYSTEM
14515 if (FRAME_WINDOW_P (f
)
14516 && update_window_fringes (w
, (just_this_one_p
14517 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14518 || w
->pseudo_window_p
)))
14522 if (draw_window_fringes (w
, 1))
14523 x_draw_vertical_border (w
);
14527 #endif /* HAVE_WINDOW_SYSTEM */
14529 /* We go to this label, with fonts_changed_p nonzero,
14530 if it is necessary to try again using larger glyph matrices.
14531 We have to redeem the scroll bar even in this case,
14532 because the loop in redisplay_internal expects that. */
14533 need_larger_matrices
:
14535 finish_scroll_bars
:
14537 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14539 /* Set the thumb's position and size. */
14540 set_vertical_scroll_bar (w
);
14542 /* Note that we actually used the scroll bar attached to this
14543 window, so it shouldn't be deleted at the end of redisplay. */
14544 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14545 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14548 /* Restore current_buffer and value of point in it. The window
14549 update may have changed the buffer, so first make sure `opoint'
14550 is still valid (Bug#6177). */
14551 if (CHARPOS (opoint
) < BEGV
)
14552 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14553 else if (CHARPOS (opoint
) > ZV
)
14554 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14556 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14558 set_buffer_internal_1 (old
);
14559 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14560 shorter. This can be caused by log truncation in *Messages*. */
14561 if (CHARPOS (lpoint
) <= ZV
)
14562 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14564 unbind_to (count
, Qnil
);
14568 /* Build the complete desired matrix of WINDOW with a window start
14569 buffer position POS.
14571 Value is 1 if successful. It is zero if fonts were loaded during
14572 redisplay which makes re-adjusting glyph matrices necessary, and -1
14573 if point would appear in the scroll margins.
14574 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14575 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14579 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14581 struct window
*w
= XWINDOW (window
);
14583 struct glyph_row
*last_text_row
= NULL
;
14584 struct frame
*f
= XFRAME (w
->frame
);
14586 /* Make POS the new window start. */
14587 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14589 /* Mark cursor position as unknown. No overlay arrow seen. */
14590 w
->cursor
.vpos
= -1;
14591 overlay_arrow_seen
= 0;
14593 /* Initialize iterator and info to start at POS. */
14594 start_display (&it
, w
, pos
);
14596 /* Display all lines of W. */
14597 while (it
.current_y
< it
.last_visible_y
)
14599 if (display_line (&it
))
14600 last_text_row
= it
.glyph_row
- 1;
14601 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14605 /* Don't let the cursor end in the scroll margins. */
14606 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14607 && !MINI_WINDOW_P (w
))
14609 int this_scroll_margin
;
14611 if (scroll_margin
> 0)
14613 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14614 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14617 this_scroll_margin
= 0;
14619 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14620 && w
->cursor
.y
< this_scroll_margin
14621 && CHARPOS (pos
) > BEGV
14622 && IT_CHARPOS (it
) < ZV
)
14623 /* rms: considering make_cursor_line_fully_visible_p here
14624 seems to give wrong results. We don't want to recenter
14625 when the last line is partly visible, we want to allow
14626 that case to be handled in the usual way. */
14627 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14629 w
->cursor
.vpos
= -1;
14630 clear_glyph_matrix (w
->desired_matrix
);
14635 /* If bottom moved off end of frame, change mode line percentage. */
14636 if (XFASTINT (w
->window_end_pos
) <= 0
14637 && Z
!= IT_CHARPOS (it
))
14638 w
->update_mode_line
= Qt
;
14640 /* Set window_end_pos to the offset of the last character displayed
14641 on the window from the end of current_buffer. Set
14642 window_end_vpos to its row number. */
14645 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14646 w
->window_end_bytepos
14647 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14649 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14651 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14652 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14653 ->displays_text_p
);
14657 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14658 w
->window_end_pos
= make_number (Z
- ZV
);
14659 w
->window_end_vpos
= make_number (0);
14662 /* But that is not valid info until redisplay finishes. */
14663 w
->window_end_valid
= Qnil
;
14669 /************************************************************************
14670 Window redisplay reusing current matrix when buffer has not changed
14671 ************************************************************************/
14673 /* Try redisplay of window W showing an unchanged buffer with a
14674 different window start than the last time it was displayed by
14675 reusing its current matrix. Value is non-zero if successful.
14676 W->start is the new window start. */
14679 try_window_reusing_current_matrix (struct window
*w
)
14681 struct frame
*f
= XFRAME (w
->frame
);
14682 struct glyph_row
*bottom_row
;
14685 struct text_pos start
, new_start
;
14686 int nrows_scrolled
, i
;
14687 struct glyph_row
*last_text_row
;
14688 struct glyph_row
*last_reused_text_row
;
14689 struct glyph_row
*start_row
;
14690 int start_vpos
, min_y
, max_y
;
14693 if (inhibit_try_window_reusing
)
14697 if (/* This function doesn't handle terminal frames. */
14698 !FRAME_WINDOW_P (f
)
14699 /* Don't try to reuse the display if windows have been split
14701 || windows_or_buffers_changed
14702 || cursor_type_changed
)
14705 /* Can't do this if region may have changed. */
14706 if ((!NILP (Vtransient_mark_mode
)
14707 && !NILP (BVAR (current_buffer
, mark_active
)))
14708 || !NILP (w
->region_showing
)
14709 || !NILP (Vshow_trailing_whitespace
))
14712 /* If top-line visibility has changed, give up. */
14713 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14714 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14717 /* Give up if old or new display is scrolled vertically. We could
14718 make this function handle this, but right now it doesn't. */
14719 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14720 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14723 /* The variable new_start now holds the new window start. The old
14724 start `start' can be determined from the current matrix. */
14725 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14726 start
= start_row
->minpos
;
14727 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14729 /* Clear the desired matrix for the display below. */
14730 clear_glyph_matrix (w
->desired_matrix
);
14732 if (CHARPOS (new_start
) <= CHARPOS (start
))
14734 /* Don't use this method if the display starts with an ellipsis
14735 displayed for invisible text. It's not easy to handle that case
14736 below, and it's certainly not worth the effort since this is
14737 not a frequent case. */
14738 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14741 IF_DEBUG (debug_method_add (w
, "twu1"));
14743 /* Display up to a row that can be reused. The variable
14744 last_text_row is set to the last row displayed that displays
14745 text. Note that it.vpos == 0 if or if not there is a
14746 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14747 start_display (&it
, w
, new_start
);
14748 w
->cursor
.vpos
= -1;
14749 last_text_row
= last_reused_text_row
= NULL
;
14751 while (it
.current_y
< it
.last_visible_y
14752 && !fonts_changed_p
)
14754 /* If we have reached into the characters in the START row,
14755 that means the line boundaries have changed. So we
14756 can't start copying with the row START. Maybe it will
14757 work to start copying with the following row. */
14758 while (IT_CHARPOS (it
) > CHARPOS (start
))
14760 /* Advance to the next row as the "start". */
14762 start
= start_row
->minpos
;
14763 /* If there are no more rows to try, or just one, give up. */
14764 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14765 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14766 || CHARPOS (start
) == ZV
)
14768 clear_glyph_matrix (w
->desired_matrix
);
14772 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14774 /* If we have reached alignment,
14775 we can copy the rest of the rows. */
14776 if (IT_CHARPOS (it
) == CHARPOS (start
))
14779 if (display_line (&it
))
14780 last_text_row
= it
.glyph_row
- 1;
14783 /* A value of current_y < last_visible_y means that we stopped
14784 at the previous window start, which in turn means that we
14785 have at least one reusable row. */
14786 if (it
.current_y
< it
.last_visible_y
)
14788 struct glyph_row
*row
;
14790 /* IT.vpos always starts from 0; it counts text lines. */
14791 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14793 /* Find PT if not already found in the lines displayed. */
14794 if (w
->cursor
.vpos
< 0)
14796 int dy
= it
.current_y
- start_row
->y
;
14798 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14799 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14801 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14802 dy
, nrows_scrolled
);
14805 clear_glyph_matrix (w
->desired_matrix
);
14810 /* Scroll the display. Do it before the current matrix is
14811 changed. The problem here is that update has not yet
14812 run, i.e. part of the current matrix is not up to date.
14813 scroll_run_hook will clear the cursor, and use the
14814 current matrix to get the height of the row the cursor is
14816 run
.current_y
= start_row
->y
;
14817 run
.desired_y
= it
.current_y
;
14818 run
.height
= it
.last_visible_y
- it
.current_y
;
14820 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14823 FRAME_RIF (f
)->update_window_begin_hook (w
);
14824 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14825 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14826 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14830 /* Shift current matrix down by nrows_scrolled lines. */
14831 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14832 rotate_matrix (w
->current_matrix
,
14834 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14837 /* Disable lines that must be updated. */
14838 for (i
= 0; i
< nrows_scrolled
; ++i
)
14839 (start_row
+ i
)->enabled_p
= 0;
14841 /* Re-compute Y positions. */
14842 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14843 max_y
= it
.last_visible_y
;
14844 for (row
= start_row
+ nrows_scrolled
;
14848 row
->y
= it
.current_y
;
14849 row
->visible_height
= row
->height
;
14851 if (row
->y
< min_y
)
14852 row
->visible_height
-= min_y
- row
->y
;
14853 if (row
->y
+ row
->height
> max_y
)
14854 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14855 row
->redraw_fringe_bitmaps_p
= 1;
14857 it
.current_y
+= row
->height
;
14859 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14860 last_reused_text_row
= row
;
14861 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14865 /* Disable lines in the current matrix which are now
14866 below the window. */
14867 for (++row
; row
< bottom_row
; ++row
)
14868 row
->enabled_p
= row
->mode_line_p
= 0;
14871 /* Update window_end_pos etc.; last_reused_text_row is the last
14872 reused row from the current matrix containing text, if any.
14873 The value of last_text_row is the last displayed line
14874 containing text. */
14875 if (last_reused_text_row
)
14877 w
->window_end_bytepos
14878 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14880 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14882 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14883 w
->current_matrix
));
14885 else if (last_text_row
)
14887 w
->window_end_bytepos
14888 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14890 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14892 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14896 /* This window must be completely empty. */
14897 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14898 w
->window_end_pos
= make_number (Z
- ZV
);
14899 w
->window_end_vpos
= make_number (0);
14901 w
->window_end_valid
= Qnil
;
14903 /* Update hint: don't try scrolling again in update_window. */
14904 w
->desired_matrix
->no_scrolling_p
= 1;
14907 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14911 else if (CHARPOS (new_start
) > CHARPOS (start
))
14913 struct glyph_row
*pt_row
, *row
;
14914 struct glyph_row
*first_reusable_row
;
14915 struct glyph_row
*first_row_to_display
;
14917 int yb
= window_text_bottom_y (w
);
14919 /* Find the row starting at new_start, if there is one. Don't
14920 reuse a partially visible line at the end. */
14921 first_reusable_row
= start_row
;
14922 while (first_reusable_row
->enabled_p
14923 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14924 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14925 < CHARPOS (new_start
)))
14926 ++first_reusable_row
;
14928 /* Give up if there is no row to reuse. */
14929 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14930 || !first_reusable_row
->enabled_p
14931 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14932 != CHARPOS (new_start
)))
14935 /* We can reuse fully visible rows beginning with
14936 first_reusable_row to the end of the window. Set
14937 first_row_to_display to the first row that cannot be reused.
14938 Set pt_row to the row containing point, if there is any. */
14940 for (first_row_to_display
= first_reusable_row
;
14941 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14942 ++first_row_to_display
)
14944 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14945 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14946 pt_row
= first_row_to_display
;
14949 /* Start displaying at the start of first_row_to_display. */
14950 xassert (first_row_to_display
->y
< yb
);
14951 init_to_row_start (&it
, w
, first_row_to_display
);
14953 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14955 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14957 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14958 + WINDOW_HEADER_LINE_HEIGHT (w
));
14960 /* Display lines beginning with first_row_to_display in the
14961 desired matrix. Set last_text_row to the last row displayed
14962 that displays text. */
14963 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14964 if (pt_row
== NULL
)
14965 w
->cursor
.vpos
= -1;
14966 last_text_row
= NULL
;
14967 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14968 if (display_line (&it
))
14969 last_text_row
= it
.glyph_row
- 1;
14971 /* If point is in a reused row, adjust y and vpos of the cursor
14975 w
->cursor
.vpos
-= nrows_scrolled
;
14976 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14979 /* Give up if point isn't in a row displayed or reused. (This
14980 also handles the case where w->cursor.vpos < nrows_scrolled
14981 after the calls to display_line, which can happen with scroll
14982 margins. See bug#1295.) */
14983 if (w
->cursor
.vpos
< 0)
14985 clear_glyph_matrix (w
->desired_matrix
);
14989 /* Scroll the display. */
14990 run
.current_y
= first_reusable_row
->y
;
14991 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14992 run
.height
= it
.last_visible_y
- run
.current_y
;
14993 dy
= run
.current_y
- run
.desired_y
;
14998 FRAME_RIF (f
)->update_window_begin_hook (w
);
14999 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15000 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15001 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15005 /* Adjust Y positions of reused rows. */
15006 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15007 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15008 max_y
= it
.last_visible_y
;
15009 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15012 row
->visible_height
= row
->height
;
15013 if (row
->y
< min_y
)
15014 row
->visible_height
-= min_y
- row
->y
;
15015 if (row
->y
+ row
->height
> max_y
)
15016 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15017 row
->redraw_fringe_bitmaps_p
= 1;
15020 /* Scroll the current matrix. */
15021 xassert (nrows_scrolled
> 0);
15022 rotate_matrix (w
->current_matrix
,
15024 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15027 /* Disable rows not reused. */
15028 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15029 row
->enabled_p
= 0;
15031 /* Point may have moved to a different line, so we cannot assume that
15032 the previous cursor position is valid; locate the correct row. */
15035 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15036 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15040 w
->cursor
.y
= row
->y
;
15042 if (row
< bottom_row
)
15044 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15045 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15047 /* Can't use this optimization with bidi-reordered glyph
15048 rows, unless cursor is already at point. */
15049 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15051 if (!(w
->cursor
.hpos
>= 0
15052 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15053 && BUFFERP (glyph
->object
)
15054 && glyph
->charpos
== PT
))
15059 && (!BUFFERP (glyph
->object
)
15060 || glyph
->charpos
< PT
);
15064 w
->cursor
.x
+= glyph
->pixel_width
;
15069 /* Adjust window end. A null value of last_text_row means that
15070 the window end is in reused rows which in turn means that
15071 only its vpos can have changed. */
15074 w
->window_end_bytepos
15075 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15077 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15079 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15084 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15087 w
->window_end_valid
= Qnil
;
15088 w
->desired_matrix
->no_scrolling_p
= 1;
15091 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15101 /************************************************************************
15102 Window redisplay reusing current matrix when buffer has changed
15103 ************************************************************************/
15105 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15106 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15107 EMACS_INT
*, EMACS_INT
*);
15108 static struct glyph_row
*
15109 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15110 struct glyph_row
*);
15113 /* Return the last row in MATRIX displaying text. If row START is
15114 non-null, start searching with that row. IT gives the dimensions
15115 of the display. Value is null if matrix is empty; otherwise it is
15116 a pointer to the row found. */
15118 static struct glyph_row
*
15119 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15120 struct glyph_row
*start
)
15122 struct glyph_row
*row
, *row_found
;
15124 /* Set row_found to the last row in IT->w's current matrix
15125 displaying text. The loop looks funny but think of partially
15128 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15129 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15131 xassert (row
->enabled_p
);
15133 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15142 /* Return the last row in the current matrix of W that is not affected
15143 by changes at the start of current_buffer that occurred since W's
15144 current matrix was built. Value is null if no such row exists.
15146 BEG_UNCHANGED us the number of characters unchanged at the start of
15147 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15148 first changed character in current_buffer. Characters at positions <
15149 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15150 when the current matrix was built. */
15152 static struct glyph_row
*
15153 find_last_unchanged_at_beg_row (struct window
*w
)
15155 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15156 struct glyph_row
*row
;
15157 struct glyph_row
*row_found
= NULL
;
15158 int yb
= window_text_bottom_y (w
);
15160 /* Find the last row displaying unchanged text. */
15161 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15162 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15163 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15166 if (/* If row ends before first_changed_pos, it is unchanged,
15167 except in some case. */
15168 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15169 /* When row ends in ZV and we write at ZV it is not
15171 && !row
->ends_at_zv_p
15172 /* When first_changed_pos is the end of a continued line,
15173 row is not unchanged because it may be no longer
15175 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15176 && (row
->continued_p
15177 || row
->exact_window_width_line_p
)))
15180 /* Stop if last visible row. */
15181 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15189 /* Find the first glyph row in the current matrix of W that is not
15190 affected by changes at the end of current_buffer since the
15191 time W's current matrix was built.
15193 Return in *DELTA the number of chars by which buffer positions in
15194 unchanged text at the end of current_buffer must be adjusted.
15196 Return in *DELTA_BYTES the corresponding number of bytes.
15198 Value is null if no such row exists, i.e. all rows are affected by
15201 static struct glyph_row
*
15202 find_first_unchanged_at_end_row (struct window
*w
,
15203 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15205 struct glyph_row
*row
;
15206 struct glyph_row
*row_found
= NULL
;
15208 *delta
= *delta_bytes
= 0;
15210 /* Display must not have been paused, otherwise the current matrix
15211 is not up to date. */
15212 eassert (!NILP (w
->window_end_valid
));
15214 /* A value of window_end_pos >= END_UNCHANGED means that the window
15215 end is in the range of changed text. If so, there is no
15216 unchanged row at the end of W's current matrix. */
15217 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15220 /* Set row to the last row in W's current matrix displaying text. */
15221 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15223 /* If matrix is entirely empty, no unchanged row exists. */
15224 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15226 /* The value of row is the last glyph row in the matrix having a
15227 meaningful buffer position in it. The end position of row
15228 corresponds to window_end_pos. This allows us to translate
15229 buffer positions in the current matrix to current buffer
15230 positions for characters not in changed text. */
15232 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15233 EMACS_INT Z_BYTE_old
=
15234 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15235 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15236 struct glyph_row
*first_text_row
15237 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15239 *delta
= Z
- Z_old
;
15240 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15242 /* Set last_unchanged_pos to the buffer position of the last
15243 character in the buffer that has not been changed. Z is the
15244 index + 1 of the last character in current_buffer, i.e. by
15245 subtracting END_UNCHANGED we get the index of the last
15246 unchanged character, and we have to add BEG to get its buffer
15248 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15249 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15251 /* Search backward from ROW for a row displaying a line that
15252 starts at a minimum position >= last_unchanged_pos_old. */
15253 for (; row
> first_text_row
; --row
)
15255 /* This used to abort, but it can happen.
15256 It is ok to just stop the search instead here. KFS. */
15257 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15260 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15265 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15271 /* Make sure that glyph rows in the current matrix of window W
15272 reference the same glyph memory as corresponding rows in the
15273 frame's frame matrix. This function is called after scrolling W's
15274 current matrix on a terminal frame in try_window_id and
15275 try_window_reusing_current_matrix. */
15278 sync_frame_with_window_matrix_rows (struct window
*w
)
15280 struct frame
*f
= XFRAME (w
->frame
);
15281 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15283 /* Preconditions: W must be a leaf window and full-width. Its frame
15284 must have a frame matrix. */
15285 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15286 xassert (WINDOW_FULL_WIDTH_P (w
));
15287 xassert (!FRAME_WINDOW_P (f
));
15289 /* If W is a full-width window, glyph pointers in W's current matrix
15290 have, by definition, to be the same as glyph pointers in the
15291 corresponding frame matrix. Note that frame matrices have no
15292 marginal areas (see build_frame_matrix). */
15293 window_row
= w
->current_matrix
->rows
;
15294 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15295 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15296 while (window_row
< window_row_end
)
15298 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15299 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15301 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15302 frame_row
->glyphs
[TEXT_AREA
] = start
;
15303 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15304 frame_row
->glyphs
[LAST_AREA
] = end
;
15306 /* Disable frame rows whose corresponding window rows have
15307 been disabled in try_window_id. */
15308 if (!window_row
->enabled_p
)
15309 frame_row
->enabled_p
= 0;
15311 ++window_row
, ++frame_row
;
15316 /* Find the glyph row in window W containing CHARPOS. Consider all
15317 rows between START and END (not inclusive). END null means search
15318 all rows to the end of the display area of W. Value is the row
15319 containing CHARPOS or null. */
15322 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15323 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15325 struct glyph_row
*row
= start
;
15326 struct glyph_row
*best_row
= NULL
;
15327 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15330 /* If we happen to start on a header-line, skip that. */
15331 if (row
->mode_line_p
)
15334 if ((end
&& row
>= end
) || !row
->enabled_p
)
15337 last_y
= window_text_bottom_y (w
) - dy
;
15341 /* Give up if we have gone too far. */
15342 if (end
&& row
>= end
)
15344 /* This formerly returned if they were equal.
15345 I think that both quantities are of a "last plus one" type;
15346 if so, when they are equal, the row is within the screen. -- rms. */
15347 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15350 /* If it is in this row, return this row. */
15351 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15352 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15353 /* The end position of a row equals the start
15354 position of the next row. If CHARPOS is there, we
15355 would rather display it in the next line, except
15356 when this line ends in ZV. */
15357 && !row
->ends_at_zv_p
15358 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15359 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15363 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15364 || (!best_row
&& !row
->continued_p
))
15366 /* In bidi-reordered rows, there could be several rows
15367 occluding point, all of them belonging to the same
15368 continued line. We need to find the row which fits
15369 CHARPOS the best. */
15370 for (g
= row
->glyphs
[TEXT_AREA
];
15371 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15374 if (!STRINGP (g
->object
))
15376 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15378 mindif
= eabs (g
->charpos
- charpos
);
15380 /* Exact match always wins. */
15387 else if (best_row
&& !row
->continued_p
)
15394 /* Try to redisplay window W by reusing its existing display. W's
15395 current matrix must be up to date when this function is called,
15396 i.e. window_end_valid must not be nil.
15400 1 if display has been updated
15401 0 if otherwise unsuccessful
15402 -1 if redisplay with same window start is known not to succeed
15404 The following steps are performed:
15406 1. Find the last row in the current matrix of W that is not
15407 affected by changes at the start of current_buffer. If no such row
15410 2. Find the first row in W's current matrix that is not affected by
15411 changes at the end of current_buffer. Maybe there is no such row.
15413 3. Display lines beginning with the row + 1 found in step 1 to the
15414 row found in step 2 or, if step 2 didn't find a row, to the end of
15417 4. If cursor is not known to appear on the window, give up.
15419 5. If display stopped at the row found in step 2, scroll the
15420 display and current matrix as needed.
15422 6. Maybe display some lines at the end of W, if we must. This can
15423 happen under various circumstances, like a partially visible line
15424 becoming fully visible, or because newly displayed lines are displayed
15425 in smaller font sizes.
15427 7. Update W's window end information. */
15430 try_window_id (struct window
*w
)
15432 struct frame
*f
= XFRAME (w
->frame
);
15433 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15434 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15435 struct glyph_row
*last_unchanged_at_beg_row
;
15436 struct glyph_row
*first_unchanged_at_end_row
;
15437 struct glyph_row
*row
;
15438 struct glyph_row
*bottom_row
;
15441 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15443 struct text_pos start_pos
;
15445 int first_unchanged_at_end_vpos
= 0;
15446 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15447 struct text_pos start
;
15448 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15451 if (inhibit_try_window_id
)
15455 /* This is handy for debugging. */
15457 #define GIVE_UP(X) \
15459 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15463 #define GIVE_UP(X) return 0
15466 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15468 /* Don't use this for mini-windows because these can show
15469 messages and mini-buffers, and we don't handle that here. */
15470 if (MINI_WINDOW_P (w
))
15473 /* This flag is used to prevent redisplay optimizations. */
15474 if (windows_or_buffers_changed
|| cursor_type_changed
)
15477 /* Verify that narrowing has not changed.
15478 Also verify that we were not told to prevent redisplay optimizations.
15479 It would be nice to further
15480 reduce the number of cases where this prevents try_window_id. */
15481 if (current_buffer
->clip_changed
15482 || current_buffer
->prevent_redisplay_optimizations_p
)
15485 /* Window must either use window-based redisplay or be full width. */
15486 if (!FRAME_WINDOW_P (f
)
15487 && (!FRAME_LINE_INS_DEL_OK (f
)
15488 || !WINDOW_FULL_WIDTH_P (w
)))
15491 /* Give up if point is known NOT to appear in W. */
15492 if (PT
< CHARPOS (start
))
15495 /* Another way to prevent redisplay optimizations. */
15496 if (XFASTINT (w
->last_modified
) == 0)
15499 /* Verify that window is not hscrolled. */
15500 if (XFASTINT (w
->hscroll
) != 0)
15503 /* Verify that display wasn't paused. */
15504 if (NILP (w
->window_end_valid
))
15507 /* Can't use this if highlighting a region because a cursor movement
15508 will do more than just set the cursor. */
15509 if (!NILP (Vtransient_mark_mode
)
15510 && !NILP (BVAR (current_buffer
, mark_active
)))
15513 /* Likewise if highlighting trailing whitespace. */
15514 if (!NILP (Vshow_trailing_whitespace
))
15517 /* Likewise if showing a region. */
15518 if (!NILP (w
->region_showing
))
15521 /* Can't use this if overlay arrow position and/or string have
15523 if (overlay_arrows_changed_p ())
15526 /* When word-wrap is on, adding a space to the first word of a
15527 wrapped line can change the wrap position, altering the line
15528 above it. It might be worthwhile to handle this more
15529 intelligently, but for now just redisplay from scratch. */
15530 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15533 /* Under bidi reordering, adding or deleting a character in the
15534 beginning of a paragraph, before the first strong directional
15535 character, can change the base direction of the paragraph (unless
15536 the buffer specifies a fixed paragraph direction), which will
15537 require to redisplay the whole paragraph. It might be worthwhile
15538 to find the paragraph limits and widen the range of redisplayed
15539 lines to that, but for now just give up this optimization and
15540 redisplay from scratch. */
15541 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15542 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15545 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15546 only if buffer has really changed. The reason is that the gap is
15547 initially at Z for freshly visited files. The code below would
15548 set end_unchanged to 0 in that case. */
15549 if (MODIFF
> SAVE_MODIFF
15550 /* This seems to happen sometimes after saving a buffer. */
15551 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15553 if (GPT
- BEG
< BEG_UNCHANGED
)
15554 BEG_UNCHANGED
= GPT
- BEG
;
15555 if (Z
- GPT
< END_UNCHANGED
)
15556 END_UNCHANGED
= Z
- GPT
;
15559 /* The position of the first and last character that has been changed. */
15560 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15561 last_changed_charpos
= Z
- END_UNCHANGED
;
15563 /* If window starts after a line end, and the last change is in
15564 front of that newline, then changes don't affect the display.
15565 This case happens with stealth-fontification. Note that although
15566 the display is unchanged, glyph positions in the matrix have to
15567 be adjusted, of course. */
15568 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15569 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15570 && ((last_changed_charpos
< CHARPOS (start
)
15571 && CHARPOS (start
) == BEGV
)
15572 || (last_changed_charpos
< CHARPOS (start
) - 1
15573 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15575 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15576 struct glyph_row
*r0
;
15578 /* Compute how many chars/bytes have been added to or removed
15579 from the buffer. */
15580 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15581 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15582 Z_delta
= Z
- Z_old
;
15583 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15585 /* Give up if PT is not in the window. Note that it already has
15586 been checked at the start of try_window_id that PT is not in
15587 front of the window start. */
15588 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15591 /* If window start is unchanged, we can reuse the whole matrix
15592 as is, after adjusting glyph positions. No need to compute
15593 the window end again, since its offset from Z hasn't changed. */
15594 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15595 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15596 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15597 /* PT must not be in a partially visible line. */
15598 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15599 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15601 /* Adjust positions in the glyph matrix. */
15602 if (Z_delta
|| Z_delta_bytes
)
15604 struct glyph_row
*r1
15605 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15606 increment_matrix_positions (w
->current_matrix
,
15607 MATRIX_ROW_VPOS (r0
, current_matrix
),
15608 MATRIX_ROW_VPOS (r1
, current_matrix
),
15609 Z_delta
, Z_delta_bytes
);
15612 /* Set the cursor. */
15613 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15615 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15622 /* Handle the case that changes are all below what is displayed in
15623 the window, and that PT is in the window. This shortcut cannot
15624 be taken if ZV is visible in the window, and text has been added
15625 there that is visible in the window. */
15626 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15627 /* ZV is not visible in the window, or there are no
15628 changes at ZV, actually. */
15629 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15630 || first_changed_charpos
== last_changed_charpos
))
15632 struct glyph_row
*r0
;
15634 /* Give up if PT is not in the window. Note that it already has
15635 been checked at the start of try_window_id that PT is not in
15636 front of the window start. */
15637 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15640 /* If window start is unchanged, we can reuse the whole matrix
15641 as is, without changing glyph positions since no text has
15642 been added/removed in front of the window end. */
15643 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15644 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15645 /* PT must not be in a partially visible line. */
15646 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15647 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15649 /* We have to compute the window end anew since text
15650 could have been added/removed after it. */
15652 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15653 w
->window_end_bytepos
15654 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15656 /* Set the cursor. */
15657 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15659 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15666 /* Give up if window start is in the changed area.
15668 The condition used to read
15670 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15672 but why that was tested escapes me at the moment. */
15673 if (CHARPOS (start
) >= first_changed_charpos
15674 && CHARPOS (start
) <= last_changed_charpos
)
15677 /* Check that window start agrees with the start of the first glyph
15678 row in its current matrix. Check this after we know the window
15679 start is not in changed text, otherwise positions would not be
15681 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15682 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15685 /* Give up if the window ends in strings. Overlay strings
15686 at the end are difficult to handle, so don't try. */
15687 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15688 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15691 /* Compute the position at which we have to start displaying new
15692 lines. Some of the lines at the top of the window might be
15693 reusable because they are not displaying changed text. Find the
15694 last row in W's current matrix not affected by changes at the
15695 start of current_buffer. Value is null if changes start in the
15696 first line of window. */
15697 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15698 if (last_unchanged_at_beg_row
)
15700 /* Avoid starting to display in the moddle of a character, a TAB
15701 for instance. This is easier than to set up the iterator
15702 exactly, and it's not a frequent case, so the additional
15703 effort wouldn't really pay off. */
15704 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15705 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15706 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15707 --last_unchanged_at_beg_row
;
15709 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15712 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15714 start_pos
= it
.current
.pos
;
15716 /* Start displaying new lines in the desired matrix at the same
15717 vpos we would use in the current matrix, i.e. below
15718 last_unchanged_at_beg_row. */
15719 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15721 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15722 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15724 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15728 /* There are no reusable lines at the start of the window.
15729 Start displaying in the first text line. */
15730 start_display (&it
, w
, start
);
15731 it
.vpos
= it
.first_vpos
;
15732 start_pos
= it
.current
.pos
;
15735 /* Find the first row that is not affected by changes at the end of
15736 the buffer. Value will be null if there is no unchanged row, in
15737 which case we must redisplay to the end of the window. delta
15738 will be set to the value by which buffer positions beginning with
15739 first_unchanged_at_end_row have to be adjusted due to text
15741 first_unchanged_at_end_row
15742 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15743 IF_DEBUG (debug_delta
= delta
);
15744 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15746 /* Set stop_pos to the buffer position up to which we will have to
15747 display new lines. If first_unchanged_at_end_row != NULL, this
15748 is the buffer position of the start of the line displayed in that
15749 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15750 that we don't stop at a buffer position. */
15752 if (first_unchanged_at_end_row
)
15754 xassert (last_unchanged_at_beg_row
== NULL
15755 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15757 /* If this is a continuation line, move forward to the next one
15758 that isn't. Changes in lines above affect this line.
15759 Caution: this may move first_unchanged_at_end_row to a row
15760 not displaying text. */
15761 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15762 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15763 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15764 < it
.last_visible_y
))
15765 ++first_unchanged_at_end_row
;
15767 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15768 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15769 >= it
.last_visible_y
))
15770 first_unchanged_at_end_row
= NULL
;
15773 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15775 first_unchanged_at_end_vpos
15776 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15777 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15780 else if (last_unchanged_at_beg_row
== NULL
)
15786 /* Either there is no unchanged row at the end, or the one we have
15787 now displays text. This is a necessary condition for the window
15788 end pos calculation at the end of this function. */
15789 xassert (first_unchanged_at_end_row
== NULL
15790 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15792 debug_last_unchanged_at_beg_vpos
15793 = (last_unchanged_at_beg_row
15794 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15796 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15798 #endif /* GLYPH_DEBUG != 0 */
15801 /* Display new lines. Set last_text_row to the last new line
15802 displayed which has text on it, i.e. might end up as being the
15803 line where the window_end_vpos is. */
15804 w
->cursor
.vpos
= -1;
15805 last_text_row
= NULL
;
15806 overlay_arrow_seen
= 0;
15807 while (it
.current_y
< it
.last_visible_y
15808 && !fonts_changed_p
15809 && (first_unchanged_at_end_row
== NULL
15810 || IT_CHARPOS (it
) < stop_pos
))
15812 if (display_line (&it
))
15813 last_text_row
= it
.glyph_row
- 1;
15816 if (fonts_changed_p
)
15820 /* Compute differences in buffer positions, y-positions etc. for
15821 lines reused at the bottom of the window. Compute what we can
15823 if (first_unchanged_at_end_row
15824 /* No lines reused because we displayed everything up to the
15825 bottom of the window. */
15826 && it
.current_y
< it
.last_visible_y
)
15829 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15831 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15832 run
.current_y
= first_unchanged_at_end_row
->y
;
15833 run
.desired_y
= run
.current_y
+ dy
;
15834 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15838 delta
= delta_bytes
= dvpos
= dy
15839 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15840 first_unchanged_at_end_row
= NULL
;
15842 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15845 /* Find the cursor if not already found. We have to decide whether
15846 PT will appear on this window (it sometimes doesn't, but this is
15847 not a very frequent case.) This decision has to be made before
15848 the current matrix is altered. A value of cursor.vpos < 0 means
15849 that PT is either in one of the lines beginning at
15850 first_unchanged_at_end_row or below the window. Don't care for
15851 lines that might be displayed later at the window end; as
15852 mentioned, this is not a frequent case. */
15853 if (w
->cursor
.vpos
< 0)
15855 /* Cursor in unchanged rows at the top? */
15856 if (PT
< CHARPOS (start_pos
)
15857 && last_unchanged_at_beg_row
)
15859 row
= row_containing_pos (w
, PT
,
15860 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15861 last_unchanged_at_beg_row
+ 1, 0);
15863 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15866 /* Start from first_unchanged_at_end_row looking for PT. */
15867 else if (first_unchanged_at_end_row
)
15869 row
= row_containing_pos (w
, PT
- delta
,
15870 first_unchanged_at_end_row
, NULL
, 0);
15872 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15873 delta_bytes
, dy
, dvpos
);
15876 /* Give up if cursor was not found. */
15877 if (w
->cursor
.vpos
< 0)
15879 clear_glyph_matrix (w
->desired_matrix
);
15884 /* Don't let the cursor end in the scroll margins. */
15886 int this_scroll_margin
, cursor_height
;
15888 this_scroll_margin
= max (0, scroll_margin
);
15889 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15890 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15891 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15893 if ((w
->cursor
.y
< this_scroll_margin
15894 && CHARPOS (start
) > BEGV
)
15895 /* Old redisplay didn't take scroll margin into account at the bottom,
15896 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15897 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15898 ? cursor_height
+ this_scroll_margin
15899 : 1)) > it
.last_visible_y
)
15901 w
->cursor
.vpos
= -1;
15902 clear_glyph_matrix (w
->desired_matrix
);
15907 /* Scroll the display. Do it before changing the current matrix so
15908 that xterm.c doesn't get confused about where the cursor glyph is
15910 if (dy
&& run
.height
)
15914 if (FRAME_WINDOW_P (f
))
15916 FRAME_RIF (f
)->update_window_begin_hook (w
);
15917 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15918 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15919 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15923 /* Terminal frame. In this case, dvpos gives the number of
15924 lines to scroll by; dvpos < 0 means scroll up. */
15926 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15927 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
15928 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15929 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15930 + window_internal_height (w
));
15932 #if defined (HAVE_GPM) || defined (MSDOS)
15933 x_clear_window_mouse_face (w
);
15935 /* Perform the operation on the screen. */
15938 /* Scroll last_unchanged_at_beg_row to the end of the
15939 window down dvpos lines. */
15940 set_terminal_window (f
, end
);
15942 /* On dumb terminals delete dvpos lines at the end
15943 before inserting dvpos empty lines. */
15944 if (!FRAME_SCROLL_REGION_OK (f
))
15945 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15947 /* Insert dvpos empty lines in front of
15948 last_unchanged_at_beg_row. */
15949 ins_del_lines (f
, from
, dvpos
);
15951 else if (dvpos
< 0)
15953 /* Scroll up last_unchanged_at_beg_vpos to the end of
15954 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15955 set_terminal_window (f
, end
);
15957 /* Delete dvpos lines in front of
15958 last_unchanged_at_beg_vpos. ins_del_lines will set
15959 the cursor to the given vpos and emit |dvpos| delete
15961 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15963 /* On a dumb terminal insert dvpos empty lines at the
15965 if (!FRAME_SCROLL_REGION_OK (f
))
15966 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15969 set_terminal_window (f
, 0);
15975 /* Shift reused rows of the current matrix to the right position.
15976 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15978 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15979 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15982 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15983 bottom_vpos
, dvpos
);
15984 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15987 else if (dvpos
> 0)
15989 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15990 bottom_vpos
, dvpos
);
15991 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15992 first_unchanged_at_end_vpos
+ dvpos
, 0);
15995 /* For frame-based redisplay, make sure that current frame and window
15996 matrix are in sync with respect to glyph memory. */
15997 if (!FRAME_WINDOW_P (f
))
15998 sync_frame_with_window_matrix_rows (w
);
16000 /* Adjust buffer positions in reused rows. */
16001 if (delta
|| delta_bytes
)
16002 increment_matrix_positions (current_matrix
,
16003 first_unchanged_at_end_vpos
+ dvpos
,
16004 bottom_vpos
, delta
, delta_bytes
);
16006 /* Adjust Y positions. */
16008 shift_glyph_matrix (w
, current_matrix
,
16009 first_unchanged_at_end_vpos
+ dvpos
,
16012 if (first_unchanged_at_end_row
)
16014 first_unchanged_at_end_row
+= dvpos
;
16015 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16016 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16017 first_unchanged_at_end_row
= NULL
;
16020 /* If scrolling up, there may be some lines to display at the end of
16022 last_text_row_at_end
= NULL
;
16025 /* Scrolling up can leave for example a partially visible line
16026 at the end of the window to be redisplayed. */
16027 /* Set last_row to the glyph row in the current matrix where the
16028 window end line is found. It has been moved up or down in
16029 the matrix by dvpos. */
16030 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16031 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16033 /* If last_row is the window end line, it should display text. */
16034 xassert (last_row
->displays_text_p
);
16036 /* If window end line was partially visible before, begin
16037 displaying at that line. Otherwise begin displaying with the
16038 line following it. */
16039 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16041 init_to_row_start (&it
, w
, last_row
);
16042 it
.vpos
= last_vpos
;
16043 it
.current_y
= last_row
->y
;
16047 init_to_row_end (&it
, w
, last_row
);
16048 it
.vpos
= 1 + last_vpos
;
16049 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16053 /* We may start in a continuation line. If so, we have to
16054 get the right continuation_lines_width and current_x. */
16055 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16056 it
.hpos
= it
.current_x
= 0;
16058 /* Display the rest of the lines at the window end. */
16059 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16060 while (it
.current_y
< it
.last_visible_y
16061 && !fonts_changed_p
)
16063 /* Is it always sure that the display agrees with lines in
16064 the current matrix? I don't think so, so we mark rows
16065 displayed invalid in the current matrix by setting their
16066 enabled_p flag to zero. */
16067 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16068 if (display_line (&it
))
16069 last_text_row_at_end
= it
.glyph_row
- 1;
16073 /* Update window_end_pos and window_end_vpos. */
16074 if (first_unchanged_at_end_row
16075 && !last_text_row_at_end
)
16077 /* Window end line if one of the preserved rows from the current
16078 matrix. Set row to the last row displaying text in current
16079 matrix starting at first_unchanged_at_end_row, after
16081 xassert (first_unchanged_at_end_row
->displays_text_p
);
16082 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16083 first_unchanged_at_end_row
);
16084 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16086 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16087 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16089 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16090 xassert (w
->window_end_bytepos
>= 0);
16091 IF_DEBUG (debug_method_add (w
, "A"));
16093 else if (last_text_row_at_end
)
16096 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16097 w
->window_end_bytepos
16098 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16100 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16101 xassert (w
->window_end_bytepos
>= 0);
16102 IF_DEBUG (debug_method_add (w
, "B"));
16104 else if (last_text_row
)
16106 /* We have displayed either to the end of the window or at the
16107 end of the window, i.e. the last row with text is to be found
16108 in the desired matrix. */
16110 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16111 w
->window_end_bytepos
16112 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16114 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16115 xassert (w
->window_end_bytepos
>= 0);
16117 else if (first_unchanged_at_end_row
== NULL
16118 && last_text_row
== NULL
16119 && last_text_row_at_end
== NULL
)
16121 /* Displayed to end of window, but no line containing text was
16122 displayed. Lines were deleted at the end of the window. */
16123 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16124 int vpos
= XFASTINT (w
->window_end_vpos
);
16125 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16126 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16129 row
== NULL
&& vpos
>= first_vpos
;
16130 --vpos
, --current_row
, --desired_row
)
16132 if (desired_row
->enabled_p
)
16134 if (desired_row
->displays_text_p
)
16137 else if (current_row
->displays_text_p
)
16141 xassert (row
!= NULL
);
16142 w
->window_end_vpos
= make_number (vpos
+ 1);
16143 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16144 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16145 xassert (w
->window_end_bytepos
>= 0);
16146 IF_DEBUG (debug_method_add (w
, "C"));
16151 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16152 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16154 /* Record that display has not been completed. */
16155 w
->window_end_valid
= Qnil
;
16156 w
->desired_matrix
->no_scrolling_p
= 1;
16164 /***********************************************************************
16165 More debugging support
16166 ***********************************************************************/
16170 void dump_glyph_row (struct glyph_row
*, int, int);
16171 void dump_glyph_matrix (struct glyph_matrix
*, int);
16172 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16175 /* Dump the contents of glyph matrix MATRIX on stderr.
16177 GLYPHS 0 means don't show glyph contents.
16178 GLYPHS 1 means show glyphs in short form
16179 GLYPHS > 1 means show glyphs in long form. */
16182 dump_glyph_matrix (matrix
, glyphs
)
16183 struct glyph_matrix
*matrix
;
16187 for (i
= 0; i
< matrix
->nrows
; ++i
)
16188 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16192 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16193 the glyph row and area where the glyph comes from. */
16196 dump_glyph (row
, glyph
, area
)
16197 struct glyph_row
*row
;
16198 struct glyph
*glyph
;
16201 if (glyph
->type
== CHAR_GLYPH
)
16204 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16205 glyph
- row
->glyphs
[TEXT_AREA
],
16208 (BUFFERP (glyph
->object
)
16210 : (STRINGP (glyph
->object
)
16213 glyph
->pixel_width
,
16215 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16219 glyph
->left_box_line_p
,
16220 glyph
->right_box_line_p
);
16222 else if (glyph
->type
== STRETCH_GLYPH
)
16225 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16226 glyph
- row
->glyphs
[TEXT_AREA
],
16229 (BUFFERP (glyph
->object
)
16231 : (STRINGP (glyph
->object
)
16234 glyph
->pixel_width
,
16238 glyph
->left_box_line_p
,
16239 glyph
->right_box_line_p
);
16241 else if (glyph
->type
== IMAGE_GLYPH
)
16244 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16245 glyph
- row
->glyphs
[TEXT_AREA
],
16248 (BUFFERP (glyph
->object
)
16250 : (STRINGP (glyph
->object
)
16253 glyph
->pixel_width
,
16257 glyph
->left_box_line_p
,
16258 glyph
->right_box_line_p
);
16260 else if (glyph
->type
== COMPOSITE_GLYPH
)
16263 " %5d %4c %6d %c %3d 0x%05x",
16264 glyph
- row
->glyphs
[TEXT_AREA
],
16267 (BUFFERP (glyph
->object
)
16269 : (STRINGP (glyph
->object
)
16272 glyph
->pixel_width
,
16274 if (glyph
->u
.cmp
.automatic
)
16277 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16278 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16280 glyph
->left_box_line_p
,
16281 glyph
->right_box_line_p
);
16286 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16287 GLYPHS 0 means don't show glyph contents.
16288 GLYPHS 1 means show glyphs in short form
16289 GLYPHS > 1 means show glyphs in long form. */
16292 dump_glyph_row (row
, vpos
, glyphs
)
16293 struct glyph_row
*row
;
16298 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16299 fprintf (stderr
, "======================================================================\n");
16301 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16302 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16304 MATRIX_ROW_START_CHARPOS (row
),
16305 MATRIX_ROW_END_CHARPOS (row
),
16306 row
->used
[TEXT_AREA
],
16307 row
->contains_overlapping_glyphs_p
,
16309 row
->truncated_on_left_p
,
16310 row
->truncated_on_right_p
,
16312 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16313 row
->displays_text_p
,
16316 row
->ends_in_middle_of_char_p
,
16317 row
->starts_in_middle_of_char_p
,
16323 row
->visible_height
,
16326 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16327 row
->end
.overlay_string_index
,
16328 row
->continuation_lines_width
);
16329 fprintf (stderr
, "%9d %5d\n",
16330 CHARPOS (row
->start
.string_pos
),
16331 CHARPOS (row
->end
.string_pos
));
16332 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16333 row
->end
.dpvec_index
);
16340 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16342 struct glyph
*glyph
= row
->glyphs
[area
];
16343 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16345 /* Glyph for a line end in text. */
16346 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16349 if (glyph
< glyph_end
)
16350 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16352 for (; glyph
< glyph_end
; ++glyph
)
16353 dump_glyph (row
, glyph
, area
);
16356 else if (glyphs
== 1)
16360 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16362 char *s
= (char *) alloca (row
->used
[area
] + 1);
16365 for (i
= 0; i
< row
->used
[area
]; ++i
)
16367 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16368 if (glyph
->type
== CHAR_GLYPH
16369 && glyph
->u
.ch
< 0x80
16370 && glyph
->u
.ch
>= ' ')
16371 s
[i
] = glyph
->u
.ch
;
16377 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16383 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16384 Sdump_glyph_matrix
, 0, 1, "p",
16385 doc
: /* Dump the current matrix of the selected window to stderr.
16386 Shows contents of glyph row structures. With non-nil
16387 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16388 glyphs in short form, otherwise show glyphs in long form. */)
16389 (Lisp_Object glyphs
)
16391 struct window
*w
= XWINDOW (selected_window
);
16392 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16394 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16395 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16396 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16397 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16398 fprintf (stderr
, "=============================================\n");
16399 dump_glyph_matrix (w
->current_matrix
,
16400 NILP (glyphs
) ? 0 : XINT (glyphs
));
16405 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16406 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16409 struct frame
*f
= XFRAME (selected_frame
);
16410 dump_glyph_matrix (f
->current_matrix
, 1);
16415 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16416 doc
: /* Dump glyph row ROW to stderr.
16417 GLYPH 0 means don't dump glyphs.
16418 GLYPH 1 means dump glyphs in short form.
16419 GLYPH > 1 or omitted means dump glyphs in long form. */)
16420 (Lisp_Object row
, Lisp_Object glyphs
)
16422 struct glyph_matrix
*matrix
;
16425 CHECK_NUMBER (row
);
16426 matrix
= XWINDOW (selected_window
)->current_matrix
;
16428 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16429 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16431 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16436 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16437 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16438 GLYPH 0 means don't dump glyphs.
16439 GLYPH 1 means dump glyphs in short form.
16440 GLYPH > 1 or omitted means dump glyphs in long form. */)
16441 (Lisp_Object row
, Lisp_Object glyphs
)
16443 struct frame
*sf
= SELECTED_FRAME ();
16444 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16447 CHECK_NUMBER (row
);
16449 if (vpos
>= 0 && vpos
< m
->nrows
)
16450 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16451 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16456 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16457 doc
: /* Toggle tracing of redisplay.
16458 With ARG, turn tracing on if and only if ARG is positive. */)
16462 trace_redisplay_p
= !trace_redisplay_p
;
16465 arg
= Fprefix_numeric_value (arg
);
16466 trace_redisplay_p
= XINT (arg
) > 0;
16473 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16474 doc
: /* Like `format', but print result to stderr.
16475 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16476 (size_t nargs
, Lisp_Object
*args
)
16478 Lisp_Object s
= Fformat (nargs
, args
);
16479 fprintf (stderr
, "%s", SDATA (s
));
16483 #endif /* GLYPH_DEBUG */
16487 /***********************************************************************
16488 Building Desired Matrix Rows
16489 ***********************************************************************/
16491 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16492 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16494 static struct glyph_row
*
16495 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16497 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16498 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16499 struct buffer
*old
= current_buffer
;
16500 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16501 int arrow_len
= SCHARS (overlay_arrow_string
);
16502 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16503 const unsigned char *p
;
16506 int n_glyphs_before
;
16508 set_buffer_temp (buffer
);
16509 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16510 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16511 SET_TEXT_POS (it
.position
, 0, 0);
16513 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16515 while (p
< arrow_end
)
16517 Lisp_Object face
, ilisp
;
16519 /* Get the next character. */
16521 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16524 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16525 if (! ASCII_CHAR_P (it
.c
))
16526 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16530 /* Get its face. */
16531 ilisp
= make_number (p
- arrow_string
);
16532 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16533 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16535 /* Compute its width, get its glyphs. */
16536 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16537 SET_TEXT_POS (it
.position
, -1, -1);
16538 PRODUCE_GLYPHS (&it
);
16540 /* If this character doesn't fit any more in the line, we have
16541 to remove some glyphs. */
16542 if (it
.current_x
> it
.last_visible_x
)
16544 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16549 set_buffer_temp (old
);
16550 return it
.glyph_row
;
16554 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16555 glyphs are only inserted for terminal frames since we can't really
16556 win with truncation glyphs when partially visible glyphs are
16557 involved. Which glyphs to insert is determined by
16558 produce_special_glyphs. */
16561 insert_left_trunc_glyphs (struct it
*it
)
16563 struct it truncate_it
;
16564 struct glyph
*from
, *end
, *to
, *toend
;
16566 xassert (!FRAME_WINDOW_P (it
->f
));
16568 /* Get the truncation glyphs. */
16570 truncate_it
.current_x
= 0;
16571 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16572 truncate_it
.glyph_row
= &scratch_glyph_row
;
16573 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16574 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16575 truncate_it
.object
= make_number (0);
16576 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16578 /* Overwrite glyphs from IT with truncation glyphs. */
16579 if (!it
->glyph_row
->reversed_p
)
16581 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16582 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16583 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16584 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16589 /* There may be padding glyphs left over. Overwrite them too. */
16590 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16592 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16598 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16602 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16603 that back to front. */
16604 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16605 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16606 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16607 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16609 while (from
>= end
&& to
>= toend
)
16611 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16614 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16615 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16616 while (from
>= end
&& to
>= toend
)
16621 /* Need to free some room before prepending additional
16623 int move_by
= from
- end
+ 1;
16624 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16625 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16627 for ( ; g
>= g0
; g
--)
16629 while (from
>= end
)
16631 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16637 /* Compute the pixel height and width of IT->glyph_row.
16639 Most of the time, ascent and height of a display line will be equal
16640 to the max_ascent and max_height values of the display iterator
16641 structure. This is not the case if
16643 1. We hit ZV without displaying anything. In this case, max_ascent
16644 and max_height will be zero.
16646 2. We have some glyphs that don't contribute to the line height.
16647 (The glyph row flag contributes_to_line_height_p is for future
16648 pixmap extensions).
16650 The first case is easily covered by using default values because in
16651 these cases, the line height does not really matter, except that it
16652 must not be zero. */
16655 compute_line_metrics (struct it
*it
)
16657 struct glyph_row
*row
= it
->glyph_row
;
16659 if (FRAME_WINDOW_P (it
->f
))
16661 int i
, min_y
, max_y
;
16663 /* The line may consist of one space only, that was added to
16664 place the cursor on it. If so, the row's height hasn't been
16666 if (row
->height
== 0)
16668 if (it
->max_ascent
+ it
->max_descent
== 0)
16669 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16670 row
->ascent
= it
->max_ascent
;
16671 row
->height
= it
->max_ascent
+ it
->max_descent
;
16672 row
->phys_ascent
= it
->max_phys_ascent
;
16673 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16674 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16677 /* Compute the width of this line. */
16678 row
->pixel_width
= row
->x
;
16679 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16680 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16682 xassert (row
->pixel_width
>= 0);
16683 xassert (row
->ascent
>= 0 && row
->height
> 0);
16685 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16686 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16688 /* If first line's physical ascent is larger than its logical
16689 ascent, use the physical ascent, and make the row taller.
16690 This makes accented characters fully visible. */
16691 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16692 && row
->phys_ascent
> row
->ascent
)
16694 row
->height
+= row
->phys_ascent
- row
->ascent
;
16695 row
->ascent
= row
->phys_ascent
;
16698 /* Compute how much of the line is visible. */
16699 row
->visible_height
= row
->height
;
16701 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16702 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16704 if (row
->y
< min_y
)
16705 row
->visible_height
-= min_y
- row
->y
;
16706 if (row
->y
+ row
->height
> max_y
)
16707 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16711 row
->pixel_width
= row
->used
[TEXT_AREA
];
16712 if (row
->continued_p
)
16713 row
->pixel_width
-= it
->continuation_pixel_width
;
16714 else if (row
->truncated_on_right_p
)
16715 row
->pixel_width
-= it
->truncation_pixel_width
;
16716 row
->ascent
= row
->phys_ascent
= 0;
16717 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16718 row
->extra_line_spacing
= 0;
16721 /* Compute a hash code for this row. */
16725 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16726 for (i
= 0; i
< row
->used
[area
]; ++i
)
16727 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16728 + row
->glyphs
[area
][i
].u
.val
16729 + row
->glyphs
[area
][i
].face_id
16730 + row
->glyphs
[area
][i
].padding_p
16731 + (row
->glyphs
[area
][i
].type
<< 2));
16734 it
->max_ascent
= it
->max_descent
= 0;
16735 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16739 /* Append one space to the glyph row of iterator IT if doing a
16740 window-based redisplay. The space has the same face as
16741 IT->face_id. Value is non-zero if a space was added.
16743 This function is called to make sure that there is always one glyph
16744 at the end of a glyph row that the cursor can be set on under
16745 window-systems. (If there weren't such a glyph we would not know
16746 how wide and tall a box cursor should be displayed).
16748 At the same time this space let's a nicely handle clearing to the
16749 end of the line if the row ends in italic text. */
16752 append_space_for_newline (struct it
*it
, int default_face_p
)
16754 if (FRAME_WINDOW_P (it
->f
))
16756 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16758 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16759 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16761 /* Save some values that must not be changed.
16762 Must save IT->c and IT->len because otherwise
16763 ITERATOR_AT_END_P wouldn't work anymore after
16764 append_space_for_newline has been called. */
16765 enum display_element_type saved_what
= it
->what
;
16766 int saved_c
= it
->c
, saved_len
= it
->len
;
16767 int saved_char_to_display
= it
->char_to_display
;
16768 int saved_x
= it
->current_x
;
16769 int saved_face_id
= it
->face_id
;
16770 struct text_pos saved_pos
;
16771 Lisp_Object saved_object
;
16774 saved_object
= it
->object
;
16775 saved_pos
= it
->position
;
16777 it
->what
= IT_CHARACTER
;
16778 memset (&it
->position
, 0, sizeof it
->position
);
16779 it
->object
= make_number (0);
16780 it
->c
= it
->char_to_display
= ' ';
16783 if (default_face_p
)
16784 it
->face_id
= DEFAULT_FACE_ID
;
16785 else if (it
->face_before_selective_p
)
16786 it
->face_id
= it
->saved_face_id
;
16787 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16788 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16790 PRODUCE_GLYPHS (it
);
16792 it
->override_ascent
= -1;
16793 it
->constrain_row_ascent_descent_p
= 0;
16794 it
->current_x
= saved_x
;
16795 it
->object
= saved_object
;
16796 it
->position
= saved_pos
;
16797 it
->what
= saved_what
;
16798 it
->face_id
= saved_face_id
;
16799 it
->len
= saved_len
;
16801 it
->char_to_display
= saved_char_to_display
;
16810 /* Extend the face of the last glyph in the text area of IT->glyph_row
16811 to the end of the display line. Called from display_line. If the
16812 glyph row is empty, add a space glyph to it so that we know the
16813 face to draw. Set the glyph row flag fill_line_p. If the glyph
16814 row is R2L, prepend a stretch glyph to cover the empty space to the
16815 left of the leftmost glyph. */
16818 extend_face_to_end_of_line (struct it
*it
)
16821 struct frame
*f
= it
->f
;
16823 /* If line is already filled, do nothing. Non window-system frames
16824 get a grace of one more ``pixel'' because their characters are
16825 1-``pixel'' wide, so they hit the equality too early. This grace
16826 is needed only for R2L rows that are not continued, to produce
16827 one extra blank where we could display the cursor. */
16828 if (it
->current_x
>= it
->last_visible_x
16829 + (!FRAME_WINDOW_P (f
)
16830 && it
->glyph_row
->reversed_p
16831 && !it
->glyph_row
->continued_p
))
16834 /* Face extension extends the background and box of IT->face_id
16835 to the end of the line. If the background equals the background
16836 of the frame, we don't have to do anything. */
16837 if (it
->face_before_selective_p
)
16838 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16840 face
= FACE_FROM_ID (f
, it
->face_id
);
16842 if (FRAME_WINDOW_P (f
)
16843 && it
->glyph_row
->displays_text_p
16844 && face
->box
== FACE_NO_BOX
16845 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16847 && !it
->glyph_row
->reversed_p
)
16850 /* Set the glyph row flag indicating that the face of the last glyph
16851 in the text area has to be drawn to the end of the text area. */
16852 it
->glyph_row
->fill_line_p
= 1;
16854 /* If current character of IT is not ASCII, make sure we have the
16855 ASCII face. This will be automatically undone the next time
16856 get_next_display_element returns a multibyte character. Note
16857 that the character will always be single byte in unibyte
16859 if (!ASCII_CHAR_P (it
->c
))
16861 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16864 if (FRAME_WINDOW_P (f
))
16866 /* If the row is empty, add a space with the current face of IT,
16867 so that we know which face to draw. */
16868 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16870 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16871 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16872 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16874 #ifdef HAVE_WINDOW_SYSTEM
16875 if (it
->glyph_row
->reversed_p
)
16877 /* Prepend a stretch glyph to the row, such that the
16878 rightmost glyph will be drawn flushed all the way to the
16879 right margin of the window. The stretch glyph that will
16880 occupy the empty space, if any, to the left of the
16882 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16883 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16884 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16886 int row_width
, stretch_ascent
, stretch_width
;
16887 struct text_pos saved_pos
;
16888 int saved_face_id
, saved_avoid_cursor
;
16890 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16891 row_width
+= g
->pixel_width
;
16892 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16893 if (stretch_width
> 0)
16896 (((it
->ascent
+ it
->descent
)
16897 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16898 saved_pos
= it
->position
;
16899 memset (&it
->position
, 0, sizeof it
->position
);
16900 saved_avoid_cursor
= it
->avoid_cursor_p
;
16901 it
->avoid_cursor_p
= 1;
16902 saved_face_id
= it
->face_id
;
16903 /* The last row's stretch glyph should get the default
16904 face, to avoid painting the rest of the window with
16905 the region face, if the region ends at ZV. */
16906 if (it
->glyph_row
->ends_at_zv_p
)
16907 it
->face_id
= DEFAULT_FACE_ID
;
16909 it
->face_id
= face
->id
;
16910 append_stretch_glyph (it
, make_number (0), stretch_width
,
16911 it
->ascent
+ it
->descent
, stretch_ascent
);
16912 it
->position
= saved_pos
;
16913 it
->avoid_cursor_p
= saved_avoid_cursor
;
16914 it
->face_id
= saved_face_id
;
16917 #endif /* HAVE_WINDOW_SYSTEM */
16921 /* Save some values that must not be changed. */
16922 int saved_x
= it
->current_x
;
16923 struct text_pos saved_pos
;
16924 Lisp_Object saved_object
;
16925 enum display_element_type saved_what
= it
->what
;
16926 int saved_face_id
= it
->face_id
;
16928 saved_object
= it
->object
;
16929 saved_pos
= it
->position
;
16931 it
->what
= IT_CHARACTER
;
16932 memset (&it
->position
, 0, sizeof it
->position
);
16933 it
->object
= make_number (0);
16934 it
->c
= it
->char_to_display
= ' ';
16936 /* The last row's blank glyphs should get the default face, to
16937 avoid painting the rest of the window with the region face,
16938 if the region ends at ZV. */
16939 if (it
->glyph_row
->ends_at_zv_p
)
16940 it
->face_id
= DEFAULT_FACE_ID
;
16942 it
->face_id
= face
->id
;
16944 PRODUCE_GLYPHS (it
);
16946 while (it
->current_x
<= it
->last_visible_x
)
16947 PRODUCE_GLYPHS (it
);
16949 /* Don't count these blanks really. It would let us insert a left
16950 truncation glyph below and make us set the cursor on them, maybe. */
16951 it
->current_x
= saved_x
;
16952 it
->object
= saved_object
;
16953 it
->position
= saved_pos
;
16954 it
->what
= saved_what
;
16955 it
->face_id
= saved_face_id
;
16960 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16961 trailing whitespace. */
16964 trailing_whitespace_p (EMACS_INT charpos
)
16966 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16969 while (bytepos
< ZV_BYTE
16970 && (c
= FETCH_CHAR (bytepos
),
16971 c
== ' ' || c
== '\t'))
16974 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16976 if (bytepos
!= PT_BYTE
)
16983 /* Highlight trailing whitespace, if any, in ROW. */
16986 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16988 int used
= row
->used
[TEXT_AREA
];
16992 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16993 struct glyph
*glyph
= start
+ used
- 1;
16995 if (row
->reversed_p
)
16997 /* Right-to-left rows need to be processed in the opposite
16998 direction, so swap the edge pointers. */
17000 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17003 /* Skip over glyphs inserted to display the cursor at the
17004 end of a line, for extending the face of the last glyph
17005 to the end of the line on terminals, and for truncation
17006 and continuation glyphs. */
17007 if (!row
->reversed_p
)
17009 while (glyph
>= start
17010 && glyph
->type
== CHAR_GLYPH
17011 && INTEGERP (glyph
->object
))
17016 while (glyph
<= start
17017 && glyph
->type
== CHAR_GLYPH
17018 && INTEGERP (glyph
->object
))
17022 /* If last glyph is a space or stretch, and it's trailing
17023 whitespace, set the face of all trailing whitespace glyphs in
17024 IT->glyph_row to `trailing-whitespace'. */
17025 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17026 && BUFFERP (glyph
->object
)
17027 && (glyph
->type
== STRETCH_GLYPH
17028 || (glyph
->type
== CHAR_GLYPH
17029 && glyph
->u
.ch
== ' '))
17030 && trailing_whitespace_p (glyph
->charpos
))
17032 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17036 if (!row
->reversed_p
)
17038 while (glyph
>= start
17039 && BUFFERP (glyph
->object
)
17040 && (glyph
->type
== STRETCH_GLYPH
17041 || (glyph
->type
== CHAR_GLYPH
17042 && glyph
->u
.ch
== ' ')))
17043 (glyph
--)->face_id
= face_id
;
17047 while (glyph
<= start
17048 && BUFFERP (glyph
->object
)
17049 && (glyph
->type
== STRETCH_GLYPH
17050 || (glyph
->type
== CHAR_GLYPH
17051 && glyph
->u
.ch
== ' ')))
17052 (glyph
++)->face_id
= face_id
;
17059 /* Value is non-zero if glyph row ROW should be
17060 used to hold the cursor. */
17063 cursor_row_p (struct glyph_row
*row
)
17067 if (PT
== CHARPOS (row
->end
.pos
))
17069 /* Suppose the row ends on a string.
17070 Unless the row is continued, that means it ends on a newline
17071 in the string. If it's anything other than a display string
17072 (e.g. a before-string from an overlay), we don't want the
17073 cursor there. (This heuristic seems to give the optimal
17074 behavior for the various types of multi-line strings.) */
17075 if (CHARPOS (row
->end
.string_pos
) >= 0)
17077 if (row
->continued_p
)
17081 /* Check for `display' property. */
17082 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17083 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17084 struct glyph
*glyph
;
17087 for (glyph
= end
; glyph
>= beg
; --glyph
)
17088 if (STRINGP (glyph
->object
))
17091 = Fget_char_property (make_number (PT
),
17095 && display_prop_string_p (prop
, glyph
->object
));
17100 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17102 /* If the row ends in middle of a real character,
17103 and the line is continued, we want the cursor here.
17104 That's because CHARPOS (ROW->end.pos) would equal
17105 PT if PT is before the character. */
17106 if (!row
->ends_in_ellipsis_p
)
17107 result
= row
->continued_p
;
17109 /* If the row ends in an ellipsis, then
17110 CHARPOS (ROW->end.pos) will equal point after the
17111 invisible text. We want that position to be displayed
17112 after the ellipsis. */
17115 /* If the row ends at ZV, display the cursor at the end of that
17116 row instead of at the start of the row below. */
17117 else if (row
->ends_at_zv_p
)
17128 /* Push the display property PROP so that it will be rendered at the
17129 current position in IT. Return 1 if PROP was successfully pushed,
17133 push_display_prop (struct it
*it
, Lisp_Object prop
)
17137 if (STRINGP (prop
))
17139 if (SCHARS (prop
) == 0)
17146 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17147 it
->current
.overlay_string_index
= -1;
17148 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17149 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17150 it
->method
= GET_FROM_STRING
;
17151 it
->stop_charpos
= 0;
17153 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17155 it
->method
= GET_FROM_STRETCH
;
17158 #ifdef HAVE_WINDOW_SYSTEM
17159 else if (IMAGEP (prop
))
17161 it
->what
= IT_IMAGE
;
17162 it
->image_id
= lookup_image (it
->f
, prop
);
17163 it
->method
= GET_FROM_IMAGE
;
17165 #endif /* HAVE_WINDOW_SYSTEM */
17168 pop_it (it
); /* bogus display property, give up */
17175 /* Return the character-property PROP at the current position in IT. */
17178 get_it_property (struct it
*it
, Lisp_Object prop
)
17180 Lisp_Object position
;
17182 if (STRINGP (it
->object
))
17183 position
= make_number (IT_STRING_CHARPOS (*it
));
17184 else if (BUFFERP (it
->object
))
17185 position
= make_number (IT_CHARPOS (*it
));
17189 return Fget_char_property (position
, prop
, it
->object
);
17192 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17195 handle_line_prefix (struct it
*it
)
17197 Lisp_Object prefix
;
17198 if (it
->continuation_lines_width
> 0)
17200 prefix
= get_it_property (it
, Qwrap_prefix
);
17202 prefix
= Vwrap_prefix
;
17206 prefix
= get_it_property (it
, Qline_prefix
);
17208 prefix
= Vline_prefix
;
17210 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17212 /* If the prefix is wider than the window, and we try to wrap
17213 it, it would acquire its own wrap prefix, and so on till the
17214 iterator stack overflows. So, don't wrap the prefix. */
17215 it
->line_wrap
= TRUNCATE
;
17216 it
->avoid_cursor_p
= 1;
17222 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17223 only for R2L lines from display_line, when it decides that too many
17224 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17227 unproduce_glyphs (struct it
*it
, int n
)
17229 struct glyph
*glyph
, *end
;
17231 xassert (it
->glyph_row
);
17232 xassert (it
->glyph_row
->reversed_p
);
17233 xassert (it
->area
== TEXT_AREA
);
17234 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17236 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17237 n
= it
->glyph_row
->used
[TEXT_AREA
];
17238 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17239 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17240 for ( ; glyph
< end
; glyph
++)
17241 glyph
[-n
] = *glyph
;
17244 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17245 and ROW->maxpos. */
17247 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17248 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17249 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17251 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17252 lines' rows is implemented for bidi-reordered rows. */
17254 /* ROW->minpos is the value of min_pos, the minimal buffer position
17257 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17259 /* We didn't find _any_ valid buffer positions in any of the
17260 glyphs, so we must trust the iterator's computed positions. */
17261 row
->minpos
= row
->start
.pos
;
17264 max_pos
= CHARPOS (it
->current
.pos
);
17265 max_bpos
= BYTEPOS (it
->current
.pos
);
17268 /* Here are the various use-cases for ending the row, and the
17269 corresponding values for ROW->maxpos:
17271 Line ends in a newline from buffer eol_pos + 1
17272 Line is continued from buffer max_pos + 1
17273 Line is truncated on right it->current.pos
17274 Line ends in a newline from string max_pos
17275 Line is continued from string max_pos
17276 Line is continued from display vector max_pos
17277 Line is entirely from a string min_pos == max_pos
17278 Line is entirely from a display vector min_pos == max_pos
17279 Line that ends at ZV ZV
17281 If you discover other use-cases, please add them here as
17283 if (row
->ends_at_zv_p
)
17284 row
->maxpos
= it
->current
.pos
;
17285 else if (row
->used
[TEXT_AREA
])
17287 if (row
->ends_in_newline_from_string_p
)
17288 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17289 else if (CHARPOS (it
->eol_pos
) > 0)
17290 SET_TEXT_POS (row
->maxpos
,
17291 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17292 else if (row
->continued_p
)
17294 /* If max_pos is different from IT's current position, it
17295 means IT->method does not belong to the display element
17296 at max_pos. However, it also means that the display
17297 element at max_pos was displayed in its entirety on this
17298 line, which is equivalent to saying that the next line
17299 starts at the next buffer position. */
17300 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17301 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17304 INC_BOTH (max_pos
, max_bpos
);
17305 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17308 else if (row
->truncated_on_right_p
)
17309 /* display_line already called reseat_at_next_visible_line_start,
17310 which puts the iterator at the beginning of the next line, in
17311 the logical order. */
17312 row
->maxpos
= it
->current
.pos
;
17313 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17314 /* A line that is entirely from a string/image/stretch... */
17315 row
->maxpos
= row
->minpos
;
17320 row
->maxpos
= it
->current
.pos
;
17323 /* Construct the glyph row IT->glyph_row in the desired matrix of
17324 IT->w from text at the current position of IT. See dispextern.h
17325 for an overview of struct it. Value is non-zero if
17326 IT->glyph_row displays text, as opposed to a line displaying ZV
17330 display_line (struct it
*it
)
17332 struct glyph_row
*row
= it
->glyph_row
;
17333 Lisp_Object overlay_arrow_string
;
17335 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17336 int wrap_row_used
= -1;
17337 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17338 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17339 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17340 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17341 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17343 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17344 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17346 /* We always start displaying at hpos zero even if hscrolled. */
17347 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17349 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17350 >= it
->w
->desired_matrix
->nrows
)
17352 it
->w
->nrows_scale_factor
++;
17353 fonts_changed_p
= 1;
17357 /* Is IT->w showing the region? */
17358 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17360 /* Clear the result glyph row and enable it. */
17361 prepare_desired_row (row
);
17363 row
->y
= it
->current_y
;
17364 row
->start
= it
->start
;
17365 row
->continuation_lines_width
= it
->continuation_lines_width
;
17366 row
->displays_text_p
= 1;
17367 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17368 it
->starts_in_middle_of_char_p
= 0;
17370 /* Arrange the overlays nicely for our purposes. Usually, we call
17371 display_line on only one line at a time, in which case this
17372 can't really hurt too much, or we call it on lines which appear
17373 one after another in the buffer, in which case all calls to
17374 recenter_overlay_lists but the first will be pretty cheap. */
17375 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17377 /* Move over display elements that are not visible because we are
17378 hscrolled. This may stop at an x-position < IT->first_visible_x
17379 if the first glyph is partially visible or if we hit a line end. */
17380 if (it
->current_x
< it
->first_visible_x
)
17382 this_line_min_pos
= row
->start
.pos
;
17383 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17384 MOVE_TO_POS
| MOVE_TO_X
);
17385 /* Record the smallest positions seen while we moved over
17386 display elements that are not visible. This is needed by
17387 redisplay_internal for optimizing the case where the cursor
17388 stays inside the same line. The rest of this function only
17389 considers positions that are actually displayed, so
17390 RECORD_MAX_MIN_POS will not otherwise record positions that
17391 are hscrolled to the left of the left edge of the window. */
17392 min_pos
= CHARPOS (this_line_min_pos
);
17393 min_bpos
= BYTEPOS (this_line_min_pos
);
17397 /* We only do this when not calling `move_it_in_display_line_to'
17398 above, because move_it_in_display_line_to calls
17399 handle_line_prefix itself. */
17400 handle_line_prefix (it
);
17403 /* Get the initial row height. This is either the height of the
17404 text hscrolled, if there is any, or zero. */
17405 row
->ascent
= it
->max_ascent
;
17406 row
->height
= it
->max_ascent
+ it
->max_descent
;
17407 row
->phys_ascent
= it
->max_phys_ascent
;
17408 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17409 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17411 /* Utility macro to record max and min buffer positions seen until now. */
17412 #define RECORD_MAX_MIN_POS(IT) \
17415 if (IT_CHARPOS (*(IT)) < min_pos) \
17417 min_pos = IT_CHARPOS (*(IT)); \
17418 min_bpos = IT_BYTEPOS (*(IT)); \
17420 if (IT_CHARPOS (*(IT)) > max_pos) \
17422 max_pos = IT_CHARPOS (*(IT)); \
17423 max_bpos = IT_BYTEPOS (*(IT)); \
17428 /* Loop generating characters. The loop is left with IT on the next
17429 character to display. */
17432 int n_glyphs_before
, hpos_before
, x_before
;
17434 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17436 /* Retrieve the next thing to display. Value is zero if end of
17438 if (!get_next_display_element (it
))
17440 /* Maybe add a space at the end of this line that is used to
17441 display the cursor there under X. Set the charpos of the
17442 first glyph of blank lines not corresponding to any text
17444 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17445 row
->exact_window_width_line_p
= 1;
17446 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17447 || row
->used
[TEXT_AREA
] == 0)
17449 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17450 row
->displays_text_p
= 0;
17452 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17453 && (!MINI_WINDOW_P (it
->w
)
17454 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17455 row
->indicate_empty_line_p
= 1;
17458 it
->continuation_lines_width
= 0;
17459 row
->ends_at_zv_p
= 1;
17460 /* A row that displays right-to-left text must always have
17461 its last face extended all the way to the end of line,
17462 even if this row ends in ZV, because we still write to
17463 the screen left to right. */
17464 if (row
->reversed_p
)
17465 extend_face_to_end_of_line (it
);
17469 /* Now, get the metrics of what we want to display. This also
17470 generates glyphs in `row' (which is IT->glyph_row). */
17471 n_glyphs_before
= row
->used
[TEXT_AREA
];
17474 /* Remember the line height so far in case the next element doesn't
17475 fit on the line. */
17476 if (it
->line_wrap
!= TRUNCATE
)
17478 ascent
= it
->max_ascent
;
17479 descent
= it
->max_descent
;
17480 phys_ascent
= it
->max_phys_ascent
;
17481 phys_descent
= it
->max_phys_descent
;
17483 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17485 if (IT_DISPLAYING_WHITESPACE (it
))
17491 wrap_row_used
= row
->used
[TEXT_AREA
];
17492 wrap_row_ascent
= row
->ascent
;
17493 wrap_row_height
= row
->height
;
17494 wrap_row_phys_ascent
= row
->phys_ascent
;
17495 wrap_row_phys_height
= row
->phys_height
;
17496 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17497 wrap_row_min_pos
= min_pos
;
17498 wrap_row_min_bpos
= min_bpos
;
17499 wrap_row_max_pos
= max_pos
;
17500 wrap_row_max_bpos
= max_bpos
;
17506 PRODUCE_GLYPHS (it
);
17508 /* If this display element was in marginal areas, continue with
17510 if (it
->area
!= TEXT_AREA
)
17512 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17513 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17514 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17515 row
->phys_height
= max (row
->phys_height
,
17516 it
->max_phys_ascent
+ it
->max_phys_descent
);
17517 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17518 it
->max_extra_line_spacing
);
17519 set_iterator_to_next (it
, 1);
17523 /* Does the display element fit on the line? If we truncate
17524 lines, we should draw past the right edge of the window. If
17525 we don't truncate, we want to stop so that we can display the
17526 continuation glyph before the right margin. If lines are
17527 continued, there are two possible strategies for characters
17528 resulting in more than 1 glyph (e.g. tabs): Display as many
17529 glyphs as possible in this line and leave the rest for the
17530 continuation line, or display the whole element in the next
17531 line. Original redisplay did the former, so we do it also. */
17532 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17533 hpos_before
= it
->hpos
;
17536 if (/* Not a newline. */
17538 /* Glyphs produced fit entirely in the line. */
17539 && it
->current_x
< it
->last_visible_x
)
17541 it
->hpos
+= nglyphs
;
17542 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17543 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17544 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17545 row
->phys_height
= max (row
->phys_height
,
17546 it
->max_phys_ascent
+ it
->max_phys_descent
);
17547 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17548 it
->max_extra_line_spacing
);
17549 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17550 row
->x
= x
- it
->first_visible_x
;
17551 /* Record the maximum and minimum buffer positions seen so
17552 far in glyphs that will be displayed by this row. */
17554 RECORD_MAX_MIN_POS (it
);
17559 struct glyph
*glyph
;
17561 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17563 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17564 new_x
= x
+ glyph
->pixel_width
;
17566 if (/* Lines are continued. */
17567 it
->line_wrap
!= TRUNCATE
17568 && (/* Glyph doesn't fit on the line. */
17569 new_x
> it
->last_visible_x
17570 /* Or it fits exactly on a window system frame. */
17571 || (new_x
== it
->last_visible_x
17572 && FRAME_WINDOW_P (it
->f
))))
17574 /* End of a continued line. */
17577 || (new_x
== it
->last_visible_x
17578 && FRAME_WINDOW_P (it
->f
)))
17580 /* Current glyph is the only one on the line or
17581 fits exactly on the line. We must continue
17582 the line because we can't draw the cursor
17583 after the glyph. */
17584 row
->continued_p
= 1;
17585 it
->current_x
= new_x
;
17586 it
->continuation_lines_width
+= new_x
;
17588 /* Record the maximum and minimum buffer
17589 positions seen so far in glyphs that will be
17590 displayed by this row. */
17592 RECORD_MAX_MIN_POS (it
);
17593 if (i
== nglyphs
- 1)
17595 /* If line-wrap is on, check if a previous
17596 wrap point was found. */
17597 if (wrap_row_used
> 0
17598 /* Even if there is a previous wrap
17599 point, continue the line here as
17600 usual, if (i) the previous character
17601 was a space or tab AND (ii) the
17602 current character is not. */
17604 || IT_DISPLAYING_WHITESPACE (it
)))
17607 set_iterator_to_next (it
, 1);
17608 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17610 if (!get_next_display_element (it
))
17612 row
->exact_window_width_line_p
= 1;
17613 it
->continuation_lines_width
= 0;
17614 row
->continued_p
= 0;
17615 row
->ends_at_zv_p
= 1;
17617 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17619 row
->continued_p
= 0;
17620 row
->exact_window_width_line_p
= 1;
17625 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17626 && !FRAME_WINDOW_P (it
->f
))
17628 /* A padding glyph that doesn't fit on this line.
17629 This means the whole character doesn't fit
17631 if (row
->reversed_p
)
17632 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17633 - n_glyphs_before
);
17634 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17636 /* Fill the rest of the row with continuation
17637 glyphs like in 20.x. */
17638 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17639 < row
->glyphs
[1 + TEXT_AREA
])
17640 produce_special_glyphs (it
, IT_CONTINUATION
);
17642 row
->continued_p
= 1;
17643 it
->current_x
= x_before
;
17644 it
->continuation_lines_width
+= x_before
;
17646 /* Restore the height to what it was before the
17647 element not fitting on the line. */
17648 it
->max_ascent
= ascent
;
17649 it
->max_descent
= descent
;
17650 it
->max_phys_ascent
= phys_ascent
;
17651 it
->max_phys_descent
= phys_descent
;
17653 else if (wrap_row_used
> 0)
17656 if (row
->reversed_p
)
17657 unproduce_glyphs (it
,
17658 row
->used
[TEXT_AREA
] - wrap_row_used
);
17660 it
->continuation_lines_width
+= wrap_x
;
17661 row
->used
[TEXT_AREA
] = wrap_row_used
;
17662 row
->ascent
= wrap_row_ascent
;
17663 row
->height
= wrap_row_height
;
17664 row
->phys_ascent
= wrap_row_phys_ascent
;
17665 row
->phys_height
= wrap_row_phys_height
;
17666 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17667 min_pos
= wrap_row_min_pos
;
17668 min_bpos
= wrap_row_min_bpos
;
17669 max_pos
= wrap_row_max_pos
;
17670 max_bpos
= wrap_row_max_bpos
;
17671 row
->continued_p
= 1;
17672 row
->ends_at_zv_p
= 0;
17673 row
->exact_window_width_line_p
= 0;
17674 it
->continuation_lines_width
+= x
;
17676 /* Make sure that a non-default face is extended
17677 up to the right margin of the window. */
17678 extend_face_to_end_of_line (it
);
17680 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17682 /* A TAB that extends past the right edge of the
17683 window. This produces a single glyph on
17684 window system frames. We leave the glyph in
17685 this row and let it fill the row, but don't
17686 consume the TAB. */
17687 it
->continuation_lines_width
+= it
->last_visible_x
;
17688 row
->ends_in_middle_of_char_p
= 1;
17689 row
->continued_p
= 1;
17690 glyph
->pixel_width
= it
->last_visible_x
- x
;
17691 it
->starts_in_middle_of_char_p
= 1;
17695 /* Something other than a TAB that draws past
17696 the right edge of the window. Restore
17697 positions to values before the element. */
17698 if (row
->reversed_p
)
17699 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17700 - (n_glyphs_before
+ i
));
17701 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17703 /* Display continuation glyphs. */
17704 if (!FRAME_WINDOW_P (it
->f
))
17705 produce_special_glyphs (it
, IT_CONTINUATION
);
17706 row
->continued_p
= 1;
17708 it
->current_x
= x_before
;
17709 it
->continuation_lines_width
+= x
;
17710 extend_face_to_end_of_line (it
);
17712 if (nglyphs
> 1 && i
> 0)
17714 row
->ends_in_middle_of_char_p
= 1;
17715 it
->starts_in_middle_of_char_p
= 1;
17718 /* Restore the height to what it was before the
17719 element not fitting on the line. */
17720 it
->max_ascent
= ascent
;
17721 it
->max_descent
= descent
;
17722 it
->max_phys_ascent
= phys_ascent
;
17723 it
->max_phys_descent
= phys_descent
;
17728 else if (new_x
> it
->first_visible_x
)
17730 /* Increment number of glyphs actually displayed. */
17733 /* Record the maximum and minimum buffer positions
17734 seen so far in glyphs that will be displayed by
17737 RECORD_MAX_MIN_POS (it
);
17739 if (x
< it
->first_visible_x
)
17740 /* Glyph is partially visible, i.e. row starts at
17741 negative X position. */
17742 row
->x
= x
- it
->first_visible_x
;
17746 /* Glyph is completely off the left margin of the
17747 window. This should not happen because of the
17748 move_it_in_display_line at the start of this
17749 function, unless the text display area of the
17750 window is empty. */
17751 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17755 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17756 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17757 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17758 row
->phys_height
= max (row
->phys_height
,
17759 it
->max_phys_ascent
+ it
->max_phys_descent
);
17760 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17761 it
->max_extra_line_spacing
);
17763 /* End of this display line if row is continued. */
17764 if (row
->continued_p
|| row
->ends_at_zv_p
)
17769 /* Is this a line end? If yes, we're also done, after making
17770 sure that a non-default face is extended up to the right
17771 margin of the window. */
17772 if (ITERATOR_AT_END_OF_LINE_P (it
))
17774 int used_before
= row
->used
[TEXT_AREA
];
17776 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17778 /* Add a space at the end of the line that is used to
17779 display the cursor there. */
17780 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17781 append_space_for_newline (it
, 0);
17783 /* Extend the face to the end of the line. */
17784 extend_face_to_end_of_line (it
);
17786 /* Make sure we have the position. */
17787 if (used_before
== 0)
17788 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17790 /* Record the position of the newline, for use in
17792 it
->eol_pos
= it
->current
.pos
;
17794 /* Consume the line end. This skips over invisible lines. */
17795 set_iterator_to_next (it
, 1);
17796 it
->continuation_lines_width
= 0;
17800 /* Proceed with next display element. Note that this skips
17801 over lines invisible because of selective display. */
17802 set_iterator_to_next (it
, 1);
17804 /* If we truncate lines, we are done when the last displayed
17805 glyphs reach past the right margin of the window. */
17806 if (it
->line_wrap
== TRUNCATE
17807 && (FRAME_WINDOW_P (it
->f
)
17808 ? (it
->current_x
>= it
->last_visible_x
)
17809 : (it
->current_x
> it
->last_visible_x
)))
17811 /* Maybe add truncation glyphs. */
17812 if (!FRAME_WINDOW_P (it
->f
))
17816 if (!row
->reversed_p
)
17818 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17819 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17824 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17825 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17827 /* Remove any padding glyphs at the front of ROW, to
17828 make room for the truncation glyphs we will be
17829 adding below. The loop below always inserts at
17830 least one truncation glyph, so also remove the
17831 last glyph added to ROW. */
17832 unproduce_glyphs (it
, i
+ 1);
17833 /* Adjust i for the loop below. */
17834 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17837 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17839 row
->used
[TEXT_AREA
] = i
;
17840 produce_special_glyphs (it
, IT_TRUNCATION
);
17843 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17845 /* Don't truncate if we can overflow newline into fringe. */
17846 if (!get_next_display_element (it
))
17848 it
->continuation_lines_width
= 0;
17849 row
->ends_at_zv_p
= 1;
17850 row
->exact_window_width_line_p
= 1;
17853 if (ITERATOR_AT_END_OF_LINE_P (it
))
17855 row
->exact_window_width_line_p
= 1;
17856 goto at_end_of_line
;
17860 row
->truncated_on_right_p
= 1;
17861 it
->continuation_lines_width
= 0;
17862 reseat_at_next_visible_line_start (it
, 0);
17863 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17864 it
->hpos
= hpos_before
;
17865 it
->current_x
= x_before
;
17870 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17871 at the left window margin. */
17872 if (it
->first_visible_x
17873 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17875 if (!FRAME_WINDOW_P (it
->f
))
17876 insert_left_trunc_glyphs (it
);
17877 row
->truncated_on_left_p
= 1;
17880 /* Remember the position at which this line ends.
17882 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17883 cannot be before the call to find_row_edges below, since that is
17884 where these positions are determined. */
17885 row
->end
= it
->current
;
17888 row
->minpos
= row
->start
.pos
;
17889 row
->maxpos
= row
->end
.pos
;
17893 /* ROW->minpos and ROW->maxpos must be the smallest and
17894 `1 + the largest' buffer positions in ROW. But if ROW was
17895 bidi-reordered, these two positions can be anywhere in the
17896 row, so we must determine them now. */
17897 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17900 /* If the start of this line is the overlay arrow-position, then
17901 mark this glyph row as the one containing the overlay arrow.
17902 This is clearly a mess with variable size fonts. It would be
17903 better to let it be displayed like cursors under X. */
17904 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17905 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17906 !NILP (overlay_arrow_string
)))
17908 /* Overlay arrow in window redisplay is a fringe bitmap. */
17909 if (STRINGP (overlay_arrow_string
))
17911 struct glyph_row
*arrow_row
17912 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17913 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17914 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17915 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17916 struct glyph
*p2
, *end
;
17918 /* Copy the arrow glyphs. */
17919 while (glyph
< arrow_end
)
17922 /* Throw away padding glyphs. */
17924 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17925 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17931 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17936 xassert (INTEGERP (overlay_arrow_string
));
17937 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17939 overlay_arrow_seen
= 1;
17942 /* Compute pixel dimensions of this line. */
17943 compute_line_metrics (it
);
17945 /* Record whether this row ends inside an ellipsis. */
17946 row
->ends_in_ellipsis_p
17947 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17948 && it
->ellipsis_p
);
17950 /* Save fringe bitmaps in this row. */
17951 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17952 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17953 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17954 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17956 it
->left_user_fringe_bitmap
= 0;
17957 it
->left_user_fringe_face_id
= 0;
17958 it
->right_user_fringe_bitmap
= 0;
17959 it
->right_user_fringe_face_id
= 0;
17961 /* Maybe set the cursor. */
17962 cvpos
= it
->w
->cursor
.vpos
;
17964 /* In bidi-reordered rows, keep checking for proper cursor
17965 position even if one has been found already, because buffer
17966 positions in such rows change non-linearly with ROW->VPOS,
17967 when a line is continued. One exception: when we are at ZV,
17968 display cursor on the first suitable glyph row, since all
17969 the empty rows after that also have their position set to ZV. */
17970 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17971 lines' rows is implemented for bidi-reordered rows. */
17973 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17974 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17975 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17976 && cursor_row_p (row
))
17977 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17979 /* Highlight trailing whitespace. */
17980 if (!NILP (Vshow_trailing_whitespace
))
17981 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17983 /* Prepare for the next line. This line starts horizontally at (X
17984 HPOS) = (0 0). Vertical positions are incremented. As a
17985 convenience for the caller, IT->glyph_row is set to the next
17987 it
->current_x
= it
->hpos
= 0;
17988 it
->current_y
+= row
->height
;
17989 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17992 /* The next row should by default use the same value of the
17993 reversed_p flag as this one. set_iterator_to_next decides when
17994 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17995 the flag accordingly. */
17996 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17997 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17998 it
->start
= row
->end
;
17999 return row
->displays_text_p
;
18001 #undef RECORD_MAX_MIN_POS
18004 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18005 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18006 doc
: /* Return paragraph direction at point in BUFFER.
18007 Value is either `left-to-right' or `right-to-left'.
18008 If BUFFER is omitted or nil, it defaults to the current buffer.
18010 Paragraph direction determines how the text in the paragraph is displayed.
18011 In left-to-right paragraphs, text begins at the left margin of the window
18012 and the reading direction is generally left to right. In right-to-left
18013 paragraphs, text begins at the right margin and is read from right to left.
18015 See also `bidi-paragraph-direction'. */)
18016 (Lisp_Object buffer
)
18018 struct buffer
*buf
= current_buffer
;
18019 struct buffer
*old
= buf
;
18021 if (! NILP (buffer
))
18023 CHECK_BUFFER (buffer
);
18024 buf
= XBUFFER (buffer
);
18027 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18028 return Qleft_to_right
;
18029 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18030 return BVAR (buf
, bidi_paragraph_direction
);
18033 /* Determine the direction from buffer text. We could try to
18034 use current_matrix if it is up to date, but this seems fast
18035 enough as it is. */
18036 struct bidi_it itb
;
18037 EMACS_INT pos
= BUF_PT (buf
);
18038 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18041 set_buffer_temp (buf
);
18042 /* bidi_paragraph_init finds the base direction of the paragraph
18043 by searching forward from paragraph start. We need the base
18044 direction of the current or _previous_ paragraph, so we need
18045 to make sure we are within that paragraph. To that end, find
18046 the previous non-empty line. */
18047 if (pos
>= ZV
&& pos
> BEGV
)
18050 bytepos
= CHAR_TO_BYTE (pos
);
18052 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18053 || c
== ' ' || c
== '\t' || c
== '\f')
18055 if (bytepos
<= BEGV_BYTE
)
18060 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18063 itb
.bytepos
= bytepos
;
18065 itb
.separator_limit
= -1;
18066 itb
.paragraph_dir
= NEUTRAL_DIR
;
18068 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18069 set_buffer_temp (old
);
18070 switch (itb
.paragraph_dir
)
18073 return Qleft_to_right
;
18076 return Qright_to_left
;
18086 /***********************************************************************
18088 ***********************************************************************/
18090 /* Redisplay the menu bar in the frame for window W.
18092 The menu bar of X frames that don't have X toolkit support is
18093 displayed in a special window W->frame->menu_bar_window.
18095 The menu bar of terminal frames is treated specially as far as
18096 glyph matrices are concerned. Menu bar lines are not part of
18097 windows, so the update is done directly on the frame matrix rows
18098 for the menu bar. */
18101 display_menu_bar (struct window
*w
)
18103 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18108 /* Don't do all this for graphical frames. */
18110 if (FRAME_W32_P (f
))
18113 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18119 if (FRAME_NS_P (f
))
18121 #endif /* HAVE_NS */
18123 #ifdef USE_X_TOOLKIT
18124 xassert (!FRAME_WINDOW_P (f
));
18125 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18126 it
.first_visible_x
= 0;
18127 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18128 #else /* not USE_X_TOOLKIT */
18129 if (FRAME_WINDOW_P (f
))
18131 /* Menu bar lines are displayed in the desired matrix of the
18132 dummy window menu_bar_window. */
18133 struct window
*menu_w
;
18134 xassert (WINDOWP (f
->menu_bar_window
));
18135 menu_w
= XWINDOW (f
->menu_bar_window
);
18136 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18138 it
.first_visible_x
= 0;
18139 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18143 /* This is a TTY frame, i.e. character hpos/vpos are used as
18145 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18147 it
.first_visible_x
= 0;
18148 it
.last_visible_x
= FRAME_COLS (f
);
18150 #endif /* not USE_X_TOOLKIT */
18152 if (! mode_line_inverse_video
)
18153 /* Force the menu-bar to be displayed in the default face. */
18154 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18156 /* Clear all rows of the menu bar. */
18157 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18159 struct glyph_row
*row
= it
.glyph_row
+ i
;
18160 clear_glyph_row (row
);
18161 row
->enabled_p
= 1;
18162 row
->full_width_p
= 1;
18165 /* Display all items of the menu bar. */
18166 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18167 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18169 Lisp_Object string
;
18171 /* Stop at nil string. */
18172 string
= AREF (items
, i
+ 1);
18176 /* Remember where item was displayed. */
18177 ASET (items
, i
+ 3, make_number (it
.hpos
));
18179 /* Display the item, pad with one space. */
18180 if (it
.current_x
< it
.last_visible_x
)
18181 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18182 SCHARS (string
) + 1, 0, 0, -1);
18185 /* Fill out the line with spaces. */
18186 if (it
.current_x
< it
.last_visible_x
)
18187 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18189 /* Compute the total height of the lines. */
18190 compute_line_metrics (&it
);
18195 /***********************************************************************
18197 ***********************************************************************/
18199 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18200 FORCE is non-zero, redisplay mode lines unconditionally.
18201 Otherwise, redisplay only mode lines that are garbaged. Value is
18202 the number of windows whose mode lines were redisplayed. */
18205 redisplay_mode_lines (Lisp_Object window
, int force
)
18209 while (!NILP (window
))
18211 struct window
*w
= XWINDOW (window
);
18213 if (WINDOWP (w
->hchild
))
18214 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18215 else if (WINDOWP (w
->vchild
))
18216 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18218 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18219 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18221 struct text_pos lpoint
;
18222 struct buffer
*old
= current_buffer
;
18224 /* Set the window's buffer for the mode line display. */
18225 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18226 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18228 /* Point refers normally to the selected window. For any
18229 other window, set up appropriate value. */
18230 if (!EQ (window
, selected_window
))
18232 struct text_pos pt
;
18234 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18235 if (CHARPOS (pt
) < BEGV
)
18236 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18237 else if (CHARPOS (pt
) > (ZV
- 1))
18238 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18240 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18243 /* Display mode lines. */
18244 clear_glyph_matrix (w
->desired_matrix
);
18245 if (display_mode_lines (w
))
18248 w
->must_be_updated_p
= 1;
18251 /* Restore old settings. */
18252 set_buffer_internal_1 (old
);
18253 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18263 /* Display the mode and/or header line of window W. Value is the
18264 sum number of mode lines and header lines displayed. */
18267 display_mode_lines (struct window
*w
)
18269 Lisp_Object old_selected_window
, old_selected_frame
;
18272 old_selected_frame
= selected_frame
;
18273 selected_frame
= w
->frame
;
18274 old_selected_window
= selected_window
;
18275 XSETWINDOW (selected_window
, w
);
18277 /* These will be set while the mode line specs are processed. */
18278 line_number_displayed
= 0;
18279 w
->column_number_displayed
= Qnil
;
18281 if (WINDOW_WANTS_MODELINE_P (w
))
18283 struct window
*sel_w
= XWINDOW (old_selected_window
);
18285 /* Select mode line face based on the real selected window. */
18286 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18287 BVAR (current_buffer
, mode_line_format
));
18291 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18293 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18294 BVAR (current_buffer
, header_line_format
));
18298 selected_frame
= old_selected_frame
;
18299 selected_window
= old_selected_window
;
18304 /* Display mode or header line of window W. FACE_ID specifies which
18305 line to display; it is either MODE_LINE_FACE_ID or
18306 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18307 display. Value is the pixel height of the mode/header line
18311 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18315 int count
= SPECPDL_INDEX ();
18317 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18318 /* Don't extend on a previously drawn mode-line.
18319 This may happen if called from pos_visible_p. */
18320 it
.glyph_row
->enabled_p
= 0;
18321 prepare_desired_row (it
.glyph_row
);
18323 it
.glyph_row
->mode_line_p
= 1;
18325 if (! mode_line_inverse_video
)
18326 /* Force the mode-line to be displayed in the default face. */
18327 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18329 record_unwind_protect (unwind_format_mode_line
,
18330 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18332 mode_line_target
= MODE_LINE_DISPLAY
;
18334 /* Temporarily make frame's keyboard the current kboard so that
18335 kboard-local variables in the mode_line_format will get the right
18337 push_kboard (FRAME_KBOARD (it
.f
));
18338 record_unwind_save_match_data ();
18339 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18342 unbind_to (count
, Qnil
);
18344 /* Fill up with spaces. */
18345 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18347 compute_line_metrics (&it
);
18348 it
.glyph_row
->full_width_p
= 1;
18349 it
.glyph_row
->continued_p
= 0;
18350 it
.glyph_row
->truncated_on_left_p
= 0;
18351 it
.glyph_row
->truncated_on_right_p
= 0;
18353 /* Make a 3D mode-line have a shadow at its right end. */
18354 face
= FACE_FROM_ID (it
.f
, face_id
);
18355 extend_face_to_end_of_line (&it
);
18356 if (face
->box
!= FACE_NO_BOX
)
18358 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18359 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18360 last
->right_box_line_p
= 1;
18363 return it
.glyph_row
->height
;
18366 /* Move element ELT in LIST to the front of LIST.
18367 Return the updated list. */
18370 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18372 register Lisp_Object tail
, prev
;
18373 register Lisp_Object tem
;
18377 while (CONSP (tail
))
18383 /* Splice out the link TAIL. */
18385 list
= XCDR (tail
);
18387 Fsetcdr (prev
, XCDR (tail
));
18389 /* Now make it the first. */
18390 Fsetcdr (tail
, list
);
18395 tail
= XCDR (tail
);
18399 /* Not found--return unchanged LIST. */
18403 /* Contribute ELT to the mode line for window IT->w. How it
18404 translates into text depends on its data type.
18406 IT describes the display environment in which we display, as usual.
18408 DEPTH is the depth in recursion. It is used to prevent
18409 infinite recursion here.
18411 FIELD_WIDTH is the number of characters the display of ELT should
18412 occupy in the mode line, and PRECISION is the maximum number of
18413 characters to display from ELT's representation. See
18414 display_string for details.
18416 Returns the hpos of the end of the text generated by ELT.
18418 PROPS is a property list to add to any string we encounter.
18420 If RISKY is nonzero, remove (disregard) any properties in any string
18421 we encounter, and ignore :eval and :propertize.
18423 The global variable `mode_line_target' determines whether the
18424 output is passed to `store_mode_line_noprop',
18425 `store_mode_line_string', or `display_string'. */
18428 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18429 Lisp_Object elt
, Lisp_Object props
, int risky
)
18431 int n
= 0, field
, prec
;
18436 elt
= build_string ("*too-deep*");
18440 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18444 /* A string: output it and check for %-constructs within it. */
18446 EMACS_INT offset
= 0;
18448 if (SCHARS (elt
) > 0
18449 && (!NILP (props
) || risky
))
18451 Lisp_Object oprops
, aelt
;
18452 oprops
= Ftext_properties_at (make_number (0), elt
);
18454 /* If the starting string's properties are not what
18455 we want, translate the string. Also, if the string
18456 is risky, do that anyway. */
18458 if (NILP (Fequal (props
, oprops
)) || risky
)
18460 /* If the starting string has properties,
18461 merge the specified ones onto the existing ones. */
18462 if (! NILP (oprops
) && !risky
)
18466 oprops
= Fcopy_sequence (oprops
);
18468 while (CONSP (tem
))
18470 oprops
= Fplist_put (oprops
, XCAR (tem
),
18471 XCAR (XCDR (tem
)));
18472 tem
= XCDR (XCDR (tem
));
18477 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18478 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18480 /* AELT is what we want. Move it to the front
18481 without consing. */
18483 mode_line_proptrans_alist
18484 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18490 /* If AELT has the wrong props, it is useless.
18491 so get rid of it. */
18493 mode_line_proptrans_alist
18494 = Fdelq (aelt
, mode_line_proptrans_alist
);
18496 elt
= Fcopy_sequence (elt
);
18497 Fset_text_properties (make_number (0), Flength (elt
),
18499 /* Add this item to mode_line_proptrans_alist. */
18500 mode_line_proptrans_alist
18501 = Fcons (Fcons (elt
, props
),
18502 mode_line_proptrans_alist
);
18503 /* Truncate mode_line_proptrans_alist
18504 to at most 50 elements. */
18505 tem
= Fnthcdr (make_number (50),
18506 mode_line_proptrans_alist
);
18508 XSETCDR (tem
, Qnil
);
18517 prec
= precision
- n
;
18518 switch (mode_line_target
)
18520 case MODE_LINE_NOPROP
:
18521 case MODE_LINE_TITLE
:
18522 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18524 case MODE_LINE_STRING
:
18525 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18527 case MODE_LINE_DISPLAY
:
18528 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18529 0, prec
, 0, STRING_MULTIBYTE (elt
));
18536 /* Handle the non-literal case. */
18538 while ((precision
<= 0 || n
< precision
)
18539 && SREF (elt
, offset
) != 0
18540 && (mode_line_target
!= MODE_LINE_DISPLAY
18541 || it
->current_x
< it
->last_visible_x
))
18543 EMACS_INT last_offset
= offset
;
18545 /* Advance to end of string or next format specifier. */
18546 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18549 if (offset
- 1 != last_offset
)
18551 EMACS_INT nchars
, nbytes
;
18553 /* Output to end of string or up to '%'. Field width
18554 is length of string. Don't output more than
18555 PRECISION allows us. */
18558 prec
= c_string_width (SDATA (elt
) + last_offset
,
18559 offset
- last_offset
, precision
- n
,
18562 switch (mode_line_target
)
18564 case MODE_LINE_NOPROP
:
18565 case MODE_LINE_TITLE
:
18566 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18568 case MODE_LINE_STRING
:
18570 EMACS_INT bytepos
= last_offset
;
18571 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18572 EMACS_INT endpos
= (precision
<= 0
18573 ? string_byte_to_char (elt
, offset
)
18574 : charpos
+ nchars
);
18576 n
+= store_mode_line_string (NULL
,
18577 Fsubstring (elt
, make_number (charpos
),
18578 make_number (endpos
)),
18582 case MODE_LINE_DISPLAY
:
18584 EMACS_INT bytepos
= last_offset
;
18585 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18587 if (precision
<= 0)
18588 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18589 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18591 STRING_MULTIBYTE (elt
));
18596 else /* c == '%' */
18598 EMACS_INT percent_position
= offset
;
18600 /* Get the specified minimum width. Zero means
18603 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18604 field
= field
* 10 + c
- '0';
18606 /* Don't pad beyond the total padding allowed. */
18607 if (field_width
- n
> 0 && field
> field_width
- n
)
18608 field
= field_width
- n
;
18610 /* Note that either PRECISION <= 0 or N < PRECISION. */
18611 prec
= precision
- n
;
18614 n
+= display_mode_element (it
, depth
, field
, prec
,
18615 Vglobal_mode_string
, props
,
18620 EMACS_INT bytepos
, charpos
;
18622 Lisp_Object string
;
18624 bytepos
= percent_position
;
18625 charpos
= (STRING_MULTIBYTE (elt
)
18626 ? string_byte_to_char (elt
, bytepos
)
18628 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
18629 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18631 switch (mode_line_target
)
18633 case MODE_LINE_NOPROP
:
18634 case MODE_LINE_TITLE
:
18635 n
+= store_mode_line_noprop (spec
, field
, prec
);
18637 case MODE_LINE_STRING
:
18639 int len
= strlen (spec
);
18640 Lisp_Object tem
= make_string (spec
, len
);
18641 props
= Ftext_properties_at (make_number (charpos
), elt
);
18642 /* Should only keep face property in props */
18643 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18646 case MODE_LINE_DISPLAY
:
18648 int nglyphs_before
, nwritten
;
18650 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18651 nwritten
= display_string (spec
, string
, elt
,
18656 /* Assign to the glyphs written above the
18657 string where the `%x' came from, position
18661 struct glyph
*glyph
18662 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18666 for (i
= 0; i
< nwritten
; ++i
)
18668 glyph
[i
].object
= elt
;
18669 glyph
[i
].charpos
= charpos
;
18686 /* A symbol: process the value of the symbol recursively
18687 as if it appeared here directly. Avoid error if symbol void.
18688 Special case: if value of symbol is a string, output the string
18691 register Lisp_Object tem
;
18693 /* If the variable is not marked as risky to set
18694 then its contents are risky to use. */
18695 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18698 tem
= Fboundp (elt
);
18701 tem
= Fsymbol_value (elt
);
18702 /* If value is a string, output that string literally:
18703 don't check for % within it. */
18707 if (!EQ (tem
, elt
))
18709 /* Give up right away for nil or t. */
18719 register Lisp_Object car
, tem
;
18721 /* A cons cell: five distinct cases.
18722 If first element is :eval or :propertize, do something special.
18723 If first element is a string or a cons, process all the elements
18724 and effectively concatenate them.
18725 If first element is a negative number, truncate displaying cdr to
18726 at most that many characters. If positive, pad (with spaces)
18727 to at least that many characters.
18728 If first element is a symbol, process the cadr or caddr recursively
18729 according to whether the symbol's value is non-nil or nil. */
18731 if (EQ (car
, QCeval
))
18733 /* An element of the form (:eval FORM) means evaluate FORM
18734 and use the result as mode line elements. */
18739 if (CONSP (XCDR (elt
)))
18742 spec
= safe_eval (XCAR (XCDR (elt
)));
18743 n
+= display_mode_element (it
, depth
, field_width
- n
,
18744 precision
- n
, spec
, props
,
18748 else if (EQ (car
, QCpropertize
))
18750 /* An element of the form (:propertize ELT PROPS...)
18751 means display ELT but applying properties PROPS. */
18756 if (CONSP (XCDR (elt
)))
18757 n
+= display_mode_element (it
, depth
, field_width
- n
,
18758 precision
- n
, XCAR (XCDR (elt
)),
18759 XCDR (XCDR (elt
)), risky
);
18761 else if (SYMBOLP (car
))
18763 tem
= Fboundp (car
);
18767 /* elt is now the cdr, and we know it is a cons cell.
18768 Use its car if CAR has a non-nil value. */
18771 tem
= Fsymbol_value (car
);
18778 /* Symbol's value is nil (or symbol is unbound)
18779 Get the cddr of the original list
18780 and if possible find the caddr and use that. */
18784 else if (!CONSP (elt
))
18789 else if (INTEGERP (car
))
18791 register int lim
= XINT (car
);
18795 /* Negative int means reduce maximum width. */
18796 if (precision
<= 0)
18799 precision
= min (precision
, -lim
);
18803 /* Padding specified. Don't let it be more than
18804 current maximum. */
18806 lim
= min (precision
, lim
);
18808 /* If that's more padding than already wanted, queue it.
18809 But don't reduce padding already specified even if
18810 that is beyond the current truncation point. */
18811 field_width
= max (lim
, field_width
);
18815 else if (STRINGP (car
) || CONSP (car
))
18817 Lisp_Object halftail
= elt
;
18821 && (precision
<= 0 || n
< precision
))
18823 n
+= display_mode_element (it
, depth
,
18824 /* Do padding only after the last
18825 element in the list. */
18826 (! CONSP (XCDR (elt
))
18829 precision
- n
, XCAR (elt
),
18833 if ((len
& 1) == 0)
18834 halftail
= XCDR (halftail
);
18835 /* Check for cycle. */
18836 if (EQ (halftail
, elt
))
18845 elt
= build_string ("*invalid*");
18849 /* Pad to FIELD_WIDTH. */
18850 if (field_width
> 0 && n
< field_width
)
18852 switch (mode_line_target
)
18854 case MODE_LINE_NOPROP
:
18855 case MODE_LINE_TITLE
:
18856 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18858 case MODE_LINE_STRING
:
18859 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18861 case MODE_LINE_DISPLAY
:
18862 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18871 /* Store a mode-line string element in mode_line_string_list.
18873 If STRING is non-null, display that C string. Otherwise, the Lisp
18874 string LISP_STRING is displayed.
18876 FIELD_WIDTH is the minimum number of output glyphs to produce.
18877 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18878 with spaces. FIELD_WIDTH <= 0 means don't pad.
18880 PRECISION is the maximum number of characters to output from
18881 STRING. PRECISION <= 0 means don't truncate the string.
18883 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18884 properties to the string.
18886 PROPS are the properties to add to the string.
18887 The mode_line_string_face face property is always added to the string.
18891 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18892 int field_width
, int precision
, Lisp_Object props
)
18897 if (string
!= NULL
)
18899 len
= strlen (string
);
18900 if (precision
> 0 && len
> precision
)
18902 lisp_string
= make_string (string
, len
);
18904 props
= mode_line_string_face_prop
;
18905 else if (!NILP (mode_line_string_face
))
18907 Lisp_Object face
= Fplist_get (props
, Qface
);
18908 props
= Fcopy_sequence (props
);
18910 face
= mode_line_string_face
;
18912 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18913 props
= Fplist_put (props
, Qface
, face
);
18915 Fadd_text_properties (make_number (0), make_number (len
),
18916 props
, lisp_string
);
18920 len
= XFASTINT (Flength (lisp_string
));
18921 if (precision
> 0 && len
> precision
)
18924 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18927 if (!NILP (mode_line_string_face
))
18931 props
= Ftext_properties_at (make_number (0), lisp_string
);
18932 face
= Fplist_get (props
, Qface
);
18934 face
= mode_line_string_face
;
18936 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18937 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18939 lisp_string
= Fcopy_sequence (lisp_string
);
18942 Fadd_text_properties (make_number (0), make_number (len
),
18943 props
, lisp_string
);
18948 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18952 if (field_width
> len
)
18954 field_width
-= len
;
18955 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18957 Fadd_text_properties (make_number (0), make_number (field_width
),
18958 props
, lisp_string
);
18959 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18967 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18969 doc
: /* Format a string out of a mode line format specification.
18970 First arg FORMAT specifies the mode line format (see `mode-line-format'
18971 for details) to use.
18973 By default, the format is evaluated for the currently selected window.
18975 Optional second arg FACE specifies the face property to put on all
18976 characters for which no face is specified. The value nil means the
18977 default face. The value t means whatever face the window's mode line
18978 currently uses (either `mode-line' or `mode-line-inactive',
18979 depending on whether the window is the selected window or not).
18980 An integer value means the value string has no text
18983 Optional third and fourth args WINDOW and BUFFER specify the window
18984 and buffer to use as the context for the formatting (defaults
18985 are the selected window and the WINDOW's buffer). */)
18986 (Lisp_Object format
, Lisp_Object face
,
18987 Lisp_Object window
, Lisp_Object buffer
)
18992 struct buffer
*old_buffer
= NULL
;
18994 int no_props
= INTEGERP (face
);
18995 int count
= SPECPDL_INDEX ();
18997 int string_start
= 0;
19000 window
= selected_window
;
19001 CHECK_WINDOW (window
);
19002 w
= XWINDOW (window
);
19005 buffer
= w
->buffer
;
19006 CHECK_BUFFER (buffer
);
19008 /* Make formatting the modeline a non-op when noninteractive, otherwise
19009 there will be problems later caused by a partially initialized frame. */
19010 if (NILP (format
) || noninteractive
)
19011 return empty_unibyte_string
;
19016 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19017 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19018 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19019 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19020 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19021 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19022 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19025 if (XBUFFER (buffer
) != current_buffer
)
19026 old_buffer
= current_buffer
;
19028 /* Save things including mode_line_proptrans_alist,
19029 and set that to nil so that we don't alter the outer value. */
19030 record_unwind_protect (unwind_format_mode_line
,
19031 format_mode_line_unwind_data
19032 (old_buffer
, selected_window
, 1));
19033 mode_line_proptrans_alist
= Qnil
;
19035 Fselect_window (window
, Qt
);
19037 set_buffer_internal_1 (XBUFFER (buffer
));
19039 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19043 mode_line_target
= MODE_LINE_NOPROP
;
19044 mode_line_string_face_prop
= Qnil
;
19045 mode_line_string_list
= Qnil
;
19046 string_start
= MODE_LINE_NOPROP_LEN (0);
19050 mode_line_target
= MODE_LINE_STRING
;
19051 mode_line_string_list
= Qnil
;
19052 mode_line_string_face
= face
;
19053 mode_line_string_face_prop
19054 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19057 push_kboard (FRAME_KBOARD (it
.f
));
19058 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19063 len
= MODE_LINE_NOPROP_LEN (string_start
);
19064 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19068 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19069 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19070 empty_unibyte_string
);
19073 unbind_to (count
, Qnil
);
19077 /* Write a null-terminated, right justified decimal representation of
19078 the positive integer D to BUF using a minimal field width WIDTH. */
19081 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19083 register char *p
= buf
;
19091 *p
++ = d
% 10 + '0';
19096 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19107 /* Write a null-terminated, right justified decimal and "human
19108 readable" representation of the nonnegative integer D to BUF using
19109 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19111 static const char power_letter
[] =
19125 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19127 /* We aim to represent the nonnegative integer D as
19128 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19129 EMACS_INT quotient
= d
;
19131 /* -1 means: do not use TENTHS. */
19135 /* Length of QUOTIENT.TENTHS as a string. */
19141 if (1000 <= quotient
)
19143 /* Scale to the appropriate EXPONENT. */
19146 remainder
= quotient
% 1000;
19150 while (1000 <= quotient
);
19152 /* Round to nearest and decide whether to use TENTHS or not. */
19155 tenths
= remainder
/ 100;
19156 if (50 <= remainder
% 100)
19163 if (quotient
== 10)
19171 if (500 <= remainder
)
19173 if (quotient
< 999)
19184 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19185 if (tenths
== -1 && quotient
<= 99)
19192 p
= psuffix
= buf
+ max (width
, length
);
19194 /* Print EXPONENT. */
19195 *psuffix
++ = power_letter
[exponent
];
19198 /* Print TENTHS. */
19201 *--p
= '0' + tenths
;
19205 /* Print QUOTIENT. */
19208 int digit
= quotient
% 10;
19209 *--p
= '0' + digit
;
19211 while ((quotient
/= 10) != 0);
19213 /* Print leading spaces. */
19218 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19219 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19220 type of CODING_SYSTEM. Return updated pointer into BUF. */
19222 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19225 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19228 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19229 const unsigned char *eol_str
;
19231 /* The EOL conversion we are using. */
19232 Lisp_Object eoltype
;
19234 val
= CODING_SYSTEM_SPEC (coding_system
);
19237 if (!VECTORP (val
)) /* Not yet decided. */
19242 eoltype
= eol_mnemonic_undecided
;
19243 /* Don't mention EOL conversion if it isn't decided. */
19248 Lisp_Object eolvalue
;
19250 attrs
= AREF (val
, 0);
19251 eolvalue
= AREF (val
, 2);
19254 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19258 /* The EOL conversion that is normal on this system. */
19260 if (NILP (eolvalue
)) /* Not yet decided. */
19261 eoltype
= eol_mnemonic_undecided
;
19262 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19263 eoltype
= eol_mnemonic_undecided
;
19264 else /* eolvalue is Qunix, Qdos, or Qmac. */
19265 eoltype
= (EQ (eolvalue
, Qunix
)
19266 ? eol_mnemonic_unix
19267 : (EQ (eolvalue
, Qdos
) == 1
19268 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19274 /* Mention the EOL conversion if it is not the usual one. */
19275 if (STRINGP (eoltype
))
19277 eol_str
= SDATA (eoltype
);
19278 eol_str_len
= SBYTES (eoltype
);
19280 else if (CHARACTERP (eoltype
))
19282 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19283 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19288 eol_str
= invalid_eol_type
;
19289 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19291 memcpy (buf
, eol_str
, eol_str_len
);
19292 buf
+= eol_str_len
;
19298 /* Return a string for the output of a mode line %-spec for window W,
19299 generated by character C. FIELD_WIDTH > 0 means pad the string
19300 returned with spaces to that value. Return a Lisp string in
19301 *STRING if the resulting string is taken from that Lisp string.
19303 Note we operate on the current buffer for most purposes,
19304 the exception being w->base_line_pos. */
19306 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19308 static const char *
19309 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19310 Lisp_Object
*string
)
19313 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19314 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19315 struct buffer
*b
= current_buffer
;
19323 if (!NILP (BVAR (b
, read_only
)))
19325 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19330 /* This differs from %* only for a modified read-only buffer. */
19331 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19333 if (!NILP (BVAR (b
, read_only
)))
19338 /* This differs from %* in ignoring read-only-ness. */
19339 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19351 if (command_loop_level
> 5)
19353 p
= decode_mode_spec_buf
;
19354 for (i
= 0; i
< command_loop_level
; i
++)
19357 return decode_mode_spec_buf
;
19365 if (command_loop_level
> 5)
19367 p
= decode_mode_spec_buf
;
19368 for (i
= 0; i
< command_loop_level
; i
++)
19371 return decode_mode_spec_buf
;
19378 /* Let lots_of_dashes be a string of infinite length. */
19379 if (mode_line_target
== MODE_LINE_NOPROP
||
19380 mode_line_target
== MODE_LINE_STRING
)
19382 if (field_width
<= 0
19383 || field_width
> sizeof (lots_of_dashes
))
19385 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19386 decode_mode_spec_buf
[i
] = '-';
19387 decode_mode_spec_buf
[i
] = '\0';
19388 return decode_mode_spec_buf
;
19391 return lots_of_dashes
;
19395 obj
= BVAR (b
, name
);
19399 /* %c and %l are ignored in `frame-title-format'.
19400 (In redisplay_internal, the frame title is drawn _before_ the
19401 windows are updated, so the stuff which depends on actual
19402 window contents (such as %l) may fail to render properly, or
19403 even crash emacs.) */
19404 if (mode_line_target
== MODE_LINE_TITLE
)
19408 EMACS_INT col
= current_column ();
19409 w
->column_number_displayed
= make_number (col
);
19410 pint2str (decode_mode_spec_buf
, field_width
, col
);
19411 return decode_mode_spec_buf
;
19415 #ifndef SYSTEM_MALLOC
19417 if (NILP (Vmemory_full
))
19420 return "!MEM FULL! ";
19427 /* %F displays the frame name. */
19428 if (!NILP (f
->title
))
19429 return SSDATA (f
->title
);
19430 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19431 return SSDATA (f
->name
);
19435 obj
= BVAR (b
, filename
);
19440 EMACS_INT size
= ZV
- BEGV
;
19441 pint2str (decode_mode_spec_buf
, field_width
, size
);
19442 return decode_mode_spec_buf
;
19447 EMACS_INT size
= ZV
- BEGV
;
19448 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19449 return decode_mode_spec_buf
;
19454 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19455 EMACS_INT topline
, nlines
, height
;
19458 /* %c and %l are ignored in `frame-title-format'. */
19459 if (mode_line_target
== MODE_LINE_TITLE
)
19462 startpos
= XMARKER (w
->start
)->charpos
;
19463 startpos_byte
= marker_byte_position (w
->start
);
19464 height
= WINDOW_TOTAL_LINES (w
);
19466 /* If we decided that this buffer isn't suitable for line numbers,
19467 don't forget that too fast. */
19468 if (EQ (w
->base_line_pos
, w
->buffer
))
19470 /* But do forget it, if the window shows a different buffer now. */
19471 else if (BUFFERP (w
->base_line_pos
))
19472 w
->base_line_pos
= Qnil
;
19474 /* If the buffer is very big, don't waste time. */
19475 if (INTEGERP (Vline_number_display_limit
)
19476 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19478 w
->base_line_pos
= Qnil
;
19479 w
->base_line_number
= Qnil
;
19483 if (INTEGERP (w
->base_line_number
)
19484 && INTEGERP (w
->base_line_pos
)
19485 && XFASTINT (w
->base_line_pos
) <= startpos
)
19487 line
= XFASTINT (w
->base_line_number
);
19488 linepos
= XFASTINT (w
->base_line_pos
);
19489 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19494 linepos
= BUF_BEGV (b
);
19495 linepos_byte
= BUF_BEGV_BYTE (b
);
19498 /* Count lines from base line to window start position. */
19499 nlines
= display_count_lines (linepos_byte
,
19503 topline
= nlines
+ line
;
19505 /* Determine a new base line, if the old one is too close
19506 or too far away, or if we did not have one.
19507 "Too close" means it's plausible a scroll-down would
19508 go back past it. */
19509 if (startpos
== BUF_BEGV (b
))
19511 w
->base_line_number
= make_number (topline
);
19512 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19514 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19515 || linepos
== BUF_BEGV (b
))
19517 EMACS_INT limit
= BUF_BEGV (b
);
19518 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19519 EMACS_INT position
;
19520 EMACS_INT distance
=
19521 (height
* 2 + 30) * line_number_display_limit_width
;
19523 if (startpos
- distance
> limit
)
19525 limit
= startpos
- distance
;
19526 limit_byte
= CHAR_TO_BYTE (limit
);
19529 nlines
= display_count_lines (startpos_byte
,
19531 - (height
* 2 + 30),
19533 /* If we couldn't find the lines we wanted within
19534 line_number_display_limit_width chars per line,
19535 give up on line numbers for this window. */
19536 if (position
== limit_byte
&& limit
== startpos
- distance
)
19538 w
->base_line_pos
= w
->buffer
;
19539 w
->base_line_number
= Qnil
;
19543 w
->base_line_number
= make_number (topline
- nlines
);
19544 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19547 /* Now count lines from the start pos to point. */
19548 nlines
= display_count_lines (startpos_byte
,
19549 PT_BYTE
, PT
, &junk
);
19551 /* Record that we did display the line number. */
19552 line_number_displayed
= 1;
19554 /* Make the string to show. */
19555 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19556 return decode_mode_spec_buf
;
19559 char* p
= decode_mode_spec_buf
;
19560 int pad
= field_width
- 2;
19566 return decode_mode_spec_buf
;
19572 obj
= BVAR (b
, mode_name
);
19576 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19582 EMACS_INT pos
= marker_position (w
->start
);
19583 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19585 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19587 if (pos
<= BUF_BEGV (b
))
19592 else if (pos
<= BUF_BEGV (b
))
19596 if (total
> 1000000)
19597 /* Do it differently for a large value, to avoid overflow. */
19598 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19600 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19601 /* We can't normally display a 3-digit number,
19602 so get us a 2-digit number that is close. */
19605 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19606 return decode_mode_spec_buf
;
19610 /* Display percentage of size above the bottom of the screen. */
19613 EMACS_INT toppos
= marker_position (w
->start
);
19614 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19615 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19617 if (botpos
>= BUF_ZV (b
))
19619 if (toppos
<= BUF_BEGV (b
))
19626 if (total
> 1000000)
19627 /* Do it differently for a large value, to avoid overflow. */
19628 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19630 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19631 /* We can't normally display a 3-digit number,
19632 so get us a 2-digit number that is close. */
19635 if (toppos
<= BUF_BEGV (b
))
19636 sprintf (decode_mode_spec_buf
, "Top%2ld%%", (long)total
);
19638 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19639 return decode_mode_spec_buf
;
19644 /* status of process */
19645 obj
= Fget_buffer_process (Fcurrent_buffer ());
19647 return "no process";
19649 obj
= Fsymbol_name (Fprocess_status (obj
));
19655 int count
= inhibit_garbage_collection ();
19656 Lisp_Object val
= call1 (intern ("file-remote-p"),
19657 BVAR (current_buffer
, directory
));
19658 unbind_to (count
, Qnil
);
19666 case 't': /* indicate TEXT or BINARY */
19670 /* coding-system (not including end-of-line format) */
19672 /* coding-system (including end-of-line type) */
19674 int eol_flag
= (c
== 'Z');
19675 char *p
= decode_mode_spec_buf
;
19677 if (! FRAME_WINDOW_P (f
))
19679 /* No need to mention EOL here--the terminal never needs
19680 to do EOL conversion. */
19681 p
= decode_mode_spec_coding (CODING_ID_NAME
19682 (FRAME_KEYBOARD_CODING (f
)->id
),
19684 p
= decode_mode_spec_coding (CODING_ID_NAME
19685 (FRAME_TERMINAL_CODING (f
)->id
),
19688 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19691 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19692 #ifdef subprocesses
19693 obj
= Fget_buffer_process (Fcurrent_buffer ());
19694 if (PROCESSP (obj
))
19696 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19698 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19701 #endif /* subprocesses */
19704 return decode_mode_spec_buf
;
19711 return SSDATA (obj
);
19718 /* Count up to COUNT lines starting from START_BYTE.
19719 But don't go beyond LIMIT_BYTE.
19720 Return the number of lines thus found (always nonnegative).
19722 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19725 display_count_lines (EMACS_INT start_byte
,
19726 EMACS_INT limit_byte
, EMACS_INT count
,
19727 EMACS_INT
*byte_pos_ptr
)
19729 register unsigned char *cursor
;
19730 unsigned char *base
;
19732 register EMACS_INT ceiling
;
19733 register unsigned char *ceiling_addr
;
19734 EMACS_INT orig_count
= count
;
19736 /* If we are not in selective display mode,
19737 check only for newlines. */
19738 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19739 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19743 while (start_byte
< limit_byte
)
19745 ceiling
= BUFFER_CEILING_OF (start_byte
);
19746 ceiling
= min (limit_byte
- 1, ceiling
);
19747 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19748 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19751 if (selective_display
)
19752 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19755 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19758 if (cursor
!= ceiling_addr
)
19762 start_byte
+= cursor
- base
+ 1;
19763 *byte_pos_ptr
= start_byte
;
19767 if (++cursor
== ceiling_addr
)
19773 start_byte
+= cursor
- base
;
19778 while (start_byte
> limit_byte
)
19780 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19781 ceiling
= max (limit_byte
, ceiling
);
19782 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19783 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19786 if (selective_display
)
19787 while (--cursor
!= ceiling_addr
19788 && *cursor
!= '\n' && *cursor
!= 015)
19791 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19794 if (cursor
!= ceiling_addr
)
19798 start_byte
+= cursor
- base
+ 1;
19799 *byte_pos_ptr
= start_byte
;
19800 /* When scanning backwards, we should
19801 not count the newline posterior to which we stop. */
19802 return - orig_count
- 1;
19808 /* Here we add 1 to compensate for the last decrement
19809 of CURSOR, which took it past the valid range. */
19810 start_byte
+= cursor
- base
+ 1;
19814 *byte_pos_ptr
= limit_byte
;
19817 return - orig_count
+ count
;
19818 return orig_count
- count
;
19824 /***********************************************************************
19826 ***********************************************************************/
19828 /* Display a NUL-terminated string, starting with index START.
19830 If STRING is non-null, display that C string. Otherwise, the Lisp
19831 string LISP_STRING is displayed. There's a case that STRING is
19832 non-null and LISP_STRING is not nil. It means STRING is a string
19833 data of LISP_STRING. In that case, we display LISP_STRING while
19834 ignoring its text properties.
19836 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19837 FACE_STRING. Display STRING or LISP_STRING with the face at
19838 FACE_STRING_POS in FACE_STRING:
19840 Display the string in the environment given by IT, but use the
19841 standard display table, temporarily.
19843 FIELD_WIDTH is the minimum number of output glyphs to produce.
19844 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19845 with spaces. If STRING has more characters, more than FIELD_WIDTH
19846 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19848 PRECISION is the maximum number of characters to output from
19849 STRING. PRECISION < 0 means don't truncate the string.
19851 This is roughly equivalent to printf format specifiers:
19853 FIELD_WIDTH PRECISION PRINTF
19854 ----------------------------------------
19860 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19861 display them, and < 0 means obey the current buffer's value of
19862 enable_multibyte_characters.
19864 Value is the number of columns displayed. */
19867 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19868 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19869 int field_width
, int precision
, int max_x
, int multibyte
)
19871 int hpos_at_start
= it
->hpos
;
19872 int saved_face_id
= it
->face_id
;
19873 struct glyph_row
*row
= it
->glyph_row
;
19875 /* Initialize the iterator IT for iteration over STRING beginning
19876 with index START. */
19877 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19878 precision
, field_width
, multibyte
);
19879 if (string
&& STRINGP (lisp_string
))
19880 /* LISP_STRING is the one returned by decode_mode_spec. We should
19881 ignore its text properties. */
19882 it
->stop_charpos
= -1;
19884 /* If displaying STRING, set up the face of the iterator
19885 from LISP_STRING, if that's given. */
19886 if (STRINGP (face_string
))
19892 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19893 0, it
->region_beg_charpos
,
19894 it
->region_end_charpos
,
19895 &endptr
, it
->base_face_id
, 0);
19896 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19897 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19900 /* Set max_x to the maximum allowed X position. Don't let it go
19901 beyond the right edge of the window. */
19903 max_x
= it
->last_visible_x
;
19905 max_x
= min (max_x
, it
->last_visible_x
);
19907 /* Skip over display elements that are not visible. because IT->w is
19909 if (it
->current_x
< it
->first_visible_x
)
19910 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19911 MOVE_TO_POS
| MOVE_TO_X
);
19913 row
->ascent
= it
->max_ascent
;
19914 row
->height
= it
->max_ascent
+ it
->max_descent
;
19915 row
->phys_ascent
= it
->max_phys_ascent
;
19916 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19917 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19919 /* This condition is for the case that we are called with current_x
19920 past last_visible_x. */
19921 while (it
->current_x
< max_x
)
19923 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19925 /* Get the next display element. */
19926 if (!get_next_display_element (it
))
19929 /* Produce glyphs. */
19930 x_before
= it
->current_x
;
19931 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19932 PRODUCE_GLYPHS (it
);
19934 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19937 while (i
< nglyphs
)
19939 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19941 if (it
->line_wrap
!= TRUNCATE
19942 && x
+ glyph
->pixel_width
> max_x
)
19944 /* End of continued line or max_x reached. */
19945 if (CHAR_GLYPH_PADDING_P (*glyph
))
19947 /* A wide character is unbreakable. */
19948 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19949 it
->current_x
= x_before
;
19953 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19958 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19960 /* Glyph is at least partially visible. */
19962 if (x
< it
->first_visible_x
)
19963 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19967 /* Glyph is off the left margin of the display area.
19968 Should not happen. */
19972 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19973 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19974 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19975 row
->phys_height
= max (row
->phys_height
,
19976 it
->max_phys_ascent
+ it
->max_phys_descent
);
19977 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19978 it
->max_extra_line_spacing
);
19979 x
+= glyph
->pixel_width
;
19983 /* Stop if max_x reached. */
19987 /* Stop at line ends. */
19988 if (ITERATOR_AT_END_OF_LINE_P (it
))
19990 it
->continuation_lines_width
= 0;
19994 set_iterator_to_next (it
, 1);
19996 /* Stop if truncating at the right edge. */
19997 if (it
->line_wrap
== TRUNCATE
19998 && it
->current_x
>= it
->last_visible_x
)
20000 /* Add truncation mark, but don't do it if the line is
20001 truncated at a padding space. */
20002 if (IT_CHARPOS (*it
) < it
->string_nchars
)
20004 if (!FRAME_WINDOW_P (it
->f
))
20008 if (it
->current_x
> it
->last_visible_x
)
20010 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20011 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20013 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20015 row
->used
[TEXT_AREA
] = ii
;
20016 produce_special_glyphs (it
, IT_TRUNCATION
);
20019 produce_special_glyphs (it
, IT_TRUNCATION
);
20021 it
->glyph_row
->truncated_on_right_p
= 1;
20027 /* Maybe insert a truncation at the left. */
20028 if (it
->first_visible_x
20029 && IT_CHARPOS (*it
) > 0)
20031 if (!FRAME_WINDOW_P (it
->f
))
20032 insert_left_trunc_glyphs (it
);
20033 it
->glyph_row
->truncated_on_left_p
= 1;
20036 it
->face_id
= saved_face_id
;
20038 /* Value is number of columns displayed. */
20039 return it
->hpos
- hpos_at_start
;
20044 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20045 appears as an element of LIST or as the car of an element of LIST.
20046 If PROPVAL is a list, compare each element against LIST in that
20047 way, and return 1/2 if any element of PROPVAL is found in LIST.
20048 Otherwise return 0. This function cannot quit.
20049 The return value is 2 if the text is invisible but with an ellipsis
20050 and 1 if it's invisible and without an ellipsis. */
20053 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20055 register Lisp_Object tail
, proptail
;
20057 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20059 register Lisp_Object tem
;
20061 if (EQ (propval
, tem
))
20063 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20064 return NILP (XCDR (tem
)) ? 1 : 2;
20067 if (CONSP (propval
))
20069 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20071 Lisp_Object propelt
;
20072 propelt
= XCAR (proptail
);
20073 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20075 register Lisp_Object tem
;
20077 if (EQ (propelt
, tem
))
20079 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20080 return NILP (XCDR (tem
)) ? 1 : 2;
20088 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20089 doc
: /* Non-nil if the property makes the text invisible.
20090 POS-OR-PROP can be a marker or number, in which case it is taken to be
20091 a position in the current buffer and the value of the `invisible' property
20092 is checked; or it can be some other value, which is then presumed to be the
20093 value of the `invisible' property of the text of interest.
20094 The non-nil value returned can be t for truly invisible text or something
20095 else if the text is replaced by an ellipsis. */)
20096 (Lisp_Object pos_or_prop
)
20099 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20100 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20102 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20103 return (invis
== 0 ? Qnil
20105 : make_number (invis
));
20108 /* Calculate a width or height in pixels from a specification using
20109 the following elements:
20112 NUM - a (fractional) multiple of the default font width/height
20113 (NUM) - specifies exactly NUM pixels
20114 UNIT - a fixed number of pixels, see below.
20115 ELEMENT - size of a display element in pixels, see below.
20116 (NUM . SPEC) - equals NUM * SPEC
20117 (+ SPEC SPEC ...) - add pixel values
20118 (- SPEC SPEC ...) - subtract pixel values
20119 (- SPEC) - negate pixel value
20122 INT or FLOAT - a number constant
20123 SYMBOL - use symbol's (buffer local) variable binding.
20126 in - pixels per inch *)
20127 mm - pixels per 1/1000 meter *)
20128 cm - pixels per 1/100 meter *)
20129 width - width of current font in pixels.
20130 height - height of current font in pixels.
20132 *) using the ratio(s) defined in display-pixels-per-inch.
20136 left-fringe - left fringe width in pixels
20137 right-fringe - right fringe width in pixels
20139 left-margin - left margin width in pixels
20140 right-margin - right margin width in pixels
20142 scroll-bar - scroll-bar area width in pixels
20146 Pixels corresponding to 5 inches:
20149 Total width of non-text areas on left side of window (if scroll-bar is on left):
20150 '(space :width (+ left-fringe left-margin scroll-bar))
20152 Align to first text column (in header line):
20153 '(space :align-to 0)
20155 Align to middle of text area minus half the width of variable `my-image'
20156 containing a loaded image:
20157 '(space :align-to (0.5 . (- text my-image)))
20159 Width of left margin minus width of 1 character in the default font:
20160 '(space :width (- left-margin 1))
20162 Width of left margin minus width of 2 characters in the current font:
20163 '(space :width (- left-margin (2 . width)))
20165 Center 1 character over left-margin (in header line):
20166 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20168 Different ways to express width of left fringe plus left margin minus one pixel:
20169 '(space :width (- (+ left-fringe left-margin) (1)))
20170 '(space :width (+ left-fringe left-margin (- (1))))
20171 '(space :width (+ left-fringe left-margin (-1)))
20175 #define NUMVAL(X) \
20176 ((INTEGERP (X) || FLOATP (X)) \
20181 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20182 struct font
*font
, int width_p
, int *align_to
)
20186 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20187 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20190 return OK_PIXELS (0);
20192 xassert (FRAME_LIVE_P (it
->f
));
20194 if (SYMBOLP (prop
))
20196 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20198 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20200 if (unit
[0] == 'i' && unit
[1] == 'n')
20202 else if (unit
[0] == 'm' && unit
[1] == 'm')
20204 else if (unit
[0] == 'c' && unit
[1] == 'm')
20211 #ifdef HAVE_WINDOW_SYSTEM
20212 if (FRAME_WINDOW_P (it
->f
)
20214 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20215 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20217 return OK_PIXELS (ppi
/ pixels
);
20220 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20221 || (CONSP (Vdisplay_pixels_per_inch
)
20223 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20224 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20226 return OK_PIXELS (ppi
/ pixels
);
20232 #ifdef HAVE_WINDOW_SYSTEM
20233 if (EQ (prop
, Qheight
))
20234 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20235 if (EQ (prop
, Qwidth
))
20236 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20238 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20239 return OK_PIXELS (1);
20242 if (EQ (prop
, Qtext
))
20243 return OK_PIXELS (width_p
20244 ? window_box_width (it
->w
, TEXT_AREA
)
20245 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20247 if (align_to
&& *align_to
< 0)
20250 if (EQ (prop
, Qleft
))
20251 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20252 if (EQ (prop
, Qright
))
20253 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20254 if (EQ (prop
, Qcenter
))
20255 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20256 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20257 if (EQ (prop
, Qleft_fringe
))
20258 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20259 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20260 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20261 if (EQ (prop
, Qright_fringe
))
20262 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20263 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20264 : window_box_right_offset (it
->w
, TEXT_AREA
));
20265 if (EQ (prop
, Qleft_margin
))
20266 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20267 if (EQ (prop
, Qright_margin
))
20268 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20269 if (EQ (prop
, Qscroll_bar
))
20270 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20272 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20273 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20274 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20279 if (EQ (prop
, Qleft_fringe
))
20280 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20281 if (EQ (prop
, Qright_fringe
))
20282 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20283 if (EQ (prop
, Qleft_margin
))
20284 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20285 if (EQ (prop
, Qright_margin
))
20286 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20287 if (EQ (prop
, Qscroll_bar
))
20288 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20291 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20294 if (INTEGERP (prop
) || FLOATP (prop
))
20296 int base_unit
= (width_p
20297 ? FRAME_COLUMN_WIDTH (it
->f
)
20298 : FRAME_LINE_HEIGHT (it
->f
));
20299 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20304 Lisp_Object car
= XCAR (prop
);
20305 Lisp_Object cdr
= XCDR (prop
);
20309 #ifdef HAVE_WINDOW_SYSTEM
20310 if (FRAME_WINDOW_P (it
->f
)
20311 && valid_image_p (prop
))
20313 int id
= lookup_image (it
->f
, prop
);
20314 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20316 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20319 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20325 while (CONSP (cdr
))
20327 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20328 font
, width_p
, align_to
))
20331 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20336 if (EQ (car
, Qminus
))
20338 return OK_PIXELS (pixels
);
20341 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20344 if (INTEGERP (car
) || FLOATP (car
))
20347 pixels
= XFLOATINT (car
);
20349 return OK_PIXELS (pixels
);
20350 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20351 font
, width_p
, align_to
))
20352 return OK_PIXELS (pixels
* fact
);
20363 /***********************************************************************
20365 ***********************************************************************/
20367 #ifdef HAVE_WINDOW_SYSTEM
20372 dump_glyph_string (s
)
20373 struct glyph_string
*s
;
20375 fprintf (stderr
, "glyph string\n");
20376 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20377 s
->x
, s
->y
, s
->width
, s
->height
);
20378 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20379 fprintf (stderr
, " hl = %d\n", s
->hl
);
20380 fprintf (stderr
, " left overhang = %d, right = %d\n",
20381 s
->left_overhang
, s
->right_overhang
);
20382 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20383 fprintf (stderr
, " extends to end of line = %d\n",
20384 s
->extends_to_end_of_line_p
);
20385 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20386 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20389 #endif /* GLYPH_DEBUG */
20391 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20392 of XChar2b structures for S; it can't be allocated in
20393 init_glyph_string because it must be allocated via `alloca'. W
20394 is the window on which S is drawn. ROW and AREA are the glyph row
20395 and area within the row from which S is constructed. START is the
20396 index of the first glyph structure covered by S. HL is a
20397 face-override for drawing S. */
20400 #define OPTIONAL_HDC(hdc) HDC hdc,
20401 #define DECLARE_HDC(hdc) HDC hdc;
20402 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20403 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20406 #ifndef OPTIONAL_HDC
20407 #define OPTIONAL_HDC(hdc)
20408 #define DECLARE_HDC(hdc)
20409 #define ALLOCATE_HDC(hdc, f)
20410 #define RELEASE_HDC(hdc, f)
20414 init_glyph_string (struct glyph_string
*s
,
20416 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20417 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20419 memset (s
, 0, sizeof *s
);
20421 s
->f
= XFRAME (w
->frame
);
20425 s
->display
= FRAME_X_DISPLAY (s
->f
);
20426 s
->window
= FRAME_X_WINDOW (s
->f
);
20427 s
->char2b
= char2b
;
20431 s
->first_glyph
= row
->glyphs
[area
] + start
;
20432 s
->height
= row
->height
;
20433 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20434 s
->ybase
= s
->y
+ row
->ascent
;
20438 /* Append the list of glyph strings with head H and tail T to the list
20439 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20442 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20443 struct glyph_string
*h
, struct glyph_string
*t
)
20457 /* Prepend the list of glyph strings with head H and tail T to the
20458 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20462 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20463 struct glyph_string
*h
, struct glyph_string
*t
)
20477 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20478 Set *HEAD and *TAIL to the resulting list. */
20481 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20482 struct glyph_string
*s
)
20484 s
->next
= s
->prev
= NULL
;
20485 append_glyph_string_lists (head
, tail
, s
, s
);
20489 /* Get face and two-byte form of character C in face FACE_ID on frame F.
20490 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
20491 make sure that X resources for the face returned are allocated.
20492 Value is a pointer to a realized face that is ready for display if
20493 DISPLAY_P is non-zero. */
20495 static INLINE
struct face
*
20496 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20497 XChar2b
*char2b
, int display_p
)
20499 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20503 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20505 if (code
!= FONT_INVALID_CODE
)
20506 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20508 STORE_XCHAR2B (char2b
, 0, 0);
20511 /* Make sure X resources of the face are allocated. */
20512 #ifdef HAVE_X_WINDOWS
20516 xassert (face
!= NULL
);
20517 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20524 /* Get face and two-byte form of character glyph GLYPH on frame F.
20525 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20526 a pointer to a realized face that is ready for display. */
20528 static INLINE
struct face
*
20529 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20530 XChar2b
*char2b
, int *two_byte_p
)
20534 xassert (glyph
->type
== CHAR_GLYPH
);
20535 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20544 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20545 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20547 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20549 if (code
!= FONT_INVALID_CODE
)
20550 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20552 STORE_XCHAR2B (char2b
, 0, 0);
20555 /* Make sure X resources of the face are allocated. */
20556 xassert (face
!= NULL
);
20557 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20562 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20563 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20566 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20570 if (CHAR_BYTE8_P (c
))
20571 code
= CHAR_TO_BYTE8 (c
);
20573 code
= font
->driver
->encode_char (font
, c
);
20575 if (code
== FONT_INVALID_CODE
)
20577 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20582 /* Fill glyph string S with composition components specified by S->cmp.
20584 BASE_FACE is the base face of the composition.
20585 S->cmp_from is the index of the first component for S.
20587 OVERLAPS non-zero means S should draw the foreground only, and use
20588 its physical height for clipping. See also draw_glyphs.
20590 Value is the index of a component not in S. */
20593 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20597 /* For all glyphs of this composition, starting at the offset
20598 S->cmp_from, until we reach the end of the definition or encounter a
20599 glyph that requires the different face, add it to S. */
20604 s
->for_overlaps
= overlaps
;
20607 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20609 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20613 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20616 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20623 s
->font
= s
->face
->font
;
20625 else if (s
->face
!= face
)
20633 /* All glyph strings for the same composition has the same width,
20634 i.e. the width set for the first component of the composition. */
20635 s
->width
= s
->first_glyph
->pixel_width
;
20637 /* If the specified font could not be loaded, use the frame's
20638 default font, but record the fact that we couldn't load it in
20639 the glyph string so that we can draw rectangles for the
20640 characters of the glyph string. */
20641 if (s
->font
== NULL
)
20643 s
->font_not_found_p
= 1;
20644 s
->font
= FRAME_FONT (s
->f
);
20647 /* Adjust base line for subscript/superscript text. */
20648 s
->ybase
+= s
->first_glyph
->voffset
;
20650 /* This glyph string must always be drawn with 16-bit functions. */
20657 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20658 int start
, int end
, int overlaps
)
20660 struct glyph
*glyph
, *last
;
20661 Lisp_Object lgstring
;
20664 s
->for_overlaps
= overlaps
;
20665 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20666 last
= s
->row
->glyphs
[s
->area
] + end
;
20667 s
->cmp_id
= glyph
->u
.cmp
.id
;
20668 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20669 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20670 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20671 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20672 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20674 while (glyph
< last
20675 && glyph
->u
.cmp
.automatic
20676 && glyph
->u
.cmp
.id
== s
->cmp_id
20677 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20678 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20680 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20682 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20683 unsigned code
= LGLYPH_CODE (lglyph
);
20685 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20687 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20688 return glyph
- s
->row
->glyphs
[s
->area
];
20692 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20693 See the comment of fill_glyph_string for arguments.
20694 Value is the index of the first glyph not in S. */
20698 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20699 int start
, int end
, int overlaps
)
20701 struct glyph
*glyph
, *last
;
20704 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20705 s
->for_overlaps
= overlaps
;
20706 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20707 last
= s
->row
->glyphs
[s
->area
] + end
;
20708 voffset
= glyph
->voffset
;
20709 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20710 s
->font
= s
->face
->font
;
20712 s
->width
= glyph
->pixel_width
;
20714 while (glyph
< last
20715 && glyph
->type
== GLYPHLESS_GLYPH
20716 && glyph
->voffset
== voffset
20717 && glyph
->face_id
== face_id
)
20720 s
->width
+= glyph
->pixel_width
;
20723 s
->ybase
+= voffset
;
20724 return glyph
- s
->row
->glyphs
[s
->area
];
20728 /* Fill glyph string S from a sequence of character glyphs.
20730 FACE_ID is the face id of the string. START is the index of the
20731 first glyph to consider, END is the index of the last + 1.
20732 OVERLAPS non-zero means S should draw the foreground only, and use
20733 its physical height for clipping. See also draw_glyphs.
20735 Value is the index of the first glyph not in S. */
20738 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20739 int start
, int end
, int overlaps
)
20741 struct glyph
*glyph
, *last
;
20743 int glyph_not_available_p
;
20745 xassert (s
->f
== XFRAME (s
->w
->frame
));
20746 xassert (s
->nchars
== 0);
20747 xassert (start
>= 0 && end
> start
);
20749 s
->for_overlaps
= overlaps
;
20750 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20751 last
= s
->row
->glyphs
[s
->area
] + end
;
20752 voffset
= glyph
->voffset
;
20753 s
->padding_p
= glyph
->padding_p
;
20754 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20756 while (glyph
< last
20757 && glyph
->type
== CHAR_GLYPH
20758 && glyph
->voffset
== voffset
20759 /* Same face id implies same font, nowadays. */
20760 && glyph
->face_id
== face_id
20761 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20765 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20766 s
->char2b
+ s
->nchars
,
20768 s
->two_byte_p
= two_byte_p
;
20770 xassert (s
->nchars
<= end
- start
);
20771 s
->width
+= glyph
->pixel_width
;
20772 if (glyph
++->padding_p
!= s
->padding_p
)
20776 s
->font
= s
->face
->font
;
20778 /* If the specified font could not be loaded, use the frame's font,
20779 but record the fact that we couldn't load it in
20780 S->font_not_found_p so that we can draw rectangles for the
20781 characters of the glyph string. */
20782 if (s
->font
== NULL
|| glyph_not_available_p
)
20784 s
->font_not_found_p
= 1;
20785 s
->font
= FRAME_FONT (s
->f
);
20788 /* Adjust base line for subscript/superscript text. */
20789 s
->ybase
+= voffset
;
20791 xassert (s
->face
&& s
->face
->gc
);
20792 return glyph
- s
->row
->glyphs
[s
->area
];
20796 /* Fill glyph string S from image glyph S->first_glyph. */
20799 fill_image_glyph_string (struct glyph_string
*s
)
20801 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20802 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20804 s
->slice
= s
->first_glyph
->slice
.img
;
20805 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20806 s
->font
= s
->face
->font
;
20807 s
->width
= s
->first_glyph
->pixel_width
;
20809 /* Adjust base line for subscript/superscript text. */
20810 s
->ybase
+= s
->first_glyph
->voffset
;
20814 /* Fill glyph string S from a sequence of stretch glyphs.
20816 START is the index of the first glyph to consider,
20817 END is the index of the last + 1.
20819 Value is the index of the first glyph not in S. */
20822 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
20824 struct glyph
*glyph
, *last
;
20825 int voffset
, face_id
;
20827 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20829 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20830 last
= s
->row
->glyphs
[s
->area
] + end
;
20831 face_id
= glyph
->face_id
;
20832 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20833 s
->font
= s
->face
->font
;
20834 s
->width
= glyph
->pixel_width
;
20836 voffset
= glyph
->voffset
;
20840 && glyph
->type
== STRETCH_GLYPH
20841 && glyph
->voffset
== voffset
20842 && glyph
->face_id
== face_id
);
20844 s
->width
+= glyph
->pixel_width
;
20846 /* Adjust base line for subscript/superscript text. */
20847 s
->ybase
+= voffset
;
20849 /* The case that face->gc == 0 is handled when drawing the glyph
20850 string by calling PREPARE_FACE_FOR_DISPLAY. */
20852 return glyph
- s
->row
->glyphs
[s
->area
];
20855 static struct font_metrics
*
20856 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
20858 static struct font_metrics metrics
;
20859 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20861 if (! font
|| code
== FONT_INVALID_CODE
)
20863 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20868 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20869 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20870 assumed to be zero. */
20873 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20875 *left
= *right
= 0;
20877 if (glyph
->type
== CHAR_GLYPH
)
20881 struct font_metrics
*pcm
;
20883 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20884 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
20886 if (pcm
->rbearing
> pcm
->width
)
20887 *right
= pcm
->rbearing
- pcm
->width
;
20888 if (pcm
->lbearing
< 0)
20889 *left
= -pcm
->lbearing
;
20892 else if (glyph
->type
== COMPOSITE_GLYPH
)
20894 if (! glyph
->u
.cmp
.automatic
)
20896 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20898 if (cmp
->rbearing
> cmp
->pixel_width
)
20899 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20900 if (cmp
->lbearing
< 0)
20901 *left
= - cmp
->lbearing
;
20905 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20906 struct font_metrics metrics
;
20908 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20909 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20910 if (metrics
.rbearing
> metrics
.width
)
20911 *right
= metrics
.rbearing
- metrics
.width
;
20912 if (metrics
.lbearing
< 0)
20913 *left
= - metrics
.lbearing
;
20919 /* Return the index of the first glyph preceding glyph string S that
20920 is overwritten by S because of S's left overhang. Value is -1
20921 if no glyphs are overwritten. */
20924 left_overwritten (struct glyph_string
*s
)
20928 if (s
->left_overhang
)
20931 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20932 int first
= s
->first_glyph
- glyphs
;
20934 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20935 x
-= glyphs
[i
].pixel_width
;
20946 /* Return the index of the first glyph preceding glyph string S that
20947 is overwriting S because of its right overhang. Value is -1 if no
20948 glyph in front of S overwrites S. */
20951 left_overwriting (struct glyph_string
*s
)
20954 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20955 int first
= s
->first_glyph
- glyphs
;
20959 for (i
= first
- 1; i
>= 0; --i
)
20962 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20965 x
-= glyphs
[i
].pixel_width
;
20972 /* Return the index of the last glyph following glyph string S that is
20973 overwritten by S because of S's right overhang. Value is -1 if
20974 no such glyph is found. */
20977 right_overwritten (struct glyph_string
*s
)
20981 if (s
->right_overhang
)
20984 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20985 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20986 int end
= s
->row
->used
[s
->area
];
20988 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20989 x
+= glyphs
[i
].pixel_width
;
20998 /* Return the index of the last glyph following glyph string S that
20999 overwrites S because of its left overhang. Value is negative
21000 if no such glyph is found. */
21003 right_overwriting (struct glyph_string
*s
)
21006 int end
= s
->row
->used
[s
->area
];
21007 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21008 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21012 for (i
= first
; i
< end
; ++i
)
21015 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21018 x
+= glyphs
[i
].pixel_width
;
21025 /* Set background width of glyph string S. START is the index of the
21026 first glyph following S. LAST_X is the right-most x-position + 1
21027 in the drawing area. */
21030 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21032 /* If the face of this glyph string has to be drawn to the end of
21033 the drawing area, set S->extends_to_end_of_line_p. */
21035 if (start
== s
->row
->used
[s
->area
]
21036 && s
->area
== TEXT_AREA
21037 && ((s
->row
->fill_line_p
21038 && (s
->hl
== DRAW_NORMAL_TEXT
21039 || s
->hl
== DRAW_IMAGE_RAISED
21040 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21041 || s
->hl
== DRAW_MOUSE_FACE
))
21042 s
->extends_to_end_of_line_p
= 1;
21044 /* If S extends its face to the end of the line, set its
21045 background_width to the distance to the right edge of the drawing
21047 if (s
->extends_to_end_of_line_p
)
21048 s
->background_width
= last_x
- s
->x
+ 1;
21050 s
->background_width
= s
->width
;
21054 /* Compute overhangs and x-positions for glyph string S and its
21055 predecessors, or successors. X is the starting x-position for S.
21056 BACKWARD_P non-zero means process predecessors. */
21059 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21065 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21066 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21076 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21077 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21087 /* The following macros are only called from draw_glyphs below.
21088 They reference the following parameters of that function directly:
21089 `w', `row', `area', and `overlap_p'
21090 as well as the following local variables:
21091 `s', `f', and `hdc' (in W32) */
21094 /* On W32, silently add local `hdc' variable to argument list of
21095 init_glyph_string. */
21096 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21097 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21099 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21100 init_glyph_string (s, char2b, w, row, area, start, hl)
21103 /* Add a glyph string for a stretch glyph to the list of strings
21104 between HEAD and TAIL. START is the index of the stretch glyph in
21105 row area AREA of glyph row ROW. END is the index of the last glyph
21106 in that glyph row area. X is the current output position assigned
21107 to the new glyph string constructed. HL overrides that face of the
21108 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21109 is the right-most x-position of the drawing area. */
21111 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21112 and below -- keep them on one line. */
21113 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21116 s = (struct glyph_string *) alloca (sizeof *s); \
21117 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21118 START = fill_stretch_glyph_string (s, START, END); \
21119 append_glyph_string (&HEAD, &TAIL, s); \
21125 /* Add a glyph string for an image glyph to the list of strings
21126 between HEAD and TAIL. START is the index of the image glyph in
21127 row area AREA of glyph row ROW. END is the index of the last glyph
21128 in that glyph row area. X is the current output position assigned
21129 to the new glyph string constructed. HL overrides that face of the
21130 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21131 is the right-most x-position of the drawing area. */
21133 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21136 s = (struct glyph_string *) alloca (sizeof *s); \
21137 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21138 fill_image_glyph_string (s); \
21139 append_glyph_string (&HEAD, &TAIL, s); \
21146 /* Add a glyph string for a sequence of character glyphs to the list
21147 of strings between HEAD and TAIL. START is the index of the first
21148 glyph in row area AREA of glyph row ROW that is part of the new
21149 glyph string. END is the index of the last glyph in that glyph row
21150 area. X is the current output position assigned to the new glyph
21151 string constructed. HL overrides that face of the glyph; e.g. it
21152 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21153 right-most x-position of the drawing area. */
21155 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21161 face_id = (row)->glyphs[area][START].face_id; \
21163 s = (struct glyph_string *) alloca (sizeof *s); \
21164 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21165 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21166 append_glyph_string (&HEAD, &TAIL, s); \
21168 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21173 /* Add a glyph string for a composite sequence to the list of strings
21174 between HEAD and TAIL. START is the index of the first glyph in
21175 row area AREA of glyph row ROW that is part of the new glyph
21176 string. END is the index of the last glyph in that glyph row area.
21177 X is the current output position assigned to the new glyph string
21178 constructed. HL overrides that face of the glyph; e.g. it is
21179 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21180 x-position of the drawing area. */
21182 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21184 int face_id = (row)->glyphs[area][START].face_id; \
21185 struct face *base_face = FACE_FROM_ID (f, face_id); \
21186 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21187 struct composition *cmp = composition_table[cmp_id]; \
21189 struct glyph_string *first_s IF_LINT (= NULL); \
21192 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21194 /* Make glyph_strings for each glyph sequence that is drawable by \
21195 the same face, and append them to HEAD/TAIL. */ \
21196 for (n = 0; n < cmp->glyph_len;) \
21198 s = (struct glyph_string *) alloca (sizeof *s); \
21199 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21200 append_glyph_string (&(HEAD), &(TAIL), s); \
21206 n = fill_composite_glyph_string (s, base_face, overlaps); \
21214 /* Add a glyph string for a glyph-string sequence to the list of strings
21215 between HEAD and TAIL. */
21217 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21221 Lisp_Object gstring; \
21223 face_id = (row)->glyphs[area][START].face_id; \
21224 gstring = (composition_gstring_from_id \
21225 ((row)->glyphs[area][START].u.cmp.id)); \
21226 s = (struct glyph_string *) alloca (sizeof *s); \
21227 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21228 * LGSTRING_GLYPH_LEN (gstring)); \
21229 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21230 append_glyph_string (&(HEAD), &(TAIL), s); \
21232 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21236 /* Add a glyph string for a sequence of glyphless character's glyphs
21237 to the list of strings between HEAD and TAIL. The meanings of
21238 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21240 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21245 face_id = (row)->glyphs[area][START].face_id; \
21247 s = (struct glyph_string *) alloca (sizeof *s); \
21248 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21249 append_glyph_string (&HEAD, &TAIL, s); \
21251 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21257 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21258 of AREA of glyph row ROW on window W between indices START and END.
21259 HL overrides the face for drawing glyph strings, e.g. it is
21260 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21261 x-positions of the drawing area.
21263 This is an ugly monster macro construct because we must use alloca
21264 to allocate glyph strings (because draw_glyphs can be called
21265 asynchronously). */
21267 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21270 HEAD = TAIL = NULL; \
21271 while (START < END) \
21273 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21274 switch (first_glyph->type) \
21277 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21281 case COMPOSITE_GLYPH: \
21282 if (first_glyph->u.cmp.automatic) \
21283 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21286 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21290 case STRETCH_GLYPH: \
21291 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21295 case IMAGE_GLYPH: \
21296 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21300 case GLYPHLESS_GLYPH: \
21301 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21311 set_glyph_string_background_width (s, START, LAST_X); \
21318 /* Draw glyphs between START and END in AREA of ROW on window W,
21319 starting at x-position X. X is relative to AREA in W. HL is a
21320 face-override with the following meaning:
21322 DRAW_NORMAL_TEXT draw normally
21323 DRAW_CURSOR draw in cursor face
21324 DRAW_MOUSE_FACE draw in mouse face.
21325 DRAW_INVERSE_VIDEO draw in mode line face
21326 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21327 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21329 If OVERLAPS is non-zero, draw only the foreground of characters and
21330 clip to the physical height of ROW. Non-zero value also defines
21331 the overlapping part to be drawn:
21333 OVERLAPS_PRED overlap with preceding rows
21334 OVERLAPS_SUCC overlap with succeeding rows
21335 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21336 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21338 Value is the x-position reached, relative to AREA of W. */
21341 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21342 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21343 enum draw_glyphs_face hl
, int overlaps
)
21345 struct glyph_string
*head
, *tail
;
21346 struct glyph_string
*s
;
21347 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21348 int i
, j
, x_reached
, last_x
, area_left
= 0;
21349 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21352 ALLOCATE_HDC (hdc
, f
);
21354 /* Let's rather be paranoid than getting a SEGV. */
21355 end
= min (end
, row
->used
[area
]);
21356 start
= max (0, start
);
21357 start
= min (end
, start
);
21359 /* Translate X to frame coordinates. Set last_x to the right
21360 end of the drawing area. */
21361 if (row
->full_width_p
)
21363 /* X is relative to the left edge of W, without scroll bars
21365 area_left
= WINDOW_LEFT_EDGE_X (w
);
21366 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21370 area_left
= window_box_left (w
, area
);
21371 last_x
= area_left
+ window_box_width (w
, area
);
21375 /* Build a doubly-linked list of glyph_string structures between
21376 head and tail from what we have to draw. Note that the macro
21377 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21378 the reason we use a separate variable `i'. */
21380 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21382 x_reached
= tail
->x
+ tail
->background_width
;
21386 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21387 the row, redraw some glyphs in front or following the glyph
21388 strings built above. */
21389 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21391 struct glyph_string
*h
, *t
;
21392 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21393 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21394 int check_mouse_face
= 0;
21397 /* If mouse highlighting is on, we may need to draw adjacent
21398 glyphs using mouse-face highlighting. */
21399 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21401 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21403 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21404 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21406 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21408 check_mouse_face
= 1;
21409 mouse_beg_col
= (row
== mouse_beg_row
)
21410 ? hlinfo
->mouse_face_beg_col
: 0;
21411 mouse_end_col
= (row
== mouse_end_row
)
21412 ? hlinfo
->mouse_face_end_col
21413 : row
->used
[TEXT_AREA
];
21417 /* Compute overhangs for all glyph strings. */
21418 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21419 for (s
= head
; s
; s
= s
->next
)
21420 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21422 /* Prepend glyph strings for glyphs in front of the first glyph
21423 string that are overwritten because of the first glyph
21424 string's left overhang. The background of all strings
21425 prepended must be drawn because the first glyph string
21427 i
= left_overwritten (head
);
21430 enum draw_glyphs_face overlap_hl
;
21432 /* If this row contains mouse highlighting, attempt to draw
21433 the overlapped glyphs with the correct highlight. This
21434 code fails if the overlap encompasses more than one glyph
21435 and mouse-highlight spans only some of these glyphs.
21436 However, making it work perfectly involves a lot more
21437 code, and I don't know if the pathological case occurs in
21438 practice, so we'll stick to this for now. --- cyd */
21439 if (check_mouse_face
21440 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21441 overlap_hl
= DRAW_MOUSE_FACE
;
21443 overlap_hl
= DRAW_NORMAL_TEXT
;
21446 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21447 overlap_hl
, dummy_x
, last_x
);
21449 compute_overhangs_and_x (t
, head
->x
, 1);
21450 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21454 /* Prepend glyph strings for glyphs in front of the first glyph
21455 string that overwrite that glyph string because of their
21456 right overhang. For these strings, only the foreground must
21457 be drawn, because it draws over the glyph string at `head'.
21458 The background must not be drawn because this would overwrite
21459 right overhangs of preceding glyphs for which no glyph
21461 i
= left_overwriting (head
);
21464 enum draw_glyphs_face overlap_hl
;
21466 if (check_mouse_face
21467 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21468 overlap_hl
= DRAW_MOUSE_FACE
;
21470 overlap_hl
= DRAW_NORMAL_TEXT
;
21473 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21474 overlap_hl
, dummy_x
, last_x
);
21475 for (s
= h
; s
; s
= s
->next
)
21476 s
->background_filled_p
= 1;
21477 compute_overhangs_and_x (t
, head
->x
, 1);
21478 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21481 /* Append glyphs strings for glyphs following the last glyph
21482 string tail that are overwritten by tail. The background of
21483 these strings has to be drawn because tail's foreground draws
21485 i
= right_overwritten (tail
);
21488 enum draw_glyphs_face overlap_hl
;
21490 if (check_mouse_face
21491 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21492 overlap_hl
= DRAW_MOUSE_FACE
;
21494 overlap_hl
= DRAW_NORMAL_TEXT
;
21496 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21497 overlap_hl
, x
, last_x
);
21498 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21499 we don't have `end = i;' here. */
21500 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21501 append_glyph_string_lists (&head
, &tail
, h
, t
);
21505 /* Append glyph strings for glyphs following the last glyph
21506 string tail that overwrite tail. The foreground of such
21507 glyphs has to be drawn because it writes into the background
21508 of tail. The background must not be drawn because it could
21509 paint over the foreground of following glyphs. */
21510 i
= right_overwriting (tail
);
21513 enum draw_glyphs_face overlap_hl
;
21514 if (check_mouse_face
21515 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21516 overlap_hl
= DRAW_MOUSE_FACE
;
21518 overlap_hl
= DRAW_NORMAL_TEXT
;
21521 i
++; /* We must include the Ith glyph. */
21522 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21523 overlap_hl
, x
, last_x
);
21524 for (s
= h
; s
; s
= s
->next
)
21525 s
->background_filled_p
= 1;
21526 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21527 append_glyph_string_lists (&head
, &tail
, h
, t
);
21529 if (clip_head
|| clip_tail
)
21530 for (s
= head
; s
; s
= s
->next
)
21532 s
->clip_head
= clip_head
;
21533 s
->clip_tail
= clip_tail
;
21537 /* Draw all strings. */
21538 for (s
= head
; s
; s
= s
->next
)
21539 FRAME_RIF (f
)->draw_glyph_string (s
);
21542 /* When focus a sole frame and move horizontally, this sets on_p to 0
21543 causing a failure to erase prev cursor position. */
21544 if (area
== TEXT_AREA
21545 && !row
->full_width_p
21546 /* When drawing overlapping rows, only the glyph strings'
21547 foreground is drawn, which doesn't erase a cursor
21551 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21552 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21553 : (tail
? tail
->x
+ tail
->background_width
: x
));
21557 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21558 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21562 /* Value is the x-position up to which drawn, relative to AREA of W.
21563 This doesn't include parts drawn because of overhangs. */
21564 if (row
->full_width_p
)
21565 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21567 x_reached
-= area_left
;
21569 RELEASE_HDC (hdc
, f
);
21574 /* Expand row matrix if too narrow. Don't expand if area
21577 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21579 if (!fonts_changed_p \
21580 && (it->glyph_row->glyphs[area] \
21581 < it->glyph_row->glyphs[area + 1])) \
21583 it->w->ncols_scale_factor++; \
21584 fonts_changed_p = 1; \
21588 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21589 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21592 append_glyph (struct it
*it
)
21594 struct glyph
*glyph
;
21595 enum glyph_row_area area
= it
->area
;
21597 xassert (it
->glyph_row
);
21598 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21600 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21601 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21603 /* If the glyph row is reversed, we need to prepend the glyph
21604 rather than append it. */
21605 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21609 /* Make room for the additional glyph. */
21610 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21612 glyph
= it
->glyph_row
->glyphs
[area
];
21614 glyph
->charpos
= CHARPOS (it
->position
);
21615 glyph
->object
= it
->object
;
21616 if (it
->pixel_width
> 0)
21618 glyph
->pixel_width
= it
->pixel_width
;
21619 glyph
->padding_p
= 0;
21623 /* Assure at least 1-pixel width. Otherwise, cursor can't
21624 be displayed correctly. */
21625 glyph
->pixel_width
= 1;
21626 glyph
->padding_p
= 1;
21628 glyph
->ascent
= it
->ascent
;
21629 glyph
->descent
= it
->descent
;
21630 glyph
->voffset
= it
->voffset
;
21631 glyph
->type
= CHAR_GLYPH
;
21632 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21633 glyph
->multibyte_p
= it
->multibyte_p
;
21634 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21635 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21636 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21637 || it
->phys_descent
> it
->descent
);
21638 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21639 glyph
->face_id
= it
->face_id
;
21640 glyph
->u
.ch
= it
->char_to_display
;
21641 glyph
->slice
.img
= null_glyph_slice
;
21642 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21645 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21646 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21648 glyph
->bidi_type
= it
->bidi_it
.type
;
21652 glyph
->resolved_level
= 0;
21653 glyph
->bidi_type
= UNKNOWN_BT
;
21655 ++it
->glyph_row
->used
[area
];
21658 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21661 /* Store one glyph for the composition IT->cmp_it.id in
21662 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21666 append_composite_glyph (struct it
*it
)
21668 struct glyph
*glyph
;
21669 enum glyph_row_area area
= it
->area
;
21671 xassert (it
->glyph_row
);
21673 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21674 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21676 /* If the glyph row is reversed, we need to prepend the glyph
21677 rather than append it. */
21678 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21682 /* Make room for the new glyph. */
21683 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21685 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21687 glyph
->charpos
= it
->cmp_it
.charpos
;
21688 glyph
->object
= it
->object
;
21689 glyph
->pixel_width
= it
->pixel_width
;
21690 glyph
->ascent
= it
->ascent
;
21691 glyph
->descent
= it
->descent
;
21692 glyph
->voffset
= it
->voffset
;
21693 glyph
->type
= COMPOSITE_GLYPH
;
21694 if (it
->cmp_it
.ch
< 0)
21696 glyph
->u
.cmp
.automatic
= 0;
21697 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21698 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21702 glyph
->u
.cmp
.automatic
= 1;
21703 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21704 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21705 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21707 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21708 glyph
->multibyte_p
= it
->multibyte_p
;
21709 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21710 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21711 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21712 || it
->phys_descent
> it
->descent
);
21713 glyph
->padding_p
= 0;
21714 glyph
->glyph_not_available_p
= 0;
21715 glyph
->face_id
= it
->face_id
;
21716 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21719 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21720 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21722 glyph
->bidi_type
= it
->bidi_it
.type
;
21724 ++it
->glyph_row
->used
[area
];
21727 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21731 /* Change IT->ascent and IT->height according to the setting of
21735 take_vertical_position_into_account (struct it
*it
)
21739 if (it
->voffset
< 0)
21740 /* Increase the ascent so that we can display the text higher
21742 it
->ascent
-= it
->voffset
;
21744 /* Increase the descent so that we can display the text lower
21746 it
->descent
+= it
->voffset
;
21751 /* Produce glyphs/get display metrics for the image IT is loaded with.
21752 See the description of struct display_iterator in dispextern.h for
21753 an overview of struct display_iterator. */
21756 produce_image_glyph (struct it
*it
)
21760 int glyph_ascent
, crop
;
21761 struct glyph_slice slice
;
21763 xassert (it
->what
== IT_IMAGE
);
21765 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21767 /* Make sure X resources of the face is loaded. */
21768 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21770 if (it
->image_id
< 0)
21772 /* Fringe bitmap. */
21773 it
->ascent
= it
->phys_ascent
= 0;
21774 it
->descent
= it
->phys_descent
= 0;
21775 it
->pixel_width
= 0;
21780 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21782 /* Make sure X resources of the image is loaded. */
21783 prepare_image_for_display (it
->f
, img
);
21785 slice
.x
= slice
.y
= 0;
21786 slice
.width
= img
->width
;
21787 slice
.height
= img
->height
;
21789 if (INTEGERP (it
->slice
.x
))
21790 slice
.x
= XINT (it
->slice
.x
);
21791 else if (FLOATP (it
->slice
.x
))
21792 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21794 if (INTEGERP (it
->slice
.y
))
21795 slice
.y
= XINT (it
->slice
.y
);
21796 else if (FLOATP (it
->slice
.y
))
21797 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21799 if (INTEGERP (it
->slice
.width
))
21800 slice
.width
= XINT (it
->slice
.width
);
21801 else if (FLOATP (it
->slice
.width
))
21802 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21804 if (INTEGERP (it
->slice
.height
))
21805 slice
.height
= XINT (it
->slice
.height
);
21806 else if (FLOATP (it
->slice
.height
))
21807 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21809 if (slice
.x
>= img
->width
)
21810 slice
.x
= img
->width
;
21811 if (slice
.y
>= img
->height
)
21812 slice
.y
= img
->height
;
21813 if (slice
.x
+ slice
.width
>= img
->width
)
21814 slice
.width
= img
->width
- slice
.x
;
21815 if (slice
.y
+ slice
.height
> img
->height
)
21816 slice
.height
= img
->height
- slice
.y
;
21818 if (slice
.width
== 0 || slice
.height
== 0)
21821 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21823 it
->descent
= slice
.height
- glyph_ascent
;
21825 it
->descent
+= img
->vmargin
;
21826 if (slice
.y
+ slice
.height
== img
->height
)
21827 it
->descent
+= img
->vmargin
;
21828 it
->phys_descent
= it
->descent
;
21830 it
->pixel_width
= slice
.width
;
21832 it
->pixel_width
+= img
->hmargin
;
21833 if (slice
.x
+ slice
.width
== img
->width
)
21834 it
->pixel_width
+= img
->hmargin
;
21836 /* It's quite possible for images to have an ascent greater than
21837 their height, so don't get confused in that case. */
21838 if (it
->descent
< 0)
21843 if (face
->box
!= FACE_NO_BOX
)
21845 if (face
->box_line_width
> 0)
21848 it
->ascent
+= face
->box_line_width
;
21849 if (slice
.y
+ slice
.height
== img
->height
)
21850 it
->descent
+= face
->box_line_width
;
21853 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21854 it
->pixel_width
+= eabs (face
->box_line_width
);
21855 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21856 it
->pixel_width
+= eabs (face
->box_line_width
);
21859 take_vertical_position_into_account (it
);
21861 /* Automatically crop wide image glyphs at right edge so we can
21862 draw the cursor on same display row. */
21863 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21864 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21866 it
->pixel_width
-= crop
;
21867 slice
.width
-= crop
;
21872 struct glyph
*glyph
;
21873 enum glyph_row_area area
= it
->area
;
21875 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21876 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21878 glyph
->charpos
= CHARPOS (it
->position
);
21879 glyph
->object
= it
->object
;
21880 glyph
->pixel_width
= it
->pixel_width
;
21881 glyph
->ascent
= glyph_ascent
;
21882 glyph
->descent
= it
->descent
;
21883 glyph
->voffset
= it
->voffset
;
21884 glyph
->type
= IMAGE_GLYPH
;
21885 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21886 glyph
->multibyte_p
= it
->multibyte_p
;
21887 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21888 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21889 glyph
->overlaps_vertically_p
= 0;
21890 glyph
->padding_p
= 0;
21891 glyph
->glyph_not_available_p
= 0;
21892 glyph
->face_id
= it
->face_id
;
21893 glyph
->u
.img_id
= img
->id
;
21894 glyph
->slice
.img
= slice
;
21895 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21898 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21899 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21901 glyph
->bidi_type
= it
->bidi_it
.type
;
21903 ++it
->glyph_row
->used
[area
];
21906 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21911 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21912 of the glyph, WIDTH and HEIGHT are the width and height of the
21913 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21916 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21917 int width
, int height
, int ascent
)
21919 struct glyph
*glyph
;
21920 enum glyph_row_area area
= it
->area
;
21922 xassert (ascent
>= 0 && ascent
<= height
);
21924 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21925 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21927 /* If the glyph row is reversed, we need to prepend the glyph
21928 rather than append it. */
21929 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21933 /* Make room for the additional glyph. */
21934 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21936 glyph
= it
->glyph_row
->glyphs
[area
];
21938 glyph
->charpos
= CHARPOS (it
->position
);
21939 glyph
->object
= object
;
21940 glyph
->pixel_width
= width
;
21941 glyph
->ascent
= ascent
;
21942 glyph
->descent
= height
- ascent
;
21943 glyph
->voffset
= it
->voffset
;
21944 glyph
->type
= STRETCH_GLYPH
;
21945 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21946 glyph
->multibyte_p
= it
->multibyte_p
;
21947 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21948 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21949 glyph
->overlaps_vertically_p
= 0;
21950 glyph
->padding_p
= 0;
21951 glyph
->glyph_not_available_p
= 0;
21952 glyph
->face_id
= it
->face_id
;
21953 glyph
->u
.stretch
.ascent
= ascent
;
21954 glyph
->u
.stretch
.height
= height
;
21955 glyph
->slice
.img
= null_glyph_slice
;
21956 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21959 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21960 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21962 glyph
->bidi_type
= it
->bidi_it
.type
;
21966 glyph
->resolved_level
= 0;
21967 glyph
->bidi_type
= UNKNOWN_BT
;
21969 ++it
->glyph_row
->used
[area
];
21972 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21976 /* Produce a stretch glyph for iterator IT. IT->object is the value
21977 of the glyph property displayed. The value must be a list
21978 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21981 1. `:width WIDTH' specifies that the space should be WIDTH *
21982 canonical char width wide. WIDTH may be an integer or floating
21985 2. `:relative-width FACTOR' specifies that the width of the stretch
21986 should be computed from the width of the first character having the
21987 `glyph' property, and should be FACTOR times that width.
21989 3. `:align-to HPOS' specifies that the space should be wide enough
21990 to reach HPOS, a value in canonical character units.
21992 Exactly one of the above pairs must be present.
21994 4. `:height HEIGHT' specifies that the height of the stretch produced
21995 should be HEIGHT, measured in canonical character units.
21997 5. `:relative-height FACTOR' specifies that the height of the
21998 stretch should be FACTOR times the height of the characters having
21999 the glyph property.
22001 Either none or exactly one of 4 or 5 must be present.
22003 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22004 of the stretch should be used for the ascent of the stretch.
22005 ASCENT must be in the range 0 <= ASCENT <= 100. */
22008 produce_stretch_glyph (struct it
*it
)
22010 /* (space :width WIDTH :height HEIGHT ...) */
22011 Lisp_Object prop
, plist
;
22012 int width
= 0, height
= 0, align_to
= -1;
22013 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22016 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22017 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22019 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22021 /* List should start with `space'. */
22022 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22023 plist
= XCDR (it
->object
);
22025 /* Compute the width of the stretch. */
22026 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22027 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22029 /* Absolute width `:width WIDTH' specified and valid. */
22030 zero_width_ok_p
= 1;
22033 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22036 /* Relative width `:relative-width FACTOR' specified and valid.
22037 Compute the width of the characters having the `glyph'
22040 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22043 if (it
->multibyte_p
)
22044 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22047 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22048 if (! ASCII_CHAR_P (it2
.c
))
22049 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22052 it2
.glyph_row
= NULL
;
22053 it2
.what
= IT_CHARACTER
;
22054 x_produce_glyphs (&it2
);
22055 width
= NUMVAL (prop
) * it2
.pixel_width
;
22057 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22058 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22060 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22061 align_to
= (align_to
< 0
22063 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22064 else if (align_to
< 0)
22065 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22066 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22067 zero_width_ok_p
= 1;
22070 /* Nothing specified -> width defaults to canonical char width. */
22071 width
= FRAME_COLUMN_WIDTH (it
->f
);
22073 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22076 /* Compute height. */
22077 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22078 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22081 zero_height_ok_p
= 1;
22083 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22085 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22087 height
= FONT_HEIGHT (font
);
22089 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22092 /* Compute percentage of height used for ascent. If
22093 `:ascent ASCENT' is present and valid, use that. Otherwise,
22094 derive the ascent from the font in use. */
22095 if (prop
= Fplist_get (plist
, QCascent
),
22096 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22097 ascent
= height
* NUMVAL (prop
) / 100.0;
22098 else if (!NILP (prop
)
22099 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22100 ascent
= min (max (0, (int)tem
), height
);
22102 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22104 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22105 && it
->current_x
+ width
> it
->last_visible_x
)
22106 width
= it
->last_visible_x
- it
->current_x
- 1;
22108 if (width
> 0 && height
> 0 && it
->glyph_row
)
22110 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22111 if (!STRINGP (object
))
22112 object
= it
->w
->buffer
;
22113 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22116 it
->pixel_width
= width
;
22117 it
->ascent
= it
->phys_ascent
= ascent
;
22118 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22119 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22121 take_vertical_position_into_account (it
);
22124 /* Calculate line-height and line-spacing properties.
22125 An integer value specifies explicit pixel value.
22126 A float value specifies relative value to current face height.
22127 A cons (float . face-name) specifies relative value to
22128 height of specified face font.
22130 Returns height in pixels, or nil. */
22134 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22135 int boff
, int override
)
22137 Lisp_Object face_name
= Qnil
;
22138 int ascent
, descent
, height
;
22140 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22145 face_name
= XCAR (val
);
22147 if (!NUMBERP (val
))
22148 val
= make_number (1);
22149 if (NILP (face_name
))
22151 height
= it
->ascent
+ it
->descent
;
22156 if (NILP (face_name
))
22158 font
= FRAME_FONT (it
->f
);
22159 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22161 else if (EQ (face_name
, Qt
))
22170 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22172 return make_number (-1);
22174 face
= FACE_FROM_ID (it
->f
, face_id
);
22177 return make_number (-1);
22178 boff
= font
->baseline_offset
;
22179 if (font
->vertical_centering
)
22180 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22183 ascent
= FONT_BASE (font
) + boff
;
22184 descent
= FONT_DESCENT (font
) - boff
;
22188 it
->override_ascent
= ascent
;
22189 it
->override_descent
= descent
;
22190 it
->override_boff
= boff
;
22193 height
= ascent
+ descent
;
22197 height
= (int)(XFLOAT_DATA (val
) * height
);
22198 else if (INTEGERP (val
))
22199 height
*= XINT (val
);
22201 return make_number (height
);
22205 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22206 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22207 and only if this is for a character for which no font was found.
22209 If the display method (it->glyphless_method) is
22210 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22211 length of the acronym or the hexadecimal string, UPPER_XOFF and
22212 UPPER_YOFF are pixel offsets for the upper part of the string,
22213 LOWER_XOFF and LOWER_YOFF are for the lower part.
22215 For the other display methods, LEN through LOWER_YOFF are zero. */
22218 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22219 short upper_xoff
, short upper_yoff
,
22220 short lower_xoff
, short lower_yoff
)
22222 struct glyph
*glyph
;
22223 enum glyph_row_area area
= it
->area
;
22225 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22226 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22228 /* If the glyph row is reversed, we need to prepend the glyph
22229 rather than append it. */
22230 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22234 /* Make room for the additional glyph. */
22235 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22237 glyph
= it
->glyph_row
->glyphs
[area
];
22239 glyph
->charpos
= CHARPOS (it
->position
);
22240 glyph
->object
= it
->object
;
22241 glyph
->pixel_width
= it
->pixel_width
;
22242 glyph
->ascent
= it
->ascent
;
22243 glyph
->descent
= it
->descent
;
22244 glyph
->voffset
= it
->voffset
;
22245 glyph
->type
= GLYPHLESS_GLYPH
;
22246 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22247 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22248 glyph
->u
.glyphless
.len
= len
;
22249 glyph
->u
.glyphless
.ch
= it
->c
;
22250 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22251 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22252 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22253 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22254 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22255 glyph
->multibyte_p
= it
->multibyte_p
;
22256 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22257 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22258 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22259 || it
->phys_descent
> it
->descent
);
22260 glyph
->padding_p
= 0;
22261 glyph
->glyph_not_available_p
= 0;
22262 glyph
->face_id
= face_id
;
22263 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22266 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22267 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22269 glyph
->bidi_type
= it
->bidi_it
.type
;
22271 ++it
->glyph_row
->used
[area
];
22274 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22278 /* Produce a glyph for a glyphless character for iterator IT.
22279 IT->glyphless_method specifies which method to use for displaying
22280 the character. See the description of enum
22281 glyphless_display_method in dispextern.h for the detail.
22283 FOR_NO_FONT is nonzero if and only if this is for a character for
22284 which no font was found. ACRONYM, if non-nil, is an acronym string
22285 for the character. */
22288 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22293 int base_width
, base_height
, width
, height
;
22294 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22297 /* Get the metrics of the base font. We always refer to the current
22299 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22300 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22301 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22302 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22303 base_height
= it
->ascent
+ it
->descent
;
22304 base_width
= font
->average_width
;
22306 /* Get a face ID for the glyph by utilizing a cache (the same way as
22307 doen for `escape-glyph' in get_next_display_element). */
22308 if (it
->f
== last_glyphless_glyph_frame
22309 && it
->face_id
== last_glyphless_glyph_face_id
)
22311 face_id
= last_glyphless_glyph_merged_face_id
;
22315 /* Merge the `glyphless-char' face into the current face. */
22316 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22317 last_glyphless_glyph_frame
= it
->f
;
22318 last_glyphless_glyph_face_id
= it
->face_id
;
22319 last_glyphless_glyph_merged_face_id
= face_id
;
22322 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22324 it
->pixel_width
= THIN_SPACE_WIDTH
;
22326 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22328 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22330 width
= CHAR_WIDTH (it
->c
);
22333 else if (width
> 4)
22335 it
->pixel_width
= base_width
* width
;
22337 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22343 unsigned int code
[6];
22345 int ascent
, descent
;
22346 struct font_metrics metrics_upper
, metrics_lower
;
22348 face
= FACE_FROM_ID (it
->f
, face_id
);
22349 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22350 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22352 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22354 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22355 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22356 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22360 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22361 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22364 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22365 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22366 upper_len
= (len
+ 1) / 2;
22367 font
->driver
->text_extents (font
, code
, upper_len
,
22369 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22374 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22375 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22376 upper_xoff
= upper_yoff
= 2; /* the typical case */
22377 if (base_width
>= width
)
22379 /* Align the upper to the left, the lower to the right. */
22380 it
->pixel_width
= base_width
;
22381 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22385 /* Center the shorter one. */
22386 it
->pixel_width
= width
;
22387 if (metrics_upper
.width
>= metrics_lower
.width
)
22388 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22391 /* FIXME: This code doesn't look right. It formerly was
22392 missing the "lower_xoff = 0;", which couldn't have
22393 been right since it left lower_xoff uninitialized. */
22395 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22399 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22400 top, bottom, and between upper and lower strings. */
22401 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22402 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22403 /* Center vertically.
22404 H:base_height, D:base_descent
22405 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22407 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22408 descent = D - H/2 + h/2;
22409 lower_yoff = descent - 2 - ld;
22410 upper_yoff = lower_yoff - la - 1 - ud; */
22411 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22412 descent
= it
->descent
- (base_height
- height
) / 2;
22413 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22414 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22415 - metrics_upper
.descent
);
22416 /* Don't make the height shorter than the base height. */
22417 if (height
> base_height
)
22419 it
->ascent
= ascent
;
22420 it
->descent
= descent
;
22424 it
->phys_ascent
= it
->ascent
;
22425 it
->phys_descent
= it
->descent
;
22427 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22428 upper_xoff
, upper_yoff
,
22429 lower_xoff
, lower_yoff
);
22431 take_vertical_position_into_account (it
);
22436 Produce glyphs/get display metrics for the display element IT is
22437 loaded with. See the description of struct it in dispextern.h
22438 for an overview of struct it. */
22441 x_produce_glyphs (struct it
*it
)
22443 int extra_line_spacing
= it
->extra_line_spacing
;
22445 it
->glyph_not_available_p
= 0;
22447 if (it
->what
== IT_CHARACTER
)
22450 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22451 struct font
*font
= face
->font
;
22452 struct font_metrics
*pcm
= NULL
;
22453 int boff
; /* baseline offset */
22457 /* When no suitable font is found, display this character by
22458 the method specified in the first extra slot of
22459 Vglyphless_char_display. */
22460 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22462 xassert (it
->what
== IT_GLYPHLESS
);
22463 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22467 boff
= font
->baseline_offset
;
22468 if (font
->vertical_centering
)
22469 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22471 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22477 if (it
->override_ascent
>= 0)
22479 it
->ascent
= it
->override_ascent
;
22480 it
->descent
= it
->override_descent
;
22481 boff
= it
->override_boff
;
22485 it
->ascent
= FONT_BASE (font
) + boff
;
22486 it
->descent
= FONT_DESCENT (font
) - boff
;
22489 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22491 pcm
= get_per_char_metric (font
, &char2b
);
22492 if (pcm
->width
== 0
22493 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22499 it
->phys_ascent
= pcm
->ascent
+ boff
;
22500 it
->phys_descent
= pcm
->descent
- boff
;
22501 it
->pixel_width
= pcm
->width
;
22505 it
->glyph_not_available_p
= 1;
22506 it
->phys_ascent
= it
->ascent
;
22507 it
->phys_descent
= it
->descent
;
22508 it
->pixel_width
= font
->space_width
;
22511 if (it
->constrain_row_ascent_descent_p
)
22513 if (it
->descent
> it
->max_descent
)
22515 it
->ascent
+= it
->descent
- it
->max_descent
;
22516 it
->descent
= it
->max_descent
;
22518 if (it
->ascent
> it
->max_ascent
)
22520 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22521 it
->ascent
= it
->max_ascent
;
22523 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22524 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22525 extra_line_spacing
= 0;
22528 /* If this is a space inside a region of text with
22529 `space-width' property, change its width. */
22530 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22532 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22534 /* If face has a box, add the box thickness to the character
22535 height. If character has a box line to the left and/or
22536 right, add the box line width to the character's width. */
22537 if (face
->box
!= FACE_NO_BOX
)
22539 int thick
= face
->box_line_width
;
22543 it
->ascent
+= thick
;
22544 it
->descent
+= thick
;
22549 if (it
->start_of_box_run_p
)
22550 it
->pixel_width
+= thick
;
22551 if (it
->end_of_box_run_p
)
22552 it
->pixel_width
+= thick
;
22555 /* If face has an overline, add the height of the overline
22556 (1 pixel) and a 1 pixel margin to the character height. */
22557 if (face
->overline_p
)
22558 it
->ascent
+= overline_margin
;
22560 if (it
->constrain_row_ascent_descent_p
)
22562 if (it
->ascent
> it
->max_ascent
)
22563 it
->ascent
= it
->max_ascent
;
22564 if (it
->descent
> it
->max_descent
)
22565 it
->descent
= it
->max_descent
;
22568 take_vertical_position_into_account (it
);
22570 /* If we have to actually produce glyphs, do it. */
22575 /* Translate a space with a `space-width' property
22576 into a stretch glyph. */
22577 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22578 / FONT_HEIGHT (font
));
22579 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22580 it
->ascent
+ it
->descent
, ascent
);
22585 /* If characters with lbearing or rbearing are displayed
22586 in this line, record that fact in a flag of the
22587 glyph row. This is used to optimize X output code. */
22588 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22589 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22591 if (! stretched_p
&& it
->pixel_width
== 0)
22592 /* We assure that all visible glyphs have at least 1-pixel
22594 it
->pixel_width
= 1;
22596 else if (it
->char_to_display
== '\n')
22598 /* A newline has no width, but we need the height of the
22599 line. But if previous part of the line sets a height,
22600 don't increase that height */
22602 Lisp_Object height
;
22603 Lisp_Object total_height
= Qnil
;
22605 it
->override_ascent
= -1;
22606 it
->pixel_width
= 0;
22609 height
= get_it_property (it
, Qline_height
);
22610 /* Split (line-height total-height) list */
22612 && CONSP (XCDR (height
))
22613 && NILP (XCDR (XCDR (height
))))
22615 total_height
= XCAR (XCDR (height
));
22616 height
= XCAR (height
);
22618 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22620 if (it
->override_ascent
>= 0)
22622 it
->ascent
= it
->override_ascent
;
22623 it
->descent
= it
->override_descent
;
22624 boff
= it
->override_boff
;
22628 it
->ascent
= FONT_BASE (font
) + boff
;
22629 it
->descent
= FONT_DESCENT (font
) - boff
;
22632 if (EQ (height
, Qt
))
22634 if (it
->descent
> it
->max_descent
)
22636 it
->ascent
+= it
->descent
- it
->max_descent
;
22637 it
->descent
= it
->max_descent
;
22639 if (it
->ascent
> it
->max_ascent
)
22641 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22642 it
->ascent
= it
->max_ascent
;
22644 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22645 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22646 it
->constrain_row_ascent_descent_p
= 1;
22647 extra_line_spacing
= 0;
22651 Lisp_Object spacing
;
22653 it
->phys_ascent
= it
->ascent
;
22654 it
->phys_descent
= it
->descent
;
22656 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22657 && face
->box
!= FACE_NO_BOX
22658 && face
->box_line_width
> 0)
22660 it
->ascent
+= face
->box_line_width
;
22661 it
->descent
+= face
->box_line_width
;
22664 && XINT (height
) > it
->ascent
+ it
->descent
)
22665 it
->ascent
= XINT (height
) - it
->descent
;
22667 if (!NILP (total_height
))
22668 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22671 spacing
= get_it_property (it
, Qline_spacing
);
22672 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22674 if (INTEGERP (spacing
))
22676 extra_line_spacing
= XINT (spacing
);
22677 if (!NILP (total_height
))
22678 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22682 else /* i.e. (it->char_to_display == '\t') */
22684 if (font
->space_width
> 0)
22686 int tab_width
= it
->tab_width
* font
->space_width
;
22687 int x
= it
->current_x
+ it
->continuation_lines_width
;
22688 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22690 /* If the distance from the current position to the next tab
22691 stop is less than a space character width, use the
22692 tab stop after that. */
22693 if (next_tab_x
- x
< font
->space_width
)
22694 next_tab_x
+= tab_width
;
22696 it
->pixel_width
= next_tab_x
- x
;
22698 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22699 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22703 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22704 it
->ascent
+ it
->descent
, it
->ascent
);
22709 it
->pixel_width
= 0;
22714 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22716 /* A static composition.
22718 Note: A composition is represented as one glyph in the
22719 glyph matrix. There are no padding glyphs.
22721 Important note: pixel_width, ascent, and descent are the
22722 values of what is drawn by draw_glyphs (i.e. the values of
22723 the overall glyphs composed). */
22724 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22725 int boff
; /* baseline offset */
22726 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22727 int glyph_len
= cmp
->glyph_len
;
22728 struct font
*font
= face
->font
;
22732 /* If we have not yet calculated pixel size data of glyphs of
22733 the composition for the current face font, calculate them
22734 now. Theoretically, we have to check all fonts for the
22735 glyphs, but that requires much time and memory space. So,
22736 here we check only the font of the first glyph. This may
22737 lead to incorrect display, but it's very rare, and C-l
22738 (recenter-top-bottom) can correct the display anyway. */
22739 if (! cmp
->font
|| cmp
->font
!= font
)
22741 /* Ascent and descent of the font of the first character
22742 of this composition (adjusted by baseline offset).
22743 Ascent and descent of overall glyphs should not be less
22744 than these, respectively. */
22745 int font_ascent
, font_descent
, font_height
;
22746 /* Bounding box of the overall glyphs. */
22747 int leftmost
, rightmost
, lowest
, highest
;
22748 int lbearing
, rbearing
;
22749 int i
, width
, ascent
, descent
;
22750 int left_padded
= 0, right_padded
= 0;
22753 struct font_metrics
*pcm
;
22754 int font_not_found_p
;
22757 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22758 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22760 if (glyph_len
< cmp
->glyph_len
)
22762 for (i
= 0; i
< glyph_len
; i
++)
22764 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22766 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22771 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22772 : IT_CHARPOS (*it
));
22773 /* If no suitable font is found, use the default font. */
22774 font_not_found_p
= font
== NULL
;
22775 if (font_not_found_p
)
22777 face
= face
->ascii_face
;
22780 boff
= font
->baseline_offset
;
22781 if (font
->vertical_centering
)
22782 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22783 font_ascent
= FONT_BASE (font
) + boff
;
22784 font_descent
= FONT_DESCENT (font
) - boff
;
22785 font_height
= FONT_HEIGHT (font
);
22787 cmp
->font
= (void *) font
;
22790 if (! font_not_found_p
)
22792 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22794 pcm
= get_per_char_metric (font
, &char2b
);
22797 /* Initialize the bounding box. */
22800 width
= pcm
->width
;
22801 ascent
= pcm
->ascent
;
22802 descent
= pcm
->descent
;
22803 lbearing
= pcm
->lbearing
;
22804 rbearing
= pcm
->rbearing
;
22808 width
= font
->space_width
;
22809 ascent
= FONT_BASE (font
);
22810 descent
= FONT_DESCENT (font
);
22817 lowest
= - descent
+ boff
;
22818 highest
= ascent
+ boff
;
22820 if (! font_not_found_p
22821 && font
->default_ascent
22822 && CHAR_TABLE_P (Vuse_default_ascent
)
22823 && !NILP (Faref (Vuse_default_ascent
,
22824 make_number (it
->char_to_display
))))
22825 highest
= font
->default_ascent
+ boff
;
22827 /* Draw the first glyph at the normal position. It may be
22828 shifted to right later if some other glyphs are drawn
22830 cmp
->offsets
[i
* 2] = 0;
22831 cmp
->offsets
[i
* 2 + 1] = boff
;
22832 cmp
->lbearing
= lbearing
;
22833 cmp
->rbearing
= rbearing
;
22835 /* Set cmp->offsets for the remaining glyphs. */
22836 for (i
++; i
< glyph_len
; i
++)
22838 int left
, right
, btm
, top
;
22839 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22841 struct face
*this_face
;
22845 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22846 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22847 font
= this_face
->font
;
22853 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22855 pcm
= get_per_char_metric (font
, &char2b
);
22858 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22861 width
= pcm
->width
;
22862 ascent
= pcm
->ascent
;
22863 descent
= pcm
->descent
;
22864 lbearing
= pcm
->lbearing
;
22865 rbearing
= pcm
->rbearing
;
22866 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22868 /* Relative composition with or without
22869 alternate chars. */
22870 left
= (leftmost
+ rightmost
- width
) / 2;
22871 btm
= - descent
+ boff
;
22872 if (font
->relative_compose
22873 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22874 || NILP (Faref (Vignore_relative_composition
,
22875 make_number (ch
)))))
22878 if (- descent
>= font
->relative_compose
)
22879 /* One extra pixel between two glyphs. */
22881 else if (ascent
<= 0)
22882 /* One extra pixel between two glyphs. */
22883 btm
= lowest
- 1 - ascent
- descent
;
22888 /* A composition rule is specified by an integer
22889 value that encodes global and new reference
22890 points (GREF and NREF). GREF and NREF are
22891 specified by numbers as below:
22893 0---1---2 -- ascent
22897 9--10--11 -- center
22899 ---3---4---5--- baseline
22901 6---7---8 -- descent
22903 int rule
= COMPOSITION_RULE (cmp
, i
);
22904 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22906 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22907 grefx
= gref
% 3, nrefx
= nref
% 3;
22908 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22910 xoff
= font_height
* (xoff
- 128) / 256;
22912 yoff
= font_height
* (yoff
- 128) / 256;
22915 + grefx
* (rightmost
- leftmost
) / 2
22916 - nrefx
* width
/ 2
22919 btm
= ((grefy
== 0 ? highest
22921 : grefy
== 2 ? lowest
22922 : (highest
+ lowest
) / 2)
22923 - (nrefy
== 0 ? ascent
+ descent
22924 : nrefy
== 1 ? descent
- boff
22926 : (ascent
+ descent
) / 2)
22930 cmp
->offsets
[i
* 2] = left
;
22931 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22933 /* Update the bounding box of the overall glyphs. */
22936 right
= left
+ width
;
22937 if (left
< leftmost
)
22939 if (right
> rightmost
)
22942 top
= btm
+ descent
+ ascent
;
22948 if (cmp
->lbearing
> left
+ lbearing
)
22949 cmp
->lbearing
= left
+ lbearing
;
22950 if (cmp
->rbearing
< left
+ rbearing
)
22951 cmp
->rbearing
= left
+ rbearing
;
22955 /* If there are glyphs whose x-offsets are negative,
22956 shift all glyphs to the right and make all x-offsets
22960 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22961 cmp
->offsets
[i
* 2] -= leftmost
;
22962 rightmost
-= leftmost
;
22963 cmp
->lbearing
-= leftmost
;
22964 cmp
->rbearing
-= leftmost
;
22967 if (left_padded
&& cmp
->lbearing
< 0)
22969 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22970 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22971 rightmost
-= cmp
->lbearing
;
22972 cmp
->rbearing
-= cmp
->lbearing
;
22975 if (right_padded
&& rightmost
< cmp
->rbearing
)
22977 rightmost
= cmp
->rbearing
;
22980 cmp
->pixel_width
= rightmost
;
22981 cmp
->ascent
= highest
;
22982 cmp
->descent
= - lowest
;
22983 if (cmp
->ascent
< font_ascent
)
22984 cmp
->ascent
= font_ascent
;
22985 if (cmp
->descent
< font_descent
)
22986 cmp
->descent
= font_descent
;
22990 && (cmp
->lbearing
< 0
22991 || cmp
->rbearing
> cmp
->pixel_width
))
22992 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22994 it
->pixel_width
= cmp
->pixel_width
;
22995 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22996 it
->descent
= it
->phys_descent
= cmp
->descent
;
22997 if (face
->box
!= FACE_NO_BOX
)
22999 int thick
= face
->box_line_width
;
23003 it
->ascent
+= thick
;
23004 it
->descent
+= thick
;
23009 if (it
->start_of_box_run_p
)
23010 it
->pixel_width
+= thick
;
23011 if (it
->end_of_box_run_p
)
23012 it
->pixel_width
+= thick
;
23015 /* If face has an overline, add the height of the overline
23016 (1 pixel) and a 1 pixel margin to the character height. */
23017 if (face
->overline_p
)
23018 it
->ascent
+= overline_margin
;
23020 take_vertical_position_into_account (it
);
23021 if (it
->ascent
< 0)
23023 if (it
->descent
< 0)
23027 append_composite_glyph (it
);
23029 else if (it
->what
== IT_COMPOSITION
)
23031 /* A dynamic (automatic) composition. */
23032 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23033 Lisp_Object gstring
;
23034 struct font_metrics metrics
;
23036 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23038 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23041 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23042 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23043 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23044 it
->descent
= it
->phys_descent
= metrics
.descent
;
23045 if (face
->box
!= FACE_NO_BOX
)
23047 int thick
= face
->box_line_width
;
23051 it
->ascent
+= thick
;
23052 it
->descent
+= thick
;
23057 if (it
->start_of_box_run_p
)
23058 it
->pixel_width
+= thick
;
23059 if (it
->end_of_box_run_p
)
23060 it
->pixel_width
+= thick
;
23062 /* If face has an overline, add the height of the overline
23063 (1 pixel) and a 1 pixel margin to the character height. */
23064 if (face
->overline_p
)
23065 it
->ascent
+= overline_margin
;
23066 take_vertical_position_into_account (it
);
23067 if (it
->ascent
< 0)
23069 if (it
->descent
< 0)
23073 append_composite_glyph (it
);
23075 else if (it
->what
== IT_GLYPHLESS
)
23076 produce_glyphless_glyph (it
, 0, Qnil
);
23077 else if (it
->what
== IT_IMAGE
)
23078 produce_image_glyph (it
);
23079 else if (it
->what
== IT_STRETCH
)
23080 produce_stretch_glyph (it
);
23083 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23084 because this isn't true for images with `:ascent 100'. */
23085 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23086 if (it
->area
== TEXT_AREA
)
23087 it
->current_x
+= it
->pixel_width
;
23089 if (extra_line_spacing
> 0)
23091 it
->descent
+= extra_line_spacing
;
23092 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23093 it
->max_extra_line_spacing
= extra_line_spacing
;
23096 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23097 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23098 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23099 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23103 Output LEN glyphs starting at START at the nominal cursor position.
23104 Advance the nominal cursor over the text. The global variable
23105 updated_window contains the window being updated, updated_row is
23106 the glyph row being updated, and updated_area is the area of that
23107 row being updated. */
23110 x_write_glyphs (struct glyph
*start
, int len
)
23114 xassert (updated_window
&& updated_row
);
23117 /* Write glyphs. */
23119 hpos
= start
- updated_row
->glyphs
[updated_area
];
23120 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23121 updated_row
, updated_area
,
23123 DRAW_NORMAL_TEXT
, 0);
23125 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23126 if (updated_area
== TEXT_AREA
23127 && updated_window
->phys_cursor_on_p
23128 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23129 && updated_window
->phys_cursor
.hpos
>= hpos
23130 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23131 updated_window
->phys_cursor_on_p
= 0;
23135 /* Advance the output cursor. */
23136 output_cursor
.hpos
+= len
;
23137 output_cursor
.x
= x
;
23142 Insert LEN glyphs from START at the nominal cursor position. */
23145 x_insert_glyphs (struct glyph
*start
, int len
)
23149 int line_height
, shift_by_width
, shifted_region_width
;
23150 struct glyph_row
*row
;
23151 struct glyph
*glyph
;
23152 int frame_x
, frame_y
;
23155 xassert (updated_window
&& updated_row
);
23157 w
= updated_window
;
23158 f
= XFRAME (WINDOW_FRAME (w
));
23160 /* Get the height of the line we are in. */
23162 line_height
= row
->height
;
23164 /* Get the width of the glyphs to insert. */
23165 shift_by_width
= 0;
23166 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23167 shift_by_width
+= glyph
->pixel_width
;
23169 /* Get the width of the region to shift right. */
23170 shifted_region_width
= (window_box_width (w
, updated_area
)
23175 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23176 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23178 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23179 line_height
, shift_by_width
);
23181 /* Write the glyphs. */
23182 hpos
= start
- row
->glyphs
[updated_area
];
23183 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23185 DRAW_NORMAL_TEXT
, 0);
23187 /* Advance the output cursor. */
23188 output_cursor
.hpos
+= len
;
23189 output_cursor
.x
+= shift_by_width
;
23195 Erase the current text line from the nominal cursor position
23196 (inclusive) to pixel column TO_X (exclusive). The idea is that
23197 everything from TO_X onward is already erased.
23199 TO_X is a pixel position relative to updated_area of
23200 updated_window. TO_X == -1 means clear to the end of this area. */
23203 x_clear_end_of_line (int to_x
)
23206 struct window
*w
= updated_window
;
23207 int max_x
, min_y
, max_y
;
23208 int from_x
, from_y
, to_y
;
23210 xassert (updated_window
&& updated_row
);
23211 f
= XFRAME (w
->frame
);
23213 if (updated_row
->full_width_p
)
23214 max_x
= WINDOW_TOTAL_WIDTH (w
);
23216 max_x
= window_box_width (w
, updated_area
);
23217 max_y
= window_text_bottom_y (w
);
23219 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23220 of window. For TO_X > 0, truncate to end of drawing area. */
23226 to_x
= min (to_x
, max_x
);
23228 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23230 /* Notice if the cursor will be cleared by this operation. */
23231 if (!updated_row
->full_width_p
)
23232 notice_overwritten_cursor (w
, updated_area
,
23233 output_cursor
.x
, -1,
23235 MATRIX_ROW_BOTTOM_Y (updated_row
));
23237 from_x
= output_cursor
.x
;
23239 /* Translate to frame coordinates. */
23240 if (updated_row
->full_width_p
)
23242 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23243 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23247 int area_left
= window_box_left (w
, updated_area
);
23248 from_x
+= area_left
;
23252 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23253 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23254 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23256 /* Prevent inadvertently clearing to end of the X window. */
23257 if (to_x
> from_x
&& to_y
> from_y
)
23260 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23261 to_x
- from_x
, to_y
- from_y
);
23266 #endif /* HAVE_WINDOW_SYSTEM */
23270 /***********************************************************************
23272 ***********************************************************************/
23274 /* Value is the internal representation of the specified cursor type
23275 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23276 of the bar cursor. */
23278 static enum text_cursor_kinds
23279 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23281 enum text_cursor_kinds type
;
23286 if (EQ (arg
, Qbox
))
23287 return FILLED_BOX_CURSOR
;
23289 if (EQ (arg
, Qhollow
))
23290 return HOLLOW_BOX_CURSOR
;
23292 if (EQ (arg
, Qbar
))
23299 && EQ (XCAR (arg
), Qbar
)
23300 && INTEGERP (XCDR (arg
))
23301 && XINT (XCDR (arg
)) >= 0)
23303 *width
= XINT (XCDR (arg
));
23307 if (EQ (arg
, Qhbar
))
23310 return HBAR_CURSOR
;
23314 && EQ (XCAR (arg
), Qhbar
)
23315 && INTEGERP (XCDR (arg
))
23316 && XINT (XCDR (arg
)) >= 0)
23318 *width
= XINT (XCDR (arg
));
23319 return HBAR_CURSOR
;
23322 /* Treat anything unknown as "hollow box cursor".
23323 It was bad to signal an error; people have trouble fixing
23324 .Xdefaults with Emacs, when it has something bad in it. */
23325 type
= HOLLOW_BOX_CURSOR
;
23330 /* Set the default cursor types for specified frame. */
23332 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23337 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23338 FRAME_CURSOR_WIDTH (f
) = width
;
23340 /* By default, set up the blink-off state depending on the on-state. */
23342 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23345 FRAME_BLINK_OFF_CURSOR (f
)
23346 = get_specified_cursor_type (XCDR (tem
), &width
);
23347 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23350 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23354 #ifdef HAVE_WINDOW_SYSTEM
23356 /* Return the cursor we want to be displayed in window W. Return
23357 width of bar/hbar cursor through WIDTH arg. Return with
23358 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23359 (i.e. if the `system caret' should track this cursor).
23361 In a mini-buffer window, we want the cursor only to appear if we
23362 are reading input from this window. For the selected window, we
23363 want the cursor type given by the frame parameter or buffer local
23364 setting of cursor-type. If explicitly marked off, draw no cursor.
23365 In all other cases, we want a hollow box cursor. */
23367 static enum text_cursor_kinds
23368 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23369 int *active_cursor
)
23371 struct frame
*f
= XFRAME (w
->frame
);
23372 struct buffer
*b
= XBUFFER (w
->buffer
);
23373 int cursor_type
= DEFAULT_CURSOR
;
23374 Lisp_Object alt_cursor
;
23375 int non_selected
= 0;
23377 *active_cursor
= 1;
23380 if (cursor_in_echo_area
23381 && FRAME_HAS_MINIBUF_P (f
)
23382 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23384 if (w
== XWINDOW (echo_area_window
))
23386 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23388 *width
= FRAME_CURSOR_WIDTH (f
);
23389 return FRAME_DESIRED_CURSOR (f
);
23392 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23395 *active_cursor
= 0;
23399 /* Detect a nonselected window or nonselected frame. */
23400 else if (w
!= XWINDOW (f
->selected_window
)
23401 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23403 *active_cursor
= 0;
23405 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23411 /* Never display a cursor in a window in which cursor-type is nil. */
23412 if (NILP (BVAR (b
, cursor_type
)))
23415 /* Get the normal cursor type for this window. */
23416 if (EQ (BVAR (b
, cursor_type
), Qt
))
23418 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23419 *width
= FRAME_CURSOR_WIDTH (f
);
23422 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23424 /* Use cursor-in-non-selected-windows instead
23425 for non-selected window or frame. */
23428 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23429 if (!EQ (Qt
, alt_cursor
))
23430 return get_specified_cursor_type (alt_cursor
, width
);
23431 /* t means modify the normal cursor type. */
23432 if (cursor_type
== FILLED_BOX_CURSOR
)
23433 cursor_type
= HOLLOW_BOX_CURSOR
;
23434 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23436 return cursor_type
;
23439 /* Use normal cursor if not blinked off. */
23440 if (!w
->cursor_off_p
)
23442 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23444 if (cursor_type
== FILLED_BOX_CURSOR
)
23446 /* Using a block cursor on large images can be very annoying.
23447 So use a hollow cursor for "large" images.
23448 If image is not transparent (no mask), also use hollow cursor. */
23449 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23450 if (img
!= NULL
&& IMAGEP (img
->spec
))
23452 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23453 where N = size of default frame font size.
23454 This should cover most of the "tiny" icons people may use. */
23456 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23457 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23458 cursor_type
= HOLLOW_BOX_CURSOR
;
23461 else if (cursor_type
!= NO_CURSOR
)
23463 /* Display current only supports BOX and HOLLOW cursors for images.
23464 So for now, unconditionally use a HOLLOW cursor when cursor is
23465 not a solid box cursor. */
23466 cursor_type
= HOLLOW_BOX_CURSOR
;
23469 return cursor_type
;
23472 /* Cursor is blinked off, so determine how to "toggle" it. */
23474 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23475 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23476 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23478 /* Then see if frame has specified a specific blink off cursor type. */
23479 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23481 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23482 return FRAME_BLINK_OFF_CURSOR (f
);
23486 /* Some people liked having a permanently visible blinking cursor,
23487 while others had very strong opinions against it. So it was
23488 decided to remove it. KFS 2003-09-03 */
23490 /* Finally perform built-in cursor blinking:
23491 filled box <-> hollow box
23492 wide [h]bar <-> narrow [h]bar
23493 narrow [h]bar <-> no cursor
23494 other type <-> no cursor */
23496 if (cursor_type
== FILLED_BOX_CURSOR
)
23497 return HOLLOW_BOX_CURSOR
;
23499 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23502 return cursor_type
;
23510 /* Notice when the text cursor of window W has been completely
23511 overwritten by a drawing operation that outputs glyphs in AREA
23512 starting at X0 and ending at X1 in the line starting at Y0 and
23513 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23514 the rest of the line after X0 has been written. Y coordinates
23515 are window-relative. */
23518 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23519 int x0
, int x1
, int y0
, int y1
)
23521 int cx0
, cx1
, cy0
, cy1
;
23522 struct glyph_row
*row
;
23524 if (!w
->phys_cursor_on_p
)
23526 if (area
!= TEXT_AREA
)
23529 if (w
->phys_cursor
.vpos
< 0
23530 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23531 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23532 !(row
->enabled_p
&& row
->displays_text_p
)))
23535 if (row
->cursor_in_fringe_p
)
23537 row
->cursor_in_fringe_p
= 0;
23538 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23539 w
->phys_cursor_on_p
= 0;
23543 cx0
= w
->phys_cursor
.x
;
23544 cx1
= cx0
+ w
->phys_cursor_width
;
23545 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23548 /* The cursor image will be completely removed from the
23549 screen if the output area intersects the cursor area in
23550 y-direction. When we draw in [y0 y1[, and some part of
23551 the cursor is at y < y0, that part must have been drawn
23552 before. When scrolling, the cursor is erased before
23553 actually scrolling, so we don't come here. When not
23554 scrolling, the rows above the old cursor row must have
23555 changed, and in this case these rows must have written
23556 over the cursor image.
23558 Likewise if part of the cursor is below y1, with the
23559 exception of the cursor being in the first blank row at
23560 the buffer and window end because update_text_area
23561 doesn't draw that row. (Except when it does, but
23562 that's handled in update_text_area.) */
23564 cy0
= w
->phys_cursor
.y
;
23565 cy1
= cy0
+ w
->phys_cursor_height
;
23566 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23569 w
->phys_cursor_on_p
= 0;
23572 #endif /* HAVE_WINDOW_SYSTEM */
23575 /************************************************************************
23577 ************************************************************************/
23579 #ifdef HAVE_WINDOW_SYSTEM
23582 Fix the display of area AREA of overlapping row ROW in window W
23583 with respect to the overlapping part OVERLAPS. */
23586 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23587 enum glyph_row_area area
, int overlaps
)
23594 for (i
= 0; i
< row
->used
[area
];)
23596 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23598 int start
= i
, start_x
= x
;
23602 x
+= row
->glyphs
[area
][i
].pixel_width
;
23605 while (i
< row
->used
[area
]
23606 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23608 draw_glyphs (w
, start_x
, row
, area
,
23610 DRAW_NORMAL_TEXT
, overlaps
);
23614 x
+= row
->glyphs
[area
][i
].pixel_width
;
23624 Draw the cursor glyph of window W in glyph row ROW. See the
23625 comment of draw_glyphs for the meaning of HL. */
23628 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23629 enum draw_glyphs_face hl
)
23631 /* If cursor hpos is out of bounds, don't draw garbage. This can
23632 happen in mini-buffer windows when switching between echo area
23633 glyphs and mini-buffer. */
23634 if ((row
->reversed_p
23635 ? (w
->phys_cursor
.hpos
>= 0)
23636 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23638 int on_p
= w
->phys_cursor_on_p
;
23640 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23641 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23643 w
->phys_cursor_on_p
= on_p
;
23645 if (hl
== DRAW_CURSOR
)
23646 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23647 /* When we erase the cursor, and ROW is overlapped by other
23648 rows, make sure that these overlapping parts of other rows
23650 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23652 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23654 if (row
> w
->current_matrix
->rows
23655 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23656 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23657 OVERLAPS_ERASED_CURSOR
);
23659 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23660 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23661 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23662 OVERLAPS_ERASED_CURSOR
);
23669 Erase the image of a cursor of window W from the screen. */
23672 erase_phys_cursor (struct window
*w
)
23674 struct frame
*f
= XFRAME (w
->frame
);
23675 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23676 int hpos
= w
->phys_cursor
.hpos
;
23677 int vpos
= w
->phys_cursor
.vpos
;
23678 int mouse_face_here_p
= 0;
23679 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23680 struct glyph_row
*cursor_row
;
23681 struct glyph
*cursor_glyph
;
23682 enum draw_glyphs_face hl
;
23684 /* No cursor displayed or row invalidated => nothing to do on the
23686 if (w
->phys_cursor_type
== NO_CURSOR
)
23687 goto mark_cursor_off
;
23689 /* VPOS >= active_glyphs->nrows means that window has been resized.
23690 Don't bother to erase the cursor. */
23691 if (vpos
>= active_glyphs
->nrows
)
23692 goto mark_cursor_off
;
23694 /* If row containing cursor is marked invalid, there is nothing we
23696 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23697 if (!cursor_row
->enabled_p
)
23698 goto mark_cursor_off
;
23700 /* If line spacing is > 0, old cursor may only be partially visible in
23701 window after split-window. So adjust visible height. */
23702 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23703 window_text_bottom_y (w
) - cursor_row
->y
);
23705 /* If row is completely invisible, don't attempt to delete a cursor which
23706 isn't there. This can happen if cursor is at top of a window, and
23707 we switch to a buffer with a header line in that window. */
23708 if (cursor_row
->visible_height
<= 0)
23709 goto mark_cursor_off
;
23711 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23712 if (cursor_row
->cursor_in_fringe_p
)
23714 cursor_row
->cursor_in_fringe_p
= 0;
23715 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23716 goto mark_cursor_off
;
23719 /* This can happen when the new row is shorter than the old one.
23720 In this case, either draw_glyphs or clear_end_of_line
23721 should have cleared the cursor. Note that we wouldn't be
23722 able to erase the cursor in this case because we don't have a
23723 cursor glyph at hand. */
23724 if ((cursor_row
->reversed_p
23725 ? (w
->phys_cursor
.hpos
< 0)
23726 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23727 goto mark_cursor_off
;
23729 /* If the cursor is in the mouse face area, redisplay that when
23730 we clear the cursor. */
23731 if (! NILP (hlinfo
->mouse_face_window
)
23732 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23733 /* Don't redraw the cursor's spot in mouse face if it is at the
23734 end of a line (on a newline). The cursor appears there, but
23735 mouse highlighting does not. */
23736 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23737 mouse_face_here_p
= 1;
23739 /* Maybe clear the display under the cursor. */
23740 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23743 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23746 cursor_glyph
= get_phys_cursor_glyph (w
);
23747 if (cursor_glyph
== NULL
)
23748 goto mark_cursor_off
;
23750 width
= cursor_glyph
->pixel_width
;
23751 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23752 x
= w
->phys_cursor
.x
;
23754 width
-= left_x
- x
;
23755 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23756 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23757 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23760 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23763 /* Erase the cursor by redrawing the character underneath it. */
23764 if (mouse_face_here_p
)
23765 hl
= DRAW_MOUSE_FACE
;
23767 hl
= DRAW_NORMAL_TEXT
;
23768 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23771 w
->phys_cursor_on_p
= 0;
23772 w
->phys_cursor_type
= NO_CURSOR
;
23777 Display or clear cursor of window W. If ON is zero, clear the
23778 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23779 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23782 display_and_set_cursor (struct window
*w
, int on
,
23783 int hpos
, int vpos
, int x
, int y
)
23785 struct frame
*f
= XFRAME (w
->frame
);
23786 int new_cursor_type
;
23787 int new_cursor_width
;
23789 struct glyph_row
*glyph_row
;
23790 struct glyph
*glyph
;
23792 /* This is pointless on invisible frames, and dangerous on garbaged
23793 windows and frames; in the latter case, the frame or window may
23794 be in the midst of changing its size, and x and y may be off the
23796 if (! FRAME_VISIBLE_P (f
)
23797 || FRAME_GARBAGED_P (f
)
23798 || vpos
>= w
->current_matrix
->nrows
23799 || hpos
>= w
->current_matrix
->matrix_w
)
23802 /* If cursor is off and we want it off, return quickly. */
23803 if (!on
&& !w
->phys_cursor_on_p
)
23806 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23807 /* If cursor row is not enabled, we don't really know where to
23808 display the cursor. */
23809 if (!glyph_row
->enabled_p
)
23811 w
->phys_cursor_on_p
= 0;
23816 if (!glyph_row
->exact_window_width_line_p
23817 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23818 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23820 xassert (interrupt_input_blocked
);
23822 /* Set new_cursor_type to the cursor we want to be displayed. */
23823 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23824 &new_cursor_width
, &active_cursor
);
23826 /* If cursor is currently being shown and we don't want it to be or
23827 it is in the wrong place, or the cursor type is not what we want,
23829 if (w
->phys_cursor_on_p
23831 || w
->phys_cursor
.x
!= x
23832 || w
->phys_cursor
.y
!= y
23833 || new_cursor_type
!= w
->phys_cursor_type
23834 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23835 && new_cursor_width
!= w
->phys_cursor_width
)))
23836 erase_phys_cursor (w
);
23838 /* Don't check phys_cursor_on_p here because that flag is only set
23839 to zero in some cases where we know that the cursor has been
23840 completely erased, to avoid the extra work of erasing the cursor
23841 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23842 still not be visible, or it has only been partly erased. */
23845 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23846 w
->phys_cursor_height
= glyph_row
->height
;
23848 /* Set phys_cursor_.* before x_draw_.* is called because some
23849 of them may need the information. */
23850 w
->phys_cursor
.x
= x
;
23851 w
->phys_cursor
.y
= glyph_row
->y
;
23852 w
->phys_cursor
.hpos
= hpos
;
23853 w
->phys_cursor
.vpos
= vpos
;
23856 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23857 new_cursor_type
, new_cursor_width
,
23858 on
, active_cursor
);
23862 /* Switch the display of W's cursor on or off, according to the value
23866 update_window_cursor (struct window
*w
, int on
)
23868 /* Don't update cursor in windows whose frame is in the process
23869 of being deleted. */
23870 if (w
->current_matrix
)
23873 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23874 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23880 /* Call update_window_cursor with parameter ON_P on all leaf windows
23881 in the window tree rooted at W. */
23884 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23888 if (!NILP (w
->hchild
))
23889 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23890 else if (!NILP (w
->vchild
))
23891 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23893 update_window_cursor (w
, on_p
);
23895 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23901 Display the cursor on window W, or clear it, according to ON_P.
23902 Don't change the cursor's position. */
23905 x_update_cursor (struct frame
*f
, int on_p
)
23907 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23912 Clear the cursor of window W to background color, and mark the
23913 cursor as not shown. This is used when the text where the cursor
23914 is about to be rewritten. */
23917 x_clear_cursor (struct window
*w
)
23919 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23920 update_window_cursor (w
, 0);
23923 #endif /* HAVE_WINDOW_SYSTEM */
23925 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
23928 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
23929 int start_hpos
, int end_hpos
,
23930 enum draw_glyphs_face draw
)
23932 #ifdef HAVE_WINDOW_SYSTEM
23933 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
23935 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
23939 #if defined (HAVE_GPM) || defined (MSDOS)
23940 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
23945 Display the active region described by mouse_face_* according to DRAW. */
23948 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
23950 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
23951 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23953 if (/* If window is in the process of being destroyed, don't bother
23955 w
->current_matrix
!= NULL
23956 /* Don't update mouse highlight if hidden */
23957 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
23958 /* Recognize when we are called to operate on rows that don't exist
23959 anymore. This can happen when a window is split. */
23960 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23962 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23963 struct glyph_row
*row
, *first
, *last
;
23965 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23966 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23968 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23970 int start_hpos
, end_hpos
, start_x
;
23972 /* For all but the first row, the highlight starts at column 0. */
23975 /* R2L rows have BEG and END in reversed order, but the
23976 screen drawing geometry is always left to right. So
23977 we need to mirror the beginning and end of the
23978 highlighted area in R2L rows. */
23979 if (!row
->reversed_p
)
23981 start_hpos
= hlinfo
->mouse_face_beg_col
;
23982 start_x
= hlinfo
->mouse_face_beg_x
;
23984 else if (row
== last
)
23986 start_hpos
= hlinfo
->mouse_face_end_col
;
23987 start_x
= hlinfo
->mouse_face_end_x
;
23995 else if (row
->reversed_p
&& row
== last
)
23997 start_hpos
= hlinfo
->mouse_face_end_col
;
23998 start_x
= hlinfo
->mouse_face_end_x
;
24008 if (!row
->reversed_p
)
24009 end_hpos
= hlinfo
->mouse_face_end_col
;
24010 else if (row
== first
)
24011 end_hpos
= hlinfo
->mouse_face_beg_col
;
24014 end_hpos
= row
->used
[TEXT_AREA
];
24015 if (draw
== DRAW_NORMAL_TEXT
)
24016 row
->fill_line_p
= 1; /* Clear to end of line */
24019 else if (row
->reversed_p
&& row
== first
)
24020 end_hpos
= hlinfo
->mouse_face_beg_col
;
24023 end_hpos
= row
->used
[TEXT_AREA
];
24024 if (draw
== DRAW_NORMAL_TEXT
)
24025 row
->fill_line_p
= 1; /* Clear to end of line */
24028 if (end_hpos
> start_hpos
)
24030 draw_row_with_mouse_face (w
, start_x
, row
,
24031 start_hpos
, end_hpos
, draw
);
24034 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24038 #ifdef HAVE_WINDOW_SYSTEM
24039 /* When we've written over the cursor, arrange for it to
24040 be displayed again. */
24041 if (FRAME_WINDOW_P (f
)
24042 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24045 display_and_set_cursor (w
, 1,
24046 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24047 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24050 #endif /* HAVE_WINDOW_SYSTEM */
24053 #ifdef HAVE_WINDOW_SYSTEM
24054 /* Change the mouse cursor. */
24055 if (FRAME_WINDOW_P (f
))
24057 if (draw
== DRAW_NORMAL_TEXT
24058 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24059 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24060 else if (draw
== DRAW_MOUSE_FACE
)
24061 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24063 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24065 #endif /* HAVE_WINDOW_SYSTEM */
24069 Clear out the mouse-highlighted active region.
24070 Redraw it un-highlighted first. Value is non-zero if mouse
24071 face was actually drawn unhighlighted. */
24074 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24078 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24080 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24084 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24085 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24086 hlinfo
->mouse_face_window
= Qnil
;
24087 hlinfo
->mouse_face_overlay
= Qnil
;
24091 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24092 within the mouse face on that window. */
24094 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24096 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24098 /* Quickly resolve the easy cases. */
24099 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24100 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24102 if (vpos
< hlinfo
->mouse_face_beg_row
24103 || vpos
> hlinfo
->mouse_face_end_row
)
24105 if (vpos
> hlinfo
->mouse_face_beg_row
24106 && vpos
< hlinfo
->mouse_face_end_row
)
24109 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24111 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24113 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24116 else if ((vpos
== hlinfo
->mouse_face_beg_row
24117 && hpos
>= hlinfo
->mouse_face_beg_col
)
24118 || (vpos
== hlinfo
->mouse_face_end_row
24119 && hpos
< hlinfo
->mouse_face_end_col
))
24124 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24126 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24129 else if ((vpos
== hlinfo
->mouse_face_beg_row
24130 && hpos
<= hlinfo
->mouse_face_beg_col
)
24131 || (vpos
== hlinfo
->mouse_face_end_row
24132 && hpos
> hlinfo
->mouse_face_end_col
))
24140 Non-zero if physical cursor of window W is within mouse face. */
24143 cursor_in_mouse_face_p (struct window
*w
)
24145 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24150 /* Find the glyph rows START_ROW and END_ROW of window W that display
24151 characters between buffer positions START_CHARPOS and END_CHARPOS
24152 (excluding END_CHARPOS). This is similar to row_containing_pos,
24153 but is more accurate when bidi reordering makes buffer positions
24154 change non-linearly with glyph rows. */
24156 rows_from_pos_range (struct window
*w
,
24157 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24158 struct glyph_row
**start
, struct glyph_row
**end
)
24160 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24161 int last_y
= window_text_bottom_y (w
);
24162 struct glyph_row
*row
;
24167 while (!first
->enabled_p
24168 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24171 /* Find the START row. */
24173 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24176 /* A row can potentially be the START row if the range of the
24177 characters it displays intersects the range
24178 [START_CHARPOS..END_CHARPOS). */
24179 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24180 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24181 /* See the commentary in row_containing_pos, for the
24182 explanation of the complicated way to check whether
24183 some position is beyond the end of the characters
24184 displayed by a row. */
24185 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24186 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24187 && !row
->ends_at_zv_p
24188 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24189 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24190 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24191 && !row
->ends_at_zv_p
24192 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24194 /* Found a candidate row. Now make sure at least one of the
24195 glyphs it displays has a charpos from the range
24196 [START_CHARPOS..END_CHARPOS).
24198 This is not obvious because bidi reordering could make
24199 buffer positions of a row be 1,2,3,102,101,100, and if we
24200 want to highlight characters in [50..60), we don't want
24201 this row, even though [50..60) does intersect [1..103),
24202 the range of character positions given by the row's start
24203 and end positions. */
24204 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24205 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24209 if (BUFFERP (g
->object
)
24210 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24219 /* Find the END row. */
24221 /* If the last row is partially visible, start looking for END
24222 from that row, instead of starting from FIRST. */
24223 && !(row
->enabled_p
24224 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24226 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24228 struct glyph_row
*next
= row
+ 1;
24230 if (!next
->enabled_p
24231 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24232 /* The first row >= START whose range of displayed characters
24233 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24234 is the row END + 1. */
24235 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24236 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24237 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24238 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24239 && !next
->ends_at_zv_p
24240 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24241 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24242 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24243 && !next
->ends_at_zv_p
24244 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24251 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24252 but none of the characters it displays are in the range, it is
24254 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24255 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24259 if (BUFFERP (g
->object
)
24260 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24273 /* This function sets the mouse_face_* elements of HLINFO, assuming
24274 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24275 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24276 for the overlay or run of text properties specifying the mouse
24277 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24278 before-string and after-string that must also be highlighted.
24279 COVER_STRING, if non-nil, is a display string that may cover some
24280 or all of the highlighted text. */
24283 mouse_face_from_buffer_pos (Lisp_Object window
,
24284 Mouse_HLInfo
*hlinfo
,
24285 EMACS_INT mouse_charpos
,
24286 EMACS_INT start_charpos
,
24287 EMACS_INT end_charpos
,
24288 Lisp_Object before_string
,
24289 Lisp_Object after_string
,
24290 Lisp_Object cover_string
)
24292 struct window
*w
= XWINDOW (window
);
24293 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24294 struct glyph_row
*r1
, *r2
;
24295 struct glyph
*glyph
, *end
;
24296 EMACS_INT ignore
, pos
;
24299 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24300 xassert (NILP (before_string
) || STRINGP (before_string
));
24301 xassert (NILP (after_string
) || STRINGP (after_string
));
24303 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24304 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24306 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24307 /* If the before-string or display-string contains newlines,
24308 rows_from_pos_range skips to its last row. Move back. */
24309 if (!NILP (before_string
) || !NILP (cover_string
))
24311 struct glyph_row
*prev
;
24312 while ((prev
= r1
- 1, prev
>= first
)
24313 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24314 && prev
->used
[TEXT_AREA
] > 0)
24316 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24317 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24318 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24320 || !(EQ (glyph
->object
, before_string
)
24321 || EQ (glyph
->object
, cover_string
)))
24328 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24329 hlinfo
->mouse_face_past_end
= 1;
24331 else if (!NILP (after_string
))
24333 /* If the after-string has newlines, advance to its last row. */
24334 struct glyph_row
*next
;
24335 struct glyph_row
*last
24336 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24338 for (next
= r2
+ 1;
24340 && next
->used
[TEXT_AREA
] > 0
24341 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24345 /* The rest of the display engine assumes that mouse_face_beg_row is
24346 either above below mouse_face_end_row or identical to it. But
24347 with bidi-reordered continued lines, the row for START_CHARPOS
24348 could be below the row for END_CHARPOS. If so, swap the rows and
24349 store them in correct order. */
24352 struct glyph_row
*tem
= r2
;
24358 hlinfo
->mouse_face_beg_y
= r1
->y
;
24359 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24360 hlinfo
->mouse_face_end_y
= r2
->y
;
24361 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24363 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24364 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24365 could be anywhere in the row and in any order. The strategy
24366 below is to find the leftmost and the rightmost glyph that
24367 belongs to either of these 3 strings, or whose position is
24368 between START_CHARPOS and END_CHARPOS, and highlight all the
24369 glyphs between those two. This may cover more than just the text
24370 between START_CHARPOS and END_CHARPOS if the range of characters
24371 strides the bidi level boundary, e.g. if the beginning is in R2L
24372 text while the end is in L2R text or vice versa. */
24373 if (!r1
->reversed_p
)
24375 /* This row is in a left to right paragraph. Scan it left to
24377 glyph
= r1
->glyphs
[TEXT_AREA
];
24378 end
= glyph
+ r1
->used
[TEXT_AREA
];
24381 /* Skip truncation glyphs at the start of the glyph row. */
24382 if (r1
->displays_text_p
)
24384 && INTEGERP (glyph
->object
)
24385 && glyph
->charpos
< 0;
24387 x
+= glyph
->pixel_width
;
24389 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24390 or COVER_STRING, and the first glyph from buffer whose
24391 position is between START_CHARPOS and END_CHARPOS. */
24393 && !INTEGERP (glyph
->object
)
24394 && !EQ (glyph
->object
, cover_string
)
24395 && !(BUFFERP (glyph
->object
)
24396 && (glyph
->charpos
>= start_charpos
24397 && glyph
->charpos
< end_charpos
));
24400 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24401 are present at buffer positions between START_CHARPOS and
24402 END_CHARPOS, or if they come from an overlay. */
24403 if (EQ (glyph
->object
, before_string
))
24405 pos
= string_buffer_position (before_string
,
24407 /* If pos == 0, it means before_string came from an
24408 overlay, not from a buffer position. */
24409 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24412 else if (EQ (glyph
->object
, after_string
))
24414 pos
= string_buffer_position (after_string
, end_charpos
);
24415 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24418 x
+= glyph
->pixel_width
;
24420 hlinfo
->mouse_face_beg_x
= x
;
24421 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24425 /* This row is in a right to left paragraph. Scan it right to
24429 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24430 glyph
= end
+ r1
->used
[TEXT_AREA
];
24432 /* Skip truncation glyphs at the start of the glyph row. */
24433 if (r1
->displays_text_p
)
24435 && INTEGERP (glyph
->object
)
24436 && glyph
->charpos
< 0;
24440 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24441 or COVER_STRING, and the first glyph from buffer whose
24442 position is between START_CHARPOS and END_CHARPOS. */
24444 && !INTEGERP (glyph
->object
)
24445 && !EQ (glyph
->object
, cover_string
)
24446 && !(BUFFERP (glyph
->object
)
24447 && (glyph
->charpos
>= start_charpos
24448 && glyph
->charpos
< end_charpos
));
24451 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24452 are present at buffer positions between START_CHARPOS and
24453 END_CHARPOS, or if they come from an overlay. */
24454 if (EQ (glyph
->object
, before_string
))
24456 pos
= string_buffer_position (before_string
, start_charpos
);
24457 /* If pos == 0, it means before_string came from an
24458 overlay, not from a buffer position. */
24459 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24462 else if (EQ (glyph
->object
, after_string
))
24464 pos
= string_buffer_position (after_string
, end_charpos
);
24465 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24470 glyph
++; /* first glyph to the right of the highlighted area */
24471 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24472 x
+= g
->pixel_width
;
24473 hlinfo
->mouse_face_beg_x
= x
;
24474 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24477 /* If the highlight ends in a different row, compute GLYPH and END
24478 for the end row. Otherwise, reuse the values computed above for
24479 the row where the highlight begins. */
24482 if (!r2
->reversed_p
)
24484 glyph
= r2
->glyphs
[TEXT_AREA
];
24485 end
= glyph
+ r2
->used
[TEXT_AREA
];
24490 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24491 glyph
= end
+ r2
->used
[TEXT_AREA
];
24495 if (!r2
->reversed_p
)
24497 /* Skip truncation and continuation glyphs near the end of the
24498 row, and also blanks and stretch glyphs inserted by
24499 extend_face_to_end_of_line. */
24501 && INTEGERP ((end
- 1)->object
)
24502 && (end
- 1)->charpos
<= 0)
24504 /* Scan the rest of the glyph row from the end, looking for the
24505 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24506 COVER_STRING, or whose position is between START_CHARPOS
24510 && !INTEGERP (end
->object
)
24511 && !EQ (end
->object
, cover_string
)
24512 && !(BUFFERP (end
->object
)
24513 && (end
->charpos
>= start_charpos
24514 && end
->charpos
< end_charpos
));
24517 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24518 are present at buffer positions between START_CHARPOS and
24519 END_CHARPOS, or if they come from an overlay. */
24520 if (EQ (end
->object
, before_string
))
24522 pos
= string_buffer_position (before_string
, start_charpos
);
24523 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24526 else if (EQ (end
->object
, after_string
))
24528 pos
= string_buffer_position (after_string
, end_charpos
);
24529 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24533 /* Find the X coordinate of the last glyph to be highlighted. */
24534 for (; glyph
<= end
; ++glyph
)
24535 x
+= glyph
->pixel_width
;
24537 hlinfo
->mouse_face_end_x
= x
;
24538 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24542 /* Skip truncation and continuation glyphs near the end of the
24543 row, and also blanks and stretch glyphs inserted by
24544 extend_face_to_end_of_line. */
24548 && INTEGERP (end
->object
)
24549 && end
->charpos
<= 0)
24551 x
+= end
->pixel_width
;
24554 /* Scan the rest of the glyph row from the end, looking for the
24555 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24556 COVER_STRING, or whose position is between START_CHARPOS
24560 && !INTEGERP (end
->object
)
24561 && !EQ (end
->object
, cover_string
)
24562 && !(BUFFERP (end
->object
)
24563 && (end
->charpos
>= start_charpos
24564 && end
->charpos
< end_charpos
));
24567 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24568 are present at buffer positions between START_CHARPOS and
24569 END_CHARPOS, or if they come from an overlay. */
24570 if (EQ (end
->object
, before_string
))
24572 pos
= string_buffer_position (before_string
, start_charpos
);
24573 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24576 else if (EQ (end
->object
, after_string
))
24578 pos
= string_buffer_position (after_string
, end_charpos
);
24579 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24582 x
+= end
->pixel_width
;
24584 hlinfo
->mouse_face_end_x
= x
;
24585 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24588 hlinfo
->mouse_face_window
= window
;
24589 hlinfo
->mouse_face_face_id
24590 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24592 !hlinfo
->mouse_face_hidden
, -1);
24593 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24596 /* The following function is not used anymore (replaced with
24597 mouse_face_from_string_pos), but I leave it here for the time
24598 being, in case someone would. */
24600 #if 0 /* not used */
24602 /* Find the position of the glyph for position POS in OBJECT in
24603 window W's current matrix, and return in *X, *Y the pixel
24604 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24606 RIGHT_P non-zero means return the position of the right edge of the
24607 glyph, RIGHT_P zero means return the left edge position.
24609 If no glyph for POS exists in the matrix, return the position of
24610 the glyph with the next smaller position that is in the matrix, if
24611 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24612 exists in the matrix, return the position of the glyph with the
24613 next larger position in OBJECT.
24615 Value is non-zero if a glyph was found. */
24618 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24619 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24621 int yb
= window_text_bottom_y (w
);
24622 struct glyph_row
*r
;
24623 struct glyph
*best_glyph
= NULL
;
24624 struct glyph_row
*best_row
= NULL
;
24627 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24628 r
->enabled_p
&& r
->y
< yb
;
24631 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24632 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24635 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24636 if (EQ (g
->object
, object
))
24638 if (g
->charpos
== pos
)
24645 else if (best_glyph
== NULL
24646 || ((eabs (g
->charpos
- pos
)
24647 < eabs (best_glyph
->charpos
- pos
))
24650 : g
->charpos
> pos
)))
24664 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24668 *x
+= best_glyph
->pixel_width
;
24673 *vpos
= best_row
- w
->current_matrix
->rows
;
24676 return best_glyph
!= NULL
;
24678 #endif /* not used */
24680 /* Find the positions of the first and the last glyphs in window W's
24681 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24682 (assumed to be a string), and return in HLINFO's mouse_face_*
24683 members the pixel and column/row coordinates of those glyphs. */
24686 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24687 Lisp_Object object
,
24688 EMACS_INT startpos
, EMACS_INT endpos
)
24690 int yb
= window_text_bottom_y (w
);
24691 struct glyph_row
*r
;
24692 struct glyph
*g
, *e
;
24696 /* Find the glyph row with at least one position in the range
24697 [STARTPOS..ENDPOS], and the first glyph in that row whose
24698 position belongs to that range. */
24699 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24700 r
->enabled_p
&& r
->y
< yb
;
24703 if (!r
->reversed_p
)
24705 g
= r
->glyphs
[TEXT_AREA
];
24706 e
= g
+ r
->used
[TEXT_AREA
];
24707 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24708 if (EQ (g
->object
, object
)
24709 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24711 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24712 hlinfo
->mouse_face_beg_y
= r
->y
;
24713 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24714 hlinfo
->mouse_face_beg_x
= gx
;
24723 e
= r
->glyphs
[TEXT_AREA
];
24724 g
= e
+ r
->used
[TEXT_AREA
];
24725 for ( ; g
> e
; --g
)
24726 if (EQ ((g
-1)->object
, object
)
24727 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24729 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24730 hlinfo
->mouse_face_beg_y
= r
->y
;
24731 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24732 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24733 gx
+= g1
->pixel_width
;
24734 hlinfo
->mouse_face_beg_x
= gx
;
24746 /* Starting with the next row, look for the first row which does NOT
24747 include any glyphs whose positions are in the range. */
24748 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24750 g
= r
->glyphs
[TEXT_AREA
];
24751 e
= g
+ r
->used
[TEXT_AREA
];
24753 for ( ; g
< e
; ++g
)
24754 if (EQ (g
->object
, object
)
24755 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24764 /* The highlighted region ends on the previous row. */
24767 /* Set the end row and its vertical pixel coordinate. */
24768 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24769 hlinfo
->mouse_face_end_y
= r
->y
;
24771 /* Compute and set the end column and the end column's horizontal
24772 pixel coordinate. */
24773 if (!r
->reversed_p
)
24775 g
= r
->glyphs
[TEXT_AREA
];
24776 e
= g
+ r
->used
[TEXT_AREA
];
24777 for ( ; e
> g
; --e
)
24778 if (EQ ((e
-1)->object
, object
)
24779 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24781 hlinfo
->mouse_face_end_col
= e
- g
;
24783 for (gx
= r
->x
; g
< e
; ++g
)
24784 gx
+= g
->pixel_width
;
24785 hlinfo
->mouse_face_end_x
= gx
;
24789 e
= r
->glyphs
[TEXT_AREA
];
24790 g
= e
+ r
->used
[TEXT_AREA
];
24791 for (gx
= r
->x
; e
< g
; ++e
)
24793 if (EQ (e
->object
, object
)
24794 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24796 gx
+= e
->pixel_width
;
24798 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24799 hlinfo
->mouse_face_end_x
= gx
;
24803 #ifdef HAVE_WINDOW_SYSTEM
24805 /* See if position X, Y is within a hot-spot of an image. */
24808 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24810 if (!CONSP (hot_spot
))
24813 if (EQ (XCAR (hot_spot
), Qrect
))
24815 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24816 Lisp_Object rect
= XCDR (hot_spot
);
24820 if (!CONSP (XCAR (rect
)))
24822 if (!CONSP (XCDR (rect
)))
24824 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24826 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24828 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24830 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24834 else if (EQ (XCAR (hot_spot
), Qcircle
))
24836 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24837 Lisp_Object circ
= XCDR (hot_spot
);
24838 Lisp_Object lr
, lx0
, ly0
;
24840 && CONSP (XCAR (circ
))
24841 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24842 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24843 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24845 double r
= XFLOATINT (lr
);
24846 double dx
= XINT (lx0
) - x
;
24847 double dy
= XINT (ly0
) - y
;
24848 return (dx
* dx
+ dy
* dy
<= r
* r
);
24851 else if (EQ (XCAR (hot_spot
), Qpoly
))
24853 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24854 if (VECTORP (XCDR (hot_spot
)))
24856 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24857 Lisp_Object
*poly
= v
->contents
;
24861 Lisp_Object lx
, ly
;
24864 /* Need an even number of coordinates, and at least 3 edges. */
24865 if (n
< 6 || n
& 1)
24868 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24869 If count is odd, we are inside polygon. Pixels on edges
24870 may or may not be included depending on actual geometry of the
24872 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24873 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24875 x0
= XINT (lx
), y0
= XINT (ly
);
24876 for (i
= 0; i
< n
; i
+= 2)
24878 int x1
= x0
, y1
= y0
;
24879 if ((lx
= poly
[i
], !INTEGERP (lx
))
24880 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24882 x0
= XINT (lx
), y0
= XINT (ly
);
24884 /* Does this segment cross the X line? */
24892 if (y
> y0
&& y
> y1
)
24894 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24904 find_hot_spot (Lisp_Object map
, int x
, int y
)
24906 while (CONSP (map
))
24908 if (CONSP (XCAR (map
))
24909 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24917 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24919 doc
: /* Lookup in image map MAP coordinates X and Y.
24920 An image map is an alist where each element has the format (AREA ID PLIST).
24921 An AREA is specified as either a rectangle, a circle, or a polygon:
24922 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24923 pixel coordinates of the upper left and bottom right corners.
24924 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24925 and the radius of the circle; r may be a float or integer.
24926 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24927 vector describes one corner in the polygon.
24928 Returns the alist element for the first matching AREA in MAP. */)
24929 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24937 return find_hot_spot (map
, XINT (x
), XINT (y
));
24941 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24943 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24945 /* Do not change cursor shape while dragging mouse. */
24946 if (!NILP (do_mouse_tracking
))
24949 if (!NILP (pointer
))
24951 if (EQ (pointer
, Qarrow
))
24952 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24953 else if (EQ (pointer
, Qhand
))
24954 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24955 else if (EQ (pointer
, Qtext
))
24956 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24957 else if (EQ (pointer
, intern ("hdrag")))
24958 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24959 #ifdef HAVE_X_WINDOWS
24960 else if (EQ (pointer
, intern ("vdrag")))
24961 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24963 else if (EQ (pointer
, intern ("hourglass")))
24964 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24965 else if (EQ (pointer
, Qmodeline
))
24966 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24968 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24971 if (cursor
!= No_Cursor
)
24972 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24975 #endif /* HAVE_WINDOW_SYSTEM */
24977 /* Take proper action when mouse has moved to the mode or header line
24978 or marginal area AREA of window W, x-position X and y-position Y.
24979 X is relative to the start of the text display area of W, so the
24980 width of bitmap areas and scroll bars must be subtracted to get a
24981 position relative to the start of the mode line. */
24984 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24985 enum window_part area
)
24987 struct window
*w
= XWINDOW (window
);
24988 struct frame
*f
= XFRAME (w
->frame
);
24989 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24990 #ifdef HAVE_WINDOW_SYSTEM
24991 Display_Info
*dpyinfo
;
24993 Cursor cursor
= No_Cursor
;
24994 Lisp_Object pointer
= Qnil
;
24995 int dx
, dy
, width
, height
;
24997 Lisp_Object string
, object
= Qnil
;
24998 Lisp_Object pos
, help
;
25000 Lisp_Object mouse_face
;
25001 int original_x_pixel
= x
;
25002 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25003 struct glyph_row
*row
;
25005 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25010 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25011 returns them in row/column units! */
25012 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25013 &object
, &dx
, &dy
, &width
, &height
);
25015 row
= (area
== ON_MODE_LINE
25016 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25017 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25019 /* Find the glyph under the mouse pointer. */
25020 if (row
->mode_line_p
&& row
->enabled_p
)
25022 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25023 end
= glyph
+ row
->used
[TEXT_AREA
];
25025 for (x0
= original_x_pixel
;
25026 glyph
< end
&& x0
>= glyph
->pixel_width
;
25028 x0
-= glyph
->pixel_width
;
25036 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25037 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25038 returns them in row/column units! */
25039 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25040 &object
, &dx
, &dy
, &width
, &height
);
25045 #ifdef HAVE_WINDOW_SYSTEM
25046 if (IMAGEP (object
))
25048 Lisp_Object image_map
, hotspot
;
25049 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25051 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25053 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25057 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25058 If so, we could look for mouse-enter, mouse-leave
25059 properties in PLIST (and do something...). */
25060 hotspot
= XCDR (hotspot
);
25061 if (CONSP (hotspot
)
25062 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25064 pointer
= Fplist_get (plist
, Qpointer
);
25065 if (NILP (pointer
))
25067 help
= Fplist_get (plist
, Qhelp_echo
);
25070 help_echo_string
= help
;
25071 /* Is this correct? ++kfs */
25072 XSETWINDOW (help_echo_window
, w
);
25073 help_echo_object
= w
->buffer
;
25074 help_echo_pos
= charpos
;
25078 if (NILP (pointer
))
25079 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25081 #endif /* HAVE_WINDOW_SYSTEM */
25083 if (STRINGP (string
))
25085 pos
= make_number (charpos
);
25086 /* If we're on a string with `help-echo' text property, arrange
25087 for the help to be displayed. This is done by setting the
25088 global variable help_echo_string to the help string. */
25091 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25094 help_echo_string
= help
;
25095 XSETWINDOW (help_echo_window
, w
);
25096 help_echo_object
= string
;
25097 help_echo_pos
= charpos
;
25101 #ifdef HAVE_WINDOW_SYSTEM
25102 if (FRAME_WINDOW_P (f
))
25104 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25105 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25106 if (NILP (pointer
))
25107 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25109 /* Change the mouse pointer according to what is under X/Y. */
25111 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25114 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25115 if (!KEYMAPP (map
))
25116 map
= Fget_text_property (pos
, Qkeymap
, string
);
25117 if (!KEYMAPP (map
))
25118 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25123 /* Change the mouse face according to what is under X/Y. */
25124 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25125 if (!NILP (mouse_face
)
25126 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25131 struct glyph
* tmp_glyph
;
25135 int total_pixel_width
;
25136 EMACS_INT begpos
, endpos
, ignore
;
25140 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25141 Qmouse_face
, string
, Qnil
);
25147 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25149 endpos
= SCHARS (string
);
25153 /* Calculate the glyph position GPOS of GLYPH in the
25154 displayed string, relative to the beginning of the
25155 highlighted part of the string.
25157 Note: GPOS is different from CHARPOS. CHARPOS is the
25158 position of GLYPH in the internal string object. A mode
25159 line string format has structures which are converted to
25160 a flattened string by the Emacs Lisp interpreter. The
25161 internal string is an element of those structures. The
25162 displayed string is the flattened string. */
25163 tmp_glyph
= row_start_glyph
;
25164 while (tmp_glyph
< glyph
25165 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25166 && begpos
<= tmp_glyph
->charpos
25167 && tmp_glyph
->charpos
< endpos
)))
25169 gpos
= glyph
- tmp_glyph
;
25171 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25172 the highlighted part of the displayed string to which
25173 GLYPH belongs. Note: GSEQ_LENGTH is different from
25174 SCHARS (STRING), because the latter returns the length of
25175 the internal string. */
25176 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25178 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25179 && begpos
<= tmp_glyph
->charpos
25180 && tmp_glyph
->charpos
< endpos
));
25183 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25185 /* Calculate the total pixel width of all the glyphs between
25186 the beginning of the highlighted area and GLYPH. */
25187 total_pixel_width
= 0;
25188 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25189 total_pixel_width
+= tmp_glyph
->pixel_width
;
25191 /* Pre calculation of re-rendering position. Note: X is in
25192 column units here, after the call to mode_line_string or
25193 marginal_area_string. */
25195 vpos
= (area
== ON_MODE_LINE
25196 ? (w
->current_matrix
)->nrows
- 1
25199 /* If GLYPH's position is included in the region that is
25200 already drawn in mouse face, we have nothing to do. */
25201 if ( EQ (window
, hlinfo
->mouse_face_window
)
25202 && (!row
->reversed_p
25203 ? (hlinfo
->mouse_face_beg_col
<= hpos
25204 && hpos
< hlinfo
->mouse_face_end_col
)
25205 /* In R2L rows we swap BEG and END, see below. */
25206 : (hlinfo
->mouse_face_end_col
<= hpos
25207 && hpos
< hlinfo
->mouse_face_beg_col
))
25208 && hlinfo
->mouse_face_beg_row
== vpos
)
25211 if (clear_mouse_face (hlinfo
))
25212 cursor
= No_Cursor
;
25214 if (!row
->reversed_p
)
25216 hlinfo
->mouse_face_beg_col
= hpos
;
25217 hlinfo
->mouse_face_beg_x
= original_x_pixel
25218 - (total_pixel_width
+ dx
);
25219 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25220 hlinfo
->mouse_face_end_x
= 0;
25224 /* In R2L rows, show_mouse_face expects BEG and END
25225 coordinates to be swapped. */
25226 hlinfo
->mouse_face_end_col
= hpos
;
25227 hlinfo
->mouse_face_end_x
= original_x_pixel
25228 - (total_pixel_width
+ dx
);
25229 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25230 hlinfo
->mouse_face_beg_x
= 0;
25233 hlinfo
->mouse_face_beg_row
= vpos
;
25234 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25235 hlinfo
->mouse_face_beg_y
= 0;
25236 hlinfo
->mouse_face_end_y
= 0;
25237 hlinfo
->mouse_face_past_end
= 0;
25238 hlinfo
->mouse_face_window
= window
;
25240 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25246 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25248 if (NILP (pointer
))
25251 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25252 clear_mouse_face (hlinfo
);
25254 #ifdef HAVE_WINDOW_SYSTEM
25255 if (FRAME_WINDOW_P (f
))
25256 define_frame_cursor1 (f
, cursor
, pointer
);
25262 Take proper action when the mouse has moved to position X, Y on
25263 frame F as regards highlighting characters that have mouse-face
25264 properties. Also de-highlighting chars where the mouse was before.
25265 X and Y can be negative or out of range. */
25268 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25270 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25271 enum window_part part
;
25272 Lisp_Object window
;
25274 Cursor cursor
= No_Cursor
;
25275 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25278 /* When a menu is active, don't highlight because this looks odd. */
25279 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25280 if (popup_activated ())
25284 if (NILP (Vmouse_highlight
)
25285 || !f
->glyphs_initialized_p
25286 || f
->pointer_invisible
)
25289 hlinfo
->mouse_face_mouse_x
= x
;
25290 hlinfo
->mouse_face_mouse_y
= y
;
25291 hlinfo
->mouse_face_mouse_frame
= f
;
25293 if (hlinfo
->mouse_face_defer
)
25296 if (gc_in_progress
)
25298 hlinfo
->mouse_face_deferred_gc
= 1;
25302 /* Which window is that in? */
25303 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25305 /* If we were displaying active text in another window, clear that.
25306 Also clear if we move out of text area in same window. */
25307 if (! EQ (window
, hlinfo
->mouse_face_window
)
25308 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25309 && !NILP (hlinfo
->mouse_face_window
)))
25310 clear_mouse_face (hlinfo
);
25312 /* Not on a window -> return. */
25313 if (!WINDOWP (window
))
25316 /* Reset help_echo_string. It will get recomputed below. */
25317 help_echo_string
= Qnil
;
25319 /* Convert to window-relative pixel coordinates. */
25320 w
= XWINDOW (window
);
25321 frame_to_window_pixel_xy (w
, &x
, &y
);
25323 #ifdef HAVE_WINDOW_SYSTEM
25324 /* Handle tool-bar window differently since it doesn't display a
25326 if (EQ (window
, f
->tool_bar_window
))
25328 note_tool_bar_highlight (f
, x
, y
);
25333 /* Mouse is on the mode, header line or margin? */
25334 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25335 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25337 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25341 #ifdef HAVE_WINDOW_SYSTEM
25342 if (part
== ON_VERTICAL_BORDER
)
25344 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25345 help_echo_string
= build_string ("drag-mouse-1: resize");
25347 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25348 || part
== ON_SCROLL_BAR
)
25349 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25351 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25354 /* Are we in a window whose display is up to date?
25355 And verify the buffer's text has not changed. */
25356 b
= XBUFFER (w
->buffer
);
25357 if (part
== ON_TEXT
25358 && EQ (w
->window_end_valid
, w
->buffer
)
25359 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25360 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25362 int hpos
, vpos
, i
, dx
, dy
, area
;
25364 struct glyph
*glyph
;
25365 Lisp_Object object
;
25366 Lisp_Object mouse_face
= Qnil
, position
;
25367 Lisp_Object
*overlay_vec
= NULL
;
25369 struct buffer
*obuf
;
25370 EMACS_INT obegv
, ozv
;
25373 /* Find the glyph under X/Y. */
25374 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25376 #ifdef HAVE_WINDOW_SYSTEM
25377 /* Look for :pointer property on image. */
25378 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25380 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25381 if (img
!= NULL
&& IMAGEP (img
->spec
))
25383 Lisp_Object image_map
, hotspot
;
25384 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25386 && (hotspot
= find_hot_spot (image_map
,
25387 glyph
->slice
.img
.x
+ dx
,
25388 glyph
->slice
.img
.y
+ dy
),
25390 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25394 /* Could check XCAR (hotspot) to see if we enter/leave
25396 If so, we could look for mouse-enter, mouse-leave
25397 properties in PLIST (and do something...). */
25398 hotspot
= XCDR (hotspot
);
25399 if (CONSP (hotspot
)
25400 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25402 pointer
= Fplist_get (plist
, Qpointer
);
25403 if (NILP (pointer
))
25405 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25406 if (!NILP (help_echo_string
))
25408 help_echo_window
= window
;
25409 help_echo_object
= glyph
->object
;
25410 help_echo_pos
= glyph
->charpos
;
25414 if (NILP (pointer
))
25415 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25418 #endif /* HAVE_WINDOW_SYSTEM */
25420 /* Clear mouse face if X/Y not over text. */
25422 || area
!= TEXT_AREA
25423 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25424 /* Glyph's OBJECT is an integer for glyphs inserted by the
25425 display engine for its internal purposes, like truncation
25426 and continuation glyphs and blanks beyond the end of
25427 line's text on text terminals. If we are over such a
25428 glyph, we are not over any text. */
25429 || INTEGERP (glyph
->object
)
25430 /* R2L rows have a stretch glyph at their front, which
25431 stands for no text, whereas L2R rows have no glyphs at
25432 all beyond the end of text. Treat such stretch glyphs
25433 like we do with NULL glyphs in L2R rows. */
25434 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25435 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25436 && glyph
->type
== STRETCH_GLYPH
25437 && glyph
->avoid_cursor_p
))
25439 if (clear_mouse_face (hlinfo
))
25440 cursor
= No_Cursor
;
25441 #ifdef HAVE_WINDOW_SYSTEM
25442 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25444 if (area
!= TEXT_AREA
)
25445 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25447 pointer
= Vvoid_text_area_pointer
;
25453 pos
= glyph
->charpos
;
25454 object
= glyph
->object
;
25455 if (!STRINGP (object
) && !BUFFERP (object
))
25458 /* If we get an out-of-range value, return now; avoid an error. */
25459 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25462 /* Make the window's buffer temporarily current for
25463 overlays_at and compute_char_face. */
25464 obuf
= current_buffer
;
25465 current_buffer
= b
;
25471 /* Is this char mouse-active or does it have help-echo? */
25472 position
= make_number (pos
);
25474 if (BUFFERP (object
))
25476 /* Put all the overlays we want in a vector in overlay_vec. */
25477 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25478 /* Sort overlays into increasing priority order. */
25479 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25484 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25487 cursor
= No_Cursor
;
25489 /* Check mouse-face highlighting. */
25491 /* If there exists an overlay with mouse-face overlapping
25492 the one we are currently highlighting, we have to
25493 check if we enter the overlapping overlay, and then
25494 highlight only that. */
25495 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25496 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25498 /* Find the highest priority overlay with a mouse-face. */
25499 Lisp_Object overlay
= Qnil
;
25500 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25502 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25503 if (!NILP (mouse_face
))
25504 overlay
= overlay_vec
[i
];
25507 /* If we're highlighting the same overlay as before, there's
25508 no need to do that again. */
25509 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25510 goto check_help_echo
;
25511 hlinfo
->mouse_face_overlay
= overlay
;
25513 /* Clear the display of the old active region, if any. */
25514 if (clear_mouse_face (hlinfo
))
25515 cursor
= No_Cursor
;
25517 /* If no overlay applies, get a text property. */
25518 if (NILP (overlay
))
25519 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25521 /* Next, compute the bounds of the mouse highlighting and
25523 if (!NILP (mouse_face
) && STRINGP (object
))
25525 /* The mouse-highlighting comes from a display string
25526 with a mouse-face. */
25530 s
= Fprevious_single_property_change
25531 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25532 e
= Fnext_single_property_change
25533 (position
, Qmouse_face
, object
, Qnil
);
25535 s
= make_number (0);
25537 e
= make_number (SCHARS (object
) - 1);
25538 mouse_face_from_string_pos (w
, hlinfo
, object
,
25539 XINT (s
), XINT (e
));
25540 hlinfo
->mouse_face_past_end
= 0;
25541 hlinfo
->mouse_face_window
= window
;
25542 hlinfo
->mouse_face_face_id
25543 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25544 glyph
->face_id
, 1);
25545 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25546 cursor
= No_Cursor
;
25550 /* The mouse-highlighting, if any, comes from an overlay
25551 or text property in the buffer. */
25552 Lisp_Object buffer
IF_LINT (= Qnil
);
25553 Lisp_Object cover_string
IF_LINT (= Qnil
);
25555 if (STRINGP (object
))
25557 /* If we are on a display string with no mouse-face,
25558 check if the text under it has one. */
25559 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25560 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25561 pos
= string_buffer_position (object
, start
);
25564 mouse_face
= get_char_property_and_overlay
25565 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25566 buffer
= w
->buffer
;
25567 cover_string
= object
;
25573 cover_string
= Qnil
;
25576 if (!NILP (mouse_face
))
25578 Lisp_Object before
, after
;
25579 Lisp_Object before_string
, after_string
;
25580 /* To correctly find the limits of mouse highlight
25581 in a bidi-reordered buffer, we must not use the
25582 optimization of limiting the search in
25583 previous-single-property-change and
25584 next-single-property-change, because
25585 rows_from_pos_range needs the real start and end
25586 positions to DTRT in this case. That's because
25587 the first row visible in a window does not
25588 necessarily display the character whose position
25589 is the smallest. */
25591 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25592 ? Fmarker_position (w
->start
)
25595 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25596 ? make_number (BUF_Z (XBUFFER (buffer
))
25597 - XFASTINT (w
->window_end_pos
))
25600 if (NILP (overlay
))
25602 /* Handle the text property case. */
25603 before
= Fprevious_single_property_change
25604 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25605 after
= Fnext_single_property_change
25606 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25607 before_string
= after_string
= Qnil
;
25611 /* Handle the overlay case. */
25612 before
= Foverlay_start (overlay
);
25613 after
= Foverlay_end (overlay
);
25614 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25615 after_string
= Foverlay_get (overlay
, Qafter_string
);
25617 if (!STRINGP (before_string
)) before_string
= Qnil
;
25618 if (!STRINGP (after_string
)) after_string
= Qnil
;
25621 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25624 before_string
, after_string
,
25626 cursor
= No_Cursor
;
25633 /* Look for a `help-echo' property. */
25634 if (NILP (help_echo_string
)) {
25635 Lisp_Object help
, overlay
;
25637 /* Check overlays first. */
25638 help
= overlay
= Qnil
;
25639 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25641 overlay
= overlay_vec
[i
];
25642 help
= Foverlay_get (overlay
, Qhelp_echo
);
25647 help_echo_string
= help
;
25648 help_echo_window
= window
;
25649 help_echo_object
= overlay
;
25650 help_echo_pos
= pos
;
25654 Lisp_Object obj
= glyph
->object
;
25655 EMACS_INT charpos
= glyph
->charpos
;
25657 /* Try text properties. */
25660 && charpos
< SCHARS (obj
))
25662 help
= Fget_text_property (make_number (charpos
),
25666 /* If the string itself doesn't specify a help-echo,
25667 see if the buffer text ``under'' it does. */
25668 struct glyph_row
*r
25669 = MATRIX_ROW (w
->current_matrix
, vpos
);
25670 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25671 EMACS_INT p
= string_buffer_position (obj
, start
);
25674 help
= Fget_char_property (make_number (p
),
25675 Qhelp_echo
, w
->buffer
);
25684 else if (BUFFERP (obj
)
25687 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25692 help_echo_string
= help
;
25693 help_echo_window
= window
;
25694 help_echo_object
= obj
;
25695 help_echo_pos
= charpos
;
25700 #ifdef HAVE_WINDOW_SYSTEM
25701 /* Look for a `pointer' property. */
25702 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25704 /* Check overlays first. */
25705 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25706 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25708 if (NILP (pointer
))
25710 Lisp_Object obj
= glyph
->object
;
25711 EMACS_INT charpos
= glyph
->charpos
;
25713 /* Try text properties. */
25716 && charpos
< SCHARS (obj
))
25718 pointer
= Fget_text_property (make_number (charpos
),
25720 if (NILP (pointer
))
25722 /* If the string itself doesn't specify a pointer,
25723 see if the buffer text ``under'' it does. */
25724 struct glyph_row
*r
25725 = MATRIX_ROW (w
->current_matrix
, vpos
);
25726 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25727 EMACS_INT p
= string_buffer_position (obj
, start
);
25729 pointer
= Fget_char_property (make_number (p
),
25730 Qpointer
, w
->buffer
);
25733 else if (BUFFERP (obj
)
25736 pointer
= Fget_text_property (make_number (charpos
),
25740 #endif /* HAVE_WINDOW_SYSTEM */
25744 current_buffer
= obuf
;
25749 #ifdef HAVE_WINDOW_SYSTEM
25750 if (FRAME_WINDOW_P (f
))
25751 define_frame_cursor1 (f
, cursor
, pointer
);
25753 /* This is here to prevent a compiler error, about "label at end of
25754 compound statement". */
25761 Clear any mouse-face on window W. This function is part of the
25762 redisplay interface, and is called from try_window_id and similar
25763 functions to ensure the mouse-highlight is off. */
25766 x_clear_window_mouse_face (struct window
*w
)
25768 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25769 Lisp_Object window
;
25772 XSETWINDOW (window
, w
);
25773 if (EQ (window
, hlinfo
->mouse_face_window
))
25774 clear_mouse_face (hlinfo
);
25780 Just discard the mouse face information for frame F, if any.
25781 This is used when the size of F is changed. */
25784 cancel_mouse_face (struct frame
*f
)
25786 Lisp_Object window
;
25787 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25789 window
= hlinfo
->mouse_face_window
;
25790 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25792 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25793 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25794 hlinfo
->mouse_face_window
= Qnil
;
25800 /***********************************************************************
25802 ***********************************************************************/
25804 #ifdef HAVE_WINDOW_SYSTEM
25806 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25807 which intersects rectangle R. R is in window-relative coordinates. */
25810 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25811 enum glyph_row_area area
)
25813 struct glyph
*first
= row
->glyphs
[area
];
25814 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25815 struct glyph
*last
;
25816 int first_x
, start_x
, x
;
25818 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25819 /* If row extends face to end of line write the whole line. */
25820 draw_glyphs (w
, 0, row
, area
,
25821 0, row
->used
[area
],
25822 DRAW_NORMAL_TEXT
, 0);
25825 /* Set START_X to the window-relative start position for drawing glyphs of
25826 AREA. The first glyph of the text area can be partially visible.
25827 The first glyphs of other areas cannot. */
25828 start_x
= window_box_left_offset (w
, area
);
25830 if (area
== TEXT_AREA
)
25833 /* Find the first glyph that must be redrawn. */
25835 && x
+ first
->pixel_width
< r
->x
)
25837 x
+= first
->pixel_width
;
25841 /* Find the last one. */
25845 && x
< r
->x
+ r
->width
)
25847 x
+= last
->pixel_width
;
25853 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25854 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25855 DRAW_NORMAL_TEXT
, 0);
25860 /* Redraw the parts of the glyph row ROW on window W intersecting
25861 rectangle R. R is in window-relative coordinates. Value is
25862 non-zero if mouse-face was overwritten. */
25865 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25867 xassert (row
->enabled_p
);
25869 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25870 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25871 0, row
->used
[TEXT_AREA
],
25872 DRAW_NORMAL_TEXT
, 0);
25875 if (row
->used
[LEFT_MARGIN_AREA
])
25876 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25877 if (row
->used
[TEXT_AREA
])
25878 expose_area (w
, row
, r
, TEXT_AREA
);
25879 if (row
->used
[RIGHT_MARGIN_AREA
])
25880 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25881 draw_row_fringe_bitmaps (w
, row
);
25884 return row
->mouse_face_p
;
25888 /* Redraw those parts of glyphs rows during expose event handling that
25889 overlap other rows. Redrawing of an exposed line writes over parts
25890 of lines overlapping that exposed line; this function fixes that.
25892 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25893 row in W's current matrix that is exposed and overlaps other rows.
25894 LAST_OVERLAPPING_ROW is the last such row. */
25897 expose_overlaps (struct window
*w
,
25898 struct glyph_row
*first_overlapping_row
,
25899 struct glyph_row
*last_overlapping_row
,
25902 struct glyph_row
*row
;
25904 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25905 if (row
->overlapping_p
)
25907 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25910 if (row
->used
[LEFT_MARGIN_AREA
])
25911 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25913 if (row
->used
[TEXT_AREA
])
25914 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25916 if (row
->used
[RIGHT_MARGIN_AREA
])
25917 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25923 /* Return non-zero if W's cursor intersects rectangle R. */
25926 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25928 XRectangle cr
, result
;
25929 struct glyph
*cursor_glyph
;
25930 struct glyph_row
*row
;
25932 if (w
->phys_cursor
.vpos
>= 0
25933 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25934 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25936 && row
->cursor_in_fringe_p
)
25938 /* Cursor is in the fringe. */
25939 cr
.x
= window_box_right_offset (w
,
25940 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25941 ? RIGHT_MARGIN_AREA
25944 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25945 cr
.height
= row
->height
;
25946 return x_intersect_rectangles (&cr
, r
, &result
);
25949 cursor_glyph
= get_phys_cursor_glyph (w
);
25952 /* r is relative to W's box, but w->phys_cursor.x is relative
25953 to left edge of W's TEXT area. Adjust it. */
25954 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25955 cr
.y
= w
->phys_cursor
.y
;
25956 cr
.width
= cursor_glyph
->pixel_width
;
25957 cr
.height
= w
->phys_cursor_height
;
25958 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25959 I assume the effect is the same -- and this is portable. */
25960 return x_intersect_rectangles (&cr
, r
, &result
);
25962 /* If we don't understand the format, pretend we're not in the hot-spot. */
25968 Draw a vertical window border to the right of window W if W doesn't
25969 have vertical scroll bars. */
25972 x_draw_vertical_border (struct window
*w
)
25974 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25976 /* We could do better, if we knew what type of scroll-bar the adjacent
25977 windows (on either side) have... But we don't :-(
25978 However, I think this works ok. ++KFS 2003-04-25 */
25980 /* Redraw borders between horizontally adjacent windows. Don't
25981 do it for frames with vertical scroll bars because either the
25982 right scroll bar of a window, or the left scroll bar of its
25983 neighbor will suffice as a border. */
25984 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25987 if (!WINDOW_RIGHTMOST_P (w
)
25988 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25990 int x0
, x1
, y0
, y1
;
25992 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25995 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25998 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26000 else if (!WINDOW_LEFTMOST_P (w
)
26001 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26003 int x0
, x1
, y0
, y1
;
26005 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26008 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26011 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26016 /* Redraw the part of window W intersection rectangle FR. Pixel
26017 coordinates in FR are frame-relative. Call this function with
26018 input blocked. Value is non-zero if the exposure overwrites
26022 expose_window (struct window
*w
, XRectangle
*fr
)
26024 struct frame
*f
= XFRAME (w
->frame
);
26026 int mouse_face_overwritten_p
= 0;
26028 /* If window is not yet fully initialized, do nothing. This can
26029 happen when toolkit scroll bars are used and a window is split.
26030 Reconfiguring the scroll bar will generate an expose for a newly
26032 if (w
->current_matrix
== NULL
)
26035 /* When we're currently updating the window, display and current
26036 matrix usually don't agree. Arrange for a thorough display
26038 if (w
== updated_window
)
26040 SET_FRAME_GARBAGED (f
);
26044 /* Frame-relative pixel rectangle of W. */
26045 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26046 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26047 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26048 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26050 if (x_intersect_rectangles (fr
, &wr
, &r
))
26052 int yb
= window_text_bottom_y (w
);
26053 struct glyph_row
*row
;
26054 int cursor_cleared_p
;
26055 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26057 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26058 r
.x
, r
.y
, r
.width
, r
.height
));
26060 /* Convert to window coordinates. */
26061 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26062 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26064 /* Turn off the cursor. */
26065 if (!w
->pseudo_window_p
26066 && phys_cursor_in_rect_p (w
, &r
))
26068 x_clear_cursor (w
);
26069 cursor_cleared_p
= 1;
26072 cursor_cleared_p
= 0;
26074 /* Update lines intersecting rectangle R. */
26075 first_overlapping_row
= last_overlapping_row
= NULL
;
26076 for (row
= w
->current_matrix
->rows
;
26081 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26083 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26084 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26085 || (r
.y
>= y0
&& r
.y
< y1
)
26086 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26088 /* A header line may be overlapping, but there is no need
26089 to fix overlapping areas for them. KFS 2005-02-12 */
26090 if (row
->overlapping_p
&& !row
->mode_line_p
)
26092 if (first_overlapping_row
== NULL
)
26093 first_overlapping_row
= row
;
26094 last_overlapping_row
= row
;
26098 if (expose_line (w
, row
, &r
))
26099 mouse_face_overwritten_p
= 1;
26102 else if (row
->overlapping_p
)
26104 /* We must redraw a row overlapping the exposed area. */
26106 ? y0
+ row
->phys_height
> r
.y
26107 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26109 if (first_overlapping_row
== NULL
)
26110 first_overlapping_row
= row
;
26111 last_overlapping_row
= row
;
26119 /* Display the mode line if there is one. */
26120 if (WINDOW_WANTS_MODELINE_P (w
)
26121 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26123 && row
->y
< r
.y
+ r
.height
)
26125 if (expose_line (w
, row
, &r
))
26126 mouse_face_overwritten_p
= 1;
26129 if (!w
->pseudo_window_p
)
26131 /* Fix the display of overlapping rows. */
26132 if (first_overlapping_row
)
26133 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26136 /* Draw border between windows. */
26137 x_draw_vertical_border (w
);
26139 /* Turn the cursor on again. */
26140 if (cursor_cleared_p
)
26141 update_window_cursor (w
, 1);
26145 return mouse_face_overwritten_p
;
26150 /* Redraw (parts) of all windows in the window tree rooted at W that
26151 intersect R. R contains frame pixel coordinates. Value is
26152 non-zero if the exposure overwrites mouse-face. */
26155 expose_window_tree (struct window
*w
, XRectangle
*r
)
26157 struct frame
*f
= XFRAME (w
->frame
);
26158 int mouse_face_overwritten_p
= 0;
26160 while (w
&& !FRAME_GARBAGED_P (f
))
26162 if (!NILP (w
->hchild
))
26163 mouse_face_overwritten_p
26164 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26165 else if (!NILP (w
->vchild
))
26166 mouse_face_overwritten_p
26167 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26169 mouse_face_overwritten_p
|= expose_window (w
, r
);
26171 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26174 return mouse_face_overwritten_p
;
26179 Redisplay an exposed area of frame F. X and Y are the upper-left
26180 corner of the exposed rectangle. W and H are width and height of
26181 the exposed area. All are pixel values. W or H zero means redraw
26182 the entire frame. */
26185 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26188 int mouse_face_overwritten_p
= 0;
26190 TRACE ((stderr
, "expose_frame "));
26192 /* No need to redraw if frame will be redrawn soon. */
26193 if (FRAME_GARBAGED_P (f
))
26195 TRACE ((stderr
, " garbaged\n"));
26199 /* If basic faces haven't been realized yet, there is no point in
26200 trying to redraw anything. This can happen when we get an expose
26201 event while Emacs is starting, e.g. by moving another window. */
26202 if (FRAME_FACE_CACHE (f
) == NULL
26203 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26205 TRACE ((stderr
, " no faces\n"));
26209 if (w
== 0 || h
== 0)
26212 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26213 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26223 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26224 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26226 if (WINDOWP (f
->tool_bar_window
))
26227 mouse_face_overwritten_p
26228 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26230 #ifdef HAVE_X_WINDOWS
26232 #ifndef USE_X_TOOLKIT
26233 if (WINDOWP (f
->menu_bar_window
))
26234 mouse_face_overwritten_p
26235 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26236 #endif /* not USE_X_TOOLKIT */
26240 /* Some window managers support a focus-follows-mouse style with
26241 delayed raising of frames. Imagine a partially obscured frame,
26242 and moving the mouse into partially obscured mouse-face on that
26243 frame. The visible part of the mouse-face will be highlighted,
26244 then the WM raises the obscured frame. With at least one WM, KDE
26245 2.1, Emacs is not getting any event for the raising of the frame
26246 (even tried with SubstructureRedirectMask), only Expose events.
26247 These expose events will draw text normally, i.e. not
26248 highlighted. Which means we must redo the highlight here.
26249 Subsume it under ``we love X''. --gerd 2001-08-15 */
26250 /* Included in Windows version because Windows most likely does not
26251 do the right thing if any third party tool offers
26252 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26253 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26255 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26256 if (f
== hlinfo
->mouse_face_mouse_frame
)
26258 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26259 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26260 clear_mouse_face (hlinfo
);
26261 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26268 Determine the intersection of two rectangles R1 and R2. Return
26269 the intersection in *RESULT. Value is non-zero if RESULT is not
26273 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26275 XRectangle
*left
, *right
;
26276 XRectangle
*upper
, *lower
;
26277 int intersection_p
= 0;
26279 /* Rearrange so that R1 is the left-most rectangle. */
26281 left
= r1
, right
= r2
;
26283 left
= r2
, right
= r1
;
26285 /* X0 of the intersection is right.x0, if this is inside R1,
26286 otherwise there is no intersection. */
26287 if (right
->x
<= left
->x
+ left
->width
)
26289 result
->x
= right
->x
;
26291 /* The right end of the intersection is the minimum of the
26292 the right ends of left and right. */
26293 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26296 /* Same game for Y. */
26298 upper
= r1
, lower
= r2
;
26300 upper
= r2
, lower
= r1
;
26302 /* The upper end of the intersection is lower.y0, if this is inside
26303 of upper. Otherwise, there is no intersection. */
26304 if (lower
->y
<= upper
->y
+ upper
->height
)
26306 result
->y
= lower
->y
;
26308 /* The lower end of the intersection is the minimum of the lower
26309 ends of upper and lower. */
26310 result
->height
= (min (lower
->y
+ lower
->height
,
26311 upper
->y
+ upper
->height
)
26313 intersection_p
= 1;
26317 return intersection_p
;
26320 #endif /* HAVE_WINDOW_SYSTEM */
26323 /***********************************************************************
26325 ***********************************************************************/
26328 syms_of_xdisp (void)
26330 Vwith_echo_area_save_vector
= Qnil
;
26331 staticpro (&Vwith_echo_area_save_vector
);
26333 Vmessage_stack
= Qnil
;
26334 staticpro (&Vmessage_stack
);
26336 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26337 staticpro (&Qinhibit_redisplay
);
26339 message_dolog_marker1
= Fmake_marker ();
26340 staticpro (&message_dolog_marker1
);
26341 message_dolog_marker2
= Fmake_marker ();
26342 staticpro (&message_dolog_marker2
);
26343 message_dolog_marker3
= Fmake_marker ();
26344 staticpro (&message_dolog_marker3
);
26347 defsubr (&Sdump_frame_glyph_matrix
);
26348 defsubr (&Sdump_glyph_matrix
);
26349 defsubr (&Sdump_glyph_row
);
26350 defsubr (&Sdump_tool_bar_row
);
26351 defsubr (&Strace_redisplay
);
26352 defsubr (&Strace_to_stderr
);
26354 #ifdef HAVE_WINDOW_SYSTEM
26355 defsubr (&Stool_bar_lines_needed
);
26356 defsubr (&Slookup_image_map
);
26358 defsubr (&Sformat_mode_line
);
26359 defsubr (&Sinvisible_p
);
26360 defsubr (&Scurrent_bidi_paragraph_direction
);
26362 staticpro (&Qmenu_bar_update_hook
);
26363 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26365 staticpro (&Qoverriding_terminal_local_map
);
26366 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26368 staticpro (&Qoverriding_local_map
);
26369 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26371 staticpro (&Qwindow_scroll_functions
);
26372 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26374 staticpro (&Qwindow_text_change_functions
);
26375 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26377 staticpro (&Qredisplay_end_trigger_functions
);
26378 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26380 staticpro (&Qinhibit_point_motion_hooks
);
26381 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26383 Qeval
= intern_c_string ("eval");
26384 staticpro (&Qeval
);
26386 QCdata
= intern_c_string (":data");
26387 staticpro (&QCdata
);
26388 Qdisplay
= intern_c_string ("display");
26389 staticpro (&Qdisplay
);
26390 Qspace_width
= intern_c_string ("space-width");
26391 staticpro (&Qspace_width
);
26392 Qraise
= intern_c_string ("raise");
26393 staticpro (&Qraise
);
26394 Qslice
= intern_c_string ("slice");
26395 staticpro (&Qslice
);
26396 Qspace
= intern_c_string ("space");
26397 staticpro (&Qspace
);
26398 Qmargin
= intern_c_string ("margin");
26399 staticpro (&Qmargin
);
26400 Qpointer
= intern_c_string ("pointer");
26401 staticpro (&Qpointer
);
26402 Qleft_margin
= intern_c_string ("left-margin");
26403 staticpro (&Qleft_margin
);
26404 Qright_margin
= intern_c_string ("right-margin");
26405 staticpro (&Qright_margin
);
26406 Qcenter
= intern_c_string ("center");
26407 staticpro (&Qcenter
);
26408 Qline_height
= intern_c_string ("line-height");
26409 staticpro (&Qline_height
);
26410 QCalign_to
= intern_c_string (":align-to");
26411 staticpro (&QCalign_to
);
26412 QCrelative_width
= intern_c_string (":relative-width");
26413 staticpro (&QCrelative_width
);
26414 QCrelative_height
= intern_c_string (":relative-height");
26415 staticpro (&QCrelative_height
);
26416 QCeval
= intern_c_string (":eval");
26417 staticpro (&QCeval
);
26418 QCpropertize
= intern_c_string (":propertize");
26419 staticpro (&QCpropertize
);
26420 QCfile
= intern_c_string (":file");
26421 staticpro (&QCfile
);
26422 Qfontified
= intern_c_string ("fontified");
26423 staticpro (&Qfontified
);
26424 Qfontification_functions
= intern_c_string ("fontification-functions");
26425 staticpro (&Qfontification_functions
);
26426 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26427 staticpro (&Qtrailing_whitespace
);
26428 Qescape_glyph
= intern_c_string ("escape-glyph");
26429 staticpro (&Qescape_glyph
);
26430 Qnobreak_space
= intern_c_string ("nobreak-space");
26431 staticpro (&Qnobreak_space
);
26432 Qimage
= intern_c_string ("image");
26433 staticpro (&Qimage
);
26434 Qtext
= intern_c_string ("text");
26435 staticpro (&Qtext
);
26436 Qboth
= intern_c_string ("both");
26437 staticpro (&Qboth
);
26438 Qboth_horiz
= intern_c_string ("both-horiz");
26439 staticpro (&Qboth_horiz
);
26440 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26441 staticpro (&Qtext_image_horiz
);
26442 QCmap
= intern_c_string (":map");
26443 staticpro (&QCmap
);
26444 QCpointer
= intern_c_string (":pointer");
26445 staticpro (&QCpointer
);
26446 Qrect
= intern_c_string ("rect");
26447 staticpro (&Qrect
);
26448 Qcircle
= intern_c_string ("circle");
26449 staticpro (&Qcircle
);
26450 Qpoly
= intern_c_string ("poly");
26451 staticpro (&Qpoly
);
26452 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26453 staticpro (&Qmessage_truncate_lines
);
26454 Qgrow_only
= intern_c_string ("grow-only");
26455 staticpro (&Qgrow_only
);
26456 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26457 staticpro (&Qinhibit_menubar_update
);
26458 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26459 staticpro (&Qinhibit_eval_during_redisplay
);
26460 Qposition
= intern_c_string ("position");
26461 staticpro (&Qposition
);
26462 Qbuffer_position
= intern_c_string ("buffer-position");
26463 staticpro (&Qbuffer_position
);
26464 Qobject
= intern_c_string ("object");
26465 staticpro (&Qobject
);
26466 Qbar
= intern_c_string ("bar");
26468 Qhbar
= intern_c_string ("hbar");
26469 staticpro (&Qhbar
);
26470 Qbox
= intern_c_string ("box");
26472 Qhollow
= intern_c_string ("hollow");
26473 staticpro (&Qhollow
);
26474 Qhand
= intern_c_string ("hand");
26475 staticpro (&Qhand
);
26476 Qarrow
= intern_c_string ("arrow");
26477 staticpro (&Qarrow
);
26478 Qtext
= intern_c_string ("text");
26479 staticpro (&Qtext
);
26480 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26481 staticpro (&Qinhibit_free_realized_faces
);
26483 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26484 Fcons (intern_c_string ("void-variable"), Qnil
)),
26486 staticpro (&list_of_error
);
26488 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26489 staticpro (&Qlast_arrow_position
);
26490 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26491 staticpro (&Qlast_arrow_string
);
26493 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26494 staticpro (&Qoverlay_arrow_string
);
26495 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26496 staticpro (&Qoverlay_arrow_bitmap
);
26498 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26499 staticpro (&echo_buffer
[0]);
26500 staticpro (&echo_buffer
[1]);
26502 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26503 staticpro (&echo_area_buffer
[0]);
26504 staticpro (&echo_area_buffer
[1]);
26506 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26507 staticpro (&Vmessages_buffer_name
);
26509 mode_line_proptrans_alist
= Qnil
;
26510 staticpro (&mode_line_proptrans_alist
);
26511 mode_line_string_list
= Qnil
;
26512 staticpro (&mode_line_string_list
);
26513 mode_line_string_face
= Qnil
;
26514 staticpro (&mode_line_string_face
);
26515 mode_line_string_face_prop
= Qnil
;
26516 staticpro (&mode_line_string_face_prop
);
26517 Vmode_line_unwind_vector
= Qnil
;
26518 staticpro (&Vmode_line_unwind_vector
);
26520 help_echo_string
= Qnil
;
26521 staticpro (&help_echo_string
);
26522 help_echo_object
= Qnil
;
26523 staticpro (&help_echo_object
);
26524 help_echo_window
= Qnil
;
26525 staticpro (&help_echo_window
);
26526 previous_help_echo_string
= Qnil
;
26527 staticpro (&previous_help_echo_string
);
26528 help_echo_pos
= -1;
26530 Qright_to_left
= intern_c_string ("right-to-left");
26531 staticpro (&Qright_to_left
);
26532 Qleft_to_right
= intern_c_string ("left-to-right");
26533 staticpro (&Qleft_to_right
);
26535 #ifdef HAVE_WINDOW_SYSTEM
26536 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26537 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26538 For example, if a block cursor is over a tab, it will be drawn as
26539 wide as that tab on the display. */);
26540 x_stretch_cursor_p
= 0;
26543 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26544 doc
: /* *Non-nil means highlight trailing whitespace.
26545 The face used for trailing whitespace is `trailing-whitespace'. */);
26546 Vshow_trailing_whitespace
= Qnil
;
26548 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26549 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26550 A value of t means highlight the character itself (for nobreak space,
26551 use face `nobreak-space').
26552 A value of nil means no highlighting.
26553 Other values mean display the escape glyph followed by an ordinary
26554 space or ordinary hyphen. */);
26555 Vnobreak_char_display
= Qt
;
26557 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26558 doc
: /* *The pointer shape to show in void text areas.
26559 A value of nil means to show the text pointer. Other options are `arrow',
26560 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26561 Vvoid_text_area_pointer
= Qarrow
;
26563 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26564 doc
: /* Non-nil means don't actually do any redisplay.
26565 This is used for internal purposes. */);
26566 Vinhibit_redisplay
= Qnil
;
26568 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26569 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26570 Vglobal_mode_string
= Qnil
;
26572 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26573 doc
: /* Marker for where to display an arrow on top of the buffer text.
26574 This must be the beginning of a line in order to work.
26575 See also `overlay-arrow-string'. */);
26576 Voverlay_arrow_position
= Qnil
;
26578 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26579 doc
: /* String to display as an arrow in non-window frames.
26580 See also `overlay-arrow-position'. */);
26581 Voverlay_arrow_string
= make_pure_c_string ("=>");
26583 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26584 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26585 The symbols on this list are examined during redisplay to determine
26586 where to display overlay arrows. */);
26587 Voverlay_arrow_variable_list
26588 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26590 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26591 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26592 If that fails to bring point back on frame, point is centered instead.
26593 If this is zero, point is always centered after it moves off frame.
26594 If you want scrolling to always be a line at a time, you should set
26595 `scroll-conservatively' to a large value rather than set this to 1. */);
26597 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26598 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26599 If point moves off-screen, redisplay will scroll by up to
26600 `scroll-conservatively' lines in order to bring point just barely
26601 onto the screen again. If that cannot be done, then redisplay
26602 recenters point as usual.
26604 If the value is greater than 100, redisplay will never recenter point,
26605 but will always scroll just enough text to bring point into view, even
26606 if you move far away.
26608 A value of zero means always recenter point if it moves off screen. */);
26609 scroll_conservatively
= 0;
26611 DEFVAR_INT ("scroll-margin", scroll_margin
,
26612 doc
: /* *Number of lines of margin at the top and bottom of a window.
26613 Recenter the window whenever point gets within this many lines
26614 of the top or bottom of the window. */);
26617 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26618 doc
: /* Pixels per inch value for non-window system displays.
26619 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26620 Vdisplay_pixels_per_inch
= make_float (72.0);
26623 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26626 DEFVAR_LISP ("truncate-partial-width-windows",
26627 Vtruncate_partial_width_windows
,
26628 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26629 For an integer value, truncate lines in each window narrower than the
26630 full frame width, provided the window width is less than that integer;
26631 otherwise, respect the value of `truncate-lines'.
26633 For any other non-nil value, truncate lines in all windows that do
26634 not span the full frame width.
26636 A value of nil means to respect the value of `truncate-lines'.
26638 If `word-wrap' is enabled, you might want to reduce this. */);
26639 Vtruncate_partial_width_windows
= make_number (50);
26641 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26642 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26643 Any other value means to use the appropriate face, `mode-line',
26644 `header-line', or `menu' respectively. */);
26645 mode_line_inverse_video
= 1;
26647 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26648 doc
: /* *Maximum buffer size for which line number should be displayed.
26649 If the buffer is bigger than this, the line number does not appear
26650 in the mode line. A value of nil means no limit. */);
26651 Vline_number_display_limit
= Qnil
;
26653 DEFVAR_INT ("line-number-display-limit-width",
26654 line_number_display_limit_width
,
26655 doc
: /* *Maximum line width (in characters) for line number display.
26656 If the average length of the lines near point is bigger than this, then the
26657 line number may be omitted from the mode line. */);
26658 line_number_display_limit_width
= 200;
26660 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26661 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26662 highlight_nonselected_windows
= 0;
26664 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26665 doc
: /* Non-nil if more than one frame is visible on this display.
26666 Minibuffer-only frames don't count, but iconified frames do.
26667 This variable is not guaranteed to be accurate except while processing
26668 `frame-title-format' and `icon-title-format'. */);
26670 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26671 doc
: /* Template for displaying the title bar of visible frames.
26672 \(Assuming the window manager supports this feature.)
26674 This variable has the same structure as `mode-line-format', except that
26675 the %c and %l constructs are ignored. It is used only on frames for
26676 which no explicit name has been set \(see `modify-frame-parameters'). */);
26678 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26679 doc
: /* Template for displaying the title bar of an iconified frame.
26680 \(Assuming the window manager supports this feature.)
26681 This variable has the same structure as `mode-line-format' (which see),
26682 and is used only on frames for which no explicit name has been set
26683 \(see `modify-frame-parameters'). */);
26685 = Vframe_title_format
26686 = pure_cons (intern_c_string ("multiple-frames"),
26687 pure_cons (make_pure_c_string ("%b"),
26688 pure_cons (pure_cons (empty_unibyte_string
,
26689 pure_cons (intern_c_string ("invocation-name"),
26690 pure_cons (make_pure_c_string ("@"),
26691 pure_cons (intern_c_string ("system-name"),
26695 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26696 doc
: /* Maximum number of lines to keep in the message log buffer.
26697 If nil, disable message logging. If t, log messages but don't truncate
26698 the buffer when it becomes large. */);
26699 Vmessage_log_max
= make_number (100);
26701 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26702 doc
: /* Functions called before redisplay, if window sizes have changed.
26703 The value should be a list of functions that take one argument.
26704 Just before redisplay, for each frame, if any of its windows have changed
26705 size since the last redisplay, or have been split or deleted,
26706 all the functions in the list are called, with the frame as argument. */);
26707 Vwindow_size_change_functions
= Qnil
;
26709 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26710 doc
: /* List of functions to call before redisplaying a window with scrolling.
26711 Each function is called with two arguments, the window and its new
26712 display-start position. Note that these functions are also called by
26713 `set-window-buffer'. Also note that the value of `window-end' is not
26714 valid when these functions are called. */);
26715 Vwindow_scroll_functions
= Qnil
;
26717 DEFVAR_LISP ("window-text-change-functions",
26718 Vwindow_text_change_functions
,
26719 doc
: /* Functions to call in redisplay when text in the window might change. */);
26720 Vwindow_text_change_functions
= Qnil
;
26722 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26723 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26724 Each function is called with two arguments, the window and the end trigger value.
26725 See `set-window-redisplay-end-trigger'. */);
26726 Vredisplay_end_trigger_functions
= Qnil
;
26728 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26729 doc
: /* *Non-nil means autoselect window with mouse pointer.
26730 If nil, do not autoselect windows.
26731 A positive number means delay autoselection by that many seconds: a
26732 window is autoselected only after the mouse has remained in that
26733 window for the duration of the delay.
26734 A negative number has a similar effect, but causes windows to be
26735 autoselected only after the mouse has stopped moving. \(Because of
26736 the way Emacs compares mouse events, you will occasionally wait twice
26737 that time before the window gets selected.\)
26738 Any other value means to autoselect window instantaneously when the
26739 mouse pointer enters it.
26741 Autoselection selects the minibuffer only if it is active, and never
26742 unselects the minibuffer if it is active.
26744 When customizing this variable make sure that the actual value of
26745 `focus-follows-mouse' matches the behavior of your window manager. */);
26746 Vmouse_autoselect_window
= Qnil
;
26748 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26749 doc
: /* *Non-nil means automatically resize tool-bars.
26750 This dynamically changes the tool-bar's height to the minimum height
26751 that is needed to make all tool-bar items visible.
26752 If value is `grow-only', the tool-bar's height is only increased
26753 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26754 Vauto_resize_tool_bars
= Qt
;
26756 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26757 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26758 auto_raise_tool_bar_buttons_p
= 1;
26760 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26761 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26762 make_cursor_line_fully_visible_p
= 1;
26764 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26765 doc
: /* *Border below tool-bar in pixels.
26766 If an integer, use it as the height of the border.
26767 If it is one of `internal-border-width' or `border-width', use the
26768 value of the corresponding frame parameter.
26769 Otherwise, no border is added below the tool-bar. */);
26770 Vtool_bar_border
= Qinternal_border_width
;
26772 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26773 doc
: /* *Margin around tool-bar buttons in pixels.
26774 If an integer, use that for both horizontal and vertical margins.
26775 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26776 HORZ specifying the horizontal margin, and VERT specifying the
26777 vertical margin. */);
26778 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26780 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26781 doc
: /* *Relief thickness of tool-bar buttons. */);
26782 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26784 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26785 doc
: /* Tool bar style to use.
26787 image - show images only
26788 text - show text only
26789 both - show both, text below image
26790 both-horiz - show text to the right of the image
26791 text-image-horiz - show text to the left of the image
26792 any other - use system default or image if no system default. */);
26793 Vtool_bar_style
= Qnil
;
26795 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26796 doc
: /* *Maximum number of characters a label can have to be shown.
26797 The tool bar style must also show labels for this to have any effect, see
26798 `tool-bar-style'. */);
26799 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26801 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26802 doc
: /* List of functions to call to fontify regions of text.
26803 Each function is called with one argument POS. Functions must
26804 fontify a region starting at POS in the current buffer, and give
26805 fontified regions the property `fontified'. */);
26806 Vfontification_functions
= Qnil
;
26807 Fmake_variable_buffer_local (Qfontification_functions
);
26809 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26810 unibyte_display_via_language_environment
,
26811 doc
: /* *Non-nil means display unibyte text according to language environment.
26812 Specifically, this means that raw bytes in the range 160-255 decimal
26813 are displayed by converting them to the equivalent multibyte characters
26814 according to the current language environment. As a result, they are
26815 displayed according to the current fontset.
26817 Note that this variable affects only how these bytes are displayed,
26818 but does not change the fact they are interpreted as raw bytes. */);
26819 unibyte_display_via_language_environment
= 0;
26821 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26822 doc
: /* *Maximum height for resizing mini-windows.
26823 If a float, it specifies a fraction of the mini-window frame's height.
26824 If an integer, it specifies a number of lines. */);
26825 Vmax_mini_window_height
= make_float (0.25);
26827 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26828 doc
: /* *How to resize mini-windows.
26829 A value of nil means don't automatically resize mini-windows.
26830 A value of t means resize them to fit the text displayed in them.
26831 A value of `grow-only', the default, means let mini-windows grow
26832 only, until their display becomes empty, at which point the windows
26833 go back to their normal size. */);
26834 Vresize_mini_windows
= Qgrow_only
;
26836 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26837 doc
: /* Alist specifying how to blink the cursor off.
26838 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26839 `cursor-type' frame-parameter or variable equals ON-STATE,
26840 comparing using `equal', Emacs uses OFF-STATE to specify
26841 how to blink it off. ON-STATE and OFF-STATE are values for
26842 the `cursor-type' frame parameter.
26844 If a frame's ON-STATE has no entry in this list,
26845 the frame's other specifications determine how to blink the cursor off. */);
26846 Vblink_cursor_alist
= Qnil
;
26848 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26849 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26850 If non-nil, windows are automatically scrolled horizontally to make
26851 point visible. */);
26852 automatic_hscrolling_p
= 1;
26853 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26854 staticpro (&Qauto_hscroll_mode
);
26856 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26857 doc
: /* *How many columns away from the window edge point is allowed to get
26858 before automatic hscrolling will horizontally scroll the window. */);
26859 hscroll_margin
= 5;
26861 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26862 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26863 When point is less than `hscroll-margin' columns from the window
26864 edge, automatic hscrolling will scroll the window by the amount of columns
26865 determined by this variable. If its value is a positive integer, scroll that
26866 many columns. If it's a positive floating-point number, it specifies the
26867 fraction of the window's width to scroll. If it's nil or zero, point will be
26868 centered horizontally after the scroll. Any other value, including negative
26869 numbers, are treated as if the value were zero.
26871 Automatic hscrolling always moves point outside the scroll margin, so if
26872 point was more than scroll step columns inside the margin, the window will
26873 scroll more than the value given by the scroll step.
26875 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26876 and `scroll-right' overrides this variable's effect. */);
26877 Vhscroll_step
= make_number (0);
26879 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26880 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26881 Bind this around calls to `message' to let it take effect. */);
26882 message_truncate_lines
= 0;
26884 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26885 doc
: /* Normal hook run to update the menu bar definitions.
26886 Redisplay runs this hook before it redisplays the menu bar.
26887 This is used to update submenus such as Buffers,
26888 whose contents depend on various data. */);
26889 Vmenu_bar_update_hook
= Qnil
;
26891 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26892 doc
: /* Frame for which we are updating a menu.
26893 The enable predicate for a menu binding should check this variable. */);
26894 Vmenu_updating_frame
= Qnil
;
26896 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26897 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26898 inhibit_menubar_update
= 0;
26900 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26901 doc
: /* Prefix prepended to all continuation lines at display time.
26902 The value may be a string, an image, or a stretch-glyph; it is
26903 interpreted in the same way as the value of a `display' text property.
26905 This variable is overridden by any `wrap-prefix' text or overlay
26908 To add a prefix to non-continuation lines, use `line-prefix'. */);
26909 Vwrap_prefix
= Qnil
;
26910 staticpro (&Qwrap_prefix
);
26911 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26912 Fmake_variable_buffer_local (Qwrap_prefix
);
26914 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26915 doc
: /* Prefix prepended to all non-continuation lines at display time.
26916 The value may be a string, an image, or a stretch-glyph; it is
26917 interpreted in the same way as the value of a `display' text property.
26919 This variable is overridden by any `line-prefix' text or overlay
26922 To add a prefix to continuation lines, use `wrap-prefix'. */);
26923 Vline_prefix
= Qnil
;
26924 staticpro (&Qline_prefix
);
26925 Qline_prefix
= intern_c_string ("line-prefix");
26926 Fmake_variable_buffer_local (Qline_prefix
);
26928 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26929 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26930 inhibit_eval_during_redisplay
= 0;
26932 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26933 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26934 inhibit_free_realized_faces
= 0;
26937 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26938 doc
: /* Inhibit try_window_id display optimization. */);
26939 inhibit_try_window_id
= 0;
26941 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26942 doc
: /* Inhibit try_window_reusing display optimization. */);
26943 inhibit_try_window_reusing
= 0;
26945 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26946 doc
: /* Inhibit try_cursor_movement display optimization. */);
26947 inhibit_try_cursor_movement
= 0;
26948 #endif /* GLYPH_DEBUG */
26950 DEFVAR_INT ("overline-margin", overline_margin
,
26951 doc
: /* *Space between overline and text, in pixels.
26952 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26953 margin to the caracter height. */);
26954 overline_margin
= 2;
26956 DEFVAR_INT ("underline-minimum-offset",
26957 underline_minimum_offset
,
26958 doc
: /* Minimum distance between baseline and underline.
26959 This can improve legibility of underlined text at small font sizes,
26960 particularly when using variable `x-use-underline-position-properties'
26961 with fonts that specify an UNDERLINE_POSITION relatively close to the
26962 baseline. The default value is 1. */);
26963 underline_minimum_offset
= 1;
26965 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26966 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26967 This feature only works when on a window system that can change
26968 cursor shapes. */);
26969 display_hourglass_p
= 1;
26971 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26972 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26973 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26975 hourglass_atimer
= NULL
;
26976 hourglass_shown_p
= 0;
26978 DEFSYM (Qglyphless_char
, "glyphless-char");
26979 DEFSYM (Qhex_code
, "hex-code");
26980 DEFSYM (Qempty_box
, "empty-box");
26981 DEFSYM (Qthin_space
, "thin-space");
26982 DEFSYM (Qzero_width
, "zero-width");
26984 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
26985 /* Intern this now in case it isn't already done.
26986 Setting this variable twice is harmless.
26987 But don't staticpro it here--that is done in alloc.c. */
26988 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
26989 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
26991 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
26992 doc
: /* Char-table to control displaying of glyphless characters.
26993 Each element, if non-nil, is an ASCII acronym string (displayed in a box)
26994 or one of these symbols:
26995 hex-code: display the hexadecimal code of a character in a box
26996 empty-box: display as an empty box
26997 thin-space: display as 1-pixel width space
26998 zero-width: don't display
27000 It has one extra slot to control the display of a character for which
27001 no font is found. The value of the slot is `hex-code' or `empty-box'.
27002 The default is `empty-box'. */);
27003 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27004 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27009 /* Initialize this module when Emacs starts. */
27014 Lisp_Object root_window
;
27015 struct window
*mini_w
;
27017 current_header_line_height
= current_mode_line_height
= -1;
27019 CHARPOS (this_line_start_pos
) = 0;
27021 mini_w
= XWINDOW (minibuf_window
);
27022 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
27024 if (!noninteractive
)
27026 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
27029 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
27030 set_window_height (root_window
,
27031 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
27033 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
27034 set_window_height (minibuf_window
, 1, 0);
27036 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
27037 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
27039 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27040 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27041 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27043 /* The default ellipsis glyphs `...'. */
27044 for (i
= 0; i
< 3; ++i
)
27045 default_invis_vector
[i
] = make_number ('.');
27049 /* Allocate the buffer for frame titles.
27050 Also used for `format-mode-line'. */
27052 mode_line_noprop_buf
= (char *) xmalloc (size
);
27053 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27054 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27055 mode_line_target
= MODE_LINE_DISPLAY
;
27058 help_echo_showing_p
= 0;
27061 /* Since w32 does not support atimers, it defines its own implementation of
27062 the following three functions in w32fns.c. */
27065 /* Platform-independent portion of hourglass implementation. */
27067 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27069 hourglass_started (void)
27071 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27074 /* Cancel a currently active hourglass timer, and start a new one. */
27076 start_hourglass (void)
27078 #if defined (HAVE_WINDOW_SYSTEM)
27080 int secs
, usecs
= 0;
27082 cancel_hourglass ();
27084 if (INTEGERP (Vhourglass_delay
)
27085 && XINT (Vhourglass_delay
) > 0)
27086 secs
= XFASTINT (Vhourglass_delay
);
27087 else if (FLOATP (Vhourglass_delay
)
27088 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27091 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27092 secs
= XFASTINT (tem
);
27093 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27096 secs
= DEFAULT_HOURGLASS_DELAY
;
27098 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27099 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27100 show_hourglass
, NULL
);
27105 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27108 cancel_hourglass (void)
27110 #if defined (HAVE_WINDOW_SYSTEM)
27111 if (hourglass_atimer
)
27113 cancel_atimer (hourglass_atimer
);
27114 hourglass_atimer
= NULL
;
27117 if (hourglass_shown_p
)
27121 #endif /* ! WINDOWSNT */