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
))
8420 for (len
= strnlen (buf
, bufsize
);
8421 len
&& ! CHAR_HEAD_P (buf
[len
- 1]);
8425 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8430 /* Print should start at the beginning of the message
8431 buffer next time. */
8432 message_buf_print
= 0;
8438 message (const char *m
, ...)
8448 /* The non-logging version of message. */
8451 message_nolog (const char *m
, ...)
8453 Lisp_Object old_log_max
;
8456 old_log_max
= Vmessage_log_max
;
8457 Vmessage_log_max
= Qnil
;
8459 Vmessage_log_max
= old_log_max
;
8465 /* Display the current message in the current mini-buffer. This is
8466 only called from error handlers in process.c, and is not time
8470 update_echo_area (void)
8472 if (!NILP (echo_area_buffer
[0]))
8475 string
= Fcurrent_message ();
8476 message3 (string
, SBYTES (string
),
8477 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8482 /* Make sure echo area buffers in `echo_buffers' are live.
8483 If they aren't, make new ones. */
8486 ensure_echo_area_buffers (void)
8490 for (i
= 0; i
< 2; ++i
)
8491 if (!BUFFERP (echo_buffer
[i
])
8492 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8495 Lisp_Object old_buffer
;
8498 old_buffer
= echo_buffer
[i
];
8499 sprintf (name
, " *Echo Area %d*", i
);
8500 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8501 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8502 /* to force word wrap in echo area -
8503 it was decided to postpone this*/
8504 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8506 for (j
= 0; j
< 2; ++j
)
8507 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8508 echo_area_buffer
[j
] = echo_buffer
[i
];
8513 /* Call FN with args A1..A4 with either the current or last displayed
8514 echo_area_buffer as current buffer.
8516 WHICH zero means use the current message buffer
8517 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8518 from echo_buffer[] and clear it.
8520 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8521 suitable buffer from echo_buffer[] and clear it.
8523 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8524 that the current message becomes the last displayed one, make
8525 choose a suitable buffer for echo_area_buffer[0], and clear it.
8527 Value is what FN returns. */
8530 with_echo_area_buffer (struct window
*w
, int which
,
8531 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8532 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8535 int this_one
, the_other
, clear_buffer_p
, rc
;
8536 int count
= SPECPDL_INDEX ();
8538 /* If buffers aren't live, make new ones. */
8539 ensure_echo_area_buffers ();
8544 this_one
= 0, the_other
= 1;
8546 this_one
= 1, the_other
= 0;
8549 this_one
= 0, the_other
= 1;
8552 /* We need a fresh one in case the current echo buffer equals
8553 the one containing the last displayed echo area message. */
8554 if (!NILP (echo_area_buffer
[this_one
])
8555 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8556 echo_area_buffer
[this_one
] = Qnil
;
8559 /* Choose a suitable buffer from echo_buffer[] is we don't
8561 if (NILP (echo_area_buffer
[this_one
]))
8563 echo_area_buffer
[this_one
]
8564 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8565 ? echo_buffer
[the_other
]
8566 : echo_buffer
[this_one
]);
8570 buffer
= echo_area_buffer
[this_one
];
8572 /* Don't get confused by reusing the buffer used for echoing
8573 for a different purpose. */
8574 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8577 record_unwind_protect (unwind_with_echo_area_buffer
,
8578 with_echo_area_buffer_unwind_data (w
));
8580 /* Make the echo area buffer current. Note that for display
8581 purposes, it is not necessary that the displayed window's buffer
8582 == current_buffer, except for text property lookup. So, let's
8583 only set that buffer temporarily here without doing a full
8584 Fset_window_buffer. We must also change w->pointm, though,
8585 because otherwise an assertions in unshow_buffer fails, and Emacs
8587 set_buffer_internal_1 (XBUFFER (buffer
));
8591 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8594 BVAR (current_buffer
, undo_list
) = Qt
;
8595 BVAR (current_buffer
, read_only
) = Qnil
;
8596 specbind (Qinhibit_read_only
, Qt
);
8597 specbind (Qinhibit_modification_hooks
, Qt
);
8599 if (clear_buffer_p
&& Z
> BEG
)
8602 xassert (BEGV
>= BEG
);
8603 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8605 rc
= fn (a1
, a2
, a3
, a4
);
8607 xassert (BEGV
>= BEG
);
8608 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8610 unbind_to (count
, Qnil
);
8615 /* Save state that should be preserved around the call to the function
8616 FN called in with_echo_area_buffer. */
8619 with_echo_area_buffer_unwind_data (struct window
*w
)
8622 Lisp_Object vector
, tmp
;
8624 /* Reduce consing by keeping one vector in
8625 Vwith_echo_area_save_vector. */
8626 vector
= Vwith_echo_area_save_vector
;
8627 Vwith_echo_area_save_vector
= Qnil
;
8630 vector
= Fmake_vector (make_number (7), Qnil
);
8632 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8633 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8634 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8638 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8639 ASET (vector
, i
, w
->buffer
); ++i
;
8640 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8641 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8646 for (; i
< end
; ++i
)
8647 ASET (vector
, i
, Qnil
);
8650 xassert (i
== ASIZE (vector
));
8655 /* Restore global state from VECTOR which was created by
8656 with_echo_area_buffer_unwind_data. */
8659 unwind_with_echo_area_buffer (Lisp_Object vector
)
8661 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8662 Vdeactivate_mark
= AREF (vector
, 1);
8663 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8665 if (WINDOWP (AREF (vector
, 3)))
8668 Lisp_Object buffer
, charpos
, bytepos
;
8670 w
= XWINDOW (AREF (vector
, 3));
8671 buffer
= AREF (vector
, 4);
8672 charpos
= AREF (vector
, 5);
8673 bytepos
= AREF (vector
, 6);
8676 set_marker_both (w
->pointm
, buffer
,
8677 XFASTINT (charpos
), XFASTINT (bytepos
));
8680 Vwith_echo_area_save_vector
= vector
;
8685 /* Set up the echo area for use by print functions. MULTIBYTE_P
8686 non-zero means we will print multibyte. */
8689 setup_echo_area_for_printing (int multibyte_p
)
8691 /* If we can't find an echo area any more, exit. */
8692 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8695 ensure_echo_area_buffers ();
8697 if (!message_buf_print
)
8699 /* A message has been output since the last time we printed.
8700 Choose a fresh echo area buffer. */
8701 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8702 echo_area_buffer
[0] = echo_buffer
[1];
8704 echo_area_buffer
[0] = echo_buffer
[0];
8706 /* Switch to that buffer and clear it. */
8707 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8708 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8712 int count
= SPECPDL_INDEX ();
8713 specbind (Qinhibit_read_only
, Qt
);
8714 /* Note that undo recording is always disabled. */
8716 unbind_to (count
, Qnil
);
8718 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8720 /* Set up the buffer for the multibyteness we need. */
8722 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8723 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8725 /* Raise the frame containing the echo area. */
8726 if (minibuffer_auto_raise
)
8728 struct frame
*sf
= SELECTED_FRAME ();
8729 Lisp_Object mini_window
;
8730 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8731 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8734 message_log_maybe_newline ();
8735 message_buf_print
= 1;
8739 if (NILP (echo_area_buffer
[0]))
8741 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8742 echo_area_buffer
[0] = echo_buffer
[1];
8744 echo_area_buffer
[0] = echo_buffer
[0];
8747 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8749 /* Someone switched buffers between print requests. */
8750 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8751 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8757 /* Display an echo area message in window W. Value is non-zero if W's
8758 height is changed. If display_last_displayed_message_p is
8759 non-zero, display the message that was last displayed, otherwise
8760 display the current message. */
8763 display_echo_area (struct window
*w
)
8765 int i
, no_message_p
, window_height_changed_p
, count
;
8767 /* Temporarily disable garbage collections while displaying the echo
8768 area. This is done because a GC can print a message itself.
8769 That message would modify the echo area buffer's contents while a
8770 redisplay of the buffer is going on, and seriously confuse
8772 count
= inhibit_garbage_collection ();
8774 /* If there is no message, we must call display_echo_area_1
8775 nevertheless because it resizes the window. But we will have to
8776 reset the echo_area_buffer in question to nil at the end because
8777 with_echo_area_buffer will sets it to an empty buffer. */
8778 i
= display_last_displayed_message_p
? 1 : 0;
8779 no_message_p
= NILP (echo_area_buffer
[i
]);
8781 window_height_changed_p
8782 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8783 display_echo_area_1
,
8784 (EMACS_INT
) w
, Qnil
, 0, 0);
8787 echo_area_buffer
[i
] = Qnil
;
8789 unbind_to (count
, Qnil
);
8790 return window_height_changed_p
;
8794 /* Helper for display_echo_area. Display the current buffer which
8795 contains the current echo area message in window W, a mini-window,
8796 a pointer to which is passed in A1. A2..A4 are currently not used.
8797 Change the height of W so that all of the message is displayed.
8798 Value is non-zero if height of W was changed. */
8801 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8803 struct window
*w
= (struct window
*) a1
;
8805 struct text_pos start
;
8806 int window_height_changed_p
= 0;
8808 /* Do this before displaying, so that we have a large enough glyph
8809 matrix for the display. If we can't get enough space for the
8810 whole text, display the last N lines. That works by setting w->start. */
8811 window_height_changed_p
= resize_mini_window (w
, 0);
8813 /* Use the starting position chosen by resize_mini_window. */
8814 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8817 clear_glyph_matrix (w
->desired_matrix
);
8818 XSETWINDOW (window
, w
);
8819 try_window (window
, start
, 0);
8821 return window_height_changed_p
;
8825 /* Resize the echo area window to exactly the size needed for the
8826 currently displayed message, if there is one. If a mini-buffer
8827 is active, don't shrink it. */
8830 resize_echo_area_exactly (void)
8832 if (BUFFERP (echo_area_buffer
[0])
8833 && WINDOWP (echo_area_window
))
8835 struct window
*w
= XWINDOW (echo_area_window
);
8837 Lisp_Object resize_exactly
;
8839 if (minibuf_level
== 0)
8840 resize_exactly
= Qt
;
8842 resize_exactly
= Qnil
;
8844 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8845 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8848 ++windows_or_buffers_changed
;
8849 ++update_mode_lines
;
8850 redisplay_internal ();
8856 /* Callback function for with_echo_area_buffer, when used from
8857 resize_echo_area_exactly. A1 contains a pointer to the window to
8858 resize, EXACTLY non-nil means resize the mini-window exactly to the
8859 size of the text displayed. A3 and A4 are not used. Value is what
8860 resize_mini_window returns. */
8863 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8865 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8869 /* Resize mini-window W to fit the size of its contents. EXACT_P
8870 means size the window exactly to the size needed. Otherwise, it's
8871 only enlarged until W's buffer is empty.
8873 Set W->start to the right place to begin display. If the whole
8874 contents fit, start at the beginning. Otherwise, start so as
8875 to make the end of the contents appear. This is particularly
8876 important for y-or-n-p, but seems desirable generally.
8878 Value is non-zero if the window height has been changed. */
8881 resize_mini_window (struct window
*w
, int exact_p
)
8883 struct frame
*f
= XFRAME (w
->frame
);
8884 int window_height_changed_p
= 0;
8886 xassert (MINI_WINDOW_P (w
));
8888 /* By default, start display at the beginning. */
8889 set_marker_both (w
->start
, w
->buffer
,
8890 BUF_BEGV (XBUFFER (w
->buffer
)),
8891 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8893 /* Don't resize windows while redisplaying a window; it would
8894 confuse redisplay functions when the size of the window they are
8895 displaying changes from under them. Such a resizing can happen,
8896 for instance, when which-func prints a long message while
8897 we are running fontification-functions. We're running these
8898 functions with safe_call which binds inhibit-redisplay to t. */
8899 if (!NILP (Vinhibit_redisplay
))
8902 /* Nil means don't try to resize. */
8903 if (NILP (Vresize_mini_windows
)
8904 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8907 if (!FRAME_MINIBUF_ONLY_P (f
))
8910 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8911 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8912 int height
, max_height
;
8913 int unit
= FRAME_LINE_HEIGHT (f
);
8914 struct text_pos start
;
8915 struct buffer
*old_current_buffer
= NULL
;
8917 if (current_buffer
!= XBUFFER (w
->buffer
))
8919 old_current_buffer
= current_buffer
;
8920 set_buffer_internal (XBUFFER (w
->buffer
));
8923 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8925 /* Compute the max. number of lines specified by the user. */
8926 if (FLOATP (Vmax_mini_window_height
))
8927 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8928 else if (INTEGERP (Vmax_mini_window_height
))
8929 max_height
= XINT (Vmax_mini_window_height
);
8931 max_height
= total_height
/ 4;
8933 /* Correct that max. height if it's bogus. */
8934 max_height
= max (1, max_height
);
8935 max_height
= min (total_height
, max_height
);
8937 /* Find out the height of the text in the window. */
8938 if (it
.line_wrap
== TRUNCATE
)
8943 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8944 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8945 height
= it
.current_y
+ last_height
;
8947 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8948 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8949 height
= (height
+ unit
- 1) / unit
;
8952 /* Compute a suitable window start. */
8953 if (height
> max_height
)
8955 height
= max_height
;
8956 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8957 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8958 start
= it
.current
.pos
;
8961 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8962 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8964 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8966 /* Let it grow only, until we display an empty message, in which
8967 case the window shrinks again. */
8968 if (height
> WINDOW_TOTAL_LINES (w
))
8970 int old_height
= WINDOW_TOTAL_LINES (w
);
8971 freeze_window_starts (f
, 1);
8972 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8973 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8975 else if (height
< WINDOW_TOTAL_LINES (w
)
8976 && (exact_p
|| BEGV
== ZV
))
8978 int old_height
= WINDOW_TOTAL_LINES (w
);
8979 freeze_window_starts (f
, 0);
8980 shrink_mini_window (w
);
8981 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8986 /* Always resize to exact size needed. */
8987 if (height
> WINDOW_TOTAL_LINES (w
))
8989 int old_height
= WINDOW_TOTAL_LINES (w
);
8990 freeze_window_starts (f
, 1);
8991 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8992 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8994 else if (height
< WINDOW_TOTAL_LINES (w
))
8996 int old_height
= WINDOW_TOTAL_LINES (w
);
8997 freeze_window_starts (f
, 0);
8998 shrink_mini_window (w
);
9002 freeze_window_starts (f
, 1);
9003 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9006 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9010 if (old_current_buffer
)
9011 set_buffer_internal (old_current_buffer
);
9014 return window_height_changed_p
;
9018 /* Value is the current message, a string, or nil if there is no
9022 current_message (void)
9026 if (!BUFFERP (echo_area_buffer
[0]))
9030 with_echo_area_buffer (0, 0, current_message_1
,
9031 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9033 echo_area_buffer
[0] = Qnil
;
9041 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9043 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9046 *msg
= make_buffer_string (BEG
, Z
, 1);
9053 /* Push the current message on Vmessage_stack for later restauration
9054 by restore_message. Value is non-zero if the current message isn't
9055 empty. This is a relatively infrequent operation, so it's not
9056 worth optimizing. */
9062 msg
= current_message ();
9063 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9064 return STRINGP (msg
);
9068 /* Restore message display from the top of Vmessage_stack. */
9071 restore_message (void)
9075 xassert (CONSP (Vmessage_stack
));
9076 msg
= XCAR (Vmessage_stack
);
9078 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9080 message3_nolog (msg
, 0, 0);
9084 /* Handler for record_unwind_protect calling pop_message. */
9087 pop_message_unwind (Lisp_Object dummy
)
9093 /* Pop the top-most entry off Vmessage_stack. */
9098 xassert (CONSP (Vmessage_stack
));
9099 Vmessage_stack
= XCDR (Vmessage_stack
);
9103 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9104 exits. If the stack is not empty, we have a missing pop_message
9108 check_message_stack (void)
9110 if (!NILP (Vmessage_stack
))
9115 /* Truncate to NCHARS what will be displayed in the echo area the next
9116 time we display it---but don't redisplay it now. */
9119 truncate_echo_area (EMACS_INT nchars
)
9122 echo_area_buffer
[0] = Qnil
;
9123 /* A null message buffer means that the frame hasn't really been
9124 initialized yet. Error messages get reported properly by
9125 cmd_error, so this must be just an informative message; toss it. */
9126 else if (!noninteractive
9128 && !NILP (echo_area_buffer
[0]))
9130 struct frame
*sf
= SELECTED_FRAME ();
9131 if (FRAME_MESSAGE_BUF (sf
))
9132 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9137 /* Helper function for truncate_echo_area. Truncate the current
9138 message to at most NCHARS characters. */
9141 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9143 if (BEG
+ nchars
< Z
)
9144 del_range (BEG
+ nchars
, Z
);
9146 echo_area_buffer
[0] = Qnil
;
9151 /* Set the current message to a substring of S or STRING.
9153 If STRING is a Lisp string, set the message to the first NBYTES
9154 bytes from STRING. NBYTES zero means use the whole string. If
9155 STRING is multibyte, the message will be displayed multibyte.
9157 If S is not null, set the message to the first LEN bytes of S. LEN
9158 zero means use the whole string. MULTIBYTE_P non-zero means S is
9159 multibyte. Display the message multibyte in that case.
9161 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9162 to t before calling set_message_1 (which calls insert).
9166 set_message (const char *s
, Lisp_Object string
,
9167 EMACS_INT nbytes
, int multibyte_p
)
9169 message_enable_multibyte
9170 = ((s
&& multibyte_p
)
9171 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9173 with_echo_area_buffer (0, -1, set_message_1
,
9174 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9175 message_buf_print
= 0;
9176 help_echo_showing_p
= 0;
9180 /* Helper function for set_message. Arguments have the same meaning
9181 as there, with A1 corresponding to S and A2 corresponding to STRING
9182 This function is called with the echo area buffer being
9186 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9188 const char *s
= (const char *) a1
;
9189 const unsigned char *msg
= (const unsigned char *) s
;
9190 Lisp_Object string
= a2
;
9192 /* Change multibyteness of the echo buffer appropriately. */
9193 if (message_enable_multibyte
9194 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9195 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9197 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9198 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9199 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9201 /* Insert new message at BEG. */
9202 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9204 if (STRINGP (string
))
9209 nbytes
= SBYTES (string
);
9210 nchars
= string_byte_to_char (string
, nbytes
);
9212 /* This function takes care of single/multibyte conversion. We
9213 just have to ensure that the echo area buffer has the right
9214 setting of enable_multibyte_characters. */
9215 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9220 nbytes
= strlen (s
);
9222 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9224 /* Convert from multi-byte to single-byte. */
9229 /* Convert a multibyte string to single-byte. */
9230 for (i
= 0; i
< nbytes
; i
+= n
)
9232 c
= string_char_and_length (msg
+ i
, &n
);
9233 work
[0] = (ASCII_CHAR_P (c
)
9235 : multibyte_char_to_unibyte (c
));
9236 insert_1_both (work
, 1, 1, 1, 0, 0);
9239 else if (!multibyte_p
9240 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9242 /* Convert from single-byte to multi-byte. */
9245 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9247 /* Convert a single-byte string to multibyte. */
9248 for (i
= 0; i
< nbytes
; i
++)
9251 MAKE_CHAR_MULTIBYTE (c
);
9252 n
= CHAR_STRING (c
, str
);
9253 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9257 insert_1 (s
, nbytes
, 1, 0, 0);
9264 /* Clear messages. CURRENT_P non-zero means clear the current
9265 message. LAST_DISPLAYED_P non-zero means clear the message
9269 clear_message (int current_p
, int last_displayed_p
)
9273 echo_area_buffer
[0] = Qnil
;
9274 message_cleared_p
= 1;
9277 if (last_displayed_p
)
9278 echo_area_buffer
[1] = Qnil
;
9280 message_buf_print
= 0;
9283 /* Clear garbaged frames.
9285 This function is used where the old redisplay called
9286 redraw_garbaged_frames which in turn called redraw_frame which in
9287 turn called clear_frame. The call to clear_frame was a source of
9288 flickering. I believe a clear_frame is not necessary. It should
9289 suffice in the new redisplay to invalidate all current matrices,
9290 and ensure a complete redisplay of all windows. */
9293 clear_garbaged_frames (void)
9297 Lisp_Object tail
, frame
;
9298 int changed_count
= 0;
9300 FOR_EACH_FRAME (tail
, frame
)
9302 struct frame
*f
= XFRAME (frame
);
9304 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9308 Fredraw_frame (frame
);
9309 f
->force_flush_display_p
= 1;
9311 clear_current_matrices (f
);
9320 ++windows_or_buffers_changed
;
9325 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9326 is non-zero update selected_frame. Value is non-zero if the
9327 mini-windows height has been changed. */
9330 echo_area_display (int update_frame_p
)
9332 Lisp_Object mini_window
;
9335 int window_height_changed_p
= 0;
9336 struct frame
*sf
= SELECTED_FRAME ();
9338 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9339 w
= XWINDOW (mini_window
);
9340 f
= XFRAME (WINDOW_FRAME (w
));
9342 /* Don't display if frame is invisible or not yet initialized. */
9343 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9346 #ifdef HAVE_WINDOW_SYSTEM
9347 /* When Emacs starts, selected_frame may be the initial terminal
9348 frame. If we let this through, a message would be displayed on
9350 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9352 #endif /* HAVE_WINDOW_SYSTEM */
9354 /* Redraw garbaged frames. */
9356 clear_garbaged_frames ();
9358 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9360 echo_area_window
= mini_window
;
9361 window_height_changed_p
= display_echo_area (w
);
9362 w
->must_be_updated_p
= 1;
9364 /* Update the display, unless called from redisplay_internal.
9365 Also don't update the screen during redisplay itself. The
9366 update will happen at the end of redisplay, and an update
9367 here could cause confusion. */
9368 if (update_frame_p
&& !redisplaying_p
)
9372 /* If the display update has been interrupted by pending
9373 input, update mode lines in the frame. Due to the
9374 pending input, it might have been that redisplay hasn't
9375 been called, so that mode lines above the echo area are
9376 garbaged. This looks odd, so we prevent it here. */
9377 if (!display_completed
)
9378 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9380 if (window_height_changed_p
9381 /* Don't do this if Emacs is shutting down. Redisplay
9382 needs to run hooks. */
9383 && !NILP (Vrun_hooks
))
9385 /* Must update other windows. Likewise as in other
9386 cases, don't let this update be interrupted by
9388 int count
= SPECPDL_INDEX ();
9389 specbind (Qredisplay_dont_pause
, Qt
);
9390 windows_or_buffers_changed
= 1;
9391 redisplay_internal ();
9392 unbind_to (count
, Qnil
);
9394 else if (FRAME_WINDOW_P (f
) && n
== 0)
9396 /* Window configuration is the same as before.
9397 Can do with a display update of the echo area,
9398 unless we displayed some mode lines. */
9399 update_single_window (w
, 1);
9400 FRAME_RIF (f
)->flush_display (f
);
9403 update_frame (f
, 1, 1);
9405 /* If cursor is in the echo area, make sure that the next
9406 redisplay displays the minibuffer, so that the cursor will
9407 be replaced with what the minibuffer wants. */
9408 if (cursor_in_echo_area
)
9409 ++windows_or_buffers_changed
;
9412 else if (!EQ (mini_window
, selected_window
))
9413 windows_or_buffers_changed
++;
9415 /* Last displayed message is now the current message. */
9416 echo_area_buffer
[1] = echo_area_buffer
[0];
9417 /* Inform read_char that we're not echoing. */
9418 echo_message_buffer
= Qnil
;
9420 /* Prevent redisplay optimization in redisplay_internal by resetting
9421 this_line_start_pos. This is done because the mini-buffer now
9422 displays the message instead of its buffer text. */
9423 if (EQ (mini_window
, selected_window
))
9424 CHARPOS (this_line_start_pos
) = 0;
9426 return window_height_changed_p
;
9431 /***********************************************************************
9432 Mode Lines and Frame Titles
9433 ***********************************************************************/
9435 /* A buffer for constructing non-propertized mode-line strings and
9436 frame titles in it; allocated from the heap in init_xdisp and
9437 resized as needed in store_mode_line_noprop_char. */
9439 static char *mode_line_noprop_buf
;
9441 /* The buffer's end, and a current output position in it. */
9443 static char *mode_line_noprop_buf_end
;
9444 static char *mode_line_noprop_ptr
;
9446 #define MODE_LINE_NOPROP_LEN(start) \
9447 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9450 MODE_LINE_DISPLAY
= 0,
9456 /* Alist that caches the results of :propertize.
9457 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9458 static Lisp_Object mode_line_proptrans_alist
;
9460 /* List of strings making up the mode-line. */
9461 static Lisp_Object mode_line_string_list
;
9463 /* Base face property when building propertized mode line string. */
9464 static Lisp_Object mode_line_string_face
;
9465 static Lisp_Object mode_line_string_face_prop
;
9468 /* Unwind data for mode line strings */
9470 static Lisp_Object Vmode_line_unwind_vector
;
9473 format_mode_line_unwind_data (struct buffer
*obuf
,
9477 Lisp_Object vector
, tmp
;
9479 /* Reduce consing by keeping one vector in
9480 Vwith_echo_area_save_vector. */
9481 vector
= Vmode_line_unwind_vector
;
9482 Vmode_line_unwind_vector
= Qnil
;
9485 vector
= Fmake_vector (make_number (8), Qnil
);
9487 ASET (vector
, 0, make_number (mode_line_target
));
9488 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9489 ASET (vector
, 2, mode_line_string_list
);
9490 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9491 ASET (vector
, 4, mode_line_string_face
);
9492 ASET (vector
, 5, mode_line_string_face_prop
);
9495 XSETBUFFER (tmp
, obuf
);
9498 ASET (vector
, 6, tmp
);
9499 ASET (vector
, 7, owin
);
9505 unwind_format_mode_line (Lisp_Object vector
)
9507 mode_line_target
= XINT (AREF (vector
, 0));
9508 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9509 mode_line_string_list
= AREF (vector
, 2);
9510 if (! EQ (AREF (vector
, 3), Qt
))
9511 mode_line_proptrans_alist
= AREF (vector
, 3);
9512 mode_line_string_face
= AREF (vector
, 4);
9513 mode_line_string_face_prop
= AREF (vector
, 5);
9515 if (!NILP (AREF (vector
, 7)))
9516 /* Select window before buffer, since it may change the buffer. */
9517 Fselect_window (AREF (vector
, 7), Qt
);
9519 if (!NILP (AREF (vector
, 6)))
9521 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9522 ASET (vector
, 6, Qnil
);
9525 Vmode_line_unwind_vector
= vector
;
9530 /* Store a single character C for the frame title in mode_line_noprop_buf.
9531 Re-allocate mode_line_noprop_buf if necessary. */
9534 store_mode_line_noprop_char (char c
)
9536 /* If output position has reached the end of the allocated buffer,
9537 double the buffer's size. */
9538 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9540 int len
= MODE_LINE_NOPROP_LEN (0);
9541 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9542 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9543 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9544 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9547 *mode_line_noprop_ptr
++ = c
;
9551 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9552 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9553 characters that yield more columns than PRECISION; PRECISION <= 0
9554 means copy the whole string. Pad with spaces until FIELD_WIDTH
9555 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9556 pad. Called from display_mode_element when it is used to build a
9560 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9562 const unsigned char *str
= (const unsigned char *) string
;
9564 EMACS_INT dummy
, nbytes
;
9566 /* Copy at most PRECISION chars from STR. */
9567 nbytes
= strlen (string
);
9568 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9570 store_mode_line_noprop_char (*str
++);
9572 /* Fill up with spaces until FIELD_WIDTH reached. */
9573 while (field_width
> 0
9576 store_mode_line_noprop_char (' ');
9583 /***********************************************************************
9585 ***********************************************************************/
9587 #ifdef HAVE_WINDOW_SYSTEM
9589 /* Set the title of FRAME, if it has changed. The title format is
9590 Vicon_title_format if FRAME is iconified, otherwise it is
9591 frame_title_format. */
9594 x_consider_frame_title (Lisp_Object frame
)
9596 struct frame
*f
= XFRAME (frame
);
9598 if (FRAME_WINDOW_P (f
)
9599 || FRAME_MINIBUF_ONLY_P (f
)
9600 || f
->explicit_name
)
9602 /* Do we have more than one visible frame on this X display? */
9609 int count
= SPECPDL_INDEX ();
9611 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9613 Lisp_Object other_frame
= XCAR (tail
);
9614 struct frame
*tf
= XFRAME (other_frame
);
9617 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9618 && !FRAME_MINIBUF_ONLY_P (tf
)
9619 && !EQ (other_frame
, tip_frame
)
9620 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9624 /* Set global variable indicating that multiple frames exist. */
9625 multiple_frames
= CONSP (tail
);
9627 /* Switch to the buffer of selected window of the frame. Set up
9628 mode_line_target so that display_mode_element will output into
9629 mode_line_noprop_buf; then display the title. */
9630 record_unwind_protect (unwind_format_mode_line
,
9631 format_mode_line_unwind_data
9632 (current_buffer
, selected_window
, 0));
9634 Fselect_window (f
->selected_window
, Qt
);
9635 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9636 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9638 mode_line_target
= MODE_LINE_TITLE
;
9639 title_start
= MODE_LINE_NOPROP_LEN (0);
9640 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9641 NULL
, DEFAULT_FACE_ID
);
9642 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9643 len
= MODE_LINE_NOPROP_LEN (title_start
);
9644 title
= mode_line_noprop_buf
+ title_start
;
9645 unbind_to (count
, Qnil
);
9647 /* Set the title only if it's changed. This avoids consing in
9648 the common case where it hasn't. (If it turns out that we've
9649 already wasted too much time by walking through the list with
9650 display_mode_element, then we might need to optimize at a
9651 higher level than this.) */
9652 if (! STRINGP (f
->name
)
9653 || SBYTES (f
->name
) != len
9654 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9655 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9659 #endif /* not HAVE_WINDOW_SYSTEM */
9664 /***********************************************************************
9666 ***********************************************************************/
9669 /* Prepare for redisplay by updating menu-bar item lists when
9670 appropriate. This can call eval. */
9673 prepare_menu_bars (void)
9676 struct gcpro gcpro1
, gcpro2
;
9678 Lisp_Object tooltip_frame
;
9680 #ifdef HAVE_WINDOW_SYSTEM
9681 tooltip_frame
= tip_frame
;
9683 tooltip_frame
= Qnil
;
9686 /* Update all frame titles based on their buffer names, etc. We do
9687 this before the menu bars so that the buffer-menu will show the
9688 up-to-date frame titles. */
9689 #ifdef HAVE_WINDOW_SYSTEM
9690 if (windows_or_buffers_changed
|| update_mode_lines
)
9692 Lisp_Object tail
, frame
;
9694 FOR_EACH_FRAME (tail
, frame
)
9697 if (!EQ (frame
, tooltip_frame
)
9698 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9699 x_consider_frame_title (frame
);
9702 #endif /* HAVE_WINDOW_SYSTEM */
9704 /* Update the menu bar item lists, if appropriate. This has to be
9705 done before any actual redisplay or generation of display lines. */
9706 all_windows
= (update_mode_lines
9707 || buffer_shared
> 1
9708 || windows_or_buffers_changed
);
9711 Lisp_Object tail
, frame
;
9712 int count
= SPECPDL_INDEX ();
9713 /* 1 means that update_menu_bar has run its hooks
9714 so any further calls to update_menu_bar shouldn't do so again. */
9715 int menu_bar_hooks_run
= 0;
9717 record_unwind_save_match_data ();
9719 FOR_EACH_FRAME (tail
, frame
)
9723 /* Ignore tooltip frame. */
9724 if (EQ (frame
, tooltip_frame
))
9727 /* If a window on this frame changed size, report that to
9728 the user and clear the size-change flag. */
9729 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9731 Lisp_Object functions
;
9733 /* Clear flag first in case we get an error below. */
9734 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9735 functions
= Vwindow_size_change_functions
;
9736 GCPRO2 (tail
, functions
);
9738 while (CONSP (functions
))
9740 if (!EQ (XCAR (functions
), Qt
))
9741 call1 (XCAR (functions
), frame
);
9742 functions
= XCDR (functions
);
9748 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9749 #ifdef HAVE_WINDOW_SYSTEM
9750 update_tool_bar (f
, 0);
9753 if (windows_or_buffers_changed
9755 ns_set_doc_edited (f
, Fbuffer_modified_p
9756 (XWINDOW (f
->selected_window
)->buffer
));
9761 unbind_to (count
, Qnil
);
9765 struct frame
*sf
= SELECTED_FRAME ();
9766 update_menu_bar (sf
, 1, 0);
9767 #ifdef HAVE_WINDOW_SYSTEM
9768 update_tool_bar (sf
, 1);
9774 /* Update the menu bar item list for frame F. This has to be done
9775 before we start to fill in any display lines, because it can call
9778 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9780 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9781 already ran the menu bar hooks for this redisplay, so there
9782 is no need to run them again. The return value is the
9783 updated value of this flag, to pass to the next call. */
9786 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9789 register struct window
*w
;
9791 /* If called recursively during a menu update, do nothing. This can
9792 happen when, for instance, an activate-menubar-hook causes a
9794 if (inhibit_menubar_update
)
9797 window
= FRAME_SELECTED_WINDOW (f
);
9798 w
= XWINDOW (window
);
9800 if (FRAME_WINDOW_P (f
)
9802 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9803 || defined (HAVE_NS) || defined (USE_GTK)
9804 FRAME_EXTERNAL_MENU_BAR (f
)
9806 FRAME_MENU_BAR_LINES (f
) > 0
9808 : FRAME_MENU_BAR_LINES (f
) > 0)
9810 /* If the user has switched buffers or windows, we need to
9811 recompute to reflect the new bindings. But we'll
9812 recompute when update_mode_lines is set too; that means
9813 that people can use force-mode-line-update to request
9814 that the menu bar be recomputed. The adverse effect on
9815 the rest of the redisplay algorithm is about the same as
9816 windows_or_buffers_changed anyway. */
9817 if (windows_or_buffers_changed
9818 /* This used to test w->update_mode_line, but we believe
9819 there is no need to recompute the menu in that case. */
9820 || update_mode_lines
9821 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9822 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9823 != !NILP (w
->last_had_star
))
9824 || ((!NILP (Vtransient_mark_mode
)
9825 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9826 != !NILP (w
->region_showing
)))
9828 struct buffer
*prev
= current_buffer
;
9829 int count
= SPECPDL_INDEX ();
9831 specbind (Qinhibit_menubar_update
, Qt
);
9833 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9834 if (save_match_data
)
9835 record_unwind_save_match_data ();
9836 if (NILP (Voverriding_local_map_menu_flag
))
9838 specbind (Qoverriding_terminal_local_map
, Qnil
);
9839 specbind (Qoverriding_local_map
, Qnil
);
9844 /* Run the Lucid hook. */
9845 safe_run_hooks (Qactivate_menubar_hook
);
9847 /* If it has changed current-menubar from previous value,
9848 really recompute the menu-bar from the value. */
9849 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9850 call0 (Qrecompute_lucid_menubar
);
9852 safe_run_hooks (Qmenu_bar_update_hook
);
9857 XSETFRAME (Vmenu_updating_frame
, f
);
9858 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9860 /* Redisplay the menu bar in case we changed it. */
9861 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9862 || defined (HAVE_NS) || defined (USE_GTK)
9863 if (FRAME_WINDOW_P (f
))
9865 #if defined (HAVE_NS)
9866 /* All frames on Mac OS share the same menubar. So only
9867 the selected frame should be allowed to set it. */
9868 if (f
== SELECTED_FRAME ())
9870 set_frame_menubar (f
, 0, 0);
9873 /* On a terminal screen, the menu bar is an ordinary screen
9874 line, and this makes it get updated. */
9875 w
->update_mode_line
= Qt
;
9876 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9877 /* In the non-toolkit version, the menu bar is an ordinary screen
9878 line, and this makes it get updated. */
9879 w
->update_mode_line
= Qt
;
9880 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9882 unbind_to (count
, Qnil
);
9883 set_buffer_internal_1 (prev
);
9892 /***********************************************************************
9894 ***********************************************************************/
9896 #ifdef HAVE_WINDOW_SYSTEM
9899 Nominal cursor position -- where to draw output.
9900 HPOS and VPOS are window relative glyph matrix coordinates.
9901 X and Y are window relative pixel coordinates. */
9903 struct cursor_pos output_cursor
;
9907 Set the global variable output_cursor to CURSOR. All cursor
9908 positions are relative to updated_window. */
9911 set_output_cursor (struct cursor_pos
*cursor
)
9913 output_cursor
.hpos
= cursor
->hpos
;
9914 output_cursor
.vpos
= cursor
->vpos
;
9915 output_cursor
.x
= cursor
->x
;
9916 output_cursor
.y
= cursor
->y
;
9921 Set a nominal cursor position.
9923 HPOS and VPOS are column/row positions in a window glyph matrix. X
9924 and Y are window text area relative pixel positions.
9926 If this is done during an update, updated_window will contain the
9927 window that is being updated and the position is the future output
9928 cursor position for that window. If updated_window is null, use
9929 selected_window and display the cursor at the given position. */
9932 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9936 /* If updated_window is not set, work on selected_window. */
9940 w
= XWINDOW (selected_window
);
9942 /* Set the output cursor. */
9943 output_cursor
.hpos
= hpos
;
9944 output_cursor
.vpos
= vpos
;
9945 output_cursor
.x
= x
;
9946 output_cursor
.y
= y
;
9948 /* If not called as part of an update, really display the cursor.
9949 This will also set the cursor position of W. */
9950 if (updated_window
== NULL
)
9953 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9954 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9955 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9960 #endif /* HAVE_WINDOW_SYSTEM */
9963 /***********************************************************************
9965 ***********************************************************************/
9967 #ifdef HAVE_WINDOW_SYSTEM
9969 /* Where the mouse was last time we reported a mouse event. */
9971 FRAME_PTR last_mouse_frame
;
9973 /* Tool-bar item index of the item on which a mouse button was pressed
9976 int last_tool_bar_item
;
9980 update_tool_bar_unwind (Lisp_Object frame
)
9982 selected_frame
= frame
;
9986 /* Update the tool-bar item list for frame F. This has to be done
9987 before we start to fill in any display lines. Called from
9988 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9989 and restore it here. */
9992 update_tool_bar (struct frame
*f
, int save_match_data
)
9994 #if defined (USE_GTK) || defined (HAVE_NS)
9995 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9997 int do_update
= WINDOWP (f
->tool_bar_window
)
9998 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10003 Lisp_Object window
;
10006 window
= FRAME_SELECTED_WINDOW (f
);
10007 w
= XWINDOW (window
);
10009 /* If the user has switched buffers or windows, we need to
10010 recompute to reflect the new bindings. But we'll
10011 recompute when update_mode_lines is set too; that means
10012 that people can use force-mode-line-update to request
10013 that the menu bar be recomputed. The adverse effect on
10014 the rest of the redisplay algorithm is about the same as
10015 windows_or_buffers_changed anyway. */
10016 if (windows_or_buffers_changed
10017 || !NILP (w
->update_mode_line
)
10018 || update_mode_lines
10019 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10020 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10021 != !NILP (w
->last_had_star
))
10022 || ((!NILP (Vtransient_mark_mode
)
10023 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10024 != !NILP (w
->region_showing
)))
10026 struct buffer
*prev
= current_buffer
;
10027 int count
= SPECPDL_INDEX ();
10028 Lisp_Object frame
, new_tool_bar
;
10029 int new_n_tool_bar
;
10030 struct gcpro gcpro1
;
10032 /* Set current_buffer to the buffer of the selected
10033 window of the frame, so that we get the right local
10035 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10037 /* Save match data, if we must. */
10038 if (save_match_data
)
10039 record_unwind_save_match_data ();
10041 /* Make sure that we don't accidentally use bogus keymaps. */
10042 if (NILP (Voverriding_local_map_menu_flag
))
10044 specbind (Qoverriding_terminal_local_map
, Qnil
);
10045 specbind (Qoverriding_local_map
, Qnil
);
10048 GCPRO1 (new_tool_bar
);
10050 /* We must temporarily set the selected frame to this frame
10051 before calling tool_bar_items, because the calculation of
10052 the tool-bar keymap uses the selected frame (see
10053 `tool-bar-make-keymap' in tool-bar.el). */
10054 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10055 XSETFRAME (frame
, f
);
10056 selected_frame
= frame
;
10058 /* Build desired tool-bar items from keymaps. */
10059 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10062 /* Redisplay the tool-bar if we changed it. */
10063 if (new_n_tool_bar
!= f
->n_tool_bar_items
10064 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10066 /* Redisplay that happens asynchronously due to an expose event
10067 may access f->tool_bar_items. Make sure we update both
10068 variables within BLOCK_INPUT so no such event interrupts. */
10070 f
->tool_bar_items
= new_tool_bar
;
10071 f
->n_tool_bar_items
= new_n_tool_bar
;
10072 w
->update_mode_line
= Qt
;
10078 unbind_to (count
, Qnil
);
10079 set_buffer_internal_1 (prev
);
10085 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10086 F's desired tool-bar contents. F->tool_bar_items must have
10087 been set up previously by calling prepare_menu_bars. */
10090 build_desired_tool_bar_string (struct frame
*f
)
10092 int i
, size
, size_needed
;
10093 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10094 Lisp_Object image
, plist
, props
;
10096 image
= plist
= props
= Qnil
;
10097 GCPRO3 (image
, plist
, props
);
10099 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10100 Otherwise, make a new string. */
10102 /* The size of the string we might be able to reuse. */
10103 size
= (STRINGP (f
->desired_tool_bar_string
)
10104 ? SCHARS (f
->desired_tool_bar_string
)
10107 /* We need one space in the string for each image. */
10108 size_needed
= f
->n_tool_bar_items
;
10110 /* Reuse f->desired_tool_bar_string, if possible. */
10111 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10112 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10113 make_number (' '));
10116 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10117 Fremove_text_properties (make_number (0), make_number (size
),
10118 props
, f
->desired_tool_bar_string
);
10121 /* Put a `display' property on the string for the images to display,
10122 put a `menu_item' property on tool-bar items with a value that
10123 is the index of the item in F's tool-bar item vector. */
10124 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10126 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10128 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10129 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10130 int hmargin
, vmargin
, relief
, idx
, end
;
10132 /* If image is a vector, choose the image according to the
10134 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10135 if (VECTORP (image
))
10139 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10140 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10143 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10144 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10146 xassert (ASIZE (image
) >= idx
);
10147 image
= AREF (image
, idx
);
10152 /* Ignore invalid image specifications. */
10153 if (!valid_image_p (image
))
10156 /* Display the tool-bar button pressed, or depressed. */
10157 plist
= Fcopy_sequence (XCDR (image
));
10159 /* Compute margin and relief to draw. */
10160 relief
= (tool_bar_button_relief
>= 0
10161 ? tool_bar_button_relief
10162 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10163 hmargin
= vmargin
= relief
;
10165 if (INTEGERP (Vtool_bar_button_margin
)
10166 && XINT (Vtool_bar_button_margin
) > 0)
10168 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10169 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10171 else if (CONSP (Vtool_bar_button_margin
))
10173 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10174 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10175 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10177 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10178 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10179 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10182 if (auto_raise_tool_bar_buttons_p
)
10184 /* Add a `:relief' property to the image spec if the item is
10188 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10195 /* If image is selected, display it pressed, i.e. with a
10196 negative relief. If it's not selected, display it with a
10198 plist
= Fplist_put (plist
, QCrelief
,
10200 ? make_number (-relief
)
10201 : make_number (relief
)));
10206 /* Put a margin around the image. */
10207 if (hmargin
|| vmargin
)
10209 if (hmargin
== vmargin
)
10210 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10212 plist
= Fplist_put (plist
, QCmargin
,
10213 Fcons (make_number (hmargin
),
10214 make_number (vmargin
)));
10217 /* If button is not enabled, and we don't have special images
10218 for the disabled state, make the image appear disabled by
10219 applying an appropriate algorithm to it. */
10220 if (!enabled_p
&& idx
< 0)
10221 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10223 /* Put a `display' text property on the string for the image to
10224 display. Put a `menu-item' property on the string that gives
10225 the start of this item's properties in the tool-bar items
10227 image
= Fcons (Qimage
, plist
);
10228 props
= list4 (Qdisplay
, image
,
10229 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10231 /* Let the last image hide all remaining spaces in the tool bar
10232 string. The string can be longer than needed when we reuse a
10233 previous string. */
10234 if (i
+ 1 == f
->n_tool_bar_items
)
10235 end
= SCHARS (f
->desired_tool_bar_string
);
10238 Fadd_text_properties (make_number (i
), make_number (end
),
10239 props
, f
->desired_tool_bar_string
);
10247 /* Display one line of the tool-bar of frame IT->f.
10249 HEIGHT specifies the desired height of the tool-bar line.
10250 If the actual height of the glyph row is less than HEIGHT, the
10251 row's height is increased to HEIGHT, and the icons are centered
10252 vertically in the new height.
10254 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10255 count a final empty row in case the tool-bar width exactly matches
10260 display_tool_bar_line (struct it
*it
, int height
)
10262 struct glyph_row
*row
= it
->glyph_row
;
10263 int max_x
= it
->last_visible_x
;
10264 struct glyph
*last
;
10266 prepare_desired_row (row
);
10267 row
->y
= it
->current_y
;
10269 /* Note that this isn't made use of if the face hasn't a box,
10270 so there's no need to check the face here. */
10271 it
->start_of_box_run_p
= 1;
10273 while (it
->current_x
< max_x
)
10275 int x
, n_glyphs_before
, i
, nglyphs
;
10276 struct it it_before
;
10278 /* Get the next display element. */
10279 if (!get_next_display_element (it
))
10281 /* Don't count empty row if we are counting needed tool-bar lines. */
10282 if (height
< 0 && !it
->hpos
)
10287 /* Produce glyphs. */
10288 n_glyphs_before
= row
->used
[TEXT_AREA
];
10291 PRODUCE_GLYPHS (it
);
10293 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10295 x
= it_before
.current_x
;
10296 while (i
< nglyphs
)
10298 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10300 if (x
+ glyph
->pixel_width
> max_x
)
10302 /* Glyph doesn't fit on line. Backtrack. */
10303 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10305 /* If this is the only glyph on this line, it will never fit on the
10306 tool-bar, so skip it. But ensure there is at least one glyph,
10307 so we don't accidentally disable the tool-bar. */
10308 if (n_glyphs_before
== 0
10309 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10315 x
+= glyph
->pixel_width
;
10319 /* Stop at line ends. */
10320 if (ITERATOR_AT_END_OF_LINE_P (it
))
10323 set_iterator_to_next (it
, 1);
10328 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10330 /* Use default face for the border below the tool bar.
10332 FIXME: When auto-resize-tool-bars is grow-only, there is
10333 no additional border below the possibly empty tool-bar lines.
10334 So to make the extra empty lines look "normal", we have to
10335 use the tool-bar face for the border too. */
10336 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10337 it
->face_id
= DEFAULT_FACE_ID
;
10339 extend_face_to_end_of_line (it
);
10340 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10341 last
->right_box_line_p
= 1;
10342 if (last
== row
->glyphs
[TEXT_AREA
])
10343 last
->left_box_line_p
= 1;
10345 /* Make line the desired height and center it vertically. */
10346 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10348 /* Don't add more than one line height. */
10349 height
%= FRAME_LINE_HEIGHT (it
->f
);
10350 it
->max_ascent
+= height
/ 2;
10351 it
->max_descent
+= (height
+ 1) / 2;
10354 compute_line_metrics (it
);
10356 /* If line is empty, make it occupy the rest of the tool-bar. */
10357 if (!row
->displays_text_p
)
10359 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10360 row
->visible_height
= row
->height
;
10361 row
->ascent
= row
->phys_ascent
= 0;
10362 row
->extra_line_spacing
= 0;
10365 row
->full_width_p
= 1;
10366 row
->continued_p
= 0;
10367 row
->truncated_on_left_p
= 0;
10368 row
->truncated_on_right_p
= 0;
10370 it
->current_x
= it
->hpos
= 0;
10371 it
->current_y
+= row
->height
;
10377 /* Max tool-bar height. */
10379 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10380 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10382 /* Value is the number of screen lines needed to make all tool-bar
10383 items of frame F visible. The number of actual rows needed is
10384 returned in *N_ROWS if non-NULL. */
10387 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10389 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10391 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10392 the desired matrix, so use (unused) mode-line row as temporary row to
10393 avoid destroying the first tool-bar row. */
10394 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10396 /* Initialize an iterator for iteration over
10397 F->desired_tool_bar_string in the tool-bar window of frame F. */
10398 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10399 it
.first_visible_x
= 0;
10400 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10401 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10403 while (!ITERATOR_AT_END_P (&it
))
10405 clear_glyph_row (temp_row
);
10406 it
.glyph_row
= temp_row
;
10407 display_tool_bar_line (&it
, -1);
10409 clear_glyph_row (temp_row
);
10411 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10413 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10415 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10419 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10421 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10422 (Lisp_Object frame
)
10429 frame
= selected_frame
;
10431 CHECK_FRAME (frame
);
10432 f
= XFRAME (frame
);
10434 if (WINDOWP (f
->tool_bar_window
)
10435 || (w
= XWINDOW (f
->tool_bar_window
),
10436 WINDOW_TOTAL_LINES (w
) > 0))
10438 update_tool_bar (f
, 1);
10439 if (f
->n_tool_bar_items
)
10441 build_desired_tool_bar_string (f
);
10442 nlines
= tool_bar_lines_needed (f
, NULL
);
10446 return make_number (nlines
);
10450 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10451 height should be changed. */
10454 redisplay_tool_bar (struct frame
*f
)
10458 struct glyph_row
*row
;
10460 #if defined (USE_GTK) || defined (HAVE_NS)
10461 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10462 update_frame_tool_bar (f
);
10466 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10467 do anything. This means you must start with tool-bar-lines
10468 non-zero to get the auto-sizing effect. Or in other words, you
10469 can turn off tool-bars by specifying tool-bar-lines zero. */
10470 if (!WINDOWP (f
->tool_bar_window
)
10471 || (w
= XWINDOW (f
->tool_bar_window
),
10472 WINDOW_TOTAL_LINES (w
) == 0))
10475 /* Set up an iterator for the tool-bar window. */
10476 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10477 it
.first_visible_x
= 0;
10478 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10479 row
= it
.glyph_row
;
10481 /* Build a string that represents the contents of the tool-bar. */
10482 build_desired_tool_bar_string (f
);
10483 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10485 if (f
->n_tool_bar_rows
== 0)
10489 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10490 nlines
!= WINDOW_TOTAL_LINES (w
)))
10493 int old_height
= WINDOW_TOTAL_LINES (w
);
10495 XSETFRAME (frame
, f
);
10496 Fmodify_frame_parameters (frame
,
10497 Fcons (Fcons (Qtool_bar_lines
,
10498 make_number (nlines
)),
10500 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10502 clear_glyph_matrix (w
->desired_matrix
);
10503 fonts_changed_p
= 1;
10509 /* Display as many lines as needed to display all tool-bar items. */
10511 if (f
->n_tool_bar_rows
> 0)
10513 int border
, rows
, height
, extra
;
10515 if (INTEGERP (Vtool_bar_border
))
10516 border
= XINT (Vtool_bar_border
);
10517 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10518 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10519 else if (EQ (Vtool_bar_border
, Qborder_width
))
10520 border
= f
->border_width
;
10526 rows
= f
->n_tool_bar_rows
;
10527 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10528 extra
= it
.last_visible_y
- border
- height
* rows
;
10530 while (it
.current_y
< it
.last_visible_y
)
10533 if (extra
> 0 && rows
-- > 0)
10535 h
= (extra
+ rows
- 1) / rows
;
10538 display_tool_bar_line (&it
, height
+ h
);
10543 while (it
.current_y
< it
.last_visible_y
)
10544 display_tool_bar_line (&it
, 0);
10547 /* It doesn't make much sense to try scrolling in the tool-bar
10548 window, so don't do it. */
10549 w
->desired_matrix
->no_scrolling_p
= 1;
10550 w
->must_be_updated_p
= 1;
10552 if (!NILP (Vauto_resize_tool_bars
))
10554 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10555 int change_height_p
= 0;
10557 /* If we couldn't display everything, change the tool-bar's
10558 height if there is room for more. */
10559 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10560 && it
.current_y
< max_tool_bar_height
)
10561 change_height_p
= 1;
10563 row
= it
.glyph_row
- 1;
10565 /* If there are blank lines at the end, except for a partially
10566 visible blank line at the end that is smaller than
10567 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10568 if (!row
->displays_text_p
10569 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10570 change_height_p
= 1;
10572 /* If row displays tool-bar items, but is partially visible,
10573 change the tool-bar's height. */
10574 if (row
->displays_text_p
10575 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10576 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10577 change_height_p
= 1;
10579 /* Resize windows as needed by changing the `tool-bar-lines'
10580 frame parameter. */
10581 if (change_height_p
)
10584 int old_height
= WINDOW_TOTAL_LINES (w
);
10586 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10588 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10589 && !f
->minimize_tool_bar_window_p
)
10590 ? (nlines
> old_height
)
10591 : (nlines
!= old_height
));
10592 f
->minimize_tool_bar_window_p
= 0;
10594 if (change_height_p
)
10596 XSETFRAME (frame
, f
);
10597 Fmodify_frame_parameters (frame
,
10598 Fcons (Fcons (Qtool_bar_lines
,
10599 make_number (nlines
)),
10601 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10603 clear_glyph_matrix (w
->desired_matrix
);
10604 f
->n_tool_bar_rows
= nrows
;
10605 fonts_changed_p
= 1;
10612 f
->minimize_tool_bar_window_p
= 0;
10617 /* Get information about the tool-bar item which is displayed in GLYPH
10618 on frame F. Return in *PROP_IDX the index where tool-bar item
10619 properties start in F->tool_bar_items. Value is zero if
10620 GLYPH doesn't display a tool-bar item. */
10623 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10629 /* This function can be called asynchronously, which means we must
10630 exclude any possibility that Fget_text_property signals an
10632 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10633 charpos
= max (0, charpos
);
10635 /* Get the text property `menu-item' at pos. The value of that
10636 property is the start index of this item's properties in
10637 F->tool_bar_items. */
10638 prop
= Fget_text_property (make_number (charpos
),
10639 Qmenu_item
, f
->current_tool_bar_string
);
10640 if (INTEGERP (prop
))
10642 *prop_idx
= XINT (prop
);
10652 /* Get information about the tool-bar item at position X/Y on frame F.
10653 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10654 the current matrix of the tool-bar window of F, or NULL if not
10655 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10656 item in F->tool_bar_items. Value is
10658 -1 if X/Y is not on a tool-bar item
10659 0 if X/Y is on the same item that was highlighted before.
10663 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10664 int *hpos
, int *vpos
, int *prop_idx
)
10666 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10667 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10670 /* Find the glyph under X/Y. */
10671 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10672 if (*glyph
== NULL
)
10675 /* Get the start of this tool-bar item's properties in
10676 f->tool_bar_items. */
10677 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10680 /* Is mouse on the highlighted item? */
10681 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10682 && *vpos
>= hlinfo
->mouse_face_beg_row
10683 && *vpos
<= hlinfo
->mouse_face_end_row
10684 && (*vpos
> hlinfo
->mouse_face_beg_row
10685 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10686 && (*vpos
< hlinfo
->mouse_face_end_row
10687 || *hpos
< hlinfo
->mouse_face_end_col
10688 || hlinfo
->mouse_face_past_end
))
10696 Handle mouse button event on the tool-bar of frame F, at
10697 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10698 0 for button release. MODIFIERS is event modifiers for button
10702 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10703 unsigned int modifiers
)
10705 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10706 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10707 int hpos
, vpos
, prop_idx
;
10708 struct glyph
*glyph
;
10709 Lisp_Object enabled_p
;
10711 /* If not on the highlighted tool-bar item, return. */
10712 frame_to_window_pixel_xy (w
, &x
, &y
);
10713 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10716 /* If item is disabled, do nothing. */
10717 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10718 if (NILP (enabled_p
))
10723 /* Show item in pressed state. */
10724 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10725 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10726 last_tool_bar_item
= prop_idx
;
10730 Lisp_Object key
, frame
;
10731 struct input_event event
;
10732 EVENT_INIT (event
);
10734 /* Show item in released state. */
10735 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10736 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10738 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10740 XSETFRAME (frame
, f
);
10741 event
.kind
= TOOL_BAR_EVENT
;
10742 event
.frame_or_window
= frame
;
10744 kbd_buffer_store_event (&event
);
10746 event
.kind
= TOOL_BAR_EVENT
;
10747 event
.frame_or_window
= frame
;
10749 event
.modifiers
= modifiers
;
10750 kbd_buffer_store_event (&event
);
10751 last_tool_bar_item
= -1;
10756 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10757 tool-bar window-relative coordinates X/Y. Called from
10758 note_mouse_highlight. */
10761 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10763 Lisp_Object window
= f
->tool_bar_window
;
10764 struct window
*w
= XWINDOW (window
);
10765 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10766 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10768 struct glyph
*glyph
;
10769 struct glyph_row
*row
;
10771 Lisp_Object enabled_p
;
10773 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10774 int mouse_down_p
, rc
;
10776 /* Function note_mouse_highlight is called with negative X/Y
10777 values when mouse moves outside of the frame. */
10778 if (x
<= 0 || y
<= 0)
10780 clear_mouse_face (hlinfo
);
10784 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10787 /* Not on tool-bar item. */
10788 clear_mouse_face (hlinfo
);
10792 /* On same tool-bar item as before. */
10793 goto set_help_echo
;
10795 clear_mouse_face (hlinfo
);
10797 /* Mouse is down, but on different tool-bar item? */
10798 mouse_down_p
= (dpyinfo
->grabbed
10799 && f
== last_mouse_frame
10800 && FRAME_LIVE_P (f
));
10802 && last_tool_bar_item
!= prop_idx
)
10805 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10806 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10808 /* If tool-bar item is not enabled, don't highlight it. */
10809 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10810 if (!NILP (enabled_p
))
10812 /* Compute the x-position of the glyph. In front and past the
10813 image is a space. We include this in the highlighted area. */
10814 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10815 for (i
= x
= 0; i
< hpos
; ++i
)
10816 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10818 /* Record this as the current active region. */
10819 hlinfo
->mouse_face_beg_col
= hpos
;
10820 hlinfo
->mouse_face_beg_row
= vpos
;
10821 hlinfo
->mouse_face_beg_x
= x
;
10822 hlinfo
->mouse_face_beg_y
= row
->y
;
10823 hlinfo
->mouse_face_past_end
= 0;
10825 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10826 hlinfo
->mouse_face_end_row
= vpos
;
10827 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10828 hlinfo
->mouse_face_end_y
= row
->y
;
10829 hlinfo
->mouse_face_window
= window
;
10830 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10832 /* Display it as active. */
10833 show_mouse_face (hlinfo
, draw
);
10834 hlinfo
->mouse_face_image_state
= draw
;
10839 /* Set help_echo_string to a help string to display for this tool-bar item.
10840 XTread_socket does the rest. */
10841 help_echo_object
= help_echo_window
= Qnil
;
10842 help_echo_pos
= -1;
10843 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10844 if (NILP (help_echo_string
))
10845 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10848 #endif /* HAVE_WINDOW_SYSTEM */
10852 /************************************************************************
10853 Horizontal scrolling
10854 ************************************************************************/
10856 static int hscroll_window_tree (Lisp_Object
);
10857 static int hscroll_windows (Lisp_Object
);
10859 /* For all leaf windows in the window tree rooted at WINDOW, set their
10860 hscroll value so that PT is (i) visible in the window, and (ii) so
10861 that it is not within a certain margin at the window's left and
10862 right border. Value is non-zero if any window's hscroll has been
10866 hscroll_window_tree (Lisp_Object window
)
10868 int hscrolled_p
= 0;
10869 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10870 int hscroll_step_abs
= 0;
10871 double hscroll_step_rel
= 0;
10873 if (hscroll_relative_p
)
10875 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10876 if (hscroll_step_rel
< 0)
10878 hscroll_relative_p
= 0;
10879 hscroll_step_abs
= 0;
10882 else if (INTEGERP (Vhscroll_step
))
10884 hscroll_step_abs
= XINT (Vhscroll_step
);
10885 if (hscroll_step_abs
< 0)
10886 hscroll_step_abs
= 0;
10889 hscroll_step_abs
= 0;
10891 while (WINDOWP (window
))
10893 struct window
*w
= XWINDOW (window
);
10895 if (WINDOWP (w
->hchild
))
10896 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10897 else if (WINDOWP (w
->vchild
))
10898 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10899 else if (w
->cursor
.vpos
>= 0)
10902 int text_area_width
;
10903 struct glyph_row
*current_cursor_row
10904 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10905 struct glyph_row
*desired_cursor_row
10906 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10907 struct glyph_row
*cursor_row
10908 = (desired_cursor_row
->enabled_p
10909 ? desired_cursor_row
10910 : current_cursor_row
);
10912 text_area_width
= window_box_width (w
, TEXT_AREA
);
10914 /* Scroll when cursor is inside this scroll margin. */
10915 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10917 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10918 && ((XFASTINT (w
->hscroll
)
10919 && w
->cursor
.x
<= h_margin
)
10920 || (cursor_row
->enabled_p
10921 && cursor_row
->truncated_on_right_p
10922 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10926 struct buffer
*saved_current_buffer
;
10930 /* Find point in a display of infinite width. */
10931 saved_current_buffer
= current_buffer
;
10932 current_buffer
= XBUFFER (w
->buffer
);
10934 if (w
== XWINDOW (selected_window
))
10938 pt
= marker_position (w
->pointm
);
10939 pt
= max (BEGV
, pt
);
10943 /* Move iterator to pt starting at cursor_row->start in
10944 a line with infinite width. */
10945 init_to_row_start (&it
, w
, cursor_row
);
10946 it
.last_visible_x
= INFINITY
;
10947 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10948 current_buffer
= saved_current_buffer
;
10950 /* Position cursor in window. */
10951 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10952 hscroll
= max (0, (it
.current_x
10953 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10954 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10955 : (text_area_width
/ 2))))
10956 / FRAME_COLUMN_WIDTH (it
.f
);
10957 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10959 if (hscroll_relative_p
)
10960 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10963 wanted_x
= text_area_width
10964 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10967 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10971 if (hscroll_relative_p
)
10972 wanted_x
= text_area_width
* hscroll_step_rel
10975 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10978 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10980 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10982 /* Don't call Fset_window_hscroll if value hasn't
10983 changed because it will prevent redisplay
10985 if (XFASTINT (w
->hscroll
) != hscroll
)
10987 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10988 w
->hscroll
= make_number (hscroll
);
10997 /* Value is non-zero if hscroll of any leaf window has been changed. */
10998 return hscrolled_p
;
11002 /* Set hscroll so that cursor is visible and not inside horizontal
11003 scroll margins for all windows in the tree rooted at WINDOW. See
11004 also hscroll_window_tree above. Value is non-zero if any window's
11005 hscroll has been changed. If it has, desired matrices on the frame
11006 of WINDOW are cleared. */
11009 hscroll_windows (Lisp_Object window
)
11011 int hscrolled_p
= hscroll_window_tree (window
);
11013 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11014 return hscrolled_p
;
11019 /************************************************************************
11021 ************************************************************************/
11023 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11024 to a non-zero value. This is sometimes handy to have in a debugger
11029 /* First and last unchanged row for try_window_id. */
11031 int debug_first_unchanged_at_end_vpos
;
11032 int debug_last_unchanged_at_beg_vpos
;
11034 /* Delta vpos and y. */
11036 int debug_dvpos
, debug_dy
;
11038 /* Delta in characters and bytes for try_window_id. */
11040 EMACS_INT debug_delta
, debug_delta_bytes
;
11042 /* Values of window_end_pos and window_end_vpos at the end of
11045 EMACS_INT debug_end_vpos
;
11047 /* Append a string to W->desired_matrix->method. FMT is a printf
11048 format string. A1...A9 are a supplement for a variable-length
11049 argument list. If trace_redisplay_p is non-zero also printf the
11050 resulting string to stderr. */
11053 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11056 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11059 char *method
= w
->desired_matrix
->method
;
11060 int len
= strlen (method
);
11061 int size
= sizeof w
->desired_matrix
->method
;
11062 int remaining
= size
- len
- 1;
11064 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11065 if (len
&& remaining
)
11068 --remaining
, ++len
;
11071 strncpy (method
+ len
, buffer
, remaining
);
11073 if (trace_redisplay_p
)
11074 fprintf (stderr
, "%p (%s): %s\n",
11076 ((BUFFERP (w
->buffer
)
11077 && STRINGP (XBUFFER (w
->buffer
)->name
))
11078 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11083 #endif /* GLYPH_DEBUG */
11086 /* Value is non-zero if all changes in window W, which displays
11087 current_buffer, are in the text between START and END. START is a
11088 buffer position, END is given as a distance from Z. Used in
11089 redisplay_internal for display optimization. */
11092 text_outside_line_unchanged_p (struct window
*w
,
11093 EMACS_INT start
, EMACS_INT end
)
11095 int unchanged_p
= 1;
11097 /* If text or overlays have changed, see where. */
11098 if (XFASTINT (w
->last_modified
) < MODIFF
11099 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11101 /* Gap in the line? */
11102 if (GPT
< start
|| Z
- GPT
< end
)
11105 /* Changes start in front of the line, or end after it? */
11107 && (BEG_UNCHANGED
< start
- 1
11108 || END_UNCHANGED
< end
))
11111 /* If selective display, can't optimize if changes start at the
11112 beginning of the line. */
11114 && INTEGERP (BVAR (current_buffer
, selective_display
))
11115 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11116 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11119 /* If there are overlays at the start or end of the line, these
11120 may have overlay strings with newlines in them. A change at
11121 START, for instance, may actually concern the display of such
11122 overlay strings as well, and they are displayed on different
11123 lines. So, quickly rule out this case. (For the future, it
11124 might be desirable to implement something more telling than
11125 just BEG/END_UNCHANGED.) */
11128 if (BEG
+ BEG_UNCHANGED
== start
11129 && overlay_touches_p (start
))
11131 if (END_UNCHANGED
== end
11132 && overlay_touches_p (Z
- end
))
11136 /* Under bidi reordering, adding or deleting a character in the
11137 beginning of a paragraph, before the first strong directional
11138 character, can change the base direction of the paragraph (unless
11139 the buffer specifies a fixed paragraph direction), which will
11140 require to redisplay the whole paragraph. It might be worthwhile
11141 to find the paragraph limits and widen the range of redisplayed
11142 lines to that, but for now just give up this optimization. */
11143 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11144 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11148 return unchanged_p
;
11152 /* Do a frame update, taking possible shortcuts into account. This is
11153 the main external entry point for redisplay.
11155 If the last redisplay displayed an echo area message and that message
11156 is no longer requested, we clear the echo area or bring back the
11157 mini-buffer if that is in use. */
11162 redisplay_internal ();
11167 overlay_arrow_string_or_property (Lisp_Object var
)
11171 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11174 return Voverlay_arrow_string
;
11177 /* Return 1 if there are any overlay-arrows in current_buffer. */
11179 overlay_arrow_in_current_buffer_p (void)
11183 for (vlist
= Voverlay_arrow_variable_list
;
11185 vlist
= XCDR (vlist
))
11187 Lisp_Object var
= XCAR (vlist
);
11190 if (!SYMBOLP (var
))
11192 val
= find_symbol_value (var
);
11194 && current_buffer
== XMARKER (val
)->buffer
)
11201 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11205 overlay_arrows_changed_p (void)
11209 for (vlist
= Voverlay_arrow_variable_list
;
11211 vlist
= XCDR (vlist
))
11213 Lisp_Object var
= XCAR (vlist
);
11214 Lisp_Object val
, pstr
;
11216 if (!SYMBOLP (var
))
11218 val
= find_symbol_value (var
);
11219 if (!MARKERP (val
))
11221 if (! EQ (COERCE_MARKER (val
),
11222 Fget (var
, Qlast_arrow_position
))
11223 || ! (pstr
= overlay_arrow_string_or_property (var
),
11224 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11230 /* Mark overlay arrows to be updated on next redisplay. */
11233 update_overlay_arrows (int up_to_date
)
11237 for (vlist
= Voverlay_arrow_variable_list
;
11239 vlist
= XCDR (vlist
))
11241 Lisp_Object var
= XCAR (vlist
);
11243 if (!SYMBOLP (var
))
11246 if (up_to_date
> 0)
11248 Lisp_Object val
= find_symbol_value (var
);
11249 Fput (var
, Qlast_arrow_position
,
11250 COERCE_MARKER (val
));
11251 Fput (var
, Qlast_arrow_string
,
11252 overlay_arrow_string_or_property (var
));
11254 else if (up_to_date
< 0
11255 || !NILP (Fget (var
, Qlast_arrow_position
)))
11257 Fput (var
, Qlast_arrow_position
, Qt
);
11258 Fput (var
, Qlast_arrow_string
, Qt
);
11264 /* Return overlay arrow string to display at row.
11265 Return integer (bitmap number) for arrow bitmap in left fringe.
11266 Return nil if no overlay arrow. */
11269 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11273 for (vlist
= Voverlay_arrow_variable_list
;
11275 vlist
= XCDR (vlist
))
11277 Lisp_Object var
= XCAR (vlist
);
11280 if (!SYMBOLP (var
))
11283 val
= find_symbol_value (var
);
11286 && current_buffer
== XMARKER (val
)->buffer
11287 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11289 if (FRAME_WINDOW_P (it
->f
)
11290 /* FIXME: if ROW->reversed_p is set, this should test
11291 the right fringe, not the left one. */
11292 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11294 #ifdef HAVE_WINDOW_SYSTEM
11295 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11298 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11299 return make_number (fringe_bitmap
);
11302 return make_number (-1); /* Use default arrow bitmap */
11304 return overlay_arrow_string_or_property (var
);
11311 /* Return 1 if point moved out of or into a composition. Otherwise
11312 return 0. PREV_BUF and PREV_PT are the last point buffer and
11313 position. BUF and PT are the current point buffer and position. */
11316 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11317 struct buffer
*buf
, EMACS_INT pt
)
11319 EMACS_INT start
, end
;
11321 Lisp_Object buffer
;
11323 XSETBUFFER (buffer
, buf
);
11324 /* Check a composition at the last point if point moved within the
11326 if (prev_buf
== buf
)
11329 /* Point didn't move. */
11332 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11333 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11334 && COMPOSITION_VALID_P (start
, end
, prop
)
11335 && start
< prev_pt
&& end
> prev_pt
)
11336 /* The last point was within the composition. Return 1 iff
11337 point moved out of the composition. */
11338 return (pt
<= start
|| pt
>= end
);
11341 /* Check a composition at the current point. */
11342 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11343 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11344 && COMPOSITION_VALID_P (start
, end
, prop
)
11345 && start
< pt
&& end
> pt
);
11349 /* Reconsider the setting of B->clip_changed which is displayed
11353 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11355 if (b
->clip_changed
11356 && !NILP (w
->window_end_valid
)
11357 && w
->current_matrix
->buffer
== b
11358 && w
->current_matrix
->zv
== BUF_ZV (b
)
11359 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11360 b
->clip_changed
= 0;
11362 /* If display wasn't paused, and W is not a tool bar window, see if
11363 point has been moved into or out of a composition. In that case,
11364 we set b->clip_changed to 1 to force updating the screen. If
11365 b->clip_changed has already been set to 1, we can skip this
11367 if (!b
->clip_changed
11368 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11372 if (w
== XWINDOW (selected_window
))
11375 pt
= marker_position (w
->pointm
);
11377 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11378 || pt
!= XINT (w
->last_point
))
11379 && check_point_in_composition (w
->current_matrix
->buffer
,
11380 XINT (w
->last_point
),
11381 XBUFFER (w
->buffer
), pt
))
11382 b
->clip_changed
= 1;
11387 /* Select FRAME to forward the values of frame-local variables into C
11388 variables so that the redisplay routines can access those values
11392 select_frame_for_redisplay (Lisp_Object frame
)
11394 Lisp_Object tail
, tem
;
11395 Lisp_Object old
= selected_frame
;
11396 struct Lisp_Symbol
*sym
;
11398 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11400 selected_frame
= frame
;
11403 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11404 if (CONSP (XCAR (tail
))
11405 && (tem
= XCAR (XCAR (tail
)),
11407 && (sym
= indirect_variable (XSYMBOL (tem
)),
11408 sym
->redirect
== SYMBOL_LOCALIZED
)
11409 && sym
->val
.blv
->frame_local
)
11410 /* Use find_symbol_value rather than Fsymbol_value
11411 to avoid an error if it is void. */
11412 find_symbol_value (tem
);
11413 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11417 #define STOP_POLLING \
11418 do { if (! polling_stopped_here) stop_polling (); \
11419 polling_stopped_here = 1; } while (0)
11421 #define RESUME_POLLING \
11422 do { if (polling_stopped_here) start_polling (); \
11423 polling_stopped_here = 0; } while (0)
11426 /* Perhaps in the future avoid recentering windows if it
11427 is not necessary; currently that causes some problems. */
11430 redisplay_internal (void)
11432 struct window
*w
= XWINDOW (selected_window
);
11436 int must_finish
= 0;
11437 struct text_pos tlbufpos
, tlendpos
;
11438 int number_of_visible_frames
;
11441 int polling_stopped_here
= 0;
11442 Lisp_Object old_frame
= selected_frame
;
11444 /* Non-zero means redisplay has to consider all windows on all
11445 frames. Zero means, only selected_window is considered. */
11446 int consider_all_windows_p
;
11448 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11450 /* No redisplay if running in batch mode or frame is not yet fully
11451 initialized, or redisplay is explicitly turned off by setting
11452 Vinhibit_redisplay. */
11453 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11454 || !NILP (Vinhibit_redisplay
))
11457 /* Don't examine these until after testing Vinhibit_redisplay.
11458 When Emacs is shutting down, perhaps because its connection to
11459 X has dropped, we should not look at them at all. */
11460 fr
= XFRAME (w
->frame
);
11461 sf
= SELECTED_FRAME ();
11463 if (!fr
->glyphs_initialized_p
)
11466 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11467 if (popup_activated ())
11471 /* I don't think this happens but let's be paranoid. */
11472 if (redisplaying_p
)
11475 /* Record a function that resets redisplaying_p to its old value
11476 when we leave this function. */
11477 count
= SPECPDL_INDEX ();
11478 record_unwind_protect (unwind_redisplay
,
11479 Fcons (make_number (redisplaying_p
), selected_frame
));
11481 specbind (Qinhibit_free_realized_faces
, Qnil
);
11484 Lisp_Object tail
, frame
;
11486 FOR_EACH_FRAME (tail
, frame
)
11488 struct frame
*f
= XFRAME (frame
);
11489 f
->already_hscrolled_p
= 0;
11494 /* Remember the currently selected window. */
11497 if (!EQ (old_frame
, selected_frame
)
11498 && FRAME_LIVE_P (XFRAME (old_frame
)))
11499 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11500 selected_frame and selected_window to be temporarily out-of-sync so
11501 when we come back here via `goto retry', we need to resync because we
11502 may need to run Elisp code (via prepare_menu_bars). */
11503 select_frame_for_redisplay (old_frame
);
11506 reconsider_clip_changes (w
, current_buffer
);
11507 last_escape_glyph_frame
= NULL
;
11508 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11509 last_glyphless_glyph_frame
= NULL
;
11510 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11512 /* If new fonts have been loaded that make a glyph matrix adjustment
11513 necessary, do it. */
11514 if (fonts_changed_p
)
11516 adjust_glyphs (NULL
);
11517 ++windows_or_buffers_changed
;
11518 fonts_changed_p
= 0;
11521 /* If face_change_count is non-zero, init_iterator will free all
11522 realized faces, which includes the faces referenced from current
11523 matrices. So, we can't reuse current matrices in this case. */
11524 if (face_change_count
)
11525 ++windows_or_buffers_changed
;
11527 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11528 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11530 /* Since frames on a single ASCII terminal share the same
11531 display area, displaying a different frame means redisplay
11532 the whole thing. */
11533 windows_or_buffers_changed
++;
11534 SET_FRAME_GARBAGED (sf
);
11536 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11538 FRAME_TTY (sf
)->previous_frame
= sf
;
11541 /* Set the visible flags for all frames. Do this before checking
11542 for resized or garbaged frames; they want to know if their frames
11543 are visible. See the comment in frame.h for
11544 FRAME_SAMPLE_VISIBILITY. */
11546 Lisp_Object tail
, frame
;
11548 number_of_visible_frames
= 0;
11550 FOR_EACH_FRAME (tail
, frame
)
11552 struct frame
*f
= XFRAME (frame
);
11554 FRAME_SAMPLE_VISIBILITY (f
);
11555 if (FRAME_VISIBLE_P (f
))
11556 ++number_of_visible_frames
;
11557 clear_desired_matrices (f
);
11561 /* Notice any pending interrupt request to change frame size. */
11562 do_pending_window_change (1);
11564 /* do_pending_window_change could change the selected_window due to
11565 frame resizing which makes the selected window too small. */
11566 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11569 reconsider_clip_changes (w
, current_buffer
);
11572 /* Clear frames marked as garbaged. */
11573 if (frame_garbaged
)
11574 clear_garbaged_frames ();
11576 /* Build menubar and tool-bar items. */
11577 if (NILP (Vmemory_full
))
11578 prepare_menu_bars ();
11580 if (windows_or_buffers_changed
)
11581 update_mode_lines
++;
11583 /* Detect case that we need to write or remove a star in the mode line. */
11584 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11586 w
->update_mode_line
= Qt
;
11587 if (buffer_shared
> 1)
11588 update_mode_lines
++;
11591 /* Avoid invocation of point motion hooks by `current_column' below. */
11592 count1
= SPECPDL_INDEX ();
11593 specbind (Qinhibit_point_motion_hooks
, Qt
);
11595 /* If %c is in the mode line, update it if needed. */
11596 if (!NILP (w
->column_number_displayed
)
11597 /* This alternative quickly identifies a common case
11598 where no change is needed. */
11599 && !(PT
== XFASTINT (w
->last_point
)
11600 && XFASTINT (w
->last_modified
) >= MODIFF
11601 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11602 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11603 w
->update_mode_line
= Qt
;
11605 unbind_to (count1
, Qnil
);
11607 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11609 /* The variable buffer_shared is set in redisplay_window and
11610 indicates that we redisplay a buffer in different windows. See
11612 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11613 || cursor_type_changed
);
11615 /* If specs for an arrow have changed, do thorough redisplay
11616 to ensure we remove any arrow that should no longer exist. */
11617 if (overlay_arrows_changed_p ())
11618 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11620 /* Normally the message* functions will have already displayed and
11621 updated the echo area, but the frame may have been trashed, or
11622 the update may have been preempted, so display the echo area
11623 again here. Checking message_cleared_p captures the case that
11624 the echo area should be cleared. */
11625 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11626 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11627 || (message_cleared_p
11628 && minibuf_level
== 0
11629 /* If the mini-window is currently selected, this means the
11630 echo-area doesn't show through. */
11631 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11633 int window_height_changed_p
= echo_area_display (0);
11636 /* If we don't display the current message, don't clear the
11637 message_cleared_p flag, because, if we did, we wouldn't clear
11638 the echo area in the next redisplay which doesn't preserve
11640 if (!display_last_displayed_message_p
)
11641 message_cleared_p
= 0;
11643 if (fonts_changed_p
)
11645 else if (window_height_changed_p
)
11647 consider_all_windows_p
= 1;
11648 ++update_mode_lines
;
11649 ++windows_or_buffers_changed
;
11651 /* If window configuration was changed, frames may have been
11652 marked garbaged. Clear them or we will experience
11653 surprises wrt scrolling. */
11654 if (frame_garbaged
)
11655 clear_garbaged_frames ();
11658 else if (EQ (selected_window
, minibuf_window
)
11659 && (current_buffer
->clip_changed
11660 || XFASTINT (w
->last_modified
) < MODIFF
11661 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11662 && resize_mini_window (w
, 0))
11664 /* Resized active mini-window to fit the size of what it is
11665 showing if its contents might have changed. */
11667 /* FIXME: this causes all frames to be updated, which seems unnecessary
11668 since only the current frame needs to be considered. This function needs
11669 to be rewritten with two variables, consider_all_windows and
11670 consider_all_frames. */
11671 consider_all_windows_p
= 1;
11672 ++windows_or_buffers_changed
;
11673 ++update_mode_lines
;
11675 /* If window configuration was changed, frames may have been
11676 marked garbaged. Clear them or we will experience
11677 surprises wrt scrolling. */
11678 if (frame_garbaged
)
11679 clear_garbaged_frames ();
11683 /* If showing the region, and mark has changed, we must redisplay
11684 the whole window. The assignment to this_line_start_pos prevents
11685 the optimization directly below this if-statement. */
11686 if (((!NILP (Vtransient_mark_mode
)
11687 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11688 != !NILP (w
->region_showing
))
11689 || (!NILP (w
->region_showing
)
11690 && !EQ (w
->region_showing
,
11691 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11692 CHARPOS (this_line_start_pos
) = 0;
11694 /* Optimize the case that only the line containing the cursor in the
11695 selected window has changed. Variables starting with this_ are
11696 set in display_line and record information about the line
11697 containing the cursor. */
11698 tlbufpos
= this_line_start_pos
;
11699 tlendpos
= this_line_end_pos
;
11700 if (!consider_all_windows_p
11701 && CHARPOS (tlbufpos
) > 0
11702 && NILP (w
->update_mode_line
)
11703 && !current_buffer
->clip_changed
11704 && !current_buffer
->prevent_redisplay_optimizations_p
11705 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11706 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11707 /* Make sure recorded data applies to current buffer, etc. */
11708 && this_line_buffer
== current_buffer
11709 && current_buffer
== XBUFFER (w
->buffer
)
11710 && NILP (w
->force_start
)
11711 && NILP (w
->optional_new_start
)
11712 /* Point must be on the line that we have info recorded about. */
11713 && PT
>= CHARPOS (tlbufpos
)
11714 && PT
<= Z
- CHARPOS (tlendpos
)
11715 /* All text outside that line, including its final newline,
11716 must be unchanged. */
11717 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11718 CHARPOS (tlendpos
)))
11720 if (CHARPOS (tlbufpos
) > BEGV
11721 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11722 && (CHARPOS (tlbufpos
) == ZV
11723 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11724 /* Former continuation line has disappeared by becoming empty. */
11726 else if (XFASTINT (w
->last_modified
) < MODIFF
11727 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11728 || MINI_WINDOW_P (w
))
11730 /* We have to handle the case of continuation around a
11731 wide-column character (see the comment in indent.c around
11734 For instance, in the following case:
11736 -------- Insert --------
11737 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11738 J_I_ ==> J_I_ `^^' are cursors.
11742 As we have to redraw the line above, we cannot use this
11746 int line_height_before
= this_line_pixel_height
;
11748 /* Note that start_display will handle the case that the
11749 line starting at tlbufpos is a continuation line. */
11750 start_display (&it
, w
, tlbufpos
);
11752 /* Implementation note: It this still necessary? */
11753 if (it
.current_x
!= this_line_start_x
)
11756 TRACE ((stderr
, "trying display optimization 1\n"));
11757 w
->cursor
.vpos
= -1;
11758 overlay_arrow_seen
= 0;
11759 it
.vpos
= this_line_vpos
;
11760 it
.current_y
= this_line_y
;
11761 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11762 display_line (&it
);
11764 /* If line contains point, is not continued,
11765 and ends at same distance from eob as before, we win. */
11766 if (w
->cursor
.vpos
>= 0
11767 /* Line is not continued, otherwise this_line_start_pos
11768 would have been set to 0 in display_line. */
11769 && CHARPOS (this_line_start_pos
)
11770 /* Line ends as before. */
11771 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11772 /* Line has same height as before. Otherwise other lines
11773 would have to be shifted up or down. */
11774 && this_line_pixel_height
== line_height_before
)
11776 /* If this is not the window's last line, we must adjust
11777 the charstarts of the lines below. */
11778 if (it
.current_y
< it
.last_visible_y
)
11780 struct glyph_row
*row
11781 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11782 EMACS_INT delta
, delta_bytes
;
11784 /* We used to distinguish between two cases here,
11785 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11786 when the line ends in a newline or the end of the
11787 buffer's accessible portion. But both cases did
11788 the same, so they were collapsed. */
11790 - CHARPOS (tlendpos
)
11791 - MATRIX_ROW_START_CHARPOS (row
));
11792 delta_bytes
= (Z_BYTE
11793 - BYTEPOS (tlendpos
)
11794 - MATRIX_ROW_START_BYTEPOS (row
));
11796 increment_matrix_positions (w
->current_matrix
,
11797 this_line_vpos
+ 1,
11798 w
->current_matrix
->nrows
,
11799 delta
, delta_bytes
);
11802 /* If this row displays text now but previously didn't,
11803 or vice versa, w->window_end_vpos may have to be
11805 if ((it
.glyph_row
- 1)->displays_text_p
)
11807 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11808 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11810 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11811 && this_line_vpos
> 0)
11812 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11813 w
->window_end_valid
= Qnil
;
11815 /* Update hint: No need to try to scroll in update_window. */
11816 w
->desired_matrix
->no_scrolling_p
= 1;
11819 *w
->desired_matrix
->method
= 0;
11820 debug_method_add (w
, "optimization 1");
11822 #ifdef HAVE_WINDOW_SYSTEM
11823 update_window_fringes (w
, 0);
11830 else if (/* Cursor position hasn't changed. */
11831 PT
== XFASTINT (w
->last_point
)
11832 /* Make sure the cursor was last displayed
11833 in this window. Otherwise we have to reposition it. */
11834 && 0 <= w
->cursor
.vpos
11835 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11839 do_pending_window_change (1);
11840 /* If selected_window changed, redisplay again. */
11841 if (WINDOWP (selected_window
)
11842 && (w
= XWINDOW (selected_window
)) != sw
)
11845 /* We used to always goto end_of_redisplay here, but this
11846 isn't enough if we have a blinking cursor. */
11847 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11848 goto end_of_redisplay
;
11852 /* If highlighting the region, or if the cursor is in the echo area,
11853 then we can't just move the cursor. */
11854 else if (! (!NILP (Vtransient_mark_mode
)
11855 && !NILP (BVAR (current_buffer
, mark_active
)))
11856 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11857 || highlight_nonselected_windows
)
11858 && NILP (w
->region_showing
)
11859 && NILP (Vshow_trailing_whitespace
)
11860 && !cursor_in_echo_area
)
11863 struct glyph_row
*row
;
11865 /* Skip from tlbufpos to PT and see where it is. Note that
11866 PT may be in invisible text. If so, we will end at the
11867 next visible position. */
11868 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11869 NULL
, DEFAULT_FACE_ID
);
11870 it
.current_x
= this_line_start_x
;
11871 it
.current_y
= this_line_y
;
11872 it
.vpos
= this_line_vpos
;
11874 /* The call to move_it_to stops in front of PT, but
11875 moves over before-strings. */
11876 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11878 if (it
.vpos
== this_line_vpos
11879 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11882 xassert (this_line_vpos
== it
.vpos
);
11883 xassert (this_line_y
== it
.current_y
);
11884 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11886 *w
->desired_matrix
->method
= 0;
11887 debug_method_add (w
, "optimization 3");
11896 /* Text changed drastically or point moved off of line. */
11897 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11900 CHARPOS (this_line_start_pos
) = 0;
11901 consider_all_windows_p
|= buffer_shared
> 1;
11902 ++clear_face_cache_count
;
11903 #ifdef HAVE_WINDOW_SYSTEM
11904 ++clear_image_cache_count
;
11907 /* Build desired matrices, and update the display. If
11908 consider_all_windows_p is non-zero, do it for all windows on all
11909 frames. Otherwise do it for selected_window, only. */
11911 if (consider_all_windows_p
)
11913 Lisp_Object tail
, frame
;
11915 FOR_EACH_FRAME (tail
, frame
)
11916 XFRAME (frame
)->updated_p
= 0;
11918 /* Recompute # windows showing selected buffer. This will be
11919 incremented each time such a window is displayed. */
11922 FOR_EACH_FRAME (tail
, frame
)
11924 struct frame
*f
= XFRAME (frame
);
11926 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11928 if (! EQ (frame
, selected_frame
))
11929 /* Select the frame, for the sake of frame-local
11931 select_frame_for_redisplay (frame
);
11933 /* Mark all the scroll bars to be removed; we'll redeem
11934 the ones we want when we redisplay their windows. */
11935 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11936 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11938 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11939 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11941 /* The X error handler may have deleted that frame. */
11942 if (!FRAME_LIVE_P (f
))
11945 /* Any scroll bars which redisplay_windows should have
11946 nuked should now go away. */
11947 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11948 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11950 /* If fonts changed, display again. */
11951 /* ??? rms: I suspect it is a mistake to jump all the way
11952 back to retry here. It should just retry this frame. */
11953 if (fonts_changed_p
)
11956 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11958 /* See if we have to hscroll. */
11959 if (!f
->already_hscrolled_p
)
11961 f
->already_hscrolled_p
= 1;
11962 if (hscroll_windows (f
->root_window
))
11966 /* Prevent various kinds of signals during display
11967 update. stdio is not robust about handling
11968 signals, which can cause an apparent I/O
11970 if (interrupt_input
)
11971 unrequest_sigio ();
11974 /* Update the display. */
11975 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11976 pending
|= update_frame (f
, 0, 0);
11982 if (!EQ (old_frame
, selected_frame
)
11983 && FRAME_LIVE_P (XFRAME (old_frame
)))
11984 /* We played a bit fast-and-loose above and allowed selected_frame
11985 and selected_window to be temporarily out-of-sync but let's make
11986 sure this stays contained. */
11987 select_frame_for_redisplay (old_frame
);
11988 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11992 /* Do the mark_window_display_accurate after all windows have
11993 been redisplayed because this call resets flags in buffers
11994 which are needed for proper redisplay. */
11995 FOR_EACH_FRAME (tail
, frame
)
11997 struct frame
*f
= XFRAME (frame
);
12000 mark_window_display_accurate (f
->root_window
, 1);
12001 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12002 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12007 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12009 Lisp_Object mini_window
;
12010 struct frame
*mini_frame
;
12012 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12013 /* Use list_of_error, not Qerror, so that
12014 we catch only errors and don't run the debugger. */
12015 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12017 redisplay_window_error
);
12019 /* Compare desired and current matrices, perform output. */
12022 /* If fonts changed, display again. */
12023 if (fonts_changed_p
)
12026 /* Prevent various kinds of signals during display update.
12027 stdio is not robust about handling signals,
12028 which can cause an apparent I/O error. */
12029 if (interrupt_input
)
12030 unrequest_sigio ();
12033 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12035 if (hscroll_windows (selected_window
))
12038 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12039 pending
= update_frame (sf
, 0, 0);
12042 /* We may have called echo_area_display at the top of this
12043 function. If the echo area is on another frame, that may
12044 have put text on a frame other than the selected one, so the
12045 above call to update_frame would not have caught it. Catch
12047 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12048 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12050 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12052 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12053 pending
|= update_frame (mini_frame
, 0, 0);
12054 if (!pending
&& hscroll_windows (mini_window
))
12059 /* If display was paused because of pending input, make sure we do a
12060 thorough update the next time. */
12063 /* Prevent the optimization at the beginning of
12064 redisplay_internal that tries a single-line update of the
12065 line containing the cursor in the selected window. */
12066 CHARPOS (this_line_start_pos
) = 0;
12068 /* Let the overlay arrow be updated the next time. */
12069 update_overlay_arrows (0);
12071 /* If we pause after scrolling, some rows in the current
12072 matrices of some windows are not valid. */
12073 if (!WINDOW_FULL_WIDTH_P (w
)
12074 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12075 update_mode_lines
= 1;
12079 if (!consider_all_windows_p
)
12081 /* This has already been done above if
12082 consider_all_windows_p is set. */
12083 mark_window_display_accurate_1 (w
, 1);
12085 /* Say overlay arrows are up to date. */
12086 update_overlay_arrows (1);
12088 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12089 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12092 update_mode_lines
= 0;
12093 windows_or_buffers_changed
= 0;
12094 cursor_type_changed
= 0;
12097 /* Start SIGIO interrupts coming again. Having them off during the
12098 code above makes it less likely one will discard output, but not
12099 impossible, since there might be stuff in the system buffer here.
12100 But it is much hairier to try to do anything about that. */
12101 if (interrupt_input
)
12105 /* If a frame has become visible which was not before, redisplay
12106 again, so that we display it. Expose events for such a frame
12107 (which it gets when becoming visible) don't call the parts of
12108 redisplay constructing glyphs, so simply exposing a frame won't
12109 display anything in this case. So, we have to display these
12110 frames here explicitly. */
12113 Lisp_Object tail
, frame
;
12116 FOR_EACH_FRAME (tail
, frame
)
12118 int this_is_visible
= 0;
12120 if (XFRAME (frame
)->visible
)
12121 this_is_visible
= 1;
12122 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12123 if (XFRAME (frame
)->visible
)
12124 this_is_visible
= 1;
12126 if (this_is_visible
)
12130 if (new_count
!= number_of_visible_frames
)
12131 windows_or_buffers_changed
++;
12134 /* Change frame size now if a change is pending. */
12135 do_pending_window_change (1);
12137 /* If we just did a pending size change, or have additional
12138 visible frames, or selected_window changed, redisplay again. */
12139 if ((windows_or_buffers_changed
&& !pending
)
12140 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12143 /* Clear the face and image caches.
12145 We used to do this only if consider_all_windows_p. But the cache
12146 needs to be cleared if a timer creates images in the current
12147 buffer (e.g. the test case in Bug#6230). */
12149 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12151 clear_face_cache (0);
12152 clear_face_cache_count
= 0;
12155 #ifdef HAVE_WINDOW_SYSTEM
12156 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12158 clear_image_caches (Qnil
);
12159 clear_image_cache_count
= 0;
12161 #endif /* HAVE_WINDOW_SYSTEM */
12164 unbind_to (count
, Qnil
);
12169 /* Redisplay, but leave alone any recent echo area message unless
12170 another message has been requested in its place.
12172 This is useful in situations where you need to redisplay but no
12173 user action has occurred, making it inappropriate for the message
12174 area to be cleared. See tracking_off and
12175 wait_reading_process_output for examples of these situations.
12177 FROM_WHERE is an integer saying from where this function was
12178 called. This is useful for debugging. */
12181 redisplay_preserve_echo_area (int from_where
)
12183 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12185 if (!NILP (echo_area_buffer
[1]))
12187 /* We have a previously displayed message, but no current
12188 message. Redisplay the previous message. */
12189 display_last_displayed_message_p
= 1;
12190 redisplay_internal ();
12191 display_last_displayed_message_p
= 0;
12194 redisplay_internal ();
12196 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12197 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12198 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12202 /* Function registered with record_unwind_protect in
12203 redisplay_internal. Reset redisplaying_p to the value it had
12204 before redisplay_internal was called, and clear
12205 prevent_freeing_realized_faces_p. It also selects the previously
12206 selected frame, unless it has been deleted (by an X connection
12207 failure during redisplay, for example). */
12210 unwind_redisplay (Lisp_Object val
)
12212 Lisp_Object old_redisplaying_p
, old_frame
;
12214 old_redisplaying_p
= XCAR (val
);
12215 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12216 old_frame
= XCDR (val
);
12217 if (! EQ (old_frame
, selected_frame
)
12218 && FRAME_LIVE_P (XFRAME (old_frame
)))
12219 select_frame_for_redisplay (old_frame
);
12224 /* Mark the display of window W as accurate or inaccurate. If
12225 ACCURATE_P is non-zero mark display of W as accurate. If
12226 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12227 redisplay_internal is called. */
12230 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12232 if (BUFFERP (w
->buffer
))
12234 struct buffer
*b
= XBUFFER (w
->buffer
);
12237 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12238 w
->last_overlay_modified
12239 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12241 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12245 b
->clip_changed
= 0;
12246 b
->prevent_redisplay_optimizations_p
= 0;
12248 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12249 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12250 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12251 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12253 w
->current_matrix
->buffer
= b
;
12254 w
->current_matrix
->begv
= BUF_BEGV (b
);
12255 w
->current_matrix
->zv
= BUF_ZV (b
);
12257 w
->last_cursor
= w
->cursor
;
12258 w
->last_cursor_off_p
= w
->cursor_off_p
;
12260 if (w
== XWINDOW (selected_window
))
12261 w
->last_point
= make_number (BUF_PT (b
));
12263 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12269 w
->window_end_valid
= w
->buffer
;
12270 w
->update_mode_line
= Qnil
;
12275 /* Mark the display of windows in the window tree rooted at WINDOW as
12276 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12277 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12278 be redisplayed the next time redisplay_internal is called. */
12281 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12285 for (; !NILP (window
); window
= w
->next
)
12287 w
= XWINDOW (window
);
12288 mark_window_display_accurate_1 (w
, accurate_p
);
12290 if (!NILP (w
->vchild
))
12291 mark_window_display_accurate (w
->vchild
, accurate_p
);
12292 if (!NILP (w
->hchild
))
12293 mark_window_display_accurate (w
->hchild
, accurate_p
);
12298 update_overlay_arrows (1);
12302 /* Force a thorough redisplay the next time by setting
12303 last_arrow_position and last_arrow_string to t, which is
12304 unequal to any useful value of Voverlay_arrow_... */
12305 update_overlay_arrows (-1);
12310 /* Return value in display table DP (Lisp_Char_Table *) for character
12311 C. Since a display table doesn't have any parent, we don't have to
12312 follow parent. Do not call this function directly but use the
12313 macro DISP_CHAR_VECTOR. */
12316 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12320 if (ASCII_CHAR_P (c
))
12323 if (SUB_CHAR_TABLE_P (val
))
12324 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12330 XSETCHAR_TABLE (table
, dp
);
12331 val
= char_table_ref (table
, c
);
12340 /***********************************************************************
12342 ***********************************************************************/
12344 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12347 redisplay_windows (Lisp_Object window
)
12349 while (!NILP (window
))
12351 struct window
*w
= XWINDOW (window
);
12353 if (!NILP (w
->hchild
))
12354 redisplay_windows (w
->hchild
);
12355 else if (!NILP (w
->vchild
))
12356 redisplay_windows (w
->vchild
);
12357 else if (!NILP (w
->buffer
))
12359 displayed_buffer
= XBUFFER (w
->buffer
);
12360 /* Use list_of_error, not Qerror, so that
12361 we catch only errors and don't run the debugger. */
12362 internal_condition_case_1 (redisplay_window_0
, window
,
12364 redisplay_window_error
);
12372 redisplay_window_error (Lisp_Object ignore
)
12374 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12379 redisplay_window_0 (Lisp_Object window
)
12381 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12382 redisplay_window (window
, 0);
12387 redisplay_window_1 (Lisp_Object window
)
12389 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12390 redisplay_window (window
, 1);
12395 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12396 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12397 which positions recorded in ROW differ from current buffer
12400 Return 0 if cursor is not on this row, 1 otherwise. */
12403 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12404 struct glyph_matrix
*matrix
,
12405 EMACS_INT delta
, EMACS_INT delta_bytes
,
12408 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12409 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12410 struct glyph
*cursor
= NULL
;
12411 /* The last known character position in row. */
12412 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12414 EMACS_INT pt_old
= PT
- delta
;
12415 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12416 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12417 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12418 /* A glyph beyond the edge of TEXT_AREA which we should never
12420 struct glyph
*glyphs_end
= end
;
12421 /* Non-zero means we've found a match for cursor position, but that
12422 glyph has the avoid_cursor_p flag set. */
12423 int match_with_avoid_cursor
= 0;
12424 /* Non-zero means we've seen at least one glyph that came from a
12426 int string_seen
= 0;
12427 /* Largest and smalles buffer positions seen so far during scan of
12429 EMACS_INT bpos_max
= pos_before
;
12430 EMACS_INT bpos_min
= pos_after
;
12431 /* Last buffer position covered by an overlay string with an integer
12432 `cursor' property. */
12433 EMACS_INT bpos_covered
= 0;
12435 /* Skip over glyphs not having an object at the start and the end of
12436 the row. These are special glyphs like truncation marks on
12437 terminal frames. */
12438 if (row
->displays_text_p
)
12440 if (!row
->reversed_p
)
12443 && INTEGERP (glyph
->object
)
12444 && glyph
->charpos
< 0)
12446 x
+= glyph
->pixel_width
;
12450 && INTEGERP ((end
- 1)->object
)
12451 /* CHARPOS is zero for blanks and stretch glyphs
12452 inserted by extend_face_to_end_of_line. */
12453 && (end
- 1)->charpos
<= 0)
12455 glyph_before
= glyph
- 1;
12462 /* If the glyph row is reversed, we need to process it from back
12463 to front, so swap the edge pointers. */
12464 glyphs_end
= end
= glyph
- 1;
12465 glyph
+= row
->used
[TEXT_AREA
] - 1;
12467 while (glyph
> end
+ 1
12468 && INTEGERP (glyph
->object
)
12469 && glyph
->charpos
< 0)
12472 x
-= glyph
->pixel_width
;
12474 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12476 /* By default, in reversed rows we put the cursor on the
12477 rightmost (first in the reading order) glyph. */
12478 for (g
= end
+ 1; g
< glyph
; g
++)
12479 x
+= g
->pixel_width
;
12481 && INTEGERP ((end
+ 1)->object
)
12482 && (end
+ 1)->charpos
<= 0)
12484 glyph_before
= glyph
+ 1;
12488 else if (row
->reversed_p
)
12490 /* In R2L rows that don't display text, put the cursor on the
12491 rightmost glyph. Case in point: an empty last line that is
12492 part of an R2L paragraph. */
12494 /* Avoid placing the cursor on the last glyph of the row, where
12495 on terminal frames we hold the vertical border between
12496 adjacent windows. */
12497 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12498 && !WINDOW_RIGHTMOST_P (w
)
12499 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12501 x
= -1; /* will be computed below, at label compute_x */
12504 /* Step 1: Try to find the glyph whose character position
12505 corresponds to point. If that's not possible, find 2 glyphs
12506 whose character positions are the closest to point, one before
12507 point, the other after it. */
12508 if (!row
->reversed_p
)
12509 while (/* not marched to end of glyph row */
12511 /* glyph was not inserted by redisplay for internal purposes */
12512 && !INTEGERP (glyph
->object
))
12514 if (BUFFERP (glyph
->object
))
12516 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12518 if (glyph
->charpos
> bpos_max
)
12519 bpos_max
= glyph
->charpos
;
12520 if (glyph
->charpos
< bpos_min
)
12521 bpos_min
= glyph
->charpos
;
12522 if (!glyph
->avoid_cursor_p
)
12524 /* If we hit point, we've found the glyph on which to
12525 display the cursor. */
12528 match_with_avoid_cursor
= 0;
12531 /* See if we've found a better approximation to
12532 POS_BEFORE or to POS_AFTER. Note that we want the
12533 first (leftmost) glyph of all those that are the
12534 closest from below, and the last (rightmost) of all
12535 those from above. */
12536 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12538 pos_before
= glyph
->charpos
;
12539 glyph_before
= glyph
;
12541 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12543 pos_after
= glyph
->charpos
;
12544 glyph_after
= glyph
;
12547 else if (dpos
== 0)
12548 match_with_avoid_cursor
= 1;
12550 else if (STRINGP (glyph
->object
))
12552 Lisp_Object chprop
;
12553 EMACS_INT glyph_pos
= glyph
->charpos
;
12555 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12557 if (INTEGERP (chprop
))
12559 bpos_covered
= bpos_max
+ XINT (chprop
);
12560 /* If the `cursor' property covers buffer positions up
12561 to and including point, we should display cursor on
12562 this glyph. Note that overlays and text properties
12563 with string values stop bidi reordering, so every
12564 buffer position to the left of the string is always
12565 smaller than any position to the right of the
12566 string. Therefore, if a `cursor' property on one
12567 of the string's characters has an integer value, we
12568 will break out of the loop below _before_ we get to
12569 the position match above. IOW, integer values of
12570 the `cursor' property override the "exact match for
12571 point" strategy of positioning the cursor. */
12572 /* Implementation note: bpos_max == pt_old when, e.g.,
12573 we are in an empty line, where bpos_max is set to
12574 MATRIX_ROW_START_CHARPOS, see above. */
12575 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12584 x
+= glyph
->pixel_width
;
12587 else if (glyph
> end
) /* row is reversed */
12588 while (!INTEGERP (glyph
->object
))
12590 if (BUFFERP (glyph
->object
))
12592 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12594 if (glyph
->charpos
> bpos_max
)
12595 bpos_max
= glyph
->charpos
;
12596 if (glyph
->charpos
< bpos_min
)
12597 bpos_min
= glyph
->charpos
;
12598 if (!glyph
->avoid_cursor_p
)
12602 match_with_avoid_cursor
= 0;
12605 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12607 pos_before
= glyph
->charpos
;
12608 glyph_before
= glyph
;
12610 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12612 pos_after
= glyph
->charpos
;
12613 glyph_after
= glyph
;
12616 else if (dpos
== 0)
12617 match_with_avoid_cursor
= 1;
12619 else if (STRINGP (glyph
->object
))
12621 Lisp_Object chprop
;
12622 EMACS_INT glyph_pos
= glyph
->charpos
;
12624 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12626 if (INTEGERP (chprop
))
12628 bpos_covered
= bpos_max
+ XINT (chprop
);
12629 /* If the `cursor' property covers buffer positions up
12630 to and including point, we should display cursor on
12632 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12641 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12643 x
--; /* can't use any pixel_width */
12646 x
-= glyph
->pixel_width
;
12649 /* Step 2: If we didn't find an exact match for point, we need to
12650 look for a proper place to put the cursor among glyphs between
12651 GLYPH_BEFORE and GLYPH_AFTER. */
12652 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12653 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12654 && bpos_covered
< pt_old
)
12656 /* An empty line has a single glyph whose OBJECT is zero and
12657 whose CHARPOS is the position of a newline on that line.
12658 Note that on a TTY, there are more glyphs after that, which
12659 were produced by extend_face_to_end_of_line, but their
12660 CHARPOS is zero or negative. */
12662 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12663 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12665 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12667 EMACS_INT ellipsis_pos
;
12669 /* Scan back over the ellipsis glyphs. */
12670 if (!row
->reversed_p
)
12672 ellipsis_pos
= (glyph
- 1)->charpos
;
12673 while (glyph
> row
->glyphs
[TEXT_AREA
]
12674 && (glyph
- 1)->charpos
== ellipsis_pos
)
12675 glyph
--, x
-= glyph
->pixel_width
;
12676 /* That loop always goes one position too far, including
12677 the glyph before the ellipsis. So scan forward over
12679 x
+= glyph
->pixel_width
;
12682 else /* row is reversed */
12684 ellipsis_pos
= (glyph
+ 1)->charpos
;
12685 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12686 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12687 glyph
++, x
+= glyph
->pixel_width
;
12688 x
-= glyph
->pixel_width
;
12692 else if (match_with_avoid_cursor
12693 /* A truncated row may not include PT among its
12694 character positions. Setting the cursor inside the
12695 scroll margin will trigger recalculation of hscroll
12696 in hscroll_window_tree. */
12697 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12698 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12699 /* Zero-width characters produce no glyphs. */
12702 && (row
->reversed_p
12703 ? glyph_after
> glyphs_end
12704 : glyph_after
< glyphs_end
)))
12706 cursor
= glyph_after
;
12709 else if (string_seen
)
12711 int incr
= row
->reversed_p
? -1 : +1;
12713 /* Need to find the glyph that came out of a string which is
12714 present at point. That glyph is somewhere between
12715 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12716 positioned between POS_BEFORE and POS_AFTER in the
12718 struct glyph
*stop
= glyph_after
;
12719 EMACS_INT pos
= pos_before
;
12722 for (glyph
= glyph_before
+ incr
;
12723 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12726 /* Any glyphs that come from the buffer are here because
12727 of bidi reordering. Skip them, and only pay
12728 attention to glyphs that came from some string. */
12729 if (STRINGP (glyph
->object
))
12734 str
= glyph
->object
;
12735 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
12736 if (tem
== 0 /* from overlay */
12739 /* If the string from which this glyph came is
12740 found in the buffer at point, then we've
12741 found the glyph we've been looking for. If
12742 it comes from an overlay (tem == 0), and it
12743 has the `cursor' property on one of its
12744 glyphs, record that glyph as a candidate for
12745 displaying the cursor. (As in the
12746 unidirectional version, we will display the
12747 cursor on the last candidate we find.) */
12748 if (tem
== 0 || tem
== pt_old
)
12750 /* The glyphs from this string could have
12751 been reordered. Find the one with the
12752 smallest string position. Or there could
12753 be a character in the string with the
12754 `cursor' property, which means display
12755 cursor on that character's glyph. */
12756 EMACS_INT strpos
= glyph
->charpos
;
12761 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12762 && EQ (glyph
->object
, str
);
12766 EMACS_INT gpos
= glyph
->charpos
;
12768 cprop
= Fget_char_property (make_number (gpos
),
12776 if (tem
&& glyph
->charpos
< strpos
)
12778 strpos
= glyph
->charpos
;
12787 pos
= tem
+ 1; /* don't find previous instances */
12789 /* This string is not what we want; skip all of the
12790 glyphs that came from it. */
12791 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12792 && EQ (glyph
->object
, str
))
12799 /* If we reached the end of the line, and END was from a string,
12800 the cursor is not on this line. */
12802 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12803 && STRINGP (end
->object
)
12804 && row
->continued_p
)
12810 if (cursor
!= NULL
)
12816 /* Need to compute x that corresponds to GLYPH. */
12817 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12819 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12821 x
+= g
->pixel_width
;
12825 /* ROW could be part of a continued line, which, under bidi
12826 reordering, might have other rows whose start and end charpos
12827 occlude point. Only set w->cursor if we found a better
12828 approximation to the cursor position than we have from previously
12829 examined candidate rows belonging to the same continued line. */
12830 if (/* we already have a candidate row */
12831 w
->cursor
.vpos
>= 0
12832 /* that candidate is not the row we are processing */
12833 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12834 /* the row we are processing is part of a continued line */
12835 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12836 /* Make sure cursor.vpos specifies a row whose start and end
12837 charpos occlude point. This is because some callers of this
12838 function leave cursor.vpos at the row where the cursor was
12839 displayed during the last redisplay cycle. */
12840 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12841 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12844 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12846 /* Don't consider glyphs that are outside TEXT_AREA. */
12847 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12849 /* Keep the candidate whose buffer position is the closest to
12851 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12852 w
->cursor
.hpos
>= 0
12853 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12854 && BUFFERP (g1
->object
)
12855 && (g1
->charpos
== pt_old
/* an exact match always wins */
12856 || (BUFFERP (glyph
->object
)
12857 && eabs (g1
->charpos
- pt_old
)
12858 < eabs (glyph
->charpos
- pt_old
))))
12860 /* If this candidate gives an exact match, use that. */
12861 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12862 /* Otherwise, keep the candidate that comes from a row
12863 spanning less buffer positions. This may win when one or
12864 both candidate positions are on glyphs that came from
12865 display strings, for which we cannot compare buffer
12867 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12868 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12869 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12872 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12874 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12875 w
->cursor
.y
= row
->y
+ dy
;
12877 if (w
== XWINDOW (selected_window
))
12879 if (!row
->continued_p
12880 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12883 this_line_buffer
= XBUFFER (w
->buffer
);
12885 CHARPOS (this_line_start_pos
)
12886 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12887 BYTEPOS (this_line_start_pos
)
12888 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12890 CHARPOS (this_line_end_pos
)
12891 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12892 BYTEPOS (this_line_end_pos
)
12893 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12895 this_line_y
= w
->cursor
.y
;
12896 this_line_pixel_height
= row
->height
;
12897 this_line_vpos
= w
->cursor
.vpos
;
12898 this_line_start_x
= row
->x
;
12901 CHARPOS (this_line_start_pos
) = 0;
12908 /* Run window scroll functions, if any, for WINDOW with new window
12909 start STARTP. Sets the window start of WINDOW to that position.
12911 We assume that the window's buffer is really current. */
12913 static INLINE
struct text_pos
12914 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12916 struct window
*w
= XWINDOW (window
);
12917 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12919 if (current_buffer
!= XBUFFER (w
->buffer
))
12922 if (!NILP (Vwindow_scroll_functions
))
12924 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12925 make_number (CHARPOS (startp
)));
12926 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12927 /* In case the hook functions switch buffers. */
12928 if (current_buffer
!= XBUFFER (w
->buffer
))
12929 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12936 /* Make sure the line containing the cursor is fully visible.
12937 A value of 1 means there is nothing to be done.
12938 (Either the line is fully visible, or it cannot be made so,
12939 or we cannot tell.)
12941 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12942 is higher than window.
12944 A value of 0 means the caller should do scrolling
12945 as if point had gone off the screen. */
12948 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12950 struct glyph_matrix
*matrix
;
12951 struct glyph_row
*row
;
12954 if (!make_cursor_line_fully_visible_p
)
12957 /* It's not always possible to find the cursor, e.g, when a window
12958 is full of overlay strings. Don't do anything in that case. */
12959 if (w
->cursor
.vpos
< 0)
12962 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12963 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12965 /* If the cursor row is not partially visible, there's nothing to do. */
12966 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12969 /* If the row the cursor is in is taller than the window's height,
12970 it's not clear what to do, so do nothing. */
12971 window_height
= window_box_height (w
);
12972 if (row
->height
>= window_height
)
12974 if (!force_p
|| MINI_WINDOW_P (w
)
12975 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12982 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12983 non-zero means only WINDOW is redisplayed in redisplay_internal.
12984 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
12985 in redisplay_window to bring a partially visible line into view in
12986 the case that only the cursor has moved.
12988 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12989 last screen line's vertical height extends past the end of the screen.
12993 1 if scrolling succeeded
12995 0 if scrolling didn't find point.
12997 -1 if new fonts have been loaded so that we must interrupt
12998 redisplay, adjust glyph matrices, and try again. */
13004 SCROLLING_NEED_LARGER_MATRICES
13007 /* If scroll-conservatively is more than this, never recenter.
13009 If you change this, don't forget to update the doc string of
13010 `scroll-conservatively' and the Emacs manual. */
13011 #define SCROLL_LIMIT 100
13014 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13015 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13016 int temp_scroll_step
, int last_line_misfit
)
13018 struct window
*w
= XWINDOW (window
);
13019 struct frame
*f
= XFRAME (w
->frame
);
13020 struct text_pos pos
, startp
;
13022 int this_scroll_margin
, scroll_max
, rc
, height
;
13023 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13024 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13025 Lisp_Object aggressive
;
13026 /* We will never try scrolling more than this number of lines. */
13027 int scroll_limit
= SCROLL_LIMIT
;
13030 debug_method_add (w
, "try_scrolling");
13033 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13035 /* Compute scroll margin height in pixels. We scroll when point is
13036 within this distance from the top or bottom of the window. */
13037 if (scroll_margin
> 0)
13038 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13039 * FRAME_LINE_HEIGHT (f
);
13041 this_scroll_margin
= 0;
13043 /* Force arg_scroll_conservatively to have a reasonable value, to
13044 avoid scrolling too far away with slow move_it_* functions. Note
13045 that the user can supply scroll-conservatively equal to
13046 `most-positive-fixnum', which can be larger than INT_MAX. */
13047 if (arg_scroll_conservatively
> scroll_limit
)
13049 arg_scroll_conservatively
= scroll_limit
+ 1;
13050 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13052 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13053 /* Compute how much we should try to scroll maximally to bring
13054 point into view. */
13055 scroll_max
= (max (scroll_step
,
13056 max (arg_scroll_conservatively
, temp_scroll_step
))
13057 * FRAME_LINE_HEIGHT (f
));
13058 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13059 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13060 /* We're trying to scroll because of aggressive scrolling but no
13061 scroll_step is set. Choose an arbitrary one. */
13062 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13068 /* Decide whether to scroll down. */
13069 if (PT
> CHARPOS (startp
))
13071 int scroll_margin_y
;
13073 /* Compute the pixel ypos of the scroll margin, then move it to
13074 either that ypos or PT, whichever comes first. */
13075 start_display (&it
, w
, startp
);
13076 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13077 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13078 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13079 (MOVE_TO_POS
| MOVE_TO_Y
));
13081 if (PT
> CHARPOS (it
.current
.pos
))
13083 int y0
= line_bottom_y (&it
);
13084 /* Compute how many pixels below window bottom to stop searching
13085 for PT. This avoids costly search for PT that is far away if
13086 the user limited scrolling by a small number of lines, but
13087 always finds PT if scroll_conservatively is set to a large
13088 number, such as most-positive-fixnum. */
13089 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13090 int y_to_move
= it
.last_visible_y
+ slack
;
13092 /* Compute the distance from the scroll margin to PT or to
13093 the scroll limit, whichever comes first. This should
13094 include the height of the cursor line, to make that line
13096 move_it_to (&it
, PT
, -1, y_to_move
,
13097 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13098 dy
= line_bottom_y (&it
) - y0
;
13100 if (dy
> scroll_max
)
13101 return SCROLLING_FAILED
;
13109 /* Point is in or below the bottom scroll margin, so move the
13110 window start down. If scrolling conservatively, move it just
13111 enough down to make point visible. If scroll_step is set,
13112 move it down by scroll_step. */
13113 if (arg_scroll_conservatively
)
13115 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13116 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13117 else if (scroll_step
|| temp_scroll_step
)
13118 amount_to_scroll
= scroll_max
;
13121 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13122 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13123 if (NUMBERP (aggressive
))
13125 double float_amount
= XFLOATINT (aggressive
) * height
;
13126 amount_to_scroll
= float_amount
;
13127 if (amount_to_scroll
== 0 && float_amount
> 0)
13128 amount_to_scroll
= 1;
13129 /* Don't let point enter the scroll margin near top of
13131 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13132 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13136 if (amount_to_scroll
<= 0)
13137 return SCROLLING_FAILED
;
13139 start_display (&it
, w
, startp
);
13140 if (arg_scroll_conservatively
<= scroll_limit
)
13141 move_it_vertically (&it
, amount_to_scroll
);
13144 /* Extra precision for users who set scroll-conservatively
13145 to a large number: make sure the amount we scroll
13146 the window start is never less than amount_to_scroll,
13147 which was computed as distance from window bottom to
13148 point. This matters when lines at window top and lines
13149 below window bottom have different height. */
13150 struct it it1
= it
;
13151 /* We use a temporary it1 because line_bottom_y can modify
13152 its argument, if it moves one line down; see there. */
13153 int start_y
= line_bottom_y (&it1
);
13156 move_it_by_lines (&it
, 1);
13158 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13161 /* If STARTP is unchanged, move it down another screen line. */
13162 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13163 move_it_by_lines (&it
, 1);
13164 startp
= it
.current
.pos
;
13168 struct text_pos scroll_margin_pos
= startp
;
13170 /* See if point is inside the scroll margin at the top of the
13172 if (this_scroll_margin
)
13174 start_display (&it
, w
, startp
);
13175 move_it_vertically (&it
, this_scroll_margin
);
13176 scroll_margin_pos
= it
.current
.pos
;
13179 if (PT
< CHARPOS (scroll_margin_pos
))
13181 /* Point is in the scroll margin at the top of the window or
13182 above what is displayed in the window. */
13185 /* Compute the vertical distance from PT to the scroll
13186 margin position. Move as far as scroll_max allows, or
13187 one screenful, or 10 screen lines, whichever is largest.
13188 Give up if distance is greater than scroll_max. */
13189 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13190 start_display (&it
, w
, pos
);
13192 y_to_move
= max (it
.last_visible_y
,
13193 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13194 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13196 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13197 dy
= it
.current_y
- y0
;
13198 if (dy
> scroll_max
)
13199 return SCROLLING_FAILED
;
13201 /* Compute new window start. */
13202 start_display (&it
, w
, startp
);
13204 if (arg_scroll_conservatively
)
13205 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13206 max (scroll_step
, temp_scroll_step
));
13207 else if (scroll_step
|| temp_scroll_step
)
13208 amount_to_scroll
= scroll_max
;
13211 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13212 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13213 if (NUMBERP (aggressive
))
13215 double float_amount
= XFLOATINT (aggressive
) * height
;
13216 amount_to_scroll
= float_amount
;
13217 if (amount_to_scroll
== 0 && float_amount
> 0)
13218 amount_to_scroll
= 1;
13219 amount_to_scroll
-=
13220 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13221 /* Don't let point enter the scroll margin near
13222 bottom of the window. */
13223 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13224 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13228 if (amount_to_scroll
<= 0)
13229 return SCROLLING_FAILED
;
13231 move_it_vertically_backward (&it
, amount_to_scroll
);
13232 startp
= it
.current
.pos
;
13236 /* Run window scroll functions. */
13237 startp
= run_window_scroll_functions (window
, startp
);
13239 /* Display the window. Give up if new fonts are loaded, or if point
13241 if (!try_window (window
, startp
, 0))
13242 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13243 else if (w
->cursor
.vpos
< 0)
13245 clear_glyph_matrix (w
->desired_matrix
);
13246 rc
= SCROLLING_FAILED
;
13250 /* Maybe forget recorded base line for line number display. */
13251 if (!just_this_one_p
13252 || current_buffer
->clip_changed
13253 || BEG_UNCHANGED
< CHARPOS (startp
))
13254 w
->base_line_number
= Qnil
;
13256 /* If cursor ends up on a partially visible line,
13257 treat that as being off the bottom of the screen. */
13258 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13259 /* It's possible that the cursor is on the first line of the
13260 buffer, which is partially obscured due to a vscroll
13261 (Bug#7537). In that case, avoid looping forever . */
13262 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13264 clear_glyph_matrix (w
->desired_matrix
);
13265 ++extra_scroll_margin_lines
;
13268 rc
= SCROLLING_SUCCESS
;
13275 /* Compute a suitable window start for window W if display of W starts
13276 on a continuation line. Value is non-zero if a new window start
13279 The new window start will be computed, based on W's width, starting
13280 from the start of the continued line. It is the start of the
13281 screen line with the minimum distance from the old start W->start. */
13284 compute_window_start_on_continuation_line (struct window
*w
)
13286 struct text_pos pos
, start_pos
;
13287 int window_start_changed_p
= 0;
13289 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13291 /* If window start is on a continuation line... Window start may be
13292 < BEGV in case there's invisible text at the start of the
13293 buffer (M-x rmail, for example). */
13294 if (CHARPOS (start_pos
) > BEGV
13295 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13298 struct glyph_row
*row
;
13300 /* Handle the case that the window start is out of range. */
13301 if (CHARPOS (start_pos
) < BEGV
)
13302 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13303 else if (CHARPOS (start_pos
) > ZV
)
13304 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13306 /* Find the start of the continued line. This should be fast
13307 because scan_buffer is fast (newline cache). */
13308 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13309 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13310 row
, DEFAULT_FACE_ID
);
13311 reseat_at_previous_visible_line_start (&it
);
13313 /* If the line start is "too far" away from the window start,
13314 say it takes too much time to compute a new window start. */
13315 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13316 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13318 int min_distance
, distance
;
13320 /* Move forward by display lines to find the new window
13321 start. If window width was enlarged, the new start can
13322 be expected to be > the old start. If window width was
13323 decreased, the new window start will be < the old start.
13324 So, we're looking for the display line start with the
13325 minimum distance from the old window start. */
13326 pos
= it
.current
.pos
;
13327 min_distance
= INFINITY
;
13328 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13329 distance
< min_distance
)
13331 min_distance
= distance
;
13332 pos
= it
.current
.pos
;
13333 move_it_by_lines (&it
, 1);
13336 /* Set the window start there. */
13337 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13338 window_start_changed_p
= 1;
13342 return window_start_changed_p
;
13346 /* Try cursor movement in case text has not changed in window WINDOW,
13347 with window start STARTP. Value is
13349 CURSOR_MOVEMENT_SUCCESS if successful
13351 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13353 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13354 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13355 we want to scroll as if scroll-step were set to 1. See the code.
13357 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13358 which case we have to abort this redisplay, and adjust matrices
13363 CURSOR_MOVEMENT_SUCCESS
,
13364 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13365 CURSOR_MOVEMENT_MUST_SCROLL
,
13366 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13370 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13372 struct window
*w
= XWINDOW (window
);
13373 struct frame
*f
= XFRAME (w
->frame
);
13374 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13377 if (inhibit_try_cursor_movement
)
13381 /* Handle case where text has not changed, only point, and it has
13382 not moved off the frame. */
13383 if (/* Point may be in this window. */
13384 PT
>= CHARPOS (startp
)
13385 /* Selective display hasn't changed. */
13386 && !current_buffer
->clip_changed
13387 /* Function force-mode-line-update is used to force a thorough
13388 redisplay. It sets either windows_or_buffers_changed or
13389 update_mode_lines. So don't take a shortcut here for these
13391 && !update_mode_lines
13392 && !windows_or_buffers_changed
13393 && !cursor_type_changed
13394 /* Can't use this case if highlighting a region. When a
13395 region exists, cursor movement has to do more than just
13397 && !(!NILP (Vtransient_mark_mode
)
13398 && !NILP (BVAR (current_buffer
, mark_active
)))
13399 && NILP (w
->region_showing
)
13400 && NILP (Vshow_trailing_whitespace
)
13401 /* Right after splitting windows, last_point may be nil. */
13402 && INTEGERP (w
->last_point
)
13403 /* This code is not used for mini-buffer for the sake of the case
13404 of redisplaying to replace an echo area message; since in
13405 that case the mini-buffer contents per se are usually
13406 unchanged. This code is of no real use in the mini-buffer
13407 since the handling of this_line_start_pos, etc., in redisplay
13408 handles the same cases. */
13409 && !EQ (window
, minibuf_window
)
13410 /* When splitting windows or for new windows, it happens that
13411 redisplay is called with a nil window_end_vpos or one being
13412 larger than the window. This should really be fixed in
13413 window.c. I don't have this on my list, now, so we do
13414 approximately the same as the old redisplay code. --gerd. */
13415 && INTEGERP (w
->window_end_vpos
)
13416 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13417 && (FRAME_WINDOW_P (f
)
13418 || !overlay_arrow_in_current_buffer_p ()))
13420 int this_scroll_margin
, top_scroll_margin
;
13421 struct glyph_row
*row
= NULL
;
13424 debug_method_add (w
, "cursor movement");
13427 /* Scroll if point within this distance from the top or bottom
13428 of the window. This is a pixel value. */
13429 if (scroll_margin
> 0)
13431 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13432 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13435 this_scroll_margin
= 0;
13437 top_scroll_margin
= this_scroll_margin
;
13438 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13439 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13441 /* Start with the row the cursor was displayed during the last
13442 not paused redisplay. Give up if that row is not valid. */
13443 if (w
->last_cursor
.vpos
< 0
13444 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13445 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13448 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13449 if (row
->mode_line_p
)
13451 if (!row
->enabled_p
)
13452 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13455 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13457 int scroll_p
= 0, must_scroll
= 0;
13458 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13460 if (PT
> XFASTINT (w
->last_point
))
13462 /* Point has moved forward. */
13463 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13464 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13466 xassert (row
->enabled_p
);
13470 /* If the end position of a row equals the start
13471 position of the next row, and PT is at that position,
13472 we would rather display cursor in the next line. */
13473 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13474 && MATRIX_ROW_END_CHARPOS (row
) == PT
13475 && row
< w
->current_matrix
->rows
13476 + w
->current_matrix
->nrows
- 1
13477 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13478 && !cursor_row_p (row
))
13481 /* If within the scroll margin, scroll. Note that
13482 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13483 the next line would be drawn, and that
13484 this_scroll_margin can be zero. */
13485 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13486 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13487 /* Line is completely visible last line in window
13488 and PT is to be set in the next line. */
13489 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13490 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13491 && !row
->ends_at_zv_p
13492 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13495 else if (PT
< XFASTINT (w
->last_point
))
13497 /* Cursor has to be moved backward. Note that PT >=
13498 CHARPOS (startp) because of the outer if-statement. */
13499 while (!row
->mode_line_p
13500 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13501 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13502 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13503 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13504 row
> w
->current_matrix
->rows
13505 && (row
-1)->ends_in_newline_from_string_p
))))
13506 && (row
->y
> top_scroll_margin
13507 || CHARPOS (startp
) == BEGV
))
13509 xassert (row
->enabled_p
);
13513 /* Consider the following case: Window starts at BEGV,
13514 there is invisible, intangible text at BEGV, so that
13515 display starts at some point START > BEGV. It can
13516 happen that we are called with PT somewhere between
13517 BEGV and START. Try to handle that case. */
13518 if (row
< w
->current_matrix
->rows
13519 || row
->mode_line_p
)
13521 row
= w
->current_matrix
->rows
;
13522 if (row
->mode_line_p
)
13526 /* Due to newlines in overlay strings, we may have to
13527 skip forward over overlay strings. */
13528 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13529 && MATRIX_ROW_END_CHARPOS (row
) == PT
13530 && !cursor_row_p (row
))
13533 /* If within the scroll margin, scroll. */
13534 if (row
->y
< top_scroll_margin
13535 && CHARPOS (startp
) != BEGV
)
13540 /* Cursor did not move. So don't scroll even if cursor line
13541 is partially visible, as it was so before. */
13542 rc
= CURSOR_MOVEMENT_SUCCESS
;
13545 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13546 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13548 /* if PT is not in the glyph row, give up. */
13549 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13552 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13553 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13555 /* If rows are bidi-reordered and point moved, back up
13556 until we find a row that does not belong to a
13557 continuation line. This is because we must consider
13558 all rows of a continued line as candidates for the
13559 new cursor positioning, since row start and end
13560 positions change non-linearly with vertical position
13562 /* FIXME: Revisit this when glyph ``spilling'' in
13563 continuation lines' rows is implemented for
13564 bidi-reordered rows. */
13565 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13567 xassert (row
->enabled_p
);
13569 /* If we hit the beginning of the displayed portion
13570 without finding the first row of a continued
13572 if (row
<= w
->current_matrix
->rows
)
13574 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13582 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13583 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13584 && make_cursor_line_fully_visible_p
)
13586 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13587 && !row
->ends_at_zv_p
13588 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13589 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13590 else if (row
->height
> window_box_height (w
))
13592 /* If we end up in a partially visible line, let's
13593 make it fully visible, except when it's taller
13594 than the window, in which case we can't do much
13597 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13601 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13602 if (!cursor_row_fully_visible_p (w
, 0, 1))
13603 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13605 rc
= CURSOR_MOVEMENT_SUCCESS
;
13609 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13610 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13611 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13613 /* With bidi-reordered rows, there could be more than
13614 one candidate row whose start and end positions
13615 occlude point. We need to let set_cursor_from_row
13616 find the best candidate. */
13617 /* FIXME: Revisit this when glyph ``spilling'' in
13618 continuation lines' rows is implemented for
13619 bidi-reordered rows. */
13624 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13625 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13626 && cursor_row_p (row
))
13627 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13629 /* As soon as we've found the first suitable row
13630 whose ends_at_zv_p flag is set, we are done. */
13632 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13634 rc
= CURSOR_MOVEMENT_SUCCESS
;
13639 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13640 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13641 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13642 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13643 /* If we didn't find any candidate rows, or exited the
13644 loop before all the candidates were examined, signal
13645 to the caller that this method failed. */
13646 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13647 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13648 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13650 rc
= CURSOR_MOVEMENT_SUCCESS
;
13656 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13658 rc
= CURSOR_MOVEMENT_SUCCESS
;
13663 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13664 && MATRIX_ROW_START_CHARPOS (row
) == PT
13665 && cursor_row_p (row
));
13674 set_vertical_scroll_bar (struct window
*w
)
13676 EMACS_INT start
, end
, whole
;
13678 /* Calculate the start and end positions for the current window.
13679 At some point, it would be nice to choose between scrollbars
13680 which reflect the whole buffer size, with special markers
13681 indicating narrowing, and scrollbars which reflect only the
13684 Note that mini-buffers sometimes aren't displaying any text. */
13685 if (!MINI_WINDOW_P (w
)
13686 || (w
== XWINDOW (minibuf_window
)
13687 && NILP (echo_area_buffer
[0])))
13689 struct buffer
*buf
= XBUFFER (w
->buffer
);
13690 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13691 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13692 /* I don't think this is guaranteed to be right. For the
13693 moment, we'll pretend it is. */
13694 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13698 if (whole
< (end
- start
))
13699 whole
= end
- start
;
13702 start
= end
= whole
= 0;
13704 /* Indicate what this scroll bar ought to be displaying now. */
13705 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13706 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13707 (w
, end
- start
, whole
, start
);
13711 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13712 selected_window is redisplayed.
13714 We can return without actually redisplaying the window if
13715 fonts_changed_p is nonzero. In that case, redisplay_internal will
13719 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13721 struct window
*w
= XWINDOW (window
);
13722 struct frame
*f
= XFRAME (w
->frame
);
13723 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13724 struct buffer
*old
= current_buffer
;
13725 struct text_pos lpoint
, opoint
, startp
;
13726 int update_mode_line
;
13729 /* Record it now because it's overwritten. */
13730 int current_matrix_up_to_date_p
= 0;
13731 int used_current_matrix_p
= 0;
13732 /* This is less strict than current_matrix_up_to_date_p.
13733 It indictes that the buffer contents and narrowing are unchanged. */
13734 int buffer_unchanged_p
= 0;
13735 int temp_scroll_step
= 0;
13736 int count
= SPECPDL_INDEX ();
13738 int centering_position
= -1;
13739 int last_line_misfit
= 0;
13740 EMACS_INT beg_unchanged
, end_unchanged
;
13742 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13745 /* W must be a leaf window here. */
13746 xassert (!NILP (w
->buffer
));
13748 *w
->desired_matrix
->method
= 0;
13752 reconsider_clip_changes (w
, buffer
);
13754 /* Has the mode line to be updated? */
13755 update_mode_line
= (!NILP (w
->update_mode_line
)
13756 || update_mode_lines
13757 || buffer
->clip_changed
13758 || buffer
->prevent_redisplay_optimizations_p
);
13760 if (MINI_WINDOW_P (w
))
13762 if (w
== XWINDOW (echo_area_window
)
13763 && !NILP (echo_area_buffer
[0]))
13765 if (update_mode_line
)
13766 /* We may have to update a tty frame's menu bar or a
13767 tool-bar. Example `M-x C-h C-h C-g'. */
13768 goto finish_menu_bars
;
13770 /* We've already displayed the echo area glyphs in this window. */
13771 goto finish_scroll_bars
;
13773 else if ((w
!= XWINDOW (minibuf_window
)
13774 || minibuf_level
== 0)
13775 /* When buffer is nonempty, redisplay window normally. */
13776 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13777 /* Quail displays non-mini buffers in minibuffer window.
13778 In that case, redisplay the window normally. */
13779 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13781 /* W is a mini-buffer window, but it's not active, so clear
13783 int yb
= window_text_bottom_y (w
);
13784 struct glyph_row
*row
;
13787 for (y
= 0, row
= w
->desired_matrix
->rows
;
13789 y
+= row
->height
, ++row
)
13790 blank_row (w
, row
, y
);
13791 goto finish_scroll_bars
;
13794 clear_glyph_matrix (w
->desired_matrix
);
13797 /* Otherwise set up data on this window; select its buffer and point
13799 /* Really select the buffer, for the sake of buffer-local
13801 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13803 current_matrix_up_to_date_p
13804 = (!NILP (w
->window_end_valid
)
13805 && !current_buffer
->clip_changed
13806 && !current_buffer
->prevent_redisplay_optimizations_p
13807 && XFASTINT (w
->last_modified
) >= MODIFF
13808 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13810 /* Run the window-bottom-change-functions
13811 if it is possible that the text on the screen has changed
13812 (either due to modification of the text, or any other reason). */
13813 if (!current_matrix_up_to_date_p
13814 && !NILP (Vwindow_text_change_functions
))
13816 safe_run_hooks (Qwindow_text_change_functions
);
13820 beg_unchanged
= BEG_UNCHANGED
;
13821 end_unchanged
= END_UNCHANGED
;
13823 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13825 specbind (Qinhibit_point_motion_hooks
, Qt
);
13828 = (!NILP (w
->window_end_valid
)
13829 && !current_buffer
->clip_changed
13830 && XFASTINT (w
->last_modified
) >= MODIFF
13831 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13833 /* When windows_or_buffers_changed is non-zero, we can't rely on
13834 the window end being valid, so set it to nil there. */
13835 if (windows_or_buffers_changed
)
13837 /* If window starts on a continuation line, maybe adjust the
13838 window start in case the window's width changed. */
13839 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13840 compute_window_start_on_continuation_line (w
);
13842 w
->window_end_valid
= Qnil
;
13845 /* Some sanity checks. */
13846 CHECK_WINDOW_END (w
);
13847 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13849 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13852 /* If %c is in mode line, update it if needed. */
13853 if (!NILP (w
->column_number_displayed
)
13854 /* This alternative quickly identifies a common case
13855 where no change is needed. */
13856 && !(PT
== XFASTINT (w
->last_point
)
13857 && XFASTINT (w
->last_modified
) >= MODIFF
13858 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13859 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13860 update_mode_line
= 1;
13862 /* Count number of windows showing the selected buffer. An indirect
13863 buffer counts as its base buffer. */
13864 if (!just_this_one_p
)
13866 struct buffer
*current_base
, *window_base
;
13867 current_base
= current_buffer
;
13868 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13869 if (current_base
->base_buffer
)
13870 current_base
= current_base
->base_buffer
;
13871 if (window_base
->base_buffer
)
13872 window_base
= window_base
->base_buffer
;
13873 if (current_base
== window_base
)
13877 /* Point refers normally to the selected window. For any other
13878 window, set up appropriate value. */
13879 if (!EQ (window
, selected_window
))
13881 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13882 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13886 new_pt_byte
= BEGV_BYTE
;
13887 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13889 else if (new_pt
> (ZV
- 1))
13892 new_pt_byte
= ZV_BYTE
;
13893 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13896 /* We don't use SET_PT so that the point-motion hooks don't run. */
13897 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13900 /* If any of the character widths specified in the display table
13901 have changed, invalidate the width run cache. It's true that
13902 this may be a bit late to catch such changes, but the rest of
13903 redisplay goes (non-fatally) haywire when the display table is
13904 changed, so why should we worry about doing any better? */
13905 if (current_buffer
->width_run_cache
)
13907 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13909 if (! disptab_matches_widthtab (disptab
,
13910 XVECTOR (BVAR (current_buffer
, width_table
))))
13912 invalidate_region_cache (current_buffer
,
13913 current_buffer
->width_run_cache
,
13915 recompute_width_table (current_buffer
, disptab
);
13919 /* If window-start is screwed up, choose a new one. */
13920 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13923 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13925 /* If someone specified a new starting point but did not insist,
13926 check whether it can be used. */
13927 if (!NILP (w
->optional_new_start
)
13928 && CHARPOS (startp
) >= BEGV
13929 && CHARPOS (startp
) <= ZV
)
13931 w
->optional_new_start
= Qnil
;
13932 start_display (&it
, w
, startp
);
13933 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13934 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13935 if (IT_CHARPOS (it
) == PT
)
13936 w
->force_start
= Qt
;
13937 /* IT may overshoot PT if text at PT is invisible. */
13938 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13939 w
->force_start
= Qt
;
13944 /* Handle case where place to start displaying has been specified,
13945 unless the specified location is outside the accessible range. */
13946 if (!NILP (w
->force_start
)
13947 || w
->frozen_window_start_p
)
13949 /* We set this later on if we have to adjust point. */
13952 w
->force_start
= Qnil
;
13954 w
->window_end_valid
= Qnil
;
13956 /* Forget any recorded base line for line number display. */
13957 if (!buffer_unchanged_p
)
13958 w
->base_line_number
= Qnil
;
13960 /* Redisplay the mode line. Select the buffer properly for that.
13961 Also, run the hook window-scroll-functions
13962 because we have scrolled. */
13963 /* Note, we do this after clearing force_start because
13964 if there's an error, it is better to forget about force_start
13965 than to get into an infinite loop calling the hook functions
13966 and having them get more errors. */
13967 if (!update_mode_line
13968 || ! NILP (Vwindow_scroll_functions
))
13970 update_mode_line
= 1;
13971 w
->update_mode_line
= Qt
;
13972 startp
= run_window_scroll_functions (window
, startp
);
13975 w
->last_modified
= make_number (0);
13976 w
->last_overlay_modified
= make_number (0);
13977 if (CHARPOS (startp
) < BEGV
)
13978 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13979 else if (CHARPOS (startp
) > ZV
)
13980 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13982 /* Redisplay, then check if cursor has been set during the
13983 redisplay. Give up if new fonts were loaded. */
13984 /* We used to issue a CHECK_MARGINS argument to try_window here,
13985 but this causes scrolling to fail when point begins inside
13986 the scroll margin (bug#148) -- cyd */
13987 if (!try_window (window
, startp
, 0))
13989 w
->force_start
= Qt
;
13990 clear_glyph_matrix (w
->desired_matrix
);
13991 goto need_larger_matrices
;
13994 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13996 /* If point does not appear, try to move point so it does
13997 appear. The desired matrix has been built above, so we
13998 can use it here. */
13999 new_vpos
= window_box_height (w
) / 2;
14002 if (!cursor_row_fully_visible_p (w
, 0, 0))
14004 /* Point does appear, but on a line partly visible at end of window.
14005 Move it back to a fully-visible line. */
14006 new_vpos
= window_box_height (w
);
14009 /* If we need to move point for either of the above reasons,
14010 now actually do it. */
14013 struct glyph_row
*row
;
14015 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14016 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14019 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14020 MATRIX_ROW_START_BYTEPOS (row
));
14022 if (w
!= XWINDOW (selected_window
))
14023 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14024 else if (current_buffer
== old
)
14025 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14027 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14029 /* If we are highlighting the region, then we just changed
14030 the region, so redisplay to show it. */
14031 if (!NILP (Vtransient_mark_mode
)
14032 && !NILP (BVAR (current_buffer
, mark_active
)))
14034 clear_glyph_matrix (w
->desired_matrix
);
14035 if (!try_window (window
, startp
, 0))
14036 goto need_larger_matrices
;
14041 debug_method_add (w
, "forced window start");
14046 /* Handle case where text has not changed, only point, and it has
14047 not moved off the frame, and we are not retrying after hscroll.
14048 (current_matrix_up_to_date_p is nonzero when retrying.) */
14049 if (current_matrix_up_to_date_p
14050 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14051 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14055 case CURSOR_MOVEMENT_SUCCESS
:
14056 used_current_matrix_p
= 1;
14059 case CURSOR_MOVEMENT_MUST_SCROLL
:
14060 goto try_to_scroll
;
14066 /* If current starting point was originally the beginning of a line
14067 but no longer is, find a new starting point. */
14068 else if (!NILP (w
->start_at_line_beg
)
14069 && !(CHARPOS (startp
) <= BEGV
14070 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14073 debug_method_add (w
, "recenter 1");
14078 /* Try scrolling with try_window_id. Value is > 0 if update has
14079 been done, it is -1 if we know that the same window start will
14080 not work. It is 0 if unsuccessful for some other reason. */
14081 else if ((tem
= try_window_id (w
)) != 0)
14084 debug_method_add (w
, "try_window_id %d", tem
);
14087 if (fonts_changed_p
)
14088 goto need_larger_matrices
;
14092 /* Otherwise try_window_id has returned -1 which means that we
14093 don't want the alternative below this comment to execute. */
14095 else if (CHARPOS (startp
) >= BEGV
14096 && CHARPOS (startp
) <= ZV
14097 && PT
>= CHARPOS (startp
)
14098 && (CHARPOS (startp
) < ZV
14099 /* Avoid starting at end of buffer. */
14100 || CHARPOS (startp
) == BEGV
14101 || (XFASTINT (w
->last_modified
) >= MODIFF
14102 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14105 /* If first window line is a continuation line, and window start
14106 is inside the modified region, but the first change is before
14107 current window start, we must select a new window start.
14109 However, if this is the result of a down-mouse event (e.g. by
14110 extending the mouse-drag-overlay), we don't want to select a
14111 new window start, since that would change the position under
14112 the mouse, resulting in an unwanted mouse-movement rather
14113 than a simple mouse-click. */
14114 if (NILP (w
->start_at_line_beg
)
14115 && NILP (do_mouse_tracking
)
14116 && CHARPOS (startp
) > BEGV
14117 && CHARPOS (startp
) > BEG
+ beg_unchanged
14118 && CHARPOS (startp
) <= Z
- end_unchanged
14119 /* Even if w->start_at_line_beg is nil, a new window may
14120 start at a line_beg, since that's how set_buffer_window
14121 sets it. So, we need to check the return value of
14122 compute_window_start_on_continuation_line. (See also
14124 && XMARKER (w
->start
)->buffer
== current_buffer
14125 && compute_window_start_on_continuation_line (w
))
14127 w
->force_start
= Qt
;
14128 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14133 debug_method_add (w
, "same window start");
14136 /* Try to redisplay starting at same place as before.
14137 If point has not moved off frame, accept the results. */
14138 if (!current_matrix_up_to_date_p
14139 /* Don't use try_window_reusing_current_matrix in this case
14140 because a window scroll function can have changed the
14142 || !NILP (Vwindow_scroll_functions
)
14143 || MINI_WINDOW_P (w
)
14144 || !(used_current_matrix_p
14145 = try_window_reusing_current_matrix (w
)))
14147 IF_DEBUG (debug_method_add (w
, "1"));
14148 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14149 /* -1 means we need to scroll.
14150 0 means we need new matrices, but fonts_changed_p
14151 is set in that case, so we will detect it below. */
14152 goto try_to_scroll
;
14155 if (fonts_changed_p
)
14156 goto need_larger_matrices
;
14158 if (w
->cursor
.vpos
>= 0)
14160 if (!just_this_one_p
14161 || current_buffer
->clip_changed
14162 || BEG_UNCHANGED
< CHARPOS (startp
))
14163 /* Forget any recorded base line for line number display. */
14164 w
->base_line_number
= Qnil
;
14166 if (!cursor_row_fully_visible_p (w
, 1, 0))
14168 clear_glyph_matrix (w
->desired_matrix
);
14169 last_line_misfit
= 1;
14171 /* Drop through and scroll. */
14176 clear_glyph_matrix (w
->desired_matrix
);
14181 w
->last_modified
= make_number (0);
14182 w
->last_overlay_modified
= make_number (0);
14184 /* Redisplay the mode line. Select the buffer properly for that. */
14185 if (!update_mode_line
)
14187 update_mode_line
= 1;
14188 w
->update_mode_line
= Qt
;
14191 /* Try to scroll by specified few lines. */
14192 if ((scroll_conservatively
14193 || emacs_scroll_step
14194 || temp_scroll_step
14195 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14196 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14197 && CHARPOS (startp
) >= BEGV
14198 && CHARPOS (startp
) <= ZV
)
14200 /* The function returns -1 if new fonts were loaded, 1 if
14201 successful, 0 if not successful. */
14202 int ss
= try_scrolling (window
, just_this_one_p
,
14203 scroll_conservatively
,
14205 temp_scroll_step
, last_line_misfit
);
14208 case SCROLLING_SUCCESS
:
14211 case SCROLLING_NEED_LARGER_MATRICES
:
14212 goto need_larger_matrices
;
14214 case SCROLLING_FAILED
:
14222 /* Finally, just choose a place to start which positions point
14223 according to user preferences. */
14228 debug_method_add (w
, "recenter");
14231 /* w->vscroll = 0; */
14233 /* Forget any previously recorded base line for line number display. */
14234 if (!buffer_unchanged_p
)
14235 w
->base_line_number
= Qnil
;
14237 /* Determine the window start relative to point. */
14238 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14239 it
.current_y
= it
.last_visible_y
;
14240 if (centering_position
< 0)
14244 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14246 EMACS_INT margin_pos
= CHARPOS (startp
);
14248 Lisp_Object aggressive
;
14250 /* If there is a scroll margin at the top of the window, find
14251 its character position. */
14256 start_display (&it1
, w
, startp
);
14257 move_it_vertically (&it1
, margin
);
14258 margin_pos
= IT_CHARPOS (it1
);
14260 scrolling_up
= PT
> margin_pos
;
14263 ? BVAR (current_buffer
, scroll_up_aggressively
)
14264 : BVAR (current_buffer
, scroll_down_aggressively
);
14266 if (!MINI_WINDOW_P (w
)
14267 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
14271 /* Setting scroll-conservatively overrides
14272 scroll-*-aggressively. */
14273 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14275 double float_amount
= XFLOATINT (aggressive
);
14277 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14278 if (pt_offset
== 0 && float_amount
> 0)
14283 /* Compute how much to move the window start backward from
14284 point so that point will be displayed where the user
14288 centering_position
= it
.last_visible_y
;
14290 centering_position
-= pt_offset
;
14291 centering_position
-=
14292 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14293 /* Don't let point enter the scroll margin near top of
14295 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
14296 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
14299 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
14302 /* Set the window start half the height of the window backward
14304 centering_position
= window_box_height (w
) / 2;
14306 move_it_vertically_backward (&it
, centering_position
);
14308 xassert (IT_CHARPOS (it
) >= BEGV
);
14310 /* The function move_it_vertically_backward may move over more
14311 than the specified y-distance. If it->w is small, e.g. a
14312 mini-buffer window, we may end up in front of the window's
14313 display area. Start displaying at the start of the line
14314 containing PT in this case. */
14315 if (it
.current_y
<= 0)
14317 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14318 move_it_vertically_backward (&it
, 0);
14322 it
.current_x
= it
.hpos
= 0;
14324 /* Set the window start position here explicitly, to avoid an
14325 infinite loop in case the functions in window-scroll-functions
14327 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14329 /* Run scroll hooks. */
14330 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14332 /* Redisplay the window. */
14333 if (!current_matrix_up_to_date_p
14334 || windows_or_buffers_changed
14335 || cursor_type_changed
14336 /* Don't use try_window_reusing_current_matrix in this case
14337 because it can have changed the buffer. */
14338 || !NILP (Vwindow_scroll_functions
)
14339 || !just_this_one_p
14340 || MINI_WINDOW_P (w
)
14341 || !(used_current_matrix_p
14342 = try_window_reusing_current_matrix (w
)))
14343 try_window (window
, startp
, 0);
14345 /* If new fonts have been loaded (due to fontsets), give up. We
14346 have to start a new redisplay since we need to re-adjust glyph
14348 if (fonts_changed_p
)
14349 goto need_larger_matrices
;
14351 /* If cursor did not appear assume that the middle of the window is
14352 in the first line of the window. Do it again with the next line.
14353 (Imagine a window of height 100, displaying two lines of height
14354 60. Moving back 50 from it->last_visible_y will end in the first
14356 if (w
->cursor
.vpos
< 0)
14358 if (!NILP (w
->window_end_valid
)
14359 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14361 clear_glyph_matrix (w
->desired_matrix
);
14362 move_it_by_lines (&it
, 1);
14363 try_window (window
, it
.current
.pos
, 0);
14365 else if (PT
< IT_CHARPOS (it
))
14367 clear_glyph_matrix (w
->desired_matrix
);
14368 move_it_by_lines (&it
, -1);
14369 try_window (window
, it
.current
.pos
, 0);
14373 /* Not much we can do about it. */
14377 /* Consider the following case: Window starts at BEGV, there is
14378 invisible, intangible text at BEGV, so that display starts at
14379 some point START > BEGV. It can happen that we are called with
14380 PT somewhere between BEGV and START. Try to handle that case. */
14381 if (w
->cursor
.vpos
< 0)
14383 struct glyph_row
*row
= w
->current_matrix
->rows
;
14384 if (row
->mode_line_p
)
14386 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14389 if (!cursor_row_fully_visible_p (w
, 0, 0))
14391 /* If vscroll is enabled, disable it and try again. */
14395 clear_glyph_matrix (w
->desired_matrix
);
14399 /* If centering point failed to make the whole line visible,
14400 put point at the top instead. That has to make the whole line
14401 visible, if it can be done. */
14402 if (centering_position
== 0)
14405 clear_glyph_matrix (w
->desired_matrix
);
14406 centering_position
= 0;
14412 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14413 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14414 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14417 /* Display the mode line, if we must. */
14418 if ((update_mode_line
14419 /* If window not full width, must redo its mode line
14420 if (a) the window to its side is being redone and
14421 (b) we do a frame-based redisplay. This is a consequence
14422 of how inverted lines are drawn in frame-based redisplay. */
14423 || (!just_this_one_p
14424 && !FRAME_WINDOW_P (f
)
14425 && !WINDOW_FULL_WIDTH_P (w
))
14426 /* Line number to display. */
14427 || INTEGERP (w
->base_line_pos
)
14428 /* Column number is displayed and different from the one displayed. */
14429 || (!NILP (w
->column_number_displayed
)
14430 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14431 /* This means that the window has a mode line. */
14432 && (WINDOW_WANTS_MODELINE_P (w
)
14433 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14435 display_mode_lines (w
);
14437 /* If mode line height has changed, arrange for a thorough
14438 immediate redisplay using the correct mode line height. */
14439 if (WINDOW_WANTS_MODELINE_P (w
)
14440 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14442 fonts_changed_p
= 1;
14443 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14444 = DESIRED_MODE_LINE_HEIGHT (w
);
14447 /* If header line height has changed, arrange for a thorough
14448 immediate redisplay using the correct header line height. */
14449 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14450 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14452 fonts_changed_p
= 1;
14453 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14454 = DESIRED_HEADER_LINE_HEIGHT (w
);
14457 if (fonts_changed_p
)
14458 goto need_larger_matrices
;
14461 if (!line_number_displayed
14462 && !BUFFERP (w
->base_line_pos
))
14464 w
->base_line_pos
= Qnil
;
14465 w
->base_line_number
= Qnil
;
14470 /* When we reach a frame's selected window, redo the frame's menu bar. */
14471 if (update_mode_line
14472 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14474 int redisplay_menu_p
= 0;
14475 int redisplay_tool_bar_p
= 0;
14477 if (FRAME_WINDOW_P (f
))
14479 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14480 || defined (HAVE_NS) || defined (USE_GTK)
14481 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14483 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14487 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14489 if (redisplay_menu_p
)
14490 display_menu_bar (w
);
14492 #ifdef HAVE_WINDOW_SYSTEM
14493 if (FRAME_WINDOW_P (f
))
14495 #if defined (USE_GTK) || defined (HAVE_NS)
14496 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14498 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14499 && (FRAME_TOOL_BAR_LINES (f
) > 0
14500 || !NILP (Vauto_resize_tool_bars
));
14503 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14505 ignore_mouse_drag_p
= 1;
14511 #ifdef HAVE_WINDOW_SYSTEM
14512 if (FRAME_WINDOW_P (f
)
14513 && update_window_fringes (w
, (just_this_one_p
14514 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14515 || w
->pseudo_window_p
)))
14519 if (draw_window_fringes (w
, 1))
14520 x_draw_vertical_border (w
);
14524 #endif /* HAVE_WINDOW_SYSTEM */
14526 /* We go to this label, with fonts_changed_p nonzero,
14527 if it is necessary to try again using larger glyph matrices.
14528 We have to redeem the scroll bar even in this case,
14529 because the loop in redisplay_internal expects that. */
14530 need_larger_matrices
:
14532 finish_scroll_bars
:
14534 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14536 /* Set the thumb's position and size. */
14537 set_vertical_scroll_bar (w
);
14539 /* Note that we actually used the scroll bar attached to this
14540 window, so it shouldn't be deleted at the end of redisplay. */
14541 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14542 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14545 /* Restore current_buffer and value of point in it. The window
14546 update may have changed the buffer, so first make sure `opoint'
14547 is still valid (Bug#6177). */
14548 if (CHARPOS (opoint
) < BEGV
)
14549 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14550 else if (CHARPOS (opoint
) > ZV
)
14551 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14553 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14555 set_buffer_internal_1 (old
);
14556 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14557 shorter. This can be caused by log truncation in *Messages*. */
14558 if (CHARPOS (lpoint
) <= ZV
)
14559 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14561 unbind_to (count
, Qnil
);
14565 /* Build the complete desired matrix of WINDOW with a window start
14566 buffer position POS.
14568 Value is 1 if successful. It is zero if fonts were loaded during
14569 redisplay which makes re-adjusting glyph matrices necessary, and -1
14570 if point would appear in the scroll margins.
14571 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14572 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14576 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14578 struct window
*w
= XWINDOW (window
);
14580 struct glyph_row
*last_text_row
= NULL
;
14581 struct frame
*f
= XFRAME (w
->frame
);
14583 /* Make POS the new window start. */
14584 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14586 /* Mark cursor position as unknown. No overlay arrow seen. */
14587 w
->cursor
.vpos
= -1;
14588 overlay_arrow_seen
= 0;
14590 /* Initialize iterator and info to start at POS. */
14591 start_display (&it
, w
, pos
);
14593 /* Display all lines of W. */
14594 while (it
.current_y
< it
.last_visible_y
)
14596 if (display_line (&it
))
14597 last_text_row
= it
.glyph_row
- 1;
14598 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14602 /* Don't let the cursor end in the scroll margins. */
14603 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14604 && !MINI_WINDOW_P (w
))
14606 int this_scroll_margin
;
14608 if (scroll_margin
> 0)
14610 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14611 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14614 this_scroll_margin
= 0;
14616 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14617 && w
->cursor
.y
< this_scroll_margin
14618 && CHARPOS (pos
) > BEGV
14619 && IT_CHARPOS (it
) < ZV
)
14620 /* rms: considering make_cursor_line_fully_visible_p here
14621 seems to give wrong results. We don't want to recenter
14622 when the last line is partly visible, we want to allow
14623 that case to be handled in the usual way. */
14624 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14626 w
->cursor
.vpos
= -1;
14627 clear_glyph_matrix (w
->desired_matrix
);
14632 /* If bottom moved off end of frame, change mode line percentage. */
14633 if (XFASTINT (w
->window_end_pos
) <= 0
14634 && Z
!= IT_CHARPOS (it
))
14635 w
->update_mode_line
= Qt
;
14637 /* Set window_end_pos to the offset of the last character displayed
14638 on the window from the end of current_buffer. Set
14639 window_end_vpos to its row number. */
14642 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14643 w
->window_end_bytepos
14644 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14646 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14648 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14649 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14650 ->displays_text_p
);
14654 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14655 w
->window_end_pos
= make_number (Z
- ZV
);
14656 w
->window_end_vpos
= make_number (0);
14659 /* But that is not valid info until redisplay finishes. */
14660 w
->window_end_valid
= Qnil
;
14666 /************************************************************************
14667 Window redisplay reusing current matrix when buffer has not changed
14668 ************************************************************************/
14670 /* Try redisplay of window W showing an unchanged buffer with a
14671 different window start than the last time it was displayed by
14672 reusing its current matrix. Value is non-zero if successful.
14673 W->start is the new window start. */
14676 try_window_reusing_current_matrix (struct window
*w
)
14678 struct frame
*f
= XFRAME (w
->frame
);
14679 struct glyph_row
*bottom_row
;
14682 struct text_pos start
, new_start
;
14683 int nrows_scrolled
, i
;
14684 struct glyph_row
*last_text_row
;
14685 struct glyph_row
*last_reused_text_row
;
14686 struct glyph_row
*start_row
;
14687 int start_vpos
, min_y
, max_y
;
14690 if (inhibit_try_window_reusing
)
14694 if (/* This function doesn't handle terminal frames. */
14695 !FRAME_WINDOW_P (f
)
14696 /* Don't try to reuse the display if windows have been split
14698 || windows_or_buffers_changed
14699 || cursor_type_changed
)
14702 /* Can't do this if region may have changed. */
14703 if ((!NILP (Vtransient_mark_mode
)
14704 && !NILP (BVAR (current_buffer
, mark_active
)))
14705 || !NILP (w
->region_showing
)
14706 || !NILP (Vshow_trailing_whitespace
))
14709 /* If top-line visibility has changed, give up. */
14710 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14711 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14714 /* Give up if old or new display is scrolled vertically. We could
14715 make this function handle this, but right now it doesn't. */
14716 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14717 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14720 /* The variable new_start now holds the new window start. The old
14721 start `start' can be determined from the current matrix. */
14722 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14723 start
= start_row
->minpos
;
14724 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14726 /* Clear the desired matrix for the display below. */
14727 clear_glyph_matrix (w
->desired_matrix
);
14729 if (CHARPOS (new_start
) <= CHARPOS (start
))
14731 /* Don't use this method if the display starts with an ellipsis
14732 displayed for invisible text. It's not easy to handle that case
14733 below, and it's certainly not worth the effort since this is
14734 not a frequent case. */
14735 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14738 IF_DEBUG (debug_method_add (w
, "twu1"));
14740 /* Display up to a row that can be reused. The variable
14741 last_text_row is set to the last row displayed that displays
14742 text. Note that it.vpos == 0 if or if not there is a
14743 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14744 start_display (&it
, w
, new_start
);
14745 w
->cursor
.vpos
= -1;
14746 last_text_row
= last_reused_text_row
= NULL
;
14748 while (it
.current_y
< it
.last_visible_y
14749 && !fonts_changed_p
)
14751 /* If we have reached into the characters in the START row,
14752 that means the line boundaries have changed. So we
14753 can't start copying with the row START. Maybe it will
14754 work to start copying with the following row. */
14755 while (IT_CHARPOS (it
) > CHARPOS (start
))
14757 /* Advance to the next row as the "start". */
14759 start
= start_row
->minpos
;
14760 /* If there are no more rows to try, or just one, give up. */
14761 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14762 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14763 || CHARPOS (start
) == ZV
)
14765 clear_glyph_matrix (w
->desired_matrix
);
14769 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14771 /* If we have reached alignment,
14772 we can copy the rest of the rows. */
14773 if (IT_CHARPOS (it
) == CHARPOS (start
))
14776 if (display_line (&it
))
14777 last_text_row
= it
.glyph_row
- 1;
14780 /* A value of current_y < last_visible_y means that we stopped
14781 at the previous window start, which in turn means that we
14782 have at least one reusable row. */
14783 if (it
.current_y
< it
.last_visible_y
)
14785 struct glyph_row
*row
;
14787 /* IT.vpos always starts from 0; it counts text lines. */
14788 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14790 /* Find PT if not already found in the lines displayed. */
14791 if (w
->cursor
.vpos
< 0)
14793 int dy
= it
.current_y
- start_row
->y
;
14795 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14796 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14798 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14799 dy
, nrows_scrolled
);
14802 clear_glyph_matrix (w
->desired_matrix
);
14807 /* Scroll the display. Do it before the current matrix is
14808 changed. The problem here is that update has not yet
14809 run, i.e. part of the current matrix is not up to date.
14810 scroll_run_hook will clear the cursor, and use the
14811 current matrix to get the height of the row the cursor is
14813 run
.current_y
= start_row
->y
;
14814 run
.desired_y
= it
.current_y
;
14815 run
.height
= it
.last_visible_y
- it
.current_y
;
14817 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14820 FRAME_RIF (f
)->update_window_begin_hook (w
);
14821 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14822 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14823 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14827 /* Shift current matrix down by nrows_scrolled lines. */
14828 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14829 rotate_matrix (w
->current_matrix
,
14831 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14834 /* Disable lines that must be updated. */
14835 for (i
= 0; i
< nrows_scrolled
; ++i
)
14836 (start_row
+ i
)->enabled_p
= 0;
14838 /* Re-compute Y positions. */
14839 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14840 max_y
= it
.last_visible_y
;
14841 for (row
= start_row
+ nrows_scrolled
;
14845 row
->y
= it
.current_y
;
14846 row
->visible_height
= row
->height
;
14848 if (row
->y
< min_y
)
14849 row
->visible_height
-= min_y
- row
->y
;
14850 if (row
->y
+ row
->height
> max_y
)
14851 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14852 row
->redraw_fringe_bitmaps_p
= 1;
14854 it
.current_y
+= row
->height
;
14856 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14857 last_reused_text_row
= row
;
14858 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14862 /* Disable lines in the current matrix which are now
14863 below the window. */
14864 for (++row
; row
< bottom_row
; ++row
)
14865 row
->enabled_p
= row
->mode_line_p
= 0;
14868 /* Update window_end_pos etc.; last_reused_text_row is the last
14869 reused row from the current matrix containing text, if any.
14870 The value of last_text_row is the last displayed line
14871 containing text. */
14872 if (last_reused_text_row
)
14874 w
->window_end_bytepos
14875 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14877 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14879 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14880 w
->current_matrix
));
14882 else if (last_text_row
)
14884 w
->window_end_bytepos
14885 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14887 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14889 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14893 /* This window must be completely empty. */
14894 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14895 w
->window_end_pos
= make_number (Z
- ZV
);
14896 w
->window_end_vpos
= make_number (0);
14898 w
->window_end_valid
= Qnil
;
14900 /* Update hint: don't try scrolling again in update_window. */
14901 w
->desired_matrix
->no_scrolling_p
= 1;
14904 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14908 else if (CHARPOS (new_start
) > CHARPOS (start
))
14910 struct glyph_row
*pt_row
, *row
;
14911 struct glyph_row
*first_reusable_row
;
14912 struct glyph_row
*first_row_to_display
;
14914 int yb
= window_text_bottom_y (w
);
14916 /* Find the row starting at new_start, if there is one. Don't
14917 reuse a partially visible line at the end. */
14918 first_reusable_row
= start_row
;
14919 while (first_reusable_row
->enabled_p
14920 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14921 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14922 < CHARPOS (new_start
)))
14923 ++first_reusable_row
;
14925 /* Give up if there is no row to reuse. */
14926 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14927 || !first_reusable_row
->enabled_p
14928 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14929 != CHARPOS (new_start
)))
14932 /* We can reuse fully visible rows beginning with
14933 first_reusable_row to the end of the window. Set
14934 first_row_to_display to the first row that cannot be reused.
14935 Set pt_row to the row containing point, if there is any. */
14937 for (first_row_to_display
= first_reusable_row
;
14938 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14939 ++first_row_to_display
)
14941 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14942 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14943 pt_row
= first_row_to_display
;
14946 /* Start displaying at the start of first_row_to_display. */
14947 xassert (first_row_to_display
->y
< yb
);
14948 init_to_row_start (&it
, w
, first_row_to_display
);
14950 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14952 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14954 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14955 + WINDOW_HEADER_LINE_HEIGHT (w
));
14957 /* Display lines beginning with first_row_to_display in the
14958 desired matrix. Set last_text_row to the last row displayed
14959 that displays text. */
14960 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14961 if (pt_row
== NULL
)
14962 w
->cursor
.vpos
= -1;
14963 last_text_row
= NULL
;
14964 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14965 if (display_line (&it
))
14966 last_text_row
= it
.glyph_row
- 1;
14968 /* If point is in a reused row, adjust y and vpos of the cursor
14972 w
->cursor
.vpos
-= nrows_scrolled
;
14973 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14976 /* Give up if point isn't in a row displayed or reused. (This
14977 also handles the case where w->cursor.vpos < nrows_scrolled
14978 after the calls to display_line, which can happen with scroll
14979 margins. See bug#1295.) */
14980 if (w
->cursor
.vpos
< 0)
14982 clear_glyph_matrix (w
->desired_matrix
);
14986 /* Scroll the display. */
14987 run
.current_y
= first_reusable_row
->y
;
14988 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14989 run
.height
= it
.last_visible_y
- run
.current_y
;
14990 dy
= run
.current_y
- run
.desired_y
;
14995 FRAME_RIF (f
)->update_window_begin_hook (w
);
14996 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14997 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14998 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15002 /* Adjust Y positions of reused rows. */
15003 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15004 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15005 max_y
= it
.last_visible_y
;
15006 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15009 row
->visible_height
= row
->height
;
15010 if (row
->y
< min_y
)
15011 row
->visible_height
-= min_y
- row
->y
;
15012 if (row
->y
+ row
->height
> max_y
)
15013 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15014 row
->redraw_fringe_bitmaps_p
= 1;
15017 /* Scroll the current matrix. */
15018 xassert (nrows_scrolled
> 0);
15019 rotate_matrix (w
->current_matrix
,
15021 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15024 /* Disable rows not reused. */
15025 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15026 row
->enabled_p
= 0;
15028 /* Point may have moved to a different line, so we cannot assume that
15029 the previous cursor position is valid; locate the correct row. */
15032 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15033 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15037 w
->cursor
.y
= row
->y
;
15039 if (row
< bottom_row
)
15041 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15042 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15044 /* Can't use this optimization with bidi-reordered glyph
15045 rows, unless cursor is already at point. */
15046 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15048 if (!(w
->cursor
.hpos
>= 0
15049 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15050 && BUFFERP (glyph
->object
)
15051 && glyph
->charpos
== PT
))
15056 && (!BUFFERP (glyph
->object
)
15057 || glyph
->charpos
< PT
);
15061 w
->cursor
.x
+= glyph
->pixel_width
;
15066 /* Adjust window end. A null value of last_text_row means that
15067 the window end is in reused rows which in turn means that
15068 only its vpos can have changed. */
15071 w
->window_end_bytepos
15072 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15074 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15076 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15081 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15084 w
->window_end_valid
= Qnil
;
15085 w
->desired_matrix
->no_scrolling_p
= 1;
15088 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15098 /************************************************************************
15099 Window redisplay reusing current matrix when buffer has changed
15100 ************************************************************************/
15102 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15103 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15104 EMACS_INT
*, EMACS_INT
*);
15105 static struct glyph_row
*
15106 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15107 struct glyph_row
*);
15110 /* Return the last row in MATRIX displaying text. If row START is
15111 non-null, start searching with that row. IT gives the dimensions
15112 of the display. Value is null if matrix is empty; otherwise it is
15113 a pointer to the row found. */
15115 static struct glyph_row
*
15116 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15117 struct glyph_row
*start
)
15119 struct glyph_row
*row
, *row_found
;
15121 /* Set row_found to the last row in IT->w's current matrix
15122 displaying text. The loop looks funny but think of partially
15125 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15126 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15128 xassert (row
->enabled_p
);
15130 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15139 /* Return the last row in the current matrix of W that is not affected
15140 by changes at the start of current_buffer that occurred since W's
15141 current matrix was built. Value is null if no such row exists.
15143 BEG_UNCHANGED us the number of characters unchanged at the start of
15144 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15145 first changed character in current_buffer. Characters at positions <
15146 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15147 when the current matrix was built. */
15149 static struct glyph_row
*
15150 find_last_unchanged_at_beg_row (struct window
*w
)
15152 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15153 struct glyph_row
*row
;
15154 struct glyph_row
*row_found
= NULL
;
15155 int yb
= window_text_bottom_y (w
);
15157 /* Find the last row displaying unchanged text. */
15158 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15159 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15160 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15163 if (/* If row ends before first_changed_pos, it is unchanged,
15164 except in some case. */
15165 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15166 /* When row ends in ZV and we write at ZV it is not
15168 && !row
->ends_at_zv_p
15169 /* When first_changed_pos is the end of a continued line,
15170 row is not unchanged because it may be no longer
15172 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15173 && (row
->continued_p
15174 || row
->exact_window_width_line_p
)))
15177 /* Stop if last visible row. */
15178 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15186 /* Find the first glyph row in the current matrix of W that is not
15187 affected by changes at the end of current_buffer since the
15188 time W's current matrix was built.
15190 Return in *DELTA the number of chars by which buffer positions in
15191 unchanged text at the end of current_buffer must be adjusted.
15193 Return in *DELTA_BYTES the corresponding number of bytes.
15195 Value is null if no such row exists, i.e. all rows are affected by
15198 static struct glyph_row
*
15199 find_first_unchanged_at_end_row (struct window
*w
,
15200 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15202 struct glyph_row
*row
;
15203 struct glyph_row
*row_found
= NULL
;
15205 *delta
= *delta_bytes
= 0;
15207 /* Display must not have been paused, otherwise the current matrix
15208 is not up to date. */
15209 eassert (!NILP (w
->window_end_valid
));
15211 /* A value of window_end_pos >= END_UNCHANGED means that the window
15212 end is in the range of changed text. If so, there is no
15213 unchanged row at the end of W's current matrix. */
15214 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15217 /* Set row to the last row in W's current matrix displaying text. */
15218 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15220 /* If matrix is entirely empty, no unchanged row exists. */
15221 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15223 /* The value of row is the last glyph row in the matrix having a
15224 meaningful buffer position in it. The end position of row
15225 corresponds to window_end_pos. This allows us to translate
15226 buffer positions in the current matrix to current buffer
15227 positions for characters not in changed text. */
15229 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15230 EMACS_INT Z_BYTE_old
=
15231 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15232 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15233 struct glyph_row
*first_text_row
15234 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15236 *delta
= Z
- Z_old
;
15237 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15239 /* Set last_unchanged_pos to the buffer position of the last
15240 character in the buffer that has not been changed. Z is the
15241 index + 1 of the last character in current_buffer, i.e. by
15242 subtracting END_UNCHANGED we get the index of the last
15243 unchanged character, and we have to add BEG to get its buffer
15245 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15246 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15248 /* Search backward from ROW for a row displaying a line that
15249 starts at a minimum position >= last_unchanged_pos_old. */
15250 for (; row
> first_text_row
; --row
)
15252 /* This used to abort, but it can happen.
15253 It is ok to just stop the search instead here. KFS. */
15254 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15257 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15262 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15268 /* Make sure that glyph rows in the current matrix of window W
15269 reference the same glyph memory as corresponding rows in the
15270 frame's frame matrix. This function is called after scrolling W's
15271 current matrix on a terminal frame in try_window_id and
15272 try_window_reusing_current_matrix. */
15275 sync_frame_with_window_matrix_rows (struct window
*w
)
15277 struct frame
*f
= XFRAME (w
->frame
);
15278 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15280 /* Preconditions: W must be a leaf window and full-width. Its frame
15281 must have a frame matrix. */
15282 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15283 xassert (WINDOW_FULL_WIDTH_P (w
));
15284 xassert (!FRAME_WINDOW_P (f
));
15286 /* If W is a full-width window, glyph pointers in W's current matrix
15287 have, by definition, to be the same as glyph pointers in the
15288 corresponding frame matrix. Note that frame matrices have no
15289 marginal areas (see build_frame_matrix). */
15290 window_row
= w
->current_matrix
->rows
;
15291 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15292 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15293 while (window_row
< window_row_end
)
15295 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15296 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15298 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15299 frame_row
->glyphs
[TEXT_AREA
] = start
;
15300 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15301 frame_row
->glyphs
[LAST_AREA
] = end
;
15303 /* Disable frame rows whose corresponding window rows have
15304 been disabled in try_window_id. */
15305 if (!window_row
->enabled_p
)
15306 frame_row
->enabled_p
= 0;
15308 ++window_row
, ++frame_row
;
15313 /* Find the glyph row in window W containing CHARPOS. Consider all
15314 rows between START and END (not inclusive). END null means search
15315 all rows to the end of the display area of W. Value is the row
15316 containing CHARPOS or null. */
15319 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15320 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15322 struct glyph_row
*row
= start
;
15323 struct glyph_row
*best_row
= NULL
;
15324 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15327 /* If we happen to start on a header-line, skip that. */
15328 if (row
->mode_line_p
)
15331 if ((end
&& row
>= end
) || !row
->enabled_p
)
15334 last_y
= window_text_bottom_y (w
) - dy
;
15338 /* Give up if we have gone too far. */
15339 if (end
&& row
>= end
)
15341 /* This formerly returned if they were equal.
15342 I think that both quantities are of a "last plus one" type;
15343 if so, when they are equal, the row is within the screen. -- rms. */
15344 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15347 /* If it is in this row, return this row. */
15348 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15349 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15350 /* The end position of a row equals the start
15351 position of the next row. If CHARPOS is there, we
15352 would rather display it in the next line, except
15353 when this line ends in ZV. */
15354 && !row
->ends_at_zv_p
15355 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15356 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15360 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15361 || (!best_row
&& !row
->continued_p
))
15363 /* In bidi-reordered rows, there could be several rows
15364 occluding point, all of them belonging to the same
15365 continued line. We need to find the row which fits
15366 CHARPOS the best. */
15367 for (g
= row
->glyphs
[TEXT_AREA
];
15368 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15371 if (!STRINGP (g
->object
))
15373 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15375 mindif
= eabs (g
->charpos
- charpos
);
15377 /* Exact match always wins. */
15384 else if (best_row
&& !row
->continued_p
)
15391 /* Try to redisplay window W by reusing its existing display. W's
15392 current matrix must be up to date when this function is called,
15393 i.e. window_end_valid must not be nil.
15397 1 if display has been updated
15398 0 if otherwise unsuccessful
15399 -1 if redisplay with same window start is known not to succeed
15401 The following steps are performed:
15403 1. Find the last row in the current matrix of W that is not
15404 affected by changes at the start of current_buffer. If no such row
15407 2. Find the first row in W's current matrix that is not affected by
15408 changes at the end of current_buffer. Maybe there is no such row.
15410 3. Display lines beginning with the row + 1 found in step 1 to the
15411 row found in step 2 or, if step 2 didn't find a row, to the end of
15414 4. If cursor is not known to appear on the window, give up.
15416 5. If display stopped at the row found in step 2, scroll the
15417 display and current matrix as needed.
15419 6. Maybe display some lines at the end of W, if we must. This can
15420 happen under various circumstances, like a partially visible line
15421 becoming fully visible, or because newly displayed lines are displayed
15422 in smaller font sizes.
15424 7. Update W's window end information. */
15427 try_window_id (struct window
*w
)
15429 struct frame
*f
= XFRAME (w
->frame
);
15430 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15431 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15432 struct glyph_row
*last_unchanged_at_beg_row
;
15433 struct glyph_row
*first_unchanged_at_end_row
;
15434 struct glyph_row
*row
;
15435 struct glyph_row
*bottom_row
;
15438 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15440 struct text_pos start_pos
;
15442 int first_unchanged_at_end_vpos
= 0;
15443 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15444 struct text_pos start
;
15445 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15448 if (inhibit_try_window_id
)
15452 /* This is handy for debugging. */
15454 #define GIVE_UP(X) \
15456 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15460 #define GIVE_UP(X) return 0
15463 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15465 /* Don't use this for mini-windows because these can show
15466 messages and mini-buffers, and we don't handle that here. */
15467 if (MINI_WINDOW_P (w
))
15470 /* This flag is used to prevent redisplay optimizations. */
15471 if (windows_or_buffers_changed
|| cursor_type_changed
)
15474 /* Verify that narrowing has not changed.
15475 Also verify that we were not told to prevent redisplay optimizations.
15476 It would be nice to further
15477 reduce the number of cases where this prevents try_window_id. */
15478 if (current_buffer
->clip_changed
15479 || current_buffer
->prevent_redisplay_optimizations_p
)
15482 /* Window must either use window-based redisplay or be full width. */
15483 if (!FRAME_WINDOW_P (f
)
15484 && (!FRAME_LINE_INS_DEL_OK (f
)
15485 || !WINDOW_FULL_WIDTH_P (w
)))
15488 /* Give up if point is known NOT to appear in W. */
15489 if (PT
< CHARPOS (start
))
15492 /* Another way to prevent redisplay optimizations. */
15493 if (XFASTINT (w
->last_modified
) == 0)
15496 /* Verify that window is not hscrolled. */
15497 if (XFASTINT (w
->hscroll
) != 0)
15500 /* Verify that display wasn't paused. */
15501 if (NILP (w
->window_end_valid
))
15504 /* Can't use this if highlighting a region because a cursor movement
15505 will do more than just set the cursor. */
15506 if (!NILP (Vtransient_mark_mode
)
15507 && !NILP (BVAR (current_buffer
, mark_active
)))
15510 /* Likewise if highlighting trailing whitespace. */
15511 if (!NILP (Vshow_trailing_whitespace
))
15514 /* Likewise if showing a region. */
15515 if (!NILP (w
->region_showing
))
15518 /* Can't use this if overlay arrow position and/or string have
15520 if (overlay_arrows_changed_p ())
15523 /* When word-wrap is on, adding a space to the first word of a
15524 wrapped line can change the wrap position, altering the line
15525 above it. It might be worthwhile to handle this more
15526 intelligently, but for now just redisplay from scratch. */
15527 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15530 /* Under bidi reordering, adding or deleting a character in the
15531 beginning of a paragraph, before the first strong directional
15532 character, can change the base direction of the paragraph (unless
15533 the buffer specifies a fixed paragraph direction), which will
15534 require to redisplay the whole paragraph. It might be worthwhile
15535 to find the paragraph limits and widen the range of redisplayed
15536 lines to that, but for now just give up this optimization and
15537 redisplay from scratch. */
15538 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15539 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15542 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15543 only if buffer has really changed. The reason is that the gap is
15544 initially at Z for freshly visited files. The code below would
15545 set end_unchanged to 0 in that case. */
15546 if (MODIFF
> SAVE_MODIFF
15547 /* This seems to happen sometimes after saving a buffer. */
15548 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15550 if (GPT
- BEG
< BEG_UNCHANGED
)
15551 BEG_UNCHANGED
= GPT
- BEG
;
15552 if (Z
- GPT
< END_UNCHANGED
)
15553 END_UNCHANGED
= Z
- GPT
;
15556 /* The position of the first and last character that has been changed. */
15557 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15558 last_changed_charpos
= Z
- END_UNCHANGED
;
15560 /* If window starts after a line end, and the last change is in
15561 front of that newline, then changes don't affect the display.
15562 This case happens with stealth-fontification. Note that although
15563 the display is unchanged, glyph positions in the matrix have to
15564 be adjusted, of course. */
15565 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15566 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15567 && ((last_changed_charpos
< CHARPOS (start
)
15568 && CHARPOS (start
) == BEGV
)
15569 || (last_changed_charpos
< CHARPOS (start
) - 1
15570 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15572 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15573 struct glyph_row
*r0
;
15575 /* Compute how many chars/bytes have been added to or removed
15576 from the buffer. */
15577 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15578 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15579 Z_delta
= Z
- Z_old
;
15580 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15582 /* Give up if PT is not in the window. Note that it already has
15583 been checked at the start of try_window_id that PT is not in
15584 front of the window start. */
15585 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15588 /* If window start is unchanged, we can reuse the whole matrix
15589 as is, after adjusting glyph positions. No need to compute
15590 the window end again, since its offset from Z hasn't changed. */
15591 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15592 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15593 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15594 /* PT must not be in a partially visible line. */
15595 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15596 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15598 /* Adjust positions in the glyph matrix. */
15599 if (Z_delta
|| Z_delta_bytes
)
15601 struct glyph_row
*r1
15602 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15603 increment_matrix_positions (w
->current_matrix
,
15604 MATRIX_ROW_VPOS (r0
, current_matrix
),
15605 MATRIX_ROW_VPOS (r1
, current_matrix
),
15606 Z_delta
, Z_delta_bytes
);
15609 /* Set the cursor. */
15610 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15612 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15619 /* Handle the case that changes are all below what is displayed in
15620 the window, and that PT is in the window. This shortcut cannot
15621 be taken if ZV is visible in the window, and text has been added
15622 there that is visible in the window. */
15623 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15624 /* ZV is not visible in the window, or there are no
15625 changes at ZV, actually. */
15626 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15627 || first_changed_charpos
== last_changed_charpos
))
15629 struct glyph_row
*r0
;
15631 /* Give up if PT is not in the window. Note that it already has
15632 been checked at the start of try_window_id that PT is not in
15633 front of the window start. */
15634 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15637 /* If window start is unchanged, we can reuse the whole matrix
15638 as is, without changing glyph positions since no text has
15639 been added/removed in front of the window end. */
15640 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15641 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15642 /* PT must not be in a partially visible line. */
15643 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15644 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15646 /* We have to compute the window end anew since text
15647 could have been added/removed after it. */
15649 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15650 w
->window_end_bytepos
15651 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15653 /* Set the cursor. */
15654 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15656 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15663 /* Give up if window start is in the changed area.
15665 The condition used to read
15667 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15669 but why that was tested escapes me at the moment. */
15670 if (CHARPOS (start
) >= first_changed_charpos
15671 && CHARPOS (start
) <= last_changed_charpos
)
15674 /* Check that window start agrees with the start of the first glyph
15675 row in its current matrix. Check this after we know the window
15676 start is not in changed text, otherwise positions would not be
15678 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15679 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15682 /* Give up if the window ends in strings. Overlay strings
15683 at the end are difficult to handle, so don't try. */
15684 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15685 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15688 /* Compute the position at which we have to start displaying new
15689 lines. Some of the lines at the top of the window might be
15690 reusable because they are not displaying changed text. Find the
15691 last row in W's current matrix not affected by changes at the
15692 start of current_buffer. Value is null if changes start in the
15693 first line of window. */
15694 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15695 if (last_unchanged_at_beg_row
)
15697 /* Avoid starting to display in the moddle of a character, a TAB
15698 for instance. This is easier than to set up the iterator
15699 exactly, and it's not a frequent case, so the additional
15700 effort wouldn't really pay off. */
15701 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15702 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15703 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15704 --last_unchanged_at_beg_row
;
15706 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15709 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15711 start_pos
= it
.current
.pos
;
15713 /* Start displaying new lines in the desired matrix at the same
15714 vpos we would use in the current matrix, i.e. below
15715 last_unchanged_at_beg_row. */
15716 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15718 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15719 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15721 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15725 /* There are no reusable lines at the start of the window.
15726 Start displaying in the first text line. */
15727 start_display (&it
, w
, start
);
15728 it
.vpos
= it
.first_vpos
;
15729 start_pos
= it
.current
.pos
;
15732 /* Find the first row that is not affected by changes at the end of
15733 the buffer. Value will be null if there is no unchanged row, in
15734 which case we must redisplay to the end of the window. delta
15735 will be set to the value by which buffer positions beginning with
15736 first_unchanged_at_end_row have to be adjusted due to text
15738 first_unchanged_at_end_row
15739 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15740 IF_DEBUG (debug_delta
= delta
);
15741 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15743 /* Set stop_pos to the buffer position up to which we will have to
15744 display new lines. If first_unchanged_at_end_row != NULL, this
15745 is the buffer position of the start of the line displayed in that
15746 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15747 that we don't stop at a buffer position. */
15749 if (first_unchanged_at_end_row
)
15751 xassert (last_unchanged_at_beg_row
== NULL
15752 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15754 /* If this is a continuation line, move forward to the next one
15755 that isn't. Changes in lines above affect this line.
15756 Caution: this may move first_unchanged_at_end_row to a row
15757 not displaying text. */
15758 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15759 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15760 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15761 < it
.last_visible_y
))
15762 ++first_unchanged_at_end_row
;
15764 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15765 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15766 >= it
.last_visible_y
))
15767 first_unchanged_at_end_row
= NULL
;
15770 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15772 first_unchanged_at_end_vpos
15773 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15774 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15777 else if (last_unchanged_at_beg_row
== NULL
)
15783 /* Either there is no unchanged row at the end, or the one we have
15784 now displays text. This is a necessary condition for the window
15785 end pos calculation at the end of this function. */
15786 xassert (first_unchanged_at_end_row
== NULL
15787 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15789 debug_last_unchanged_at_beg_vpos
15790 = (last_unchanged_at_beg_row
15791 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15793 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15795 #endif /* GLYPH_DEBUG != 0 */
15798 /* Display new lines. Set last_text_row to the last new line
15799 displayed which has text on it, i.e. might end up as being the
15800 line where the window_end_vpos is. */
15801 w
->cursor
.vpos
= -1;
15802 last_text_row
= NULL
;
15803 overlay_arrow_seen
= 0;
15804 while (it
.current_y
< it
.last_visible_y
15805 && !fonts_changed_p
15806 && (first_unchanged_at_end_row
== NULL
15807 || IT_CHARPOS (it
) < stop_pos
))
15809 if (display_line (&it
))
15810 last_text_row
= it
.glyph_row
- 1;
15813 if (fonts_changed_p
)
15817 /* Compute differences in buffer positions, y-positions etc. for
15818 lines reused at the bottom of the window. Compute what we can
15820 if (first_unchanged_at_end_row
15821 /* No lines reused because we displayed everything up to the
15822 bottom of the window. */
15823 && it
.current_y
< it
.last_visible_y
)
15826 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15828 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15829 run
.current_y
= first_unchanged_at_end_row
->y
;
15830 run
.desired_y
= run
.current_y
+ dy
;
15831 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15835 delta
= delta_bytes
= dvpos
= dy
15836 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15837 first_unchanged_at_end_row
= NULL
;
15839 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15842 /* Find the cursor if not already found. We have to decide whether
15843 PT will appear on this window (it sometimes doesn't, but this is
15844 not a very frequent case.) This decision has to be made before
15845 the current matrix is altered. A value of cursor.vpos < 0 means
15846 that PT is either in one of the lines beginning at
15847 first_unchanged_at_end_row or below the window. Don't care for
15848 lines that might be displayed later at the window end; as
15849 mentioned, this is not a frequent case. */
15850 if (w
->cursor
.vpos
< 0)
15852 /* Cursor in unchanged rows at the top? */
15853 if (PT
< CHARPOS (start_pos
)
15854 && last_unchanged_at_beg_row
)
15856 row
= row_containing_pos (w
, PT
,
15857 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15858 last_unchanged_at_beg_row
+ 1, 0);
15860 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15863 /* Start from first_unchanged_at_end_row looking for PT. */
15864 else if (first_unchanged_at_end_row
)
15866 row
= row_containing_pos (w
, PT
- delta
,
15867 first_unchanged_at_end_row
, NULL
, 0);
15869 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15870 delta_bytes
, dy
, dvpos
);
15873 /* Give up if cursor was not found. */
15874 if (w
->cursor
.vpos
< 0)
15876 clear_glyph_matrix (w
->desired_matrix
);
15881 /* Don't let the cursor end in the scroll margins. */
15883 int this_scroll_margin
, cursor_height
;
15885 this_scroll_margin
= max (0, scroll_margin
);
15886 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15887 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15888 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15890 if ((w
->cursor
.y
< this_scroll_margin
15891 && CHARPOS (start
) > BEGV
)
15892 /* Old redisplay didn't take scroll margin into account at the bottom,
15893 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15894 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15895 ? cursor_height
+ this_scroll_margin
15896 : 1)) > it
.last_visible_y
)
15898 w
->cursor
.vpos
= -1;
15899 clear_glyph_matrix (w
->desired_matrix
);
15904 /* Scroll the display. Do it before changing the current matrix so
15905 that xterm.c doesn't get confused about where the cursor glyph is
15907 if (dy
&& run
.height
)
15911 if (FRAME_WINDOW_P (f
))
15913 FRAME_RIF (f
)->update_window_begin_hook (w
);
15914 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15915 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15916 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15920 /* Terminal frame. In this case, dvpos gives the number of
15921 lines to scroll by; dvpos < 0 means scroll up. */
15923 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15924 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
15925 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15926 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15927 + window_internal_height (w
));
15929 #if defined (HAVE_GPM) || defined (MSDOS)
15930 x_clear_window_mouse_face (w
);
15932 /* Perform the operation on the screen. */
15935 /* Scroll last_unchanged_at_beg_row to the end of the
15936 window down dvpos lines. */
15937 set_terminal_window (f
, end
);
15939 /* On dumb terminals delete dvpos lines at the end
15940 before inserting dvpos empty lines. */
15941 if (!FRAME_SCROLL_REGION_OK (f
))
15942 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15944 /* Insert dvpos empty lines in front of
15945 last_unchanged_at_beg_row. */
15946 ins_del_lines (f
, from
, dvpos
);
15948 else if (dvpos
< 0)
15950 /* Scroll up last_unchanged_at_beg_vpos to the end of
15951 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15952 set_terminal_window (f
, end
);
15954 /* Delete dvpos lines in front of
15955 last_unchanged_at_beg_vpos. ins_del_lines will set
15956 the cursor to the given vpos and emit |dvpos| delete
15958 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15960 /* On a dumb terminal insert dvpos empty lines at the
15962 if (!FRAME_SCROLL_REGION_OK (f
))
15963 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15966 set_terminal_window (f
, 0);
15972 /* Shift reused rows of the current matrix to the right position.
15973 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15975 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15976 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15979 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15980 bottom_vpos
, dvpos
);
15981 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15984 else if (dvpos
> 0)
15986 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15987 bottom_vpos
, dvpos
);
15988 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15989 first_unchanged_at_end_vpos
+ dvpos
, 0);
15992 /* For frame-based redisplay, make sure that current frame and window
15993 matrix are in sync with respect to glyph memory. */
15994 if (!FRAME_WINDOW_P (f
))
15995 sync_frame_with_window_matrix_rows (w
);
15997 /* Adjust buffer positions in reused rows. */
15998 if (delta
|| delta_bytes
)
15999 increment_matrix_positions (current_matrix
,
16000 first_unchanged_at_end_vpos
+ dvpos
,
16001 bottom_vpos
, delta
, delta_bytes
);
16003 /* Adjust Y positions. */
16005 shift_glyph_matrix (w
, current_matrix
,
16006 first_unchanged_at_end_vpos
+ dvpos
,
16009 if (first_unchanged_at_end_row
)
16011 first_unchanged_at_end_row
+= dvpos
;
16012 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16013 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16014 first_unchanged_at_end_row
= NULL
;
16017 /* If scrolling up, there may be some lines to display at the end of
16019 last_text_row_at_end
= NULL
;
16022 /* Scrolling up can leave for example a partially visible line
16023 at the end of the window to be redisplayed. */
16024 /* Set last_row to the glyph row in the current matrix where the
16025 window end line is found. It has been moved up or down in
16026 the matrix by dvpos. */
16027 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16028 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16030 /* If last_row is the window end line, it should display text. */
16031 xassert (last_row
->displays_text_p
);
16033 /* If window end line was partially visible before, begin
16034 displaying at that line. Otherwise begin displaying with the
16035 line following it. */
16036 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16038 init_to_row_start (&it
, w
, last_row
);
16039 it
.vpos
= last_vpos
;
16040 it
.current_y
= last_row
->y
;
16044 init_to_row_end (&it
, w
, last_row
);
16045 it
.vpos
= 1 + last_vpos
;
16046 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16050 /* We may start in a continuation line. If so, we have to
16051 get the right continuation_lines_width and current_x. */
16052 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16053 it
.hpos
= it
.current_x
= 0;
16055 /* Display the rest of the lines at the window end. */
16056 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16057 while (it
.current_y
< it
.last_visible_y
16058 && !fonts_changed_p
)
16060 /* Is it always sure that the display agrees with lines in
16061 the current matrix? I don't think so, so we mark rows
16062 displayed invalid in the current matrix by setting their
16063 enabled_p flag to zero. */
16064 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16065 if (display_line (&it
))
16066 last_text_row_at_end
= it
.glyph_row
- 1;
16070 /* Update window_end_pos and window_end_vpos. */
16071 if (first_unchanged_at_end_row
16072 && !last_text_row_at_end
)
16074 /* Window end line if one of the preserved rows from the current
16075 matrix. Set row to the last row displaying text in current
16076 matrix starting at first_unchanged_at_end_row, after
16078 xassert (first_unchanged_at_end_row
->displays_text_p
);
16079 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16080 first_unchanged_at_end_row
);
16081 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16083 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16084 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16086 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16087 xassert (w
->window_end_bytepos
>= 0);
16088 IF_DEBUG (debug_method_add (w
, "A"));
16090 else if (last_text_row_at_end
)
16093 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16094 w
->window_end_bytepos
16095 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16097 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16098 xassert (w
->window_end_bytepos
>= 0);
16099 IF_DEBUG (debug_method_add (w
, "B"));
16101 else if (last_text_row
)
16103 /* We have displayed either to the end of the window or at the
16104 end of the window, i.e. the last row with text is to be found
16105 in the desired matrix. */
16107 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16108 w
->window_end_bytepos
16109 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16111 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16112 xassert (w
->window_end_bytepos
>= 0);
16114 else if (first_unchanged_at_end_row
== NULL
16115 && last_text_row
== NULL
16116 && last_text_row_at_end
== NULL
)
16118 /* Displayed to end of window, but no line containing text was
16119 displayed. Lines were deleted at the end of the window. */
16120 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16121 int vpos
= XFASTINT (w
->window_end_vpos
);
16122 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16123 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16126 row
== NULL
&& vpos
>= first_vpos
;
16127 --vpos
, --current_row
, --desired_row
)
16129 if (desired_row
->enabled_p
)
16131 if (desired_row
->displays_text_p
)
16134 else if (current_row
->displays_text_p
)
16138 xassert (row
!= NULL
);
16139 w
->window_end_vpos
= make_number (vpos
+ 1);
16140 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16141 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16142 xassert (w
->window_end_bytepos
>= 0);
16143 IF_DEBUG (debug_method_add (w
, "C"));
16148 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16149 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16151 /* Record that display has not been completed. */
16152 w
->window_end_valid
= Qnil
;
16153 w
->desired_matrix
->no_scrolling_p
= 1;
16161 /***********************************************************************
16162 More debugging support
16163 ***********************************************************************/
16167 void dump_glyph_row (struct glyph_row
*, int, int);
16168 void dump_glyph_matrix (struct glyph_matrix
*, int);
16169 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16172 /* Dump the contents of glyph matrix MATRIX on stderr.
16174 GLYPHS 0 means don't show glyph contents.
16175 GLYPHS 1 means show glyphs in short form
16176 GLYPHS > 1 means show glyphs in long form. */
16179 dump_glyph_matrix (matrix
, glyphs
)
16180 struct glyph_matrix
*matrix
;
16184 for (i
= 0; i
< matrix
->nrows
; ++i
)
16185 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16189 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16190 the glyph row and area where the glyph comes from. */
16193 dump_glyph (row
, glyph
, area
)
16194 struct glyph_row
*row
;
16195 struct glyph
*glyph
;
16198 if (glyph
->type
== CHAR_GLYPH
)
16201 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16202 glyph
- row
->glyphs
[TEXT_AREA
],
16205 (BUFFERP (glyph
->object
)
16207 : (STRINGP (glyph
->object
)
16210 glyph
->pixel_width
,
16212 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16216 glyph
->left_box_line_p
,
16217 glyph
->right_box_line_p
);
16219 else if (glyph
->type
== STRETCH_GLYPH
)
16222 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16223 glyph
- row
->glyphs
[TEXT_AREA
],
16226 (BUFFERP (glyph
->object
)
16228 : (STRINGP (glyph
->object
)
16231 glyph
->pixel_width
,
16235 glyph
->left_box_line_p
,
16236 glyph
->right_box_line_p
);
16238 else if (glyph
->type
== IMAGE_GLYPH
)
16241 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16242 glyph
- row
->glyphs
[TEXT_AREA
],
16245 (BUFFERP (glyph
->object
)
16247 : (STRINGP (glyph
->object
)
16250 glyph
->pixel_width
,
16254 glyph
->left_box_line_p
,
16255 glyph
->right_box_line_p
);
16257 else if (glyph
->type
== COMPOSITE_GLYPH
)
16260 " %5d %4c %6d %c %3d 0x%05x",
16261 glyph
- row
->glyphs
[TEXT_AREA
],
16264 (BUFFERP (glyph
->object
)
16266 : (STRINGP (glyph
->object
)
16269 glyph
->pixel_width
,
16271 if (glyph
->u
.cmp
.automatic
)
16274 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16275 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16277 glyph
->left_box_line_p
,
16278 glyph
->right_box_line_p
);
16283 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16284 GLYPHS 0 means don't show glyph contents.
16285 GLYPHS 1 means show glyphs in short form
16286 GLYPHS > 1 means show glyphs in long form. */
16289 dump_glyph_row (row
, vpos
, glyphs
)
16290 struct glyph_row
*row
;
16295 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16296 fprintf (stderr
, "======================================================================\n");
16298 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16299 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16301 MATRIX_ROW_START_CHARPOS (row
),
16302 MATRIX_ROW_END_CHARPOS (row
),
16303 row
->used
[TEXT_AREA
],
16304 row
->contains_overlapping_glyphs_p
,
16306 row
->truncated_on_left_p
,
16307 row
->truncated_on_right_p
,
16309 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16310 row
->displays_text_p
,
16313 row
->ends_in_middle_of_char_p
,
16314 row
->starts_in_middle_of_char_p
,
16320 row
->visible_height
,
16323 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16324 row
->end
.overlay_string_index
,
16325 row
->continuation_lines_width
);
16326 fprintf (stderr
, "%9d %5d\n",
16327 CHARPOS (row
->start
.string_pos
),
16328 CHARPOS (row
->end
.string_pos
));
16329 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16330 row
->end
.dpvec_index
);
16337 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16339 struct glyph
*glyph
= row
->glyphs
[area
];
16340 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16342 /* Glyph for a line end in text. */
16343 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16346 if (glyph
< glyph_end
)
16347 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16349 for (; glyph
< glyph_end
; ++glyph
)
16350 dump_glyph (row
, glyph
, area
);
16353 else if (glyphs
== 1)
16357 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16359 char *s
= (char *) alloca (row
->used
[area
] + 1);
16362 for (i
= 0; i
< row
->used
[area
]; ++i
)
16364 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16365 if (glyph
->type
== CHAR_GLYPH
16366 && glyph
->u
.ch
< 0x80
16367 && glyph
->u
.ch
>= ' ')
16368 s
[i
] = glyph
->u
.ch
;
16374 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16380 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16381 Sdump_glyph_matrix
, 0, 1, "p",
16382 doc
: /* Dump the current matrix of the selected window to stderr.
16383 Shows contents of glyph row structures. With non-nil
16384 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16385 glyphs in short form, otherwise show glyphs in long form. */)
16386 (Lisp_Object glyphs
)
16388 struct window
*w
= XWINDOW (selected_window
);
16389 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16391 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16392 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16393 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16394 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16395 fprintf (stderr
, "=============================================\n");
16396 dump_glyph_matrix (w
->current_matrix
,
16397 NILP (glyphs
) ? 0 : XINT (glyphs
));
16402 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16403 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16406 struct frame
*f
= XFRAME (selected_frame
);
16407 dump_glyph_matrix (f
->current_matrix
, 1);
16412 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16413 doc
: /* Dump glyph row ROW to stderr.
16414 GLYPH 0 means don't dump glyphs.
16415 GLYPH 1 means dump glyphs in short form.
16416 GLYPH > 1 or omitted means dump glyphs in long form. */)
16417 (Lisp_Object row
, Lisp_Object glyphs
)
16419 struct glyph_matrix
*matrix
;
16422 CHECK_NUMBER (row
);
16423 matrix
= XWINDOW (selected_window
)->current_matrix
;
16425 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16426 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16428 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16433 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16434 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16435 GLYPH 0 means don't dump glyphs.
16436 GLYPH 1 means dump glyphs in short form.
16437 GLYPH > 1 or omitted means dump glyphs in long form. */)
16438 (Lisp_Object row
, Lisp_Object glyphs
)
16440 struct frame
*sf
= SELECTED_FRAME ();
16441 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16444 CHECK_NUMBER (row
);
16446 if (vpos
>= 0 && vpos
< m
->nrows
)
16447 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16448 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16453 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16454 doc
: /* Toggle tracing of redisplay.
16455 With ARG, turn tracing on if and only if ARG is positive. */)
16459 trace_redisplay_p
= !trace_redisplay_p
;
16462 arg
= Fprefix_numeric_value (arg
);
16463 trace_redisplay_p
= XINT (arg
) > 0;
16470 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16471 doc
: /* Like `format', but print result to stderr.
16472 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16473 (size_t nargs
, Lisp_Object
*args
)
16475 Lisp_Object s
= Fformat (nargs
, args
);
16476 fprintf (stderr
, "%s", SDATA (s
));
16480 #endif /* GLYPH_DEBUG */
16484 /***********************************************************************
16485 Building Desired Matrix Rows
16486 ***********************************************************************/
16488 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16489 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16491 static struct glyph_row
*
16492 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16494 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16495 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16496 struct buffer
*old
= current_buffer
;
16497 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16498 int arrow_len
= SCHARS (overlay_arrow_string
);
16499 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16500 const unsigned char *p
;
16503 int n_glyphs_before
;
16505 set_buffer_temp (buffer
);
16506 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16507 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16508 SET_TEXT_POS (it
.position
, 0, 0);
16510 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16512 while (p
< arrow_end
)
16514 Lisp_Object face
, ilisp
;
16516 /* Get the next character. */
16518 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16521 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16522 if (! ASCII_CHAR_P (it
.c
))
16523 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16527 /* Get its face. */
16528 ilisp
= make_number (p
- arrow_string
);
16529 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16530 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16532 /* Compute its width, get its glyphs. */
16533 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16534 SET_TEXT_POS (it
.position
, -1, -1);
16535 PRODUCE_GLYPHS (&it
);
16537 /* If this character doesn't fit any more in the line, we have
16538 to remove some glyphs. */
16539 if (it
.current_x
> it
.last_visible_x
)
16541 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16546 set_buffer_temp (old
);
16547 return it
.glyph_row
;
16551 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16552 glyphs are only inserted for terminal frames since we can't really
16553 win with truncation glyphs when partially visible glyphs are
16554 involved. Which glyphs to insert is determined by
16555 produce_special_glyphs. */
16558 insert_left_trunc_glyphs (struct it
*it
)
16560 struct it truncate_it
;
16561 struct glyph
*from
, *end
, *to
, *toend
;
16563 xassert (!FRAME_WINDOW_P (it
->f
));
16565 /* Get the truncation glyphs. */
16567 truncate_it
.current_x
= 0;
16568 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16569 truncate_it
.glyph_row
= &scratch_glyph_row
;
16570 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16571 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16572 truncate_it
.object
= make_number (0);
16573 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16575 /* Overwrite glyphs from IT with truncation glyphs. */
16576 if (!it
->glyph_row
->reversed_p
)
16578 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16579 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16580 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16581 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16586 /* There may be padding glyphs left over. Overwrite them too. */
16587 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16589 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16595 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16599 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16600 that back to front. */
16601 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16602 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16603 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16604 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16606 while (from
>= end
&& to
>= toend
)
16608 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16611 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16612 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16613 while (from
>= end
&& to
>= toend
)
16618 /* Need to free some room before prepending additional
16620 int move_by
= from
- end
+ 1;
16621 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16622 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16624 for ( ; g
>= g0
; g
--)
16626 while (from
>= end
)
16628 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16634 /* Compute the pixel height and width of IT->glyph_row.
16636 Most of the time, ascent and height of a display line will be equal
16637 to the max_ascent and max_height values of the display iterator
16638 structure. This is not the case if
16640 1. We hit ZV without displaying anything. In this case, max_ascent
16641 and max_height will be zero.
16643 2. We have some glyphs that don't contribute to the line height.
16644 (The glyph row flag contributes_to_line_height_p is for future
16645 pixmap extensions).
16647 The first case is easily covered by using default values because in
16648 these cases, the line height does not really matter, except that it
16649 must not be zero. */
16652 compute_line_metrics (struct it
*it
)
16654 struct glyph_row
*row
= it
->glyph_row
;
16656 if (FRAME_WINDOW_P (it
->f
))
16658 int i
, min_y
, max_y
;
16660 /* The line may consist of one space only, that was added to
16661 place the cursor on it. If so, the row's height hasn't been
16663 if (row
->height
== 0)
16665 if (it
->max_ascent
+ it
->max_descent
== 0)
16666 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16667 row
->ascent
= it
->max_ascent
;
16668 row
->height
= it
->max_ascent
+ it
->max_descent
;
16669 row
->phys_ascent
= it
->max_phys_ascent
;
16670 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16671 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16674 /* Compute the width of this line. */
16675 row
->pixel_width
= row
->x
;
16676 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16677 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16679 xassert (row
->pixel_width
>= 0);
16680 xassert (row
->ascent
>= 0 && row
->height
> 0);
16682 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16683 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16685 /* If first line's physical ascent is larger than its logical
16686 ascent, use the physical ascent, and make the row taller.
16687 This makes accented characters fully visible. */
16688 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16689 && row
->phys_ascent
> row
->ascent
)
16691 row
->height
+= row
->phys_ascent
- row
->ascent
;
16692 row
->ascent
= row
->phys_ascent
;
16695 /* Compute how much of the line is visible. */
16696 row
->visible_height
= row
->height
;
16698 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16699 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16701 if (row
->y
< min_y
)
16702 row
->visible_height
-= min_y
- row
->y
;
16703 if (row
->y
+ row
->height
> max_y
)
16704 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16708 row
->pixel_width
= row
->used
[TEXT_AREA
];
16709 if (row
->continued_p
)
16710 row
->pixel_width
-= it
->continuation_pixel_width
;
16711 else if (row
->truncated_on_right_p
)
16712 row
->pixel_width
-= it
->truncation_pixel_width
;
16713 row
->ascent
= row
->phys_ascent
= 0;
16714 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16715 row
->extra_line_spacing
= 0;
16718 /* Compute a hash code for this row. */
16722 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16723 for (i
= 0; i
< row
->used
[area
]; ++i
)
16724 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16725 + row
->glyphs
[area
][i
].u
.val
16726 + row
->glyphs
[area
][i
].face_id
16727 + row
->glyphs
[area
][i
].padding_p
16728 + (row
->glyphs
[area
][i
].type
<< 2));
16731 it
->max_ascent
= it
->max_descent
= 0;
16732 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16736 /* Append one space to the glyph row of iterator IT if doing a
16737 window-based redisplay. The space has the same face as
16738 IT->face_id. Value is non-zero if a space was added.
16740 This function is called to make sure that there is always one glyph
16741 at the end of a glyph row that the cursor can be set on under
16742 window-systems. (If there weren't such a glyph we would not know
16743 how wide and tall a box cursor should be displayed).
16745 At the same time this space let's a nicely handle clearing to the
16746 end of the line if the row ends in italic text. */
16749 append_space_for_newline (struct it
*it
, int default_face_p
)
16751 if (FRAME_WINDOW_P (it
->f
))
16753 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16755 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16756 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16758 /* Save some values that must not be changed.
16759 Must save IT->c and IT->len because otherwise
16760 ITERATOR_AT_END_P wouldn't work anymore after
16761 append_space_for_newline has been called. */
16762 enum display_element_type saved_what
= it
->what
;
16763 int saved_c
= it
->c
, saved_len
= it
->len
;
16764 int saved_char_to_display
= it
->char_to_display
;
16765 int saved_x
= it
->current_x
;
16766 int saved_face_id
= it
->face_id
;
16767 struct text_pos saved_pos
;
16768 Lisp_Object saved_object
;
16771 saved_object
= it
->object
;
16772 saved_pos
= it
->position
;
16774 it
->what
= IT_CHARACTER
;
16775 memset (&it
->position
, 0, sizeof it
->position
);
16776 it
->object
= make_number (0);
16777 it
->c
= it
->char_to_display
= ' ';
16780 if (default_face_p
)
16781 it
->face_id
= DEFAULT_FACE_ID
;
16782 else if (it
->face_before_selective_p
)
16783 it
->face_id
= it
->saved_face_id
;
16784 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16785 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16787 PRODUCE_GLYPHS (it
);
16789 it
->override_ascent
= -1;
16790 it
->constrain_row_ascent_descent_p
= 0;
16791 it
->current_x
= saved_x
;
16792 it
->object
= saved_object
;
16793 it
->position
= saved_pos
;
16794 it
->what
= saved_what
;
16795 it
->face_id
= saved_face_id
;
16796 it
->len
= saved_len
;
16798 it
->char_to_display
= saved_char_to_display
;
16807 /* Extend the face of the last glyph in the text area of IT->glyph_row
16808 to the end of the display line. Called from display_line. If the
16809 glyph row is empty, add a space glyph to it so that we know the
16810 face to draw. Set the glyph row flag fill_line_p. If the glyph
16811 row is R2L, prepend a stretch glyph to cover the empty space to the
16812 left of the leftmost glyph. */
16815 extend_face_to_end_of_line (struct it
*it
)
16818 struct frame
*f
= it
->f
;
16820 /* If line is already filled, do nothing. Non window-system frames
16821 get a grace of one more ``pixel'' because their characters are
16822 1-``pixel'' wide, so they hit the equality too early. This grace
16823 is needed only for R2L rows that are not continued, to produce
16824 one extra blank where we could display the cursor. */
16825 if (it
->current_x
>= it
->last_visible_x
16826 + (!FRAME_WINDOW_P (f
)
16827 && it
->glyph_row
->reversed_p
16828 && !it
->glyph_row
->continued_p
))
16831 /* Face extension extends the background and box of IT->face_id
16832 to the end of the line. If the background equals the background
16833 of the frame, we don't have to do anything. */
16834 if (it
->face_before_selective_p
)
16835 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16837 face
= FACE_FROM_ID (f
, it
->face_id
);
16839 if (FRAME_WINDOW_P (f
)
16840 && it
->glyph_row
->displays_text_p
16841 && face
->box
== FACE_NO_BOX
16842 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16844 && !it
->glyph_row
->reversed_p
)
16847 /* Set the glyph row flag indicating that the face of the last glyph
16848 in the text area has to be drawn to the end of the text area. */
16849 it
->glyph_row
->fill_line_p
= 1;
16851 /* If current character of IT is not ASCII, make sure we have the
16852 ASCII face. This will be automatically undone the next time
16853 get_next_display_element returns a multibyte character. Note
16854 that the character will always be single byte in unibyte
16856 if (!ASCII_CHAR_P (it
->c
))
16858 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16861 if (FRAME_WINDOW_P (f
))
16863 /* If the row is empty, add a space with the current face of IT,
16864 so that we know which face to draw. */
16865 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16867 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16868 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16869 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16871 #ifdef HAVE_WINDOW_SYSTEM
16872 if (it
->glyph_row
->reversed_p
)
16874 /* Prepend a stretch glyph to the row, such that the
16875 rightmost glyph will be drawn flushed all the way to the
16876 right margin of the window. The stretch glyph that will
16877 occupy the empty space, if any, to the left of the
16879 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16880 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16881 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16883 int row_width
, stretch_ascent
, stretch_width
;
16884 struct text_pos saved_pos
;
16885 int saved_face_id
, saved_avoid_cursor
;
16887 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16888 row_width
+= g
->pixel_width
;
16889 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16890 if (stretch_width
> 0)
16893 (((it
->ascent
+ it
->descent
)
16894 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16895 saved_pos
= it
->position
;
16896 memset (&it
->position
, 0, sizeof it
->position
);
16897 saved_avoid_cursor
= it
->avoid_cursor_p
;
16898 it
->avoid_cursor_p
= 1;
16899 saved_face_id
= it
->face_id
;
16900 /* The last row's stretch glyph should get the default
16901 face, to avoid painting the rest of the window with
16902 the region face, if the region ends at ZV. */
16903 if (it
->glyph_row
->ends_at_zv_p
)
16904 it
->face_id
= DEFAULT_FACE_ID
;
16906 it
->face_id
= face
->id
;
16907 append_stretch_glyph (it
, make_number (0), stretch_width
,
16908 it
->ascent
+ it
->descent
, stretch_ascent
);
16909 it
->position
= saved_pos
;
16910 it
->avoid_cursor_p
= saved_avoid_cursor
;
16911 it
->face_id
= saved_face_id
;
16914 #endif /* HAVE_WINDOW_SYSTEM */
16918 /* Save some values that must not be changed. */
16919 int saved_x
= it
->current_x
;
16920 struct text_pos saved_pos
;
16921 Lisp_Object saved_object
;
16922 enum display_element_type saved_what
= it
->what
;
16923 int saved_face_id
= it
->face_id
;
16925 saved_object
= it
->object
;
16926 saved_pos
= it
->position
;
16928 it
->what
= IT_CHARACTER
;
16929 memset (&it
->position
, 0, sizeof it
->position
);
16930 it
->object
= make_number (0);
16931 it
->c
= it
->char_to_display
= ' ';
16933 /* The last row's blank glyphs should get the default face, to
16934 avoid painting the rest of the window with the region face,
16935 if the region ends at ZV. */
16936 if (it
->glyph_row
->ends_at_zv_p
)
16937 it
->face_id
= DEFAULT_FACE_ID
;
16939 it
->face_id
= face
->id
;
16941 PRODUCE_GLYPHS (it
);
16943 while (it
->current_x
<= it
->last_visible_x
)
16944 PRODUCE_GLYPHS (it
);
16946 /* Don't count these blanks really. It would let us insert a left
16947 truncation glyph below and make us set the cursor on them, maybe. */
16948 it
->current_x
= saved_x
;
16949 it
->object
= saved_object
;
16950 it
->position
= saved_pos
;
16951 it
->what
= saved_what
;
16952 it
->face_id
= saved_face_id
;
16957 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16958 trailing whitespace. */
16961 trailing_whitespace_p (EMACS_INT charpos
)
16963 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16966 while (bytepos
< ZV_BYTE
16967 && (c
= FETCH_CHAR (bytepos
),
16968 c
== ' ' || c
== '\t'))
16971 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16973 if (bytepos
!= PT_BYTE
)
16980 /* Highlight trailing whitespace, if any, in ROW. */
16983 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16985 int used
= row
->used
[TEXT_AREA
];
16989 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16990 struct glyph
*glyph
= start
+ used
- 1;
16992 if (row
->reversed_p
)
16994 /* Right-to-left rows need to be processed in the opposite
16995 direction, so swap the edge pointers. */
16997 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17000 /* Skip over glyphs inserted to display the cursor at the
17001 end of a line, for extending the face of the last glyph
17002 to the end of the line on terminals, and for truncation
17003 and continuation glyphs. */
17004 if (!row
->reversed_p
)
17006 while (glyph
>= start
17007 && glyph
->type
== CHAR_GLYPH
17008 && INTEGERP (glyph
->object
))
17013 while (glyph
<= start
17014 && glyph
->type
== CHAR_GLYPH
17015 && INTEGERP (glyph
->object
))
17019 /* If last glyph is a space or stretch, and it's trailing
17020 whitespace, set the face of all trailing whitespace glyphs in
17021 IT->glyph_row to `trailing-whitespace'. */
17022 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17023 && BUFFERP (glyph
->object
)
17024 && (glyph
->type
== STRETCH_GLYPH
17025 || (glyph
->type
== CHAR_GLYPH
17026 && glyph
->u
.ch
== ' '))
17027 && trailing_whitespace_p (glyph
->charpos
))
17029 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17033 if (!row
->reversed_p
)
17035 while (glyph
>= start
17036 && BUFFERP (glyph
->object
)
17037 && (glyph
->type
== STRETCH_GLYPH
17038 || (glyph
->type
== CHAR_GLYPH
17039 && glyph
->u
.ch
== ' ')))
17040 (glyph
--)->face_id
= face_id
;
17044 while (glyph
<= start
17045 && BUFFERP (glyph
->object
)
17046 && (glyph
->type
== STRETCH_GLYPH
17047 || (glyph
->type
== CHAR_GLYPH
17048 && glyph
->u
.ch
== ' ')))
17049 (glyph
++)->face_id
= face_id
;
17056 /* Value is non-zero if glyph row ROW should be
17057 used to hold the cursor. */
17060 cursor_row_p (struct glyph_row
*row
)
17064 if (PT
== CHARPOS (row
->end
.pos
))
17066 /* Suppose the row ends on a string.
17067 Unless the row is continued, that means it ends on a newline
17068 in the string. If it's anything other than a display string
17069 (e.g. a before-string from an overlay), we don't want the
17070 cursor there. (This heuristic seems to give the optimal
17071 behavior for the various types of multi-line strings.) */
17072 if (CHARPOS (row
->end
.string_pos
) >= 0)
17074 if (row
->continued_p
)
17078 /* Check for `display' property. */
17079 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17080 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17081 struct glyph
*glyph
;
17084 for (glyph
= end
; glyph
>= beg
; --glyph
)
17085 if (STRINGP (glyph
->object
))
17088 = Fget_char_property (make_number (PT
),
17092 && display_prop_string_p (prop
, glyph
->object
));
17097 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17099 /* If the row ends in middle of a real character,
17100 and the line is continued, we want the cursor here.
17101 That's because CHARPOS (ROW->end.pos) would equal
17102 PT if PT is before the character. */
17103 if (!row
->ends_in_ellipsis_p
)
17104 result
= row
->continued_p
;
17106 /* If the row ends in an ellipsis, then
17107 CHARPOS (ROW->end.pos) will equal point after the
17108 invisible text. We want that position to be displayed
17109 after the ellipsis. */
17112 /* If the row ends at ZV, display the cursor at the end of that
17113 row instead of at the start of the row below. */
17114 else if (row
->ends_at_zv_p
)
17125 /* Push the display property PROP so that it will be rendered at the
17126 current position in IT. Return 1 if PROP was successfully pushed,
17130 push_display_prop (struct it
*it
, Lisp_Object prop
)
17134 if (STRINGP (prop
))
17136 if (SCHARS (prop
) == 0)
17143 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17144 it
->current
.overlay_string_index
= -1;
17145 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17146 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17147 it
->method
= GET_FROM_STRING
;
17148 it
->stop_charpos
= 0;
17150 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17152 it
->method
= GET_FROM_STRETCH
;
17155 #ifdef HAVE_WINDOW_SYSTEM
17156 else if (IMAGEP (prop
))
17158 it
->what
= IT_IMAGE
;
17159 it
->image_id
= lookup_image (it
->f
, prop
);
17160 it
->method
= GET_FROM_IMAGE
;
17162 #endif /* HAVE_WINDOW_SYSTEM */
17165 pop_it (it
); /* bogus display property, give up */
17172 /* Return the character-property PROP at the current position in IT. */
17175 get_it_property (struct it
*it
, Lisp_Object prop
)
17177 Lisp_Object position
;
17179 if (STRINGP (it
->object
))
17180 position
= make_number (IT_STRING_CHARPOS (*it
));
17181 else if (BUFFERP (it
->object
))
17182 position
= make_number (IT_CHARPOS (*it
));
17186 return Fget_char_property (position
, prop
, it
->object
);
17189 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17192 handle_line_prefix (struct it
*it
)
17194 Lisp_Object prefix
;
17195 if (it
->continuation_lines_width
> 0)
17197 prefix
= get_it_property (it
, Qwrap_prefix
);
17199 prefix
= Vwrap_prefix
;
17203 prefix
= get_it_property (it
, Qline_prefix
);
17205 prefix
= Vline_prefix
;
17207 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17209 /* If the prefix is wider than the window, and we try to wrap
17210 it, it would acquire its own wrap prefix, and so on till the
17211 iterator stack overflows. So, don't wrap the prefix. */
17212 it
->line_wrap
= TRUNCATE
;
17213 it
->avoid_cursor_p
= 1;
17219 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17220 only for R2L lines from display_line, when it decides that too many
17221 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17224 unproduce_glyphs (struct it
*it
, int n
)
17226 struct glyph
*glyph
, *end
;
17228 xassert (it
->glyph_row
);
17229 xassert (it
->glyph_row
->reversed_p
);
17230 xassert (it
->area
== TEXT_AREA
);
17231 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17233 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17234 n
= it
->glyph_row
->used
[TEXT_AREA
];
17235 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17236 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17237 for ( ; glyph
< end
; glyph
++)
17238 glyph
[-n
] = *glyph
;
17241 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17242 and ROW->maxpos. */
17244 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17245 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17246 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17248 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17249 lines' rows is implemented for bidi-reordered rows. */
17251 /* ROW->minpos is the value of min_pos, the minimal buffer position
17254 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17256 /* We didn't find _any_ valid buffer positions in any of the
17257 glyphs, so we must trust the iterator's computed positions. */
17258 row
->minpos
= row
->start
.pos
;
17261 max_pos
= CHARPOS (it
->current
.pos
);
17262 max_bpos
= BYTEPOS (it
->current
.pos
);
17265 /* Here are the various use-cases for ending the row, and the
17266 corresponding values for ROW->maxpos:
17268 Line ends in a newline from buffer eol_pos + 1
17269 Line is continued from buffer max_pos + 1
17270 Line is truncated on right it->current.pos
17271 Line ends in a newline from string max_pos
17272 Line is continued from string max_pos
17273 Line is continued from display vector max_pos
17274 Line is entirely from a string min_pos == max_pos
17275 Line is entirely from a display vector min_pos == max_pos
17276 Line that ends at ZV ZV
17278 If you discover other use-cases, please add them here as
17280 if (row
->ends_at_zv_p
)
17281 row
->maxpos
= it
->current
.pos
;
17282 else if (row
->used
[TEXT_AREA
])
17284 if (row
->ends_in_newline_from_string_p
)
17285 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17286 else if (CHARPOS (it
->eol_pos
) > 0)
17287 SET_TEXT_POS (row
->maxpos
,
17288 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17289 else if (row
->continued_p
)
17291 /* If max_pos is different from IT's current position, it
17292 means IT->method does not belong to the display element
17293 at max_pos. However, it also means that the display
17294 element at max_pos was displayed in its entirety on this
17295 line, which is equivalent to saying that the next line
17296 starts at the next buffer position. */
17297 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17298 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17301 INC_BOTH (max_pos
, max_bpos
);
17302 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17305 else if (row
->truncated_on_right_p
)
17306 /* display_line already called reseat_at_next_visible_line_start,
17307 which puts the iterator at the beginning of the next line, in
17308 the logical order. */
17309 row
->maxpos
= it
->current
.pos
;
17310 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17311 /* A line that is entirely from a string/image/stretch... */
17312 row
->maxpos
= row
->minpos
;
17317 row
->maxpos
= it
->current
.pos
;
17320 /* Construct the glyph row IT->glyph_row in the desired matrix of
17321 IT->w from text at the current position of IT. See dispextern.h
17322 for an overview of struct it. Value is non-zero if
17323 IT->glyph_row displays text, as opposed to a line displaying ZV
17327 display_line (struct it
*it
)
17329 struct glyph_row
*row
= it
->glyph_row
;
17330 Lisp_Object overlay_arrow_string
;
17332 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17333 int wrap_row_used
= -1;
17334 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17335 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17336 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17337 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17338 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17340 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17341 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17343 /* We always start displaying at hpos zero even if hscrolled. */
17344 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17346 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17347 >= it
->w
->desired_matrix
->nrows
)
17349 it
->w
->nrows_scale_factor
++;
17350 fonts_changed_p
= 1;
17354 /* Is IT->w showing the region? */
17355 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17357 /* Clear the result glyph row and enable it. */
17358 prepare_desired_row (row
);
17360 row
->y
= it
->current_y
;
17361 row
->start
= it
->start
;
17362 row
->continuation_lines_width
= it
->continuation_lines_width
;
17363 row
->displays_text_p
= 1;
17364 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17365 it
->starts_in_middle_of_char_p
= 0;
17367 /* Arrange the overlays nicely for our purposes. Usually, we call
17368 display_line on only one line at a time, in which case this
17369 can't really hurt too much, or we call it on lines which appear
17370 one after another in the buffer, in which case all calls to
17371 recenter_overlay_lists but the first will be pretty cheap. */
17372 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17374 /* Move over display elements that are not visible because we are
17375 hscrolled. This may stop at an x-position < IT->first_visible_x
17376 if the first glyph is partially visible or if we hit a line end. */
17377 if (it
->current_x
< it
->first_visible_x
)
17379 this_line_min_pos
= row
->start
.pos
;
17380 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17381 MOVE_TO_POS
| MOVE_TO_X
);
17382 /* Record the smallest positions seen while we moved over
17383 display elements that are not visible. This is needed by
17384 redisplay_internal for optimizing the case where the cursor
17385 stays inside the same line. The rest of this function only
17386 considers positions that are actually displayed, so
17387 RECORD_MAX_MIN_POS will not otherwise record positions that
17388 are hscrolled to the left of the left edge of the window. */
17389 min_pos
= CHARPOS (this_line_min_pos
);
17390 min_bpos
= BYTEPOS (this_line_min_pos
);
17394 /* We only do this when not calling `move_it_in_display_line_to'
17395 above, because move_it_in_display_line_to calls
17396 handle_line_prefix itself. */
17397 handle_line_prefix (it
);
17400 /* Get the initial row height. This is either the height of the
17401 text hscrolled, if there is any, or zero. */
17402 row
->ascent
= it
->max_ascent
;
17403 row
->height
= it
->max_ascent
+ it
->max_descent
;
17404 row
->phys_ascent
= it
->max_phys_ascent
;
17405 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17406 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17408 /* Utility macro to record max and min buffer positions seen until now. */
17409 #define RECORD_MAX_MIN_POS(IT) \
17412 if (IT_CHARPOS (*(IT)) < min_pos) \
17414 min_pos = IT_CHARPOS (*(IT)); \
17415 min_bpos = IT_BYTEPOS (*(IT)); \
17417 if (IT_CHARPOS (*(IT)) > max_pos) \
17419 max_pos = IT_CHARPOS (*(IT)); \
17420 max_bpos = IT_BYTEPOS (*(IT)); \
17425 /* Loop generating characters. The loop is left with IT on the next
17426 character to display. */
17429 int n_glyphs_before
, hpos_before
, x_before
;
17431 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17433 /* Retrieve the next thing to display. Value is zero if end of
17435 if (!get_next_display_element (it
))
17437 /* Maybe add a space at the end of this line that is used to
17438 display the cursor there under X. Set the charpos of the
17439 first glyph of blank lines not corresponding to any text
17441 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17442 row
->exact_window_width_line_p
= 1;
17443 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17444 || row
->used
[TEXT_AREA
] == 0)
17446 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17447 row
->displays_text_p
= 0;
17449 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17450 && (!MINI_WINDOW_P (it
->w
)
17451 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17452 row
->indicate_empty_line_p
= 1;
17455 it
->continuation_lines_width
= 0;
17456 row
->ends_at_zv_p
= 1;
17457 /* A row that displays right-to-left text must always have
17458 its last face extended all the way to the end of line,
17459 even if this row ends in ZV, because we still write to
17460 the screen left to right. */
17461 if (row
->reversed_p
)
17462 extend_face_to_end_of_line (it
);
17466 /* Now, get the metrics of what we want to display. This also
17467 generates glyphs in `row' (which is IT->glyph_row). */
17468 n_glyphs_before
= row
->used
[TEXT_AREA
];
17471 /* Remember the line height so far in case the next element doesn't
17472 fit on the line. */
17473 if (it
->line_wrap
!= TRUNCATE
)
17475 ascent
= it
->max_ascent
;
17476 descent
= it
->max_descent
;
17477 phys_ascent
= it
->max_phys_ascent
;
17478 phys_descent
= it
->max_phys_descent
;
17480 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17482 if (IT_DISPLAYING_WHITESPACE (it
))
17488 wrap_row_used
= row
->used
[TEXT_AREA
];
17489 wrap_row_ascent
= row
->ascent
;
17490 wrap_row_height
= row
->height
;
17491 wrap_row_phys_ascent
= row
->phys_ascent
;
17492 wrap_row_phys_height
= row
->phys_height
;
17493 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17494 wrap_row_min_pos
= min_pos
;
17495 wrap_row_min_bpos
= min_bpos
;
17496 wrap_row_max_pos
= max_pos
;
17497 wrap_row_max_bpos
= max_bpos
;
17503 PRODUCE_GLYPHS (it
);
17505 /* If this display element was in marginal areas, continue with
17507 if (it
->area
!= TEXT_AREA
)
17509 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17510 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17511 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17512 row
->phys_height
= max (row
->phys_height
,
17513 it
->max_phys_ascent
+ it
->max_phys_descent
);
17514 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17515 it
->max_extra_line_spacing
);
17516 set_iterator_to_next (it
, 1);
17520 /* Does the display element fit on the line? If we truncate
17521 lines, we should draw past the right edge of the window. If
17522 we don't truncate, we want to stop so that we can display the
17523 continuation glyph before the right margin. If lines are
17524 continued, there are two possible strategies for characters
17525 resulting in more than 1 glyph (e.g. tabs): Display as many
17526 glyphs as possible in this line and leave the rest for the
17527 continuation line, or display the whole element in the next
17528 line. Original redisplay did the former, so we do it also. */
17529 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17530 hpos_before
= it
->hpos
;
17533 if (/* Not a newline. */
17535 /* Glyphs produced fit entirely in the line. */
17536 && it
->current_x
< it
->last_visible_x
)
17538 it
->hpos
+= nglyphs
;
17539 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17540 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17541 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17542 row
->phys_height
= max (row
->phys_height
,
17543 it
->max_phys_ascent
+ it
->max_phys_descent
);
17544 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17545 it
->max_extra_line_spacing
);
17546 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17547 row
->x
= x
- it
->first_visible_x
;
17548 /* Record the maximum and minimum buffer positions seen so
17549 far in glyphs that will be displayed by this row. */
17551 RECORD_MAX_MIN_POS (it
);
17556 struct glyph
*glyph
;
17558 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17560 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17561 new_x
= x
+ glyph
->pixel_width
;
17563 if (/* Lines are continued. */
17564 it
->line_wrap
!= TRUNCATE
17565 && (/* Glyph doesn't fit on the line. */
17566 new_x
> it
->last_visible_x
17567 /* Or it fits exactly on a window system frame. */
17568 || (new_x
== it
->last_visible_x
17569 && FRAME_WINDOW_P (it
->f
))))
17571 /* End of a continued line. */
17574 || (new_x
== it
->last_visible_x
17575 && FRAME_WINDOW_P (it
->f
)))
17577 /* Current glyph is the only one on the line or
17578 fits exactly on the line. We must continue
17579 the line because we can't draw the cursor
17580 after the glyph. */
17581 row
->continued_p
= 1;
17582 it
->current_x
= new_x
;
17583 it
->continuation_lines_width
+= new_x
;
17585 /* Record the maximum and minimum buffer
17586 positions seen so far in glyphs that will be
17587 displayed by this row. */
17589 RECORD_MAX_MIN_POS (it
);
17590 if (i
== nglyphs
- 1)
17592 /* If line-wrap is on, check if a previous
17593 wrap point was found. */
17594 if (wrap_row_used
> 0
17595 /* Even if there is a previous wrap
17596 point, continue the line here as
17597 usual, if (i) the previous character
17598 was a space or tab AND (ii) the
17599 current character is not. */
17601 || IT_DISPLAYING_WHITESPACE (it
)))
17604 set_iterator_to_next (it
, 1);
17605 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17607 if (!get_next_display_element (it
))
17609 row
->exact_window_width_line_p
= 1;
17610 it
->continuation_lines_width
= 0;
17611 row
->continued_p
= 0;
17612 row
->ends_at_zv_p
= 1;
17614 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17616 row
->continued_p
= 0;
17617 row
->exact_window_width_line_p
= 1;
17622 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17623 && !FRAME_WINDOW_P (it
->f
))
17625 /* A padding glyph that doesn't fit on this line.
17626 This means the whole character doesn't fit
17628 if (row
->reversed_p
)
17629 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17630 - n_glyphs_before
);
17631 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17633 /* Fill the rest of the row with continuation
17634 glyphs like in 20.x. */
17635 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17636 < row
->glyphs
[1 + TEXT_AREA
])
17637 produce_special_glyphs (it
, IT_CONTINUATION
);
17639 row
->continued_p
= 1;
17640 it
->current_x
= x_before
;
17641 it
->continuation_lines_width
+= x_before
;
17643 /* Restore the height to what it was before the
17644 element not fitting on the line. */
17645 it
->max_ascent
= ascent
;
17646 it
->max_descent
= descent
;
17647 it
->max_phys_ascent
= phys_ascent
;
17648 it
->max_phys_descent
= phys_descent
;
17650 else if (wrap_row_used
> 0)
17653 if (row
->reversed_p
)
17654 unproduce_glyphs (it
,
17655 row
->used
[TEXT_AREA
] - wrap_row_used
);
17657 it
->continuation_lines_width
+= wrap_x
;
17658 row
->used
[TEXT_AREA
] = wrap_row_used
;
17659 row
->ascent
= wrap_row_ascent
;
17660 row
->height
= wrap_row_height
;
17661 row
->phys_ascent
= wrap_row_phys_ascent
;
17662 row
->phys_height
= wrap_row_phys_height
;
17663 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17664 min_pos
= wrap_row_min_pos
;
17665 min_bpos
= wrap_row_min_bpos
;
17666 max_pos
= wrap_row_max_pos
;
17667 max_bpos
= wrap_row_max_bpos
;
17668 row
->continued_p
= 1;
17669 row
->ends_at_zv_p
= 0;
17670 row
->exact_window_width_line_p
= 0;
17671 it
->continuation_lines_width
+= x
;
17673 /* Make sure that a non-default face is extended
17674 up to the right margin of the window. */
17675 extend_face_to_end_of_line (it
);
17677 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17679 /* A TAB that extends past the right edge of the
17680 window. This produces a single glyph on
17681 window system frames. We leave the glyph in
17682 this row and let it fill the row, but don't
17683 consume the TAB. */
17684 it
->continuation_lines_width
+= it
->last_visible_x
;
17685 row
->ends_in_middle_of_char_p
= 1;
17686 row
->continued_p
= 1;
17687 glyph
->pixel_width
= it
->last_visible_x
- x
;
17688 it
->starts_in_middle_of_char_p
= 1;
17692 /* Something other than a TAB that draws past
17693 the right edge of the window. Restore
17694 positions to values before the element. */
17695 if (row
->reversed_p
)
17696 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17697 - (n_glyphs_before
+ i
));
17698 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17700 /* Display continuation glyphs. */
17701 if (!FRAME_WINDOW_P (it
->f
))
17702 produce_special_glyphs (it
, IT_CONTINUATION
);
17703 row
->continued_p
= 1;
17705 it
->current_x
= x_before
;
17706 it
->continuation_lines_width
+= x
;
17707 extend_face_to_end_of_line (it
);
17709 if (nglyphs
> 1 && i
> 0)
17711 row
->ends_in_middle_of_char_p
= 1;
17712 it
->starts_in_middle_of_char_p
= 1;
17715 /* Restore the height to what it was before the
17716 element not fitting on the line. */
17717 it
->max_ascent
= ascent
;
17718 it
->max_descent
= descent
;
17719 it
->max_phys_ascent
= phys_ascent
;
17720 it
->max_phys_descent
= phys_descent
;
17725 else if (new_x
> it
->first_visible_x
)
17727 /* Increment number of glyphs actually displayed. */
17730 /* Record the maximum and minimum buffer positions
17731 seen so far in glyphs that will be displayed by
17734 RECORD_MAX_MIN_POS (it
);
17736 if (x
< it
->first_visible_x
)
17737 /* Glyph is partially visible, i.e. row starts at
17738 negative X position. */
17739 row
->x
= x
- it
->first_visible_x
;
17743 /* Glyph is completely off the left margin of the
17744 window. This should not happen because of the
17745 move_it_in_display_line at the start of this
17746 function, unless the text display area of the
17747 window is empty. */
17748 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17752 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17753 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17754 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17755 row
->phys_height
= max (row
->phys_height
,
17756 it
->max_phys_ascent
+ it
->max_phys_descent
);
17757 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17758 it
->max_extra_line_spacing
);
17760 /* End of this display line if row is continued. */
17761 if (row
->continued_p
|| row
->ends_at_zv_p
)
17766 /* Is this a line end? If yes, we're also done, after making
17767 sure that a non-default face is extended up to the right
17768 margin of the window. */
17769 if (ITERATOR_AT_END_OF_LINE_P (it
))
17771 int used_before
= row
->used
[TEXT_AREA
];
17773 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17775 /* Add a space at the end of the line that is used to
17776 display the cursor there. */
17777 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17778 append_space_for_newline (it
, 0);
17780 /* Extend the face to the end of the line. */
17781 extend_face_to_end_of_line (it
);
17783 /* Make sure we have the position. */
17784 if (used_before
== 0)
17785 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17787 /* Record the position of the newline, for use in
17789 it
->eol_pos
= it
->current
.pos
;
17791 /* Consume the line end. This skips over invisible lines. */
17792 set_iterator_to_next (it
, 1);
17793 it
->continuation_lines_width
= 0;
17797 /* Proceed with next display element. Note that this skips
17798 over lines invisible because of selective display. */
17799 set_iterator_to_next (it
, 1);
17801 /* If we truncate lines, we are done when the last displayed
17802 glyphs reach past the right margin of the window. */
17803 if (it
->line_wrap
== TRUNCATE
17804 && (FRAME_WINDOW_P (it
->f
)
17805 ? (it
->current_x
>= it
->last_visible_x
)
17806 : (it
->current_x
> it
->last_visible_x
)))
17808 /* Maybe add truncation glyphs. */
17809 if (!FRAME_WINDOW_P (it
->f
))
17813 if (!row
->reversed_p
)
17815 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17816 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17821 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17822 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17824 /* Remove any padding glyphs at the front of ROW, to
17825 make room for the truncation glyphs we will be
17826 adding below. The loop below always inserts at
17827 least one truncation glyph, so also remove the
17828 last glyph added to ROW. */
17829 unproduce_glyphs (it
, i
+ 1);
17830 /* Adjust i for the loop below. */
17831 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17834 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17836 row
->used
[TEXT_AREA
] = i
;
17837 produce_special_glyphs (it
, IT_TRUNCATION
);
17840 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17842 /* Don't truncate if we can overflow newline into fringe. */
17843 if (!get_next_display_element (it
))
17845 it
->continuation_lines_width
= 0;
17846 row
->ends_at_zv_p
= 1;
17847 row
->exact_window_width_line_p
= 1;
17850 if (ITERATOR_AT_END_OF_LINE_P (it
))
17852 row
->exact_window_width_line_p
= 1;
17853 goto at_end_of_line
;
17857 row
->truncated_on_right_p
= 1;
17858 it
->continuation_lines_width
= 0;
17859 reseat_at_next_visible_line_start (it
, 0);
17860 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17861 it
->hpos
= hpos_before
;
17862 it
->current_x
= x_before
;
17867 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17868 at the left window margin. */
17869 if (it
->first_visible_x
17870 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17872 if (!FRAME_WINDOW_P (it
->f
))
17873 insert_left_trunc_glyphs (it
);
17874 row
->truncated_on_left_p
= 1;
17877 /* Remember the position at which this line ends.
17879 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17880 cannot be before the call to find_row_edges below, since that is
17881 where these positions are determined. */
17882 row
->end
= it
->current
;
17885 row
->minpos
= row
->start
.pos
;
17886 row
->maxpos
= row
->end
.pos
;
17890 /* ROW->minpos and ROW->maxpos must be the smallest and
17891 `1 + the largest' buffer positions in ROW. But if ROW was
17892 bidi-reordered, these two positions can be anywhere in the
17893 row, so we must determine them now. */
17894 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17897 /* If the start of this line is the overlay arrow-position, then
17898 mark this glyph row as the one containing the overlay arrow.
17899 This is clearly a mess with variable size fonts. It would be
17900 better to let it be displayed like cursors under X. */
17901 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17902 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17903 !NILP (overlay_arrow_string
)))
17905 /* Overlay arrow in window redisplay is a fringe bitmap. */
17906 if (STRINGP (overlay_arrow_string
))
17908 struct glyph_row
*arrow_row
17909 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17910 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17911 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17912 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17913 struct glyph
*p2
, *end
;
17915 /* Copy the arrow glyphs. */
17916 while (glyph
< arrow_end
)
17919 /* Throw away padding glyphs. */
17921 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17922 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17928 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17933 xassert (INTEGERP (overlay_arrow_string
));
17934 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17936 overlay_arrow_seen
= 1;
17939 /* Compute pixel dimensions of this line. */
17940 compute_line_metrics (it
);
17942 /* Record whether this row ends inside an ellipsis. */
17943 row
->ends_in_ellipsis_p
17944 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17945 && it
->ellipsis_p
);
17947 /* Save fringe bitmaps in this row. */
17948 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17949 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17950 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17951 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17953 it
->left_user_fringe_bitmap
= 0;
17954 it
->left_user_fringe_face_id
= 0;
17955 it
->right_user_fringe_bitmap
= 0;
17956 it
->right_user_fringe_face_id
= 0;
17958 /* Maybe set the cursor. */
17959 cvpos
= it
->w
->cursor
.vpos
;
17961 /* In bidi-reordered rows, keep checking for proper cursor
17962 position even if one has been found already, because buffer
17963 positions in such rows change non-linearly with ROW->VPOS,
17964 when a line is continued. One exception: when we are at ZV,
17965 display cursor on the first suitable glyph row, since all
17966 the empty rows after that also have their position set to ZV. */
17967 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17968 lines' rows is implemented for bidi-reordered rows. */
17970 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17971 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17972 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17973 && cursor_row_p (row
))
17974 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17976 /* Highlight trailing whitespace. */
17977 if (!NILP (Vshow_trailing_whitespace
))
17978 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17980 /* Prepare for the next line. This line starts horizontally at (X
17981 HPOS) = (0 0). Vertical positions are incremented. As a
17982 convenience for the caller, IT->glyph_row is set to the next
17984 it
->current_x
= it
->hpos
= 0;
17985 it
->current_y
+= row
->height
;
17986 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17989 /* The next row should by default use the same value of the
17990 reversed_p flag as this one. set_iterator_to_next decides when
17991 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17992 the flag accordingly. */
17993 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17994 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17995 it
->start
= row
->end
;
17996 return row
->displays_text_p
;
17998 #undef RECORD_MAX_MIN_POS
18001 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18002 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18003 doc
: /* Return paragraph direction at point in BUFFER.
18004 Value is either `left-to-right' or `right-to-left'.
18005 If BUFFER is omitted or nil, it defaults to the current buffer.
18007 Paragraph direction determines how the text in the paragraph is displayed.
18008 In left-to-right paragraphs, text begins at the left margin of the window
18009 and the reading direction is generally left to right. In right-to-left
18010 paragraphs, text begins at the right margin and is read from right to left.
18012 See also `bidi-paragraph-direction'. */)
18013 (Lisp_Object buffer
)
18015 struct buffer
*buf
= current_buffer
;
18016 struct buffer
*old
= buf
;
18018 if (! NILP (buffer
))
18020 CHECK_BUFFER (buffer
);
18021 buf
= XBUFFER (buffer
);
18024 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18025 return Qleft_to_right
;
18026 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18027 return BVAR (buf
, bidi_paragraph_direction
);
18030 /* Determine the direction from buffer text. We could try to
18031 use current_matrix if it is up to date, but this seems fast
18032 enough as it is. */
18033 struct bidi_it itb
;
18034 EMACS_INT pos
= BUF_PT (buf
);
18035 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18038 set_buffer_temp (buf
);
18039 /* bidi_paragraph_init finds the base direction of the paragraph
18040 by searching forward from paragraph start. We need the base
18041 direction of the current or _previous_ paragraph, so we need
18042 to make sure we are within that paragraph. To that end, find
18043 the previous non-empty line. */
18044 if (pos
>= ZV
&& pos
> BEGV
)
18047 bytepos
= CHAR_TO_BYTE (pos
);
18049 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18050 || c
== ' ' || c
== '\t' || c
== '\f')
18052 if (bytepos
<= BEGV_BYTE
)
18057 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18060 itb
.bytepos
= bytepos
;
18062 itb
.separator_limit
= -1;
18063 itb
.paragraph_dir
= NEUTRAL_DIR
;
18065 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18066 set_buffer_temp (old
);
18067 switch (itb
.paragraph_dir
)
18070 return Qleft_to_right
;
18073 return Qright_to_left
;
18083 /***********************************************************************
18085 ***********************************************************************/
18087 /* Redisplay the menu bar in the frame for window W.
18089 The menu bar of X frames that don't have X toolkit support is
18090 displayed in a special window W->frame->menu_bar_window.
18092 The menu bar of terminal frames is treated specially as far as
18093 glyph matrices are concerned. Menu bar lines are not part of
18094 windows, so the update is done directly on the frame matrix rows
18095 for the menu bar. */
18098 display_menu_bar (struct window
*w
)
18100 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18105 /* Don't do all this for graphical frames. */
18107 if (FRAME_W32_P (f
))
18110 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18116 if (FRAME_NS_P (f
))
18118 #endif /* HAVE_NS */
18120 #ifdef USE_X_TOOLKIT
18121 xassert (!FRAME_WINDOW_P (f
));
18122 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18123 it
.first_visible_x
= 0;
18124 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18125 #else /* not USE_X_TOOLKIT */
18126 if (FRAME_WINDOW_P (f
))
18128 /* Menu bar lines are displayed in the desired matrix of the
18129 dummy window menu_bar_window. */
18130 struct window
*menu_w
;
18131 xassert (WINDOWP (f
->menu_bar_window
));
18132 menu_w
= XWINDOW (f
->menu_bar_window
);
18133 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18135 it
.first_visible_x
= 0;
18136 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18140 /* This is a TTY frame, i.e. character hpos/vpos are used as
18142 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18144 it
.first_visible_x
= 0;
18145 it
.last_visible_x
= FRAME_COLS (f
);
18147 #endif /* not USE_X_TOOLKIT */
18149 if (! mode_line_inverse_video
)
18150 /* Force the menu-bar to be displayed in the default face. */
18151 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18153 /* Clear all rows of the menu bar. */
18154 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18156 struct glyph_row
*row
= it
.glyph_row
+ i
;
18157 clear_glyph_row (row
);
18158 row
->enabled_p
= 1;
18159 row
->full_width_p
= 1;
18162 /* Display all items of the menu bar. */
18163 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18164 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18166 Lisp_Object string
;
18168 /* Stop at nil string. */
18169 string
= AREF (items
, i
+ 1);
18173 /* Remember where item was displayed. */
18174 ASET (items
, i
+ 3, make_number (it
.hpos
));
18176 /* Display the item, pad with one space. */
18177 if (it
.current_x
< it
.last_visible_x
)
18178 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18179 SCHARS (string
) + 1, 0, 0, -1);
18182 /* Fill out the line with spaces. */
18183 if (it
.current_x
< it
.last_visible_x
)
18184 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18186 /* Compute the total height of the lines. */
18187 compute_line_metrics (&it
);
18192 /***********************************************************************
18194 ***********************************************************************/
18196 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18197 FORCE is non-zero, redisplay mode lines unconditionally.
18198 Otherwise, redisplay only mode lines that are garbaged. Value is
18199 the number of windows whose mode lines were redisplayed. */
18202 redisplay_mode_lines (Lisp_Object window
, int force
)
18206 while (!NILP (window
))
18208 struct window
*w
= XWINDOW (window
);
18210 if (WINDOWP (w
->hchild
))
18211 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18212 else if (WINDOWP (w
->vchild
))
18213 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18215 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18216 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18218 struct text_pos lpoint
;
18219 struct buffer
*old
= current_buffer
;
18221 /* Set the window's buffer for the mode line display. */
18222 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18223 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18225 /* Point refers normally to the selected window. For any
18226 other window, set up appropriate value. */
18227 if (!EQ (window
, selected_window
))
18229 struct text_pos pt
;
18231 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18232 if (CHARPOS (pt
) < BEGV
)
18233 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18234 else if (CHARPOS (pt
) > (ZV
- 1))
18235 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18237 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18240 /* Display mode lines. */
18241 clear_glyph_matrix (w
->desired_matrix
);
18242 if (display_mode_lines (w
))
18245 w
->must_be_updated_p
= 1;
18248 /* Restore old settings. */
18249 set_buffer_internal_1 (old
);
18250 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18260 /* Display the mode and/or header line of window W. Value is the
18261 sum number of mode lines and header lines displayed. */
18264 display_mode_lines (struct window
*w
)
18266 Lisp_Object old_selected_window
, old_selected_frame
;
18269 old_selected_frame
= selected_frame
;
18270 selected_frame
= w
->frame
;
18271 old_selected_window
= selected_window
;
18272 XSETWINDOW (selected_window
, w
);
18274 /* These will be set while the mode line specs are processed. */
18275 line_number_displayed
= 0;
18276 w
->column_number_displayed
= Qnil
;
18278 if (WINDOW_WANTS_MODELINE_P (w
))
18280 struct window
*sel_w
= XWINDOW (old_selected_window
);
18282 /* Select mode line face based on the real selected window. */
18283 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18284 BVAR (current_buffer
, mode_line_format
));
18288 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18290 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18291 BVAR (current_buffer
, header_line_format
));
18295 selected_frame
= old_selected_frame
;
18296 selected_window
= old_selected_window
;
18301 /* Display mode or header line of window W. FACE_ID specifies which
18302 line to display; it is either MODE_LINE_FACE_ID or
18303 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18304 display. Value is the pixel height of the mode/header line
18308 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18312 int count
= SPECPDL_INDEX ();
18314 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18315 /* Don't extend on a previously drawn mode-line.
18316 This may happen if called from pos_visible_p. */
18317 it
.glyph_row
->enabled_p
= 0;
18318 prepare_desired_row (it
.glyph_row
);
18320 it
.glyph_row
->mode_line_p
= 1;
18322 if (! mode_line_inverse_video
)
18323 /* Force the mode-line to be displayed in the default face. */
18324 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18326 record_unwind_protect (unwind_format_mode_line
,
18327 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18329 mode_line_target
= MODE_LINE_DISPLAY
;
18331 /* Temporarily make frame's keyboard the current kboard so that
18332 kboard-local variables in the mode_line_format will get the right
18334 push_kboard (FRAME_KBOARD (it
.f
));
18335 record_unwind_save_match_data ();
18336 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18339 unbind_to (count
, Qnil
);
18341 /* Fill up with spaces. */
18342 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18344 compute_line_metrics (&it
);
18345 it
.glyph_row
->full_width_p
= 1;
18346 it
.glyph_row
->continued_p
= 0;
18347 it
.glyph_row
->truncated_on_left_p
= 0;
18348 it
.glyph_row
->truncated_on_right_p
= 0;
18350 /* Make a 3D mode-line have a shadow at its right end. */
18351 face
= FACE_FROM_ID (it
.f
, face_id
);
18352 extend_face_to_end_of_line (&it
);
18353 if (face
->box
!= FACE_NO_BOX
)
18355 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18356 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18357 last
->right_box_line_p
= 1;
18360 return it
.glyph_row
->height
;
18363 /* Move element ELT in LIST to the front of LIST.
18364 Return the updated list. */
18367 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18369 register Lisp_Object tail
, prev
;
18370 register Lisp_Object tem
;
18374 while (CONSP (tail
))
18380 /* Splice out the link TAIL. */
18382 list
= XCDR (tail
);
18384 Fsetcdr (prev
, XCDR (tail
));
18386 /* Now make it the first. */
18387 Fsetcdr (tail
, list
);
18392 tail
= XCDR (tail
);
18396 /* Not found--return unchanged LIST. */
18400 /* Contribute ELT to the mode line for window IT->w. How it
18401 translates into text depends on its data type.
18403 IT describes the display environment in which we display, as usual.
18405 DEPTH is the depth in recursion. It is used to prevent
18406 infinite recursion here.
18408 FIELD_WIDTH is the number of characters the display of ELT should
18409 occupy in the mode line, and PRECISION is the maximum number of
18410 characters to display from ELT's representation. See
18411 display_string for details.
18413 Returns the hpos of the end of the text generated by ELT.
18415 PROPS is a property list to add to any string we encounter.
18417 If RISKY is nonzero, remove (disregard) any properties in any string
18418 we encounter, and ignore :eval and :propertize.
18420 The global variable `mode_line_target' determines whether the
18421 output is passed to `store_mode_line_noprop',
18422 `store_mode_line_string', or `display_string'. */
18425 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18426 Lisp_Object elt
, Lisp_Object props
, int risky
)
18428 int n
= 0, field
, prec
;
18433 elt
= build_string ("*too-deep*");
18437 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18441 /* A string: output it and check for %-constructs within it. */
18443 EMACS_INT offset
= 0;
18445 if (SCHARS (elt
) > 0
18446 && (!NILP (props
) || risky
))
18448 Lisp_Object oprops
, aelt
;
18449 oprops
= Ftext_properties_at (make_number (0), elt
);
18451 /* If the starting string's properties are not what
18452 we want, translate the string. Also, if the string
18453 is risky, do that anyway. */
18455 if (NILP (Fequal (props
, oprops
)) || risky
)
18457 /* If the starting string has properties,
18458 merge the specified ones onto the existing ones. */
18459 if (! NILP (oprops
) && !risky
)
18463 oprops
= Fcopy_sequence (oprops
);
18465 while (CONSP (tem
))
18467 oprops
= Fplist_put (oprops
, XCAR (tem
),
18468 XCAR (XCDR (tem
)));
18469 tem
= XCDR (XCDR (tem
));
18474 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18475 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18477 /* AELT is what we want. Move it to the front
18478 without consing. */
18480 mode_line_proptrans_alist
18481 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18487 /* If AELT has the wrong props, it is useless.
18488 so get rid of it. */
18490 mode_line_proptrans_alist
18491 = Fdelq (aelt
, mode_line_proptrans_alist
);
18493 elt
= Fcopy_sequence (elt
);
18494 Fset_text_properties (make_number (0), Flength (elt
),
18496 /* Add this item to mode_line_proptrans_alist. */
18497 mode_line_proptrans_alist
18498 = Fcons (Fcons (elt
, props
),
18499 mode_line_proptrans_alist
);
18500 /* Truncate mode_line_proptrans_alist
18501 to at most 50 elements. */
18502 tem
= Fnthcdr (make_number (50),
18503 mode_line_proptrans_alist
);
18505 XSETCDR (tem
, Qnil
);
18514 prec
= precision
- n
;
18515 switch (mode_line_target
)
18517 case MODE_LINE_NOPROP
:
18518 case MODE_LINE_TITLE
:
18519 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18521 case MODE_LINE_STRING
:
18522 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18524 case MODE_LINE_DISPLAY
:
18525 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18526 0, prec
, 0, STRING_MULTIBYTE (elt
));
18533 /* Handle the non-literal case. */
18535 while ((precision
<= 0 || n
< precision
)
18536 && SREF (elt
, offset
) != 0
18537 && (mode_line_target
!= MODE_LINE_DISPLAY
18538 || it
->current_x
< it
->last_visible_x
))
18540 EMACS_INT last_offset
= offset
;
18542 /* Advance to end of string or next format specifier. */
18543 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18546 if (offset
- 1 != last_offset
)
18548 EMACS_INT nchars
, nbytes
;
18550 /* Output to end of string or up to '%'. Field width
18551 is length of string. Don't output more than
18552 PRECISION allows us. */
18555 prec
= c_string_width (SDATA (elt
) + last_offset
,
18556 offset
- last_offset
, precision
- n
,
18559 switch (mode_line_target
)
18561 case MODE_LINE_NOPROP
:
18562 case MODE_LINE_TITLE
:
18563 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18565 case MODE_LINE_STRING
:
18567 EMACS_INT bytepos
= last_offset
;
18568 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18569 EMACS_INT endpos
= (precision
<= 0
18570 ? string_byte_to_char (elt
, offset
)
18571 : charpos
+ nchars
);
18573 n
+= store_mode_line_string (NULL
,
18574 Fsubstring (elt
, make_number (charpos
),
18575 make_number (endpos
)),
18579 case MODE_LINE_DISPLAY
:
18581 EMACS_INT bytepos
= last_offset
;
18582 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18584 if (precision
<= 0)
18585 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18586 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18588 STRING_MULTIBYTE (elt
));
18593 else /* c == '%' */
18595 EMACS_INT percent_position
= offset
;
18597 /* Get the specified minimum width. Zero means
18600 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18601 field
= field
* 10 + c
- '0';
18603 /* Don't pad beyond the total padding allowed. */
18604 if (field_width
- n
> 0 && field
> field_width
- n
)
18605 field
= field_width
- n
;
18607 /* Note that either PRECISION <= 0 or N < PRECISION. */
18608 prec
= precision
- n
;
18611 n
+= display_mode_element (it
, depth
, field
, prec
,
18612 Vglobal_mode_string
, props
,
18617 EMACS_INT bytepos
, charpos
;
18619 Lisp_Object string
;
18621 bytepos
= percent_position
;
18622 charpos
= (STRING_MULTIBYTE (elt
)
18623 ? string_byte_to_char (elt
, bytepos
)
18625 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
18626 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18628 switch (mode_line_target
)
18630 case MODE_LINE_NOPROP
:
18631 case MODE_LINE_TITLE
:
18632 n
+= store_mode_line_noprop (spec
, field
, prec
);
18634 case MODE_LINE_STRING
:
18636 int len
= strlen (spec
);
18637 Lisp_Object tem
= make_string (spec
, len
);
18638 props
= Ftext_properties_at (make_number (charpos
), elt
);
18639 /* Should only keep face property in props */
18640 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18643 case MODE_LINE_DISPLAY
:
18645 int nglyphs_before
, nwritten
;
18647 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18648 nwritten
= display_string (spec
, string
, elt
,
18653 /* Assign to the glyphs written above the
18654 string where the `%x' came from, position
18658 struct glyph
*glyph
18659 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18663 for (i
= 0; i
< nwritten
; ++i
)
18665 glyph
[i
].object
= elt
;
18666 glyph
[i
].charpos
= charpos
;
18683 /* A symbol: process the value of the symbol recursively
18684 as if it appeared here directly. Avoid error if symbol void.
18685 Special case: if value of symbol is a string, output the string
18688 register Lisp_Object tem
;
18690 /* If the variable is not marked as risky to set
18691 then its contents are risky to use. */
18692 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18695 tem
= Fboundp (elt
);
18698 tem
= Fsymbol_value (elt
);
18699 /* If value is a string, output that string literally:
18700 don't check for % within it. */
18704 if (!EQ (tem
, elt
))
18706 /* Give up right away for nil or t. */
18716 register Lisp_Object car
, tem
;
18718 /* A cons cell: five distinct cases.
18719 If first element is :eval or :propertize, do something special.
18720 If first element is a string or a cons, process all the elements
18721 and effectively concatenate them.
18722 If first element is a negative number, truncate displaying cdr to
18723 at most that many characters. If positive, pad (with spaces)
18724 to at least that many characters.
18725 If first element is a symbol, process the cadr or caddr recursively
18726 according to whether the symbol's value is non-nil or nil. */
18728 if (EQ (car
, QCeval
))
18730 /* An element of the form (:eval FORM) means evaluate FORM
18731 and use the result as mode line elements. */
18736 if (CONSP (XCDR (elt
)))
18739 spec
= safe_eval (XCAR (XCDR (elt
)));
18740 n
+= display_mode_element (it
, depth
, field_width
- n
,
18741 precision
- n
, spec
, props
,
18745 else if (EQ (car
, QCpropertize
))
18747 /* An element of the form (:propertize ELT PROPS...)
18748 means display ELT but applying properties PROPS. */
18753 if (CONSP (XCDR (elt
)))
18754 n
+= display_mode_element (it
, depth
, field_width
- n
,
18755 precision
- n
, XCAR (XCDR (elt
)),
18756 XCDR (XCDR (elt
)), risky
);
18758 else if (SYMBOLP (car
))
18760 tem
= Fboundp (car
);
18764 /* elt is now the cdr, and we know it is a cons cell.
18765 Use its car if CAR has a non-nil value. */
18768 tem
= Fsymbol_value (car
);
18775 /* Symbol's value is nil (or symbol is unbound)
18776 Get the cddr of the original list
18777 and if possible find the caddr and use that. */
18781 else if (!CONSP (elt
))
18786 else if (INTEGERP (car
))
18788 register int lim
= XINT (car
);
18792 /* Negative int means reduce maximum width. */
18793 if (precision
<= 0)
18796 precision
= min (precision
, -lim
);
18800 /* Padding specified. Don't let it be more than
18801 current maximum. */
18803 lim
= min (precision
, lim
);
18805 /* If that's more padding than already wanted, queue it.
18806 But don't reduce padding already specified even if
18807 that is beyond the current truncation point. */
18808 field_width
= max (lim
, field_width
);
18812 else if (STRINGP (car
) || CONSP (car
))
18814 Lisp_Object halftail
= elt
;
18818 && (precision
<= 0 || n
< precision
))
18820 n
+= display_mode_element (it
, depth
,
18821 /* Do padding only after the last
18822 element in the list. */
18823 (! CONSP (XCDR (elt
))
18826 precision
- n
, XCAR (elt
),
18830 if ((len
& 1) == 0)
18831 halftail
= XCDR (halftail
);
18832 /* Check for cycle. */
18833 if (EQ (halftail
, elt
))
18842 elt
= build_string ("*invalid*");
18846 /* Pad to FIELD_WIDTH. */
18847 if (field_width
> 0 && n
< field_width
)
18849 switch (mode_line_target
)
18851 case MODE_LINE_NOPROP
:
18852 case MODE_LINE_TITLE
:
18853 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18855 case MODE_LINE_STRING
:
18856 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18858 case MODE_LINE_DISPLAY
:
18859 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18868 /* Store a mode-line string element in mode_line_string_list.
18870 If STRING is non-null, display that C string. Otherwise, the Lisp
18871 string LISP_STRING is displayed.
18873 FIELD_WIDTH is the minimum number of output glyphs to produce.
18874 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18875 with spaces. FIELD_WIDTH <= 0 means don't pad.
18877 PRECISION is the maximum number of characters to output from
18878 STRING. PRECISION <= 0 means don't truncate the string.
18880 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18881 properties to the string.
18883 PROPS are the properties to add to the string.
18884 The mode_line_string_face face property is always added to the string.
18888 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18889 int field_width
, int precision
, Lisp_Object props
)
18894 if (string
!= NULL
)
18896 len
= strlen (string
);
18897 if (precision
> 0 && len
> precision
)
18899 lisp_string
= make_string (string
, len
);
18901 props
= mode_line_string_face_prop
;
18902 else if (!NILP (mode_line_string_face
))
18904 Lisp_Object face
= Fplist_get (props
, Qface
);
18905 props
= Fcopy_sequence (props
);
18907 face
= mode_line_string_face
;
18909 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18910 props
= Fplist_put (props
, Qface
, face
);
18912 Fadd_text_properties (make_number (0), make_number (len
),
18913 props
, lisp_string
);
18917 len
= XFASTINT (Flength (lisp_string
));
18918 if (precision
> 0 && len
> precision
)
18921 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18924 if (!NILP (mode_line_string_face
))
18928 props
= Ftext_properties_at (make_number (0), lisp_string
);
18929 face
= Fplist_get (props
, Qface
);
18931 face
= mode_line_string_face
;
18933 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18934 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18936 lisp_string
= Fcopy_sequence (lisp_string
);
18939 Fadd_text_properties (make_number (0), make_number (len
),
18940 props
, lisp_string
);
18945 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18949 if (field_width
> len
)
18951 field_width
-= len
;
18952 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18954 Fadd_text_properties (make_number (0), make_number (field_width
),
18955 props
, lisp_string
);
18956 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18964 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18966 doc
: /* Format a string out of a mode line format specification.
18967 First arg FORMAT specifies the mode line format (see `mode-line-format'
18968 for details) to use.
18970 By default, the format is evaluated for the currently selected window.
18972 Optional second arg FACE specifies the face property to put on all
18973 characters for which no face is specified. The value nil means the
18974 default face. The value t means whatever face the window's mode line
18975 currently uses (either `mode-line' or `mode-line-inactive',
18976 depending on whether the window is the selected window or not).
18977 An integer value means the value string has no text
18980 Optional third and fourth args WINDOW and BUFFER specify the window
18981 and buffer to use as the context for the formatting (defaults
18982 are the selected window and the WINDOW's buffer). */)
18983 (Lisp_Object format
, Lisp_Object face
,
18984 Lisp_Object window
, Lisp_Object buffer
)
18989 struct buffer
*old_buffer
= NULL
;
18991 int no_props
= INTEGERP (face
);
18992 int count
= SPECPDL_INDEX ();
18994 int string_start
= 0;
18997 window
= selected_window
;
18998 CHECK_WINDOW (window
);
18999 w
= XWINDOW (window
);
19002 buffer
= w
->buffer
;
19003 CHECK_BUFFER (buffer
);
19005 /* Make formatting the modeline a non-op when noninteractive, otherwise
19006 there will be problems later caused by a partially initialized frame. */
19007 if (NILP (format
) || noninteractive
)
19008 return empty_unibyte_string
;
19013 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19014 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19015 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19016 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19017 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19018 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19019 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19022 if (XBUFFER (buffer
) != current_buffer
)
19023 old_buffer
= current_buffer
;
19025 /* Save things including mode_line_proptrans_alist,
19026 and set that to nil so that we don't alter the outer value. */
19027 record_unwind_protect (unwind_format_mode_line
,
19028 format_mode_line_unwind_data
19029 (old_buffer
, selected_window
, 1));
19030 mode_line_proptrans_alist
= Qnil
;
19032 Fselect_window (window
, Qt
);
19034 set_buffer_internal_1 (XBUFFER (buffer
));
19036 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19040 mode_line_target
= MODE_LINE_NOPROP
;
19041 mode_line_string_face_prop
= Qnil
;
19042 mode_line_string_list
= Qnil
;
19043 string_start
= MODE_LINE_NOPROP_LEN (0);
19047 mode_line_target
= MODE_LINE_STRING
;
19048 mode_line_string_list
= Qnil
;
19049 mode_line_string_face
= face
;
19050 mode_line_string_face_prop
19051 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19054 push_kboard (FRAME_KBOARD (it
.f
));
19055 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19060 len
= MODE_LINE_NOPROP_LEN (string_start
);
19061 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19065 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19066 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19067 empty_unibyte_string
);
19070 unbind_to (count
, Qnil
);
19074 /* Write a null-terminated, right justified decimal representation of
19075 the positive integer D to BUF using a minimal field width WIDTH. */
19078 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19080 register char *p
= buf
;
19088 *p
++ = d
% 10 + '0';
19093 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19104 /* Write a null-terminated, right justified decimal and "human
19105 readable" representation of the nonnegative integer D to BUF using
19106 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19108 static const char power_letter
[] =
19122 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19124 /* We aim to represent the nonnegative integer D as
19125 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19126 EMACS_INT quotient
= d
;
19128 /* -1 means: do not use TENTHS. */
19132 /* Length of QUOTIENT.TENTHS as a string. */
19138 if (1000 <= quotient
)
19140 /* Scale to the appropriate EXPONENT. */
19143 remainder
= quotient
% 1000;
19147 while (1000 <= quotient
);
19149 /* Round to nearest and decide whether to use TENTHS or not. */
19152 tenths
= remainder
/ 100;
19153 if (50 <= remainder
% 100)
19160 if (quotient
== 10)
19168 if (500 <= remainder
)
19170 if (quotient
< 999)
19181 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19182 if (tenths
== -1 && quotient
<= 99)
19189 p
= psuffix
= buf
+ max (width
, length
);
19191 /* Print EXPONENT. */
19192 *psuffix
++ = power_letter
[exponent
];
19195 /* Print TENTHS. */
19198 *--p
= '0' + tenths
;
19202 /* Print QUOTIENT. */
19205 int digit
= quotient
% 10;
19206 *--p
= '0' + digit
;
19208 while ((quotient
/= 10) != 0);
19210 /* Print leading spaces. */
19215 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19216 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19217 type of CODING_SYSTEM. Return updated pointer into BUF. */
19219 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19222 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19225 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19226 const unsigned char *eol_str
;
19228 /* The EOL conversion we are using. */
19229 Lisp_Object eoltype
;
19231 val
= CODING_SYSTEM_SPEC (coding_system
);
19234 if (!VECTORP (val
)) /* Not yet decided. */
19239 eoltype
= eol_mnemonic_undecided
;
19240 /* Don't mention EOL conversion if it isn't decided. */
19245 Lisp_Object eolvalue
;
19247 attrs
= AREF (val
, 0);
19248 eolvalue
= AREF (val
, 2);
19251 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19255 /* The EOL conversion that is normal on this system. */
19257 if (NILP (eolvalue
)) /* Not yet decided. */
19258 eoltype
= eol_mnemonic_undecided
;
19259 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19260 eoltype
= eol_mnemonic_undecided
;
19261 else /* eolvalue is Qunix, Qdos, or Qmac. */
19262 eoltype
= (EQ (eolvalue
, Qunix
)
19263 ? eol_mnemonic_unix
19264 : (EQ (eolvalue
, Qdos
) == 1
19265 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19271 /* Mention the EOL conversion if it is not the usual one. */
19272 if (STRINGP (eoltype
))
19274 eol_str
= SDATA (eoltype
);
19275 eol_str_len
= SBYTES (eoltype
);
19277 else if (CHARACTERP (eoltype
))
19279 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19280 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19285 eol_str
= invalid_eol_type
;
19286 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19288 memcpy (buf
, eol_str
, eol_str_len
);
19289 buf
+= eol_str_len
;
19295 /* Return a string for the output of a mode line %-spec for window W,
19296 generated by character C. FIELD_WIDTH > 0 means pad the string
19297 returned with spaces to that value. Return a Lisp string in
19298 *STRING if the resulting string is taken from that Lisp string.
19300 Note we operate on the current buffer for most purposes,
19301 the exception being w->base_line_pos. */
19303 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19305 static const char *
19306 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19307 Lisp_Object
*string
)
19310 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19311 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19312 struct buffer
*b
= current_buffer
;
19320 if (!NILP (BVAR (b
, read_only
)))
19322 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19327 /* This differs from %* only for a modified read-only buffer. */
19328 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19330 if (!NILP (BVAR (b
, read_only
)))
19335 /* This differs from %* in ignoring read-only-ness. */
19336 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19348 if (command_loop_level
> 5)
19350 p
= decode_mode_spec_buf
;
19351 for (i
= 0; i
< command_loop_level
; i
++)
19354 return decode_mode_spec_buf
;
19362 if (command_loop_level
> 5)
19364 p
= decode_mode_spec_buf
;
19365 for (i
= 0; i
< command_loop_level
; i
++)
19368 return decode_mode_spec_buf
;
19375 /* Let lots_of_dashes be a string of infinite length. */
19376 if (mode_line_target
== MODE_LINE_NOPROP
||
19377 mode_line_target
== MODE_LINE_STRING
)
19379 if (field_width
<= 0
19380 || field_width
> sizeof (lots_of_dashes
))
19382 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19383 decode_mode_spec_buf
[i
] = '-';
19384 decode_mode_spec_buf
[i
] = '\0';
19385 return decode_mode_spec_buf
;
19388 return lots_of_dashes
;
19392 obj
= BVAR (b
, name
);
19396 /* %c and %l are ignored in `frame-title-format'.
19397 (In redisplay_internal, the frame title is drawn _before_ the
19398 windows are updated, so the stuff which depends on actual
19399 window contents (such as %l) may fail to render properly, or
19400 even crash emacs.) */
19401 if (mode_line_target
== MODE_LINE_TITLE
)
19405 EMACS_INT col
= current_column ();
19406 w
->column_number_displayed
= make_number (col
);
19407 pint2str (decode_mode_spec_buf
, field_width
, col
);
19408 return decode_mode_spec_buf
;
19412 #ifndef SYSTEM_MALLOC
19414 if (NILP (Vmemory_full
))
19417 return "!MEM FULL! ";
19424 /* %F displays the frame name. */
19425 if (!NILP (f
->title
))
19426 return SSDATA (f
->title
);
19427 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19428 return SSDATA (f
->name
);
19432 obj
= BVAR (b
, filename
);
19437 EMACS_INT size
= ZV
- BEGV
;
19438 pint2str (decode_mode_spec_buf
, field_width
, size
);
19439 return decode_mode_spec_buf
;
19444 EMACS_INT size
= ZV
- BEGV
;
19445 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19446 return decode_mode_spec_buf
;
19451 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19452 EMACS_INT topline
, nlines
, height
;
19455 /* %c and %l are ignored in `frame-title-format'. */
19456 if (mode_line_target
== MODE_LINE_TITLE
)
19459 startpos
= XMARKER (w
->start
)->charpos
;
19460 startpos_byte
= marker_byte_position (w
->start
);
19461 height
= WINDOW_TOTAL_LINES (w
);
19463 /* If we decided that this buffer isn't suitable for line numbers,
19464 don't forget that too fast. */
19465 if (EQ (w
->base_line_pos
, w
->buffer
))
19467 /* But do forget it, if the window shows a different buffer now. */
19468 else if (BUFFERP (w
->base_line_pos
))
19469 w
->base_line_pos
= Qnil
;
19471 /* If the buffer is very big, don't waste time. */
19472 if (INTEGERP (Vline_number_display_limit
)
19473 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19475 w
->base_line_pos
= Qnil
;
19476 w
->base_line_number
= Qnil
;
19480 if (INTEGERP (w
->base_line_number
)
19481 && INTEGERP (w
->base_line_pos
)
19482 && XFASTINT (w
->base_line_pos
) <= startpos
)
19484 line
= XFASTINT (w
->base_line_number
);
19485 linepos
= XFASTINT (w
->base_line_pos
);
19486 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19491 linepos
= BUF_BEGV (b
);
19492 linepos_byte
= BUF_BEGV_BYTE (b
);
19495 /* Count lines from base line to window start position. */
19496 nlines
= display_count_lines (linepos_byte
,
19500 topline
= nlines
+ line
;
19502 /* Determine a new base line, if the old one is too close
19503 or too far away, or if we did not have one.
19504 "Too close" means it's plausible a scroll-down would
19505 go back past it. */
19506 if (startpos
== BUF_BEGV (b
))
19508 w
->base_line_number
= make_number (topline
);
19509 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19511 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19512 || linepos
== BUF_BEGV (b
))
19514 EMACS_INT limit
= BUF_BEGV (b
);
19515 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19516 EMACS_INT position
;
19517 EMACS_INT distance
=
19518 (height
* 2 + 30) * line_number_display_limit_width
;
19520 if (startpos
- distance
> limit
)
19522 limit
= startpos
- distance
;
19523 limit_byte
= CHAR_TO_BYTE (limit
);
19526 nlines
= display_count_lines (startpos_byte
,
19528 - (height
* 2 + 30),
19530 /* If we couldn't find the lines we wanted within
19531 line_number_display_limit_width chars per line,
19532 give up on line numbers for this window. */
19533 if (position
== limit_byte
&& limit
== startpos
- distance
)
19535 w
->base_line_pos
= w
->buffer
;
19536 w
->base_line_number
= Qnil
;
19540 w
->base_line_number
= make_number (topline
- nlines
);
19541 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19544 /* Now count lines from the start pos to point. */
19545 nlines
= display_count_lines (startpos_byte
,
19546 PT_BYTE
, PT
, &junk
);
19548 /* Record that we did display the line number. */
19549 line_number_displayed
= 1;
19551 /* Make the string to show. */
19552 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19553 return decode_mode_spec_buf
;
19556 char* p
= decode_mode_spec_buf
;
19557 int pad
= field_width
- 2;
19563 return decode_mode_spec_buf
;
19569 obj
= BVAR (b
, mode_name
);
19573 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19579 EMACS_INT pos
= marker_position (w
->start
);
19580 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19582 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19584 if (pos
<= BUF_BEGV (b
))
19589 else if (pos
<= BUF_BEGV (b
))
19593 if (total
> 1000000)
19594 /* Do it differently for a large value, to avoid overflow. */
19595 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19597 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19598 /* We can't normally display a 3-digit number,
19599 so get us a 2-digit number that is close. */
19602 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19603 return decode_mode_spec_buf
;
19607 /* Display percentage of size above the bottom of the screen. */
19610 EMACS_INT toppos
= marker_position (w
->start
);
19611 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19612 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19614 if (botpos
>= BUF_ZV (b
))
19616 if (toppos
<= BUF_BEGV (b
))
19623 if (total
> 1000000)
19624 /* Do it differently for a large value, to avoid overflow. */
19625 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19627 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19628 /* We can't normally display a 3-digit number,
19629 so get us a 2-digit number that is close. */
19632 if (toppos
<= BUF_BEGV (b
))
19633 sprintf (decode_mode_spec_buf
, "Top%2ld%%", (long)total
);
19635 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19636 return decode_mode_spec_buf
;
19641 /* status of process */
19642 obj
= Fget_buffer_process (Fcurrent_buffer ());
19644 return "no process";
19646 obj
= Fsymbol_name (Fprocess_status (obj
));
19652 int count
= inhibit_garbage_collection ();
19653 Lisp_Object val
= call1 (intern ("file-remote-p"),
19654 BVAR (current_buffer
, directory
));
19655 unbind_to (count
, Qnil
);
19663 case 't': /* indicate TEXT or BINARY */
19667 /* coding-system (not including end-of-line format) */
19669 /* coding-system (including end-of-line type) */
19671 int eol_flag
= (c
== 'Z');
19672 char *p
= decode_mode_spec_buf
;
19674 if (! FRAME_WINDOW_P (f
))
19676 /* No need to mention EOL here--the terminal never needs
19677 to do EOL conversion. */
19678 p
= decode_mode_spec_coding (CODING_ID_NAME
19679 (FRAME_KEYBOARD_CODING (f
)->id
),
19681 p
= decode_mode_spec_coding (CODING_ID_NAME
19682 (FRAME_TERMINAL_CODING (f
)->id
),
19685 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19688 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19689 #ifdef subprocesses
19690 obj
= Fget_buffer_process (Fcurrent_buffer ());
19691 if (PROCESSP (obj
))
19693 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19695 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19698 #endif /* subprocesses */
19701 return decode_mode_spec_buf
;
19708 return SSDATA (obj
);
19715 /* Count up to COUNT lines starting from START_BYTE.
19716 But don't go beyond LIMIT_BYTE.
19717 Return the number of lines thus found (always nonnegative).
19719 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19722 display_count_lines (EMACS_INT start_byte
,
19723 EMACS_INT limit_byte
, EMACS_INT count
,
19724 EMACS_INT
*byte_pos_ptr
)
19726 register unsigned char *cursor
;
19727 unsigned char *base
;
19729 register EMACS_INT ceiling
;
19730 register unsigned char *ceiling_addr
;
19731 EMACS_INT orig_count
= count
;
19733 /* If we are not in selective display mode,
19734 check only for newlines. */
19735 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19736 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19740 while (start_byte
< limit_byte
)
19742 ceiling
= BUFFER_CEILING_OF (start_byte
);
19743 ceiling
= min (limit_byte
- 1, ceiling
);
19744 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19745 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19748 if (selective_display
)
19749 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19752 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19755 if (cursor
!= ceiling_addr
)
19759 start_byte
+= cursor
- base
+ 1;
19760 *byte_pos_ptr
= start_byte
;
19764 if (++cursor
== ceiling_addr
)
19770 start_byte
+= cursor
- base
;
19775 while (start_byte
> limit_byte
)
19777 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19778 ceiling
= max (limit_byte
, ceiling
);
19779 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19780 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19783 if (selective_display
)
19784 while (--cursor
!= ceiling_addr
19785 && *cursor
!= '\n' && *cursor
!= 015)
19788 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19791 if (cursor
!= ceiling_addr
)
19795 start_byte
+= cursor
- base
+ 1;
19796 *byte_pos_ptr
= start_byte
;
19797 /* When scanning backwards, we should
19798 not count the newline posterior to which we stop. */
19799 return - orig_count
- 1;
19805 /* Here we add 1 to compensate for the last decrement
19806 of CURSOR, which took it past the valid range. */
19807 start_byte
+= cursor
- base
+ 1;
19811 *byte_pos_ptr
= limit_byte
;
19814 return - orig_count
+ count
;
19815 return orig_count
- count
;
19821 /***********************************************************************
19823 ***********************************************************************/
19825 /* Display a NUL-terminated string, starting with index START.
19827 If STRING is non-null, display that C string. Otherwise, the Lisp
19828 string LISP_STRING is displayed. There's a case that STRING is
19829 non-null and LISP_STRING is not nil. It means STRING is a string
19830 data of LISP_STRING. In that case, we display LISP_STRING while
19831 ignoring its text properties.
19833 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19834 FACE_STRING. Display STRING or LISP_STRING with the face at
19835 FACE_STRING_POS in FACE_STRING:
19837 Display the string in the environment given by IT, but use the
19838 standard display table, temporarily.
19840 FIELD_WIDTH is the minimum number of output glyphs to produce.
19841 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19842 with spaces. If STRING has more characters, more than FIELD_WIDTH
19843 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19845 PRECISION is the maximum number of characters to output from
19846 STRING. PRECISION < 0 means don't truncate the string.
19848 This is roughly equivalent to printf format specifiers:
19850 FIELD_WIDTH PRECISION PRINTF
19851 ----------------------------------------
19857 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19858 display them, and < 0 means obey the current buffer's value of
19859 enable_multibyte_characters.
19861 Value is the number of columns displayed. */
19864 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19865 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19866 int field_width
, int precision
, int max_x
, int multibyte
)
19868 int hpos_at_start
= it
->hpos
;
19869 int saved_face_id
= it
->face_id
;
19870 struct glyph_row
*row
= it
->glyph_row
;
19872 /* Initialize the iterator IT for iteration over STRING beginning
19873 with index START. */
19874 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19875 precision
, field_width
, multibyte
);
19876 if (string
&& STRINGP (lisp_string
))
19877 /* LISP_STRING is the one returned by decode_mode_spec. We should
19878 ignore its text properties. */
19879 it
->stop_charpos
= -1;
19881 /* If displaying STRING, set up the face of the iterator
19882 from LISP_STRING, if that's given. */
19883 if (STRINGP (face_string
))
19889 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19890 0, it
->region_beg_charpos
,
19891 it
->region_end_charpos
,
19892 &endptr
, it
->base_face_id
, 0);
19893 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19894 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19897 /* Set max_x to the maximum allowed X position. Don't let it go
19898 beyond the right edge of the window. */
19900 max_x
= it
->last_visible_x
;
19902 max_x
= min (max_x
, it
->last_visible_x
);
19904 /* Skip over display elements that are not visible. because IT->w is
19906 if (it
->current_x
< it
->first_visible_x
)
19907 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19908 MOVE_TO_POS
| MOVE_TO_X
);
19910 row
->ascent
= it
->max_ascent
;
19911 row
->height
= it
->max_ascent
+ it
->max_descent
;
19912 row
->phys_ascent
= it
->max_phys_ascent
;
19913 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19914 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19916 /* This condition is for the case that we are called with current_x
19917 past last_visible_x. */
19918 while (it
->current_x
< max_x
)
19920 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19922 /* Get the next display element. */
19923 if (!get_next_display_element (it
))
19926 /* Produce glyphs. */
19927 x_before
= it
->current_x
;
19928 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19929 PRODUCE_GLYPHS (it
);
19931 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19934 while (i
< nglyphs
)
19936 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19938 if (it
->line_wrap
!= TRUNCATE
19939 && x
+ glyph
->pixel_width
> max_x
)
19941 /* End of continued line or max_x reached. */
19942 if (CHAR_GLYPH_PADDING_P (*glyph
))
19944 /* A wide character is unbreakable. */
19945 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19946 it
->current_x
= x_before
;
19950 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19955 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19957 /* Glyph is at least partially visible. */
19959 if (x
< it
->first_visible_x
)
19960 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19964 /* Glyph is off the left margin of the display area.
19965 Should not happen. */
19969 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19970 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19971 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19972 row
->phys_height
= max (row
->phys_height
,
19973 it
->max_phys_ascent
+ it
->max_phys_descent
);
19974 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19975 it
->max_extra_line_spacing
);
19976 x
+= glyph
->pixel_width
;
19980 /* Stop if max_x reached. */
19984 /* Stop at line ends. */
19985 if (ITERATOR_AT_END_OF_LINE_P (it
))
19987 it
->continuation_lines_width
= 0;
19991 set_iterator_to_next (it
, 1);
19993 /* Stop if truncating at the right edge. */
19994 if (it
->line_wrap
== TRUNCATE
19995 && it
->current_x
>= it
->last_visible_x
)
19997 /* Add truncation mark, but don't do it if the line is
19998 truncated at a padding space. */
19999 if (IT_CHARPOS (*it
) < it
->string_nchars
)
20001 if (!FRAME_WINDOW_P (it
->f
))
20005 if (it
->current_x
> it
->last_visible_x
)
20007 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20008 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20010 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20012 row
->used
[TEXT_AREA
] = ii
;
20013 produce_special_glyphs (it
, IT_TRUNCATION
);
20016 produce_special_glyphs (it
, IT_TRUNCATION
);
20018 it
->glyph_row
->truncated_on_right_p
= 1;
20024 /* Maybe insert a truncation at the left. */
20025 if (it
->first_visible_x
20026 && IT_CHARPOS (*it
) > 0)
20028 if (!FRAME_WINDOW_P (it
->f
))
20029 insert_left_trunc_glyphs (it
);
20030 it
->glyph_row
->truncated_on_left_p
= 1;
20033 it
->face_id
= saved_face_id
;
20035 /* Value is number of columns displayed. */
20036 return it
->hpos
- hpos_at_start
;
20041 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20042 appears as an element of LIST or as the car of an element of LIST.
20043 If PROPVAL is a list, compare each element against LIST in that
20044 way, and return 1/2 if any element of PROPVAL is found in LIST.
20045 Otherwise return 0. This function cannot quit.
20046 The return value is 2 if the text is invisible but with an ellipsis
20047 and 1 if it's invisible and without an ellipsis. */
20050 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20052 register Lisp_Object tail
, proptail
;
20054 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20056 register Lisp_Object tem
;
20058 if (EQ (propval
, tem
))
20060 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20061 return NILP (XCDR (tem
)) ? 1 : 2;
20064 if (CONSP (propval
))
20066 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20068 Lisp_Object propelt
;
20069 propelt
= XCAR (proptail
);
20070 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20072 register Lisp_Object tem
;
20074 if (EQ (propelt
, tem
))
20076 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20077 return NILP (XCDR (tem
)) ? 1 : 2;
20085 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20086 doc
: /* Non-nil if the property makes the text invisible.
20087 POS-OR-PROP can be a marker or number, in which case it is taken to be
20088 a position in the current buffer and the value of the `invisible' property
20089 is checked; or it can be some other value, which is then presumed to be the
20090 value of the `invisible' property of the text of interest.
20091 The non-nil value returned can be t for truly invisible text or something
20092 else if the text is replaced by an ellipsis. */)
20093 (Lisp_Object pos_or_prop
)
20096 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20097 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20099 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20100 return (invis
== 0 ? Qnil
20102 : make_number (invis
));
20105 /* Calculate a width or height in pixels from a specification using
20106 the following elements:
20109 NUM - a (fractional) multiple of the default font width/height
20110 (NUM) - specifies exactly NUM pixels
20111 UNIT - a fixed number of pixels, see below.
20112 ELEMENT - size of a display element in pixels, see below.
20113 (NUM . SPEC) - equals NUM * SPEC
20114 (+ SPEC SPEC ...) - add pixel values
20115 (- SPEC SPEC ...) - subtract pixel values
20116 (- SPEC) - negate pixel value
20119 INT or FLOAT - a number constant
20120 SYMBOL - use symbol's (buffer local) variable binding.
20123 in - pixels per inch *)
20124 mm - pixels per 1/1000 meter *)
20125 cm - pixels per 1/100 meter *)
20126 width - width of current font in pixels.
20127 height - height of current font in pixels.
20129 *) using the ratio(s) defined in display-pixels-per-inch.
20133 left-fringe - left fringe width in pixels
20134 right-fringe - right fringe width in pixels
20136 left-margin - left margin width in pixels
20137 right-margin - right margin width in pixels
20139 scroll-bar - scroll-bar area width in pixels
20143 Pixels corresponding to 5 inches:
20146 Total width of non-text areas on left side of window (if scroll-bar is on left):
20147 '(space :width (+ left-fringe left-margin scroll-bar))
20149 Align to first text column (in header line):
20150 '(space :align-to 0)
20152 Align to middle of text area minus half the width of variable `my-image'
20153 containing a loaded image:
20154 '(space :align-to (0.5 . (- text my-image)))
20156 Width of left margin minus width of 1 character in the default font:
20157 '(space :width (- left-margin 1))
20159 Width of left margin minus width of 2 characters in the current font:
20160 '(space :width (- left-margin (2 . width)))
20162 Center 1 character over left-margin (in header line):
20163 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20165 Different ways to express width of left fringe plus left margin minus one pixel:
20166 '(space :width (- (+ left-fringe left-margin) (1)))
20167 '(space :width (+ left-fringe left-margin (- (1))))
20168 '(space :width (+ left-fringe left-margin (-1)))
20172 #define NUMVAL(X) \
20173 ((INTEGERP (X) || FLOATP (X)) \
20178 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20179 struct font
*font
, int width_p
, int *align_to
)
20183 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20184 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20187 return OK_PIXELS (0);
20189 xassert (FRAME_LIVE_P (it
->f
));
20191 if (SYMBOLP (prop
))
20193 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20195 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20197 if (unit
[0] == 'i' && unit
[1] == 'n')
20199 else if (unit
[0] == 'm' && unit
[1] == 'm')
20201 else if (unit
[0] == 'c' && unit
[1] == 'm')
20208 #ifdef HAVE_WINDOW_SYSTEM
20209 if (FRAME_WINDOW_P (it
->f
)
20211 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20212 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20214 return OK_PIXELS (ppi
/ pixels
);
20217 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20218 || (CONSP (Vdisplay_pixels_per_inch
)
20220 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20221 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20223 return OK_PIXELS (ppi
/ pixels
);
20229 #ifdef HAVE_WINDOW_SYSTEM
20230 if (EQ (prop
, Qheight
))
20231 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20232 if (EQ (prop
, Qwidth
))
20233 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20235 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20236 return OK_PIXELS (1);
20239 if (EQ (prop
, Qtext
))
20240 return OK_PIXELS (width_p
20241 ? window_box_width (it
->w
, TEXT_AREA
)
20242 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20244 if (align_to
&& *align_to
< 0)
20247 if (EQ (prop
, Qleft
))
20248 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20249 if (EQ (prop
, Qright
))
20250 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20251 if (EQ (prop
, Qcenter
))
20252 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20253 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20254 if (EQ (prop
, Qleft_fringe
))
20255 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20256 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20257 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20258 if (EQ (prop
, Qright_fringe
))
20259 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20260 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20261 : window_box_right_offset (it
->w
, TEXT_AREA
));
20262 if (EQ (prop
, Qleft_margin
))
20263 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20264 if (EQ (prop
, Qright_margin
))
20265 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20266 if (EQ (prop
, Qscroll_bar
))
20267 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20269 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20270 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20271 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20276 if (EQ (prop
, Qleft_fringe
))
20277 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20278 if (EQ (prop
, Qright_fringe
))
20279 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20280 if (EQ (prop
, Qleft_margin
))
20281 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20282 if (EQ (prop
, Qright_margin
))
20283 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20284 if (EQ (prop
, Qscroll_bar
))
20285 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20288 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20291 if (INTEGERP (prop
) || FLOATP (prop
))
20293 int base_unit
= (width_p
20294 ? FRAME_COLUMN_WIDTH (it
->f
)
20295 : FRAME_LINE_HEIGHT (it
->f
));
20296 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20301 Lisp_Object car
= XCAR (prop
);
20302 Lisp_Object cdr
= XCDR (prop
);
20306 #ifdef HAVE_WINDOW_SYSTEM
20307 if (FRAME_WINDOW_P (it
->f
)
20308 && valid_image_p (prop
))
20310 int id
= lookup_image (it
->f
, prop
);
20311 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20313 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20316 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20322 while (CONSP (cdr
))
20324 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20325 font
, width_p
, align_to
))
20328 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20333 if (EQ (car
, Qminus
))
20335 return OK_PIXELS (pixels
);
20338 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20341 if (INTEGERP (car
) || FLOATP (car
))
20344 pixels
= XFLOATINT (car
);
20346 return OK_PIXELS (pixels
);
20347 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20348 font
, width_p
, align_to
))
20349 return OK_PIXELS (pixels
* fact
);
20360 /***********************************************************************
20362 ***********************************************************************/
20364 #ifdef HAVE_WINDOW_SYSTEM
20369 dump_glyph_string (s
)
20370 struct glyph_string
*s
;
20372 fprintf (stderr
, "glyph string\n");
20373 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20374 s
->x
, s
->y
, s
->width
, s
->height
);
20375 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20376 fprintf (stderr
, " hl = %d\n", s
->hl
);
20377 fprintf (stderr
, " left overhang = %d, right = %d\n",
20378 s
->left_overhang
, s
->right_overhang
);
20379 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20380 fprintf (stderr
, " extends to end of line = %d\n",
20381 s
->extends_to_end_of_line_p
);
20382 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20383 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20386 #endif /* GLYPH_DEBUG */
20388 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20389 of XChar2b structures for S; it can't be allocated in
20390 init_glyph_string because it must be allocated via `alloca'. W
20391 is the window on which S is drawn. ROW and AREA are the glyph row
20392 and area within the row from which S is constructed. START is the
20393 index of the first glyph structure covered by S. HL is a
20394 face-override for drawing S. */
20397 #define OPTIONAL_HDC(hdc) HDC hdc,
20398 #define DECLARE_HDC(hdc) HDC hdc;
20399 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20400 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20403 #ifndef OPTIONAL_HDC
20404 #define OPTIONAL_HDC(hdc)
20405 #define DECLARE_HDC(hdc)
20406 #define ALLOCATE_HDC(hdc, f)
20407 #define RELEASE_HDC(hdc, f)
20411 init_glyph_string (struct glyph_string
*s
,
20413 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20414 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20416 memset (s
, 0, sizeof *s
);
20418 s
->f
= XFRAME (w
->frame
);
20422 s
->display
= FRAME_X_DISPLAY (s
->f
);
20423 s
->window
= FRAME_X_WINDOW (s
->f
);
20424 s
->char2b
= char2b
;
20428 s
->first_glyph
= row
->glyphs
[area
] + start
;
20429 s
->height
= row
->height
;
20430 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20431 s
->ybase
= s
->y
+ row
->ascent
;
20435 /* Append the list of glyph strings with head H and tail T to the list
20436 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20439 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20440 struct glyph_string
*h
, struct glyph_string
*t
)
20454 /* Prepend the list of glyph strings with head H and tail T to the
20455 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20459 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20460 struct glyph_string
*h
, struct glyph_string
*t
)
20474 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20475 Set *HEAD and *TAIL to the resulting list. */
20478 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20479 struct glyph_string
*s
)
20481 s
->next
= s
->prev
= NULL
;
20482 append_glyph_string_lists (head
, tail
, s
, s
);
20486 /* Get face and two-byte form of character C in face FACE_ID on frame F.
20487 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
20488 make sure that X resources for the face returned are allocated.
20489 Value is a pointer to a realized face that is ready for display if
20490 DISPLAY_P is non-zero. */
20492 static INLINE
struct face
*
20493 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20494 XChar2b
*char2b
, int display_p
)
20496 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20500 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20502 if (code
!= FONT_INVALID_CODE
)
20503 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20505 STORE_XCHAR2B (char2b
, 0, 0);
20508 /* Make sure X resources of the face are allocated. */
20509 #ifdef HAVE_X_WINDOWS
20513 xassert (face
!= NULL
);
20514 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20521 /* Get face and two-byte form of character glyph GLYPH on frame F.
20522 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20523 a pointer to a realized face that is ready for display. */
20525 static INLINE
struct face
*
20526 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20527 XChar2b
*char2b
, int *two_byte_p
)
20531 xassert (glyph
->type
== CHAR_GLYPH
);
20532 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20541 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20542 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20544 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20546 if (code
!= FONT_INVALID_CODE
)
20547 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20549 STORE_XCHAR2B (char2b
, 0, 0);
20552 /* Make sure X resources of the face are allocated. */
20553 xassert (face
!= NULL
);
20554 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20559 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20560 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20563 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20567 if (CHAR_BYTE8_P (c
))
20568 code
= CHAR_TO_BYTE8 (c
);
20570 code
= font
->driver
->encode_char (font
, c
);
20572 if (code
== FONT_INVALID_CODE
)
20574 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20579 /* Fill glyph string S with composition components specified by S->cmp.
20581 BASE_FACE is the base face of the composition.
20582 S->cmp_from is the index of the first component for S.
20584 OVERLAPS non-zero means S should draw the foreground only, and use
20585 its physical height for clipping. See also draw_glyphs.
20587 Value is the index of a component not in S. */
20590 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20594 /* For all glyphs of this composition, starting at the offset
20595 S->cmp_from, until we reach the end of the definition or encounter a
20596 glyph that requires the different face, add it to S. */
20601 s
->for_overlaps
= overlaps
;
20604 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20606 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20610 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20613 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20620 s
->font
= s
->face
->font
;
20622 else if (s
->face
!= face
)
20630 /* All glyph strings for the same composition has the same width,
20631 i.e. the width set for the first component of the composition. */
20632 s
->width
= s
->first_glyph
->pixel_width
;
20634 /* If the specified font could not be loaded, use the frame's
20635 default font, but record the fact that we couldn't load it in
20636 the glyph string so that we can draw rectangles for the
20637 characters of the glyph string. */
20638 if (s
->font
== NULL
)
20640 s
->font_not_found_p
= 1;
20641 s
->font
= FRAME_FONT (s
->f
);
20644 /* Adjust base line for subscript/superscript text. */
20645 s
->ybase
+= s
->first_glyph
->voffset
;
20647 /* This glyph string must always be drawn with 16-bit functions. */
20654 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20655 int start
, int end
, int overlaps
)
20657 struct glyph
*glyph
, *last
;
20658 Lisp_Object lgstring
;
20661 s
->for_overlaps
= overlaps
;
20662 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20663 last
= s
->row
->glyphs
[s
->area
] + end
;
20664 s
->cmp_id
= glyph
->u
.cmp
.id
;
20665 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20666 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20667 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20668 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20669 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20671 while (glyph
< last
20672 && glyph
->u
.cmp
.automatic
20673 && glyph
->u
.cmp
.id
== s
->cmp_id
20674 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20675 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20677 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20679 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20680 unsigned code
= LGLYPH_CODE (lglyph
);
20682 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20684 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20685 return glyph
- s
->row
->glyphs
[s
->area
];
20689 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20690 See the comment of fill_glyph_string for arguments.
20691 Value is the index of the first glyph not in S. */
20695 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20696 int start
, int end
, int overlaps
)
20698 struct glyph
*glyph
, *last
;
20701 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20702 s
->for_overlaps
= overlaps
;
20703 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20704 last
= s
->row
->glyphs
[s
->area
] + end
;
20705 voffset
= glyph
->voffset
;
20706 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20707 s
->font
= s
->face
->font
;
20709 s
->width
= glyph
->pixel_width
;
20711 while (glyph
< last
20712 && glyph
->type
== GLYPHLESS_GLYPH
20713 && glyph
->voffset
== voffset
20714 && glyph
->face_id
== face_id
)
20717 s
->width
+= glyph
->pixel_width
;
20720 s
->ybase
+= voffset
;
20721 return glyph
- s
->row
->glyphs
[s
->area
];
20725 /* Fill glyph string S from a sequence of character glyphs.
20727 FACE_ID is the face id of the string. START is the index of the
20728 first glyph to consider, END is the index of the last + 1.
20729 OVERLAPS non-zero means S should draw the foreground only, and use
20730 its physical height for clipping. See also draw_glyphs.
20732 Value is the index of the first glyph not in S. */
20735 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20736 int start
, int end
, int overlaps
)
20738 struct glyph
*glyph
, *last
;
20740 int glyph_not_available_p
;
20742 xassert (s
->f
== XFRAME (s
->w
->frame
));
20743 xassert (s
->nchars
== 0);
20744 xassert (start
>= 0 && end
> start
);
20746 s
->for_overlaps
= overlaps
;
20747 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20748 last
= s
->row
->glyphs
[s
->area
] + end
;
20749 voffset
= glyph
->voffset
;
20750 s
->padding_p
= glyph
->padding_p
;
20751 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20753 while (glyph
< last
20754 && glyph
->type
== CHAR_GLYPH
20755 && glyph
->voffset
== voffset
20756 /* Same face id implies same font, nowadays. */
20757 && glyph
->face_id
== face_id
20758 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20762 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20763 s
->char2b
+ s
->nchars
,
20765 s
->two_byte_p
= two_byte_p
;
20767 xassert (s
->nchars
<= end
- start
);
20768 s
->width
+= glyph
->pixel_width
;
20769 if (glyph
++->padding_p
!= s
->padding_p
)
20773 s
->font
= s
->face
->font
;
20775 /* If the specified font could not be loaded, use the frame's font,
20776 but record the fact that we couldn't load it in
20777 S->font_not_found_p so that we can draw rectangles for the
20778 characters of the glyph string. */
20779 if (s
->font
== NULL
|| glyph_not_available_p
)
20781 s
->font_not_found_p
= 1;
20782 s
->font
= FRAME_FONT (s
->f
);
20785 /* Adjust base line for subscript/superscript text. */
20786 s
->ybase
+= voffset
;
20788 xassert (s
->face
&& s
->face
->gc
);
20789 return glyph
- s
->row
->glyphs
[s
->area
];
20793 /* Fill glyph string S from image glyph S->first_glyph. */
20796 fill_image_glyph_string (struct glyph_string
*s
)
20798 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20799 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20801 s
->slice
= s
->first_glyph
->slice
.img
;
20802 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20803 s
->font
= s
->face
->font
;
20804 s
->width
= s
->first_glyph
->pixel_width
;
20806 /* Adjust base line for subscript/superscript text. */
20807 s
->ybase
+= s
->first_glyph
->voffset
;
20811 /* Fill glyph string S from a sequence of stretch glyphs.
20813 START is the index of the first glyph to consider,
20814 END is the index of the last + 1.
20816 Value is the index of the first glyph not in S. */
20819 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
20821 struct glyph
*glyph
, *last
;
20822 int voffset
, face_id
;
20824 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20826 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20827 last
= s
->row
->glyphs
[s
->area
] + end
;
20828 face_id
= glyph
->face_id
;
20829 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20830 s
->font
= s
->face
->font
;
20831 s
->width
= glyph
->pixel_width
;
20833 voffset
= glyph
->voffset
;
20837 && glyph
->type
== STRETCH_GLYPH
20838 && glyph
->voffset
== voffset
20839 && glyph
->face_id
== face_id
);
20841 s
->width
+= glyph
->pixel_width
;
20843 /* Adjust base line for subscript/superscript text. */
20844 s
->ybase
+= voffset
;
20846 /* The case that face->gc == 0 is handled when drawing the glyph
20847 string by calling PREPARE_FACE_FOR_DISPLAY. */
20849 return glyph
- s
->row
->glyphs
[s
->area
];
20852 static struct font_metrics
*
20853 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
20855 static struct font_metrics metrics
;
20856 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20858 if (! font
|| code
== FONT_INVALID_CODE
)
20860 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20865 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20866 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20867 assumed to be zero. */
20870 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20872 *left
= *right
= 0;
20874 if (glyph
->type
== CHAR_GLYPH
)
20878 struct font_metrics
*pcm
;
20880 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20881 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
20883 if (pcm
->rbearing
> pcm
->width
)
20884 *right
= pcm
->rbearing
- pcm
->width
;
20885 if (pcm
->lbearing
< 0)
20886 *left
= -pcm
->lbearing
;
20889 else if (glyph
->type
== COMPOSITE_GLYPH
)
20891 if (! glyph
->u
.cmp
.automatic
)
20893 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20895 if (cmp
->rbearing
> cmp
->pixel_width
)
20896 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20897 if (cmp
->lbearing
< 0)
20898 *left
= - cmp
->lbearing
;
20902 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20903 struct font_metrics metrics
;
20905 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20906 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20907 if (metrics
.rbearing
> metrics
.width
)
20908 *right
= metrics
.rbearing
- metrics
.width
;
20909 if (metrics
.lbearing
< 0)
20910 *left
= - metrics
.lbearing
;
20916 /* Return the index of the first glyph preceding glyph string S that
20917 is overwritten by S because of S's left overhang. Value is -1
20918 if no glyphs are overwritten. */
20921 left_overwritten (struct glyph_string
*s
)
20925 if (s
->left_overhang
)
20928 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20929 int first
= s
->first_glyph
- glyphs
;
20931 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20932 x
-= glyphs
[i
].pixel_width
;
20943 /* Return the index of the first glyph preceding glyph string S that
20944 is overwriting S because of its right overhang. Value is -1 if no
20945 glyph in front of S overwrites S. */
20948 left_overwriting (struct glyph_string
*s
)
20951 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20952 int first
= s
->first_glyph
- glyphs
;
20956 for (i
= first
- 1; i
>= 0; --i
)
20959 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20962 x
-= glyphs
[i
].pixel_width
;
20969 /* Return the index of the last glyph following glyph string S that is
20970 overwritten by S because of S's right overhang. Value is -1 if
20971 no such glyph is found. */
20974 right_overwritten (struct glyph_string
*s
)
20978 if (s
->right_overhang
)
20981 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20982 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20983 int end
= s
->row
->used
[s
->area
];
20985 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20986 x
+= glyphs
[i
].pixel_width
;
20995 /* Return the index of the last glyph following glyph string S that
20996 overwrites S because of its left overhang. Value is negative
20997 if no such glyph is found. */
21000 right_overwriting (struct glyph_string
*s
)
21003 int end
= s
->row
->used
[s
->area
];
21004 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21005 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21009 for (i
= first
; i
< end
; ++i
)
21012 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21015 x
+= glyphs
[i
].pixel_width
;
21022 /* Set background width of glyph string S. START is the index of the
21023 first glyph following S. LAST_X is the right-most x-position + 1
21024 in the drawing area. */
21027 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21029 /* If the face of this glyph string has to be drawn to the end of
21030 the drawing area, set S->extends_to_end_of_line_p. */
21032 if (start
== s
->row
->used
[s
->area
]
21033 && s
->area
== TEXT_AREA
21034 && ((s
->row
->fill_line_p
21035 && (s
->hl
== DRAW_NORMAL_TEXT
21036 || s
->hl
== DRAW_IMAGE_RAISED
21037 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21038 || s
->hl
== DRAW_MOUSE_FACE
))
21039 s
->extends_to_end_of_line_p
= 1;
21041 /* If S extends its face to the end of the line, set its
21042 background_width to the distance to the right edge of the drawing
21044 if (s
->extends_to_end_of_line_p
)
21045 s
->background_width
= last_x
- s
->x
+ 1;
21047 s
->background_width
= s
->width
;
21051 /* Compute overhangs and x-positions for glyph string S and its
21052 predecessors, or successors. X is the starting x-position for S.
21053 BACKWARD_P non-zero means process predecessors. */
21056 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21062 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21063 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21073 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21074 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21084 /* The following macros are only called from draw_glyphs below.
21085 They reference the following parameters of that function directly:
21086 `w', `row', `area', and `overlap_p'
21087 as well as the following local variables:
21088 `s', `f', and `hdc' (in W32) */
21091 /* On W32, silently add local `hdc' variable to argument list of
21092 init_glyph_string. */
21093 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21094 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21096 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21097 init_glyph_string (s, char2b, w, row, area, start, hl)
21100 /* Add a glyph string for a stretch glyph to the list of strings
21101 between HEAD and TAIL. START is the index of the stretch glyph in
21102 row area AREA of glyph row ROW. END is the index of the last glyph
21103 in that glyph row area. X is the current output position assigned
21104 to the new glyph string constructed. HL overrides that face of the
21105 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21106 is the right-most x-position of the drawing area. */
21108 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21109 and below -- keep them on one line. */
21110 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21113 s = (struct glyph_string *) alloca (sizeof *s); \
21114 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21115 START = fill_stretch_glyph_string (s, START, END); \
21116 append_glyph_string (&HEAD, &TAIL, s); \
21122 /* Add a glyph string for an image glyph to the list of strings
21123 between HEAD and TAIL. START is the index of the image glyph in
21124 row area AREA of glyph row ROW. END is the index of the last glyph
21125 in that glyph row area. X is the current output position assigned
21126 to the new glyph string constructed. HL overrides that face of the
21127 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21128 is the right-most x-position of the drawing area. */
21130 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21133 s = (struct glyph_string *) alloca (sizeof *s); \
21134 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21135 fill_image_glyph_string (s); \
21136 append_glyph_string (&HEAD, &TAIL, s); \
21143 /* Add a glyph string for a sequence of character glyphs to the list
21144 of strings between HEAD and TAIL. START is the index of the first
21145 glyph in row area AREA of glyph row ROW that is part of the new
21146 glyph string. END is the index of the last glyph in that glyph row
21147 area. X is the current output position assigned to the new glyph
21148 string constructed. HL overrides that face of the glyph; e.g. it
21149 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21150 right-most x-position of the drawing area. */
21152 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21158 face_id = (row)->glyphs[area][START].face_id; \
21160 s = (struct glyph_string *) alloca (sizeof *s); \
21161 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21162 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21163 append_glyph_string (&HEAD, &TAIL, s); \
21165 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21170 /* Add a glyph string for a composite sequence to the list of strings
21171 between HEAD and TAIL. START is the index of the first glyph in
21172 row area AREA of glyph row ROW that is part of the new glyph
21173 string. END is the index of the last glyph in that glyph row area.
21174 X is the current output position assigned to the new glyph string
21175 constructed. HL overrides that face of the glyph; e.g. it is
21176 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21177 x-position of the drawing area. */
21179 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21181 int face_id = (row)->glyphs[area][START].face_id; \
21182 struct face *base_face = FACE_FROM_ID (f, face_id); \
21183 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21184 struct composition *cmp = composition_table[cmp_id]; \
21186 struct glyph_string *first_s IF_LINT (= NULL); \
21189 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21191 /* Make glyph_strings for each glyph sequence that is drawable by \
21192 the same face, and append them to HEAD/TAIL. */ \
21193 for (n = 0; n < cmp->glyph_len;) \
21195 s = (struct glyph_string *) alloca (sizeof *s); \
21196 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21197 append_glyph_string (&(HEAD), &(TAIL), s); \
21203 n = fill_composite_glyph_string (s, base_face, overlaps); \
21211 /* Add a glyph string for a glyph-string sequence to the list of strings
21212 between HEAD and TAIL. */
21214 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21218 Lisp_Object gstring; \
21220 face_id = (row)->glyphs[area][START].face_id; \
21221 gstring = (composition_gstring_from_id \
21222 ((row)->glyphs[area][START].u.cmp.id)); \
21223 s = (struct glyph_string *) alloca (sizeof *s); \
21224 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21225 * LGSTRING_GLYPH_LEN (gstring)); \
21226 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21227 append_glyph_string (&(HEAD), &(TAIL), s); \
21229 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21233 /* Add a glyph string for a sequence of glyphless character's glyphs
21234 to the list of strings between HEAD and TAIL. The meanings of
21235 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21237 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21242 face_id = (row)->glyphs[area][START].face_id; \
21244 s = (struct glyph_string *) alloca (sizeof *s); \
21245 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21246 append_glyph_string (&HEAD, &TAIL, s); \
21248 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21254 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21255 of AREA of glyph row ROW on window W between indices START and END.
21256 HL overrides the face for drawing glyph strings, e.g. it is
21257 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21258 x-positions of the drawing area.
21260 This is an ugly monster macro construct because we must use alloca
21261 to allocate glyph strings (because draw_glyphs can be called
21262 asynchronously). */
21264 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21267 HEAD = TAIL = NULL; \
21268 while (START < END) \
21270 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21271 switch (first_glyph->type) \
21274 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21278 case COMPOSITE_GLYPH: \
21279 if (first_glyph->u.cmp.automatic) \
21280 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21283 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21287 case STRETCH_GLYPH: \
21288 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21292 case IMAGE_GLYPH: \
21293 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21297 case GLYPHLESS_GLYPH: \
21298 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21308 set_glyph_string_background_width (s, START, LAST_X); \
21315 /* Draw glyphs between START and END in AREA of ROW on window W,
21316 starting at x-position X. X is relative to AREA in W. HL is a
21317 face-override with the following meaning:
21319 DRAW_NORMAL_TEXT draw normally
21320 DRAW_CURSOR draw in cursor face
21321 DRAW_MOUSE_FACE draw in mouse face.
21322 DRAW_INVERSE_VIDEO draw in mode line face
21323 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21324 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21326 If OVERLAPS is non-zero, draw only the foreground of characters and
21327 clip to the physical height of ROW. Non-zero value also defines
21328 the overlapping part to be drawn:
21330 OVERLAPS_PRED overlap with preceding rows
21331 OVERLAPS_SUCC overlap with succeeding rows
21332 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21333 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21335 Value is the x-position reached, relative to AREA of W. */
21338 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21339 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21340 enum draw_glyphs_face hl
, int overlaps
)
21342 struct glyph_string
*head
, *tail
;
21343 struct glyph_string
*s
;
21344 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21345 int i
, j
, x_reached
, last_x
, area_left
= 0;
21346 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21349 ALLOCATE_HDC (hdc
, f
);
21351 /* Let's rather be paranoid than getting a SEGV. */
21352 end
= min (end
, row
->used
[area
]);
21353 start
= max (0, start
);
21354 start
= min (end
, start
);
21356 /* Translate X to frame coordinates. Set last_x to the right
21357 end of the drawing area. */
21358 if (row
->full_width_p
)
21360 /* X is relative to the left edge of W, without scroll bars
21362 area_left
= WINDOW_LEFT_EDGE_X (w
);
21363 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21367 area_left
= window_box_left (w
, area
);
21368 last_x
= area_left
+ window_box_width (w
, area
);
21372 /* Build a doubly-linked list of glyph_string structures between
21373 head and tail from what we have to draw. Note that the macro
21374 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21375 the reason we use a separate variable `i'. */
21377 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21379 x_reached
= tail
->x
+ tail
->background_width
;
21383 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21384 the row, redraw some glyphs in front or following the glyph
21385 strings built above. */
21386 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21388 struct glyph_string
*h
, *t
;
21389 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21390 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21391 int check_mouse_face
= 0;
21394 /* If mouse highlighting is on, we may need to draw adjacent
21395 glyphs using mouse-face highlighting. */
21396 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21398 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21400 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21401 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21403 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21405 check_mouse_face
= 1;
21406 mouse_beg_col
= (row
== mouse_beg_row
)
21407 ? hlinfo
->mouse_face_beg_col
: 0;
21408 mouse_end_col
= (row
== mouse_end_row
)
21409 ? hlinfo
->mouse_face_end_col
21410 : row
->used
[TEXT_AREA
];
21414 /* Compute overhangs for all glyph strings. */
21415 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21416 for (s
= head
; s
; s
= s
->next
)
21417 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21419 /* Prepend glyph strings for glyphs in front of the first glyph
21420 string that are overwritten because of the first glyph
21421 string's left overhang. The background of all strings
21422 prepended must be drawn because the first glyph string
21424 i
= left_overwritten (head
);
21427 enum draw_glyphs_face overlap_hl
;
21429 /* If this row contains mouse highlighting, attempt to draw
21430 the overlapped glyphs with the correct highlight. This
21431 code fails if the overlap encompasses more than one glyph
21432 and mouse-highlight spans only some of these glyphs.
21433 However, making it work perfectly involves a lot more
21434 code, and I don't know if the pathological case occurs in
21435 practice, so we'll stick to this for now. --- cyd */
21436 if (check_mouse_face
21437 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21438 overlap_hl
= DRAW_MOUSE_FACE
;
21440 overlap_hl
= DRAW_NORMAL_TEXT
;
21443 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21444 overlap_hl
, dummy_x
, last_x
);
21446 compute_overhangs_and_x (t
, head
->x
, 1);
21447 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21451 /* Prepend glyph strings for glyphs in front of the first glyph
21452 string that overwrite that glyph string because of their
21453 right overhang. For these strings, only the foreground must
21454 be drawn, because it draws over the glyph string at `head'.
21455 The background must not be drawn because this would overwrite
21456 right overhangs of preceding glyphs for which no glyph
21458 i
= left_overwriting (head
);
21461 enum draw_glyphs_face overlap_hl
;
21463 if (check_mouse_face
21464 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21465 overlap_hl
= DRAW_MOUSE_FACE
;
21467 overlap_hl
= DRAW_NORMAL_TEXT
;
21470 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21471 overlap_hl
, dummy_x
, last_x
);
21472 for (s
= h
; s
; s
= s
->next
)
21473 s
->background_filled_p
= 1;
21474 compute_overhangs_and_x (t
, head
->x
, 1);
21475 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21478 /* Append glyphs strings for glyphs following the last glyph
21479 string tail that are overwritten by tail. The background of
21480 these strings has to be drawn because tail's foreground draws
21482 i
= right_overwritten (tail
);
21485 enum draw_glyphs_face overlap_hl
;
21487 if (check_mouse_face
21488 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21489 overlap_hl
= DRAW_MOUSE_FACE
;
21491 overlap_hl
= DRAW_NORMAL_TEXT
;
21493 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21494 overlap_hl
, x
, last_x
);
21495 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21496 we don't have `end = i;' here. */
21497 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21498 append_glyph_string_lists (&head
, &tail
, h
, t
);
21502 /* Append glyph strings for glyphs following the last glyph
21503 string tail that overwrite tail. The foreground of such
21504 glyphs has to be drawn because it writes into the background
21505 of tail. The background must not be drawn because it could
21506 paint over the foreground of following glyphs. */
21507 i
= right_overwriting (tail
);
21510 enum draw_glyphs_face overlap_hl
;
21511 if (check_mouse_face
21512 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21513 overlap_hl
= DRAW_MOUSE_FACE
;
21515 overlap_hl
= DRAW_NORMAL_TEXT
;
21518 i
++; /* We must include the Ith glyph. */
21519 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21520 overlap_hl
, x
, last_x
);
21521 for (s
= h
; s
; s
= s
->next
)
21522 s
->background_filled_p
= 1;
21523 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21524 append_glyph_string_lists (&head
, &tail
, h
, t
);
21526 if (clip_head
|| clip_tail
)
21527 for (s
= head
; s
; s
= s
->next
)
21529 s
->clip_head
= clip_head
;
21530 s
->clip_tail
= clip_tail
;
21534 /* Draw all strings. */
21535 for (s
= head
; s
; s
= s
->next
)
21536 FRAME_RIF (f
)->draw_glyph_string (s
);
21539 /* When focus a sole frame and move horizontally, this sets on_p to 0
21540 causing a failure to erase prev cursor position. */
21541 if (area
== TEXT_AREA
21542 && !row
->full_width_p
21543 /* When drawing overlapping rows, only the glyph strings'
21544 foreground is drawn, which doesn't erase a cursor
21548 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21549 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21550 : (tail
? tail
->x
+ tail
->background_width
: x
));
21554 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21555 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21559 /* Value is the x-position up to which drawn, relative to AREA of W.
21560 This doesn't include parts drawn because of overhangs. */
21561 if (row
->full_width_p
)
21562 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21564 x_reached
-= area_left
;
21566 RELEASE_HDC (hdc
, f
);
21571 /* Expand row matrix if too narrow. Don't expand if area
21574 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21576 if (!fonts_changed_p \
21577 && (it->glyph_row->glyphs[area] \
21578 < it->glyph_row->glyphs[area + 1])) \
21580 it->w->ncols_scale_factor++; \
21581 fonts_changed_p = 1; \
21585 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21586 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21589 append_glyph (struct it
*it
)
21591 struct glyph
*glyph
;
21592 enum glyph_row_area area
= it
->area
;
21594 xassert (it
->glyph_row
);
21595 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21597 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21598 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21600 /* If the glyph row is reversed, we need to prepend the glyph
21601 rather than append it. */
21602 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21606 /* Make room for the additional glyph. */
21607 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21609 glyph
= it
->glyph_row
->glyphs
[area
];
21611 glyph
->charpos
= CHARPOS (it
->position
);
21612 glyph
->object
= it
->object
;
21613 if (it
->pixel_width
> 0)
21615 glyph
->pixel_width
= it
->pixel_width
;
21616 glyph
->padding_p
= 0;
21620 /* Assure at least 1-pixel width. Otherwise, cursor can't
21621 be displayed correctly. */
21622 glyph
->pixel_width
= 1;
21623 glyph
->padding_p
= 1;
21625 glyph
->ascent
= it
->ascent
;
21626 glyph
->descent
= it
->descent
;
21627 glyph
->voffset
= it
->voffset
;
21628 glyph
->type
= CHAR_GLYPH
;
21629 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21630 glyph
->multibyte_p
= it
->multibyte_p
;
21631 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21632 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21633 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21634 || it
->phys_descent
> it
->descent
);
21635 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21636 glyph
->face_id
= it
->face_id
;
21637 glyph
->u
.ch
= it
->char_to_display
;
21638 glyph
->slice
.img
= null_glyph_slice
;
21639 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21642 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21643 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21645 glyph
->bidi_type
= it
->bidi_it
.type
;
21649 glyph
->resolved_level
= 0;
21650 glyph
->bidi_type
= UNKNOWN_BT
;
21652 ++it
->glyph_row
->used
[area
];
21655 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21658 /* Store one glyph for the composition IT->cmp_it.id in
21659 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21663 append_composite_glyph (struct it
*it
)
21665 struct glyph
*glyph
;
21666 enum glyph_row_area area
= it
->area
;
21668 xassert (it
->glyph_row
);
21670 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21671 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21673 /* If the glyph row is reversed, we need to prepend the glyph
21674 rather than append it. */
21675 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21679 /* Make room for the new glyph. */
21680 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21682 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21684 glyph
->charpos
= it
->cmp_it
.charpos
;
21685 glyph
->object
= it
->object
;
21686 glyph
->pixel_width
= it
->pixel_width
;
21687 glyph
->ascent
= it
->ascent
;
21688 glyph
->descent
= it
->descent
;
21689 glyph
->voffset
= it
->voffset
;
21690 glyph
->type
= COMPOSITE_GLYPH
;
21691 if (it
->cmp_it
.ch
< 0)
21693 glyph
->u
.cmp
.automatic
= 0;
21694 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21695 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21699 glyph
->u
.cmp
.automatic
= 1;
21700 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21701 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21702 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21704 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21705 glyph
->multibyte_p
= it
->multibyte_p
;
21706 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21707 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21708 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21709 || it
->phys_descent
> it
->descent
);
21710 glyph
->padding_p
= 0;
21711 glyph
->glyph_not_available_p
= 0;
21712 glyph
->face_id
= it
->face_id
;
21713 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21716 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21717 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21719 glyph
->bidi_type
= it
->bidi_it
.type
;
21721 ++it
->glyph_row
->used
[area
];
21724 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21728 /* Change IT->ascent and IT->height according to the setting of
21732 take_vertical_position_into_account (struct it
*it
)
21736 if (it
->voffset
< 0)
21737 /* Increase the ascent so that we can display the text higher
21739 it
->ascent
-= it
->voffset
;
21741 /* Increase the descent so that we can display the text lower
21743 it
->descent
+= it
->voffset
;
21748 /* Produce glyphs/get display metrics for the image IT is loaded with.
21749 See the description of struct display_iterator in dispextern.h for
21750 an overview of struct display_iterator. */
21753 produce_image_glyph (struct it
*it
)
21757 int glyph_ascent
, crop
;
21758 struct glyph_slice slice
;
21760 xassert (it
->what
== IT_IMAGE
);
21762 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21764 /* Make sure X resources of the face is loaded. */
21765 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21767 if (it
->image_id
< 0)
21769 /* Fringe bitmap. */
21770 it
->ascent
= it
->phys_ascent
= 0;
21771 it
->descent
= it
->phys_descent
= 0;
21772 it
->pixel_width
= 0;
21777 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21779 /* Make sure X resources of the image is loaded. */
21780 prepare_image_for_display (it
->f
, img
);
21782 slice
.x
= slice
.y
= 0;
21783 slice
.width
= img
->width
;
21784 slice
.height
= img
->height
;
21786 if (INTEGERP (it
->slice
.x
))
21787 slice
.x
= XINT (it
->slice
.x
);
21788 else if (FLOATP (it
->slice
.x
))
21789 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21791 if (INTEGERP (it
->slice
.y
))
21792 slice
.y
= XINT (it
->slice
.y
);
21793 else if (FLOATP (it
->slice
.y
))
21794 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21796 if (INTEGERP (it
->slice
.width
))
21797 slice
.width
= XINT (it
->slice
.width
);
21798 else if (FLOATP (it
->slice
.width
))
21799 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21801 if (INTEGERP (it
->slice
.height
))
21802 slice
.height
= XINT (it
->slice
.height
);
21803 else if (FLOATP (it
->slice
.height
))
21804 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21806 if (slice
.x
>= img
->width
)
21807 slice
.x
= img
->width
;
21808 if (slice
.y
>= img
->height
)
21809 slice
.y
= img
->height
;
21810 if (slice
.x
+ slice
.width
>= img
->width
)
21811 slice
.width
= img
->width
- slice
.x
;
21812 if (slice
.y
+ slice
.height
> img
->height
)
21813 slice
.height
= img
->height
- slice
.y
;
21815 if (slice
.width
== 0 || slice
.height
== 0)
21818 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21820 it
->descent
= slice
.height
- glyph_ascent
;
21822 it
->descent
+= img
->vmargin
;
21823 if (slice
.y
+ slice
.height
== img
->height
)
21824 it
->descent
+= img
->vmargin
;
21825 it
->phys_descent
= it
->descent
;
21827 it
->pixel_width
= slice
.width
;
21829 it
->pixel_width
+= img
->hmargin
;
21830 if (slice
.x
+ slice
.width
== img
->width
)
21831 it
->pixel_width
+= img
->hmargin
;
21833 /* It's quite possible for images to have an ascent greater than
21834 their height, so don't get confused in that case. */
21835 if (it
->descent
< 0)
21840 if (face
->box
!= FACE_NO_BOX
)
21842 if (face
->box_line_width
> 0)
21845 it
->ascent
+= face
->box_line_width
;
21846 if (slice
.y
+ slice
.height
== img
->height
)
21847 it
->descent
+= face
->box_line_width
;
21850 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21851 it
->pixel_width
+= eabs (face
->box_line_width
);
21852 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21853 it
->pixel_width
+= eabs (face
->box_line_width
);
21856 take_vertical_position_into_account (it
);
21858 /* Automatically crop wide image glyphs at right edge so we can
21859 draw the cursor on same display row. */
21860 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21861 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21863 it
->pixel_width
-= crop
;
21864 slice
.width
-= crop
;
21869 struct glyph
*glyph
;
21870 enum glyph_row_area area
= it
->area
;
21872 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21873 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21875 glyph
->charpos
= CHARPOS (it
->position
);
21876 glyph
->object
= it
->object
;
21877 glyph
->pixel_width
= it
->pixel_width
;
21878 glyph
->ascent
= glyph_ascent
;
21879 glyph
->descent
= it
->descent
;
21880 glyph
->voffset
= it
->voffset
;
21881 glyph
->type
= IMAGE_GLYPH
;
21882 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21883 glyph
->multibyte_p
= it
->multibyte_p
;
21884 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21885 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21886 glyph
->overlaps_vertically_p
= 0;
21887 glyph
->padding_p
= 0;
21888 glyph
->glyph_not_available_p
= 0;
21889 glyph
->face_id
= it
->face_id
;
21890 glyph
->u
.img_id
= img
->id
;
21891 glyph
->slice
.img
= slice
;
21892 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21895 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21896 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21898 glyph
->bidi_type
= it
->bidi_it
.type
;
21900 ++it
->glyph_row
->used
[area
];
21903 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21908 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21909 of the glyph, WIDTH and HEIGHT are the width and height of the
21910 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21913 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21914 int width
, int height
, int ascent
)
21916 struct glyph
*glyph
;
21917 enum glyph_row_area area
= it
->area
;
21919 xassert (ascent
>= 0 && ascent
<= height
);
21921 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21922 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21924 /* If the glyph row is reversed, we need to prepend the glyph
21925 rather than append it. */
21926 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21930 /* Make room for the additional glyph. */
21931 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21933 glyph
= it
->glyph_row
->glyphs
[area
];
21935 glyph
->charpos
= CHARPOS (it
->position
);
21936 glyph
->object
= object
;
21937 glyph
->pixel_width
= width
;
21938 glyph
->ascent
= ascent
;
21939 glyph
->descent
= height
- ascent
;
21940 glyph
->voffset
= it
->voffset
;
21941 glyph
->type
= STRETCH_GLYPH
;
21942 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21943 glyph
->multibyte_p
= it
->multibyte_p
;
21944 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21945 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21946 glyph
->overlaps_vertically_p
= 0;
21947 glyph
->padding_p
= 0;
21948 glyph
->glyph_not_available_p
= 0;
21949 glyph
->face_id
= it
->face_id
;
21950 glyph
->u
.stretch
.ascent
= ascent
;
21951 glyph
->u
.stretch
.height
= height
;
21952 glyph
->slice
.img
= null_glyph_slice
;
21953 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21956 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21957 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21959 glyph
->bidi_type
= it
->bidi_it
.type
;
21963 glyph
->resolved_level
= 0;
21964 glyph
->bidi_type
= UNKNOWN_BT
;
21966 ++it
->glyph_row
->used
[area
];
21969 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21973 /* Produce a stretch glyph for iterator IT. IT->object is the value
21974 of the glyph property displayed. The value must be a list
21975 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21978 1. `:width WIDTH' specifies that the space should be WIDTH *
21979 canonical char width wide. WIDTH may be an integer or floating
21982 2. `:relative-width FACTOR' specifies that the width of the stretch
21983 should be computed from the width of the first character having the
21984 `glyph' property, and should be FACTOR times that width.
21986 3. `:align-to HPOS' specifies that the space should be wide enough
21987 to reach HPOS, a value in canonical character units.
21989 Exactly one of the above pairs must be present.
21991 4. `:height HEIGHT' specifies that the height of the stretch produced
21992 should be HEIGHT, measured in canonical character units.
21994 5. `:relative-height FACTOR' specifies that the height of the
21995 stretch should be FACTOR times the height of the characters having
21996 the glyph property.
21998 Either none or exactly one of 4 or 5 must be present.
22000 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22001 of the stretch should be used for the ascent of the stretch.
22002 ASCENT must be in the range 0 <= ASCENT <= 100. */
22005 produce_stretch_glyph (struct it
*it
)
22007 /* (space :width WIDTH :height HEIGHT ...) */
22008 Lisp_Object prop
, plist
;
22009 int width
= 0, height
= 0, align_to
= -1;
22010 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22013 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22014 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22016 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22018 /* List should start with `space'. */
22019 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22020 plist
= XCDR (it
->object
);
22022 /* Compute the width of the stretch. */
22023 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22024 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22026 /* Absolute width `:width WIDTH' specified and valid. */
22027 zero_width_ok_p
= 1;
22030 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22033 /* Relative width `:relative-width FACTOR' specified and valid.
22034 Compute the width of the characters having the `glyph'
22037 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22040 if (it
->multibyte_p
)
22041 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22044 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22045 if (! ASCII_CHAR_P (it2
.c
))
22046 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22049 it2
.glyph_row
= NULL
;
22050 it2
.what
= IT_CHARACTER
;
22051 x_produce_glyphs (&it2
);
22052 width
= NUMVAL (prop
) * it2
.pixel_width
;
22054 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22055 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22057 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22058 align_to
= (align_to
< 0
22060 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22061 else if (align_to
< 0)
22062 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22063 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22064 zero_width_ok_p
= 1;
22067 /* Nothing specified -> width defaults to canonical char width. */
22068 width
= FRAME_COLUMN_WIDTH (it
->f
);
22070 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22073 /* Compute height. */
22074 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22075 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22078 zero_height_ok_p
= 1;
22080 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22082 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22084 height
= FONT_HEIGHT (font
);
22086 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22089 /* Compute percentage of height used for ascent. If
22090 `:ascent ASCENT' is present and valid, use that. Otherwise,
22091 derive the ascent from the font in use. */
22092 if (prop
= Fplist_get (plist
, QCascent
),
22093 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22094 ascent
= height
* NUMVAL (prop
) / 100.0;
22095 else if (!NILP (prop
)
22096 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22097 ascent
= min (max (0, (int)tem
), height
);
22099 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22101 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22102 && it
->current_x
+ width
> it
->last_visible_x
)
22103 width
= it
->last_visible_x
- it
->current_x
- 1;
22105 if (width
> 0 && height
> 0 && it
->glyph_row
)
22107 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22108 if (!STRINGP (object
))
22109 object
= it
->w
->buffer
;
22110 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22113 it
->pixel_width
= width
;
22114 it
->ascent
= it
->phys_ascent
= ascent
;
22115 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22116 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22118 take_vertical_position_into_account (it
);
22121 /* Calculate line-height and line-spacing properties.
22122 An integer value specifies explicit pixel value.
22123 A float value specifies relative value to current face height.
22124 A cons (float . face-name) specifies relative value to
22125 height of specified face font.
22127 Returns height in pixels, or nil. */
22131 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22132 int boff
, int override
)
22134 Lisp_Object face_name
= Qnil
;
22135 int ascent
, descent
, height
;
22137 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22142 face_name
= XCAR (val
);
22144 if (!NUMBERP (val
))
22145 val
= make_number (1);
22146 if (NILP (face_name
))
22148 height
= it
->ascent
+ it
->descent
;
22153 if (NILP (face_name
))
22155 font
= FRAME_FONT (it
->f
);
22156 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22158 else if (EQ (face_name
, Qt
))
22167 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22169 return make_number (-1);
22171 face
= FACE_FROM_ID (it
->f
, face_id
);
22174 return make_number (-1);
22175 boff
= font
->baseline_offset
;
22176 if (font
->vertical_centering
)
22177 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22180 ascent
= FONT_BASE (font
) + boff
;
22181 descent
= FONT_DESCENT (font
) - boff
;
22185 it
->override_ascent
= ascent
;
22186 it
->override_descent
= descent
;
22187 it
->override_boff
= boff
;
22190 height
= ascent
+ descent
;
22194 height
= (int)(XFLOAT_DATA (val
) * height
);
22195 else if (INTEGERP (val
))
22196 height
*= XINT (val
);
22198 return make_number (height
);
22202 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22203 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22204 and only if this is for a character for which no font was found.
22206 If the display method (it->glyphless_method) is
22207 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22208 length of the acronym or the hexadecimal string, UPPER_XOFF and
22209 UPPER_YOFF are pixel offsets for the upper part of the string,
22210 LOWER_XOFF and LOWER_YOFF are for the lower part.
22212 For the other display methods, LEN through LOWER_YOFF are zero. */
22215 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22216 short upper_xoff
, short upper_yoff
,
22217 short lower_xoff
, short lower_yoff
)
22219 struct glyph
*glyph
;
22220 enum glyph_row_area area
= it
->area
;
22222 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22223 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22225 /* If the glyph row is reversed, we need to prepend the glyph
22226 rather than append it. */
22227 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22231 /* Make room for the additional glyph. */
22232 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22234 glyph
= it
->glyph_row
->glyphs
[area
];
22236 glyph
->charpos
= CHARPOS (it
->position
);
22237 glyph
->object
= it
->object
;
22238 glyph
->pixel_width
= it
->pixel_width
;
22239 glyph
->ascent
= it
->ascent
;
22240 glyph
->descent
= it
->descent
;
22241 glyph
->voffset
= it
->voffset
;
22242 glyph
->type
= GLYPHLESS_GLYPH
;
22243 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22244 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22245 glyph
->u
.glyphless
.len
= len
;
22246 glyph
->u
.glyphless
.ch
= it
->c
;
22247 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22248 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22249 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22250 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22251 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22252 glyph
->multibyte_p
= it
->multibyte_p
;
22253 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22254 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22255 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22256 || it
->phys_descent
> it
->descent
);
22257 glyph
->padding_p
= 0;
22258 glyph
->glyph_not_available_p
= 0;
22259 glyph
->face_id
= face_id
;
22260 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22263 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22264 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22266 glyph
->bidi_type
= it
->bidi_it
.type
;
22268 ++it
->glyph_row
->used
[area
];
22271 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22275 /* Produce a glyph for a glyphless character for iterator IT.
22276 IT->glyphless_method specifies which method to use for displaying
22277 the character. See the description of enum
22278 glyphless_display_method in dispextern.h for the detail.
22280 FOR_NO_FONT is nonzero if and only if this is for a character for
22281 which no font was found. ACRONYM, if non-nil, is an acronym string
22282 for the character. */
22285 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22290 int base_width
, base_height
, width
, height
;
22291 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22294 /* Get the metrics of the base font. We always refer to the current
22296 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22297 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22298 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22299 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22300 base_height
= it
->ascent
+ it
->descent
;
22301 base_width
= font
->average_width
;
22303 /* Get a face ID for the glyph by utilizing a cache (the same way as
22304 doen for `escape-glyph' in get_next_display_element). */
22305 if (it
->f
== last_glyphless_glyph_frame
22306 && it
->face_id
== last_glyphless_glyph_face_id
)
22308 face_id
= last_glyphless_glyph_merged_face_id
;
22312 /* Merge the `glyphless-char' face into the current face. */
22313 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22314 last_glyphless_glyph_frame
= it
->f
;
22315 last_glyphless_glyph_face_id
= it
->face_id
;
22316 last_glyphless_glyph_merged_face_id
= face_id
;
22319 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22321 it
->pixel_width
= THIN_SPACE_WIDTH
;
22323 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22325 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22327 width
= CHAR_WIDTH (it
->c
);
22330 else if (width
> 4)
22332 it
->pixel_width
= base_width
* width
;
22334 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22340 unsigned int code
[6];
22342 int ascent
, descent
;
22343 struct font_metrics metrics_upper
, metrics_lower
;
22345 face
= FACE_FROM_ID (it
->f
, face_id
);
22346 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22347 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22349 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22351 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22352 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22353 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22357 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22358 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22361 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22362 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22363 upper_len
= (len
+ 1) / 2;
22364 font
->driver
->text_extents (font
, code
, upper_len
,
22366 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22371 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22372 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22373 upper_xoff
= upper_yoff
= 2; /* the typical case */
22374 if (base_width
>= width
)
22376 /* Align the upper to the left, the lower to the right. */
22377 it
->pixel_width
= base_width
;
22378 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22382 /* Center the shorter one. */
22383 it
->pixel_width
= width
;
22384 if (metrics_upper
.width
>= metrics_lower
.width
)
22385 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22388 /* FIXME: This code doesn't look right. It formerly was
22389 missing the "lower_xoff = 0;", which couldn't have
22390 been right since it left lower_xoff uninitialized. */
22392 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22396 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22397 top, bottom, and between upper and lower strings. */
22398 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22399 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22400 /* Center vertically.
22401 H:base_height, D:base_descent
22402 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22404 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22405 descent = D - H/2 + h/2;
22406 lower_yoff = descent - 2 - ld;
22407 upper_yoff = lower_yoff - la - 1 - ud; */
22408 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22409 descent
= it
->descent
- (base_height
- height
) / 2;
22410 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22411 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22412 - metrics_upper
.descent
);
22413 /* Don't make the height shorter than the base height. */
22414 if (height
> base_height
)
22416 it
->ascent
= ascent
;
22417 it
->descent
= descent
;
22421 it
->phys_ascent
= it
->ascent
;
22422 it
->phys_descent
= it
->descent
;
22424 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22425 upper_xoff
, upper_yoff
,
22426 lower_xoff
, lower_yoff
);
22428 take_vertical_position_into_account (it
);
22433 Produce glyphs/get display metrics for the display element IT is
22434 loaded with. See the description of struct it in dispextern.h
22435 for an overview of struct it. */
22438 x_produce_glyphs (struct it
*it
)
22440 int extra_line_spacing
= it
->extra_line_spacing
;
22442 it
->glyph_not_available_p
= 0;
22444 if (it
->what
== IT_CHARACTER
)
22447 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22448 struct font
*font
= face
->font
;
22449 struct font_metrics
*pcm
= NULL
;
22450 int boff
; /* baseline offset */
22454 /* When no suitable font is found, display this character by
22455 the method specified in the first extra slot of
22456 Vglyphless_char_display. */
22457 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22459 xassert (it
->what
== IT_GLYPHLESS
);
22460 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22464 boff
= font
->baseline_offset
;
22465 if (font
->vertical_centering
)
22466 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22468 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22474 if (it
->override_ascent
>= 0)
22476 it
->ascent
= it
->override_ascent
;
22477 it
->descent
= it
->override_descent
;
22478 boff
= it
->override_boff
;
22482 it
->ascent
= FONT_BASE (font
) + boff
;
22483 it
->descent
= FONT_DESCENT (font
) - boff
;
22486 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22488 pcm
= get_per_char_metric (font
, &char2b
);
22489 if (pcm
->width
== 0
22490 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22496 it
->phys_ascent
= pcm
->ascent
+ boff
;
22497 it
->phys_descent
= pcm
->descent
- boff
;
22498 it
->pixel_width
= pcm
->width
;
22502 it
->glyph_not_available_p
= 1;
22503 it
->phys_ascent
= it
->ascent
;
22504 it
->phys_descent
= it
->descent
;
22505 it
->pixel_width
= font
->space_width
;
22508 if (it
->constrain_row_ascent_descent_p
)
22510 if (it
->descent
> it
->max_descent
)
22512 it
->ascent
+= it
->descent
- it
->max_descent
;
22513 it
->descent
= it
->max_descent
;
22515 if (it
->ascent
> it
->max_ascent
)
22517 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22518 it
->ascent
= it
->max_ascent
;
22520 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22521 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22522 extra_line_spacing
= 0;
22525 /* If this is a space inside a region of text with
22526 `space-width' property, change its width. */
22527 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22529 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22531 /* If face has a box, add the box thickness to the character
22532 height. If character has a box line to the left and/or
22533 right, add the box line width to the character's width. */
22534 if (face
->box
!= FACE_NO_BOX
)
22536 int thick
= face
->box_line_width
;
22540 it
->ascent
+= thick
;
22541 it
->descent
+= thick
;
22546 if (it
->start_of_box_run_p
)
22547 it
->pixel_width
+= thick
;
22548 if (it
->end_of_box_run_p
)
22549 it
->pixel_width
+= thick
;
22552 /* If face has an overline, add the height of the overline
22553 (1 pixel) and a 1 pixel margin to the character height. */
22554 if (face
->overline_p
)
22555 it
->ascent
+= overline_margin
;
22557 if (it
->constrain_row_ascent_descent_p
)
22559 if (it
->ascent
> it
->max_ascent
)
22560 it
->ascent
= it
->max_ascent
;
22561 if (it
->descent
> it
->max_descent
)
22562 it
->descent
= it
->max_descent
;
22565 take_vertical_position_into_account (it
);
22567 /* If we have to actually produce glyphs, do it. */
22572 /* Translate a space with a `space-width' property
22573 into a stretch glyph. */
22574 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22575 / FONT_HEIGHT (font
));
22576 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22577 it
->ascent
+ it
->descent
, ascent
);
22582 /* If characters with lbearing or rbearing are displayed
22583 in this line, record that fact in a flag of the
22584 glyph row. This is used to optimize X output code. */
22585 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22586 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22588 if (! stretched_p
&& it
->pixel_width
== 0)
22589 /* We assure that all visible glyphs have at least 1-pixel
22591 it
->pixel_width
= 1;
22593 else if (it
->char_to_display
== '\n')
22595 /* A newline has no width, but we need the height of the
22596 line. But if previous part of the line sets a height,
22597 don't increase that height */
22599 Lisp_Object height
;
22600 Lisp_Object total_height
= Qnil
;
22602 it
->override_ascent
= -1;
22603 it
->pixel_width
= 0;
22606 height
= get_it_property (it
, Qline_height
);
22607 /* Split (line-height total-height) list */
22609 && CONSP (XCDR (height
))
22610 && NILP (XCDR (XCDR (height
))))
22612 total_height
= XCAR (XCDR (height
));
22613 height
= XCAR (height
);
22615 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22617 if (it
->override_ascent
>= 0)
22619 it
->ascent
= it
->override_ascent
;
22620 it
->descent
= it
->override_descent
;
22621 boff
= it
->override_boff
;
22625 it
->ascent
= FONT_BASE (font
) + boff
;
22626 it
->descent
= FONT_DESCENT (font
) - boff
;
22629 if (EQ (height
, Qt
))
22631 if (it
->descent
> it
->max_descent
)
22633 it
->ascent
+= it
->descent
- it
->max_descent
;
22634 it
->descent
= it
->max_descent
;
22636 if (it
->ascent
> it
->max_ascent
)
22638 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22639 it
->ascent
= it
->max_ascent
;
22641 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22642 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22643 it
->constrain_row_ascent_descent_p
= 1;
22644 extra_line_spacing
= 0;
22648 Lisp_Object spacing
;
22650 it
->phys_ascent
= it
->ascent
;
22651 it
->phys_descent
= it
->descent
;
22653 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22654 && face
->box
!= FACE_NO_BOX
22655 && face
->box_line_width
> 0)
22657 it
->ascent
+= face
->box_line_width
;
22658 it
->descent
+= face
->box_line_width
;
22661 && XINT (height
) > it
->ascent
+ it
->descent
)
22662 it
->ascent
= XINT (height
) - it
->descent
;
22664 if (!NILP (total_height
))
22665 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22668 spacing
= get_it_property (it
, Qline_spacing
);
22669 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22671 if (INTEGERP (spacing
))
22673 extra_line_spacing
= XINT (spacing
);
22674 if (!NILP (total_height
))
22675 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22679 else /* i.e. (it->char_to_display == '\t') */
22681 if (font
->space_width
> 0)
22683 int tab_width
= it
->tab_width
* font
->space_width
;
22684 int x
= it
->current_x
+ it
->continuation_lines_width
;
22685 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22687 /* If the distance from the current position to the next tab
22688 stop is less than a space character width, use the
22689 tab stop after that. */
22690 if (next_tab_x
- x
< font
->space_width
)
22691 next_tab_x
+= tab_width
;
22693 it
->pixel_width
= next_tab_x
- x
;
22695 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22696 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22700 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22701 it
->ascent
+ it
->descent
, it
->ascent
);
22706 it
->pixel_width
= 0;
22711 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22713 /* A static composition.
22715 Note: A composition is represented as one glyph in the
22716 glyph matrix. There are no padding glyphs.
22718 Important note: pixel_width, ascent, and descent are the
22719 values of what is drawn by draw_glyphs (i.e. the values of
22720 the overall glyphs composed). */
22721 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22722 int boff
; /* baseline offset */
22723 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22724 int glyph_len
= cmp
->glyph_len
;
22725 struct font
*font
= face
->font
;
22729 /* If we have not yet calculated pixel size data of glyphs of
22730 the composition for the current face font, calculate them
22731 now. Theoretically, we have to check all fonts for the
22732 glyphs, but that requires much time and memory space. So,
22733 here we check only the font of the first glyph. This may
22734 lead to incorrect display, but it's very rare, and C-l
22735 (recenter-top-bottom) can correct the display anyway. */
22736 if (! cmp
->font
|| cmp
->font
!= font
)
22738 /* Ascent and descent of the font of the first character
22739 of this composition (adjusted by baseline offset).
22740 Ascent and descent of overall glyphs should not be less
22741 than these, respectively. */
22742 int font_ascent
, font_descent
, font_height
;
22743 /* Bounding box of the overall glyphs. */
22744 int leftmost
, rightmost
, lowest
, highest
;
22745 int lbearing
, rbearing
;
22746 int i
, width
, ascent
, descent
;
22747 int left_padded
= 0, right_padded
= 0;
22750 struct font_metrics
*pcm
;
22751 int font_not_found_p
;
22754 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22755 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22757 if (glyph_len
< cmp
->glyph_len
)
22759 for (i
= 0; i
< glyph_len
; i
++)
22761 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22763 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22768 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22769 : IT_CHARPOS (*it
));
22770 /* If no suitable font is found, use the default font. */
22771 font_not_found_p
= font
== NULL
;
22772 if (font_not_found_p
)
22774 face
= face
->ascii_face
;
22777 boff
= font
->baseline_offset
;
22778 if (font
->vertical_centering
)
22779 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22780 font_ascent
= FONT_BASE (font
) + boff
;
22781 font_descent
= FONT_DESCENT (font
) - boff
;
22782 font_height
= FONT_HEIGHT (font
);
22784 cmp
->font
= (void *) font
;
22787 if (! font_not_found_p
)
22789 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22791 pcm
= get_per_char_metric (font
, &char2b
);
22794 /* Initialize the bounding box. */
22797 width
= pcm
->width
;
22798 ascent
= pcm
->ascent
;
22799 descent
= pcm
->descent
;
22800 lbearing
= pcm
->lbearing
;
22801 rbearing
= pcm
->rbearing
;
22805 width
= font
->space_width
;
22806 ascent
= FONT_BASE (font
);
22807 descent
= FONT_DESCENT (font
);
22814 lowest
= - descent
+ boff
;
22815 highest
= ascent
+ boff
;
22817 if (! font_not_found_p
22818 && font
->default_ascent
22819 && CHAR_TABLE_P (Vuse_default_ascent
)
22820 && !NILP (Faref (Vuse_default_ascent
,
22821 make_number (it
->char_to_display
))))
22822 highest
= font
->default_ascent
+ boff
;
22824 /* Draw the first glyph at the normal position. It may be
22825 shifted to right later if some other glyphs are drawn
22827 cmp
->offsets
[i
* 2] = 0;
22828 cmp
->offsets
[i
* 2 + 1] = boff
;
22829 cmp
->lbearing
= lbearing
;
22830 cmp
->rbearing
= rbearing
;
22832 /* Set cmp->offsets for the remaining glyphs. */
22833 for (i
++; i
< glyph_len
; i
++)
22835 int left
, right
, btm
, top
;
22836 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22838 struct face
*this_face
;
22842 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22843 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22844 font
= this_face
->font
;
22850 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22852 pcm
= get_per_char_metric (font
, &char2b
);
22855 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22858 width
= pcm
->width
;
22859 ascent
= pcm
->ascent
;
22860 descent
= pcm
->descent
;
22861 lbearing
= pcm
->lbearing
;
22862 rbearing
= pcm
->rbearing
;
22863 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22865 /* Relative composition with or without
22866 alternate chars. */
22867 left
= (leftmost
+ rightmost
- width
) / 2;
22868 btm
= - descent
+ boff
;
22869 if (font
->relative_compose
22870 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22871 || NILP (Faref (Vignore_relative_composition
,
22872 make_number (ch
)))))
22875 if (- descent
>= font
->relative_compose
)
22876 /* One extra pixel between two glyphs. */
22878 else if (ascent
<= 0)
22879 /* One extra pixel between two glyphs. */
22880 btm
= lowest
- 1 - ascent
- descent
;
22885 /* A composition rule is specified by an integer
22886 value that encodes global and new reference
22887 points (GREF and NREF). GREF and NREF are
22888 specified by numbers as below:
22890 0---1---2 -- ascent
22894 9--10--11 -- center
22896 ---3---4---5--- baseline
22898 6---7---8 -- descent
22900 int rule
= COMPOSITION_RULE (cmp
, i
);
22901 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22903 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22904 grefx
= gref
% 3, nrefx
= nref
% 3;
22905 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22907 xoff
= font_height
* (xoff
- 128) / 256;
22909 yoff
= font_height
* (yoff
- 128) / 256;
22912 + grefx
* (rightmost
- leftmost
) / 2
22913 - nrefx
* width
/ 2
22916 btm
= ((grefy
== 0 ? highest
22918 : grefy
== 2 ? lowest
22919 : (highest
+ lowest
) / 2)
22920 - (nrefy
== 0 ? ascent
+ descent
22921 : nrefy
== 1 ? descent
- boff
22923 : (ascent
+ descent
) / 2)
22927 cmp
->offsets
[i
* 2] = left
;
22928 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22930 /* Update the bounding box of the overall glyphs. */
22933 right
= left
+ width
;
22934 if (left
< leftmost
)
22936 if (right
> rightmost
)
22939 top
= btm
+ descent
+ ascent
;
22945 if (cmp
->lbearing
> left
+ lbearing
)
22946 cmp
->lbearing
= left
+ lbearing
;
22947 if (cmp
->rbearing
< left
+ rbearing
)
22948 cmp
->rbearing
= left
+ rbearing
;
22952 /* If there are glyphs whose x-offsets are negative,
22953 shift all glyphs to the right and make all x-offsets
22957 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22958 cmp
->offsets
[i
* 2] -= leftmost
;
22959 rightmost
-= leftmost
;
22960 cmp
->lbearing
-= leftmost
;
22961 cmp
->rbearing
-= leftmost
;
22964 if (left_padded
&& cmp
->lbearing
< 0)
22966 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22967 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22968 rightmost
-= cmp
->lbearing
;
22969 cmp
->rbearing
-= cmp
->lbearing
;
22972 if (right_padded
&& rightmost
< cmp
->rbearing
)
22974 rightmost
= cmp
->rbearing
;
22977 cmp
->pixel_width
= rightmost
;
22978 cmp
->ascent
= highest
;
22979 cmp
->descent
= - lowest
;
22980 if (cmp
->ascent
< font_ascent
)
22981 cmp
->ascent
= font_ascent
;
22982 if (cmp
->descent
< font_descent
)
22983 cmp
->descent
= font_descent
;
22987 && (cmp
->lbearing
< 0
22988 || cmp
->rbearing
> cmp
->pixel_width
))
22989 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22991 it
->pixel_width
= cmp
->pixel_width
;
22992 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22993 it
->descent
= it
->phys_descent
= cmp
->descent
;
22994 if (face
->box
!= FACE_NO_BOX
)
22996 int thick
= face
->box_line_width
;
23000 it
->ascent
+= thick
;
23001 it
->descent
+= thick
;
23006 if (it
->start_of_box_run_p
)
23007 it
->pixel_width
+= thick
;
23008 if (it
->end_of_box_run_p
)
23009 it
->pixel_width
+= thick
;
23012 /* If face has an overline, add the height of the overline
23013 (1 pixel) and a 1 pixel margin to the character height. */
23014 if (face
->overline_p
)
23015 it
->ascent
+= overline_margin
;
23017 take_vertical_position_into_account (it
);
23018 if (it
->ascent
< 0)
23020 if (it
->descent
< 0)
23024 append_composite_glyph (it
);
23026 else if (it
->what
== IT_COMPOSITION
)
23028 /* A dynamic (automatic) composition. */
23029 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23030 Lisp_Object gstring
;
23031 struct font_metrics metrics
;
23033 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23035 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23038 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23039 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23040 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23041 it
->descent
= it
->phys_descent
= metrics
.descent
;
23042 if (face
->box
!= FACE_NO_BOX
)
23044 int thick
= face
->box_line_width
;
23048 it
->ascent
+= thick
;
23049 it
->descent
+= thick
;
23054 if (it
->start_of_box_run_p
)
23055 it
->pixel_width
+= thick
;
23056 if (it
->end_of_box_run_p
)
23057 it
->pixel_width
+= thick
;
23059 /* If face has an overline, add the height of the overline
23060 (1 pixel) and a 1 pixel margin to the character height. */
23061 if (face
->overline_p
)
23062 it
->ascent
+= overline_margin
;
23063 take_vertical_position_into_account (it
);
23064 if (it
->ascent
< 0)
23066 if (it
->descent
< 0)
23070 append_composite_glyph (it
);
23072 else if (it
->what
== IT_GLYPHLESS
)
23073 produce_glyphless_glyph (it
, 0, Qnil
);
23074 else if (it
->what
== IT_IMAGE
)
23075 produce_image_glyph (it
);
23076 else if (it
->what
== IT_STRETCH
)
23077 produce_stretch_glyph (it
);
23080 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23081 because this isn't true for images with `:ascent 100'. */
23082 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23083 if (it
->area
== TEXT_AREA
)
23084 it
->current_x
+= it
->pixel_width
;
23086 if (extra_line_spacing
> 0)
23088 it
->descent
+= extra_line_spacing
;
23089 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23090 it
->max_extra_line_spacing
= extra_line_spacing
;
23093 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23094 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23095 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23096 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23100 Output LEN glyphs starting at START at the nominal cursor position.
23101 Advance the nominal cursor over the text. The global variable
23102 updated_window contains the window being updated, updated_row is
23103 the glyph row being updated, and updated_area is the area of that
23104 row being updated. */
23107 x_write_glyphs (struct glyph
*start
, int len
)
23111 xassert (updated_window
&& updated_row
);
23114 /* Write glyphs. */
23116 hpos
= start
- updated_row
->glyphs
[updated_area
];
23117 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23118 updated_row
, updated_area
,
23120 DRAW_NORMAL_TEXT
, 0);
23122 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23123 if (updated_area
== TEXT_AREA
23124 && updated_window
->phys_cursor_on_p
23125 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23126 && updated_window
->phys_cursor
.hpos
>= hpos
23127 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23128 updated_window
->phys_cursor_on_p
= 0;
23132 /* Advance the output cursor. */
23133 output_cursor
.hpos
+= len
;
23134 output_cursor
.x
= x
;
23139 Insert LEN glyphs from START at the nominal cursor position. */
23142 x_insert_glyphs (struct glyph
*start
, int len
)
23146 int line_height
, shift_by_width
, shifted_region_width
;
23147 struct glyph_row
*row
;
23148 struct glyph
*glyph
;
23149 int frame_x
, frame_y
;
23152 xassert (updated_window
&& updated_row
);
23154 w
= updated_window
;
23155 f
= XFRAME (WINDOW_FRAME (w
));
23157 /* Get the height of the line we are in. */
23159 line_height
= row
->height
;
23161 /* Get the width of the glyphs to insert. */
23162 shift_by_width
= 0;
23163 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23164 shift_by_width
+= glyph
->pixel_width
;
23166 /* Get the width of the region to shift right. */
23167 shifted_region_width
= (window_box_width (w
, updated_area
)
23172 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23173 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23175 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23176 line_height
, shift_by_width
);
23178 /* Write the glyphs. */
23179 hpos
= start
- row
->glyphs
[updated_area
];
23180 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23182 DRAW_NORMAL_TEXT
, 0);
23184 /* Advance the output cursor. */
23185 output_cursor
.hpos
+= len
;
23186 output_cursor
.x
+= shift_by_width
;
23192 Erase the current text line from the nominal cursor position
23193 (inclusive) to pixel column TO_X (exclusive). The idea is that
23194 everything from TO_X onward is already erased.
23196 TO_X is a pixel position relative to updated_area of
23197 updated_window. TO_X == -1 means clear to the end of this area. */
23200 x_clear_end_of_line (int to_x
)
23203 struct window
*w
= updated_window
;
23204 int max_x
, min_y
, max_y
;
23205 int from_x
, from_y
, to_y
;
23207 xassert (updated_window
&& updated_row
);
23208 f
= XFRAME (w
->frame
);
23210 if (updated_row
->full_width_p
)
23211 max_x
= WINDOW_TOTAL_WIDTH (w
);
23213 max_x
= window_box_width (w
, updated_area
);
23214 max_y
= window_text_bottom_y (w
);
23216 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23217 of window. For TO_X > 0, truncate to end of drawing area. */
23223 to_x
= min (to_x
, max_x
);
23225 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23227 /* Notice if the cursor will be cleared by this operation. */
23228 if (!updated_row
->full_width_p
)
23229 notice_overwritten_cursor (w
, updated_area
,
23230 output_cursor
.x
, -1,
23232 MATRIX_ROW_BOTTOM_Y (updated_row
));
23234 from_x
= output_cursor
.x
;
23236 /* Translate to frame coordinates. */
23237 if (updated_row
->full_width_p
)
23239 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23240 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23244 int area_left
= window_box_left (w
, updated_area
);
23245 from_x
+= area_left
;
23249 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23250 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23251 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23253 /* Prevent inadvertently clearing to end of the X window. */
23254 if (to_x
> from_x
&& to_y
> from_y
)
23257 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23258 to_x
- from_x
, to_y
- from_y
);
23263 #endif /* HAVE_WINDOW_SYSTEM */
23267 /***********************************************************************
23269 ***********************************************************************/
23271 /* Value is the internal representation of the specified cursor type
23272 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23273 of the bar cursor. */
23275 static enum text_cursor_kinds
23276 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23278 enum text_cursor_kinds type
;
23283 if (EQ (arg
, Qbox
))
23284 return FILLED_BOX_CURSOR
;
23286 if (EQ (arg
, Qhollow
))
23287 return HOLLOW_BOX_CURSOR
;
23289 if (EQ (arg
, Qbar
))
23296 && EQ (XCAR (arg
), Qbar
)
23297 && INTEGERP (XCDR (arg
))
23298 && XINT (XCDR (arg
)) >= 0)
23300 *width
= XINT (XCDR (arg
));
23304 if (EQ (arg
, Qhbar
))
23307 return HBAR_CURSOR
;
23311 && EQ (XCAR (arg
), Qhbar
)
23312 && INTEGERP (XCDR (arg
))
23313 && XINT (XCDR (arg
)) >= 0)
23315 *width
= XINT (XCDR (arg
));
23316 return HBAR_CURSOR
;
23319 /* Treat anything unknown as "hollow box cursor".
23320 It was bad to signal an error; people have trouble fixing
23321 .Xdefaults with Emacs, when it has something bad in it. */
23322 type
= HOLLOW_BOX_CURSOR
;
23327 /* Set the default cursor types for specified frame. */
23329 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23334 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23335 FRAME_CURSOR_WIDTH (f
) = width
;
23337 /* By default, set up the blink-off state depending on the on-state. */
23339 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23342 FRAME_BLINK_OFF_CURSOR (f
)
23343 = get_specified_cursor_type (XCDR (tem
), &width
);
23344 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23347 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23351 #ifdef HAVE_WINDOW_SYSTEM
23353 /* Return the cursor we want to be displayed in window W. Return
23354 width of bar/hbar cursor through WIDTH arg. Return with
23355 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23356 (i.e. if the `system caret' should track this cursor).
23358 In a mini-buffer window, we want the cursor only to appear if we
23359 are reading input from this window. For the selected window, we
23360 want the cursor type given by the frame parameter or buffer local
23361 setting of cursor-type. If explicitly marked off, draw no cursor.
23362 In all other cases, we want a hollow box cursor. */
23364 static enum text_cursor_kinds
23365 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23366 int *active_cursor
)
23368 struct frame
*f
= XFRAME (w
->frame
);
23369 struct buffer
*b
= XBUFFER (w
->buffer
);
23370 int cursor_type
= DEFAULT_CURSOR
;
23371 Lisp_Object alt_cursor
;
23372 int non_selected
= 0;
23374 *active_cursor
= 1;
23377 if (cursor_in_echo_area
23378 && FRAME_HAS_MINIBUF_P (f
)
23379 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23381 if (w
== XWINDOW (echo_area_window
))
23383 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23385 *width
= FRAME_CURSOR_WIDTH (f
);
23386 return FRAME_DESIRED_CURSOR (f
);
23389 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23392 *active_cursor
= 0;
23396 /* Detect a nonselected window or nonselected frame. */
23397 else if (w
!= XWINDOW (f
->selected_window
)
23398 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23400 *active_cursor
= 0;
23402 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23408 /* Never display a cursor in a window in which cursor-type is nil. */
23409 if (NILP (BVAR (b
, cursor_type
)))
23412 /* Get the normal cursor type for this window. */
23413 if (EQ (BVAR (b
, cursor_type
), Qt
))
23415 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23416 *width
= FRAME_CURSOR_WIDTH (f
);
23419 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23421 /* Use cursor-in-non-selected-windows instead
23422 for non-selected window or frame. */
23425 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23426 if (!EQ (Qt
, alt_cursor
))
23427 return get_specified_cursor_type (alt_cursor
, width
);
23428 /* t means modify the normal cursor type. */
23429 if (cursor_type
== FILLED_BOX_CURSOR
)
23430 cursor_type
= HOLLOW_BOX_CURSOR
;
23431 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23433 return cursor_type
;
23436 /* Use normal cursor if not blinked off. */
23437 if (!w
->cursor_off_p
)
23439 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23441 if (cursor_type
== FILLED_BOX_CURSOR
)
23443 /* Using a block cursor on large images can be very annoying.
23444 So use a hollow cursor for "large" images.
23445 If image is not transparent (no mask), also use hollow cursor. */
23446 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23447 if (img
!= NULL
&& IMAGEP (img
->spec
))
23449 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23450 where N = size of default frame font size.
23451 This should cover most of the "tiny" icons people may use. */
23453 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23454 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23455 cursor_type
= HOLLOW_BOX_CURSOR
;
23458 else if (cursor_type
!= NO_CURSOR
)
23460 /* Display current only supports BOX and HOLLOW cursors for images.
23461 So for now, unconditionally use a HOLLOW cursor when cursor is
23462 not a solid box cursor. */
23463 cursor_type
= HOLLOW_BOX_CURSOR
;
23466 return cursor_type
;
23469 /* Cursor is blinked off, so determine how to "toggle" it. */
23471 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23472 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23473 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23475 /* Then see if frame has specified a specific blink off cursor type. */
23476 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23478 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23479 return FRAME_BLINK_OFF_CURSOR (f
);
23483 /* Some people liked having a permanently visible blinking cursor,
23484 while others had very strong opinions against it. So it was
23485 decided to remove it. KFS 2003-09-03 */
23487 /* Finally perform built-in cursor blinking:
23488 filled box <-> hollow box
23489 wide [h]bar <-> narrow [h]bar
23490 narrow [h]bar <-> no cursor
23491 other type <-> no cursor */
23493 if (cursor_type
== FILLED_BOX_CURSOR
)
23494 return HOLLOW_BOX_CURSOR
;
23496 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23499 return cursor_type
;
23507 /* Notice when the text cursor of window W has been completely
23508 overwritten by a drawing operation that outputs glyphs in AREA
23509 starting at X0 and ending at X1 in the line starting at Y0 and
23510 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23511 the rest of the line after X0 has been written. Y coordinates
23512 are window-relative. */
23515 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23516 int x0
, int x1
, int y0
, int y1
)
23518 int cx0
, cx1
, cy0
, cy1
;
23519 struct glyph_row
*row
;
23521 if (!w
->phys_cursor_on_p
)
23523 if (area
!= TEXT_AREA
)
23526 if (w
->phys_cursor
.vpos
< 0
23527 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23528 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23529 !(row
->enabled_p
&& row
->displays_text_p
)))
23532 if (row
->cursor_in_fringe_p
)
23534 row
->cursor_in_fringe_p
= 0;
23535 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23536 w
->phys_cursor_on_p
= 0;
23540 cx0
= w
->phys_cursor
.x
;
23541 cx1
= cx0
+ w
->phys_cursor_width
;
23542 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23545 /* The cursor image will be completely removed from the
23546 screen if the output area intersects the cursor area in
23547 y-direction. When we draw in [y0 y1[, and some part of
23548 the cursor is at y < y0, that part must have been drawn
23549 before. When scrolling, the cursor is erased before
23550 actually scrolling, so we don't come here. When not
23551 scrolling, the rows above the old cursor row must have
23552 changed, and in this case these rows must have written
23553 over the cursor image.
23555 Likewise if part of the cursor is below y1, with the
23556 exception of the cursor being in the first blank row at
23557 the buffer and window end because update_text_area
23558 doesn't draw that row. (Except when it does, but
23559 that's handled in update_text_area.) */
23561 cy0
= w
->phys_cursor
.y
;
23562 cy1
= cy0
+ w
->phys_cursor_height
;
23563 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23566 w
->phys_cursor_on_p
= 0;
23569 #endif /* HAVE_WINDOW_SYSTEM */
23572 /************************************************************************
23574 ************************************************************************/
23576 #ifdef HAVE_WINDOW_SYSTEM
23579 Fix the display of area AREA of overlapping row ROW in window W
23580 with respect to the overlapping part OVERLAPS. */
23583 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23584 enum glyph_row_area area
, int overlaps
)
23591 for (i
= 0; i
< row
->used
[area
];)
23593 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23595 int start
= i
, start_x
= x
;
23599 x
+= row
->glyphs
[area
][i
].pixel_width
;
23602 while (i
< row
->used
[area
]
23603 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23605 draw_glyphs (w
, start_x
, row
, area
,
23607 DRAW_NORMAL_TEXT
, overlaps
);
23611 x
+= row
->glyphs
[area
][i
].pixel_width
;
23621 Draw the cursor glyph of window W in glyph row ROW. See the
23622 comment of draw_glyphs for the meaning of HL. */
23625 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23626 enum draw_glyphs_face hl
)
23628 /* If cursor hpos is out of bounds, don't draw garbage. This can
23629 happen in mini-buffer windows when switching between echo area
23630 glyphs and mini-buffer. */
23631 if ((row
->reversed_p
23632 ? (w
->phys_cursor
.hpos
>= 0)
23633 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23635 int on_p
= w
->phys_cursor_on_p
;
23637 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23638 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23640 w
->phys_cursor_on_p
= on_p
;
23642 if (hl
== DRAW_CURSOR
)
23643 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23644 /* When we erase the cursor, and ROW is overlapped by other
23645 rows, make sure that these overlapping parts of other rows
23647 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23649 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23651 if (row
> w
->current_matrix
->rows
23652 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23653 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23654 OVERLAPS_ERASED_CURSOR
);
23656 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23657 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23658 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23659 OVERLAPS_ERASED_CURSOR
);
23666 Erase the image of a cursor of window W from the screen. */
23669 erase_phys_cursor (struct window
*w
)
23671 struct frame
*f
= XFRAME (w
->frame
);
23672 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23673 int hpos
= w
->phys_cursor
.hpos
;
23674 int vpos
= w
->phys_cursor
.vpos
;
23675 int mouse_face_here_p
= 0;
23676 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23677 struct glyph_row
*cursor_row
;
23678 struct glyph
*cursor_glyph
;
23679 enum draw_glyphs_face hl
;
23681 /* No cursor displayed or row invalidated => nothing to do on the
23683 if (w
->phys_cursor_type
== NO_CURSOR
)
23684 goto mark_cursor_off
;
23686 /* VPOS >= active_glyphs->nrows means that window has been resized.
23687 Don't bother to erase the cursor. */
23688 if (vpos
>= active_glyphs
->nrows
)
23689 goto mark_cursor_off
;
23691 /* If row containing cursor is marked invalid, there is nothing we
23693 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23694 if (!cursor_row
->enabled_p
)
23695 goto mark_cursor_off
;
23697 /* If line spacing is > 0, old cursor may only be partially visible in
23698 window after split-window. So adjust visible height. */
23699 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23700 window_text_bottom_y (w
) - cursor_row
->y
);
23702 /* If row is completely invisible, don't attempt to delete a cursor which
23703 isn't there. This can happen if cursor is at top of a window, and
23704 we switch to a buffer with a header line in that window. */
23705 if (cursor_row
->visible_height
<= 0)
23706 goto mark_cursor_off
;
23708 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23709 if (cursor_row
->cursor_in_fringe_p
)
23711 cursor_row
->cursor_in_fringe_p
= 0;
23712 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23713 goto mark_cursor_off
;
23716 /* This can happen when the new row is shorter than the old one.
23717 In this case, either draw_glyphs or clear_end_of_line
23718 should have cleared the cursor. Note that we wouldn't be
23719 able to erase the cursor in this case because we don't have a
23720 cursor glyph at hand. */
23721 if ((cursor_row
->reversed_p
23722 ? (w
->phys_cursor
.hpos
< 0)
23723 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23724 goto mark_cursor_off
;
23726 /* If the cursor is in the mouse face area, redisplay that when
23727 we clear the cursor. */
23728 if (! NILP (hlinfo
->mouse_face_window
)
23729 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23730 /* Don't redraw the cursor's spot in mouse face if it is at the
23731 end of a line (on a newline). The cursor appears there, but
23732 mouse highlighting does not. */
23733 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23734 mouse_face_here_p
= 1;
23736 /* Maybe clear the display under the cursor. */
23737 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23740 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23743 cursor_glyph
= get_phys_cursor_glyph (w
);
23744 if (cursor_glyph
== NULL
)
23745 goto mark_cursor_off
;
23747 width
= cursor_glyph
->pixel_width
;
23748 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23749 x
= w
->phys_cursor
.x
;
23751 width
-= left_x
- x
;
23752 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23753 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23754 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23757 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23760 /* Erase the cursor by redrawing the character underneath it. */
23761 if (mouse_face_here_p
)
23762 hl
= DRAW_MOUSE_FACE
;
23764 hl
= DRAW_NORMAL_TEXT
;
23765 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23768 w
->phys_cursor_on_p
= 0;
23769 w
->phys_cursor_type
= NO_CURSOR
;
23774 Display or clear cursor of window W. If ON is zero, clear the
23775 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23776 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23779 display_and_set_cursor (struct window
*w
, int on
,
23780 int hpos
, int vpos
, int x
, int y
)
23782 struct frame
*f
= XFRAME (w
->frame
);
23783 int new_cursor_type
;
23784 int new_cursor_width
;
23786 struct glyph_row
*glyph_row
;
23787 struct glyph
*glyph
;
23789 /* This is pointless on invisible frames, and dangerous on garbaged
23790 windows and frames; in the latter case, the frame or window may
23791 be in the midst of changing its size, and x and y may be off the
23793 if (! FRAME_VISIBLE_P (f
)
23794 || FRAME_GARBAGED_P (f
)
23795 || vpos
>= w
->current_matrix
->nrows
23796 || hpos
>= w
->current_matrix
->matrix_w
)
23799 /* If cursor is off and we want it off, return quickly. */
23800 if (!on
&& !w
->phys_cursor_on_p
)
23803 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23804 /* If cursor row is not enabled, we don't really know where to
23805 display the cursor. */
23806 if (!glyph_row
->enabled_p
)
23808 w
->phys_cursor_on_p
= 0;
23813 if (!glyph_row
->exact_window_width_line_p
23814 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23815 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23817 xassert (interrupt_input_blocked
);
23819 /* Set new_cursor_type to the cursor we want to be displayed. */
23820 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23821 &new_cursor_width
, &active_cursor
);
23823 /* If cursor is currently being shown and we don't want it to be or
23824 it is in the wrong place, or the cursor type is not what we want,
23826 if (w
->phys_cursor_on_p
23828 || w
->phys_cursor
.x
!= x
23829 || w
->phys_cursor
.y
!= y
23830 || new_cursor_type
!= w
->phys_cursor_type
23831 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23832 && new_cursor_width
!= w
->phys_cursor_width
)))
23833 erase_phys_cursor (w
);
23835 /* Don't check phys_cursor_on_p here because that flag is only set
23836 to zero in some cases where we know that the cursor has been
23837 completely erased, to avoid the extra work of erasing the cursor
23838 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23839 still not be visible, or it has only been partly erased. */
23842 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23843 w
->phys_cursor_height
= glyph_row
->height
;
23845 /* Set phys_cursor_.* before x_draw_.* is called because some
23846 of them may need the information. */
23847 w
->phys_cursor
.x
= x
;
23848 w
->phys_cursor
.y
= glyph_row
->y
;
23849 w
->phys_cursor
.hpos
= hpos
;
23850 w
->phys_cursor
.vpos
= vpos
;
23853 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23854 new_cursor_type
, new_cursor_width
,
23855 on
, active_cursor
);
23859 /* Switch the display of W's cursor on or off, according to the value
23863 update_window_cursor (struct window
*w
, int on
)
23865 /* Don't update cursor in windows whose frame is in the process
23866 of being deleted. */
23867 if (w
->current_matrix
)
23870 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23871 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23877 /* Call update_window_cursor with parameter ON_P on all leaf windows
23878 in the window tree rooted at W. */
23881 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23885 if (!NILP (w
->hchild
))
23886 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23887 else if (!NILP (w
->vchild
))
23888 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23890 update_window_cursor (w
, on_p
);
23892 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23898 Display the cursor on window W, or clear it, according to ON_P.
23899 Don't change the cursor's position. */
23902 x_update_cursor (struct frame
*f
, int on_p
)
23904 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23909 Clear the cursor of window W to background color, and mark the
23910 cursor as not shown. This is used when the text where the cursor
23911 is about to be rewritten. */
23914 x_clear_cursor (struct window
*w
)
23916 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23917 update_window_cursor (w
, 0);
23920 #endif /* HAVE_WINDOW_SYSTEM */
23922 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
23925 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
23926 int start_hpos
, int end_hpos
,
23927 enum draw_glyphs_face draw
)
23929 #ifdef HAVE_WINDOW_SYSTEM
23930 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
23932 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
23936 #if defined (HAVE_GPM) || defined (MSDOS)
23937 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
23942 Display the active region described by mouse_face_* according to DRAW. */
23945 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
23947 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
23948 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23950 if (/* If window is in the process of being destroyed, don't bother
23952 w
->current_matrix
!= NULL
23953 /* Don't update mouse highlight if hidden */
23954 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
23955 /* Recognize when we are called to operate on rows that don't exist
23956 anymore. This can happen when a window is split. */
23957 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23959 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23960 struct glyph_row
*row
, *first
, *last
;
23962 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23963 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23965 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23967 int start_hpos
, end_hpos
, start_x
;
23969 /* For all but the first row, the highlight starts at column 0. */
23972 /* R2L rows have BEG and END in reversed order, but the
23973 screen drawing geometry is always left to right. So
23974 we need to mirror the beginning and end of the
23975 highlighted area in R2L rows. */
23976 if (!row
->reversed_p
)
23978 start_hpos
= hlinfo
->mouse_face_beg_col
;
23979 start_x
= hlinfo
->mouse_face_beg_x
;
23981 else if (row
== last
)
23983 start_hpos
= hlinfo
->mouse_face_end_col
;
23984 start_x
= hlinfo
->mouse_face_end_x
;
23992 else if (row
->reversed_p
&& row
== last
)
23994 start_hpos
= hlinfo
->mouse_face_end_col
;
23995 start_x
= hlinfo
->mouse_face_end_x
;
24005 if (!row
->reversed_p
)
24006 end_hpos
= hlinfo
->mouse_face_end_col
;
24007 else if (row
== first
)
24008 end_hpos
= hlinfo
->mouse_face_beg_col
;
24011 end_hpos
= row
->used
[TEXT_AREA
];
24012 if (draw
== DRAW_NORMAL_TEXT
)
24013 row
->fill_line_p
= 1; /* Clear to end of line */
24016 else if (row
->reversed_p
&& row
== first
)
24017 end_hpos
= hlinfo
->mouse_face_beg_col
;
24020 end_hpos
= row
->used
[TEXT_AREA
];
24021 if (draw
== DRAW_NORMAL_TEXT
)
24022 row
->fill_line_p
= 1; /* Clear to end of line */
24025 if (end_hpos
> start_hpos
)
24027 draw_row_with_mouse_face (w
, start_x
, row
,
24028 start_hpos
, end_hpos
, draw
);
24031 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24035 #ifdef HAVE_WINDOW_SYSTEM
24036 /* When we've written over the cursor, arrange for it to
24037 be displayed again. */
24038 if (FRAME_WINDOW_P (f
)
24039 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24042 display_and_set_cursor (w
, 1,
24043 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24044 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24047 #endif /* HAVE_WINDOW_SYSTEM */
24050 #ifdef HAVE_WINDOW_SYSTEM
24051 /* Change the mouse cursor. */
24052 if (FRAME_WINDOW_P (f
))
24054 if (draw
== DRAW_NORMAL_TEXT
24055 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24056 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24057 else if (draw
== DRAW_MOUSE_FACE
)
24058 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24060 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24062 #endif /* HAVE_WINDOW_SYSTEM */
24066 Clear out the mouse-highlighted active region.
24067 Redraw it un-highlighted first. Value is non-zero if mouse
24068 face was actually drawn unhighlighted. */
24071 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24075 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24077 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24081 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24082 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24083 hlinfo
->mouse_face_window
= Qnil
;
24084 hlinfo
->mouse_face_overlay
= Qnil
;
24088 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24089 within the mouse face on that window. */
24091 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24093 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24095 /* Quickly resolve the easy cases. */
24096 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24097 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24099 if (vpos
< hlinfo
->mouse_face_beg_row
24100 || vpos
> hlinfo
->mouse_face_end_row
)
24102 if (vpos
> hlinfo
->mouse_face_beg_row
24103 && vpos
< hlinfo
->mouse_face_end_row
)
24106 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24108 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24110 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24113 else if ((vpos
== hlinfo
->mouse_face_beg_row
24114 && hpos
>= hlinfo
->mouse_face_beg_col
)
24115 || (vpos
== hlinfo
->mouse_face_end_row
24116 && hpos
< hlinfo
->mouse_face_end_col
))
24121 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24123 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24126 else if ((vpos
== hlinfo
->mouse_face_beg_row
24127 && hpos
<= hlinfo
->mouse_face_beg_col
)
24128 || (vpos
== hlinfo
->mouse_face_end_row
24129 && hpos
> hlinfo
->mouse_face_end_col
))
24137 Non-zero if physical cursor of window W is within mouse face. */
24140 cursor_in_mouse_face_p (struct window
*w
)
24142 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24147 /* Find the glyph rows START_ROW and END_ROW of window W that display
24148 characters between buffer positions START_CHARPOS and END_CHARPOS
24149 (excluding END_CHARPOS). This is similar to row_containing_pos,
24150 but is more accurate when bidi reordering makes buffer positions
24151 change non-linearly with glyph rows. */
24153 rows_from_pos_range (struct window
*w
,
24154 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24155 struct glyph_row
**start
, struct glyph_row
**end
)
24157 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24158 int last_y
= window_text_bottom_y (w
);
24159 struct glyph_row
*row
;
24164 while (!first
->enabled_p
24165 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24168 /* Find the START row. */
24170 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24173 /* A row can potentially be the START row if the range of the
24174 characters it displays intersects the range
24175 [START_CHARPOS..END_CHARPOS). */
24176 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24177 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24178 /* See the commentary in row_containing_pos, for the
24179 explanation of the complicated way to check whether
24180 some position is beyond the end of the characters
24181 displayed by a row. */
24182 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24183 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24184 && !row
->ends_at_zv_p
24185 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24186 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24187 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24188 && !row
->ends_at_zv_p
24189 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24191 /* Found a candidate row. Now make sure at least one of the
24192 glyphs it displays has a charpos from the range
24193 [START_CHARPOS..END_CHARPOS).
24195 This is not obvious because bidi reordering could make
24196 buffer positions of a row be 1,2,3,102,101,100, and if we
24197 want to highlight characters in [50..60), we don't want
24198 this row, even though [50..60) does intersect [1..103),
24199 the range of character positions given by the row's start
24200 and end positions. */
24201 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24202 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24206 if (BUFFERP (g
->object
)
24207 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24216 /* Find the END row. */
24218 /* If the last row is partially visible, start looking for END
24219 from that row, instead of starting from FIRST. */
24220 && !(row
->enabled_p
24221 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24223 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24225 struct glyph_row
*next
= row
+ 1;
24227 if (!next
->enabled_p
24228 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24229 /* The first row >= START whose range of displayed characters
24230 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24231 is the row END + 1. */
24232 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24233 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24234 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24235 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24236 && !next
->ends_at_zv_p
24237 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24238 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24239 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24240 && !next
->ends_at_zv_p
24241 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24248 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24249 but none of the characters it displays are in the range, it is
24251 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24252 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24256 if (BUFFERP (g
->object
)
24257 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24270 /* This function sets the mouse_face_* elements of HLINFO, assuming
24271 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24272 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24273 for the overlay or run of text properties specifying the mouse
24274 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24275 before-string and after-string that must also be highlighted.
24276 COVER_STRING, if non-nil, is a display string that may cover some
24277 or all of the highlighted text. */
24280 mouse_face_from_buffer_pos (Lisp_Object window
,
24281 Mouse_HLInfo
*hlinfo
,
24282 EMACS_INT mouse_charpos
,
24283 EMACS_INT start_charpos
,
24284 EMACS_INT end_charpos
,
24285 Lisp_Object before_string
,
24286 Lisp_Object after_string
,
24287 Lisp_Object cover_string
)
24289 struct window
*w
= XWINDOW (window
);
24290 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24291 struct glyph_row
*r1
, *r2
;
24292 struct glyph
*glyph
, *end
;
24293 EMACS_INT ignore
, pos
;
24296 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24297 xassert (NILP (before_string
) || STRINGP (before_string
));
24298 xassert (NILP (after_string
) || STRINGP (after_string
));
24300 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24301 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24303 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24304 /* If the before-string or display-string contains newlines,
24305 rows_from_pos_range skips to its last row. Move back. */
24306 if (!NILP (before_string
) || !NILP (cover_string
))
24308 struct glyph_row
*prev
;
24309 while ((prev
= r1
- 1, prev
>= first
)
24310 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24311 && prev
->used
[TEXT_AREA
] > 0)
24313 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24314 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24315 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24317 || !(EQ (glyph
->object
, before_string
)
24318 || EQ (glyph
->object
, cover_string
)))
24325 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24326 hlinfo
->mouse_face_past_end
= 1;
24328 else if (!NILP (after_string
))
24330 /* If the after-string has newlines, advance to its last row. */
24331 struct glyph_row
*next
;
24332 struct glyph_row
*last
24333 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24335 for (next
= r2
+ 1;
24337 && next
->used
[TEXT_AREA
] > 0
24338 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24342 /* The rest of the display engine assumes that mouse_face_beg_row is
24343 either above below mouse_face_end_row or identical to it. But
24344 with bidi-reordered continued lines, the row for START_CHARPOS
24345 could be below the row for END_CHARPOS. If so, swap the rows and
24346 store them in correct order. */
24349 struct glyph_row
*tem
= r2
;
24355 hlinfo
->mouse_face_beg_y
= r1
->y
;
24356 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24357 hlinfo
->mouse_face_end_y
= r2
->y
;
24358 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24360 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24361 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24362 could be anywhere in the row and in any order. The strategy
24363 below is to find the leftmost and the rightmost glyph that
24364 belongs to either of these 3 strings, or whose position is
24365 between START_CHARPOS and END_CHARPOS, and highlight all the
24366 glyphs between those two. This may cover more than just the text
24367 between START_CHARPOS and END_CHARPOS if the range of characters
24368 strides the bidi level boundary, e.g. if the beginning is in R2L
24369 text while the end is in L2R text or vice versa. */
24370 if (!r1
->reversed_p
)
24372 /* This row is in a left to right paragraph. Scan it left to
24374 glyph
= r1
->glyphs
[TEXT_AREA
];
24375 end
= glyph
+ r1
->used
[TEXT_AREA
];
24378 /* Skip truncation glyphs at the start of the glyph row. */
24379 if (r1
->displays_text_p
)
24381 && INTEGERP (glyph
->object
)
24382 && glyph
->charpos
< 0;
24384 x
+= glyph
->pixel_width
;
24386 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24387 or COVER_STRING, and the first glyph from buffer whose
24388 position is between START_CHARPOS and END_CHARPOS. */
24390 && !INTEGERP (glyph
->object
)
24391 && !EQ (glyph
->object
, cover_string
)
24392 && !(BUFFERP (glyph
->object
)
24393 && (glyph
->charpos
>= start_charpos
24394 && glyph
->charpos
< end_charpos
));
24397 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24398 are present at buffer positions between START_CHARPOS and
24399 END_CHARPOS, or if they come from an overlay. */
24400 if (EQ (glyph
->object
, before_string
))
24402 pos
= string_buffer_position (before_string
,
24404 /* If pos == 0, it means before_string came from an
24405 overlay, not from a buffer position. */
24406 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24409 else if (EQ (glyph
->object
, after_string
))
24411 pos
= string_buffer_position (after_string
, end_charpos
);
24412 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24415 x
+= glyph
->pixel_width
;
24417 hlinfo
->mouse_face_beg_x
= x
;
24418 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24422 /* This row is in a right to left paragraph. Scan it right to
24426 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24427 glyph
= end
+ r1
->used
[TEXT_AREA
];
24429 /* Skip truncation glyphs at the start of the glyph row. */
24430 if (r1
->displays_text_p
)
24432 && INTEGERP (glyph
->object
)
24433 && glyph
->charpos
< 0;
24437 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24438 or COVER_STRING, and the first glyph from buffer whose
24439 position is between START_CHARPOS and END_CHARPOS. */
24441 && !INTEGERP (glyph
->object
)
24442 && !EQ (glyph
->object
, cover_string
)
24443 && !(BUFFERP (glyph
->object
)
24444 && (glyph
->charpos
>= start_charpos
24445 && glyph
->charpos
< end_charpos
));
24448 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24449 are present at buffer positions between START_CHARPOS and
24450 END_CHARPOS, or if they come from an overlay. */
24451 if (EQ (glyph
->object
, before_string
))
24453 pos
= string_buffer_position (before_string
, start_charpos
);
24454 /* If pos == 0, it means before_string came from an
24455 overlay, not from a buffer position. */
24456 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24459 else if (EQ (glyph
->object
, after_string
))
24461 pos
= string_buffer_position (after_string
, end_charpos
);
24462 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24467 glyph
++; /* first glyph to the right of the highlighted area */
24468 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24469 x
+= g
->pixel_width
;
24470 hlinfo
->mouse_face_beg_x
= x
;
24471 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24474 /* If the highlight ends in a different row, compute GLYPH and END
24475 for the end row. Otherwise, reuse the values computed above for
24476 the row where the highlight begins. */
24479 if (!r2
->reversed_p
)
24481 glyph
= r2
->glyphs
[TEXT_AREA
];
24482 end
= glyph
+ r2
->used
[TEXT_AREA
];
24487 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24488 glyph
= end
+ r2
->used
[TEXT_AREA
];
24492 if (!r2
->reversed_p
)
24494 /* Skip truncation and continuation glyphs near the end of the
24495 row, and also blanks and stretch glyphs inserted by
24496 extend_face_to_end_of_line. */
24498 && INTEGERP ((end
- 1)->object
)
24499 && (end
- 1)->charpos
<= 0)
24501 /* Scan the rest of the glyph row from the end, looking for the
24502 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24503 COVER_STRING, or whose position is between START_CHARPOS
24507 && !INTEGERP (end
->object
)
24508 && !EQ (end
->object
, cover_string
)
24509 && !(BUFFERP (end
->object
)
24510 && (end
->charpos
>= start_charpos
24511 && end
->charpos
< end_charpos
));
24514 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24515 are present at buffer positions between START_CHARPOS and
24516 END_CHARPOS, or if they come from an overlay. */
24517 if (EQ (end
->object
, before_string
))
24519 pos
= string_buffer_position (before_string
, start_charpos
);
24520 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24523 else if (EQ (end
->object
, after_string
))
24525 pos
= string_buffer_position (after_string
, end_charpos
);
24526 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24530 /* Find the X coordinate of the last glyph to be highlighted. */
24531 for (; glyph
<= end
; ++glyph
)
24532 x
+= glyph
->pixel_width
;
24534 hlinfo
->mouse_face_end_x
= x
;
24535 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24539 /* Skip truncation and continuation glyphs near the end of the
24540 row, and also blanks and stretch glyphs inserted by
24541 extend_face_to_end_of_line. */
24545 && INTEGERP (end
->object
)
24546 && end
->charpos
<= 0)
24548 x
+= end
->pixel_width
;
24551 /* Scan the rest of the glyph row from the end, looking for the
24552 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24553 COVER_STRING, or whose position is between START_CHARPOS
24557 && !INTEGERP (end
->object
)
24558 && !EQ (end
->object
, cover_string
)
24559 && !(BUFFERP (end
->object
)
24560 && (end
->charpos
>= start_charpos
24561 && end
->charpos
< end_charpos
));
24564 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24565 are present at buffer positions between START_CHARPOS and
24566 END_CHARPOS, or if they come from an overlay. */
24567 if (EQ (end
->object
, before_string
))
24569 pos
= string_buffer_position (before_string
, start_charpos
);
24570 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24573 else if (EQ (end
->object
, after_string
))
24575 pos
= string_buffer_position (after_string
, end_charpos
);
24576 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24579 x
+= end
->pixel_width
;
24581 hlinfo
->mouse_face_end_x
= x
;
24582 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24585 hlinfo
->mouse_face_window
= window
;
24586 hlinfo
->mouse_face_face_id
24587 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24589 !hlinfo
->mouse_face_hidden
, -1);
24590 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24593 /* The following function is not used anymore (replaced with
24594 mouse_face_from_string_pos), but I leave it here for the time
24595 being, in case someone would. */
24597 #if 0 /* not used */
24599 /* Find the position of the glyph for position POS in OBJECT in
24600 window W's current matrix, and return in *X, *Y the pixel
24601 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24603 RIGHT_P non-zero means return the position of the right edge of the
24604 glyph, RIGHT_P zero means return the left edge position.
24606 If no glyph for POS exists in the matrix, return the position of
24607 the glyph with the next smaller position that is in the matrix, if
24608 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24609 exists in the matrix, return the position of the glyph with the
24610 next larger position in OBJECT.
24612 Value is non-zero if a glyph was found. */
24615 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24616 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24618 int yb
= window_text_bottom_y (w
);
24619 struct glyph_row
*r
;
24620 struct glyph
*best_glyph
= NULL
;
24621 struct glyph_row
*best_row
= NULL
;
24624 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24625 r
->enabled_p
&& r
->y
< yb
;
24628 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24629 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24632 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24633 if (EQ (g
->object
, object
))
24635 if (g
->charpos
== pos
)
24642 else if (best_glyph
== NULL
24643 || ((eabs (g
->charpos
- pos
)
24644 < eabs (best_glyph
->charpos
- pos
))
24647 : g
->charpos
> pos
)))
24661 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24665 *x
+= best_glyph
->pixel_width
;
24670 *vpos
= best_row
- w
->current_matrix
->rows
;
24673 return best_glyph
!= NULL
;
24675 #endif /* not used */
24677 /* Find the positions of the first and the last glyphs in window W's
24678 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24679 (assumed to be a string), and return in HLINFO's mouse_face_*
24680 members the pixel and column/row coordinates of those glyphs. */
24683 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24684 Lisp_Object object
,
24685 EMACS_INT startpos
, EMACS_INT endpos
)
24687 int yb
= window_text_bottom_y (w
);
24688 struct glyph_row
*r
;
24689 struct glyph
*g
, *e
;
24693 /* Find the glyph row with at least one position in the range
24694 [STARTPOS..ENDPOS], and the first glyph in that row whose
24695 position belongs to that range. */
24696 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24697 r
->enabled_p
&& r
->y
< yb
;
24700 if (!r
->reversed_p
)
24702 g
= r
->glyphs
[TEXT_AREA
];
24703 e
= g
+ r
->used
[TEXT_AREA
];
24704 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24705 if (EQ (g
->object
, object
)
24706 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24708 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24709 hlinfo
->mouse_face_beg_y
= r
->y
;
24710 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24711 hlinfo
->mouse_face_beg_x
= gx
;
24720 e
= r
->glyphs
[TEXT_AREA
];
24721 g
= e
+ r
->used
[TEXT_AREA
];
24722 for ( ; g
> e
; --g
)
24723 if (EQ ((g
-1)->object
, object
)
24724 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24726 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24727 hlinfo
->mouse_face_beg_y
= r
->y
;
24728 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24729 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24730 gx
+= g1
->pixel_width
;
24731 hlinfo
->mouse_face_beg_x
= gx
;
24743 /* Starting with the next row, look for the first row which does NOT
24744 include any glyphs whose positions are in the range. */
24745 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24747 g
= r
->glyphs
[TEXT_AREA
];
24748 e
= g
+ r
->used
[TEXT_AREA
];
24750 for ( ; g
< e
; ++g
)
24751 if (EQ (g
->object
, object
)
24752 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24761 /* The highlighted region ends on the previous row. */
24764 /* Set the end row and its vertical pixel coordinate. */
24765 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24766 hlinfo
->mouse_face_end_y
= r
->y
;
24768 /* Compute and set the end column and the end column's horizontal
24769 pixel coordinate. */
24770 if (!r
->reversed_p
)
24772 g
= r
->glyphs
[TEXT_AREA
];
24773 e
= g
+ r
->used
[TEXT_AREA
];
24774 for ( ; e
> g
; --e
)
24775 if (EQ ((e
-1)->object
, object
)
24776 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24778 hlinfo
->mouse_face_end_col
= e
- g
;
24780 for (gx
= r
->x
; g
< e
; ++g
)
24781 gx
+= g
->pixel_width
;
24782 hlinfo
->mouse_face_end_x
= gx
;
24786 e
= r
->glyphs
[TEXT_AREA
];
24787 g
= e
+ r
->used
[TEXT_AREA
];
24788 for (gx
= r
->x
; e
< g
; ++e
)
24790 if (EQ (e
->object
, object
)
24791 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24793 gx
+= e
->pixel_width
;
24795 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24796 hlinfo
->mouse_face_end_x
= gx
;
24800 #ifdef HAVE_WINDOW_SYSTEM
24802 /* See if position X, Y is within a hot-spot of an image. */
24805 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24807 if (!CONSP (hot_spot
))
24810 if (EQ (XCAR (hot_spot
), Qrect
))
24812 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24813 Lisp_Object rect
= XCDR (hot_spot
);
24817 if (!CONSP (XCAR (rect
)))
24819 if (!CONSP (XCDR (rect
)))
24821 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24823 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24825 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24827 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24831 else if (EQ (XCAR (hot_spot
), Qcircle
))
24833 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24834 Lisp_Object circ
= XCDR (hot_spot
);
24835 Lisp_Object lr
, lx0
, ly0
;
24837 && CONSP (XCAR (circ
))
24838 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24839 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24840 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24842 double r
= XFLOATINT (lr
);
24843 double dx
= XINT (lx0
) - x
;
24844 double dy
= XINT (ly0
) - y
;
24845 return (dx
* dx
+ dy
* dy
<= r
* r
);
24848 else if (EQ (XCAR (hot_spot
), Qpoly
))
24850 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24851 if (VECTORP (XCDR (hot_spot
)))
24853 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24854 Lisp_Object
*poly
= v
->contents
;
24858 Lisp_Object lx
, ly
;
24861 /* Need an even number of coordinates, and at least 3 edges. */
24862 if (n
< 6 || n
& 1)
24865 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24866 If count is odd, we are inside polygon. Pixels on edges
24867 may or may not be included depending on actual geometry of the
24869 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24870 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24872 x0
= XINT (lx
), y0
= XINT (ly
);
24873 for (i
= 0; i
< n
; i
+= 2)
24875 int x1
= x0
, y1
= y0
;
24876 if ((lx
= poly
[i
], !INTEGERP (lx
))
24877 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24879 x0
= XINT (lx
), y0
= XINT (ly
);
24881 /* Does this segment cross the X line? */
24889 if (y
> y0
&& y
> y1
)
24891 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24901 find_hot_spot (Lisp_Object map
, int x
, int y
)
24903 while (CONSP (map
))
24905 if (CONSP (XCAR (map
))
24906 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24914 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24916 doc
: /* Lookup in image map MAP coordinates X and Y.
24917 An image map is an alist where each element has the format (AREA ID PLIST).
24918 An AREA is specified as either a rectangle, a circle, or a polygon:
24919 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24920 pixel coordinates of the upper left and bottom right corners.
24921 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24922 and the radius of the circle; r may be a float or integer.
24923 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24924 vector describes one corner in the polygon.
24925 Returns the alist element for the first matching AREA in MAP. */)
24926 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24934 return find_hot_spot (map
, XINT (x
), XINT (y
));
24938 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24940 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24942 /* Do not change cursor shape while dragging mouse. */
24943 if (!NILP (do_mouse_tracking
))
24946 if (!NILP (pointer
))
24948 if (EQ (pointer
, Qarrow
))
24949 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24950 else if (EQ (pointer
, Qhand
))
24951 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24952 else if (EQ (pointer
, Qtext
))
24953 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24954 else if (EQ (pointer
, intern ("hdrag")))
24955 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24956 #ifdef HAVE_X_WINDOWS
24957 else if (EQ (pointer
, intern ("vdrag")))
24958 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24960 else if (EQ (pointer
, intern ("hourglass")))
24961 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24962 else if (EQ (pointer
, Qmodeline
))
24963 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24965 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24968 if (cursor
!= No_Cursor
)
24969 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24972 #endif /* HAVE_WINDOW_SYSTEM */
24974 /* Take proper action when mouse has moved to the mode or header line
24975 or marginal area AREA of window W, x-position X and y-position Y.
24976 X is relative to the start of the text display area of W, so the
24977 width of bitmap areas and scroll bars must be subtracted to get a
24978 position relative to the start of the mode line. */
24981 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24982 enum window_part area
)
24984 struct window
*w
= XWINDOW (window
);
24985 struct frame
*f
= XFRAME (w
->frame
);
24986 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24987 #ifdef HAVE_WINDOW_SYSTEM
24988 Display_Info
*dpyinfo
;
24990 Cursor cursor
= No_Cursor
;
24991 Lisp_Object pointer
= Qnil
;
24992 int dx
, dy
, width
, height
;
24994 Lisp_Object string
, object
= Qnil
;
24995 Lisp_Object pos
, help
;
24997 Lisp_Object mouse_face
;
24998 int original_x_pixel
= x
;
24999 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25000 struct glyph_row
*row
;
25002 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25007 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25008 returns them in row/column units! */
25009 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25010 &object
, &dx
, &dy
, &width
, &height
);
25012 row
= (area
== ON_MODE_LINE
25013 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25014 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25016 /* Find the glyph under the mouse pointer. */
25017 if (row
->mode_line_p
&& row
->enabled_p
)
25019 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25020 end
= glyph
+ row
->used
[TEXT_AREA
];
25022 for (x0
= original_x_pixel
;
25023 glyph
< end
&& x0
>= glyph
->pixel_width
;
25025 x0
-= glyph
->pixel_width
;
25033 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25034 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25035 returns them in row/column units! */
25036 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25037 &object
, &dx
, &dy
, &width
, &height
);
25042 #ifdef HAVE_WINDOW_SYSTEM
25043 if (IMAGEP (object
))
25045 Lisp_Object image_map
, hotspot
;
25046 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25048 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25050 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25054 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25055 If so, we could look for mouse-enter, mouse-leave
25056 properties in PLIST (and do something...). */
25057 hotspot
= XCDR (hotspot
);
25058 if (CONSP (hotspot
)
25059 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25061 pointer
= Fplist_get (plist
, Qpointer
);
25062 if (NILP (pointer
))
25064 help
= Fplist_get (plist
, Qhelp_echo
);
25067 help_echo_string
= help
;
25068 /* Is this correct? ++kfs */
25069 XSETWINDOW (help_echo_window
, w
);
25070 help_echo_object
= w
->buffer
;
25071 help_echo_pos
= charpos
;
25075 if (NILP (pointer
))
25076 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25078 #endif /* HAVE_WINDOW_SYSTEM */
25080 if (STRINGP (string
))
25082 pos
= make_number (charpos
);
25083 /* If we're on a string with `help-echo' text property, arrange
25084 for the help to be displayed. This is done by setting the
25085 global variable help_echo_string to the help string. */
25088 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25091 help_echo_string
= help
;
25092 XSETWINDOW (help_echo_window
, w
);
25093 help_echo_object
= string
;
25094 help_echo_pos
= charpos
;
25098 #ifdef HAVE_WINDOW_SYSTEM
25099 if (FRAME_WINDOW_P (f
))
25101 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25102 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25103 if (NILP (pointer
))
25104 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25106 /* Change the mouse pointer according to what is under X/Y. */
25108 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25111 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25112 if (!KEYMAPP (map
))
25113 map
= Fget_text_property (pos
, Qkeymap
, string
);
25114 if (!KEYMAPP (map
))
25115 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25120 /* Change the mouse face according to what is under X/Y. */
25121 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25122 if (!NILP (mouse_face
)
25123 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25128 struct glyph
* tmp_glyph
;
25132 int total_pixel_width
;
25133 EMACS_INT begpos
, endpos
, ignore
;
25137 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25138 Qmouse_face
, string
, Qnil
);
25144 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25146 endpos
= SCHARS (string
);
25150 /* Calculate the glyph position GPOS of GLYPH in the
25151 displayed string, relative to the beginning of the
25152 highlighted part of the string.
25154 Note: GPOS is different from CHARPOS. CHARPOS is the
25155 position of GLYPH in the internal string object. A mode
25156 line string format has structures which are converted to
25157 a flattened string by the Emacs Lisp interpreter. The
25158 internal string is an element of those structures. The
25159 displayed string is the flattened string. */
25160 tmp_glyph
= row_start_glyph
;
25161 while (tmp_glyph
< glyph
25162 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25163 && begpos
<= tmp_glyph
->charpos
25164 && tmp_glyph
->charpos
< endpos
)))
25166 gpos
= glyph
- tmp_glyph
;
25168 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25169 the highlighted part of the displayed string to which
25170 GLYPH belongs. Note: GSEQ_LENGTH is different from
25171 SCHARS (STRING), because the latter returns the length of
25172 the internal string. */
25173 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25175 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25176 && begpos
<= tmp_glyph
->charpos
25177 && tmp_glyph
->charpos
< endpos
));
25180 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25182 /* Calculate the total pixel width of all the glyphs between
25183 the beginning of the highlighted area and GLYPH. */
25184 total_pixel_width
= 0;
25185 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25186 total_pixel_width
+= tmp_glyph
->pixel_width
;
25188 /* Pre calculation of re-rendering position. Note: X is in
25189 column units here, after the call to mode_line_string or
25190 marginal_area_string. */
25192 vpos
= (area
== ON_MODE_LINE
25193 ? (w
->current_matrix
)->nrows
- 1
25196 /* If GLYPH's position is included in the region that is
25197 already drawn in mouse face, we have nothing to do. */
25198 if ( EQ (window
, hlinfo
->mouse_face_window
)
25199 && (!row
->reversed_p
25200 ? (hlinfo
->mouse_face_beg_col
<= hpos
25201 && hpos
< hlinfo
->mouse_face_end_col
)
25202 /* In R2L rows we swap BEG and END, see below. */
25203 : (hlinfo
->mouse_face_end_col
<= hpos
25204 && hpos
< hlinfo
->mouse_face_beg_col
))
25205 && hlinfo
->mouse_face_beg_row
== vpos
)
25208 if (clear_mouse_face (hlinfo
))
25209 cursor
= No_Cursor
;
25211 if (!row
->reversed_p
)
25213 hlinfo
->mouse_face_beg_col
= hpos
;
25214 hlinfo
->mouse_face_beg_x
= original_x_pixel
25215 - (total_pixel_width
+ dx
);
25216 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25217 hlinfo
->mouse_face_end_x
= 0;
25221 /* In R2L rows, show_mouse_face expects BEG and END
25222 coordinates to be swapped. */
25223 hlinfo
->mouse_face_end_col
= hpos
;
25224 hlinfo
->mouse_face_end_x
= original_x_pixel
25225 - (total_pixel_width
+ dx
);
25226 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25227 hlinfo
->mouse_face_beg_x
= 0;
25230 hlinfo
->mouse_face_beg_row
= vpos
;
25231 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25232 hlinfo
->mouse_face_beg_y
= 0;
25233 hlinfo
->mouse_face_end_y
= 0;
25234 hlinfo
->mouse_face_past_end
= 0;
25235 hlinfo
->mouse_face_window
= window
;
25237 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25243 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25245 if (NILP (pointer
))
25248 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25249 clear_mouse_face (hlinfo
);
25251 #ifdef HAVE_WINDOW_SYSTEM
25252 if (FRAME_WINDOW_P (f
))
25253 define_frame_cursor1 (f
, cursor
, pointer
);
25259 Take proper action when the mouse has moved to position X, Y on
25260 frame F as regards highlighting characters that have mouse-face
25261 properties. Also de-highlighting chars where the mouse was before.
25262 X and Y can be negative or out of range. */
25265 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25267 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25268 enum window_part part
;
25269 Lisp_Object window
;
25271 Cursor cursor
= No_Cursor
;
25272 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25275 /* When a menu is active, don't highlight because this looks odd. */
25276 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25277 if (popup_activated ())
25281 if (NILP (Vmouse_highlight
)
25282 || !f
->glyphs_initialized_p
25283 || f
->pointer_invisible
)
25286 hlinfo
->mouse_face_mouse_x
= x
;
25287 hlinfo
->mouse_face_mouse_y
= y
;
25288 hlinfo
->mouse_face_mouse_frame
= f
;
25290 if (hlinfo
->mouse_face_defer
)
25293 if (gc_in_progress
)
25295 hlinfo
->mouse_face_deferred_gc
= 1;
25299 /* Which window is that in? */
25300 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25302 /* If we were displaying active text in another window, clear that.
25303 Also clear if we move out of text area in same window. */
25304 if (! EQ (window
, hlinfo
->mouse_face_window
)
25305 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25306 && !NILP (hlinfo
->mouse_face_window
)))
25307 clear_mouse_face (hlinfo
);
25309 /* Not on a window -> return. */
25310 if (!WINDOWP (window
))
25313 /* Reset help_echo_string. It will get recomputed below. */
25314 help_echo_string
= Qnil
;
25316 /* Convert to window-relative pixel coordinates. */
25317 w
= XWINDOW (window
);
25318 frame_to_window_pixel_xy (w
, &x
, &y
);
25320 #ifdef HAVE_WINDOW_SYSTEM
25321 /* Handle tool-bar window differently since it doesn't display a
25323 if (EQ (window
, f
->tool_bar_window
))
25325 note_tool_bar_highlight (f
, x
, y
);
25330 /* Mouse is on the mode, header line or margin? */
25331 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25332 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25334 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25338 #ifdef HAVE_WINDOW_SYSTEM
25339 if (part
== ON_VERTICAL_BORDER
)
25341 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25342 help_echo_string
= build_string ("drag-mouse-1: resize");
25344 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25345 || part
== ON_SCROLL_BAR
)
25346 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25348 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25351 /* Are we in a window whose display is up to date?
25352 And verify the buffer's text has not changed. */
25353 b
= XBUFFER (w
->buffer
);
25354 if (part
== ON_TEXT
25355 && EQ (w
->window_end_valid
, w
->buffer
)
25356 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25357 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25359 int hpos
, vpos
, i
, dx
, dy
, area
;
25361 struct glyph
*glyph
;
25362 Lisp_Object object
;
25363 Lisp_Object mouse_face
= Qnil
, position
;
25364 Lisp_Object
*overlay_vec
= NULL
;
25366 struct buffer
*obuf
;
25367 EMACS_INT obegv
, ozv
;
25370 /* Find the glyph under X/Y. */
25371 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25373 #ifdef HAVE_WINDOW_SYSTEM
25374 /* Look for :pointer property on image. */
25375 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25377 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25378 if (img
!= NULL
&& IMAGEP (img
->spec
))
25380 Lisp_Object image_map
, hotspot
;
25381 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25383 && (hotspot
= find_hot_spot (image_map
,
25384 glyph
->slice
.img
.x
+ dx
,
25385 glyph
->slice
.img
.y
+ dy
),
25387 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25391 /* Could check XCAR (hotspot) to see if we enter/leave
25393 If so, we could look for mouse-enter, mouse-leave
25394 properties in PLIST (and do something...). */
25395 hotspot
= XCDR (hotspot
);
25396 if (CONSP (hotspot
)
25397 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25399 pointer
= Fplist_get (plist
, Qpointer
);
25400 if (NILP (pointer
))
25402 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25403 if (!NILP (help_echo_string
))
25405 help_echo_window
= window
;
25406 help_echo_object
= glyph
->object
;
25407 help_echo_pos
= glyph
->charpos
;
25411 if (NILP (pointer
))
25412 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25415 #endif /* HAVE_WINDOW_SYSTEM */
25417 /* Clear mouse face if X/Y not over text. */
25419 || area
!= TEXT_AREA
25420 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25421 /* Glyph's OBJECT is an integer for glyphs inserted by the
25422 display engine for its internal purposes, like truncation
25423 and continuation glyphs and blanks beyond the end of
25424 line's text on text terminals. If we are over such a
25425 glyph, we are not over any text. */
25426 || INTEGERP (glyph
->object
)
25427 /* R2L rows have a stretch glyph at their front, which
25428 stands for no text, whereas L2R rows have no glyphs at
25429 all beyond the end of text. Treat such stretch glyphs
25430 like we do with NULL glyphs in L2R rows. */
25431 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25432 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25433 && glyph
->type
== STRETCH_GLYPH
25434 && glyph
->avoid_cursor_p
))
25436 if (clear_mouse_face (hlinfo
))
25437 cursor
= No_Cursor
;
25438 #ifdef HAVE_WINDOW_SYSTEM
25439 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25441 if (area
!= TEXT_AREA
)
25442 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25444 pointer
= Vvoid_text_area_pointer
;
25450 pos
= glyph
->charpos
;
25451 object
= glyph
->object
;
25452 if (!STRINGP (object
) && !BUFFERP (object
))
25455 /* If we get an out-of-range value, return now; avoid an error. */
25456 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25459 /* Make the window's buffer temporarily current for
25460 overlays_at and compute_char_face. */
25461 obuf
= current_buffer
;
25462 current_buffer
= b
;
25468 /* Is this char mouse-active or does it have help-echo? */
25469 position
= make_number (pos
);
25471 if (BUFFERP (object
))
25473 /* Put all the overlays we want in a vector in overlay_vec. */
25474 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25475 /* Sort overlays into increasing priority order. */
25476 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25481 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25484 cursor
= No_Cursor
;
25486 /* Check mouse-face highlighting. */
25488 /* If there exists an overlay with mouse-face overlapping
25489 the one we are currently highlighting, we have to
25490 check if we enter the overlapping overlay, and then
25491 highlight only that. */
25492 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25493 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25495 /* Find the highest priority overlay with a mouse-face. */
25496 Lisp_Object overlay
= Qnil
;
25497 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25499 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25500 if (!NILP (mouse_face
))
25501 overlay
= overlay_vec
[i
];
25504 /* If we're highlighting the same overlay as before, there's
25505 no need to do that again. */
25506 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25507 goto check_help_echo
;
25508 hlinfo
->mouse_face_overlay
= overlay
;
25510 /* Clear the display of the old active region, if any. */
25511 if (clear_mouse_face (hlinfo
))
25512 cursor
= No_Cursor
;
25514 /* If no overlay applies, get a text property. */
25515 if (NILP (overlay
))
25516 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25518 /* Next, compute the bounds of the mouse highlighting and
25520 if (!NILP (mouse_face
) && STRINGP (object
))
25522 /* The mouse-highlighting comes from a display string
25523 with a mouse-face. */
25527 s
= Fprevious_single_property_change
25528 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25529 e
= Fnext_single_property_change
25530 (position
, Qmouse_face
, object
, Qnil
);
25532 s
= make_number (0);
25534 e
= make_number (SCHARS (object
) - 1);
25535 mouse_face_from_string_pos (w
, hlinfo
, object
,
25536 XINT (s
), XINT (e
));
25537 hlinfo
->mouse_face_past_end
= 0;
25538 hlinfo
->mouse_face_window
= window
;
25539 hlinfo
->mouse_face_face_id
25540 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25541 glyph
->face_id
, 1);
25542 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25543 cursor
= No_Cursor
;
25547 /* The mouse-highlighting, if any, comes from an overlay
25548 or text property in the buffer. */
25549 Lisp_Object buffer
IF_LINT (= Qnil
);
25550 Lisp_Object cover_string
IF_LINT (= Qnil
);
25552 if (STRINGP (object
))
25554 /* If we are on a display string with no mouse-face,
25555 check if the text under it has one. */
25556 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25557 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25558 pos
= string_buffer_position (object
, start
);
25561 mouse_face
= get_char_property_and_overlay
25562 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25563 buffer
= w
->buffer
;
25564 cover_string
= object
;
25570 cover_string
= Qnil
;
25573 if (!NILP (mouse_face
))
25575 Lisp_Object before
, after
;
25576 Lisp_Object before_string
, after_string
;
25577 /* To correctly find the limits of mouse highlight
25578 in a bidi-reordered buffer, we must not use the
25579 optimization of limiting the search in
25580 previous-single-property-change and
25581 next-single-property-change, because
25582 rows_from_pos_range needs the real start and end
25583 positions to DTRT in this case. That's because
25584 the first row visible in a window does not
25585 necessarily display the character whose position
25586 is the smallest. */
25588 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25589 ? Fmarker_position (w
->start
)
25592 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25593 ? make_number (BUF_Z (XBUFFER (buffer
))
25594 - XFASTINT (w
->window_end_pos
))
25597 if (NILP (overlay
))
25599 /* Handle the text property case. */
25600 before
= Fprevious_single_property_change
25601 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25602 after
= Fnext_single_property_change
25603 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25604 before_string
= after_string
= Qnil
;
25608 /* Handle the overlay case. */
25609 before
= Foverlay_start (overlay
);
25610 after
= Foverlay_end (overlay
);
25611 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25612 after_string
= Foverlay_get (overlay
, Qafter_string
);
25614 if (!STRINGP (before_string
)) before_string
= Qnil
;
25615 if (!STRINGP (after_string
)) after_string
= Qnil
;
25618 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25621 before_string
, after_string
,
25623 cursor
= No_Cursor
;
25630 /* Look for a `help-echo' property. */
25631 if (NILP (help_echo_string
)) {
25632 Lisp_Object help
, overlay
;
25634 /* Check overlays first. */
25635 help
= overlay
= Qnil
;
25636 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25638 overlay
= overlay_vec
[i
];
25639 help
= Foverlay_get (overlay
, Qhelp_echo
);
25644 help_echo_string
= help
;
25645 help_echo_window
= window
;
25646 help_echo_object
= overlay
;
25647 help_echo_pos
= pos
;
25651 Lisp_Object obj
= glyph
->object
;
25652 EMACS_INT charpos
= glyph
->charpos
;
25654 /* Try text properties. */
25657 && charpos
< SCHARS (obj
))
25659 help
= Fget_text_property (make_number (charpos
),
25663 /* If the string itself doesn't specify a help-echo,
25664 see if the buffer text ``under'' it does. */
25665 struct glyph_row
*r
25666 = MATRIX_ROW (w
->current_matrix
, vpos
);
25667 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25668 EMACS_INT p
= string_buffer_position (obj
, start
);
25671 help
= Fget_char_property (make_number (p
),
25672 Qhelp_echo
, w
->buffer
);
25681 else if (BUFFERP (obj
)
25684 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25689 help_echo_string
= help
;
25690 help_echo_window
= window
;
25691 help_echo_object
= obj
;
25692 help_echo_pos
= charpos
;
25697 #ifdef HAVE_WINDOW_SYSTEM
25698 /* Look for a `pointer' property. */
25699 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25701 /* Check overlays first. */
25702 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25703 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25705 if (NILP (pointer
))
25707 Lisp_Object obj
= glyph
->object
;
25708 EMACS_INT charpos
= glyph
->charpos
;
25710 /* Try text properties. */
25713 && charpos
< SCHARS (obj
))
25715 pointer
= Fget_text_property (make_number (charpos
),
25717 if (NILP (pointer
))
25719 /* If the string itself doesn't specify a pointer,
25720 see if the buffer text ``under'' it does. */
25721 struct glyph_row
*r
25722 = MATRIX_ROW (w
->current_matrix
, vpos
);
25723 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25724 EMACS_INT p
= string_buffer_position (obj
, start
);
25726 pointer
= Fget_char_property (make_number (p
),
25727 Qpointer
, w
->buffer
);
25730 else if (BUFFERP (obj
)
25733 pointer
= Fget_text_property (make_number (charpos
),
25737 #endif /* HAVE_WINDOW_SYSTEM */
25741 current_buffer
= obuf
;
25746 #ifdef HAVE_WINDOW_SYSTEM
25747 if (FRAME_WINDOW_P (f
))
25748 define_frame_cursor1 (f
, cursor
, pointer
);
25750 /* This is here to prevent a compiler error, about "label at end of
25751 compound statement". */
25758 Clear any mouse-face on window W. This function is part of the
25759 redisplay interface, and is called from try_window_id and similar
25760 functions to ensure the mouse-highlight is off. */
25763 x_clear_window_mouse_face (struct window
*w
)
25765 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25766 Lisp_Object window
;
25769 XSETWINDOW (window
, w
);
25770 if (EQ (window
, hlinfo
->mouse_face_window
))
25771 clear_mouse_face (hlinfo
);
25777 Just discard the mouse face information for frame F, if any.
25778 This is used when the size of F is changed. */
25781 cancel_mouse_face (struct frame
*f
)
25783 Lisp_Object window
;
25784 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25786 window
= hlinfo
->mouse_face_window
;
25787 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25789 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25790 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25791 hlinfo
->mouse_face_window
= Qnil
;
25797 /***********************************************************************
25799 ***********************************************************************/
25801 #ifdef HAVE_WINDOW_SYSTEM
25803 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25804 which intersects rectangle R. R is in window-relative coordinates. */
25807 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25808 enum glyph_row_area area
)
25810 struct glyph
*first
= row
->glyphs
[area
];
25811 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25812 struct glyph
*last
;
25813 int first_x
, start_x
, x
;
25815 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25816 /* If row extends face to end of line write the whole line. */
25817 draw_glyphs (w
, 0, row
, area
,
25818 0, row
->used
[area
],
25819 DRAW_NORMAL_TEXT
, 0);
25822 /* Set START_X to the window-relative start position for drawing glyphs of
25823 AREA. The first glyph of the text area can be partially visible.
25824 The first glyphs of other areas cannot. */
25825 start_x
= window_box_left_offset (w
, area
);
25827 if (area
== TEXT_AREA
)
25830 /* Find the first glyph that must be redrawn. */
25832 && x
+ first
->pixel_width
< r
->x
)
25834 x
+= first
->pixel_width
;
25838 /* Find the last one. */
25842 && x
< r
->x
+ r
->width
)
25844 x
+= last
->pixel_width
;
25850 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25851 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25852 DRAW_NORMAL_TEXT
, 0);
25857 /* Redraw the parts of the glyph row ROW on window W intersecting
25858 rectangle R. R is in window-relative coordinates. Value is
25859 non-zero if mouse-face was overwritten. */
25862 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25864 xassert (row
->enabled_p
);
25866 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25867 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25868 0, row
->used
[TEXT_AREA
],
25869 DRAW_NORMAL_TEXT
, 0);
25872 if (row
->used
[LEFT_MARGIN_AREA
])
25873 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25874 if (row
->used
[TEXT_AREA
])
25875 expose_area (w
, row
, r
, TEXT_AREA
);
25876 if (row
->used
[RIGHT_MARGIN_AREA
])
25877 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25878 draw_row_fringe_bitmaps (w
, row
);
25881 return row
->mouse_face_p
;
25885 /* Redraw those parts of glyphs rows during expose event handling that
25886 overlap other rows. Redrawing of an exposed line writes over parts
25887 of lines overlapping that exposed line; this function fixes that.
25889 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25890 row in W's current matrix that is exposed and overlaps other rows.
25891 LAST_OVERLAPPING_ROW is the last such row. */
25894 expose_overlaps (struct window
*w
,
25895 struct glyph_row
*first_overlapping_row
,
25896 struct glyph_row
*last_overlapping_row
,
25899 struct glyph_row
*row
;
25901 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25902 if (row
->overlapping_p
)
25904 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25907 if (row
->used
[LEFT_MARGIN_AREA
])
25908 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25910 if (row
->used
[TEXT_AREA
])
25911 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25913 if (row
->used
[RIGHT_MARGIN_AREA
])
25914 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25920 /* Return non-zero if W's cursor intersects rectangle R. */
25923 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25925 XRectangle cr
, result
;
25926 struct glyph
*cursor_glyph
;
25927 struct glyph_row
*row
;
25929 if (w
->phys_cursor
.vpos
>= 0
25930 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25931 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25933 && row
->cursor_in_fringe_p
)
25935 /* Cursor is in the fringe. */
25936 cr
.x
= window_box_right_offset (w
,
25937 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25938 ? RIGHT_MARGIN_AREA
25941 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25942 cr
.height
= row
->height
;
25943 return x_intersect_rectangles (&cr
, r
, &result
);
25946 cursor_glyph
= get_phys_cursor_glyph (w
);
25949 /* r is relative to W's box, but w->phys_cursor.x is relative
25950 to left edge of W's TEXT area. Adjust it. */
25951 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25952 cr
.y
= w
->phys_cursor
.y
;
25953 cr
.width
= cursor_glyph
->pixel_width
;
25954 cr
.height
= w
->phys_cursor_height
;
25955 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25956 I assume the effect is the same -- and this is portable. */
25957 return x_intersect_rectangles (&cr
, r
, &result
);
25959 /* If we don't understand the format, pretend we're not in the hot-spot. */
25965 Draw a vertical window border to the right of window W if W doesn't
25966 have vertical scroll bars. */
25969 x_draw_vertical_border (struct window
*w
)
25971 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25973 /* We could do better, if we knew what type of scroll-bar the adjacent
25974 windows (on either side) have... But we don't :-(
25975 However, I think this works ok. ++KFS 2003-04-25 */
25977 /* Redraw borders between horizontally adjacent windows. Don't
25978 do it for frames with vertical scroll bars because either the
25979 right scroll bar of a window, or the left scroll bar of its
25980 neighbor will suffice as a border. */
25981 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25984 if (!WINDOW_RIGHTMOST_P (w
)
25985 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25987 int x0
, x1
, y0
, y1
;
25989 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25992 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25995 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25997 else if (!WINDOW_LEFTMOST_P (w
)
25998 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26000 int x0
, x1
, y0
, y1
;
26002 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26005 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26008 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26013 /* Redraw the part of window W intersection rectangle FR. Pixel
26014 coordinates in FR are frame-relative. Call this function with
26015 input blocked. Value is non-zero if the exposure overwrites
26019 expose_window (struct window
*w
, XRectangle
*fr
)
26021 struct frame
*f
= XFRAME (w
->frame
);
26023 int mouse_face_overwritten_p
= 0;
26025 /* If window is not yet fully initialized, do nothing. This can
26026 happen when toolkit scroll bars are used and a window is split.
26027 Reconfiguring the scroll bar will generate an expose for a newly
26029 if (w
->current_matrix
== NULL
)
26032 /* When we're currently updating the window, display and current
26033 matrix usually don't agree. Arrange for a thorough display
26035 if (w
== updated_window
)
26037 SET_FRAME_GARBAGED (f
);
26041 /* Frame-relative pixel rectangle of W. */
26042 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26043 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26044 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26045 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26047 if (x_intersect_rectangles (fr
, &wr
, &r
))
26049 int yb
= window_text_bottom_y (w
);
26050 struct glyph_row
*row
;
26051 int cursor_cleared_p
;
26052 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26054 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26055 r
.x
, r
.y
, r
.width
, r
.height
));
26057 /* Convert to window coordinates. */
26058 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26059 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26061 /* Turn off the cursor. */
26062 if (!w
->pseudo_window_p
26063 && phys_cursor_in_rect_p (w
, &r
))
26065 x_clear_cursor (w
);
26066 cursor_cleared_p
= 1;
26069 cursor_cleared_p
= 0;
26071 /* Update lines intersecting rectangle R. */
26072 first_overlapping_row
= last_overlapping_row
= NULL
;
26073 for (row
= w
->current_matrix
->rows
;
26078 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26080 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26081 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26082 || (r
.y
>= y0
&& r
.y
< y1
)
26083 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26085 /* A header line may be overlapping, but there is no need
26086 to fix overlapping areas for them. KFS 2005-02-12 */
26087 if (row
->overlapping_p
&& !row
->mode_line_p
)
26089 if (first_overlapping_row
== NULL
)
26090 first_overlapping_row
= row
;
26091 last_overlapping_row
= row
;
26095 if (expose_line (w
, row
, &r
))
26096 mouse_face_overwritten_p
= 1;
26099 else if (row
->overlapping_p
)
26101 /* We must redraw a row overlapping the exposed area. */
26103 ? y0
+ row
->phys_height
> r
.y
26104 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26106 if (first_overlapping_row
== NULL
)
26107 first_overlapping_row
= row
;
26108 last_overlapping_row
= row
;
26116 /* Display the mode line if there is one. */
26117 if (WINDOW_WANTS_MODELINE_P (w
)
26118 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26120 && row
->y
< r
.y
+ r
.height
)
26122 if (expose_line (w
, row
, &r
))
26123 mouse_face_overwritten_p
= 1;
26126 if (!w
->pseudo_window_p
)
26128 /* Fix the display of overlapping rows. */
26129 if (first_overlapping_row
)
26130 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26133 /* Draw border between windows. */
26134 x_draw_vertical_border (w
);
26136 /* Turn the cursor on again. */
26137 if (cursor_cleared_p
)
26138 update_window_cursor (w
, 1);
26142 return mouse_face_overwritten_p
;
26147 /* Redraw (parts) of all windows in the window tree rooted at W that
26148 intersect R. R contains frame pixel coordinates. Value is
26149 non-zero if the exposure overwrites mouse-face. */
26152 expose_window_tree (struct window
*w
, XRectangle
*r
)
26154 struct frame
*f
= XFRAME (w
->frame
);
26155 int mouse_face_overwritten_p
= 0;
26157 while (w
&& !FRAME_GARBAGED_P (f
))
26159 if (!NILP (w
->hchild
))
26160 mouse_face_overwritten_p
26161 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26162 else if (!NILP (w
->vchild
))
26163 mouse_face_overwritten_p
26164 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26166 mouse_face_overwritten_p
|= expose_window (w
, r
);
26168 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26171 return mouse_face_overwritten_p
;
26176 Redisplay an exposed area of frame F. X and Y are the upper-left
26177 corner of the exposed rectangle. W and H are width and height of
26178 the exposed area. All are pixel values. W or H zero means redraw
26179 the entire frame. */
26182 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26185 int mouse_face_overwritten_p
= 0;
26187 TRACE ((stderr
, "expose_frame "));
26189 /* No need to redraw if frame will be redrawn soon. */
26190 if (FRAME_GARBAGED_P (f
))
26192 TRACE ((stderr
, " garbaged\n"));
26196 /* If basic faces haven't been realized yet, there is no point in
26197 trying to redraw anything. This can happen when we get an expose
26198 event while Emacs is starting, e.g. by moving another window. */
26199 if (FRAME_FACE_CACHE (f
) == NULL
26200 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26202 TRACE ((stderr
, " no faces\n"));
26206 if (w
== 0 || h
== 0)
26209 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26210 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26220 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26221 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26223 if (WINDOWP (f
->tool_bar_window
))
26224 mouse_face_overwritten_p
26225 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26227 #ifdef HAVE_X_WINDOWS
26229 #ifndef USE_X_TOOLKIT
26230 if (WINDOWP (f
->menu_bar_window
))
26231 mouse_face_overwritten_p
26232 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26233 #endif /* not USE_X_TOOLKIT */
26237 /* Some window managers support a focus-follows-mouse style with
26238 delayed raising of frames. Imagine a partially obscured frame,
26239 and moving the mouse into partially obscured mouse-face on that
26240 frame. The visible part of the mouse-face will be highlighted,
26241 then the WM raises the obscured frame. With at least one WM, KDE
26242 2.1, Emacs is not getting any event for the raising of the frame
26243 (even tried with SubstructureRedirectMask), only Expose events.
26244 These expose events will draw text normally, i.e. not
26245 highlighted. Which means we must redo the highlight here.
26246 Subsume it under ``we love X''. --gerd 2001-08-15 */
26247 /* Included in Windows version because Windows most likely does not
26248 do the right thing if any third party tool offers
26249 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26250 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26252 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26253 if (f
== hlinfo
->mouse_face_mouse_frame
)
26255 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26256 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26257 clear_mouse_face (hlinfo
);
26258 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26265 Determine the intersection of two rectangles R1 and R2. Return
26266 the intersection in *RESULT. Value is non-zero if RESULT is not
26270 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26272 XRectangle
*left
, *right
;
26273 XRectangle
*upper
, *lower
;
26274 int intersection_p
= 0;
26276 /* Rearrange so that R1 is the left-most rectangle. */
26278 left
= r1
, right
= r2
;
26280 left
= r2
, right
= r1
;
26282 /* X0 of the intersection is right.x0, if this is inside R1,
26283 otherwise there is no intersection. */
26284 if (right
->x
<= left
->x
+ left
->width
)
26286 result
->x
= right
->x
;
26288 /* The right end of the intersection is the minimum of the
26289 the right ends of left and right. */
26290 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26293 /* Same game for Y. */
26295 upper
= r1
, lower
= r2
;
26297 upper
= r2
, lower
= r1
;
26299 /* The upper end of the intersection is lower.y0, if this is inside
26300 of upper. Otherwise, there is no intersection. */
26301 if (lower
->y
<= upper
->y
+ upper
->height
)
26303 result
->y
= lower
->y
;
26305 /* The lower end of the intersection is the minimum of the lower
26306 ends of upper and lower. */
26307 result
->height
= (min (lower
->y
+ lower
->height
,
26308 upper
->y
+ upper
->height
)
26310 intersection_p
= 1;
26314 return intersection_p
;
26317 #endif /* HAVE_WINDOW_SYSTEM */
26320 /***********************************************************************
26322 ***********************************************************************/
26325 syms_of_xdisp (void)
26327 Vwith_echo_area_save_vector
= Qnil
;
26328 staticpro (&Vwith_echo_area_save_vector
);
26330 Vmessage_stack
= Qnil
;
26331 staticpro (&Vmessage_stack
);
26333 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26334 staticpro (&Qinhibit_redisplay
);
26336 message_dolog_marker1
= Fmake_marker ();
26337 staticpro (&message_dolog_marker1
);
26338 message_dolog_marker2
= Fmake_marker ();
26339 staticpro (&message_dolog_marker2
);
26340 message_dolog_marker3
= Fmake_marker ();
26341 staticpro (&message_dolog_marker3
);
26344 defsubr (&Sdump_frame_glyph_matrix
);
26345 defsubr (&Sdump_glyph_matrix
);
26346 defsubr (&Sdump_glyph_row
);
26347 defsubr (&Sdump_tool_bar_row
);
26348 defsubr (&Strace_redisplay
);
26349 defsubr (&Strace_to_stderr
);
26351 #ifdef HAVE_WINDOW_SYSTEM
26352 defsubr (&Stool_bar_lines_needed
);
26353 defsubr (&Slookup_image_map
);
26355 defsubr (&Sformat_mode_line
);
26356 defsubr (&Sinvisible_p
);
26357 defsubr (&Scurrent_bidi_paragraph_direction
);
26359 staticpro (&Qmenu_bar_update_hook
);
26360 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26362 staticpro (&Qoverriding_terminal_local_map
);
26363 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26365 staticpro (&Qoverriding_local_map
);
26366 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26368 staticpro (&Qwindow_scroll_functions
);
26369 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26371 staticpro (&Qwindow_text_change_functions
);
26372 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26374 staticpro (&Qredisplay_end_trigger_functions
);
26375 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26377 staticpro (&Qinhibit_point_motion_hooks
);
26378 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26380 Qeval
= intern_c_string ("eval");
26381 staticpro (&Qeval
);
26383 QCdata
= intern_c_string (":data");
26384 staticpro (&QCdata
);
26385 Qdisplay
= intern_c_string ("display");
26386 staticpro (&Qdisplay
);
26387 Qspace_width
= intern_c_string ("space-width");
26388 staticpro (&Qspace_width
);
26389 Qraise
= intern_c_string ("raise");
26390 staticpro (&Qraise
);
26391 Qslice
= intern_c_string ("slice");
26392 staticpro (&Qslice
);
26393 Qspace
= intern_c_string ("space");
26394 staticpro (&Qspace
);
26395 Qmargin
= intern_c_string ("margin");
26396 staticpro (&Qmargin
);
26397 Qpointer
= intern_c_string ("pointer");
26398 staticpro (&Qpointer
);
26399 Qleft_margin
= intern_c_string ("left-margin");
26400 staticpro (&Qleft_margin
);
26401 Qright_margin
= intern_c_string ("right-margin");
26402 staticpro (&Qright_margin
);
26403 Qcenter
= intern_c_string ("center");
26404 staticpro (&Qcenter
);
26405 Qline_height
= intern_c_string ("line-height");
26406 staticpro (&Qline_height
);
26407 QCalign_to
= intern_c_string (":align-to");
26408 staticpro (&QCalign_to
);
26409 QCrelative_width
= intern_c_string (":relative-width");
26410 staticpro (&QCrelative_width
);
26411 QCrelative_height
= intern_c_string (":relative-height");
26412 staticpro (&QCrelative_height
);
26413 QCeval
= intern_c_string (":eval");
26414 staticpro (&QCeval
);
26415 QCpropertize
= intern_c_string (":propertize");
26416 staticpro (&QCpropertize
);
26417 QCfile
= intern_c_string (":file");
26418 staticpro (&QCfile
);
26419 Qfontified
= intern_c_string ("fontified");
26420 staticpro (&Qfontified
);
26421 Qfontification_functions
= intern_c_string ("fontification-functions");
26422 staticpro (&Qfontification_functions
);
26423 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26424 staticpro (&Qtrailing_whitespace
);
26425 Qescape_glyph
= intern_c_string ("escape-glyph");
26426 staticpro (&Qescape_glyph
);
26427 Qnobreak_space
= intern_c_string ("nobreak-space");
26428 staticpro (&Qnobreak_space
);
26429 Qimage
= intern_c_string ("image");
26430 staticpro (&Qimage
);
26431 Qtext
= intern_c_string ("text");
26432 staticpro (&Qtext
);
26433 Qboth
= intern_c_string ("both");
26434 staticpro (&Qboth
);
26435 Qboth_horiz
= intern_c_string ("both-horiz");
26436 staticpro (&Qboth_horiz
);
26437 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26438 staticpro (&Qtext_image_horiz
);
26439 QCmap
= intern_c_string (":map");
26440 staticpro (&QCmap
);
26441 QCpointer
= intern_c_string (":pointer");
26442 staticpro (&QCpointer
);
26443 Qrect
= intern_c_string ("rect");
26444 staticpro (&Qrect
);
26445 Qcircle
= intern_c_string ("circle");
26446 staticpro (&Qcircle
);
26447 Qpoly
= intern_c_string ("poly");
26448 staticpro (&Qpoly
);
26449 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26450 staticpro (&Qmessage_truncate_lines
);
26451 Qgrow_only
= intern_c_string ("grow-only");
26452 staticpro (&Qgrow_only
);
26453 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26454 staticpro (&Qinhibit_menubar_update
);
26455 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26456 staticpro (&Qinhibit_eval_during_redisplay
);
26457 Qposition
= intern_c_string ("position");
26458 staticpro (&Qposition
);
26459 Qbuffer_position
= intern_c_string ("buffer-position");
26460 staticpro (&Qbuffer_position
);
26461 Qobject
= intern_c_string ("object");
26462 staticpro (&Qobject
);
26463 Qbar
= intern_c_string ("bar");
26465 Qhbar
= intern_c_string ("hbar");
26466 staticpro (&Qhbar
);
26467 Qbox
= intern_c_string ("box");
26469 Qhollow
= intern_c_string ("hollow");
26470 staticpro (&Qhollow
);
26471 Qhand
= intern_c_string ("hand");
26472 staticpro (&Qhand
);
26473 Qarrow
= intern_c_string ("arrow");
26474 staticpro (&Qarrow
);
26475 Qtext
= intern_c_string ("text");
26476 staticpro (&Qtext
);
26477 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26478 staticpro (&Qinhibit_free_realized_faces
);
26480 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26481 Fcons (intern_c_string ("void-variable"), Qnil
)),
26483 staticpro (&list_of_error
);
26485 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26486 staticpro (&Qlast_arrow_position
);
26487 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26488 staticpro (&Qlast_arrow_string
);
26490 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26491 staticpro (&Qoverlay_arrow_string
);
26492 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26493 staticpro (&Qoverlay_arrow_bitmap
);
26495 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26496 staticpro (&echo_buffer
[0]);
26497 staticpro (&echo_buffer
[1]);
26499 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26500 staticpro (&echo_area_buffer
[0]);
26501 staticpro (&echo_area_buffer
[1]);
26503 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26504 staticpro (&Vmessages_buffer_name
);
26506 mode_line_proptrans_alist
= Qnil
;
26507 staticpro (&mode_line_proptrans_alist
);
26508 mode_line_string_list
= Qnil
;
26509 staticpro (&mode_line_string_list
);
26510 mode_line_string_face
= Qnil
;
26511 staticpro (&mode_line_string_face
);
26512 mode_line_string_face_prop
= Qnil
;
26513 staticpro (&mode_line_string_face_prop
);
26514 Vmode_line_unwind_vector
= Qnil
;
26515 staticpro (&Vmode_line_unwind_vector
);
26517 help_echo_string
= Qnil
;
26518 staticpro (&help_echo_string
);
26519 help_echo_object
= Qnil
;
26520 staticpro (&help_echo_object
);
26521 help_echo_window
= Qnil
;
26522 staticpro (&help_echo_window
);
26523 previous_help_echo_string
= Qnil
;
26524 staticpro (&previous_help_echo_string
);
26525 help_echo_pos
= -1;
26527 Qright_to_left
= intern_c_string ("right-to-left");
26528 staticpro (&Qright_to_left
);
26529 Qleft_to_right
= intern_c_string ("left-to-right");
26530 staticpro (&Qleft_to_right
);
26532 #ifdef HAVE_WINDOW_SYSTEM
26533 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26534 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26535 For example, if a block cursor is over a tab, it will be drawn as
26536 wide as that tab on the display. */);
26537 x_stretch_cursor_p
= 0;
26540 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26541 doc
: /* *Non-nil means highlight trailing whitespace.
26542 The face used for trailing whitespace is `trailing-whitespace'. */);
26543 Vshow_trailing_whitespace
= Qnil
;
26545 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26546 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26547 A value of t means highlight the character itself (for nobreak space,
26548 use face `nobreak-space').
26549 A value of nil means no highlighting.
26550 Other values mean display the escape glyph followed by an ordinary
26551 space or ordinary hyphen. */);
26552 Vnobreak_char_display
= Qt
;
26554 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26555 doc
: /* *The pointer shape to show in void text areas.
26556 A value of nil means to show the text pointer. Other options are `arrow',
26557 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26558 Vvoid_text_area_pointer
= Qarrow
;
26560 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26561 doc
: /* Non-nil means don't actually do any redisplay.
26562 This is used for internal purposes. */);
26563 Vinhibit_redisplay
= Qnil
;
26565 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26566 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26567 Vglobal_mode_string
= Qnil
;
26569 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26570 doc
: /* Marker for where to display an arrow on top of the buffer text.
26571 This must be the beginning of a line in order to work.
26572 See also `overlay-arrow-string'. */);
26573 Voverlay_arrow_position
= Qnil
;
26575 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26576 doc
: /* String to display as an arrow in non-window frames.
26577 See also `overlay-arrow-position'. */);
26578 Voverlay_arrow_string
= make_pure_c_string ("=>");
26580 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26581 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26582 The symbols on this list are examined during redisplay to determine
26583 where to display overlay arrows. */);
26584 Voverlay_arrow_variable_list
26585 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26587 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26588 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26589 If that fails to bring point back on frame, point is centered instead.
26590 If this is zero, point is always centered after it moves off frame.
26591 If you want scrolling to always be a line at a time, you should set
26592 `scroll-conservatively' to a large value rather than set this to 1. */);
26594 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26595 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26596 If point moves off-screen, redisplay will scroll by up to
26597 `scroll-conservatively' lines in order to bring point just barely
26598 onto the screen again. If that cannot be done, then redisplay
26599 recenters point as usual.
26601 If the value is greater than 100, redisplay will never recenter point,
26602 but will always scroll just enough text to bring point into view, even
26603 if you move far away.
26605 A value of zero means always recenter point if it moves off screen. */);
26606 scroll_conservatively
= 0;
26608 DEFVAR_INT ("scroll-margin", scroll_margin
,
26609 doc
: /* *Number of lines of margin at the top and bottom of a window.
26610 Recenter the window whenever point gets within this many lines
26611 of the top or bottom of the window. */);
26614 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26615 doc
: /* Pixels per inch value for non-window system displays.
26616 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26617 Vdisplay_pixels_per_inch
= make_float (72.0);
26620 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26623 DEFVAR_LISP ("truncate-partial-width-windows",
26624 Vtruncate_partial_width_windows
,
26625 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26626 For an integer value, truncate lines in each window narrower than the
26627 full frame width, provided the window width is less than that integer;
26628 otherwise, respect the value of `truncate-lines'.
26630 For any other non-nil value, truncate lines in all windows that do
26631 not span the full frame width.
26633 A value of nil means to respect the value of `truncate-lines'.
26635 If `word-wrap' is enabled, you might want to reduce this. */);
26636 Vtruncate_partial_width_windows
= make_number (50);
26638 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26639 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26640 Any other value means to use the appropriate face, `mode-line',
26641 `header-line', or `menu' respectively. */);
26642 mode_line_inverse_video
= 1;
26644 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26645 doc
: /* *Maximum buffer size for which line number should be displayed.
26646 If the buffer is bigger than this, the line number does not appear
26647 in the mode line. A value of nil means no limit. */);
26648 Vline_number_display_limit
= Qnil
;
26650 DEFVAR_INT ("line-number-display-limit-width",
26651 line_number_display_limit_width
,
26652 doc
: /* *Maximum line width (in characters) for line number display.
26653 If the average length of the lines near point is bigger than this, then the
26654 line number may be omitted from the mode line. */);
26655 line_number_display_limit_width
= 200;
26657 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26658 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26659 highlight_nonselected_windows
= 0;
26661 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26662 doc
: /* Non-nil if more than one frame is visible on this display.
26663 Minibuffer-only frames don't count, but iconified frames do.
26664 This variable is not guaranteed to be accurate except while processing
26665 `frame-title-format' and `icon-title-format'. */);
26667 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26668 doc
: /* Template for displaying the title bar of visible frames.
26669 \(Assuming the window manager supports this feature.)
26671 This variable has the same structure as `mode-line-format', except that
26672 the %c and %l constructs are ignored. It is used only on frames for
26673 which no explicit name has been set \(see `modify-frame-parameters'). */);
26675 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26676 doc
: /* Template for displaying the title bar of an iconified frame.
26677 \(Assuming the window manager supports this feature.)
26678 This variable has the same structure as `mode-line-format' (which see),
26679 and is used only on frames for which no explicit name has been set
26680 \(see `modify-frame-parameters'). */);
26682 = Vframe_title_format
26683 = pure_cons (intern_c_string ("multiple-frames"),
26684 pure_cons (make_pure_c_string ("%b"),
26685 pure_cons (pure_cons (empty_unibyte_string
,
26686 pure_cons (intern_c_string ("invocation-name"),
26687 pure_cons (make_pure_c_string ("@"),
26688 pure_cons (intern_c_string ("system-name"),
26692 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26693 doc
: /* Maximum number of lines to keep in the message log buffer.
26694 If nil, disable message logging. If t, log messages but don't truncate
26695 the buffer when it becomes large. */);
26696 Vmessage_log_max
= make_number (100);
26698 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26699 doc
: /* Functions called before redisplay, if window sizes have changed.
26700 The value should be a list of functions that take one argument.
26701 Just before redisplay, for each frame, if any of its windows have changed
26702 size since the last redisplay, or have been split or deleted,
26703 all the functions in the list are called, with the frame as argument. */);
26704 Vwindow_size_change_functions
= Qnil
;
26706 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26707 doc
: /* List of functions to call before redisplaying a window with scrolling.
26708 Each function is called with two arguments, the window and its new
26709 display-start position. Note that these functions are also called by
26710 `set-window-buffer'. Also note that the value of `window-end' is not
26711 valid when these functions are called. */);
26712 Vwindow_scroll_functions
= Qnil
;
26714 DEFVAR_LISP ("window-text-change-functions",
26715 Vwindow_text_change_functions
,
26716 doc
: /* Functions to call in redisplay when text in the window might change. */);
26717 Vwindow_text_change_functions
= Qnil
;
26719 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26720 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26721 Each function is called with two arguments, the window and the end trigger value.
26722 See `set-window-redisplay-end-trigger'. */);
26723 Vredisplay_end_trigger_functions
= Qnil
;
26725 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26726 doc
: /* *Non-nil means autoselect window with mouse pointer.
26727 If nil, do not autoselect windows.
26728 A positive number means delay autoselection by that many seconds: a
26729 window is autoselected only after the mouse has remained in that
26730 window for the duration of the delay.
26731 A negative number has a similar effect, but causes windows to be
26732 autoselected only after the mouse has stopped moving. \(Because of
26733 the way Emacs compares mouse events, you will occasionally wait twice
26734 that time before the window gets selected.\)
26735 Any other value means to autoselect window instantaneously when the
26736 mouse pointer enters it.
26738 Autoselection selects the minibuffer only if it is active, and never
26739 unselects the minibuffer if it is active.
26741 When customizing this variable make sure that the actual value of
26742 `focus-follows-mouse' matches the behavior of your window manager. */);
26743 Vmouse_autoselect_window
= Qnil
;
26745 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26746 doc
: /* *Non-nil means automatically resize tool-bars.
26747 This dynamically changes the tool-bar's height to the minimum height
26748 that is needed to make all tool-bar items visible.
26749 If value is `grow-only', the tool-bar's height is only increased
26750 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26751 Vauto_resize_tool_bars
= Qt
;
26753 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26754 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26755 auto_raise_tool_bar_buttons_p
= 1;
26757 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26758 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26759 make_cursor_line_fully_visible_p
= 1;
26761 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26762 doc
: /* *Border below tool-bar in pixels.
26763 If an integer, use it as the height of the border.
26764 If it is one of `internal-border-width' or `border-width', use the
26765 value of the corresponding frame parameter.
26766 Otherwise, no border is added below the tool-bar. */);
26767 Vtool_bar_border
= Qinternal_border_width
;
26769 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26770 doc
: /* *Margin around tool-bar buttons in pixels.
26771 If an integer, use that for both horizontal and vertical margins.
26772 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26773 HORZ specifying the horizontal margin, and VERT specifying the
26774 vertical margin. */);
26775 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26777 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26778 doc
: /* *Relief thickness of tool-bar buttons. */);
26779 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26781 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26782 doc
: /* Tool bar style to use.
26784 image - show images only
26785 text - show text only
26786 both - show both, text below image
26787 both-horiz - show text to the right of the image
26788 text-image-horiz - show text to the left of the image
26789 any other - use system default or image if no system default. */);
26790 Vtool_bar_style
= Qnil
;
26792 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26793 doc
: /* *Maximum number of characters a label can have to be shown.
26794 The tool bar style must also show labels for this to have any effect, see
26795 `tool-bar-style'. */);
26796 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26798 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26799 doc
: /* List of functions to call to fontify regions of text.
26800 Each function is called with one argument POS. Functions must
26801 fontify a region starting at POS in the current buffer, and give
26802 fontified regions the property `fontified'. */);
26803 Vfontification_functions
= Qnil
;
26804 Fmake_variable_buffer_local (Qfontification_functions
);
26806 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26807 unibyte_display_via_language_environment
,
26808 doc
: /* *Non-nil means display unibyte text according to language environment.
26809 Specifically, this means that raw bytes in the range 160-255 decimal
26810 are displayed by converting them to the equivalent multibyte characters
26811 according to the current language environment. As a result, they are
26812 displayed according to the current fontset.
26814 Note that this variable affects only how these bytes are displayed,
26815 but does not change the fact they are interpreted as raw bytes. */);
26816 unibyte_display_via_language_environment
= 0;
26818 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26819 doc
: /* *Maximum height for resizing mini-windows.
26820 If a float, it specifies a fraction of the mini-window frame's height.
26821 If an integer, it specifies a number of lines. */);
26822 Vmax_mini_window_height
= make_float (0.25);
26824 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26825 doc
: /* *How to resize mini-windows.
26826 A value of nil means don't automatically resize mini-windows.
26827 A value of t means resize them to fit the text displayed in them.
26828 A value of `grow-only', the default, means let mini-windows grow
26829 only, until their display becomes empty, at which point the windows
26830 go back to their normal size. */);
26831 Vresize_mini_windows
= Qgrow_only
;
26833 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26834 doc
: /* Alist specifying how to blink the cursor off.
26835 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26836 `cursor-type' frame-parameter or variable equals ON-STATE,
26837 comparing using `equal', Emacs uses OFF-STATE to specify
26838 how to blink it off. ON-STATE and OFF-STATE are values for
26839 the `cursor-type' frame parameter.
26841 If a frame's ON-STATE has no entry in this list,
26842 the frame's other specifications determine how to blink the cursor off. */);
26843 Vblink_cursor_alist
= Qnil
;
26845 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26846 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26847 If non-nil, windows are automatically scrolled horizontally to make
26848 point visible. */);
26849 automatic_hscrolling_p
= 1;
26850 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26851 staticpro (&Qauto_hscroll_mode
);
26853 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26854 doc
: /* *How many columns away from the window edge point is allowed to get
26855 before automatic hscrolling will horizontally scroll the window. */);
26856 hscroll_margin
= 5;
26858 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26859 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26860 When point is less than `hscroll-margin' columns from the window
26861 edge, automatic hscrolling will scroll the window by the amount of columns
26862 determined by this variable. If its value is a positive integer, scroll that
26863 many columns. If it's a positive floating-point number, it specifies the
26864 fraction of the window's width to scroll. If it's nil or zero, point will be
26865 centered horizontally after the scroll. Any other value, including negative
26866 numbers, are treated as if the value were zero.
26868 Automatic hscrolling always moves point outside the scroll margin, so if
26869 point was more than scroll step columns inside the margin, the window will
26870 scroll more than the value given by the scroll step.
26872 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26873 and `scroll-right' overrides this variable's effect. */);
26874 Vhscroll_step
= make_number (0);
26876 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26877 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26878 Bind this around calls to `message' to let it take effect. */);
26879 message_truncate_lines
= 0;
26881 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26882 doc
: /* Normal hook run to update the menu bar definitions.
26883 Redisplay runs this hook before it redisplays the menu bar.
26884 This is used to update submenus such as Buffers,
26885 whose contents depend on various data. */);
26886 Vmenu_bar_update_hook
= Qnil
;
26888 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26889 doc
: /* Frame for which we are updating a menu.
26890 The enable predicate for a menu binding should check this variable. */);
26891 Vmenu_updating_frame
= Qnil
;
26893 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26894 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26895 inhibit_menubar_update
= 0;
26897 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26898 doc
: /* Prefix prepended to all continuation lines at display time.
26899 The value may be a string, an image, or a stretch-glyph; it is
26900 interpreted in the same way as the value of a `display' text property.
26902 This variable is overridden by any `wrap-prefix' text or overlay
26905 To add a prefix to non-continuation lines, use `line-prefix'. */);
26906 Vwrap_prefix
= Qnil
;
26907 staticpro (&Qwrap_prefix
);
26908 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26909 Fmake_variable_buffer_local (Qwrap_prefix
);
26911 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26912 doc
: /* Prefix prepended to all non-continuation lines at display time.
26913 The value may be a string, an image, or a stretch-glyph; it is
26914 interpreted in the same way as the value of a `display' text property.
26916 This variable is overridden by any `line-prefix' text or overlay
26919 To add a prefix to continuation lines, use `wrap-prefix'. */);
26920 Vline_prefix
= Qnil
;
26921 staticpro (&Qline_prefix
);
26922 Qline_prefix
= intern_c_string ("line-prefix");
26923 Fmake_variable_buffer_local (Qline_prefix
);
26925 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26926 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26927 inhibit_eval_during_redisplay
= 0;
26929 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26930 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26931 inhibit_free_realized_faces
= 0;
26934 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26935 doc
: /* Inhibit try_window_id display optimization. */);
26936 inhibit_try_window_id
= 0;
26938 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26939 doc
: /* Inhibit try_window_reusing display optimization. */);
26940 inhibit_try_window_reusing
= 0;
26942 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26943 doc
: /* Inhibit try_cursor_movement display optimization. */);
26944 inhibit_try_cursor_movement
= 0;
26945 #endif /* GLYPH_DEBUG */
26947 DEFVAR_INT ("overline-margin", overline_margin
,
26948 doc
: /* *Space between overline and text, in pixels.
26949 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26950 margin to the caracter height. */);
26951 overline_margin
= 2;
26953 DEFVAR_INT ("underline-minimum-offset",
26954 underline_minimum_offset
,
26955 doc
: /* Minimum distance between baseline and underline.
26956 This can improve legibility of underlined text at small font sizes,
26957 particularly when using variable `x-use-underline-position-properties'
26958 with fonts that specify an UNDERLINE_POSITION relatively close to the
26959 baseline. The default value is 1. */);
26960 underline_minimum_offset
= 1;
26962 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26963 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26964 This feature only works when on a window system that can change
26965 cursor shapes. */);
26966 display_hourglass_p
= 1;
26968 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26969 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26970 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26972 hourglass_atimer
= NULL
;
26973 hourglass_shown_p
= 0;
26975 DEFSYM (Qglyphless_char
, "glyphless-char");
26976 DEFSYM (Qhex_code
, "hex-code");
26977 DEFSYM (Qempty_box
, "empty-box");
26978 DEFSYM (Qthin_space
, "thin-space");
26979 DEFSYM (Qzero_width
, "zero-width");
26981 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
26982 /* Intern this now in case it isn't already done.
26983 Setting this variable twice is harmless.
26984 But don't staticpro it here--that is done in alloc.c. */
26985 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
26986 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
26988 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
26989 doc
: /* Char-table to control displaying of glyphless characters.
26990 Each element, if non-nil, is an ASCII acronym string (displayed in a box)
26991 or one of these symbols:
26992 hex-code: display the hexadecimal code of a character in a box
26993 empty-box: display as an empty box
26994 thin-space: display as 1-pixel width space
26995 zero-width: don't display
26997 It has one extra slot to control the display of a character for which
26998 no font is found. The value of the slot is `hex-code' or `empty-box'.
26999 The default is `empty-box'. */);
27000 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27001 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27006 /* Initialize this module when Emacs starts. */
27011 Lisp_Object root_window
;
27012 struct window
*mini_w
;
27014 current_header_line_height
= current_mode_line_height
= -1;
27016 CHARPOS (this_line_start_pos
) = 0;
27018 mini_w
= XWINDOW (minibuf_window
);
27019 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
27021 if (!noninteractive
)
27023 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
27026 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
27027 set_window_height (root_window
,
27028 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
27030 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
27031 set_window_height (minibuf_window
, 1, 0);
27033 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
27034 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
27036 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27037 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27038 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27040 /* The default ellipsis glyphs `...'. */
27041 for (i
= 0; i
< 3; ++i
)
27042 default_invis_vector
[i
] = make_number ('.');
27046 /* Allocate the buffer for frame titles.
27047 Also used for `format-mode-line'. */
27049 mode_line_noprop_buf
= (char *) xmalloc (size
);
27050 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27051 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27052 mode_line_target
= MODE_LINE_DISPLAY
;
27055 help_echo_showing_p
= 0;
27058 /* Since w32 does not support atimers, it defines its own implementation of
27059 the following three functions in w32fns.c. */
27062 /* Platform-independent portion of hourglass implementation. */
27064 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27066 hourglass_started (void)
27068 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27071 /* Cancel a currently active hourglass timer, and start a new one. */
27073 start_hourglass (void)
27075 #if defined (HAVE_WINDOW_SYSTEM)
27077 int secs
, usecs
= 0;
27079 cancel_hourglass ();
27081 if (INTEGERP (Vhourglass_delay
)
27082 && XINT (Vhourglass_delay
) > 0)
27083 secs
= XFASTINT (Vhourglass_delay
);
27084 else if (FLOATP (Vhourglass_delay
)
27085 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27088 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27089 secs
= XFASTINT (tem
);
27090 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27093 secs
= DEFAULT_HOURGLASS_DELAY
;
27095 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27096 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27097 show_hourglass
, NULL
);
27102 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27105 cancel_hourglass (void)
27107 #if defined (HAVE_WINDOW_SYSTEM)
27108 if (hourglass_atimer
)
27110 cancel_atimer (hourglass_atimer
);
27111 hourglass_atimer
= NULL
;
27114 if (hourglass_shown_p
)
27118 #endif /* ! WINDOWSNT */